summaryrefslogtreecommitdiff
path: root/packages/taler-util/src/promises.ts
blob: bc1e402607b45ff6ae2e28458a192176da7fc8a4 (plain)
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
/*
 This file is part of GNU Taler
 (C) 2019 GNUnet e.V.

 TALER is free software; you can redistribute it and/or modify it under the
 terms of the GNU General Public License as published by the Free Software
 Foundation; either version 3, or (at your option) any later version.

 TALER is distributed in the hope that it will be useful, but WITHOUT ANY
 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

 You should have received a copy of the GNU General Public License along with
 TALER; see the file COPYING.  If not, see <http://www.gnu.org/licenses/>
 */

/**
 * An opened promise.
 *
 * @see {@link openPromise}
 */
export interface OpenedPromise<T> {
  promise: Promise<T>;
  resolve: (val: T) => void;
  reject: (err: any) => void;
  lastError?: any;
}

/**
 * Get an unresolved promise together with its extracted resolve / reject
 * function.
 *
 * Recent ECMAScript proposals also call this a promise capability.
 */
export function openPromise<T>(): OpenedPromise<T> {
  let resolve: ((x?: any) => void) | null = null;
  let promiseReject: ((reason?: any) => void) | null = null;
  const promise = new Promise<T>((res, rej) => {
    resolve = res;
    promiseReject = rej;
  });
  if (!(resolve && promiseReject)) {
    // Never happens, unless JS implementation is broken
    throw Error("JS implementation is broken");
  }
  const result: OpenedPromise<T> = { resolve, reject: promiseReject, promise };
  function saveLastError(reason?: any) {
    result.lastError = reason;
    promiseReject!(reason);
  }
  result.reject = saveLastError;
  return result;
}

export class AsyncCondition {
  private promCap?: OpenedPromise<void> = undefined;
  constructor() {}

  wait(): Promise<void> {
    if (!this.promCap) {
      this.promCap = openPromise<void>();
    }
    return this.promCap.promise;
  }

  trigger(): void {
    if (this.promCap) {
      this.promCap.resolve();
    }
    this.promCap = undefined;
  }
}

/**
 * Flag that can be raised to notify asynchronous waiters.
 *
 * You can think of it as a promise that can
 * be un-resolved.
 */
export class AsyncFlag {
  private promCap?: OpenedPromise<void> = undefined;
  private internalFlagRaised: boolean = false;

  constructor() {}

  /**
   * Wait until the flag is raised.
   *
   * Reset if before returning.
   */
  wait(): Promise<void> {
    if (this.internalFlagRaised) {
      return Promise.resolve();
    }
    if (!this.promCap) {
      this.promCap = openPromise<void>();
    }
    return this.promCap.promise;
  }

  raise(): void {
    this.internalFlagRaised = true;
    if (this.promCap) {
      this.promCap.resolve();
    }
  }

  reset(): void {
    this.internalFlagRaised = false;
    this.promCap = undefined;
  }
}