Revert "Move api to top-level, rename addFlag"

This reverts commit 94c120e.

Author: aliu39

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

@@ -23,12 +23,12 @@ sentryTest('Basic test with eviction, update, and no async tasks', async ({ getL
   await page.goto(url);
 
   await page.evaluate(bufferSize => {
-    const Sentry = (window as any).Sentry;
+    const flagsIntegration = (window as any).Sentry.getClient().getIntegrationByName('FeatureFlags');
     for (let i = 1; i <= bufferSize; i++) {
-      Sentry.addFlag(`feat${i}`, false);
+      flagsIntegration.setFlag(`feat${i}`, false);
     }
-    Sentry.addFlag(`feat${bufferSize + 1}`, true); // eviction
-    Sentry.addFlag('feat3', true); // update
+    flagsIntegration.setFlag(`feat${bufferSize + 1}`, true); // eviction
+    flagsIntegration.setFlag('feat3', true); // update
     return true;
   }, FLAG_BUFFER_SIZE);
 

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

@@ -2,6 +2,9 @@ import * as Sentry from '@sentry/browser';
 
 window.Sentry = Sentry;
 
+// Not using this as we want to test the getIntegrationByName() approach
+// window.sentryFeatureFlagsIntegration = Sentry.featureFlagsIntegration();
+
 Sentry.init({
   dsn: 'https://[email protected]/1337',
   sampleRate: 1.0,

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

@@ -28,19 +28,20 @@ sentryTest('Flag evaluations in forked scopes are stored separately.', async ({
   await page.evaluate(() => {
     const Sentry = (window as any).Sentry;
     const errorButton = document.querySelector('#error') as HTMLButtonElement;
+    const flagsIntegration = (window as any).Sentry.getClient().getIntegrationByName('FeatureFlags');
 
-    Sentry.addFlag('shared', true);
+    flagsIntegration.setFlag('shared', true);
 
     Sentry.withScope((scope: Scope) => {
-      Sentry.addFlag('forked', true);
-      Sentry.addFlag('shared', false);
+      flagsIntegration.setFlag('forked', true);
+      flagsIntegration.setFlag('shared', false);
       scope.setTag('isForked', true);
       if (errorButton) {
         errorButton.click();
       }
     });
 
-    Sentry.addFlag('main', true);
+    flagsIntegration.setFlag('main', true);
     Sentry.getCurrentScope().setTag('isForked', false);
     errorButton.click();
     return true;

packages/browser/src/index.ts

@@ -71,7 +71,7 @@ export { spotlightBrowserIntegration } from './integrations/spotlight';
 export { browserSessionIntegration } from './integrations/browsersession';
 export {
   featureFlagsIntegration,
-  addFlag,
+  type FeatureFlagsIntegration,
 } from './integrations/featureFlags';
 export { launchDarklyIntegration, buildLaunchDarklyFlagUsedHandler } from './integrations/featureFlags/launchdarkly';
 export { openFeatureIntegration, OpenFeatureIntegrationHook } from './integrations/featureFlags/openfeature';

packages/browser/src/integrations/featureFlags/featureFlagsIntegration.ts

@@ -1,8 +1,11 @@
-import type { Client, Event, EventHint, IntegrationFn } from '@sentry/core';
+import type { Client, Event, EventHint, Integration, IntegrationFn } from '@sentry/core';
 
-import { defineIntegration, getClient, logger } from '@sentry/core';
+import { defineIntegration } from '@sentry/core';
 import { copyFlagsFromScopeToEvent, insertFlagToScope } from '../../utils/featureFlags';
-import { DEBUG_BUILD } from '../../debug-build';
+
+export interface FeatureFlagsIntegration extends Integration {
+  setFlag: (name: string, value: unknown) => void;
+}
 
 /**
  * Sentry integration for buffering feature flags manually with an API, and
@@ -14,11 +17,19 @@ import { DEBUG_BUILD } from '../../debug-build';
  * @example
  * ```
  * import * as Sentry from '@sentry/browser';
+ * import { type FeatureFlagsIntegration } from '@sentry/browser';
  *
- * Sentry.init(..., integrations: [Sentry.featureFlagsIntegration()]);
+ * // Setup
+ * Sentry.init(..., integrations: [Sentry.featureFlagsIntegration()])
  *
- * Sentry.addFlag('my-flag', true);
- * Sentry.captureException(Exception('broke')); // 'my-flag' should be captured on this Sentry event.
+ * // Verify
+ * const flagsIntegration = Sentry.getClient()?.getIntegrationByName<FeatureFlagsIntegration>('FeatureFlags');
+ * if (flagsIntegration) {
+ *   flagsIntegration.setFlag('my-flag', true);
+ * } else {
+ *   // check your setup
+ * }
+ * Sentry.captureException(Exception('broke')); // 'my-flag' should be captured to this Sentry event.
  * ```
  */
 export const featureFlagsIntegration = defineIntegration(() => {
@@ -27,21 +38,10 @@ export const featureFlagsIntegration = defineIntegration(() => {
 
     processEvent(event: Event, _hint: EventHint, _client: Client): Event {
       return copyFlagsFromScopeToEvent(event);
-    }
-  };
-}) as IntegrationFn;
-
+    },
 
-/**
- * Records a flag and its value to be sent on subsequent error events. We
- * recommend you do this on flag evaluations. Flags are buffered per Sentry
- * scope and limited to 100 per event.
- */
-export function addFlag(name: string, value: unknown): void {
-  const client = getClient();
-  if (!client || !client.getIntegrationByName('FeatureFlags')) {
-    DEBUG_BUILD && logger.error('Must enable the Feature Flags Integration to use the addFlag function.');
-    return;
-  }
-  insertFlagToScope(name, value);
-}
+    setFlag(name: string, value: unknown): void {
+      insertFlagToScope(name, value);
+    },
+  };
+}) as IntegrationFn<FeatureFlagsIntegration>;

packages/browser/src/integrations/featureFlags/index.ts

@@ -1 +1 @@
-export { featureFlagsIntegration, addFlag } from './featureFlagsIntegration';
+export { featureFlagsIntegration, type FeatureFlagsIntegration } from './featureFlagsIntegration';