Move util to browser pkg

Author: aliu39

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

@@ -3,6 +3,8 @@ import { expect } from '@playwright/test';
 import { sentryTest } from '../../../../utils/fixtures';
 
 import { envelopeRequestParser, waitForErrorRequest } from '../../../../utils/helpers';
+// import { FLAG_BUFFER_SIZE } from '@sentry/browser'; // TODO: not picking up export atm
+const FLAG_BUFFER_SIZE = 100;
 
 sentryTest('e2e test', async ({ getLocalTestPath, page }) => {
   await page.route('https://dsn.ingest.sentry.io/**/*', route => {
@@ -18,10 +20,10 @@ sentryTest('e2e test', async ({ getLocalTestPath, page }) => {
 
   await page.waitForFunction(() => {
     const ldClient = (window as any).InitializeLD();
-    for (let i = 1; i <= 100; i++) { // TODO: import constant for buffer size
+    for (let i = 1; i <= FLAG_BUFFER_SIZE; i++) { // TODO: import constant for buffer size
       ldClient.variation(`feat${i}`, false);
     }
-    ldClient.variation('feat101', true); // eviction
+    ldClient.variation(`feat${FLAG_BUFFER_SIZE+1}`, true); // eviction
     ldClient.variation('feat3', true);   // update
     return true;
   });
@@ -32,10 +34,10 @@ sentryTest('e2e test', async ({ getLocalTestPath, page }) => {
   const event = envelopeRequestParser(req);
 
   const expectedFlags = [{ flag: 'feat2', result: false }];
-  for (let i = 4; i <= 100; i++) {
+  for (let i = 4; i <= FLAG_BUFFER_SIZE; i++) {
     expectedFlags.push({ flag: `feat${i}`, result: false });
   }
-  expectedFlags.push({ flag: 'feat101', result: true });
+  expectedFlags.push({ flag: `feat${FLAG_BUFFER_SIZE + 1}`, result: true });
   expectedFlags.push({ flag: 'feat3', result: true });
 
   expect(event.contexts?.flags?.values).toEqual(expectedFlags);

packages/browser/src/index.ts

@@ -76,3 +76,4 @@ export { makeBrowserOfflineTransport } from './transports/offline';
 export { browserProfilingIntegration } from './profiling/integration';
 export { spotlightBrowserIntegration } from './integrations/spotlight';
 export { launchDarklyIntegration, buildLaunchDarklyFlagUsedHandler } from './integrations/launchdarkly';
+export { FLAG_BUFFER_SIZE } from './utils/flags';

packages/browser/src/integrations/launchdarkly.ts

@@ -1,7 +1,7 @@
 import type { Client, Event, EventHint, IntegrationFn } from '@sentry/types';
 import type { LDContext, LDEvaluationDetail, LDInspectionFlagUsedHandler } from 'launchdarkly-js-client-sdk';
 
-import { insertToFlagBuffer } from '@sentry/utils';
+import { insertToFlagBuffer } from '../utils/flags'
 import { defineIntegration, getCurrentScope } from '@sentry/core';
 
 /**

packages/utils/src/flags.ts renamed to packages/browser/src/utils/flags.ts

@@ -6,7 +6,10 @@ import type { FeatureFlag } from '@sentry/types';
  * from oldest to newest.
  */
 
-export const DEFAULT_MAX_SIZE = 100;
+/**
+ * Max size of the LRU flag buffer stored in Sentry scope and event contexts.
+ */
+export const FLAG_BUFFER_SIZE = 100;
 
 /**
  * Insert into a FeatureFlag array while maintaining ordered LRU properties. Not
@@ -26,7 +29,7 @@ export function insertToFlagBuffer(
   flags: FeatureFlag[],
   name: string,
   value: boolean,
-  maxSize: number = DEFAULT_MAX_SIZE,
+  maxSize: number = FLAG_BUFFER_SIZE,
 ): void {
   if (flags.length > maxSize) {
     throw Error(`insertToFlagBuffer called on a buffer larger than the given maxSize=${maxSize}`);

packages/utils/test/flags.test.ts renamed to packages/browser/test/utils/flags.test.ts

@@ -1,5 +1,5 @@
 
-import { insertToFlagBuffer } from '../src';
+import { insertToFlagBuffer } from '../../src/utils/flags';
 import type { FeatureFlag } from '@sentry/types';
 
 describe('flags', () => {

packages/core/src/scope.ts

@@ -129,7 +129,8 @@ class ScopeClass implements ScopeInterface {
     newScope._extra = { ...this._extra };
     newScope._contexts = { ...this._contexts };
     if (this._contexts.flags) {
-      // The flags context needs a deep copy.
+      // We need to copy the `values` array so insertions on a cloned scope
+      // won't affect the original array.
       newScope._contexts.flags = {
         values: [...this._contexts.flags.values]
       }

packages/utils/src/index.ts

@@ -41,4 +41,3 @@ export * from './propagationContext';
 export * from './vercelWaitUntil';
 export * from './version';
 export * from './debug-ids';
-export * from './flags';