fix tests and rename

Author: Luca Forstner

packages/nextjs/src/config/webpackPluginOptions.ts renamed to packages/nextjs/src/config/buildPluginOptions.ts

@@ -23,40 +23,45 @@ export function getBuildPluginOptions(
   const sourcemapUploadIgnore: string[] = [];
   const filesToDeleteAfterUpload: string[] = [];
 
+  // We need to convert paths to posix because Glob patterns use `\` to escape
+  // glob characters. This clashes with Windows path separators.
+  // See: https://www.npmjs.com/package/glob
+  const normalizedDistDirAbsPath = distDirAbsPath.replace(/\\/g, '/');
+
   if (mode === 'after-production-build') {
     sourcemapUploadAssets.push(
-      path.posix.join(distDirAbsPath, '**'), // This is normally where Next.js outputs things
+      path.posix.join(normalizedDistDirAbsPath, '**'), // This is normally where Next.js outputs things
     );
     if (sentryBuildOptions.sourcemaps?.deleteSourcemapsAfterUpload) {
       filesToDeleteAfterUpload.push(
-        path.posix.join(distDirAbsPath, '**', '*.js.map'),
-        path.posix.join(distDirAbsPath, '**', '*.mjs.map'),
-        path.posix.join(distDirAbsPath, '**', '*.cjs.map'),
+        path.posix.join(normalizedDistDirAbsPath, '**', '*.js.map'),
+        path.posix.join(normalizedDistDirAbsPath, '**', '*.mjs.map'),
+        path.posix.join(normalizedDistDirAbsPath, '**', '*.cjs.map'),
       );
     }
   } else {
     if (mode === 'webpack-nodejs' || mode === 'webpack-edge') {
       sourcemapUploadAssets.push(
-        path.posix.join(distDirAbsPath, 'server', '**'), // This is normally where Next.js outputs things
-        path.posix.join(distDirAbsPath, 'serverless', '**'), // This was the output location for serverless Next.js
+        path.posix.join(normalizedDistDirAbsPath, 'server', '**'), // This is normally where Next.js outputs things
+        path.posix.join(normalizedDistDirAbsPath, 'serverless', '**'), // This was the output location for serverless Next.js
       );
     } else {
       if (sentryBuildOptions.widenClientFileUpload) {
-        sourcemapUploadAssets.push(path.posix.join(distDirAbsPath, 'static', 'chunks', '**'));
+        sourcemapUploadAssets.push(path.posix.join(normalizedDistDirAbsPath, 'static', 'chunks', '**'));
       } else {
         sourcemapUploadAssets.push(
-          path.posix.join(distDirAbsPath, 'static', 'chunks', 'pages', '**'),
-          path.posix.join(distDirAbsPath, 'static', 'chunks', 'app', '**'),
+          path.posix.join(normalizedDistDirAbsPath, 'static', 'chunks', 'pages', '**'),
+          path.posix.join(normalizedDistDirAbsPath, 'static', 'chunks', 'app', '**'),
         );
       }
 
       // TODO: We should think about uploading these when `widenClientFileUpload` is `true`. They may be useful in some situations.
       sourcemapUploadIgnore.push(
-        path.posix.join(distDirAbsPath, 'static', 'chunks', 'framework-*'),
-        path.posix.join(distDirAbsPath, 'static', 'chunks', 'framework.*'),
-        path.posix.join(distDirAbsPath, 'static', 'chunks', 'main-*'),
-        path.posix.join(distDirAbsPath, 'static', 'chunks', 'polyfills-*'),
-        path.posix.join(distDirAbsPath, 'static', 'chunks', 'webpack-*'),
+        path.posix.join(normalizedDistDirAbsPath, 'static', 'chunks', 'framework-*'),
+        path.posix.join(normalizedDistDirAbsPath, 'static', 'chunks', 'framework.*'),
+        path.posix.join(normalizedDistDirAbsPath, 'static', 'chunks', 'main-*'),
+        path.posix.join(normalizedDistDirAbsPath, 'static', 'chunks', 'polyfills-*'),
+        path.posix.join(normalizedDistDirAbsPath, 'static', 'chunks', 'webpack-*'),
       );
     }
 
@@ -65,9 +70,9 @@ export function getBuildPluginOptions(
         // We only care to delete client bundle source maps because they would be the ones being served.
         // Removing the server source maps crashes Vercel builds for (thus far) unknown reasons:
         // https://github.com/getsentry/sentry-javascript/issues/13099
-        path.posix.join(distDirAbsPath, 'static', '**', '*.js.map'),
-        path.posix.join(distDirAbsPath, 'static', '**', '*.mjs.map'),
-        path.posix.join(distDirAbsPath, 'static', '**', '*.cjs.map'),
+        path.posix.join(normalizedDistDirAbsPath, 'static', '**', '*.js.map'),
+        path.posix.join(normalizedDistDirAbsPath, 'static', '**', '*.mjs.map'),
+        path.posix.join(normalizedDistDirAbsPath, 'static', '**', '*.cjs.map'),
       );
     }
   }

