ref(nextjs): Use debug instead of logger

Author: AbhiPrasad

packages/nextjs/src/client/routing/pagesRouterRoutingInstrumentation.ts

@@ -1,7 +1,7 @@
 import type { Client, TransactionSource } from '@sentry/core';
 import {
   browserPerformanceTimeOrigin,
-  logger,
+  debug,
   parseBaggageHeader,
   SEMANTIC_ATTRIBUTE_SENTRY_OP,
   SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
@@ -70,7 +70,7 @@ function extractNextDataTagInformation(): NextDataTagInfo {
     try {
       nextData = JSON.parse(nextDataTag.innerHTML);
     } catch {
-      DEBUG_BUILD && logger.warn('Could not extract __NEXT_DATA__');
+      DEBUG_BUILD && debug.warn('Could not extract __NEXT_DATA__');
     }
   }
 

packages/nextjs/src/client/routing/parameterization.ts

@@ -1,4 +1,4 @@
-import { GLOBAL_OBJ, logger } from '@sentry/core';
+import { GLOBAL_OBJ, debug } from '@sentry/core';
 import { DEBUG_BUILD } from '../../common/debug-build';
 import type { RouteManifest } from '../../config/manifest/types';
 
@@ -54,7 +54,7 @@ function getCompiledRegex(regexString: string): RegExp | null {
     compiledRegexCache.set(regexString, regex);
     return regex;
   } catch (error) {
-    DEBUG_BUILD && logger.warn('Could not compile regex', { regexString, error });
+    DEBUG_BUILD && debug.warn('Could not compile regex', { regexString, error });
     // Cache the failure to avoid repeated attempts by storing undefined
     return null;
   }
@@ -100,7 +100,7 @@ function getManifest(): RouteManifest | null {
     return manifest;
   } catch {
     // Something went wrong while parsing the manifest, so we'll fallback to no parameterization
-    DEBUG_BUILD && logger.warn('Could not extract route manifest');
+    DEBUG_BUILD && debug.warn('Could not extract route manifest');
     return null;
   }
 }

packages/nextjs/src/client/tunnelRoute.ts

@@ -1,4 +1,4 @@
-import { dsnFromString, GLOBAL_OBJ, logger } from '@sentry/core';
+import { debug, dsnFromString, GLOBAL_OBJ } from '@sentry/core';
 import type { BrowserOptions } from '@sentry/react';
 import { DEBUG_BUILD } from '../common/debug-build';
 
@@ -25,9 +25,9 @@ export function applyTunnelRouteOption(options: BrowserOptions): void {
         tunnelPath += `&r=${regionCode}`;
       }
       options.tunnel = tunnelPath;
-      DEBUG_BUILD && logger.info(`Tunneling events to "${tunnelPath}"`);
+      DEBUG_BUILD && debug.log(`Tunneling events to "${tunnelPath}"`);
     } else {
-      DEBUG_BUILD && logger.warn('Provided DSN is not a Sentry SaaS DSN. Will not tunnel events.');
+      DEBUG_BUILD && debug.warn('Provided DSN is not a Sentry SaaS DSN. Will not tunnel events.');
     }
   }
 }

packages/nextjs/src/common/devErrorSymbolicationEventProcessor.ts

@@ -1,5 +1,5 @@
 import type { Event, EventHint } from '@sentry/core';
-import { GLOBAL_OBJ, logger, parseSemver, suppressTracing } from '@sentry/core';
+import { GLOBAL_OBJ, debug, parseSemver, suppressTracing } from '@sentry/core';
 import type { StackFrame } from 'stacktrace-parser';
 import * as stackTraceParser from 'stacktrace-parser';
 import { DEBUG_BUILD } from './debug-build';
@@ -150,7 +150,7 @@ async function resolveStackFrame(
       originalStackFrame: body.originalStackFrame,
     };
   } catch (e) {
-    DEBUG_BUILD && logger.error('Failed to symbolicate event with Next.js dev server', e);
+    DEBUG_BUILD && debug.error('Failed to symbolicate event with Next.js dev server', e);
     return null;
   }
 }
@@ -224,7 +224,7 @@ async function resolveStackFrames(
       };
     });
   } catch (e) {
-    DEBUG_BUILD && logger.error('Failed to symbolicate event with Next.js dev server', e);
+    DEBUG_BUILD && debug.error('Failed to symbolicate event with Next.js dev server', e);
     return null;
   }
 }

