Fix tests

Author: Luca Forstner

packages/nextjs/src/config/webpack.ts

@@ -1,7 +1,7 @@
 /* eslint-disable complexity */
 /* eslint-disable max-lines */
 import { getSentryRelease } from '@sentry/node';
-import { arrayify, dropUndefinedKeys, escapeStringForRegex, logger } from '@sentry/utils';
+import { arrayify, dropUndefinedKeys, escapeStringForRegex, logger, stringMatchesSomePattern } from '@sentry/utils';
 import { default as SentryWebpackPlugin } from '@sentry/webpack-plugin';
 import * as chalk from 'chalk';
 import * as fs from 'fs';
@@ -316,7 +316,7 @@ async function addSentryToEntryProperty(
 
   // inject into all entry points which might contain user's code
   for (const entryPointName in newEntryProperty) {
-    if (shouldAddSentryToEntryPoint(entryPointName, runtime)) {
+    if (shouldAddSentryToEntryPoint(entryPointName, runtime, userSentryOptions.excludeServerRoutes ?? [])) {
       addFilesToExistingEntryPoint(newEntryProperty, entryPointName, filesToInject);
     } else {
       if (
@@ -448,9 +448,20 @@ function checkWebpackPluginOverrides(
  * @param excludeServerRoutes A list of excluded serverside entrypoints provided by the user
  * @returns `true` if sentry code should be injected, and `false` otherwise
  */
-function shouldAddSentryToEntryPoint(entryPointName: string, runtime: 'node' | 'browser' | 'edge'): boolean {
+function shouldAddSentryToEntryPoint(
+  entryPointName: string,
+  runtime: 'node' | 'browser' | 'edge',
+  excludeServerRoutes: Array<string | RegExp>,
+): boolean {
   // On the server side, by default we inject the `Sentry.init()` code into every page (with a few exceptions).
   if (runtime === 'node') {
+    // User-specified pages to skip. (Note: For ease of use, `excludeServerRoutes` is specified in terms of routes,
+    // which don't have the `pages` prefix.)
+    const entryPointRoute = entryPointName.replace(/^pages/, '');
+    if (stringMatchesSomePattern(entryPointRoute, excludeServerRoutes, true)) {
+      return false;
+    }
+
     // This expression will implicitly include `pages/_app` which is called for all serverside routes and pages
     // regardless whether or not the user has a`_app` file.
     return entryPointName.startsWith('pages/');
@@ -460,6 +471,13 @@ function shouldAddSentryToEntryPoint(entryPointName: string, runtime: 'node' | '
       entryPointName === 'main-app' // entrypoint for `/app` pages
     );
   } else {
+    // User-specified pages to skip. (Note: For ease of use, `excludeServerRoutes` is specified in terms of routes,
+    // which don't have the `pages` prefix.)
+    const entryPointRoute = entryPointName.replace(/^pages/, '');
+    if (stringMatchesSomePattern(entryPointRoute, excludeServerRoutes, true)) {
+      return false;
+    }
+
     return true;
   }
 }

packages/nextjs/test/config/testUtils.ts

@@ -1,3 +1,4 @@
+import type { default as SentryWebpackPlugin } from '@sentry/webpack-plugin';
 import type { WebpackPluginInstance } from 'webpack';
 
 import type {
@@ -9,7 +10,6 @@ import type {
   WebpackConfigObject,
   WebpackConfigObjectWithModuleRules,
 } from '../../src/config/types';
-import type { SentryWebpackPlugin } from '../../src/config/webpack';
 import { constructWebpackConfigFunction } from '../../src/config/webpack';
 import { withSentryConfig } from '../../src/config/withSentryConfig';
 import { defaultRuntimePhase, defaultsObject } from './fixtures';

packages/nextjs/test/config/webpack/constructWebpackConfig.test.ts

@@ -1,7 +1,8 @@
 // mock helper functions not tested directly in this file
 import '../mocks';
 
-import { SentryWebpackPlugin } from '../../../src/config/webpack';
+import { default as SentryWebpackPlugin } from '@sentry/webpack-plugin';
+
 import {
   CLIENT_SDK_CONFIG_FILE,
   clientBuildContext,
@@ -138,7 +139,7 @@ describe('constructWebpackConfigFunction()', () => {
       );
     });
 
-    it('injects user config file into `_app` in client bundle but not in server bundle', async () => {
+    it('injects user config file into `_app` in server bundle but not in client bundle', async () => {
       const finalServerWebpackConfig = await materializeFinalWebpackConfig({
         exportedNextConfig,
         incomingWebpackConfig: serverWebpackConfig,
@@ -152,12 +153,12 @@ describe('constructWebpackConfigFunction()', () => {
 
       expect(finalServerWebpackConfig.entry).toEqual(
         expect.objectContaining({
-          'pages/_app': expect.not.arrayContaining([serverConfigFilePath]),
+          'pages/_app': expect.arrayContaining([serverConfigFilePath]),
         }),
       );
       expect(finalClientWebpackConfig.entry).toEqual(
         expect.objectContaining({
-          'pages/_app': expect.arrayContaining([clientConfigFilePath]),
+          'pages/_app': expect.not.arrayContaining([clientConfigFilePath]),
         }),
       );
     });
@@ -232,9 +233,9 @@ describe('constructWebpackConfigFunction()', () => {
       });
 
       expect(finalWebpackConfig.entry).toEqual({
-        main: './src/index.ts',
+        main: ['./sentry.client.config.js', './src/index.ts'],
         // only _app has config file injected
-        'pages/_app': [clientConfigFilePath, 'next-client-pages-loader?page=%2F_app'],
+        'pages/_app': 'next-client-pages-loader?page=%2F_app',
         'pages/_error': 'next-client-pages-loader?page=%2F_error',
         'pages/sniffTour': ['./node_modules/smellOVision/index.js', 'private-next-pages/sniffTour.js'],
         'pages/simulator/leaderboard': {

packages/nextjs/test/config/webpack/sentryWebpackPlugin.test.ts

@@ -1,9 +1,10 @@
+import { default as SentryWebpackPlugin } from '@sentry/webpack-plugin';
 import * as fs from 'fs';
 import * as os from 'os';
 import * as path from 'path';
 
 import type { BuildContext, ExportedNextConfig } from '../../../src/config/types';
-import { getUserConfigFile, getWebpackPluginOptions, SentryWebpackPlugin } from '../../../src/config/webpack';
+import { getUserConfigFile, getWebpackPluginOptions } from '../../../src/config/webpack';
 import {
   clientBuildContext,
   clientWebpackConfig,
@@ -36,7 +37,7 @@ describe('Sentry webpack plugin config', () => {
         authToken: 'dogsarebadatkeepingsecrets', // picked up from env
         stripPrefix: ['webpack://_N_E/'], // default
         urlPrefix: '~/_next', // default
-        entries: expect.any(Function), // default, tested separately elsewhere
+        entries: [],
         release: 'doGsaREgReaT', // picked up from env
         dryRun: false, // based on buildContext.dev being false
       }),
@@ -78,6 +79,7 @@ describe('Sentry webpack plugin config', () => {
 
       expect(sentryWebpackPluginInstance.options.include).toEqual([
         { paths: [`${clientBuildContext.dir}/.next/static/chunks/pages`], urlPrefix: '~/_next/static/chunks/pages' },
+        { paths: [`${clientBuildContext.dir}/.next/static/chunks/app`], urlPrefix: '~/_next/static/chunks/app' },
       ]);
     });
 
@@ -141,6 +143,7 @@ describe('Sentry webpack plugin config', () => {
 
       expect(sentryWebpackPluginInstance.options.include).toEqual([
         { paths: [`${serverBuildContextWebpack4.dir}/.next/server/pages/`], urlPrefix: '~/_next/server/pages' },
+        { paths: [`${serverBuildContextWebpack4.dir}/.next/server/app/`], urlPrefix: '~/_next/server/app' },
       ]);
     });
 
@@ -158,6 +161,7 @@ describe('Sentry webpack plugin config', () => {
 
       expect(sentryWebpackPluginInstance.options.include).toEqual([
         { paths: [`${serverBuildContext.dir}/.next/server/pages/`], urlPrefix: '~/_next/server/pages' },
+        { paths: [`${serverBuildContext.dir}/.next/server/app/`], urlPrefix: '~/_next/server/app' },
         { paths: [`${serverBuildContext.dir}/.next/server/chunks/`], urlPrefix: '~/_next/server/chunks' },
       ]);
     });