feat(flags): Adds LaunchDarkly and OpenFeature integrations #14207

aliu39 · 2024-11-07T19:18:41Z

Adds browser integrations for tracking feature flag evaluations through the LaunchDarkly JS SDK and OpenFeature Web SDK

Notion doc summarizing our goal, constraints, and potential approaches: https://www.notion.so/sentry/Feature-Flags-JavaScript-SDK-1358b10e4b5d805288abe1a4fede75ed?pvs=4. This PR implements approach 1.

Also see https://develop.sentry.dev/sdk/expected-features/#feature-flags

Ref

https://github.com/getsentry/team-replay/issues/492

Decisions:

we are storing the flags in the current scope's context, and copying them to the event context on error. This way we don't have to extend the scope class/core package. Potential follow-ups:

users have to manually register the FF SDK hook (e.g. LDInspectionFlagUsedHandler) separately from Sentry.init(). Unlike python, it's not possible to do this when instantiating the integration.
this hook is available for client SDKs only, hence why this is a browser only integration.
To keep bundle sizes light, this integration is not exported to CDN bundles. Users should install with npm, and we expect tree-shaking to help if this integration is unused.

Both integrations are live and verified to work, in

@sentry/browser 8.41.0-beta.1
@sentry/react 8.41.0-beta.0

DOCS:
launchdarkly
openfeature
feature flags product index

…try-javascript into aliu/launch-darkly

…ag field and methods

packages/types/src/context.ts

packages/launchdarkly/src/core/integration.ts

…ration feat(flags): Add OpenFeature integration

…tion-abstraction ref(flags): Refactor LaunchDarkly integration to reusable functions

billyvg · 2024-12-04T19:25:07Z

packages/browser/src/index.ts

 export { makeBrowserOfflineTransport } from './transports/offline';
 export { browserProfilingIntegration } from './profiling/integration';
 export { spotlightBrowserIntegration } from './integrations/spotlight';
+export { copyFlagsFromScopeToEvent, insertFlagToScope } from './utils/featureFlags';


Let's remove these exports - they shouldn't be public

mydea · 2024-12-05T07:55:23Z

Just for reference for the next time @aliu39 , please make sure to use squash merge :) No big deal, and we know it is not ideal that we cannot enforce this right now in this repo, so it's a bit of a manual thing sadly 😬

…evaluations (#14582) Follow-up to #14207. Sentry integration for buffering feature flags manually with an API and auto-capturing them on error events.

aliu39 and others added 26 commits October 29, 2024 14:03

Init package files

26722d7

Merge branch 'develop' into aliu/launch-darkly

72f9cc0

Revert changelog and move types file

419cd83

Add ld to dependencies and skeleton code. Get rid of core/

610da4d

Fix readme, rename types file, bring back core/

5b2e5ec

Fix readme 2

66b1253

Merge branch 'develop' into aliu/launch-darkly

023604a

Merge branch 'aliu/launch-darkly' of https://github.com/getsentry/sen…

1f99c28

…try-javascript into aliu/launch-darkly

Finish implementing, minus scope.flags

85acc6d

Implement flag buffer in sentry scope

3b3a767

Revert changelog

ab3181d

fix types

22684ea

docstring

79e5b24

Export FeatureFlag type in index.ts

63649c5

Merge branch 'aliu/launch-darkly' of https://github.com/getsentry/sen…

923500f

…try-javascript into aliu/launch-darkly

Clean up comments

bd04755

Fix build (uses yalc for scope changes) and use LRUMap util

91a4db9

Merge branch 'develop' into aliu/launch-darkly

1849673

Tweak hook name and docs

1ca9d53

FlagBuffer class and interface, add to scope._contexts. Remove old fl…

893cd62

…ag field and methods

Call clone in scope.clone()

f172683

Rewrite as a util fx instead of class. Use in LD integration

b96c17f

Delete LD pkg

f9a659b

Delete LD from package.json and update lock

d9c5860

Readd LD integration

cf24b75

Fix dependencies and rename exports

5561633

aliu39 commented Nov 7, 2024

View reviewed changes

packages/types/src/context.ts Outdated Show resolved Hide resolved

aliu39 added 2 commits November 8, 2024 11:02

Fix normalize depth of 3 for contexts.flags, improve docstrings

6eab55f

Rm eslint rules, todos

d90d346

aliu39 commented Nov 8, 2024

View reviewed changes

packages/launchdarkly/src/core/integration.ts Outdated Show resolved Hide resolved

cmanallen and others added 6 commits November 20, 2024 12:49

Linting

c9d3a74

Add missing semi-colons

3dcf07e

update tests to use shouldSkipFeatureFlagsTest and getLocalTestUrl

1e1d734

ref; use featureFlags util functions

06e7fbb

export copyFlags/insertFlagToScope

a47d337

add error hook test

afd4f78

billyvg mentioned this pull request Nov 25, 2024

feat(flags): Add OpenFeature integration #14326

Merged

cmanallen added 2 commits December 2, 2024 08:38

Merge pull request #14326 from getsentry/cmanallen/open-feature-integ…

a292a60

…ration feat(flags): Add OpenFeature integration

Merge pull request #14369 from getsentry/ref-ff-launch-darkly-integra…

049e312

…tion-abstraction ref(flags): Refactor LaunchDarkly integration to reusable functions

cmanallen changed the title ~~feat(flags): Add LaunchDarkly integration~~ feat(flags): Adds LaunchDarkly and OpenFeature integrations Dec 2, 2024

cmanallen and others added 6 commits December 2, 2024 08:41

Merge branch 'develop' into aliu/launch-darkly-integration

8be7d99

Fix types

3c49dda

Remove deprecated type file

2901aa2

Merge branch 'develop' into aliu/launch-darkly-integration

ee89c68

Fix type import

0a0299e

Update deprecated type imports to use core

cf6992f

aliu39 requested a review from billyvg December 4, 2024 19:07

billyvg reviewed Dec 4, 2024

View reviewed changes

aliu39 added 3 commits December 4, 2024 11:52

review comments

46eb462

Merge branch 'develop' into aliu/launch-darkly-integration

026acec

Revert export ordering

05dab63

aliu39 requested a review from billyvg December 4, 2024 19:55

billyvg approved these changes Dec 4, 2024

View reviewed changes

aliu39 merged commit 2a41c84 into develop Dec 4, 2024
154 checks passed

aliu39 deleted the aliu/launch-darkly-integration branch December 4, 2024 20:56

aliu39 mentioned this pull request Dec 4, 2024

feat(flags): Add featureFlagsIntegration for custom tracking of flag evaluations #14582

Merged

lforst mentioned this pull request Dec 5, 2024

meta(types): Remove Feature Flag APIs from deprecated package #14591

Merged

billyvg mentioned this pull request Dec 11, 2024

Create an RFC for the SDK and protocol where we can capture FF with events getsentry/sentry#77041

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Uh oh!

feat(flags): Adds LaunchDarkly and OpenFeature integrations #14207

feat(flags): Adds LaunchDarkly and OpenFeature integrations #14207

Uh oh!

aliu39 commented Nov 7, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

billyvg Dec 4, 2024

Uh oh!

Uh oh!

mydea commented Dec 5, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

Uh oh!

Uh oh!

feat(flags): Adds LaunchDarkly and OpenFeature integrations #14207

feat(flags): Adds LaunchDarkly and OpenFeature integrations #14207

Uh oh!

Conversation

aliu39 commented Nov 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

billyvg Dec 4, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mydea commented Dec 5, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

aliu39 commented Nov 7, 2024 •

edited

Loading