@endo/compartment-mapper 1.4.0 → 1.5.0

package/README.md

@@ -328,6 +328,20 @@ These will be appended to each module from the archive, for debugging purposes.
 The `@endo/bundle-source` and `@endo/import-bundle` tools integrate source maps
 for an end-to-end debugging experience.
 
+# XS (experimental)
+
+The Compartment Mapper can use native XS `Compartment` and `ModuleSource` under
+certain conditions:
+
+1. The application must be an XS script that was compiled with the `xs`
+  package condition.
+  This causes `ses`, `@endo/module-source`, and `@endo/import-bundle` to
+  provide slightly different implementations that can fall through to native
+  behavior.
+2. The application must opt-in with the `__native__: true` option on any
+  of the compartment mapper methods that import modules like `importLocation`
+  and `importArchive`.
+
 # Design
 
 Each of the workflows the compartment mapper executes a portion of one sequence

package/import-archive-all-parsers.d.ts

@@ -0,0 +1,2 @@
+export { defaultParserForLanguage } from "./src/import-archive-all-parsers.js";
+//# sourceMappingURL=import-archive-all-parsers.d.ts.map

package/import-archive-all-parsers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"import-archive-all-parsers.d.ts","sourceRoot":"","sources":["import-archive-all-parsers.js"],"names":[],"mappings":""}

package/import-archive-all-parsers.js

@@ -0,0 +1 @@
+export { defaultParserForLanguage } from './src/import-archive-all-parsers.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@endo/compartment-mapper",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "The compartment mapper assembles Node applications in a sandbox",
   "keywords": [
     "node",
@@ -32,7 +32,12 @@
     "./capture-lite.js": "./capture-lite.js",
     "./import-archive.js": "./import-archive.js",
     "./import-archive-lite.js": "./import-archive-lite.js",
-    "./import-archive-parsers.js": "./import-archive-parsers.js",
+    "./import-archive-parsers.js": {
+      "xs": "./import-archive-all-parsers.js",
+      "node": "./import-archive-all-parsers.js",
+      "default": "./import-archive-parsers.js"
+    },
+    "./import-archive-all-parsers.js": "./import-archive-all-parsers.js",
     "./bundle.js": "./bundle.js",
     "./node-powers.js": "./node-powers.js",
     "./node-modules.js": "./node-modules.js",
@@ -52,10 +57,10 @@
   },
   "dependencies": {
     "@endo/cjs-module-analyzer": "^1.0.9",
-    "@endo/module-source": "^1.1.2",
+    "@endo/module-source": "^1.2.0",
     "@endo/trampoline": "^1.0.3",
     "@endo/zip": "^1.0.9",
-    "ses": "^1.10.0"
+    "ses": "^1.11.0"
   },
   "devDependencies": {
     "ava": "^6.1.3",
@@ -109,5 +114,5 @@
   "typeCoverage": {
     "atLeast": 86.14
   },
-  "gitHead": "5486ed1f238104716b6a8321b977fbc508ef80e1"
+  "gitHead": "e0683e0bfdbfc84351af332c9e78813d7b67ef89"
 }

package/src/archive-lite.d.ts

