velocious 1.0.699 → 1.0.700
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 +1 -2
- package/build/configuration-types.js +11 -0
- package/build/configuration.js +122 -1
- package/build/database/advisory-lock-backend-policy.js +204 -0
- package/build/database/advisory-lock-file-backend.js +348 -0
- package/build/database/advisory-lock-runner.js +239 -16
- package/build/environment-handlers/base.js +13 -0
- package/build/environment-handlers/node.js +11 -0
- package/build/http-server/server-lock.js +21 -115
- package/build/src/configuration-types.d.ts +31 -0
- package/build/src/configuration-types.d.ts.map +1 -1
- package/build/src/configuration-types.js +11 -1
- package/build/src/configuration.d.ts +88 -1
- package/build/src/configuration.d.ts.map +1 -1
- package/build/src/configuration.js +112 -2
- package/build/src/database/advisory-lock-backend-policy.d.ts +145 -0
- package/build/src/database/advisory-lock-backend-policy.d.ts.map +1 -0
- package/build/src/database/advisory-lock-backend-policy.js +184 -0
- package/build/src/database/advisory-lock-file-backend.d.ts +194 -0
- package/build/src/database/advisory-lock-file-backend.d.ts.map +1 -0
- package/build/src/database/advisory-lock-file-backend.js +313 -0
- package/build/src/database/advisory-lock-runner.d.ts +116 -15
- package/build/src/database/advisory-lock-runner.d.ts.map +1 -1
- package/build/src/database/advisory-lock-runner.js +190 -17
- package/build/src/environment-handlers/base.d.ts +14 -0
- package/build/src/environment-handlers/base.d.ts.map +1 -1
- package/build/src/environment-handlers/base.js +13 -1
- package/build/src/environment-handlers/node.d.ts +11 -0
- package/build/src/environment-handlers/node.d.ts.map +1 -1
- package/build/src/environment-handlers/node.js +11 -1
- package/build/src/http-server/server-lock.d.ts +13 -37
- package/build/src/http-server/server-lock.d.ts.map +1 -1
- package/build/src/http-server/server-lock.js +22 -109
- package/package.json +1 -1
- package/src/configuration-types.js +11 -0
- package/src/configuration.js +122 -1
- package/src/database/advisory-lock-backend-policy.js +204 -0
- package/src/database/advisory-lock-file-backend.js +348 -0
- package/src/database/advisory-lock-runner.js +239 -16
- package/src/environment-handlers/base.js +13 -0
- package/src/environment-handlers/node.js +11 -0
- package/src/http-server/server-lock.js +21 -115
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
export type AdvisoryLockTier = "process-local" | "file" | "driver-native" | "lock-server";
|
|
2
|
+
export type AdvisoryLockBackendPolicyEntry = {
|
|
3
|
+
/**
|
|
4
|
+
* - Lock name or `*`-suffixed glob pattern (e.g. `background_jobs:*`).
|
|
5
|
+
*/
|
|
6
|
+
name: string;
|
|
7
|
+
/**
|
|
8
|
+
* - Weakest tier this name may ever be served by. Defaults to `driver-native` (default-deny).
|
|
9
|
+
*/
|
|
10
|
+
minTier?: AdvisoryLockTier;
|
|
11
|
+
/**
|
|
12
|
+
* - Explicit whitelist of servable tiers. Defaults to every tier at or above `minTier`.
|
|
13
|
+
*/
|
|
14
|
+
allowedTiers?: AdvisoryLockTier[];
|
|
15
|
+
/**
|
|
16
|
+
* - Tier used when available; falling below it triggers the fallback report (§3). Defaults to `driver-native`.
|
|
17
|
+
*/
|
|
18
|
+
preferredTier?: AdvisoryLockTier;
|
|
19
|
+
};
|
|
20
|
+
export type ResolvedAdvisoryLockBackendPolicy = {
|
|
21
|
+
/**
|
|
22
|
+
* - Weakest tier this name may be served by.
|
|
23
|
+
*/
|
|
24
|
+
minTier: AdvisoryLockTier;
|
|
25
|
+
/**
|
|
26
|
+
* - Tiers that may serve this name (minimum-closed).
|
|
27
|
+
*/
|
|
28
|
+
allowedTiers: AdvisoryLockTier[];
|
|
29
|
+
/**
|
|
30
|
+
* - Tier preferred when available.
|
|
31
|
+
*/
|
|
32
|
+
preferredTier: AdvisoryLockTier;
|
|
33
|
+
/**
|
|
34
|
+
* - The matched configuration entry, or null for the default policy.
|
|
35
|
+
*/
|
|
36
|
+
entry: AdvisoryLockBackendPolicyEntry | null;
|
|
37
|
+
};
|
|
38
|
+
/**
|
|
39
|
+
* Advisory-lock backend tiers (STC-210 design, `docs/advisory-lock-backends.md` §1/§9).
|
|
40
|
+
* `process-local` and `file` are host-local; `driver-native` and `lock-server` are
|
|
41
|
+
* cross-host. Tier strength order (strongest first):
|
|
42
|
+
* `lock-server` ≡ `driver-native` > `file` > `process-local`.
|
|
43
|
+
* @typedef {"process-local" | "file" | "driver-native" | "lock-server"} AdvisoryLockTier
|
|
44
|
+
*/
|
|
45
|
+
/**
|
|
46
|
+
* One per-lock-name backend policy entry as declared in configuration (§5).
|
|
47
|
+
* @typedef {object} AdvisoryLockBackendPolicyEntry
|
|
48
|
+
* @property {string} name - Lock name or `*`-suffixed glob pattern (e.g. `background_jobs:*`).
|
|
49
|
+
* @property {AdvisoryLockTier} [minTier] - Weakest tier this name may ever be served by. Defaults to `driver-native` (default-deny).
|
|
50
|
+
* @property {AdvisoryLockTier[]} [allowedTiers] - Explicit whitelist of servable tiers. Defaults to every tier at or above `minTier`.
|
|
51
|
+
* @property {AdvisoryLockTier} [preferredTier] - Tier used when available; falling below it triggers the fallback report (§3). Defaults to `driver-native`.
|
|
52
|
+
*/
|
|
53
|
+
/**
|
|
54
|
+
* Policy resolved for one concrete lock name, with tier gaps already closed:
|
|
55
|
+
* `allowedTiers` always contains every tier at or above `minTier`, so a
|
|
56
|
+
* cross-host-minimum name can never be served by `file` or `process-local`.
|
|
57
|
+
* @typedef {object} ResolvedAdvisoryLockBackendPolicy
|
|
58
|
+
* @property {AdvisoryLockTier} minTier - Weakest tier this name may be served by.
|
|
59
|
+
* @property {AdvisoryLockTier[]} allowedTiers - Tiers that may serve this name (minimum-closed).
|
|
60
|
+
* @property {AdvisoryLockTier} preferredTier - Tier preferred when available.
|
|
61
|
+
* @property {AdvisoryLockBackendPolicyEntry | null} entry - The matched configuration entry, or null for the default policy.
|
|
62
|
+
*/
|
|
63
|
+
/**
|
|
64
|
+
* Thrown when an acquisition would have to be served by a tier below the
|
|
65
|
+
* lock name's declared minimum tier. Fail-closed refusal (§9): the name is
|
|
66
|
+
* never served by the weaker tier, and the refusal is reported on the
|
|
67
|
+
* framework-error channel as `advisory-lock-min-tier-refused`.
|
|
68
|
+
*/
|
|
69
|
+
export declare class AdvisoryLockMinTierRefusedError extends Error {
|
|
70
|
+
lockName: string;
|
|
71
|
+
requestedBackend: AdvisoryLockTier;
|
|
72
|
+
minTier: AdvisoryLockTier;
|
|
73
|
+
/**
|
|
74
|
+
* Runs constructor.
|
|
75
|
+
* @param {string} message - Error message.
|
|
76
|
+
* @param {{lockName: string, requestedBackend: AdvisoryLockTier, minTier: AdvisoryLockTier}} args - Refusal details.
|
|
77
|
+
*/
|
|
78
|
+
constructor(message: string, { lockName, requestedBackend, minTier }: {
|
|
79
|
+
lockName: string;
|
|
80
|
+
requestedBackend: AdvisoryLockTier;
|
|
81
|
+
minTier: AdvisoryLockTier;
|
|
82
|
+
});
|
|
83
|
+
}
|
|
84
|
+
/**
|
|
85
|
+
* Thrown when no enabled backend that satisfies the lock name's minimum tier
|
|
86
|
+
* is available (§9). Distinct from `AdvisoryLockTimeoutError` (a backend
|
|
87
|
+
* served the wait but the holder never released).
|
|
88
|
+
*/
|
|
89
|
+
export declare class AdvisoryLockBackendUnavailableError extends Error {
|
|
90
|
+
lockName: string;
|
|
91
|
+
minTier: AdvisoryLockTier;
|
|
92
|
+
reasons: string[];
|
|
93
|
+
/**
|
|
94
|
+
* Runs constructor.
|
|
95
|
+
* @param {string} message - Error message.
|
|
96
|
+
* @param {{lockName: string, minTier: AdvisoryLockTier, reasons: string[]}} args - Unavailability details.
|
|
97
|
+
*/
|
|
98
|
+
constructor(message: string, { lockName, minTier, reasons }: {
|
|
99
|
+
lockName: string;
|
|
100
|
+
minTier: AdvisoryLockTier;
|
|
101
|
+
reasons: string[];
|
|
102
|
+
});
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* Runs tier rank.
|
|
106
|
+
* @param {AdvisoryLockTier} tier - Tier to rank.
|
|
107
|
+
* @returns {number} - Strength rank (higher is stronger).
|
|
108
|
+
*/
|
|
109
|
+
export declare function advisoryLockTierRank(tier: AdvisoryLockTier): number;
|
|
110
|
+
/**
|
|
111
|
+
* Runs tier is at least as strong as.
|
|
112
|
+
* @param {AdvisoryLockTier} tier - Candidate serving tier.
|
|
113
|
+
* @param {AdvisoryLockTier} minimum - Required minimum tier.
|
|
114
|
+
* @returns {boolean} - Whether `tier` satisfies the minimum.
|
|
115
|
+
*/
|
|
116
|
+
export declare function advisoryLockTierSatisfies(tier: AdvisoryLockTier, minimum: AdvisoryLockTier): boolean;
|
|
117
|
+
/**
|
|
118
|
+
* Resolves the effective backend policy for one concrete lock name:
|
|
119
|
+
* longest-prefix glob match over the configured entries (exact names win),
|
|
120
|
+
* default-deny for undeclared names (`minTier: driver-native`,
|
|
121
|
+
* `preferredTier: driver-native`), and `allowedTiers` closed upward so a
|
|
122
|
+
* cross-host minimum can never be served by a host-local tier.
|
|
123
|
+
* @param {string} lockName - Concrete lock name.
|
|
124
|
+
* @param {AdvisoryLockBackendPolicyEntry[] | undefined} policy - Configured policy entries.
|
|
125
|
+
* @returns {ResolvedAdvisoryLockBackendPolicy} - Resolved policy.
|
|
126
|
+
*/
|
|
127
|
+
export declare function resolveAdvisoryLockBackendPolicy(lockName: string, policy: AdvisoryLockBackendPolicyEntry[] | undefined): ResolvedAdvisoryLockBackendPolicy;
|
|
128
|
+
/**
|
|
129
|
+
* Refuses a downgrade below the lock name's minimum tier before any contact
|
|
130
|
+
* with the weaker backend (§9), reporting the refusal on the framework-error
|
|
131
|
+
* channel so a silent downgrade is impossible to hide.
|
|
132
|
+
* @param {object} args - Refusal args.
|
|
133
|
+
* @param {import("../configuration.js").default} args.configuration - Configuration owning the error channel.
|
|
134
|
+
* @param {string} args.lockName - Lock name.
|
|
135
|
+
* @param {AdvisoryLockTier} args.requestedBackend - Tier the acquisition would fall to.
|
|
136
|
+
* @param {AdvisoryLockTier} args.minTier - Declared minimum tier.
|
|
137
|
+
* @returns {never} - Always throws.
|
|
138
|
+
*/
|
|
139
|
+
export declare function refuseAdvisoryLockTierBelowMinimum({ configuration, lockName, requestedBackend, minTier }: {
|
|
140
|
+
configuration: import("../configuration.js").default;
|
|
141
|
+
lockName: string;
|
|
142
|
+
requestedBackend: AdvisoryLockTier;
|
|
143
|
+
minTier: AdvisoryLockTier;
|
|
144
|
+
}): never;
|
|
145
|
+
//# sourceMappingURL=advisory-lock-backend-policy.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"advisory-lock-backend-policy.d.ts","sourceRoot":"","sources":["../../../src/database/advisory-lock-backend-policy.js"],"names":[],"mappings":"AAOG,YAAsE,gBAAgB,GAA5E,eAAe,GAAG,MAAM,GAAG,eAAe,GAAG,aAAa,CAAkB;AAItF,YAAkB,8BAA8B,GAChD;;;;IAAmB,IAAI,EAAZ,MAAM,CACjB;;;;IAA8B,OAAO,AAArC,CACA,EADW,gBAAgB,CAC3B;;;;IAAgC,YAAY,AAA5C,CACA,EADW,gBAAgB,EAAE,CAC7B;;;;IAA8B,aAAa,AAA3C,CACF,EADa,gBAAgB,CAC7B;CAAA,CAAA;AAKE,YAAkB,iCAAiC,GACnD;;;;IAA6B,OAAO,EAAzB,gBAAgB,CAC3B;;;;IAA+B,YAAY,EAAhC,gBAAgB,EAAE,CAC7B;;;;IAA6B,aAAa,EAA/B,gBAAgB,CAC3B;;;;IAAkD,KAAK,EAA5C,8BAA8B,GAAG,IAAI,CAClD;CAAA,CAAA;AAxBD;;;;;;GAMG;AACH;;;;;;;GAOG;AACH;;;;;;;;;GASG;AAEH;;;;;GAKG;AACH,qBAAa,+BAAgC,SAAQ,KAAK;IASjD,QAAQ;IACR,gBAAgB;IAChB,OAAO;IAVd;;;;OAIG;IACH,YAAY,OAAO,EAHR,MAGQ,EAAE,EAAC,QAAQ,EAAE,gBAAgB,EAAE,OAAO,EAAC,EAF/C;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,gBAAgB,EAAE,gBAAgB,CAAC;QAAC,OAAO,EAAE,gBAAgB,CAAA;KAEjC,EAMzD;CACF;AAED;;;;GAIG;AACH,qBAAa,mCAAoC,SAAQ,KAAK;IASrD,QAAQ;IACR,OAAO;IACP,OAAO;IAVd;;;;OAIG;IACH,YAAY,OAAO,EAHR,MAGQ,EAAE,EAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAC,EAFtC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,gBAAgB,CAAC;QAAC,OAAO,EAAE,MAAM,EAAE,CAAA;KAEzB,EAMhD;CACF;AAgBD;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAH9B,gBAG8B,GAF5B,MAAM,CAQlB;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,IAAI,EAJnC,gBAImC,EAAE,OAAO,EAH5C,gBAG4C,GAF1C,OAAO,CAInB;AAED;;;;;;;;;GASG;AACH,wBAAgB,gCAAgC,CAAC,QAAQ,EAJ9C,MAI8C,EAAE,MAAM,EAHtD,8BAA8B,EAAE,GAAG,SAGmB,GAFpD,iCAAiC,CAsB7C;AAiCD;;;;;;;;;;GAUG;AACH,wBAAgB,kCAAkC,CAAC,EAAC,aAAa,EAAE,QAAQ,EAAE,gBAAgB,EAAE,OAAO,EAAC,EANpG;IAAoD,aAAa,EAAzD,OAAO,qBAAqB,EAAE,OAAO,CAC7C;IAAqB,QAAQ,EAArB,MAAM,CACd;IAA+B,gBAAgB,EAAvC,gBAAgB,CACxB;IAA+B,OAAO,EAA9B,gBAAgB,CACxB;CAEoG,GAF1F,KAAK,CAyBjB"}
|
|
@@ -0,0 +1,184 @@
|
|
|
1
|
+
// @ts-check
|
|
2
|
+
/**
|
|
3
|
+
* Advisory-lock backend tiers (STC-210 design, `docs/advisory-lock-backends.md` §1/§9).
|
|
4
|
+
* `process-local` and `file` are host-local; `driver-native` and `lock-server` are
|
|
5
|
+
* cross-host. Tier strength order (strongest first):
|
|
6
|
+
* `lock-server` ≡ `driver-native` > `file` > `process-local`.
|
|
7
|
+
* @typedef {"process-local" | "file" | "driver-native" | "lock-server"} AdvisoryLockTier
|
|
8
|
+
*/
|
|
9
|
+
/**
|
|
10
|
+
* One per-lock-name backend policy entry as declared in configuration (§5).
|
|
11
|
+
* @typedef {object} AdvisoryLockBackendPolicyEntry
|
|
12
|
+
* @property {string} name - Lock name or `*`-suffixed glob pattern (e.g. `background_jobs:*`).
|
|
13
|
+
* @property {AdvisoryLockTier} [minTier] - Weakest tier this name may ever be served by. Defaults to `driver-native` (default-deny).
|
|
14
|
+
* @property {AdvisoryLockTier[]} [allowedTiers] - Explicit whitelist of servable tiers. Defaults to every tier at or above `minTier`.
|
|
15
|
+
* @property {AdvisoryLockTier} [preferredTier] - Tier used when available; falling below it triggers the fallback report (§3). Defaults to `driver-native`.
|
|
16
|
+
*/
|
|
17
|
+
/**
|
|
18
|
+
* Policy resolved for one concrete lock name, with tier gaps already closed:
|
|
19
|
+
* `allowedTiers` always contains every tier at or above `minTier`, so a
|
|
20
|
+
* cross-host-minimum name can never be served by `file` or `process-local`.
|
|
21
|
+
* @typedef {object} ResolvedAdvisoryLockBackendPolicy
|
|
22
|
+
* @property {AdvisoryLockTier} minTier - Weakest tier this name may be served by.
|
|
23
|
+
* @property {AdvisoryLockTier[]} allowedTiers - Tiers that may serve this name (minimum-closed).
|
|
24
|
+
* @property {AdvisoryLockTier} preferredTier - Tier preferred when available.
|
|
25
|
+
* @property {AdvisoryLockBackendPolicyEntry | null} entry - The matched configuration entry, or null for the default policy.
|
|
26
|
+
*/
|
|
27
|
+
/**
|
|
28
|
+
* Thrown when an acquisition would have to be served by a tier below the
|
|
29
|
+
* lock name's declared minimum tier. Fail-closed refusal (§9): the name is
|
|
30
|
+
* never served by the weaker tier, and the refusal is reported on the
|
|
31
|
+
* framework-error channel as `advisory-lock-min-tier-refused`.
|
|
32
|
+
*/
|
|
33
|
+
export class AdvisoryLockMinTierRefusedError extends Error {
|
|
34
|
+
/**
|
|
35
|
+
* Runs constructor.
|
|
36
|
+
* @param {string} message - Error message.
|
|
37
|
+
* @param {{lockName: string, requestedBackend: AdvisoryLockTier, minTier: AdvisoryLockTier}} args - Refusal details.
|
|
38
|
+
*/
|
|
39
|
+
constructor(message, { lockName, requestedBackend, minTier }) {
|
|
40
|
+
super(message);
|
|
41
|
+
this.name = "AdvisoryLockMinTierRefusedError";
|
|
42
|
+
this.lockName = lockName;
|
|
43
|
+
this.requestedBackend = requestedBackend;
|
|
44
|
+
this.minTier = minTier;
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* Thrown when no enabled backend that satisfies the lock name's minimum tier
|
|
49
|
+
* is available (§9). Distinct from `AdvisoryLockTimeoutError` (a backend
|
|
50
|
+
* served the wait but the holder never released).
|
|
51
|
+
*/
|
|
52
|
+
export class AdvisoryLockBackendUnavailableError extends Error {
|
|
53
|
+
/**
|
|
54
|
+
* Runs constructor.
|
|
55
|
+
* @param {string} message - Error message.
|
|
56
|
+
* @param {{lockName: string, minTier: AdvisoryLockTier, reasons: string[]}} args - Unavailability details.
|
|
57
|
+
*/
|
|
58
|
+
constructor(message, { lockName, minTier, reasons }) {
|
|
59
|
+
super(message);
|
|
60
|
+
this.name = "AdvisoryLockBackendUnavailableError";
|
|
61
|
+
this.lockName = lockName;
|
|
62
|
+
this.minTier = minTier;
|
|
63
|
+
this.reasons = reasons;
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* Tier strength ranks (§9): higher rank is stronger. `lock-server` and
|
|
68
|
+
* `driver-native` are both cross-host and rank equal.
|
|
69
|
+
* @type {Record<AdvisoryLockTier, number>} */
|
|
70
|
+
const TIER_RANKS = {
|
|
71
|
+
"driver-native": 2,
|
|
72
|
+
file: 1,
|
|
73
|
+
"lock-server": 3,
|
|
74
|
+
"process-local": 0
|
|
75
|
+
};
|
|
76
|
+
/** All tiers ordered strongest-first. */
|
|
77
|
+
const TIERS_STRONGEST_FIRST = /** @type {AdvisoryLockTier[]} */ (["lock-server", "driver-native", "file", "process-local"]);
|
|
78
|
+
/**
|
|
79
|
+
* Runs tier rank.
|
|
80
|
+
* @param {AdvisoryLockTier} tier - Tier to rank.
|
|
81
|
+
* @returns {number} - Strength rank (higher is stronger).
|
|
82
|
+
*/
|
|
83
|
+
export function advisoryLockTierRank(tier) {
|
|
84
|
+
const rank = TIER_RANKS[tier];
|
|
85
|
+
if (rank === undefined)
|
|
86
|
+
throw new Error(`Unknown advisory-lock tier ${JSON.stringify(String(tier))}`);
|
|
87
|
+
return rank;
|
|
88
|
+
}
|
|
89
|
+
/**
|
|
90
|
+
* Runs tier is at least as strong as.
|
|
91
|
+
* @param {AdvisoryLockTier} tier - Candidate serving tier.
|
|
92
|
+
* @param {AdvisoryLockTier} minimum - Required minimum tier.
|
|
93
|
+
* @returns {boolean} - Whether `tier` satisfies the minimum.
|
|
94
|
+
*/
|
|
95
|
+
export function advisoryLockTierSatisfies(tier, minimum) {
|
|
96
|
+
return advisoryLockTierRank(tier) >= advisoryLockTierRank(minimum);
|
|
97
|
+
}
|
|
98
|
+
/**
|
|
99
|
+
* Resolves the effective backend policy for one concrete lock name:
|
|
100
|
+
* longest-prefix glob match over the configured entries (exact names win),
|
|
101
|
+
* default-deny for undeclared names (`minTier: driver-native`,
|
|
102
|
+
* `preferredTier: driver-native`), and `allowedTiers` closed upward so a
|
|
103
|
+
* cross-host minimum can never be served by a host-local tier.
|
|
104
|
+
* @param {string} lockName - Concrete lock name.
|
|
105
|
+
* @param {AdvisoryLockBackendPolicyEntry[] | undefined} policy - Configured policy entries.
|
|
106
|
+
* @returns {ResolvedAdvisoryLockBackendPolicy} - Resolved policy.
|
|
107
|
+
*/
|
|
108
|
+
export function resolveAdvisoryLockBackendPolicy(lockName, policy) {
|
|
109
|
+
const entry = matchAdvisoryLockPolicyEntry(lockName, policy);
|
|
110
|
+
const minTier = entry?.minTier ?? "driver-native";
|
|
111
|
+
const preferredTier = entry?.preferredTier ?? "driver-native";
|
|
112
|
+
// §9: eligibility filters to tier strength >= minTier even when a weaker
|
|
113
|
+
// tier was declared in `allowedTiers` — a cross-host minimum can never be
|
|
114
|
+
// served by `file` or `process-local`. A `preferredTier` below the minimum
|
|
115
|
+
// stays visible here so the runner can refuse it loudly before contacting
|
|
116
|
+
// the weaker backend.
|
|
117
|
+
const declaredAllowed = entry?.allowedTiers;
|
|
118
|
+
const allowedTiers = TIERS_STRONGEST_FIRST.filter((tier) => {
|
|
119
|
+
if (!advisoryLockTierSatisfies(tier, minTier))
|
|
120
|
+
return false;
|
|
121
|
+
if (!Array.isArray(declaredAllowed))
|
|
122
|
+
return true;
|
|
123
|
+
return declaredAllowed.includes(tier);
|
|
124
|
+
});
|
|
125
|
+
return { allowedTiers, entry: entry ?? null, minTier, preferredTier };
|
|
126
|
+
}
|
|
127
|
+
/**
|
|
128
|
+
* Matches one policy entry for a lock name: exact `name` matches win;
|
|
129
|
+
* otherwise the longest `*`-suffixed prefix pattern wins.
|
|
130
|
+
* @param {string} lockName - Concrete lock name.
|
|
131
|
+
* @param {AdvisoryLockBackendPolicyEntry[] | undefined} policy - Configured policy entries.
|
|
132
|
+
* @returns {AdvisoryLockBackendPolicyEntry | null} - Matched entry or null.
|
|
133
|
+
*/
|
|
134
|
+
function matchAdvisoryLockPolicyEntry(lockName, policy) {
|
|
135
|
+
if (!Array.isArray(policy))
|
|
136
|
+
return null;
|
|
137
|
+
let bestPrefixMatch = null;
|
|
138
|
+
let bestPrefixLength = -1;
|
|
139
|
+
for (const entry of policy) {
|
|
140
|
+
if (typeof entry?.name !== "string")
|
|
141
|
+
continue;
|
|
142
|
+
if (entry.name === lockName)
|
|
143
|
+
return entry;
|
|
144
|
+
if (entry.name.endsWith("*")) {
|
|
145
|
+
const prefix = entry.name.slice(0, -1);
|
|
146
|
+
if (lockName.startsWith(prefix) && prefix.length > bestPrefixLength) {
|
|
147
|
+
bestPrefixMatch = entry;
|
|
148
|
+
bestPrefixLength = prefix.length;
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
return bestPrefixMatch;
|
|
153
|
+
}
|
|
154
|
+
/**
|
|
155
|
+
* Refuses a downgrade below the lock name's minimum tier before any contact
|
|
156
|
+
* with the weaker backend (§9), reporting the refusal on the framework-error
|
|
157
|
+
* channel so a silent downgrade is impossible to hide.
|
|
158
|
+
* @param {object} args - Refusal args.
|
|
159
|
+
* @param {import("../configuration.js").default} args.configuration - Configuration owning the error channel.
|
|
160
|
+
* @param {string} args.lockName - Lock name.
|
|
161
|
+
* @param {AdvisoryLockTier} args.requestedBackend - Tier the acquisition would fall to.
|
|
162
|
+
* @param {AdvisoryLockTier} args.minTier - Declared minimum tier.
|
|
163
|
+
* @returns {never} - Always throws.
|
|
164
|
+
*/
|
|
165
|
+
export function refuseAdvisoryLockTierBelowMinimum({ configuration, lockName, requestedBackend, minTier }) {
|
|
166
|
+
const error = new AdvisoryLockMinTierRefusedError(`Advisory lock ${JSON.stringify(lockName)} requires minimum tier ${JSON.stringify(minTier)}; the ${JSON.stringify(requestedBackend)} tier is refused. Enable a cross-host backend or declare minTier: "file" for this lock name (single-host deployments only).`, { lockName, minTier, requestedBackend });
|
|
167
|
+
configuration.getErrorEvents().emit("framework-error", {
|
|
168
|
+
context: "advisory-lock-min-tier-refused",
|
|
169
|
+
error,
|
|
170
|
+
lockName,
|
|
171
|
+
minTier,
|
|
172
|
+
requestedBackend
|
|
173
|
+
});
|
|
174
|
+
configuration.getErrorEvents().emit("all-error", {
|
|
175
|
+
context: "advisory-lock-min-tier-refused",
|
|
176
|
+
error,
|
|
177
|
+
errorType: "framework-error",
|
|
178
|
+
lockName,
|
|
179
|
+
minTier,
|
|
180
|
+
requestedBackend
|
|
181
|
+
});
|
|
182
|
+
throw error;
|
|
183
|
+
}
|
|
184
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"advisory-lock-backend-policy.js","sourceRoot":"","sources":["../../../src/database/advisory-lock-backend-policy.js"],"names":[],"mappings":"AAAA,YAAY;AAEZ;;;;;;GAMG;AACH;;;;;;;GAOG;AACH;;;;;;;;;GASG;AAEH;;;;;GAKG;AACH,MAAM,OAAO,+BAAgC,SAAQ,KAAK;IACxD;;;;OAIG;IACH,YAAY,OAAO,EAAE,EAAC,QAAQ,EAAE,gBAAgB,EAAE,OAAO,EAAC;QACxD,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,iCAAiC,CAAA;QAC7C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACxB,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAA;QACxC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,mCAAoC,SAAQ,KAAK;IAC5D;;;;OAIG;IACH,YAAY,OAAO,EAAE,EAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAC;QAC/C,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,qCAAqC,CAAA;QACjD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACxB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;CACF;AAED;;;8CAG8C;AAC9C,MAAM,UAAU,GAAG;IACjB,eAAe,EAAE,CAAC;IAClB,IAAI,EAAE,CAAC;IACP,aAAa,EAAE,CAAC;IAChB,eAAe,EAAE,CAAC;CACnB,CAAA;AAED,yCAAyC;AACzC,MAAM,qBAAqB,GAAG,iCAAiC,CAAC,CAAC,CAAC,aAAa,EAAE,eAAe,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC,CAAA;AAE3H;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAAC,IAAI;IACvC,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,CAAA;IAE7B,IAAI,IAAI,KAAK,SAAS;QAAE,MAAM,IAAI,KAAK,CAAC,8BAA8B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAA;IAErG,OAAO,IAAI,CAAA;AACb,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,yBAAyB,CAAC,IAAI,EAAE,OAAO;IACrD,OAAO,oBAAoB,CAAC,IAAI,CAAC,IAAI,oBAAoB,CAAC,OAAO,CAAC,CAAA;AACpE,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,gCAAgC,CAAC,QAAQ,EAAE,MAAM;IAC/D,MAAM,KAAK,GAAG,4BAA4B,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;IAC5D,MAAM,OAAO,GAAG,KAAK,EAAE,OAAO,IAAI,eAAe,CAAA;IACjD,MAAM,aAAa,GAAG,KAAK,EAAE,aAAa,IAAI,eAAe,CAAA;IAE7D,yEAAyE;IACzE,0EAA0E;IAC1E,2EAA2E;IAC3E,0EAA0E;IAC1E,sBAAsB;IACtB,MAAM,eAAe,GAAG,KAAK,EAAE,YAAY,CAAA;IAC3C,MAAM,YAAY,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;QACzD,IAAI,CAAC,yBAAyB,CAAC,IAAI,EAAE,OAAO,CAAC;YAAE,OAAO,KAAK,CAAA;QAE3D,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC;YAAE,OAAO,IAAI,CAAA;QAEhD,OAAO,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;IACvC,CAAC,CAAC,CAAA;IAEF,OAAO,EAAC,YAAY,EAAE,KAAK,EAAE,KAAK,IAAI,IAAI,EAAE,OAAO,EAAE,aAAa,EAAC,CAAA;AACrE,CAAC;AAED;;;;;;GAMG;AACH,SAAS,4BAA4B,CAAC,QAAQ,EAAE,MAAM;IACpD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;QAAE,OAAO,IAAI,CAAA;IAEvC,IAAI,eAAe,GAAG,IAAI,CAAA;IAC1B,IAAI,gBAAgB,GAAG,CAAC,CAAC,CAAA;IAEzB,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,OAAO,KAAK,EAAE,IAAI,KAAK,QAAQ;YAAE,SAAQ;QAE7C,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAA;QAEzC,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC7B,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;YAEtC,IAAI,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,gBAAgB,EAAE,CAAC;gBACpE,eAAe,GAAG,KAAK,CAAA;gBACvB,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAA;YAClC,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,eAAe,CAAA;AACxB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,kCAAkC,CAAC,EAAC,aAAa,EAAE,QAAQ,EAAE,gBAAgB,EAAE,OAAO,EAAC;IACrG,MAAM,KAAK,GAAG,IAAI,+BAA+B,CAC/C,iBAAiB,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,0BAA0B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,6HAA6H,EAChQ,EAAC,QAAQ,EAAE,OAAO,EAAE,gBAAgB,EAAC,CACtC,CAAA;IAED,aAAa,CAAC,cAAc,EAAE,CAAC,IAAI,CAAC,iBAAiB,EAAE;QACrD,OAAO,EAAE,gCAAgC;QACzC,KAAK;QACL,QAAQ;QACR,OAAO;QACP,gBAAgB;KACjB,CAAC,CAAA;IACF,aAAa,CAAC,cAAc,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE;QAC/C,OAAO,EAAE,gCAAgC;QACzC,KAAK;QACL,SAAS,EAAE,iBAAiB;QAC5B,QAAQ;QACR,OAAO;QACP,gBAAgB;KACjB,CAAC,CAAA;IAEF,MAAM,KAAK,CAAA;AACb,CAAC","sourcesContent":["// @ts-check\n\n/**\n * Advisory-lock backend tiers (STC-210 design, `docs/advisory-lock-backends.md` §1/§9).\n * `process-local` and `file` are host-local; `driver-native` and `lock-server` are\n * cross-host. Tier strength order (strongest first):\n * `lock-server` ≡ `driver-native` > `file` > `process-local`.\n * @typedef {\"process-local\" | \"file\" | \"driver-native\" | \"lock-server\"} AdvisoryLockTier\n */\n/**\n * One per-lock-name backend policy entry as declared in configuration (§5).\n * @typedef {object} AdvisoryLockBackendPolicyEntry\n * @property {string} name - Lock name or `*`-suffixed glob pattern (e.g. `background_jobs:*`).\n * @property {AdvisoryLockTier} [minTier] - Weakest tier this name may ever be served by. Defaults to `driver-native` (default-deny).\n * @property {AdvisoryLockTier[]} [allowedTiers] - Explicit whitelist of servable tiers. Defaults to every tier at or above `minTier`.\n * @property {AdvisoryLockTier} [preferredTier] - Tier used when available; falling below it triggers the fallback report (§3). Defaults to `driver-native`.\n */\n/**\n * Policy resolved for one concrete lock name, with tier gaps already closed:\n * `allowedTiers` always contains every tier at or above `minTier`, so a\n * cross-host-minimum name can never be served by `file` or `process-local`.\n * @typedef {object} ResolvedAdvisoryLockBackendPolicy\n * @property {AdvisoryLockTier} minTier - Weakest tier this name may be served by.\n * @property {AdvisoryLockTier[]} allowedTiers - Tiers that may serve this name (minimum-closed).\n * @property {AdvisoryLockTier} preferredTier - Tier preferred when available.\n * @property {AdvisoryLockBackendPolicyEntry | null} entry - The matched configuration entry, or null for the default policy.\n */\n\n/**\n * Thrown when an acquisition would have to be served by a tier below the\n * lock name's declared minimum tier. Fail-closed refusal (§9): the name is\n * never served by the weaker tier, and the refusal is reported on the\n * framework-error channel as `advisory-lock-min-tier-refused`.\n */\nexport class AdvisoryLockMinTierRefusedError extends Error {\n  /**\n   * Runs constructor.\n   * @param {string} message - Error message.\n   * @param {{lockName: string, requestedBackend: AdvisoryLockTier, minTier: AdvisoryLockTier}} args - Refusal details.\n   */\n  constructor(message, {lockName, requestedBackend, minTier}) {\n    super(message)\n    this.name = \"AdvisoryLockMinTierRefusedError\"\n    this.lockName = lockName\n    this.requestedBackend = requestedBackend\n    this.minTier = minTier\n  }\n}\n\n/**\n * Thrown when no enabled backend that satisfies the lock name's minimum tier\n * is available (§9). Distinct from `AdvisoryLockTimeoutError` (a backend\n * served the wait but the holder never released).\n */\nexport class AdvisoryLockBackendUnavailableError extends Error {\n  /**\n   * Runs constructor.\n   * @param {string} message - Error message.\n   * @param {{lockName: string, minTier: AdvisoryLockTier, reasons: string[]}} args - Unavailability details.\n   */\n  constructor(message, {lockName, minTier, reasons}) {\n    super(message)\n    this.name = \"AdvisoryLockBackendUnavailableError\"\n    this.lockName = lockName\n    this.minTier = minTier\n    this.reasons = reasons\n  }\n}\n\n/**\n * Tier strength ranks (§9): higher rank is stronger. `lock-server` and\n * `driver-native` are both cross-host and rank equal.\n * @type {Record<AdvisoryLockTier, number>} */\nconst TIER_RANKS = {\n  \"driver-native\": 2,\n  file: 1,\n  \"lock-server\": 3,\n  \"process-local\": 0\n}\n\n/** All tiers ordered strongest-first. */\nconst TIERS_STRONGEST_FIRST = /** @type {AdvisoryLockTier[]} */ ([\"lock-server\", \"driver-native\", \"file\", \"process-local\"])\n\n/**\n * Runs tier rank.\n * @param {AdvisoryLockTier} tier - Tier to rank.\n * @returns {number} - Strength rank (higher is stronger).\n */\nexport function advisoryLockTierRank(tier) {\n  const rank = TIER_RANKS[tier]\n\n  if (rank === undefined) throw new Error(`Unknown advisory-lock tier ${JSON.stringify(String(tier))}`)\n\n  return rank\n}\n\n/**\n * Runs tier is at least as strong as.\n * @param {AdvisoryLockTier} tier - Candidate serving tier.\n * @param {AdvisoryLockTier} minimum - Required minimum tier.\n * @returns {boolean} - Whether `tier` satisfies the minimum.\n */\nexport function advisoryLockTierSatisfies(tier, minimum) {\n  return advisoryLockTierRank(tier) >= advisoryLockTierRank(minimum)\n}\n\n/**\n * Resolves the effective backend policy for one concrete lock name:\n * longest-prefix glob match over the configured entries (exact names win),\n * default-deny for undeclared names (`minTier: driver-native`,\n * `preferredTier: driver-native`), and `allowedTiers` closed upward so a\n * cross-host minimum can never be served by a host-local tier.\n * @param {string} lockName - Concrete lock name.\n * @param {AdvisoryLockBackendPolicyEntry[] | undefined} policy - Configured policy entries.\n * @returns {ResolvedAdvisoryLockBackendPolicy} - Resolved policy.\n */\nexport function resolveAdvisoryLockBackendPolicy(lockName, policy) {\n  const entry = matchAdvisoryLockPolicyEntry(lockName, policy)\n  const minTier = entry?.minTier ?? \"driver-native\"\n  const preferredTier = entry?.preferredTier ?? \"driver-native\"\n\n  // §9: eligibility filters to tier strength >= minTier even when a weaker\n  // tier was declared in `allowedTiers` — a cross-host minimum can never be\n  // served by `file` or `process-local`. A `preferredTier` below the minimum\n  // stays visible here so the runner can refuse it loudly before contacting\n  // the weaker backend.\n  const declaredAllowed = entry?.allowedTiers\n  const allowedTiers = TIERS_STRONGEST_FIRST.filter((tier) => {\n    if (!advisoryLockTierSatisfies(tier, minTier)) return false\n\n    if (!Array.isArray(declaredAllowed)) return true\n\n    return declaredAllowed.includes(tier)\n  })\n\n  return {allowedTiers, entry: entry ?? null, minTier, preferredTier}\n}\n\n/**\n * Matches one policy entry for a lock name: exact `name` matches win;\n * otherwise the longest `*`-suffixed prefix pattern wins.\n * @param {string} lockName - Concrete lock name.\n * @param {AdvisoryLockBackendPolicyEntry[] | undefined} policy - Configured policy entries.\n * @returns {AdvisoryLockBackendPolicyEntry | null} - Matched entry or null.\n */\nfunction matchAdvisoryLockPolicyEntry(lockName, policy) {\n  if (!Array.isArray(policy)) return null\n\n  let bestPrefixMatch = null\n  let bestPrefixLength = -1\n\n  for (const entry of policy) {\n    if (typeof entry?.name !== \"string\") continue\n\n    if (entry.name === lockName) return entry\n\n    if (entry.name.endsWith(\"*\")) {\n      const prefix = entry.name.slice(0, -1)\n\n      if (lockName.startsWith(prefix) && prefix.length > bestPrefixLength) {\n        bestPrefixMatch = entry\n        bestPrefixLength = prefix.length\n      }\n    }\n  }\n\n  return bestPrefixMatch\n}\n\n/**\n * Refuses a downgrade below the lock name's minimum tier before any contact\n * with the weaker backend (§9), reporting the refusal on the framework-error\n * channel so a silent downgrade is impossible to hide.\n * @param {object} args - Refusal args.\n * @param {import(\"../configuration.js\").default} args.configuration - Configuration owning the error channel.\n * @param {string} args.lockName - Lock name.\n * @param {AdvisoryLockTier} args.requestedBackend - Tier the acquisition would fall to.\n * @param {AdvisoryLockTier} args.minTier - Declared minimum tier.\n * @returns {never} - Always throws.\n */\nexport function refuseAdvisoryLockTierBelowMinimum({configuration, lockName, requestedBackend, minTier}) {\n  const error = new AdvisoryLockMinTierRefusedError(\n    `Advisory lock ${JSON.stringify(lockName)} requires minimum tier ${JSON.stringify(minTier)}; the ${JSON.stringify(requestedBackend)} tier is refused. Enable a cross-host backend or declare minTier: \"file\" for this lock name (single-host deployments only).`,\n    {lockName, minTier, requestedBackend}\n  )\n\n  configuration.getErrorEvents().emit(\"framework-error\", {\n    context: \"advisory-lock-min-tier-refused\",\n    error,\n    lockName,\n    minTier,\n    requestedBackend\n  })\n  configuration.getErrorEvents().emit(\"all-error\", {\n    context: \"advisory-lock-min-tier-refused\",\n    error,\n    errorType: \"framework-error\",\n    lockName,\n    minTier,\n    requestedBackend\n  })\n\n  throw error\n}\n"]}
|
|
@@ -0,0 +1,194 @@
|
|
|
1
|
+
export type AdvisoryLockFileOwner = {
|
|
2
|
+
/**
|
|
3
|
+
* - PID of the holding process.
|
|
4
|
+
*/
|
|
5
|
+
pid: number;
|
|
6
|
+
/**
|
|
7
|
+
* - Host of the holding process.
|
|
8
|
+
*/
|
|
9
|
+
hostname: string;
|
|
10
|
+
/**
|
|
11
|
+
* - Unique id of the acquiring backend instance.
|
|
12
|
+
*/
|
|
13
|
+
holderId: string;
|
|
14
|
+
/**
|
|
15
|
+
* - ISO timestamp of acquisition.
|
|
16
|
+
*/
|
|
17
|
+
acquiredAt: string;
|
|
18
|
+
/**
|
|
19
|
+
* - ISO timestamp when the current lease expires without renewal.
|
|
20
|
+
*/
|
|
21
|
+
leaseExpiresAt: string;
|
|
22
|
+
/**
|
|
23
|
+
* - Extra owner field: HTTP host (server lock only).
|
|
24
|
+
*/
|
|
25
|
+
host?: string;
|
|
26
|
+
/**
|
|
27
|
+
* - Extra owner field: HTTP port (server lock only).
|
|
28
|
+
*/
|
|
29
|
+
port?: number;
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* Owner metadata written inside one file-lock directory.
|
|
33
|
+
* @typedef {object} AdvisoryLockFileOwner
|
|
34
|
+
* @property {number} pid - PID of the holding process.
|
|
35
|
+
* @property {string} hostname - Host of the holding process.
|
|
36
|
+
* @property {string} holderId - Unique id of the acquiring backend instance.
|
|
37
|
+
* @property {string} acquiredAt - ISO timestamp of acquisition.
|
|
38
|
+
* @property {string} leaseExpiresAt - ISO timestamp when the current lease expires without renewal.
|
|
39
|
+
* @property {string} [host] - Extra owner field: HTTP host (server lock only).
|
|
40
|
+
* @property {number} [port] - Extra owner field: HTTP port (server lock only).
|
|
41
|
+
*/
|
|
42
|
+
/**
|
|
43
|
+
* Directory-based advisory-lock backend for the STC-210 `file` tier
|
|
44
|
+
* (`docs/advisory-lock-backends.md` tier (d)). This generalizes the pattern
|
|
45
|
+
* already used by `src/http-server/server-lock.js` and the Node SQLite
|
|
46
|
+
* driver's filesystem layer into one reusable backend behind the shared
|
|
47
|
+
* advisory-lock seam:
|
|
48
|
+
*
|
|
49
|
+
* - Atomic publication: a lock is claimed by `fs.mkdtemp` + `fs.rename` onto
|
|
50
|
+
* the stable lock path, so a losing candidate never observes or deletes a
|
|
51
|
+
* half-written owner record.
|
|
52
|
+
* - Lease + renewal: each hold carries a `leaseMs` lease renewed on
|
|
53
|
+
* `renewIntervalMs` while held, so a holder that dies without releasing
|
|
54
|
+
* (or whose PID was recycled) is reclaimable once the lease expires.
|
|
55
|
+
* - Staleness: a lock directory is stale when its owner metadata is
|
|
56
|
+
* unreadable, its lease expired, or its owner is a dead local process
|
|
57
|
+
* (`kill(pid, 0)` → `ESRCH`). Cross-host owners are only reclaimable via
|
|
58
|
+
* lease expiry because PID liveness cannot be probed remotely.
|
|
59
|
+
*
|
|
60
|
+
* This tier provides no fencing tokens (design §8: a file lock has no
|
|
61
|
+
* monotonic authority a partitioned holder can be checked against), so
|
|
62
|
+
* acquisitions report `fencingSupported: false` instead of pretending.
|
|
63
|
+
*/
|
|
64
|
+
export default class AdvisoryLockFileBackend {
|
|
65
|
+
directory: string;
|
|
66
|
+
extraOwnerFields: Record<string, string | number>;
|
|
67
|
+
leaseMs: number;
|
|
68
|
+
renewIntervalMs: number;
|
|
69
|
+
pathStyle: "hashed" | "plain";
|
|
70
|
+
pollIntervalMs: number;
|
|
71
|
+
holderId: string;
|
|
72
|
+
/** @type {Map<string, {timer: ReturnType<typeof setInterval>}>} */
|
|
73
|
+
holdsByName: Map<string, {
|
|
74
|
+
timer: ReturnType<typeof setInterval>;
|
|
75
|
+
}>;
|
|
76
|
+
/**
|
|
77
|
+
* Creates one file-lock backend.
|
|
78
|
+
* @param {object} args - Backend options.
|
|
79
|
+
* @param {string} args.directory - Directory that holds the lock directories.
|
|
80
|
+
* @param {Record<string, string | number>} [args.extraOwnerFields] - Extra fields merged into every owner metadata record (e.g. the HTTP server lock's host/port).
|
|
81
|
+
* @param {number} [args.leaseMs] - Lease duration for one hold; expired leases make a lock stale. Defaults to 30000.
|
|
82
|
+
* @param {number} [args.renewIntervalMs] - Renewal cadence while holding; must stay below `leaseMs`. Defaults to 10000.
|
|
83
|
+
* @param {"hashed" | "plain"} [args.pathStyle] - `hashed` derives `<safeName>-<hash>.lock` names (advisory-lock tier); `plain` uses `<name>.lock` (HTTP server lock). Defaults to `hashed`.
|
|
84
|
+
* @param {number} [args.pollIntervalMs] - Wait between acquisition retries. Defaults to 50.
|
|
85
|
+
*/
|
|
86
|
+
constructor({ directory, extraOwnerFields, leaseMs, renewIntervalMs, pathStyle, pollIntervalMs }: {
|
|
87
|
+
directory: string;
|
|
88
|
+
extraOwnerFields?: Record<string, string | number>;
|
|
89
|
+
leaseMs?: number;
|
|
90
|
+
renewIntervalMs?: number;
|
|
91
|
+
pathStyle?: "hashed" | "plain";
|
|
92
|
+
pollIntervalMs?: number;
|
|
93
|
+
});
|
|
94
|
+
/**
|
|
95
|
+
* Resolves the stable lock directory path for one lock name.
|
|
96
|
+
* @param {string} name - Lock name.
|
|
97
|
+
* @returns {string} - Filesystem path for the lock directory.
|
|
98
|
+
*/
|
|
99
|
+
lockPathFor(name: string): string;
|
|
100
|
+
/**
|
|
101
|
+
* Blocks until the named lock is acquired or `timeoutMs` elapses.
|
|
102
|
+
* @param {string} name - Lock name.
|
|
103
|
+
* @param {{timeoutMs?: number | null}} [args] - Timeout args; `null`, `undefined`, or negative waits indefinitely.
|
|
104
|
+
* @returns {Promise<boolean>} - True when acquired, false when the timeout elapsed.
|
|
105
|
+
*/
|
|
106
|
+
acquire(name: string, { timeoutMs }?: {
|
|
107
|
+
timeoutMs?: number | null;
|
|
108
|
+
}): Promise<boolean>;
|
|
109
|
+
/**
|
|
110
|
+
* Attempts to acquire the named lock without waiting, reclaiming a stale
|
|
111
|
+
* lock directory when one is found.
|
|
112
|
+
* @param {string} name - Lock name.
|
|
113
|
+
* @returns {Promise<boolean>} - True when this backend became the lock owner.
|
|
114
|
+
*/
|
|
115
|
+
tryAcquire(name: string): Promise<boolean>;
|
|
116
|
+
/**
|
|
117
|
+
* Releases the lock only when this backend instance owns it, mirroring the
|
|
118
|
+
* "you can only release locks you own" contract of the database tiers.
|
|
119
|
+
* @param {string} name - Lock name.
|
|
120
|
+
* @returns {Promise<boolean>} - True when the held lock was released.
|
|
121
|
+
*/
|
|
122
|
+
release(name: string): Promise<boolean>;
|
|
123
|
+
/**
|
|
124
|
+
* Runs is held.
|
|
125
|
+
* @param {string} name - Lock name.
|
|
126
|
+
* @returns {Promise<boolean>} - Whether the lock is currently held by a live, unexpired owner.
|
|
127
|
+
*/
|
|
128
|
+
isHeld(name: string): Promise<boolean>;
|
|
129
|
+
/**
|
|
130
|
+
* Reads the current owner metadata for diagnostics.
|
|
131
|
+
* @param {string} name - Lock name.
|
|
132
|
+
* @returns {Promise<AdvisoryLockFileOwner | null>} - Parsed owner metadata, when a lock directory exists.
|
|
133
|
+
*/
|
|
134
|
+
holderInfo(name: string): Promise<AdvisoryLockFileOwner | null>;
|
|
135
|
+
/**
|
|
136
|
+
* Releases every lock this backend instance currently holds (shutdown path).
|
|
137
|
+
* @returns {Promise<void>} - Resolves after best-effort release of all holds.
|
|
138
|
+
*/
|
|
139
|
+
releaseAllHeld(): Promise<void>;
|
|
140
|
+
/**
|
|
141
|
+
* Ensures the parent lock directory exists.
|
|
142
|
+
* @returns {Promise<void>} - Resolves after the directory exists.
|
|
143
|
+
*/
|
|
144
|
+
ensureDirectory(): Promise<void>;
|
|
145
|
+
/**
|
|
146
|
+
* Publishes a fully initialized lock directory with one atomic rename so
|
|
147
|
+
* concurrent candidates cannot observe a half-written owner record.
|
|
148
|
+
* @param {string} lockPath - Stable lock directory path.
|
|
149
|
+
* @returns {Promise<boolean>} - Whether this candidate became the lock owner.
|
|
150
|
+
*/
|
|
151
|
+
publishLockDirectory(lockPath: string): Promise<boolean>;
|
|
152
|
+
/**
|
|
153
|
+
* Starts lease renewal for a freshly acquired hold.
|
|
154
|
+
* @param {string} name - Lock name.
|
|
155
|
+
* @returns {true} - Always true; the hold is now tracked.
|
|
156
|
+
*/
|
|
157
|
+
startHold(name: string): true;
|
|
158
|
+
/**
|
|
159
|
+
* Extends this instance's lease on one held lock; stops renewing when the
|
|
160
|
+
* directory is no longer ours (the lock was reclaimed).
|
|
161
|
+
* @param {string} name - Lock name.
|
|
162
|
+
* @returns {Promise<void>} - Resolves after the renewal attempt.
|
|
163
|
+
*/
|
|
164
|
+
renewHold(name: string): Promise<void>;
|
|
165
|
+
/**
|
|
166
|
+
* Clears the renewal timer for one hold.
|
|
167
|
+
* @param {string} name - Lock name.
|
|
168
|
+
* @returns {void}
|
|
169
|
+
*/
|
|
170
|
+
clearHold(name: string): void;
|
|
171
|
+
/**
|
|
172
|
+
* Writes owner + lease metadata into a lock directory.
|
|
173
|
+
* @param {string} lockDirPath - Lock directory to write metadata into.
|
|
174
|
+
* @returns {Promise<void>} - Resolves after metadata is written.
|
|
175
|
+
*/
|
|
176
|
+
writeOwner(lockDirPath: string): Promise<void>;
|
|
177
|
+
/**
|
|
178
|
+
* Reads owner metadata from a lock directory.
|
|
179
|
+
* @param {string} lockPath - Lock directory path.
|
|
180
|
+
* @returns {Promise<AdvisoryLockFileOwner | null>} - Parsed owner metadata, when readable.
|
|
181
|
+
*/
|
|
182
|
+
readOwner(lockPath: string): Promise<AdvisoryLockFileOwner | null>;
|
|
183
|
+
/**
|
|
184
|
+
* A lock directory is stale when its metadata is unreadable, its lease has
|
|
185
|
+
* expired, or its owner is a dead process on this host. Cross-host owners
|
|
186
|
+
* are only reclaimable via lease expiry — PID probing is unreliable beyond
|
|
187
|
+
* one host, which is exactly why this tier is the opt-in single-host last
|
|
188
|
+
* resort (design §4/§8).
|
|
189
|
+
* @param {string} lockPath - Lock directory path.
|
|
190
|
+
* @returns {Promise<boolean>} - Whether the lock can be reclaimed.
|
|
191
|
+
*/
|
|
192
|
+
isStale(lockPath: string): Promise<boolean>;
|
|
193
|
+
}
|
|
194
|
+
//# sourceMappingURL=advisory-lock-file-backend.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"advisory-lock-file-backend.d.ts","sourceRoot":"","sources":["../../../src/database/advisory-lock-file-backend.js"],"names":[],"mappings":"AAUG,YAAkB,qBAAqB,GACvC;;;;IAAmB,GAAG,EAAX,MAAM,CACjB;;;;IAAmB,QAAQ,EAAhB,MAAM,CACjB;;;;IAAmB,QAAQ,EAAhB,MAAM,CACjB;;;;IAAmB,UAAU,EAAlB,MAAM,CACjB;;;;IAAmB,cAAc,EAAtB,MAAM,CACjB;;;;IAAoB,IAAI,AAAxB,CACA,EADW,MAAM,CACjB;;;;IAAoB,IAAI,AAAxB,CACF,EADa,MAAM,CACnB;CAAA,CAAA;AAVD;;;;;;;;;;GAUG;AAEH;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,OAAO,OAAO,uBAAuB;IAYnC,SAAS;IACT,gBAAgB;IAChB,OAAO;IACP,eAAe;IACf,SAAS;IACT,cAAc;IACd,QAAQ;IACb,mEAAmE;IAC9D,WAAW,EADL,GAAG,CAAC,MAAM,EAAE;QAAC,KAAK,EAAE,UAAU,CAAC,OAAO,WAAW,CAAC,CAAA;KAAC,CAAC;IAlBjE;;;;;;;;;OASG;IACH,YAAY,EAAC,SAAS,EAAE,gBAAqB,EAAE,OAAgB,EAAE,eAAwB,EAAE,SAAoB,EAAE,cAAmB,EAAC,EAPlI;QAAqB,SAAS,EAAtB,MAAM,CACd;QAA+C,gBAAgB,AAA/D,CACA,EADQ,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CACvC;QAAsB,OAAO,AAA7B,CACA,EADQ,MAAM,CACd;QAAsB,eAAe,AAArC,CACA,EADQ,MAAM,CACd;QAAkC,SAAS,AAA3C,CACA,EADQ,QAAQ,GAAG,OAAO,CAC1B;QAAsB,cAAc,AAApC,CACF,EADU,MAAM,CAChB;KACoI,EAUpI;IAED;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAHL,MAGK,GAFH,MAAM,CASlB;IAED;;;;;OAKG;IACG,OAAO,CAAC,IAAI,EAJP,MAIO,EAAE,EAAC,SAAS,EAAC,AAH5B,CACA,EADQ;QAAC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAGD,GAFvB,OAAO,CAAC,OAAO,CAAC,CAuB5B;IAED;;;;;OAKG;IACG,UAAU,CAAC,IAAI,EAHV,MAGU,GAFR,OAAO,CAAC,OAAO,CAAC,CAkB5B;IAED;;;;;OAKG;IACG,OAAO,CAAC,IAAI,EAHP,MAGO,GAFL,OAAO,CAAC,OAAO,CAAC,CAgB5B;IAED;;;;OAIG;IACG,MAAM,CAAC,IAAI,EAHN,MAGM,GAFJ,OAAO,CAAC,OAAO,CAAC,CAY5B;IAED;;;;OAIG;IACG,UAAU,CAAC,IAAI,EAHV,MAGU,GAFR,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC,CAIjD;IAED;;;OAGG;IACG,cAAc,IAFP,OAAO,CAAC,IAAI,CAAC,CAMzB;IAED;;;OAGG;IACG,eAAe,IAFR,OAAO,CAAC,IAAI,CAAC,CAIzB;IAED;;;;;OAKG;IACG,oBAAoB,CAAC,QAAQ,EAHxB,MAGwB,GAFtB,OAAO,CAAC,OAAO,CAAC,CAsB5B;IAED;;;;OAIG;IACH,SAAS,CAAC,IAAI,EAHH,MAGG,GAFD,IAAI,CAYhB;IAED;;;;;OAKG;IACG,SAAS,CAAC,IAAI,EAHT,MAGS,GAFP,OAAO,CAAC,IAAI,CAAC,CAezB;IAED;;;;OAIG;IACH,SAAS,CAAC,IAAI,EAHH,MAGG,GAFD,IAAI,CAShB;IAED;;;;OAIG;IACG,UAAU,CAAC,WAAW,EAHjB,MAGiB,GAFf,OAAO,CAAC,IAAI,CAAC,CAczB;IAED;;;;OAIG;IACG,SAAS,CAAC,QAAQ,EAHb,MAGa,GAFX,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC,CAiBjD;IAED;;;;;;;;OAQG;IACG,OAAO,CAAC,QAAQ,EAHX,MAGW,GAFT,OAAO,CAAC,OAAO,CAAC,CAoB5B;CACF"}
|