fix: remove @brillout/require-shim (#3091)

Author: brillout

.github/workflows/ci/prepare.spec.ts

@@ -765,14 +765,6 @@ describe('prepare()', () => {
               },
               "testFilePath": "test/playground/test-preview.test.ts",
             },
-            {
-              "localConfig": {
-                "ci": {
-                  "job": "Unit Tests E2E",
-                },
-              },
-              "testFilePath": "test/require-shim/test-prod.test.ts",
-            },
             {
               "localConfig": {
                 "ci": {

packages/vike/package.json

@@ -123,7 +123,6 @@
     "@brillout/import": "^0.2.6",
     "@brillout/json-serializer": "^0.5.21",
     "@brillout/picocolors": "^1.0.30",
-    "@brillout/require-shim": "^0.1.2",
     "@brillout/vite-plugin-server-entry": "^0.7.17",
     "cac": "^6.0.0",
     "es-module-lexer": "^1.0.0",

packages/vike/src/node/vite/plugins/pluginCommon.ts

@@ -9,7 +9,6 @@ import { assert, assertUsage, assertWarning } from '../../../utils/assert.js'
 import { hasProp } from '../../../utils/hasProp.js'
 import { isObject } from '../../../utils/isObject.js'
 import { assertRollupInput } from './build/pluginBuildConfig.js'
-import { installRequireShim_setUserRootDir } from '@brillout/require-shim'
 import pc from '@brillout/picocolors'
 import { assertResolveAlias } from './pluginCommon/assertResolveAlias.js'
 import { isViteCli } from '../shared/isViteCli.js'
@@ -77,7 +76,6 @@ function pluginCommon(vikeVitePluginOptions: unknown): Plugin[] {
         handler(config) {
           assertViteRoot(config._rootResolvedEarly!, config)
           assertSingleInstance(config)
-          installRequireShim_setUserRootDir(config.root)
         },
       },
     },

packages/vike/src/node/vite/plugins/pluginDev/optimizeDeps.ts

@@ -33,6 +33,15 @@ const LATE_DISCOVERED = [
   '@compiled/react/runtime',
 ]
 
+// TO-DO/eventually: remove this.
+// Avoid following warning for older vike-photon versions:
+// ```
+// [11:32:49.768][/test/photon-vercel/.test-dev.test.ts][pnpm run dev][stderr] Failed to resolve dependency: vike > @brillout/require-shim, present in ssr 'optimizeDeps.include'
+// ```
+// https://github.com/vikejs/vike-photon/issues/56
+// https://github.com/vikejs/vike/pull/3091
+const ALWAYS_REMOVE = ['@brillout/require-shim', 'vike > @brillout/require-shim']
+
 const optimizeDeps = {
   optimizeDeps: {
     exclude: [
@@ -109,6 +118,15 @@ async function resolveOptimizeDeps(config: ResolvedConfig) {
     }
   }
 
+  // Remove @brillout/require-shim
+  config.optimizeDeps.include = remove(config.optimizeDeps.include)
+  config.optimizeDeps.entries = remove(config.optimizeDeps.entries)
+  for (const envName in config.environments) {
+    const env = config.environments[envName]!
+    env.optimizeDeps.include = remove(env.optimizeDeps.include ?? [])
+    env.optimizeDeps.entries = remove(env.optimizeDeps.entries ?? [])
+  }
+
   // Debug
   if (debug.isActivated)
     debug('optimizeDeps', {
@@ -241,13 +259,23 @@ async function getPageDeps(config: ResolvedConfig, pageConfigs: PageConfigBuildT
 }
 
 function add(input: string | string[] | undefined, listAddendum: string[]): string[] {
-  const list = !input ? [] : isArray(input) ? unique(input) : [input]
+  const list = normalizeInput(input)
   listAddendum.forEach((e) => {
     if (!list.includes(e)) list.push(e)
   })
   return list
 }
+function normalizeInput(input: string[] | string | undefined): string[] {
+  const list = !input ? [] : isArray(input) ? unique(input) : [input]
+  return list
+}
 function unique<T>(arr: T[]): T[] {
   const arrUnique = Array.from(new Set(arr))
   return arr.length !== arrUnique.length ? arrUnique : arr
 }
+
+function remove(input: string[] | string | undefined) {
+  let list = normalizeInput(input)
+  list = list.filter((e) => !ALWAYS_REMOVE.includes(e))
+  return list
+}

packages/vike/src/server/assertEnvServer.ts

@@ -3,7 +3,6 @@ import '../utils/trackLogs.js' // should be loaded ASAP
 import { assertIsNotBrowser } from '../utils/assertIsNotBrowser.js'
 import { assertNodeVersion } from '../utils/assertNodeVersion.js'
 import { setAssertAlwaysShowStackTrace } from '../utils/assert.js'
-import { installRequireShim } from '@brillout/require-shim'
 import { isDebugError } from '../utils/debug.js'
 import { installUncaughtErrorHandlers } from '../utils/installUncaughtErrorHandlers.js'
 
@@ -23,7 +22,6 @@ function onLoad() {
     setAssertAlwaysShowStackTrace()
   }
   addEcosystemStamp()
-  installRequireShim()
 }
 
 // Used by: