add node integration tests

Author: madhuchavva

dev-packages/node-integration-tests/suites/featureFlags/growthbook/onError/basic/scenario.ts

@@ -0,0 +1,59 @@
+import { _INTERNAL_FLAG_BUFFER_SIZE as FLAG_BUFFER_SIZE } from '@sentry/core';
+import * as Sentry from '@sentry/node';
+import { loggingTransport } from '@sentry-internal/node-integration-tests';
+
+// Minimal GrowthBook-like class that matches the real API for testing
+// This is necessary since we don't want to add @growthbook/growthbook as a dependency
+// just for integration tests, but we want to test the actual integration behavior
+class GrowthBookLike {
+  private _features: Record<string, { value: unknown }> = {};
+
+  public isOn(featureKey: string): boolean {
+    const feature = this._features[featureKey];
+    return feature ? !!feature.value : false;
+  }
+
+  public getFeatureValue(featureKey: string, defaultValue: unknown): unknown {
+    const feature = this._features[featureKey];
+    return feature ? feature.value : defaultValue;
+  }
+
+  // Helper method to set feature values for testing
+  public setFeature(featureKey: string, value: unknown): void {
+    this._features[featureKey] = { value };
+  }
+}
+
+Sentry.init({
+  dsn: 'https://[email protected]/1337',
+  sampleRate: 1.0,
+  transport: loggingTransport,
+  integrations: [Sentry.growthbookIntegration({ growthbookClass: GrowthBookLike })],
+});
+
+const gb = new GrowthBookLike();
+
+// Fill buffer with flags 1-100 (all false by default)
+for (let i = 1; i <= FLAG_BUFFER_SIZE; i++) {
+  gb.isOn(`feat${i}`);
+}
+
+// Add feat101 (true), which should evict feat1
+gb.setFeature(`feat${FLAG_BUFFER_SIZE + 1}`, true);
+gb.isOn(`feat${FLAG_BUFFER_SIZE + 1}`);
+
+// Update feat3 to true, which should move it to the end
+gb.setFeature('feat3', true);
+gb.isOn('feat3');
+
+// Test getFeatureValue with boolean values (should be captured)
+gb.setFeature('bool-feat', true);
+gb.getFeatureValue('bool-feat', false);
+
+// Test getFeatureValue with non-boolean values (should NOT be captured)
+gb.setFeature('string-feat', 'hello');
+gb.getFeatureValue('string-feat', 'default');
+gb.setFeature('number-feat', 42);
+gb.getFeatureValue('number-feat', 0);
+
+throw new Error('Test error');

dev-packages/node-integration-tests/suites/featureFlags/growthbook/onError/basic/test.ts

@@ -0,0 +1,32 @@
+import { _INTERNAL_FLAG_BUFFER_SIZE as FLAG_BUFFER_SIZE } from '@sentry/core';
+import { afterAll, test } from 'vitest';
+import { cleanupChildProcesses, createRunner } from '../../../../../utils/runner';
+
+afterAll(() => {
+  cleanupChildProcesses();
+});
+
+test('GrowthBook flags captured on error with eviction, update, and no async tasks', async () => {
+
+  const expectedFlags = [];
+  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 });
+  expectedFlags.push({ flag: 'bool-feat', result: true }); // Only boolean getFeatureValue should be captured
+
+  await createRunner(__dirname, 'scenario.ts')
+    .expect({
+      event: {
+        exception: { values: [{ type: 'Error', value: 'Test error' }] },
+        contexts: {
+          flags: {
+            values: expectedFlags,
+          },
+        },
+      },
+    })
+    .start()
+    .completed();
+});

dev-packages/node-integration-tests/suites/featureFlags/growthbook/onSpan/scenario.ts

@@ -0,0 +1,50 @@
+import * as Sentry from '@sentry/node';
+import { loggingTransport } from '@sentry-internal/node-integration-tests';
+
+// Minimal GrowthBook-like class that matches the real API for testing
+class GrowthBookLike {
+  private _features: Record<string, { value: unknown }> = {};
+
+  public isOn(featureKey: string): boolean {
+    const feature = this._features[featureKey];
+    return feature ? !!feature.value : false;
+  }
+
+  public getFeatureValue(featureKey: string, defaultValue: unknown): unknown {
+    const feature = this._features[featureKey];
+    return feature ? feature.value : defaultValue;
+  }
+
+  // Helper method to set feature values for testing
+  public setFeature(featureKey: string, value: unknown): void {
+    this._features[featureKey] = { value };
+  }
+}
+
+Sentry.init({
+  dsn: 'https://[email protected]/1337',
+  sampleRate: 1.0,
+  tracesSampleRate: 1.0,
+  transport: loggingTransport,
+  integrations: [Sentry.growthbookIntegration({ growthbookClass: GrowthBookLike })],
+});
+
+const gb = new GrowthBookLike();
+
+// Set up feature flags
+gb.setFeature('feat1', true);
+gb.setFeature('feat2', false);
+gb.setFeature('bool-feat', true);
+
+Sentry.startSpan({ name: 'test-span', op: 'function' }, () => {
+  // Evaluate feature flags during the span
+  gb.isOn('feat1');
+  gb.isOn('feat2');
+
+  // Test getFeatureValue with boolean values (should be captured)
+  gb.getFeatureValue('bool-feat', false);
+
+  // Test getFeatureValue with non-boolean values (should NOT be captured)
+  gb.setFeature('string-feat', 'hello');
+  gb.getFeatureValue('string-feat', 'default');
+});

dev-packages/node-integration-tests/suites/featureFlags/growthbook/onSpan/test.ts

@@ -0,0 +1,34 @@
+import { afterAll, expect, test } from 'vitest';
+import { cleanupChildProcesses, createRunner } from '../../../../utils/runner';
+
+afterAll(() => {
+  cleanupChildProcesses();
+});
+
+test('GrowthBook flags are added to active span attributes on span end', async () => {
+  await createRunner(__dirname, 'scenario.ts')
+    .expect({
+      transaction: {
+        contexts: {
+          trace: {
+            data: {
+              'flag.evaluation.feat1': true,
+              'flag.evaluation.feat2': false,
+              'flag.evaluation.bool-feat': true,
+              // string-feat should NOT be here since it's not boolean
+            },
+            op: 'function',
+            origin: 'manual',
+            status: 'ok',
+            span_id: expect.stringMatching(/[a-f0-9]{16}/),
+            trace_id: expect.stringMatching(/[a-f0-9]{32}/)
+          },
+        },
+        spans: [],
+        transaction: 'test-span',
+        type: 'transaction',
+      },
+    })
+    .start()
+    .completed();
+});

packages/node/src/index.ts

@@ -34,6 +34,7 @@ export {
   OpenFeatureIntegrationHook,
   statsigIntegration,
   unleashIntegration,
+  growthbookIntegration,
 } from './integrations/featureFlagShims';
 export { firebaseIntegration } from './integrations/tracing/firebase';