@rocicorp/zero 0.25.0-canary.6 → 0.25.0-canary.8

package/out/zero-client/src/client/options.d.ts

@@ -1,16 +1,14 @@
 import type { LogLevel } from '@rocicorp/logger';
 import type { StoreProvider } from '../../../replicache/src/kv/store.ts';
-import type { MaybePromise } from '../../../shared/src/types.ts';
 import * as v from '../../../shared/src/valita.ts';
-import type { ApplicationError } from '../../../zero-protocol/src/application-error.ts';
 import type { Schema } from '../../../zero-types/src/schema.ts';
+import type { QueryDefinitions } from '../../../zql/src/query/query-definitions.ts';
 import type { CustomMutatorDefs } from './custom.ts';
-import type { ZeroError } from './error.ts';
 import { UpdateNeededReasonType } from './update-needed-reason-type.ts';
 /**
  * Configuration for {@linkcode Zero}.
  */
-export interface ZeroOptions<S extends Schema, MD extends CustomMutatorDefs | undefined = undefined, Context = unknown> {
+export interface ZeroOptions<S extends Schema, MD extends CustomMutatorDefs | undefined = undefined, Context = unknown, QD extends QueryDefinitions<S, Context> | undefined = undefined> {
     /**
      * URL to the zero-cache. This can be a simple hostname, e.g.
      * - "https://myapp-myteam.zero.ms"
@@ -83,6 +81,38 @@ export interface ZeroOptions<S extends Schema, MD extends CustomMutatorDefs | un
      * If not provided, uses the default configured in zero-cache.
      */
     mutateURL?: string | undefined;
+    /**
+     * An object whose values are your custom query definitions. Queries can
+     * either be top-level functions or grouped in namespaces (objects).
+     *
+     * Define queries using the `defineQuery` function to create parameterized
+     * queries that can be called with arguments.
+     *
+     * @example
+     * ```ts
+     * const z = new Zero({
+     *   schema,
+     *   userID,
+     *   queries: {
+     *     // Top-level query
+     *     activeIssues: defineQuery('activeIssues', ({ctx}) =>
+     *       ctx.query.issue.where('status', '=', 'active')
+     *     ),
+     *     // Namespace with multiple queries
+     *     user: {
+     *       byID: defineQuery('userByID', ({ctx, args}: {args: string}) =>
+     *         ctx.query.user.where('id', '=', args)
+     *       ),
+     *     },
+     *   },
+     * });
+     *
+     * // Usage
+     * const issues = await z.run(z.query.activeIssues());
+     * const user = await z.run(z.query.user.byID('user-123'));
+     * ```
+     */
+    queries?: QD | undefined;
     /**
      * Custom URL for query requests sent to your API server.
      * If not provided, uses the default configured in zero-cache.
@@ -143,7 +173,7 @@ export interface ZeroOptions<S extends Schema, MD extends CustomMutatorDefs | un
      *
      * Default is 5 minutes.
      */
-    disconnectTimeout?: number | undefined;
+    disconnectTimeoutMs?: number | undefined;
     /**
      * The timeout in milliseconds for ping operations. This value is used for:
      * - How long to wait in idle before sending a ping to the server
@@ -154,19 +184,6 @@ export interface ZeroOptions<S extends Schema, MD extends CustomMutatorDefs | un
      * Default is 5_000.
      */
     pingTimeoutMs?: number | undefined;
-    /**
-     * Invoked whenever Zero encounters an error.
-     *
-     * The argument is either an error originating from the server/zero-cache,
-     * client error (offline transitions, ping timeouts, websocket errors, etc),
-     * or an application error (e.g. a custom mutator error).
-     *
-     * Use this callback only to surface errors in your metrics/telemetry - use the
-     * `zero.connection` API for handling errors in the UI.
-     *
-     * When `onError` is omitted, Zero logs the error to the browser console.
-     */
-    onError?: (error: ZeroError | ApplicationError) => MaybePromise<void>;
     /**
      * Determines what kind of storage implementation to use on the client.
      *
@@ -249,7 +266,7 @@ export interface ZeroOptions<S extends Schema, MD extends CustomMutatorDefs | un
 /**
  * @deprecated Use {@link ZeroOptions} instead.
  */
-export interface ZeroAdvancedOptions<S extends Schema, MD extends CustomMutatorDefs | undefined = undefined> extends ZeroOptions<S, MD> {
+export interface ZeroAdvancedOptions<S extends Schema, MD extends CustomMutatorDefs | undefined, Context, QD extends QueryDefinitions<S, Context> | undefined> extends ZeroOptions<S, MD, Context, QD> {
 }
 type UpdateNeededReasonBase = {
     message?: string;

package/out/zero-client/src/client/options.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../../../../zero-client/src/client/options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,kBAAkB,CAAC;AAC/C,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,qCAAqC,CAAC;AACvE,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,8BAA8B,CAAC;AAC/D,OAAO,KAAK,CAAC,MAAM,+BAA+B,CAAC;AACnD,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,iDAAiD,CAAC;AACtF,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,mCAAmC,CAAC;AAC9D,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,aAAa,CAAC;AACnD,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAC,sBAAsB,EAAC,MAAM,gCAAgC,CAAC;AAEtE;;GAEG;AACH,MAAM,WAAW,WAAW,CAC1B,CAAC,SAAS,MAAM,EAChB,EAAE,SAAS,iBAAiB,GAAG,SAAS,GAAG,SAAS,EACpD,OAAO,GAAG,OAAO;IAEjB;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEnC;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEjC;;;;;;;;OAQG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAEhC;;;OAGG;IACH,MAAM,EAAE,CAAC,CAAC;IAEV;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,GAAG,SAAS,CAAC;IAE1B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE/B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnC;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAEzD;;;;;;;;;;OAUG;IACH,cAAc,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAEpE;;;;;;;;;;;;OAYG;IACH,qBAAqB,CAAC,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,CAAC;IAEjD;;;;;;;OAOG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE9C;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEvC;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnC;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,SAAS,GAAG,gBAAgB,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC;IAEtE;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,aAAa,GAAG,SAAS,CAAC;IAEpD;;;;;;;;;OASG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAErC;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE9C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,gBAAgB,CAAC,EAAE,CAAC,CAAC,gBAAgB,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAExE;;;;;;;OAOG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEtC;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE3C;;OAEG;IAEH,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB,CAClC,CAAC,SAAS,MAAM,EAChB,EAAE,SAAS,iBAAiB,GAAG,SAAS,GAAG,SAAS,CACpD,SAAQ,WAAW,CAAC,CAAC,EAAE,EAAE,CAAC;CAAG;AAE/B,KAAK,sBAAsB,GAAG;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAC1B,CAAC;IAAC,IAAI,EAAE,sBAAsB,CAAC,cAAc,CAAA;CAAC,GAAG,sBAAsB,CAAC,GACxE,CAAC;IACC,IAAI,EAAE,sBAAsB,CAAC,mBAAmB,CAAC;CAClD,GAAG,sBAAsB,CAAC,GAC3B,CAAC;IACC,IAAI,EAAE,sBAAsB,CAAC,yBAAyB,CAAC;CACxD,GAAG,sBAAsB,CAAC,CAAC;AAEhC,eAAO,MAAM,4BAA4B,EAAE,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAKzE,CAAC"}
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../../../../zero-client/src/client/options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,kBAAkB,CAAC;AAC/C,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,qCAAqC,CAAC;AACvE,OAAO,KAAK,CAAC,MAAM,+BAA+B,CAAC;AACnD,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,mCAAmC,CAAC;AAC9D,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,6CAA6C,CAAC;AAClF,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,aAAa,CAAC;AACnD,OAAO,EAAC,sBAAsB,EAAC,MAAM,gCAAgC,CAAC;AAEtE;;GAEG;AACH,MAAM,WAAW,WAAW,CAC1B,CAAC,SAAS,MAAM,EAChB,EAAE,SAAS,iBAAiB,GAAG,SAAS,GAAG,SAAS,EACpD,OAAO,GAAG,OAAO,EACjB,EAAE,SAAS,gBAAgB,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,SAAS,GAAG,SAAS;IAE/D;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEnC;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEjC;;;;;;;;OAQG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAEhC;;;OAGG;IACH,MAAM,EAAE,CAAC,CAAC;IAEV;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,GAAG,SAAS,CAAC;IAE1B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,OAAO,CAAC,EAAE,EAAE,GAAG,SAAS,CAAC;IAEzB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnC;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAEzD;;;;;;;;;;OAUG;IACH,cAAc,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAEpE;;;;;;;;;;;;OAYG;IACH,qBAAqB,CAAC,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,CAAC;IAEjD;;;;;;;OAOG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE9C;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEzC;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnC;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,aAAa,GAAG,SAAS,CAAC;IAEpD;;;;;;;;;OASG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAErC;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE9C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,gBAAgB,CAAC,EAAE,CAAC,CAAC,gBAAgB,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAExE;;;;;;;OAOG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEtC;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE3C;;OAEG;IAEH,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB,CAClC,CAAC,SAAS,MAAM,EAChB,EAAE,SAAS,iBAAiB,GAAG,SAAS,EACxC,OAAO,EACP,EAAE,SAAS,gBAAgB,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,SAAS,CACnD,SAAQ,WAAW,CAAC,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,CAAC;CAAG;AAE5C,KAAK,sBAAsB,GAAG;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAC1B,CAAC;IAAC,IAAI,EAAE,sBAAsB,CAAC,cAAc,CAAA;CAAC,GAAG,sBAAsB,CAAC,GACxE,CAAC;IACC,IAAI,EAAE,sBAAsB,CAAC,mBAAmB,CAAC;CAClD,GAAG,sBAAsB,CAAC,GAC3B,CAAC;IACC,IAAI,EAAE,sBAAsB,CAAC,yBAAyB,CAAC;CACxD,GAAG,sBAAsB,CAAC,CAAC;AAEhC,eAAO,MAAM,4BAA4B,EAAE,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAKzE,CAAC"}

package/out/zero-client/src/client/options.js

@@ -0,0 +1,11 @@
+import { literalUnion } from "../../../shared/src/valita.js";
+import { SchemaVersionNotSupported, VersionNotSupported, NewClientGroup } from "./update-needed-reason-type-enum.js";
+const updateNeededReasonTypeSchema = literalUnion(
+  NewClientGroup,
+  VersionNotSupported,
+  SchemaVersionNotSupported
+);
+export {
+  updateNeededReasonTypeSchema
+};
+//# sourceMappingURL=options.js.map

package/out/zero-client/src/client/options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.js","sources":["../../../../../zero-client/src/client/options.ts"],"sourcesContent":["import type {LogLevel} from '@rocicorp/logger';\nimport type {StoreProvider} from '../../../replicache/src/kv/store.ts';\nimport * as v from '../../../shared/src/valita.ts';\nimport type {Schema} from '../../../zero-types/src/schema.ts';\nimport type {QueryDefinitions} from '../../../zql/src/query/query-definitions.ts';\nimport type {CustomMutatorDefs} from './custom.ts';\nimport {UpdateNeededReasonType} from './update-needed-reason-type.ts';\n\n/**\n * Configuration for {@linkcode Zero}.\n */\nexport interface ZeroOptions<\n  S extends Schema,\n  MD extends CustomMutatorDefs | undefined = undefined,\n  Context = unknown,\n  QD extends QueryDefinitions<S, Context> | undefined = undefined,\n> {\n  /**\n   * URL to the zero-cache. This can be a simple hostname, e.g.\n   * - \"https://myapp-myteam.zero.ms\"\n   * or a prefix with a single path component, e.g.\n   * - \"https://myapp-myteam.zero.ms/zero\"\n   * - \"https://myapp-myteam.zero.ms/db\"\n   *\n   * The latter is useful for configuring routing rules (e.g. \"/zero/\\*\") when\n   * the zero-cache is hosted on the same domain as the application. **Note that\n   * only a single path segment is allowed (e.g. it cannot be \"/proxy/zero/\\*\")**.\n   */\n  server?: string | null | undefined;\n\n  /**\n   * A token to identify and authenticate the user.\n   *\n   * Set `auth` to `null` or `undefined` if there is no logged in user.\n   *\n   * When a 401 or 403 HTTP status code is received from your server, Zero will\n   * transition to the `needs-auth` connection state. The app should call\n   * `zero.connection.connect({auth: newToken})` with a new token to reconnect.\n   *\n   * The call to `connect` is handled automatically by the ZeroProvider component\n   * for React and SolidJS when the `auth` prop changes.\n   */\n  auth?: string | null | undefined;\n\n  /**\n   * A unique identifier for the user. Must be non-empty.\n   *\n   * Each userID gets its own client-side storage so that the app can switch\n   * between users without losing state.\n   *\n   * This must match the `sub` claim of the `auth` token if\n   * `auth` is provided.\n   */\n  userID: string;\n\n  /**\n   * Distinguishes the storage used by this Zero instance from that of other\n   * instances with the same userID. Useful in the case where the app wants to\n   * have multiple Zero instances for the same user for different parts of the\n   * app.\n   */\n  storageKey?: string | undefined;\n\n  /**\n   * Determines the level of detail at which Zero logs messages about\n   * its operation. Messages are logged to the `console`.\n   *\n   * When this is set to `'debug'`, `'info'` and `'error'` messages are also\n   * logged. When set to `'info'`, `'info'` and `'error'` but not\n   * `'debug'` messages are logged. When set to `'error'` only `'error'`\n   * messages are logged.\n   *\n   * Default is `'error'`.\n   */\n  logLevel?: LogLevel | undefined;\n\n  /**\n   * This defines the schema of the tables used in Zero and their relationships\n   * to one another.\n   */\n  schema: S;\n\n  /**\n   * `mutators` is a map of custom mutator definitions. The keys are\n   * namespaces or names of the mutators. The values are the mutator\n   * implementations. Client side mutators must be idempotent as a\n   * mutation can be rebased multiple times when folding in authoritative\n   * changes from the server to the client.\n   */\n  mutators?: MD | undefined;\n\n  /**\n   * Custom URL for mutation requests sent to your API server.\n   * If not provided, uses the default configured in zero-cache.\n   */\n  mutateURL?: string | undefined;\n\n  /**\n   * An object whose values are your custom query definitions. Queries can\n   * either be top-level functions or grouped in namespaces (objects).\n   *\n   * Define queries using the `defineQuery` function to create parameterized\n   * queries that can be called with arguments.\n   *\n   * @example\n   * ```ts\n   * const z = new Zero({\n   *   schema,\n   *   userID,\n   *   queries: {\n   *     // Top-level query\n   *     activeIssues: defineQuery('activeIssues', ({ctx}) =>\n   *       ctx.query.issue.where('status', '=', 'active')\n   *     ),\n   *     // Namespace with multiple queries\n   *     user: {\n   *       byID: defineQuery('userByID', ({ctx, args}: {args: string}) =>\n   *         ctx.query.user.where('id', '=', args)\n   *       ),\n   *     },\n   *   },\n   * });\n   *\n   * // Usage\n   * const issues = await z.run(z.query.activeIssues());\n   * const user = await z.run(z.query.user.byID('user-123'));\n   * ```\n   */\n  queries?: QD | undefined;\n\n  /**\n   * Custom URL for query requests sent to your API server.\n   * If not provided, uses the default configured in zero-cache.\n   */\n  getQueriesURL?: string | undefined;\n\n  /**\n   * `onOnlineChange` is called when the Zero instance's online status changes.\n   *\n   * @deprecated Use {@linkcode Connection.state.subscribe} on the Zero instance instead. e.g.\n   * ```ts\n   * const zero = new Zero({...});\n   * zero.connection.state.subscribe((state) => {\n   *   console.log('Connection state:', state.name);\n   * });\n   * ```\n   *\n   * Or use a hook like {@linkcode useZeroConnectionState} to subscribe to state changes.\n   */\n  onOnlineChange?: ((online: boolean) => void) | undefined;\n\n  /**\n   * `onUpdateNeeded` is called when a client code update is needed.\n   *\n   * See {@link UpdateNeededReason} for why updates can be needed.\n   *\n   * The default behavior is to reload the page (using `location.reload()`).\n   * Provide your own function to prevent the page from\n   * reloading automatically. You may want to display a toast to inform the end\n   * user there is a new version of your app available and prompt them to\n   * refresh.\n   */\n  onUpdateNeeded?: ((reason: UpdateNeededReason) => void) | undefined;\n\n  /**\n   * `onClientStateNotFound` is called when this client is no longer able\n   * to sync with the zero-cache due to missing synchronization state.  This\n   * can be because:\n   * - the local persistent synchronization state has been garbage collected.\n   *   This can happen if the client has no pending mutations and has not been\n   *   used for a while (e.g. the client's tab has been hidden for a long time).\n   * - the zero-cache fails to find the server side synchronization state for\n   *   this client.\n   *\n   * The default behavior is to reload the page (using `location.reload()`).\n   * Provide your own function to prevent the page from reloading automatically.\n   */\n  onClientStateNotFound?: (() => void) | undefined;\n\n  /**\n   * The number of milliseconds to wait before disconnecting a Zero\n   * instance whose tab has become hidden.\n   *\n   * Instances in hidden tabs are disconnected to save resources.\n   *\n   * Default is 5_000.\n   */\n  hiddenTabDisconnectDelay?: number | undefined;\n\n  /**\n   * The number of milliseconds to wait before disconnecting a Zero\n   * instance when the connection to the server has timed out.\n   *\n   * Default is 5 minutes.\n   */\n  disconnectTimeoutMs?: number | undefined;\n\n  /**\n   * The timeout in milliseconds for ping operations. This value is used for:\n   * - How long to wait in idle before sending a ping to the server\n   * - How long to wait for a pong response after sending a ping\n   *\n   * Total time to detect a dead connection is 2 × pingTimeoutMs.\n   *\n   * Default is 5_000.\n   */\n  pingTimeoutMs?: number | undefined;\n\n  /**\n   * Determines what kind of storage implementation to use on the client.\n   *\n   * Defaults to `'idb'` which means that Zero uses an IndexedDB storage\n   * implementation. This allows the data to be persisted on the client and\n   * enables faster syncs between application restarts.\n   *\n   * By setting this to `'mem'`, Zero uses an in memory storage and\n   * the data is not persisted on the client.\n   *\n   * You can also set this to a function that is used to create new KV stores,\n   * allowing a custom implementation of the underlying storage layer.\n   */\n  kvStore?: 'mem' | 'idb' | StoreProvider | undefined;\n\n  /**\n   * The maximum number of bytes to allow in a single header.\n   *\n   * Zero adds some extra information to headers on initialization if possible.\n   * This speeds up data synchronization. This number should be kept less than\n   * or equal to the maximum header size allowed by the zero-cache and any load\n   * balancers.\n   *\n   * Default value: 8kb.\n   */\n  maxHeaderLength?: number | undefined;\n\n  /**\n   * The maximum amount of milliseconds to wait for a materialization to\n   * complete (including network/server time) before printing a warning to the\n   * console.\n   *\n   * Default value: 5_000.\n   */\n  slowMaterializeThreshold?: number | undefined;\n\n  /**\n   * UI rendering libraries will often provide a utility for batching multiple\n   * state updates into a single render. Some examples are React's\n   * `unstable_batchedUpdates`, and solid-js's `batch`.\n   *\n   * This option enables integrating these batch utilities with Zero.\n   *\n   * When `batchViewUpdates` is provided, Zero will call it whenever\n   * it updates query view state with an `applyViewUpdates` function\n   * that performs the actual state updates.\n   *\n   * Zero updates query view state when:\n   * 1. creating a new view\n   * 2. updating all existing queries' views to a new consistent state\n   *\n   * When creating a new view, that single view's creation will be wrapped\n   * in a `batchViewUpdates` call.\n   *\n   * When updating existing queries, all queries will be updated in a single\n   * `batchViewUpdates` call, so that the transition to the new consistent\n   * state can be done in a single render.\n   *\n   * Implementations must always call `applyViewUpdates` synchronously.\n   */\n  batchViewUpdates?: ((applyViewUpdates: () => void) => void) | undefined;\n\n  /**\n   * The maximum number of recent queries, no longer subscribed to by a preload\n   * or view, to continue syncing.\n   *\n   * Defaults is 0.\n   *\n   * @deprecated Use ttl instead\n   */\n  maxRecentQueries?: number | undefined;\n\n  /**\n   * Changes to queries are sent to server in batches. This option controls\n   * the number of milliseconds to wait before sending the next batch.\n   *\n   * Defaults is 10.\n   */\n  queryChangeThrottleMs?: number | undefined;\n\n  /**\n   * Context is passed to Synced Queries when they are executed\n   */\n  // TODO(arv): Mutators should also get context.\n  context?: Context | undefined;\n}\n\n/**\n * @deprecated Use {@link ZeroOptions} instead.\n */\nexport interface ZeroAdvancedOptions<\n  S extends Schema,\n  MD extends CustomMutatorDefs | undefined,\n  Context,\n  QD extends QueryDefinitions<S, Context> | undefined,\n> extends ZeroOptions<S, MD, Context, QD> {}\n\ntype UpdateNeededReasonBase = {\n  message?: string;\n};\n\nexport type UpdateNeededReason =\n  | ({type: UpdateNeededReasonType.NewClientGroup} & UpdateNeededReasonBase)\n  | ({\n      type: UpdateNeededReasonType.VersionNotSupported;\n    } & UpdateNeededReasonBase)\n  | ({\n      type: UpdateNeededReasonType.SchemaVersionNotSupported;\n    } & UpdateNeededReasonBase);\n\nexport const updateNeededReasonTypeSchema: v.Type<UpdateNeededReason['type']> =\n  v.literalUnion(\n    UpdateNeededReasonType.NewClientGroup,\n    UpdateNeededReasonType.VersionNotSupported,\n    UpdateNeededReasonType.SchemaVersionNotSupported,\n  );\n"],"names":["v.literalUnion","UpdateNeededReasonType.NewClientGroup","UpdateNeededReasonType.VersionNotSupported","UpdateNeededReasonType.SchemaVersionNotSupported"],"mappings":";;AA8TO,MAAM,+BACXA;AAAAA,EACEC;AAAAA,EACAC;AAAAA,EACAC;AACF;"}

package/out/zero-client/src/client/query-manager.d.ts

@@ -1,7 +1,7 @@
+import type { LogContext } from '@rocicorp/logger';
 import type { ReplicacheImpl } from '../../../replicache/src/replicache-impl.ts';
 import type { ClientID } from '../../../replicache/src/sync/ids.ts';
 import { TDigest } from '../../../shared/src/tdigest.ts';
-import { ApplicationError } from '../../../zero-protocol/src/application-error.ts';
 import { type AST } from '../../../zero-protocol/src/ast.ts';
 import type { ChangeDesiredQueriesMessage } from '../../../zero-protocol/src/change-desired-queries.ts';
 import type { ErroredQuery } from '../../../zero-protocol/src/custom-queries.ts';
@@ -11,12 +11,12 @@ import type { ClientMetricMap } from '../../../zql/src/query/metrics-delegate.ts
 import type { CustomQueryID } from '../../../zql/src/query/named.ts';
 import type { GotCallback } from '../../../zql/src/query/query-delegate.ts';
 import { type TTL } from '../../../zql/src/query/ttl.ts';
-import { ClientErrorKind } from './client-error-kind.ts';
-import { ClientError, type ZeroError } from './error.ts';
+import type { ClientErrorKind } from './client-error-kind.ts';
+import type { ClientError } from './error.ts';
+import { type ZeroError } from './error.ts';
 import type { InspectorDelegate } from './inspector/inspector.ts';
 import type { MutationTracker } from './mutation-tracker.ts';
 import type { ReadTransaction } from './replicache-types.ts';
-import type { ZeroLogContext } from './zero-log-context.ts';
 type ClientMetric = {
     [K in keyof ClientMetricMap]: TDigest;
 };
@@ -27,7 +27,7 @@ type ClientMetric = {
  */
 export declare class QueryManager implements InspectorDelegate {
     #private;
-    constructor(lc: ZeroLogContext, mutationTracker: MutationTracker, clientID: ClientID, tables: Record<string, TableSchema>, send: (change: ChangeDesiredQueriesMessage) => void, experimentalWatch: ReplicacheImpl['experimentalWatch'], recentQueriesMaxSize: number, queryChangeThrottleMs: number, slowMaterializeThreshold: number, onFatalError: (error: ZeroError) => void, onApplicationError: (error: ApplicationError) => void);
+    constructor(lc: LogContext, mutationTracker: MutationTracker, clientID: ClientID, tables: Record<string, TableSchema>, send: (change: ChangeDesiredQueriesMessage) => void, experimentalWatch: ReplicacheImpl['experimentalWatch'], recentQueriesMaxSize: number, queryChangeThrottleMs: number, slowMaterializeThreshold: number, onFatalError: (error: ZeroError) => void);
     getAST(queryID: string): AST | undefined;
     mapClientASTToServer(ast: AST): AST;
     /**

package/out/zero-client/src/client/query-manager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"query-manager.d.ts","sourceRoot":"","sources":["../../../../../zero-client/src/client/query-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,4CAA4C,CAAC;AAC/E,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,qCAAqC,CAAC;AAIlE,OAAO,EAAC,OAAO,EAAC,MAAM,gCAAgC,CAAC;AACvD,OAAO,EAAC,gBAAgB,EAAC,MAAM,iDAAiD,CAAC;AACjF,OAAO,EAGL,KAAK,GAAG,EACT,MAAM,mCAAmC,CAAC;AAC3C,OAAO,KAAK,EAAC,2BAA2B,EAAC,MAAM,sDAAsD,CAAC;AACtG,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,8CAA8C,CAAC;AAK/E,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,6CAA6C,CAAC;AAUlF,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,0CAA0C,CAAC;AAC1E,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,4CAA4C,CAAC;AAChF,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,iCAAiC,CAAC;AACnE,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,0CAA0C,CAAC;AAC1E,OAAO,EAAuB,KAAK,GAAG,EAAC,MAAM,+BAA+B,CAAC;AAC7E,OAAO,EAAC,eAAe,EAAC,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAC,WAAW,EAAE,KAAK,SAAS,EAAC,MAAM,YAAY,CAAC;AACvD,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,0BAA0B,CAAC;AAEhE,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,uBAAuB,CAAC;AAC3D,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,uBAAuB,CAAC;AAC3D,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,uBAAuB,CAAC;AAc1D,KAAK,YAAY,GAAG;KACjB,CAAC,IAAI,MAAM,eAAe,GAAG,OAAO;CACtC,CAAC;AAEF;;;;GAIG;AACH,qBAAa,YAAa,YAAW,iBAAiB;;gBAuBlD,EAAE,EAAE,cAAc,EAClB,eAAe,EAAE,eAAe,EAChC,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,EACnC,IAAI,EAAE,CAAC,MAAM,EAAE,2BAA2B,KAAK,IAAI,EACnD,iBAAiB,EAAE,cAAc,CAAC,mBAAmB,CAAC,EACtD,oBAAoB,EAAE,MAAM,EAC5B,qBAAqB,EAAE,MAAM,EAC7B,wBAAwB,EAAE,MAAM,EAChC,YAAY,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,EACxC,kBAAkB,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,IAAI;IA+CvD,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,GAAG,SAAS;IAKxC,oBAAoB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG;IAWnC;;;;;;;;;;;;;;OAcG;IACG,eAAe,CACnB,EAAE,EAAE,eAAe,EACnB,SAAS,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,GACxC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAgDzC,qBAAqB,CAAC,MAAM,EAAE,YAAY,EAAE;IAoC5C,YAAY,CACV,MAAM,EAAE,WAAW,CAAC;QAAC,IAAI,EAAE,eAAe,CAAC,YAAY,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAC,CAAC;IAoB5E,SAAS,CACP,GAAG,EAAE,GAAG,EACR,EAAC,IAAI,EAAE,IAAI,EAAC,EAAE,aAAa,EAC3B,GAAG,EAAE,GAAG,EACR,WAAW,CAAC,EAAE,WAAW,GACxB,MAAM,IAAI;IAMb,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,MAAM,IAAI;IAkFpE,YAAY,CAAC,EAAC,IAAI,EAAE,IAAI,EAAC,EAAE,aAAa,EAAE,GAAG,EAAE,GAAG;IAMlD,YAAY,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG;IAsC/B,UAAU;IAmCV;;OAEG;IACH,IAAI,OAAO,IAAI,YAAY,CAE1B;IAED,SAAS,CAAC,CAAC,SAAS,MAAM,eAAe,EACvC,MAAM,EAAE,CAAC,EACT,KAAK,EAAE,MAAM,EACb,GAAG,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,GAC1B,IAAI;IA4CP,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;CAG3D"}
+{"version":3,"file":"query-manager.d.ts","sourceRoot":"","sources":["../../../../../zero-client/src/client/query-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AACjD,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,4CAA4C,CAAC;AAC/E,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,qCAAqC,CAAC;AAIlE,OAAO,EAAC,OAAO,EAAC,MAAM,gCAAgC,CAAC;AACvD,OAAO,EAGL,KAAK,GAAG,EACT,MAAM,mCAAmC,CAAC;AAC3C,OAAO,KAAK,EAAC,2BAA2B,EAAC,MAAM,sDAAsD,CAAC;AACtG,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,8CAA8C,CAAC;AAK/E,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,6CAA6C,CAAC;AAUlF,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,0CAA0C,CAAC;AAC1E,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,4CAA4C,CAAC;AAChF,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,iCAAiC,CAAC;AACnE,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,0CAA0C,CAAC;AAC1E,OAAO,EAAuB,KAAK,GAAG,EAAC,MAAM,+BAA+B,CAAC;AAC7E,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAC,KAAK,SAAS,EAAC,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,0BAA0B,CAAC;AAEhE,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,uBAAuB,CAAC;AAC3D,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,uBAAuB,CAAC;AAc3D,KAAK,YAAY,GAAG;KACjB,CAAC,IAAI,MAAM,eAAe,GAAG,OAAO;CACtC,CAAC;AAEF;;;;GAIG;AACH,qBAAa,YAAa,YAAW,iBAAiB;;gBAsBlD,EAAE,EAAE,UAAU,EACd,eAAe,EAAE,eAAe,EAChC,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,EACnC,IAAI,EAAE,CAAC,MAAM,EAAE,2BAA2B,KAAK,IAAI,EACnD,iBAAiB,EAAE,cAAc,CAAC,mBAAmB,CAAC,EACtD,oBAAoB,EAAE,MAAM,EAC5B,qBAAqB,EAAE,MAAM,EAC7B,wBAAwB,EAAE,MAAM,EAChC,YAAY,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI;IA8C1C,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,GAAG,SAAS;IAKxC,oBAAoB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG;IAWnC;;;;;;;;;;;;;;OAcG;IACG,eAAe,CACnB,EAAE,EAAE,eAAe,EACnB,SAAS,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,GACxC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAgDzC,qBAAqB,CAAC,MAAM,EAAE,YAAY,EAAE;IA8B5C,YAAY,CACV,MAAM,EAAE,WAAW,CAAC;QAAC,IAAI,EAAE,eAAe,CAAC,YAAY,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAC,CAAC;IAoB5E,SAAS,CACP,GAAG,EAAE,GAAG,EACR,EAAC,IAAI,EAAE,IAAI,EAAC,EAAE,aAAa,EAC3B,GAAG,EAAE,GAAG,EACR,WAAW,CAAC,EAAE,WAAW,GACxB,MAAM,IAAI;IAMb,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,MAAM,IAAI;IAkFpE,YAAY,CAAC,EAAC,IAAI,EAAE,IAAI,EAAC,EAAE,aAAa,EAAE,GAAG,EAAE,GAAG;IAMlD,YAAY,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG;IAsC/B,UAAU;IAmCV;;OAEG;IACH,IAAI,OAAO,IAAI,YAAY,CAE1B;IAED,SAAS,CAAC,CAAC,SAAS,MAAM,eAAe,EACvC,MAAM,EAAE,CAAC,EACT,KAAK,EAAE,MAAM,EACb,GAAG,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,GAC1B,IAAI;IA4CP,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;CAG3D"}

package/out/zero-client/src/client/query-manager.js

@@ -0,0 +1,377 @@
+import { assert } from "../../../shared/src/asserts.js";
+import { must } from "../../../shared/src/must.js";
+import { TDigest } from "../../../shared/src/tdigest.js";
+import { mapAST, normalizeAST } from "../../../zero-protocol/src/ast.js";
+import { TransformFailed } from "../../../zero-protocol/src/error-kind-enum.js";
+import { ZeroCache } from "../../../zero-protocol/src/error-origin-enum.js";
+import { Internal } from "../../../zero-protocol/src/error-reason-enum.js";
+import { ProtocolError } from "../../../zero-protocol/src/error.js";
+import { hashOfNameAndArgs, hashOfAST } from "../../../zero-protocol/src/query-hash.js";
+import { clientToServer, serverToClient } from "../../../zero-schema/src/name-mapper.js";
+import { clampTTL, compareTTL } from "../../../zql/src/query/ttl.js";
+import "../../../shared/src/json-schema.js";
+import { GOT_QUERIES_KEY_PREFIX, desiredQueriesPrefixForClient } from "./keys.js";
+class QueryManager {
+  #clientID;
+  #clientToServer;
+  #serverToClient;
+  #send;
+  #onFatalError;
+  #queries = /* @__PURE__ */ new Map();
+  #recentQueriesMaxSize;
+  #recentQueries = /* @__PURE__ */ new Set();
+  #gotQueries = /* @__PURE__ */ new Set();
+  #mutationTracker;
+  #pendingQueryChanges = [];
+  #queryChangeThrottleMs;
+  #pendingRemovals = [];
+  #batchTimer;
+  #lc;
+  #metrics = newMetrics();
+  #queryMetrics = /* @__PURE__ */ new Map();
+  #slowMaterializeThreshold;
+  #closedError;
+  constructor(lc, mutationTracker, clientID, tables, send, experimentalWatch, recentQueriesMaxSize, queryChangeThrottleMs, slowMaterializeThreshold, onFatalError) {
+    this.#lc = lc.withContext("QueryManager");
+    this.#clientID = clientID;
+    this.#clientToServer = clientToServer(tables);
+    this.#serverToClient = serverToClient(tables);
+    this.#recentQueriesMaxSize = recentQueriesMaxSize;
+    this.#send = send;
+    this.#mutationTracker = mutationTracker;
+    this.#queryChangeThrottleMs = queryChangeThrottleMs;
+    this.#slowMaterializeThreshold = slowMaterializeThreshold;
+    this.#onFatalError = onFatalError;
+    this.#mutationTracker.onAllMutationsApplied(() => {
+      if (this.#pendingRemovals.length === 0) {
+        return;
+      }
+      const pendingRemovals = this.#pendingRemovals;
+      this.#pendingRemovals = [];
+      for (const removal of pendingRemovals) {
+        removal();
+      }
+    });
+    experimentalWatch(
+      (diff) => {
+        for (const diffOp of diff) {
+          const queryHash = diffOp.key.substring(GOT_QUERIES_KEY_PREFIX.length);
+          switch (diffOp.op) {
+            case "add":
+              this.#gotQueries.add(queryHash);
+              this.#fireGotCallbacks(queryHash, true);
+              break;
+            case "del":
+              this.#gotQueries.delete(queryHash);
+              this.#fireGotCallbacks(queryHash, false);
+              break;
+          }
+        }
+      },
+      {
+        prefix: GOT_QUERIES_KEY_PREFIX,
+        initialValuesInFirstDiff: true
+      }
+    );
+  }
+  getAST(queryID) {
+    const ast = this.#queries.get(queryID)?.normalized;
+    return ast && mapAST(ast, this.#serverToClient);
+  }
+  mapClientASTToServer(ast) {
+    return mapAST(ast, this.#clientToServer);
+  }
+  #fireGotCallbacks(queryHash, got) {
+    const gotCallbacks = this.#queries.get(queryHash)?.gotCallbacks ?? [];
+    for (const gotCallback of gotCallbacks) {
+      gotCallback(got);
+    }
+  }
+  /**
+   * Get the queries that need to be registered with the server.
+   *
+   * An optional `lastPatch` can be provided. This is the last patch that was
+   * sent to the server and may not yet have been acked. If `lastPatch` is provided,
+   * this method will return a patch that does not include any events sent in `lastPatch`.
+   *
+   * This diffing of last patch and current patch is needed since we send
+   * a set of queries to the server when we first connect inside of the `sec-protocol` as
+   * the `initConnectionMessage`.
+   *
+   * While we're waiting for the `connected` response to come back from the server,
+   * the client may have registered more queries. We need to diff the `initConnectionMessage`
+   * queries with the current set of queries to understand what those were.
+   */
+  async getQueriesPatch(tx, lastPatch) {
+    const existingQueryHashes = /* @__PURE__ */ new Set();
+    const prefix = desiredQueriesPrefixForClient(this.#clientID);
+    for await (const key of tx.scan({ prefix }).keys()) {
+      existingQueryHashes.add(key.substring(prefix.length, key.length));
+    }
+    const patch = /* @__PURE__ */ new Map();
+    for (const hash of existingQueryHashes) {
+      if (!this.#queries.has(hash)) {
+        patch.set(hash, { op: "del", hash });
+      }
+    }
+    for (const [hash, { normalized, ttl, name, args }] of this.#queries) {
+      if (!existingQueryHashes.has(hash)) {
+        patch.set(hash, {
+          op: "put",
+          hash,
+          ast: name === void 0 ? normalized : void 0,
+          name,
+          args,
+          // We get TTL out of the DagStore so it is possible that the TTL was written
+          // with a too high TTL.
+          ttl: clampTTL(ttl)
+          // no lc here since no need to log here
+        });
+      }
+    }
+    if (lastPatch) {
+      for (const [hash, { op }] of lastPatch) {
+        if (op === "put" && !patch.has(hash)) {
+          patch.set(hash, { op: "del", hash });
+        }
+      }
+      for (const [hash, { op }] of patch) {
+        const lastPatchOp = lastPatch.get(hash);
+        if (lastPatchOp && lastPatchOp.op === op) {
+          patch.delete(hash);
+        }
+      }
+    }
+    return patch;
+  }
+  handleTransformErrors(errors) {
+    for (const error of errors) {
+      const queryId = error.id;
+      const entry = this.#queries.get(queryId);
+      if (!entry) {
+        continue;
+      }
+      if (error.error === "app" || error.error === "parse") {
+        entry.gotCallbacks.forEach((callback) => callback(false, error));
+      } else {
+        this.#onFatalError(
+          new ProtocolError({
+            kind: TransformFailed,
+            origin: ZeroCache,
+            reason: Internal,
+            message: `Unknown error transforming queries: ${JSON.stringify(error)}`,
+            queryIDs: []
+          })
+        );
+      }
+    }
+  }
+  handleClosed(reason) {
+    if (this.#closedError) {
+      return;
+    }
+    this.#closedError = reason;
+    for (const [queryId, entry] of this.#queries) {
+      const erroredQuery = {
+        error: "app",
+        id: queryId,
+        name: entry.name ?? "legacy",
+        message: reason.message,
+        details: { kind: reason.kind }
+      };
+      for (const gotCallback of entry.gotCallbacks) {
+        gotCallback(false, erroredQuery);
+      }
+    }
+  }
+  addCustom(ast, { name, args }, ttl, gotCallback) {
+    const normalized = normalizeAST(ast);
+    const queryId = hashOfNameAndArgs(name, args);
+    return this.#add(queryId, normalized, name, args, ttl, gotCallback);
+  }
+  addLegacy(ast, ttl, gotCallback) {
+    const normalized = normalizeAST(ast);
+    const astHash = hashOfAST(normalized);
+    return this.#add(
+      astHash,
+      normalized,
+      void 0,
+      // name is undefined for legacy queries
+      void 0,
+      // args are undefined for legacy queries
+      ttl,
+      gotCallback
+    );
+  }
+  #add(queryId, normalized, name, args, ttl, gotCallback) {
+    assert(
+      name === void 0 === (args === void 0),
+      "If name is defined, args must be defined"
+    );
+    ttl = clampTTL(ttl, this.#lc);
+    let entry = this.#queries.get(queryId);
+    this.#recentQueries.delete(queryId);
+    if (!entry) {
+      normalized = mapAST(normalized, this.#clientToServer);
+      entry = {
+        normalized,
+        name,
+        args,
+        count: 1,
+        gotCallbacks: gotCallback ? [gotCallback] : [],
+        ttl
+      };
+      this.#queries.set(queryId, entry);
+      this.#queueQueryChange({
+        op: "put",
+        hash: queryId,
+        ast: name === void 0 ? normalized : void 0,
+        name,
+        args,
+        ttl
+      });
+    } else {
+      ++entry.count;
+      this.#updateEntry(entry, queryId, ttl);
+      if (gotCallback) {
+        entry.gotCallbacks.push(gotCallback);
+      }
+    }
+    if (gotCallback) {
+      gotCallback(this.#gotQueries.has(queryId));
+    }
+    let removed = false;
+    const cleanupCb = () => {
+      if (removed) {
+        return;
+      }
+      removed = true;
+      if (this.#mutationTracker.size > 0) {
+        this.#pendingRemovals.push(
+          () => this.#remove(entry, queryId, gotCallback)
+        );
+        return;
+      }
+      this.#remove(entry, queryId, gotCallback);
+    };
+    return cleanupCb;
+  }
+  updateCustom({ name, args }, ttl) {
+    const queryID = hashOfNameAndArgs(name, args);
+    const entry = must(this.#queries.get(queryID));
+    this.#updateEntry(entry, queryID, ttl);
+  }
+  updateLegacy(ast, ttl) {
+    const normalized = normalizeAST(ast);
+    const queryID = hashOfAST(normalized);
+    const entry = must(this.#queries.get(queryID));
+    this.#updateEntry(entry, queryID, ttl);
+  }
+  #updateEntry(entry, queryID, ttl) {
+    ttl = clampTTL(ttl, this.#lc);
+    if (compareTTL(ttl, entry.ttl) > 0) {
+      entry.ttl = ttl;
+      this.#queueQueryChange({
+        op: "put",
+        hash: queryID,
+        ast: entry.name === void 0 ? entry.normalized : void 0,
+        name: entry.name,
+        args: entry.args,
+        ttl
+      });
+    }
+  }
+  #queueQueryChange(op) {
+    this.#pendingQueryChanges.push(op);
+    this.#scheduleBatch();
+  }
+  #scheduleBatch() {
+    if (this.#batchTimer === void 0) {
+      this.#batchTimer = setTimeout(
+        () => this.flushBatch(),
+        this.#queryChangeThrottleMs
+      );
+    }
+  }
+  flushBatch() {
+    if (this.#batchTimer !== void 0) {
+      clearTimeout(this.#batchTimer);
+      this.#batchTimer = void 0;
+    }
+    if (this.#pendingQueryChanges.length > 0) {
+      this.#send([
+        "changeDesiredQueries",
+        {
+          desiredQueriesPatch: [...this.#pendingQueryChanges]
+        }
+      ]);
+      this.#pendingQueryChanges.length = 0;
+    }
+  }
+  #remove(entry, astHash, gotCallback) {
+    if (gotCallback) {
+      const index = entry.gotCallbacks.indexOf(gotCallback);
+      entry.gotCallbacks.splice(index, 1);
+    }
+    --entry.count;
+    if (entry.count === 0) {
+      this.#recentQueries.add(astHash);
+      if (this.#recentQueries.size > this.#recentQueriesMaxSize) {
+        const lruQueryID = this.#recentQueries.values().next().value;
+        assert(lruQueryID);
+        this.#queries.delete(lruQueryID);
+        this.#recentQueries.delete(lruQueryID);
+        this.#queryMetrics.delete(lruQueryID);
+        this.#queueQueryChange({ op: "del", hash: lruQueryID });
+      }
+    }
+  }
+  /**
+   * Gets the aggregated metrics for all queries managed by this QueryManager.
+   */
+  get metrics() {
+    return this.#metrics;
+  }
+  addMetric(metric, value, ...args) {
+    this.#metrics[metric].add(value);
+    const queryID = args[0];
+    if (metric === "query-materialization-end-to-end") {
+      const ast = args[1];
+      if (this.#slowMaterializeThreshold !== void 0 && value > this.#slowMaterializeThreshold) {
+        this.#lc.warn?.(
+          "Slow query materialization (including server/network)",
+          queryID,
+          ast,
+          value
+        );
+      } else {
+        this.#lc.debug?.(
+          "Materialized query (including server/network)",
+          queryID,
+          ast,
+          value
+        );
+      }
+    }
+    let existing = this.#queryMetrics.get(queryID);
+    if (!existing) {
+      existing = newMetrics();
+      this.#queryMetrics.set(queryID, existing);
+    }
+    existing[metric].add(value);
+  }
+  getQueryMetrics(queryID) {
+    return this.#queryMetrics.get(queryID);
+  }
+}
+function newMetrics() {
+  return {
+    "query-materialization-client": new TDigest(),
+    "query-materialization-end-to-end": new TDigest(),
+    "query-update-client": new TDigest()
+  };
+}
+export {
+  QueryManager
+};
+//# sourceMappingURL=query-manager.js.map

