@dxos/lock-file 0.1.52-main.0e90c21

package/LICENSE

@@ -0,0 +1,8 @@
+MIT License 
+Copyright (c) 2022 DXOS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/lib/node/index.cjs

@@ -0,0 +1,72 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// packages/common/lock-file/src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  LockFile: () => LockFile
+});
+module.exports = __toCommonJS(src_exports);
+
+// packages/common/lock-file/src/lock-file.ts
+var import_fs_ext = require("fs-ext");
+var import_node_fs = require("node:fs");
+var import_promises = require("node:fs/promises");
+var LockFile = class {
+  static async acquire(filename) {
+    const handle = await (0, import_promises.open)(filename, import_node_fs.constants.O_CREAT);
+    await new Promise((resolve, reject) => {
+      (0, import_fs_ext.flock)(handle.fd, "exnb", (err) => {
+        if (err) {
+          reject(err);
+          return;
+        }
+        resolve();
+      });
+    });
+    return handle;
+  }
+  static async release(handle) {
+    await new Promise((resolve, reject) => {
+      (0, import_fs_ext.flock)(handle.fd, "un", (err) => {
+        if (err) {
+          reject(err);
+          return;
+        }
+        resolve();
+      });
+    });
+    await handle.close();
+  }
+  static async isLocked(filename) {
+    try {
+      const handle = await LockFile.acquire(filename);
+      await LockFile.release(handle);
+      await handle.close();
+      return false;
+    } catch (e) {
+      return true;
+    }
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  LockFile
+});
+//# sourceMappingURL=index.cjs.map

package/dist/lib/node/index.cjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/index.ts", "../../../src/lock-file.ts"],
+  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nexport * from './lock-file';\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { flock } from 'fs-ext';\nimport { constants } from 'node:fs';\nimport { open, FileHandle } from 'node:fs/promises';\n\nexport class LockFile {\n  static async acquire(filename: string): Promise<FileHandle> {\n    const handle = await open(filename, constants.O_CREAT);\n    await new Promise<void>((resolve, reject) => {\n      flock(handle.fd, 'exnb', (err) => {\n        if (err) {\n          reject(err);\n          return;\n        }\n        resolve();\n      });\n    });\n    return handle;\n  }\n\n  static async release(handle: FileHandle): Promise<void> {\n    await new Promise<void>((resolve, reject) => {\n      flock(handle.fd, 'un', (err) => {\n        if (err) {\n          reject(err);\n          return;\n        }\n        resolve();\n      });\n    });\n    await handle.close();\n  }\n\n  static async isLocked(filename: string): Promise<boolean> {\n    try {\n      const handle = await LockFile.acquire(filename);\n      await LockFile.release(handle);\n      await handle.close();\n\n      return false;\n    } catch (e) {\n      return true;\n    }\n  }\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;ACIA,oBAAsB;AACtB,qBAA0B;AAC1B,sBAAiC;AAE1B,IAAMA,WAAN,MAAMA;EACX,aAAaC,QAAQC,UAAuC;AAC1D,UAAMC,SAAS,UAAMC,sBAAKF,UAAUG,yBAAUC,OAAO;AACrD,UAAM,IAAIC,QAAc,CAACC,SAASC,WAAW;AAC3CC,+BAAMP,OAAOQ,IAAI,QAAQ,CAACC,QAAQ;AAChC,YAAIA,KAAK;AACPH,iBAAOG,GAAAA;AACP;QACF;AACAJ,gBAAAA;MACF,CAAA;IACF,CAAA;AACA,WAAOL;EACT;EAEA,aAAaU,QAAQV,QAAmC;AACtD,UAAM,IAAII,QAAc,CAACC,SAASC,WAAW;AAC3CC,+BAAMP,OAAOQ,IAAI,MAAM,CAACC,QAAQ;AAC9B,YAAIA,KAAK;AACPH,iBAAOG,GAAAA;AACP;QACF;AACAJ,gBAAAA;MACF,CAAA;IACF,CAAA;AACA,UAAML,OAAOW,MAAK;EACpB;EAEA,aAAaC,SAASb,UAAoC;AACxD,QAAI;AACF,YAAMC,SAAS,MAAMH,SAASC,QAAQC,QAAAA;AACtC,YAAMF,SAASa,QAAQV,MAAAA;AACvB,YAAMA,OAAOW,MAAK;AAElB,aAAO;IACT,SAASE,GAAP;AACA,aAAO;IACT;EACF;AACF;",
+  "names": ["LockFile", "acquire", "filename", "handle", "open", "constants", "O_CREAT", "Promise", "resolve", "reject", "flock", "fd", "err", "release", "close", "isLocked", "e"]
+}

package/dist/lib/node/meta.json

@@ -0,0 +1 @@
+{"inputs":{"packages/common/lock-file/src/lock-file.ts":{"bytes":4071,"imports":[{"path":"fs-ext","kind":"import-statement","external":true},{"path":"node:fs","kind":"import-statement","external":true},{"path":"node:fs/promises","kind":"import-statement","external":true}]},"packages/common/lock-file/src/index.ts":{"bytes":377,"imports":[{"path":"packages/common/lock-file/src/lock-file.ts","kind":"import-statement","original":"./lock-file"}]}},"outputs":{"packages/common/lock-file/dist/lib/node/index.cjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":2241},"packages/common/lock-file/dist/lib/node/index.cjs":{"imports":[{"path":"fs-ext","kind":"require-call","external":true},{"path":"node:fs","kind":"require-call","external":true},{"path":"node:fs/promises","kind":"require-call","external":true}],"exports":[],"entryPoint":"packages/common/lock-file/src/index.ts","inputs":{"packages/common/lock-file/src/index.ts":{"bytesInOutput":121},"packages/common/lock-file/src/lock-file.ts":{"bytesInOutput":1032}},"bytes":2179}}}