@@ -1,7 +1,4 @@
-export function makeArchiveCompartmentMap(compartmentMap: CompartmentMapDescriptor, sources: Sources): {
-    archiveCompartmentMap: CompartmentMapDescriptor;
-    archiveSources: Sources;
-};
+export function makeArchiveCompartmentMap(compartmentMap: CompartmentMapDescriptor, sources: Sources): ArchiveResult;
 export function makeAndHashArchiveFromMap(powers: ReadFn | ReadPowers, compartmentMap: CompartmentMapDescriptor, options?: ArchiveLiteOptions | undefined): Promise<{
     bytes: Uint8Array;
     sha512?: string;
@@ -12,6 +9,7 @@ export function hashFromMap(powers: HashPowers, compartmentMap: CompartmentMapDe
 export function writeArchiveFromMap(write: WriteFn, readPowers: ReadFn | ReadPowers, archiveLocation: string, compartmentMap: CompartmentMapDescriptor, options?: ArchiveLiteOptions | undefined): Promise<void>;
 import type { CompartmentMapDescriptor } from './types.js';
 import type { Sources } from './types.js';
+import type { ArchiveResult } from './types.js';
 import type { ReadFn } from './types.js';
 import type { ReadPowers } from './types.js';
 import type { ArchiveLiteOptions } from './types.js';

package/src/archive-lite.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"archive-lite.d.ts","sourceRoot":"","sources":["archive-lite.js"],"names":[],"mappings":"AAiRO,0DAJI,wBAAwB,WACxB,OAAO,GACL;IAAC,qBAAqB,EAAE,wBAAwB,CAAC;IAAC,cAAc,EAAE,OAAO,CAAA;CAAC,CAmCtF;AAyGM,kDALI,MAAM,GAAG,UAAU,kBACnB,wBAAwB,6CAEtB,OAAO,CAAC;IAAC,KAAK,EAAE,UAAU,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAC,CAAC,CAmBzD;AAQM,2CALI,MAAM,GAAG,UAAU,kBACnB,wBAAwB,6CAEtB,OAAO,CAAC,UAAU,CAAC,CAS/B;AAQM,mCALI,MAAM,GAAG,UAAU,kBACnB,wBAAwB,6CAEtB,OAAO,CAAC,UAAU,CAAC,CAS/B;AAQM,oCALI,UAAU,kBACV,wBAAwB,6CAEtB,OAAO,CAAC,MAAM,CAAC,CAU3B;AASM,2CANI,OAAO,cACP,MAAM,GAAG,UAAU,mBACnB,MAAM,kBACN,wBAAwB,2DAgBlC;8CAncS,YAAY;6BAAZ,YAAY;4BAAZ,YAAY;gCAAZ,YAAY;wCAAZ,YAAY;gCAAZ,YAAY;6BAAZ,YAAY"}
+{"version":3,"file":"archive-lite.d.ts","sourceRoot":"","sources":["archive-lite.js"],"names":[],"mappings":"AAmHO,0DAJI,wBAAwB,WACxB,OAAO,GACL,aAAa,CAiBzB;AAyGM,kDALI,MAAM,GAAG,UAAU,kBACnB,wBAAwB,6CAEtB,OAAO,CAAC;IAAC,KAAK,EAAE,UAAU,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAC,CAAC,CAmBzD;AAQM,2CALI,MAAM,GAAG,UAAU,kBACnB,wBAAwB,6CAEtB,OAAO,CAAC,UAAU,CAAC,CAS/B;AAQM,mCALI,MAAM,GAAG,UAAU,kBACnB,wBAAwB,6CAEtB,OAAO,CAAC,UAAU,CAAC,CAS/B;AAQM,oCALI,UAAU,kBACV,wBAAwB,6CAEtB,OAAO,CAAC,MAAM,CAAC,CAU3B;AASM,2CANI,OAAO,cACP,MAAM,GAAG,UAAU,mBACnB,MAAM,kBACN,wBAAwB,2DAgBlC;8CApRS,YAAY;6BAAZ,YAAY;mCAAZ,YAAY;4BAAZ,YAAY;gCAAZ,YAAY;wCAAZ,YAAY;gCAAZ,YAAY;6BAAZ,YAAY"}

package/src/archive-lite.js

@@ -33,12 +33,11 @@
 /**
  * @import {
  *   ArchiveLiteOptions,
+ *   ArchiveResult,
  *   ArchiveWriter,
  *   CaptureSourceLocationHook,
- *   CompartmentDescriptor,
  *   CompartmentMapDescriptor,
  *   HashPowers,
- *   ModuleDescriptor,
  *   ReadFn,
  *   ReadPowers,
  *   Sources,
@@ -54,12 +53,8 @@ import {
   makeImportHookMaker,
 } from './import-hook.js';
 import { unpackReadPowers } from './powers.js';
-import {
-  assertCompartmentMap,
-  stringCompare,
-  pathCompare,
-} from './compartment-map.js';
 import { detectAttenuators } from './policy.js';
+import { digestCompartmentMap } from './digest.js';
 
 const textEncoder = new TextEncoder();
 
@@ -72,160 +67,7 @@ const { assign, create, freeze } = Object;
  */
 const resolveLocation = (rel, abs) => new URL(rel, abs).toString();
 
-const { keys, entries, fromEntries } = Object;
-
-/**
- * We attempt to produce compartment maps that are consistent regardless of
- * whether the packages were originally laid out on disk for development or
- * production, and other trivia like the fully qualified path of a specific
- * installation.
- *
- * Naming compartments for the self-ascribed name and version of each Node.js
- * package is insufficient because they are not guaranteed to be unique.
- * Dependencies do not necessarilly come from the npm registry and may be
- * for example derived from fully qualified URL's or Github org and project
- * names.
- * Package managers are also not required to fully deduplicate the hard
- * copy of each package even when they are identical resources.
- * Duplication is undesirable, but we elect to defer that problem to solutions
- * in the package managers, as the alternative would be to consistently hash
- * the original sources of the packages themselves, which may not even be
- * available much less pristine for us.
- *
- * So, instead, we use the lexically least path of dependency names, delimited
- * by hashes.
- * The compartment maps generated by the ./node-modules.js tooling pre-compute
- * these traces for our use here.
- * We sort the compartments lexically on their self-ascribed name and version,
- * and use the lexically least dependency name path as a tie-breaker.
- * The dependency path is logical and orthogonal to the package manager's
- * actual installation location, so should be orthogonal to the vagaries of the
- * package manager's deduplication algorithm.
- *
- * @param {Record<string, CompartmentDescriptor>} compartments
- * @returns {Record<string, string>} map from old to new compartment names.
- */
-const renameCompartments = compartments => {
-  /** @type {Record<string, string>} */
-  const compartmentRenames = create(null);
-  let index = 0;
-  let prev = '';
-
-  // The sort below combines two comparators to avoid depending on sort
-  // stability, which became standard as recently as 2019.
-  // If that date seems quaint, please accept my regards from the distant past.
-  // We are very proud of you.
-  const compartmentsByPath = Object.entries(compartments)
-    .map(([name, compartment]) => ({
-      name,
-      path: compartment.path,
-      label: compartment.label,
-    }))
-    .sort((a, b) => {
-      if (a.label === b.label) {
-        assert(a.path !== undefined && b.path !== undefined);
-        return pathCompare(a.path, b.path);
-      }
-      return stringCompare(a.label, b.label);
-    });
-
-  for (const { name, label } of compartmentsByPath) {
-    if (label === prev) {
-      compartmentRenames[name] = `${label}-n${index}`;
-      index += 1;
-    } else {
-      compartmentRenames[name] = label;
-      prev = label;
-      index = 1;
-    }
-  }
-  return compartmentRenames;
-};
-
-/**
- * @param {Record<string, CompartmentDescriptor>} compartments
- * @param {Sources} sources
- * @param {Record<string, string>} compartmentRenames
- */
-const translateCompartmentMap = (compartments, sources, compartmentRenames) => {
-  const result = create(null);
-  for (const compartmentName of keys(compartmentRenames)) {
-    const compartment = compartments[compartmentName];
-    const { name, label, retained: compartmentRetained, policy } = compartment;
-    if (compartmentRetained) {
-      // rename module compartments
-      /** @type {Record<string, ModuleDescriptor>} */
-      const modules = create(null);
-      const compartmentModules = compartment.modules;
-      if (compartment.modules) {
-        for (const name of keys(compartmentModules).sort()) {
-          const { retained: moduleRetained, ...retainedModule } =
-            compartmentModules[name];
-          if (moduleRetained) {
-            if (retainedModule.compartment !== undefined) {
-              modules[name] = {
-                ...retainedModule,
-                compartment: compartmentRenames[retainedModule.compartment],
-              };
-            } else {
-              modules[name] = retainedModule;
-            }
-          }
-        }
-      }
-
-      // integrate sources into modules
-      const compartmentSources = sources[compartmentName];
-      if (compartmentSources) {
-        for (const name of keys(compartmentSources).sort()) {
-          const source = compartmentSources[name];
-          const { location, parser, exit, sha512, deferredError } = source;
-          if (location !== undefined) {
-            modules[name] = {
-              location,
-              parser,
-              sha512,
-            };
-          } else if (exit !== undefined) {
-            modules[name] = {
-              exit,
-            };
-          } else if (deferredError !== undefined) {
-            modules[name] = {
-              deferredError,
-            };
-          }
-        }
-      }
-
-      result[compartmentRenames[compartmentName]] = {
-        name,
-        label,
-        location: compartmentRenames[compartmentName],
-        modules,
-        policy,
-        // `scopes`, `types`, and `parsers` are not necessary since every
-        // loadable module is captured in `modules`.
-      };
-    }
-  }
-
-  return result;
-};
-
-/**
- * @param {Sources} sources
- * @param {Record<string, string>} compartmentRenames
- * @returns {Sources}
- */
-const renameSources = (sources, compartmentRenames) => {
-  return fromEntries(
-    entries(sources).map(([name, compartmentSources]) => [
-      compartmentRenames[name],
-      compartmentSources,
-    ]),
-  );
-};
+const { keys } = Object;
 
 /**
  * @param {ArchiveWriter} archive
@@ -269,41 +111,23 @@ const captureSourceLocations = async (sources, captureSourceLocation) => {
 /**
  * @param {CompartmentMapDescriptor} compartmentMap
  * @param {Sources} sources
- * @returns {{archiveCompartmentMap: CompartmentMapDescriptor, archiveSources: Sources}}
+ * @returns {ArchiveResult}
  */
 export const makeArchiveCompartmentMap = (compartmentMap, sources) => {
   const {
-    compartments,
-    entry: { compartment: entryCompartmentName, module: entryModuleSpecifier },
-  } = compartmentMap;
-
-  const compartmentRenames = renameCompartments(compartments);
-  const archiveCompartments = translateCompartmentMap(
-    compartments,
-    sources,
+    compartmentMap: archiveCompartmentMap,
+    sources: archiveSources,
+    oldToNewCompartmentNames,
+    newToOldCompartmentNames,
+    compartmentRenames,
+  } = digestCompartmentMap(compartmentMap, sources);
+  return {
+    archiveCompartmentMap,
+    archiveSources,
+    oldToNewCompartmentNames,
+    newToOldCompartmentNames,
     compartmentRenames,
-  );
-  const archiveEntryCompartmentName = compartmentRenames[entryCompartmentName];
-  const archiveSources = renameSources(sources, compartmentRenames);
-
-  const archiveCompartmentMap = {
-    // TODO migrate tags to conditions
-    // https://github.com/endojs/endo/issues/2388
-    tags: [],
-    entry: {
-      compartment: archiveEntryCompartmentName,
-      module: entryModuleSpecifier,
-    },
-    compartments: archiveCompartments,
   };
-
-  // Cross-check:
-  // We assert that we have constructed a valid compartment map, not because it
-  // might not be, but to ensure that the assertCompartmentMap function can
-  // accept all valid compartment maps.
-  assertCompartmentMap(archiveCompartmentMap);
-
-  return { archiveCompartmentMap, archiveSources };
 };
 
 /**

package/src/archive.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"archive.d.ts","sourceRoot":"","sources":["archive.js"],"names":[],"mappings":"AA2DO,2CALI,MAAM,GAAG,UAAU,kBACnB,MAAM,yCAEJ,OAAO,CAAC;IAAC,KAAK,EAAE,UAAU,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAC,CAAC,CAiBzD;AAQM,oCALI,MAAM,GAAG,UAAU,kBACnB,MAAM,yCAEJ,OAAO,CAAC,UAAU,CAAC,CAsC/B;AAQM,oCALI,MAAM,GAAG,UAAU,kBACnB,MAAM,yCAEJ,OAAO,CAAC,UAAU,CAAC,CAuC/B;AAQM,qCALI,UAAU,kBACV,MAAM,yCAEJ,OAAO,CAAC,MAAM,CAAC,CAuC3B;AASM,oCANI,OAAO,cACP,MAAM,GAAG,UAAU,mBACnB,MAAM,kBACN,MAAM,uDA8ChB;4BA5OS,YAAY;gCAAZ,YAAY;oCAAZ,YAAY;gCAAZ,YAAY;6BAAZ,YAAY"}
+{"version":3,"file":"archive.d.ts","sourceRoot":"","sources":["archive.js"],"names":[],"mappings":"AA2DO,2CALI,MAAM,GAAG,UAAU,kBACnB,MAAM,yCAEJ,OAAO,CAAC;IAAC,KAAK,EAAE,UAAU,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAC,CAAC,CAiBzD;AAQM,oCALI,MAAM,GAAG,UAAU,kBACnB,MAAM,yCAEJ,OAAO,CAAC,UAAU,CAAC,CAwC/B;AAQM,oCALI,MAAM,GAAG,UAAU,kBACnB,MAAM,yCAEJ,OAAO,CAAC,UAAU,CAAC,CAyC/B;AAQM,qCALI,UAAU,kBACV,MAAM,yCAEJ,OAAO,CAAC,MAAM,CAAC,CAyC3B;AASM,oCANI,OAAO,cACP,MAAM,GAAG,UAAU,mBACnB,MAAM,kBACN,MAAM,uDAgDhB;4BApPS,YAAY;gCAAZ,YAAY;oCAAZ,YAAY;gCAAZ,YAAY;6BAAZ,YAAY"}

package/src/archive.js

@@ -85,6 +85,7 @@ export const makeArchive = async (powers, moduleLocation, options = {}) => {
     dev,
     tags,
     conditions = tags,
+    strict = false,
     commonDependencies,
     policy,
     languageForExtension,
@@ -99,6 +100,7 @@ export const makeArchive = async (powers, moduleLocation, options = {}) => {
   } = assignParserForLanguage(options);
   const compartmentMap = await mapNodeModules(powers, moduleLocation, {
     dev,
+    strict,
     conditions,
     commonDependencies,
     policy,
@@ -129,6 +131,7 @@ export const mapLocation = async (powers, moduleLocation, options = {}) => {
     dev,
     tags,
     conditions = tags,
+    strict = false,
     commonDependencies,
     policy,
     parserForLanguage,
@@ -144,6 +147,7 @@ export const mapLocation = async (powers, moduleLocation, options = {}) => {
 
   const compartmentMap = await mapNodeModules(powers, moduleLocation, {
     dev,
+    strict,
     conditions,
     commonDependencies,
     policy,
@@ -174,6 +178,7 @@ export const hashLocation = async (powers, moduleLocation, options = {}) => {
     dev,
     tags,
     conditions = tags,
+    strict = false,
     commonDependencies,
     policy,
     parserForLanguage,
@@ -189,6 +194,7 @@ export const hashLocation = async (powers, moduleLocation, options = {}) => {
 
   const compartmentMap = await mapNodeModules(powers, moduleLocation, {
     dev,
+    strict,
     conditions,
     commonDependencies,
     policy,
@@ -226,6 +232,7 @@ export const writeArchive = async (
     dev,
     tags,
     conditions = tags,
+    strict = false,
     commonDependencies,
     policy,
     parserForLanguage,
@@ -240,6 +247,7 @@ export const writeArchive = async (
   } = assignParserForLanguage(options);
   const compartmentMap = await mapNodeModules(readPowers, moduleLocation, {
     dev,
+    strict,
     conditions,
     commonDependencies,
     policy,

package/src/bundle.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bundle.d.ts","sourceRoot":"","sources":["bundle.js"],"names":[],"mappings":"AAgOO,uCALI,MAAM,GAAG,UAAU,GAAG,eAAe,kBACrC,MAAM,yCAEJ,OAAO,CAAC,MAAM,CAAC,CAgN3B;AASM,mCANI,OAAO,QACP,MAAM,kBACN,MAAM,kBACN,MAAM,uDAahB;;;;;;;;;;;gBA5aa,MAAM,MAAM;;;;;;;cAOZ,MAAM,MAAM;;;;;;;oBAIZ,MAAM,MAAM;;;;;wBAIZ,MAAM,MAAM;;yBAKH,oBAAoB,SAA9B,OAAS;SAER,MAAM;qBACN,MAAM;qBACN,MAAM;YACN,MAAM;YACN,gBAAgB,GAAG,oBAAoB;qBACvC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;oBACtB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;WACtB,UAAU;WACV,MAAM;gBACN,UAAU;;0BAID,oBAAoB,SAA9B,OAAS,aAEX,YAAY,CAAC,oBAAoB,CAAC,KAChC,UAAU;2BAIA,oBAAoB,SAA9B,OAAS;aAER,MAAM;mBACN,aAAa,CAAC,oBAAoB,CAAC;;4BAlDvC,YAAY;gCAAZ,YAAY;qCAAZ,YAAY;oCAAZ,YAAY;6BAAZ,YAAY;sCAVZ,KAAK"}
+{"version":3,"file":"bundle.d.ts","sourceRoot":"","sources":["bundle.js"],"names":[],"mappings":"AAsOO,uCALI,MAAM,GAAG,UAAU,GAAG,eAAe,kBACrC,MAAM,yCAEJ,OAAO,CAAC,MAAM,CAAC,CAgN3B;AASM,mCANI,OAAO,QACP,MAAM,kBACN,MAAM,kBACN,MAAM,uDAahB;;;;;;;;;;;gBAlba,MAAM,MAAM;;;;;;;cAOZ,MAAM,MAAM;;;;;;;oBAIZ,MAAM,MAAM;;;;;wBAIZ,MAAM,MAAM;;yBAKH,oBAAoB,SAA9B,OAAS;SAER,MAAM;qBACN,MAAM;qBACN,MAAM;YACN,MAAM;YACN,gBAAgB,GAAG,oBAAoB;qBACvC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;oBACtB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;WACtB,UAAU;WACV,MAAM;gBACN,UAAU;;0BAID,oBAAoB,SAA9B,OAAS,aAEX,YAAY,CAAC,oBAAoB,CAAC,KAChC,UAAU;2BAIA,oBAAoB,SAA9B,OAAS;aAER,MAAM;mBACN,aAAa,CAAC,oBAAoB,CAAC;;4BAlDvC,YAAY;gCAAZ,YAAY;qCAAZ,YAAY;oCAAZ,YAAY;6BAAZ,YAAY;sCAVZ,KAAK"}

package/src/bundle.js

@@ -117,8 +117,14 @@ const sortedModules = (
     const source = compartmentSources[compartmentName][moduleSpecifier];
     if (source !== undefined) {
       const { record, parser, deferredError, bytes } = source;
-      assert(parser !== undefined);
-      assert(bytes !== undefined);
+      assert(
+        bytes !== undefined,
+        `No bytes for ${moduleSpecifier} in ${compartmentName}`,
+      );
+      assert(
+        parser !== undefined,
+        `No parser for ${moduleSpecifier} in ${compartmentName}`,
+      );
       if (deferredError) {
         throw Error(
           `Cannot bundle: encountered deferredError ${deferredError}`,

package/src/capture-lite.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"capture-lite.d.ts","sourceRoot":"","sources":["capture-lite.js"],"names":[],"mappings":"AAsQO,uCALI,MAAM,GAAG,UAAU,kBACnB,wBAAwB,6CAEtB,OAAO,CAAC,aAAa,CAAC,CAmElC;4BA9RS,YAAY;gCAAZ,YAAY;8CAAZ,YAAY;wCAAZ,YAAY;mCAAZ,YAAY"}
+{"version":3,"file":"capture-lite.d.ts","sourceRoot":"","sources":["capture-lite.js"],"names":[],"mappings":"AAoFO,uCALI,MAAM,GAAG,UAAU,kBACnB,wBAAwB,6CAEtB,OAAO,CAAC,aAAa,CAAC,CAmElC;4BA9GS,YAAY;gCAAZ,YAAY;8CAAZ,YAAY;wCAAZ,YAAY;mCAAZ,YAAY"}

package/src/capture-lite.js

@@ -33,20 +33,13 @@
  * @import {
  *   CaptureLiteOptions,
  *   CaptureResult,
- *   CompartmentDescriptor,
  *   CompartmentMapDescriptor,
- *   ModuleDescriptor,
  *   ReadFn,
  *   ReadPowers,
  *   Sources,
  * } from './types.js'
  */
 
-import {
-  assertCompartmentMap,
-  pathCompare,
-  stringCompare,
-} from './compartment-map.js';
 import {
   exitModuleImportHookMaker,
   makeImportHookMaker,
@@ -55,161 +48,12 @@ import { link } from './link.js';
 import { resolve } from './node-module-specifier.js';
 import { detectAttenuators } from './policy.js';
 import { unpackReadPowers } from './powers.js';
+import { digestCompartmentMap } from './digest.js';
 
-const { freeze, assign, create, fromEntries, entries, keys } = Object;
+const { freeze, assign, create } = Object;
 
 const defaultCompartment = Compartment;
 
-/**
- * We attempt to produce compartment maps that are consistent regardless of
- * whether the packages were originally laid out on disk for development or
- * production, and other trivia like the fully qualified path of a specific
- * installation.
- *
- * Naming compartments for the self-ascribed name and version of each Node.js
- * package is insufficient because they are not guaranteed to be unique.
- * Dependencies do not necessarilly come from the npm registry and may be
- * for example derived from fully qualified URL's or Github org and project
- * names.
- * Package managers are also not required to fully deduplicate the hard
- * copy of each package even when they are identical resources.
- * Duplication is undesirable, but we elect to defer that problem to solutions
- * in the package managers, as the alternative would be to consistently hash
- * the original sources of the packages themselves, which may not even be
- * available much less pristine for us.
- *
- * So, instead, we use the lexically least path of dependency names, delimited
- * by hashes.
- * The compartment maps generated by the ./node-modules.js tooling pre-compute
- * these traces for our use here.
- * We sort the compartments lexically on their self-ascribed name and version,
- * and use the lexically least dependency name path as a tie-breaker.
- * The dependency path is logical and orthogonal to the package manager's
- * actual installation location, so should be orthogonal to the vagaries of the
- * package manager's deduplication algorithm.
- *
- * @param {Record<string, CompartmentDescriptor>} compartments
- * @returns {Record<string, string>} map from old to new compartment names.
- */
-const renameCompartments = compartments => {
-  /** @type {Record<string, string>} */
-  const compartmentRenames = create(null);
-  let index = 0;
-  let prev = '';
-
-  // The sort below combines two comparators to avoid depending on sort
-  // stability, which became standard as recently as 2019.
-  // If that date seems quaint, please accept my regards from the distant past.
-  // We are very proud of you.
-  const compartmentsByPath = Object.entries(compartments)
-    .map(([name, compartment]) => ({
-      name,
-      path: compartment.path,
-      label: compartment.label,
-    }))
-    .sort((a, b) => {
-      if (a.label === b.label) {
-        assert(a.path !== undefined && b.path !== undefined);
-        return pathCompare(a.path, b.path);
-      }
-      return stringCompare(a.label, b.label);
-    });
-
-  for (const { name, label } of compartmentsByPath) {
-    if (label === prev) {
-      compartmentRenames[name] = `${label}-n${index}`;
-      index += 1;
-    } else {
-      compartmentRenames[name] = label;
-      prev = label;
-      index = 1;
-    }
-  }
-  return compartmentRenames;
-};
-
-/**
- * @param {Record<string, CompartmentDescriptor>} compartments
- * @param {Sources} sources
- * @param {Record<string, string>} compartmentRenames
- */
-const translateCompartmentMap = (compartments, sources, compartmentRenames) => {
-  const result = create(null);
-  for (const compartmentName of keys(compartmentRenames)) {
-    const compartment = compartments[compartmentName];
-    const { name, label, retained, policy } = compartment;
-    if (retained) {
-      // rename module compartments
-      /** @type {Record<string, ModuleDescriptor>} */
-      const modules = create(null);
-      const compartmentModules = compartment.modules;
-      if (compartment.modules) {
-        for (const name of keys(compartmentModules).sort()) {
-          const module = compartmentModules[name];
-          if (module.compartment !== undefined) {
-            modules[name] = {
-              ...module,
-              compartment: compartmentRenames[module.compartment],
-            };
-          } else {
-            modules[name] = module;
-          }
-        }
-      }
-
-      // integrate sources into modules
-      const compartmentSources = sources[compartmentName];
-      if (compartmentSources) {
-        for (const name of keys(compartmentSources).sort()) {
-          const source = compartmentSources[name];
-          const { location, parser, exit, sha512, deferredError } = source;
-          if (location !== undefined) {
-            modules[name] = {
-              location,
-              parser,
-              sha512,
-            };
-          } else if (exit !== undefined) {
-            modules[name] = {
-              exit,
-            };
-          } else if (deferredError !== undefined) {
-            modules[name] = {
-              deferredError,
-            };
-          }
-        }
-      }
-
-      result[compartmentRenames[compartmentName]] = {
-        name,
-        label,
-        location: compartmentRenames[compartmentName],
-        modules,
-        policy,
-        // `scopes`, `types`, and `parsers` are not necessary since every
-        // loadable module is captured in `modules`.
-      };
-    }
-  }
-
-  return result;
-};
-
-/**
- * @param {Sources} sources
- * @param {Record<string, string>} compartmentRenames
- * @returns {Sources}
- */
-const renameSources = (sources, compartmentRenames) => {
-  return fromEntries(
-    entries(sources).map(([name, compartmentSources]) => [
-      compartmentRenames[name],
-      compartmentSources,
-    ]),
-  );
-};
-
 /**
  * @param {CompartmentMapDescriptor} compartmentMap
  * @param {Sources} sources
@@ -217,40 +61,18 @@ const renameSources = (sources, compartmentRenames) => {
  */
 const captureCompartmentMap = (compartmentMap, sources) => {
   const {
-    compartments,
-    entry: { compartment: entryCompartmentName, module: entryModuleSpecifier },
-  } = compartmentMap;
-
-  const compartmentRenames = renameCompartments(compartments);
-  const captureCompartments = translateCompartmentMap(
-    compartments,
-    sources,
+    compartmentMap: captureCompartmentMap,
+    sources: captureSources,
+    newToOldCompartmentNames,
     compartmentRenames,
-  );
-  const captureEntryCompartmentName = compartmentRenames[entryCompartmentName];
-  const captureSources = renameSources(sources, compartmentRenames);
-
-  const captureCompartmentMap = {
-    // TODO graceful migration from tags to conditions
-    // https://github.com/endojs/endo/issues/2388
-    tags: [],
-    entry: {
-      compartment: captureEntryCompartmentName,
-      module: entryModuleSpecifier,
-    },
-    compartments: captureCompartments,
-  };
-
-  // Cross-check:
-  // We assert that we have constructed a valid compartment map, not because it
-  // might not be, but to ensure that the assertCompartmentMap function can
-  // accept all valid compartment maps.
-  assertCompartmentMap(captureCompartmentMap);
-
+    oldToNewCompartmentNames,
+  } = digestCompartmentMap(compartmentMap, sources);
   return {
     captureCompartmentMap,
     captureSources,
     compartmentRenames,
+    newToOldCompartmentNames,
+    oldToNewCompartmentNames,
   };
 };
 

package/src/digest.d.ts

@@ -0,0 +1,5 @@
+export function digestCompartmentMap(compartmentMap: CompartmentMapDescriptor, sources: Sources): DigestResult;
+import type { CompartmentMapDescriptor } from './types.js';
+import type { Sources } from './types.js';
+import type { DigestResult } from './types.js';
+//# sourceMappingURL=digest.d.ts.map

package/src/digest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"digest.d.ts","sourceRoot":"","sources":["digest.js"],"names":[],"mappings":"AAwLO,qDAJI,wBAAwB,WACxB,OAAO,GACL,YAAY,CAoDxB;8CA3NS,YAAY;6BAAZ,YAAY;kCAAZ,YAAY"}