packages/nextjs/src/common/pages-router-instrumentation/wrapApiHandlerWithSentry.ts

@@ -1,10 +1,10 @@
 import {
   captureException,
   continueTrace,
+  debug,
   getActiveSpan,
   httpRequestToRequestData,
   isString,
-  logger,
   objectify,
   SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
   SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
@@ -42,12 +42,12 @@ export function wrapApiHandlerWithSentry(apiHandler: NextApiHandler, parameteriz
         const [req, res] = args;
 
         if (!req) {
-          logger.debug(
+          debug.log(
             `Wrapped API handler on route "${parameterizedRoute}" was not passed a request object. Will not instrument.`,
           );
           return wrappingTarget.apply(thisArg, args);
         } else if (!res) {
-          logger.debug(
+          debug.log(
             `Wrapped API handler on route "${parameterizedRoute}" was not passed a response object. Will not instrument.`,
           );
           return wrappingTarget.apply(thisArg, args);

packages/nextjs/src/common/utils/responseEnd.ts

@@ -1,5 +1,5 @@
 import type { Span } from '@sentry/core';
-import { fill, flush, logger, setHttpStatus } from '@sentry/core';
+import { debug, fill, flush, setHttpStatus } from '@sentry/core';
 import type { ServerResponse } from 'http';
 import { DEBUG_BUILD } from '../debug-build';
 import type { ResponseEndMethod, WrappedResponseEndMethod } from '../types';
@@ -47,10 +47,10 @@ export function finishSpan(span: Span, res: ServerResponse): void {
  */
 export async function flushSafelyWithTimeout(): Promise<void> {
   try {
-    DEBUG_BUILD && logger.log('Flushing events...');
+    DEBUG_BUILD && debug.log('Flushing events...');
     await flush(2000);
-    DEBUG_BUILD && logger.log('Done flushing events');
+    DEBUG_BUILD && debug.log('Done flushing events');
   } catch (e) {
-    DEBUG_BUILD && logger.log('Error while flushing events:\n', e);
+    DEBUG_BUILD && debug.log('Error while flushing events:\n', e);
   }
 }

packages/nextjs/src/common/utils/tracingUtils.ts

@@ -1,5 +1,5 @@
 import type { PropagationContext } from '@sentry/core';
-import { getActiveSpan, getRootSpan, GLOBAL_OBJ, logger, Scope, spanToJSON, startNewTrace } from '@sentry/core';
+import { debug, getActiveSpan, getRootSpan, GLOBAL_OBJ, Scope, spanToJSON, startNewTrace } from '@sentry/core';
 import { DEBUG_BUILD } from '../debug-build';
 import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../span-attributes-with-logic-attached';
 
@@ -72,7 +72,7 @@ export function escapeNextjsTracing<T>(cb: () => T): T {
 
   if (!MaybeGlobalAsyncLocalStorage) {
     DEBUG_BUILD &&
-      logger.warn(
+      debug.warn(
         "Tried to register AsyncLocalStorage async context strategy in a runtime that doesn't support AsyncLocalStorage.",
       );
     return cb();

packages/nextjs/src/config/turbopack/constructTurbopackConfig.ts

@@ -1,4 +1,4 @@
-import { logger } from '@sentry/core';
+import { debug } from '@sentry/core';
 import * as chalk from 'chalk';
 import * as path from 'path';
 import type { RouteManifest } from '../manifest/types';
@@ -63,7 +63,7 @@ export function safelyAddTurbopackRule(
 
   // If the rule already exists, we don't want to mess with it.
   if (existingRules[matcher]) {
-    logger.info(
+    debug.info(
       `${chalk.cyan(
         'info',
       )} - Turbopack rule already exists for ${matcher}. Please remove it from your Next.js config in order for Sentry to work properly.`,

packages/nextjs/src/config/webpack.ts

@@ -1,7 +1,7 @@
 /* eslint-disable complexity */
 /* eslint-disable max-lines */
 
-import { escapeStringForRegex, loadModule, logger, parseSemver } from '@sentry/core';
+import { debug, escapeStringForRegex, loadModule, parseSemver } from '@sentry/core';
 import * as chalk from 'chalk';
 import * as fs from 'fs';
 import * as path from 'path';
@@ -219,7 +219,7 @@ export function constructWebpackConfigFunction(
           // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
           vercelCronsConfig = JSON.parse(fs.readFileSync(path.join(process.cwd(), 'vercel.json'), 'utf8')).crons;
           if (vercelCronsConfig) {
-            logger.info(
+            debug.log(
               `${chalk.cyan(
                 'info',
               )} - Creating Sentry cron monitors for your Vercel Cron Jobs. You can disable this feature by setting the ${chalk.bold.cyan(
@@ -233,7 +233,7 @@ export function constructWebpackConfigFunction(
           // noop if file does not exist
         } else {
           // log but noop
-          logger.error(
+          debug.error(
             `${chalk.red(
               'error',
             )} - Sentry failed to read vercel.json for automatic cron job monitoring instrumentation`,
@@ -368,7 +368,7 @@ export function constructWebpackConfigFunction(
           // We only update this if no explicit value is set
           // (Next.js defaults to `false`: https://github.com/vercel/next.js/blob/5f4f96c133bd6b10954812cc2fef6af085b82aa5/packages/next/src/build/webpack/config/blocks/base.ts#L61)
           if (!newConfig.devtool) {
-            logger.info(`[@sentry/nextjs] Automatically enabling source map generation for ${runtime} build.`);
+            debug.log(`[@sentry/nextjs] Automatically enabling source map generation for ${runtime} build.`);
             // `hidden-source-map` produces the same sourcemaps as `source-map`, but doesn't include the `sourceMappingURL`
             // comment at the bottom. For folks who aren't publicly hosting their sourcemaps, this is helpful because then
             // the browser won't look for them and throw errors into the console when it can't find them. Because this is a
@@ -383,7 +383,7 @@ export function constructWebpackConfigFunction(
 
           // enable source map deletion if not explicitly disabled
           if (!isServer && userSentryOptions.sourcemaps?.deleteSourcemapsAfterUpload === undefined) {
-            logger.warn(
+            debug.warn(
               '[@sentry/nextjs] Source maps will be automatically deleted after being uploaded to Sentry. If you want to keep the source maps, set the `sourcemaps.deleteSourcemapsAfterUpload` option to false in `withSentryConfig()`. If you do not want to generate and upload sourcemaps at all, set the `sourcemaps.disable` option to true.',
             );
             userSentryOptions.sourcemaps = {
@@ -643,7 +643,7 @@ function addFilesToWebpackEntryPoint(
       import: newImportValue,
     };
   }
-  // malformed entry point (use `console.error` rather than `logger.error` because it will always be printed, regardless
+  // malformed entry point (use `console.error` rather than `debug.error` because it will always be printed, regardless
   // of SDK settings)
   else {
     // eslint-disable-next-line no-console

packages/nextjs/src/server/index.ts

@@ -9,6 +9,7 @@ import {
 import type { EventProcessor } from '@sentry/core';
 import {
   applySdkMetadata,
+  debug,
   extractTraceparentData,
   getCapturedScopesOnSpan,
   getClient,
@@ -17,7 +18,6 @@ import {
   getIsolationScope,
   getRootSpan,
   GLOBAL_OBJ,
-  logger,
   SEMANTIC_ATTRIBUTE_SENTRY_OP,
   SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
   SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
@@ -125,13 +125,13 @@ export function init(options: NodeOptions): NodeClient | undefined {
   };
 
   if (DEBUG_BUILD && opts.debug) {
-    logger.enable();
+    debug.enable();
   }
 
-  DEBUG_BUILD && logger.log('Initializing SDK...');
+  DEBUG_BUILD && debug.log('Initializing SDK...');
 
   if (sdkAlreadyInitialized()) {
-    DEBUG_BUILD && logger.log('SDK already initialized');
+    DEBUG_BUILD && debug.log('SDK already initialized');
     return;
   }
 
@@ -377,7 +377,7 @@ export function init(options: NodeOptions): NodeClient | undefined {
     // The statement above can throw because process is not defined on the client
   }
 
-  DEBUG_BUILD && logger.log('SDK successfully initialized');
+  DEBUG_BUILD && debug.log('SDK successfully initialized');
 
   return client;
 }