refactor: Consolidate tmpDir definitions into a package "internal" export (#11139)

## Description
As noted in #10954 (comment) , the callback for [`tmp.dir`](https://www.npmjs.com/package/tmp#asynchronous-directory-creation-1) is given three arguments, which is at odds with the normal Node.js (err, value) convention and therefore not compatible with [`util.promisify`](https://nodejs.org/docs/latest/api/util.html#utilpromisifyoriginal) (hence our many open-coded implementations of a _(prefix?: string) => Promise\<[dirName: string, cleanup: () => void]>_ `tmpDir`). Further, all the call sites of those many functions use `await` anyway and aren't doing useful work until the temporary directory is available.

This PR defines a single factory function in package "internal" and uses it throughout the codebase—almost entirely confined to testing, with the notable exception of `handleSwingStoreExport`.

### Security Considerations
None known.

### Scaling Considerations
No impact is expected, and even the non-testing change is after an `await`.

### Documentation Considerations
No relevant changes.

### Testing Considerations
All tests must continue to pass.

### Upgrade Considerations
Nothing special.

Author: mergify[bot]

a3p-integration/proposals/z:acceptance/yarn.lock

@@ -9,6 +9,7 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@agoric/access-token@portal:../../agoric-sdk/packages/access-token::locator=root-workspace-0b6124%40workspace%3A."
   dependencies:
+    "@agoric/internal": "npm:^0.3.2"
     n-readlines: "npm:^1.0.0"
     proper-lockfile: "npm:^4.1.2"
     tmp: "npm:^0.2.1"

packages/SwingSet/test/transcript/state-sync-reload.test.js

@@ -2,6 +2,7 @@
 import test from 'ava';
 
 import tmp from 'tmp';
+import { makeTempDirFactory } from '@agoric/internal/src/tmpDir.js';
 import { kunser } from '@agoric/kmarshal';
 import {
   initSwingStore,
@@ -12,20 +13,7 @@ import {
 import { initializeSwingset, makeSwingsetController } from '../../src/index.js';
 import { buildKernelBundle } from '../../src/controller/initializeSwingset.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]);
-      }
-    });
-  });
+const tmpDir = makeTempDirFactory(tmp);
 
 const bfile = name => new URL(name, import.meta.url).pathname;
 