package/out/zero-client/src/client/query-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-manager.js","sources":["../../../../../zero-client/src/client/query-manager.ts"],"sourcesContent":["import type {LogContext} from '@rocicorp/logger';\nimport type {ReplicacheImpl} from '../../../replicache/src/replicache-impl.ts';\nimport type {ClientID} from '../../../replicache/src/sync/ids.ts';\nimport {assert} from '../../../shared/src/asserts.ts';\nimport type {ReadonlyJSONValue} from '../../../shared/src/json.ts';\nimport {must} from '../../../shared/src/must.ts';\nimport {TDigest} from '../../../shared/src/tdigest.ts';\nimport {\n  mapAST,\n  normalizeAST,\n  type AST,\n} from '../../../zero-protocol/src/ast.ts';\nimport type {ChangeDesiredQueriesMessage} from '../../../zero-protocol/src/change-desired-queries.ts';\nimport type {ErroredQuery} from '../../../zero-protocol/src/custom-queries.ts';\nimport {ErrorKind} from '../../../zero-protocol/src/error-kind.ts';\nimport {ErrorOrigin} from '../../../zero-protocol/src/error-origin.ts';\nimport {ErrorReason} from '../../../zero-protocol/src/error-reason.ts';\nimport {ProtocolError} from '../../../zero-protocol/src/error.ts';\nimport type {UpQueriesPatchOp} from '../../../zero-protocol/src/queries-patch.ts';\nimport {\n  hashOfAST,\n  hashOfNameAndArgs,\n} from '../../../zero-protocol/src/query-hash.ts';\nimport {\n  clientToServer,\n  serverToClient,\n  type NameMapper,\n} from '../../../zero-schema/src/name-mapper.ts';\nimport type {TableSchema} from '../../../zero-schema/src/table-schema.ts';\nimport type {ClientMetricMap} from '../../../zql/src/query/metrics-delegate.ts';\nimport type {CustomQueryID} from '../../../zql/src/query/named.ts';\nimport type {GotCallback} from '../../../zql/src/query/query-delegate.ts';\nimport {clampTTL, compareTTL, type TTL} from '../../../zql/src/query/ttl.ts';\nimport type {ClientErrorKind} from './client-error-kind.ts';\nimport type {ClientError} from './error.ts';\nimport {type ZeroError} from './error.ts';\nimport type {InspectorDelegate} from './inspector/inspector.ts';\nimport {desiredQueriesPrefixForClient, GOT_QUERIES_KEY_PREFIX} from './keys.ts';\nimport type {MutationTracker} from './mutation-tracker.ts';\nimport type {ReadTransaction} from './replicache-types.ts';\n\ntype QueryHash = string;\n\ntype Entry = {\n  // We keep track of the AST so we can use it in the inspector.\n  normalized: AST;\n  name: string | undefined;\n  args: readonly ReadonlyJSONValue[] | undefined;\n  count: number;\n  gotCallbacks: GotCallback[];\n  ttl: TTL;\n};\n\ntype ClientMetric = {\n  [K in keyof ClientMetricMap]: TDigest;\n};\n\n/**\n * Tracks what queries the client is currently subscribed to on the server.\n * Sends `changeDesiredQueries` message to server when this changes.\n * Deduplicates requests so that we only listen to a given unique query once.\n */\nexport class QueryManager implements InspectorDelegate {\n  readonly #clientID: ClientID;\n  readonly #clientToServer: NameMapper;\n  readonly #serverToClient: NameMapper;\n  readonly #send: (change: ChangeDesiredQueriesMessage) => void;\n  readonly #onFatalError: (error: ZeroError) => void;\n  readonly #queries: Map<QueryHash, Entry> = new Map();\n  readonly #recentQueriesMaxSize: number;\n  readonly #recentQueries: Set<string> = new Set();\n  readonly #gotQueries: Set<string> = new Set();\n  readonly #mutationTracker: MutationTracker;\n  readonly #pendingQueryChanges: UpQueriesPatchOp[] = [];\n  readonly #queryChangeThrottleMs: number;\n  #pendingRemovals: Array<() => void> = [];\n  #batchTimer: ReturnType<typeof setTimeout> | undefined;\n  readonly #lc: LogContext;\n  readonly #metrics: ClientMetric = newMetrics();\n  readonly #queryMetrics: Map<string, ClientMetric> = new Map();\n  readonly #slowMaterializeThreshold: number;\n  #closedError: ZeroError | undefined;\n\n  constructor(\n    lc: LogContext,\n    mutationTracker: MutationTracker,\n    clientID: ClientID,\n    tables: Record<string, TableSchema>,\n    send: (change: ChangeDesiredQueriesMessage) => void,\n    experimentalWatch: ReplicacheImpl['experimentalWatch'],\n    recentQueriesMaxSize: number,\n    queryChangeThrottleMs: number,\n    slowMaterializeThreshold: number,\n    onFatalError: (error: ZeroError) => void,\n  ) {\n    this.#lc = lc.withContext('QueryManager');\n    this.#clientID = clientID;\n    this.#clientToServer = clientToServer(tables);\n    this.#serverToClient = serverToClient(tables);\n    this.#recentQueriesMaxSize = recentQueriesMaxSize;\n    this.#send = send;\n    this.#mutationTracker = mutationTracker;\n    this.#queryChangeThrottleMs = queryChangeThrottleMs;\n    this.#slowMaterializeThreshold = slowMaterializeThreshold;\n    this.#onFatalError = onFatalError;\n    this.#mutationTracker.onAllMutationsApplied(() => {\n      if (this.#pendingRemovals.length === 0) {\n        return;\n      }\n      const pendingRemovals = this.#pendingRemovals;\n      this.#pendingRemovals = [];\n      for (const removal of pendingRemovals) {\n        removal();\n      }\n    });\n\n    experimentalWatch(\n      diff => {\n        for (const diffOp of diff) {\n          const queryHash = diffOp.key.substring(GOT_QUERIES_KEY_PREFIX.length);\n          switch (diffOp.op) {\n            case 'add':\n              this.#gotQueries.add(queryHash);\n              this.#fireGotCallbacks(queryHash, true);\n              break;\n            case 'del':\n              this.#gotQueries.delete(queryHash);\n              this.#fireGotCallbacks(queryHash, false);\n              break;\n          }\n        }\n      },\n      {\n        prefix: GOT_QUERIES_KEY_PREFIX,\n        initialValuesInFirstDiff: true,\n      },\n    );\n  }\n\n  getAST(queryID: string): AST | undefined {\n    const ast = this.#queries.get(queryID)?.normalized;\n    return ast && mapAST(ast, this.#serverToClient);\n  }\n\n  mapClientASTToServer(ast: AST): AST {\n    return mapAST(ast, this.#clientToServer);\n  }\n\n  #fireGotCallbacks(queryHash: string, got: boolean) {\n    const gotCallbacks = this.#queries.get(queryHash)?.gotCallbacks ?? [];\n    for (const gotCallback of gotCallbacks) {\n      gotCallback(got);\n    }\n  }\n\n  /**\n   * Get the queries that need to be registered with the server.\n   *\n   * An optional `lastPatch` can be provided. This is the last patch that was\n   * sent to the server and may not yet have been acked. If `lastPatch` is provided,\n   * this method will return a patch that does not include any events sent in `lastPatch`.\n   *\n   * This diffing of last patch and current patch is needed since we send\n   * a set of queries to the server when we first connect inside of the `sec-protocol` as\n   * the `initConnectionMessage`.\n   *\n   * While we're waiting for the `connected` response to come back from the server,\n   * the client may have registered more queries. We need to diff the `initConnectionMessage`\n   * queries with the current set of queries to understand what those were.\n   */\n  async getQueriesPatch(\n    tx: ReadTransaction,\n    lastPatch?: Map<string, UpQueriesPatchOp>,\n  ): Promise<Map<string, UpQueriesPatchOp>> {\n    const existingQueryHashes = new Set<string>();\n    const prefix = desiredQueriesPrefixForClient(this.#clientID);\n    for await (const key of tx.scan({prefix}).keys()) {\n      existingQueryHashes.add(key.substring(prefix.length, key.length));\n    }\n    const patch: Map<string, UpQueriesPatchOp> = new Map();\n    for (const hash of existingQueryHashes) {\n      if (!this.#queries.has(hash)) {\n        patch.set(hash, {op: 'del', hash});\n      }\n    }\n\n    for (const [hash, {normalized, ttl, name, args}] of this.#queries) {\n      if (!existingQueryHashes.has(hash)) {\n        patch.set(hash, {\n          op: 'put',\n          hash,\n          ast: name === undefined ? normalized : undefined,\n          name,\n          args,\n          // We get TTL out of the DagStore so it is possible that the TTL was written\n          // with a too high TTL.\n          ttl: clampTTL(ttl), // no lc here since no need to log here\n        });\n      }\n    }\n\n    if (lastPatch) {\n      // if there are any `puts` in `lastPatch` that are not in `patch` then we need to\n      // send a `del` event in `patch`.\n      for (const [hash, {op}] of lastPatch) {\n        if (op === 'put' && !patch.has(hash)) {\n          patch.set(hash, {op: 'del', hash});\n        }\n      }\n      // Remove everything from `patch` that was already sent in `lastPatch`.\n      for (const [hash, {op}] of patch) {\n        const lastPatchOp = lastPatch.get(hash);\n        if (lastPatchOp && lastPatchOp.op === op) {\n          patch.delete(hash);\n        }\n      }\n    }\n\n    return patch;\n  }\n\n  handleTransformErrors(errors: ErroredQuery[]) {\n    for (const error of errors) {\n      const queryId = error.id;\n      const entry = this.#queries.get(queryId);\n\n      // if we don't have the query registered, continue\n      if (!entry) {\n        continue;\n      }\n\n      if (error.error === 'app' || error.error === 'parse') {\n        entry.gotCallbacks.forEach(callback => callback(false, error));\n      }\n      // this code path is not possible technically since errors were never implemented in the legacy query transform error\n      // but is included for backwards compatibility and we have a test case for it\n      else {\n        this.#onFatalError(\n          new ProtocolError({\n            kind: ErrorKind.TransformFailed,\n            origin: ErrorOrigin.ZeroCache,\n            reason: ErrorReason.Internal,\n            message: `Unknown error transforming queries: ${JSON.stringify(error)}`,\n            queryIDs: [],\n          }),\n        );\n        // unreachable(error); TODO(0xcadams): this should eventually be unreachable\n      }\n    }\n  }\n\n  handleClosed(\n    reason: ClientError<{kind: ClientErrorKind.ClientClosed; message: string}>,\n  ) {\n    if (this.#closedError) {\n      return;\n    }\n    this.#closedError = reason;\n    for (const [queryId, entry] of this.#queries) {\n      const erroredQuery: ErroredQuery = {\n        error: 'app',\n        id: queryId,\n        name: entry.name ?? 'legacy',\n        message: reason.message,\n        details: {kind: reason.kind},\n      };\n      for (const gotCallback of entry.gotCallbacks) {\n        gotCallback(false, erroredQuery);\n      }\n    }\n  }\n\n  addCustom(\n    ast: AST,\n    {name, args}: CustomQueryID,\n    ttl: TTL,\n    gotCallback?: GotCallback,\n  ): () => void {\n    const normalized = normalizeAST(ast);\n    const queryId = hashOfNameAndArgs(name, args);\n    return this.#add(queryId, normalized, name, args, ttl, gotCallback);\n  }\n\n  addLegacy(ast: AST, ttl: TTL, gotCallback?: GotCallback): () => void {\n    const normalized = normalizeAST(ast);\n    const astHash = hashOfAST(normalized);\n    return this.#add(\n      astHash,\n      normalized,\n      undefined, // name is undefined for legacy queries\n      undefined, // args are undefined for legacy queries\n      ttl,\n      gotCallback,\n    );\n  }\n\n  #add(\n    queryId: string,\n    normalized: AST,\n    name: string | undefined,\n    args: readonly ReadonlyJSONValue[] | undefined,\n    ttl: TTL,\n    gotCallback?: GotCallback,\n  ) {\n    assert(\n      (name === undefined) === (args === undefined),\n      'If name is defined, args must be defined',\n    );\n    ttl = clampTTL(ttl, this.#lc);\n    let entry = this.#queries.get(queryId);\n    this.#recentQueries.delete(queryId);\n    if (!entry) {\n      normalized = mapAST(normalized, this.#clientToServer);\n\n      entry = {\n        normalized,\n        name,\n        args,\n        count: 1,\n        gotCallbacks: gotCallback ? [gotCallback] : [],\n        ttl,\n      };\n      this.#queries.set(queryId, entry);\n      this.#queueQueryChange({\n        op: 'put',\n        hash: queryId,\n        ast: name === undefined ? normalized : undefined,\n        name,\n        args,\n        ttl,\n      });\n    } else {\n      ++entry.count;\n      this.#updateEntry(entry, queryId, ttl);\n\n      if (gotCallback) {\n        entry.gotCallbacks.push(gotCallback);\n      }\n    }\n\n    if (gotCallback) {\n      gotCallback(this.#gotQueries.has(queryId));\n    }\n\n    let removed = false;\n    const cleanupCb = () => {\n      if (removed) {\n        return;\n      }\n      removed = true;\n\n      // We cannot remove queries while mutations are pending\n      // as that could take data out of scope that is needed in a rebase\n      if (this.#mutationTracker.size > 0) {\n        this.#pendingRemovals.push(() =>\n          this.#remove(entry, queryId, gotCallback),\n        );\n        return;\n      }\n\n      this.#remove(entry, queryId, gotCallback);\n    };\n    return cleanupCb;\n  }\n\n  updateCustom({name, args}: CustomQueryID, ttl: TTL) {\n    const queryID = hashOfNameAndArgs(name, args);\n    const entry = must(this.#queries.get(queryID));\n    this.#updateEntry(entry, queryID, ttl);\n  }\n\n  updateLegacy(ast: AST, ttl: TTL) {\n    const normalized = normalizeAST(ast);\n    const queryID = hashOfAST(normalized);\n    const entry = must(this.#queries.get(queryID));\n    this.#updateEntry(entry, queryID, ttl);\n  }\n\n  #updateEntry(entry: Entry, queryID: string, ttl: TTL): void {\n    // If the query already exists and the new ttl is larger than the old one\n    // we send a changeDesiredQueries message to the server to update the ttl.\n    ttl = clampTTL(ttl, this.#lc);\n    if (compareTTL(ttl, entry.ttl) > 0) {\n      entry.ttl = ttl;\n      this.#queueQueryChange({\n        op: 'put',\n        hash: queryID,\n        ast: entry.name === undefined ? entry.normalized : undefined,\n        name: entry.name,\n        args: entry.args,\n        ttl,\n      });\n    }\n  }\n\n  #queueQueryChange(op: UpQueriesPatchOp) {\n    this.#pendingQueryChanges.push(op);\n    this.#scheduleBatch();\n  }\n\n  #scheduleBatch() {\n    if (this.#batchTimer === undefined) {\n      this.#batchTimer = setTimeout(\n        () => this.flushBatch(),\n        this.#queryChangeThrottleMs,\n      );\n    }\n  }\n\n  flushBatch() {\n    if (this.#batchTimer !== undefined) {\n      clearTimeout(this.#batchTimer);\n      this.#batchTimer = undefined;\n    }\n    if (this.#pendingQueryChanges.length > 0) {\n      this.#send([\n        'changeDesiredQueries',\n        {\n          desiredQueriesPatch: [...this.#pendingQueryChanges],\n        },\n      ]);\n      this.#pendingQueryChanges.length = 0;\n    }\n  }\n\n  #remove(entry: Entry, astHash: string, gotCallback: GotCallback | undefined) {\n    if (gotCallback) {\n      const index = entry.gotCallbacks.indexOf(gotCallback);\n      entry.gotCallbacks.splice(index, 1);\n    }\n    --entry.count;\n    if (entry.count === 0) {\n      this.#recentQueries.add(astHash);\n      if (this.#recentQueries.size > this.#recentQueriesMaxSize) {\n        const lruQueryID = this.#recentQueries.values().next().value;\n        assert(lruQueryID);\n        this.#queries.delete(lruQueryID);\n        this.#recentQueries.delete(lruQueryID);\n        this.#queryMetrics.delete(lruQueryID);\n        this.#queueQueryChange({op: 'del', hash: lruQueryID});\n      }\n    }\n  }\n\n  /**\n   * Gets the aggregated metrics for all queries managed by this QueryManager.\n   */\n  get metrics(): ClientMetric {\n    return this.#metrics;\n  }\n\n  addMetric<K extends keyof ClientMetricMap>(\n    metric: K,\n    value: number,\n    ...args: ClientMetricMap[K]\n  ): void {\n    // Only query metrics are tracked at this point.\n    // If this check fails then we need to add a runtime check.\n    metric satisfies `query-${string}`;\n\n    // We track all materializations of queries as well as per\n    // query materializations.\n    this.#metrics[metric].add(value);\n\n    const queryID = args[0];\n\n    // Handle slow query logging for end-to-end materialization\n    if (metric === 'query-materialization-end-to-end') {\n      const ast = args[1];\n\n      if (\n        this.#slowMaterializeThreshold !== undefined &&\n        value > this.#slowMaterializeThreshold\n      ) {\n        this.#lc.warn?.(\n          'Slow query materialization (including server/network)',\n          queryID,\n          ast,\n          value,\n        );\n      } else {\n        this.#lc.debug?.(\n          'Materialized query (including server/network)',\n          queryID,\n          ast,\n          value,\n        );\n      }\n    }\n\n    // The query manager manages metrics that are per query.\n    let existing = this.#queryMetrics.get(queryID);\n    if (!existing) {\n      existing = newMetrics();\n      this.#queryMetrics.set(queryID, existing);\n    }\n    existing[metric].add(value);\n  }\n\n  getQueryMetrics(queryID: string): ClientMetric | undefined {\n    return this.#queryMetrics.get(queryID);\n  }\n}\n\nfunction newMetrics(): ClientMetric {\n  return {\n    'query-materialization-client': new TDigest(),\n    'query-materialization-end-to-end': new TDigest(),\n    'query-update-client': new TDigest(),\n  };\n}\n"],"names":["ErrorKind.TransformFailed","ErrorOrigin.ZeroCache","ErrorReason.Internal"],"mappings":";;;;;;;;;;;;;AA8DO,MAAM,aAA0C;AAAA,EAC5C;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA,+BAAsC,IAAA;AAAA,EACtC;AAAA,EACA,qCAAkC,IAAA;AAAA,EAClC,kCAA+B,IAAA;AAAA,EAC/B;AAAA,EACA,uBAA2C,CAAA;AAAA,EAC3C;AAAA,EACT,mBAAsC,CAAA;AAAA,EACtC;AAAA,EACS;AAAA,EACA,WAAyB,WAAA;AAAA,EACzB,oCAA+C,IAAA;AAAA,EAC/C;AAAA,EACT;AAAA,EAEA,YACE,IACA,iBACA,UACA,QACA,MACA,mBACA,sBACA,uBACA,0BACA,cACA;AACA,SAAK,MAAM,GAAG,YAAY,cAAc;AACxC,SAAK,YAAY;AACjB,SAAK,kBAAkB,eAAe,MAAM;AAC5C,SAAK,kBAAkB,eAAe,MAAM;AAC5C,SAAK,wBAAwB;AAC7B,SAAK,QAAQ;AACb,SAAK,mBAAmB;AACxB,SAAK,yBAAyB;AAC9B,SAAK,4BAA4B;AACjC,SAAK,gBAAgB;AACrB,SAAK,iBAAiB,sBAAsB,MAAM;AAChD,UAAI,KAAK,iBAAiB,WAAW,GAAG;AACtC;AAAA,MACF;AACA,YAAM,kBAAkB,KAAK;AAC7B,WAAK,mBAAmB,CAAA;AACxB,iBAAW,WAAW,iBAAiB;AACrC,gBAAA;AAAA,MACF;AAAA,IACF,CAAC;AAED;AAAA,MACE,CAAA,SAAQ;AACN,mBAAW,UAAU,MAAM;AACzB,gBAAM,YAAY,OAAO,IAAI,UAAU,uBAAuB,MAAM;AACpE,kBAAQ,OAAO,IAAA;AAAA,YACb,KAAK;AACH,mBAAK,YAAY,IAAI,SAAS;AAC9B,mBAAK,kBAAkB,WAAW,IAAI;AACtC;AAAA,YACF,KAAK;AACH,mBAAK,YAAY,OAAO,SAAS;AACjC,mBAAK,kBAAkB,WAAW,KAAK;AACvC;AAAA,UAAA;AAAA,QAEN;AAAA,MACF;AAAA,MACA;AAAA,QACE,QAAQ;AAAA,QACR,0BAA0B;AAAA,MAAA;AAAA,IAC5B;AAAA,EAEJ;AAAA,EAEA,OAAO,SAAkC;AACvC,UAAM,MAAM,KAAK,SAAS,IAAI,OAAO,GAAG;AACxC,WAAO,OAAO,OAAO,KAAK,KAAK,eAAe;AAAA,EAChD;AAAA,EAEA,qBAAqB,KAAe;AAClC,WAAO,OAAO,KAAK,KAAK,eAAe;AAAA,EACzC;AAAA,EAEA,kBAAkB,WAAmB,KAAc;AACjD,UAAM,eAAe,KAAK,SAAS,IAAI,SAAS,GAAG,gBAAgB,CAAA;AACnE,eAAW,eAAe,cAAc;AACtC,kBAAY,GAAG;AAAA,IACjB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,MAAM,gBACJ,IACA,WACwC;AACxC,UAAM,0CAA0B,IAAA;AAChC,UAAM,SAAS,8BAA8B,KAAK,SAAS;AAC3D,qBAAiB,OAAO,GAAG,KAAK,EAAC,QAAO,EAAE,QAAQ;AAChD,0BAAoB,IAAI,IAAI,UAAU,OAAO,QAAQ,IAAI,MAAM,CAAC;AAAA,IAClE;AACA,UAAM,4BAA2C,IAAA;AACjD,eAAW,QAAQ,qBAAqB;AACtC,UAAI,CAAC,KAAK,SAAS,IAAI,IAAI,GAAG;AAC5B,cAAM,IAAI,MAAM,EAAC,IAAI,OAAO,MAAK;AAAA,MACnC;AAAA,IACF;AAEA,eAAW,CAAC,MAAM,EAAC,YAAY,KAAK,MAAM,KAAA,CAAK,KAAK,KAAK,UAAU;AACjE,UAAI,CAAC,oBAAoB,IAAI,IAAI,GAAG;AAClC,cAAM,IAAI,MAAM;AAAA,UACd,IAAI;AAAA,UACJ;AAAA,UACA,KAAK,SAAS,SAAY,aAAa;AAAA,UACvC;AAAA,UACA;AAAA;AAAA;AAAA,UAGA,KAAK,SAAS,GAAG;AAAA;AAAA,QAAA,CAClB;AAAA,MACH;AAAA,IACF;AAEA,QAAI,WAAW;AAGb,iBAAW,CAAC,MAAM,EAAC,GAAA,CAAG,KAAK,WAAW;AACpC,YAAI,OAAO,SAAS,CAAC,MAAM,IAAI,IAAI,GAAG;AACpC,gBAAM,IAAI,MAAM,EAAC,IAAI,OAAO,MAAK;AAAA,QACnC;AAAA,MACF;AAEA,iBAAW,CAAC,MAAM,EAAC,GAAA,CAAG,KAAK,OAAO;AAChC,cAAM,cAAc,UAAU,IAAI,IAAI;AACtC,YAAI,eAAe,YAAY,OAAO,IAAI;AACxC,gBAAM,OAAO,IAAI;AAAA,QACnB;AAAA,MACF;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AAAA,EAEA,sBAAsB,QAAwB;AAC5C,eAAW,SAAS,QAAQ;AAC1B,YAAM,UAAU,MAAM;AACtB,YAAM,QAAQ,KAAK,SAAS,IAAI,OAAO;AAGvC,UAAI,CAAC,OAAO;AACV;AAAA,MACF;AAEA,UAAI,MAAM,UAAU,SAAS,MAAM,UAAU,SAAS;AACpD,cAAM,aAAa,QAAQ,CAAA,aAAY,SAAS,OAAO,KAAK,CAAC;AAAA,MAC/D,OAGK;AACH,aAAK;AAAA,UACH,IAAI,cAAc;AAAA,YAChB,MAAMA;AAAAA,YACN,QAAQC;AAAAA,YACR,QAAQC;AAAAA,YACR,SAAS,uCAAuC,KAAK,UAAU,KAAK,CAAC;AAAA,YACrE,UAAU,CAAA;AAAA,UAAC,CACZ;AAAA,QAAA;AAAA,MAGL;AAAA,IACF;AAAA,EACF;AAAA,EAEA,aACE,QACA;AACA,QAAI,KAAK,cAAc;AACrB;AAAA,IACF;AACA,SAAK,eAAe;AACpB,eAAW,CAAC,SAAS,KAAK,KAAK,KAAK,UAAU;AAC5C,YAAM,eAA6B;AAAA,QACjC,OAAO;AAAA,QACP,IAAI;AAAA,QACJ,MAAM,MAAM,QAAQ;AAAA,QACpB,SAAS,OAAO;AAAA,QAChB,SAAS,EAAC,MAAM,OAAO,KAAA;AAAA,MAAI;AAE7B,iBAAW,eAAe,MAAM,cAAc;AAC5C,oBAAY,OAAO,YAAY;AAAA,MACjC;AAAA,IACF;AAAA,EACF;AAAA,EAEA,UACE,KACA,EAAC,MAAM,KAAA,GACP,KACA,aACY;AACZ,UAAM,aAAa,aAAa,GAAG;AACnC,UAAM,UAAU,kBAAkB,MAAM,IAAI;AAC5C,WAAO,KAAK,KAAK,SAAS,YAAY,MAAM,MAAM,KAAK,WAAW;AAAA,EACpE;AAAA,EAEA,UAAU,KAAU,KAAU,aAAuC;AACnE,UAAM,aAAa,aAAa,GAAG;AACnC,UAAM,UAAU,UAAU,UAAU;AACpC,WAAO,KAAK;AAAA,MACV;AAAA,MACA;AAAA,MACA;AAAA;AAAA,MACA;AAAA;AAAA,MACA;AAAA,MACA;AAAA,IAAA;AAAA,EAEJ;AAAA,EAEA,KACE,SACA,YACA,MACA,MACA,KACA,aACA;AACA;AAAA,MACG,SAAS,YAAgB,SAAS;AAAA,MACnC;AAAA,IAAA;AAEF,UAAM,SAAS,KAAK,KAAK,GAAG;AAC5B,QAAI,QAAQ,KAAK,SAAS,IAAI,OAAO;AACrC,SAAK,eAAe,OAAO,OAAO;AAClC,QAAI,CAAC,OAAO;AACV,mBAAa,OAAO,YAAY,KAAK,eAAe;AAEpD,cAAQ;AAAA,QACN;AAAA,QACA;AAAA,QACA;AAAA,QACA,OAAO;AAAA,QACP,cAAc,cAAc,CAAC,WAAW,IAAI,CAAA;AAAA,QAC5C;AAAA,MAAA;AAEF,WAAK,SAAS,IAAI,SAAS,KAAK;AAChC,WAAK,kBAAkB;AAAA,QACrB,IAAI;AAAA,QACJ,MAAM;AAAA,QACN,KAAK,SAAS,SAAY,aAAa;AAAA,QACvC;AAAA,QACA;AAAA,QACA;AAAA,MAAA,CACD;AAAA,IACH,OAAO;AACL,QAAE,MAAM;AACR,WAAK,aAAa,OAAO,SAAS,GAAG;AAErC,UAAI,aAAa;AACf,cAAM,aAAa,KAAK,WAAW;AAAA,MACrC;AAAA,IACF;AAEA,QAAI,aAAa;AACf,kBAAY,KAAK,YAAY,IAAI,OAAO,CAAC;AAAA,IAC3C;AAEA,QAAI,UAAU;AACd,UAAM,YAAY,MAAM;AACtB,UAAI,SAAS;AACX;AAAA,MACF;AACA,gBAAU;AAIV,UAAI,KAAK,iBAAiB,OAAO,GAAG;AAClC,aAAK,iBAAiB;AAAA,UAAK,MACzB,KAAK,QAAQ,OAAO,SAAS,WAAW;AAAA,QAAA;AAE1C;AAAA,MACF;AAEA,WAAK,QAAQ,OAAO,SAAS,WAAW;AAAA,IAC1C;AACA,WAAO;AAAA,EACT;AAAA,EAEA,aAAa,EAAC,MAAM,KAAA,GAAsB,KAAU;AAClD,UAAM,UAAU,kBAAkB,MAAM,IAAI;AAC5C,UAAM,QAAQ,KAAK,KAAK,SAAS,IAAI,OAAO,CAAC;AAC7C,SAAK,aAAa,OAAO,SAAS,GAAG;AAAA,EACvC;AAAA,EAEA,aAAa,KAAU,KAAU;AAC/B,UAAM,aAAa,aAAa,GAAG;AACnC,UAAM,UAAU,UAAU,UAAU;AACpC,UAAM,QAAQ,KAAK,KAAK,SAAS,IAAI,OAAO,CAAC;AAC7C,SAAK,aAAa,OAAO,SAAS,GAAG;AAAA,EACvC;AAAA,EAEA,aAAa,OAAc,SAAiB,KAAgB;AAG1D,UAAM,SAAS,KAAK,KAAK,GAAG;AAC5B,QAAI,WAAW,KAAK,MAAM,GAAG,IAAI,GAAG;AAClC,YAAM,MAAM;AACZ,WAAK,kBAAkB;AAAA,QACrB,IAAI;AAAA,QACJ,MAAM;AAAA,QACN,KAAK,MAAM,SAAS,SAAY,MAAM,aAAa;AAAA,QACnD,MAAM,MAAM;AAAA,QACZ,MAAM,MAAM;AAAA,QACZ;AAAA,MAAA,CACD;AAAA,IACH;AAAA,EACF;AAAA,EAEA,kBAAkB,IAAsB;AACtC,SAAK,qBAAqB,KAAK,EAAE;AACjC,SAAK,eAAA;AAAA,EACP;AAAA,EAEA,iBAAiB;AACf,QAAI,KAAK,gBAAgB,QAAW;AAClC,WAAK,cAAc;AAAA,QACjB,MAAM,KAAK,WAAA;AAAA,QACX,KAAK;AAAA,MAAA;AAAA,IAET;AAAA,EACF;AAAA,EAEA,aAAa;AACX,QAAI,KAAK,gBAAgB,QAAW;AAClC,mBAAa,KAAK,WAAW;AAC7B,WAAK,cAAc;AAAA,IACrB;AACA,QAAI,KAAK,qBAAqB,SAAS,GAAG;AACxC,WAAK,MAAM;AAAA,QACT;AAAA,QACA;AAAA,UACE,qBAAqB,CAAC,GAAG,KAAK,oBAAoB;AAAA,QAAA;AAAA,MACpD,CACD;AACD,WAAK,qBAAqB,SAAS;AAAA,IACrC;AAAA,EACF;AAAA,EAEA,QAAQ,OAAc,SAAiB,aAAsC;AAC3E,QAAI,aAAa;AACf,YAAM,QAAQ,MAAM,aAAa,QAAQ,WAAW;AACpD,YAAM,aAAa,OAAO,OAAO,CAAC;AAAA,IACpC;AACA,MAAE,MAAM;AACR,QAAI,MAAM,UAAU,GAAG;AACrB,WAAK,eAAe,IAAI,OAAO;AAC/B,UAAI,KAAK,eAAe,OAAO,KAAK,uBAAuB;AACzD,cAAM,aAAa,KAAK,eAAe,OAAA,EAAS,OAAO;AACvD,eAAO,UAAU;AACjB,aAAK,SAAS,OAAO,UAAU;AAC/B,aAAK,eAAe,OAAO,UAAU;AACrC,aAAK,cAAc,OAAO,UAAU;AACpC,aAAK,kBAAkB,EAAC,IAAI,OAAO,MAAM,YAAW;AAAA,MACtD;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,UAAwB;AAC1B,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,UACE,QACA,UACG,MACG;AAON,SAAK,SAAS,MAAM,EAAE,IAAI,KAAK;AAE/B,UAAM,UAAU,KAAK,CAAC;AAGtB,QAAI,WAAW,oCAAoC;AACjD,YAAM,MAAM,KAAK,CAAC;AAElB,UACE,KAAK,8BAA8B,UACnC,QAAQ,KAAK,2BACb;AACA,aAAK,IAAI;AAAA,UACP;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,QAAA;AAAA,MAEJ,OAAO;AACL,aAAK,IAAI;AAAA,UACP;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,QAAA;AAAA,MAEJ;AAAA,IACF;AAGA,QAAI,WAAW,KAAK,cAAc,IAAI,OAAO;AAC7C,QAAI,CAAC,UAAU;AACb,iBAAW,WAAA;AACX,WAAK,cAAc,IAAI,SAAS,QAAQ;AAAA,IAC1C;AACA,aAAS,MAAM,EAAE,IAAI,KAAK;AAAA,EAC5B;AAAA,EAEA,gBAAgB,SAA2C;AACzD,WAAO,KAAK,cAAc,IAAI,OAAO;AAAA,EACvC;AACF;AAEA,SAAS,aAA2B;AAClC,SAAO;AAAA,IACL,gCAAgC,IAAI,QAAA;AAAA,IACpC,oCAAoC,IAAI,QAAA;AAAA,IACxC,uBAAuB,IAAI,QAAA;AAAA,EAAQ;AAEvC;"}

package/out/zero-client/src/client/reload-error-handler.d.ts

@@ -1,7 +1,7 @@
+import type { LogContext } from '@rocicorp/logger';
 import * as v from '../../../shared/src/valita.ts';
-import { ErrorKind } from '../../../zero-protocol/src/error-kind.ts';
+import type { ErrorKind } from '../../../zero-protocol/src/error-kind.ts';
 import type { UpdateNeededReasonType } from './update-needed-reason-type.ts';
-import type { ZeroLogContext } from './zero-log-context.ts';
 export declare const RELOAD_REASON_STORAGE_KEY = "_zeroReloadReason";
 export declare const RELOAD_BACKOFF_STATE_KEY = "_zeroReloadBackoffState";
 declare const backoffStateSchema: v.ObjectType<{
@@ -12,8 +12,8 @@ export type BackoffState = v.Infer<typeof backoffStateSchema>;
 export declare const MIN_RELOAD_INTERVAL_MS = 500;
 export declare const MAX_RELOAD_INTERVAL_MS = 60000;
 export declare const FALLBACK_RELOAD_INTERVAL_MS = 10000;
-export declare function reloadWithReason(lc: ZeroLogContext, reload: () => void, reason: UpdateNeededReasonType | ErrorKind, message: string): void;
-export declare function reportReloadReason(lc: ZeroLogContext): void;
+export declare function reloadWithReason(lc: LogContext, reload: () => void, reason: UpdateNeededReasonType | ErrorKind, message: string): void;
+export declare function reportReloadReason(lc: LogContext): void;
 /** If a reload is scheduled, do not attempt to reconnect. */
 export declare function reloadScheduled(): boolean;
 /** Call upon a successful connection, indicating that backoff should be reset. */