@embroider/compat 3.4.8 → 3.4.9-unstable.4c21dd5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@embroider/compat",
-  "version": "3.4.8",
+  "version": "3.4.9-unstable.4c21dd5",
   "private": false,
   "description": "Backward compatibility layer for the Embroider build system.",
   "repository": {
@@ -19,6 +19,9 @@
   "bin": {
     "embroider-compat-audit": "./src/audit-cli.js"
   },
+  "scripts": {
+    "test": "jest"
+  },
   "dependencies": {
     "@babel/code-frame": "^7.14.5",
     "@babel/core": "^7.14.5",
@@ -27,6 +30,7 @@
     "@babel/preset-env": "^7.14.5",
     "@babel/runtime": "^7.18.6",
     "@babel/traverse": "^7.14.5",
+    "@embroider/macros": "1.16.1-unstable.4c21dd5",
     "@types/babel__code-frame": "^7.0.2",
     "@types/yargs": "^17.0.3",
     "assert-never": "^1.1.0",
@@ -59,10 +63,12 @@
     "tree-sync": "^2.1.0",
     "typescript-memoize": "^1.0.1",
     "walk-sync": "^3.0.0",
-    "yargs": "^17.0.1",
-    "@embroider/macros": "1.16.0"
+    "yargs": "^17.0.1"
   },
   "devDependencies": {
+    "@embroider/core": "3.4.9-unstable.4c21dd5",
+    "@embroider/sample-transforms": "workspace:*",
+    "@embroider/test-support": "workspace:*",
     "@glimmer/syntax": "^0.84.3",
     "@glint/template": "^1.0.0",
     "@types/babel__core": "^7.1.14",
@@ -81,19 +87,13 @@
     "broccoli-node-api": "^1.7.0",
     "code-equality-assertions": "^0.9.0",
     "ember-engines": "^0.8.19",
-    "scenario-tester": "^2.1.2",
-    "typescript": "^5.1.6",
-    "@embroider/core": "^3.4.8",
-    "@embroider/sample-transforms": "0.0.0",
-    "@embroider/test-support": "0.36.0"
+    "scenario-tester": "^3.0.1",
+    "typescript": "^5.1.6"
   },
   "peerDependencies": {
-    "@embroider/core": "^3.4.8"
+    "@embroider/core": "3.4.9-unstable.4c21dd5"
   },
   "engines": {
     "node": "12.* || 14.* || >= 16"
-  },
-  "scripts": {
-    "test": "jest"
   }
-}
+}

package/src/audit.d.ts

@@ -1,7 +1,6 @@
-/// <reference types="node" />
-import type { ExportAll, InternalImport, NamespaceMarker } from './audit/babel-visitor';
 import { AuditBuildOptions, AuditOptions } from './audit/options';
 import { BuildError, isBuildError } from './audit/build';