@@ -35,8 +23,8 @@ test.before(async t => {
 });
 
 test('state-sync reload', async t => {
-  const [dbDir, cleanup] = await tmpDir('testdb');
-  const [importDbDir, cleanupImport] = await tmpDir('importtestdb');
+  const [dbDir, cleanup] = tmpDir('testdb');
+  const [importDbDir, cleanupImport] = tmpDir('importtestdb');
   t.teardown(cleanup);
   t.teardown(cleanupImport);
 

packages/SwingSet/test/vat-admin/slow-termination/slow-termination.test.js

@@ -6,26 +6,14 @@ import tmp from 'tmp';
 import sqlite3 from 'better-sqlite3';
 import path from 'path';
 
+import { makeTempDirFactory } from '@agoric/internal/src/tmpDir.js';
 import { kser } from '@agoric/kmarshal';
 import { initSwingStore } from '@agoric/swing-store';
 
 import { buildVatController, buildKernelBundles } from '../../../src/index.js';
 import { enumeratePrefixedKeys } from '../../../src/kernel/state/storageHelper.js';
 
-/**
- * @param {string} [prefix]
- * @returns {Promise<[string, () => void]>}
- */
-export const tmpDir = prefix =>
-  new Promise((resolve, reject) => {
-    tmp.dir({ unsafeCleanup: true, prefix }, (err, name, removeCallback) => {
-      if (err) {
-        reject(err);
-      } else {
-        resolve([name, removeCallback]);
-      }
-    });
-  });
+const tmpDir = makeTempDirFactory(tmp);
 
 test.before(async t => {
   const kernelBundles = await buildKernelBundles();
@@ -90,7 +78,7 @@ async function doSlowTerminate(t, mode) {
     },
   };
 
-  const [dbDir, cleanup] = await tmpDir('testdb');
+  const [dbDir, cleanup] = tmpDir('testdb');
   t.teardown(cleanup);
 
   const ss = initSwingStore(dbDir);

packages/access-token/package.json

@@ -18,6 +18,7 @@
     "lint:types": "tsc"
   },
   "dependencies": {
+    "@agoric/internal": "^0.3.2",
     "n-readlines": "^1.0.0",
     "proper-lockfile": "^4.1.2",
     "tmp": "^0.2.1"

packages/access-token/test/state.test.js

@@ -1,12 +1,15 @@
 import test from 'ava';
-import { tmpDir } from './tmp.js';
+import tmp from 'tmp';
+import { makeTempDirFactory } from '@agoric/internal/src/tmpDir.js';
 import {
   initJSONStore,
   openJSONStore,
   getAllState,
   isJSONStore,
 } from '../src/json-store.js';
 
+const tmpDir = makeTempDirFactory(tmp);
+
 function testStorage(t, storage) {
   t.falsy(storage.has('missing'));
   t.is(storage.get('missing'), undefined);
@@ -39,7 +42,7 @@ function testStorage(t, storage) {
 }
 
 test('storageInFile', async t => {
-  const [dbDir, cleanup] = await tmpDir('testdb');
+  const [dbDir, cleanup] = tmpDir('testdb');
   t.teardown(cleanup);
   t.is(isJSONStore(dbDir), false);
   const { storage, commit, close } = await initJSONStore(dbDir);

packages/access-token/test/tmp.js

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

packages/access-token/test/token.test.js

@@ -37,6 +37,7 @@ import { makeShutdown } from '@agoric/internal/src/node/shutdown.js';
 import { makeInitMsg } from '@agoric/internal/src/chain-utils.js';
 import * as STORAGE_PATH from '@agoric/internal/src/chain-storage-paths.js';
 import * as ActionType from '@agoric/internal/src/action-types.js';
+import { makeTempDirFactory } from '@agoric/internal/src/tmpDir.js';
 import { BridgeId, CosmosInitKeyToBridgeId } from '@agoric/internal';
 import {
   makeArchiveSnapshot,
@@ -64,6 +65,8 @@ import {
 
 const ignore = () => {};
 
+const tmpDir = makeTempDirFactory(tmp);
+
 // eslint-disable-next-line no-unused-vars
 let whenHellFreezesOver = null;
 
@@ -700,38 +703,24 @@ export default async function main(
           });
         stateSyncExport = exportData;
 
-        await new Promise((resolve, reject) => {
-          tmp.dir(
-            {
-              prefix: `agd-state-sync-${blockHeight}-`,
-              unsafeCleanup: true,
-            },
-            (err, exportDir, cleanup) => {
-              if (err) {
-                reject(err);
-                return;
-              }
-              exportData.exportDir = exportDir;
-              /** @type {Promise<void> | undefined} */
-              let cleanupResult;
-              exportData.cleanup = async () => {
-                cleanupResult ||= new Promise(cleanupDone => {
-                  // If the exporter is still the same, then the retriever
-                  // is in charge of cleanups
-                  if (stateSyncExport !== exportData) {
-                    // @ts-expect-error wrong type definitions
-                    cleanup(cleanupDone);
-                  } else {
-                    console.warn('unexpected call of state-sync cleanup');
-                    cleanupDone();
-                  }
-                });
-                await cleanupResult;
-              };
-              resolve(null);
-            },
-          );
-        });
+        const [exportDir, cleanup] = tmpDir(`agd-state-sync-${blockHeight}-`);
+        exportData.exportDir = exportDir;
+        /** @type {Promise<void> | undefined} */
+        let cleanupResult;
+        exportData.cleanup = async () => {
+          cleanupResult ||= new Promise(cleanupDone => {
+            // If the exporter is still the same, then the retriever
+            // is in charge of cleanups
+            if (stateSyncExport !== exportData) {
+              // @ts-expect-error wrong type definitions
+              cleanup(cleanupDone);
+            } else {
+              console.warn('unexpected call of state-sync cleanup');
+              cleanupDone();
+            }
+          });
+          await cleanupResult;
+        };
 
         console.warn(
           'Initiating SwingSet state snapshot at block height',

packages/cosmic-swingset/src/chain-main.js

@@ -13,6 +13,7 @@ import {
 } from '@agoric/internal/src/action-types.js';
 import * as STORAGE_PATH from '@agoric/internal/src/chain-storage-paths.js';
 import { deepCopyJsonable } from '@agoric/internal/src/js-utils.js';
+import { makeTempDirFactory } from '@agoric/internal/src/tmpDir.js';
 import { makeRunUtils } from '@agoric/swingset-vat/tools/run-utils.js';
 import { initSwingStore } from '@agoric/swing-store';
 import {
@@ -28,6 +29,8 @@ import { makeQueue } from '../src/helpers/make-queue.js';
 /** @import { ManagerType, SwingSetConfig } from '@agoric/swingset-vat' */
 /** @import { InboundQueue } from '../src/launch-chain.js'; */
 
+const tmpDir = makeTempDirFactory(tmp);
+
 /**
  * @template T
  * @typedef {(input: T) => T} Replacer
@@ -245,10 +248,7 @@ export const makeCosmicSwingsetTestKit = async (
     STORAGE_PATH.HIGH_PRIORITY_QUEUE,
   );
 
-  const { name: dbDir, removeCallback: cleanupDB } = tmp.dirSync({
-    prefix: debugName || 'testdb',
-    unsafeCleanup: true,
-  });
+  const [dbDir, cleanupDB] = tmpDir(debugName || 'testdb');
   const launchChain = makeLaunchChain(fakeAgcc, dbDir, {
     env,
     fs,

packages/cosmic-swingset/tools/test-kit.js

@@ -9,6 +9,7 @@ export * from './js-utils.js';
 export { pureDataMarshaller } from './marshal.js';
 export * from './method-tools.js';
 export * from './ses-utils.js';
+export * from './tmpDir.js';
 export * from './typeCheck.js';
 export * from './typeGuards.js';