Skip to content

[FSSDK-11497] fire config update events synchronously #1043

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 6, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 16 additions & 18 deletions lib/project_config/project_config_manager.spec.ts
Original file line number Diff line number Diff line change
@@ -121,24 +121,17 @@ describe('ProjectConfigManagerImpl', () => {
expect(manager.getState()).toBe(ServiceState.Running);
});

it('should call onUpdate listeners registered before or after start() with the project config after resolving onRunning()', async () => {
it('should call onUpdate listeners registered before start() with the project config', async () => {
const logger = getMockLogger();
const manager = new ProjectConfigManagerImpl({ logger, datafile: testData.getTestProjectConfig()});
const listener1 = vi.fn();
manager.onUpdate(listener1);
const listener = vi.fn();
manager.onUpdate(listener);
manager.start();
const listener2 = vi.fn();
manager.onUpdate(listener2);
expect(listener1).not.toHaveBeenCalled();
expect(listener2).not.toHaveBeenCalledOnce();

await manager.onRunning();

expect(listener1).toHaveBeenCalledOnce();
expect(listener2).toHaveBeenCalledOnce();

expect(listener1).toHaveBeenCalledWith(createProjectConfig(testData.getTestProjectConfig()));
expect(listener2).toHaveBeenCalledWith(createProjectConfig(testData.getTestProjectConfig()));
expect(listener).toHaveBeenCalledOnce();
expect(listener).toHaveBeenCalledWith(createProjectConfig(testData.getTestProjectConfig()));
});

it('should return the correct config from getConfig() both before or after onRunning() resolves', async () => {
@@ -187,8 +180,8 @@ describe('ProjectConfigManagerImpl', () => {
const listener = vi.fn();

const manager = new ProjectConfigManagerImpl({ datafile: testData.getTestProjectConfig(), datafileManager });
manager.start();
manager.onUpdate(listener);
manager.start();
await expect(manager.onRunning()).resolves.not.toThrow();
expect(listener).toHaveBeenCalledWith(createProjectConfig(testData.getTestProjectConfig()));
});
@@ -309,11 +302,12 @@ describe('ProjectConfigManagerImpl', () => {

const datafile = testData.getTestProjectConfig();
const manager = new ProjectConfigManagerImpl({ datafile, datafileManager });
manager.start();

const listener = vi.fn();
manager.onUpdate(listener);

manager.start();

expect(manager.getConfig()).toEqual(createProjectConfig(datafile));
await manager.onRunning();
expect(manager.getConfig()).toEqual(createProjectConfig(datafile));
@@ -334,11 +328,12 @@ describe('ProjectConfigManagerImpl', () => {
const logger = getMockLogger();
const datafile = testData.getTestProjectConfig();
const manager = new ProjectConfigManagerImpl({ logger, datafile, datafileManager });
manager.start();

const listener = vi.fn();
manager.onUpdate(listener);

manager.start();

expect(manager.getConfig()).toEqual(createProjectConfig(testData.getTestProjectConfig()));
await manager.onRunning();
expect(manager.getConfig()).toEqual(createProjectConfig(testData.getTestProjectConfig()));
@@ -379,11 +374,12 @@ describe('ProjectConfigManagerImpl', () => {

const datafile = testData.getTestProjectConfig();
const manager = new ProjectConfigManagerImpl({ datafile, datafileManager });
manager.start();

const listener = vi.fn();
manager.onUpdate(listener);

manager.start();

expect(manager.getConfig()).toEqual(createProjectConfig(datafile));
await manager.onRunning();
expect(manager.getConfig()).toEqual(createProjectConfig(datafile));
@@ -401,11 +397,12 @@ describe('ProjectConfigManagerImpl', () => {
const datafileManager = getMockDatafileManager({});

const manager = new ProjectConfigManagerImpl({ datafile });
manager.start();

const listener = vi.fn();
const dispose = manager.onUpdate(listener);

manager.start();

await manager.onRunning();
expect(listener).toHaveBeenNthCalledWith(1, createProjectConfig(datafile));

@@ -420,11 +417,12 @@ describe('ProjectConfigManagerImpl', () => {
const datafile = testData.getTestProjectConfig();

const manager = new ProjectConfigManagerImpl({ datafile: JSON.stringify(datafile) });
manager.start();

const listener = vi.fn();
manager.onUpdate(listener);

manager.start();

await manager.onRunning();
expect(listener).toHaveBeenCalledWith(createProjectConfig(datafile));
expect(manager.getConfig()).toEqual(createProjectConfig(datafile));
5 changes: 1 addition & 4 deletions lib/project_config/project_config_manager.ts
Original file line number Diff line number Diff line change
@@ -18,7 +18,6 @@ import { createOptimizelyConfig } from './optimizely_config';
import { OptimizelyConfig } from '../shared_types';
import { DatafileManager } from './datafile_manager';
import { ProjectConfig, toDatafile, tryCreatingProjectConfig } from './project_config';
import { scheduleMicrotask } from '../utils/microtask';
import { Service, ServiceState, BaseService } from '../service';
import { Consumer, Fn, Transformer } from '../utils/type';
import { EventEmitter } from '../utils/event_emitter/event_emitter';
@@ -166,9 +165,7 @@ export class ProjectConfigManagerImpl extends BaseService implements ProjectConf
if (this.projectConfig?.revision !== config.revision) {
this.projectConfig = config;
this.optimizelyConfig = undefined;
scheduleMicrotask(() => {
this.eventEmitter.emit('update', config);
})
this.eventEmitter.emit('update', config);
}
} catch (err) {
this.logger?.error(err);

Unchanged files with check annotations Beta

isQualifiedFor: segment => segments ? segments.indexOf(segment) > -1 : false,
qualifiedSegments: segments || [],
getUserId: () => 'mockUserId',
setAttribute: (key: string, value: any) => {},

Check warning on line 33 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / lint

'key' is defined but never used

Check warning on line 33 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / lint

'value' is defined but never used

Check warning on line 33 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / lint

Unexpected any. Specify a different type

Check warning on line 33 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (18)

'key' is defined but never used

Check warning on line 33 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (18)

'value' is defined but never used

Check warning on line 33 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (18)

Unexpected any. Specify a different type

Check warning on line 33 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (20)

'key' is defined but never used

Check warning on line 33 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (20)

'value' is defined but never used

Check warning on line 33 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (20)

Unexpected any. Specify a different type

Check warning on line 33 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (22)

'key' is defined but never used

Check warning on line 33 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (22)

'value' is defined but never used

Check warning on line 33 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (22)

Unexpected any. Specify a different type
decide: (key: string, options?: OptimizelyDecideOption[]): OptimizelyDecision => ({

Check warning on line 35 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / lint

'key' is defined but never used

Check warning on line 35 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / lint

'options' is defined but never used

Check warning on line 35 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (18)

'key' is defined but never used

Check warning on line 35 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (18)

'options' is defined but never used

Check warning on line 35 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (20)

'key' is defined but never used

Check warning on line 35 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (20)

'options' is defined but never used

Check warning on line 35 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (22)

'key' is defined but never used

Check warning on line 35 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (22)

'options' is defined but never used
variationKey: 'mockVariationKey',
enabled: true,
variables: { mockVariable: 'mockValue' },
});
it('calls customAttributeConditionEvaluator.evaluate in the leaf evaluator for audience conditions', () => {
vi.spyOn(conditionTreeEvaluator, 'evaluate').mockImplementation((conditions: any, leafEvaluator) => {

Check warning on line 253 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / lint

Unexpected any. Specify a different type

Check warning on line 253 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (18)

Unexpected any. Specify a different type

Check warning on line 253 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (20)

Unexpected any. Specify a different type

Check warning on line 253 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (22)

Unexpected any. Specify a different type
return leafEvaluator(conditions[1]);
});
});
it('logs correctly when conditionTreeEvaluator.evaluate returns null', () => {
vi.spyOn(conditionTreeEvaluator, 'evaluate').mockImplementationOnce((conditions: any, leafEvaluator) => {

Check warning on line 295 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / lint

Unexpected any. Specify a different type

Check warning on line 295 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (18)

Unexpected any. Specify a different type

Check warning on line 295 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (20)

Unexpected any. Specify a different type

Check warning on line 295 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (22)

Unexpected any. Specify a different type
return leafEvaluator(conditions[1]);
});
});
it('logs correctly when conditionTreeEvaluator.evaluate returns true', () => {
vi.spyOn(conditionTreeEvaluator, 'evaluate').mockImplementationOnce((conditions: any, leafEvaluator) => {

Check warning on line 322 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / lint

Unexpected any. Specify a different type

Check warning on line 322 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (18)

Unexpected any. Specify a different type

Check warning on line 322 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (20)

Unexpected any. Specify a different type

Check warning on line 322 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (22)

Unexpected any. Specify a different type
return leafEvaluator(conditions[1]);
});
});
it('logs correctly when conditionTreeEvaluator.evaluate returns false', () => {
vi.spyOn(conditionTreeEvaluator, 'evaluate').mockImplementationOnce((conditions: any, leafEvaluator) => {

Check warning on line 348 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / lint

Unexpected any. Specify a different type

Check warning on line 348 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (18)

Unexpected any. Specify a different type

Check warning on line 348 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (20)

Unexpected any. Specify a different type

Check warning on line 348 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (22)

Unexpected any. Specify a different type
return leafEvaluator(conditions[1]);
});
};
audienceEvaluator = createAudienceEvaluator({
special_condition_type: {
evaluate: (condition: any, user: any) => {

Check warning on line 384 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / lint

Unexpected any. Specify a different type

Check warning on line 384 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (18)

Unexpected any. Specify a different type

Check warning on line 384 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (20)

Unexpected any. Specify a different type

Check warning on line 384 in lib/core/audience_evaluator/index.spec.ts

GitHub Actions / unit_tests (22)

Unexpected any. Specify a different type
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
const result = mockEnvironment[condition.value] && user.getAttributes()[condition.match] > 0;