extract import map generation logic into utility

packages/cli/src/lib/walker-package-ranger.js

@@ -0,0 +1,235 @@
+/* eslint-disable max-depth,complexity */
+import * as acorn from 'acorn';
+import fs from 'fs';
+import { getNodeModulesLocationForPackage } from './node-modules-utils.js';
+import path from 'path';
+import * as walk from 'acorn-walk';
+
+const importMap = {};
+
+const updateImportMap = (entry, entryPath) => {
+
+  if (path.extname(entryPath) === '') {
+    entryPath = `${entryPath}.js`;
+  }
+
+  // handle WIn v Unix-style path separators and force to /
+  importMap[entry.replace(/\\/g, '/')] = entryPath.replace(/\\/g, '/');
+};
+
+// handle ESM paths that have varying levels of nesting, e.g. export * from '../../something.js'
+// https://github.com/ProjectEvergreen/greenwood/issues/820
+async function resolveRelativeSpecifier(specifier, modulePath, dependency) {
+  const absoluteNodeModulesLocation = await getNodeModulesLocationForPackage(dependency);
+
+  // handle WIn v Unix-style path separators and force to /
+  return `${dependency}${path.join(path.dirname(modulePath), specifier).replace(/\\/g, '/').replace(absoluteNodeModulesLocation.replace(/\\/g, '/', ''), '')}`;
+}
+
+async function getPackageEntryPath(packageJson) {
+  let entry = packageJson.exports
+    ? Object.keys(packageJson.exports) // first favor export maps first
+    : packageJson.module // next favor ESM entry points
+      ? packageJson.module
+      : packageJson.main && packageJson.main !== '' // then favor main
+        ? packageJson.main
+        : 'index.js'; // lastly, fallback to index.js
+
+  // use .mjs version if it exists, for packages like redux
+  if (!Array.isArray(entry) && fs.existsSync(`${await getNodeModulesLocationForPackage(packageJson.name)}/${entry.replace('.js', '.mjs')}`)) {
+    entry = entry.replace('.js', '.mjs');
+  }
+
+  return entry;
+}
+
+async function walkModule(modulePath, dependency) {
+  const moduleContents = fs.readFileSync(modulePath, 'utf-8');
+
+  walk.simple(acorn.parse(moduleContents, {
+    ecmaVersion: '2020',
+    sourceType: 'module'
+  }), {
+    async ImportDeclaration(node) {
+      let { value: sourceValue } = node.source;
+      const absoluteNodeModulesLocation = await getNodeModulesLocationForPackage(dependency);
+      const isBarePath = sourceValue.indexOf('http') !== 0 && sourceValue.charAt(0) !== '.' && sourceValue.charAt(0) !== path.sep;
+      const hasExtension = path.extname(sourceValue) !== '';
+
+      if (isBarePath && !hasExtension) {
+        if (!importMap[sourceValue]) {
+          updateImportMap(sourceValue, `/node_modules/${sourceValue}`);
+        }
+
+        await walkPackageJson(path.join(absoluteNodeModulesLocation, 'package.json'));
+      } else if (isBarePath) {
+        updateImportMap(sourceValue, `/node_modules/${sourceValue}`);
+      } else {
+        // walk this module for all its dependencies
+        sourceValue = !hasExtension
+          ? `${sourceValue}.js`
+          : sourceValue;
+
+        if (fs.existsSync(path.join(absoluteNodeModulesLocation, sourceValue))) {
+          const entry = `/node_modules/${await resolveRelativeSpecifier(sourceValue, modulePath, dependency)}`;
+          await walkModule(path.join(absoluteNodeModulesLocation, sourceValue), dependency);
+
+          updateImportMap(path.join(dependency, sourceValue), entry);
+        }
+      }
+    },
+    async ExportNamedDeclaration(node) {
+      const sourceValue = node && node.source ? node.source.value : '';
+
+      if (sourceValue !== '' && sourceValue.indexOf('http') !== 0) {
+        // handle relative specifier
+        if (sourceValue.indexOf('.') === 0) {
+          const entry = `/node_modules/${await resolveRelativeSpecifier(sourceValue, modulePath, dependency)}`;
+
+          updateImportMap(path.join(dependency, sourceValue), entry);
+        } else {
+          // handle bare specifier
+          updateImportMap(sourceValue, `/node_modules/${sourceValue}`);
+        }
+      }
+    },
+    async ExportAllDeclaration(node) {
+      const sourceValue = node && node.source ? node.source.value : '';
+
+      if (sourceValue !== '' && sourceValue.indexOf('http') !== 0) {
+        if (sourceValue.indexOf('.') === 0) {
+          const entry = `/node_modules/${await resolveRelativeSpecifier(sourceValue, modulePath, dependency)}`;
+
+          updateImportMap(path.join(dependency, sourceValue), entry);
+        } else {
+          updateImportMap(sourceValue, `/node_modules/${sourceValue}`);
+        }
+      }
+    }
+  });
+}
+
+async function walkPackageJson(packageJson = {}) {
+  // while walking a package.json we need to find its entry point, e.g. index.js
+  // and then walk that for import / export statements
+  // and walk its package.json for its dependencies
+
+  for (const dependency of Object.keys(packageJson.dependencies || {})) {
+    const dependencyPackageRootPath = path.join(process.cwd(), 'node_modules', dependency);
+    const dependencyPackageJsonPath = path.join(dependencyPackageRootPath, 'package.json');
+    const dependencyPackageJson = JSON.parse(fs.readFileSync(dependencyPackageJsonPath, 'utf-8'));
+    const entry = await getPackageEntryPath(dependencyPackageJson);
+    const isJavascriptPackage = Array.isArray(entry) || typeof entry === 'string' && entry.endsWith('.js') || entry.endsWith('.mjs');
+
+    if (isJavascriptPackage) {
+      const absoluteNodeModulesLocation = await getNodeModulesLocationForPackage(dependency);
+
+      // https://nodejs.org/api/packages.html#packages_determining_module_system
+      if (Array.isArray(entry)) {
+        // we have an exportMap
+        const exportMap = entry;
+
+        for (const entry of exportMap) {
+          const exportMapEntry = dependencyPackageJson.exports[entry];
+          let packageExport;
+
+          if (Array.isArray(exportMapEntry)) {
+            let fallbackPath;
+            let esmPath;
+
+            exportMapEntry.forEach((mapItem) => {
+              switch (typeof mapItem) {
+
+                case 'string':
+                  fallbackPath = mapItem;
+                  break;
+                case 'object':
+                  const entryTypes = Object.keys(mapItem);
+
+                  if (entryTypes.import) {
+                    esmPath = entryTypes.import;
+                  } else if (entryTypes.require) {
+                    console.error('The package you are importing needs commonjs support.  Please use our commonjs plugin to fix this error.');
+                    fallbackPath = entryTypes.require;
+                  } else if (entryTypes.default) {
+                    console.warn('The package you are requiring may need commonjs support.  If this module is not working for you, consider adding our commonjs plugin.');
+                    fallbackPath = entryTypes.default;
+                  }
+                  break;
+                default:
+                  console.warn(`Sorry, we were unable to detect the module type for ${mapItem} :(.  please consider opening an issue to let us know about your use case.`);
+                  break;
+
+              }
+            });
+
+            packageExport = esmPath
+              ? esmPath
+              : fallbackPath;
+          } else if (exportMapEntry.import || exportMapEntry.default) {
+            packageExport = exportMapEntry.import
+              ? exportMapEntry.import
+              : exportMapEntry.default;
+
+            // use the dependency itself as an entry in the importMap
+            if (entry === '.') {
+              updateImportMap(dependency, `/node_modules/${path.join(dependency, packageExport)}`);
+            }
+          } else if (exportMapEntry.endsWith && (exportMapEntry.endsWith('.js') || exportMapEntry.endsWith('.mjs')) && exportMapEntry.indexOf('*') < 0) {
+            // is probably a file, so _not_ an export array, package.json, or wildcard export
+            packageExport = exportMapEntry;
+          }
+
+          if (packageExport) {
+            const packageExportLocation = path.resolve(absoluteNodeModulesLocation, packageExport);
+
+            if (packageExport.endsWith('js')) {
+              updateImportMap(path.join(dependency, entry), `/node_modules/${path.join(dependency, packageExport)}`);
+            } else if (fs.lstatSync(packageExportLocation).isDirectory()) {
+              fs.readdirSync(packageExportLocation)
+                .filter(file => file.endsWith('.js') || file.endsWith('.mjs'))
+                .forEach((file) => {
+                  updateImportMap(path.join(dependency, packageExport, file), `/node_modules/${path.join(dependency, packageExport, file)}`);
+                });
+            } else {
+              console.warn('Warning, not able to handle export', path.join(dependency, packageExport));
+            }
+          }
+        }
+
+        await walkPackageJson(dependencyPackageJson);
+      } else {
+        const packageEntryPointPath = path.join(absoluteNodeModulesLocation, entry);
+
+        // sometimes a main file is actually just an empty string... :/
+        if (fs.existsSync(packageEntryPointPath)) {
+          updateImportMap(dependency, `/node_modules/${path.join(dependency, entry)}`);
+
+          await walkModule(packageEntryPointPath, dependency);
+          await walkPackageJson(dependencyPackageJson);
+        }
+      }
+    }
+  }
+
+  return importMap;
+}
+
+function mergeImportMap(html = '', map = {}) {
+  // es-modules-shims breaks on dangling commas in an importMap :/
+  const danglingComma = html.indexOf('"imports": {}') > 0 ? '' : ',';
+  const importMap = JSON.stringify(map).replace('}', '').replace('{', '');
+
+  const merged = html.replace('"imports": {', `
+    "imports": {
+      ${importMap}${danglingComma}
+  `);
+
+  return merged;
+}
+
+export {
+  mergeImportMap,
+  walkPackageJson,
+  walkModule
+};