Opt out of logging (#37020)

Make opting out of logging simpler by allowing a boolean to be passed to logger in client options. Function line logging is only received by clients when interacting with Convex development deployments, not production deployments; dropping the logs on the floor makes behavior against dev deployments closer to behavior against production ones.

GitOrigin-RevId: a5cfd2163726bb0d66a908819810e84507b8b8eb

Author: thomasballinger

npm-packages/convex/src/browser/http_client.ts

@@ -12,7 +12,12 @@ import {
   convexToJson,
   jsonToConvex,
 } from "../values/index.js";
-import { instantiateDefaultLogger, logForFunction, Logger } from "./logging.js";
+import {
+  instantiateDefaultLogger,
+  instantiateNoopLogger,
+  logForFunction,
+  Logger,
+} from "./logging.js";
 import { FunctionArgs, UserIdentityAttributes } from "../server/index.js";
 
 export const STATUS_CODE_OK = 200;
@@ -62,7 +67,10 @@ export class ConvexHttpClient {
    */
   constructor(
     address: string,
-    options?: { skipConvexDeploymentUrlCheck?: boolean; logger?: Logger },
+    options?: {
+      skipConvexDeploymentUrlCheck?: boolean;
+      logger?: Logger | boolean;
+    },
   ) {
     if (typeof options === "boolean") {
       throw new Error(
@@ -73,7 +81,12 @@ export class ConvexHttpClient {
     if (opts.skipConvexDeploymentUrlCheck !== true) {
       validateDeploymentUrl(address);
     }
-    this.logger = opts.logger ?? instantiateDefaultLogger({ verbose: false });
+    this.logger =
+      options?.logger === false
+        ? instantiateNoopLogger({ verbose: false })
+        : options?.logger !== true && options?.logger
+          ? options.logger
+          : instantiateDefaultLogger({ verbose: false });
     this.address = address;
     this.debug = true;
   }

npm-packages/convex/src/browser/logging.ts

@@ -110,6 +110,10 @@ export function instantiateDefaultLogger(options: {
   return logger;
 }
 
+export function instantiateNoopLogger(options: { verbose: boolean }): Logger {
+  return new Logger(options);
+}
+
 export function logForFunction(
   logger: Logger,
   type: "info" | "error",

npm-packages/convex/src/browser/sync/client.ts

@@ -4,6 +4,7 @@ import {
   createHybridErrorStacktrace,
   forwardData,
   instantiateDefaultLogger,
+  instantiateNoopLogger,
   logFatalError,
   Logger,
 } from "../logging.js";
@@ -70,12 +71,12 @@ export interface BaseConvexClientOptions {
    */
   verbose?: boolean;
   /**
-   * A logger. If not provided, logs to the console.
+   * A logger, `true`, or `false`. If not provided or `true`, logs to the console.
+   * If `false`, logs are not printed anywhere.
    *
-   * You can construct your own logger to customize logging to log elsewhere
-   * or not log at all.
+   * You can construct your own logger to customize logging to log elsewhere.
    */
-  logger?: Logger;
+  logger?: Logger | boolean;
   /**
    * Sends additional metrics to Convex for debugging purposes.
    *
@@ -255,8 +256,11 @@ export class BaseConvexClient {
     this.debug = options.reportDebugInfoToConvex ?? false;
     this.address = address;
     this.logger =
-      options.logger ??
-      instantiateDefaultLogger({ verbose: options.verbose ?? false });
+      options.logger === false
+        ? instantiateNoopLogger({ verbose: options.verbose ?? false })
+        : options.logger !== true && options.logger
+          ? options.logger
+          : instantiateDefaultLogger({ verbose: options.verbose ?? false });
     // Substitute http(s) with ws(s)
     const i = address.search("://");
     if (i === -1) {

npm-packages/convex/src/react/client.ts

@@ -21,7 +21,11 @@ import {
   makeFunctionReference,
 } from "../server/api.js";
 import { EmptyObject } from "../server/registration.js";
-import { instantiateDefaultLogger, Logger } from "../browser/logging.js";
+import {
+  instantiateDefaultLogger,
+  instantiateNoopLogger,
+  Logger,
+} from "../browser/logging.js";
 
 if (typeof React === "undefined") {
   throw new Error("Required dependency 'react' not found");
@@ -256,8 +260,11 @@ export class ConvexReactClient {
     this.address = address;
     this.listeners = new Map();
     this._logger =
-      options?.logger ??
-      instantiateDefaultLogger({ verbose: options?.verbose ?? false });
+      options?.logger === false
+        ? instantiateNoopLogger({ verbose: options?.verbose ?? false })
+        : options?.logger !== true && options?.logger
+          ? options.logger
+          : instantiateDefaultLogger({ verbose: options?.verbose ?? false });
     this.options = { ...options, logger: this._logger };
   }