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

Author: aliu39

packages/core/src/scope.ts

@@ -129,8 +129,10 @@ class ScopeClass implements ScopeInterface {
     newScope._extra = { ...this._extra };
     newScope._contexts = { ...this._contexts };
     if (this._contexts.flags) {
-      // The flags context requires a deep copy.
-      newScope._contexts.flags = {flag_buffer: this._contexts.flags.flag_buffer.clone()};
+      // The flags context needs a deep copy.
+      newScope._contexts.flags = {
+        values: [...this._contexts.flags.values]
+      }
     }
 
     newScope._user = this._user;

packages/launchdarkly/.yalc/@sentry/types/LICENSE

@@ -1,5 +1,5 @@
 {
-  "name": "@sentry-internal/launchdarkly",
+  "name": "@sentry/launchdarkly",
   "version": "8.35.0",
   "description": "Sentry SDK integration for Launch Darkly feature flagging",
   "repository": "git://github.com/getsentry/sentry-javascript.git",
@@ -41,7 +41,7 @@
   "dependencies": {
     "@sentry/browser": "^8.35.0",
     "@sentry/core": "8.35.0",
-    "@sentry/types": "file:.yalc/@sentry/types",
+    "@sentry/types": "8.35.0",
     "@sentry/utils": "8.35.0",
     "launchdarkly-js-client-sdk": "^3.5.0"
   },

packages/launchdarkly/.yalc/@sentry/types/README.md

@@ -3,7 +3,7 @@ import { makeBaseBundleConfig, makeBundleConfigVariants } from '@sentry-internal
 const baseBundleConfig = makeBaseBundleConfig({
   bundleType: 'addon',
   entrypoints: ['src/index.ts'],
-  licenseTitle: '@sentry-internal/launchdarkly',
+  licenseTitle: '@sentry/launchdarkly',
   outputFileBase: () => 'bundles/launchdarkly',
 });
 

packages/launchdarkly/.yalc/@sentry/types/package.json

@@ -4,43 +4,45 @@ import * as Sentry from '@sentry/browser';
 import type { Client as SentryClient, Event, EventHint, IntegrationFn } from '@sentry/types';
 import type { LDContext, LDEvaluationDetail, LDInspectionFlagUsedHandler } from 'launchdarkly-js-client-sdk';
 import type { LaunchDarklyOptions } from '../types';
+import { insertToFlagBuffer } from '@sentry/utils';
 
 /**
  * Sentry integration for capturing feature flags from LaunchDarkly.
  *
  * See the [feature flag documentation](TODO:) for more information.
  *
  * @example
- *
  * ```
- * TODO:
- * Sentry.init({
- *   dsn: '__DSN__',
- *   integrations: [Sentry.replayIntegration()],
- * });
+ * import {SentryInspector, launchDarklyIntegration} from '@sentry/launchdarkly';
+ * import {LDClient} from 'launchdarkly-js-client-sdk';
+ *
+ * Sentry.init(..., integrations: [launchDarklyIntegration()])
+ * const ldClient = LDClient.initialize(..., inspectors: [SentryInspector]);
  * ```
  */
 export const launchDarklyIntegration = ((_options?: LaunchDarklyOptions) => {
   return {
     name: 'launchdarkly',
 
     processEvent(event: Event, _hint: EventHint, _client: SentryClient): Event {
-      const scope = Sentry.getCurrentScope(); // client doesn't have getCurrentScope
-      const flagContext = { values: scope.getFlags() };
-      if (event.contexts) {
-        event.contexts.flags = flagContext;
-      } else {
-        event.contexts = { flags: flagContext };
+      const scope = Sentry.getCurrentScope();
+      const flagContext = scope.getScopeData().contexts.flags;
+
+      if (event.contexts === undefined) {
+        event.contexts = {};
       }
+      event.contexts.flags = flagContext;
       return event;
     },
   };
 }) satisfies IntegrationFn;
 
 /**
  * LaunchDarkly hook that listens for flag evaluations and updates the
- * flagBuffer in our current scope
- * TODO: finalize docstring
+ * flagBuffer in our current scope.
+ *
+ * This needs to be registered separately in the LDClient, after initializing
+ * Sentry.
  */
 export class SentryInspector implements LDInspectionFlagUsedHandler {
   public name = 'sentry-flag-auditor';
@@ -51,11 +53,16 @@ export class SentryInspector implements LDInspectionFlagUsedHandler {
   public synchronous = false;
 
   /**
-   * TODO: docstring
+   * Handle a flag evaluation by storing its name and value on the current scope.
    */
   public method(flagKey: string, flagDetail: LDEvaluationDetail, _context: LDContext): void {
     if (typeof flagDetail.value === 'boolean') {
-      Sentry.getCurrentScope().insertFlag(flagKey, flagDetail.value);
+      const scopeContexts = Sentry.getCurrentScope().getScopeData().contexts;
+      if (!scopeContexts.flags) {
+        scopeContexts.flags = {values: []}
+      }
+      const flagBuffer = scopeContexts.flags.values;
+      insertToFlagBuffer(flagBuffer, flagKey, flagDetail.value);
     }
     return;
   }

packages/launchdarkly/.yalc/@sentry/types/yalc.sig

@@ -1,6 +1,6 @@
 import type { Primitive } from './misc';
 import type { SpanOrigin } from './span';
-import type { FlagBufferInterface } from './flags'
+import type { FeatureFlag } from './flags'
 
 export type Context = Record<string, unknown>;
 
@@ -128,5 +128,6 @@ export interface MissingInstrumentationContext extends Record<string, unknown> {
 }
 
 export interface FeatureFlagContext extends Record<string, unknown> {
-  flag_buffer: FlagBufferInterface;
+  // This should only be modified by @sentry/util methods (insertToFlagBuffer).
+  readonly values: FeatureFlag[];
 }