Fix test

Author: aliu39

dev-packages/browser-integration-tests/suites/integrations/featureFlags/launchdarkly/init.js

@@ -1,5 +1,6 @@
 import * as Sentry from '@sentry/browser';
-import { launchDarklyIntegration } from '@sentry/browser';
+import { launchDarklyIntegration, buildLaunchDarklyFlagUsedHandler } from '@sentry/browser';
+
 
 window.Sentry = Sentry;
 window.LDIntegration = launchDarklyIntegration();
@@ -10,18 +11,25 @@ Sentry.init({
   integrations: [window.LDIntegration],
 });
 
-// TODO: can't type this unless we duplicate to every test.ts file
 window.MockLaunchDarkly = {
   initialize(_clientId, context, options) {
-    // const flagUsedHandler = options?.inspectors?.[0].method;
+    const flagUsedHandler = (options && options.inspectors) ? options.inspectors[0].method : undefined;
 
     return {
       variation(key, defaultValue) {
-        // flagUsedHandler?.(key, { value: defaultValue }, context);
+        if (flagUsedHandler) {
+          flagUsedHandler(key, { value: defaultValue }, context); // TODO:this is async atm
+        }
         return defaultValue;
       },
     };
   },
 };
 
-console.log(window.MockLaunchDarkly)
+window.InitializeLD = () => {
+  return window.MockLaunchDarkly.initialize(
+    'example-client-id',
+    { kind: 'user', key: 'example-context-key' },
+    { inspectors: [buildLaunchDarklyFlagUsedHandler()] },
+  );
+};

dev-packages/browser-integration-tests/suites/integrations/featureFlags/launchdarkly/test.ts

@@ -3,21 +3,25 @@ import { expect } from '@playwright/test';
 import { sentryTest } from '../../../../utils/fixtures';
 
 import { envelopeRequestParser, waitForErrorRequest } from '../../../../utils/helpers';
-import { buildLaunchDarklyFlagUsedHandler } from '@sentry/browser';
-import type { LDContext, LDOptions, LDFlagValue, LDClient } from 'launchdarkly-js-client-sdk';
+import type { LDContext, LDOptions, LDFlagValue, LDClient, LDEvaluationDetail } from 'launchdarkly-js-client-sdk';
 import type { Event } from '@sentry/types';
 
-// const MockLaunchDarkly = { //TODO:
+// const MockLaunchDarkly = { //TODO: remove in favor of window.MockLaunchDarkly from init.js
 //   initialize(
 //     _clientId: string,
 //     context: LDContext,
 //     options: LDOptions,
 //   ) {
 //     const flagUsedHandler = options?.inspectors?.[0].method;
+//     const wellTypedHandler = flagUsedHandler as ((
+//       flagKey: string,
+//       flagDetail: LDEvaluationDetail,
+//       context: LDContext,
+//     ) => void) | undefined;
 
 //     return {
 //       variation(key: string, defaultValue: LDFlagValue) {
-//         flagUsedHandler?.(key, { value: defaultValue }, context);
+//         wellTypedHandler?.(key, { value: defaultValue }, context);
 //         return defaultValue;
 //       },
 //     };
@@ -44,24 +48,24 @@ sentryTest('e2e test', async ({ getLocalTestPath, page }) => {
   await page.goto(url);
 
   // TODO: could this be in init.js?
-  const ldClient = await page.evaluate(() => {
-    return (window as any).MockLaunchDarkly.initialize(
-      'example-client-id',
-      { kind: 'user', key: 'example-context-key' },
-      { inspectors: [buildLaunchDarklyFlagUsedHandler()] },
-    ) as LDClient;
+  await page.waitForFunction(() => {
+    const ldClient = (window as any).InitializeLD();
+    ldClient.variation('feat1', false);
+    ldClient.variation('feat2', false);
+    ldClient.variation('feat3', false);
+    ldClient.variation('feat2', true);
+    return true;
   });
 
-  ldClient.variation('feat1', false);
-  ldClient.variation('feat2', false);
-  ldClient.variation('feat3', false);
-  ldClient.variation('feat2', true);
+
   // TODO: eviction not tested
 
   // trigger error
+  const reqPromise = waitForErrorRequest(page);
   await page.locator('#error').click();
+  const req = await reqPromise;
 
-  const req = await waitForErrorRequest(page);
+  // console.log(errorEventId);
   const event = envelopeRequestParser(req);
 
   expect(event.contexts?.flags?.values).toEqual([

packages/browser/src/integrations/launchdarkly.ts

@@ -37,11 +37,10 @@ export const launchDarklyIntegration = defineIntegration(() => {
 }) satisfies IntegrationFn;
 
 /**
- * Constructs a LaunchDarkly hook that listens for flag evaluations and updates
- * the flagBuffer in our current scope.
- *
- * This needs to be registered separately in the LD SDK initialize() options,
- * after initializing Sentry.
+ * LaunchDarkly hook that listens for flag evaluations and updates the `flags`
+ * context in our Sentry scope. This needs to be registered as an
+ * 'inspector' in LaunchDarkly initialize() options, separately from
+ * `launchDarklyIntegration`. Both are needed to collect feature flags on error.
  */
 export function buildLaunchDarklyFlagUsedHandler(): LDInspectionFlagUsedHandler {
   return {