@agoric/access-token 0.4.22-upgrade-14-dev-0169c7e.0 → 0.4.22-upgrade-16-dev-8879538.0

package/CHANGELOG.md

@@ -3,14 +3,6 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-### [0.4.22-u11wf.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/access-token@0.4.21...@agoric/access-token@0.4.22-u11wf.0) (2023-09-23)
-
-**Note:** Version bump only for package @agoric/access-token
-
-
-
-
-
 ### [0.4.21](https://github.com/Agoric/agoric-sdk/compare/@agoric/access-token@0.4.20...@agoric/access-token@0.4.21) (2023-05-19)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/access-token",
-  "version": "0.4.22-upgrade-14-dev-0169c7e.0+0169c7e",
+  "version": "0.4.22-upgrade-16-dev-8879538.0+8879538",
   "description": "Persistent credentials for Agoric users, backed by a simple JSON file",
   "type": "module",
   "main": "src/access-token.js",
@@ -12,26 +12,36 @@
     "test": "ava",
     "test:c8": "c8 $C8_OPTIONS ava --config=ava-nesm.config.js",
     "test:xs": "exit 0",
+    "lint": "run-s --continue-on-error lint:*",
     "lint-fix": "yarn lint:eslint --fix",
-    "lint:eslint": "eslint ."
+    "lint:eslint": "eslint .",
+    "lint:types": "tsc"
   },
   "dependencies": {
-    "@agoric/assert": "0.6.1-upgrade-14-dev-0169c7e.0+0169c7e",
     "n-readlines": "^1.0.0",
+    "proper-lockfile": "^4.1.2",
     "tmp": "^0.2.1"
   },
   "devDependencies": {
-    "ava": "^5.2.0",
-    "c8": "^7.13.0"
+    "@types/n-readlines": "^1.0.3",
+    "@types/proper-lockfile": "^4.1.2",
+    "ava": "^5.3.0",
+    "c8": "^9.1.0"
   },
   "publishConfig": {
     "access": "public"
   },
   "ava": {
     "files": [
-      "test/**/test-*.js"
+      "test/**/*.test.*"
+    ],
+    "require": [
+      "@endo/init/debug.js"
     ],
     "timeout": "2m"
   },
-  "gitHead": "0169c7e505099fdcfa8e4d1436e5d3b372f1c320"
+  "typeCoverage": {
+    "atLeast": 83.97
+  },
+  "gitHead": "8879538cd1d125a08346f02dd5701d0d70c90bb8"
 }

package/src/access-token.js

@@ -6,6 +6,11 @@ import path from 'path';
 import { openJSONStore } from './json-store.js';
 
 // Adapted from https://stackoverflow.com/a/43866992/14073862
