@aws-cdk-testing/cli-integ 0.0.0

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.
Files changed (257) hide show
  1. package/.eslintrc.js +9 -0
  2. package/LICENSE +202 -0
  3. package/NOTICE +16 -0
  4. package/README.md +205 -0
  5. package/bin/apply-patches +22 -0
  6. package/bin/download-and-run-old-tests +52 -0
  7. package/bin/query-github +2 -0
  8. package/bin/query-github.d.ts +1 -0
  9. package/bin/query-github.js +54 -0
  10. package/bin/query-github.ts +56 -0
  11. package/bin/run-suite +2 -0
  12. package/bin/run-suite.d.ts +1 -0
  13. package/bin/run-suite.js +131 -0
  14. package/bin/run-suite.ts +140 -0
  15. package/bin/stage-distribution +2 -0
  16. package/bin/stage-distribution.d.ts +1 -0
  17. package/bin/stage-distribution.js +217 -0
  18. package/bin/stage-distribution.ts +267 -0
  19. package/bin/test-root +2 -0
  20. package/bin/test-root.d.ts +1 -0
  21. package/bin/test-root.js +6 -0
  22. package/bin/test-root.ts +3 -0
  23. package/entrypoints/test-cli-regression-against-current-code.sh +11 -0
  24. package/entrypoints/test-cli-regression-against-latest-release.sh +11 -0
  25. package/entrypoints/test-cli-regression.bash +83 -0
  26. package/entrypoints/test.sh +12 -0
  27. package/lib/aws.d.ts +51 -0
  28. package/lib/aws.js +206 -0
  29. package/lib/aws.ts +263 -0
  30. package/lib/corking.d.ts +12 -0
  31. package/lib/corking.js +35 -0
  32. package/lib/corking.ts +33 -0
  33. package/lib/eventually.d.ts +20 -0
  34. package/lib/eventually.js +34 -0
  35. package/lib/eventually.ts +42 -0
  36. package/lib/files.d.ts +15 -0
  37. package/lib/files.js +80 -0
  38. package/lib/files.ts +80 -0
  39. package/lib/github.d.ts +4 -0
  40. package/lib/github.js +43 -0
  41. package/lib/github.ts +43 -0
  42. package/lib/index.d.ts +13 -0
  43. package/lib/index.js +30 -0
  44. package/lib/index.ts +13 -0
  45. package/lib/integ-test.d.ts +10 -0
  46. package/lib/integ-test.js +70 -0
  47. package/lib/integ-test.ts +81 -0
  48. package/lib/lists.d.ts +1 -0
  49. package/lib/lists.js +11 -0
  50. package/lib/lists.ts +9 -0
  51. package/lib/memoize.d.ts +6 -0
  52. package/lib/memoize.js +18 -0
  53. package/lib/memoize.ts +14 -0
  54. package/lib/npm.d.ts +8 -0
  55. package/lib/npm.js +38 -0
  56. package/lib/npm.ts +41 -0
  57. package/lib/package-sources/release-source.d.ts +23 -0
  58. package/lib/package-sources/release-source.js +71 -0
  59. package/lib/package-sources/release-source.ts +81 -0
  60. package/lib/package-sources/repo-source.d.ts +30 -0
  61. package/lib/package-sources/repo-source.js +97 -0
  62. package/lib/package-sources/repo-source.ts +111 -0
  63. package/lib/package-sources/repo-tools/npm +2 -0
  64. package/lib/package-sources/repo-tools/npm.d.ts +1 -0
  65. package/lib/package-sources/repo-tools/npm.js +43 -0
  66. package/lib/package-sources/repo-tools/npm.ts +48 -0
  67. package/lib/package-sources/source.d.ts +28 -0
  68. package/lib/package-sources/source.js +3 -0
  69. package/lib/package-sources/source.ts +35 -0
  70. package/lib/package-sources/subprocess.d.ts +3 -0
  71. package/lib/package-sources/subprocess.js +17 -0
  72. package/lib/package-sources/subprocess.ts +15 -0
  73. package/lib/resource-pool.d.ts +50 -0
  74. package/lib/resource-pool.js +117 -0
  75. package/lib/resource-pool.ts +140 -0
  76. package/lib/resources.d.ts +1 -0
  77. package/lib/resources.js +6 -0
  78. package/lib/resources.ts +4 -0
  79. package/lib/shell.d.ts +56 -0
  80. package/lib/shell.js +123 -0
  81. package/lib/shell.ts +168 -0
  82. package/lib/staging/codeartifact.d.ts +44 -0
  83. package/lib/staging/codeartifact.js +281 -0
  84. package/lib/staging/codeartifact.ts +387 -0
  85. package/lib/staging/maven.d.ts +5 -0
  86. package/lib/staging/maven.js +91 -0
  87. package/lib/staging/maven.ts +95 -0
  88. package/lib/staging/npm.d.ts +4 -0
  89. package/lib/staging/npm.js +55 -0
  90. package/lib/staging/npm.ts +62 -0
  91. package/lib/staging/nuget.d.ts +4 -0
  92. package/lib/staging/nuget.js +69 -0
  93. package/lib/staging/nuget.ts +75 -0
  94. package/lib/staging/parallel-shell.d.ts +5 -0
  95. package/lib/staging/parallel-shell.js +45 -0
  96. package/lib/staging/parallel-shell.ts +51 -0
  97. package/lib/staging/pypi.d.ts +4 -0
  98. package/lib/staging/pypi.js +48 -0
  99. package/lib/staging/pypi.ts +50 -0
  100. package/lib/staging/usage-dir.d.ts +31 -0
  101. package/lib/staging/usage-dir.js +87 -0
  102. package/lib/staging/usage-dir.ts +99 -0
  103. package/lib/with-aws.d.ts +14 -0
  104. package/lib/with-aws.js +60 -0
  105. package/lib/with-aws.ts +67 -0
  106. package/lib/with-cdk-app.d.ts +210 -0
  107. package/lib/with-cdk-app.js +539 -0
  108. package/lib/with-cdk-app.ts +742 -0
  109. package/lib/with-cli-lib.d.ts +17 -0
  110. package/lib/with-cli-lib.js +123 -0
  111. package/lib/with-cli-lib.ts +134 -0
  112. package/lib/with-packages.d.ts +5 -0
  113. package/lib/with-packages.js +13 -0
  114. package/lib/with-packages.ts +15 -0
  115. package/lib/with-sam.d.ts +33 -0
  116. package/lib/with-sam.js +258 -0
  117. package/lib/with-sam.ts +288 -0
  118. package/lib/with-temporary-directory.d.ts +5 -0
  119. package/lib/with-temporary-directory.js +31 -0
  120. package/lib/with-temporary-directory.ts +35 -0
  121. package/lib/with-timeout.d.ts +19 -0
  122. package/lib/with-timeout.js +34 -0
  123. package/lib/with-timeout.ts +33 -0
  124. package/lib/xpmutex.d.ts +43 -0
  125. package/lib/xpmutex.js +207 -0
  126. package/lib/xpmutex.ts +218 -0
  127. package/package.json +111 -0
  128. package/resources/bootstrap-templates/session-tags.all-roles-deny-all.yaml +703 -0
  129. package/resources/bootstrap-templates/session-tags.deploy-role-deny-sqs.yaml +700 -0
  130. package/resources/cdk-apps/app/app.js +926 -0
  131. package/resources/cdk-apps/app/appsync.hotswap.graphql +3 -0
  132. package/resources/cdk-apps/app/cdk.json +7 -0
  133. package/resources/cdk-apps/app/docker/Dockerfile +2 -0
  134. package/resources/cdk-apps/app/docker/Dockerfile.Custom +2 -0
  135. package/resources/cdk-apps/app/lambda/index.js +4 -0
  136. package/resources/cdk-apps/app/lambda/response.json +3 -0
  137. package/resources/cdk-apps/app/nested-stack.js +65 -0
  138. package/resources/cdk-apps/cfn-include-app/cdk.json +4 -0
  139. package/resources/cdk-apps/cfn-include-app/cfn-include-app.js +21 -0
  140. package/resources/cdk-apps/cfn-include-app/example-template.json +13 -0
  141. package/resources/cdk-apps/rollback-test-app/app.js +110 -0
  142. package/resources/cdk-apps/rollback-test-app/cdk.json +7 -0
  143. package/resources/cdk-apps/sam_cdk_integ_app/bin/test-app.js +11 -0
  144. package/resources/cdk-apps/sam_cdk_integ_app/cdk.json +6 -0
  145. package/resources/cdk-apps/sam_cdk_integ_app/lib/nested-stack.js +19 -0
  146. package/resources/cdk-apps/sam_cdk_integ_app/lib/test-stack.js +134 -0
  147. package/resources/cdk-apps/sam_cdk_integ_app/src/docker/DockerImageFunctionConstruct/.no-packagejson-validator +0 -0
  148. package/resources/cdk-apps/sam_cdk_integ_app/src/docker/DockerImageFunctionConstruct/Dockerfile +9 -0
  149. package/resources/cdk-apps/sam_cdk_integ_app/src/docker/DockerImageFunctionConstruct/app.js +22 -0
  150. package/resources/cdk-apps/sam_cdk_integ_app/src/docker/DockerImageFunctionConstruct/package.json +18 -0
  151. package/resources/cdk-apps/sam_cdk_integ_app/src/go/GoFunctionConstruct/go.mod +5 -0
  152. package/resources/cdk-apps/sam_cdk_integ_app/src/go/GoFunctionConstruct/go.sum +17 -0
  153. package/resources/cdk-apps/sam_cdk_integ_app/src/go/GoFunctionConstruct/main.go +17 -0
  154. package/resources/cdk-apps/sam_cdk_integ_app/src/nodejs/NodeJsFunctionConstruct/.no-packagejson-validator +0 -0
  155. package/resources/cdk-apps/sam_cdk_integ_app/src/nodejs/NodeJsFunctionConstruct/app.ts +16 -0
  156. package/resources/cdk-apps/sam_cdk_integ_app/src/nodejs/NodeJsFunctionConstruct/package-lock.json +12 -0
  157. package/resources/cdk-apps/sam_cdk_integ_app/src/nodejs/NodeJsFunctionConstruct/package.json +5 -0
  158. package/resources/cdk-apps/sam_cdk_integ_app/src/python/Function/app.py +15 -0
  159. package/resources/cdk-apps/sam_cdk_integ_app/src/python/Function/requirements.txt +1 -0
  160. package/resources/cdk-apps/sam_cdk_integ_app/src/python/Layer/layer_version_dependency.py +5 -0
  161. package/resources/cdk-apps/sam_cdk_integ_app/src/python/Layer/requirements.txt +1 -0
  162. package/resources/cdk-apps/sam_cdk_integ_app/src/rest-api-definition.yaml +12 -0
  163. package/resources/cdk-apps/simple-app/app.js +26 -0
  164. package/resources/cdk-apps/simple-app/cdk.json +7 -0
  165. package/resources/cli-regression-patches/v1.119.0/NOTES.md +5 -0
  166. package/resources/cli-regression-patches/v1.119.0/cli.integtest.js +659 -0
  167. package/resources/cli-regression-patches/v1.130.0/NOTES.md +12 -0
  168. package/resources/cli-regression-patches/v1.130.0/app/app.js +378 -0
  169. package/resources/cli-regression-patches/v1.130.0/bootstrapping.integtest.js +220 -0
  170. package/resources/cli-regression-patches/v1.44.0/NOTES.md +18 -0
  171. package/resources/cli-regression-patches/v1.44.0/bootstrapping.integtest.js +126 -0
  172. package/resources/cli-regression-patches/v1.44.0/test.sh +26 -0
  173. package/resources/cli-regression-patches/v1.61.1/NOTES.md +2 -0
  174. package/resources/cli-regression-patches/v1.61.1/skip-tests.txt +16 -0
  175. package/resources/cli-regression-patches/v1.62.0/NOTES.md +2 -0
  176. package/resources/cli-regression-patches/v1.62.0/aws-helpers.js +245 -0
  177. package/resources/cli-regression-patches/v1.63.0/NOTES.md +1 -0
  178. package/resources/cli-regression-patches/v1.63.0/skip-tests.txt +7 -0
  179. package/resources/cli-regression-patches/v1.64.0/NOTES.md +3 -0
  180. package/resources/cli-regression-patches/v1.64.0/cdk-helpers.js +325 -0
  181. package/resources/cli-regression-patches/v1.64.0/cli.integtest.js +599 -0
  182. package/resources/cli-regression-patches/v1.64.1/NOTES.md +3 -0
  183. package/resources/cli-regression-patches/v1.64.1/cdk-helpers.js +324 -0
  184. package/resources/cli-regression-patches/v1.64.1/cli.integtest.js +599 -0
  185. package/resources/cli-regression-patches/v1.67.0/NOTES.md +2 -0
  186. package/resources/cli-regression-patches/v1.67.0/cdk-helpers.js +331 -0
  187. package/resources/cli-regression-patches/v2.130.0/NOTES.md +1 -0
  188. package/resources/cli-regression-patches/v2.130.0/node_modules/@aws-cdk-testing/cli-integ/resources/cdk-apps/sam_cdk_integ_app/lib/nested-stack.js +19 -0
  189. package/resources/cli-regression-patches/v2.130.0/node_modules/@aws-cdk-testing/cli-integ/resources/cdk-apps/sam_cdk_integ_app/lib/test-stack.js +134 -0
  190. package/resources/cli-regression-patches/v2.130.0/skip-tests.txt +5 -0
  191. package/resources/cli-regression-patches/v2.132.0/NOTES.md +1 -0
  192. package/resources/cli-regression-patches/v2.132.0/skip-tests.txt +4 -0
  193. package/resources/cli-regression-patches/v2.142.0/NOTES.md +1 -0
  194. package/resources/cli-regression-patches/v2.142.0/skip-tests.txt +4 -0
  195. package/resources/cli-regression-patches/v2.160.0/skip-tests.txt +2 -0
  196. package/resources/cli-regression-patches/v2.161.0/NOTES.md +1 -0
  197. package/resources/cli-regression-patches/v2.161.0/skip-tests.txt +5 -0
  198. package/resources/cli-regression-patches/v2.166.0/NOTES.md +1 -0
  199. package/resources/cli-regression-patches/v2.166.0/skip-tests.txt +2 -0
  200. package/resources/cloud-assemblies/0.36.0/InitStack.template.json +1 -0
  201. package/resources/cloud-assemblies/0.36.0/cdk.out +1 -0
  202. package/resources/cloud-assemblies/0.36.0/manifest.json +19 -0
  203. package/resources/cloud-assemblies/1.10.0-lookup-default-vpc/InitStack.template.json +2 -0
  204. package/resources/cloud-assemblies/1.10.0-lookup-default-vpc/cdk.out +1 -0
  205. package/resources/cloud-assemblies/1.10.0-lookup-default-vpc/manifest.json.js +37 -0
  206. package/resources/cloud-assemblies/1.10.0-request-azs/InitStack.template.json +2 -0
  207. package/resources/cloud-assemblies/1.10.0-request-azs/cdk.out +1 -0
  208. package/resources/cloud-assemblies/1.10.0-request-azs/manifest.json.js +34 -0
  209. package/resources/integ.jest.config.js +25 -0
  210. package/resources/templates/sqs-template.json +36 -0
  211. package/skip-tests.txt +8 -0
  212. package/tests/cli-integ-tests/README.md +47 -0
  213. package/tests/cli-integ-tests/bootstrapping.integtest.d.ts +1 -0
  214. package/tests/cli-integ-tests/bootstrapping.integtest.js +412 -0
  215. package/tests/cli-integ-tests/bootstrapping.integtest.ts +493 -0
  216. package/tests/cli-integ-tests/cli-lib.integtest.d.ts +1 -0
  217. package/tests/cli-integ-tests/cli-lib.integtest.js +62 -0
  218. package/tests/cli-integ-tests/cli-lib.integtest.ts +90 -0
  219. package/tests/cli-integ-tests/cli.integtest.d.ts +1 -0
  220. package/tests/cli-integ-tests/cli.integtest.js +2104 -0
  221. package/tests/cli-integ-tests/cli.integtest.ts +2874 -0
  222. package/tests/cli-integ-tests/garbage-collection.integtest.d.ts +1 -0
  223. package/tests/cli-integ-tests/garbage-collection.integtest.js +314 -0
  224. package/tests/cli-integ-tests/garbage-collection.integtest.ts +392 -0
  225. package/tests/init-csharp/init-csharp.integtest.d.ts +1 -0
  226. package/tests/init-csharp/init-csharp.integtest.js +14 -0
  227. package/tests/init-csharp/init-csharp.integtest.ts +15 -0
  228. package/tests/init-fsharp/init-fsharp.integtest.d.ts +1 -0
  229. package/tests/init-fsharp/init-fsharp.integtest.js +14 -0
  230. package/tests/init-fsharp/init-fsharp.integtest.ts +15 -0
  231. package/tests/init-go/init-go.integtest.d.ts +1 -0
  232. package/tests/init-go/init-go.integtest.js +21 -0
  233. package/tests/init-go/init-go.integtest.ts +23 -0
  234. package/tests/init-java/init-java.integtest.d.ts +1 -0
  235. package/tests/init-java/init-java.integtest.js +14 -0
  236. package/tests/init-java/init-java.integtest.ts +14 -0
  237. package/tests/init-javascript/init-javascript.integtest.d.ts +1 -0
  238. package/tests/init-javascript/init-javascript.integtest.js +53 -0
  239. package/tests/init-javascript/init-javascript.integtest.ts +59 -0
  240. package/tests/init-python/init-python.integtest.d.ts +1 -0
  241. package/tests/init-python/init-python.integtest.js +19 -0
  242. package/tests/init-python/init-python.integtest.ts +20 -0
  243. package/tests/init-typescript-app/init-typescript-app.integtest.d.ts +1 -0
  244. package/tests/init-typescript-app/init-typescript-app.integtest.js +54 -0
  245. package/tests/init-typescript-app/init-typescript-app.integtest.ts +66 -0
  246. package/tests/init-typescript-lib/init-typescript-lib.integtest.d.ts +1 -0
  247. package/tests/init-typescript-lib/init-typescript-lib.integtest.js +13 -0
  248. package/tests/init-typescript-lib/init-typescript-lib.integtest.ts +13 -0
  249. package/tests/tool-integrations/amplify.integtest.d.ts +1 -0
  250. package/tests/tool-integrations/amplify.integtest.js +39 -0
  251. package/tests/tool-integrations/amplify.integtest.ts +43 -0
  252. package/tests/tool-integrations/with-tool-context.d.ts +9 -0
  253. package/tests/tool-integrations/with-tool-context.js +13 -0
  254. package/tests/tool-integrations/with-tool-context.ts +14 -0
  255. package/tests/uberpackage/uberpackage.integtest.d.ts +1 -0
  256. package/tests/uberpackage/uberpackage.integtest.js +11 -0
  257. package/tests/uberpackage/uberpackage.integtest.ts +11 -0
