use helper function for finding correct plugin to test

Author: lobsterkatie

packages/nextjs/test/config.test.ts

@@ -2,6 +2,7 @@ import * as fs from 'fs';
 import * as os from 'os';
 import * as path from 'path';
 import * as rimraf from 'rimraf';
+import { WebpackPluginInstance } from 'webpack';
 
 import { withSentryConfig } from '../src/config';
 import {
@@ -176,6 +177,14 @@ async function materializeFinalWebpackConfig(options: {
   return finalWebpackConfigValue;
 }
 
+// helper function to make sure we're checking the correct plugin's data
+export function findWebpackPlugin(
+  webpackConfig: WebpackConfigObject,
+  pluginName: string,
+): WebpackPluginInstance | SentryWebpackPlugin | undefined {
+  return webpackConfig.plugins?.find(plugin => plugin.constructor.name === pluginName);
+}
+
 describe('withSentryConfig', () => {
   it('includes expected properties', () => {
     const finalConfig = materializeFinalNextConfig(userNextConfig);
@@ -334,8 +343,9 @@ describe('Sentry webpack plugin config', () => {
       incomingWebpackConfig: serverWebpackConfig,
       incomingWebpackBuildContext: serverBuildContext,
     });
+    const sentryWebpackPluginInstance = findWebpackPlugin(finalWebpackConfig, 'SentryCliPlugin') as SentryWebpackPlugin;
 
-    expect((finalWebpackConfig.plugins?.[0] as SentryWebpackPlugin).options).toEqual(
+    expect(sentryWebpackPluginInstance.options).toEqual(
       expect.objectContaining({
         include: expect.any(Array), // default, tested separately elsewhere
         ignore: [], // default
@@ -358,8 +368,9 @@ describe('Sentry webpack plugin config', () => {
       incomingWebpackConfig: serverWebpackConfig,
       incomingWebpackBuildContext: serverBuildContext,
     });
+    const sentryWebpackPluginInstance = findWebpackPlugin(finalWebpackConfig, 'SentryCliPlugin') as SentryWebpackPlugin;
 
-    expect((finalWebpackConfig.plugins?.[0] as SentryWebpackPlugin).options.debug).toEqual(true);
+    expect(sentryWebpackPluginInstance.options.debug).toEqual(true);
   });
 
   it('warns when overriding certain default values', () => {
@@ -378,9 +389,12 @@ describe('Sentry webpack plugin config', () => {
         incomingWebpackBuildContext: clientBuildContext,
       });
 
-      const sentryWebpackPlugin = finalWebpackConfig.plugins?.[0] as SentryWebpackPluginType;
+      const sentryWebpackPluginInstance = findWebpackPlugin(
+        finalWebpackConfig,
+        'SentryCliPlugin',
+      ) as SentryWebpackPlugin;
 
-      expect(sentryWebpackPlugin.options?.include).toEqual([
+      expect(sentryWebpackPluginInstance.options.include).toEqual([
         { paths: ['.next/static/chunks/pages'], urlPrefix: '~/_next/static/chunks/pages' },
       ]);
     });
@@ -395,9 +409,12 @@ describe('Sentry webpack plugin config', () => {
         incomingWebpackBuildContext: getBuildContext('server', userNextConfigServerless),
       });
 
-      const sentryWebpackPlugin = finalWebpackConfig.plugins?.[0] as SentryWebpackPluginType;
+      const sentryWebpackPluginInstance = findWebpackPlugin(
+        finalWebpackConfig,
+        'SentryCliPlugin',
+      ) as SentryWebpackPlugin;
 
-      expect(sentryWebpackPlugin.options?.include).toEqual([
+      expect(sentryWebpackPluginInstance.options.include).toEqual([
         { paths: ['.next/serverless/'], urlPrefix: '~/_next/serverless' },
       ]);
     });
@@ -412,9 +429,12 @@ describe('Sentry webpack plugin config', () => {
         incomingWebpackBuildContext: serverBuildContextWebpack4,
       });
 
-      const sentryWebpackPlugin = finalWebpackConfig.plugins?.[0] as SentryWebpackPluginType;
+      const sentryWebpackPluginInstance = findWebpackPlugin(
+        finalWebpackConfig,
+        'SentryCliPlugin',
+      ) as SentryWebpackPlugin;
 
-      expect(sentryWebpackPlugin.options?.include).toEqual([
+      expect(sentryWebpackPluginInstance.options.include).toEqual([
         { paths: ['.next/server/pages/'], urlPrefix: '~/_next/server/pages' },
       ]);
     });
@@ -426,9 +446,12 @@ describe('Sentry webpack plugin config', () => {
         incomingWebpackBuildContext: serverBuildContext,
       });
 
-      const sentryWebpackPlugin = finalWebpackConfig.plugins?.[0] as SentryWebpackPluginType;
+      const sentryWebpackPluginInstance = findWebpackPlugin(
+        finalWebpackConfig,
+        'SentryCliPlugin',
+      ) as SentryWebpackPlugin;
 
-      expect(sentryWebpackPlugin.options?.include).toEqual([
+      expect(sentryWebpackPluginInstance.options.include).toEqual([
         { paths: ['.next/server/pages/'], urlPrefix: '~/_next/server/pages' },
         { paths: ['.next/server/chunks/'], urlPrefix: '~/_next/server/chunks' },
       ]);
@@ -448,9 +471,12 @@ describe('Sentry webpack plugin config', () => {
         incomingWebpackBuildContext: getBuildContext('client', userNextConfigWithBasePath),
       });
 
-      const sentryWebpackPlugin = finalWebpackConfig.plugins?.[0] as SentryWebpackPluginType;
+      const sentryWebpackPluginInstance = findWebpackPlugin(
+        finalWebpackConfig,
+        'SentryCliPlugin',
+      ) as SentryWebpackPlugin;
 
-      expect(sentryWebpackPlugin.options?.include).toEqual([
+      expect(sentryWebpackPluginInstance.options.include).toEqual([
         { paths: ['.next/static/chunks/pages'], urlPrefix: '~/city-park/_next/static/chunks/pages' },
       ]);
     });
@@ -465,9 +491,12 @@ describe('Sentry webpack plugin config', () => {
         incomingWebpackBuildContext: getBuildContext('server', userNextConfigServerless),
       });
 
-      const sentryWebpackPlugin = finalWebpackConfig.plugins?.[0] as SentryWebpackPluginType;
+      const sentryWebpackPluginInstance = findWebpackPlugin(
+        finalWebpackConfig,
+        'SentryCliPlugin',
+      ) as SentryWebpackPlugin;
 
-      expect(sentryWebpackPlugin.options?.include).toEqual([
+      expect(sentryWebpackPluginInstance.options.include).toEqual([
         { paths: ['.next/serverless/'], urlPrefix: '~/city-park/_next/serverless' },
       ]);
     });
@@ -482,9 +511,12 @@ describe('Sentry webpack plugin config', () => {
         incomingWebpackBuildContext: serverBuildContextWebpack4,
       });
 
-      const sentryWebpackPlugin = finalWebpackConfig.plugins?.[0] as SentryWebpackPluginType;
+      const sentryWebpackPluginInstance = findWebpackPlugin(
+        finalWebpackConfig,
+        'SentryCliPlugin',
+      ) as SentryWebpackPlugin;
 
-      expect(sentryWebpackPlugin.options?.include).toEqual([
+      expect(sentryWebpackPluginInstance.options.include).toEqual([
         { paths: ['.next/server/pages/'], urlPrefix: '~/city-park/_next/server/pages' },
       ]);
     });
@@ -496,9 +528,12 @@ describe('Sentry webpack plugin config', () => {
         incomingWebpackBuildContext: getBuildContext('server', userNextConfigWithBasePath),
       });
 
-      const sentryWebpackPlugin = finalWebpackConfig.plugins?.[0] as SentryWebpackPluginType;
+      const sentryWebpackPluginInstance = findWebpackPlugin(
+        finalWebpackConfig,
+        'SentryCliPlugin',
+      ) as SentryWebpackPlugin;
 
-      expect(sentryWebpackPlugin.options?.include).toEqual([
+      expect(sentryWebpackPluginInstance.options.include).toEqual([
         { paths: ['.next/server/pages/'], urlPrefix: '~/city-park/_next/server/pages' },
         { paths: ['.next/server/chunks/'], urlPrefix: '~/city-park/_next/server/chunks' },
       ]);