Skip CDN bundle tests, fix unit test, un-export FLAG_BUFFER_SIZE, update lockfile

Author: aliu39

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

@@ -2,10 +2,15 @@ import { expect } from '@playwright/test';
 
 import { sentryTest } from '../../../../../utils/fixtures';
 
-import { envelopeRequestParser, waitForErrorRequest } from '../../../../../utils/helpers';
-import { FLAG_BUFFER_SIZE } from '@sentry/browser';
+import { envelopeRequestParser, shouldSkipLaunchDarklyTest, waitForErrorRequest } from '../../../../../utils/helpers';
+
+const FLAG_BUFFER_SIZE = 100;  // Corresponds to constant in featureFlags.ts, in browser utils.
 
 sentryTest('Basic test with eviction, update, and no async tasks', async ({ getLocalTestPath, page }) => {
+  if (shouldSkipLaunchDarklyTest()) {
+    sentryTest.skip();
+  }
+
   await page.route('https://dsn.ingest.sentry.io/**/*', route => {
     return route.fulfill({
       status: 200,

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

@@ -2,11 +2,15 @@ import { expect } from '@playwright/test';
 
 import { sentryTest } from '../../../../../utils/fixtures';
 
-import { envelopeRequestParser, waitForErrorRequest } from '../../../../../utils/helpers';
+import { envelopeRequestParser, shouldSkipLaunchDarklyTest, waitForErrorRequest } from '../../../../../utils/helpers';
 
 import type { Scope } from '@sentry/browser';
 
 sentryTest('Flag evaluations in forked scopes are stored separately.', async ({ getLocalTestPath, page }) => {
+  if (shouldSkipLaunchDarklyTest()) {
+    sentryTest.skip();
+  }
+
   await page.route('https://dsn.ingest.sentry.io/**/*', route => {
     return route.fulfill({
       status: 200,

dev-packages/browser-integration-tests/utils/helpers.ts

@@ -273,6 +273,18 @@ export function shouldSkipMetricsTest(): boolean {
   return bundle != null && !bundle.includes('tracing') && !bundle.includes('esm') && !bundle.includes('cjs');
 }
 
+/**
+ * We can only test the launchdarkly browser integration in certain bundles/packages:
+ * - NPM (ESM, CJS)
+ * - Not CDNs.
+ *
+ * @returns `true` if we should skip the launchdarkly test
+ */
+export function shouldSkipLaunchDarklyTest(): boolean {
+  const bundle = process.env.PW_BUNDLE as string | undefined;
+  return bundle != null && !bundle.includes('esm') && !bundle.includes('cjs');
+}
+
 /**
  * Waits until a number of requests matching urlRgx at the given URL arrive.
  * If the timeout option is configured, this function will abort waiting, even if it hasn't received the configured

packages/browser/src/exports.ts

@@ -100,5 +100,3 @@ export { linkedErrorsIntegration } from './integrations/linkederrors';
 export { browserApiErrorsIntegration } from './integrations/browserapierrors';
 
 export { lazyLoadIntegration } from './utils/lazyLoadIntegration';
-export { launchDarklyIntegration, buildLaunchDarklyFlagUsedHandler } from './integrations/featureFlags/launchdarkly';
-export { FLAG_BUFFER_SIZE } from './utils/featureFlags';

packages/browser/src/index.ts

@@ -75,3 +75,4 @@ export type { Span } from '@sentry/types';
 export { makeBrowserOfflineTransport } from './transports/offline';
 export { browserProfilingIntegration } from './profiling/integration';
 export { spotlightBrowserIntegration } from './integrations/spotlight';
+export { launchDarklyIntegration, buildLaunchDarklyFlagUsedHandler } from './integrations/featureFlags/launchdarkly';

packages/browser/src/utils/featureFlags.ts

@@ -34,7 +34,7 @@ export function insertToFlagBuffer(
   maxSize: number = FLAG_BUFFER_SIZE,
 ): void {
   if (flags.length > maxSize) {
-    DEBUG_BUILD && logger.error(`insertToFlagBuffer called on a buffer larger than the given maxSize=${maxSize}`);
+    DEBUG_BUILD && logger.error(`[Feature Flags] insertToFlagBuffer called on a buffer larger than maxSize=${maxSize}`);
     return;
   }
 

packages/browser/test/utils/featureFlags.test.ts

@@ -1,9 +1,17 @@
 
+import { logger } from '@sentry/utils';
 import { insertToFlagBuffer } from '../../src/utils/featureFlags';
 import type { FeatureFlag } from '@sentry/types';
+import { vi } from 'vitest';
 
 describe('flags', () => {
   describe('insertToFlagBuffer()', () => {
+    const loggerSpy = vi.spyOn(logger, 'error');
+
+    afterEach(() => {
+      loggerSpy.mockClear();
+    });
+
     it('maintains ordering and evicts the oldest entry', () => {
       const buffer: FeatureFlag[] = [];
       const maxSize = 3;
@@ -47,14 +55,29 @@ describe('flags', () => {
       ]);
     });
 
-    it('errors when maxSize is less than current buffer size', () => {
+    it('logs error and is a no-op when buffer is larger than maxSize', () => {
       const buffer: FeatureFlag[] = [
         { flag: 'feat1', result: true },
         { flag: 'feat2', result: true },
       ];
 
-      expect(() => insertToFlagBuffer(buffer, 'feat1', true, 1)).toThrowError();
-      expect(() => insertToFlagBuffer(buffer, 'feat1', true, -2)).toThrowError();
+      insertToFlagBuffer(buffer, 'feat1', true, 1);
+      expect(loggerSpy).toHaveBeenCalledWith(
+        expect.stringContaining('[Feature Flags] insertToFlagBuffer called on a buffer larger than maxSize'),
+      );
+      expect(buffer).toEqual([
+        { flag: 'feat1', result: true },
+        { flag: 'feat2', result: true },
+      ]);
+
+      insertToFlagBuffer(buffer, 'feat1', true, -2);
+      expect(loggerSpy).toHaveBeenCalledWith(
+        expect.stringContaining('[Feature Flags] insertToFlagBuffer called on a buffer larger than maxSize'),
+      );
+      expect(buffer).toEqual([
+        { flag: 'feat1', result: true },
+        { flag: 'feat2', result: true },
+      ]);
     });
   })
 })