Skip to content

Commit 2a41c84

Browse files
aliu39aliu39
authored
Merge pull request #14207 from getsentry/aliu/launch-darkly-integration
feat(flags): Adds LaunchDarkly and OpenFeature integrations
2 parents cb1c7ee + 05dab63 commit 2a41c84

File tree

28 files changed

+857
-12
lines changed

28 files changed

+857
-12
lines changed

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

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
import { expect } from '@playwright/test';
2+
3+
import { sentryTest } from '../../../../../utils/fixtures';
4+
5+
import { envelopeRequestParser, shouldSkipFeatureFlagsTest, waitForErrorRequest } from '../../../../../utils/helpers';
6+
7+
const FLAG_BUFFER_SIZE = 100; // Corresponds to constant in featureFlags.ts, in browser utils.
8+
9+
sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
10+
if (shouldSkipFeatureFlagsTest()) {
11+
sentryTest.skip();
12+
}
13+
14+
await page.route('https://dsn.ingest.sentry.io/**/*', route => {
15+
return route.fulfill({
16+
status: 200,
17+
contentType: 'application/json',
18+
body: JSON.stringify({ id: 'test-id' }),
19+
});
20+
});
21+
22+
const url = await getLocalTestUrl({ testDir: __dirname, skipDsnRouteHandler: true });
23+
await page.goto(url);
24+
25+
await page.evaluate(bufferSize => {
26+
const ldClient = (window as any).initializeLD();
27+
for (let i = 1; i <= bufferSize; i++) {
28+
ldClient.variation(`feat${i}`, false);
29+
}
30+
ldClient.variation(`feat${bufferSize + 1}`, true); // eviction
31+
ldClient.variation('feat3', true); // update
32+
return true;
33+
}, FLAG_BUFFER_SIZE);
34+
35+
const reqPromise = waitForErrorRequest(page);
36+
await page.locator('#error').click();
37+
const req = await reqPromise;
38+
const event = envelopeRequestParser(req);
39+
40+
const expectedFlags = [{ flag: 'feat2', result: false }];
41+
for (let i = 4; i <= FLAG_BUFFER_SIZE; i++) {
42+
expectedFlags.push({ flag: `feat${i}`, result: false });
43+
}
44+
expectedFlags.push({ flag: `feat${FLAG_BUFFER_SIZE + 1}`, result: true });
45+
expectedFlags.push({ flag: 'feat3', result: true });
46+
47+
expect(event.contexts?.flags?.values).toEqual(expectedFlags);
48+
});

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

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
import * as Sentry from '@sentry/browser';
2+
3+
window.Sentry = Sentry;
4+
window.sentryLDIntegration = Sentry.launchDarklyIntegration();
5+
6+
Sentry.init({
7+
dsn: 'https://[email protected]/1337',
8+
sampleRate: 1.0,
9+
integrations: [window.sentryLDIntegration],
10+
});
11+
12+
// Manually mocking this because LD only has mock test utils for the React SDK.
13+
// Also, no SDK has mock utils for FlagUsedHandler's.
14+
const MockLaunchDarkly = {
15+
initialize(_clientId, context, options) {
16+
const flagUsedHandler = options && options.inspectors ? options.inspectors[0].method : undefined;
17+
18+
return {
19+
variation(key, defaultValue) {
20+
if (flagUsedHandler) {
21+
flagUsedHandler(key, { value: defaultValue }, context);
22+
}
23+
return defaultValue;
24+
},
25+
};
26+
},
27+
};
28+
29+
window.initializeLD = () => {
30+
return MockLaunchDarkly.initialize(
31+
'example-client-id',
32+
{ kind: 'user', key: 'example-context-key' },
33+
{ inspectors: [Sentry.buildLaunchDarklyFlagUsedHandler()] },
34+
);
35+
};

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

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
document.getElementById('error').addEventListener('click', () => {
2+
throw new Error('Button triggered error');
3+
});