+/**
+ * @param {object} opts
+ * @param {BufferEncoding} [opts.stringBase]
+ * @param {number} [opts.byteLength]
+ */
 export function generateAccessToken({
   stringBase = 'base64url',
   byteLength = 48,
@@ -28,9 +33,13 @@ export function generateAccessToken({
 
 /**
  * @param {string|number} port
+ * @param {string} [sharedStateDir]
  * @returns {Promise<string>}
  */
-export async function getAccessToken(port) {
+export async function getAccessToken(
+  port,
+  sharedStateDir = path.join(os.homedir(), '.agoric'),
+) {
   if (typeof port === 'string') {
     const match = port.match(/^(.*:)?(\d+)$/);
     if (match) {
@@ -39,18 +48,22 @@ export async function getAccessToken(port) {
   }
 
   // Ensure we're protected with a unique accessToken for this basedir.
-  const sharedStateDir = path.join(os.homedir(), '.agoric');
   await fs.promises.mkdir(sharedStateDir, { mode: 0o700, recursive: true });
 
-  // Ensure an access token exists.
-  const { storage, commit, close } = openJSONStore(sharedStateDir);
-  const accessTokenKey = `accessToken/${port}`;
-  if (!storage.has(accessTokenKey)) {
-    storage.set(accessTokenKey, await generateAccessToken());
-    await commit();
+  const { storage, commit, close } = await openJSONStore(sharedStateDir);
+  let accessToken;
+  try {
+    // Ensure an access token exists.
+    const accessTokenKey = `accessToken/${port}`;
+    if (!storage.has(accessTokenKey)) {
+      storage.set(accessTokenKey, await generateAccessToken());
+      await commit();
+    }
+    accessToken = storage.get(accessTokenKey);
+  } finally {
+    await close();
   }
-  const accessToken = storage.get(accessTokenKey);
-  await close();
+
   if (typeof accessToken !== 'string') {
     throw Error(`Could not find access token for ${port}`);
   }

package/src/json-store.js

@@ -2,6 +2,7 @@
 import fs from 'fs';
 import path from 'path';
 import process from 'process';
+import lockfile from 'proper-lockfile';
 import Readlines from 'n-readlines';
 
 // TODO: Update this when we make a breaking change.
@@ -11,6 +12,8 @@ import Readlines from 'n-readlines';
 // changed when you're just trying to use the wallet from the browser.
 const DATA_FILE = 'swingset-kernel-state.jsonlines';
 
+const DEFAULT_LOCK_RETRIES = 10;
+
 /**
  * @typedef {ReturnType<typeof makeStorageInMemory>['storage']} JSONStore
  */
@@ -156,20 +159,37 @@ function makeStorageInMemory() {
  * @param {string} [dirPath]  Path to a directory in which database files may be kept, or
  *   null.
  * @param {boolean} [forceReset]  If true, initialize the database to an empty state
+ * @param {null | import('proper-lockfile').LockOptions['retries']} [lockRetries] If null, do not lock the database.
  *
- * @returns {{
+ * @returns {Promise<{
  *   storage: JSONStore, // a storage API object to load and store data
  *   commit: () => Promise<void>,  // commit changes made since the last commit
  *   close: () => Promise<void>,   // shutdown the store, abandoning any uncommitted changes
- * }}
+ * }>}
  */
-function makeJSONStore(dirPath, forceReset = false) {
+async function makeJSONStore(
+  dirPath,
+  forceReset = false,
+  lockRetries = DEFAULT_LOCK_RETRIES,
+) {
+  await null;
   const { storage, state } = makeStorageInMemory();
 
+  let releaseLock = async () => {};
   let storeFile;
   if (dirPath) {
     fs.mkdirSync(dirPath, { recursive: true });
     storeFile = path.resolve(dirPath, DATA_FILE);
+
+    if (lockRetries !== null) {
+      // We need to lock the database to prevent multiple divergent instances.
+      releaseLock = await lockfile.lock(dirPath, {
+        // @ts-expect-error TS(2345) lockFilePath really does exist on LockOptions
+        lockFilePath: `${storeFile}.lock`,
+        retries: lockRetries,
+      });
+    }
+
     if (forceReset) {
       safeUnlink(storeFile);
     } else {
@@ -186,8 +206,7 @@ function makeJSONStore(dirPath, forceReset = false) {
       if (lines) {
         let line = lines.next();
         while (line) {
-          // @ts-expect-error JSON.parse can take a Buffer
-          const [key, value] = JSON.parse(line);
+          const [key, value] = JSON.parse(line.toString());
           storage.set(key, value);
           line = lines.next();
         }
@@ -195,18 +214,25 @@ function makeJSONStore(dirPath, forceReset = false) {
     }
   }
 
+  const assertNotClosed = () => {
+    if (!dirPath || storeFile) {
+      return;
+    }
+    throw Error('JSON store is already closed');
+  };
+
   /**
    * Commit unsaved changes.
    */
   async function commit() {
+    assertNotClosed();
     if (dirPath) {
       const tempFile = `${storeFile}-${process.pid}.tmp`;
       const fd = fs.openSync(tempFile, 'w');
 
       for (const [key, value] of state.entries()) {
         const line = JSON.stringify([key, value]);
-        fs.writeSync(fd, line);
-        fs.writeSync(fd, '\n');
+        fs.writeSync(fd, `${line}\n`);
       }
       fs.closeSync(fd);
       fs.renameSync(tempFile, storeFile);
@@ -218,7 +244,9 @@ function makeJSONStore(dirPath, forceReset = false) {
    * (if you want to save them, call commit() first).
    */
   async function close() {
-    // Nothing to do here.
+    assertNotClosed();
+    storeFile = undefined;
+    await releaseLock();
   }
 
   return { storage, commit, close };

package/test/{test-state.js → state.test.js}

@@ -1,6 +1,5 @@
-import tmp from 'tmp';
-
 import test from 'ava';
+import { tmpDir } from './tmp.js';
 import {
   initJSONStore,
   openJSONStore,
@@ -8,21 +7,6 @@ import {
   isJSONStore,
 } from '../src/json-store.js';
 
-/**
- * @param {string} [prefix]
- * @returns {Promise<[string, () => void]>}
- */
-const tmpDir = prefix =>
-  new Promise((resolve, reject) => {
-    tmp.dir({ unsafeCleanup: true, prefix }, (err, name, removeCallback) => {
-      if (err) {
-        reject(err);
-      } else {
-        resolve([name, removeCallback]);
-      }
-    });
-  });
-
 function testStorage(t, storage) {
   t.falsy(storage.has('missing'));
   t.is(storage.get('missing'), undefined);
@@ -58,14 +42,14 @@ test('storageInFile', async t => {
   const [dbDir, cleanup] = await tmpDir('testdb');
   t.teardown(cleanup);
   t.is(isJSONStore(dbDir), false);
-  const { storage, commit, close } = initJSONStore(dbDir);
+  const { storage, commit, close } = await initJSONStore(dbDir);
   testStorage(t, storage);
   await commit();
   const before = getAllState(storage);
   await close();
   t.is(isJSONStore(dbDir), true);
 
-  const { storage: after } = openJSONStore(dbDir);
+  const { storage: after } = await openJSONStore(dbDir);
   t.deepEqual(getAllState(after), before, 'check state after reread');
   t.is(isJSONStore(dbDir), true);
 });

package/test/tmp.js

@@ -0,0 +1,19 @@
+import tmp from 'tmp';
+
+/**
+ * @param {string} [prefix]
+ * @returns {Promise<[string, () => void]>}
+ */
+export const tmpDir = prefix =>
+  new Promise((resolve, reject) => {
+    // We use `unsafeCleanup` because we want to remove the directory even if it
+    // still contains files.
+    const unsafeCleanup = true;
+    tmp.dir({ unsafeCleanup, prefix }, (err, name, removeCallback) => {
+      if (err) {
+        reject(err);
+      } else {
+        resolve([name, removeCallback]);
+      }
+    });
+  });

package/test/token.test.js

@@ -0,0 +1,17 @@
+import test from 'ava';
+import { tmpDir } from './tmp.js';
+
+import { getAccessToken } from '../src/access-token.js';
+
+test('access tokens', async t => {
+  const [sharedStateDir, removeCallback] = await tmpDir('access-token-test');
+  const [a, b, c] = await Promise.all([
+    getAccessToken(1234, sharedStateDir),
+    getAccessToken(1234, sharedStateDir),
+    getAccessToken(1234, sharedStateDir),
+  ]);
+
+  t.is(a, b);
+  t.is(a, c);
+  await removeCallback();
+});

package/{jsconfig.json → tsconfig.json}

@@ -1,6 +1,9 @@
 // This file can contain .js-specific Typescript compiler config.
 {
   "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "allowSyntheticDefaultImports": true
+  },
   "include": [
     "src/**/*.js",
     "test/**/*.js"