packages/nextjs/src/config/runAfterProductionCompile.ts

@@ -1,6 +1,6 @@
 import type { SentryBuildOptions } from './types';
 import { getWebpackBuildFunctionCalled } from './util';
-import { getBuildPluginOptions } from './webpackPluginOptions';
+import { getBuildPluginOptions } from './buildPluginOptions';
 import { glob } from 'glob';
 import { loadModule } from '@sentry/core';
 import type { createSentryBuildPluginManager as createSentryBuildPluginManagerType } from '@sentry/bundler-plugin-core';

packages/nextjs/src/config/webpack.ts

@@ -21,7 +21,7 @@ import type {
   WebpackConfigObjectWithModuleRules,
   WebpackEntryProperty,
 } from './types';
-import { getBuildPluginOptions } from './webpackPluginOptions';
+import { getBuildPluginOptions } from './buildPluginOptions';
 import { getNextjsVersion, setWebpackBuildFunctionCalled } from './util';
 
 // Next.js runs webpack 3 times, once for the client, the server, and for edge. Because we don't want to print certain

packages/nextjs/test/config/webpack/webpackPluginOptions.test.ts renamed to packages/nextjs/test/config/webpack/buildPluginOptions.test.ts

@@ -1,33 +1,10 @@
 import { describe, it, expect } from 'vitest';
 
-import type { BuildContext, NextConfigObject } from '../../../src/config/types';
-import { getWebpackPluginOptions } from '../../../src/config/webpackPluginOptions';
+import { getBuildPluginOptions } from '../../../src/config/buildPluginOptions';
 
