feat: adding support for debug override plugins #1033
Conversation
- Added `LDDebugOverride` interface to manage flag value overrides during development. - Introduced `safeRegisterDebugOverridePlugins` function to register plugins with debug capabilities. - Updated `FlagManager` to support debug overrides, including methods to set, remove, and clear overrides. - Enhanced `LDClientImpl` to utilize debug overrides during client initialization. - Refactored `LDPlugin` interface to include optional `registerDebug` method for plugins. This commit will enable `@launchdarkly/toolbar` to use 4.x
|
@launchdarkly/browser size report |
|
@launchdarkly/js-sdk-common size report |
|
@launchdarkly/js-client-sdk-common size report |
|
@launchdarkly/js-client-sdk size report |
joker23
changed the base branch from
main
to
skz/sdk-1360/browser-4.x-waitforinit
joker23
changed the base branch from
skz/sdk-1360/browser-4.x-waitforinit
to
main
| * Unregister a flag change callback. | ||
| */ | ||
| off(callback: FlagsChangeCallback): void; | ||
|
|
There was a problem hiding this comment.
Blocking until we have some eyes on this - ultimately want to make sure we are fine with having the flag override functionality handled by the flag manager. I think this makes sense, but I can also see how having this implemented as part of the client impl give us a bit more flexibility.
| * This event does not include the value of the flag. It is expected that you | ||
| * will call a variation method for flag values which you require. | ||
| */ | ||
| export type FlagsChangeCallback = ( |
There was a problem hiding this comment.
Blocking until we get some eyes on this - main reason to add null as a valid context to pass in for these events is to support flag changes that are triggered by an override... An alternative is to somehow designate a special context for the override event?
There was a problem hiding this comment.
I think we should just include whatever context is associated with the currently active payload. Because this would propagate all the way to the events emitted by the LD client.
this._flagManager.on((context, flagKeys, type) => {
this._handleInspectionChanged(flagKeys, type);
const ldContext = Context.toLDContext(context);
this.emitter.emit('change', ldContext, flagKeys);
flagKeys.forEach((it) => {
this.emitter.emit(`change:${it}`, ldContext);
});
});
From a consuming standpoint the override changing is changing the value for the current context.
Requirements
Describe the solution you've provided
LDDebugOverrideinterface to manage flag value overrides during development.safeRegisterDebugOverridePluginsfunction to register plugins with debug capabilities.FlagManagerto support debug overrides, including methods to set, remove, and clear overrides.LDClientImplto utilize debug overrides during client initialization.LDPlugininterface to include optionalregisterDebugmethod for plugins.This PR will enable
@launchdarkly/toolbarto use 4.xAdditional context
waitForInitializationfor browser sdk 4.x #1028 (will need to do some rebase magic later)REVIEWERthat I would like some additional discussions before merging