feat(flags/v8): add Statsig browser integration#15347

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aliu39 merged 1 commit into from
Feb 10, 2025
Merged

feat(flags/v8): add Statsig browser integration #15347

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions dev-packages/browser-integration-tests/suites/integrations/featureFlags/constants.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export const FLAG_BUFFER_SIZE = 100; // Corresponds to constant in featureFlags.ts, in browser utils.
2 changes: 1 addition & 1 deletion ...ges/browser-integration-tests/suites/integrations/featureFlags/featureFlags/basic/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
if (shouldSkipFeatureFlagsTest()) {
Expand Down
2 changes: 1 addition & 1 deletion ...ges/browser-integration-tests/suites/integrations/featureFlags/launchdarkly/basic/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
if (shouldSkipFeatureFlagsTest()) {
Expand Down
2 changes: 1 addition & 1 deletion ...ages/browser-integration-tests/suites/integrations/featureFlags/openfeature/basic/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

@billyvgbillyvgFeb 10, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is fine for this PR, but in the future it'd be better practice to introduce the constant in this PR and do the refactor for the other integrations in a separate PR.


sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
if (shouldSkipFeatureFlagsTest()) {
Expand Down
2 changes: 1 addition & 1 deletion .../browser-integration-tests/suites/integrations/featureFlags/openfeature/errorHook/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Flag evaluation error hook', async ({ getLocalTestUrl, page }) => {
if (shouldSkipFeatureFlagsTest()) {
Expand Down
51 changes: 51 additions & 0 deletions ...packages/browser-integration-tests/suites/integrations/featureFlags/statsig/basic/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../../../utils/fixtures';

import { envelopeRequestParser, shouldSkipFeatureFlagsTest, waitForErrorRequest } from '../../../../../utils/helpers';

import { FLAG_BUFFER_SIZE } from '../../constants';

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).statsigClient;
for (let i = 1; i <= bufferSize; i++) {
client.checkGate(`feat${i}`); // values default to false
}

client.setMockGateValue(`feat${bufferSize + 1}`, true);
client.checkGate(`feat${bufferSize + 1}`); // eviction

client.setMockGateValue('feat3', true);
client.checkGate('feat3'); // 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);
});
35 changes: 35 additions & 0 deletions dev-packages/browser-integration-tests/suites/integrations/featureFlags/statsig/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
import * as Sentry from '@sentry/browser';

class MockStatsigClient {
constructor() {
this._gateEvaluationListeners = [];
this._mockGateValues = {};
}

on(event, listener) {
this._gateEvaluationListeners.push(listener);
}

checkGate(name) {
const value = this._mockGateValues[name] || false; // unknown features default to false.
this._gateEvaluationListeners.forEach(listener => {
listener({ gate: { name, value } });
});
return value;
}

setMockGateValue(name, value) {
this._mockGateValues[name] = value;
}
}

window.statsigClient = new MockStatsigClient();

window.Sentry = Sentry;
window.sentryStatsigIntegration = Sentry.statsigIntegration({ featureFlagClient: window.statsigClient });

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
sampleRate: 1.0,
integrations: [window.sentryStatsigIntegration],
});
3 changes: 3 additions & 0 deletions dev-packages/browser-integration-tests/suites/integrations/featureFlags/statsig/subject.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
document.getElementById('error').addEventListener('click', () => {
throw new Error('Button triggered error');
});
9 changes: 9 additions & 0 deletions ...packages/browser-integration-tests/suites/integrations/featureFlags/statsig/template.html
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
</head>
<body>
<button id="error">Throw Error</button>
</body>
</html>
69 changes: 69 additions & 0 deletions ...ages/browser-integration-tests/suites/integrations/featureFlags/statsig/withScope/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
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?.isForked === true);
const mainReqPromise = waitForErrorRequest(page, event => !!event.tags?.isForked === false);

await page.evaluate(() => {
const Sentry = (window as any).Sentry;
const errorButton = document.querySelector('#error') as HTMLButtonElement;
const client = (window as any).statsigClient;

client.setMockGateValue('shared', true);
client.setMockGateValue('main', true);

client.checkGate('shared');

Sentry.withScope((scope: Scope) => {
client.setMockGateValue('forked', true);
client.setMockGateValue('shared', false); // override the value in the parent scope.

client.checkGate('forked');
client.checkGate('shared');
scope.setTag('isForked', true);
errorButton.click();
});

client.checkGate('main');
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 },
]);
});
2 changes: 1 addition & 1 deletion ...packages/browser-integration-tests/suites/integrations/featureFlags/unleash/basic/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
if (shouldSkipFeatureFlagsTest()) {
Expand Down
1 change: 1 addition & 0 deletions packages/browser/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,3 +76,4 @@ export {
export { launchDarklyIntegration, buildLaunchDarklyFlagUsedHandler } from './integrations/featureFlags/launchdarkly';
export { openFeatureIntegration, OpenFeatureIntegrationHook } from './integrations/featureFlags/openfeature';
export { unleashIntegration } from './integrations/featureFlags/unleash';
export { statsigIntegration } from './integrations/featureFlags/statsig';
1 change: 1 addition & 0 deletions packages/browser/src/integrations/featureFlags/statsig/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export { statsigIntegration } from './integration';
46 changes: 46 additions & 0 deletions packages/browser/src/integrations/featureFlags/statsig/integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
import type { Client, Event, EventHint, IntegrationFn } from '@sentry/core';

import { defineIntegration } from '@sentry/core';
import { copyFlagsFromScopeToEvent, insertFlagToScope } from '../../../utils/featureFlags';
import type { FeatureGate, StatsigClient } from './types';

/**
* Sentry integration for capturing feature flag evaluations from the Statsig js-client SDK.
*
* See the [feature flag documentation](https://develop.sentry.dev/sdk/expected-features/#feature-flags) for more information.
*
* @example
* ```
* import { StatsigClient } from '@statsig/js-client';
* import * as Sentry from '@sentry/browser';
*
* const statsigClient = new StatsigClient();
*
* Sentry.init({
* dsn: '___PUBLIC_DSN___',
* integrations: [Sentry.statsigIntegration({featureFlagClient: statsigClient})],
* });
*
* await statsigClient.initializeAsync(); // or statsigClient.initializeSync();
*
* const result = statsigClient.checkGate('my-feature-gate');
* Sentry.captureException(new Error('something went wrong'));
* ```
*/
export const statsigIntegration = defineIntegration(
({ featureFlagClient: statsigClient }: { featureFlagClient: StatsigClient }) => {
return {
name: 'Statsig',

processEvent(event: Event, _hint: EventHint, _client: Client): Event {
return copyFlagsFromScopeToEvent(event);
},

setup() {
statsigClient.on('gate_evaluation', (event: { gate: FeatureGate }) => {
insertFlagToScope(event.gate.name, event.gate.value);
});
},
};
},
) satisfies IntegrationFn;
15 changes: 15 additions & 0 deletions packages/browser/src/integrations/featureFlags/statsig/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
export type FeatureGate = {
readonly name: string;
readonly value: boolean;
};

type EventNameToEventDataMap = {
gate_evaluation: { gate: FeatureGate };
};

export interface StatsigClient {
on(
event: keyof EventNameToEventDataMap,
callback: (data: EventNameToEventDataMap[keyof EventNameToEventDataMap]) => void,
): void;
}
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(flags/v8): add Statsig browser integration#15347

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

aliu39
merged 1 commit into

from

Feb 10, 2025
 Merged


feat(flags/v8): add Statsig browser integration
#15347
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/featureFlags/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export const FLAG_BUFFER_SIZE = 100; // Corresponds to constant in featureFlags.ts, in browser utils.

2 changes: 1 addition & 1 deletion
...ges/browser-integration-tests/suites/integrations/featureFlags/featureFlags/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

2 changes: 1 addition & 1 deletion
...ges/browser-integration-tests/suites/integrations/featureFlags/launchdarkly/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

2 changes: 1 addition & 1 deletion
...ages/browser-integration-tests/suites/integrations/featureFlags/openfeature/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';
@billyvgbillyvgFeb 10, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is fine for this PR, but in the future it'd be better practice to introduce the constant in this PR and do the refactor for the other integrations in a separate PR.

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

2 changes: 1 addition & 1 deletion
.../browser-integration-tests/suites/integrations/featureFlags/openfeature/errorHook/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Flag evaluation error hook', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

51 changes: 51 additions & 0 deletions
...packages/browser-integration-tests/suites/integrations/featureFlags/statsig/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../../../utils/fixtures';

import { envelopeRequestParser, shouldSkipFeatureFlagsTest, waitForErrorRequest } from '../../../../../utils/helpers';

import { FLAG_BUFFER_SIZE } from '../../constants';

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).statsigClient;
 for (let i = 1; i <= bufferSize; i++) {
 client.checkGate(`feat${i}`); // values default to false
 }

 client.setMockGateValue(`feat${bufferSize + 1}`, true);
 client.checkGate(`feat${bufferSize + 1}`); // eviction

 client.setMockGateValue('feat3', true);
 client.checkGate('feat3'); // 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);
});

