summaryrefslogtreecommitdiffstats
path: root/vespajlib/src/main/java/com/yahoo/concurrent/CompletableFutures.java
blob: 35506ec451279b6b6570335384ca21daf7b79489 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.concurrent;

import com.google.common.util.concurrent.ListenableFuture;
import com.google.common.util.concurrent.SettableFuture;
import com.yahoo.yolean.UncheckedInterruptedException;

import java.util.List;
import java.util.concurrent.CancellationException;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

/**
 * Helper for {@link java.util.concurrent.CompletableFuture} / {@link java.util.concurrent.CompletionStage}.
 *
 * @author bjorncs
 */
public class CompletableFutures {

    private CompletableFutures() {}

    /**
     * Returns a new completable future that is either
     * - completed when any of the provided futures complete without exception
     * - completed exceptionally once all provided futures complete exceptionally
     */
    public static <T> CompletableFuture<T> firstOf(List<CompletableFuture<T>> futures) {
        class Combiner {
            final Object monitor = new Object();
            final CompletableFuture<T> combined = new CompletableFuture<>();
            final int futuresCount;

            Throwable error = null;
            int exceptionCount = 0;

            Combiner(int futuresCount) { this.futuresCount = futuresCount; }

            void onCompletion(T value, Throwable error) {
                if (combined.isDone()) return;
                T valueToComplete = null;
                Throwable exceptionToComplete = null;

                synchronized (monitor) {
                    if (value != null) {
                        valueToComplete = value;
                    } else {
                        if (this.error == null) {
                            this.error = error;
                        } else {
                            this.error.addSuppressed(error);
                        }
                        if (++exceptionCount == futuresCount) {
                            exceptionToComplete = this.error;
                        }
                    }
                }
                if (valueToComplete != null) {
                    combined.complete(value);
                } else if (exceptionToComplete != null) {
                    combined.completeExceptionally(exceptionToComplete);
                }
            }
        }

        int size = futures.size();
        if (size == 0) throw new IllegalArgumentException();
        if (size == 1) return futures.get(0);
        Combiner combiner = new Combiner(size);
        futures.forEach(future -> future.whenComplete(combiner::onCompletion));
        return combiner.combined;
    }

    /**
     * Helper for migrating from {@link ListenableFuture} to {@link CompletableFuture> in Vespa public apis
     * @deprecated to be removed in Vespa 8
     */
    @Deprecated(forRemoval = true, since = "7")
    public static <V> ListenableFuture<V> toGuavaListenableFuture(CompletableFuture<V> future) {
        SettableFuture<V> guavaFuture = SettableFuture.create();
        future.whenComplete((result, error) -> {
            if (result != null) guavaFuture.set(result);
            else if (error instanceof CancellationException) guavaFuture.setException(error);
            else guavaFuture.cancel(true);
        });
        return guavaFuture;
    }

    /**
     * Helper for migrating from {@link ListenableFuture} to {@link CompletableFuture> in Vespa public apis
     * @deprecated to be removed in Vespa 8
     */
    @Deprecated(forRemoval = true, since = "7")
    public static <V> CompletableFuture<V> toCompletableFuture(ListenableFuture<V> guavaFuture) {
        CompletableFuture<V> future = new CompletableFuture<>();
        guavaFuture.addListener(
                () -> {
                    if (guavaFuture.isCancelled()) future.cancel(true);
                    try {
                        V value = guavaFuture.get();
                        future.complete(value);
                    } catch (InterruptedException e) {
                        // Should not happens since listener is invoked after future is complete
                        throw new UncheckedInterruptedException(e);
                    } catch (ExecutionException e) {
                        future.completeExceptionally(e.getCause());
                    }
                },
                Runnable::run);
        return future;
    }

}