@zukhruf/single-flight 0.6.12 → 0.6.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -1
- package/dist/connection/electing-connector.d.ts +3 -0
- package/dist/connection/electing-connector.d.ts.map +1 -1
- package/dist/connection/electing-connector.js +7 -8
- package/dist/connection/electing-connector.js.map +1 -1
- package/dist/connection/flight-election.d.ts +2 -1
- package/dist/connection/flight-election.d.ts.map +1 -1
- package/dist/connection/flight-election.js +2 -1
- package/dist/connection/flight-election.js.map +1 -1
- package/dist/key-lock/key-locks.d.ts +2 -1
- package/dist/key-lock/key-locks.d.ts.map +1 -1
- package/dist/key-lock/key-locks.js +5 -2
- package/dist/key-lock/key-locks.js.map +1 -1
- package/dist/single-flight.d.ts +4 -1
- package/dist/single-flight.d.ts.map +1 -1
- package/dist/single-flight.js +4 -3
- package/dist/single-flight.js.map +1 -1
- package/package.json +8 -8
package/README.md
CHANGED
|
@@ -72,6 +72,8 @@ The lease that the work gets comes from `@zukhruf/lease`, and its token comes fr
|
|
|
72
72
|
|
|
73
73
|
The directory is the local folder where the processes that share flights meet. Each process that uses a `SingleFlight` keeps three files and a folder there: `flight.lock`, `flight.epoch`, `flight.sock` and `execution-locks/`. The election of [`@zukhruf/election`](../election/README.md) claims `flight.lock` with a file lock, and records the epoch of the last term in `flight.epoch`. The folder `execution-locks/` has one file for each key that ever led: the key lock of that key, named by the SHA-256 of the key. The process that runs the work of a key holds a file lock on that file (see [When a process stops](#when-a-process-stops)). The files stay after the flights, so do not remove them while a process uses the directory. The journal of the claim is in memory, so a coordinator that stops leaves no `flight.lock-journal` file. All the processes that name the same directory are one group, and the callers of one key share a flight in that group only.
|
|
74
74
|
|
|
75
|
+
Each `SingleFlight` also takes a `clock`: the clock of the waits of the group, for example the wait for a key lock. Give `globalThis` in production. A test gives a fake clock, for example `createClock()` of `@sinonjs/fake-timers` ([`@zukhruf/async`](../async/README.md#run-a-wait-on-a-clock)).
|
|
76
|
+
|
|
75
77
|
There is no default directory. One default would put each application on the host into one group, and unrelated applications that use the same key would join each other's flights. Give each group its own directory, for example a folder of your application's data.
|
|
76
78
|
|
|
77
79
|
- The directory must be on a local file system. On a network file system, a call rejects with `NetworkDirectoryError`.
|
|
@@ -121,7 +123,11 @@ const syncs: Codec<Sync> = {
|
|
|
121
123
|
};
|
|
122
124
|
|
|
123
125
|
const directory = await mkdtemp(join(tmpdir(), 'syncs-'));
|
|
124
|
-
const flights = new SingleFlight({
|
|
126
|
+
const flights = new SingleFlight({
|
|
127
|
+
clock: globalThis,
|
|
128
|
+
directory,
|
|
129
|
+
codec: syncs,
|
|
130
|
+
});
|
|
125
131
|
const { value } = await flights.run('sync', async () => ({
|
|
126
132
|
at: new Date('2026-10-09T12:00:00Z'),
|
|
127
133
|
files: 42,
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { type Clock } from '@zukhruf/async';
|
|
1
2
|
import type { LeaderElection, Term } from '@zukhruf/election';
|
|
2
3
|
import type { FlightConnection, FlightConnector } from './connector.ts';
|
|
3
4
|
export interface ElectingConnectorOptions {
|
|
@@ -5,6 +6,8 @@ export interface ElectingConnectorOptions {
|
|
|
5
6
|
/** Only `campaign`: the connector never runs a backend's own steps, so an election of any backend fits. */
|
|
6
7
|
election: Pick<LeaderElection<unknown>, 'campaign'>;
|
|
7
8
|
pollInterval: number;
|
|
9
|
+
/** The clock of the waits and of the patience after a hang-up. */
|
|
10
|
+
clock: Clock;
|
|
8
11
|
/** Starts serving for a term this process just won. */
|
|
9
12
|
serve(term: Term): Promise<void>;
|
|
10
13
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"electing-connector.d.ts","sourceRoot":"","sources":["../../src/connection/electing-connector.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"electing-connector.d.ts","sourceRoot":"","sources":["../../src/connection/electing-connector.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,KAAK,EAAuB,MAAM,gBAAgB,CAAC;AACjE,OAAO,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAG9D,OAAO,KAAK,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAWxE,MAAM,WAAW,wBAAwB;IACvC,UAAU,EAAE,MAAM,CAAC;IACnB,2GAA2G;IAC3G,QAAQ,EAAE,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC,CAAC;IACpD,YAAY,EAAE,MAAM,CAAC;IACrB,kEAAkE;IAClE,KAAK,EAAE,KAAK,CAAC;IACb,uDAAuD;IACvD,KAAK,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAClC;AAED;;;;;GAKG;AACH,qBAAa,iBAAkB,YAAW,eAAe;;gBAG3C,OAAO,EAAE,wBAAwB;IAIvC,OAAO,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,gBAAgB,CAAC;CA6F9D"}
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import { once } from 'node:events';
|
|
2
2
|
import { connect } from 'node:net';
|
|
3
|
-
import {
|
|
4
|
-
import { untilAborted } from '@zukhruf/async';
|
|
3
|
+
import { delay, untilAborted } from '@zukhruf/async';
|
|
5
4
|
import { PROTOCOL_VERSION, greet } from "./handshake.js";
|
|
6
5
|
import { ProtocolVersionError } from "./protocol-version-error.js";
|
|
7
6
|
import { SocketConnection } from "./socket-connection.js";
|
|
@@ -22,7 +21,7 @@ export class ElectingConnector {
|
|
|
22
21
|
this.#options = options;
|
|
23
22
|
}
|
|
24
23
|
async connect(signal) {
|
|
25
|
-
const { socketPath, pollInterval } = this.#options;
|
|
24
|
+
const { socketPath, pollInterval, clock } = this.#options;
|
|
26
25
|
for (;;) {
|
|
27
26
|
const coordinator = await reachUnlessAborted(socketPath, signal);
|
|
28
27
|
if (coordinator) {
|
|
@@ -38,7 +37,7 @@ export class ElectingConnector {
|
|
|
38
37
|
return own;
|
|
39
38
|
}
|
|
40
39
|
else {
|
|
41
|
-
await
|
|
40
|
+
await delay(pollInterval, { clock, signal });
|
|
42
41
|
}
|
|
43
42
|
}
|
|
44
43
|
}
|
|
@@ -51,8 +50,8 @@ export class ElectingConnector {
|
|
|
51
50
|
* nothing listens.
|
|
52
51
|
*/
|
|
53
52
|
async #outlastHangUp(signal) {
|
|
54
|
-
const { socketPath, pollInterval } = this.#options;
|
|
55
|
-
const deadline = performance.now() + HANDSHAKE_PATIENCE;
|
|
53
|
+
const { socketPath, pollInterval, clock } = this.#options;
|
|
54
|
+
const deadline = clock.performance.now() + HANDSHAKE_PATIENCE;
|
|
56
55
|
for (;;) {
|
|
57
56
|
const term = await this.#campaign(0, signal);
|
|
58
57
|
if (term)
|
|
@@ -63,10 +62,10 @@ export class ElectingConnector {
|
|
|
63
62
|
const connection = await this.#follow(again, signal);
|
|
64
63
|
if (connection)
|
|
65
64
|
return connection;
|
|
66
|
-
if (performance.now() >= deadline) {
|
|
65
|
+
if (clock.performance.now() >= deadline) {
|
|
67
66
|
throw new ProtocolVersionError(PROTOCOL_VERSION, undefined);
|
|
68
67
|
}
|
|
69
|
-
await
|
|
68
|
+
await delay(pollInterval, { clock, signal });
|
|
70
69
|
}
|
|
71
70
|
}
|
|
72
71
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"electing-connector.js","sourceRoot":"","sources":["../../src/connection/electing-connector.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AACnC,OAAO,EAAe,OAAO,EAAE,MAAM,UAAU,CAAC;
|
|
1
|
+
{"version":3,"file":"electing-connector.js","sourceRoot":"","sources":["../../src/connection/electing-connector.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AACnC,OAAO,EAAe,OAAO,EAAE,MAAM,UAAU,CAAC;AAEhD,OAAO,EAAc,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAKjE,OAAO,EAAiB,gBAAgB,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACxE,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D;;;GAGG;AACH,MAAM,kBAAkB,GAAG,IAAI,CAAC;AAahC;;;;;GAKG;AACH,MAAM,OAAO,iBAAiB;IACnB,QAAQ,CAA2B;IAE5C,YAAY,OAAiC;QAC3C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,MAAmB;QAC/B,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC1D,SAAS,CAAC;YACR,MAAM,WAAW,GAAG,MAAM,kBAAkB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;YACjE,IAAI,WAAW,EAAE,CAAC;gBAChB,MAAM,UAAU,GACd,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;oBACzC,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;gBACtC,IAAI,UAAU;oBAAE,OAAO,UAAU,CAAC;YACpC,CAAC;YACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;YACxD,IAAI,IAAI,EAAE,CAAC;gBACT,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;gBACjD,IAAI,GAAG;oBAAE,OAAO,GAAG,CAAC;YACtB,CAAC;iBAAM,CAAC;gBACN,MAAM,KAAK,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;YAC/C,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,cAAc,CAClB,MAAmB;QAEnB,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC1D,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,kBAAkB,CAAC;QAC9D,SAAS,CAAC;YACR,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YAC7C,IAAI,IAAI;gBAAE,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAChD,MAAM,KAAK,GAAG,MAAM,kBAAkB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;YAC3D,IAAI,CAAC,KAAK;gBAAE,OAAO,SAAS,CAAC;YAC7B,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YACrD,IAAI,UAAU;gBAAE,OAAO,UAAU,CAAC;YAClC,IAAI,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,QAAQ,EAAE,CAAC;gBACxC,MAAM,IAAI,oBAAoB,CAAC,gBAAgB,EAAE,SAAS,CAAC,CAAC;YAC9D,CAAC;YACD,MAAM,KAAK,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,SAAS,CACb,OAAe,EACf,MAAmB;QAEnB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;QACxE,IAAI,MAAM,CAAC,OAAO;YAAE,MAAM,IAAI,EAAE,MAAM,EAAE,CAAC;QACzC,MAAM,CAAC,cAAc,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gGAAgG;IAChG,KAAK,CAAC,WAAW,CACf,IAAU,EACV,MAAmB;QAEnB,YAAY,OAAO,GAAG,IAAI,oBAAoB,EAAE,CAAC;QACjD,iFAAiF;QACjF,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QACnC,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAChC,OAAO,CAAC,IAAI,EAAE,CAAC;QACf,MAAM,GAAG,GAAG,MAAM,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QACvE,IAAI,CAAC,GAAG;YAAE,OAAO,SAAS,CAAC;QAC3B,MAAM,QAAQ,GAAG,MAAM,kBAAkB,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QACvD,IAAI,QAAQ,CAAC,IAAI,KAAK,SAAS;YAAE,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAC;QAC9D,GAAG,CAAC,OAAO,EAAE,CAAC;QACd,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,6GAA6G;IAC7G,KAAK,CAAC,OAAO,CACX,MAAc,EACd,MAAmB;QAEnB,MAAM,QAAQ,GAAG,MAAM,kBAAkB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC1D,IAAI,QAAQ,CAAC,IAAI,KAAK,SAAS;YAAE,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC;QACjE,MAAM,CAAC,OAAO,EAAE,CAAC;QACjB,IAAI,QAAQ,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,IAAI,oBAAoB,CAAC,gBAAgB,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;QACrE,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAED,SAAS,gBAAgB,CAAC,MAAc;IACtC,OAAO,IAAI,gBAAgB,CAAgB,MAAM,CAAC,CAAC;AACrD,CAAC;AAED,4FAA4F;AAC5F,KAAK,UAAU,kBAAkB,CAC/B,UAAkB,EAClB,MAAmB;IAEnB,MAAM,CAAC,cAAc,EAAE,CAAC;IACxB,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,CAAC;IACvC,IAAI,MAAM,CAAC,OAAO;QAAE,MAAM,EAAE,OAAO,EAAE,CAAC;IACtC,MAAM,CAAC,cAAc,EAAE,CAAC;IACxB,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,6FAA6F;AAC7F,KAAK,UAAU,KAAK,CAAC,UAAkB;IACrC,MAAM,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IACnC,IAAI,CAAC;QACH,MAAM,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAC9B,OAAO,MAAM,CAAC;IAChB,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,CAAC,OAAO,EAAE,CAAC;QACjB,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,8FAA8F;AAC9F,KAAK,UAAU,kBAAkB,CAC/B,MAAc,EACd,MAAmB;IAEnB,MAAM,QAAQ,GAAG,IAAI,eAAe,EAAE,CAAC;IACvC,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;IACvC,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC;IAC1D,QAAQ,CAAC,IAAI,EAAE,CAAC;IAChB,OAAO,OAAO,CAAC;AACjB,CAAC"}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { Clock } from '@zukhruf/async';
|
|
1
2
|
import { SqliteElection } from '@zukhruf/election';
|
|
2
3
|
/**
|
|
3
4
|
* The election of the single flights that share `directory`. Every published
|
|
@@ -7,5 +8,5 @@ import { SqliteElection } from '@zukhruf/election';
|
|
|
7
8
|
* `@zukhruf/mutex` names its files `leader.*`, so it never joins this
|
|
8
9
|
* election in a shared directory.
|
|
9
10
|
*/
|
|
10
|
-
export declare function flightElection(directory: string, pollInterval: number): SqliteElection;
|
|
11
|
+
export declare function flightElection(directory: string, pollInterval: number, clock: Clock): SqliteElection;
|
|
11
12
|
//# sourceMappingURL=flight-election.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"flight-election.d.ts","sourceRoot":"","sources":["../../src/connection/flight-election.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEnD;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC5B,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"flight-election.d.ts","sourceRoot":"","sources":["../../src/connection/flight-election.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEnD;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC5B,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,EACpB,KAAK,EAAE,KAAK,GACX,cAAc,CAQhB"}
|
|
@@ -7,12 +7,13 @@ import { SqliteElection } from '@zukhruf/election';
|
|
|
7
7
|
* `@zukhruf/mutex` names its files `leader.*`, so it never joins this
|
|
8
8
|
* election in a shared directory.
|
|
9
9
|
*/
|
|
10
|
-
export function flightElection(directory, pollInterval) {
|
|
10
|
+
export function flightElection(directory, pollInterval, clock) {
|
|
11
11
|
return new SqliteElection({
|
|
12
12
|
directory,
|
|
13
13
|
claimFile: 'flight.lock',
|
|
14
14
|
epochFile: 'flight.epoch',
|
|
15
15
|
pollInterval,
|
|
16
|
+
clock,
|
|
16
17
|
});
|
|
17
18
|
}
|
|
18
19
|
//# sourceMappingURL=flight-election.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"flight-election.js","sourceRoot":"","sources":["../../src/connection/flight-election.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"flight-election.js","sourceRoot":"","sources":["../../src/connection/flight-election.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEnD;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAC5B,SAAiB,EACjB,YAAoB,EACpB,KAAY;IAEZ,OAAO,IAAI,cAAc,CAAC;QACxB,SAAS;QACT,SAAS,EAAE,aAAa;QACxB,SAAS,EAAE,cAAc;QACzB,YAAY;QACZ,KAAK;KACN,CAAC,CAAC;AACL,CAAC"}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { type Clock } from '@zukhruf/async';
|
|
1
2
|
/**
|
|
2
3
|
* The kernel locks on the keys of one flight directory. The process that runs
|
|
3
4
|
* a key's work holds that key's lock, so the kernel keeps the key while the
|
|
@@ -10,7 +11,7 @@
|
|
|
10
11
|
*/
|
|
11
12
|
export declare class KeyLocks {
|
|
12
13
|
#private;
|
|
13
|
-
constructor(directory: string, pollInterval: number);
|
|
14
|
+
constructor(directory: string, pollInterval: number, clock: Clock);
|
|
14
15
|
/**
|
|
15
16
|
* Holds the lock of `key` until the result is disposed. The first try is
|
|
16
17
|
* synchronous, in the call; while another handle holds the lock, it tries
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"key-locks.d.ts","sourceRoot":"","sources":["../../src/key-lock/key-locks.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"key-locks.d.ts","sourceRoot":"","sources":["../../src/key-lock/key-locks.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,KAAK,EAAQ,MAAM,gBAAgB,CAAC;AAGlD;;;;;;;;;GASG;AACH,qBAAa,QAAQ;;gBAKP,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK;IAMjE;;;;;OAKG;IACG,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC;IAcpE;;;;OAIG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAI5B;;;;;OAKG;IACH,QAAQ,CACN,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,OAAO,EACrB,MAAM,EAAE,WAAW,GAClB,OAAO,CAAC,OAAO,CAAC;CAcpB"}
|
|
@@ -16,9 +16,11 @@ import { FileLock } from '@zukhruf/fs';
|
|
|
16
16
|
export class KeyLocks {
|
|
17
17
|
#folder;
|
|
18
18
|
#pollInterval;
|
|
19
|
-
|
|
19
|
+
#clock;
|
|
20
|
+
constructor(directory, pollInterval, clock) {
|
|
20
21
|
this.#folder = join(directory, 'execution-locks');
|
|
21
22
|
this.#pollInterval = pollInterval;
|
|
23
|
+
this.#clock = clock;
|
|
22
24
|
}
|
|
23
25
|
/**
|
|
24
26
|
* Holds the lock of `key` until the result is disposed. The first try is
|
|
@@ -34,6 +36,7 @@ export class KeyLocks {
|
|
|
34
36
|
await poll(async () => (lock.tryLock() ? lock : undefined), {
|
|
35
37
|
interval: this.#pollInterval,
|
|
36
38
|
signal,
|
|
39
|
+
clock: this.#clock,
|
|
37
40
|
});
|
|
38
41
|
opened.move();
|
|
39
42
|
return lock;
|
|
@@ -57,7 +60,7 @@ export class KeyLocks {
|
|
|
57
60
|
if (!wanted())
|
|
58
61
|
return false;
|
|
59
62
|
return this.isHeld(key) ? undefined : true;
|
|
60
|
-
}, { interval: this.#pollInterval, signal, ref: false });
|
|
63
|
+
}, { interval: this.#pollInterval, signal, clock: this.#clock, ref: false });
|
|
61
64
|
}
|
|
62
65
|
#pathOf(key) {
|
|
63
66
|
const digest = createHash('sha256').update(key).digest('hex');
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"key-locks.js","sourceRoot":"","sources":["../../src/key-lock/key-locks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,OAAO,
|
|
1
|
+
{"version":3,"file":"key-locks.js","sourceRoot":"","sources":["../../src/key-lock/key-locks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,OAAO,EAAc,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC;;;;;;;;;GASG;AACH,MAAM,OAAO,QAAQ;IACV,OAAO,CAAS;IAChB,aAAa,CAAS;IACtB,MAAM,CAAQ;IAEvB,YAAY,SAAiB,EAAE,YAAoB,EAAE,KAAY;QAC/D,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;QAClD,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAClC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CAAC,GAAW,EAAE,MAAmB;QAC5C,wFAAwF;QACxF,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC7C,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC1D,MAAM,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;YAC1D,QAAQ,EAAE,IAAI,CAAC,aAAa;YAC5B,MAAM;YACN,KAAK,EAAE,IAAI,CAAC,MAAM;SACnB,CAAC,CAAC;QACH,MAAM,CAAC,IAAI,EAAE,CAAC;QACd,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,GAAW;QAChB,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,QAAQ,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CACN,GAAW,EACX,MAAqB,EACrB,MAAmB;QAEnB,OAAO,IAAI,CACT,KAAK,IAAI,EAAE;YACT,IAAI,CAAC,MAAM,EAAE;gBAAE,OAAO,KAAK,CAAC;YAC5B,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC;QAC7C,CAAC,EACD,EAAE,QAAQ,EAAE,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,CACzE,CAAC;IACJ,CAAC;IAED,OAAO,CAAC,GAAW;QACjB,MAAM,MAAM,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC9D,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,MAAM,OAAO,CAAC,CAAC;IAC9C,CAAC;CACF"}
|
package/dist/single-flight.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { type Clock } from '@zukhruf/async';
|
|
1
2
|
import type { FencedLease } from '@zukhruf/fencing';
|
|
2
3
|
import type { Codec } from './codec.ts';
|
|
3
4
|
export interface SingleFlightOptions<T> {
|
|
@@ -13,6 +14,8 @@ export interface SingleFlightOptions<T> {
|
|
|
13
14
|
directory: string;
|
|
14
15
|
/** Turns the flight's value into text for the processes that joined it, and back. */
|
|
15
16
|
codec: Codec<T>;
|
|
17
|
+
/** The clock of every wait of the group: `globalThis` in production, a fake clock in a test. */
|
|
18
|
+
clock: Clock;
|
|
16
19
|
}
|
|
17
20
|
export interface RunOptions {
|
|
18
21
|
/** Called once, when this caller joins a flight that another caller leads. */
|
|
@@ -34,7 +37,7 @@ export interface FlightValue<T> {
|
|
|
34
37
|
*/
|
|
35
38
|
export declare class SingleFlight<T> implements AsyncDisposable {
|
|
36
39
|
#private;
|
|
37
|
-
constructor({ directory, codec }: SingleFlightOptions<T>);
|
|
40
|
+
constructor({ directory, codec, clock }: SingleFlightOptions<T>);
|
|
38
41
|
/**
|
|
39
42
|
* Runs `work` for `key` as the leader of a new flight, or joins the flight
|
|
40
43
|
* of `key` in progress. `work` gets the flight's lease: its token, and a
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"single-flight.d.ts","sourceRoot":"","sources":["../src/single-flight.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"single-flight.d.ts","sourceRoot":"","sources":["../src/single-flight.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,KAAK,EAAgB,MAAM,gBAAgB,CAAC;AAC1D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAIpD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAqBxC,MAAM,WAAW,mBAAmB,CAAC,CAAC;IACpC;;;;;;;;OAQG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,qFAAqF;IACrF,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAChB,gGAAgG;IAChG,KAAK,EAAE,KAAK,CAAC;CACd;AAED,MAAM,WAAW,UAAU;IACzB,8EAA8E;IAC9E,MAAM,CAAC,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,CAAC;IAClC,uGAAuG;IACvG,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;CAClC;AAED,mHAAmH;AACnH,MAAM,WAAW,WAAW,CAAC,CAAC;IAC5B,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;IAClB,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;CAC1B;AAKD;;;;;;GAMG;AACH,qBAAa,YAAY,CAAC,CAAC,CAAE,YAAW,eAAe;;gBAMzC,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,mBAAmB,CAAC,CAAC,CAAC;IAmC/D;;;;;;;;OAQG;IACG,GAAG,CACP,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,OAAO,CAAC,CAAC,CAAC,EACxC,EAAE,MAAM,EAAE,MAAM,EAAE,GAAE,UAAe,GAClC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAmB1B,gGAAgG;IAC1F,CAAC,MAAM,CAAC,YAAY,CAAC;CAuC5B"}
|
package/dist/single-flight.js
CHANGED
|
@@ -25,15 +25,16 @@ export class SingleFlight {
|
|
|
25
25
|
#codec;
|
|
26
26
|
/** The flight servers this process started; disposing closes them. */
|
|
27
27
|
#servers = new AsyncDisposableStack();
|
|
28
|
-
constructor({ directory, codec }) {
|
|
28
|
+
constructor({ directory, codec, clock }) {
|
|
29
29
|
this.#codec = codec;
|
|
30
30
|
const socketPath = socketPathFor(directory);
|
|
31
|
-
const election = flightElection(directory, POLL_INTERVAL);
|
|
32
|
-
const locks = new KeyLocks(directory, POLL_INTERVAL);
|
|
31
|
+
const election = flightElection(directory, POLL_INTERVAL, clock);
|
|
32
|
+
const locks = new KeyLocks(directory, POLL_INTERVAL, clock);
|
|
33
33
|
this.#client = new FlightClient(new ConnectionSupervisor(new LocalDirectoryConnector(directory, new ElectingConnector({
|
|
34
34
|
socketPath,
|
|
35
35
|
election,
|
|
36
36
|
pollInterval: POLL_INTERVAL,
|
|
37
|
+
clock,
|
|
37
38
|
serve: async (term) => {
|
|
38
39
|
// Until serving has fully started, a failure closes the new server, so no server outlives its term.
|
|
39
40
|
await using starting = new AsyncDisposableStack();
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"single-flight.js","sourceRoot":"","sources":["../src/single-flight.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"single-flight.js","sourceRoot":"","sources":["../src/single-flight.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE1D,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEhD,OAAO,EAAE,YAAY,EAAa,MAAM,2BAA2B,CAAC;AAEpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,uCAAuC,CAAC;AAC7E,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AACvE,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,uBAAuB,EAAE,MAAM,2CAA2C,CAAC;AACpF,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAC9D,OAAO,EACL,iBAAiB,EACjB,sBAAsB,EACtB,SAAS,GACV,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AAGnD,4GAA4G;AAC5G,MAAM,aAAa,GAAG,EAAE,CAAC;AAEzB,mHAAmH;AACnH,MAAM,aAAa,GAAG,GAAG,CAAC;AAmC1B;;;;;;GAMG;AACH,MAAM,OAAO,YAAY;IACd,OAAO,CAAe;IACtB,MAAM,CAAW;IAC1B,sEAAsE;IAC7D,QAAQ,GAAG,IAAI,oBAAoB,EAAE,CAAC;IAE/C,YAAY,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAA0B;QAC7D,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,MAAM,UAAU,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC;QAC5C,MAAM,QAAQ,GAAG,cAAc,CAAC,SAAS,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;QACjE,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,SAAS,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;QAC5D,IAAI,CAAC,OAAO,GAAG,IAAI,YAAY,CAC7B,IAAI,oBAAoB,CACtB,IAAI,uBAAuB,CACzB,SAAS,EACT,IAAI,iBAAiB,CAAC;YACpB,UAAU;YACV,QAAQ;YACR,YAAY,EAAE,aAAa;YAC3B,KAAK;YACL,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;gBACpB,oGAAoG;gBACpG,YAAY,QAAQ,GAAG,IAAI,oBAAoB,EAAE,CAAC;gBAClD,QAAQ,CAAC,KAAK,CACZ,MAAM,YAAY,CAAC,KAAK,CAAC,UAAU,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,EACrD,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,CAC7B,CAAC;gBACF,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;YACrC,CAAC;SACF,CAAC,CACH,CACF,EACD;YACE,KAAK;YACL,kFAAkF;YAClF,aAAa,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAC7B,CAAC,MAAM,QAAQ,CAAC,SAAS,EAAE,CAAC,IAAI,KAAK,CAAC,KAAK,IAAI,aAAa;SAC/D,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,GAAG,CACP,GAAW,EACX,IAAwC,EACxC,EAAE,MAAM,EAAE,MAAM,KAAiB,EAAE;QAEnC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;QAC/D,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;YACpB,KAAK,QAAQ;gBACX,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;YAClE,KAAK,aAAa;gBAChB,MAAM,IAAI,sBAAsB,CAAC,GAAG,CAAC,CAAC;YACxC,KAAK,MAAM,CAAC,CAAC,CAAC;gBACZ,gFAAgF;gBAChF,MAAM,OAAO,GAAG,MAAM,YAAY,CAChC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,EACjC,MAAM,CACP,CAAC;gBACF,IAAI,OAAO,IAAI,OAAO;oBAAE,MAAM,OAAO,CAAC,KAAK,CAAC;gBAC5C,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;YACjD,CAAC;QACH,CAAC;IACH,CAAC;IAED,gGAAgG;IAChG,KAAK,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC;QACzB,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QAC3B,MAAM,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAC;IACrC,CAAC;IAED,uHAAuH;IACvH,KAAK,CAAC,IAAI,CACR,GAAW,EACX,IAAwC,EACxC,IAAU;QAEV,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QACrC,IAAI,CAAC;YACH,IAAI,IAAY,CAAC;YACjB,IAAI,CAAC;gBACH,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YACjE,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBACzC,4HAA4H;gBAC5H,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,KAAK,KAAK,IAAI,CAAC,MAAM;oBAAE,OAAO,EAAE,KAAK,EAAE,CAAC;gBAC7D,OAAO,EAAE,KAAK,EAAE,IAAI,cAAc,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;YAC9D,CAAC;YACD,0FAA0F;YAC1F,IAAI,IAAI,CAAC,OAAO;gBAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;YAChD,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YAC3B,IAAI,CAAC;gBACH,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7C,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,EAAE,KAAK,EAAE,CAAC;YACnB,CAAC;QACH,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,CAAC;IACH,CAAC;IAED,KAAK,CAAC,GAAW,EAAE,OAAgB;QACjC,IAAI,SAAS,IAAI,OAAO;YAAE,MAAM,IAAI,iBAAiB,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAC5E,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;CACF"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@zukhruf/single-flight",
|
|
3
|
-
"version": "0.6.
|
|
3
|
+
"version": "0.6.14",
|
|
4
4
|
"description": "Callers of one key share the run already in flight, in one process or across the processes that use one directory, and get its outcome instead of a busy error.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
@@ -40,14 +40,14 @@
|
|
|
40
40
|
"access": "public"
|
|
41
41
|
},
|
|
42
42
|
"dependencies": {
|
|
43
|
-
"@zukhruf/async": "^0.6.
|
|
44
|
-
"@zukhruf/election": "^0.6.
|
|
45
|
-
"@zukhruf/fencing": "^0.6.
|
|
46
|
-
"@zukhruf/fs": "^0.6.
|
|
47
|
-
"@zukhruf/lease": "^0.6.
|
|
43
|
+
"@zukhruf/async": "^0.6.14",
|
|
44
|
+
"@zukhruf/election": "^0.6.14",
|
|
45
|
+
"@zukhruf/fencing": "^0.6.14",
|
|
46
|
+
"@zukhruf/fs": "^0.6.14",
|
|
47
|
+
"@zukhruf/lease": "^0.6.14"
|
|
48
48
|
},
|
|
49
49
|
"devDependencies": {
|
|
50
|
-
"@zukhruf/mutex": "^0.6.
|
|
51
|
-
"@zukhruf/testing": "^0.6.
|
|
50
|
+
"@zukhruf/mutex": "^0.6.14",
|
|
51
|
+
"@zukhruf/testing": "^0.6.14"
|
|
52
52
|
}
|
|
53
53
|
}
|