@dxos/lock-file 0.1.58-main.59c38c1 → 0.1.58-main.5e0f151

package/dist/lib/node/index.cjs

@@ -26,15 +26,15 @@ 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 _LockFile {
   static async acquire(filename) {
-    const handle = await (0, import_promises.open)(filename, import_promises.constants.O_CREAT);
+    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", async (err) => {
+      (0, import_fs_ext.flock)(handle.fd, "exnb", (err) => {
         if (err) {
           reject(err);
-          await handle.close();
           return;
         }
         resolve();

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

@@ -1,7 +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 { open, FileHandle, constants } 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', async (err) => {\n        if (err) {\n          reject(err);\n          await handle.close();\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,sBAA4C;AAErC,IAAMA,WAAN,MAAMA,UAAAA;EACX,aAAaC,QAAQC,UAAuC;AAC1D,UAAMC,SAAS,UAAMC,sBAAKF,UAAUG,0BAAUC,OAAO;AACrD,UAAM,IAAIC,QAAc,CAACC,SAASC,WAAAA;AAChCC,+BAAMP,OAAOQ,IAAI,QAAQ,OAAOC,QAAAA;AAC9B,YAAIA,KAAK;AACPH,iBAAOG,GAAAA;AACP,gBAAMT,OAAOU,MAAK;AAClB;QACF;AACAL,gBAAAA;MACF,CAAA;IACF,CAAA;AACA,WAAOL;EACT;EAEA,aAAaW,QAAQX,QAAmC;AACtD,UAAM,IAAII,QAAc,CAACC,SAASC,WAAAA;AAChCC,+BAAMP,OAAOQ,IAAI,MAAM,CAACC,QAAAA;AACtB,YAAIA,KAAK;AACPH,iBAAOG,GAAAA;AACP;QACF;AACAJ,gBAAAA;MACF,CAAA;IACF,CAAA;AACA,UAAML,OAAOU,MAAK;EACpB;EAEA,aAAaE,SAASb,UAAoC;AACxD,QAAI;AACF,YAAMC,SAAS,MAAMH,UAASC,QAAQC,QAAAA;AACtC,YAAMF,UAASc,QAAQX,MAAAA;AACvB,YAAMA,OAAOU,MAAK;AAElB,aAAO;IACT,SAASG,GAAG;AACV,aAAO;IACT;EACF;AACF;",
-  "names": ["LockFile", "acquire", "filename", "handle", "open", "constants", "O_CREAT", "Promise", "resolve", "reject", "flock", "fd", "err", "close", "release", "isLocked", "e"]
+  "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,UAAAA;EACX,aAAaC,QAAQC,UAAuC;AAC1D,UAAMC,SAAS,UAAMC,sBAAKF,UAAUG,yBAAUC,OAAO;AACrD,UAAM,IAAIC,QAAc,CAACC,SAASC,WAAAA;AAChCC,+BAAMP,OAAOQ,IAAI,QAAQ,CAACC,QAAAA;AACxB,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,WAAAA;AAChCC,+BAAMP,OAAOQ,IAAI,MAAM,CAACC,QAAAA;AACtB,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,UAASC,QAAQC,QAAAA;AACtC,YAAMF,UAASa,QAAQV,MAAAA;AACvB,YAAMA,OAAOW,MAAK;AAElB,aAAO;IACT,SAASE,GAAG;AACV,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

@@ -1 +1 @@
-{"inputs":{"packages/common/lock-file/src/lock-file.ts":{"bytes":4154,"imports":[{"path":"fs-ext","kind":"import-statement","external":true},{"path":"node:fs/promises","kind":"import-statement","external":true}],"format":"esm"},"packages/common/lock-file/src/index.ts":{"bytes":470,"imports":[{"path":"packages/common/lock-file/src/lock-file.ts","kind":"import-statement","original":"./lock-file"}],"format":"esm"}},"outputs":{"packages/common/lock-file/dist/lib/node/index.cjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":2274},"packages/common/lock-file/dist/lib/node/index.cjs":{"imports":[{"path":"fs-ext","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":1042}},"bytes":2189}}}
+{"inputs":{"packages/common/lock-file/src/lock-file.ts":{"bytes":4104,"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}],"format":"esm"},"packages/common/lock-file/src/index.ts":{"bytes":470,"imports":[{"path":"packages/common/lock-file/src/lock-file.ts","kind":"import-statement","original":"./lock-file"}],"format":"esm"}},"outputs":{"packages/common/lock-file/dist/lib/node/index.cjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":2251},"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":1044}},"bytes":2191}}}

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

@@ -1 +1 @@
-{"version":3,"file":"lock-file.d.ts","sourceRoot":"","sources":["../../../src/lock-file.ts"],"names":[],"mappings":";AAKA,OAAO,EAAQ,UAAU,EAAa,MAAM,kBAAkB,CAAC;AAE/D,qBAAa,QAAQ;WACN,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;WAe9C,OAAO,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;WAa1C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;CAW1D"}
+{"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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/lock-file",
-  "version": "0.1.58-main.59c38c1",
+  "version": "0.1.58-main.5e0f151",
   "description": "Lock file .",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -14,9 +14,9 @@
   ],
   "dependencies": {
     "fs-ext": "^2.0.0",
-    "@dxos/async": "0.1.58-main.59c38c1",
-    "@dxos/log": "0.1.58-main.59c38c1",
-    "@dxos/node-std": "0.1.58-main.59c38c1"
+    "@dxos/async": "0.1.58-main.5e0f151",
+    "@dxos/log": "0.1.58-main.5e0f151",
+    "@dxos/node-std": "0.1.58-main.5e0f151"
   },
   "devDependencies": {
     "@types/fs-ext": "^2.0.0",

package/src/lock-file.test.ts

@@ -5,24 +5,17 @@
 import chai, { expect } from 'chai';
 import chaiAsPromised from 'chai-as-promised';
 import { spawn } from 'node:child_process';
-import { existsSync, mkdirSync, unlinkSync } from 'node:fs';
+import { existsSync } from 'node:fs';
 import { join } from 'node:path';
-import waitForExpect from 'wait-for-expect';
 
-import { Trigger } from '@dxos/async';
-import { afterTest, beforeAll, describe, test } from '@dxos/test';
+import { Trigger, sleep } from '@dxos/async';
+import { describe, test } from '@dxos/test';
 
 import { LockFile } from './lock-file';
 
 chai.use(chaiAsPromised);
 
-const TEST_DIR = '/tmp/dxos/testing/lock-file';
-
 describe('LockFile', () => {
-  beforeAll(() => {
-    mkdirSync(TEST_DIR, { recursive: true });
-  });
-
   test('basic', async () => {
     const filename = join('/tmp', `lock-${Math.random()}.lock`);
 
@@ -34,55 +27,32 @@ describe('LockFile', () => {
     await LockFile.release(handle2);
   });
 
-  test('released when process exits', async () => {
-    const filename = join(TEST_DIR, `lock-${Math.random()}.lock`);
-    afterTest(() => {
-      if (existsSync(filename)) {
-        unlinkSync(filename);
-      }
-    });
-
-    const trigger = new Trigger();
+  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: 'pipe',
+      stdio: 'inherit',
     });
 
-    {
-      // Wait for process to start
-
-      processHandle.stdout.on('data', (data: Uint8Array) => {
-        expect(data.toString().trim()).to.equal('locked');
+    // Wait for process to start
+    const trigger = new Trigger();
+    const intervalId = setInterval(() => {
+      if (existsSync(filename)) {
         trigger.wake();
-      });
-    }
-
+      }
+    }, 100);
     await trigger.wait({ timeout: 1_000 });
+    clearInterval(intervalId);
 
     await expect(LockFile.acquire(filename)).to.be.rejected;
 
-    processHandle.stdin.write('close');
     processHandle.kill();
 
     // Wait for process to be killed
-    await waitForExpect(async () => {
-      expect(await LockFile.isLocked(filename)).to.be.false;
-    });
+    await sleep(400);
 
     const handle = await LockFile.acquire(filename);
     await LockFile.release(handle);
   });
-
-  test('spam with isLocked calls', async () => {
-    const checksNumber = 1000;
-    const filename = join('/tmp', `lock-${Math.random()}.lock`);
-
-    for (const _ of Array(checksNumber).keys()) {
-      const handle = await LockFile.acquire(filename);
-      expect(await LockFile.isLocked(filename)).to.be.true;
-      await LockFile.release(handle);
-      expect(await LockFile.isLocked(filename)).to.be.false;
-    }
-  });
 });
 
 // NOTE: Self-contained so when function.toString is called the code runs.
@@ -94,9 +64,6 @@ const lockInProcess = (filename: string) => {
   // 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
-  let fileHandle;
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore
   open(filename, constants.O_CREAT).then((handle) => {
@@ -104,23 +71,11 @@ const lockInProcess = (filename: string) => {
     // @ts-ignore
     flock(handle.fd, 'exnb', (err) => {
       if (err) {
-        handle.close();
         console.error(err);
         return;
       }
-      fileHandle = handle;
-      console.log('locked');
       // Hang
       setTimeout(() => {}, 1_000_000);
     });
   });
-
-  // Close file handle on stdin close.
-  process.stdin.on('data', (data) => {
-    if (data.toString().trim() === 'close') {
-      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-      // @ts-ignore
-      fileHandle.close();
-    }
-  });
 };

package/src/lock-file.ts

@@ -3,16 +3,16 @@
 //
 
 import { flock } from 'fs-ext';
-import { open, FileHandle, constants } from 'node:fs/promises';
+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', async (err) => {
+      flock(handle.fd, 'exnb', (err) => {
         if (err) {
           reject(err);
-          await handle.close();
           return;
         }
         resolve();