ref(core): Ensure error span status is always valid

Author: mydea

packages/core/src/tracing/index.ts

@@ -13,8 +13,14 @@ export { startIdleSpan, TRACING_DEFAULTS } from './idleSpan';
 export { SentrySpan } from './sentrySpan';
 export { _INTERNAL_setDeferSegmentSpanCapture } from './deferSegmentSpanCapture';
 export { SentryNonRecordingSpan } from './sentryNonRecordingSpan';
-export { setHttpStatus, getSpanStatusFromHttpCode } from './spanstatus';
-export { SPAN_STATUS_ERROR, SPAN_STATUS_OK, SPAN_STATUS_UNSET } from './spanstatus';
+export {
+  setHttpStatus,
+  getSpanStatusFromHttpCode,
+  isStatusErrorMessageValid,
+  SPAN_STATUS_ERROR,
+  SPAN_STATUS_OK,
+  SPAN_STATUS_UNSET,
+} from './spanstatus';
 export {
   startSpan,
   startInactiveSpan,

packages/core/src/tracing/spanstatus.ts

@@ -1,10 +1,15 @@
 import type { Span } from '../types/span';
-import type { SpanStatus } from '../types/spanStatus';
+import type { SpanStatusType } from '../types/spanStatus';
+import { SPAN_STATUS_TYPES, type SpanStatus } from '../types/spanStatus';
 
 export const SPAN_STATUS_UNSET = 0;
 export const SPAN_STATUS_OK = 1;
 export const SPAN_STATUS_ERROR = 2;
 
+export function isStatusErrorMessageValid(message: string): boolean {
+  return SPAN_STATUS_TYPES.includes(message as SpanStatusType);
+}
+
 /**
  * Converts a HTTP status code into a sentry status with a message.
  *

packages/core/src/types/spanStatus.ts

@@ -1,38 +1,41 @@
-export type SpanStatusType =
+export const SPAN_STATUS_TYPES = [
   /** The operation completed successfully. */
-  | 'ok'
+  'ok',
   /** Deadline expired before operation could complete. */
-  | 'deadline_exceeded'
+  'deadline_exceeded',
   /** 401 Unauthorized (actually does mean unauthenticated according to RFC 7235) */
-  | 'unauthenticated'
+  'unauthenticated',
   /** 403 Forbidden */
-  | 'permission_denied'
+  'permission_denied',
   /** 404 Not Found. Some requested entity (file or directory) was not found. */
-  | 'not_found'
+  'not_found',
   /** 429 Too Many Requests */
-  | 'resource_exhausted'
+  'resource_exhausted',
   /** Client specified an invalid argument. 4xx. */
-  | 'invalid_argument'
+  'invalid_argument',
   /** 501 Not Implemented */
-  | 'unimplemented'
+  'unimplemented',
   /** 503 Service Unavailable */
-  | 'unavailable'
+  'unavailable',
   /** Other/generic 5xx. */
-  | 'internal_error'
+  'internal_error',
   /** Unknown. Any non-standard HTTP status code. */
-  | 'unknown_error'
+  'unknown_error',
   /** The operation was cancelled (typically by the user). */
-  | 'cancelled'
+  'cancelled',
   /** Already exists (409) */
-  | 'already_exists'
+  'already_exists',
   /** Operation was rejected because the system is not in a state required for the operation's */
-  | 'failed_precondition'
+  'failed_precondition',
   /** The operation was aborted, typically due to a concurrency issue. */
-  | 'aborted'
+  'aborted',
   /** Operation was attempted past the valid range. */
-  | 'out_of_range'
+  'out_of_range',
   /** Unrecoverable data loss or corruption */
-  | 'data_loss';
+  'data_loss',
+] as const;
+
+export type SpanStatusType = (typeof SPAN_STATUS_TYPES)[number];
 
 // These are aligned with OpenTelemetry span status codes
 const SPAN_STATUS_UNSET = 0;

packages/core/src/utils/spanUtils.ts

@@ -12,7 +12,7 @@ import {
   SEMANTIC_ATTRIBUTE_SENTRY_STATUS_MESSAGE,
 } from '../semanticAttributes';
 import type { SentrySpan } from '../tracing/sentrySpan';
-import { SPAN_STATUS_OK, SPAN_STATUS_UNSET } from '../tracing/spanstatus';
+import { isStatusErrorMessageValid, SPAN_STATUS_OK, SPAN_STATUS_UNSET } from '../tracing/spanstatus';
 import { getCapturedScopesOnSpan } from '../tracing/utils';
 import type { TraceContext } from '../types/context';
 import type { SpanLink, SpanLinkJSON } from '../types/link';
@@ -326,7 +326,7 @@ export function getStatusMessage(status: SpanStatus | undefined): string | undef
     return 'ok';
   }
 
-  return status.message || 'internal_error';
+  return status.message && isStatusErrorMessageValid(status.message) ? status.message : 'internal_error';
 }
 
 /**

packages/opentelemetry/src/applyOtelSpanData.ts

@@ -12,9 +12,10 @@ import {
   spanToJSON,
   SPAN_STATUS_ERROR,
   SPAN_STATUS_OK,
+  isStatusErrorMessageValid,
 } from '@sentry/core';
 import type { Span, SpanAttributes } from '@sentry/core';
-import { inferStatusFromAttributes, isStatusErrorMessageValid } from './utils/mapStatus';
+import { inferStatusFromAttributes } from './utils/mapStatus';
 import { inferSpanData } from './utils/parseSpanDescription';
 
 type SentrySpanWithOtelKind = Span & { kind?: SpanKind };

packages/opentelemetry/src/utils/mapStatus.ts

@@ -1,7 +1,7 @@
 import { SpanStatusCode } from '@opentelemetry/api';
 import { HTTP_RESPONSE_STATUS_CODE, HTTP_STATUS_CODE, RPC_GRPC_STATUS_CODE } from '@sentry/conventions/attributes';
 import type { SpanAttributes, SpanStatus } from '@sentry/core';
-import { getSpanStatusFromHttpCode, SPAN_STATUS_ERROR, SPAN_STATUS_OK } from '@sentry/core';
+import { getSpanStatusFromHttpCode, isStatusErrorMessageValid, SPAN_STATUS_ERROR, SPAN_STATUS_OK } from '@sentry/core';
 import type { AbstractSpan } from '../types';
 import { spanHasAttributes, spanHasStatus } from './spanTypes';
 
@@ -25,10 +25,6 @@ const canonicalGrpcErrorCodesMap: Record<string, SpanStatus['message']> = {
   '16': 'unauthenticated',
 } as const;
 
-export const isStatusErrorMessageValid = (message: string): boolean => {
-  return Object.values(canonicalGrpcErrorCodesMap).includes(message as SpanStatus['message']);
-};
-
 /**
  * Get a Sentry span status from an otel span.
  */