Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: stabilize global frontend api cache (#6466)
- Loading branch information
Showing
7 changed files
with
226 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
import { IFeatureToggleClient } from '../types'; | ||
|
||
export interface IClientFeatureToggleReadModel { | ||
getClient(): Promise<Record<string, IFeatureToggleClient[]>>; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
import { IFeatureToggleClient } from '../types'; | ||
import { IClientFeatureToggleReadModel } from './client-feature-toggle-read-model-type'; | ||
|
||
export default class FakeClientFeatureToggleReadModel | ||
implements IClientFeatureToggleReadModel | ||
{ | ||
constructor(private value: Record<string, IFeatureToggleClient[]>) {} | ||
|
||
getClient(): Promise<Record<string, IFeatureToggleClient[]>> { | ||
return Promise.resolve(this.value); | ||
} | ||
|
||
setValue(value: Record<string, IFeatureToggleClient[]>) { | ||
this.value = value; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,169 @@ | ||
import { | ||
GlobalFrontendApiCache, | ||
GlobalFrontendApiCacheState, | ||
} from './global-frontend-api-cache'; | ||
import noLogger from '../../test/fixtures/no-logger'; | ||
import { FakeSegmentReadModel } from '../features/segment/fake-segment-read-model'; | ||
import FakeClientFeatureToggleReadModel from './fake-client-feature-toggle-read-model'; | ||
import EventEmitter from 'events'; | ||
import { IApiUser, IFeatureToggleClient, ISegment } from '../types'; | ||
import { UPDATE_REVISION } from '../features/feature-toggle/configuration-revision-service'; | ||
|
||
const state = async ( | ||
cache: GlobalFrontendApiCache, | ||
state: GlobalFrontendApiCacheState, | ||
) => { | ||
await new Promise((resolve) => { | ||
cache.on(state, () => { | ||
resolve('done'); | ||
}); | ||
}); | ||
}; | ||
|
||
const defaultFeature: IFeatureToggleClient = { | ||
name: 'featureA', | ||
enabled: true, | ||
strategies: [], | ||
variants: [], | ||
project: 'projectA', | ||
dependencies: [], | ||
type: 'release', | ||
stale: false, | ||
description: '', | ||
}; | ||
const defaultSegment = { name: 'segment', id: 1 } as ISegment; | ||
|
||
const createCache = ( | ||
segment: ISegment = defaultSegment, | ||
features: Record<string, IFeatureToggleClient[]> = {}, | ||
) => { | ||
const config = { getLogger: noLogger }; | ||
const segmentReadModel = new FakeSegmentReadModel([segment as ISegment]); | ||
const clientFeatureToggleReadModel = new FakeClientFeatureToggleReadModel( | ||
features, | ||
); | ||
const configurationRevisionService = new EventEmitter(); | ||
const cache = new GlobalFrontendApiCache( | ||
config, | ||
segmentReadModel, | ||
clientFeatureToggleReadModel, | ||
configurationRevisionService, | ||
); | ||
|
||
return { | ||
cache, | ||
configurationRevisionService, | ||
clientFeatureToggleReadModel, | ||
}; | ||
}; | ||
|
||
test('Can read initial segment', async () => { | ||
const { cache } = createCache({ name: 'segment', id: 1 } as ISegment); | ||
|
||
const segmentBeforeRead = cache.getSegment(1); | ||
expect(segmentBeforeRead).toEqual(undefined); | ||
|
||
await state(cache, 'ready'); | ||
|
||
const segment = cache.getSegment(1); | ||
expect(segment).toEqual({ name: 'segment', id: 1 }); | ||
}); | ||
|
||
test('Can read initial features', async () => { | ||
const { cache } = createCache(defaultSegment, { | ||
development: [ | ||
{ | ||
...defaultFeature, | ||
name: 'featureA', | ||
enabled: true, | ||
project: 'projectA', | ||
}, | ||
{ | ||
...defaultFeature, | ||
name: 'featureB', | ||
enabled: true, | ||
project: 'projectB', | ||
}, | ||
], | ||
production: [ | ||
{ | ||
...defaultFeature, | ||
name: 'featureA', | ||
enabled: false, | ||
project: 'projectA', | ||
}, | ||
], | ||
}); | ||
|
||
const featuresBeforeRead = cache.getToggles({ | ||
environment: 'development', | ||
projects: ['projectA'], | ||
} as IApiUser); | ||
expect(featuresBeforeRead).toEqual([]); | ||
|
||
await state(cache, 'ready'); | ||
|
||
const features = cache.getToggles({ | ||
environment: 'development', | ||
projects: ['projectA'], | ||
} as IApiUser); | ||
expect(features).toEqual([ | ||
{ | ||
...defaultFeature, | ||
name: 'featureA', | ||
enabled: true, | ||
impressionData: false, | ||
}, | ||
]); | ||
|
||
const allProjectFeatures = cache.getToggles({ | ||
environment: 'development', | ||
projects: ['*'], | ||
} as IApiUser); | ||
expect(allProjectFeatures.length).toBe(2); | ||
|
||
const defaultProjectFeatures = cache.getToggles({ | ||
environment: '*', | ||
projects: ['*'], | ||
} as IApiUser); | ||
expect(defaultProjectFeatures.length).toBe(0); | ||
}); | ||
|
||
test('Can refresh data on revision update', async () => { | ||
const { | ||
cache, | ||
configurationRevisionService, | ||
clientFeatureToggleReadModel, | ||
} = createCache(); | ||
|
||
await state(cache, 'ready'); | ||
|
||
clientFeatureToggleReadModel.setValue({ | ||
development: [ | ||
{ | ||
...defaultFeature, | ||
name: 'featureA', | ||
enabled: false, | ||
strategies: [{ name: 'default' }], | ||
project: 'projectA', | ||
}, | ||
], | ||
}); | ||
configurationRevisionService.emit(UPDATE_REVISION); | ||
|
||
await state(cache, 'updated'); | ||
|
||
const features = cache.getToggles({ | ||
environment: 'development', | ||
projects: ['projectA'], | ||
} as IApiUser); | ||
expect(features).toMatchObject([ | ||
{ | ||
...defaultFeature, | ||
name: 'featureA', | ||
enabled: false, | ||
strategies: [{ name: 'default' }], | ||
impressionData: false, | ||
}, | ||
]); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters