Skip to content
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

fix: named client events #472

Merged
merged 3 commits into from
Jul 4, 2023
Merged
Show file tree
Hide file tree
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
44 changes: 44 additions & 0 deletions packages/client/test/events.spec.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import {
EventDetails,
JsonValue,
NOOP_PROVIDER,
OpenFeature,
OpenFeatureEventEmitter,
Provider,
Expand Down Expand Up @@ -76,6 +77,10 @@ describe('Events', () => {
clientId = uuid();
});

beforeEach(() => {
OpenFeature.setProvider(NOOP_PROVIDER);
});

describe('Requirement 5.1.1', () => {
describe('provider implements events', () => {
it('The provider defines a mechanism for signalling the occurrence of an event`PROVIDER_READY`', (done) => {
Expand Down Expand Up @@ -192,6 +197,45 @@ describe('Events', () => {
OpenFeature.setProvider(clientId, provider);
});

it('anonymous provider with named client should run', (done) => {
const defaultProvider = new MockProvider({
failOnInit: false,
initialStatus: ProviderStatus.NOT_READY,
name: 'default',
});
const unboundName = 'some-new-unbound-name';

// get a client using the default because it has not other mapping
const unBoundClient = OpenFeature.getClient(unboundName);
unBoundClient.addHandler(ProviderEvents.ConfigurationChanged, () => {
done();
});

// set the default provider
OpenFeature.setProvider(defaultProvider);

// fire events
defaultProvider.events?.emit(ProviderEvents.ConfigurationChanged);
});

it('anonymous provider with named client should run init events', (done) => {
const defaultProvider = new MockProvider({
failOnInit: false,
initialStatus: ProviderStatus.NOT_READY,
name: 'default',
});
const unboundName = 'some-other-unbound-name';

// get a client using the default because it has not other mapping
const unBoundClient = OpenFeature.getClient(unboundName);
unBoundClient.addHandler(ProviderEvents.Ready, () => {
done();
});

// set the default provider
OpenFeature.setProvider(defaultProvider);
});

it('un-bound client event handlers still run after new provider set', (done) => {
const defaultProvider = new MockProvider({ name: 'default' });
const namedProvider = new MockProvider();
Expand Down
44 changes: 44 additions & 0 deletions packages/server/test/events.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import {
ResolutionDetails,
} from '../src';
import { v4 as uuid } from 'uuid';
import { NOOP_PROVIDER } from '../src';

class MockProvider implements Provider {
readonly metadata: ProviderMetadata;
Expand Down Expand Up @@ -79,6 +80,10 @@ describe('Events', () => {
clientId = uuid();
});

beforeEach(() => {
OpenFeature.setProvider(NOOP_PROVIDER);
});

describe('Requirement 5.1.1', () => {
describe('provider implements events', () => {
it('The provider defines a mechanism for signalling the occurrence of an event`PROVIDER_READY`', (done) => {
Expand Down Expand Up @@ -195,6 +200,45 @@ describe('Events', () => {
OpenFeature.setProvider(clientId, provider);
});

it('anonymous provider with named client should run', (done) => {
const defaultProvider = new MockProvider({
failOnInit: false,
initialStatus: ProviderStatus.NOT_READY,
name: 'default',
});
const unboundName = 'some-new-unbound-name';

// get a client using the default because it has not other mapping
const unBoundClient = OpenFeature.getClient(unboundName);
unBoundClient.addHandler(ProviderEvents.ConfigurationChanged, () => {
done();
});

// set the default provider
OpenFeature.setProvider(defaultProvider);

// fire events
defaultProvider.events?.emit(ProviderEvents.ConfigurationChanged);
});

it('anonymous provider with named client should run init events', (done) => {
const defaultProvider = new MockProvider({
failOnInit: false,
initialStatus: ProviderStatus.NOT_READY,
name: 'default',
});
const unboundName = 'some-other-unbound-name';

// get a client using the default because it has not other mapping
const unBoundClient = OpenFeature.getClient(unboundName);
unBoundClient.addHandler(ProviderEvents.Ready, () => {
done();
});

// set the default provider
OpenFeature.setProvider(defaultProvider);
});

it('un-bound client event handlers still run after new provider set', (done) => {
const defaultProvider = new MockProvider({ name: 'default' });
const namedProvider = new MockProvider();
Expand Down
9 changes: 9 additions & 0 deletions packages/shared/src/filter.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
/**
* Checks if a value is not null or undefined and returns it as type assertion
* @template T
* @param {T} input The value to check
* @returns If the value is not null or undefined
*/
export function isDefined<T>(input?: T | null | undefined): input is T {
return typeof input !== 'undefined' && input !== null;
}
31 changes: 24 additions & 7 deletions packages/shared/src/open-feature.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import {
} from './types';
import { EventDetails, EventHandler, Eventing, OpenFeatureEventEmitter, ProviderEvents } from './events';
import { objectOrUndefined, stringOrUndefined } from './type-guards';
import { isDefined } from './filter';

export abstract class OpenFeatureCommonAPI<P extends CommonProvider = CommonProvider> implements Eventing {
protected _transactionContextPropagator: TransactionContextPropagator = NOOP_TRANSACTION_CONTEXT_PROPAGATOR;
Expand Down Expand Up @@ -104,21 +105,28 @@ export abstract class OpenFeatureCommonAPI<P extends CommonProvider = CommonProv
return this;
}

const clientEmitter = this.getAndCacheEventEmitterForClient(clientName);
// get the named emitter, or if this is the default provider, get all event emitters not associated with a provider
const emitters = clientName ? [this.getAndCacheEventEmitterForClient(clientName)] : this.getUnboundEmitters();

if (typeof provider.initialize === 'function') {
provider
.initialize?.(this._context)
?.then(() => {
clientEmitter.emit(ProviderEvents.Ready, { clientName });
emitters.forEach((emitter) => {
emitter?.emit(ProviderEvents.Ready, { clientName });
});
this._events?.emit(ProviderEvents.Ready, { clientName });
})
?.catch((error) => {
clientEmitter.emit(ProviderEvents.Error, { clientName, message: error.message });
emitters.forEach((emitter) => {
emitter?.emit(ProviderEvents.Error, { clientName, message: error.message });
});
this._events?.emit(ProviderEvents.Error, { clientName, message: error.message });
});
} else {
clientEmitter.emit(ProviderEvents.Ready, { clientName });
emitters.forEach((emitter) => {
emitter?.emit(ProviderEvents.Ready, { clientName });
});
this._events?.emit(ProviderEvents.Ready, { clientName });
}

Expand All @@ -128,7 +136,7 @@ export abstract class OpenFeatureCommonAPI<P extends CommonProvider = CommonProv
this._defaultProvider = provider;
}

this.transferListeners(oldProvider, provider, clientName, clientEmitter);
this.transferListeners(oldProvider, provider, clientName, emitters);

// Do not close a provider that is bound to any client
if (![...this._clientProviders.values(), this._defaultProvider].includes(oldProvider)) {
Expand Down Expand Up @@ -167,11 +175,18 @@ export abstract class OpenFeatureCommonAPI<P extends CommonProvider = CommonProv
return newEmitter;
}

private getUnboundEmitters(): OpenFeatureEventEmitter[] {
const namedProviders = [...this._clientProviders.keys()];
const eventEmitterNames = [...this._clientEvents.keys()].filter(isDefined);
const unboundEmitterNames = eventEmitterNames.filter((name) => !namedProviders.includes(name));
return unboundEmitterNames.map((name) => this._clientEvents.get(name)).filter(isDefined);
}

private transferListeners(
oldProvider: P,
newProvider: P,
clientName: string | undefined,
clientEmitter: OpenFeatureEventEmitter
emitters: (OpenFeatureEventEmitter | undefined)[]
) {
this._clientEventHandlers
.get(clientName)
Expand All @@ -182,7 +197,9 @@ export abstract class OpenFeatureCommonAPI<P extends CommonProvider = CommonProv
(eventType) => {
const handler = async (details?: EventDetails) => {
// on each event type, fire the associated handlers
clientEmitter.emit(eventType, { ...details, clientName });
emitters.forEach((emitter) => {
emitter?.emit(eventType, { ...details, clientName });
});
this._events.emit(eventType, { ...details, clientName });
};

Expand Down