@embroider/core 3.4.3-unstable.ebf92d6 → 3.4.3-unstable.efd9117

package/src/module-resolver.js

@@ -15,59 +15,47 @@ const path_1 = require("path");
 const shared_internals_2 = require("@embroider/shared-internals");
 const debug_1 = __importDefault(require("debug"));
 const assert_never_1 = __importDefault(require("assert-never"));
-const resolve_1 = __importDefault(require("resolve"));
 const reverse_exports_1 = __importDefault(require("@embroider/reverse-exports"));
 const virtual_content_1 = require("./virtual-content");
 const typescript_memoize_1 = require("typescript-memoize");
 const describe_exports_1 = require("./describe-exports");
 const fs_1 = require("fs");
+const node_resolve_1 = require("./node-resolve");
 const debug = (0, debug_1.default)('embroider:resolver');
+// Using a formatter makes this work lazy so nothing happens when we aren't
+// logging. It is unfortunate that formatters are a globally mutable config and
+// you can only use single character names, but oh well.
+debug_1.default.formatters.p = (s) => {
+    let cwd = process.cwd();
+    if (s.startsWith(cwd)) {
+        return s.slice(cwd.length + 1);
+    }
+    return s;
+};
 function logTransition(reason, before, after = before) {
     if (after.isVirtual) {
-        debug(`virtualized %s in %s because %s`, before.specifier, before.fromFile, reason);
+        debug(`[%s:virtualized] %s because %s\n  in    %p`, before.debugType, before.specifier, reason, before.fromFile);
     }
     else if (before.specifier !== after.specifier) {
         if (before.fromFile !== after.fromFile) {
-            debug(`aliased and rehomed: %s to %s, from %s to %s because %s`, before.specifier, after.specifier, before.fromFile, after.fromFile, reason);
+            debug(`[%s:aliased and rehomed] %s to %s\n  because %s\n  from    %p\n  to      %p`, before.debugType, before.specifier, after.specifier, reason, before.fromFile, after.fromFile);
         }
         else {
-            debug(`aliased: %s to %s in %s because`, before.specifier, after.specifier, before.fromFile, reason);
+            debug(`[%s:aliased] %s to %s\n  because %s`, before.debugType, before.specifier, after.specifier, reason);
         }
     }
     else if (before.fromFile !== after.fromFile) {
-        debug(`rehomed: %s from %s to %s because`, before.specifier, before.fromFile, after.fromFile, reason);
+        debug(`[%s:rehomed] %s, because %s\n  from    %p\n  to      %p`, before.debugType, before.specifier, reason, before.fromFile, after.fromFile);
+    }
+    else if (after.isNotFound) {
+        debug(`[%s:not-found] %s because %s\n  in    %p`, before.debugType, before.specifier, reason, before.fromFile);
     }
     else {
-        debug(`unchanged: %s in %s because %s`, before.specifier, before.fromFile, reason);
+        debug(`[%s:unchanged] %s because %s\n  in    %p`, before.debugType, before.specifier, reason, before.fromFile);
     }
     return after;
 }
 const compatPattern = /#embroider_compat\/(?<type>[^\/]+)\/(?<rest>.*)/;