35 changes: 35 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/featureFlags/statsig/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
import * as Sentry from '@sentry/browser';

class MockStatsigClient {
 constructor() {
 this._gateEvaluationListeners = [];
 this._mockGateValues = {};
 }

 on(event, listener) {
 this._gateEvaluationListeners.push(listener);
 }

 checkGate(name) {
 const value = this._mockGateValues[name] || false; // unknown features default to false.
 this._gateEvaluationListeners.forEach(listener => {
 listener({ gate: { name, value } });
 });
 return value;
 }

 setMockGateValue(name, value) {
 this._mockGateValues[name] = value;
 }
}

window.statsigClient = new MockStatsigClient();

window.Sentry = Sentry;
window.sentryStatsigIntegration = Sentry.statsigIntegration({ featureFlagClient: window.statsigClient });

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 sampleRate: 1.0,
 integrations: [window.sentryStatsigIntegration],
});

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/featureFlags/statsig/subject.js

View file


Open in desktop

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

9 changes: 9 additions & 0 deletions
...packages/browser-integration-tests/suites/integrations/featureFlags/statsig/template.html

View file


Open in desktop

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

69 changes: 69 additions & 0 deletions
...ages/browser-integration-tests/suites/integrations/featureFlags/statsig/withScope/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
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?.isForked === true);
 const mainReqPromise = waitForErrorRequest(page, event => !!event.tags?.isForked === false);

 await page.evaluate(() => {
 const Sentry = (window as any).Sentry;
 const errorButton = document.querySelector('#error') as HTMLButtonElement;
 const client = (window as any).statsigClient;

 client.setMockGateValue('shared', true);
 client.setMockGateValue('main', true);

 client.checkGate('shared');

 Sentry.withScope((scope: Scope) => {
 client.setMockGateValue('forked', true);
 client.setMockGateValue('shared', false); // override the value in the parent scope.

 client.checkGate('forked');
 client.checkGate('shared');
 scope.setTag('isForked', true);
 errorButton.click();
 });

 client.checkGate('main');
 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 },
 ]);
});

2 changes: 1 addition & 1 deletion
...packages/browser-integration-tests/suites/integrations/featureFlags/unleash/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

1 change: 1 addition & 0 deletions
packages/browser/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,3 +76,4 @@ export {
export { launchDarklyIntegration, buildLaunchDarklyFlagUsedHandler } from './integrations/featureFlags/launchdarkly';
export { openFeatureIntegration, OpenFeatureIntegrationHook } from './integrations/featureFlags/openfeature';
export { unleashIntegration } from './integrations/featureFlags/unleash';
export { statsigIntegration } from './integrations/featureFlags/statsig';

1 change: 1 addition & 0 deletions
packages/browser/src/integrations/featureFlags/statsig/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export { statsigIntegration } from './integration';

46 changes: 46 additions & 0 deletions
packages/browser/src/integrations/featureFlags/statsig/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
import type { Client, Event, EventHint, IntegrationFn } from '@sentry/core';

import { defineIntegration } from '@sentry/core';
import { copyFlagsFromScopeToEvent, insertFlagToScope } from '../../../utils/featureFlags';
import type { FeatureGate, StatsigClient } from './types';

/**
 * Sentry integration for capturing feature flag evaluations from the Statsig js-client SDK.
 *
 * See the [feature flag documentation](https://develop.sentry.dev/sdk/expected-features/#feature-flags) for more information.
 *
 * @example
 * ```
 * import { StatsigClient } from '@statsig/js-client';
 * import * as Sentry from '@sentry/browser';
 *
 * const statsigClient = new StatsigClient();
 *
 * Sentry.init({
 * dsn: '___PUBLIC_DSN___',
 * integrations: [Sentry.statsigIntegration({featureFlagClient: statsigClient})],
 * });
 *
 * await statsigClient.initializeAsync(); // or statsigClient.initializeSync();
 *
 * const result = statsigClient.checkGate('my-feature-gate');
 * Sentry.captureException(new Error('something went wrong'));
 * ```
 */
export const statsigIntegration = defineIntegration(
 ({ featureFlagClient: statsigClient }: { featureFlagClient: StatsigClient }) => {
 return {
 name: 'Statsig',

 processEvent(event: Event, _hint: EventHint, _client: Client): Event {
 return copyFlagsFromScopeToEvent(event);
 },

 setup() {
 statsigClient.on('gate_evaluation', (event: { gate: FeatureGate }) => {
 insertFlagToScope(event.gate.name, event.gate.value);
 });
 },
 };
 },
) satisfies IntegrationFn;

15 changes: 15 additions & 0 deletions
packages/browser/src/integrations/featureFlags/statsig/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
export type FeatureGate = {
 readonly name: string;
 readonly value: boolean;
};

type EventNameToEventDataMap = {
 gate_evaluation: { gate: FeatureGate };
};

export interface StatsigClient {
 on(
 event: keyof EventNameToEventDataMap,
 callback: (data: EventNameToEventDataMap[keyof EventNameToEventDataMap]) => void,
 ): void;
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(flags/v8): add Statsig browser integration#15347

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

aliu39
merged 1 commit into

from

Feb 10, 2025
 Merged


feat(flags/v8): add Statsig browser integration
#15347
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/featureFlags/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export const FLAG_BUFFER_SIZE = 100; // Corresponds to constant in featureFlags.ts, in browser utils.

2 changes: 1 addition & 1 deletion
...ges/browser-integration-tests/suites/integrations/featureFlags/featureFlags/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

2 changes: 1 addition & 1 deletion
...ges/browser-integration-tests/suites/integrations/featureFlags/launchdarkly/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

2 changes: 1 addition & 1 deletion
...ages/browser-integration-tests/suites/integrations/featureFlags/openfeature/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';
@billyvgbillyvgFeb 10, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is fine for this PR, but in the future it'd be better practice to introduce the constant in this PR and do the refactor for the other integrations in a separate PR.

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

2 changes: 1 addition & 1 deletion
.../browser-integration-tests/suites/integrations/featureFlags/openfeature/errorHook/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Flag evaluation error hook', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

51 changes: 51 additions & 0 deletions
...packages/browser-integration-tests/suites/integrations/featureFlags/statsig/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../../../utils/fixtures';

import { envelopeRequestParser, shouldSkipFeatureFlagsTest, waitForErrorRequest } from '../../../../../utils/helpers';

import { FLAG_BUFFER_SIZE } from '../../constants';

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).statsigClient;
 for (let i = 1; i <= bufferSize; i++) {
 client.checkGate(`feat${i}`); // values default to false
 }

 client.setMockGateValue(`feat${bufferSize + 1}`, true);
 client.checkGate(`feat${bufferSize + 1}`); // eviction

 client.setMockGateValue('feat3', true);
 client.checkGate('feat3'); // 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);
});

