@rocicorp/zero 0.18.2025032800 → 0.18.2025040200

package/out/analyze-query/src/bin.d.ts

@@ -0,0 +1,2 @@
+import '@dotenvx/dotenvx/config';
+//# sourceMappingURL=bin.d.ts.map

package/out/analyze-query/src/bin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bin.d.ts","sourceRoot":"","sources":["../../../../analyze-query/src/bin.ts"],"names":[],"mappings":"AAEA,OAAO,yBAAyB,CAAC"}

package/out/analyze-query/src/bin.js

@@ -0,0 +1,178 @@
+/* eslint-disable no-console */
+import chalk from 'chalk';
+import '@dotenvx/dotenvx/config';
+import { testLogConfig } from "../../otel/src/test-log-config.js";
+import { createSilentLogContext } from "../../shared/src/logging-test-utils.js";
+import { parseOptions } from "../../shared/src/options.js";
+import * as v from "../../shared/src/valita.js";
+import { mapAST, } from "../../zero-protocol/src/ast.js";
+import { buildPipeline } from "../../zql/src/builder/builder.js";
+import { Catch } from "../../zql/src/ivm/catch.js";
+import { MemoryStorage } from "../../zql/src/ivm/memory-storage.js";
+import { newQuery } from "../../zql/src/query/query-impl.js";
+import { Database } from "../../zqlite/src/db.js";
+import { runtimeDebugFlags, runtimeDebugStats, } from "../../zqlite/src/runtime-debug.js";
+import { TableSource } from "../../zqlite/src/table-source.js";
+import { ZERO_ENV_VAR_PREFIX, zeroOptions, } from "../../zero-cache/src/config/zero-config.js";
+import { loadSchemaAndPermissions } from "../../zero-cache/src/scripts/permissions.js";
+import { clientToServer, serverToClient, } from "../../zero-schema/src/name-mapper.js";
+const options = {
+    replicaFile: zeroOptions.replica.file,
+    ast: {
+        type: v.string().optional(),
+        desc: ['AST for the query to be analyzed.'],
+    },
+    query: {
+        type: v.string().optional(),
+        desc: [
+            `Query to be analyzed in the form of: z.query.table.where(...).related(...).etc`,
+        ],
+    },
+    schema: {
+        type: v.string().default('./schema.ts'),
+        desc: ['Path to the schema file.'],
+    },
+};
+const config = parseOptions(options, process.argv.slice(2), ZERO_ENV_VAR_PREFIX);
+runtimeDebugFlags.trackRowsVended = true;
+const lc = createSilentLogContext();
+const db = new Database(lc, config.replicaFile);
+const { schema } = await loadSchemaAndPermissions(lc, config.schema);
+const sources = new Map();
+const clientToServerMapper = clientToServer(schema.tables);
+const serverToClientMapper = serverToClient(schema.tables);
+const host = {
+    mapAst(ast) {
+        return mapAST(ast, clientToServerMapper);
+    },
+    getSource: (serverTableName) => {
+        const clientTableName = serverToClientMapper.tableName(serverTableName);
+        let source = sources.get(serverTableName);
+        if (source) {
+            return source;
+        }
+        source = new TableSource(lc, testLogConfig, '', db, serverTableName, Object.fromEntries(Object.entries(schema.tables[clientTableName].columns).map(([colName, column]) => [
+            clientToServerMapper.columnName(clientTableName, colName),
+            column,
+        ])), schema.tables[clientTableName].primaryKey.map(col => clientToServerMapper.columnName(clientTableName, col)));
+        sources.set(serverTableName, source);
+        return source;
+    },
+    createStorage() {
+        // TODO: table storage!!
+        return new MemoryStorage();
+    },
+    decorateInput(input) {
+        return input;
+    },
+    addServerQuery() {
+        return () => { };
+    },
+    updateServerQuery() { },
+    onQueryMaterialized() { },
+    onTransactionCommit() {
+        return () => { };
+    },
+    batchViewUpdates(applyViewUpdates) {
+        return applyViewUpdates();
+    },
+};
+let start;
+let end;
+const suppressError = {};
+if (config.ast) {
+    [start, end] = runAst(JSON.parse(config.ast));
+}
+else if (config.query) {
+    [start, end] = runQuery(config.query);
+}
+else {
+    throw new Error('No query or AST provided');
+}
+function runAst(ast) {
+    const pipeline = buildPipeline(ast, host);
+    const output = new Catch(pipeline);
+    const start = performance.now();
+    output.fetch();
+    const end = performance.now();
+    return [start, end];
+}
+function runQuery(queryString) {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    let q;
+    const z = {
+        query: Object.fromEntries(Object.entries(schema.tables).map(([name]) => [
+            name,
+            newQuery(host, schema, name),
+        ])),
+    };
+    suppressError.q = q;
+    suppressError.z = z;
+    eval(`q = z.query.${queryString};`);
+    const start = performance.now();
+    q.run();
+    const end = performance.now();
+    return [start, end];
+}
+console.log(chalk.blue.bold('=== Query Stats: ===\n'));
+showStats();
+console.log(chalk.blue.bold('\n\n=== Query Plans: ===\n'));
+explainQueries();
+function showStats() {
+    let totalRowsConsidered = 0;
+    for (const source of sources.values()) {
+        const entires = [
+            ...(runtimeDebugStats.getRowsVended('')?.get(source.table)?.entries() ??
+                []),
+        ];
+        totalRowsConsidered += entires.reduce((acc, entry) => acc + entry[1], 0);
+        console.log(chalk.bold(source.table + ' vended:'), entires);
+    }
+    console.log(chalk.bold('total rows considered:'), colorRowsConsidered(totalRowsConsidered));
+    console.log(chalk.bold('time:'), colorTime(end - start), 'ms');
+}
+function explainQueries() {
+    for (const source of sources.values()) {
+        const queries = runtimeDebugStats.getRowsVended('')?.get(source.table)?.keys() ?? [];
+        for (const query of queries) {
+            console.log(chalk.bold('query'), query);
+            console.log(db
+                // we should be more intelligent about value replacement.
+                // Different values result in different plans. E.g., picking a value at the start
+                // of an index will result in `scan` vs `search`. The scan is fine in that case.
+                .prepare(`EXPLAIN QUERY PLAN ${query.replaceAll('?', "'sdfse'")}`)
+                .all()
+                .map((row, i) => colorPlanRow(row.detail, i))
+                .join('\n'));
+            console.log('\n');
+        }
+    }
+}
+function colorTime(duration) {
+    if (duration < 100) {
+        return chalk.green(duration.toFixed(2) + 'ms');
+    }
+    else if (duration < 1000) {
+        return chalk.yellow(duration.toFixed(2) + 'ms');
+    }
+    return chalk.red(duration.toFixed(2) + 'ms');
+}
+function colorRowsConsidered(n) {
+    if (n < 1000) {
+        return chalk.green(n.toString());
+    }
+    else if (n < 10000) {
+        return chalk.yellow(n.toString());
+    }
+    return chalk.red(n.toString());
+}
+function colorPlanRow(row, i) {
+    if (row.includes('SCAN')) {
+        if (i === 0) {
+            return chalk.yellow(row);
+        }
+        return chalk.red(row);
+    }
+    return chalk.green(row);
+}
+//# sourceMappingURL=bin.js.map

