From 712f592fc93879698a79790c46f0eb9458473d31 Mon Sep 17 00:00:00 2001 From: Seth Silesky <5115498+silesky@users.noreply.github.com> Date: Mon, 22 Apr 2024 15:23:38 -0400 Subject: [PATCH] Update consent change event name (#1072) --- .changeset/twenty-waves-learn.md | 5 +++++ .../src/page-objects/base-page.ts | 2 +- .../src/tests/consent-tools-vanilla-opt-in.test.ts | 4 +++- .../src/tests/consent-tools-vanilla-opt-out.test.ts | 4 +++- .../src/domain/__tests__/create-wrapper.test.ts | 2 +- .../src/domain/analytics/__tests__/analytics-service.test.ts | 2 +- .../consent-tools/src/domain/analytics/analytics-service.ts | 4 ++-- packages/consent/consent-tools/src/types/settings.ts | 4 ++-- 8 files changed, 18 insertions(+), 9 deletions(-) create mode 100644 .changeset/twenty-waves-learn.md diff --git a/.changeset/twenty-waves-learn.md b/.changeset/twenty-waves-learn.md new file mode 100644 index 000000000..d33d4c4f4 --- /dev/null +++ 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 index b676e6c02..6f340b782 100644 --- 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/packages/consent/consent-tools-integration-tests/src/tests/consent-tools-vanilla-opt-in.test.ts b/packages/consent/consent-tools-integration-tests/src/tests/consent-tools-vanilla-opt-in.test.ts index 7aee1ce88..d73e343c8 100644 --- a/packages/consent/consent-tools-integration-tests/src/tests/consent-tools-vanilla-opt-in.test.ts +++ b/packages/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/packages/consent/consent-tools-integration-tests/src/tests/consent-tools-vanilla-opt-out.test.ts b/packages/consent/consent-tools-integration-tests/src/tests/consent-tools-vanilla-opt-out.test.ts index aa5ac764f..1fdc80d94 100644 --- a/packages/consent/consent-tools-integration-tests/src/tests/consent-tools-vanilla-opt-out.test.ts +++ b/packages/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 index 5e786af83..13a1fb43c 100644 --- 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 index e589a21cf..e32c18843 100644 --- 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 index cc07107e4..edcf2c0c8 100644 --- 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 index 639527d58..e352eeb39 100644 --- 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,