feat(import-bundle): Support per-user source map caches

packages/import-bundle/package.json

@@ -8,6 +8,12 @@
   "engines": {
     "node": ">=12"
   },
+  "exports": {
+    ".": "./src/index.js",
+    "./source-map-node.js": "./source-map-node.js",
+    "./source-map-node-powers.js": "./source-map-node-powers.js",
+    "./package.json": "./package.json"
+  },
   "scripts": {
     "test": "ava",
     "test:c8": "c8 $C8_OPTIONS ava --config=ava-nesm.config.js",
@@ -22,7 +28,9 @@
   },
   "dependencies": {
     "@endo/base64": "^0.2.32",
-    "@endo/compartment-mapper": "^0.8.5"
+    "@endo/compartment-mapper": "^0.8.5",
+    "@endo/where": "^0.3.2",
+    "ses": "^0.18.4"
   },
   "devDependencies": {
     "@endo/bundle-source": "^2.5.2",

packages/import-bundle/source-map-node-powers.js

@@ -0,0 +1 @@
+export * from './src/source-map-node-powers.js';

packages/import-bundle/source-map-node.js

@@ -0,0 +1 @@
+export * from './src/source-map-node.js';

packages/import-bundle/src/index.js

@@ -14,16 +14,23 @@ const { Fail } = assert;
 // importBundle takes the output of bundle-source, and returns a namespace
 // object (with .default, and maybe other properties for named exports)
 
-export async function importBundle(bundle, options = {}) {
+export async function importBundle(bundle, options = {}, powers = {}) {
   const {
+    bundleUrl = undefined,
     filePrefix,
     endowments: optEndowments = {},
     // transforms are indeed __shimTransforms__, intended to apply to both
     // evaluated programs and modules shimmed to programs.
     transforms = [],
     inescapableTransforms = [],
     inescapableGlobalProperties = {},
+    expectedSha512 = undefined,
   } = options;
+  const {
+    computeSha512 = undefined,
+    computeSourceLocation = undefined,
+    computeSourceMapLocation = undefined,
+  } = powers;
   const endowments = {
     TextEncoder,
     TextDecoder,
@@ -51,7 +58,12 @@ export async function importBundle(bundle, options = {}) {
   if (moduleFormat === 'endoZipBase64') {
     const { endoZipBase64 } = bundle;
     const bytes = decodeBase64(endoZipBase64);
-    const archive = await parseArchive(bytes);
+    const archive = await parseArchive(bytes, bundleUrl, {
+      computeSha512,
+      expectedSha512,
+      computeSourceLocation,
+      computeSourceMapLocation,
+    });
     // Call import by property to bypass SES censoring for dynamic import.
     // eslint-disable-next-line dot-notation
     const { namespace } = await archive['import']({

packages/import-bundle/src/source-map-node-powers.js

@@ -0,0 +1,35 @@
+import { whereEndoCache } from '@endo/where';
+
+/**
+ * @typedef {object} Process
+ * @property {Record<string, string | undefined>} env
+ * @property {string} platform
+ */
+
+/**
+ * @param {object} powers
+ * @param {typeof import('node:url')} powers.url
+ * @param {typeof import('node:os')} powers.os
+ * @param {Process} powers.process
+ */
+export const makeEndoSourceMapLocator = powers => {
+  const { url, os, process } = powers;
+
+  const home = os.userInfo().homedir;
+  const cacheDirectory = whereEndoCache(process.platform, process.env, {
+    home,
+  });
+  const cacheLocation = url.pathToFileURL(cacheDirectory);
+
+  /**
+   * @param {object} details
+   * @param {string} details.sha512
+   */
+  const whereSourceMap = ({ sha512 }) => {
+    const sha512Head = sha512.slice(0, 2);
+    const sha512Tail = sha512.slice(2);
+    return `${cacheLocation}/source-map/${sha512Head}/${sha512Tail}.map.json`;
+  };
+
+  return whereSourceMap;
+};

packages/import-bundle/src/source-map-node.js

@@ -0,0 +1,10 @@
+/* global process */
+import url from 'node:url';
+import os from 'node:os';
+import { makeEndoSourceMapLocator } from './source-map-node-powers.js';
+
+export const computeSourceMapLocation = makeEndoSourceMapLocator({
+  url,
+  os,
+  process,
+});