File size: 7,689 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 { act, render, renderHook, waitFor } from '@testing-library/react';
import React from 'react';
import createExPlatClientReactHelpers from '../index';
import type { ExPlatClient, ExperimentAssignment } from '@automattic/explat-client';
const validExperimentAssignment = {
experimentName: 'experiment_name_a',
variationName: 'treatment',
retrievedTimestamp: Date.now(),
ttl: 60,
};
const createMockExPlatClient = ( isDevelopmentMode = false ): ExPlatClient => ( {
loadExperimentAssignment: jest.fn(),
dangerouslyGetExperimentAssignment: jest.fn(),
dangerouslyGetMaybeLoadedExperimentAssignment: jest.fn( () => null ),
config: {
isDevelopmentMode,
logError: jest.fn(),
fetchExperimentAssignment: jest.fn(),
getAnonId: jest.fn(),
},
} );
const createControllablePromise = function < T >() {
let resOuter;
let rejOuter;
const promise = new Promise< T >( ( resolve, reject ) => {
resOuter = resolve;
rejOuter = reject;
} );
return {
resolve: resOuter as unknown as ( T ) => void,
reject: rejOuter as unknown as ( ...x: unknown[] ) => void,
promise,
};
};
describe( 'useExperiment', () => {
it( 'should correctly load an experiment assignment', async () => {
const exPlatClient = createMockExPlatClient();
const { useExperiment } = createExPlatClientReactHelpers( exPlatClient );
const controllablePromise1 = createControllablePromise< ExperimentAssignment >();
jest
.mocked( exPlatClient.loadExperimentAssignment )
.mockReturnValueOnce( controllablePromise1.promise );
const { result, rerender } = renderHook( () => useExperiment( 'experiment_a' ) );
expect( result.current ).toEqual( [ true, null ] );
expect( exPlatClient.loadExperimentAssignment ).toHaveBeenCalledTimes( 1 );
act( () => controllablePromise1.resolve( validExperimentAssignment ) );
jest
.mocked( exPlatClient.dangerouslyGetMaybeLoadedExperimentAssignment )
.mockReturnValue( validExperimentAssignment );
await waitFor( () => expect( result.current ).toEqual( [ true, null ] ) );
rerender();
expect( result.current ).toEqual( [ false, validExperimentAssignment ] );
rerender();
expect( result.current ).toEqual( [ false, validExperimentAssignment ] );
} );
it( 'should correctly load an experiment assignment respecting eligibility', async () => {
const exPlatClient = createMockExPlatClient();
const { useExperiment } = createExPlatClientReactHelpers( exPlatClient );
const controllablePromise1 = createControllablePromise< ExperimentAssignment >();
jest
.mocked( exPlatClient.loadExperimentAssignment )
.mockReturnValueOnce( controllablePromise1.promise );
let isEligible = false;
const { result, rerender } = renderHook( () =>
useExperiment( 'experiment_a', { isEligible } )
);
expect( result.current ).toEqual( [ false, null ] );
expect( exPlatClient.loadExperimentAssignment ).toHaveBeenCalledTimes( 0 );
isEligible = true;
rerender();
expect( result.current ).toEqual( [ true, null ] );
expect( exPlatClient.loadExperimentAssignment ).toHaveBeenCalledTimes( 1 );
jest
.mocked( exPlatClient.dangerouslyGetMaybeLoadedExperimentAssignment )
.mockReturnValue( validExperimentAssignment );
act( () => controllablePromise1.resolve( validExperimentAssignment ) );
await waitFor( () => expect( result.current ).toEqual( [ true, null ] ) );
rerender();
expect( result.current ).toEqual( [ false, validExperimentAssignment ] );
rerender();
expect( result.current ).toEqual( [ false, validExperimentAssignment ] );
isEligible = false;
rerender();
expect( result.current ).toEqual( [ false, null ] );
expect( exPlatClient.loadExperimentAssignment ).toHaveBeenCalledTimes( 1 );
} );
} );
describe( 'Experiment', () => {
it( 'should correctly show treatment after loading', async () => {
const exPlatClient = createMockExPlatClient();
const { Experiment } = createExPlatClientReactHelpers( exPlatClient );
const controllablePromise1 = createControllablePromise< ExperimentAssignment >();
jest
.mocked( exPlatClient.loadExperimentAssignment )
.mockReturnValueOnce( controllablePromise1.promise );
const { container, rerender } = render(
<Experiment
name="experiment_a"
treatmentExperience="treatment-1"
defaultExperience="default"
loadingExperience="loading-1"
/>
);
expect( container.textContent ).toBe( 'loading-1' );
rerender(
<Experiment
name="experiment_a"
treatmentExperience="treatment-1"
defaultExperience="default"
loadingExperience="loading-2"
/>
);
expect( container.textContent ).toBe( 'loading-2' );
jest
.mocked( exPlatClient.dangerouslyGetMaybeLoadedExperimentAssignment )
.mockReturnValue( validExperimentAssignment );
await act( async () => controllablePromise1.resolve( validExperimentAssignment ) );
await waitFor( () => expect( container.textContent ).toBe( 'treatment-1' ) );
rerender(
<Experiment
name="experiment_a"
treatmentExperience="treatment-2"
defaultExperience="default"
loadingExperience="loading-2"
/>
);
expect( container.textContent ).toBe( 'treatment-2' );
} );
it( 'should correctly show default after loading', async () => {
const exPlatClient = createMockExPlatClient();
const { Experiment } = createExPlatClientReactHelpers( exPlatClient );
const controllablePromise1 = createControllablePromise< ExperimentAssignment >();
jest
.mocked( exPlatClient.loadExperimentAssignment )
.mockReturnValueOnce( controllablePromise1.promise );
const { container, rerender } = render(
<Experiment
name="experiment_a"
treatmentExperience="treatment"
defaultExperience="default-1"
loadingExperience="loading"
/>
);
expect( container.textContent ).toBe( 'loading' );
const resolvedExperimentAssignment = { ...validExperimentAssignment, variationName: null };
jest
.mocked( exPlatClient.dangerouslyGetMaybeLoadedExperimentAssignment )
.mockReturnValue( resolvedExperimentAssignment );
await act( async () => controllablePromise1.resolve( resolvedExperimentAssignment ) );
await waitFor( () => expect( container.textContent ).toBe( 'default-1' ) );
rerender(
<Experiment
name="experiment_a"
treatmentExperience="treatment-2"
defaultExperience="default-2"
loadingExperience="loading-2"
/>
);
expect( container.textContent ).toBe( 'default-2' );
} );
} );
describe( 'ProvideExperimentData', () => {
it( 'should correctly provide data', async () => {
const exPlatClient = createMockExPlatClient();
const { ProvideExperimentData } = createExPlatClientReactHelpers( exPlatClient );
const controllablePromise1 = createControllablePromise< ExperimentAssignment >();
jest
.mocked( exPlatClient.loadExperimentAssignment )
.mockReturnValueOnce( controllablePromise1.promise );
const capture = jest.fn();
render(
<ProvideExperimentData name="experiment_a">
{ ( isLoading, experimentAssignment ) => (
<>{ capture( isLoading, experimentAssignment ) }</>
) }
</ProvideExperimentData>
);
expect( capture ).toHaveBeenCalledTimes( 1 );
expect( capture.mock.calls[ 0 ] ).toEqual( [ true, null ] );
capture.mockReset();
const experimentAssignment = { ...validExperimentAssignment, variationName: null };
jest
.mocked( exPlatClient.dangerouslyGetMaybeLoadedExperimentAssignment )
.mockReturnValue( experimentAssignment );
await act( async () => controllablePromise1.resolve( experimentAssignment ) );
await waitFor( () => {
expect( capture ).toHaveBeenCalledTimes( 1 );
} );
expect( capture.mock.calls[ 0 ] ).toEqual( [ false, experimentAssignment ] );
} );
} );
|