convex 1.26.0-alpha.2 → 1.26.0-alpha.4

package/CHANGELOG.md

@@ -1,5 +1,48 @@
 # Changelog
 
+## 1.25.3
+
+- Experimental `convex dev --once --debug-node-apis` debug flag for tracing
+  through imports to find Node.js APIs imported from non-"use node" convex
+  endpoint files.
+
+- Experimental `CONVEX_AGENT_MODE=anonymous npx convex dev` for a
+  non-interactive anonymous development flow when not logged in.
+
+- Simplify the `Logger` interface of Convex clients making it easier to replace.
+
+- Reactive `ConnectionState` via `useConvexConnectionState` hook. How often this
+  value updates may change in the future if more information is added to
+  `ConnectionState`.
+
+- Escape JavaScript keywords in codegen, fixing issues with files in the convex
+  folder named things like convex/delete.ts.
+
+- Warn when the explicit value `undefined` is passed to Next.js server-side
+  helpers, indicating the issue may have been an unset environment variable.
+  This may become an error in the future.
+
+- Error closer to the call site when invalid validators are contructed.
+
+## 1.25.2
+
+- Increase a network timeout that was causing Node.js v20+ issues on slow
+  connections, good old Happy Eyeballs
+  https://github.com/nodejs/node/issues/54359.
+
+## 1.25.1
+
+- Print more error info in `npx convex network-test`.
+
+- Crash when it looks like an environment variable is missing:
+  `CONVEX_DEPLOY_KEY=project:me:new-project|eyABCD0= npx convex` parses as
+  `CONVEX_DEPLOY_KEY=project:me:new-project | eyABCD0='' npx convex` but when
+  was meant was
+  `CONVEX_DEPLOY_KEY='project:me:new-project|eyABCD0=' npx convex`.
+
+  Crash when an environment variable like `ey...0=` is present to surface errors
+  like this quicker.
+
 ## 1.25.0
 
 To upgrade to this release you'll need to upgrade any Convex components you use.

package/dist/browser.bundle.js

@@ -28,7 +28,7 @@ var convex = (() => {
   });
 
   // src/index.ts
-  var version = "1.26.0-alpha.2";
+  var version = "1.26.0-alpha.4";
 
   // src/values/base64.ts
   var base64_exports = {};
@@ -481,7 +481,7 @@ var convex = (() => {
         return "?";
     }
   }