35 changes: 35 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/featureFlags/statsig/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
import * as Sentry from '@sentry/browser';

class MockStatsigClient {
 constructor() {
 this._gateEvaluationListeners = [];
 this._mockGateValues = {};
 }

 on(event, listener) {
 this._gateEvaluationListeners.push(listener);
 }

 checkGate(name) {
 const value = this._mockGateValues[name] || false; // unknown features default to false.
 this._gateEvaluationListeners.forEach(listener => {
 listener({ gate: { name, value } });
 });
 return value;
 }

 setMockGateValue(name, value) {
 this._mockGateValues[name] = value;
 }
}

window.statsigClient = new MockStatsigClient();

window.Sentry = Sentry;
window.sentryStatsigIntegration = Sentry.statsigIntegration({ featureFlagClient: window.statsigClient });

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 sampleRate: 1.0,
 integrations: [window.sentryStatsigIntegration],
});

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/featureFlags/statsig/subject.js

View file


Open in desktop

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

9 changes: 9 additions & 0 deletions
...packages/browser-integration-tests/suites/integrations/featureFlags/statsig/template.html

View file


Open in desktop

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

69 changes: 69 additions & 0 deletions
...ages/browser-integration-tests/suites/integrations/featureFlags/statsig/withScope/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
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?.isForked === true);
 const mainReqPromise = waitForErrorRequest(page, event => !!event.tags?.isForked === false);

 await page.evaluate(() => {
 const Sentry = (window as any).Sentry;
 const errorButton = document.querySelector('#error') as HTMLButtonElement;
 const client = (window as any).statsigClient;

 client.setMockGateValue('shared', true);
 client.setMockGateValue('main', true);

 client.checkGate('shared');

 Sentry.withScope((scope: Scope) => {
 client.setMockGateValue('forked', true);
 client.setMockGateValue('shared', false); // override the value in the parent scope.

 client.checkGate('forked');
 client.checkGate('shared');
 scope.setTag('isForked', true);
 errorButton.click();
 });

 client.checkGate('main');
 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 },
 ]);
});

2 changes: 1 addition & 1 deletion
...packages/browser-integration-tests/suites/integrations/featureFlags/unleash/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

1 change: 1 addition & 0 deletions
packages/browser/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,3 +76,4 @@ export {
export { launchDarklyIntegration, buildLaunchDarklyFlagUsedHandler } from './integrations/featureFlags/launchdarkly';
export { openFeatureIntegration, OpenFeatureIntegrationHook } from './integrations/featureFlags/openfeature';
export { unleashIntegration } from './integrations/featureFlags/unleash';
export { statsigIntegration } from './integrations/featureFlags/statsig';

1 change: 1 addition & 0 deletions
packages/browser/src/integrations/featureFlags/statsig/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export { statsigIntegration } from './integration';

46 changes: 46 additions & 0 deletions
packages/browser/src/integrations/featureFlags/statsig/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
import type { Client, Event, EventHint, IntegrationFn } from '@sentry/core';

import { defineIntegration } from '@sentry/core';
import { copyFlagsFromScopeToEvent, insertFlagToScope } from '../../../utils/featureFlags';
import type { FeatureGate, StatsigClient } from './types';

/**
 * Sentry integration for capturing feature flag evaluations from the Statsig js-client SDK.
 *
 * See the [feature flag documentation](https://develop.sentry.dev/sdk/expected-features/#feature-flags) for more information.
 *
 * @example
 * ```
 * import { StatsigClient } from '@statsig/js-client';
 * import * as Sentry from '@sentry/browser';
 *
 * const statsigClient = new StatsigClient();
 *
 * Sentry.init({
 * dsn: '___PUBLIC_DSN___',
 * integrations: [Sentry.statsigIntegration({featureFlagClient: statsigClient})],
 * });
 *
 * await statsigClient.initializeAsync(); // or statsigClient.initializeSync();
 *
 * const result = statsigClient.checkGate('my-feature-gate');
 * Sentry.captureException(new Error('something went wrong'));
 * ```
 */
export const statsigIntegration = defineIntegration(
 ({ featureFlagClient: statsigClient }: { featureFlagClient: StatsigClient }) => {
 return {
 name: 'Statsig',

 processEvent(event: Event, _hint: EventHint, _client: Client): Event {
 return copyFlagsFromScopeToEvent(event);
 },

 setup() {
 statsigClient.on('gate_evaluation', (event: { gate: FeatureGate }) => {
 insertFlagToScope(event.gate.name, event.gate.value);
 });
 },
 };
 },
) satisfies IntegrationFn;

15 changes: 15 additions & 0 deletions
packages/browser/src/integrations/featureFlags/statsig/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
export type FeatureGate = {
 readonly name: string;
 readonly value: boolean;
};

type EventNameToEventDataMap = {
 gate_evaluation: { gate: FeatureGate };
};

export interface StatsigClient {
 on(
 event: keyof EventNameToEventDataMap,
 callback: (data: EventNameToEventDataMap[keyof EventNameToEventDataMap]) => void,
 ): void;
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(flags/v8): add Statsig browser integration#15347

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

aliu39
merged 1 commit into

from

Feb 10, 2025
 Merged


feat(flags/v8): add Statsig browser integration
#15347
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/featureFlags/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export const FLAG_BUFFER_SIZE = 100; // Corresponds to constant in featureFlags.ts, in browser utils.

2 changes: 1 addition & 1 deletion
...ges/browser-integration-tests/suites/integrations/featureFlags/featureFlags/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

2 changes: 1 addition & 1 deletion
...ges/browser-integration-tests/suites/integrations/featureFlags/launchdarkly/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

2 changes: 1 addition & 1 deletion
...ages/browser-integration-tests/suites/integrations/featureFlags/openfeature/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';
@billyvgbillyvgFeb 10, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is fine for this PR, but in the future it'd be better practice to introduce the constant in this PR and do the refactor for the other integrations in a separate PR.

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

2 changes: 1 addition & 1 deletion
.../browser-integration-tests/suites/integrations/featureFlags/openfeature/errorHook/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Flag evaluation error hook', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

51 changes: 51 additions & 0 deletions
...packages/browser-integration-tests/suites/integrations/featureFlags/statsig/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../../../utils/fixtures';

import { envelopeRequestParser, shouldSkipFeatureFlagsTest, waitForErrorRequest } from '../../../../../utils/helpers';

import { FLAG_BUFFER_SIZE } from '../../constants';

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).statsigClient;
 for (let i = 1; i <= bufferSize; i++) {
 client.checkGate(`feat${i}`); // values default to false
 }

 client.setMockGateValue(`feat${bufferSize + 1}`, true);
 client.checkGate(`feat${bufferSize + 1}`); // eviction

 client.setMockGateValue('feat3', true);
 client.checkGate('feat3'); // 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);
});

35 changes: 35 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/featureFlags/statsig/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
import * as Sentry from '@sentry/browser';

class MockStatsigClient {
 constructor() {
 this._gateEvaluationListeners = [];
 this._mockGateValues = {};
 }

 on(event, listener) {
 this._gateEvaluationListeners.push(listener);
 }

 checkGate(name) {
 const value = this._mockGateValues[name] || false; // unknown features default to false.
 this._gateEvaluationListeners.forEach(listener => {
 listener({ gate: { name, value } });
 });
 return value;
 }

 setMockGateValue(name, value) {
 this._mockGateValues[name] = value;
 }
}

window.statsigClient = new MockStatsigClient();

window.Sentry = Sentry;
window.sentryStatsigIntegration = Sentry.statsigIntegration({ featureFlagClient: window.statsigClient });

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 sampleRate: 1.0,
 integrations: [window.sentryStatsigIntegration],
});

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/featureFlags/statsig/subject.js

View file


Open in desktop

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

9 changes: 9 additions & 0 deletions
...packages/browser-integration-tests/suites/integrations/featureFlags/statsig/template.html

View file


Open in desktop

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

69 changes: 69 additions & 0 deletions
...ages/browser-integration-tests/suites/integrations/featureFlags/statsig/withScope/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
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?.isForked === true);
 const mainReqPromise = waitForErrorRequest(page, event => !!event.tags?.isForked === false);

 await page.evaluate(() => {
 const Sentry = (window as any).Sentry;
 const errorButton = document.querySelector('#error') as HTMLButtonElement;
 const client = (window as any).statsigClient;

 client.setMockGateValue('shared', true);
 client.setMockGateValue('main', true);

 client.checkGate('shared');

 Sentry.withScope((scope: Scope) => {
 client.setMockGateValue('forked', true);
 client.setMockGateValue('shared', false); // override the value in the parent scope.

 client.checkGate('forked');
 client.checkGate('shared');
 scope.setTag('isForked', true);
 errorButton.click();
 });

 client.checkGate('main');
 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 },
 ]);
});

2 changes: 1 addition & 1 deletion
...packages/browser-integration-tests/suites/integrations/featureFlags/unleash/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

1 change: 1 addition & 0 deletions
packages/browser/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,3 +76,4 @@ export {
export { launchDarklyIntegration, buildLaunchDarklyFlagUsedHandler } from './integrations/featureFlags/launchdarkly';
export { openFeatureIntegration, OpenFeatureIntegrationHook } from './integrations/featureFlags/openfeature';
export { unleashIntegration } from './integrations/featureFlags/unleash';
export { statsigIntegration } from './integrations/featureFlags/statsig';

1 change: 1 addition & 0 deletions
packages/browser/src/integrations/featureFlags/statsig/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export { statsigIntegration } from './integration';

46 changes: 46 additions & 0 deletions
packages/browser/src/integrations/featureFlags/statsig/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
import type { Client, Event, EventHint, IntegrationFn } from '@sentry/core';

import { defineIntegration } from '@sentry/core';
import { copyFlagsFromScopeToEvent, insertFlagToScope } from '../../../utils/featureFlags';
import type { FeatureGate, StatsigClient } from './types';

/**
 * Sentry integration for capturing feature flag evaluations from the Statsig js-client SDK.
 *
 * See the [feature flag documentation](https://develop.sentry.dev/sdk/expected-features/#feature-flags) for more information.
 *
 * @example
 * ```
 * import { StatsigClient } from '@statsig/js-client';
 * import * as Sentry from '@sentry/browser';
 *
 * const statsigClient = new StatsigClient();
 *
 * Sentry.init({
 * dsn: '___PUBLIC_DSN___',
 * integrations: [Sentry.statsigIntegration({featureFlagClient: statsigClient})],
 * });
 *
 * await statsigClient.initializeAsync(); // or statsigClient.initializeSync();
 *
 * const result = statsigClient.checkGate('my-feature-gate');
 * Sentry.captureException(new Error('something went wrong'));
 * ```
 */
export const statsigIntegration = defineIntegration(
 ({ featureFlagClient: statsigClient }: { featureFlagClient: StatsigClient }) => {
 return {
 name: 'Statsig',

 processEvent(event: Event, _hint: EventHint, _client: Client): Event {
 return copyFlagsFromScopeToEvent(event);
 },

 setup() {
 statsigClient.on('gate_evaluation', (event: { gate: FeatureGate }) => {
 insertFlagToScope(event.gate.name, event.gate.value);
 });
 },
 };
 },
) satisfies IntegrationFn;

15 changes: 15 additions & 0 deletions
packages/browser/src/integrations/featureFlags/statsig/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
export type FeatureGate = {
 readonly name: string;
 readonly value: boolean;
};

type EventNameToEventDataMap = {
 gate_evaluation: { gate: FeatureGate };
};

export interface StatsigClient {
 on(
 event: keyof EventNameToEventDataMap,
 callback: (data: EventNameToEventDataMap[keyof EventNameToEventDataMap]) => void,
 ): void;
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(flags/v8): add Statsig browser integration#15347

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

aliu39
merged 1 commit into

from

Feb 10, 2025
 Merged


feat(flags/v8): add Statsig browser integration
#15347
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/featureFlags/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export const FLAG_BUFFER_SIZE = 100; // Corresponds to constant in featureFlags.ts, in browser utils.

2 changes: 1 addition & 1 deletion
...ges/browser-integration-tests/suites/integrations/featureFlags/featureFlags/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

2 changes: 1 addition & 1 deletion
...ges/browser-integration-tests/suites/integrations/featureFlags/launchdarkly/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

2 changes: 1 addition & 1 deletion
...ages/browser-integration-tests/suites/integrations/featureFlags/openfeature/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';
@billyvgbillyvgFeb 10, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is fine for this PR, but in the future it'd be better practice to introduce the constant in this PR and do the refactor for the other integrations in a separate PR.

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

2 changes: 1 addition & 1 deletion
.../browser-integration-tests/suites/integrations/featureFlags/openfeature/errorHook/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Flag evaluation error hook', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

51 changes: 51 additions & 0 deletions
...packages/browser-integration-tests/suites/integrations/featureFlags/statsig/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../../../utils/fixtures';

import { envelopeRequestParser, shouldSkipFeatureFlagsTest, waitForErrorRequest } from '../../../../../utils/helpers';

import { FLAG_BUFFER_SIZE } from '../../constants';

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).statsigClient;
 for (let i = 1; i <= bufferSize; i++) {
 client.checkGate(`feat${i}`); // values default to false
 }

 client.setMockGateValue(`feat${bufferSize + 1}`, true);
 client.checkGate(`feat${bufferSize + 1}`); // eviction

 client.setMockGateValue('feat3', true);
 client.checkGate('feat3'); // 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);
});

