Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: fix unexposure events not deduped by integration #151

Merged
merged 1 commit into from
Dec 27, 2024
Merged

fix: fix unexposure events not deduped by integration #151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions packages/experiment-browser/src/integration/manager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,10 +126,14 @@ export class IntegrationManager {
export class SessionDedupeCache {
private readonly storageKey: string;
private readonly isSessionStorageAvailable = isSessionStorageAvailable();
private inMemoryCache: Record<string, string> = {};
private inMemoryCache: Record<string, Exposure> = {};

constructor(instanceName: string) {
this.storageKey = `EXP_sent_${instanceName}`;
this.storageKey = `EXP_sent_v2_${instanceName}`;
// Remove previous version of storage if it exists.
if (isSessionStorageAvailable) {
safeGlobal.sessionStorage.removeItem(`EXP_sent_${instanceName}`);
}
}

shouldTrack(exposure: Exposure): boolean {
Expand All @@ -138,11 +142,11 @@ export class SessionDedupeCache {
return true;
}
this.loadCache();
const value = this.inMemoryCache[exposure.flag_key];
const cachedExposure = this.inMemoryCache[exposure.flag_key];
let shouldTrack = false;
if (!value) {
if (!cachedExposure || cachedExposure.variant !== exposure.variant) {
shouldTrack = true;
this.inMemoryCache[exposure.flag_key] = exposure.variant;
this.inMemoryCache[exposure.flag_key] = exposure;
}
this.storeCache();
return shouldTrack;
Expand Down
91 changes: 80 additions & 11 deletions packages/experiment-browser/test/integration/manager.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import { ExperimentEvent } from 'src/types/plugin';
describe('IntegrationManager', () => {
let manager: IntegrationManager;
beforeEach(() => {
safeGlobal.sessionStorage.clear();
safeGlobal.localStorage.clear();
const config = { test: 'config' } as ExperimentConfig;
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
Expand Down Expand Up @@ -199,17 +200,81 @@ describe('IntegrationManager', () => {
},
});
});
test('un exposure is deduped', () => {
manager.track({ flag_key: 'flag-key' });
manager.track({ flag_key: 'flag-key' });
manager.track({ flag_key: 'flag-key' });
expect(manager['queue']['inMemoryQueue'].length).toEqual(1);
expect(manager['queue']['inMemoryQueue'][0]).toEqual({
eventType: '$exposure',
eventProperties: {
flag_key: 'flag-key',
},
});
});
test('different variant values for same key are all tracked', () => {
manager.track({ flag_key: 'flag-key' });
manager.track({ flag_key: 'flag-key', variant: 'control' });
manager.track({ flag_key: 'flag-key' });
manager.track({ flag_key: 'flag-key', variant: 'control' });
manager.track({ flag_key: 'flag-key', variant: 'treatment' });
expect(manager['queue']['inMemoryQueue'].length).toEqual(5);
expect(manager['queue']['inMemoryQueue'][0]).toEqual({
eventType: '$exposure',
eventProperties: {
flag_key: 'flag-key',
},
});
expect(manager['queue']['inMemoryQueue'][1]).toEqual({
eventType: '$exposure',
eventProperties: {
flag_key: 'flag-key',
variant: 'control',
},
});
expect(manager['queue']['inMemoryQueue'][2]).toEqual({
eventType: '$exposure',
eventProperties: {
flag_key: 'flag-key',
},
});
expect(manager['queue']['inMemoryQueue'][3]).toEqual({
eventType: '$exposure',
eventProperties: {
flag_key: 'flag-key',
variant: 'control',
},
});
expect(manager['queue']['inMemoryQueue'][4]).toEqual({
eventType: '$exposure',
eventProperties: {
flag_key: 'flag-key',
variant: 'treatment',
},
});
});
});
});

describe('SessionDedupeCache', () => {
beforeEach(() => {
safeGlobal.sessionStorage.setItem(
'EXP_sent_$default_instance',
`{"flag-key":"variant"}`,
);
safeGlobal.sessionStorage.clear();
});
test('old storage is cleared', () => {
const instanceName = '$default_instance';
new SessionDedupeCache(instanceName);
expect(
safeGlobal.sessionStorage.getItem('EXP_sent_$default_instance'),
).toBeNull();
});
test('test storage key', () => {
const instanceName = '$default_instance';
const cache = new SessionDedupeCache(instanceName);
expect(cache['storageKey']).toEqual('EXP_sent_$default_instance');
expect(cache['storageKey']).toEqual('EXP_sent_v2_$default_instance');
});
test('should track with empty storage returns true, sets storage', () => {
const instanceName = '$default_instance';
Expand All @@ -222,7 +287,7 @@ describe('SessionDedupeCache', () => {
const storedCache = JSON.parse(
safeGlobal.sessionStorage.getItem(cache['storageKey']),
);
const expected = { 'flag-key': 'on' };
const expected = { 'flag-key': exposure };
expect(storedCache).toEqual(expected);
expect(cache['inMemoryCache']).toEqual(expected);
});
Expand All @@ -234,14 +299,14 @@ describe('SessionDedupeCache', () => {
variant: 'on',
};
safeGlobal.sessionStorage.setItem(
'EXP_sent_$default_instance',
JSON.stringify({ [`${exposure.flag_key}`]: exposure.variant }),
cache['storageKey'],
JSON.stringify({ [`${exposure.flag_key}`]: exposure }),
);
expect(cache.shouldTrack(exposure)).toEqual(false);
const storedCache = JSON.parse(
safeGlobal.sessionStorage.getItem('EXP_sent_$default_instance'),
safeGlobal.sessionStorage.getItem(cache['storageKey']),
);
const expected = { 'flag-key': 'on' };
const expected = { 'flag-key': exposure };
expect(storedCache).toEqual(expected);
expect(cache['inMemoryCache']).toEqual(expected);
});
Expand All @@ -252,17 +317,21 @@ describe('SessionDedupeCache', () => {
flag_key: 'flag-key',
variant: 'on',
};
const exposure2 = {
flag_key: 'flag-key-2',
variant: 'on',
};
safeGlobal.sessionStorage.setItem(
'EXP_sent_$default_instance',
JSON.stringify({ [`${exposure.flag_key}-2`]: exposure.variant }),
cache['storageKey'],
JSON.stringify({ [exposure2.flag_key]: exposure2 }),
);
expect(cache.shouldTrack(exposure)).toEqual(true);
const storedCache = JSON.parse(
safeGlobal.sessionStorage.getItem('EXP_sent_$default_instance'),
safeGlobal.sessionStorage.getItem(cache['storageKey']),
);
const expected = {
'flag-key': 'on',
'flag-key-2': 'on',
'flag-key': exposure,
'flag-key-2': exposure2,
};
expect(storedCache).toEqual(expected);
expect(cache['inMemoryCache']).toEqual(expected);
Expand Down
Loading