@embroider/core 3.4.20-unstable.3e8dbe3 → 3.4.20-unstable.4070ba7

package/src/module-resolver.js

@@ -24,6 +24,7 @@ const fs_1 = require("fs");
 const node_resolve_1 = require("./node-resolve");
 const virtual_route_entrypoint_1 = require("./virtual-route-entrypoint");
 const semver_1 = require("semver");
+const virtual_entrypoint_1 = require("./virtual-entrypoint");
 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
@@ -36,10 +37,7 @@ debug_1.default.formatters.p = (s) => {
     return s;
 };
 function logTransition(reason, before, after = before) {
-    if (after.isVirtual) {
-        debug(`[%s:virtualized] %s because %s\n  in    %p`, before.debugType, before.specifier, reason, before.fromFile);
-    }
-    else if (after.resolvedTo) {
+    if (after.resolvedTo) {
         debug(`[%s:resolvedTo] %s because %s\n  in    %p`, before.debugType, before.specifier, reason, before.fromFile);
     }
     else if (before.specifier !== after.specifier) {
@@ -53,17 +51,11 @@ function logTransition(reason, before, after = before) {
     else if (before.fromFile !== after.fromFile) {
         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(`[%s:unchanged] %s because %s\n  in    %p`, before.debugType, before.specifier, reason, before.fromFile);
     }
     return after;
 }
-function isTerminal(request) {
-    return request.isVirtual || request.isNotFound || Boolean(request.resolvedTo);
-}
 const compatPattern = /@embroider\/virtual\/(?<type>[^\/]+)\/(?<rest>.*)/;
 class Resolver {
     constructor(options) {
@@ -77,9 +69,6 @@ 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 = await this.handleGlobalsCompat(request);
         request = this.handleImplicitModules(request);
@@ -105,36 +94,43 @@ class Resolver {
     // rules.
     async resolve(request) {
         request = await this.beforeResolve(request);
+        let resolution;
         if (request.resolvedTo) {
-            return request.resolvedTo;
+            if (typeof request.resolvedTo === 'function') {
+                resolution = await request.resolvedTo();
+            }
+            else {
+                resolution = request.resolvedTo;
+            }
+        }
+        else {
+            resolution = await request.defaultResolve();
         }
-        let resolution = await request.defaultResolve();
         switch (resolution.type) {
             case 'found':
-            case 'ignored':
                 return resolution;
             case 'not_found':
                 break;
             default:
                 throw (0, assert_never_1.default)(resolution);
         }
+        request = request.clone();
         let nextRequest = await this.fallbackResolve(request);
         if (nextRequest === request) {
             // no additional fallback is available.
             return resolution;
         }
         if (nextRequest.resolvedTo) {
-            return nextRequest.resolvedTo;
+            if (typeof nextRequest.resolvedTo === 'function') {
+                return await nextRequest.resolvedTo();
+            }
+            else {
+                return nextRequest.resolvedTo;
+            }
         }
         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 || 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 nextRequest.defaultResolve();
-        }
         return this.resolve(nextRequest);
     }
     // Use standard NodeJS resolving, with our required compatibility rules on
@@ -158,7 +154,7 @@ class Resolver {
         return owningPackage;
     }
     generateFastbootSwitch(request) {
-        if (isTerminal(request)) {
+        if (request.resolvedTo) {
             return request;
         }
         let pkg = this.packageCache.ownerOfFile(request.fromFile);
@@ -186,7 +182,7 @@ class Resolver {
                             return logTransition('internal lookup from fastbootSwitch', request);
                         }
                         else {
-                            return logTransition('shadowed app fastboot', request, request.virtualize(switchFile));
+                            return logTransition('shadowed app fastboot', request, request.virtualize({ type: 'fastboot-switch', specifier: switchFile }));
                         }
                     }
                     else {
@@ -199,7 +195,7 @@ class Resolver {
     }
     handleFastbootSwitch(request) {
         var _a;
-        if (isTerminal(request)) {
+        if (request.resolvedTo) {
             return request;
         }
         let match = (0, virtual_content_1.decodeFastbootSwitch)(request.fromFile);
@@ -246,7 +242,7 @@ class Resolver {
         return logTransition('failed to match in fastboot switch', request);
     }
     handleImplicitModules(request) {
-        if (isTerminal(request)) {
+        if (request.resolvedTo) {
             return request;
         }
         let im = (0, virtual_content_1.decodeImplicitModules)(request.specifier);
@@ -260,51 +256,26 @@ class Resolver {
         let packageName = (0, shared_internals_1.packageName)(im.fromFile);
         if (packageName) {
             let dep = this.packageCache.resolve(packageName, pkg);
-            return logTransition(`dep's implicit modules`, request, request.virtualize((0, path_1.resolve)(dep.root, `-embroider-${im.type}.js`)));
+            return logTransition(`dep's implicit modules`, request, request.virtualize({ type: im.type, specifier: (0, path_1.resolve)(dep.root, `-embroider-${im.type}.js`) }));
         }
         else {
-            return logTransition(`own implicit modules`, request, request.virtualize((0, path_1.resolve)(pkg.root, `-embroider-${im.type}.js`)));
+            return logTransition(`own implicit modules`, request, request.virtualize({ type: im.type, specifier: (0, path_1.resolve)(pkg.root, `-embroider-${im.type}.js`) }));
         }
     }
     handleEntrypoint(request) {
-        var _a;
-        if (isTerminal(request)) {
-            return request;
-        }
-        //TODO move the extra forwardslash handling out into the vite plugin
-        const candidates = [
-            '@embroider/virtual/compat-modules',
-            '/@embroider/virtual/compat-modules',
-            './@embroider/virtual/compat-modules',
-        ];
-        if (!candidates.some(c => request.specifier.startsWith(c + '/') || request.specifier === c)) {
+        if (request.resolvedTo) {
             return request;
         }
-        const result = /\.?\/?@embroider\/virtual\/compat-modules(?:\/(?<packageName>.*))?/.exec(request.specifier);
-        if (!result) {
-            // TODO make a better error
-            throw new Error('entrypoint does not match pattern' + request.specifier);
-        }
-        const { packageName } = result.groups;
-        const requestingPkg = this.packageCache.ownerOfFile(request.fromFile);
-        if (!(requestingPkg === null || requestingPkg === void 0 ? void 0 : requestingPkg.isV2Ember())) {
-            throw new Error(`bug: found entrypoint import in non-ember package at ${request.fromFile}`);
-        }
-        let pkg;
-        if (packageName) {
-            pkg = this.packageCache.resolve(packageName, requestingPkg);
+        let virtualResponse = (0, virtual_entrypoint_1.virtualEntrypoint)(request, this.packageCache);
+        if (virtualResponse) {
+            return logTransition('entrypoint', request, request.virtualize(virtualResponse));
         }
         else {
-            pkg = requestingPkg;
+            return request;
         }
-        let matched = (0, resolve_exports_1.exports)(pkg.packageJSON, '-embroider-entrypoint.js', {
-            browser: true,
-            conditions: ['default', 'imports'],
-        });
-        return logTransition('entrypoint', request, request.virtualize((0, path_1.resolve)(pkg.root, (_a = matched === null || matched === void 0 ? void 0 : matched[0]) !== null && _a !== void 0 ? _a : '-embroider-entrypoint.js')));
     }
     handleRouteEntrypoint(request) {
-        if (isTerminal(request)) {
+        if (request.resolvedTo) {
             return request;
         }
         let routeName = (0, virtual_route_entrypoint_1.decodePublicRouteEntrypoint)(request.specifier);
@@ -315,11 +286,7 @@ class Resolver {
         if (!(pkg === null || pkg === void 0 ? void 0 : pkg.isV2Ember())) {
             throw new Error(`bug: found entrypoint import in non-ember package at ${request.fromFile}`);
         }
-        let matched = (0, resolve_exports_1.exports)(pkg.packageJSON, '-embroider-route-entrypoint.js', {
-            browser: true,
-            conditions: ['default', 'imports'],
-        });
-        return logTransition('route entrypoint', request, request.virtualize((0, virtual_route_entrypoint_1.encodeRouteEntrypoint)(pkg.root, matched === null || matched === void 0 ? void 0 : matched[0], routeName)));
+        return logTransition('route entrypoint', request, request.virtualize({ type: 'route-entrypoint', specifier: (0, virtual_route_entrypoint_1.encodeRouteEntrypoint)(pkg, routeName) }));
     }
     handleImplicitTestScripts(request) {
         //TODO move the extra forwardslash handling out into the vite plugin
@@ -335,7 +302,7 @@ class Resolver {
         if ((pkg === null || pkg === void 0 ? void 0 : pkg.root) !== this.options.engines[0].root) {
             throw new Error(`bug: found an import of ${request.specifier} in ${request.fromFile}, but this is not the top-level Ember app. The top-level Ember app is the only one that has support for @embroider/virtual/test-support.js. If you think something should be fixed in Embroider, please open an issue on https://github.com/embroider-build/embroider/issues.`);
         }
-        return logTransition('test-support', request, request.virtualize((0, path_1.resolve)(pkg.root, '-embroider-test-support.js')));
+        return logTransition('test-support', request, request.virtualize({ type: 'test-support-js', specifier: (0, path_1.resolve)(pkg.root, '-embroider-test-support.js') }));
     }
     handleTestSupportStyles(request) {
         //TODO move the extra forwardslash handling out into the vite plugin
@@ -351,10 +318,13 @@ class Resolver {
         if ((pkg === null || pkg === void 0 ? void 0 : pkg.root) !== this.options.engines[0].root) {
             throw new Error(`bug: found an import of ${request.specifier} in ${request.fromFile}, but this is not the top-level Ember app. The top-level Ember app is the only one that has support for @embroider/virtual/test-support.css. If you think something should be fixed in Embroider, please open an issue on https://github.com/embroider-build/embroider/issues.`);
         }
-        return logTransition('test-support-styles', request, request.virtualize((0, path_1.resolve)(pkg.root, '-embroider-test-support-styles.css')));
+        return logTransition('test-support-styles', request, request.virtualize({
+            type: 'test-support-css',
+            specifier: (0, path_1.resolve)(pkg.root, '-embroider-test-support-styles.css'),
+        }));
     }
     async handleGlobalsCompat(request) {
-        if (isTerminal(request)) {
+        if (request.resolvedTo) {
             return request;
         }
         let match = compatPattern.exec(request.specifier);
@@ -394,7 +364,7 @@ class Resolver {
         if (!pkg || !this.options.engines.some(e => e.root === (pkg === null || pkg === void 0 ? void 0 : pkg.root))) {
             throw new Error(`bug: found an import of ${request.specifier} in ${request.fromFile}, but this is not the top-level Ember app or Engine. The top-level Ember app is the only one that has support for @embroider/virtual/vendor.css. If you think something should be fixed in Embroider, please open an issue on https://github.com/embroider-build/embroider/issues.`);
         }
-        return logTransition('vendor-styles', request, request.virtualize((0, path_1.resolve)(pkg.root, '-embroider-vendor-styles.css')));
+        return logTransition('vendor-styles', request, request.virtualize({ type: 'vendor-css', specifier: (0, path_1.resolve)(pkg.root, '-embroider-vendor-styles.css') }));
     }
     resolveHelper(path, inEngine, request) {
         let target = this.parseGlobalPath(path, inEngine);
@@ -407,9 +377,7 @@ class Resolver {
         // first, the various places our template might be.
         for (let candidate of this.componentTemplateCandidates(target.packageName)) {
             let candidateSpecifier = `${target.packageName}${candidate.prefix}${target.memberName}${candidate.suffix}`;
-            let resolution = await this.resolve(request.alias(candidateSpecifier).rehome(target.from).withMeta({
-                runtimeFallback: false,
-            }));
+            let resolution = await this.resolve(request.alias(candidateSpecifier).rehome(target.from));
             if (resolution.type === 'found') {
                 hbsModule = resolution;
                 break;
@@ -418,12 +386,7 @@ class Resolver {
         // then the various places our javascript might be.
         for (let candidate of this.componentJSCandidates(target.packageName)) {
             let candidateSpecifier = `${target.packageName}${candidate.prefix}${target.memberName}${candidate.suffix}`;
-            let resolution = await this.resolve(request.alias(candidateSpecifier).rehome(target.from).withMeta({
-                runtimeFallback: false,
-            }));
-            if (resolution.type === 'ignored') {
-                return logTransition(`resolving to ignored component`, request, request.resolveTo(resolution));
-            }
+            let resolution = await this.resolve(request.alias(candidateSpecifier).rehome(target.from));
             // .hbs is a resolvable extension for us, so we need to exclude it here.
             // It matches as a priority lower than .js, so finding an .hbs means
             // there's definitely not a .js.
@@ -436,7 +399,10 @@ class Resolver {
             if (!this.emberVersionSupportsSeparateTemplates) {
                 throw new Error(`Components with separately resolved templates were removed at Ember 6.0. Migrate to either co-located js/ts + hbs files or to gjs/gts. https://deprecations.emberjs.com/id/component-template-resolving/. Bad template was: ${hbsModule.filename}.`);
             }
-            return logTransition(`resolveComponent found legacy HBS`, request, request.virtualize((0, virtual_content_1.virtualPairComponent)(hbsModule.filename, jsModule === null || jsModule === void 0 ? void 0 : jsModule.filename)));
+            return logTransition(`resolveComponent found legacy HBS`, request, request.virtualize({
+                type: 'component-pair',
+                specifier: (0, virtual_content_1.virtualPairComponent)(this.options.appRoot, hbsModule.filename, jsModule === null || jsModule === void 0 ? void 0 : jsModule.filename),
+            }));
         }
         else if (jsModule) {
             return logTransition(`resolving to resolveComponent found only JS`, request, request.resolveTo(jsModule));
@@ -450,13 +416,8 @@ class Resolver {
         // component, so here to resolve the ambiguity we need to actually resolve
         // that candidate to see if it works.
         let helperCandidate = this.resolveHelper(path, inEngine, request);
-        let helperMatch = await this.resolve(request.alias(helperCandidate.specifier).rehome(helperCandidate.fromFile).withMeta({
-            runtimeFallback: false,
-        }));
-        // for the case of 'ignored' that means that esbuild found this helper in an external
-        // package so it should be considered found in this case and we should not look for a
-        // component with this name
-        if (helperMatch.type === 'found' || helperMatch.type === 'ignored') {
+        let helperMatch = await this.resolve(request.alias(helperCandidate.specifier).rehome(helperCandidate.fromFile));
+        if (helperMatch.type === 'found') {
             return logTransition('resolve to ambiguous case matched a helper', request, request.resolveTo(helperMatch));
         }
         // unlike resolveHelper, resolveComponent already does pre-resolution in
@@ -634,7 +595,7 @@ class Resolver {
         });
     }
     handleRewrittenPackages(request) {
-        if (isTerminal(request)) {
+        if (request.resolvedTo) {
             return request;
         }
         let requestingPkg = this.packageCache.ownerOfFile(request.fromFile);
@@ -687,7 +648,7 @@ class Resolver {
         return request;
     }
     handleRenaming(request) {
-        if (isTerminal(request)) {
+        if (request.resolvedTo) {
             return request;
         }
         let packageName = (0, shared_internals_1.packageName)(request.specifier);
@@ -772,7 +733,7 @@ class Resolver {
         if ((pkg === null || pkg === void 0 ? void 0 : pkg.root) !== this.options.engines[0].root) {
             throw new Error(`bug: found an import of ${request.specifier} in ${request.fromFile}, but this is not the top-level Ember app. The top-level Ember app is the only one that has support for @embroider/virtual/vendor.js. If you think something should be fixed in Embroider, please open an issue on https://github.com/embroider-build/embroider/issues.`);
         }
-        return logTransition('vendor', request, request.virtualize((0, path_1.resolve)(pkg.root, '-embroider-vendor.js')));
+        return logTransition('vendor', request, request.virtualize({ type: 'vendor-js', specifier: (0, path_1.resolve)(pkg.root, '-embroider-vendor.js') }));
     }
     resolveWithinMovedPackage(request, pkg) {
         let levels = ['..'];
@@ -789,7 +750,7 @@ class Resolver {
         return newRequest.withMeta({ originalFromFile });
     }
     preHandleExternal(request) {
-        if (isTerminal(request)) {
+        if (request.resolvedTo) {
             return request;
         }
         let { specifier, fromFile } = request;
@@ -799,11 +760,6 @@ class Resolver {
         }
         let packageName = (0, shared_internals_1.packageName)(specifier);
         if (!packageName) {
-            // This is a relative import. We don't automatically externalize those
-            // because it's rare, and by keeping them static we give better errors. But
-            // we do allow them to be explicitly externalized by the package author (or
-            // a compat adapter). In the metadata, they would be listed in
-            // package-relative form, so we need to convert this specifier to that.
             let absoluteSpecifier = (0, path_1.resolve)((0, path_1.dirname)(fromFile), specifier);
             if (!absoluteSpecifier.startsWith(pkg.root)) {
                 // this relative path escape its package. So it's not really using
@@ -812,11 +768,6 @@ class Resolver {
                 // references to runtime utilities, like we do in @embroider/macros.
                 return logTransition('beforeResolve: relative path escapes its package', request);
             }
-            let packageRelativeSpecifier = (0, shared_internals_2.explicitRelative)(pkg.root, absoluteSpecifier);
-            if (isExplicitlyExternal(packageRelativeSpecifier, pkg)) {
-                let publicSpecifier = absoluteSpecifier.replace(pkg.root, pkg.name);
-                return this.external('beforeResolve', request, publicSpecifier);
-            }
             // if the requesting file is in an addon's app-js, the relative request
             // should really be understood as a request for a module in the containing
             // engine.
@@ -826,14 +777,6 @@ class Resolver {
             }
             return request;
         }
-        // absolute package imports can also be explicitly external based on their
-        // full specifier name
-        if (isExplicitlyExternal(specifier, pkg)) {
-            return this.external('beforeResolve', request, specifier);
-        }
-        if (shared_internals_1.emberVirtualPackages.has(packageName) && !pkg.hasDependency(packageName)) {
-            return this.external('beforeResolve emberVirtualPackages', request, specifier);
-        }
         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.
@@ -853,7 +796,7 @@ class Resolver {
                 if (!dep.isEmberAddon()) {
                     // classic ember addons can only import non-ember dependencies if they
                     // have ember-auto-import.
-                    return this.external('v1 package without auto-import', request, specifier);
+                    return logTransition('v1 package without auto-import', request, request.notFound());
                 }
             }
             catch (err) {
@@ -886,42 +829,9 @@ class Resolver {
             }
         }
     }
-    external(label, request, specifier) {
-        if (this.options.amdCompatibility === 'cjs') {
-            let filename = (0, virtual_content_1.virtualExternalCJSModule)(specifier);
-            return logTransition(label, request, request.virtualize(filename));
-        }
-        else if (this.options.amdCompatibility) {
-            let entry = this.options.amdCompatibility.es.find(entry => entry[0] === specifier || entry[0] + '/index' === specifier);
-            if (!entry && request.specifier === 'require') {
-                entry = ['require', ['default', 'has']];
-            }
-            if (!entry) {
-                throw new Error(`[${request.debugType}] A module tried to resolve "${request.specifier}" and didn't find it (${label}).
-
- - Maybe a dependency declaration is missing?
- - Remember that v1 addons can only import non-Ember-addon NPM dependencies if they include ember-auto-import in their dependencies.
- - If this dependency is available in the AMD loader (because someone manually called "define()" for it), you can configure a shim like:
-
-  amdCompatibility: {
-    es: [
-      ["${request.specifier}", ["default", "yourNamedExportsGoHere"]],
-    ]
-  }
-
-`);
-            }
-            let filename = (0, virtual_content_1.virtualExternalESModule)(specifier, entry[1]);
-            return logTransition(label, request, request.virtualize(filename));
-        }
-        else {
-            throw new Error(`Embroider's amdCompatibility option is disabled, but something tried to use it to access "${request.specifier}"`);
-        }
-    }
     async fallbackResolve(request) {
-        var _a, _b;
-        if (request.isVirtual) {
-            throw new Error('Build tool bug detected! Fallback resolve should never see a virtual request. It is expected that the defaultResolve for your bundler has already resolved this request');
+        if (request.resolvedTo) {
+            throw new Error('Build tool bug detected! Fallback resolve should never see an already-resolved request.');
         }
         if (request.specifier === '@embroider/macros') {
             // the macros package is always handled directly within babel (not
@@ -997,21 +907,6 @@ class Resolver {
                 return logTransition('fallbackResolve: non-relative appJsMatch', request, appJSMatch);
             }
         }
-        if (pkg.needsLooseResolving() && ((_b = (_a = request.meta) === null || _a === void 0 ? void 0 : _a.runtimeFallback) !== null && _b !== void 0 ? _b : true)) {
-            // auto-upgraded packages can fall back to attempting to find dependencies at
-            // 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, 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, request.specifier);
-            }
-        }
         // this is falling through with the original specifier which was
         // non-resolvable, which will presumably cause a static build error in stage3.
         return logTransition('fallbackResolve final exit', request);
@@ -1094,14 +989,15 @@ class Resolver {
             case 'fastboot-only':
                 return request.alias(matched.entry['fastboot-js'].specifier).rehome(matched.entry['fastboot-js'].fromFile);
             case 'both':
-                let foundAppJS = await this.resolve(request.alias(matched.entry['app-js'].specifier).rehome(matched.entry['app-js'].fromFile).withMeta({
-                    runtimeFallback: false,
-                }));
+                let foundAppJS = await this.resolve(request.alias(matched.entry['app-js'].specifier).rehome(matched.entry['app-js'].fromFile));
                 if (foundAppJS.type !== 'found') {
                     throw new Error(`${matched.entry['app-js'].fromPackageName} declared ${inEngineSpecifier} in packageJSON.ember-addon.app-js, but that module does not exist`);
                 }
                 let { names } = (0, describe_exports_1.describeExports)((0, fs_1.readFileSync)(foundAppJS.filename, 'utf8'), { configFile: false });
-                return request.virtualize((0, virtual_content_1.fastbootSwitch)(matched.matched, (0, path_1.resolve)(engine.root, 'package.json'), names));
+                return request.virtualize({
+                    type: 'fastboot-switch',
+                    specifier: (0, virtual_content_1.fastbootSwitch)(matched.matched, (0, path_1.resolve)(engine.root, 'package.json'), names),
+                });
         }
     }
     // check whether the given file with the given owningPackage is an addon's
@@ -1165,9 +1061,6 @@ __decorate([
 __decorate([
     (0, typescript_memoize_1.Memoize)()
 ], Resolver.prototype, "emberVersionSupportsSeparateTemplates", null);
-function isExplicitlyExternal(specifier, fromPkg) {
-    return Boolean(fromPkg.isV2Addon() && fromPkg.meta['externals'] && fromPkg.meta['externals'].includes(specifier));
-}
 // we don't want to allow things that resolve only by accident that are likely
 // to break in other setups. For example: import your dependencies'
 // dependencies, or importing your own name from within a monorepo (which will