Make require stub available in ESM

vercel · Sep 19, 2024 · ed1030b · ed1030b
1 parent 8e1a92b
commit ed1030b
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 6 deletions.
diff --git a/...opack/crates/turbopack-ecmascript-runtime/js/src/browser/dev/runtime/base/runtime-base.ts b/...opack/crates/turbopack-ecmascript-runtime/js/src/browser/dev/runtime/base/runtime-base.ts
@@ -380,6 +380,7 @@ function instantiateModule(id: ModuleId, source: SourceInfo): Module {
           k: refresh,
           R: createResolvePathFromModule(r),
           b: getWorkerBlobURL,
+          z: requireStub,
           __dirname: typeof module.id === "string" ? module.id.replace(/(^|\/)\/+$/, "") : module.id
         })
       );

diff --git a/turbopack/crates/turbopack-ecmascript-runtime/js/src/nodejs/runtime.ts b/turbopack/crates/turbopack-ecmascript-runtime/js/src/nodejs/runtime.ts
@@ -177,7 +177,7 @@ function loadWebAssemblyModule(chunkPath: ChunkPath) {
   return compileWebAssemblyFromPath(resolved);
 }
 
-function getWorkerBlobURL(_chunks: ChunkPath[]) {
+function getWorkerBlobURL(_chunks: ChunkPath[]): never {
   throw new Error("Worker blobs are not implemented yet for Node.js");
 }
 
@@ -255,6 +255,7 @@ function instantiateModule(id: ModuleId, source: SourceInfo): Module {
       U: relativeURL,
       R: createResolvePathFromModule(r),
       b: getWorkerBlobURL,
+      z: requireStub,
       __dirname: typeof module.id === "string" ? module.id.replace(/(^|\/)\/+$/, "") : module.id
     });
   } catch (error) {

diff --git a/turbopack/crates/turbopack-ecmascript-runtime/js/src/shared/runtime-types.d.ts b/turbopack/crates/turbopack-ecmascript-runtime/js/src/shared/runtime-types.d.ts
@@ -77,5 +77,6 @@ interface TurbopackBaseContext {
   P: ResolveAbsolutePath;
   U: RelativeURL;
   b: GetWorkerBlobURL,
+  z: CommonJsRequire
   __dirname: string;
 }
diff --git a/turbopack/crates/turbopack-ecmascript-runtime/js/src/shared/runtime-utils.ts b/turbopack/crates/turbopack-ecmascript-runtime/js/src/shared/runtime-utils.ts
@@ -521,3 +521,10 @@ relativeURL.prototype = URL.prototype;
 function invariant(never: never, computeMessage: (arg: any) => string): never {
   throw new Error(`Invariant: ${computeMessage(never)}`);
 }
+
+/**
+ * A stub function to make `require` available but non-functional in ESM.
+ */
+function requireStub(_moduleId: ModuleId): never {
+  throw new Error("dynamic usage of require is not supported");
+}
diff --git a/turbopack/crates/turbopack-ecmascript/src/chunk/item.rs b/turbopack/crates/turbopack-ecmascript/src/chunk/item.rs
@@ -54,6 +54,7 @@ impl EcmascriptChunkItemContent {
                     refresh,
                     externals,
                     async_module,
+                    stub_require: true,
                     ..Default::default()
                 }
             } else {
@@ -67,7 +68,6 @@ impl EcmascriptChunkItemContent {
                     // These things are not available in ESM
                     module: true,
                     exports: true,
-                    require: true,
                     this: true,
                     ..Default::default()
                 }
@@ -115,7 +115,9 @@ impl EcmascriptChunkItemContent {
         if this.options.exports {
             args.push("e: exports");
         }
-        if this.options.require {
+        if this.options.stub_require {
+            args.push("z: require");
+        } else {
             args.push("t: require");
         }
         if this.options.wasm {
@@ -173,9 +175,9 @@ pub struct EcmascriptChunkItemOptions {
     /// Whether this chunk item's module factory should include an `exports`
     /// argument.
     pub exports: bool,
-    /// Whether this chunk item's module factory should include a `require`
-    /// argument.
-    pub require: bool,
+    /// Whether this chunk item's module factory should include an argument for the real `require`,
+    /// or just a throwing stub (for ESM)
+    pub stub_require: bool,
     /// Whether this chunk item's module factory should include a
     /// `__turbopack_external_require__` argument.
     pub externals: bool,