Merge pull request #770 from DataDog/marcosaia/dev/improve-generate-uuid

[IMPROVEMENT] Add paddedHex and decimal format to generateUUID

Author: marco-saia-datadog

packages/core/src/index.tsx

@@ -32,6 +32,7 @@ import { DdTrace } from './trace/DdTrace';
 import { DefaultTimeProvider } from './utils/time-provider/DefaultTimeProvider';
 import { TimeProvider } from './utils/time-provider/TimeProvider';
 import type { Timestamp } from './utils/time-provider/TimeProvider';
+import { TracingIdType } from './rum/instrumentation/resourceTracking/distributedTracing/TracingIdentifier';
 
 /* eslint-enable arca/import-ordering */
 
@@ -60,7 +61,8 @@ export {
     DefaultTimeProvider,
     DATADOG_GRAPH_QL_OPERATION_TYPE_HEADER,
     DATADOG_GRAPH_QL_OPERATION_NAME_HEADER,
-    DATADOG_GRAPH_QL_VARIABLES_HEADER
+    DATADOG_GRAPH_QL_VARIABLES_HEADER,
+    TracingIdType
 };
 
 export type { Timestamp };

packages/core/src/rum/DdRum.ts

@@ -24,6 +24,7 @@ import { generateErrorEventMapper } from './eventMappers/errorEventMapper';
 import type { ResourceEventMapper } from './eventMappers/resourceEventMapper';
 import { generateResourceEventMapper } from './eventMappers/resourceEventMapper';
 import {
+    TracingIdFormat,
     TracingIdType,
     TracingIdentifier
 } from './instrumentation/resourceTracking/distributedTracing/TracingIdentifier';
@@ -230,11 +231,23 @@ class DdRumWrapper implements DdRumType {
     };
 
     generateUUID = (type: TracingIdType): string => {
-        if (type === TracingIdType.trace) {
-            return TracingIdentifier.createTraceId().id.toString();
+        switch (type) {
+            case TracingIdType.trace:
+                return TracingIdentifier.createTraceId().toString(
+                    TracingIdFormat.paddedHex
+                );
+            case TracingIdType.span:
+                return TracingIdentifier.createSpanId().toString(
+                    TracingIdFormat.decimal
+                );
+            default:
+                console.warn(
+                    `Unsupported tracing ID type '${type}' for generateUUID. Falling back to 64 bit Span ID.`
+                );
+                return TracingIdentifier.createSpanId().toString(
+                    TracingIdFormat.decimal
+                );
         }
-
-        return TracingIdentifier.createSpanId().id.toString();
     };
 
     addError = (

packages/core/src/rum/__tests__/DdRum.test.ts

@@ -18,6 +18,7 @@ import type { ActionEventMapper } from '../eventMappers/actionEventMapper';
 import type { ErrorEventMapper } from '../eventMappers/errorEventMapper';
 import type { ResourceEventMapper } from '../eventMappers/resourceEventMapper';
 import { TracingIdType } from '../instrumentation/resourceTracking/distributedTracing/TracingIdentifier';
+import { TracingIdentifierUtils } from '../instrumentation/resourceTracking/distributedTracing/__tests__/__utils__/TracingIdentifierUtils';
 import { ErrorSource, PropagatorType, RumActionType } from '../types';
 
 jest.mock('../../utils/time-provider/DefaultTimeProvider', () => {
@@ -451,17 +452,33 @@ describe('DdRum', () => {
         });
 
         describe('DdRum.generateUUID', () => {
-            it('generates a valid trace id in decimal format', () => {
-                const traceUUID = DdRum.generateUUID(TracingIdType.trace);
+            it('generates a valid trace id in paddedHex format', () => {
+                const uuid = DdRum.generateUUID(TracingIdType.trace);
 
-                expect(traceUUID).toBeDefined(); // Ensure the value is defined
-                expect(BigInt(traceUUID).greater(BigInt(0))).toBe(true); // Ensure it's a valid positive number
+                expect(uuid).toBeDefined(); // Ensure the value is defined
+                expect(BigInt(uuid, 16).greater(BigInt(0))).toBe(true); // Ensure it's a valid positive number
+                expect(TracingIdentifierUtils.isWithin128Bits(uuid)).toBe(true); // Ensure the value is within 128 bits
+                expect(uuid).toMatch(/^[0-9a-f]{32}$/); // Ensure the value is in paddedHex format
             });
+
             it('generates a valid span id in decimal format', () => {
-                const spanUUID = DdRum.generateUUID(TracingIdType.span);
+                const uuid = DdRum.generateUUID(TracingIdType.span);
+
+                expect(uuid).toBeDefined(); // Ensure the value is defined
+                expect(BigInt(uuid).greater(BigInt(0))).toBe(true); // Ensure it's a valid positive number
+                expect(TracingIdentifierUtils.isWithin64Bits(uuid)).toBe(true); // Ensure the value is within 64 bits
+                expect(uuid).toMatch(/^[0-9]+$/); // Ensure the value contains only decimal digits
+            });
+
+            it('falls back to 64 bit span id when wrong tracingIdType is passed', () => {
+                const uuid = DdRum.generateUUID(
+                    ('wrong' as unknown) as TracingIdType
+                );
 
-                expect(spanUUID).toBeDefined();
-                expect(BigInt(spanUUID).greater(BigInt(0))).toBe(true);
+                expect(uuid).toBeDefined(); // Ensure the value is defined
+                expect(BigInt(uuid).greater(BigInt(0))).toBe(true); // Ensure it's a valid positive number
+                expect(TracingIdentifierUtils.isWithin64Bits(uuid)).toBe(true); // Ensure the value is within 64 bits
+                expect(uuid).toMatch(/^[0-9]+$/); // Ensure the value contains only decimal digits
             });
         });