javascript-commons/src/storages/__tests__/dataLoader.spec.ts at acfbc5bb73f3eba81fca9a20082cbe99530c4a3d · splitio/javascript-commons · GitHub

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
import { InMemoryStorageFactory } from '../inMemory/InMemoryStorage';
import { InMemoryStorageCSFactory } from '../inMemory/InMemoryStorageCS';
import { fullSettings } from '../../utils/settingsValidation/__tests__/settings.mocks';
import { loggerMock } from '../../logger/__tests__/sdkLogger.mock';
import { IRBSegment, ISplit } from '../../dtos/types';

import { validateRolloutPlan, setRolloutPlan } from '../setRolloutPlan';
import { getRolloutPlan } from '../getRolloutPlan';

const otherKey = 'otherKey';
const expectedRolloutPlan = {
  splitChanges: {
    ff: { d: [{ name: 'split1' }], t: 123, s: -1 },
    rbs: { d: [{ name: 'rbs1' }], t: 321, s: -1 }
  },
  memberships: {
    [fullSettings.core.key as string]: { ms: { k: [{ n: 'segment1' }] }, ls: { k: [] } },
    [otherKey]: { ms: { k: [{ n: 'segment1' }] }, ls: { k: [] } }
  },
  segmentChanges: [{
    name: 'segment1',
    added: [fullSettings.core.key as string, otherKey],
    removed: [],
    since: -1,
    till: 123
  }]
};

describe('validateRolloutPlan', () => {
  afterEach(() => {
    loggerMock.mockClear();
  });

  test('valid rollout plan and mode', () => {
    expect(validateRolloutPlan(loggerMock, { mode: 'standalone', initialRolloutPlan: expectedRolloutPlan } as any)).toEqual(expectedRolloutPlan);
    expect(loggerMock.error).not.toHaveBeenCalled();
  });

  test('invalid rollout plan', () => {
    expect(validateRolloutPlan(loggerMock, { mode: 'standalone', initialRolloutPlan: {} } as any)).toBeUndefined();
    expect(loggerMock.error).toHaveBeenCalledWith('storage: invalid rollout plan provided');
  });

  test('invalid mode', () => {
    expect(validateRolloutPlan(loggerMock, { mode: 'consumer', initialRolloutPlan: expectedRolloutPlan } as any)).toBeUndefined();
    expect(loggerMock.warn).toHaveBeenCalledWith('storage: initial rollout plan is ignored in consumer mode');
  });
});

describe('getRolloutPlan & setRolloutPlan (client-side)', () => {
  // @ts-expect-error Load server-side storage
  const serverStorage = InMemoryStorageFactory({ settings: fullSettings });
  serverStorage.splits.update([{ name: 'split1' } as ISplit], [], 123);
  serverStorage.rbSegments.update([{ name: 'rbs1' } as IRBSegment], [], 321);
  serverStorage.segments.update('segment1', [fullSettings.core.key as string, otherKey], [], 123);

  afterEach(() => {
    jest.clearAllMocks();
  });

  test('using preloaded data (no memberships, no segments)', () => {
    const rolloutPlan = getRolloutPlan(loggerMock, serverStorage);

    // @ts-expect-error Load client-side storage with preloaded data
    const clientStorage = InMemoryStorageCSFactory({ settings: fullSettings });
    setRolloutPlan(loggerMock, rolloutPlan, clientStorage, fullSettings.core.key as string);

    // Shared client storage
    const sharedClientStorage = clientStorage.shared!(otherKey);
    setRolloutPlan(loggerMock, rolloutPlan, { segments: sharedClientStorage.segments, largeSegments: sharedClientStorage.largeSegments }, otherKey);

    expect(clientStorage.segments.getRegisteredSegments()).toEqual([]);
    expect(sharedClientStorage.segments.getRegisteredSegments()).toEqual([]);

    // Get preloaded data from client-side storage
    expect(getRolloutPlan(loggerMock, clientStorage)).toEqual(rolloutPlan);
    expect(rolloutPlan).toEqual({ ...expectedRolloutPlan, memberships: undefined, segmentChanges: undefined });
  });

  test('using preloaded data with memberships', () => {
    const rolloutPlan = getRolloutPlan(loggerMock, serverStorage, { keys: [fullSettings.core.key as string, otherKey] });

    // @ts-expect-error Load client-side storage with preloaded data
    const clientStorage = InMemoryStorageCSFactory({ settings: fullSettings });
    setRolloutPlan(loggerMock, rolloutPlan, clientStorage, fullSettings.core.key as string);

    // Shared client storage
    const sharedClientStorage = clientStorage.shared!(otherKey);
    setRolloutPlan(loggerMock, rolloutPlan, { segments: sharedClientStorage.segments, largeSegments: sharedClientStorage.largeSegments }, otherKey);

    expect(clientStorage.segments.getRegisteredSegments()).toEqual(['segment1']);
    expect(sharedClientStorage.segments.getRegisteredSegments()).toEqual(['segment1']);

    // @TODO requires internal storage cache for `shared` storages
    // // Get preloaded data from client-side storage
    // expect(getRolloutPlan(loggerMock, clientStorage, { keys: [fullSettings.core.key as string, otherKey] })).toEqual(rolloutPlan);
    // expect(rolloutPlan).toEqual({ ...expectedRolloutPlan, segmentChanges: undefined });
  });

  test('using preloaded data with segments', () => {
    const rolloutPlan = getRolloutPlan(loggerMock, serverStorage, { exposeSegments: true });

    // @ts-expect-error Load client-side storage with preloaded data
    const clientStorage = InMemoryStorageCSFactory({ settings: fullSettings });
    setRolloutPlan(loggerMock, rolloutPlan, clientStorage, fullSettings.core.key as string);

    // Shared client storage
    const sharedClientStorage = clientStorage.shared!(otherKey);
    setRolloutPlan(loggerMock, rolloutPlan, { segments: sharedClientStorage.segments, largeSegments: sharedClientStorage.largeSegments }, otherKey);

    expect(clientStorage.segments.getRegisteredSegments()).toEqual(['segment1']);
    expect(sharedClientStorage.segments.getRegisteredSegments()).toEqual(['segment1']);

    expect(rolloutPlan).toEqual({ ...expectedRolloutPlan, memberships: undefined });
  });

  test('using preloaded data with memberships and segments', () => {
    const rolloutPlan = getRolloutPlan(loggerMock, serverStorage, { keys: [fullSettings.core.key as string], exposeSegments: true });

    // @ts-expect-error Load client-side storage with preloaded data
    const clientStorage = InMemoryStorageCSFactory({ settings: fullSettings });
    setRolloutPlan(loggerMock, rolloutPlan, clientStorage, fullSettings.core.key as string);

    // Shared client storage
    const sharedClientStorage = clientStorage.shared!(otherKey);
    setRolloutPlan(loggerMock, rolloutPlan, { segments: sharedClientStorage.segments, largeSegments: sharedClientStorage.largeSegments }, otherKey);

    expect(clientStorage.segments.getRegisteredSegments()).toEqual(['segment1']); // main client membership is set via the rollout plan `memberships` field
    expect(sharedClientStorage.segments.getRegisteredSegments()).toEqual(['segment1']); // shared client membership is set via the rollout plan `segmentChanges` field

    expect(rolloutPlan).toEqual({ ...expectedRolloutPlan, memberships: { [fullSettings.core.key as string]: expectedRolloutPlan.memberships![fullSettings.core.key as string] } });
  });
});