Clean up

Luca Forstner · Luca Forstner · commit e5e33ee428f4 · 2024-09-23T11:05:10.000Z
diff --git a/packages/browser/src/integrations/breadcrumbs.ts b/packages/browser/src/integrations/breadcrumbs.ts
@@ -4,7 +4,7 @@ import {
   addHistoryInstrumentationHandler,
   addXhrInstrumentationHandler,
 } from '@sentry-internal/browser-utils';
-import { addBreadcrumb, defineIntegration, getBreadcrumbLogLevel, getClient } from '@sentry/core';
+import { addBreadcrumb, defineIntegration, getClient } from '@sentry/core';
 import type {
   Breadcrumb,
   Client,
@@ -23,6 +23,7 @@ import type {
 import {
   addConsoleInstrumentationHandler,
   addFetchInstrumentationHandler,
+  getBreadcrumbLogLevelFromHttpStatusCode,
   getComponentName,
   getEventDescription,
   htmlTreeAsString,
@@ -247,14 +248,14 @@ function _getXhrBreadcrumbHandler(client: Client): (handlerData: HandlerDataXhr)
       endTimestamp,
     };
 
-    const level = getBreadcrumbLogLevel(status_code);
+    const level = getBreadcrumbLogLevelFromHttpStatusCode(status_code);
 
     addBreadcrumb(
       {
         category: 'xhr',
         data,
         type: 'http',
-        ...level,
+        level,
       },
       hint,
     );
@@ -312,14 +313,14 @@ function _getFetchBreadcrumbHandler(client: Client): (handlerData: HandlerDataFe
         startTimestamp,
         endTimestamp,
       };
-      const level = getBreadcrumbLogLevel(data.status_code);
+      const level = getBreadcrumbLogLevelFromHttpStatusCode(data.status_code);
 
       addBreadcrumb(
         {
           category: 'fetch',
           data,
           type: 'http',
-          ...level,
+          level,
         },
         hint,
       );
diff --git a/packages/cloudflare/src/integrations/fetch.ts b/packages/cloudflare/src/integrations/fetch.ts
@@ -1,11 +1,4 @@
-import {
-  addBreadcrumb,
-  defineIntegration,
-  getBreadcrumbLogLevel,
-  getClient,
-  instrumentFetchRequest,
-  isSentryRequestUrl,
-} from '@sentry/core';
+import { addBreadcrumb, defineIntegration, getClient, instrumentFetchRequest, isSentryRequestUrl } from '@sentry/core';
 import type {
   Client,
   FetchBreadcrumbData,
@@ -14,7 +7,12 @@ import type {
   IntegrationFn,
   Span,
 } from '@sentry/types';
-import { LRUMap, addFetchInstrumentationHandler, stringMatchesSomePattern } from '@sentry/utils';
+import {
+  LRUMap,
+  addFetchInstrumentationHandler,
+  getBreadcrumbLogLevelFromHttpStatusCode,
+  stringMatchesSomePattern,
+} from '@sentry/utils';
 
 const INTEGRATION_NAME = 'Fetch';
 
@@ -151,14 +149,14 @@ function createBreadcrumb(handlerData: HandlerDataFetch): void {
       startTimestamp,
       endTimestamp,
     };
-    const level = getBreadcrumbLogLevel(data.status_code);
+    const level = getBreadcrumbLogLevelFromHttpStatusCode(data.status_code);
 
     addBreadcrumb(
       {
         category: 'fetch',
         data,
         type: 'http',
-        ...level,
+        level,
       },
       hint,
     );
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -84,7 +84,6 @@ export { parseSampleRate } from './utils/parseSampleRate';
 export { applySdkMetadata } from './utils/sdkMetadata';
 export { getTraceData } from './utils/traceData';
 export { getTraceMetaTags } from './utils/meta';
-export { getBreadcrumbLogLevel } from './utils/breadcrumbsUtils';
 export { DEFAULT_ENVIRONMENT } from './constants';
 export { addBreadcrumb } from './breadcrumbs';
 export { functionToStringIntegration } from './integrations/functiontostring';
diff --git a/packages/core/src/utils/breadcrumbsUtils.ts b/packages/core/src/utils/breadcrumbsUtils.ts
diff --git a/packages/core/test/lib/utils/breadcrumbsUtils.test.ts b/packages/core/test/lib/utils/breadcrumbsUtils.test.ts
diff --git a/packages/deno/src/integrations/breadcrumbs.ts b/packages/deno/src/integrations/breadcrumbs.ts
@@ -1,4 +1,4 @@
-import { addBreadcrumb, defineIntegration, getBreadcrumbLogLevel, getClient } from '@sentry/core';
+import { addBreadcrumb, defineIntegration, getClient } from '@sentry/core';
 import type {
   Client,
   Event as SentryEvent,
@@ -11,6 +11,7 @@ import type {
 import {
   addConsoleInstrumentationHandler,
   addFetchInstrumentationHandler,
+  getBreadcrumbLogLevelFromHttpStatusCode,
   getEventDescription,
   safeJoin,
   severityLevelFromString,
@@ -178,14 +179,14 @@ function _getFetchBreadcrumbHandler(client: Client): (handlerData: HandlerDataFe
         startTimestamp,
         endTimestamp,
       };
-      const level = getBreadcrumbLogLevel(data.status_code);
+      const level = getBreadcrumbLogLevelFromHttpStatusCode(data.status_code);
 
       addBreadcrumb(
         {
           category: 'fetch',
           data,
           type: 'http',
-          ...level,
+          level,
         },
         hint,
       );
diff --git a/packages/node/src/integrations/http.ts b/packages/node/src/integrations/http.ts
@@ -6,7 +6,6 @@ import { addOpenTelemetryInstrumentation } from '@sentry/opentelemetry';
 import {
   addBreadcrumb,
   defineIntegration,
-  getBreadcrumbLogLevel,
   getCapturedScopesOnSpan,
   getCurrentScope,
   getIsolationScope,
@@ -15,7 +14,12 @@ import {
 import { getClient } from '@sentry/opentelemetry';
 import type { IntegrationFn, SanitizedRequestData } from '@sentry/types';
 
-import { getSanitizedUrlString, parseUrl, stripUrlQueryAndFragment } from '@sentry/utils';
+import {
+  getBreadcrumbLogLevelFromHttpStatusCode,
+  getSanitizedUrlString,
+  parseUrl,
+  stripUrlQueryAndFragment,
+} from '@sentry/utils';
 import type { NodeClient } from '../sdk/client';
 import { setIsolationScope } from '../sdk/scope';
 import type { HTTPModuleRequestIncomingMessage } from '../transports/http-module';
@@ -231,7 +235,7 @@ function _addRequestBreadcrumb(
 
   const data = getBreadcrumbData(request);
   const statusCode = response.statusCode;
-  const level = getBreadcrumbLogLevel(statusCode);
+  const level = getBreadcrumbLogLevelFromHttpStatusCode(statusCode);
 
   addBreadcrumb(
     {
@@ -241,7 +245,7 @@ function _addRequestBreadcrumb(
         ...data,
       },
       type: 'http',
-      ...level,
+      level,
     },
     {
       event: 'response',
diff --git a/packages/node/src/integrations/node-fetch.ts b/packages/node/src/integrations/node-fetch.ts
@@ -1,14 +1,9 @@
 import type { UndiciRequest, UndiciResponse } from '@opentelemetry/instrumentation-undici';
 import { UndiciInstrumentation } from '@opentelemetry/instrumentation-undici';
-import {
-  SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
-  addBreadcrumb,
-  defineIntegration,
-  getBreadcrumbLogLevel,
-} from '@sentry/core';
+import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, addBreadcrumb, defineIntegration } from '@sentry/core';
 import { addOpenTelemetryInstrumentation } from '@sentry/opentelemetry';
 import type { IntegrationFn, SanitizedRequestData } from '@sentry/types';
-import { getSanitizedUrlString, parseUrl } from '@sentry/utils';
+import { getBreadcrumbLogLevelFromHttpStatusCode, getSanitizedUrlString, parseUrl } from '@sentry/utils';
 
 interface NodeFetchOptions {
   /**
@@ -62,7 +57,7 @@ export const nativeNodeFetchIntegration = defineIntegration(_nativeNodeFetchInte
 function addRequestBreadcrumb(request: UndiciRequest, response: UndiciResponse): void {
   const data = getBreadcrumbData(request);
   const statusCode = response.statusCode;
-  const level = getBreadcrumbLogLevel(statusCode);
+  const level = getBreadcrumbLogLevelFromHttpStatusCode(statusCode);
 
   addBreadcrumb(
     {
@@ -72,7 +67,7 @@ function addRequestBreadcrumb(request: UndiciRequest, response: UndiciResponse):
         ...data,
       },
       type: 'http',
-      ...level,
+      level,
     },
     {
       event: 'response',
diff --git a/packages/types/src/scope.ts b/packages/types/src/scope.ts
@@ -189,7 +189,7 @@ export interface Scope {
   clear(): this;
 
   /**
-   * Sets the breadcrumb in the scope
+   * Adds a breadcrumb to the scope
    * @param breadcrumb Breadcrumb
    * @param maxBreadcrumbs number of max breadcrumbs to merged into event.
    */
@@ -201,7 +201,7 @@ export interface Scope {
   getLastBreadcrumb(): Breadcrumb | undefined;
 
   /**
-   * Clears all currently set Breadcrumbs.
+   * Clears all breadcrumbs from the scope.
    */
   clearBreadcrumbs(): this;
 
diff --git a/packages/utils/src/breadcrumb-log-level.ts b/packages/utils/src/breadcrumb-log-level.ts
@@ -0,0 +1,17 @@
+import type { SeverityLevel } from '@sentry/types';
+
+/**
+ * Determine a breadcrumb's log level (only `warning` or `error`) based on an HTTP status code.
+ */
+export function getBreadcrumbLogLevelFromHttpStatusCode(statusCode: number | undefined): SeverityLevel | undefined {
+  // NOTE: undefined defaults to 'info' in Sentry
+  if (statusCode === undefined) {
+    return undefined;
+  } else if (statusCode >= 400 && statusCode < 500) {
+    return 'warning';
+  } else if (statusCode >= 500) {
+    return 'error';
+  } else {
+    return undefined;
+  }
+}
diff --git a/packages/utils/src/index.ts b/packages/utils/src/index.ts
@@ -1,5 +1,6 @@
 export * from './aggregate-errors';
 export * from './array';
+export * from './breadcrumb-log-level';
 export * from './browser';
 export * from './dsn';
 export * from './error';
diff --git a/packages/utils/test/breadcrumb-log-level.test.ts b/packages/utils/test/breadcrumb-log-level.test.ts
@@ -0,0 +1,15 @@
+import { getBreadcrumbLogLevelFromHttpStatusCode } from '../src/breadcrumb-log-level';
+
+describe('getBreadcrumbLogLevelFromHttpStatusCode()', () => {
+  it.each([
+    ['warning', '4xx', 403],
+    ['error', '5xx', 500],
+    [undefined, '3xx', 307],
+    [undefined, '2xx', 200],
+    [undefined, '1xx', 103],
+    [undefined, '0', 0],
+    [undefined, 'undefined', undefined],
+  ])('should return `%s` for %s', (output, _codeRange, input) => {
+    expect(getBreadcrumbLogLevelFromHttpStatusCode(input)).toEqual(output);
+  });
+});
diff --git a/packages/vercel-edge/src/integrations/wintercg-fetch.ts b/packages/vercel-edge/src/integrations/wintercg-fetch.ts
@@ -1,11 +1,4 @@
-import {
-  addBreadcrumb,
-  defineIntegration,
-  getBreadcrumbLogLevel,
-  getClient,
-  instrumentFetchRequest,
-  isSentryRequestUrl,
-} from '@sentry/core';
+import { addBreadcrumb, defineIntegration, getClient, instrumentFetchRequest, isSentryRequestUrl } from '@sentry/core';
 import type {
   Client,
   FetchBreadcrumbData,
@@ -14,7 +7,12 @@ import type {
   IntegrationFn,
   Span,
 } from '@sentry/types';
-import { LRUMap, addFetchInstrumentationHandler, stringMatchesSomePattern } from '@sentry/utils';
+import {
+  LRUMap,
+  addFetchInstrumentationHandler,
+  getBreadcrumbLogLevelFromHttpStatusCode,
+  stringMatchesSomePattern,
+} from '@sentry/utils';
 
 const INTEGRATION_NAME = 'WinterCGFetch';
 
@@ -157,14 +155,14 @@ function createBreadcrumb(handlerData: HandlerDataFetch): void {
       startTimestamp,
       endTimestamp,
     };
-    const level = getBreadcrumbLogLevel(data.status_code);
+    const level = getBreadcrumbLogLevelFromHttpStatusCode(data.status_code);
 
     addBreadcrumb(
       {
         category: 'fetch',
         data,
         type: 'http',
-        ...level,
+        level,
       },
       hint,
     );