-function generateBuildContext(overrides: {
-  dir?: string;
-  isServer: boolean;
-  nextjsConfig?: NextConfigObject;
-}): BuildContext {
-  return {
-    dev: false, // The plugin is not included in dev mode
-    isServer: overrides.isServer,
-    buildId: 'test-build-id',
-    dir: overrides.dir ?? '/my/project/dir',
-    config: overrides.nextjsConfig ?? {},
-    totalPages: 2,
-    defaultLoaders: true,
-    webpack: {
-      version: '4.0.0',
-      DefinePlugin: {} as any,
-    },
-  };
-}
-
-describe('getWebpackPluginOptions()', () => {
+describe('getBuildPluginOptions()', () => {
   it('forwards relevant options', () => {
-    const buildContext = generateBuildContext({ isServer: false });
-    const generatedPluginOptions = getWebpackPluginOptions(
-      buildContext,
+    const generatedPluginOptions = getBuildPluginOptions(
       {
         authToken: 'my-auth-token',
         headers: { 'my-test-header': 'test' },
@@ -60,6 +37,8 @@ describe('getWebpackPluginOptions()', () => {
         },
       },
       'my-release',
+      'webpack-client',
+      '/my/project/dir/.next',
     );
 
     expect(generatedPluginOptions.authToken).toBe('my-auth-token');
@@ -119,16 +98,16 @@ describe('getWebpackPluginOptions()', () => {
   });
 
   it('forwards bundleSizeOptimization options', () => {
-    const buildContext = generateBuildContext({ isServer: false });
-    const generatedPluginOptions = getWebpackPluginOptions(
-      buildContext,
+    const generatedPluginOptions = getBuildPluginOptions(
       {
         bundleSizeOptimizations: {
           excludeTracing: true,
           excludeReplayShadowDom: false,
         },
       },
       undefined,
+      'webpack-client',
+      '/my/project/dir/.next',
     );
 
     expect(generatedPluginOptions).toMatchObject({
@@ -140,17 +119,15 @@ describe('getWebpackPluginOptions()', () => {
   });
 
   it('returns the right `assets` and `ignore` values during the server build', () => {
-    const buildContext = generateBuildContext({ isServer: true });
-    const generatedPluginOptions = getWebpackPluginOptions(buildContext, {}, undefined);
+    const generatedPluginOptions = getBuildPluginOptions({}, undefined, 'webpack-nodejs', '/my/project/dir/.next');
     expect(generatedPluginOptions.sourcemaps).toMatchObject({
       assets: ['/my/project/dir/.next/server/**', '/my/project/dir/.next/serverless/**'],
       ignore: [],
     });
   });
 
   it('returns the right `assets` and `ignore` values during the client build', () => {
-    const buildContext = generateBuildContext({ isServer: false });
-    const generatedPluginOptions = getWebpackPluginOptions(buildContext, {}, undefined);
+    const generatedPluginOptions = getBuildPluginOptions({}, undefined, 'webpack-client', '/my/project/dir/.next');
     expect(generatedPluginOptions.sourcemaps).toMatchObject({
       assets: ['/my/project/dir/.next/static/chunks/pages/**', '/my/project/dir/.next/static/chunks/app/**'],
       ignore: [
@@ -164,8 +141,12 @@ describe('getWebpackPluginOptions()', () => {
   });
 
   it('returns the right `assets` and `ignore` values during the client build with `widenClientFileUpload`', () => {
-    const buildContext = generateBuildContext({ isServer: false });
-    const generatedPluginOptions = getWebpackPluginOptions(buildContext, { widenClientFileUpload: true }, undefined);
+    const generatedPluginOptions = getBuildPluginOptions(
+      { widenClientFileUpload: true },
+      undefined,
+      'webpack-client',
+      '/my/project/dir/.next',
+    );
     expect(generatedPluginOptions.sourcemaps).toMatchObject({
       assets: ['/my/project/dir/.next/static/chunks/**'],
       ignore: [
@@ -179,20 +160,24 @@ describe('getWebpackPluginOptions()', () => {
   });
 
   it('sets `sourcemaps.disable` plugin options to true when `sourcemaps.disable` is true', () => {
-    const buildContext = generateBuildContext({ isServer: false });
-    const generatedPluginOptions = getWebpackPluginOptions(buildContext, { sourcemaps: { disable: true } }, undefined);
+    const generatedPluginOptions = getBuildPluginOptions(
+      { sourcemaps: { disable: true } },
+      undefined,
+      'webpack-client',
+      '/my/project/dir/.next',
+    );
     expect(generatedPluginOptions.sourcemaps).toMatchObject({
       disable: true,
     });
   });
 
   it('passes posix paths to the plugin', () => {
-    const buildContext = generateBuildContext({
-      dir: 'C:\\my\\windows\\project\\dir',
-      nextjsConfig: { distDir: '.dist\\v1' },
-      isServer: false,
-    });
-    const generatedPluginOptions = getWebpackPluginOptions(buildContext, { widenClientFileUpload: true }, undefined);
+    const generatedPluginOptions = getBuildPluginOptions(
+      { widenClientFileUpload: true },
+      undefined,
+      'webpack-client',
+      'C:\\my\\windows\\project\\dir\\.dist\\v1',
+    );
     expect(generatedPluginOptions.sourcemaps).toMatchObject({
       assets: ['C:/my/windows/project/dir/.dist/v1/static/chunks/**'],
       ignore: [
@@ -206,8 +191,7 @@ describe('getWebpackPluginOptions()', () => {
   });
 
   it('sets options to not create a release or do any release operations when releaseName is undefined', () => {
-    const buildContext = generateBuildContext({ isServer: false });
-    const generatedPluginOptions = getWebpackPluginOptions(buildContext, {}, undefined);
+    const generatedPluginOptions = getBuildPluginOptions({}, undefined, 'webpack-client', '/my/project/dir/.next');
 
     expect(generatedPluginOptions).toMatchObject({
       release: {

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

@@ -3,7 +3,7 @@ import { describe, expect, it, vi } from 'vitest';
 // mock helper functions not tested directly in this file
 import '../mocks';
 
-import * as getWebpackPluginOptionsModule from '../../../src/config/webpackPluginOptions';
+import * as getBuildPluginOptionsModule from '../../../src/config/buildPluginOptions';
 import {
   CLIENT_SDK_CONFIG_FILE,
   clientBuildContext,
@@ -55,7 +55,7 @@ describe('constructWebpackConfigFunction()', () => {
   });
 
   it('automatically enables deleteSourcemapsAfterUpload for client builds when not explicitly set', async () => {
-    const getWebpackPluginOptionsSpy = vi.spyOn(getWebpackPluginOptionsModule, 'getWebpackPluginOptions');
+    const getBuildPluginOptionsSpy = vi.spyOn(getBuildPluginOptionsModule, 'getBuildPluginOptions');
     vi.spyOn(core, 'loadModule').mockImplementation(() => ({
       sentryWebpackPlugin: () => ({
         _name: 'sentry-webpack-plugin',
@@ -71,19 +71,18 @@ describe('constructWebpackConfigFunction()', () => {
       },
     });
 
-    expect(getWebpackPluginOptionsSpy).toHaveBeenCalledWith(
-      expect.objectContaining({
-        isServer: false,
-      }),
+    expect(getBuildPluginOptionsSpy).toHaveBeenCalledWith(
       expect.objectContaining({
         sourcemaps: {
           deleteSourcemapsAfterUpload: true,
         },
       }),
       undefined,
+      expect.any(String),
+      expect.any(String),
     );
 
-    getWebpackPluginOptionsSpy.mockRestore();
+    getBuildPluginOptionsSpy.mockRestore();
   });
 
   it('preserves unrelated webpack config options', async () => {