feat(flags): Adds LaunchDarkly and OpenFeature integrations #14207
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| import { expect } from '@playwright/test'; | ||
|
|
||
| import { sentryTest } from '../../../../../utils/fixtures'; | ||
|
|
||
| import { envelopeRequestParser, shouldSkipFeatureFlagsTest, waitForErrorRequest } from '../../../../../utils/helpers'; | ||
|
|
||
| const FLAG_BUFFER_SIZE = 100; // Corresponds to constant in featureFlags.ts, in browser utils. | ||
|
|
||
| sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => { | ||
| if (shouldSkipFeatureFlagsTest()) { | ||
| sentryTest.skip(); | ||
| } | ||
|
|
||
| await page.route('https://dsn.ingest.sentry.io/**/*', route => { | ||
| return route.fulfill({ | ||
| status: 200, | ||
| contentType: 'application/json', | ||
| body: JSON.stringify({ id: 'test-id' }), | ||
| }); | ||
| }); | ||
|
|
||
| const url = await getLocalTestUrl({ testDir: __dirname, skipDsnRouteHandler: true }); | ||
| await page.goto(url); | ||
|
|
||
| await page.waitForFunction(bufferSize => { | ||
| const ldClient = (window as any).initializeLD(); | ||
| for (let i = 1; i <= bufferSize; i++) { | ||
| ldClient.variation(`feat${i}`, false); | ||
| } | ||
| ldClient.variation(`feat${bufferSize + 1}`, true); // eviction | ||
| ldClient.variation('feat3', true); // update | ||
| return true; | ||
| }, FLAG_BUFFER_SIZE); | ||
|
|
||
| const reqPromise = waitForErrorRequest(page); | ||
| await page.locator('#error').click(); | ||
| const req = await reqPromise; | ||
| const event = envelopeRequestParser(req); | ||
|
|
||
| const expectedFlags = [{ flag: 'feat2', result: false }]; | ||
| for (let i = 4; i <= FLAG_BUFFER_SIZE; i++) { | ||
| expectedFlags.push({ flag: `feat${i}`, result: false }); | ||
| } | ||
| expectedFlags.push({ flag: `feat${FLAG_BUFFER_SIZE + 1}`, result: true }); | ||
| expectedFlags.push({ flag: 'feat3', result: true }); | ||
|
|
||
| expect(event.contexts?.flags?.values).toEqual(expectedFlags); | ||
| }); | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| import * as Sentry from '@sentry/browser'; | ||
|
|
||
| window.Sentry = Sentry; | ||
| window.sentryLDIntegration = Sentry.launchDarklyIntegration(); | ||
|
|
||
| Sentry.init({ | ||
| dsn: 'https://public@dsn.ingest.sentry.io/1337', | ||
| sampleRate: 1.0, | ||
| integrations: [window.sentryLDIntegration], | ||
| }); | ||
|
|
||
| // Manually mocking this because LD only has mock test utils for the React SDK. | ||
| // Also, no SDK has mock utils for FlagUsedHandler's. | ||
| const MockLaunchDarkly = { | ||
| initialize(_clientId, context, options) { | ||
| const flagUsedHandler = options && options.inspectors ? options.inspectors[0].method : undefined; | ||
|
|
||
| return { | ||
| variation(key, defaultValue) { | ||
| if (flagUsedHandler) { | ||
| flagUsedHandler(key, { value: defaultValue }, context); | ||
| } | ||
| return defaultValue; | ||
| }, | ||
| }; | ||
| }, | ||
| }; | ||
|
|
||
| window.initializeLD = () => { | ||
| return MockLaunchDarkly.initialize( | ||
| 'example-client-id', | ||
| { kind: 'user', key: 'example-context-key' }, | ||
| { inspectors: [Sentry.buildLaunchDarklyFlagUsedHandler()] }, | ||
| ); | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| document.getElementById('error').addEventListener('click', () => { | ||
| throw new Error('Button triggered error'); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <meta charset="utf-8" /> | ||
| </head> | ||
| <body> | ||
| <button id="error">Throw Error</button> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| import { expect } from '@playwright/test'; | ||
|
|
||
| import { sentryTest } from '../../../../../utils/fixtures'; | ||
|
|
||
| import { envelopeRequestParser, shouldSkipFeatureFlagsTest, waitForErrorRequest } from '../../../../../utils/helpers'; | ||
|
|
||
| import type { Scope } from '@sentry/browser'; | ||
|
|
||
| sentryTest('Flag evaluations in forked scopes are stored separately.', async ({ getLocalTestUrl, page }) => { | ||
| if (shouldSkipFeatureFlagsTest()) { | ||
| sentryTest.skip(); | ||
| } | ||
|
|
||
| await page.route('https://dsn.ingest.sentry.io/**/*', route => { | ||
| return route.fulfill({ | ||
| status: 200, | ||
| contentType: 'application/json', | ||
| body: JSON.stringify({ id: 'test-id' }), | ||
| }); | ||
| }); | ||
|
|
||
| const url = await getLocalTestUrl({ testDir: __dirname, skipDsnRouteHandler: true }); | ||
| await page.goto(url); | ||
|
|
||
| const forkedReqPromise = waitForErrorRequest(page, event => !!event.tags && event.tags.isForked === true); | ||
| const mainReqPromise = waitForErrorRequest(page, event => !!event.tags && event.tags.isForked === false); | ||
|
|
||
| await page.waitForFunction(() => { | ||
| const Sentry = (window as any).Sentry; | ||
| const errorButton = document.querySelector('#error') as HTMLButtonElement; | ||
| const ldClient = (window as any).initializeLD(); | ||
|
|
||
| ldClient.variation('shared', true); | ||
|
|
||
| Sentry.withScope((scope: Scope) => { | ||
| ldClient.variation('forked', true); | ||
| ldClient.variation('shared', false); | ||
| scope.setTag('isForked', true); | ||
| if (errorButton) { | ||
| errorButton.click(); | ||
| } | ||
| }); | ||
|
|
||
| ldClient.variation('main', true); | ||
| Sentry.getCurrentScope().setTag('isForked', false); | ||
| errorButton.click(); | ||
| return true; | ||
| }); | ||
|
|
||
|
|
||
| const forkedReq = await forkedReqPromise; | ||
| const forkedEvent = envelopeRequestParser(forkedReq); | ||
|
|
||
| const mainReq = await mainReqPromise; | ||
| const mainEvent = envelopeRequestParser(mainReq); | ||
|
|
||
| expect(forkedEvent.contexts?.flags?.values).toEqual([ | ||
| { flag: 'forked', result: true }, | ||
| { flag: 'shared', result: false }, | ||
| ]); | ||
|
|
||
| expect(mainEvent.contexts?.flags?.values).toEqual([ | ||
| { flag: 'shared', result: true }, | ||
| { flag: 'main', result: true }, | ||
| ]); | ||
| }); | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| import { expect } from '@playwright/test'; | ||
|
|
||
| import { sentryTest } from '../../../../../utils/fixtures'; | ||
|
|
||
| import { envelopeRequestParser, shouldSkipFeatureFlagsTest, waitForErrorRequest } from '../../../../../utils/helpers'; | ||
|
|
||
| const FLAG_BUFFER_SIZE = 100; // Corresponds to constant in featureFlags.ts, in browser utils. | ||
|
|
||
| sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => { | ||
| if (shouldSkipFeatureFlagsTest()) { | ||
| sentryTest.skip(); | ||
| } | ||
|
|
||
| await page.route('https://dsn.ingest.sentry.io/**/*', route => { | ||
| return route.fulfill({ | ||
| status: 200, | ||
| contentType: 'application/json', | ||
| body: JSON.stringify({ id: 'test-id' }), | ||
| }); | ||
| }); | ||
|
|
||
| const url = await getLocalTestUrl({ testDir: __dirname, skipDsnRouteHandler: true }); | ||
| await page.goto(url); | ||
|
|
||
| await page.evaluate(bufferSize => { | ||
| const client = (window as any).initialize(); | ||
| for (let i = 1; i <= bufferSize; i++) { | ||
| client.getBooleanValue(`feat${i}`, false); | ||
| } | ||
| client.getBooleanValue(`feat${bufferSize + 1}`, true); // eviction | ||
| client.getBooleanValue('feat3', true); // update | ||
| }, FLAG_BUFFER_SIZE); | ||
|
|
||
| const reqPromise = waitForErrorRequest(page); | ||
| await page.locator('#error').click(); | ||
| const req = await reqPromise; | ||
| const event = envelopeRequestParser(req); | ||
|
|
||
| const expectedFlags = [{ flag: 'feat2', result: false }]; | ||
| for (let i = 4; i <= FLAG_BUFFER_SIZE; i++) { | ||
| expectedFlags.push({ flag: `feat${i}`, result: false }); | ||
| } | ||
| expectedFlags.push({ flag: `feat${FLAG_BUFFER_SIZE + 1}`, result: true }); | ||
| expectedFlags.push({ flag: 'feat3', result: true }); | ||
|
|
||
| expect(event.contexts?.flags?.values).toEqual(expectedFlags); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| import * as Sentry from '@sentry/browser'; | ||
|
|
||
| window.Sentry = Sentry; | ||
| window.sentryOpenFeatureIntegration = Sentry.openFeatureIntegration(); | ||
|
|
||
| Sentry.init({ | ||
| dsn: 'https://public@dsn.ingest.sentry.io/1337', | ||
| sampleRate: 1.0, | ||
| integrations: [window.sentryOpenFeatureIntegration], | ||
| }); | ||
|
|
||
| window.initialize = () => { | ||
| return { | ||
| getBooleanValue(flag, value) { | ||
| let hook = new Sentry.OpenFeatureIntegrationHook(); | ||
| hook.error({ flagKey: flag, defaultValue: false }, new Error('flag eval error')); | ||
| return value; | ||
| }, | ||
| }; | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| import { expect } from '@playwright/test'; | ||
|
|
||
| import { sentryTest } from '../../../../../utils/fixtures'; | ||
|
|
||
| import { envelopeRequestParser, shouldSkipFeatureFlagsTest, waitForErrorRequest } from '../../../../../utils/helpers'; | ||
|
|
||
| const FLAG_BUFFER_SIZE = 100; // Corresponds to constant in featureFlags.ts, in browser utils. | ||
|
|
||
| sentryTest('Flag evaluation error hook', async ({ getLocalTestUrl, page }) => { | ||
| if (shouldSkipFeatureFlagsTest()) { | ||
| sentryTest.skip(); | ||
| } | ||
|
|
||
| await page.route('https://dsn.ingest.sentry.io/**/*', route => { | ||
| return route.fulfill({ | ||
| status: 200, | ||
| contentType: 'application/json', | ||
| body: JSON.stringify({ id: 'test-id' }), | ||
| }); | ||
| }); | ||
|
|
||
| const url = await getLocalTestUrl({ testDir: __dirname, skipDsnRouteHandler: true }); | ||
| await page.goto(url); | ||
|
|
||
| await page.evaluate(bufferSize => { | ||
| const client = (window as any).initialize(); | ||
| for (let i = 1; i <= bufferSize; i++) { | ||
| client.getBooleanValue(`feat${i}`, false); | ||
| } | ||
| client.getBooleanValue(`feat${bufferSize + 1}`, true); // eviction | ||
| client.getBooleanValue('feat3', true); // update | ||
| }, FLAG_BUFFER_SIZE); | ||
|
|
||
| const reqPromise = waitForErrorRequest(page); | ||
| await page.locator('#error').click(); | ||
| const req = await reqPromise; | ||
| const event = envelopeRequestParser(req); | ||
|
|
||
| // Default value is mocked as false -- these will all error and use default | ||
| // value | ||
| const expectedFlags = [{ flag: 'feat2', result: false }]; | ||
| for (let i = 4; i <= FLAG_BUFFER_SIZE; i++) { | ||
| expectedFlags.push({ flag: `feat${i}`, result: false }); | ||
| } | ||
| expectedFlags.push({ flag: `feat${FLAG_BUFFER_SIZE + 1}`, result: false }); | ||
| expectedFlags.push({ flag: 'feat3', result: false }); | ||
|
|
||
| expect(event.contexts?.flags?.values).toEqual(expectedFlags); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| import * as Sentry from '@sentry/browser'; | ||
|
|
||
| window.Sentry = Sentry; | ||
| window.sentryOpenFeatureIntegration = Sentry.openFeatureIntegration(); | ||
|
|
||
| Sentry.init({ | ||
| dsn: 'https://public@dsn.ingest.sentry.io/1337', | ||
| sampleRate: 1.0, | ||
| integrations: [window.sentryOpenFeatureIntegration], | ||
| }); | ||
|
|
||
| window.initialize = () => { | ||
| return { | ||
| getBooleanValue(flag, value) { | ||
| let hook = new Sentry.OpenFeatureIntegrationHook(); | ||
| hook.after(null, { flagKey: flag, value: value }); | ||
| return value; | ||
| }, | ||
| }; | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| document.getElementById('error').addEventListener('click', () => { | ||
| throw new Error('Button triggered error'); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <meta charset="utf-8" /> | ||
| </head> | ||
| <body> | ||
| <button id="error">Throw Error</button> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| import { expect } from '@playwright/test'; | ||
|
|
||
| import { sentryTest } from '../../../../../utils/fixtures'; | ||
|
|
||
| import { envelopeRequestParser, shouldSkipFeatureFlagsTest, waitForErrorRequest } from '../../../../../utils/helpers'; | ||
|
|
||
| import type { Scope } from '@sentry/browser'; | ||
|
|
||
| sentryTest('Flag evaluations in forked scopes are stored separately.', async ({ getLocalTestUrl, page }) => { | ||
| if (shouldSkipFeatureFlagsTest()) { | ||
| sentryTest.skip(); | ||
| } | ||
|
|
||
| await page.route('https://dsn.ingest.sentry.io/**/*', route => { | ||
| return route.fulfill({ | ||
| status: 200, | ||
| contentType: 'application/json', | ||
| body: JSON.stringify({ id: 'test-id' }), | ||
| }); | ||
| }); | ||
|
|
||
| const url = await getLocalTestUrl({ testDir: __dirname, skipDsnRouteHandler: true }); | ||
| await page.goto(url); | ||
|
|
||
| const forkedReqPromise = waitForErrorRequest(page, event => !!event.tags && event.tags.isForked === true); | ||
| const mainReqPromise = waitForErrorRequest(page, event => !!event.tags && event.tags.isForked === false); | ||
|
|
||
| await page.waitForFunction(() => { | ||
| const Sentry = (window as any).Sentry; | ||
| const errorButton = document.querySelector('#error') as HTMLButtonElement; | ||
| const client = (window as any).initialize(); | ||
|
|
||
| client.getBooleanValue('shared', true); | ||
|
|
||
| Sentry.withScope((scope: Scope) => { | ||
| client.getBooleanValue('forked', true); | ||
| client.getBooleanValue('shared', false); | ||
| scope.setTag('isForked', true); | ||
| if (errorButton) { | ||
| errorButton.click(); | ||
| } | ||
| }); | ||
|
|
||
| client.getBooleanValue('main', true); | ||
| Sentry.getCurrentScope().setTag('isForked', false); | ||
| errorButton.click(); | ||
| return true; | ||
| }); | ||
|
|
||
| const forkedReq = await forkedReqPromise; | ||
| const forkedEvent = envelopeRequestParser(forkedReq); | ||
|
|
||
| const mainReq = await mainReqPromise; | ||
| const mainEvent = envelopeRequestParser(mainReq); | ||
|
|
||
| expect(forkedEvent.contexts?.flags?.values).toEqual([ | ||
| { flag: 'forked', result: true }, | ||
| { flag: 'shared', result: false }, | ||
| ]); | ||
|
|
||
| expect(mainEvent.contexts?.flags?.values).toEqual([ | ||
| { flag: 'shared', result: true }, | ||
| { flag: 'main', result: true }, | ||
| ]); | ||
| }); |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This can just be
page.evaluateright since we're not waiting for anything async inside