File size: 3,126 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 |
import * as ExperimentAssignments from './experiment-assignments';
import localStorage from './local-storage';
import * as Validations from './validations';
import type { ExperimentAssignment } from '../types';
/**
* Exported for testing purposes only.
*/
export const localStorageExperimentAssignmentKeyPrefix = 'explat-experiment-';
/**
* Exported for testing purposes only.
*/
export const localStorageExperimentAssignmentKey = ( experimentName: string ): string =>
`${ localStorageExperimentAssignmentKeyPrefix }-${ experimentName }`;
/**
* Store an ExperimentAssignment.
* @param experimentAssignment The ExperimentAssignment
*/
export function storeExperimentAssignment( experimentAssignment: ExperimentAssignment ): void {
Validations.validateExperimentAssignment( experimentAssignment );
const previousExperimentAssignment = retrieveExperimentAssignment(
experimentAssignment.experimentName
);
if (
previousExperimentAssignment &&
experimentAssignment.retrievedTimestamp < previousExperimentAssignment.retrievedTimestamp
) {
throw new Error(
'Trying to store an older experiment assignment than is present in the store, likely a race condition.'
);
}
localStorage.setItem(
localStorageExperimentAssignmentKey( experimentAssignment.experimentName ),
JSON.stringify( experimentAssignment )
);
}
/**
* Retrieve an ExperimentAssignment.
* @param experimentName The experiment name.
*/
export function retrieveExperimentAssignment(
experimentName: string
): ExperimentAssignment | undefined {
const maybeExperimentAssignmentJson = localStorage.getItem(
localStorageExperimentAssignmentKey( experimentName )
);
if ( ! maybeExperimentAssignmentJson ) {
return undefined;
}
return Validations.validateExperimentAssignment( JSON.parse( maybeExperimentAssignmentJson ) );
}
const range = ( i: number ) => [ ...Array( i ).keys() ];
/**
* Exported for testing purposes only.
*/
export function getAllLocalStorageKeys(): string[] {
return range( localStorage.length ).map( ( i ) => localStorage.key( i ) as string );
}
/**
* Exported for testing purposes only.
*/
export function isLocalStorageExperimentAssignmentKey( key: string ): boolean {
return key.startsWith( localStorageExperimentAssignmentKeyPrefix );
}
/**
* Exported for testing purposes only.
*/
export function experimentNameFromLocalStorageExperimentAssignmentKey( key: string ): string {
return key.slice( localStorageExperimentAssignmentKeyPrefix.length + 1 );
}
/**
* Removes all expired and invalid experiment assignments in LocalStorage.
*/
export function removeExpiredExperimentAssignments(): void {
getAllLocalStorageKeys()
.filter( isLocalStorageExperimentAssignmentKey )
.map( experimentNameFromLocalStorageExperimentAssignmentKey )
.filter( ( experimentName ) => {
try {
if (
ExperimentAssignments.isAlive(
retrieveExperimentAssignment( experimentName ) as ExperimentAssignment
)
) {
return false;
}
} catch ( _ ) {}
return true;
} )
.map( localStorageExperimentAssignmentKey )
.map( ( key ) => localStorage.removeItem( key ) );
}
|