Standardize unique key generation using nanoid (#340)

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Starefossen <968267+Starefossen@users.noreply.github.com>
Co-authored-by: Hans Kristian Flaatten <hans.kristian.flaatten@nav.no>

Author: Copilot

__tests__/lib/sanity/helpers.test.ts

@@ -0,0 +1,97 @@
+import {
+  generateKey,
+  ensureArrayKeys,
+  createReference,
+  createReferenceWithKey,
+} from '@/lib/sanity/helpers'
+
+describe('generateKey', () => {
+  it('should generate a unique key with default prefix', () => {
+    const key1 = generateKey()
+    const key2 = generateKey()
+
+    expect(key1).toMatch(/^item-/)
+    expect(key2).toMatch(/^item-/)
+    expect(key1).not.toBe(key2)
+  })
+
+  it('should generate a unique key with custom prefix', () => {
+    const key1 = generateKey('section')
+    const key2 = generateKey('section')
+
+    expect(key1).toMatch(/^section-/)
+    expect(key2).toMatch(/^section-/)
+    expect(key1).not.toBe(key2)
+  })
+
+  it('should generate unique keys on rapid successive calls', () => {
+    const keys = Array.from({ length: 100 }, () => generateKey())
+    const uniqueKeys = new Set(keys)
+
+    expect(uniqueKeys.size).toBe(keys.length)
+  })
+})
+
+describe('ensureArrayKeys', () => {
+  it('should add _key to objects without one', () => {
+    const input = [{ name: 'Item 1' }, { name: 'Item 2' }]
+    const result = ensureArrayKeys(input)
+
+    expect(result[0]).toHaveProperty('_key')
+    expect(result[1]).toHaveProperty('_key')
+    expect(result[0]._key).toMatch(/^item-/)
+    expect(result[1]._key).toMatch(/^item-/)
+    expect(result[0]._key).not.toBe(result[1]._key)
+  })
+
+  it('should preserve existing _key values', () => {
+    const input = [{ name: 'Item 1', _key: 'existing-key' }, { name: 'Item 2' }]
+    const result = ensureArrayKeys(input)
+
+    expect(result[0]._key).toBe('existing-key')
+    expect(result[1]._key).toMatch(/^item-/)
+  })
+
+  it('should use custom prefix', () => {
+    const input = [{ name: 'Section 1' }]
+    const result = ensureArrayKeys(input, 'section')
+
+    expect(result[0]._key).toMatch(/^section-/)
+  })
+})
+
+describe('createReference', () => {
+  it('should create a reference object', () => {
+    const ref = createReference('doc-id-123')
+
+    expect(ref).toEqual({
+      _type: 'reference',
+      _ref: 'doc-id-123',
+    })
+  })
+})
+
+describe('createReferenceWithKey', () => {
+  it('should create a reference with _key', () => {
+    const ref = createReferenceWithKey('doc-id-123')
+
+    expect(ref._type).toBe('reference')
+    expect(ref._ref).toBe('doc-id-123')
+    expect(ref._key).toMatch(/^ref-/)
+  })
+
+  it('should use custom prefix for _key', () => {
+    const ref = createReferenceWithKey('doc-id-123', 'speaker')
+
+    expect(ref._type).toBe('reference')
+    expect(ref._ref).toBe('doc-id-123')
+    expect(ref._key).toMatch(/^speaker-/)
+  })
+
+  it('should generate unique keys for different references', () => {
+    const ref1 = createReferenceWithKey('doc-1')
+    const ref2 = createReferenceWithKey('doc-2')
+
+    expect(ref1._key).not.toBe(ref2._key)
+  })
+})

src/__mocks__/sponsor-data.ts

@@ -15,6 +15,7 @@ import type {
   ContractReadiness,
   MissingField,
 } from '@/lib/sponsor-crm/contract-readiness'
+import { nanoid } from 'nanoid'
 
 /**
  * Mock data factories for sponsor-related components in Storybook
@@ -24,7 +25,7 @@ export function mockContactPerson(
   overrides: Partial<ContactPerson> = {},
 ): ContactPerson {
   return {
-    _key: `contact-${Math.random().toString(36).substr(2, 9)}`,
+    _key: nanoid(),
     name: 'Jane Smith',
     email: 'jane.smith@example.com',
     phone: '+47 12 34 56 78',

src/components/admin/TicketPageContentEditor.tsx

@@ -17,6 +17,7 @@ import type {
   TicketFaq,
   ConferenceVanityMetric,
 } from '@/lib/conference/types'
+import { generateKey } from '@/lib/sanity/helpers'
 
 const ICON_OPTIONS = [
   { value: 'MicrophoneIcon', label: 'Microphone' },
@@ -41,10 +42,6 @@ const ICON_OPTIONS = [
   { value: 'CheckBadgeIcon', label: 'Check Badge' },
 ]
 
-function generateKey(): string {
-  return Math.random().toString(36).substring(2, 10)
-}
-
 interface TicketPageContentEditorProps {
   conferenceId: string
   conferenceTitle: string

src/components/admin/sponsor/SponsorContactEditor.stories.tsx

@@ -11,6 +11,7 @@ import {
 } from '@heroicons/react/24/outline'
 import { StarIcon as StarIconSolid } from '@heroicons/react/24/solid'
 import { CONTACT_ROLE_OPTIONS } from '@/lib/sponsor/types'
+import { nanoid } from 'nanoid'
 
 const meta = {
   title: 'Systems/Sponsors/Admin/Contacts/SponsorContactEditor',
@@ -68,7 +69,7 @@ function ContactEditorDemo() {
     setContacts([
       ...contacts,
       {
-        _key: String(Date.now()),
+        _key: nanoid(),
         name: '',
         email: '',
         phone: '',

src/components/sponsor/SponsorPortal.tsx

@@ -15,6 +15,7 @@ import {
 import { SponsorContactRoleSelect } from '@/components/admin/sponsor/SponsorContactRoleSelect'
 import { SponsorRegistrationLogoUpload } from '@/components/sponsor/SponsorRegistrationLogoUpload'
 import { formatNumber } from '@/lib/format'
+import { nanoid } from 'nanoid'
 
 interface ContactPersonForm {
   name: string
@@ -240,8 +241,8 @@ export function SponsorPortal({ token }: { token: string }) {
 
     const validContacts = contacts
       .filter((c) => c.name.trim() && c.email.trim())
-      .map((c, index) => ({
-        _key: `contact-${Date.now()}-${index}`,
+      .map((c) => ({
+        _key: nanoid(),
         name: c.name.trim(),
         email: c.email.trim(),
         phone: c.phone.trim() || undefined,

src/lib/sanity/helpers.ts

@@ -1,7 +1,8 @@
 import { Reference } from 'sanity'
+import { nanoid } from 'nanoid'
 
 export function generateKey(prefix: string = 'item'): string {
-  return `${prefix}-${Date.now()}-${Math.random().toString(36).substring(2, 11)}`
+  return `${prefix}-${nanoid()}`
 }
 
 export function ensureArrayKeys<T extends Record<string, unknown>>(

src/lib/sponsor-crm/contract-templates.ts

@@ -3,6 +3,7 @@ import {
   clientReadUncached as clientRead,
 } from '@/lib/sanity/client'
 import type { PortableTextBlock } from '@/lib/sponsor/types'
+import { nanoid } from 'nanoid'
 
 export interface ContractSection {
   _key: string
@@ -114,7 +115,6 @@ export async function createContractTemplate(
   data: ContractTemplateInput,
 ): Promise<{ template?: ContractTemplate; error?: Error }> {
   try {
-    let keyCounter = 0
     const doc = {
       _type: 'contractTemplate',
       title: data.title,
@@ -123,7 +123,7 @@ export async function createContractTemplate(
       language: data.language,
       currency: data.currency,
       sections: data.sections.map((s) => ({
-        _key: `section-${++keyCounter}`,
+        _key: nanoid(),
         heading: s.heading,
         body: s.body,
       })),
@@ -170,8 +170,8 @@ export async function updateContractTemplate(
     if (data.language !== undefined) updates.language = data.language
     if (data.currency !== undefined) updates.currency = data.currency
     if (data.sections !== undefined) {
-      updates.sections = data.sections.map((s, index) => ({
-        _key: s._key || `section-${Date.now()}-${index}`,
+      updates.sections = data.sections.map((s) => ({
+        _key: s._key || nanoid(),
         heading: s.heading,
         body: s.body,
       }))