correctly type sentry webpack plugin

Author: lobsterkatie

packages/nextjs/src/config/types.ts

@@ -1,7 +1,8 @@
 import { SentryCliPluginOptions } from '@sentry/webpack-plugin';
+import { WebpackPluginInstance } from 'webpack';
 
 export type SentryWebpackPluginOptions = SentryCliPluginOptions;
-export type SentryWebpackPlugin = { options: SentryWebpackPluginOptions };
+export type SentryWebpackPlugin = WebpackPluginInstance & { options: SentryWebpackPluginOptions };
 
 /**
  * Overall Nextjs config
@@ -37,7 +38,7 @@ export type WebpackConfigFunction = (config: WebpackConfigObject, options: Build
 
 export type WebpackConfigObject = {
   devtool?: string;
-  plugins?: Array<{ [key: string]: unknown }>;
+  plugins?: Array<WebpackPluginInstance | SentryWebpackPlugin>;
   entry: WebpackEntryProperty;
   output: { filename: string; path: string };
   target: string;

packages/nextjs/src/config/webpack.ts

@@ -1,6 +1,6 @@
 import { getSentryRelease } from '@sentry/node';
 import { dropUndefinedKeys, logger } from '@sentry/utils';
-import * as SentryWebpackPlugin from '@sentry/webpack-plugin';
+import { default as SentryWebpackPlugin } from '@sentry/webpack-plugin';
 import * as fs from 'fs';
 import * as path from 'path';
 
@@ -96,8 +96,6 @@ export function constructWebpackConfigFunction(
 
       newConfig.plugins = newConfig.plugins || [];
       newConfig.plugins.push(
-        // @ts-ignore Our types for the plugin are messed up somehow - TS wants this to be `SentryWebpackPlugin.default`,
-        // but that's not actually a thing
         new SentryWebpackPlugin(getWebpackPluginOptions(buildContext, userSentryWebpackPluginOptions)),
       );
     }

packages/nextjs/test/config.test.ts

@@ -336,7 +336,7 @@ describe('Sentry webpack plugin config', () => {
       incomingWebpackBuildContext: serverBuildContext,
     });
 
-    expect(finalWebpackConfig.plugins?.[0].options).toEqual(
+    expect((finalWebpackConfig.plugins?.[0] as SentryWebpackPlugin).options).toEqual(
       expect.objectContaining({
         include: expect.any(Array), // default, tested separately elsewhere
         ignore: [], // default
@@ -360,7 +360,7 @@ describe('Sentry webpack plugin config', () => {
       incomingWebpackBuildContext: serverBuildContext,
     });
 
-    expect((finalWebpackConfig.plugins?.[0].options as SentryWebpackPluginOptions).debug).toEqual(true);
+    expect((finalWebpackConfig.plugins?.[0] as SentryWebpackPlugin).options.debug).toEqual(true);
   });
 
   it('warns when overriding certain default values', () => {