package/out/analyze-query/src/bin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bin.js","sourceRoot":"","sources":["../../../../analyze-query/src/bin.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,yBAAyB,CAAC;AAEjC,OAAO,EAAC,aAAa,EAAC,MAAM,mCAAmC,CAAC;AAChE,OAAO,EAAC,sBAAsB,EAAC,MAAM,wCAAwC,CAAC;AAC9E,OAAO,EAAC,YAAY,EAAC,MAAM,6BAA6B,CAAC;AACzD,OAAO,KAAK,CAAC,MAAM,4BAA4B,CAAC;AAChD,OAAO,EACL,MAAM,GAGP,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAC,aAAa,EAAC,MAAM,kCAAkC,CAAC;AAC/D,OAAO,EAAC,KAAK,EAAC,MAAM,4BAA4B,CAAC;AACjD,OAAO,EAAC,aAAa,EAAC,MAAM,qCAAqC,CAAC;AAElE,OAAO,EAAC,QAAQ,EAAqB,MAAM,mCAAmC,CAAC;AAC/E,OAAO,EAAC,QAAQ,EAAC,MAAM,wBAAwB,CAAC;AAChD,OAAO,EACL,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAC,WAAW,EAAC,MAAM,kCAAkC,CAAC;AAC7D,OAAO,EACL,mBAAmB,EACnB,WAAW,GACZ,MAAM,4CAA4C,CAAC;AACpD,OAAO,EAAC,wBAAwB,EAAC,MAAM,6CAA6C,CAAC;AACrF,OAAO,EACL,cAAc,EACd,cAAc,GACf,MAAM,sCAAsC,CAAC;AAE9C,MAAM,OAAO,GAAG;IACd,WAAW,EAAE,WAAW,CAAC,OAAO,CAAC,IAAI;IACrC,GAAG,EAAE;QACH,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,IAAI,EAAE,CAAC,mCAAmC,CAAC;KAC5C;IACD,KAAK,EAAE;QACL,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,IAAI,EAAE;YACJ,gFAAgF;SACjF;KACF;IACD,MAAM,EAAE;QACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,aAAa,CAAC;QACvC,IAAI,EAAE,CAAC,0BAA0B,CAAC;KACnC;CACF,CAAC;AAEF,MAAM,MAAM,GAAG,YAAY,CACzB,OAAO,EACP,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EACrB,mBAAmB,CACpB,CAAC;AAEF,iBAAiB,CAAC,eAAe,GAAG,IAAI,CAAC;AAEzC,MAAM,EAAE,GAAG,sBAAsB,EAAE,CAAC;AAEpC,MAAM,EAAE,GAAG,IAAI,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;AAChD,MAAM,EAAC,MAAM,EAAC,GAAG,MAAM,wBAAwB,CAAC,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;AACnE,MAAM,OAAO,GAAG,IAAI,GAAG,EAAuB,CAAC;AAC/C,MAAM,oBAAoB,GAAG,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AAC3D,MAAM,oBAAoB,GAAG,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AAC3D,MAAM,IAAI,GAAkB;IAC1B,MAAM,CAAC,GAAQ;QACb,OAAO,MAAM,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC;IAC3C,CAAC;IACD,SAAS,EAAE,CAAC,eAAuB,EAAE,EAAE;QACrC,MAAM,eAAe,GAAG,oBAAoB,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QACxE,IAAI,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAC1C,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,MAAM,GAAG,IAAI,WAAW,CACtB,EAAE,EACF,aAAa,EACb,EAAE,EACF,EAAE,EACF,eAAe,EACf,MAAM,CAAC,WAAW,CAChB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,CACxD,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC;YACrB,oBAAoB,CAAC,UAAU,CAAC,eAAe,EAAE,OAAO,CAAC;YACzD,MAAM;SACP,CACF,CACF,EACD,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAClD,oBAAoB,CAAC,UAAU,CAAC,eAAe,EAAE,GAAG,CAAC,CAC5B,CAC5B,CAAC;QAEF,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;QACrC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,aAAa;QACX,wBAAwB;QACxB,OAAO,IAAI,aAAa,EAAE,CAAC;IAC7B,CAAC;IACD,aAAa,CAAC,KAAY;QACxB,OAAO,KAAK,CAAC;IACf,CAAC;IACD,cAAc;QACZ,OAAO,GAAG,EAAE,GAAE,CAAC,CAAC;IAClB,CAAC;IACD,iBAAiB,KAAI,CAAC;IACtB,mBAAmB,KAAI,CAAC;IACxB,mBAAmB;QACjB,OAAO,GAAG,EAAE,GAAE,CAAC,CAAC;IAClB,CAAC;IACD,gBAAgB,CAAI,gBAAyB;QAC3C,OAAO,gBAAgB,EAAE,CAAC;IAC5B,CAAC;CACF,CAAC;AAEF,IAAI,KAAa,CAAC;AAClB,IAAI,GAAW,CAAC;AAChB,MAAM,aAAa,GAA4B,EAAE,CAAC;AAClD,IAAI,MAAM,CAAC,GAAG,EAAE,CAAC;IACf,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAQ,CAAC,CAAC;AACvD,CAAC;KAAM,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;IACxB,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AACxC,CAAC;KAAM,CAAC;IACN,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;AAC9C,CAAC;AAED,SAAS,MAAM,CAAC,GAAQ;IACtB,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAC1C,MAAM,MAAM,GAAG,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC;IAEnC,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IAChC,MAAM,CAAC,KAAK,EAAE,CAAC;IACf,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IAC9B,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AACtB,CAAC;AAED,SAAS,QAAQ,CAAC,WAAmB;IACnC,8DAA8D;IAC9D,IAAI,CAAM,CAAC;IACX,MAAM,CAAC,GAAG;QACR,KAAK,EAAE,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;YAC5C,IAAI;YACJ,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC;SAC7B,CAAC,CACH;KACF,CAAC;IACF,aAAa,CAAC,CAAC,GAAG,CAAC,CAAC;IACpB,aAAa,CAAC,CAAC,GAAG,CAAC,CAAC;IAEpB,IAAI,CAAC,eAAe,WAAW,GAAG,CAAC,CAAC;IAEpC,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IAChC,CAAC,CAAC,GAAG,EAAE,CAAC;IACR,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IAC9B,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AACtB,CAAC;AAED,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC,CAAC;AACvD,SAAS,EAAE,CAAC;AACZ,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC,CAAC;AAC3D,cAAc,EAAE,CAAC;AAEjB,SAAS,SAAS;IAChB,IAAI,mBAAmB,GAAG,CAAC,CAAC;IAC5B,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;QACtC,MAAM,OAAO,GAAG;YACd,GAAG,CAAC,iBAAiB,CAAC,aAAa,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE;gBACnE,EAAE,CAAC;SACN,CAAC;QACF,mBAAmB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACzE,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,UAAU,CAAC,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED,OAAO,CAAC,GAAG,CACT,KAAK,CAAC,IAAI,CAAC,wBAAwB,CAAC,EACpC,mBAAmB,CAAC,mBAAmB,CAAC,CACzC,CAAC;IACF,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,GAAG,GAAG,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;AACjE,CAAC;AAED,SAAS,cAAc;IACrB,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;QACtC,MAAM,OAAO,GACX,iBAAiB,CAAC,aAAa,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;QACvE,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC5B,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,CAAC;YACxC,OAAO,CAAC,GAAG,CACT,EAAE;gBACA,yDAAyD;gBACzD,iFAAiF;gBACjF,gFAAgF;iBAC/E,OAAO,CAAC,sBAAsB,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,SAAS,CAAC,EAAE,CAAC;iBACjE,GAAG,EAAoB;iBACvB,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;iBAC5C,IAAI,CAAC,IAAI,CAAC,CACd,CAAC;YACF,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACpB,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,SAAS,CAAC,QAAgB;IACjC,IAAI,QAAQ,GAAG,GAAG,EAAE,CAAC;QACnB,OAAO,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IACjD,CAAC;SAAM,IAAI,QAAQ,GAAG,IAAI,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IAClD,CAAC;IACD,OAAO,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,mBAAmB,CAAC,CAAS;IACpC,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC;QACb,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;IACnC,CAAC;SAAM,IAAI,CAAC,GAAG,KAAK,EAAE,CAAC;QACrB,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;IACpC,CAAC;IACD,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;AACjC,CAAC;AAED,SAAS,YAAY,CAAC,GAAW,EAAE,CAAS;IAC1C,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACzB,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACZ,OAAO,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC3B,CAAC;QACD,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACxB,CAAC;IACD,OAAO,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AAC1B,CAAC"}