feat(nextjs): Add flag for suppressing router transition warning (#16823)

Author: chargome

packages/nextjs/src/config/types.ts

@@ -462,6 +462,11 @@ export type SentryBuildOptions = {
    */
   errorHandler?: (err: Error) => void;
 
+  /**
+   * Suppress the warning about the `onRouterTransitionStart` hook.
+   */
+  suppressOnRouterTransitionStartWarning?: boolean;
+
   /**
    * Contains a set of experimental flags that might change in future releases. These flags enable
    * features that are still in development and may be modified, renamed, or removed without notice.

packages/nextjs/src/config/withSentryConfig.ts

@@ -236,7 +236,8 @@ function getFinalConfigObject(
   const instrumentationClientFileContents = getInstrumentationClientFileContents();
   if (
     instrumentationClientFileContents !== undefined &&
-    !instrumentationClientFileContents.includes('onRouterTransitionStart')
+    !instrumentationClientFileContents.includes('onRouterTransitionStart') &&
+    !userSentryOptions.suppressOnRouterTransitionStartWarning
   ) {
     // eslint-disable-next-line no-console
     console.warn(