From e9ebe09c50d2a4a6830ff17421a9136f13c56025 Mon Sep 17 00:00:00 2001 From: Andrew Liu <159852527+aliu39@users.noreply.github.com> Date: Fri, 7 Feb 2025 12:32:35 -0800 Subject: [PATCH 1/2] ref(flags): rename unleash integration param --- .../featureFlags/unleash/badSignature/init.js | 2 +- .../suites/integrations/featureFlags/unleash/init.js | 2 +- .../src/integrations/featureFlags/unleash/integration.ts | 9 ++++++--- 3 files changed, 8 insertions(+), 5 deletions(-) diff --git a/dev-packages/browser-integration-tests/suites/integrations/featureFlags/unleash/badSignature/init.js b/dev-packages/browser-integration-tests/suites/integrations/featureFlags/unleash/badSignature/init.js index dc92fbc296a4..1e0303b9c356 100644 --- a/dev-packages/browser-integration-tests/suites/integrations/featureFlags/unleash/badSignature/init.js +++ b/dev-packages/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://public@dsn.ingest.sentry.io/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 index 9f1f28730cf7..ddc74b6427b4 100644 --- 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://public@dsn.ingest.sentry.io/1337', diff --git a/packages/browser/src/integrations/featureFlags/unleash/integration.ts b/packages/browser/src/integrations/featureFlags/unleash/integration.ts index c451afb831ba..65e4483e6cc8 100644 --- 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'; +export 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', From c1dad57cfb1f310f0aee2e20a91ca8816f1d6401 Mon Sep 17 00:00:00 2001 From: Andrew Liu <159852527+aliu39@users.noreply.github.com> Date: Fri, 7 Feb 2025 12:46:07 -0800 Subject: [PATCH 2/2] Unexport options --- .../src/integrations/featureFlags/unleash/integration.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/browser/src/integrations/featureFlags/unleash/integration.ts b/packages/browser/src/integrations/featureFlags/unleash/integration.ts index 65e4483e6cc8..e7f4602d17d7 100644 --- a/packages/browser/src/integrations/featureFlags/unleash/integration.ts +++ b/packages/browser/src/integrations/featureFlags/unleash/integration.ts @@ -5,7 +5,7 @@ import { DEBUG_BUILD } from '../../../debug-build'; import { copyFlagsFromScopeToEvent, insertFlagToScope } from '../../../utils/featureFlags'; import type { UnleashClient, UnleashClientClass } from './types'; -export type UnleashIntegrationOptions = { +type UnleashIntegrationOptions = { featureFlagClientClass: UnleashClientClass; };