@@ -0,0 +1,35 @@
1
+ import * as fs from 'fs';
2
+ import * as os from 'os';
3
+ import * as path from 'path';
4
+ import { TestContext } from './integ-test';
5
+ import { rimraf } from './shell';
6
+
7
+ export interface TemporaryDirectoryContext {
8
+ readonly integTestDir: string;
9
+ }
10
+
11
+ export function withTemporaryDirectory<A extends TestContext>(block: (context: A & TemporaryDirectoryContext) => Promise<void>) {
12
+ return async (context: A) => {
13
+ const integTestDir = path.join(os.tmpdir(), `cdk-integ-${context.randomString}`);
14
+
15
+ fs.mkdirSync(integTestDir, { recursive: true });
16
+
17
+ try {
18
+ await block({
19
+ ...context,
20
+ integTestDir,
21
+ });
22
+
23
+ // Clean up in case of success
24
+ if (process.env.SKIP_CLEANUP) {
25
+ context.log(`Left test directory in '${integTestDir}' ($SKIP_CLEANUP)\n`);
26
+ } else {
27
+ rimraf(integTestDir);
28
+ }
29
+ } catch (e) {
30
+ context.log(`Left test directory in '${integTestDir}'\n`);
31
+ throw e;
32
+ }
33
+ };
34
+ }
35
+
@@ -0,0 +1,19 @@
1
+ /**
2
+ * Run a block with a timeout
3
+ *
4
+ * We can't use the jest timeout feature:
5
+ *
6
+ * - `jest.concurrent()` does not do any concurrency management. It starts all
7
+ * tests at the same time.
8
+ * - Our tests use locking to make sure only one test is running at a time per
9
+ * region.
10
+ *
11
+ * The wait time for the locks is included in the jest test timeout. We therefore
12
+ * need to set it unreasonably high (as long as the last test may need to wait
13
+ * if all tests are executed using only 1 region, and they effectively execute
14
+ * sequentially), which makes it not useful to detect stuck tests.
15
+ *
16
+ * The `withTimeout()` modifier makes it possible to measure only a specific
17
+ * block of code. In our case: the effective test code, excluding the wait time.
18
+ */
19
+ export declare function withTimeout<A>(seconds: number, block: (x: A) => Promise<void>): (x: A) => Promise<void>;
@@ -0,0 +1,34 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.withTimeout = withTimeout;
4
+ /**
5
+ * Run a block with a timeout
6
+ *
7
+ * We can't use the jest timeout feature:
8
+ *
9
+ * - `jest.concurrent()` does not do any concurrency management. It starts all
10
+ * tests at the same time.
11
+ * - Our tests use locking to make sure only one test is running at a time per
12
+ * region.
13
+ *
14
+ * The wait time for the locks is included in the jest test timeout. We therefore
15
+ * need to set it unreasonably high (as long as the last test may need to wait
16
+ * if all tests are executed using only 1 region, and they effectively execute
17
+ * sequentially), which makes it not useful to detect stuck tests.
18
+ *
19
+ * The `withTimeout()` modifier makes it possible to measure only a specific
20
+ * block of code. In our case: the effective test code, excluding the wait time.
21
+ */
22
+ function withTimeout(seconds, block) {
23
+ return (x) => {
24
+ const timeOut = new Promise((_ok, ko) => {
25
+ const timerHandle = setTimeout(() => ko(new Error(`Timeout: test took more than ${seconds}s to complete`)), seconds * 1000);
26
+ timerHandle.unref();
27
+ });
28
+ return Promise.race([
29
+ block(x),
30
+ timeOut,
31
+ ]);
32
+ };
33
+ }
34
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoid2l0aC10aW1lb3V0LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsid2l0aC10aW1lb3V0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBa0JBLGtDQWNDO0FBaENEOzs7Ozs7Ozs7Ozs7Ozs7OztHQWlCRztBQUNILFNBQWdCLFdBQVcsQ0FBSSxPQUFlLEVBQUUsS0FBOEI7SUFDNUUsT0FBTyxDQUFDLENBQUksRUFBRSxFQUFFO1FBQ2QsTUFBTSxPQUFPLEdBQUcsSUFBSSxPQUFPLENBQU8sQ0FBQyxHQUFHLEVBQUUsRUFBRSxFQUFFLEVBQUU7WUFDNUMsTUFBTSxXQUFXLEdBQUcsVUFBVSxDQUM1QixHQUFHLEVBQUUsQ0FBQyxFQUFFLENBQUMsSUFBSSxLQUFLLENBQUMsZ0NBQWdDLE9BQU8sZUFBZSxDQUFDLENBQUMsRUFDM0UsT0FBTyxHQUFHLElBQUksQ0FBQyxDQUFDO1lBQ2xCLFdBQVcsQ0FBQyxLQUFLLEVBQUUsQ0FBQztRQUN0QixDQUFDLENBQUMsQ0FBQztRQUVILE9BQU8sT0FBTyxDQUFDLElBQUksQ0FBQztZQUNsQixLQUFLLENBQUMsQ0FBQyxDQUFDO1lBQ1IsT0FBTztTQUNSLENBQUMsQ0FBQztJQUNMLENBQUMsQ0FBQztBQUNKLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyIvKipcbiAqIFJ1biBhIGJsb2NrIHdpdGggYSB0aW1lb3V0XG4gKlxuICogV2UgY2FuJ3QgdXNlIHRoZSBqZXN0IHRpbWVvdXQgZmVhdHVyZTpcbiAqXG4gKiAtIGBqZXN0LmNvbmN1cnJlbnQoKWAgZG9lcyBub3QgZG8gYW55IGNvbmN1cnJlbmN5IG1hbmFnZW1lbnQuIEl0IHN0YXJ0cyBhbGxcbiAqICAgdGVzdHMgYXQgdGhlIHNhbWUgdGltZS5cbiAqIC0gT3VyIHRlc3RzIHVzZSBsb2NraW5nIHRvIG1ha2Ugc3VyZSBvbmx5IG9uZSB0ZXN0IGlzIHJ1bm5pbmcgYXQgYSB0aW1lIHBlclxuICogICByZWdpb24uXG4gKlxuICogVGhlIHdhaXQgdGltZSBmb3IgdGhlIGxvY2tzIGlzIGluY2x1ZGVkIGluIHRoZSBqZXN0IHRlc3QgdGltZW91dC4gV2UgdGhlcmVmb3JlXG4gKiBuZWVkIHRvIHNldCBpdCB1bnJlYXNvbmFibHkgaGlnaCAoYXMgbG9uZyBhcyB0aGUgbGFzdCB0ZXN0IG1heSBuZWVkIHRvIHdhaXRcbiAqIGlmIGFsbCB0ZXN0cyBhcmUgZXhlY3V0ZWQgdXNpbmcgb25seSAxIHJlZ2lvbiwgYW5kIHRoZXkgZWZmZWN0aXZlbHkgZXhlY3V0ZVxuICogc2VxdWVudGlhbGx5KSwgd2hpY2ggbWFrZXMgaXQgbm90IHVzZWZ1bCB0byBkZXRlY3Qgc3R1Y2sgdGVzdHMuXG4gKlxuICogVGhlIGB3aXRoVGltZW91dCgpYCBtb2RpZmllciBtYWtlcyBpdCBwb3NzaWJsZSB0byBtZWFzdXJlIG9ubHkgYSBzcGVjaWZpY1xuICogYmxvY2sgb2YgY29kZS4gSW4gb3VyIGNhc2U6IHRoZSBlZmZlY3RpdmUgdGVzdCBjb2RlLCBleGNsdWRpbmcgdGhlIHdhaXQgdGltZS5cbiAqL1xuZXhwb3J0IGZ1bmN0aW9uIHdpdGhUaW1lb3V0PEE+KHNlY29uZHM6IG51bWJlciwgYmxvY2s6ICh4OiBBKSA9PiBQcm9taXNlPHZvaWQ+KSB7XG4gIHJldHVybiAoeDogQSkgPT4ge1xuICAgIGNvbnN0IHRpbWVPdXQgPSBuZXcgUHJvbWlzZTx2b2lkPigoX29rLCBrbykgPT4ge1xuICAgICAgY29uc3QgdGltZXJIYW5kbGUgPSBzZXRUaW1lb3V0KFxuICAgICAgICAoKSA9PiBrbyhuZXcgRXJyb3IoYFRpbWVvdXQ6IHRlc3QgdG9vayBtb3JlIHRoYW4gJHtzZWNvbmRzfXMgdG8gY29tcGxldGVgKSksXG4gICAgICAgIHNlY29uZHMgKiAxMDAwKTtcbiAgICAgIHRpbWVySGFuZGxlLnVucmVmKCk7XG4gICAgfSk7XG5cbiAgICByZXR1cm4gUHJvbWlzZS5yYWNlKFtcbiAgICAgIGJsb2NrKHgpLFxuICAgICAgdGltZU91dCxcbiAgICBdKTtcbiAgfTtcbn1cbiJdfQ==
@@ -0,0 +1,33 @@
1
+ /**
2
+ * Run a block with a timeout
3
+ *
4
+ * We can't use the jest timeout feature:
5
+ *
6
+ * - `jest.concurrent()` does not do any concurrency management. It starts all
7
+ * tests at the same time.
8
+ * - Our tests use locking to make sure only one test is running at a time per
9
+ * region.
10
+ *
11
+ * The wait time for the locks is included in the jest test timeout. We therefore
12
+ * need to set it unreasonably high (as long as the last test may need to wait
13
+ * if all tests are executed using only 1 region, and they effectively execute
14
+ * sequentially), which makes it not useful to detect stuck tests.
15
+ *
16
+ * The `withTimeout()` modifier makes it possible to measure only a specific
17
+ * block of code. In our case: the effective test code, excluding the wait time.
18
+ */
19
+ export function withTimeout<A>(seconds: number, block: (x: A) => Promise<void>) {
20
+ return (x: A) => {
21
+ const timeOut = new Promise<void>((_ok, ko) => {
22
+ const timerHandle = setTimeout(
23
+ () => ko(new Error(`Timeout: test took more than ${seconds}s to complete`)),
24
+ seconds * 1000);
25
+ timerHandle.unref();
26
+ });
27
+
28
+ return Promise.race([
29
+ block(x),
30
+ timeOut,
31
+ ]);
32
+ };
33
+ }
@@ -0,0 +1,43 @@
1
+ export declare class XpMutexPool {
2
+ readonly directory: string;
3
+ static fromDirectory(directory: string): XpMutexPool;
4
+ static fromName(name: string): XpMutexPool;
5
+ private readonly waitingResolvers;
6
+ private watcher;
7
+ private constructor();
8
+ mutex(name: string): XpMutex;
9
+ /**
10
+ * Await an unlock event
11
+ *
12
+ * (An unlock event is when a file in the directory gets deleted, with a tiny
13
+ * random sleep attached to it).
14
+ */
15
+ awaitUnlock(maxWaitMs?: number): Promise<void>;
16
+ private startWatch;
17
+ private notifyWaiters;
18
+ }
19
+ /**
20
+ * Cross-process mutex
21
+ *
22
+ * Uses the presence of a file on disk and `fs.watch` to represent the mutex
23
+ * and discover unlocks.
24
+ */
25
+ export declare class XpMutex {
26
+ private readonly pool;
27
+ readonly mutexName: string;
28
+ private readonly fileName;
29
+ constructor(pool: XpMutexPool, mutexName: string);
30
+ /**
31
+ * Try to acquire the lock (may fail)
32
+ */
33
+ tryAcquire(): Promise<ILock | undefined>;
34
+ /**
35
+ * Acquire the lock, waiting until we can
36
+ */
37
+ acquire(): Promise<ILock>;
38
+ private readPidFile;
39
+ private writePidFile;
40
+ }
41
+ export interface ILock {
42
+ release(): Promise<void>;
43
+ }
package/lib/xpmutex.js ADDED
@@ -0,0 +1,207 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.XpMutex = exports.XpMutexPool = void 0;
4
+ const fs_1 = require("fs");
5
+ const os = require("os");
6
+ const path = require("path");
7
+ class XpMutexPool {
8
+ static fromDirectory(directory) {
9
+ (0, fs_1.mkdirSync)(directory, { recursive: true });
10
+ return new XpMutexPool(directory);
11
+ }
12
+ static fromName(name) {
13
+ return XpMutexPool.fromDirectory(path.join(os.tmpdir(), name));
14
+ }
15
+ constructor(directory) {
16
+ this.directory = directory;
17
+ this.waitingResolvers = new Set();
18
+ this.startWatch();
19
+ }
20
+ mutex(name) {
21
+ return new XpMutex(this, name);
22
+ }
23
+ /**
24
+ * Await an unlock event
25
+ *
26
+ * (An unlock event is when a file in the directory gets deleted, with a tiny
27
+ * random sleep attached to it).
28
+ */
29
+ awaitUnlock(maxWaitMs) {
30
+ const wait = new Promise(ok => {
31
+ this.waitingResolvers.add(async () => {
32
+ await randomSleep(10);
33
+ ok();
34
+ });
35
+ });
36
+ if (maxWaitMs) {
37
+ return Promise.race([wait, sleep(maxWaitMs)]);
38
+ }
39
+ else {
40
+ return wait;
41
+ }
42
+ }
43
+ startWatch() {
44
+ this.watcher = (0, fs_1.watch)(this.directory);
45
+ this.watcher.unref(); // @types doesn't know about this but it exists
46
+ this.watcher.on('change', async (eventType, fname) => {
47
+ // Only trigger on 'deletes'.
48
+ // After receiving the event, we check if the file exists.
49
+ // - If no: the file was deleted! Huzzah, this counts as a wakeup.
50
+ // - If yes: either the file was just created (in which case we don't need to wakeup)
51
+ // or the event was due to a delete but someone raced us to it and claimed the
52
+ // file already (in which case we also don't need to wake up).
53
+ if (eventType === 'rename' && !await fileExists(path.join(this.directory, fname.toString()))) {
54
+ this.notifyWaiters();
55
+ }
56
+ });
57
+ this.watcher.on('error', async (e) => {
58
+ // eslint-disable-next-line no-console
59
+ console.error(e);
60
+ await randomSleep(100);
61
+ this.startWatch();
62
+ });
63
+ }
64
+ notifyWaiters() {
65
+ for (const promise of this.waitingResolvers) {
66
+ promise();
67
+ }
68
+ this.waitingResolvers.clear();
69
+ }
70
+ }
71
+ exports.XpMutexPool = XpMutexPool;
72
+ /**
73
+ * Cross-process mutex
74
+ *
75
+ * Uses the presence of a file on disk and `fs.watch` to represent the mutex
76
+ * and discover unlocks.
77
+ */
78
+ class XpMutex {
79
+ constructor(pool, mutexName) {
80
+ this.pool = pool;
81
+ this.mutexName = mutexName;
82
+ this.fileName = path.join(pool.directory, `${mutexName}.mutex`);
83
+ }
84
+ /**
85
+ * Try to acquire the lock (may fail)
86
+ */
87
+ async tryAcquire() {
88
+ while (true) {
89
+ // Acquire lock by being the one to create the file
90
+ try {
91
+ return await this.writePidFile('wx'); // Fails if the file already exists
92
+ }
93
+ catch (e) {
94
+ if (e.code !== 'EEXIST') {
95
+ throw e;
96
+ }
97
+ }
98
+ // File already exists. Read the contents, see if it's an existent PID (if so, the lock is taken)
99
+ const ownerPid = await this.readPidFile();
100
+ if (ownerPid === undefined) {
101
+ // File got deleted just now, maybe we can acquire it again
102
+ continue;
103
+ }
104
+ if (processExists(ownerPid)) {
105
+ return undefined;
106
+ }
107
+ // If not, the lock is stale and will never be released anymore. We may
108
+ // delete it and acquire it anyway, but we may be racing someone else trying
109
+ // to do the same. Solve this as follows:
110
+ // - Try to acquire a lock that gives us permissions to declare the existing lock stale.
111
+ // - Sleep a small random period to reduce contention on this operation
112
+ await randomSleep(10);
113
+ const innerMux = new XpMutex(this.pool, `${this.mutexName}.${ownerPid}`);
114
+ const innerLock = await innerMux.tryAcquire();
115
+ if (!innerLock) {
116
+ return undefined;
117
+ }
118
+ // We may not release the 'inner lock' we used to acquire the rights to declare the other
119
+ // lock stale until we release the actual lock itself. If we did, other contenders might
120
+ // see it released while they're still in this fallback block and accidentally steal
121
+ // from a new legitimate owner.
122
+ return this.writePidFile('w', innerLock); // Force write lock file, attach inner lock as well
123
+ }
124
+ }
125
+ /**
126
+ * Acquire the lock, waiting until we can
127
+ */
128
+ async acquire() {
129
+ while (true) {
130
+ // Start the wait here, so we don't miss the signal if it comes after
131
+ // we try but before we sleep.
132
+ //
133
+ // We also periodically retry anyway since we may have missed the delete
134
+ // signal due to unfortunate timing.
135
+ const wait = this.pool.awaitUnlock(5000);
136
+ const lock = await this.tryAcquire();
137
+ if (lock) {
138
+ // Ignore the wait (count as handled)
139
+ wait.then(() => { }, () => { });
140
+ return lock;
141
+ }
142
+ await wait;
143
+ await randomSleep(100);
144
+ }
145
+ }
146
+ async readPidFile() {
147
+ const deadLine = Date.now() + 1000;
148
+ while (Date.now() < deadLine) {
149
+ let contents;
150
+ try {
151
+ contents = await fs_1.promises.readFile(this.fileName, { encoding: 'utf-8' });
152
+ }
153
+ catch (e) {
154
+ if (e.code === 'ENOENT') {
155
+ return undefined;
156
+ }
157
+ throw e;
158
+ }
159
+ // Retry until we've seen the full contents
160
+ if (contents.endsWith('.')) {
161
+ return parseInt(contents.substring(0, contents.length - 1), 10);
162
+ }
163
+ await sleep(10);
164
+ }
165
+ throw new Error(`${this.fileName} was never completely written`);
166
+ }
167
+ async writePidFile(mode, additionalLock) {
168
+ const fd = await fs_1.promises.open(this.fileName, mode); // May fail if the file already exists
169
+ await fd.write(`${process.pid}.`); // Period guards against partial reads
170
+ await fd.close();
171
+ return {
172
+ release: async () => {
173
+ await fs_1.promises.unlink(this.fileName);
174
+ await (additionalLock === null || additionalLock === void 0 ? void 0 : additionalLock.release());
175
+ },
176
+ };
177
+ }
178
+ }
179
+ exports.XpMutex = XpMutex;
180
+ async function fileExists(fileName) {
181
+ try {
182
+ await fs_1.promises.stat(fileName);
183
+ return true;
184
+ }
185
+ catch (e) {
186
+ if (e.code === 'ENOENT') {
187
+ return false;
188
+ }
189
+ throw e;
190
+ }
191
+ }
192
+ function processExists(pid) {
193
+ try {
194
+ process.kill(pid, 0);
195
+ return true;
196
+ }
197
+ catch {
198
+ return false;
199
+ }
200
+ }
201
+ function sleep(ms) {
202
+ return new Promise(ok => setTimeout(ok, ms).unref());
203
+ }
204
+ function randomSleep(ms) {
205
+ return sleep(Math.floor(Math.random() * ms));
206
+ }
207
+ //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"xpmutex.js","sourceRoot":"","sources":["xpmutex.ts"],"names":[],"mappings":";;;AAAA,2BAAsD;AACtD,yBAAyB;AACzB,6BAA6B;AAE7B,MAAa,WAAW;IACf,MAAM,CAAC,aAAa,CAAC,SAAiB;QAC3C,IAAA,cAAS,EAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1C,OAAO,IAAI,WAAW,CAAC,SAAS,CAAC,CAAC;IACpC,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,IAAY;QACjC,OAAO,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;IACjE,CAAC;IAKD,YAAoC,SAAiB;QAAjB,cAAS,GAAT,SAAS,CAAQ;QAHpC,qBAAgB,GAAG,IAAI,GAAG,EAAc,CAAC;QAIxD,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAEM,KAAK,CAAC,IAAY;QACvB,OAAO,IAAI,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAAC,SAAkB;QACnC,MAAM,IAAI,GAAG,IAAI,OAAO,CAAO,EAAE,CAAC,EAAE;YAClC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;gBACnC,MAAM,WAAW,CAAC,EAAE,CAAC,CAAC;gBACtB,EAAE,EAAE,CAAC;YACP,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,SAAS,EAAE,CAAC;YACd,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAChD,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAEO,UAAU;QAChB,IAAI,CAAC,OAAO,GAAG,IAAA,UAAK,EAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACpC,IAAI,CAAC,OAAe,CAAC,KAAK,EAAE,CAAC,CAAC,+CAA+C;QAC9E,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE;YACnD,6BAA6B;YAC7B,0DAA0D;YAC1D,kEAAkE;YAClE,qFAAqF;YACrF,gFAAgF;YAChF,gEAAgE;YAChE,IAAI,SAAS,KAAK,QAAQ,IAAI,CAAC,MAAM,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC;gBAC7F,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,CAAC;QACH,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;YACnC,sCAAsC;YACtC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACjB,MAAM,WAAW,CAAC,GAAG,CAAC,CAAC;YACvB,IAAI,CAAC,UAAU,EAAE,CAAC;QACpB,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,aAAa;QACnB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC5C,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;IAChC,CAAC;CACF;AAtED,kCAsEC;AAED;;;;;GAKG;AACH,MAAa,OAAO;IAGlB,YAA6B,IAAiB,EAAkB,SAAiB;QAApD,SAAI,GAAJ,IAAI,CAAa;QAAkB,cAAS,GAAT,SAAS,CAAQ;QAC/E,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,SAAS,QAAQ,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,UAAU;QACrB,OAAO,IAAI,EAAE,CAAC;YACZ,mDAAmD;YACnD,IAAI,CAAC;gBACH,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,mCAAmC;YAC3E,CAAC;YAAC,OAAO,CAAM,EAAE,CAAC;gBAChB,IAAI,CAAC,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAAC,MAAM,CAAC,CAAC;gBAAC,CAAC;YACvC,CAAC;YAED,iGAAiG;YACjG,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YAC1C,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAC3B,2DAA2D;gBAC3D,SAAS;YACX,CAAC;YACD,IAAI,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC5B,OAAO,SAAS,CAAC;YACnB,CAAC;YAED,uEAAuE;YACvE,4EAA4E;YAC5E,yCAAyC;YACzC,wFAAwF;YACxF,uEAAuE;YACvE,MAAM,WAAW,CAAC,EAAE,CAAC,CAAC;YACtB,MAAM,QAAQ,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,SAAS,IAAI,QAAQ,EAAE,CAAC,CAAC;YACzE,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,UAAU,EAAE,CAAC;YAC9C,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,OAAO,SAAS,CAAC;YACnB,CAAC;YAED,yFAAyF;YACzF,wFAAwF;YACxF,oFAAoF;YACpF,+BAA+B;YAC/B,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC,mDAAmD;QAC/F,CAAC;IACH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAO;QAClB,OAAO,IAAI,EAAE,CAAC;YACZ,qEAAqE;YACrE,8BAA8B;YAC9B,EAAE;YACF,wEAAwE;YACxE,oCAAoC;YACpC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YAEzC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;YACrC,IAAI,IAAI,EAAE,CAAC;gBACT,qCAAqC;gBACrC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAE,CAAC,EAAE,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;gBAC9B,OAAO,IAAI,CAAC;YACd,CAAC;YAED,MAAM,IAAI,CAAC;YACX,MAAM,WAAW,CAAC,GAAG,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,WAAW;QACvB,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;QACnC,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,QAAQ,EAAE,CAAC;YAC7B,IAAI,QAAQ,CAAC;YACb,IAAI,CAAC;gBACH,QAAQ,GAAG,MAAM,aAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;YACrE,CAAC;YAAC,OAAO,CAAM,EAAE,CAAC;gBAChB,IAAI,CAAC,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAAC,OAAO,SAAS,CAAC;gBAAC,CAAC;gBAC9C,MAAM,CAAC,CAAC;YACV,CAAC;YAED,2CAA2C;YAC3C,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBAAC,OAAO,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YAAC,CAAC;YAChG,MAAM,KAAK,CAAC,EAAE,CAAC,CAAC;QAClB,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,QAAQ,+BAA+B,CAAC,CAAC;IACnE,CAAC;IAEO,KAAK,CAAC,YAAY,CAAC,IAAY,EAAE,cAAsB;QAC7D,MAAM,EAAE,GAAG,MAAM,aAAE,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,sCAAsC;QACrF,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,sCAAsC;QACzE,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC;QAEjB,OAAO;YACL,OAAO,EAAE,KAAK,IAAI,EAAE;gBAClB,MAAM,aAAE,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAC/B,MAAM,CAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,OAAO,EAAE,CAAA,CAAC;YAClC,CAAC;SACF,CAAC;IACJ,CAAC;CACF;AAxGD,0BAwGC;AAMD,KAAK,UAAU,UAAU,CAAC,QAAgB;IACxC,IAAI,CAAC;QACH,MAAM,aAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,IAAI,CAAC,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAAC,OAAO,KAAK,CAAC;QAAC,CAAC;QAC1C,MAAM,CAAC,CAAC;IACV,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CAAC,GAAW;IAChC,IAAI,CAAC;QACH,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,SAAS,KAAK,CAAC,EAAU;IACvB,OAAO,IAAI,OAAO,CAAC,EAAE,CAAC,EAAE,CAAE,UAAU,CAAC,EAAE,EAAE,EAAE,CAAS,CAAC,KAAK,EAAE,CAAC,CAAC;AAChE,CAAC;AAED,SAAS,WAAW,CAAC,EAAU;IAC7B,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;AAC/C,CAAC","sourcesContent":["import { watch, promises as fs, mkdirSync } from 'fs';\nimport * as os from 'os';\nimport * as path from 'path';\n\nexport class XpMutexPool {\n  public static fromDirectory(directory: string) {\n    mkdirSync(directory, { recursive: true });\n    return new XpMutexPool(directory);\n  }\n\n  public static fromName(name: string) {\n    return XpMutexPool.fromDirectory(path.join(os.tmpdir(), name));\n  }\n\n  private readonly waitingResolvers = new Set<() => void>();\n  private watcher: ReturnType<typeof watch> | undefined;\n\n  private constructor(public readonly directory: string) {\n    this.startWatch();\n  }\n\n  public mutex(name: string) {\n    return new XpMutex(this, name);\n  }\n\n  /**\n   * Await an unlock event\n   *\n   * (An unlock event is when a file in the directory gets deleted, with a tiny\n   * random sleep attached to it).\n   */\n  public awaitUnlock(maxWaitMs?: number): Promise<void> {\n    const wait = new Promise<void>(ok => {\n      this.waitingResolvers.add(async () => {\n        await randomSleep(10);\n        ok();\n      });\n    });\n\n    if (maxWaitMs) {\n      return Promise.race([wait, sleep(maxWaitMs)]);\n    } else {\n      return wait;\n    }\n  }\n\n  private startWatch() {\n    this.watcher = watch(this.directory);\n    (this.watcher as any).unref(); // @types doesn't know about this but it exists\n    this.watcher.on('change', async (eventType, fname) => {\n      // Only trigger on 'deletes'.\n      // After receiving the event, we check if the file exists.\n      // - If no: the file was deleted! Huzzah, this counts as a wakeup.\n      // - If yes: either the file was just created (in which case we don't need to wakeup)\n      //   or the event was due to a delete but someone raced us to it and claimed the\n      //   file already (in which case we also don't need to wake up).\n      if (eventType === 'rename' && !await fileExists(path.join(this.directory, fname.toString()))) {\n        this.notifyWaiters();\n      }\n    });\n    this.watcher.on('error', async (e) => {\n      // eslint-disable-next-line no-console\n      console.error(e);\n      await randomSleep(100);\n      this.startWatch();\n    });\n  }\n\n  private notifyWaiters() {\n    for (const promise of this.waitingResolvers) {\n      promise();\n    }\n    this.waitingResolvers.clear();\n  }\n}\n\n/**\n * Cross-process mutex\n *\n * Uses the presence of a file on disk and `fs.watch` to represent the mutex\n * and discover unlocks.\n */\nexport class XpMutex {\n  private readonly fileName: string;\n\n  constructor(private readonly pool: XpMutexPool, public readonly mutexName: string) {\n    this.fileName = path.join(pool.directory, `${mutexName}.mutex`);\n  }\n\n  /**\n   * Try to acquire the lock (may fail)\n   */\n  public async tryAcquire(): Promise<ILock | undefined> {\n    while (true) {\n      // Acquire lock by being the one to create the file\n      try {\n        return await this.writePidFile('wx'); // Fails if the file already exists\n      } catch (e: any) {\n        if (e.code !== 'EEXIST') { throw e; }\n      }\n\n      // File already exists. Read the contents, see if it's an existent PID (if so, the lock is taken)\n      const ownerPid = await this.readPidFile();\n      if (ownerPid === undefined) {\n        // File got deleted just now, maybe we can acquire it again\n        continue;\n      }\n      if (processExists(ownerPid)) {\n        return undefined;\n      }\n\n      // If not, the lock is stale and will never be released anymore. We may\n      // delete it and acquire it anyway, but we may be racing someone else trying\n      // to do the same. Solve this as follows:\n      // - Try to acquire a lock that gives us permissions to declare the existing lock stale.\n      // - Sleep a small random period to reduce contention on this operation\n      await randomSleep(10);\n      const innerMux = new XpMutex(this.pool, `${this.mutexName}.${ownerPid}`);\n      const innerLock = await innerMux.tryAcquire();\n      if (!innerLock) {\n        return undefined;\n      }\n\n      // We may not release the 'inner lock' we used to acquire the rights to declare the other\n      // lock stale until we release the actual lock itself. If we did, other contenders might\n      // see it released while they're still in this fallback block and accidentally steal\n      // from a new legitimate owner.\n      return this.writePidFile('w', innerLock); // Force write lock file, attach inner lock as well\n    }\n  }\n\n  /**\n   * Acquire the lock, waiting until we can\n   */\n  public async acquire(): Promise<ILock> {\n    while (true) {\n      // Start the wait here, so we don't miss the signal if it comes after\n      // we try but before we sleep.\n      //\n      // We also periodically retry anyway since we may have missed the delete\n      // signal due to unfortunate timing.\n      const wait = this.pool.awaitUnlock(5000);\n\n      const lock = await this.tryAcquire();\n      if (lock) {\n        // Ignore the wait (count as handled)\n        wait.then(() => {}, () => {});\n        return lock;\n      }\n\n      await wait;\n      await randomSleep(100);\n    }\n  }\n\n  private async readPidFile(): Promise<number | undefined> {\n    const deadLine = Date.now() + 1000;\n    while (Date.now() < deadLine) {\n      let contents;\n      try {\n        contents = await fs.readFile(this.fileName, { encoding: 'utf-8' });\n      } catch (e: any) {\n        if (e.code === 'ENOENT') { return undefined; }\n        throw e;\n      }\n\n      // Retry until we've seen the full contents\n      if (contents.endsWith('.')) { return parseInt(contents.substring(0, contents.length - 1), 10); }\n      await sleep(10);\n    }\n\n    throw new Error(`${this.fileName} was never completely written`);\n  }\n\n  private async writePidFile(mode: string, additionalLock?: ILock): Promise<ILock> {\n    const fd = await fs.open(this.fileName, mode); // May fail if the file already exists\n    await fd.write(`${process.pid}.`); // Period guards against partial reads\n    await fd.close();\n\n    return {\n      release: async () => {\n        await fs.unlink(this.fileName);\n        await additionalLock?.release();\n      },\n    };\n  }\n}\n\nexport interface ILock {\n  release(): Promise<void>;\n}\n\nasync function fileExists(fileName: string) {\n  try {\n    await fs.stat(fileName);\n    return true;\n  } catch (e: any) {\n    if (e.code === 'ENOENT') { return false; }\n    throw e;\n  }\n}\n\nfunction processExists(pid: number) {\n  try {\n    process.kill(pid, 0);\n    return true;\n  } catch {\n    return false;\n  }\n}\n\nfunction sleep(ms: number): Promise<void> {\n  return new Promise(ok => (setTimeout(ok, ms) as any).unref());\n}\n\nfunction randomSleep(ms: number) {\n  return sleep(Math.floor(Math.random() * ms));\n}\n"]}
package/lib/xpmutex.ts ADDED
@@ -0,0 +1,218 @@
1
+ import { watch, promises as fs, mkdirSync } from 'fs';
2
+ import * as os from 'os';
3
+ import * as path from 'path';
4
+
5
+ export class XpMutexPool {
6
+ public static fromDirectory(directory: string) {
7
+ mkdirSync(directory, { recursive: true });
8
+ return new XpMutexPool(directory);
9
+ }
10
+
11
+ public static fromName(name: string) {
12
+ return XpMutexPool.fromDirectory(path.join(os.tmpdir(), name));
13
+ }
14
+
15
+ private readonly waitingResolvers = new Set<() => void>();
16
+ private watcher: ReturnType<typeof watch> | undefined;
17
+
18
+ private constructor(public readonly directory: string) {
19
+ this.startWatch();
20
+ }
21
+
22
+ public mutex(name: string) {
23
+ return new XpMutex(this, name);
24
+ }
25
+
26
+ /**
27
+ * Await an unlock event
28
+ *
29
+ * (An unlock event is when a file in the directory gets deleted, with a tiny
30
+ * random sleep attached to it).
31
+ */
32
+ public awaitUnlock(maxWaitMs?: number): Promise<void> {
33
+ const wait = new Promise<void>(ok => {
34
+ this.waitingResolvers.add(async () => {
35
+ await randomSleep(10);
36
+ ok();
37
+ });
38
+ });
39
+
40
+ if (maxWaitMs) {
41
+ return Promise.race([wait, sleep(maxWaitMs)]);
42
+ } else {
43
+ return wait;
44
+ }
45
+ }
46
+
47
+ private startWatch() {
48
+ this.watcher = watch(this.directory);
49
+ (this.watcher as any).unref(); // @types doesn't know about this but it exists
50
+ this.watcher.on('change', async (eventType, fname) => {
51
+ // Only trigger on 'deletes'.
52
+ // After receiving the event, we check if the file exists.
53
+ // - If no: the file was deleted! Huzzah, this counts as a wakeup.
54
+ // - If yes: either the file was just created (in which case we don't need to wakeup)
55
+ // or the event was due to a delete but someone raced us to it and claimed the
56
+ // file already (in which case we also don't need to wake up).
57
+ if (eventType === 'rename' && !await fileExists(path.join(this.directory, fname.toString()))) {
58
+ this.notifyWaiters();
59
+ }
60
+ });
61
+ this.watcher.on('error', async (e) => {
62
+ // eslint-disable-next-line no-console
63
+ console.error(e);
64
+ await randomSleep(100);
65
+ this.startWatch();
66
+ });
67
+ }
68
+
69
+ private notifyWaiters() {
70
+ for (const promise of this.waitingResolvers) {
71
+ promise();
72
+ }
73
+ this.waitingResolvers.clear();
74
+ }
75
+ }
76
+
77
+ /**
78
+ * Cross-process mutex
79
+ *
80
+ * Uses the presence of a file on disk and `fs.watch` to represent the mutex
81
+ * and discover unlocks.
82
+ */
83
+ export class XpMutex {
84
+ private readonly fileName: string;
85
+
86
+ constructor(private readonly pool: XpMutexPool, public readonly mutexName: string) {
87
+ this.fileName = path.join(pool.directory, `${mutexName}.mutex`);
88
+ }
89
+
90
+ /**
91
+ * Try to acquire the lock (may fail)
92
+ */
93
+ public async tryAcquire(): Promise<ILock | undefined> {
94
+ while (true) {
95
+ // Acquire lock by being the one to create the file
96
+ try {
97
+ return await this.writePidFile('wx'); // Fails if the file already exists
98
+ } catch (e: any) {
99
+ if (e.code !== 'EEXIST') { throw e; }
100
+ }
101
+
102
+ // File already exists. Read the contents, see if it's an existent PID (if so, the lock is taken)
103
+ const ownerPid = await this.readPidFile();
104
+ if (ownerPid === undefined) {
105
+ // File got deleted just now, maybe we can acquire it again
106
+ continue;
107
+ }
108
+ if (processExists(ownerPid)) {
109
+ return undefined;
110
+ }
111
+
112
+ // If not, the lock is stale and will never be released anymore. We may
113
+ // delete it and acquire it anyway, but we may be racing someone else trying
114
+ // to do the same. Solve this as follows:
115
+ // - Try to acquire a lock that gives us permissions to declare the existing lock stale.
116
+ // - Sleep a small random period to reduce contention on this operation
117
+ await randomSleep(10);
118
+ const innerMux = new XpMutex(this.pool, `${this.mutexName}.${ownerPid}`);
119
+ const innerLock = await innerMux.tryAcquire();
120
+ if (!innerLock) {
121
+ return undefined;
122
+ }
123
+
124
+ // We may not release the 'inner lock' we used to acquire the rights to declare the other
125
+ // lock stale until we release the actual lock itself. If we did, other contenders might
126
+ // see it released while they're still in this fallback block and accidentally steal
127
+ // from a new legitimate owner.
128
+ return this.writePidFile('w', innerLock); // Force write lock file, attach inner lock as well
129
+ }
130
+ }
131
+
132
+ /**
133
+ * Acquire the lock, waiting until we can
134
+ */
135
+ public async acquire(): Promise<ILock> {
136
+ while (true) {
137
+ // Start the wait here, so we don't miss the signal if it comes after
138
+ // we try but before we sleep.
139
+ //
140
+ // We also periodically retry anyway since we may have missed the delete
141
+ // signal due to unfortunate timing.
142
+ const wait = this.pool.awaitUnlock(5000);
143
+
144
+ const lock = await this.tryAcquire();
145
+ if (lock) {
146
+ // Ignore the wait (count as handled)
147
+ wait.then(() => {}, () => {});
148
+ return lock;
149
+ }
150
+
151
+ await wait;
152
+ await randomSleep(100);
153
+ }
154
+ }
155
+
156
+ private async readPidFile(): Promise<number | undefined> {
157
+ const deadLine = Date.now() + 1000;
158
+ while (Date.now() < deadLine) {
159
+ let contents;
160
+ try {
161
+ contents = await fs.readFile(this.fileName, { encoding: 'utf-8' });
162
+ } catch (e: any) {
163
+ if (e.code === 'ENOENT') { return undefined; }
164
+ throw e;
165
+ }
166
+
167
+ // Retry until we've seen the full contents
168
+ if (contents.endsWith('.')) { return parseInt(contents.substring(0, contents.length - 1), 10); }
169
+ await sleep(10);
170
+ }
171
+
172
+ throw new Error(`${this.fileName} was never completely written`);
173
+ }
174
+
175
+ private async writePidFile(mode: string, additionalLock?: ILock): Promise<ILock> {
176
+ const fd = await fs.open(this.fileName, mode); // May fail if the file already exists
177
+ await fd.write(`${process.pid}.`); // Period guards against partial reads
178
+ await fd.close();
179
+
180
+ return {
181
+ release: async () => {
182
+ await fs.unlink(this.fileName);
183
+ await additionalLock?.release();
184
+ },
185
+ };
186
+ }
187
+ }
188
+
189
+ export interface ILock {
190
+ release(): Promise<void>;
191
+ }
192
+
193
+ async function fileExists(fileName: string) {
194
+ try {
195
+ await fs.stat(fileName);
196
+ return true;
197
+ } catch (e: any) {
198
+ if (e.code === 'ENOENT') { return false; }
199
+ throw e;
200
+ }
201
+ }
202
+
203
+ function processExists(pid: number) {
204
+ try {
205
+ process.kill(pid, 0);
206
+ return true;
207
+ } catch {
208
+ return false;
209
+ }
210
+ }
211
+
212
+ function sleep(ms: number): Promise<void> {
213
+ return new Promise(ok => (setTimeout(ok, ms) as any).unref());
214
+ }
215
+
216
+ function randomSleep(ms: number) {
217
+ return sleep(Math.floor(Math.random() * ms));
218
+ }