fix(analytics): normalize id

.changeset/hip-carrots-reply.md

@@ -0,0 +1,5 @@
+---
+"@scaleway/use-analytics": patch
+---
+
+Add normalize id on anonymousId, userId, groupId

packages/use-analytics/package.json

@@ -40,7 +40,9 @@
     "build": "vite build --config vite.config.ts && pnpm run type:generate",
     "build:profile": "npx vite-bundle-visualizer -c vite.config.ts",
     "lint": "eslint --report-unused-disable-directives --cache --cache-strategy content --ext ts,tsx .",
-    "lintpublish": "publint"
+    "lintpublish": "publint",
+    "test:unit": "vitest --run --config vite.config.ts",
+    "test:unit:coverage": "pnpm test:unit --coverage"
   },
   "repository": {
     "type": "git",

packages/use-analytics/src/__tests__/normalizeId.test.ts

@@ -0,0 +1,37 @@
+// use-analytics/src/__tests__/normalizeId.test.ts
+import { normalizeId } from '../analytics/normalizeId'
+
+describe('normalizeId', () => {
+  it('should return undefined for null or undefined input', () => {
+    expect(normalizeId(null)).toBeUndefined()
+    expect(normalizeId(undefined)).toBeUndefined()
+  })
+
+  it('should return the same string for non-JSON inputs', () => {
+    expect(normalizeId('user123')).toBe('user123')
+    expect(normalizeId('hello world!')).toBe('hello world!')
+  })
+
+  it('should parse valid JSON strings to string', () => {
+    expect(normalizeId('"user123"')).toBe('user123')
+    expect(normalizeId('"12345"')).toBe('12345')
+    expect(normalizeId('"\\"nested\\" string"')).toBe('"nested" string')
+  })
+
+  it('should ignore JSON strings that decode to non-strings', () => {
+    expect(normalizeId('{"id": "user123"}')).toBe('{"id": "user123"}')
+    expect(normalizeId('[1, 2, 3]')).toBe('[1, 2, 3]')
+    expect(normalizeId('123')).toBe('123')
+    expect(normalizeId('true')).toBe('true')
+  })
+
+  it('should convert numbers to strings', () => {
+    expect(normalizeId(12345)).toBe('12345')
+    expect(normalizeId(123e45)).toBe('1.23e+47') // Might vary based on the string conversion
+  })
+
+  it('should handle string inputs with special characters', () => {
+    expect(normalizeId('user!@#$%^&*()')).toBe('user!@#$%^&*()')
+    expect(normalizeId('user"123"')).toBe('user"123"')
+  })
+})

packages/use-analytics/src/analytics/index.ts

@@ -9,3 +9,4 @@ export type {
 export { userMigrationsTraits } from './segments/userMigrationsTraits'
 export { defaultLoadOptions } from './constants'
 export { useDestinations } from './useDestinations'
+export { normalizeId } from './normalizeId'

packages/use-analytics/src/analytics/normalizeId.ts

@@ -0,0 +1,24 @@
+type ID = string | number | undefined | null
+
+export const normalizeId = (id: ID) => {
+  if (id === null || id === undefined) return undefined
+
+  // Already a string but possibly JSON-encoded
+  if (typeof id === 'string') {
+    try {
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+      const parsed = JSON.parse(id)
+      // Only use parsed if it’s a string too
+
+      if (typeof parsed === 'string') {
+        return parsed
+      }
+    } catch {
+      // not JSON, keep original
+    }
+
+    return id
+  }
+
+  return String(id)
+}

packages/use-analytics/src/analytics/normalizeIdsMigration.ts

@@ -0,0 +1,25 @@
+import type { RudderAnalytics } from '@rudderstack/analytics-js'
+import { normalizeId } from './normalizeId'
+
+export const normalizeIdsMigration = (rudderAnalytics: RudderAnalytics) => {
+  // normalize id issue with segment migration
+  const anonymousId = rudderAnalytics.getAnonymousId()
+  const normalizeAnonymousId = normalizeId(anonymousId)
+  if (normalizeAnonymousId !== anonymousId) {
+    rudderAnalytics.setAnonymousId(normalizeAnonymousId)
+  }
+
+  const userId = rudderAnalytics.getUserId()
+  const normalizeUserId = userId ? normalizeId(userId) : null
+
+  if (userId !== normalizeUserId && normalizeUserId) {
+    rudderAnalytics.identify(normalizeUserId)
+  }
+
+  const groupId = rudderAnalytics.getGroupId()
+  const normalizeGroupId = groupId ? normalizeId(groupId) : null
+
+  if (userId !== normalizeGroupId && normalizeGroupId) {
+    rudderAnalytics.group(normalizeGroupId)
+  }
+}

packages/use-analytics/src/analytics/segments/userMigrationsTraits.ts

@@ -1,4 +1,5 @@
 import type { RudderAnalytics } from '@rudderstack/analytics-js'
+import { normalizeId } from '../normalizeId'
 
 const SEGMENT_COOKIES_KEY = {
   ANONYMOUS_ID: 'ajs_anonymous_id',
@@ -16,14 +17,20 @@ export const userMigrationsTraits = (rudderAnalytics: RudderAnalytics) => {
   const rudderGroupId = rudderAnalytics.getGroupId()
 
   if (segmentAnonymousId) {
-    rudderAnalytics.setAnonymousId(segmentAnonymousId)
+    rudderAnalytics.setAnonymousId(normalizeId(segmentAnonymousId))
   }
 
   if (segmentUserId && (!rudderUserId || rudderUserId !== segmentUserId)) {
-    rudderAnalytics.identify(segmentUserId)
+    const normalizedUserId = normalizeId(segmentUserId)
+    if (normalizedUserId) {
+      rudderAnalytics.identify(normalizedUserId)
+    }
   }
 
   if (segmentGroupId && (!rudderGroupId || rudderGroupId !== segmentGroupId)) {
-    rudderAnalytics.group(segmentGroupId)
+    const normalizedGroupId = normalizeId(segmentGroupId)
+    if (normalizedGroupId) {
+      rudderAnalytics.group(normalizedGroupId)
+    }
   }
 }

packages/use-analytics/src/analytics/useAnalytics.tsx

@@ -6,6 +6,7 @@ import { useDeepCompareEffectNoCheck } from 'use-deep-compare-effect'
 import { destSDKBaseURL, pluginsSDKBaseURL } from '../constants'
 import type { CategoryKind } from '../types'
 import { defaultConsentOptions, defaultLoadOptions } from './constants'
+import { normalizeIdsMigration } from './normalizeIdsMigration'
 import { userMigrationsTraits } from './segments/userMigrationsTraits'
 
 type Analytics = RudderAnalytics
@@ -130,6 +131,7 @@ export function AnalyticsProvider<T extends Events>({
         pluginsSDKBaseURL: pluginsSDKBaseURL(settings.cdnURL),
         onLoaded: (rudderAnalytics: Analytics) => {
           userMigrationsTraits(rudderAnalytics)
+          normalizeIdsMigration(rudderAnalytics)
 
           rudderAnalytics.consent({
             ...defaultConsentOptions,