@rocicorp/zero 0.0.0-202410031711

package/out/zero-cache/src/config/zero-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"zero-config.d.ts","sourceRoot":"","sources":["../../../../../zero-cache/src/config/zero-config.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,OAAO,KAAK,CAAC,MAAM,sBAAsB,CAAC;AAG1C,MAAM,MAAM,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAE/D,QAAA,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;0BAA2C,CAAC;AAC5D,MAAM,MAAM,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AAC9C,QAAA,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;2BAAsB,CAAC;AACzC,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAElD,QAAA,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aAKf,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AAE7D,QAAA,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAO9B,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E,QAAA,MAAM,YAAY;;;aAGhB,CAAC;AACH,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAOlD;;GAEG;AACH,QAAA,MAAM,iBAAiB;IACrB;;;;;;;;;OASG;;;;;IAGH;;;;;;;;;;;;;;;;;OAiBG;;;;;aAEH,CAAC;AACH,KAAK,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAEzD,QAAA,MAAM,eAAe;;;;;;;;;;;;;aAOnB,CAAC;AACH,KAAK,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AASrD,QAAA,MAAM,qBAAqB;;;;;;;;;;;;aAQzB,CAAC;AACH,KAAK,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEjE,QAAA,MAAM,iCAAiC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aAgBrC,CAAC;AAEH,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,iCAAiC,CACzC,CAAC;AAEF,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aAE3B,CAAC;AAEH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAI9D,wBAAgB,aAAa,IAAI,OAAO,CAAC,UAAU,CAAC,CAgBnD;AAED,qBAAa,UAAU;;gBAMT,MAAM,EAAE,cAAc;IASlC,IAAI,WAAW,WAEd;IAED,IAAI,QAAQ,WAEX;IAED,IAAI,WAAW,WAEd;IAED,IAAI,MAAM,uBAET;IAED,IAAI,aAAa,WAEhB;IAED,IAAI,eAAe,uBAElB;IAED,IAAI,cAAc,uBAEjB;IAED,IAAI,iBAAiB,uBAEpB;IAED,IAAI,UAAU,wBAEb;IAED,IAAI,SAAS,uBAEZ;IAED,IAAI,KAAK,gBAER;IAED,IAAI,GAAG,cAEN;IAED,IAAI,SAAS,gCAEZ;IAED,IAAI,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAEhB;CACF;AAED,qBAAa,eAAe;;gBAEd,MAAM,EAAE,mBAAmB;IAMvC,IAAI,oBAAoB,8BAEvB;CACF;AAED,qBAAa,yBAAyB;;gBAExB,MAAM,EAAE,mBAAmB,CAAC,sBAAsB,CAAC;IAI/D,IAAI,QAAQ,WAEX;IAED,IAAI,GAAG,WAEN;CACF;AAED,qBAAa,SAAS;;gBAER,MAAM,EAAE,aAAa;IAIjC,IAAI,KAAK,+BAER;IAED,IAAI,iBAAiB,uBAEpB;IAED,IAAI,mBAAmB,uBAEtB;CACF;AAID,qBAAa,WAAW;IACtB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,YAAY,EAAE,SAAS,MAAM,EAAE,CAAC;gBAE7B,MAAM,EAAE,eAAe,GAAG,SAAS;CAKhD"}

package/out/zero-cache/src/config/zero-config.js