+import { type Module } from './module-visitor';
 export interface AuditMessage {
     message: string;
     detail: string;
@@ -26,56 +25,19 @@ export interface Finding {
     detail: string;
     codeFrame?: string;
 }
-export interface Module {
-    appRelativePath: string;
-    consumedFrom: (string | RootMarker)[];
-    imports: Import[];
-    exports: string[];
-    resolutions: {
-        [source: string]: string | null;
-    };
-    content: string;
-}
-interface ResolutionFailure {
-    isResolutionFailure: true;
-}
-interface InternalModule {
-    consumedFrom: (string | RootMarker)[];
-    parsed?: {
-        imports: InternalImport[];
-        exports: Set<string | ExportAll>;
-        isCJS: boolean;
-        isAMD: boolean;
-        dependencies: string[];
-        transpiledContent: string | Buffer;
-    };
-    resolved?: Map<string, string | ResolutionFailure>;
-    linked?: {
-        exports: Set<string>;
-    };
-}
-export interface Import {
-    source: string;
-    specifiers: {
-        name: string | NamespaceMarker;
-        local: string | null;
-    }[];
-}
 export declare class AuditResults {
     modules: {
         [file: string]: Module;
     };
     findings: Finding[];
-    static create(baseDir: string, findings: Finding[], modules: Map<string, InternalModule>): AuditResults;
+    static create(baseDir: string, findings: Finding[], modules: Record<string, Module>): AuditResults;
     humanReadable(): string;
     get perfect(): boolean;
 }
 export declare class Audit {
     private originAppRoot;
     private options;
-    private modules;
     private virtualModules;
-    private moduleQueue;
     private findings;
     private frames;
     static run(options: AuditBuildOptions): Promise<AuditResults>;
@@ -87,24 +49,14 @@ export declare class Audit {
     private get resolverParams();
     private resolver;
     private debug;
-    private visitorFor;
-    private drainQueue;
     run(): Promise<AuditResults>;
+    private resolveId;
+    private load;
     private handleResolverError;
-    private linkModules;
-    private linkModule;
     private inspectModules;
     private inspectImports;
     private moduleProvidesName;
-    private visitHTML;
-    private visitJS;
-    private visitHBS;
-    private visitJSON;
-    private resolveDeps;
+    private handleJSON;
     private pushFinding;
-    private scheduleVisit;
-}
-export interface RootMarker {
-    isRoot: true;
 }
-export declare function isRootMarker(value: string | RootMarker | undefined): value is RootMarker;
+export { Module };

package/src/audit.js

@@ -9,72 +9,31 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isRootMarker = exports.Audit = exports.AuditResults = exports.isBuildError = exports.BuildError = void 0;
+exports.Audit = exports.AuditResults = exports.isBuildError = exports.BuildError = void 0;
 const fs_extra_1 = require("fs-extra");
 const path_1 = require("path");
 const core_1 = require("@embroider/core");
 const typescript_memoize_1 = require("typescript-memoize");
 const chalk_1 = __importDefault(require("chalk"));
-const jsdom_1 = __importDefault(require("jsdom"));
 const groupBy_1 = __importDefault(require("lodash/groupBy"));
-const fromPairs_1 = __importDefault(require("lodash/fromPairs"));
 const babel_visitor_1 = require("./audit/babel-visitor");
 const build_1 = require("./audit/build");
 Object.defineProperty(exports, "BuildError", { enumerable: true, get: function () { return build_1.BuildError; } });
 Object.defineProperty(exports, "isBuildError", { enumerable: true, get: function () { return build_1.isBuildError; } });
-const { JSDOM } = jsdom_1.default;
-function isResolutionFailure(result) {
-    return typeof result === 'object' && 'isResolutionFailure' in result;
-}
-function isResolved(module) {
-    return Boolean((module === null || module === void 0 ? void 0 : module.parsed) && module.resolved);
-}
-function isLinked(module) {
-    return Boolean((module === null || module === void 0 ? void 0 : module.parsed) && module.resolved && module.linked);
-}
+const module_visitor_1 = require("./module-visitor");
 class AuditResults {
     constructor() {
         this.modules = {};
         this.findings = [];
     }
     static create(baseDir, findings, modules) {
-        var _a, _b, _c, _d;
         let results = new this();
-        for (let [filename, module] of modules) {
-            let publicModule = {
-                appRelativePath: (0, core_1.explicitRelative)(baseDir, filename),
-                consumedFrom: module.consumedFrom.map(entry => {
-                    if (isRootMarker(entry)) {
-                        return entry;
-                    }
-                    else {
-                        return (0, core_1.explicitRelative)(baseDir, entry);
-                    }
-                }),
-                resolutions: module.resolved
-                    ? (0, fromPairs_1.default)([...module.resolved].map(([source, target]) => [
-                        source,
-                        isResolutionFailure(target) ? null : (0, core_1.explicitRelative)(baseDir, target),
-                    ]))
-                    : {},
-                imports: ((_a = module.parsed) === null || _a === void 0 ? void 0 : _a.imports)
-                    ? module.parsed.imports.map(i => ({
-                        source: i.source,
-                        specifiers: i.specifiers.map(s => ({
-                            name: s.name,
-                            local: s.local,
-                        })),
-                    }))
-                    : [],
-                exports: ((_b = module.linked) === null || _b === void 0 ? void 0 : _b.exports) ? [...module.linked.exports] : [],
-                content: ((_c = module.parsed) === null || _c === void 0 ? void 0 : _c.transpiledContent)
-                    ? (_d = module.parsed) === null || _d === void 0 ? void 0 : _d.transpiledContent.toString()
-                    : 'module failed to transpile',
-            };
-            results.modules[(0, core_1.explicitRelative)(baseDir, filename)] = publicModule;
-        }
+        results.modules = modules;
         for (let finding of findings) {
-            let relFinding = Object.assign({}, finding, { filename: (0, core_1.explicitRelative)(baseDir, finding.filename) });
+            const filename = finding.filename.startsWith('./')
+                ? finding.filename
+                : (0, core_1.explicitRelative)(baseDir, finding.filename);
+            let relFinding = Object.assign({}, finding, { filename });
             results.findings.push(relFinding);
         }
         return results;
@@ -94,7 +53,7 @@ class AuditResults {
             }
             output.push(indent(chalk_1.default.blueBright(`file was included because:`), 1));
             let pointer = filename;
-            while (!isRootMarker(pointer)) {
+            while (!(0, module_visitor_1.isRootMarker)(pointer)) {
                 // the zero here means we only display the first path we found. I think
                 // that's a fine tradeoff to keep the output smaller.
                 let nextPointer = (_a = this.modules[pointer]) === null || _a === void 0 ? void 0 : _a.consumedFrom[0];
@@ -102,7 +61,7 @@ class AuditResults {
                     output.push(indent(chalk_1.default.red(`couldn't figure out why this was included. Please file a bug against @embroider/compat.`), 2));
                     break;
                 }
-                if (isRootMarker(nextPointer)) {
+                if ((0, module_visitor_1.isRootMarker)(nextPointer)) {
                     output.push(indent('packageJSON.ember-addon.assets', 2));
                 }
                 else {
@@ -144,12 +103,52 @@ class Audit {
     constructor(originAppRoot, options = {}) {
         this.originAppRoot = originAppRoot;
         this.options = options;
-        this.modules = new Map();
         this.virtualModules = new Map();
-        this.moduleQueue = new Set();
         this.findings = [];
         this.frames = new babel_visitor_1.CodeFrameStorage();
         this.resolver = new core_1.Resolver(this.resolverParams);
+        this.resolveId = async (specifier, fromFile) => {
+            if (['@embroider/macros'].includes(specifier)) {
+                // the audit process deliberately removes the @embroider/macros babel
+                // plugins, so the imports are still present and should be left alone.
+                return undefined;
+            }
+            if (fromFile.endsWith('.html') && specifier.startsWith(this.meta['root-url'])) {
+                // root-relative URLs in HTML are actually relative to the appDir
+                specifier = (0, core_1.explicitRelative)((0, path_1.dirname)(fromFile), (0, path_1.resolve)(this.movedAppRoot, specifier.replace(this.meta['root-url'], '')));
+            }
+            let resolution = await this.resolver.nodeResolve(specifier, fromFile);
+            switch (resolution.type) {
+                case 'virtual':
+                    this.virtualModules.set(resolution.filename, resolution.content);
+                    return resolution.filename;
+                case 'not_found':
+                    return undefined;
+                case 'real':
+                    return resolution.filename;
+            }
+        };
+        this.load = async (id) => {
+            let content;
+            if (this.virtualModules.has(id)) {
+                content = this.virtualModules.get(id);
+            }
+            else {
+                content = (0, fs_extra_1.readFileSync)(id);
+            }
+            if (id.endsWith('.html')) {
+                return { content, type: 'html' };
+            }
+            else if (id.endsWith('.hbs')) {
+                return { content: (0, core_1.hbsToJS)(content.toString('utf8')), type: 'javascript' };
+            }
+            else if (id.endsWith('.json')) {
+                return this.handleJSON(id, content);
+            }
+            else {
+                return { content, type: 'javascript' };
+            }
+        };
     }
     get pkg() {
         return (0, fs_extra_1.readJSONSync)((0, path_1.join)(this.movedAppRoot, 'package.json'));
@@ -177,64 +176,22 @@ class Audit {
             console.log(message, ...args);
         }
     }
-    visitorFor(filename) {
-        if (filename.endsWith('.html')) {
-            return this.visitHTML;
-        }
-        else if (filename.endsWith('.hbs')) {
-            return this.visitHBS;
-        }
-        else if (filename.endsWith('.json')) {
-            return this.visitJSON;
-        }
-        else {
-            return this.visitJS;
-        }
-    }
-    async drainQueue() {
-        while (this.moduleQueue.size > 0) {
-            let filename = this.moduleQueue.values().next().value;
-            this.moduleQueue.delete(filename);
-            this.debug('visit', filename);
-            let visitor = this.visitorFor(filename);
-            let content;
-            if (this.virtualModules.has(filename)) {
-                content = this.virtualModules.get(filename);
-            }
-            else {
-                content = (0, fs_extra_1.readFileSync)(filename);
-            }
-            // cast is safe because the only way to get into the queue is to go
-            // through scheduleVisit, and scheduleVisit creates the entry in
-            // this.modules.
-            let module = this.modules.get(filename);
-            let visitResult = await visitor.call(this, filename, content);
-            if (Array.isArray(visitResult)) {
-                // the visitor was unable to figure out the ParseFields and returned
-                // some number of Findings to us to explain why.
-                for (let finding of visitResult) {
-                    this.pushFinding(finding);
-                }
-            }
-            else {
-                module.parsed = visitResult;
-                module.resolved = await this.resolveDeps(visitResult.dependencies, filename);
-            }
-        }
-    }
     async run() {
         globalThis.embroider_audit = this.handleResolverError.bind(this);
         try {
             this.debug(`meta`, this.meta);
-            for (let asset of this.meta.assets) {
-                if (asset.endsWith('.html')) {
-                    this.scheduleVisit((0, path_1.resolve)(this.movedAppRoot, asset), { isRoot: true });
-                }
-            }
-            await this.drainQueue();
-            this.linkModules();
-            this.inspectModules();
-            return AuditResults.create(this.originAppRoot, this.findings, this.modules);
+            let entrypoints = this.meta.assets.filter(a => a.endsWith('html')).map(a => (0, path_1.resolve)(this.movedAppRoot, a));
+            let modules = await (0, module_visitor_1.visitModules)({
+                base: this.originAppRoot,
+                entrypoints,
+                resolveId: this.resolveId,
+                load: this.load,
+                findings: this.findings,
+                frames: this.frames,
+                babelConfig: this.babelConfig,
+            });
+            this.inspectModules(modules);
+            return AuditResults.create(this.originAppRoot, this.findings, modules);
         }
         finally {
             delete globalThis.embroider_audit;
@@ -248,54 +205,22 @@ class Audit {
             codeFrame: this.frames.render(this.frames.forSource(msg.source)(msg)),
         });
     }
-    linkModules() {
-        for (let module of this.modules.values()) {
-            if (isResolved(module)) {
-                this.linkModule(module);
+    inspectModules(modules) {
+        for (let [filename, module] of Object.entries(modules)) {
+            if (module.type === 'complete') {
+                this.inspectImports(filename, module, modules);
             }
         }
     }
-    linkModule(module) {
-        let exports = new Set();
-        for (let exp of module.parsed.exports) {
-            if (typeof exp === 'string') {
-                exports.add(exp);
-            }
-            else {
-                let moduleName = module.resolved.get(exp.all);
-                if (!isResolutionFailure(moduleName)) {
-                    let target = this.modules.get(moduleName);
-                    if (!isLinked(target) && isResolved(target)) {
-                        this.linkModule(target);
-                    }
-                    if (isLinked(target)) {
-                        for (let innerExp of target.linked.exports) {
-                            exports.add(innerExp);
-                        }
-                    }
-                    else {
-                        // our module doesn't successfully enter linked state because it
-                        // depends on stuff that also couldn't
-                        return;
-                    }
-                }
-            }
-        }
-        module.linked = {
-            exports,
-        };
-    }
-    inspectModules() {
-        for (let [filename, module] of this.modules) {
-            if (isLinked(module)) {
-                this.inspectImports(filename, module);
+    inspectImports(filename, module, modules) {
+        for (let imp of module.imports) {
+            // our Audit should always ignore any imports of @embroider/macros because we already ignored them
+            // in resolveId above
+            if (imp.source === '@embroider/macros') {
+                continue;
             }
-        }
-    }
-    inspectImports(filename, module) {
-        for (let imp of module.parsed.imports) {
-            let resolved = module.resolved.get(imp.source);
-            if (isResolutionFailure(resolved)) {
+            let resolved = module.resolutions[imp.source];
+            if (!resolved) {
                 this.findings.push({
                     filename,
                     message: 'unable to resolve dependency',
@@ -304,9 +229,9 @@ class Audit {
                 });
             }
             else if (resolved) {
-                let target = this.modules.get(resolved);
+                let target = modules[resolved];
                 for (let specifier of imp.specifiers) {
-                    if (isLinked(target) && !this.moduleProvidesName(target, specifier.name)) {
+                    if (target.type === 'complete' && !this.moduleProvidesName(target, specifier.name)) {
                         if (specifier.name === 'default') {
                             let backtick = '`';
                             this.findings.push({
@@ -333,137 +258,27 @@ class Audit {
         // any module can provide a namespace.
         // CJS and AMD are too dynamic to be sure exactly what names are available,
         // so they always get a pass
-        return (0, babel_visitor_1.isNamespaceMarker)(name) || target.parsed.isCJS || target.parsed.isAMD || target.linked.exports.has(name);
-    }
-    async visitHTML(filename, content) {
-        let dom = new JSDOM(content);
-        let scripts = dom.window.document.querySelectorAll('script[type="module"]');
-        let dependencies = [];
-        for (let script of scripts) {
-            let src = script.src;
-            if (!src) {
-                continue;
-            }
-            if (new URL(src, 'http://example.com:4321').origin !== 'http://example.com:4321') {
-                // src was absolute, we don't handle it
-                continue;
-            }
-            if (src.startsWith(this.meta['root-url'])) {
-                // root-relative URLs are actually relative to the appDir
-                src = (0, core_1.explicitRelative)((0, path_1.dirname)(filename), (0, path_1.resolve)(this.movedAppRoot, src.replace(this.meta['root-url'], '')));
-            }
-            dependencies.push(src);
-        }
-        return {
-            imports: [],
-            exports: new Set(),
-            isCJS: false,
-            isAMD: false,
-            dependencies,
-            transpiledContent: content,
-        };
+        return (0, babel_visitor_1.isNamespaceMarker)(name) || target.isCJS || target.isAMD || target.exports.includes(name);
     }
-    async visitJS(filename, content) {
-        let rawSource = content.toString('utf8');
-        try {
-            let result = (0, babel_visitor_1.auditJS)(rawSource, filename, this.babelConfig, this.frames);
-            for (let problem of result.problems) {
-                this.pushFinding({
-                    filename,
-                    message: problem.message,
-                    detail: problem.detail,
-                    codeFrame: this.frames.render(problem.codeFrameIndex),
-                });
-            }
-            return {
-                exports: result.exports,
-                imports: result.imports,
-                isCJS: result.isCJS,
-                isAMD: result.isAMD,
-                dependencies: result.imports.map(i => i.source),
-                transpiledContent: result.transpiledContent,
-            };
-        }
-        catch (err) {
-            if (['BABEL_PARSE_ERROR', 'BABEL_TRANSFORM_ERROR'].includes(err.code)) {
-                return [
-                    {
-                        filename,
-                        message: `failed to parse`,
-                        detail: err.toString().replace(filename, (0, core_1.explicitRelative)(this.originAppRoot, filename)),
-                    },
-                ];
-            }
-            else {
-                throw err;
-            }
-        }
-    }
-    async visitHBS(filename, content) {
-        let rawSource = content.toString('utf8');
-        let js = (0, core_1.hbsToJS)(rawSource);
-        return this.visitJS(filename, js);
-    }
-    async visitJSON(filename, content) {
+    handleJSON(filename, content) {
         let js;
         try {
             let structure = JSON.parse(content.toString('utf8'));
             js = `export default ${JSON.stringify(structure)}`;
         }
         catch (err) {
-            return [
-                {
-                    filename,
-                    message: `failed to parse JSON`,
-                    detail: err.toString().replace(filename, (0, core_1.explicitRelative)(this.originAppRoot, filename)),
-                },
-            ];
+            this.findings.push({
+                filename,
+                message: `failed to parse JSON`,
+                detail: err.toString().replace(filename, (0, core_1.explicitRelative)(this.originAppRoot, filename)),
+            });
+            return;
         }
-        return this.visitJS(filename, js);
-    }
-    async resolveDeps(deps, fromFile) {
-        let resolved = new Map();
-        for (let dep of deps) {
-            let resolution = await this.resolver.nodeResolve(dep, fromFile);
-            switch (resolution.type) {
-                case 'virtual':
-                    this.virtualModules.set(resolution.filename, resolution.content);
-                    resolved.set(dep, resolution.filename);
-                    this.scheduleVisit(resolution.filename, fromFile);
-                    break;
-                case 'not_found':
-                    if (['@embroider/macros', '@ember/template-factory'].includes(dep)) {
-                        // the audit process deliberately removes the @embroider/macros babel
-                        // plugins, so the imports are still present and should be left alone.
-                        continue;
-                    }
-                    resolved.set(dep, { isResolutionFailure: true });
-                    break;
-                case 'real':
-                    resolved.set(dep, resolution.filename);
-                    this.scheduleVisit(resolution.filename, fromFile);
-                    break;
-            }
-        }
-        return resolved;
+        return { content: js, type: 'javascript' };
     }
     pushFinding(finding) {
         this.findings.push(finding);
     }
-    scheduleVisit(filename, parent) {
-        let record = this.modules.get(filename);
-        if (!record) {
-            this.debug(`discovered`, filename);
-            record = {
-                consumedFrom: [parent],
-            };
-            this.modules.set(filename, record);
-            this.moduleQueue.add(filename);
-        }
-        else {
-            record.consumedFrom.push(parent);
-        }
-    }
 }
 exports.Audit = Audit;
 __decorate([
@@ -489,8 +304,4 @@ function indent(str, level) {
         .map(line => spaces + line)
         .join('\n');
 }
-function isRootMarker(value) {
-    return Boolean(value && typeof value !== 'string' && value.isRoot);
-}
-exports.isRootMarker = isRootMarker;
 //# sourceMappingURL=audit.js.map