-  var Logger = class {
+  var DefaultLogger = class {
     _onLogLineFuncs;
     _verbose;
     constructor(options) {
@@ -525,7 +525,7 @@ var convex = (() => {
     }
   };
   function instantiateDefaultLogger(options) {
-    const logger = new Logger(options);
+    const logger = new DefaultLogger(options);
     logger.addLogLineListener((level, ...args) => {
       switch (level) {
         case "debug":
@@ -549,7 +549,7 @@ var convex = (() => {
     return logger;
   }
   function instantiateNoopLogger(options) {
-    return new Logger(options);
+    return new DefaultLogger(options);
   }
   function logForFunction(logger, type, source, udfPath, message) {
     const prefix = prefix_for_source(source);
@@ -897,8 +897,9 @@ var convex = (() => {
 
   // src/browser/sync/request_manager.ts
   var RequestManager = class {
-    constructor(logger) {
+    constructor(logger, markConnectionStateDirty) {
       this.logger = logger;
+      this.markConnectionStateDirty = markConnectionStateDirty;
       this.inflightRequests = /* @__PURE__ */ new Map();
       this.requestsOlderThanRestart = /* @__PURE__ */ new Set();
     }
@@ -919,6 +920,7 @@ var convex = (() => {
           this.inflightActionsCount++;
         }
       });
+      this.markConnectionStateDirty();
       return result;
     }
     /**
@@ -971,6 +973,7 @@ var convex = (() => {
         } else if (requestInfo.message.type === "Mutation") {
           this.inflightMutationsCount--;
         }
+        this.markConnectionStateDirty();
         return { requestId: response.requestId, result };
       }
       requestInfo.status = {
@@ -998,6 +1001,9 @@ var convex = (() => {
           this.requestsOlderThanRestart.delete(requestId);
         }
       }
+      if (completeRequests.size > 0) {
+        this.markConnectionStateDirty();
+      }
       return completeRequests;
     }
     restart() {
@@ -1025,6 +1031,7 @@ var convex = (() => {
           });
         }
       }
+      this.markConnectionStateDirty();
       return allMessages;
     }
     resume() {
@@ -1576,6 +1583,25 @@ var convex = (() => {
     return "Unknown";
   }
   var WebSocketManager = class {
+    constructor(uri, callbacks, webSocketConstructor, logger, markConnectionStateDirty) {
+      this.markConnectionStateDirty = markConnectionStateDirty;
+      this.webSocketConstructor = webSocketConstructor;
+      this.socket = { state: "disconnected" };
+      this.connectionCount = 0;
+      this.lastCloseReason = "InitialConnect";
+      this.defaultInitialBackoff = 1e3;
+      this.maxBackoff = 16e3;
+      this.retries = 0;
+      this.serverInactivityThreshold = 3e4;
+      this.reconnectDueToServerInactivityTimeout = null;
+      this.uri = uri;
+      this.onOpen = callbacks.onOpen;
+      this.onResume = callbacks.onResume;
+      this.onMessage = callbacks.onMessage;
+      this.onServerDisconnectError = callbacks.onServerDisconnectError;
+      this.logger = logger;
+      this.connect();
+    }
     socket;
     connectionCount;
     _hasEverConnected = false;
@@ -1597,29 +1623,12 @@ var convex = (() => {
     webSocketConstructor;
     logger;
     onServerDisconnectError;
-    constructor(uri, callbacks, webSocketConstructor, logger) {
-      this.webSocketConstructor = webSocketConstructor;
-      this.socket = { state: "disconnected" };
-      this.connectionCount = 0;
-      this.lastCloseReason = "InitialConnect";
-      this.defaultInitialBackoff = 1e3;
-      this.maxBackoff = 16e3;
-      this.retries = 0;
-      this.serverInactivityThreshold = 3e4;
-      this.reconnectDueToServerInactivityTimeout = null;
-      this.uri = uri;
-      this.onOpen = callbacks.onOpen;
-      this.onResume = callbacks.onResume;
-      this.onMessage = callbacks.onMessage;
-      this.onServerDisconnectError = callbacks.onServerDisconnectError;
-      this.logger = logger;
-      this.connect();
-    }
     setSocketState(state) {
       this.socket = state;
       this._logVerbose(
         `socket state changed: ${this.socket.state}, paused: ${"paused" in this.socket ? this.socket.paused : void 0}`
       );
+      this.markConnectionStateDirty();
     }
     connect() {
       if (this.socket.state === "terminated") {
@@ -1673,6 +1682,7 @@ var convex = (() => {
         const response = this.onMessage(serverMessage);
         if (response.hasSyncedPastLastReconnect) {
           this.retries = 0;
+          this.markConnectionStateDirty();
         }
       };
       ws.onclose = (event) => {
@@ -1753,6 +1763,7 @@ var convex = (() => {
     scheduleReconnect(reason) {
       this.socket = { state: "disconnected" };
       const backoff = this.nextBackoff(reason);
+      this.markConnectionStateDirty();
       this.logger.log(`Attempting reconnect in ${backoff}ms`);
       setTimeout(() => this.connect(), backoff);
     }
@@ -2388,6 +2399,9 @@ var convex = (() => {
     debug;
     logger;
     maxObservedTimestamp;
+    connectionStateSubscribers = /* @__PURE__ */ new Map();
+    nextConnectionStateSubscriberId = 0;
+    _lastPublishedConnectionState;
     /**
      * @param address - The url of your Convex deployment, often provided
      * by an environment variable. E.g. `https://small-mouse-123.convex.cloud`.
@@ -2437,7 +2451,10 @@ var convex = (() => {
         (queryId) => this.state.queryPath(queryId),
         this.logger
       );
-      this.requestManager = new RequestManager(this.logger);
+      this.requestManager = new RequestManager(
+        this.logger,
+        this.markConnectionStateDirty
+      );
       this.authenticationManager = new AuthenticationManager(
         this.state,
         {
@@ -2588,7 +2605,8 @@ var convex = (() => {
           onServerDisconnectError: options.onServerDisconnectError
         },
         webSocketConstructor,
-        this.logger
+        this.logger,
+        this.markConnectionStateDirty
       );
       this.mark("convexClientConstructed");
     }
@@ -2805,6 +2823,38 @@ var convex = (() => {
         inflightActions: this.requestManager.inflightActions()
       };
     }
+    /**
+     * Call this whenever the connection state may have changed in a way that could
+     * require publishing it. Schedules a possibly update.
+     */
+    markConnectionStateDirty = () => {
+      void Promise.resolve().then(() => {
+        const curConnectionState = this.connectionState();
+        if (JSON.stringify(curConnectionState) !== JSON.stringify(this._lastPublishedConnectionState)) {
+          this._lastPublishedConnectionState = curConnectionState;
+          for (const cb of this.connectionStateSubscribers.values()) {
+            cb(curConnectionState);
+          }
+        }
+      });
+    };
+    /**
+     * Subscribe to the {@link ConnectionState} between the client and the Convex
+     * backend, calling a callback each time it changes.
+     *
+     * Subscribed callbacks will be called when any part of ConnectionState changes.
+     * ConnectionState may grow in future versions (e.g. to provide a array of
+     * inflight requests) in which case callbacks would be called more frequently.
+     *
+     * @returns An unsubscribe function to stop listening.
+     */
+    subscribeToConnectionState(cb) {
+      const id = this.nextConnectionStateSubscriberId++;
+      this.connectionStateSubscribers.set(id, cb);
+      return () => {
+        this.connectionStateSubscribers.delete(id);
+      };
+    }
     /**
        * Execute a mutation function.
        *
@@ -3275,6 +3325,31 @@ var convex = (() => {
         );
       });
     }
+    /**
+     * Get the current {@link ConnectionState} between the client and the Convex
+     * backend.
+     *
+     * @returns The {@link ConnectionState} with the Convex backend.
+     */
+    connectionState() {
+      if (this.disabled) throw new Error("ConvexClient is disabled");
+      return this.client.connectionState();
+    }
+    /**
+     * Subscribe to the {@link ConnectionState} between the client and the Convex
+     * backend, calling a callback each time it changes.
+     *
+     * Subscribed callbacks will be called when any part of ConnectionState changes.
+     * ConnectionState may grow in future versions (e.g. to provide a array of
+     * inflight requests) in which case callbacks would be called more frequently.
+     *
+     * @returns An unsubscribe function to stop listening.
+     */
+    subscribeToConnectionState(cb) {
+      if (this.disabled) return () => {
+      };
+      return this.client.subscribeToConnectionState(cb);
+    }
   };
 
   // src/browser/http_client.ts
@@ -3302,6 +3377,8 @@ var convex = (() => {
      * - `logger` - A logger or a boolean. If not provided, logs to the console.
      * You can construct your own logger to customize logging to log elsewhere
      * or not log at all, or use `false` as a shorthand for a no-op logger.
+     * A logger is an object with 4 methods: log(), warn(), error(), and logVerbose().
+     * These methods can receive multiple arguments of any types, like console.log().
      * - `auth` - A JWT containing identity claims accessible in Convex functions.
      * This identity may expire so it may be necessary to call `setAuth()` later,
      * but for short-lived clients it's convenient to specify this value here.