fix(nextjs): Support automatic instrumentation for app directory with…

… custom page extensions (#12858) Co-authored-by: Luca Forstner <luca.forstner@sentry.io>
getsentry · Jul 11, 2024 · 1be3b4a · 1be3b4a
1 parent 0e6d802
commit 1be3b4a
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 11 deletions.
diff --git a/packages/nextjs/src/config/loaders/wrappingLoader.ts b/packages/nextjs/src/config/loaders/wrappingLoader.ts
@@ -182,7 +182,8 @@ export default function wrappingLoader(
 
     const componentTypeMatch = path.posix
       .normalize(path.relative(appDir, this.resourcePath))
-      .match(/\/?([^/]+)\.(?:js|ts|jsx|tsx)$/);
+      // eslint-disable-next-line @sentry-internal/sdk/no-regexp-constructor
+      .match(new RegExp(`/\\/?([^/]+)\\.(?:${pageExtensionRegex})$`));
 
     if (componentTypeMatch && componentTypeMatch[1]) {
       let componentType: ServerComponentContext['componentType'];

diff --git a/packages/nextjs/src/config/webpack.ts b/packages/nextjs/src/config/webpack.ts
@@ -147,7 +147,7 @@ export function constructWebpackConfigFunction(
       );
     };
 
-    const possibleMiddlewareLocations = ['js', 'jsx', 'ts', 'tsx'].map(middlewareFileEnding => {
+    const possibleMiddlewareLocations = pageExtensions.map(middlewareFileEnding => {
       return path.join(middlewareLocationFolder, `middleware.${middlewareFileEnding}`);
     });
     const isMiddlewareResource = (resourcePath: string): boolean => {
@@ -163,7 +163,10 @@ export function constructWebpackConfigFunction(
       return (
         appDirPath !== undefined &&
         normalizedAbsoluteResourcePath.startsWith(appDirPath + path.sep) &&
-        !!normalizedAbsoluteResourcePath.match(/[\\/](page|layout|loading|head|not-found)\.(js|jsx|tsx)$/)
+        !!normalizedAbsoluteResourcePath.match(
+          // eslint-disable-next-line @sentry-internal/sdk/no-regexp-constructor
+          new RegExp(`[\\\\/](page|layout|loading|head|not-found)\\.(${pageExtensionRegex})$`),
+        )
       );
     };
 
@@ -172,7 +175,10 @@ export function constructWebpackConfigFunction(
       return (
         appDirPath !== undefined &&
         normalizedAbsoluteResourcePath.startsWith(appDirPath + path.sep) &&
-        !!normalizedAbsoluteResourcePath.match(/[\\/]route\.(js|jsx|ts|tsx)$/)
+        !!normalizedAbsoluteResourcePath.match(
+          // eslint-disable-next-line @sentry-internal/sdk/no-regexp-constructor
+          new RegExp(`[\\\\/]route\\.(${pageExtensionRegex})$`),
+        )
       );
     };
 
@@ -285,10 +291,12 @@ export function constructWebpackConfigFunction(
     }
 
     if (appDirPath) {
-      const hasGlobalErrorFile = ['global-error.js', 'global-error.jsx', 'global-error.ts', 'global-error.tsx'].some(
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        globalErrorFile => fs.existsSync(path.join(appDirPath!, globalErrorFile)),
-      );
+      const hasGlobalErrorFile = pageExtensions
+        .map(extension => `global-error.${extension}`)
+        .some(
+          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+          globalErrorFile => fs.existsSync(path.join(appDirPath!, globalErrorFile)),
+        );
 
       if (
         !hasGlobalErrorFile &&

diff --git a/packages/nextjs/test/config/fixtures.ts b/packages/nextjs/test/config/fixtures.ts
@@ -13,6 +13,7 @@ export const EDGE_SDK_CONFIG_FILE = 'sentry.edge.config.js';
 /** Mock next config object */
 export const userNextConfig: NextConfigObject = {
   publicRuntimeConfig: { location: 'dogpark', activities: ['fetch', 'chasing', 'digging'] },
+  pageExtensions: ['jsx', 'js', 'tsx', 'ts', 'custom.jsx', 'custom.js', 'custom.tsx', 'custom.ts'],
   webpack: (incomingWebpackConfig: WebpackConfigObject, _options: BuildContext) => ({
     ...incomingWebpackConfig,
     mode: 'universal-sniffing',

diff --git a/packages/nextjs/test/config/loaders.test.ts b/packages/nextjs/test/config/loaders.test.ts
@@ -96,6 +96,10 @@ describe('webpack loaders', () => {
         resourcePath: '/Users/Maisey/projects/squirrelChasingSimulator/src/pages/testPage.tsx',
         expectedWrappingTargetKind: 'page',
       },
+      {
+        resourcePath: '/Users/Maisey/projects/squirrelChasingSimulator/src/pages/testPage.custom.tsx',
+        expectedWrappingTargetKind: 'page',
+      },
       {
         resourcePath: './src/pages/testPage.tsx',
         expectedWrappingTargetKind: 'page',
@@ -133,6 +137,10 @@ describe('webpack loaders', () => {
         resourcePath: '/Users/Maisey/projects/squirrelChasingSimulator/src/middleware.js',
         expectedWrappingTargetKind: 'middleware',
       },
+      {
+        resourcePath: '/Users/Maisey/projects/squirrelChasingSimulator/src/middleware.custom.js',
+        expectedWrappingTargetKind: 'middleware',
+      },
       {
         resourcePath: './src/middleware.js',
         expectedWrappingTargetKind: 'middleware',
@@ -162,25 +170,41 @@ describe('webpack loaders', () => {
         resourcePath: '/Users/Maisey/projects/squirrelChasingSimulator/src/pages/api/nested/testApiRoute.js',
         expectedWrappingTargetKind: 'api-route',
       },
+      {
+        resourcePath: '/Users/Maisey/projects/squirrelChasingSimulator/src/pages/api/nested/testApiRoute.custom.js',
+        expectedWrappingTargetKind: 'api-route',
+      },
+      {
+        resourcePath: '/Users/Maisey/projects/squirrelChasingSimulator/src/app/nested/route.ts',
+        expectedWrappingTargetKind: 'route-handler',
+      },
+      {
+        resourcePath: '/Users/Maisey/projects/squirrelChasingSimulator/src/app/nested/route.custom.ts',
+        expectedWrappingTargetKind: 'route-handler',
+      },
       {
         resourcePath: '/Users/Maisey/projects/squirrelChasingSimulator/src/app/page.js',
         expectedWrappingTargetKind: 'server-component',
       },
+      {
+        resourcePath: '/Users/Maisey/projects/squirrelChasingSimulator/src/app/page.custom.js',
+        expectedWrappingTargetKind: 'server-component',
+      },
       {
         resourcePath: '/Users/Maisey/projects/squirrelChasingSimulator/src/app/nested/page.js',
         expectedWrappingTargetKind: 'server-component',
       },
       {
-        resourcePath: '/Users/Maisey/projects/squirrelChasingSimulator/src/app/nested/page.ts', // ts is not a valid file ending for pages in the app dir
-        expectedWrappingTargetKind: undefined,
+        resourcePath: '/Users/Maisey/projects/squirrelChasingSimulator/src/app/nested/page.ts',
+        expectedWrappingTargetKind: 'server-component',
       },
       {
         resourcePath: '/Users/Maisey/projects/squirrelChasingSimulator/src/app/(group)/nested/page.tsx',
         expectedWrappingTargetKind: 'server-component',
       },
       {
         resourcePath: '/Users/Maisey/projects/squirrelChasingSimulator/src/app/(group)/nested/loading.ts',
-        expectedWrappingTargetKind: undefined,
+        expectedWrappingTargetKind: 'server-component',
       },
       {
         resourcePath: '/Users/Maisey/projects/squirrelChasingSimulator/src/app/layout.js',