isOwnerWithinQuota is required, improve docs

Author: steida

.changeset/olive-bars-count.md

@@ -0,0 +1,7 @@
+---
+"@evolu/common": patch
+"@evolu/nodejs": patch
+"@evolu/relay": patch
+---
+
+isOwnerWithinQuota is required, improve docs

apps/relay/src/index.ts

@@ -12,7 +12,8 @@ const relay = await createNodeJsRelay({
   port: 4000,
   enableLogging: false,
 
-  isOwnerAllowed: (_ownerId) => true,
+  // Note: Relay requires URL in format ws://host:port/<ownerId>
+  // isOwnerAllowed: (_ownerId) => true,
 
   isOwnerWithinQuota: (_ownerId, requiredBytes) => {
     const maxBytes = 1024 * 1024; // 1MB

packages/common/src/Evolu/Relay.ts

@@ -35,10 +35,11 @@ export interface RelayConfig extends ConsoleConfig, StorageConfig {
   readonly name?: SimpleName;
 
   /**
-   * Callback to check if an {@link OwnerId} is allowed to access the relay.
+   * Optional callback to check if an {@link OwnerId} is allowed to access the
+   * relay. If this callback is not provided, all owners are allowed.
    *
-   * The callback receives the OwnerId and returns a {@link MaybeAsync} boolean:
-   * `true` to allow access, or `false` to deny.
+   * The callback receives the {@link OwnerId} and returns a {@link MaybeAsync}
+   * boolean: `true` to allow access, or `false` to deny.
    *
    * The callback can be synchronous (for SQLite or in-memory checks) or
    * asynchronous (for calling remote APIs).
@@ -54,7 +55,8 @@ export interface RelayConfig extends ConsoleConfig, StorageConfig {
    * Owners specify which relays to connect to via {@link OwnerTransport}. In
    * WebSocket-based implementations, this check occurs before accepting the
    * connection, with the OwnerId typically extracted from the URL Path (e.g.,
-   * `ws://localhost:4000/<ownerId>`).
+   * `ws://localhost:4000/<ownerId>`). The relay requires the URL to be in the
+   * correct format for OwnerId extraction.
    *
    * ### Example
    *
@@ -75,7 +77,7 @@ export interface RelayConfig extends ConsoleConfig, StorageConfig {
    *   Promise.resolve(ownerId === "6jy_2F4RT5qqeLgJ14_dnQ"),
    * ```
    */
-  readonly isOwnerAllowed: (ownerId: OwnerId) => MaybeAsync<boolean>;
+  readonly isOwnerAllowed?: (ownerId: OwnerId) => MaybeAsync<boolean>;
 }
 
 /**

packages/common/src/Result.ts

@@ -287,7 +287,7 @@
  *
  * ```ts
  * for (const query of [
- *   sql`drop table evolu_owner;`,
+ *   sql`drop table evolu_config;`,
  *   sql`drop table evolu_message;`,
  * ]) {
  *   const result = deps.sqlite.exec(query);

packages/nodejs/src/Evolu/Relay.ts

@@ -110,6 +110,18 @@ const createNodeJsRelayWithDeps =
     server.on("upgrade", (request, socket, head) => {
       socket.on("error", log.upgradeSocketError);
 
+      const completeUpgrade = () => {
+        socket.removeListener("error", log.upgradeSocketError);
+        wss.handleUpgrade(request, socket, head, (ws) => {
+          wss.emit("connection", ws, request);
+        });
+      };
+
+      if (!isOwnerAllowed) {
+        completeUpgrade();
+        return;
+      }
+
       const ownerId = parseOwnerIdFromOwnerWebSocketTransportUrl(
         request.url ?? "",
       );
@@ -130,10 +142,7 @@ const createNodeJsRelayWithDeps =
           socket.destroy();
           return;
         }
-        socket.removeListener("error", log.upgradeSocketError);
-        wss.handleUpgrade(request, socket, head, (ws) => {
-          wss.emit("connection", ws, request);
-        });
+        completeUpgrade();
       })();
     });