Merge branch 'main' into feat/browser-sdk-bulk-queue

roncohen · web-flow · commit ac756f6a6fb7 · 2026-03-06T13:53:03.000+01:00
diff --git a/packages/react-sdk/README.md b/packages/react-sdk/README.md
@@ -541,7 +541,8 @@ The `<ReflagProvider>` initializes the Reflag SDK, fetches flags and starts list
 - `apiBaseUrl`: Optional base URL for the Reflag API. Use this to override the default API endpoint,
 - `appBaseUrl`: Optional base URL for the Reflag application. Use this to override the default app URL,
 - `sseBaseUrl`: Optional base URL for Server-Sent Events. Use this to override the default SSE endpoint,
-- `debug`: Set to `true` to enable debug logging to the console,
+- `logger`: Optional custom logger implementation (`debug`, `info`, `warn`, `error`) used by the underlying client,
+- `debug`: Set to `true` to enable debug logging to the console. If both `logger` and `debug` are provided, `logger` takes precedence,
 - `toolbar`: Optional [configuration](https://docs.reflag.com/supported-languages/browser-sdk/globals#toolbaroptions) for the Reflag toolbar,
 - `feedback`: Optional configuration for feedback collection
 
diff --git a/packages/react-sdk/src/index.tsx b/packages/react-sdk/src/index.tsx
@@ -14,6 +14,7 @@ import {
   CompanyContext,
   HookArgs,
   InitOptions,
+  Logger,
   RawFlag,
   ReflagClient,
   ReflagContext,
@@ -152,6 +153,13 @@ export type ReflagPropsBase = {
    */
   initialLoading?: boolean;
 
+  /**
+   * A custom logger to use for SDK logs.
+   * Use this for advanced control or filtering of SDK logs.
+   * If both `logger` and `debug` are provided, `logger` takes precedence.
+   */
+  logger?: Logger;
+
   /**
    * Set to `true` to enable debug logging to the console,
    */
@@ -164,7 +172,7 @@ export type ReflagPropsBase = {
  */
 export type ReflagInitOptionsBase = Omit<
   InitOptions,
-  "user" | "company" | "other" | "otherContext" | "bootstrappedFlags"
+  "user" | "company" | "other" | "otherContext" | "bootstrappedFlags" | "logger"
 >;
 
 /**
@@ -178,20 +186,28 @@ const reflagClients = new Map<string, ReflagClient>();
  * Only creates a new ReflagClient is not already created or if it hook is run on the server.
  * @internal
  */
-function useReflagClient(initOptions: InitOptions, debug = false) {
+function useReflagClient(initOptions: InitOptions & { debug?: boolean }) {
+  const {
+    debug = false,
+    logger,
+    publishableKey,
+    sdkVersion,
+    ...clientOptions
+  } = initOptions;
   const isServer = typeof window === "undefined";
-  if (isServer || !reflagClients.has(initOptions.publishableKey)) {
+  if (isServer || !reflagClients.has(publishableKey)) {
     const client = new ReflagClient({
-      ...initOptions,
-      logger: debug ? console : undefined,
-      sdkVersion: initOptions.sdkVersion ?? SDK_VERSION,
+      ...clientOptions,
+      publishableKey,
+      logger: logger ?? (debug ? console : undefined),
+      sdkVersion: sdkVersion ?? SDK_VERSION,
     });
     if (!isServer) {
-      reflagClients.set(initOptions.publishableKey, client);
+      reflagClients.set(publishableKey, client);
     }
     return client;
   }
-  return reflagClients.get(initOptions.publishableKey)!;
+  return reflagClients.get(publishableKey)!;
 }
 
 type ProviderContextType = {
@@ -204,7 +220,10 @@ const ProviderContext = createContext<ProviderContextType | null>(null);
 /**
  * Props for the ReflagClientProvider.
  */
-export type ReflagClientProviderProps = Omit<ReflagPropsBase, "debug"> & {
+export type ReflagClientProviderProps = Omit<
+  ReflagPropsBase,
+  "debug" | "logger"
+> & {
   client: ReflagClient;
 };
 
@@ -282,20 +301,20 @@ export function ReflagProvider({
   otherContext,
   loadingComponent,
   initialLoading = true,
+  logger,
   debug,
   ...config
 }: ReflagProps) {
   const resolvedContext = useMemo(
     () => ({ user, company, other: otherContext, ...context }),
     [user, company, otherContext, context],
   );
-  const client = useReflagClient(
-    {
-      ...config,
-      ...resolvedContext,
-    },
+  const client = useReflagClient({
+    ...config,
+    ...resolvedContext,
     debug,
-  );
+    logger,
+  });
 
   // Initialize the client if it is not already initialized
   useEffect(() => {
@@ -340,17 +359,17 @@ export function ReflagBootstrappedProvider({
   children,
   loadingComponent,
   initialLoading = false,
+  logger,
   debug,
   ...config
 }: ReflagBootstrappedProps) {
-  const client = useReflagClient(
-    {
-      ...config,
-      ...flags.context,
-      bootstrappedFlags: flags.flags,
-    },
+  const client = useReflagClient({
+    ...config,
+    ...flags.context,
+    bootstrappedFlags: flags.flags,
     debug,
-  );
+    logger,
+  });
 
   // Initialize the client if it is not already initialized
   useEffect(() => {
diff --git a/packages/react-sdk/test/usage.test.tsx b/packages/react-sdk/test/usage.test.tsx
@@ -228,6 +228,44 @@ describe("<ReflagProvider />", () => {
     });
   });
 
+  test("uses provided logger", async () => {
+    const logger = {
+      debug: vi.fn(),
+      info: vi.fn(),
+      warn: vi.fn(),
+      error: vi.fn(),
+    };
+
+    const { result, unmount } = renderHook(() => useClient(), {
+      wrapper: ({ children }) => getProvider({ children, logger }),
+    });
+
+    await waitFor(() => {
+      expect(result.current.logger).toBe(logger);
+    });
+
+    unmount();
+  });
+
+  test("prefers logger over debug mode", async () => {
+    const logger = {
+      debug: vi.fn(),
+      info: vi.fn(),
+      warn: vi.fn(),
+      error: vi.fn(),
+    };
+
+    const { result, unmount } = renderHook(() => useClient(), {
+      wrapper: ({ children }) => getProvider({ children, logger, debug: true }),
+    });
+
+    await waitFor(() => {
+      expect(result.current.logger).toBe(logger);
+    });
+
+    unmount();
+  });
+
   test("only calls init once with the same args", () => {
     const node = getProvider();
     const initialize = vi.spyOn(ReflagClient.prototype, "initialize");
diff --git a/packages/vue-sdk/README.md b/packages/vue-sdk/README.md
@@ -185,7 +185,8 @@ The `<ReflagProvider>` initializes the Reflag SDK, fetches flags and starts list
 - `apiBaseUrl`: Optional base URL for the Reflag API. Use this to override the default API endpoint,
 - `appBaseUrl`: Optional base URL for the Reflag application. Use this to override the default app URL,
 - `sseBaseUrl`: Optional base URL for Server-Sent Events. Use this to override the default SSE endpoint,
-- `debug`: Set to `true` to enable debug logging to the console,
+- `debug`: Set to `true` to enable debug logging to the console. If both `logger` and `debug` are provided, `logger` takes precedence,
+- `logger`: Optional custom logger implementation (`debug`, `info`, `warn`, `error`) used by the underlying client,
 - `toolbar`: Optional [configuration](https://docs.reflag.com/supported-languages/browser-sdk/globals#toolbaroptions) for the Reflag toolbar,
 - `feedback`: Optional configuration for feedback collection
 
diff --git a/packages/vue-sdk/src/ReflagBootstrappedProvider.vue b/packages/vue-sdk/src/ReflagBootstrappedProvider.vue
@@ -8,19 +8,19 @@ const {
   flags,
   initialLoading = false,
   enableTracking = true,
+  logger,
   debug,
   ...config
 } = defineProps<ReflagBootstrappedProps>();
 
-const client = useReflagClient(
-  {
-    ...config,
-    ...flags?.context,
-    enableTracking,
-    bootstrappedFlags: flags?.flags,
-  },
+const client = useReflagClient({
+  ...config,
+  ...flags?.context,
+  enableTracking,
+  bootstrappedFlags: flags?.flags,
   debug,
-);
+  logger,
+});
 
 const isLoading = ref(
   client.getState() !== "initialized" ? initialLoading : false,
diff --git a/packages/vue-sdk/src/ReflagProvider.vue b/packages/vue-sdk/src/ReflagProvider.vue
@@ -14,6 +14,7 @@ const {
   otherContext,
   initialLoading = true,
   enableTracking = true,
+  logger,
   debug,
   ...config
 } = defineProps<ReflagProps>();
@@ -25,14 +26,13 @@ const resolvedContext = computed(() => ({
   ...context,
 }));
 
-const client = useReflagClient(
-  {
-    ...config,
-    ...resolvedContext.value,
-    enableTracking,
-  },
+const client = useReflagClient({
+  ...config,
+  ...resolvedContext.value,
+  enableTracking,
   debug,
-);
+  logger,
+});
 
 const isLoading = ref(
   client.getState() !== "initialized" ? initialLoading : false,
diff --git a/packages/vue-sdk/src/hooks.ts b/packages/vue-sdk/src/hooks.ts
@@ -38,22 +38,28 @@ const reflagClients = new Map<string, ReflagClient>();
  * @internal
  */
 export function useReflagClient(
-  initOptions: InitOptions,
-  debug = false,
+  initOptions: InitOptions & { debug?: boolean },
 ): ReflagClient {
+  const {
+    debug = false,
+    logger,
+    publishableKey,
+    ...clientOptions
+  } = initOptions;
   const isServer = typeof window === "undefined";
-  if (isServer || !reflagClients.has(initOptions.publishableKey)) {
+  if (isServer || !reflagClients.has(publishableKey)) {
     const client = new ReflagClient({
-      ...initOptions,
+      ...clientOptions,
+      publishableKey,
       sdkVersion: SDK_VERSION,
-      logger: debug ? console : undefined,
+      logger: logger ?? (debug ? console : undefined),
     });
     if (!isServer) {
-      reflagClients.set(initOptions.publishableKey, client);
+      reflagClients.set(publishableKey, client);
     }
     return client;
   }
-  return reflagClients.get(initOptions.publishableKey)!;
+  return reflagClients.get(publishableKey)!;
 }
 
 /**
diff --git a/packages/vue-sdk/src/types.ts b/packages/vue-sdk/src/types.ts
@@ -3,6 +3,7 @@ import type { Ref } from "vue";
 import type {
   CompanyContext,
   InitOptions,
+  Logger,
   RawFlags,
   ReflagClient,
   ReflagContext,
@@ -70,7 +71,7 @@ export type RequestFlagFeedbackOptions = Omit<
  */
 export type ReflagInitOptionsBase = Omit<
   InitOptions,
-  "user" | "company" | "other" | "otherContext" | "bootstrappedFlags"
+  "user" | "company" | "other" | "otherContext" | "bootstrappedFlags" | "logger"
 >;
 
 /**
@@ -83,6 +84,13 @@ export type ReflagBaseProps = {
    */
   initialLoading?: boolean;
 
+  /**
+   * A custom logger to use for SDK logs.
+   * Use this for advanced control or filtering of SDK logs.
+   * If both `logger` and `debug` are provided, `logger` takes precedence.
+   */
+  logger?: Logger;
+
   /**
    * Set to `true` to enable debug logging to the console.
    */
@@ -92,7 +100,10 @@ export type ReflagBaseProps = {
 /**
  * Props for the ReflagClientProvider.
  */
-export type ReflagClientProviderProps = Omit<ReflagBaseProps, "debug"> & {
+export type ReflagClientProviderProps = Omit<
+  ReflagBaseProps,
+  "debug" | "logger"
+> & {
   /**
    * A pre-initialized ReflagClient to use.
    */
diff --git a/packages/vue-sdk/test/usage.test.ts b/packages/vue-sdk/test/usage.test.ts
