feat(compartment-mapper): expose extraParsers option

The `extraParsers` option is an optional mapping of file extension to parser name. Consumers can use it to associate a file extension with a specific parser, e.g., `{"node": "bytes"}` or override the default mappings. The specific use-case is enabling creation of compartment map descriptors for Node.js native modules (e.g., `index.node`) _without_ needing a `parsers: {node: 'bytes'}` property in the `package.json` of the package containing the native module.
endojs · Mar 28, 2024 · a4d6b59 · a4d6b59
1 parent 8f632a2
commit a4d6b59
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 1 deletion.
diff --git a/packages/compartment-mapper/src/archive.js b/packages/compartment-mapper/src/archive.js
@@ -301,6 +301,7 @@ export const loadCompartmentForArchive = async ({
   importHook: exitModuleImportHook = undefined,
   policy = undefined,
   sourceMapHook = undefined,
+  extraParsers = {},
 }) => {
   const { read, computeSha512 } = unpackReadPowers(readPowers);
   const {
@@ -357,6 +358,7 @@ export const loadCompartmentForArchive = async ({
     makeImportHook,
     moduleTransforms,
     parserForLanguage,
+    extraParsers,
     archiveOnly: true,
   });
   await compartment.load(entryModuleSpecifier);

diff --git a/packages/compartment-mapper/src/bundle.js b/packages/compartment-mapper/src/bundle.js
@@ -168,6 +168,7 @@ function getBundlerKitForModule(module) {
  * @param {object} [options.commonDependencies]
  * @param {Array<string>} [options.searchSuffixes]
  * @param {import('./types.js').SourceMapHook} [options.sourceMapHook]
+ * @param {Record<string, import('./types.js').Language>} [options.extraParsers]
  * @returns {Promise<string>}
  */
 export const makeBundle = async (read, moduleLocation, options) => {
@@ -178,6 +179,7 @@ export const makeBundle = async (read, moduleLocation, options) => {
     searchSuffixes,
     commonDependencies,
     sourceMapHook = undefined,
+    extraParsers = {},
   } = options || {};
   const tags = new Set(tagsOption);
 
@@ -223,6 +225,7 @@ export const makeBundle = async (read, moduleLocation, options) => {
     makeImportHook,
     moduleTransforms,
     parserForLanguage,
+    extraParsers,
   });
   await compartment.load(entryModuleSpecifier);
 

diff --git a/packages/compartment-mapper/src/import-archive.js b/packages/compartment-mapper/src/import-archive.js
@@ -250,6 +250,7 @@ const makeFauxModuleExportsNamespace = Compartment => {
  * @param {CompartmentConstructor} [options.Compartment]
  * @param {import('./types.js').ComputeSourceLocationHook} [options.computeSourceLocation]
  * @param {import('./types.js').ComputeSourceMapLocationHook} [options.computeSourceMapLocation]
+ * @param {Record<string, import('./types.js').Language>} [options.extraParsers]
  * @returns {Promise<import('./types.js').Application>}
  */
 export const parseArchive = async (
@@ -265,6 +266,7 @@ export const parseArchive = async (
     Compartment = DefaultCompartment,
     modules = undefined,
     importHook: exitModuleImportHook = undefined,
+    extraParsers = {},
   } = options;
 
   const compartmentExitModuleImportHook = exitModuleImportHookMaker({
@@ -345,6 +347,7 @@ export const parseArchive = async (
         }),
       ),
       Compartment,
+      extraParsers,
     });
 
     await pendingJobsPromise;
@@ -365,6 +368,7 @@ export const parseArchive = async (
       __shimTransforms__,
       Compartment,
       importHook: exitModuleImportHook,
+      extraParsers = {},
     } = options || {};
 
     const compartmentExitModuleImportHook = exitModuleImportHookMaker({
@@ -388,6 +392,7 @@ export const parseArchive = async (
       transforms,
       __shimTransforms__,
       Compartment,
+      extraParsers,
     });
 
     await pendingJobsPromise;

diff --git a/packages/compartment-mapper/src/import.js b/packages/compartment-mapper/src/import.js
@@ -80,6 +80,7 @@ export const loadLocation = async (readPowers, moduleLocation, options) => {
       __shimTransforms__,
       Compartment,
       importHook: exitModuleImportHook,
+      extraParsers = {},
     } = options;
     const compartmentExitModuleImportHook = exitModuleImportHookMaker({
       modules,
@@ -101,6 +102,7 @@ export const loadLocation = async (readPowers, moduleLocation, options) => {
       moduleTransforms,
       __shimTransforms__,
       Compartment,
+      extraParsers,
     });
 
     await pendingJobsPromise;

diff --git a/packages/compartment-mapper/src/link.js b/packages/compartment-mapper/src/link.js
@@ -147,6 +147,7 @@ export const mapParsers = (
   parserForLanguage,
   moduleTransforms = {},
 ) => {
+  /** @type {[string, string][]} */
   const languageForExtensionEntries = [];
   const problems = [];
   for (const [extension, language] of entries(languageForExtension)) {
@@ -340,6 +341,7 @@ export const link = (
     __shimTransforms__ = [],
     archiveOnly = false,
     Compartment = defaultCompartment,
+    extraParsers = {},
   },
 ) => {
   const { compartment: entryCompartmentName } = entry;
@@ -374,7 +376,7 @@ export const link = (
     compartmentDescriptor.modules = modules;
 
     const parse = mapParsers(
-      languageForExtension,
+      { ...languageForExtension, ...extraParsers },
       languageForModuleSpecifier,
       parserForLanguage,
       moduleTransforms,

diff --git a/packages/compartment-mapper/src/types.js b/packages/compartment-mapper/src/types.js
@@ -300,6 +300,7 @@ export {};
  * @property {ExitModuleImportHook} [importHook]
  * @property {Record<string, object>} [attenuations]
  * @property {typeof Compartment} [Compartment]
+ * @property {Record<string, Language>} [extraParsers]
  */
 
 /**
@@ -384,6 +385,7 @@ export {};
  * @property {Array<string>} [searchSuffixes]
  * @property {Record<string, string>} [commonDependencies]
  * @property {SourceMapHook} [sourceMapHook]
+ * @property {Record<string, Language>} [extraParsers] Additional mapping of file extension to parser
  */
 
 // /////////////////////////////////////////////////////////////////////////////