35 changes: 35 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/featureFlags/statsig/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
import * as Sentry from '@sentry/browser';

class MockStatsigClient {
 constructor() {
 this._gateEvaluationListeners = [];
 this._mockGateValues = {};
 }

 on(event, listener) {
 this._gateEvaluationListeners.push(listener);
 }

 checkGate(name) {
 const value = this._mockGateValues[name] || false; // unknown features default to false.
 this._gateEvaluationListeners.forEach(listener => {
 listener({ gate: { name, value } });
 });
 return value;
 }

 setMockGateValue(name, value) {
 this._mockGateValues[name] = value;
 }
}

window.statsigClient = new MockStatsigClient();

window.Sentry = Sentry;
window.sentryStatsigIntegration = Sentry.statsigIntegration({ featureFlagClient: window.statsigClient });

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 sampleRate: 1.0,
 integrations: [window.sentryStatsigIntegration],
});

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/featureFlags/statsig/subject.js

View file


Open in desktop

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

9 changes: 9 additions & 0 deletions
...packages/browser-integration-tests/suites/integrations/featureFlags/statsig/template.html

View file


Open in desktop

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

69 changes: 69 additions & 0 deletions
...ages/browser-integration-tests/suites/integrations/featureFlags/statsig/withScope/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
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?.isForked === true);
 const mainReqPromise = waitForErrorRequest(page, event => !!event.tags?.isForked === false);

 await page.evaluate(() => {
 const Sentry = (window as any).Sentry;
 const errorButton = document.querySelector('#error') as HTMLButtonElement;
 const client = (window as any).statsigClient;

 client.setMockGateValue('shared', true);
 client.setMockGateValue('main', true);

 client.checkGate('shared');

 Sentry.withScope((scope: Scope) => {
 client.setMockGateValue('forked', true);
 client.setMockGateValue('shared', false); // override the value in the parent scope.

 client.checkGate('forked');
 client.checkGate('shared');
 scope.setTag('isForked', true);
 errorButton.click();
 });

 client.checkGate('main');
 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 },
 ]);
});

2 changes: 1 addition & 1 deletion
...packages/browser-integration-tests/suites/integrations/featureFlags/unleash/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

1 change: 1 addition & 0 deletions
packages/browser/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,3 +76,4 @@ export {
export { launchDarklyIntegration, buildLaunchDarklyFlagUsedHandler } from './integrations/featureFlags/launchdarkly';
export { openFeatureIntegration, OpenFeatureIntegrationHook } from './integrations/featureFlags/openfeature';
export { unleashIntegration } from './integrations/featureFlags/unleash';
export { statsigIntegration } from './integrations/featureFlags/statsig';

1 change: 1 addition & 0 deletions
packages/browser/src/integrations/featureFlags/statsig/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export { statsigIntegration } from './integration';

46 changes: 46 additions & 0 deletions
packages/browser/src/integrations/featureFlags/statsig/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
import type { Client, Event, EventHint, IntegrationFn } from '@sentry/core';

import { defineIntegration } from '@sentry/core';
import { copyFlagsFromScopeToEvent, insertFlagToScope } from '../../../utils/featureFlags';
import type { FeatureGate, StatsigClient } from './types';

/**
 * Sentry integration for capturing feature flag evaluations from the Statsig js-client SDK.
 *
 * See the [feature flag documentation](https://develop.sentry.dev/sdk/expected-features/#feature-flags) for more information.
 *
 * @example
 * ```
 * import { StatsigClient } from '@statsig/js-client';
 * import * as Sentry from '@sentry/browser';
 *
 * const statsigClient = new StatsigClient();
 *
 * Sentry.init({
 * dsn: '___PUBLIC_DSN___',
 * integrations: [Sentry.statsigIntegration({featureFlagClient: statsigClient})],
 * });
 *
 * await statsigClient.initializeAsync(); // or statsigClient.initializeSync();
 *
 * const result = statsigClient.checkGate('my-feature-gate');
 * Sentry.captureException(new Error('something went wrong'));
 * ```
 */
export const statsigIntegration = defineIntegration(
 ({ featureFlagClient: statsigClient }: { featureFlagClient: StatsigClient }) => {
 return {
 name: 'Statsig',

 processEvent(event: Event, _hint: EventHint, _client: Client): Event {
 return copyFlagsFromScopeToEvent(event);
 },

 setup() {
 statsigClient.on('gate_evaluation', (event: { gate: FeatureGate }) => {
 insertFlagToScope(event.gate.name, event.gate.value);
 });
 },
 };
 },
) satisfies IntegrationFn;

15 changes: 15 additions & 0 deletions
packages/browser/src/integrations/featureFlags/statsig/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
export type FeatureGate = {
 readonly name: string;
 readonly value: boolean;
};

type EventNameToEventDataMap = {
 gate_evaluation: { gate: FeatureGate };
};

export interface StatsigClient {
 on(
 event: keyof EventNameToEventDataMap,
 callback: (data: EventNameToEventDataMap[keyof EventNameToEventDataMap]) => void,
 ): void;
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(flags/v8): add Statsig browser integration#15347

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

aliu39
merged 1 commit into

from

Feb 10, 2025
 Merged


feat(flags/v8): add Statsig browser integration
#15347
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/featureFlags/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export const FLAG_BUFFER_SIZE = 100; // Corresponds to constant in featureFlags.ts, in browser utils.

2 changes: 1 addition & 1 deletion
...ges/browser-integration-tests/suites/integrations/featureFlags/featureFlags/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

2 changes: 1 addition & 1 deletion
...ges/browser-integration-tests/suites/integrations/featureFlags/launchdarkly/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

2 changes: 1 addition & 1 deletion
...ages/browser-integration-tests/suites/integrations/featureFlags/openfeature/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';
@billyvgbillyvgFeb 10, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is fine for this PR, but in the future it'd be better practice to introduce the constant in this PR and do the refactor for the other integrations in a separate PR.

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

2 changes: 1 addition & 1 deletion
.../browser-integration-tests/suites/integrations/featureFlags/openfeature/errorHook/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Flag evaluation error hook', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

51 changes: 51 additions & 0 deletions
...packages/browser-integration-tests/suites/integrations/featureFlags/statsig/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../../../utils/fixtures';

import { envelopeRequestParser, shouldSkipFeatureFlagsTest, waitForErrorRequest } from '../../../../../utils/helpers';

import { FLAG_BUFFER_SIZE } from '../../constants';

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).statsigClient;
 for (let i = 1; i <= bufferSize; i++) {
 client.checkGate(`feat${i}`); // values default to false
 }

 client.setMockGateValue(`feat${bufferSize + 1}`, true);
 client.checkGate(`feat${bufferSize + 1}`); // eviction

 client.setMockGateValue('feat3', true);
 client.checkGate('feat3'); // 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);
});