‎dev-packages/browser-integration-tests/suites/integrations/featureFlags/launchdarkly/template.html

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8" />
5+
</head>
6+
<body>
7+
<button id="error">Throw Error</button>
8+
</body>
9+
</html>

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

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
import { expect } from '@playwright/test';
2+
3+
import { sentryTest } from '../../../../../utils/fixtures';
4+
5+
import { envelopeRequestParser, shouldSkipFeatureFlagsTest, waitForErrorRequest } from '../../../../../utils/helpers';
6+
7+
import type { Scope } from '@sentry/browser';
8+
9+
sentryTest('Flag evaluations in forked scopes are stored separately.', async ({ getLocalTestUrl, page }) => {
10+
if (shouldSkipFeatureFlagsTest()) {
11+
sentryTest.skip();
12+
}
13+
14+
await page.route('https://dsn.ingest.sentry.io/**/*', route => {
15+
return route.fulfill({
16+
status: 200,
17+
contentType: 'application/json',
18+
body: JSON.stringify({ id: 'test-id' }),
19+
});
20+
});
21+
22+
const url = await getLocalTestUrl({ testDir: __dirname, skipDsnRouteHandler: true });
23+
await page.goto(url);
24+
25+
const forkedReqPromise = waitForErrorRequest(page, event => !!event.tags && event.tags.isForked === true);
26+
const mainReqPromise = waitForErrorRequest(page, event => !!event.tags && event.tags.isForked === false);
27+
28+
await page.evaluate(() => {
29+
const Sentry = (window as any).Sentry;
30+
const errorButton = document.querySelector('#error') as HTMLButtonElement;
31+
const ldClient = (window as any).initializeLD();
32+
33+
ldClient.variation('shared', true);
34+
35+
Sentry.withScope((scope: Scope) => {
36+
ldClient.variation('forked', true);
37+
ldClient.variation('shared', false);
38+
scope.setTag('isForked', true);
39+
if (errorButton) {
40+
errorButton.click();
41+
}
42+
});
43+
44+
ldClient.variation('main', true);
45+
Sentry.getCurrentScope().setTag('isForked', false);
46+
errorButton.click();
47+
return true;
48+
});
49+
50+
const forkedReq = await forkedReqPromise;
51+
const forkedEvent = envelopeRequestParser(forkedReq);
52+
53+
const mainReq = await mainReqPromise;
54+
const mainEvent = envelopeRequestParser(mainReq);
55+
56+
expect(forkedEvent.contexts?.flags?.values).toEqual([
57+
{ flag: 'forked', result: true },
58+
{ flag: 'shared', result: false },
59+
]);
60+
61+
expect(mainEvent.contexts?.flags?.values).toEqual([
62+
{ flag: 'shared', result: true },
63+
{ flag: 'main', result: true },
64+
]);
65+
});

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

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
import { expect } from '@playwright/test';
2+
3+
import { sentryTest } from '../../../../../utils/fixtures';
4+
5+
import { envelopeRequestParser, shouldSkipFeatureFlagsTest, waitForErrorRequest } from '../../../../../utils/helpers';
6+
7+
const FLAG_BUFFER_SIZE = 100; // Corresponds to constant in featureFlags.ts, in browser utils.
8+
9+
sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
10+
if (shouldSkipFeatureFlagsTest()) {
11+
sentryTest.skip();
12+
}
13+
14+
await page.route('https://dsn.ingest.sentry.io/**/*', route => {
15+
return route.fulfill({
16+
status: 200,
17+
contentType: 'application/json',
18+
body: JSON.stringify({ id: 'test-id' }),
19+
});
20+
});
21+
22+
const url = await getLocalTestUrl({ testDir: __dirname, skipDsnRouteHandler: true });
23+
await page.goto(url);
24+
25+
await page.evaluate(bufferSize => {
26+
const client = (window as any).initialize();
27+
for (let i = 1; i <= bufferSize; i++) {
28+
client.getBooleanValue(`feat${i}`, false);
29+
}
30+
client.getBooleanValue(`feat${bufferSize + 1}`, true); // eviction
31+
client.getBooleanValue('feat3', true); // update
32+
}, FLAG_BUFFER_SIZE);
33+
34+
const reqPromise = waitForErrorRequest(page);
35+
await page.locator('#error').click();
36+
const req = await reqPromise;
37+
const event = envelopeRequestParser(req);
38+
39+
const expectedFlags = [{ flag: 'feat2', result: false }];
40+
for (let i = 4; i <= FLAG_BUFFER_SIZE; i++) {
41+
expectedFlags.push({ flag: `feat${i}`, result: false });
42+
}
43+
expectedFlags.push({ flag: `feat${FLAG_BUFFER_SIZE + 1}`, result: true });
44+
expectedFlags.push({ flag: 'feat3', result: true });
45+
46+
expect(event.contexts?.flags?.values).toEqual(expectedFlags);
47+
});

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

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
import * as Sentry from '@sentry/browser';
2+
3+
window.Sentry = Sentry;
4+
window.sentryOpenFeatureIntegration = Sentry.openFeatureIntegration();
5+
6+
Sentry.init({
7+
dsn: 'https://[email protected]/1337',
8+
sampleRate: 1.0,
9+
integrations: [window.sentryOpenFeatureIntegration],
10+
});
11+
12+
window.initialize = () => {
13+
return {
14+
getBooleanValue(flag, value) {
15+
let hook = new Sentry.OpenFeatureIntegrationHook();
16+
hook.error({ flagKey: flag, defaultValue: false }, new Error('flag eval error'));
17+
return value;
18+
},
19+
};
20+
};