-class NodeModuleRequest {
-    constructor(specifier, fromFile, isVirtual, meta) {
-        this.specifier = specifier;
-        this.fromFile = fromFile;
-        this.isVirtual = isVirtual;
-        this.meta = meta;
-    }
-    alias(specifier) {
-        return new NodeModuleRequest(specifier, this.fromFile, false, this.meta);
-    }
-    rehome(fromFile) {
-        if (this.fromFile === fromFile) {
-            return this;
-        }
-        else {
-            return new NodeModuleRequest(this.specifier, fromFile, false, this.meta);
-        }
-    }
-    virtualize(filename) {
-        return new NodeModuleRequest(filename, this.fromFile, true, this.meta);
-    }
-    withMeta(meta) {
-        return new NodeModuleRequest(this.specifier, this.fromFile, this.isVirtual, meta);
-    }
-}
 class Resolver {
     constructor(options) {
         this.options = options;
@@ -80,6 +68,9 @@ class Resolver {
             // why we need to know about it.
             return logTransition('early exit', request);
         }
+        if (request.specifier === 'require') {
+            return this.external('early require', request, request.specifier);
+        }
         request = this.handleFastbootSwitch(request);
         request = this.handleGlobalsCompat(request);
         request = this.handleImplicitModules(request);
@@ -141,10 +132,10 @@ class Resolver {
         if (nextRequest.fromFile === request.fromFile && nextRequest.specifier === request.specifier) {
             throw new Error('Bug Discovered! New request is not === original request but has the same fromFile and specifier. This will likely create a loop.');
         }
-        if (nextRequest.isVirtual) {
-            // virtual requests are terminal, there is no more beforeResolve or
-            // fallbackResolve around them. The defaultResolve is expected to know how
-            // to implement them.
+        if (nextRequest.isVirtual || nextRequest.isNotFound) {
+            // virtual and NotFound requests are terminal, there is no more
+            // beforeResolve or fallbackResolve around them. The defaultResolve is
+            // expected to know how to implement them.
             return yield defaultResolve(nextRequest);
         }
         return yield* this.internalResolve(nextRequest, defaultResolve);
@@ -153,39 +144,7 @@ class Resolver {
     // top. This is a convenience method for calling resolveSync with the
     // defaultResolve already configured to be "do the normal node thing".
     nodeResolve(specifier, fromFile) {
-        let resolution = this.resolveSync(new NodeModuleRequest(specifier, fromFile, false, undefined), request => {
-            if (request.isVirtual) {
-                return {
-                    type: 'found',
-                    result: {
-                        type: 'virtual',
-                        content: (0, virtual_content_1.virtualContent)(request.specifier, this),
-                        filename: request.specifier,
-                    },
-                };
-            }
-            try {
-                let filename = resolve_1.default.sync(request.specifier, {
-                    basedir: (0, path_1.dirname)(request.fromFile),
-                    extensions: this.options.resolvableExtensions,
-                });
-                return { type: 'found', result: { type: 'real', filename } };
-            }
-            catch (err) {
-                if (err.code !== 'MODULE_NOT_FOUND') {
-                    throw err;
-                }
-                return { type: 'not_found', err };
-            }
-        });
-        switch (resolution.type) {
-            case 'not_found':
-                return resolution;
-            case 'found':
-                return resolution.result;
-            default:
-                throw (0, assert_never_1.default)(resolution);
-        }
+        return (0, node_resolve_1.nodeResolve)(this, specifier, fromFile);
     }
     get packageCache() {
         return shared_internals_2.RewrittenPackageCache.shared('embroider', this.options.appRoot);
@@ -415,10 +374,10 @@ class Resolver {
     parseGlobalPath(path, inEngine) {
         let parts = path.split('@');
         if (parts.length > 1 && parts[0].length > 0) {
-            return { packageName: parts[0], memberName: parts[1], from: (0, path_1.resolve)(inEngine.root, 'pacakge.json') };
+            return { packageName: parts[0], memberName: parts[1], from: (0, path_1.resolve)(inEngine.root, 'package.json') };
         }
         else {
-            return { packageName: inEngine.packageName, memberName: path, from: (0, path_1.resolve)(inEngine.root, 'pacakge.json') };
+            return { packageName: inEngine.packageName, memberName: path, from: (0, path_1.resolve)(inEngine.root, 'package.json') };
         }
     }
     engineConfig(packageName) {
@@ -526,7 +485,7 @@ class Resolver {
         return owningEngine;
     }
     handleRewrittenPackages(request) {
-        if (request.isVirtual) {
+        if (request.isVirtual || request.isNotFound) {
             return request;
         }
         let requestingPkg = this.packageCache.ownerOfFile(request.fromFile);
@@ -545,10 +504,6 @@ class Resolver {
                 targetPkg = this.packageCache.resolve(packageName, requestingPkg);
             }
             catch (err) {
-                // this is not the place to report resolution failures. If the thing
-                // doesn't resolve, we're just not interested in redirecting it for
-                // backward-compat, that's all. The rest of the system will take care of
-                // reporting a failure to resolve (or handling it a different way)
                 if (err.code !== 'MODULE_NOT_FOUND') {
                     throw err;
                 }
@@ -564,14 +519,26 @@ class Resolver {
             return logTransition('request targets a moved package', request, this.resolveWithinMovedPackage(request, targetPkg));
         }
         else if (originalRequestingPkg !== requestingPkg) {
-            // in this case, the requesting package is moved but its destination is
-            // not, so we need to rehome the request back to the original location.
-            return logTransition('outbound request from moved package', request, request.withMeta({ wasMovedTo: request.fromFile }).rehome((0, path_1.resolve)(originalRequestingPkg.root, 'package.json')));
+            if (targetPkg) {
+                // in this case, the requesting package is moved but its destination is
+                // not, so we need to rehome the request back to the original location.
+                return logTransition('outbound request from moved package', request, request
+                    // setting meta here because if this fails, we want the fallback
+                    // logic to revert our rehome and continue from the *moved* package.
+                    .withMeta({ originalFromFile: request.fromFile })
+                    .rehome((0, path_1.resolve)(originalRequestingPkg.root, 'package.json')));
+            }
+            else {
+                // requesting package was moved and we failed to find its target. We
+                // can't let that accidentally succeed in the defaultResolve because we
+                // could escape the moved package system.
+                return logTransition('missing outbound request from moved package', request, request.notFound());
+            }
         }
         return request;
     }
     handleRenaming(request) {
-        if (request.isVirtual) {
+        if (request.isVirtual || request.isNotFound) {
             return request;
         }
         let packageName = (0, shared_internals_1.packageName)(request.specifier);
@@ -609,7 +576,10 @@ class Resolver {
             // packages get this help, v2 packages are natively supposed to make their
             // own modules resolvable, and we want to push them all to do that
             // correctly.
-            return logTransition(`v1 self-import`, request, request.alias(request.specifier.replace(pkg.name, '.')).rehome((0, path_1.resolve)(pkg.root, 'package.json')));
+            // "my-package/foo" -> "./foo"
+            // "my-package" -> "./" (this can't be just "." because node's require.resolve doesn't reliable support that)
+            let selfImportPath = request.specifier === pkg.name ? './' : request.specifier.replace(pkg.name, '.');
+            return logTransition(`v1 self-import`, request, request.alias(selfImportPath).rehome((0, path_1.resolve)(pkg.root, 'package.json')));
         }
         return request;
     }
@@ -618,16 +588,17 @@ class Resolver {
         if (pkg.name.startsWith('@')) {
             levels.push('..');
         }
+        let originalFromFile = request.fromFile;
         let newRequest = request.rehome((0, path_1.resolve)(pkg.root, ...levels, 'moved-package-target.js'));
         if (newRequest === request) {
             return request;
         }
-        return newRequest.withMeta({
-            resolvedWithinPackage: pkg.root,
-        });
+        // setting meta because if this fails, we want the fallback to pick up back
+        // in the original requesting package.
+        return newRequest.withMeta({ originalFromFile });
     }
     preHandleExternal(request) {
-        if (request.isVirtual) {
+        if (request.isVirtual || request.isNotFound) {
             return request;
         }
         let { specifier, fromFile } = request;
@@ -660,7 +631,15 @@ class Resolver {
             // engine
             let logicalLocation = this.reverseSearchAppTree(pkg, request.fromFile);
             if (logicalLocation) {
-                return logTransition('beforeResolve: relative import in app-js', request, request.rehome((0, path_1.resolve)(logicalLocation.owningEngine.root, logicalLocation.inAppName)));
+                return logTransition('beforeResolve: relative import in app-js', request, request
+                    .alias('./' + path_1.posix.join((0, path_1.dirname)(logicalLocation.inAppName), request.specifier))
+                    // it's important that we're rehoming this to the root of the engine
+                    // (which we know really exists), and not to a subdir like
+                    // logicalLocation.inAppName (which might not physically exist),
+                    // because some environments (including node's require.resolve) will
+                    // refuse to do resolution from a notional path that doesn't
+                    // physically exist.
+                    .rehome((0, path_1.resolve)(logicalLocation.owningEngine.root, 'package.json')));
             }
             return request;
         }
@@ -675,11 +654,11 @@ class Resolver {
         if (shared_internals_1.emberVirtualPeerDeps.has(packageName) && !pkg.hasDependency(packageName)) {
             // addons (whether auto-upgraded or not) may use the app's
             // emberVirtualPeerDeps, like "@glimmer/component" etc.
-            if (!this.options.activeAddons[packageName]) {
-                throw new Error(`${pkg.name} is trying to import the app's ${packageName} package, but it seems to be missing`);
+            let addon = this.locateActiveAddon(packageName);
+            if (!addon) {
+                throw new Error(`${pkg.name} is trying to import the emberVirtualPeerDep "${packageName}", but it seems to be missing`);
             }
-            let newHome = (0, path_1.resolve)(this.packageCache.maybeMoved(this.packageCache.get(this.options.appRoot)).root, 'package.json');
-            return logTransition(`emberVirtualPeerDeps in v2 addon`, request, request.rehome(newHome));
+            return logTransition(`emberVirtualPeerDeps`, request, request.rehome(addon.canResolveFromFile));
         }
         // if this file is part of an addon's app-js, it's really the logical
         // package to which it belongs (normally the app) that affects some policy
@@ -710,6 +689,22 @@ class Resolver {
         }
         return request;
     }
+    locateActiveAddon(packageName) {
+        if (packageName === this.options.modulePrefix) {
+            // the app itself is something that addon's can classically resolve if they know it's name.
+            return {
+                root: this.options.appRoot,
+                canResolveFromFile: (0, path_1.resolve)(this.packageCache.maybeMoved(this.packageCache.get(this.options.appRoot)).root, 'package.json'),
+            };
+        }
+        for (let engine of this.options.engines) {
+            for (let addon of engine.activeAddons) {
+                if (addon.name === packageName) {
+                    return addon;
+                }
+            }
+        }
+    }
     external(label, request, specifier) {
         if (this.options.amdCompatibility === 'cjs') {
             let filename = (0, virtual_content_1.virtualExternalCJSModule)(specifier);
@@ -743,7 +738,7 @@ class Resolver {
         }
     }
     fallbackResolve(request) {
-        var _a, _b, _c;
+        var _a;
         if (request.specifier === '@embroider/macros') {
             // the macros package is always handled directly within babel (not
             // necessarily as a real resolvable package), so we should not mess with it.
@@ -751,8 +746,7 @@ class Resolver {
             // why we need to know about it.
             return logTransition('fallback early exit', request);
         }
-        let { specifier, fromFile } = request;
-        if (compatPattern.test(specifier)) {
+        if (compatPattern.test(request.specifier)) {
             // Some kinds of compat requests get rewritten into other things
             // deterministically. For example, "#embroider_compat/helpers/whatever"
             // means only "the-current-engine/helpers/whatever", and if that doesn't
@@ -768,39 +762,33 @@ class Resolver {
             // here.
             return request;
         }
-        if (fromFile.endsWith('moved-package-target.js')) {
-            if (!((_a = request.meta) === null || _a === void 0 ? void 0 : _a.resolvedWithinPackage)) {
-                throw new Error(`bug: embroider resolver's meta is not propagating`);
-            }
-            fromFile = (0, path_1.resolve)((_b = request.meta) === null || _b === void 0 ? void 0 : _b.resolvedWithinPackage, 'package.json');
-        }
-        let pkg = this.packageCache.ownerOfFile(fromFile);
+        let pkg = this.packageCache.ownerOfFile(request.fromFile);
         if (!pkg) {
             return logTransition('no identifiable owningPackage', request);
         }
-        // if we rehomed this request to its un-rewritten location in order to try
-        // to do the defaultResolve from there, now we refer back to the rewritten
-        // location because that's what we want to use when asking things like
-        // isV2Ember()
+        // meta.originalFromFile gets set when we want to try to rehome a request
+        // but then come back to the original location here in the fallback when the
+        // rehomed request fails
         let movedPkg = this.packageCache.maybeMoved(pkg);
         if (movedPkg !== pkg) {
-            if (!((_c = request.meta) === null || _c === void 0 ? void 0 : _c.wasMovedTo)) {
+            let originalFromFile = (_a = request.meta) === null || _a === void 0 ? void 0 : _a.originalFromFile;
+            if (typeof originalFromFile !== 'string') {
                 throw new Error(`bug: embroider resolver's meta is not propagating`);
             }
-            fromFile = request.meta.wasMovedTo;
+            request = request.rehome(originalFromFile);
             pkg = movedPkg;
         }
         if (!pkg.isV2Ember()) {
             return logTransition('fallbackResolve: not in an ember package', request);
         }
-        let packageName = (0, shared_internals_1.packageName)(specifier);
+        let packageName = (0, shared_internals_1.packageName)(request.specifier);
         if (!packageName) {
             // this is a relative import
             let withinEngine = this.engineConfig(pkg.name);
             if (withinEngine) {
                 // it's a relative import inside an engine (which also means app), which
                 // means we may need to satisfy the request via app tree merging.
-                let appJSMatch = this.searchAppTree(request, withinEngine, (0, shared_internals_2.explicitRelative)(pkg.root, (0, path_1.resolve)((0, path_1.dirname)(fromFile), specifier)));
+                let appJSMatch = this.searchAppTree(request, withinEngine, (0, shared_internals_2.explicitRelative)(pkg.root, (0, path_1.resolve)((0, path_1.dirname)(request.fromFile), request.specifier)));
                 if (appJSMatch) {
                     return logTransition('fallbackResolve: relative appJsMatch', request, appJSMatch);
                 }
@@ -814,23 +802,32 @@ class Resolver {
             }
         }
         // auto-upgraded packages can fall back to the set of known active addons
-        if (pkg.meta['auto-upgraded'] && this.options.activeAddons[packageName]) {
-            const rehomed = this.resolveWithinMovedPackage(request, this.packageCache.get(this.options.activeAddons[packageName]));
-            if (rehomed !== request) {
-                return logTransition(`activeAddons`, request, rehomed);
+        if (pkg.meta['auto-upgraded']) {
+            let addon = this.locateActiveAddon(packageName);
+            if (addon) {
+                const rehomed = request.rehome(addon.canResolveFromFile);
+                if (rehomed !== request) {
+                    return logTransition(`activeAddons`, request, rehomed);
+                }
             }
         }
-        let logicalLocation = this.reverseSearchAppTree(pkg, fromFile);
+        let logicalLocation = this.reverseSearchAppTree(pkg, request.fromFile);
         if (logicalLocation) {
             // the requesting file is in an addon's appTree. We didn't succeed in
             // resolving this (non-relative) request from inside the actual addon, so
             // next try to resolve it from the corresponding logical location in the
             // app.
-            return logTransition('fallbackResolve: retry from logical home of app-js file', request, request.rehome((0, path_1.resolve)(logicalLocation.owningEngine.root, logicalLocation.inAppName)));
+            return logTransition('fallbackResolve: retry from logical home of app-js file', request, 
+            // it might look more precise to rehome into logicalLocation.inAppName
+            // rather than package.json. But that logical location may not actually
+            // exist, and some systems (including node's require.resolve) will be
+            // mad about trying to resolve from notional paths that don't really
+            // exist.
+            request.rehome((0, path_1.resolve)(logicalLocation.owningEngine.root, 'package.json')));
         }
         let targetingEngine = this.engineConfig(packageName);
         if (targetingEngine) {
-            let appJSMatch = this.searchAppTree(request, targetingEngine, specifier.replace(packageName, '.'));
+            let appJSMatch = this.searchAppTree(request, targetingEngine, request.specifier.replace(packageName, '.'));
             if (appJSMatch) {
                 return logTransition('fallbackResolve: non-relative appJsMatch', request, appJSMatch);
             }
@@ -840,14 +837,14 @@ class Resolver {
             // runtime. Native v2 packages can only get this behavior in the
             // isExplicitlyExternal case above because they need to explicitly ask for
             // externals.
-            return this.external('v1 catch-all fallback', request, specifier);
+            return this.external('v1 catch-all fallback', request, request.specifier);
         }
         else {
             // native v2 packages don't automatically externalize *everything* the way
             // auto-upgraded packages do, but they still externalize known and approved
             // ember virtual packages (like @ember/component)
             if (shared_internals_1.emberVirtualPackages.has(packageName)) {
-                return this.external('emberVirtualPackages', request, specifier);
+                return this.external('emberVirtualPackages', request, request.specifier);
             }
         }
         // this is falling through with the original specifier which was