ref(flags): rename unleash integration param (#15343)

getsentry · Feb 10, 2025 · 2afe732 · 2afe732
1 parent d8369f7
commit 2afe732
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 5 deletions.
diff --git a/...s/browser-integration-tests/suites/integrations/featureFlags/unleash/badSignature/init.js b/...s/browser-integration-tests/suites/integrations/featureFlags/unleash/badSignature/init.js
@@ -7,7 +7,7 @@ window.UnleashClient = class {
 };
 
 window.Sentry = Sentry;
-window.sentryUnleashIntegration = Sentry.unleashIntegration({ unleashClientClass: window.UnleashClient });
+window.sentryUnleashIntegration = Sentry.unleashIntegration({ featureFlagClientClass: window.UnleashClient });
 
 Sentry.init({
   dsn: 'https://[email protected]/1337',

diff --git a/dev-packages/browser-integration-tests/suites/integrations/featureFlags/unleash/init.js b/dev-packages/browser-integration-tests/suites/integrations/featureFlags/unleash/init.js
@@ -41,7 +41,7 @@ window.UnleashClient = class {
 };
 
 window.Sentry = Sentry;
-window.sentryUnleashIntegration = Sentry.unleashIntegration({ unleashClientClass: window.UnleashClient });
+window.sentryUnleashIntegration = Sentry.unleashIntegration({ featureFlagClientClass: window.UnleashClient });
 
 Sentry.init({
   dsn: 'https://[email protected]/1337',

diff --git a/packages/browser/src/integrations/featureFlags/unleash/integration.ts b/packages/browser/src/integrations/featureFlags/unleash/integration.ts
@@ -5,6 +5,10 @@ import { DEBUG_BUILD } from '../../../debug-build';
 import { copyFlagsFromScopeToEvent, insertFlagToScope } from '../../../utils/featureFlags';
 import type { UnleashClient, UnleashClientClass } from './types';
 
+type UnleashIntegrationOptions = {
+  featureFlagClientClass: UnleashClientClass;
+};
+
 /**
  * Sentry integration for capturing feature flag evaluations from the Unleash SDK.
  *
@@ -17,19 +21,18 @@ import type { UnleashClient, UnleashClientClass } from './types';
  *
  * Sentry.init({
  *   dsn: '___PUBLIC_DSN___',
- *   integrations: [Sentry.unleashIntegration({unleashClientClass: UnleashClient})],
+ *   integrations: [Sentry.unleashIntegration({featureFlagClientClass: UnleashClient})],
  * });
  *
  * const unleash = new UnleashClient(...);
  * unleash.start();
  *
  * unleash.isEnabled('my-feature');
- * unleash.getVariant('other-feature');
  * Sentry.captureException(new Error('something went wrong'));
  * ```
  */
 export const unleashIntegration = defineIntegration(
-  ({ unleashClientClass }: { unleashClientClass: UnleashClientClass }) => {
+  ({ featureFlagClientClass: unleashClientClass }: UnleashIntegrationOptions) => {
     return {
       name: 'Unleash',