35 changes: 35 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/featureFlags/statsig/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
import * as Sentry from '@sentry/browser';

class MockStatsigClient {
 constructor() {
 this._gateEvaluationListeners = [];
 this._mockGateValues = {};
 }

 on(event, listener) {
 this._gateEvaluationListeners.push(listener);
 }

 checkGate(name) {
 const value = this._mockGateValues[name] || false; // unknown features default to false.
 this._gateEvaluationListeners.forEach(listener => {
 listener({ gate: { name, value } });
 });
 return value;
 }

 setMockGateValue(name, value) {
 this._mockGateValues[name] = value;
 }
}

window.statsigClient = new MockStatsigClient();

window.Sentry = Sentry;
window.sentryStatsigIntegration = Sentry.statsigIntegration({ featureFlagClient: window.statsigClient });

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 sampleRate: 1.0,
 integrations: [window.sentryStatsigIntegration],
});

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/featureFlags/statsig/subject.js

View file


Open in desktop

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

9 changes: 9 additions & 0 deletions
...packages/browser-integration-tests/suites/integrations/featureFlags/statsig/template.html

View file


Open in desktop

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

69 changes: 69 additions & 0 deletions
...ages/browser-integration-tests/suites/integrations/featureFlags/statsig/withScope/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
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?.isForked === true);
 const mainReqPromise = waitForErrorRequest(page, event => !!event.tags?.isForked === false);

 await page.evaluate(() => {
 const Sentry = (window as any).Sentry;
 const errorButton = document.querySelector('#error') as HTMLButtonElement;
 const client = (window as any).statsigClient;

 client.setMockGateValue('shared', true);
 client.setMockGateValue('main', true);

 client.checkGate('shared');

 Sentry.withScope((scope: Scope) => {
 client.setMockGateValue('forked', true);
 client.setMockGateValue('shared', false); // override the value in the parent scope.

 client.checkGate('forked');
 client.checkGate('shared');
 scope.setTag('isForked', true);
 errorButton.click();
 });

 client.checkGate('main');
 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 },
 ]);
});

2 changes: 1 addition & 1 deletion
...packages/browser-integration-tests/suites/integrations/featureFlags/unleash/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

1 change: 1 addition & 0 deletions
packages/browser/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,3 +76,4 @@ export {
export { launchDarklyIntegration, buildLaunchDarklyFlagUsedHandler } from './integrations/featureFlags/launchdarkly';
export { openFeatureIntegration, OpenFeatureIntegrationHook } from './integrations/featureFlags/openfeature';
export { unleashIntegration } from './integrations/featureFlags/unleash';
export { statsigIntegration } from './integrations/featureFlags/statsig';

1 change: 1 addition & 0 deletions
packages/browser/src/integrations/featureFlags/statsig/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export { statsigIntegration } from './integration';

46 changes: 46 additions & 0 deletions
packages/browser/src/integrations/featureFlags/statsig/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
import type { Client, Event, EventHint, IntegrationFn } from '@sentry/core';

import { defineIntegration } from '@sentry/core';
import { copyFlagsFromScopeToEvent, insertFlagToScope } from '../../../utils/featureFlags';
import type { FeatureGate, StatsigClient } from './types';

/**
 * Sentry integration for capturing feature flag evaluations from the Statsig js-client SDK.
 *
 * See the [feature flag documentation](https://develop.sentry.dev/sdk/expected-features/#feature-flags) for more information.
 *
 * @example
 * ```
 * import { StatsigClient } from '@statsig/js-client';
 * import * as Sentry from '@sentry/browser';
 *
 * const statsigClient = new StatsigClient();
 *
 * Sentry.init({
 * dsn: '___PUBLIC_DSN___',
 * integrations: [Sentry.statsigIntegration({featureFlagClient: statsigClient})],
 * });
 *
 * await statsigClient.initializeAsync(); // or statsigClient.initializeSync();
 *
 * const result = statsigClient.checkGate('my-feature-gate');
 * Sentry.captureException(new Error('something went wrong'));
 * ```
 */
export const statsigIntegration = defineIntegration(
 ({ featureFlagClient: statsigClient }: { featureFlagClient: StatsigClient }) => {
 return {
 name: 'Statsig',

 processEvent(event: Event, _hint: EventHint, _client: Client): Event {
 return copyFlagsFromScopeToEvent(event);
 },

 setup() {
 statsigClient.on('gate_evaluation', (event: { gate: FeatureGate }) => {
 insertFlagToScope(event.gate.name, event.gate.value);
 });
 },
 };
 },
) satisfies IntegrationFn;

15 changes: 15 additions & 0 deletions
packages/browser/src/integrations/featureFlags/statsig/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
export type FeatureGate = {
 readonly name: string;
 readonly value: boolean;
};

type EventNameToEventDataMap = {
 gate_evaluation: { gate: FeatureGate };
};

export interface StatsigClient {
 on(
 event: keyof EventNameToEventDataMap,
 callback: (data: EventNameToEventDataMap[keyof EventNameToEventDataMap]) => void,
 ): void;
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(flags/v8): add Statsig browser integration#15347

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

aliu39
merged 1 commit into

from

Feb 10, 2025
 Merged


feat(flags/v8): add Statsig browser integration
#15347
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/featureFlags/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export const FLAG_BUFFER_SIZE = 100; // Corresponds to constant in featureFlags.ts, in browser utils.

2 changes: 1 addition & 1 deletion
...ges/browser-integration-tests/suites/integrations/featureFlags/featureFlags/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

2 changes: 1 addition & 1 deletion
...ges/browser-integration-tests/suites/integrations/featureFlags/launchdarkly/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

2 changes: 1 addition & 1 deletion
...ages/browser-integration-tests/suites/integrations/featureFlags/openfeature/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';
@billyvgbillyvgFeb 10, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is fine for this PR, but in the future it'd be better practice to introduce the constant in this PR and do the refactor for the other integrations in a separate PR.

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

2 changes: 1 addition & 1 deletion
.../browser-integration-tests/suites/integrations/featureFlags/openfeature/errorHook/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Flag evaluation error hook', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

51 changes: 51 additions & 0 deletions
...packages/browser-integration-tests/suites/integrations/featureFlags/statsig/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../../../utils/fixtures';

import { envelopeRequestParser, shouldSkipFeatureFlagsTest, waitForErrorRequest } from '../../../../../utils/helpers';

import { FLAG_BUFFER_SIZE } from '../../constants';

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).statsigClient;
 for (let i = 1; i <= bufferSize; i++) {
 client.checkGate(`feat${i}`); // values default to false
 }

 client.setMockGateValue(`feat${bufferSize + 1}`, true);
 client.checkGate(`feat${bufferSize + 1}`); // eviction

 client.setMockGateValue('feat3', true);
 client.checkGate('feat3'); // 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);
});

