Update consent change event name (#1072)

segmentio · Apr 22, 2024 · 712f592 · 712f592
1 parent a102cbb
commit 712f592
Show file tree

Hide file tree

Showing 8 changed files with 18 additions and 9 deletions.
diff --git a/.changeset/twenty-waves-learn.md b/.changeset/twenty-waves-learn.md
@@ -0,0 +1,5 @@
+---
+'@segment/analytics-consent-tools': patch
+---
+
+Update consent change event name
diff --git a/packages/consent/consent-tools-integration-tests/src/page-objects/base-page.ts b/packages/consent/consent-tools-integration-tests/src/page-objects/base-page.ts
@@ -40,7 +40,7 @@ export abstract class BasePage {
   getConsentChangedEvents(): SegmentEvent[] {
     const reqBodies = this.getAllTrackingEvents()
     const consentEvents = reqBodies.filter(
-      (el) => el.event === 'Segment Consent Preference'
+      (el) => el.event === 'Segment Consent Preference Updated'
     )
     return consentEvents
   }

diff --git a/...es/consent/consent-tools-integration-tests/src/tests/consent-tools-vanilla-opt-in.test.ts b/...es/consent/consent-tools-integration-tests/src/tests/consent-tools-vanilla-opt-in.test.ts
@@ -37,7 +37,9 @@ it('should send a track call after waiting for explicit consent', async () => {
 
   const consentChangeEvents = page.getConsentChangedEvents()
   expect(consentChangeEvents.length).toBe(1)
-  expect(consentChangeEvents[0].event).toEqual('Segment Consent Preference')
+  expect(consentChangeEvents[0].event).toEqual(
+    'Segment Consent Preference Updated'
+  )
 
   await browser.waitUntil(() => page.fetchIntegrationReqs.length, {
     timeout: 20000,

diff --git a/...s/consent/consent-tools-integration-tests/src/tests/consent-tools-vanilla-opt-out.test.ts b/...s/consent/consent-tools-integration-tests/src/tests/consent-tools-vanilla-opt-out.test.ts
@@ -44,7 +44,9 @@ it('should not wait for consent before sending track call', async () => {
   })
   consentChangeEvents = page.getConsentChangedEvents()
   expect(consentChangeEvents.length).toBe(1)
-  expect(consentChangeEvents[0].event).toEqual('Segment Consent Preference')
+  expect(consentChangeEvents[0].event).toEqual(
+    'Segment Consent Preference Updated'
+  )
   await browser.execute(() => {
     return window.analytics.track('sup')
   })

diff --git a/packages/consent/consent-tools/src/domain/__tests__/create-wrapper.test.ts b/packages/consent/consent-tools/src/domain/__tests__/create-wrapper.test.ts
@@ -554,7 +554,7 @@ describe(createWrapper, () => {
 
       // if OnConsentChanged callback is called with categories, it should send event
       expect(analyticsTrackSpy).toBeCalledWith(
-        'Segment Consent Preference',
+        'Segment Consent Preference Updated',
         undefined,
         { consent: { categoryPreferences: { C0001: true, C0002: false } } }
       )

diff --git a/packages/consent/consent-tools/src/domain/analytics/__tests__/analytics-service.test.ts b/packages/consent/consent-tools/src/domain/analytics/__tests__/analytics-service.test.ts
@@ -496,7 +496,7 @@ describe(AnalyticsService, () => {
       const mockCategories = { C0001: true, C0002: false }
       analyticsService.consentChange(mockCategories)
       expect(analyticsMock.track).toBeCalledWith(
-        'Segment Consent Preference',
+        'Segment Consent Preference Updated',
         undefined,
         { consent: { categoryPreferences: mockCategories } }
       )

diff --git a/packages/consent/consent-tools/src/domain/analytics/analytics-service.ts b/packages/consent/consent-tools/src/domain/analytics/analytics-service.ts
@@ -165,7 +165,7 @@ export class AnalyticsService {
    * ```ts
    * {
    * "type": "track",
-   *  "event": "Segment Consent Preference",
+   *  "event": "Segment Consent Preference Updated",
    *  "context": {
    *    "consent": {
    *      "categoryPreferences" : {
@@ -184,7 +184,7 @@ export class AnalyticsService {
       // not sure if there's a better way to handle this
       return console.error(e)
     }
-    const CONSENT_CHANGED_EVENT = 'Segment Consent Preference'
+    const CONSENT_CHANGED_EVENT = 'Segment Consent Preference Updated'
     this.analytics.track(CONSENT_CHANGED_EVENT, undefined, {
       consent: { categoryPreferences: categories },
     })

diff --git a/packages/consent/consent-tools/src/types/settings.ts b/packages/consent/consent-tools/src/types/settings.ts
@@ -64,7 +64,7 @@ export interface CreateWrapperSettings {
   getCategories: GetCategoriesFunction
 
   /**
-   * Function to register a listener for consent changes to programatically send a "Segment Consent Preference" event to Segment when consent preferences change.
+   * Function to register a listener for consent changes to programatically send a "Segment Consent Preference Updated" event to Segment when consent preferences change.
    *
    * #### Note: The callback requires the categories to be in the shape of { "C0001": true, "C0002": false }, so some normalization may be needed.
    * @example
@@ -77,7 +77,7 @@ export interface CreateWrapperSettings {
    * /* event payload
    * {
    *  "type": "track",
-   *  "event": "Segment Consent Preference",
+   *  "event": "Segment Consent Preference Updated",
    *  "context": {
    *    "consent": {
    *      "version": 2,