more unit tests

Author: Lms24

packages/opentelemetry/src/utils/parseSpanDescription.ts

@@ -263,7 +263,13 @@ export function getSanitizedUrl(
   return { urlPath: undefined, url, query, fragment, hasRoute: false };
 }
 
-function getOriginalName(name: string, attributes: Attributes): string {
+/**
+ * Because Otel decided to mutate span names via `span.updateName`, the only way to ensure
+ * that a user-set span name is preserved is to store it as a tmp attribute on the span.
+ * We delete this attribute once we're done with it when preparing the event envelope.
+ * @internal
+ */
+export function getOriginalName(name: string, attributes: Attributes): string {
   return attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] === 'custom' &&
     attributes['_sentry_span_name_set_by_user'] &&
     typeof attributes['_sentry_span_name_set_by_user'] === 'string'

packages/opentelemetry/test/utils/parseSpanDescription.test.ts

@@ -15,7 +15,12 @@ import {
   SEMATTRS_RPC_SERVICE,
 } from '@opentelemetry/semantic-conventions';
 
-import { descriptionForHttpMethod, getSanitizedUrl, parseSpanDescription } from '../../src/utils/parseSpanDescription';
+import {
+  descriptionForHttpMethod,
+  getOriginalName,
+  getSanitizedUrl,
+  parseSpanDescription,
+} from '../../src/utils/parseSpanDescription';
 import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';
 
 describe('parseSpanDescription', () => {
@@ -97,6 +102,22 @@ describe('parseSpanDescription', () => {
         source: 'custom',
       },
     ],
+    [
+      'works with db system and custom source and custom name',
+      {
+        [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom',
+        [SEMATTRS_DB_SYSTEM]: 'mysql',
+        [SEMATTRS_DB_STATEMENT]: 'SELECT * from users',
+        ['_sentry_span_name_set_by_user']: 'custom name',
+      },
+      'test name',
+      SpanKind.CLIENT,
+      {
+        description: 'custom name',
+        op: 'db',
+        source: 'custom',
+      },
+    ],
     [
       'works with db system without statement',
       {
@@ -137,6 +158,21 @@ describe('parseSpanDescription', () => {
         source: 'custom',
       },
     ],
+    [
+      'works with rpc service and custom source and custom name',
+      {
+        [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom',
+        [SEMATTRS_RPC_SERVICE]: 'rpc-test-service',
+        ['_sentry_span_name_set_by_user']: 'custom name',
+      },
+      'test name',
+      undefined,
+      {
+        description: 'custom name',
+        op: 'rpc',
+        source: 'custom',
+      },
+    ],
     [
       'works with messaging system',
       {
@@ -164,6 +200,21 @@ describe('parseSpanDescription', () => {
         source: 'custom',
       },
     ],
+    [
+      'works with messaging system and custom source and custom name',
+      {
+        [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom',
+        [SEMATTRS_MESSAGING_SYSTEM]: 'test-messaging-system',
+        ['_sentry_span_name_set_by_user']: 'custom name',
+      },
+      'test name',
+      undefined,
+      {
+        description: 'custom name',
+        op: 'message',
+        source: 'custom',
+      },
+    ],
     [
       'works with faas trigger',
       {
@@ -191,6 +242,21 @@ describe('parseSpanDescription', () => {
         source: 'custom',
       },
     ],
+    [
+      'works with faas trigger and custom source and custom name',
+      {
+        [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom',
+        [SEMATTRS_FAAS_TRIGGER]: 'test-faas-trigger',
+        ['_sentry_span_name_set_by_user']: 'custom name',
+      },
+      'test name',
+      undefined,
+      {
+        description: 'custom name',
+        op: 'test-faas-trigger',
+        source: 'custom',
+      },
+    ],
   ])('%s', (_, attributes, name, kind, expected) => {
     const actual = parseSpanDescription({ attributes, kind, name } as unknown as Span);
     expect(actual).toEqual(expected);
@@ -309,7 +375,7 @@ describe('descriptionForHttpMethod', () => {
       },
     ],
     [
-      "doesn't overwrite name with source custom",
+      "doesn't overwrite span name with source custom",
       'GET',
       {
         [SEMATTRS_HTTP_METHOD]: 'GET',
@@ -329,6 +395,28 @@ describe('descriptionForHttpMethod', () => {
         source: 'custom',
       },
     ],
+    [
+      'takes user-passed span name (with source custom)',
+      'GET',
+      {
+        [SEMATTRS_HTTP_METHOD]: 'GET',
+        [SEMATTRS_HTTP_URL]: 'https://www.example.com/my-path/123',
+        [SEMATTRS_HTTP_TARGET]: '/my-path/123',
+        [ATTR_HTTP_ROUTE]: '/my-path/:id',
+        [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom',
+        ['_sentry_span_name_set_by_user']: 'custom name',
+      },
+      'test name',
+      SpanKind.CLIENT,
+      {
+        op: 'http.client',
+        description: 'custom name',
+        data: {
+          url: 'https://www.example.com/my-path/123',
+        },
+        source: 'custom',
+      },
+    ],
   ])('%s', (_, httpMethod, attributes, name, kind, expected) => {
     const actual = descriptionForHttpMethod({ attributes, kind, name }, httpMethod);
     expect(actual).toEqual(expected);
@@ -482,3 +570,26 @@ describe('getSanitizedUrl', () => {
     expect(actual).toEqual(expected);
   });
 });
+
+describe('getOriginalName', () => {
+  it('returns param name if source is not custom', () => {
+    expect(getOriginalName('base name', {})).toBe('base name');
+  });
+
+  it('returns param name if `_sentry_span_name_set_by_user` attribute is not set', () => {
+    expect(getOriginalName('base name', { [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom' })).toBe('base name');
+  });
+
+  it('returns param name if `_sentry_span_name_set_by_user` attribute is not a string', () => {
+    expect(getOriginalName('base name', { ['_sentry_span_name_set_by_user']: 123 })).toBe('base name');
+  });
+
+  it('returns `_sentry_span_name_set_by_user` attribute if is a string and source is custom', () => {
+    expect(
+      getOriginalName('base name', {
+        ['_sentry_span_name_set_by_user']: 'custom name',
+        [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom',
+      }),
+    ).toBe('custom name');
+  });
+});