File size: 7,049 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 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 |
/**
* @jest-environment jsdom
*/
import {
retrieveExperimentAssignment,
storeExperimentAssignment,
removeExpiredExperimentAssignments,
localStorageExperimentAssignmentKeyPrefix,
localStorageExperimentAssignmentKey,
getAllLocalStorageKeys,
isLocalStorageExperimentAssignmentKey,
experimentNameFromLocalStorageExperimentAssignmentKey,
} from '../experiment-assignment-store';
import localStorage from '../local-storage';
import { validExperimentAssignment, validFallbackExperimentAssignment } from '../test-common';
beforeEach( () => {
localStorage.clear();
} );
describe( 'storeExperimentAssignment and retrieveExperimentAssignment', () => {
it( 'should save and retrieve valid ExperimentAssignments', () => {
expect( retrieveExperimentAssignment( validExperimentAssignment.experimentName ) ).toBe(
undefined
);
storeExperimentAssignment( validExperimentAssignment );
expect(
retrieveExperimentAssignment( validExperimentAssignment.experimentName )
).toStrictEqual( validExperimentAssignment );
expect( retrieveExperimentAssignment( validFallbackExperimentAssignment.experimentName ) ).toBe(
undefined
);
storeExperimentAssignment( validFallbackExperimentAssignment );
expect(
retrieveExperimentAssignment( validFallbackExperimentAssignment.experimentName )
).toStrictEqual( validFallbackExperimentAssignment );
} );
it( 'should throw for storing an ExperimentAssignment for a currently stored Experiment with an older date', () => {
storeExperimentAssignment( validFallbackExperimentAssignment );
expect(
retrieveExperimentAssignment( validFallbackExperimentAssignment.experimentName )
).toStrictEqual( validFallbackExperimentAssignment );
expect( () =>
storeExperimentAssignment( {
...validFallbackExperimentAssignment,
retrievedTimestamp: validFallbackExperimentAssignment.retrievedTimestamp - 1,
} )
).toThrowErrorMatchingInlineSnapshot(
'"Trying to store an older experiment assignment than is present in the store, likely a race condition."'
);
} );
it( 'should throw for storing an invalid ExperimentAssignment', () => {
expect( () =>
storeExperimentAssignment( {
...validFallbackExperimentAssignment,
experimentName: undefined,
} )
).toThrowErrorMatchingInlineSnapshot( '"Invalid ExperimentAssignment"' );
} );
} );
describe( 'getAllLocalStorageKeys', () => {
it( 'should return an empty array if there are no stored keys', () => {
expect( getAllLocalStorageKeys().length ).toBe( 0 );
} );
it( 'should return an array of all of the stored keys', () => {
const keys = [ 'key1', 'key2', 'key3', 'key4', 'key5' ];
keys.map( ( key ) => localStorage.setItem( key, 'test value' ) );
const result = getAllLocalStorageKeys();
expect( result ).toStrictEqual( keys );
} );
} );
describe( 'isLocalStorageExperimentAssignmentKey', () => {
it( 'should return false if key is an empty string', () => {
expect( isLocalStorageExperimentAssignmentKey( '' ) ).toBe( false );
} );
it( 'should return false if key is shorter than the experiment assignment key prefix', () => {
expect(
isLocalStorageExperimentAssignmentKey(
localStorageExperimentAssignmentKeyPrefix.slice( 0, -1 )
)
).toBe( false );
} );
it( 'should return true if key is the same as the experiment assignment key prefix', () => {
expect(
isLocalStorageExperimentAssignmentKey( localStorageExperimentAssignmentKeyPrefix )
).toBe( true );
} );
it( 'should return true if key starts with the experiment assignment key prefix', () => {
expect(
isLocalStorageExperimentAssignmentKey(
localStorageExperimentAssignmentKeyPrefix + 'an-experiment'
)
).toBe( true );
} );
} );
describe( 'experimentNameFromLocalStorageExperimentAssignmentKey', () => {
it( 'should return the experiment name if it begins with the experiment assignment key prefix', () => {
const experimentName = 'test1';
const key = `${ localStorageExperimentAssignmentKeyPrefix }-${ experimentName }`;
expect( experimentNameFromLocalStorageExperimentAssignmentKey( key ) ).toBe( experimentName );
} );
it( 'should return an empty string if the key is shorter than the experiment assignment key prefix', () => {
expect( experimentNameFromLocalStorageExperimentAssignmentKey( 'a' ) ).toBe( '' );
expect( experimentNameFromLocalStorageExperimentAssignmentKey( '' ) ).toBe( '' );
} );
} );
describe( 'removeExpiredExperimentAssignments', () => {
it( 'should remove all stored ExperimentAssignments that are past their ttl', () => {
storeExperimentAssignment( {
...validExperimentAssignment,
retrievedTimestamp: Date.now() - 1000 * 60,
} );
storeExperimentAssignment( {
...validExperimentAssignment,
experimentName: 'experiment2',
retrievedTimestamp: Date.now() - 1000 * 61,
} );
storeExperimentAssignment( {
...validExperimentAssignment,
experimentName: 'experiment3',
retrievedTimestamp: Date.now() - 1000 * 65,
} );
removeExpiredExperimentAssignments();
expect( localStorage.length ).toBe( 0 );
storeExperimentAssignment( {
...validExperimentAssignment,
experimentName: 'experiment4',
retrievedTimestamp: Date.now() - 1000 * 60,
} );
storeExperimentAssignment( validExperimentAssignment );
removeExpiredExperimentAssignments();
expect( localStorage.length ).toBe( 1 );
} );
it( 'should remove all stored ExperimentAssignments that are invalid', () => {
const invalidExperimentAssignments = [
{
...validExperimentAssignment,
experimentName: undefined,
},
{
...validFallbackExperimentAssignment,
experimentName: null,
},
{
...validExperimentAssignment,
experimentName: 42,
},
{
...validExperimentAssignment,
variationName: undefined,
},
{
...validFallbackExperimentAssignment,
variationName: 0,
},
{
...validExperimentAssignment,
retrievedTimestamp: undefined,
},
{
...validFallbackExperimentAssignment,
retrievedTimestamp: 'string',
},
{
...validExperimentAssignment,
ttl: undefined,
},
{
...validExperimentAssignment,
ttl: 'string',
},
{
...validFallbackExperimentAssignment,
ttl: 0,
},
];
localStorage.setItem(
localStorageExperimentAssignmentKey( 'invalid-experiment1' ),
JSON.stringify( invalidExperimentAssignments[ 0 ] )
);
removeExpiredExperimentAssignments();
expect( localStorage.length ).toBe( 0 );
invalidExperimentAssignments.map( ( experiment, index ) => {
localStorage.setItem(
localStorageExperimentAssignmentKey( `invalid-experiment${ index }` ),
JSON.stringify( experiment )
);
} );
removeExpiredExperimentAssignments();
expect( localStorage.length ).toBe( 0 );
localStorage.clear();
localStorage.setItem(
localStorageExperimentAssignmentKey( 'invalid-experiment2' ),
JSON.stringify( invalidExperimentAssignments[ 1 ] )
);
storeExperimentAssignment( validExperimentAssignment );
removeExpiredExperimentAssignments();
expect( localStorage.length ).toBe( 1 );
} );
} );
|