package/dist/types/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from './lock-file';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAIA,cAAc,aAAa,CAAC"}

package/dist/types/src/lock-file.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="node" />
+import { FileHandle } from 'node:fs/promises';
+export declare class LockFile {
+    static acquire(filename: string): Promise<FileHandle>;
+    static release(handle: FileHandle): Promise<void>;
+    static isLocked(filename: string): Promise<boolean>;
+}
+//# sourceMappingURL=lock-file.d.ts.map

package/dist/types/src/lock-file.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lock-file.d.ts","sourceRoot":"","sources":["../../../src/lock-file.ts"],"names":[],"mappings":";AAMA,OAAO,EAAQ,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEpD,qBAAa,QAAQ;WACN,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;WAc9C,OAAO,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;WAa1C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;CAW1D"}

package/dist/types/src/lock-file.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=lock-file.test.d.ts.map

package/dist/types/src/lock-file.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lock-file.test.d.ts","sourceRoot":"","sources":["../../../src/lock-file.test.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@dxos/lock-file",
+  "version": "0.1.52-main.0e90c21",
+  "description": "Lock file .",
+  "homepage": "https://dxos.org",
+  "bugs": "https://github.com/dxos/dxos/issues",
+  "license": "MIT",
+  "author": "DXOS.org",
+  "main": "./dist/lib/node/index.cjs",
+  "types": "./dist/types/src/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "dependencies": {
+    "fs-ext": "^2.0.0",
+    "@dxos/async": "0.1.52-main.0e90c21",
+    "@dxos/log": "0.1.52-main.0e90c21",
+    "@dxos/node-std": "0.1.52-main.0e90c21"
+  },
+  "devDependencies": {
+    "@types/fs-ext": "^2.0.0",
+    "@types/node": "^18.11.9",
+    "ts-node": "10.9.1",
+    "typescript": "^5.0.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+export * from './lock-file';

package/src/lock-file.test.ts

@@ -0,0 +1,72 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import chai, { expect } from 'chai';
+import chaiAsPromised from 'chai-as-promised';
+import { spawn } from 'node:child_process';
+import { join } from 'node:path';
+
+import { sleep } from '@dxos/async';
+import { describe, test } from '@dxos/test';
+
+import { LockFile } from './lock-file';
+
+chai.use(chaiAsPromised);
+
+describe('LockFile', () => {
+  test('basic', async () => {
+    const filename = join('/tmp', `lock-${Math.random()}.lock`);
+
+    const handle = await LockFile.acquire(filename);
+    await expect(LockFile.acquire(filename)).to.be.rejected;
+    await LockFile.release(handle);
+
+    const handle2 = await LockFile.acquire(filename);
+    await LockFile.release(handle2);
+  });
+
+  test('released when process exists', async () => {
+    const filename = join('/tmp', `lock-${Math.random()}.lock`);
+    const processHandle = spawn('node', ['-e', `(${lockInProcess.toString()})(${JSON.stringify(filename)})`], {
+      stdio: 'inherit',
+    });
+
+    // Wait for process to start
+    await sleep(200);
+    await expect(LockFile.acquire(filename)).to.be.rejected;
+
+    processHandle.kill();
+
+    // Wait for process to be killed
+    await sleep(200);
+
+    const handle = await LockFile.acquire(filename);
+    await LockFile.release(handle);
+  });
+});
+
+// NOTE: Self-contained so when function.toString is called the code runs.
+const lockInProcess = (filename: string) => {
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  const { open } = require('node:fs/promises');
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  const { constants } = require('node:fs');
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  const { flock } = require('fs-ext');
+
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore
+  open(filename, constants.O_CREAT).then((handle) => {
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    flock(handle.fd, 'exnb', (err) => {
+      if (err) {
+        console.error(err);
+        return;
+      }
+      // Hang
+      setTimeout(() => {}, 1_000_000);
+    });
+  });
+};

package/src/lock-file.ts

@@ -0,0 +1,48 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { flock } from 'fs-ext';
+import { constants } from 'node:fs';
+import { open, FileHandle } from 'node:fs/promises';
+
+export class LockFile {
+  static async acquire(filename: string): Promise<FileHandle> {
+    const handle = await open(filename, constants.O_CREAT);
+    await new Promise<void>((resolve, reject) => {
+      flock(handle.fd, 'exnb', (err) => {
+        if (err) {
+          reject(err);
+          return;
+        }
+        resolve();
+      });
+    });
+    return handle;
+  }
+
+  static async release(handle: FileHandle): Promise<void> {
+    await new Promise<void>((resolve, reject) => {
+      flock(handle.fd, 'un', (err) => {
+        if (err) {
+          reject(err);
+          return;
+        }
+        resolve();
+      });
+    });
+    await handle.close();
+  }
+
+  static async isLocked(filename: string): Promise<boolean> {
+    try {
+      const handle = await LockFile.acquire(filename);
+      await LockFile.release(handle);
+      await handle.close();
+
+      return false;
+    } catch (e) {
+      return true;
+    }
+  }
+}