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

feat: Web Experiment - Support persistent preview mode for multi page apps #148

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: Web Experiment - Support persistent preview mode for multi page apps #148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
902c4b3
feat: support persistent preview mode for multi page apps
tyiuhc Dec 18, 2024
20e1a7c
add unit tests
tyiuhc Dec 18, 2024
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
73 changes: 53 additions & 20 deletions packages/experiment-tag/src/experiment.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,32 +75,65 @@ export const initializeExperiment = (apiKey: string, initialFlags: string) => {
);
return;
}
// force variant if in preview mode
if (urlParams['PREVIEW']) {
const parsedFlags = JSON.parse(initialFlags);

let sessionStoragePreview = {};
try {
sessionStoragePreview = JSON.parse(
globalScope.sessionStorage.getItem(`${experimentStorageName}_PREVIEW`) ||
'{}',
);
} catch {
// do nothing
}

// Determine if the app is in preview mode
const isPreviewMode =
urlParams['PREVIEW'] === 'true' ||
Object.keys(sessionStoragePreview).length > 0;

if (isPreviewMode) {
const flagToVariant: Record<string, string> = {};
const parsedFlags = JSON.parse(initialFlags); // Parse the initial flags for evaluation

parsedFlags.forEach((flag: EvaluationFlag) => {
if (flag.key in urlParams && urlParams[flag.key] in flag.variants) {
// Strip the preview query param
globalScope.history.replaceState(
{},
'',
removeQueryParams(globalScope.location.href, ['PREVIEW', flag.key]),
);
// Check if the flag key has a valid variant in either URL params or session storage
const variant = urlParams[flag.key] || sessionStoragePreview[flag.key];

// Keep page targeting segments
const pageTargetingSegments = flag.segments.filter((segment) =>
isPageTargetingSegment(segment),
);
if (variant && variant in flag.variants) {
flagToVariant[flag.key] = variant;

// Create or update the preview segment
const previewSegment = {
metadata: { segmentName: 'preview' },
variant: urlParams[flag.key],
};
// Filter the existing segments to keep only page-targeting ones
const pageTargetingSegments = flag.segments.filter(
isPageTargetingSegment,
);

flag.segments = [...pageTargetingSegments, previewSegment];
// Add a new preview segment with the forced variant
flag.segments = [
...pageTargetingSegments,
{ metadata: { segmentName: 'preview' }, variant },
];
}
});

// If preview mode was initiated via URL, store the preview state in session storage
if (urlParams['PREVIEW'] === 'true') {
globalScope.sessionStorage?.setItem(
`${experimentStorageName}_PREVIEW`,
JSON.stringify(flagToVariant),
);

// Remove the preview-related query parameters from the URL
globalScope.history.replaceState(
{},
'',
removeQueryParams(globalScope.location.href, [
'PREVIEW',
...Object.keys(flagToVariant),
]),
);
}

// Update `initialFlags` with the modified flags
initialFlags = JSON.stringify(parsedFlags);
}

Expand Down
128 changes: 128 additions & 0 deletions packages/experiment-tag/test/experiment.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -736,6 +736,134 @@ describe('initializeExperiment', () => {
);
expect(mockExposure).not.toHaveBeenCalled();
});

test('preview - should set sessionStorage', () => {
const mockGlobal = {
localStorage: {
getItem: jest.fn().mockReturnValue(undefined),
setItem: jest.fn(),
},
sessionStorage: {
setItem: jest.fn(),
},
location: {
href: 'http://test.com/2',
replace: jest.fn(),
search: '?test=treatment&PREVIEW=true',
},
document: { referrer: '' },
history: { replaceState: jest.fn() },
};
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
mockGetGlobalScope.mockReturnValue(mockGlobal);

initializeExperiment(
'session',
JSON.stringify([
{
key: 'test',
metadata: {
deployed: true,
evaluationMode: 'local',
flagType: 'experiment',
deliveryMethod: 'web',
},
segments: [],
variants: {
control: {
key: 'control',
payload: [],
value: 'control',
},
off: {
key: 'off',
metadata: {
default: true,
},
},
treatment: {
key: 'treatment',
payload: [],
value: 'treatment',
},
},
},
]),
);

expect(mockGlobal.sessionStorage.setItem).toHaveBeenCalledWith(
'EXP_session_PREVIEW',
JSON.stringify({ test: 'treatment' }),
);
});

test('preview - sessionStorage persistence', () => {
const mockGlobal = {
localStorage: {
getItem: jest.fn().mockReturnValue(undefined),
setItem: jest.fn(),
},
sessionStorage: {
getItem: jest
.fn()
.mockReturnValue(JSON.stringify({ test: 'treatment' })),
},
location: {
href: 'http://test.com/2',
replace: jest.fn(),
},
document: { referrer: '' },
history: { replaceState: jest.fn() },
};
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
mockGetGlobalScope.mockReturnValue(mockGlobal);

initializeExperiment(
'session_persistence',
JSON.stringify([
{
key: 'test',
metadata: {
deployed: true,
evaluationMode: 'local',
flagType: 'experiment',
deliveryMethod: 'web',
},
segments: [
{
metadata: {
segmentName: 'All Other Users',
},
variant: 'off',
},
],
variants: {
control: {
key: 'control',
payload: [],
value: 'control',
},
off: {
key: 'off',
metadata: {
default: true,
trackExposure: false,
},
},
treatment: {
key: 'treatment',
payload: [],
value: 'treatment',
},
},
},
]),
);

expect(mockExposure).toHaveBeenCalledWith('test');
});
});

test('feature experiment on global Experiment object', () => {
Expand Down
Loading