@dash0/sdk-web 0.10.1 → 0.11.0

package/src/utils/session-id_test.ts

@@ -0,0 +1,33 @@
+import { describe, expect, it, vi } from "vitest";
+import { generateSessionId } from "./session-id";
+import * as localStorage from "./local-storage";
+
+describe("generateSessionId", () => {
+  it("returns a session ID of the expected length", () => {
+    const sessionId = generateSessionId();
+    expect(sessionId).toHaveLength(16);
+  });
+
+  it("returns a session ID with proper flags when storage is supported", () => {
+    vi.spyOn(localStorage, "isSupported", "get").mockReturnValue(true);
+
+    const sessionId = generateSessionId();
+    console.log(sessionId);
+    expect(sessionId.startsWith("00")).toBe(true);
+  });
+
+  it("returns a session ID with proper flags when storage is NOT supported", () => {
+    vi.spyOn(localStorage, "isSupported", "get").mockReturnValue(false);
+
+    const sessionId = generateSessionId();
+    console.log(sessionId);
+    expect(sessionId.startsWith("01")).toBe(true);
+  });
+
+  it("returns a unique session ID on each call", () => {
+    const sessionId1 = generateSessionId();
+    const sessionId2 = generateSessionId();
+
+    expect(sessionId1).not.toBe(sessionId2);
+  });
+});

package/src/utils/trace-id.ts

@@ -0,0 +1,27 @@
+import { generateUniqueId, SESSION_ID_BYTES, TRACE_ID_BYTES } from "./id";
+
+type TraceFlags = {
+  withoutSession: boolean;
+};
+
+const TRACE_ID_PREFIX = "d042";
+
+const TRACE_FLAGS = {
+  WITHOUT_SESSION: 0x01, // 00000001 - in some edge cases we do not have a session ID, so we need to mark the trace as such
+} as const;
+
+function encodeTraceFlags(flags: TraceFlags): string {
+  let byte = 0;
+  if (flags.withoutSession) {
+    byte |= TRACE_FLAGS.WITHOUT_SESSION;
+  }
+
+  return byte.toString(16).padStart(2, "0");
+}
+
+export function generateTraceId(sessionId: string | null): string {
+  if (!sessionId) {
+    return `${TRACE_ID_PREFIX}${encodeTraceFlags({ withoutSession: true })}${generateUniqueId(TRACE_ID_BYTES - 3)}`;
+  }
+  return `${TRACE_ID_PREFIX}${encodeTraceFlags({ withoutSession: false })}${sessionId}${generateUniqueId(TRACE_ID_BYTES - SESSION_ID_BYTES - 3)}`;
+}

package/src/utils/trace-id_test.ts

@@ -0,0 +1,42 @@
+import { expect, describe, it } from "vitest";
+import { generateTraceId } from "./trace-id";
+
+describe("generateTraceId", () => {
+  it("returns a trace ID of the expected length", () => {
+    const traceId = generateTraceId(null);
+
+    expect(traceId).toHaveLength(32);
+  });
+
+  it("returns a trace ID with correct prefix when a session id is set", () => {
+    const traceId = generateTraceId("abcdef1234567890");
+
+    expect(traceId.substring(0, 6)).toEqual("d04200");
+  });
+
+  it("returns a trace ID with correct prefix when NOT session is set", () => {
+    const traceId = generateTraceId(null);
+
+    expect(traceId.substring(0, 6)).toEqual("d04201");
+  });
+
+  it("returns a unique trace ID on each call", () => {
+    const sessiondId = "abcdef1234567890";
+    const traceId1 = generateTraceId("abcdef1234567890");
+    const traceId2 = generateTraceId("abcdef1234567890");
+
+    expect(traceId1).not.toBe(traceId2);
+    expect(traceId1.substring(6, 22)).toBe(sessiondId);
+    expect(traceId2.substring(6, 22)).toBe(sessiondId);
+  });
+
+  it("returns a unique trace ID when session id is not set", () => {
+    const traceId1 = generateTraceId(null);
+    const sessionId1 = traceId1.substring(6, 22);
+    const traceId2 = generateTraceId(null);
+    const sessionId2 = traceId2.substring(6, 22);
+
+    expect(traceId1).not.toBe(traceId2);
+    expect(sessionId1).not.toBe(sessionId2);
+  });
+});