Skip to content

Commit

Permalink
Ensure user traits set before opting in to participate in metametrics…
Browse files Browse the repository at this point in the history
… get properly updated upon participate in metametrics
  • Loading branch information
danjm committed Jan 23, 2025
1 parent 64e2c3f commit 4fa4265
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions app/scripts/controllers/metametrics-controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,10 @@ const controllerMetadata = {
persist: true,
anonymous: false,
},
userTraitsBeforeMetricsOptIn: {
persist: true,
anonymous: false,
},
traits: {
persist: true,
anonymous: false,
Expand Down Expand Up @@ -248,6 +252,7 @@ export type MetaMetricsControllerState = {
latestNonAnonymousEventTimestamp: number;
fragments: Record<string, MetaMetricsEventFragment>;
eventsBeforeMetricsOptIn: MetaMetricsEventPayload[];
userTraitsBeforeMetricsOptIn: MetaMetricsUserTraits[];
traits: MetaMetricsUserTraits;
previousUserTraits?: MetaMetricsUserTraits;
dataCollectionForMarketing: boolean | null;
Expand Down Expand Up @@ -335,6 +340,7 @@ export const getDefaultMetaMetricsControllerState =
marketingCampaignCookieId: null,
latestNonAnonymousEventTimestamp: 0,
eventsBeforeMetricsOptIn: [],
userTraitsBeforeMetricsOptIn: [],
traits: {},
previousUserTraits: {},
fragments: {},
Expand Down Expand Up @@ -754,6 +760,11 @@ export default class MetaMetricsController extends BaseController<
identify(userTraits: Partial<MetaMetricsUserTraits>): void {
const { metaMetricsId, participateInMetaMetrics } = this.state;

if (participateInMetaMetrics === null && metaMetricsId === null ) {

Check failure on line 763 in app/scripts/controllers/metametrics-controller.ts

View workflow job for this annotation

GitHub Actions / Test lint / Test lint

Delete `·`
this.addUserTraitsBeforeMetricsOptIn(userTraits);
return;
}

if (!participateInMetaMetrics || !metaMetricsId || !userTraits) {
return;
}
Expand Down Expand Up @@ -820,6 +831,7 @@ export default class MetaMetricsController extends BaseController<

if (participateInMetaMetrics) {
this.trackEventsAfterMetricsOptIn();
this.trackUserTraitsAfterMetricsOptIn();
this.clearEventsAfterMetricsOptIn();
} else if (this.state.marketingCampaignCookieId) {
this.setMarketingCampaignCookieId(null);
Expand Down Expand Up @@ -1019,6 +1031,13 @@ export default class MetaMetricsController extends BaseController<
});
}

trackUserTraitsAfterMetricsOptIn(): void {
const { userTraitsBeforeMetricsOptIn } = this.state;
userTraitsBeforeMetricsOptIn.forEach((userTraitBeforeMetricsOptIn) => {
this.#identify(userTraitBeforeMetricsOptIn);
});
}

// Once we track queued events after a user opts into metrics, we want to clear the event queue.
clearEventsAfterMetricsOptIn(): void {
this.update((state) => {
Expand All @@ -1033,6 +1052,12 @@ export default class MetaMetricsController extends BaseController<
});
}

addUserTraitsBeforeMetricsOptIn(userTraits: MetaMetricsUserTraits): void {
this.update((state) => {
state.userTraitsBeforeMetricsOptIn.push(userTraits);
});
}

// Add or update traits for tracking.
updateTraits(newTraits: MetaMetricsUserTraits): void {
this.update((state) => {
Expand Down

0 comments on commit 4fa4265

Please sign in to comment.