‎dev-packages/browser-integration-tests/suites/integrations/featureFlags/openfeature/errorHook/test.ts

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
import { expect } from '@playwright/test';
2+
3+
import { sentryTest } from '../../../../../utils/fixtures';
4+
5+
import { envelopeRequestParser, shouldSkipFeatureFlagsTest, waitForErrorRequest } from '../../../../../utils/helpers';
6+
7+
const FLAG_BUFFER_SIZE = 100; // Corresponds to constant in featureFlags.ts, in browser utils.
8+
9+
sentryTest('Flag evaluation error hook', async ({ getLocalTestUrl, page }) => {
10+
if (shouldSkipFeatureFlagsTest()) {
11+
sentryTest.skip();
12+
}
13+
14+
await page.route('https://dsn.ingest.sentry.io/**/*', route => {
15+
return route.fulfill({
16+
status: 200,
17+
contentType: 'application/json',
18+
body: JSON.stringify({ id: 'test-id' }),
19+
});
20+
});
21+
22+
const url = await getLocalTestUrl({ testDir: __dirname, skipDsnRouteHandler: true });
23+
await page.goto(url);
24+
25+
await page.evaluate(bufferSize => {
26+
const client = (window as any).initialize();
27+
for (let i = 1; i <= bufferSize; i++) {
28+
client.getBooleanValue(`feat${i}`, false);
29+
}
30+
client.getBooleanValue(`feat${bufferSize + 1}`, true); // eviction
31+
client.getBooleanValue('feat3', true); // update
32+
}, FLAG_BUFFER_SIZE);
33+
34+
const reqPromise = waitForErrorRequest(page);
35+
await page.locator('#error').click();
36+
const req = await reqPromise;
37+
const event = envelopeRequestParser(req);
38+
39+
// Default value is mocked as false -- these will all error and use default
40+
// value
41+
const expectedFlags = [{ flag: 'feat2', result: false }];
42+
for (let i = 4; i <= FLAG_BUFFER_SIZE; i++) {
43+
expectedFlags.push({ flag: `feat${i}`, result: false });
44+
}
45+
expectedFlags.push({ flag: `feat${FLAG_BUFFER_SIZE + 1}`, result: false });
46+
expectedFlags.push({ flag: 'feat3', result: false });
47+
48+
expect(event.contexts?.flags?.values).toEqual(expectedFlags);
49+
});

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

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
import * as Sentry from '@sentry/browser';
2+
3+
window.Sentry = Sentry;
4+
window.sentryOpenFeatureIntegration = Sentry.openFeatureIntegration();
5+
6+
Sentry.init({
7+
dsn: 'https://[email protected]/1337',
8+
sampleRate: 1.0,
9+
integrations: [window.sentryOpenFeatureIntegration],
10+
});
11+
12+
window.initialize = () => {
13+
return {
14+
getBooleanValue(flag, value) {
15+
let hook = new Sentry.OpenFeatureIntegrationHook();
16+
hook.after(null, { flagKey: flag, value: value });
17+
return value;
18+
},
19+
};
20+
};