35 changes: 35 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/featureFlags/statsig/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
import * as Sentry from '@sentry/browser';

class MockStatsigClient {
 constructor() {
 this._gateEvaluationListeners = [];
 this._mockGateValues = {};
 }

 on(event, listener) {
 this._gateEvaluationListeners.push(listener);
 }

 checkGate(name) {
 const value = this._mockGateValues[name] || false; // unknown features default to false.
 this._gateEvaluationListeners.forEach(listener => {
 listener({ gate: { name, value } });
 });
 return value;
 }

 setMockGateValue(name, value) {
 this._mockGateValues[name] = value;
 }
}

window.statsigClient = new MockStatsigClient();

window.Sentry = Sentry;
window.sentryStatsigIntegration = Sentry.statsigIntegration({ featureFlagClient: window.statsigClient });

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 sampleRate: 1.0,
 integrations: [window.sentryStatsigIntegration],
});

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/featureFlags/statsig/subject.js

View file


Open in desktop

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

9 changes: 9 additions & 0 deletions
...packages/browser-integration-tests/suites/integrations/featureFlags/statsig/template.html

View file


Open in desktop

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

69 changes: 69 additions & 0 deletions
...ages/browser-integration-tests/suites/integrations/featureFlags/statsig/withScope/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
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?.isForked === true);
 const mainReqPromise = waitForErrorRequest(page, event => !!event.tags?.isForked === false);

 await page.evaluate(() => {
 const Sentry = (window as any).Sentry;
 const errorButton = document.querySelector('#error') as HTMLButtonElement;
 const client = (window as any).statsigClient;

 client.setMockGateValue('shared', true);
 client.setMockGateValue('main', true);

 client.checkGate('shared');

 Sentry.withScope((scope: Scope) => {
 client.setMockGateValue('forked', true);
 client.setMockGateValue('shared', false); // override the value in the parent scope.

 client.checkGate('forked');
 client.checkGate('shared');
 scope.setTag('isForked', true);
 errorButton.click();
 });

 client.checkGate('main');
 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 },
 ]);
});

2 changes: 1 addition & 1 deletion
...packages/browser-integration-tests/suites/integrations/featureFlags/unleash/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

1 change: 1 addition & 0 deletions
packages/browser/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,3 +76,4 @@ export {
export { launchDarklyIntegration, buildLaunchDarklyFlagUsedHandler } from './integrations/featureFlags/launchdarkly';
export { openFeatureIntegration, OpenFeatureIntegrationHook } from './integrations/featureFlags/openfeature';
export { unleashIntegration } from './integrations/featureFlags/unleash';
export { statsigIntegration } from './integrations/featureFlags/statsig';

1 change: 1 addition & 0 deletions
packages/browser/src/integrations/featureFlags/statsig/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export { statsigIntegration } from './integration';

46 changes: 46 additions & 0 deletions
packages/browser/src/integrations/featureFlags/statsig/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
import type { Client, Event, EventHint, IntegrationFn } from '@sentry/core';

import { defineIntegration } from '@sentry/core';
import { copyFlagsFromScopeToEvent, insertFlagToScope } from '../../../utils/featureFlags';
import type { FeatureGate, StatsigClient } from './types';

/**
 * Sentry integration for capturing feature flag evaluations from the Statsig js-client SDK.
 *
 * See the [feature flag documentation](https://develop.sentry.dev/sdk/expected-features/#feature-flags) for more information.
 *
 * @example
 * ```
 * import { StatsigClient } from '@statsig/js-client';
 * import * as Sentry from '@sentry/browser';
 *
 * const statsigClient = new StatsigClient();
 *
 * Sentry.init({
 * dsn: '___PUBLIC_DSN___',
 * integrations: [Sentry.statsigIntegration({featureFlagClient: statsigClient})],
 * });
 *
 * await statsigClient.initializeAsync(); // or statsigClient.initializeSync();
 *
 * const result = statsigClient.checkGate('my-feature-gate');
 * Sentry.captureException(new Error('something went wrong'));
 * ```
 */
export const statsigIntegration = defineIntegration(
 ({ featureFlagClient: statsigClient }: { featureFlagClient: StatsigClient }) => {
 return {
 name: 'Statsig',

 processEvent(event: Event, _hint: EventHint, _client: Client): Event {
 return copyFlagsFromScopeToEvent(event);
 },

 setup() {
 statsigClient.on('gate_evaluation', (event: { gate: FeatureGate }) => {
 insertFlagToScope(event.gate.name, event.gate.value);
 });
 },
 };
 },
) satisfies IntegrationFn;

15 changes: 15 additions & 0 deletions
packages/browser/src/integrations/featureFlags/statsig/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
export type FeatureGate = {
 readonly name: string;
 readonly value: boolean;
};

type EventNameToEventDataMap = {
 gate_evaluation: { gate: FeatureGate };
};

export interface StatsigClient {
 on(
 event: keyof EventNameToEventDataMap,
 callback: (data: EventNameToEventDataMap[keyof EventNameToEventDataMap]) => void,
 ): void;
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(flags/v8): add Statsig browser integration#15347

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

aliu39
merged 1 commit into

from

Feb 10, 2025
 Merged


feat(flags/v8): add Statsig browser integration
#15347
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/featureFlags/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export const FLAG_BUFFER_SIZE = 100; // Corresponds to constant in featureFlags.ts, in browser utils.

2 changes: 1 addition & 1 deletion
...ges/browser-integration-tests/suites/integrations/featureFlags/featureFlags/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

2 changes: 1 addition & 1 deletion
...ges/browser-integration-tests/suites/integrations/featureFlags/launchdarkly/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

2 changes: 1 addition & 1 deletion
...ages/browser-integration-tests/suites/integrations/featureFlags/openfeature/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';
@billyvgbillyvgFeb 10, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is fine for this PR, but in the future it'd be better practice to introduce the constant in this PR and do the refactor for the other integrations in a separate PR.

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

2 changes: 1 addition & 1 deletion
.../browser-integration-tests/suites/integrations/featureFlags/openfeature/errorHook/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Flag evaluation error hook', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

51 changes: 51 additions & 0 deletions
...packages/browser-integration-tests/suites/integrations/featureFlags/statsig/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../../../utils/fixtures';

import { envelopeRequestParser, shouldSkipFeatureFlagsTest, waitForErrorRequest } from '../../../../../utils/helpers';

import { FLAG_BUFFER_SIZE } from '../../constants';

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).statsigClient;
 for (let i = 1; i <= bufferSize; i++) {
 client.checkGate(`feat${i}`); // values default to false
 }

 client.setMockGateValue(`feat${bufferSize + 1}`, true);
 client.checkGate(`feat${bufferSize + 1}`); // eviction

 client.setMockGateValue('feat3', true);
 client.checkGate('feat3'); // 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);
});