@@ -0,0 +1,227 @@
+/**
+ * These types represent the _compiled_ config whereas `define-config` types represent the _source_ config.
+ */
+import fs from 'node:fs/promises';
+import { must } from '../../../shared/src/must.js';
+import * as v from '../../../shared/src/valita.js';
+import { astSchema } from '../../../zero-protocol/src/mod.js';
+const ruleSchema = v.tuple([v.literal('allow'), astSchema]);
+const policySchema = v.array(ruleSchema);
+const assetSchema = v.object({
+    select: policySchema.optional(),
+    insert: policySchema.optional(),
+    update: policySchema.optional(),
+    delete: policySchema.optional(),
+});
+const authorizationConfigSchema = v.record(v.object({
+    table: assetSchema.optional(),
+    column: v.record(assetSchema).optional(),
+    row: assetSchema.optional(),
+    cell: v.record(assetSchema).optional(),
+}));
+const envRefSchema = v.object({
+    tag: v.literal('env'),
+    name: v.string(),
+});
+const stringLiteral = v.string();
+const numberLiteral = v.number();
+const booleanLiteral = v.boolean();
+const configStringValueSchema = v.union(envRefSchema, stringLiteral);
+/**
+ * Configures the view of the upstream database replicated to this zero-cache.
+ */
+const shardConfigSchema = v.object({
+    /**
+     * Unique identifier for the zero-cache shard. This is used to partition
+     * shardable tables such as `zero.clients`, as well as reserve a name for
+     * the replication slot.
+     *
+     * The shard `id` value is written to the `shardID` column when updating
+     * the `lastMutationID` for clients in the `zero.clients` table.
+     *
+     * Defaults to "0".
+     */
+    id: configStringValueSchema,
+    /**
+     * Optional (comma-separated) list of of Postgres `PUBLICATION`s that the
+     * shard subscribes to. All publication names must begin with the prefix
+     * `"zero_"`, and all tables must be in the `"public"` Postgres schema.
+     *
+     * If unspecified, zero will create and use a `"zero_public"` publication that
+     * publishes all tables in the `"public"` schema.
+     *
+     * ```sql
+     * CREATE PUBLICATION zero_public FOR TABLES IN SCHEMA public;
+     * ```
+     *
+     * Note that once a shard has begun syncing data, this list of publications
+     * cannot be changed, and zero-cache will refuse to start if a specified
+     * value differs from what it originally synced.
+     *
+     * To use a different set of publications, a new shard should be created.
+     */
+    publications: configStringValueSchema,
+});
+const logConfigSchema = v.object({
+    level: v.union(envRefSchema, v.union(v.literal('debug'), v.literal('info'), v.literal('error'))),
+    datadogLogsApiKey: configStringValueSchema.optional(),
+    datadogServiceLabel: configStringValueSchema.optional(),
+});
+const configValueSchema = v.union(configStringValueSchema, booleanLiteral, numberLiteral);
+const rateLimitConfigSchema = v.object({
+    // Limits to `max` transactions per `windowMs` milliseconds.
+    // This uses a sliding window algorithm to track number of transactions in the current window.
+    mutationTransactions: v.object({
+        algorithm: v.literal('sliding-window'),
+        windowMs: v.union(envRefSchema, numberLiteral),
+        max: v.union(envRefSchema, numberLiteral),
+    }),
+});
+const zeroConfigSchemaSansAuthorization = v.object({
+    upstreamUri: configStringValueSchema,
+    cvrDbUri: configStringValueSchema,
+    changeDbUri: configStringValueSchema,
+    taskId: configStringValueSchema.optional(),
+    replicaDbFile: configStringValueSchema,
+    storageDbTmpDir: configStringValueSchema.optional(),
+    numSyncWorkers: v.union(envRefSchema, numberLiteral).optional(),
+    changeStreamerUri: configStringValueSchema.optional(),
+    litestream: v.union(envRefSchema, booleanLiteral).optional(),
+    jwtSecret: configStringValueSchema.optional(),
+    log: logConfigSchema,
+    shard: shardConfigSchema.optional(),
+    rateLimit: rateLimitConfigSchema.optional(),
+});
+export const zeroConfigSchema = zeroConfigSchemaSansAuthorization.extend({
+    authorization: authorizationConfigSchema.optional(),
+});
+let loadedConfig;
+export function getZeroConfig() {
+    if (loadedConfig) {
+        return loadedConfig;
+    }
+    const zeroConfigPath = process.env['ZERO_CONFIG_PATH'];
+    if (!zeroConfigPath) {
+        // TODO: Use a specific error type and report it to the user in a nicer way.
+        return Promise.reject(new Error('ZERO_CONFIG_PATH is not set'));
+    }
+    loadedConfig = fs
+        .readFile(zeroConfigPath, 'utf-8')
+        .then(rawContent => new ZeroConfig(v.parse(JSON.parse(rawContent), zeroConfigSchema)));
+    return loadedConfig;
+}
+export class ZeroConfig {
+    #config;
+    #log;
+    #shard;
+    #rateLimit;
+    constructor(config) {
+        this.#config = config;
+        this.#log = new LogConfig(config.log);
+        this.#shard = new ShardConfig(config.shard);
+        if (config.rateLimit) {
+            this.#rateLimit = new RateLimitConfig(config.rateLimit);
+        }
+    }
+    get upstreamUri() {
+        return mustResolveValue(this.#config.upstreamUri);
+    }
+    get cvrDbUri() {
+        return mustResolveValue(this.#config.cvrDbUri);
+    }
+    get changeDbUri() {
+        return mustResolveValue(this.#config.changeDbUri);
+    }
+    get taskId() {
+        return resolveValue(this.#config.taskId);
+    }
+    get replicaDbFile() {
+        return mustResolveValue(this.#config.replicaDbFile);
+    }
+    get storageDbTmpDir() {
+        return resolveValue(this.#config.storageDbTmpDir);
+    }
+    get numSyncWorkers() {
+        return resolveValue(this.#config.numSyncWorkers);
+    }
+    get changeStreamerUri() {
+        return resolveValue(this.#config.changeStreamerUri);
+    }
+    get litestream() {
+        return resolveValue(this.#config.litestream);
+    }
+    get jwtSecret() {
+        return resolveValue(this.#config.jwtSecret);
+    }
+    get shard() {
+        return this.#shard;
+    }
+    get log() {
+        return this.#log;
+    }
+    get rateLimit() {
+        return this.#rateLimit;
+    }
+    get authorization() {
+        return this.#config.authorization;
+    }
+}
+export class RateLimitConfig {
+    #mutationTransactions;
+    constructor(config) {
+        this.#mutationTransactions = new MutationTransactionLimits(config.mutationTransactions);
+    }
+    get mutationTransactions() {
+        return this.#mutationTransactions;
+    }
+}
+export class MutationTransactionLimits {
+    #config;
+    constructor(config) {
+        this.#config = config;
+    }
+    get windowMs() {
+        return mustResolveValue(this.#config.windowMs);
+    }
+    get max() {
+        return mustResolveValue(this.#config.max);
+    }
+}
+export class LogConfig {
+    #config;
+    constructor(config) {
+        this.#config = config;
+    }
+    get level() {
+        return mustResolveValue(this.#config.level);
+    }
+    get datadogLogsApiKey() {
+        return resolveValue(this.#config.datadogLogsApiKey);
+    }
+    get datadogServiceLabel() {
+        return resolveValue(this.#config.datadogServiceLabel);
+    }
+}
+const DEFAULT_SHARD_ID = '0';
+export class ShardConfig {
+    id;
+    publications;
+    constructor(config) {
+        this.id = resolveValue(config?.id) ?? DEFAULT_SHARD_ID;
+        const p = resolveValue(config?.publications);
+        this.publications = p ? p.split(',') : [];
+    }
+}
+function resolveValue(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (typeof value === 'object' && value.tag === 'env') {
+        return process.env[value.name];
+    }
+    return value;
+}
+function mustResolveValue(value) {
+    return must(resolveValue(value));
+}
+//# sourceMappingURL=zero-config.js.map

package/out/zero-cache/src/config/zero-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"zero-config.js","sourceRoot":"","sources":["../../../../../zero-cache/src/config/zero-config.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClC,OAAO,EAAC,IAAI,EAAC,MAAM,oBAAoB,CAAC;AACxC,OAAO,KAAK,CAAC,MAAM,sBAAsB,CAAC;AAC1C,OAAO,EAAC,SAAS,EAAC,MAAM,eAAe,CAAC;AAIxC,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC;AAE5D,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;AAGzC,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3B,MAAM,EAAE,YAAY,CAAC,QAAQ,EAAE;IAC/B,MAAM,EAAE,YAAY,CAAC,QAAQ,EAAE;IAC/B,MAAM,EAAE,YAAY,CAAC,QAAQ,EAAE;IAC/B,MAAM,EAAE,YAAY,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC;AAIH,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CACxC,CAAC,CAAC,MAAM,CAAC;IACP,KAAK,EAAE,WAAW,CAAC,QAAQ,EAAE;IAC7B,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,QAAQ,EAAE;IACxC,GAAG,EAAE,WAAW,CAAC,QAAQ,EAAE;IAC3B,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,QAAQ,EAAE;CACvC,CAAC,CACH,CAAC;AAIF,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5B,GAAG,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;IACrB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;CACjB,CAAC,CAAC;AAEH,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;AACjC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;AACjC,MAAM,cAAc,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC;AAEnC,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC;AAErE;;GAEG;AACH,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACjC;;;;;;;;;OASG;IACH,EAAE,EAAE,uBAAuB;IAE3B;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,EAAE,uBAAuB;CACtC,CAAC,CAAC;AAGH,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/B,KAAK,EAAE,CAAC,CAAC,KAAK,CACZ,YAAY,EACZ,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CACnE;IACD,iBAAiB,EAAE,uBAAuB,CAAC,QAAQ,EAAE;IACrD,mBAAmB,EAAE,uBAAuB,CAAC,QAAQ,EAAE;CACxD,CAAC,CAAC;AAGH,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAC/B,uBAAuB,EACvB,cAAc,EACd,aAAa,CACd,CAAC;AAGF,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,4DAA4D;IAC5D,8FAA8F;IAC9F,oBAAoB,EAAE,CAAC,CAAC,MAAM,CAAC;QAC7B,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC;QACtC,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,YAAY,EAAE,aAAa,CAAC;QAC9C,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,YAAY,EAAE,aAAa,CAAC;KAC1C,CAAC;CACH,CAAC,CAAC;AAGH,MAAM,iCAAiC,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,WAAW,EAAE,uBAAuB;IACpC,QAAQ,EAAE,uBAAuB;IACjC,WAAW,EAAE,uBAAuB;IACpC,MAAM,EAAE,uBAAuB,CAAC,QAAQ,EAAE;IAC1C,aAAa,EAAE,uBAAuB;IACtC,eAAe,EAAE,uBAAuB,CAAC,QAAQ,EAAE;IACnD,cAAc,EAAE,CAAC,CAAC,KAAK,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC,QAAQ,EAAE;IAC/D,iBAAiB,EAAE,uBAAuB,CAAC,QAAQ,EAAE;IACrD,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC,QAAQ,EAAE;IAC5D,SAAS,EAAE,uBAAuB,CAAC,QAAQ,EAAE;IAE7C,GAAG,EAAE,eAAe;IAEpB,KAAK,EAAE,iBAAiB,CAAC,QAAQ,EAAE;IACnC,SAAS,EAAE,qBAAqB,CAAC,QAAQ,EAAE;CAC5C,CAAC,CAAC;AAMH,MAAM,CAAC,MAAM,gBAAgB,GAAG,iCAAiC,CAAC,MAAM,CAAC;IACvE,aAAa,EAAE,yBAAyB,CAAC,QAAQ,EAAE;CACpD,CAAC,CAAC;AAIH,IAAI,YAA6C,CAAC;AAElD,MAAM,UAAU,aAAa;IAC3B,IAAI,YAAY,EAAE,CAAC;QACjB,OAAO,YAAY,CAAC;IACtB,CAAC;IACD,MAAM,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IACvD,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,4EAA4E;QAC5E,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC,CAAC;IAClE,CAAC;IACD,YAAY,GAAG,EAAE;SACd,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC;SACjC,IAAI,CACH,UAAU,CAAC,EAAE,CACX,IAAI,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,gBAAgB,CAAC,CAAC,CACpE,CAAC;IACJ,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,MAAM,OAAO,UAAU;IACZ,OAAO,CAAiB;IACxB,IAAI,CAAY;IAChB,MAAM,CAAc;IACpB,UAAU,CAA8B;IAEjD,YAAY,MAAsB;QAChC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,IAAI,GAAG,IAAI,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,CAAC,MAAM,GAAG,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC5C,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;YACrB,IAAI,CAAC,UAAU,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;IAED,IAAI,WAAW;QACb,OAAO,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IACpD,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACjD,CAAC;IAED,IAAI,WAAW;QACb,OAAO,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IACpD,CAAC;IAED,IAAI,MAAM;QACR,OAAO,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAED,IAAI,aAAa;QACf,OAAO,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IACtD,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IACpD,CAAC;IAED,IAAI,cAAc;QAChB,OAAO,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,iBAAiB;QACnB,OAAO,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACtD,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC/C,CAAC;IAED,IAAI,SAAS;QACX,OAAO,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC9C,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,GAAG;QACL,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC;IACpC,CAAC;CACF;AAED,MAAM,OAAO,eAAe;IACjB,qBAAqB,CAA4B;IAC1D,YAAY,MAA2B;QACrC,IAAI,CAAC,qBAAqB,GAAG,IAAI,yBAAyB,CACxD,MAAM,CAAC,oBAAoB,CAC5B,CAAC;IACJ,CAAC;IAED,IAAI,oBAAoB;QACtB,OAAO,IAAI,CAAC,qBAAqB,CAAC;IACpC,CAAC;CACF;AAED,MAAM,OAAO,yBAAyB;IAC3B,OAAO,CAA8C;IAC9D,YAAY,MAAmD;QAC7D,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACjD,CAAC;IAED,IAAI,GAAG;QACL,OAAO,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC5C,CAAC;CACF;AAED,MAAM,OAAO,SAAS;IACX,OAAO,CAAgB;IAChC,YAAY,MAAqB;QAC/B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED,IAAI,KAAK;QACP,OAAO,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC9C,CAAC;IAED,IAAI,iBAAiB;QACnB,OAAO,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACtD,CAAC;IAED,IAAI,mBAAmB;QACrB,OAAO,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACxD,CAAC;CACF;AAED,MAAM,gBAAgB,GAAG,GAAG,CAAC;AAE7B,MAAM,OAAO,WAAW;IACb,EAAE,CAAS;IACX,YAAY,CAAoB;IAEzC,YAAY,MAAmC;QAC7C,IAAI,CAAC,EAAE,GAAG,YAAY,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,gBAAgB,CAAC;QACvD,MAAM,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;QAC7C,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5C,CAAC;CACF;AAED,SAAS,YAAY,CACnB,KAAoB;IAEpB,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,GAAG,KAAK,KAAK,EAAE,CAAC;QACrD,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAuB,CAAC;IACvD,CAAC;IACD,OAAO,KAA2B,CAAC;AACrC,CAAC;AAED,SAAS,gBAAgB,CAAwB,KAAoB;IACnE,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;AACnC,CAAC"}

package/out/zero-cache/src/db/lite-tables.d.ts

@@ -0,0 +1,5 @@
+import type { Database } from '../../../zqlite/src/db.js';
+import type { IndexSpec, TableSpec } from '../types/specs.js';
+export declare function listTables(db: Database): TableSpec[];
+export declare function listIndices(db: Database): IndexSpec[];
+//# sourceMappingURL=lite-tables.d.ts.map

package/out/zero-cache/src/db/lite-tables.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lite-tables.d.ts","sourceRoot":"","sources":["../../../../../zero-cache/src/db/lite-tables.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,kBAAkB,CAAC;AAC/C,OAAO,KAAK,EAAC,SAAS,EAAE,SAAS,EAAC,MAAM,mBAAmB,CAAC;AAW5D,wBAAgB,UAAU,CAAC,EAAE,EAAE,QAAQ,GAAG,SAAS,EAAE,CA4DpD;AAED,wBAAgB,WAAW,CAAC,EAAE,EAAE,QAAQ,GAAG,SAAS,EAAE,CAsCrD"}

package/out/zero-cache/src/db/lite-tables.js

@@ -0,0 +1,75 @@
+import { assert } from '../../../shared/src/asserts.js';
+export function listTables(db) {
+    const columns = db
+        .prepare(`
+      SELECT 
+        m.name as "table", 
+        p.name as name, 
+        p.type as type, 
+        p."notnull" as "notNull",
+        p.dflt_value as "dflt",
+        p.pk as keyPos 
+      FROM sqlite_master as m 
+      LEFT JOIN pragma_table_info(m.name) as p 
+      WHERE m.type = 'table'
+      `)
+        .all();
+    const tables = [];
+    let table;
+    columns.forEach(col => {
+        if (col.table !== table?.name) {
+            // New table
+            table = {
+                schema: '',
+                name: col.table,
+                columns: {},
+                primaryKey: [],
+            };
+            tables.push(table);
+        }
+        table.columns[col.name] = {
+            pos: Object.keys(table.columns).length + 1,
+            dataType: col.type,
+            characterMaximumLength: null,
+            notNull: col.notNull !== 0,
+            dflt: col.dflt,
+        };
+        if (col.keyPos) {
+            while (table.primaryKey.length < col.keyPos) {
+                table.primaryKey.push('');
+            }
+            table.primaryKey[col.keyPos - 1] = col.name;
+        }
+    });
+    // Sanity check that the primary keys are filled in.
+    Object.values(tables).forEach(table => {
+        assert(table.primaryKey.indexOf('') < 0, `Invalid primary key for ${JSON.stringify(table)}`);
+    });
+    return tables;
+}
+export function listIndices(db) {
+    const indices = db
+        .prepare(`SELECT name as indexName, tbl_name as tableName FROM sqlite_master WHERE type = 'index' AND tbl_name NOT LIKE '_zero.%'`)
+        .all();
+    const ret = [];
+    for (const indexDef of indices) {
+        const uniqueAndOrigin = db
+            .prepare(`SELECT "unique", origin FROM pragma_index_list(?) WHERE name = ?`)
+            .get(indexDef.tableName, indexDef.indexName);
+        if (uniqueAndOrigin.origin === 'pk') {
+            continue;
+        }
+        const columns = db
+            .prepare(`SELECT name FROM pragma_index_info(?) ORDER BY seqno ASC`)
+            .all(indexDef.indexName);
+        ret.push({
+            schemaName: '',
+            tableName: indexDef.tableName,
+            name: indexDef.indexName,
+            columns: columns.map(col => col.name),
+            unique: uniqueAndOrigin.unique !== 0,
+        });
+    }
+    return ret;
+}
+//# sourceMappingURL=lite-tables.js.map

package/out/zero-cache/src/db/lite-tables.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lite-tables.js","sourceRoot":"","sources":["../../../../../zero-cache/src/db/lite-tables.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,MAAM,EAAC,MAAM,uBAAuB,CAAC;AAa7C,MAAM,UAAU,UAAU,CAAC,EAAY;IACrC,MAAM,OAAO,GAAG,EAAE;SACf,OAAO,CACN;;;;;;;;;;;OAWC,CACF;SACA,GAAG,EAAkB,CAAC;IAKzB,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,IAAI,KAAuC,CAAC;IAE5C,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QACpB,IAAI,GAAG,CAAC,KAAK,KAAK,KAAK,EAAE,IAAI,EAAE,CAAC;YAC9B,YAAY;YACZ,KAAK,GAAG;gBACN,MAAM,EAAE,EAAE;gBACV,IAAI,EAAE,GAAG,CAAC,KAAK;gBACf,OAAO,EAAE,EAAE;gBACX,UAAU,EAAE,EAAE;aACf,CAAC;YACF,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACrB,CAAC;QAED,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG;YACxB,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC;YAC1C,QAAQ,EAAE,GAAG,CAAC,IAAI;YAClB,sBAAsB,EAAE,IAAI;YAC5B,OAAO,EAAE,GAAG,CAAC,OAAO,KAAK,CAAC;YAC1B,IAAI,EAAE,GAAG,CAAC,IAAI;SACf,CAAC;QACF,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;YACf,OAAO,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC;gBAC5C,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAC5B,CAAC;YACD,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC;QAC9C,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,oDAAoD;IACpD,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QACpC,MAAM,CACJ,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,EAChC,2BAA2B,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CACnD,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,EAAY;IACtC,MAAM,OAAO,GAAG,EAAE;SACf,OAAO,CACN,yHAAyH,CAC1H;SACA,GAAG,EAGH,CAAC;IACJ,MAAM,GAAG,GAAgB,EAAE,CAAC;IAC5B,KAAK,MAAM,QAAQ,IAAI,OAAO,EAAE,CAAC;QAC/B,MAAM,eAAe,GAAG,EAAE;aACvB,OAAO,CACN,kEAAkE,CACnE;aACA,GAAG,CAAC,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAG5C,CAAC;QACF,IAAI,eAAe,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;YACpC,SAAS;QACX,CAAC;QACD,MAAM,OAAO,GAAG,EAAE;aACf,OAAO,CAAC,0DAA0D,CAAC;aACnE,GAAG,CAAC,QAAQ,CAAC,SAAS,CAEtB,CAAC;QAEJ,GAAG,CAAC,IAAI,CAAC;YACP,UAAU,EAAE,EAAE;YACd,SAAS,EAAE,QAAQ,CAAC,SAAS;YAC7B,IAAI,EAAE,QAAQ,CAAC,SAAS;YACxB,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC;YACrC,MAAM,EAAE,eAAe,CAAC,MAAM,KAAK,CAAC;SACrC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,GAAG,CAAC;AACb,CAAC"}

package/out/zero-cache/src/db/migration-lite.d.ts

@@ -0,0 +1,38 @@
+import type { LogContext } from '@rocicorp/logger';
+import * as v from '../../../shared/src/valita.js';
+import type { Database as Db } from '../../../zqlite/src/db.js';
+/**
+ * A PreMigrationFn executes logic outside of a database transaction, and is
+ * suitable for potentially long running polling operations.
+ */
+type PreMigrationFn = (log: LogContext, db: Db) => Promise<void> | void;
+type MigrationFn = (log: LogContext, tx: Db) => Promise<void> | void;
+/**
+ * Encapsulates the logic for upgrading to a new schema. After the
+ * Migration code successfully completes, {@link runSchemaMigrations}
+ * will update the schema version and commit the transaction.
+ */
+export type Migration = {
+    pre?: PreMigrationFn;
+    run: MigrationFn;
+} | {
+    minSafeRollbackVersion: number;
+};
+/** Mapping from schema version to their respective migrations. */
+export type VersionMigrationMap = {
+    [destinationVersion: number]: Migration;
+};
+/**
+ * Ensures that the schema is compatible with the current code, updating and
+ * migrating the schema if necessary.
+ */
+export declare function runSchemaMigrations(log: LogContext, debugName: string, dbPath: string, versionMigrationMap: VersionMigrationMap): Promise<void>;
+export declare const schemaVersions: v.ObjectType<{
+    version: v.Type<number>;
+    maxVersion: v.Type<number>;
+    minSafeRollbackVersion: v.Type<number>;
+}, undefined>;
+export type SchemaVersions = v.Infer<typeof schemaVersions>;
+export declare function getSchemaVersions(db: Db): SchemaVersions;
+export {};
+//# sourceMappingURL=migration-lite.d.ts.map

package/out/zero-cache/src/db/migration-lite.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"migration-lite.d.ts","sourceRoot":"","sources":["../../../../../zero-cache/src/db/migration-lite.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AAGjD,OAAO,KAAK,CAAC,MAAM,sBAAsB,CAAC;AAC1C,OAAO,KAAK,EAAC,QAAQ,IAAI,EAAE,EAAC,MAAM,kBAAkB,CAAC;AAGrD;;;GAGG;AACH,KAAK,cAAc,GAAG,CAAC,GAAG,EAAE,UAAU,EAAE,EAAE,EAAE,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAExE,KAAK,WAAW,GAAG,CAAC,GAAG,EAAE,UAAU,EAAE,EAAE,EAAE,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAErE;;;;GAIG;AACH,MAAM,MAAM,SAAS,GACjB;IAAC,GAAG,CAAC,EAAE,cAAc,CAAC;IAAC,GAAG,EAAE,WAAW,CAAA;CAAC,GAExC;IAAC,sBAAsB,EAAE,MAAM,CAAA;CAAC,CAAC;AAErC,kEAAkE;AAClE,MAAM,MAAM,mBAAmB,GAAG;IAChC,CAAC,kBAAkB,EAAE,MAAM,GAAG,SAAS,CAAC;CACzC,CAAC;AAEF;;;GAGG;AACH,wBAAsB,mBAAmB,CACvC,GAAG,EAAE,UAAU,EACf,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,mBAAmB,EAAE,mBAAmB,GACvC,OAAO,CAAC,IAAI,CAAC,CA8Ef;AAaD,eAAO,MAAM,cAAc;;;;aAIzB,CAAC;AAGH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAG5D,wBAAgB,iBAAiB,CAAC,EAAE,EAAE,EAAE,GAAG,cAAc,CAmBxD"}

package/out/zero-cache/src/db/migration-lite.js

@@ -0,0 +1,161 @@
+import { assert } from '../../../shared/src/asserts.js';
+import { randInt } from '../../../shared/src/rand.js';
+import * as v from '../../../shared/src/valita.js';
+import { Database } from '../../../zqlite/src/db.js';
+/**
+ * Ensures that the schema is compatible with the current code, updating and
+ * migrating the schema if necessary.
+ */
+export async function runSchemaMigrations(log, debugName, dbPath, versionMigrationMap) {
+    log = log.withContext('initSchema', randInt(0, Number.MAX_SAFE_INTEGER).toString(36));
+    const db = new Database(log, dbPath);
+    db.pragma('foreign_keys = OFF');
+    try {
+        const versionMigrations = sorted(versionMigrationMap);
+        if (versionMigrations.length === 0) {
+            log.info?.(`No versions/migrations to manage.`);
+            return;
+        }
+        const codeSchemaVersion = versionMigrations[versionMigrations.length - 1][0];
+        log.info?.(`Checking schema for compatibility with ${debugName} at schema v${codeSchemaVersion}`);
+        let meta = await runTransaction(log, db, tx => {
+            const meta = getSchemaVersions(tx);
+            if (codeSchemaVersion < meta.minSafeRollbackVersion) {
+                throw new Error(`Cannot run ${debugName} at schema v${codeSchemaVersion} because rollback limit is v${meta.minSafeRollbackVersion}`);
+            }
+            if (meta.version > codeSchemaVersion) {
+                log.info?.(`Schema is at v${meta.version}. Resetting to v${codeSchemaVersion}`);
+                return setSchemaVersion(tx, meta, codeSchemaVersion);
+            }
+            return meta;
+        });
+        if (meta.version < codeSchemaVersion) {
+            for (const [dest, migration] of versionMigrations) {
+                if (meta.version < dest) {
+                    log.info?.(`Migrating schema from v${meta.version} to v${dest}`);
+                    void log.flush(); // Flush logs before each migration to help debug crash-y migrations.
+                    db.pragma('synchronous = OFF'); // For schema migrations we'll wait for the disk flush after the migration.
+                    // Run the optional PreMigration step before starting the transaction.
+                    if ('pre' in migration) {
+                        await migration.pre(log, db);
+                    }
+                    meta = await runTransaction(log, db, async (tx) => {
+                        // Fetch meta from within the transaction to make the migration atomic.
+                        let meta = getSchemaVersions(tx);
+                        if (meta.version < dest) {
+                            meta = await migrateSchemaVersion(log, tx, meta, dest, migration);
+                            assert(meta.version === dest);
+                        }
+                        return meta;
+                    });
+                    db.pragma('synchronous = NORMAL');
+                    db.exec('VACUUM');
+                    log.info?.('VACUUM completed');
+                    db.exec('ANALYZE main');
+                    log.info?.('ANALYZE completed');
+                }
+            }
+        }
+        assert(meta.version === codeSchemaVersion);
+        log.info?.(`Running ${debugName} at schema v${codeSchemaVersion}`);
+    }
+    catch (e) {
+        log.error?.('Error in ensureSchemaMigrated', e);
+        throw e;
+    }
+    finally {
+        db.close();
+        void log.flush(); // Flush the logs but do not block server progress on it.
+    }
+}
+function sorted(versionMigrationMap) {
+    const versionMigrations = [];
+    for (const [v, m] of Object.entries(versionMigrationMap)) {
+        versionMigrations.push([Number(v), m]);
+    }
+    return versionMigrations.sort(([a], [b]) => a - b);
+}
+// Exposed for tests.
+export const schemaVersions = v.object({
+    version: v.number(),
+    maxVersion: v.number(),
+    minSafeRollbackVersion: v.number(),
+});
+// Exposed for tests
+export function getSchemaVersions(db) {
+    // Note: The `lock` column transparently ensures that at most one row exists.
+    db.prepare(`
+    CREATE TABLE IF NOT EXISTS "_zero.SchemaVersions" (
+      version INTEGER NOT NULL,
+      maxVersion INTEGER NOT NULL,
+      minSafeRollbackVersion INTEGER NOT NULL,
+
+      lock INTEGER PRIMARY KEY DEFAULT 1 CHECK (lock=1)
+    );
+  `).run();
+    const result = db
+        .prepare('SELECT version, maxVersion, minSafeRollbackVersion FROM "_zero.SchemaVersions"')
+        .get();
+    return result ?? { version: 0, maxVersion: 0, minSafeRollbackVersion: 0 };
+}
+function setSchemaVersion(db, prev, newVersion) {
+    assert(newVersion > 0);
+    const meta = {
+        ...prev,
+        version: newVersion,
+        maxVersion: Math.max(newVersion, prev.maxVersion),
+    };
+    db.prepare(`
+    INSERT INTO "_zero.SchemaVersions" (version, maxVersion, minSafeRollbackVersion, lock)
+    VALUES (@version, @maxVersion, @minSafeRollbackVersion, 1)
+    ON CONFLICT (lock) DO UPDATE
+    SET version=EXCLUDED.version, 
+        maxVersion=EXCLUDED.maxVersion,
+        minSafeRollbackVersion=EXCLUDED.minSafeRollbackVersion
+  `).run(meta);
+    return meta;
+}
+async function migrateSchemaVersion(log, tx, meta, destinationVersion, migration) {
+    if ('run' in migration) {
+        await migration.run(log, tx);
+    }
+    else {
+        meta = ensureRollbackLimit(migration.minSafeRollbackVersion, log, meta);
+    }
+    return setSchemaVersion(tx, meta, destinationVersion);
+}
+/**
+ * Bumps the rollback limit [[toAtLeast]] the specified version.
+ * Leaves the rollback limit unchanged if it is equal or greater.
+ */
+function ensureRollbackLimit(toAtLeast, log, meta) {
+    // Sanity check to maintain the invariant that running code is never
+    // earlier than the rollback limit.
+    assert(toAtLeast <= meta.version + 1);
+    if (meta.minSafeRollbackVersion >= toAtLeast) {
+        // The rollback limit must never move backwards.
+        log.debug?.(`rollback limit is already at ${meta.minSafeRollbackVersion}, don't need to bump to ${toAtLeast}`);
+        return meta;
+    }
+    log.info?.(`bumping rollback limit from ${meta.minSafeRollbackVersion} to ${toAtLeast}`);
+    return {
+        ...meta,
+        minSafeRollbackVersion: toAtLeast,
+    };
+}
+// Note: We use a custom transaction wrapper (instead of db.begin(...)) in order
+// to support async operations within the transaction.
+async function runTransaction(log, db, tx) {
+    db.prepare('BEGIN EXCLUSIVE').run();
+    try {
+        const result = await tx(db);
+        db.prepare('COMMIT').run();
+        return result;
+    }
+    catch (e) {
+        db.prepare('ROLLBACK').run();
+        log.error?.('Aborted transaction due to error', e);
+        throw e;
+    }
+}
+//# sourceMappingURL=migration-lite.js.map

package/out/zero-cache/src/db/migration-lite.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"migration-lite.js","sourceRoot":"","sources":["../../../../../zero-cache/src/db/migration-lite.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,MAAM,EAAC,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EAAC,OAAO,EAAC,MAAM,oBAAoB,CAAC;AAC3C,OAAO,KAAK,CAAC,MAAM,sBAAsB,CAAC;AAE1C,OAAO,EAAC,QAAQ,EAAC,MAAM,kBAAkB,CAAC;AAyB1C;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,GAAe,EACf,SAAiB,EACjB,MAAc,EACd,mBAAwC;IAExC,GAAG,GAAG,GAAG,CAAC,WAAW,CACnB,YAAY,EACZ,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CACjD,CAAC;IACF,MAAM,EAAE,GAAG,IAAI,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACrC,EAAE,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC;IAEhC,IAAI,CAAC;QACH,MAAM,iBAAiB,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAC;QACtD,IAAI,iBAAiB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACnC,GAAG,CAAC,IAAI,EAAE,CAAC,mCAAmC,CAAC,CAAC;YAChD,OAAO;QACT,CAAC;QACD,MAAM,iBAAiB,GACrB,iBAAiB,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACrD,GAAG,CAAC,IAAI,EAAE,CACR,0CAA0C,SAAS,eAAe,iBAAiB,EAAE,CACtF,CAAC;QAEF,IAAI,IAAI,GAAG,MAAM,cAAc,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE;YAC5C,MAAM,IAAI,GAAG,iBAAiB,CAAC,EAAE,CAAC,CAAC;YACnC,IAAI,iBAAiB,GAAG,IAAI,CAAC,sBAAsB,EAAE,CAAC;gBACpD,MAAM,IAAI,KAAK,CACb,cAAc,SAAS,eAAe,iBAAiB,+BAA+B,IAAI,CAAC,sBAAsB,EAAE,CACpH,CAAC;YACJ,CAAC;YAED,IAAI,IAAI,CAAC,OAAO,GAAG,iBAAiB,EAAE,CAAC;gBACrC,GAAG,CAAC,IAAI,EAAE,CACR,iBAAiB,IAAI,CAAC,OAAO,mBAAmB,iBAAiB,EAAE,CACpE,CAAC;gBACF,OAAO,gBAAgB,CAAC,EAAE,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC;YACvD,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,OAAO,GAAG,iBAAiB,EAAE,CAAC;YACrC,KAAK,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,iBAAiB,EAAE,CAAC;gBAClD,IAAI,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,CAAC;oBACxB,GAAG,CAAC,IAAI,EAAE,CAAC,0BAA0B,IAAI,CAAC,OAAO,QAAQ,IAAI,EAAE,CAAC,CAAC;oBACjE,KAAK,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,qEAAqE;oBAEvF,EAAE,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC,CAAC,2EAA2E;oBAE3G,sEAAsE;oBACtE,IAAI,KAAK,IAAI,SAAS,EAAE,CAAC;wBACvB,MAAM,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;oBAC/B,CAAC;oBAED,IAAI,GAAG,MAAM,cAAc,CAAC,GAAG,EAAE,EAAE,EAAE,KAAK,EAAC,EAAE,EAAC,EAAE;wBAC9C,uEAAuE;wBACvE,IAAI,IAAI,GAAG,iBAAiB,CAAC,EAAE,CAAC,CAAC;wBACjC,IAAI,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,CAAC;4BACxB,IAAI,GAAG,MAAM,oBAAoB,CAAC,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;4BAClE,MAAM,CAAC,IAAI,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC;wBAChC,CAAC;wBACD,OAAO,IAAI,CAAC;oBACd,CAAC,CAAC,CAAC;oBAEH,EAAE,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC;oBAClC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;oBAClB,GAAG,CAAC,IAAI,EAAE,CAAC,kBAAkB,CAAC,CAAC;oBAC/B,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;oBACxB,GAAG,CAAC,IAAI,EAAE,CAAC,mBAAmB,CAAC,CAAC;gBAClC,CAAC;YACH,CAAC;QACH,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,OAAO,KAAK,iBAAiB,CAAC,CAAC;QAC3C,GAAG,CAAC,IAAI,EAAE,CAAC,WAAW,SAAS,eAAe,iBAAiB,EAAE,CAAC,CAAC;IACrE,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,GAAG,CAAC,KAAK,EAAE,CAAC,+BAA+B,EAAE,CAAC,CAAC,CAAC;QAChD,MAAM,CAAC,CAAC;IACV,CAAC;YAAS,CAAC;QACT,EAAE,CAAC,KAAK,EAAE,CAAC;QACX,KAAK,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,yDAAyD;IAC7E,CAAC;AACH,CAAC;AAED,SAAS,MAAM,CACb,mBAAwC;IAExC,MAAM,iBAAiB,GAA0B,EAAE,CAAC;IACpD,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,CAAC;QACzD,iBAAiB,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACzC,CAAC;IACD,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;AACrD,CAAC;AAED,qBAAqB;AACrB,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,sBAAsB,EAAE,CAAC,CAAC,MAAM,EAAE;CACnC,CAAC,CAAC;AAKH,oBAAoB;AACpB,MAAM,UAAU,iBAAiB,CAAC,EAAM;IACtC,6EAA6E;IAC7E,EAAE,CAAC,OAAO,CACR;;;;;;;;GAQD,CACA,CAAC,GAAG,EAAE,CAAC;IACR,MAAM,MAAM,GAAG,EAAE;SACd,OAAO,CACN,gFAAgF,CACjF;SACA,GAAG,EAAoB,CAAC;IAC3B,OAAO,MAAM,IAAI,EAAC,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,sBAAsB,EAAE,CAAC,EAAC,CAAC;AAC1E,CAAC;AAED,SAAS,gBAAgB,CACvB,EAAM,EACN,IAAoB,EACpB,UAAkB;IAElB,MAAM,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;IACvB,MAAM,IAAI,GAAG;QACX,GAAG,IAAI;QACP,OAAO,EAAE,UAAU;QACnB,UAAU,EAAE,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC;KAClD,CAAC;IAEF,EAAE,CAAC,OAAO,CACR;;;;;;;GAOD,CACA,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAEZ,OAAO,IAAI,CAAC;AACd,CAAC;AAED,KAAK,UAAU,oBAAoB,CACjC,GAAe,EACf,EAAM,EACN,IAAoB,EACpB,kBAA0B,EAC1B,SAAoB;IAEpB,IAAI,KAAK,IAAI,SAAS,EAAE,CAAC;QACvB,MAAM,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAC/B,CAAC;SAAM,CAAC;QACN,IAAI,GAAG,mBAAmB,CAAC,SAAS,CAAC,sBAAsB,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IAC1E,CAAC;IACD,OAAO,gBAAgB,CAAC,EAAE,EAAE,IAAI,EAAE,kBAAkB,CAAC,CAAC;AACxD,CAAC;AAED;;;GAGG;AACH,SAAS,mBAAmB,CAC1B,SAAiB,EACjB,GAAe,EACf,IAAoB;IAEpB,oEAAoE;IACpE,mCAAmC;IACnC,MAAM,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC;IAEtC,IAAI,IAAI,CAAC,sBAAsB,IAAI,SAAS,EAAE,CAAC;QAC7C,gDAAgD;QAChD,GAAG,CAAC,KAAK,EAAE,CACT,gCAAgC,IAAI,CAAC,sBAAsB,2BAA2B,SAAS,EAAE,CAClG,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IACD,GAAG,CAAC,IAAI,EAAE,CACR,+BAA+B,IAAI,CAAC,sBAAsB,OAAO,SAAS,EAAE,CAC7E,CAAC;IACF,OAAO;QACL,GAAG,IAAI;QACP,sBAAsB,EAAE,SAAS;KAClC,CAAC;AACJ,CAAC;AAED,gFAAgF;AAChF,sDAAsD;AACtD,KAAK,UAAU,cAAc,CAC3B,GAAe,EACf,EAAM,EACN,EAA8B;IAE9B,EAAE,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC,GAAG,EAAE,CAAC;IACpC,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC;QAC5B,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,GAAG,EAAE,CAAC;QAC3B,OAAO,MAAM,CAAC;IAChB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,EAAE,CAAC;QAC7B,GAAG,CAAC,KAAK,EAAE,CAAC,kCAAkC,EAAE,CAAC,CAAC,CAAC;QACnD,MAAM,CAAC,CAAC;IACV,CAAC;AACH,CAAC"}

package/out/zero-cache/src/db/migration.d.ts

@@ -0,0 +1,38 @@
+import type { LogContext } from '@rocicorp/logger';
+import type postgres from 'postgres';
+import * as v from '../../../shared/src/valita.js';
+/**
+ * A PreMigrationFn executes logic outside of a database transaction, and is
+ * suitable for potentially long running polling operations.
+ */
+type PreMigrationFn = (log: LogContext, db: postgres.Sql) => Promise<void>;
+type MigrationFn = (log: LogContext, tx: postgres.TransactionSql) => Promise<void>;
+/**
+ * Encapsulates the logic for upgrading to a new schema. After the
+ * Migration code successfully completes, {@link runSchemaMigrations}
+ * will update the schema version and commit the transaction.
+ */
+export type Migration = {
+    pre?: PreMigrationFn;
+    run: MigrationFn;
+} | {
+    minSafeRollbackVersion: number;
+};
+/** Mapping from schema version to their respective migrations. */
+export type VersionMigrationMap = {
+    [destinationVersion: number]: Migration;
+};
+/**
+ * Ensures that the schema is compatible with the current code, updating and
+ * migrating the schema if necessary.
+ */
+export declare function runSchemaMigrations(log: LogContext, debugName: string, schemaName: string, db: postgres.Sql, versionMigrationMap: VersionMigrationMap): Promise<void>;
+export declare const schemaVersions: v.ObjectType<{
+    version: v.Type<number>;
+    maxVersion: v.Type<number>;
+    minSafeRollbackVersion: v.Type<number>;
+}, undefined>;
+export type SchemaVersions = v.Infer<typeof schemaVersions>;
+export declare function getSchemaVersions(sql: postgres.Sql, schemaName: string): Promise<SchemaVersions>;
+export {};
+//# sourceMappingURL=migration.d.ts.map

package/out/zero-cache/src/db/migration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../../../../../zero-cache/src/db/migration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AACjD,OAAO,KAAK,QAAQ,MAAM,UAAU,CAAC;AAGrC,OAAO,KAAK,CAAC,MAAM,sBAAsB,CAAC;AAE1C;;;GAGG;AACH,KAAK,cAAc,GAAG,CAAC,GAAG,EAAE,UAAU,EAAE,EAAE,EAAE,QAAQ,CAAC,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAE3E,KAAK,WAAW,GAAG,CACjB,GAAG,EAAE,UAAU,EACf,EAAE,EAAE,QAAQ,CAAC,cAAc,KACxB,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB;;;;GAIG;AACH,MAAM,MAAM,SAAS,GACjB;IAAC,GAAG,CAAC,EAAE,cAAc,CAAC;IAAC,GAAG,EAAE,WAAW,CAAA;CAAC,GAExC;IAAC,sBAAsB,EAAE,MAAM,CAAA;CAAC,CAAC;AAErC,kEAAkE;AAClE,MAAM,MAAM,mBAAmB,GAAG;IAChC,CAAC,kBAAkB,EAAE,MAAM,GAAG,SAAS,CAAC;CACzC,CAAC;AAEF;;;GAGG;AACH,wBAAsB,mBAAmB,CACvC,GAAG,EAAE,UAAU,EACf,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,EAAE,EAAE,QAAQ,CAAC,GAAG,EAChB,mBAAmB,EAAE,mBAAmB,GACvC,OAAO,CAAC,IAAI,CAAC,CAyEf;AAaD,eAAO,MAAM,cAAc;;;;aAIzB,CAAC;AAGH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAG5D,wBAAsB,iBAAiB,CACrC,GAAG,EAAE,QAAQ,CAAC,GAAG,EACjB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,cAAc,CAAC,CAsBzB"}