‎dev-packages/browser-integration-tests/suites/integrations/featureFlags/openfeature/subject.js

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
document.getElementById('error').addEventListener('click', () => {
2+
throw new Error('Button triggered error');
3+
});

‎dev-packages/browser-integration-tests/suites/integrations/featureFlags/openfeature/template.html

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8" />
5+
</head>
6+
<body>
7+
<button id="error">Throw Error</button>
8+
</body>
9+
</html>

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

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
import { expect } from '@playwright/test';
2+
3+
import { sentryTest } from '../../../../../utils/fixtures';
4+
5+
import { envelopeRequestParser, shouldSkipFeatureFlagsTest, waitForErrorRequest } from '../../../../../utils/helpers';
6+
7+
import type { Scope } from '@sentry/browser';
8+
9+
sentryTest('Flag evaluations in forked scopes are stored separately.', async ({ getLocalTestUrl, page }) => {
10+
if (shouldSkipFeatureFlagsTest()) {
11+
sentryTest.skip();
12+
}
13+
14+
await page.route('https://dsn.ingest.sentry.io/**/*', route => {
15+
return route.fulfill({
16+
status: 200,
17+
contentType: 'application/json',
18+
body: JSON.stringify({ id: 'test-id' }),
19+
});
20+
});
21+
22+
const url = await getLocalTestUrl({ testDir: __dirname, skipDsnRouteHandler: true });
23+
await page.goto(url);
24+
25+
const forkedReqPromise = waitForErrorRequest(page, event => !!event.tags && event.tags.isForked === true);
26+
const mainReqPromise = waitForErrorRequest(page, event => !!event.tags && event.tags.isForked === false);
27+
28+
await page.evaluate(() => {
29+
const Sentry = (window as any).Sentry;
30+
const errorButton = document.querySelector('#error') as HTMLButtonElement;
31+
const client = (window as any).initialize();
32+
33+
client.getBooleanValue('shared', true);
34+
35+
Sentry.withScope((scope: Scope) => {
36+
client.getBooleanValue('forked', true);
37+
client.getBooleanValue('shared', false);
38+
scope.setTag('isForked', true);
39+
if (errorButton) {
40+
errorButton.click();
41+
}
42+
});
43+
44+
client.getBooleanValue('main', true);
45+
Sentry.getCurrentScope().setTag('isForked', false);
46+
errorButton.click();
47+
return true;
48+
});
49+
50+
const forkedReq = await forkedReqPromise;
51+
const forkedEvent = envelopeRequestParser(forkedReq);
52+
53+
const mainReq = await mainReqPromise;
54+
const mainEvent = envelopeRequestParser(mainReq);
55+
56+
expect(forkedEvent.contexts?.flags?.values).toEqual([
57+
{ flag: 'forked', result: true },
58+
{ flag: 'shared', result: false },
59+
]);
60+
61+
expect(mainEvent.contexts?.flags?.values).toEqual([
62+
{ flag: 'shared', result: true },
63+
{ flag: 'main', result: true },
64+
]);
65+
});

0 commit comments

Comments
 (0)