Merge pull request #78 from launchdarkly/christie/sc-164659/option-to-disable-proxy

Option to disable proxy

Author: XieX

src/getFlagsProxy.test.ts

@@ -50,3 +50,11 @@ test('filters to target flags', () => {
 
   expect(flags).toEqual({ fooBar: 'foobar' });
 });
+
+test('does not use proxy if option is false', () => {
+  const { flags } = getFlagsProxy(ldClient, rawFlags, { sendEventsOnFlagRead: false });
+
+  expect(flags['foo-bar']).toBe('foobar');
+
+  expect(variation).not.toHaveBeenCalled();
+});

src/getFlagsProxy.ts

@@ -26,7 +26,7 @@ export default function getFlagsProxy(
   }
 
   return {
-    flags: toFlagsProxy(ldClient, flags, flagKeyMap),
+    flags: reactOptions.sendEventsOnFlagRead ? toFlagsProxy(ldClient, flags, flagKeyMap) : flags,
     _flags: filteredFlags,
     flagKeyMap,
   };

src/types.ts

@@ -21,12 +21,19 @@ export interface LDReactOptions {
    * @see https://docs.launchdarkly.com/sdk/client-side/react/react-web#flag-keys
    */
   useCamelCaseFlagKeys?: boolean;
+
+  /**
+   * Whether to send flag evaluation events when a flag is read from the `flags` object
+   * retured by the `useFlags` hook. This is true by default, meaning flag evaluation
+   * events will be sent by default.
+   */
+  sendEventsOnFlagRead?: boolean;
 }
 
 /**
  * Contains default values for the `reactOptions` object.
  */
-export const defaultReactOptions = { useCamelCaseFlagKeys: true };
+export const defaultReactOptions = { useCamelCaseFlagKeys: true, sendEventsOnFlagRead: true };
 
 /**
  * Configuration object used to initialise LaunchDarkly's JS client.