fix(nextjs): Use webpack module paths to attempt to resolve internal …

…request async storage module (#9100)
getsentry · Sep 25, 2023 · 622186c · 622186c
1 parent 705be9b
commit 622186c
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 27 deletions.
diff --git a/packages/nextjs/src/config/loaders/wrappingLoader.ts b/packages/nextjs/src/config/loaders/wrappingLoader.ts
@@ -15,9 +15,6 @@ const SENTRY_WRAPPER_MODULE_NAME = 'sentry-wrapper-module';
 // Needs to end in .cjs in order for the `commonjs` plugin to pick it up
 const WRAPPING_TARGET_MODULE_NAME = '__SENTRY_WRAPPING_TARGET_FILE__.cjs';
 
-// This module is non-public API and may break
-const nextjsRequestAsyncStorageModulePath = getRequestAsyncLocalStorageModule();
-
 const apiWrapperTemplatePath = path.resolve(__dirname, '..', 'templates', 'apiWrapperTemplate.js');
 const apiWrapperTemplateCode = fs.readFileSync(apiWrapperTemplatePath, { encoding: 'utf8' });
 
@@ -51,32 +48,9 @@ type LoaderOptions = {
   wrappingTargetKind: 'page' | 'api-route' | 'middleware' | 'server-component' | 'sentry-init' | 'route-handler';
   sentryConfigFilePath?: string;
   vercelCronsConfig?: VercelCronsConfig;
+  nextjsRequestAsyncStorageModulePath?: string;
 };
 
-function getRequestAsyncLocalStorageModule(): string | undefined {
-  try {
-    // Original location of that module
-    // https://github.com/vercel/next.js/blob/46151dd68b417e7850146d00354f89930d10b43b/packages/next/src/client/components/request-async-storage.ts
-    const location = 'next/dist/client/components/request-async-storage';
-    require.resolve(location);
-    return location;
-  } catch {
-    // noop
-  }
-
-  try {
-    // Introduced in Next.js 13.4.20
-    // https://github.com/vercel/next.js/blob/e1bc270830f2fc2df3542d4ef4c61b916c802df3/packages/next/src/client/components/request-async-storage.external.ts
-    const location = 'next/dist/client/components/request-async-storage.external';
-    require.resolve(location);
-    return location;
-  } catch {
-    // noop
-  }
-
-  return undefined;
-}
-
 /**
  * Replace the loaded file with a wrapped version the original file. In the wrapped version, the original file is loaded,
  * any data-fetching functions (`getInitialProps`, `getStaticProps`, and `getServerSideProps`) or API routes it contains
@@ -98,6 +72,7 @@ export default function wrappingLoader(
     wrappingTargetKind,
     sentryConfigFilePath,
     vercelCronsConfig,
+    nextjsRequestAsyncStorageModulePath,
   } = 'getOptions' in this ? this.getOptions() : this.query;
 
   this.async();

diff --git a/packages/nextjs/src/config/types.ts b/packages/nextjs/src/config/types.ts
@@ -163,6 +163,7 @@ export type WebpackConfigObject = {
   target: string;
   context: string;
   resolve?: {
+    modules?: string[];
     alias?: { [key: string]: string | boolean };
   };
   module?: {

diff --git a/packages/nextjs/src/config/webpack.ts b/packages/nextjs/src/config/webpack.ts
@@ -126,6 +126,7 @@ export function constructWebpackConfigFunction(
       pageExtensionRegex,
       excludeServerRoutes: userSentryOptions.excludeServerRoutes,
       sentryConfigFilePath: getUserConfigFilePath(projectDir, runtime),
+      nextjsRequestAsyncStorageModulePath: getRequestAsyncLocalStorageModuleLocation(rawNewConfig.resolve?.modules),
     };
 
     const normalizeLoaderResourcePath = (resourcePath: string): string => {
@@ -975,3 +976,31 @@ function addValueInjectionLoader(
     },
   );
 }
+
+function getRequestAsyncLocalStorageModuleLocation(modules: string[] | undefined): string | undefined {
+  if (modules === undefined) {
+    return undefined;
+  }
+
+  try {
+    // Original location of that module
+    // https://github.com/vercel/next.js/blob/46151dd68b417e7850146d00354f89930d10b43b/packages/next/src/client/components/request-async-storage.ts
+    const location = 'next/dist/client/components/request-async-storage';
+    require.resolve(location, { paths: modules });
+    return location;
+  } catch {
+    // noop
+  }
+
+  try {
+    // Introduced in Next.js 13.4.20
+    // https://github.com/vercel/next.js/blob/e1bc270830f2fc2df3542d4ef4c61b916c802df3/packages/next/src/client/components/request-async-storage.external.ts
+    const location = 'next/dist/client/components/request-async-storage.external';
+    require.resolve(location, { paths: modules });
+    return location;
+  } catch {
+    // noop
+  }
+
+  return undefined;
+}