Merge pull request #7932 from QwikDev/throw-qwik-externals

fix(core vite): improve check for external qwik imports

Author: wmertens

.changeset/lemon-dingos-dance.md

@@ -2,4 +2,4 @@
 '@builder.io/qwik': minor
 ---
 
-BREAKING: (slightly) Qwik will no longer scan all modules at build start to detect Qwik modules. Instead, a runtime check is done to prevent duplicate core imports. If you get a runtime error, you need to fix your build settings so they don't externalize qwik-related libraries.
+BREAKING: (slightly) Qwik will no longer scan all modules at build start to detect Qwik modules (which should be bundled into your server code). Instead, a much faster build-time check is done, and Qwik will tell you if you need to update your `ssr.noExternal` settings in your Vite config.

packages/qwik/src/optimizer/src/plugins/vite.ts

@@ -699,24 +699,36 @@ async function checkExternals() {
     configResolved: (config) => {
       rootDir = config.root;
     },
+    // We check all SSR build lookups for external Qwik deps
     resolveId: {
       order: 'pre',
       async handler(source, importer, options) {
-        if (source.startsWith('node:') || seen.has(source)) {
+        if (!options.ssr || /^([./]|node:|[^a-z])/.test(source) || seen.has(source)) {
+          return;
+        }
+        const packageName = (
+          source.startsWith('@') ? source.split('/').slice(0, 2).join('/') : source.split('/')[0]
+        ).split('?')[0];
+        if (seen.has(packageName)) {
           return;
         }
         // technically we should check for each importer, but this is ok
         seen.add(source);
-        const result = await this.resolve(source, importer, { ...options, skipSelf: true });
+        seen.add(packageName);
+        const result = await this.resolve(packageName, importer, { ...options, skipSelf: true });
         if (result?.external) {
-          // For Qwik files, check if they should be externalized
-          if (await isQwikDep(source, importer ? path.dirname(importer) : rootDir)) {
+          // Qwik deps should not be external
+          if (await isQwikDep(packageName, importer ? path.dirname(importer) : rootDir)) {
             // TODO link to docs
             throw new Error(
-              `\n==============\n${source} is being treated as an external dependency, but it should be included in the server bundle, because it uses Qwik.\nPlease add the package to "ssr.noExternal" in the Vite config. \n==============`
+              `\n==============\n${packageName} is being treated as an external dependency, but it should be included in the server bundle, because it uses Qwik.\nPlease add the package to "ssr.noExternal" in the Vite config. \n==============`
             );
           }
         }
+        if (packageName === source) {
+          // We already resolved it, so return that result
+          return result;
+        }
       },
     },
   } as const satisfies VitePlugin<never>;