Merge pull request #322 from Flagsmith/chore/add-sentry-init-config

feat: Add sentry config to init

Author: kyle-ssg

flagsmith-core.ts

@@ -9,6 +9,7 @@ import {
     IFlagsmithResponse,
     IFlagsmithTrait,
     IInitConfig,
+    ISentry,
     IState,
     ITraits,
     LoadingState,
@@ -167,7 +168,6 @@ const Flagsmith = class {
                     console.error(e)
                 }
             }
-
             if (this.dtrum) {
                 try {
                     const traits: DynatraceObject = {
@@ -286,36 +286,38 @@ const Flagsmith = class {
     ticks: number|null= null
     timer: number|null= null
     dtrum= null
+    sentryClient: ISentry | null = null
     withTraits?: ITraits|null= null
     cacheOptions = {ttl:0, skipAPI: false, loadStale: false, storageKey: undefined as string|undefined}
     async init(config: IInitConfig) {
         const evaluationContext = toEvaluationContext(config.evaluationContext || this.evaluationContext);
         try {
             const {
-                environmentID,
+                AsyncStorage: _AsyncStorage,
+                _trigger,
+                _triggerLoadingState,
+                angularHttpClient,
                 api = defaultAPI,
-                headers,
-                onChange,
+                applicationMetadata,
                 cacheFlags,
+                cacheOptions,
                 datadogRum,
-                onError,
                 defaultFlags,
-                fetch: fetchImplementation,
-                preventFetch,
-                enableLogs,
-                enableDynatrace,
                 enableAnalytics,
-                realtime,
+                enableDynatrace,
+                enableLogs,
+                environmentID,
                 eventSourceUrl= "https://realtime.flagsmith.com/",
-                AsyncStorage: _AsyncStorage,
+                fetch: fetchImplementation,
+                headers,
                 identity,
-                traits,
+                onChange,
+                onError,
+                preventFetch,
+                realtime,
+                sentryClient,
                 state,
-                cacheOptions,
-                angularHttpClient,
-                _trigger,
-                _triggerLoadingState,
-                applicationMetadata,
+                traits,
             } = config;
             evaluationContext.environment = environmentID ? {apiKey: environmentID} : evaluationContext.environment;
             if (!evaluationContext.environment || !evaluationContext.environment.apiKey) {
@@ -396,6 +398,9 @@ const Flagsmith = class {
                 }
             }
 
+            if(sentryClient) {
+                this.sentryClient = sentryClient
+            }
             if (angularHttpClient) {
                 // @ts-expect-error
                 _fetch = angularFetch(angularHttpClient);
@@ -759,6 +764,15 @@ const Flagsmith = class {
         if ((usingNewOptions && !options.skipAnalytics) || !options) {
             this.evaluateFlag(key, "ENABLED");
         }
+        if(this.sentryClient) {
+          try {
+              this.sentryClient.getIntegrationByName(
+                  "FeatureFlags",
+              )?.addFeatureFlag?.(key, res);
+          } catch (e) {
+              console.error(e)
+          }
+        }
 
         return res;
     };

lib/flagsmith/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flagsmith",
-  "version": "9.2.2",
+  "version": "9.3.0",
   "description": "Feature flagging to support continuous development",
   "main": "./index.js",
   "module": "./index.mjs",

lib/react-native-flagsmith/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-flagsmith",
-  "version": "9.2.2",
+  "version": "9.3.0",
   "description": "Feature flagging to support continuous development",
   "main": "./index.js",
   "repository": {

test/sentry.test.ts

@@ -0,0 +1,23 @@
+import { waitFor } from '@testing-library/react';
+import {defaultState, FLAGSMITH_KEY, getFlagsmith, getStateToCheck, identityState} from './test-constants';
+import { promises as fs } from 'fs';
+
+describe('Flagsmith.init', () => {
+    beforeEach(() => {
+        // Avoid mocks, but if you need to add them here
+    });
+    test('should initialize with expected values', async () => {
+        const onChange = jest.fn();
+        const { flagsmith, initConfig, AsyncStorage, mockFetch } = getFlagsmith({ onChange });
+        const addFeatureFlag = jest.fn();
+        const integration = { addFeatureFlag };
+        const client = {
+            getIntegrationByName: jest.fn().mockReturnValue(integration),
+        };
+        await flagsmith.init({...initConfig, sentryClient: client});
+        flagsmith.hasFeature("zero")
+        flagsmith.hasFeature("hero")
+        expect(addFeatureFlag).toHaveBeenCalledWith('zero', false);
+        expect(addFeatureFlag).toHaveBeenCalledWith('hero', true);
+    });
+});

types.d.ts

@@ -76,6 +76,14 @@ export declare type IDatadogRum = {
     }
 }
 
+
+export type ISentry = {
+    getIntegrationByName(name:"FeatureFlags"): {
+        addFeatureFlag(flag: string, enabled: boolean): void;
+    } | undefined;
+} | undefined;
+
+
 export declare enum FlagSource {
     "NONE" = "NONE",
     "DEFAULT_FLAGS" = "DEFAULT_FLAGS",
@@ -104,6 +112,7 @@ export interface IInitConfig<F extends string | Record<string, any> = string, T
     cacheFlags?: boolean;
     cacheOptions?: ICacheOptions;
     datadogRum?: IDatadogRum;
+    sentryClient?: ISentryClient;
     defaultFlags?: IFlags<FKey<F>>;
     fetch?: any;
     realtime?: boolean;
@@ -148,7 +157,7 @@ type FKey<F> = F extends string ? F : keyof F;
 type FValue<F, K extends FKey<F>> = F extends Record<string, any>
     ? F[K] | null
     : IFlagsmithValue;
-  
+
 /**
  * Example usage:
  *