35 changes: 35 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/featureFlags/statsig/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
import * as Sentry from '@sentry/browser';

class MockStatsigClient {
 constructor() {
 this._gateEvaluationListeners = [];
 this._mockGateValues = {};
 }

 on(event, listener) {
 this._gateEvaluationListeners.push(listener);
 }

 checkGate(name) {
 const value = this._mockGateValues[name] || false; // unknown features default to false.
 this._gateEvaluationListeners.forEach(listener => {
 listener({ gate: { name, value } });
 });
 return value;
 }

 setMockGateValue(name, value) {
 this._mockGateValues[name] = value;
 }
}

window.statsigClient = new MockStatsigClient();

window.Sentry = Sentry;
window.sentryStatsigIntegration = Sentry.statsigIntegration({ featureFlagClient: window.statsigClient });

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 sampleRate: 1.0,
 integrations: [window.sentryStatsigIntegration],
});

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/integrations/featureFlags/statsig/subject.js

View file


Open in desktop

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

9 changes: 9 additions & 0 deletions
...packages/browser-integration-tests/suites/integrations/featureFlags/statsig/template.html

View file


Open in desktop

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

69 changes: 69 additions & 0 deletions
...ages/browser-integration-tests/suites/integrations/featureFlags/statsig/withScope/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
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?.isForked === true);
 const mainReqPromise = waitForErrorRequest(page, event => !!event.tags?.isForked === false);

 await page.evaluate(() => {
 const Sentry = (window as any).Sentry;
 const errorButton = document.querySelector('#error') as HTMLButtonElement;
 const client = (window as any).statsigClient;

 client.setMockGateValue('shared', true);
 client.setMockGateValue('main', true);

 client.checkGate('shared');

 Sentry.withScope((scope: Scope) => {
 client.setMockGateValue('forked', true);
 client.setMockGateValue('shared', false); // override the value in the parent scope.

 client.checkGate('forked');
 client.checkGate('shared');
 scope.setTag('isForked', true);
 errorButton.click();
 });

 client.checkGate('main');
 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 },
 ]);
});

2 changes: 1 addition & 1 deletion
...packages/browser-integration-tests/suites/integrations/featureFlags/unleash/basic/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ 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.
import { FLAG_BUFFER_SIZE } from '../../constants';

sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipFeatureFlagsTest()) {
Expand Down

1 change: 1 addition & 0 deletions
packages/browser/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,3 +76,4 @@ export {
export { launchDarklyIntegration, buildLaunchDarklyFlagUsedHandler } from './integrations/featureFlags/launchdarkly';
export { openFeatureIntegration, OpenFeatureIntegrationHook } from './integrations/featureFlags/openfeature';
export { unleashIntegration } from './integrations/featureFlags/unleash';
export { statsigIntegration } from './integrations/featureFlags/statsig';

1 change: 1 addition & 0 deletions
packages/browser/src/integrations/featureFlags/statsig/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export { statsigIntegration } from './integration';

46 changes: 46 additions & 0 deletions
packages/browser/src/integrations/featureFlags/statsig/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
import type { Client, Event, EventHint, IntegrationFn } from '@sentry/core';

import { defineIntegration } from '@sentry/core';
import { copyFlagsFromScopeToEvent, insertFlagToScope } from '../../../utils/featureFlags';
import type { FeatureGate, StatsigClient } from './types';

/**
 * Sentry integration for capturing feature flag evaluations from the Statsig js-client SDK.
 *
 * See the [feature flag documentation](https://develop.sentry.dev/sdk/expected-features/#feature-flags) for more information.
 *
 * @example
 * ```
 * import { StatsigClient } from '@statsig/js-client';
 * import * as Sentry from '@sentry/browser';
 *
 * const statsigClient = new StatsigClient();
 *
 * Sentry.init({
 * dsn: '___PUBLIC_DSN___',
 * integrations: [Sentry.statsigIntegration({featureFlagClient: statsigClient})],
 * });
 *
 * await statsigClient.initializeAsync(); // or statsigClient.initializeSync();
 *
 * const result = statsigClient.checkGate('my-feature-gate');
 * Sentry.captureException(new Error('something went wrong'));
 * ```
 */
export const statsigIntegration = defineIntegration(
 ({ featureFlagClient: statsigClient }: { featureFlagClient: StatsigClient }) => {
 return {
 name: 'Statsig',

 processEvent(event: Event, _hint: EventHint, _client: Client): Event {
 return copyFlagsFromScopeToEvent(event);
 },

 setup() {
 statsigClient.on('gate_evaluation', (event: { gate: FeatureGate }) => {
 insertFlagToScope(event.gate.name, event.gate.value);
 });
 },
 };
 },
) satisfies IntegrationFn;

15 changes: 15 additions & 0 deletions
packages/browser/src/integrations/featureFlags/statsig/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
export type FeatureGate = {
 readonly name: string;
 readonly value: boolean;
};

type EventNameToEventDataMap = {
 gate_evaluation: { gate: FeatureGate };
};

export interface StatsigClient {
 on(
 event: keyof EventNameToEventDataMap,
 callback: (data: EventNameToEventDataMap[keyof EventNameToEventDataMap]) => void,
 ): void;
}