@rocicorp/zero 1.11.0-canary.27 → 1.11.0-canary.29

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

@@ -62,20 +62,20 @@ var options = {
 		desc: ["JSON-encoded array of arguments for --query-name. Defaults to `[]`."]
 	},
 	outputVendedRows: {
-		type: valita_exports.boolean().default(false),
+		type: valita_exports.boolean().optional(() => false),
 		desc: ["Include the rows read from the replica to execute the query.", "Each row appears once per read."]
 	},
 	outputSyncedRows: {
-		type: valita_exports.boolean().default(false),
+		type: valita_exports.boolean().optional(() => false),
 		desc: ["Include the rows that would be synced to the client."]
 	},
 	joinPlans: {
-		type: valita_exports.boolean().default(false),
+		type: valita_exports.boolean().optional(() => false),
 		desc: ["Include join planner diagnostics."]
 	},
 	log: {
 		...logOptions,
-		level: logLevel.default("error")
+		level: logLevel.optional(() => "error")
 	}
 };
 var stderrConsole = new Console({

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

@@ -1 +1 @@
-{"version":3,"file":"analyze-cli.js","names":[],"sources":["../../../../analyze-query/src/analyze-cli.ts"],"sourcesContent":["import '../../shared/src/dotenv.ts';\n\nimport {Console} from 'node:console';\nimport {styleText} from 'node:util';\nimport type {LogSink} from '@rocicorp/logger';\nimport {WebSocket as NodeWebSocket} from 'ws';\nimport {logLevel, logOptions} from '../../otel/src/log-options.ts';\nimport {colorConsole} from '../../shared/src/logging.ts';\nimport {parseOptions} from '../../shared/src/options.ts';\nimport * as v from '../../shared/src/valita.ts';\nimport {ZERO_ENV_VAR_PREFIX} from '../../zero-cache/src/config/zero-config.ts';\nimport {Zero} from '../../zero-client/src/client/zero.ts';\nimport type {AnalyzeQueryResult} from '../../zero-protocol/src/analyze-query-result.ts';\nimport type {AST} from '../../zero-protocol/src/ast.ts';\nimport type {Schema} from '../../zero-types/src/schema.ts';\nimport {formatPlannerEvents} from '../../zql/src/planner/planner-debug.ts';\nimport {createBuilder} from '../../zql/src/query/create-builder.ts';\nimport type {AnyQuery} from '../../zql/src/query/query.ts';\nimport type {SchemaQuery} from '../../zql/src/query/schema-query.ts';\n\nexport type AnalyzeCLIOptions = {\n  schema: Schema;\n  /** Defaults to `process.argv.slice(2)`. */\n  argv?: readonly string[] | undefined;\n};\n\nconst options = {\n  zeroCacheURL: {\n    type: v.string().optional(),\n    desc: [\n      'URL of the remote zero-cache to analyze against.',\n      'Accepts http(s):// or ws(s):// (ws(s) is the transport actually used).',\n    ],\n  },\n  adminPassword: {\n    type: v.string().optional(),\n    desc: [\n      'Admin password for zero-cache.',\n      'Required when the server is configured with one; ignored in dev mode.',\n    ],\n  },\n  authToken: {\n    type: v.string().optional(),\n    desc: [\n      'Raw JWT forwarded to zero-cache.',\n      'Used server-side to fill permission variables for the query.',\n    ],\n  },\n  cookie: {\n    type: v.string().optional(),\n    desc: [\n      'Cookie header value sent on the WebSocket upgrade request,',\n      'e.g. `session=abc; foo=bar`. Use this when zero-cache is behind',\n      'a proxy that resolves auth via cookies. Merged with --headers-json',\n      '(--cookie wins on conflict).',\n    ],\n  },\n  headersJson: {\n    type: v.string().optional(),\n    desc: [\n      'JSON object of arbitrary headers to send on the WebSocket upgrade',\n      'request, e.g. `{\"x-api-key\":\"...\"}`. Escape hatch for exotic auth',\n      'schemes; prefer --auth-token or --cookie when possible.',\n    ],\n  },\n  userId: {\n    type: v.string().optional(),\n    desc: [\n      'Optional userID to report to zero-cache.',\n      'Omit for anonymous analysis.',\n    ],\n  },\n  ast: {\n    type: v.string().optional(),\n    desc: [\n      'JSON-encoded AST. Exactly one of --ast / --query / --query-name is required.',\n      'The AST is sent to the server verbatim — provide it in server (post-mapping) form.',\n    ],\n  },\n  query: {\n    type: v.string().optional(),\n    desc: [\n      'ZQL query in chain form, e.g. `issue.related(\"comments\").limit(10)`.',\n      'Evaluated against the schema you pass to runAnalyzeCLI.',\n    ],\n  },\n  queryName: {\n    type: v.string().optional(),\n    desc: [\n      'Name of a server-registered custom (named) query.',\n      'The server resolves the name + args via its registered query handler.',\n    ],\n  },\n  queryArgs: {\n    type: v.string().optional(),\n    desc: [\n      'JSON-encoded array of arguments for --query-name. Defaults to `[]`.',\n    ],\n  },\n  outputVendedRows: {\n    type: v.boolean().default(false),\n    desc: [\n      'Include the rows read from the replica to execute the query.',\n      'Each row appears once per read.',\n    ],\n  },\n  outputSyncedRows: {\n    type: v.boolean().default(false),\n    desc: ['Include the rows that would be synced to the client.'],\n  },\n  joinPlans: {\n    type: v.boolean().default(false),\n    desc: ['Include join planner diagnostics.'],\n  },\n  log: {\n    ...logOptions,\n    level: logLevel.default('error'),\n  },\n};\n\ntype QueryPlan =\n  | {kind: 'ast'; ast: AST}\n  | {kind: 'zql'; text: string}\n  | {kind: 'named'; name: string; args: ReadonlyArray<unknown>};\n\n// Route all Zero client log output to stderr so stdout contains only the\n// analyze result. Shell redirection (`2>/dev/null`) can then cleanly silence\n// logs without affecting output.\nconst stderrConsole = new Console({\n  stdout: process.stderr,\n  stderr: process.stderr,\n});\nconst stderrLogSink: LogSink = {\n  log(level, context, ...args) {\n    const ctx = context\n      ? Object.entries(context).map(([k, v]) =>\n          v === undefined ? k : `${k}=${v}`,\n        )\n      : [];\n    stderrConsole[level](...ctx, ...args);\n  },\n};\n\n/**\n * Entry point for a user's `cli.ts`. Parses argv, connects to a remote\n * zero-cache by standing up an in-process Zero client (in-memory storage,\n * no subscriptions), calls the inspector's `analyze-query` RPC, and\n * renders the result. Intended to be called as:\n *\n * ```ts\n * import {schema} from './schema.ts';\n * import {runAnalyzeCLI} from '@rocicorp/zero/analyze';\n * await runAnalyzeCLI({schema});\n * ```\n *\n * Exits the process with code 1 on error.\n */\nexport async function runAnalyzeCLI(opts: AnalyzeCLIOptions): Promise<void> {\n  const argv = (opts.argv ?? process.argv.slice(2)).map(s =>\n    s.replaceAll('\\n', ' '),\n  );\n\n  const config = parseOptions(options, {\n    argv,\n    envNamePrefix: ZERO_ENV_VAR_PREFIX,\n    description: [\n      {\n        header: 'analyze-query (remote)',\n        content: `Analyze a ZQL query against a remote zero-cache.\n\n  Connects to zero-cache's inspector protocol and reports the server-observed\n  row scans, SQLite query plans, and timings.`,\n      },\n      {\n        header: 'Examples',\n        content: `  node cli.ts --zero-cache-url=https://zero.example.com \\\\\n    --admin-password=\"$ZERO_ADMIN_PASSWORD\" \\\\\n    --query='issue.related(\"comments\").limit(10)'\n\n  node cli.ts --zero-cache-url=http://localhost:4848 \\\\\n    --ast='\\\\{\"table\": \"issue\", \"limit\": 5\\\\}'\n\n  node cli.ts --zero-cache-url=http://localhost:4848 \\\\\n    --query-name=issueList --query-args='[]'`,\n      },\n    ],\n  });\n\n  if (!config.zeroCacheURL) {\n    colorConsole.error('--zero-cache-url is required. See --help for usage.');\n    process.exit(1);\n  }\n\n  const plan = buildQueryPlan(config);\n\n  const handshakeHeaders = resolveHandshakeHeaders(config);\n  if (Object.keys(handshakeHeaders).length > 0) {\n    installWebSocketHeaderShim(handshakeHeaders);\n  }\n\n  // zero-client and replicache reference a build-time `TESTING` global that\n  // bundlers replace with a boolean literal; under node there's no replacement,\n  // so provide a runtime default.\n  (globalThis as {TESTING?: boolean}).TESTING ??= false;\n\n  const z = new Zero({\n    schema: opts.schema,\n    server: config.zeroCacheURL,\n    auth: config.authToken,\n    userID: config.userId,\n    kvStore: 'mem',\n    logLevel: config.log.level,\n    logSink: stderrLogSink,\n  });\n\n  let result: AnalyzeQueryResult;\n  try {\n    const authOk = await z.inspector.authenticate(config.adminPassword ?? '');\n    if (!authOk) {\n      throw new Error(\n        'admin password rejected (or --admin-password is required)',\n      );\n    }\n\n    const rpcOptions = {\n      vendedRows: config.outputVendedRows,\n      syncedRows: config.outputSyncedRows,\n      joinPlans: config.joinPlans,\n    };\n\n    if (plan.kind === 'ast') {\n      result = await z.inspector.analyzeServerAST(plan.ast, rpcOptions);\n    } else if (plan.kind === 'named') {\n      result = await z.inspector.analyzeNamedQuery(\n        plan.name,\n        plan.args as ReadonlyArray<never>,\n        rpcOptions,\n      );\n    } else {\n      const built = buildZqlQuery(plan.text, createBuilder(opts.schema));\n      result = await z.inspector.analyzeQuery(built, rpcOptions);\n    }\n  } catch (e) {\n    colorConsole.error(e instanceof Error ? e.message : String(e));\n    await z.close().catch(() => {});\n    process.exit(1);\n  }\n\n  renderResult(result, {\n    outputSyncedRows: config.outputSyncedRows,\n    outputVendedRows: config.outputVendedRows,\n  });\n\n  await z.close();\n}\n\nfunction buildQueryPlan(config: {\n  ast?: string | undefined;\n  query?: string | undefined;\n  queryName?: string | undefined;\n  queryArgs?: string | undefined;\n}): QueryPlan {\n  const selectors = [\n    config.ast !== undefined && 'ast',\n    config.query !== undefined && 'query',\n    config.queryName !== undefined && 'queryName',\n  ].filter(Boolean) as string[];\n\n  if (selectors.length === 0) {\n    colorConsole.error(\n      'Exactly one of --ast / --query / --query-name is required.',\n    );\n    process.exit(1);\n  }\n  if (selectors.length > 1) {\n    colorConsole.error(\n      `Only one of --ast / --query / --query-name may be provided; got: ${selectors.join(', ')}`,\n    );\n    process.exit(1);\n  }\n\n  if (config.ast !== undefined) {\n    return {kind: 'ast', ast: JSON.parse(config.ast) as AST};\n  }\n  if (config.query !== undefined) {\n    return {kind: 'zql', text: config.query};\n  }\n  const args = config.queryArgs\n    ? (JSON.parse(config.queryArgs) as ReadonlyArray<unknown>)\n    : [];\n  return {kind: 'named', name: config.queryName as string, args};\n}\n\nfunction buildZqlQuery(\n  queryString: string,\n  builder: SchemaQuery<Schema>,\n): AnyQuery {\n  const f = new Function('builder', `return builder.${queryString};`);\n  return f(builder) as AnyQuery;\n}\n\nfunction resolveHandshakeHeaders(config: {\n  cookie?: string | undefined;\n  headersJson?: string | undefined;\n}): Record<string, string> {\n  const headers: Record<string, string> = {};\n  if (config.headersJson !== undefined) {\n    let parsed: unknown;\n    try {\n      parsed = JSON.parse(config.headersJson);\n    } catch (e) {\n      colorConsole.error(\n        `--headers-json is not valid JSON: ${e instanceof Error ? e.message : String(e)}`,\n      );\n      process.exit(1);\n    }\n    if (\n      parsed === null ||\n      typeof parsed !== 'object' ||\n      Array.isArray(parsed)\n    ) {\n      colorConsole.error('--headers-json must be a JSON object.');\n      process.exit(1);\n    }\n    for (const [k, val] of Object.entries(parsed)) {\n      if (typeof val !== 'string') {\n        colorConsole.error(\n          `--headers-json values must be strings; got ${typeof val} for \"${k}\".`,\n        );\n        process.exit(1);\n      }\n      headers[k] = val;\n    }\n  }\n  if (config.cookie !== undefined) {\n    headers.cookie = config.cookie;\n  }\n  return headers;\n}\n\nfunction installWebSocketHeaderShim(headers: Record<string, string>): void {\n  class HeaderInjectingWebSocket extends NodeWebSocket {\n    constructor(url: string | URL, protocols?: string | string[]) {\n      super(url, protocols, {headers});\n    }\n  }\n  (globalThis as {WebSocket?: unknown}).WebSocket = HeaderInjectingWebSocket;\n}\n\nfunction renderResult(\n  result: AnalyzeQueryResult,\n  opts: {outputSyncedRows: boolean; outputVendedRows: boolean},\n) {\n  if (opts.outputSyncedRows) {\n    colorConsole.log(styleText(['blue', 'bold'], '=== Synced Rows: ===\\n'));\n    for (const [table, rows] of Object.entries(result.syncedRows ?? {})) {\n      colorConsole.log(styleText('bold', table + ':'), rows);\n    }\n  }\n\n  colorConsole.log(styleText(['blue', 'bold'], '=== Query Stats: ===\\n'));\n  colorConsole.log(\n    styleText('bold', 'total synced rows:'),\n    result.syncedRowCount,\n  );\n\n  const readRowCountsByQuery = result.readRowCountsByQuery ?? {};\n  let totalRowsRead = 0;\n  for (const table of Object.keys(readRowCountsByQuery).sort()) {\n    const counts = readRowCountsByQuery[table];\n    for (const n of Object.values(counts)) {\n      totalRowsRead += n;\n    }\n    colorConsole.log(styleText('bold', `${table} vended:`), counts);\n  }\n  colorConsole.log(\n    styleText('bold', 'Rows Read (into JS):'),\n    colorRowsConsidered(totalRowsRead),\n  );\n  const duration = result.elapsed ?? result.end - result.start;\n  colorConsole.log(styleText('bold', 'time:'), colorTime(duration), 'ms');\n\n  if (opts.outputVendedRows) {\n    colorConsole.log(\n      styleText(['blue', 'bold'], '=== JS Row Scan Values: ===\\n'),\n    );\n    for (const [table, rows] of Object.entries(result.readRows ?? {})) {\n      colorConsole.log(styleText('bold', `${table}:`), rows);\n    }\n  }\n\n  colorConsole.log(\n    styleText(['blue', 'bold'], '\\n=== Rows Scanned (by SQLite): ===\\n'),\n  );\n  const dbScansByQuery = result.dbScansByQuery ?? {};\n  let totalNVisit = 0;\n  for (const [table, queries] of Object.entries(dbScansByQuery)) {\n    colorConsole.log(styleText('bold', `${table}:`), queries);\n    for (const count of Object.values(queries)) {\n      totalNVisit += count;\n    }\n  }\n  colorConsole.log(\n    styleText('bold', 'total rows scanned:'),\n    colorRowsConsidered(totalNVisit),\n  );\n\n  colorConsole.log(styleText(['blue', 'bold'], '\\n\\n=== Query Plans: ===\\n'));\n  const plans = result.sqlitePlans ?? {};\n  for (const [query, plan] of Object.entries(plans)) {\n    colorConsole.log(styleText('bold', 'query'), query);\n    colorConsole.log(plan.map((row, i) => colorPlanRow(row, i)).join('\\n'));\n    colorConsole.log('\\n');\n  }\n\n  if (result.warnings.length > 0) {\n    colorConsole.log(styleText(['yellow', 'bold'], '=== Warnings: ===\\n'));\n    for (const w of result.warnings) {\n      colorConsole.log(styleText('yellow', w));\n    }\n  }\n\n  if (result.joinPlans && result.joinPlans.length > 0) {\n    colorConsole.log(styleText(['blue', 'bold'], '\\n=== Join Plans: ===\\n'));\n    colorConsole.log(formatPlannerEvents(result.joinPlans));\n  }\n}\n\nfunction colorTime(duration: number) {\n  if (duration < 100) {\n    return styleText('green', duration.toFixed(2) + 'ms');\n  } else if (duration < 1000) {\n    return styleText('yellow', duration.toFixed(2) + 'ms');\n  }\n  return styleText('red', duration.toFixed(2) + 'ms');\n}\n\nfunction colorRowsConsidered(n: number) {\n  if (n < 1000) {\n    return styleText('green', n.toString());\n  } else if (n < 10000) {\n    return styleText('yellow', n.toString());\n  }\n  return styleText('red', n.toString());\n}\n\nfunction colorPlanRow(row: string, i: number) {\n  if (row.includes('SCAN')) {\n    if (i === 0) {\n      return styleText('yellow', row);\n    }\n    return styleText('red', row);\n  }\n  return styleText('green', row);\n}\n"],"mappings":";;;;;;;;;;;;;AA0BA,IAAM,UAAU;CACd,cAAc;EACZ,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM,CACJ,oDACA,wEACF;CACF;CACA,eAAe;EACb,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM,CACJ,kCACA,uEACF;CACF;CACA,WAAW;EACT,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM,CACJ,oCACA,8DACF;CACF;CACA,QAAQ;EACN,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM;GACJ;GACA;GACA;GACA;EACF;CACF;CACA,aAAa;EACX,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM;GACJ;GACA;GACA;EACF;CACF;CACA,QAAQ;EACN,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM,CACJ,4CACA,8BACF;CACF;CACA,KAAK;EACH,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM,CACJ,gFACA,oFACF;CACF;CACA,OAAO;EACL,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM,CACJ,0EACA,yDACF;CACF;CACA,WAAW;EACT,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM,CACJ,qDACA,uEACF;CACF;CACA,WAAW;EACT,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM,CACJ,qEACF;CACF;CACA,kBAAkB;EAChB,MAAM,eAAE,QAAQ,EAAE,QAAQ,KAAK;EAC/B,MAAM,CACJ,gEACA,iCACF;CACF;CACA,kBAAkB;EAChB,MAAM,eAAE,QAAQ,EAAE,QAAQ,KAAK;EAC/B,MAAM,CAAC,sDAAsD;CAC/D;CACA,WAAW;EACT,MAAM,eAAE,QAAQ,EAAE,QAAQ,KAAK;EAC/B,MAAM,CAAC,mCAAmC;CAC5C;CACA,KAAK;EACH,GAAG;EACH,OAAO,SAAS,QAAQ,OAAO;CACjC;AACF;AAUA,IAAM,gBAAgB,IAAI,QAAQ;CAChC,QAAQ,QAAQ;CAChB,QAAQ,QAAQ;AAClB,CAAC;AACD,IAAM,gBAAyB,EAC7B,IAAI,OAAO,SAAS,GAAG,MAAM;CAC3B,MAAM,MAAM,UACR,OAAO,QAAQ,OAAO,EAAE,KAAK,CAAC,GAAG,OAC/B,MAAM,KAAA,IAAY,IAAI,GAAG,EAAE,GAAG,GAChC,IACA,CAAC;CACL,cAAc,OAAO,GAAG,KAAK,GAAG,IAAI;AACtC,EACF;;;;;;;;;;;;;;;AAgBA,eAAsB,cAAc,MAAwC;CAK1E,MAAM,SAAS,aAAa,SAAS;EACnC,OALY,KAAK,QAAQ,QAAQ,KAAK,MAAM,CAAC,GAAG,KAAI,MACpD,EAAE,WAAW,MAAM,GAAG,CAItB;EACA,eAAe;EACf,aAAa,CACX;GACE,QAAQ;GACR,SAAS;;;;EAIX,GACA;GACE,QAAQ;GACR,SAAS;;;;;;;;;EASX,CACF;CACF,CAAC;CAED,IAAI,CAAC,OAAO,cAAc;EACxB,aAAa,MAAM,qDAAqD;EACxE,QAAQ,KAAK,CAAC;CAChB;CAEA,MAAM,OAAO,eAAe,MAAM;CAElC,MAAM,mBAAmB,wBAAwB,MAAM;CACvD,IAAI,OAAO,KAAK,gBAAgB,EAAE,SAAS,GACzC,2BAA2B,gBAAgB;CAM7C,WAAoC,YAAY;CAEhD,MAAM,IAAI,IAAI,KAAK;EACjB,QAAQ,KAAK;EACb,QAAQ,OAAO;EACf,MAAM,OAAO;EACb,QAAQ,OAAO;EACf,SAAS;EACT,UAAU,OAAO,IAAI;EACrB,SAAS;CACX,CAAC;CAED,IAAI;CACJ,IAAI;EAEF,IAAI,CAAC,MADgB,EAAE,UAAU,aAAa,OAAO,iBAAiB,EAAE,GAEtE,MAAM,IAAI,MACR,2DACF;EAGF,MAAM,aAAa;GACjB,YAAY,OAAO;GACnB,YAAY,OAAO;GACnB,WAAW,OAAO;EACpB;EAEA,IAAI,KAAK,SAAS,OAChB,SAAS,MAAM,EAAE,UAAU,iBAAiB,KAAK,KAAK,UAAU;OAC3D,IAAI,KAAK,SAAS,SACvB,SAAS,MAAM,EAAE,UAAU,kBACzB,KAAK,MACL,KAAK,MACL,UACF;OACK;GACL,MAAM,QAAQ,cAAc,KAAK,MAAM,cAAc,KAAK,MAAM,CAAC;GACjE,SAAS,MAAM,EAAE,UAAU,aAAa,OAAO,UAAU;EAC3D;CACF,SAAS,GAAG;EACV,aAAa,MAAM,aAAa,QAAQ,EAAE,UAAU,OAAO,CAAC,CAAC;EAC7D,MAAM,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC;EAC9B,QAAQ,KAAK,CAAC;CAChB;CAEA,aAAa,QAAQ;EACnB,kBAAkB,OAAO;EACzB,kBAAkB,OAAO;CAC3B,CAAC;CAED,MAAM,EAAE,MAAM;AAChB;AAEA,SAAS,eAAe,QAKV;CACZ,MAAM,YAAY;EAChB,OAAO,QAAQ,KAAA,KAAa;EAC5B,OAAO,UAAU,KAAA,KAAa;EAC9B,OAAO,cAAc,KAAA,KAAa;CACpC,EAAE,OAAO,OAAO;CAEhB,IAAI,UAAU,WAAW,GAAG;EAC1B,aAAa,MACX,4DACF;EACA,QAAQ,KAAK,CAAC;CAChB;CACA,IAAI,UAAU,SAAS,GAAG;EACxB,aAAa,MACX,oEAAoE,UAAU,KAAK,IAAI,GACzF;EACA,QAAQ,KAAK,CAAC;CAChB;CAEA,IAAI,OAAO,QAAQ,KAAA,GACjB,OAAO;EAAC,MAAM;EAAO,KAAK,KAAK,MAAM,OAAO,GAAG;CAAQ;CAEzD,IAAI,OAAO,UAAU,KAAA,GACnB,OAAO;EAAC,MAAM;EAAO,MAAM,OAAO;CAAK;CAEzC,MAAM,OAAO,OAAO,YACf,KAAK,MAAM,OAAO,SAAS,IAC5B,CAAC;CACL,OAAO;EAAC,MAAM;EAAS,MAAM,OAAO;EAAqB;CAAI;AAC/D;AAEA,SAAS,cACP,aACA,SACU;CAEV,OAAO,IADO,SAAS,WAAW,kBAAkB,YAAY,EACzD,EAAE,OAAO;AAClB;AAEA,SAAS,wBAAwB,QAGN;CACzB,MAAM,UAAkC,CAAC;CACzC,IAAI,OAAO,gBAAgB,KAAA,GAAW;EACpC,IAAI;EACJ,IAAI;GACF,SAAS,KAAK,MAAM,OAAO,WAAW;EACxC,SAAS,GAAG;GACV,aAAa,MACX,qCAAqC,aAAa,QAAQ,EAAE,UAAU,OAAO,CAAC,GAChF;GACA,QAAQ,KAAK,CAAC;EAChB;EACA,IACE,WAAW,QACX,OAAO,WAAW,YAClB,MAAM,QAAQ,MAAM,GACpB;GACA,aAAa,MAAM,uCAAuC;GAC1D,QAAQ,KAAK,CAAC;EAChB;EACA,KAAK,MAAM,CAAC,GAAG,QAAQ,OAAO,QAAQ,MAAM,GAAG;GAC7C,IAAI,OAAO,QAAQ,UAAU;IAC3B,aAAa,MACX,8CAA8C,OAAO,IAAI,QAAQ,EAAE,GACrE;IACA,QAAQ,KAAK,CAAC;GAChB;GACA,QAAQ,KAAK;EACf;CACF;CACA,IAAI,OAAO,WAAW,KAAA,GACpB,QAAQ,SAAS,OAAO;CAE1B,OAAO;AACT;AAEA,SAAS,2BAA2B,SAAuC;CACzE,MAAM,iCAAiC,UAAc;EACnD,YAAY,KAAmB,WAA+B;GAC5D,MAAM,KAAK,WAAW,EAAC,QAAO,CAAC;EACjC;CACF;CACA,WAAsC,YAAY;AACpD;AAEA,SAAS,aACP,QACA,MACA;CACA,IAAI,KAAK,kBAAkB;EACzB,aAAa,IAAI,UAAU,CAAC,QAAQ,MAAM,GAAG,wBAAwB,CAAC;EACtE,KAAK,MAAM,CAAC,OAAO,SAAS,OAAO,QAAQ,OAAO,cAAc,CAAC,CAAC,GAChE,aAAa,IAAI,UAAU,QAAQ,QAAQ,GAAG,GAAG,IAAI;CAEzD;CAEA,aAAa,IAAI,UAAU,CAAC,QAAQ,MAAM,GAAG,wBAAwB,CAAC;CACtE,aAAa,IACX,UAAU,QAAQ,oBAAoB,GACtC,OAAO,cACT;CAEA,MAAM,uBAAuB,OAAO,wBAAwB,CAAC;CAC7D,IAAI,gBAAgB;CACpB,KAAK,MAAM,SAAS,OAAO,KAAK,oBAAoB,EAAE,KAAK,GAAG;EAC5D,MAAM,SAAS,qBAAqB;EACpC,KAAK,MAAM,KAAK,OAAO,OAAO,MAAM,GAClC,iBAAiB;EAEnB,aAAa,IAAI,UAAU,QAAQ,GAAG,MAAM,SAAS,GAAG,MAAM;CAChE;CACA,aAAa,IACX,UAAU,QAAQ,sBAAsB,GACxC,oBAAoB,aAAa,CACnC;CACA,MAAM,WAAW,OAAO,WAAW,OAAO,MAAM,OAAO;CACvD,aAAa,IAAI,UAAU,QAAQ,OAAO,GAAG,UAAU,QAAQ,GAAG,IAAI;CAEtE,IAAI,KAAK,kBAAkB;EACzB,aAAa,IACX,UAAU,CAAC,QAAQ,MAAM,GAAG,+BAA+B,CAC7D;EACA,KAAK,MAAM,CAAC,OAAO,SAAS,OAAO,QAAQ,OAAO,YAAY,CAAC,CAAC,GAC9D,aAAa,IAAI,UAAU,QAAQ,GAAG,MAAM,EAAE,GAAG,IAAI;CAEzD;CAEA,aAAa,IACX,UAAU,CAAC,QAAQ,MAAM,GAAG,uCAAuC,CACrE;CACA,MAAM,iBAAiB,OAAO,kBAAkB,CAAC;CACjD,IAAI,cAAc;CAClB,KAAK,MAAM,CAAC,OAAO,YAAY,OAAO,QAAQ,cAAc,GAAG;EAC7D,aAAa,IAAI,UAAU,QAAQ,GAAG,MAAM,EAAE,GAAG,OAAO;EACxD,KAAK,MAAM,SAAS,OAAO,OAAO,OAAO,GACvC,eAAe;CAEnB;CACA,aAAa,IACX,UAAU,QAAQ,qBAAqB,GACvC,oBAAoB,WAAW,CACjC;CAEA,aAAa,IAAI,UAAU,CAAC,QAAQ,MAAM,GAAG,4BAA4B,CAAC;CAC1E,MAAM,QAAQ,OAAO,eAAe,CAAC;CACrC,KAAK,MAAM,CAAC,OAAO,SAAS,OAAO,QAAQ,KAAK,GAAG;EACjD,aAAa,IAAI,UAAU,QAAQ,OAAO,GAAG,KAAK;EAClD,aAAa,IAAI,KAAK,KAAK,KAAK,MAAM,aAAa,KAAK,CAAC,CAAC,EAAE,KAAK,IAAI,CAAC;EACtE,aAAa,IAAI,IAAI;CACvB;CAEA,IAAI,OAAO,SAAS,SAAS,GAAG;EAC9B,aAAa,IAAI,UAAU,CAAC,UAAU,MAAM,GAAG,qBAAqB,CAAC;EACrE,KAAK,MAAM,KAAK,OAAO,UACrB,aAAa,IAAI,UAAU,UAAU,CAAC,CAAC;CAE3C;CAEA,IAAI,OAAO,aAAa,OAAO,UAAU,SAAS,GAAG;EACnD,aAAa,IAAI,UAAU,CAAC,QAAQ,MAAM,GAAG,yBAAyB,CAAC;EACvE,aAAa,IAAI,oBAAoB,OAAO,SAAS,CAAC;CACxD;AACF;AAEA,SAAS,UAAU,UAAkB;CACnC,IAAI,WAAW,KACb,OAAO,UAAU,SAAS,SAAS,QAAQ,CAAC,IAAI,IAAI;MAC/C,IAAI,WAAW,KACpB,OAAO,UAAU,UAAU,SAAS,QAAQ,CAAC,IAAI,IAAI;CAEvD,OAAO,UAAU,OAAO,SAAS,QAAQ,CAAC,IAAI,IAAI;AACpD;AAEA,SAAS,oBAAoB,GAAW;CACtC,IAAI,IAAI,KACN,OAAO,UAAU,SAAS,EAAE,SAAS,CAAC;MACjC,IAAI,IAAI,KACb,OAAO,UAAU,UAAU,EAAE,SAAS,CAAC;CAEzC,OAAO,UAAU,OAAO,EAAE,SAAS,CAAC;AACtC;AAEA,SAAS,aAAa,KAAa,GAAW;CAC5C,IAAI,IAAI,SAAS,MAAM,GAAG;EACxB,IAAI,MAAM,GACR,OAAO,UAAU,UAAU,GAAG;EAEhC,OAAO,UAAU,OAAO,GAAG;CAC7B;CACA,OAAO,UAAU,SAAS,GAAG;AAC/B"}
+{"version":3,"file":"analyze-cli.js","names":[],"sources":["../../../../analyze-query/src/analyze-cli.ts"],"sourcesContent":["import '../../shared/src/dotenv.ts';\n\nimport {Console} from 'node:console';\nimport {styleText} from 'node:util';\nimport type {LogSink} from '@rocicorp/logger';\nimport {WebSocket as NodeWebSocket} from 'ws';\nimport {logLevel, logOptions} from '../../otel/src/log-options.ts';\nimport {colorConsole} from '../../shared/src/logging.ts';\nimport {parseOptions} from '../../shared/src/options.ts';\nimport * as v from '../../shared/src/valita.ts';\nimport {ZERO_ENV_VAR_PREFIX} from '../../zero-cache/src/config/zero-config.ts';\nimport {Zero} from '../../zero-client/src/client/zero.ts';\nimport type {AnalyzeQueryResult} from '../../zero-protocol/src/analyze-query-result.ts';\nimport type {AST} from '../../zero-protocol/src/ast.ts';\nimport type {Schema} from '../../zero-types/src/schema.ts';\nimport {formatPlannerEvents} from '../../zql/src/planner/planner-debug.ts';\nimport {createBuilder} from '../../zql/src/query/create-builder.ts';\nimport type {AnyQuery} from '../../zql/src/query/query.ts';\nimport type {SchemaQuery} from '../../zql/src/query/schema-query.ts';\n\nexport type AnalyzeCLIOptions = {\n  schema: Schema;\n  /** Defaults to `process.argv.slice(2)`. */\n  argv?: readonly string[] | undefined;\n};\n\nconst options = {\n  zeroCacheURL: {\n    type: v.string().optional(),\n    desc: [\n      'URL of the remote zero-cache to analyze against.',\n      'Accepts http(s):// or ws(s):// (ws(s) is the transport actually used).',\n    ],\n  },\n  adminPassword: {\n    type: v.string().optional(),\n    desc: [\n      'Admin password for zero-cache.',\n      'Required when the server is configured with one; ignored in dev mode.',\n    ],\n  },\n  authToken: {\n    type: v.string().optional(),\n    desc: [\n      'Raw JWT forwarded to zero-cache.',\n      'Used server-side to fill permission variables for the query.',\n    ],\n  },\n  cookie: {\n    type: v.string().optional(),\n    desc: [\n      'Cookie header value sent on the WebSocket upgrade request,',\n      'e.g. `session=abc; foo=bar`. Use this when zero-cache is behind',\n      'a proxy that resolves auth via cookies. Merged with --headers-json',\n      '(--cookie wins on conflict).',\n    ],\n  },\n  headersJson: {\n    type: v.string().optional(),\n    desc: [\n      'JSON object of arbitrary headers to send on the WebSocket upgrade',\n      'request, e.g. `{\"x-api-key\":\"...\"}`. Escape hatch for exotic auth',\n      'schemes; prefer --auth-token or --cookie when possible.',\n    ],\n  },\n  userId: {\n    type: v.string().optional(),\n    desc: [\n      'Optional userID to report to zero-cache.',\n      'Omit for anonymous analysis.',\n    ],\n  },\n  ast: {\n    type: v.string().optional(),\n    desc: [\n      'JSON-encoded AST. Exactly one of --ast / --query / --query-name is required.',\n      'The AST is sent to the server verbatim — provide it in server (post-mapping) form.',\n    ],\n  },\n  query: {\n    type: v.string().optional(),\n    desc: [\n      'ZQL query in chain form, e.g. `issue.related(\"comments\").limit(10)`.',\n      'Evaluated against the schema you pass to runAnalyzeCLI.',\n    ],\n  },\n  queryName: {\n    type: v.string().optional(),\n    desc: [\n      'Name of a server-registered custom (named) query.',\n      'The server resolves the name + args via its registered query handler.',\n    ],\n  },\n  queryArgs: {\n    type: v.string().optional(),\n    desc: [\n      'JSON-encoded array of arguments for --query-name. Defaults to `[]`.',\n    ],\n  },\n  outputVendedRows: {\n    type: v.boolean().optional(() => false),\n    desc: [\n      'Include the rows read from the replica to execute the query.',\n      'Each row appears once per read.',\n    ],\n  },\n  outputSyncedRows: {\n    type: v.boolean().optional(() => false),\n    desc: ['Include the rows that would be synced to the client.'],\n  },\n  joinPlans: {\n    type: v.boolean().optional(() => false),\n    desc: ['Include join planner diagnostics.'],\n  },\n  log: {\n    ...logOptions,\n    level: logLevel.optional(() => 'error'),\n  },\n};\n\ntype QueryPlan =\n  | {kind: 'ast'; ast: AST}\n  | {kind: 'zql'; text: string}\n  | {kind: 'named'; name: string; args: ReadonlyArray<unknown>};\n\n// Route all Zero client log output to stderr so stdout contains only the\n// analyze result. Shell redirection (`2>/dev/null`) can then cleanly silence\n// logs without affecting output.\nconst stderrConsole = new Console({\n  stdout: process.stderr,\n  stderr: process.stderr,\n});\nconst stderrLogSink: LogSink = {\n  log(level, context, ...args) {\n    const ctx = context\n      ? Object.entries(context).map(([k, v]) =>\n          v === undefined ? k : `${k}=${v}`,\n        )\n      : [];\n    stderrConsole[level](...ctx, ...args);\n  },\n};\n\n/**\n * Entry point for a user's `cli.ts`. Parses argv, connects to a remote\n * zero-cache by standing up an in-process Zero client (in-memory storage,\n * no subscriptions), calls the inspector's `analyze-query` RPC, and\n * renders the result. Intended to be called as:\n *\n * ```ts\n * import {schema} from './schema.ts';\n * import {runAnalyzeCLI} from '@rocicorp/zero/analyze';\n * await runAnalyzeCLI({schema});\n * ```\n *\n * Exits the process with code 1 on error.\n */\nexport async function runAnalyzeCLI(opts: AnalyzeCLIOptions): Promise<void> {\n  const argv = (opts.argv ?? process.argv.slice(2)).map(s =>\n    s.replaceAll('\\n', ' '),\n  );\n\n  const config = parseOptions(options, {\n    argv,\n    envNamePrefix: ZERO_ENV_VAR_PREFIX,\n    description: [\n      {\n        header: 'analyze-query (remote)',\n        content: `Analyze a ZQL query against a remote zero-cache.\n\n  Connects to zero-cache's inspector protocol and reports the server-observed\n  row scans, SQLite query plans, and timings.`,\n      },\n      {\n        header: 'Examples',\n        content: `  node cli.ts --zero-cache-url=https://zero.example.com \\\\\n    --admin-password=\"$ZERO_ADMIN_PASSWORD\" \\\\\n    --query='issue.related(\"comments\").limit(10)'\n\n  node cli.ts --zero-cache-url=http://localhost:4848 \\\\\n    --ast='\\\\{\"table\": \"issue\", \"limit\": 5\\\\}'\n\n  node cli.ts --zero-cache-url=http://localhost:4848 \\\\\n    --query-name=issueList --query-args='[]'`,\n      },\n    ],\n  });\n\n  if (!config.zeroCacheURL) {\n    colorConsole.error('--zero-cache-url is required. See --help for usage.');\n    process.exit(1);\n  }\n\n  const plan = buildQueryPlan(config);\n\n  const handshakeHeaders = resolveHandshakeHeaders(config);\n  if (Object.keys(handshakeHeaders).length > 0) {\n    installWebSocketHeaderShim(handshakeHeaders);\n  }\n\n  // zero-client and replicache reference a build-time `TESTING` global that\n  // bundlers replace with a boolean literal; under node there's no replacement,\n  // so provide a runtime default.\n  (globalThis as {TESTING?: boolean}).TESTING ??= false;\n\n  const z = new Zero({\n    schema: opts.schema,\n    server: config.zeroCacheURL,\n    auth: config.authToken,\n    userID: config.userId,\n    kvStore: 'mem',\n    logLevel: config.log.level,\n    logSink: stderrLogSink,\n  });\n\n  let result: AnalyzeQueryResult;\n  try {\n    const authOk = await z.inspector.authenticate(config.adminPassword ?? '');\n    if (!authOk) {\n      throw new Error(\n        'admin password rejected (or --admin-password is required)',\n      );\n    }\n\n    const rpcOptions = {\n      vendedRows: config.outputVendedRows,\n      syncedRows: config.outputSyncedRows,\n      joinPlans: config.joinPlans,\n    };\n\n    if (plan.kind === 'ast') {\n      result = await z.inspector.analyzeServerAST(plan.ast, rpcOptions);\n    } else if (plan.kind === 'named') {\n      result = await z.inspector.analyzeNamedQuery(\n        plan.name,\n        plan.args as ReadonlyArray<never>,\n        rpcOptions,\n      );\n    } else {\n      const built = buildZqlQuery(plan.text, createBuilder(opts.schema));\n      result = await z.inspector.analyzeQuery(built, rpcOptions);\n    }\n  } catch (e) {\n    colorConsole.error(e instanceof Error ? e.message : String(e));\n    await z.close().catch(() => {});\n    process.exit(1);\n  }\n\n  renderResult(result, {\n    outputSyncedRows: config.outputSyncedRows,\n    outputVendedRows: config.outputVendedRows,\n  });\n\n  await z.close();\n}\n\nfunction buildQueryPlan(config: {\n  ast?: string | undefined;\n  query?: string | undefined;\n  queryName?: string | undefined;\n  queryArgs?: string | undefined;\n}): QueryPlan {\n  const selectors = [\n    config.ast !== undefined && 'ast',\n    config.query !== undefined && 'query',\n    config.queryName !== undefined && 'queryName',\n  ].filter(Boolean) as string[];\n\n  if (selectors.length === 0) {\n    colorConsole.error(\n      'Exactly one of --ast / --query / --query-name is required.',\n    );\n    process.exit(1);\n  }\n  if (selectors.length > 1) {\n    colorConsole.error(\n      `Only one of --ast / --query / --query-name may be provided; got: ${selectors.join(', ')}`,\n    );\n    process.exit(1);\n  }\n\n  if (config.ast !== undefined) {\n    return {kind: 'ast', ast: JSON.parse(config.ast) as AST};\n  }\n  if (config.query !== undefined) {\n    return {kind: 'zql', text: config.query};\n  }\n  const args = config.queryArgs\n    ? (JSON.parse(config.queryArgs) as ReadonlyArray<unknown>)\n    : [];\n  return {kind: 'named', name: config.queryName as string, args};\n}\n\nfunction buildZqlQuery(\n  queryString: string,\n  builder: SchemaQuery<Schema>,\n): AnyQuery {\n  const f = new Function('builder', `return builder.${queryString};`);\n  return f(builder) as AnyQuery;\n}\n\nfunction resolveHandshakeHeaders(config: {\n  cookie?: string | undefined;\n  headersJson?: string | undefined;\n}): Record<string, string> {\n  const headers: Record<string, string> = {};\n  if (config.headersJson !== undefined) {\n    let parsed: unknown;\n    try {\n      parsed = JSON.parse(config.headersJson);\n    } catch (e) {\n      colorConsole.error(\n        `--headers-json is not valid JSON: ${e instanceof Error ? e.message : String(e)}`,\n      );\n      process.exit(1);\n    }\n    if (\n      parsed === null ||\n      typeof parsed !== 'object' ||\n      Array.isArray(parsed)\n    ) {\n      colorConsole.error('--headers-json must be a JSON object.');\n      process.exit(1);\n    }\n    for (const [k, val] of Object.entries(parsed)) {\n      if (typeof val !== 'string') {\n        colorConsole.error(\n          `--headers-json values must be strings; got ${typeof val} for \"${k}\".`,\n        );\n        process.exit(1);\n      }\n      headers[k] = val;\n    }\n  }\n  if (config.cookie !== undefined) {\n    headers.cookie = config.cookie;\n  }\n  return headers;\n}\n\nfunction installWebSocketHeaderShim(headers: Record<string, string>): void {\n  class HeaderInjectingWebSocket extends NodeWebSocket {\n    constructor(url: string | URL, protocols?: string | string[]) {\n      super(url, protocols, {headers});\n    }\n  }\n  (globalThis as {WebSocket?: unknown}).WebSocket = HeaderInjectingWebSocket;\n}\n\nfunction renderResult(\n  result: AnalyzeQueryResult,\n  opts: {outputSyncedRows: boolean; outputVendedRows: boolean},\n) {\n  if (opts.outputSyncedRows) {\n    colorConsole.log(styleText(['blue', 'bold'], '=== Synced Rows: ===\\n'));\n    for (const [table, rows] of Object.entries(result.syncedRows ?? {})) {\n      colorConsole.log(styleText('bold', table + ':'), rows);\n    }\n  }\n\n  colorConsole.log(styleText(['blue', 'bold'], '=== Query Stats: ===\\n'));\n  colorConsole.log(\n    styleText('bold', 'total synced rows:'),\n    result.syncedRowCount,\n  );\n\n  const readRowCountsByQuery = result.readRowCountsByQuery ?? {};\n  let totalRowsRead = 0;\n  for (const table of Object.keys(readRowCountsByQuery).sort()) {\n    const counts = readRowCountsByQuery[table];\n    for (const n of Object.values(counts)) {\n      totalRowsRead += n;\n    }\n    colorConsole.log(styleText('bold', `${table} vended:`), counts);\n  }\n  colorConsole.log(\n    styleText('bold', 'Rows Read (into JS):'),\n    colorRowsConsidered(totalRowsRead),\n  );\n  const duration = result.elapsed ?? result.end - result.start;\n  colorConsole.log(styleText('bold', 'time:'), colorTime(duration), 'ms');\n\n  if (opts.outputVendedRows) {\n    colorConsole.log(\n      styleText(['blue', 'bold'], '=== JS Row Scan Values: ===\\n'),\n    );\n    for (const [table, rows] of Object.entries(result.readRows ?? {})) {\n      colorConsole.log(styleText('bold', `${table}:`), rows);\n    }\n  }\n\n  colorConsole.log(\n    styleText(['blue', 'bold'], '\\n=== Rows Scanned (by SQLite): ===\\n'),\n  );\n  const dbScansByQuery = result.dbScansByQuery ?? {};\n  let totalNVisit = 0;\n  for (const [table, queries] of Object.entries(dbScansByQuery)) {\n    colorConsole.log(styleText('bold', `${table}:`), queries);\n    for (const count of Object.values(queries)) {\n      totalNVisit += count;\n    }\n  }\n  colorConsole.log(\n    styleText('bold', 'total rows scanned:'),\n    colorRowsConsidered(totalNVisit),\n  );\n\n  colorConsole.log(styleText(['blue', 'bold'], '\\n\\n=== Query Plans: ===\\n'));\n  const plans = result.sqlitePlans ?? {};\n  for (const [query, plan] of Object.entries(plans)) {\n    colorConsole.log(styleText('bold', 'query'), query);\n    colorConsole.log(plan.map((row, i) => colorPlanRow(row, i)).join('\\n'));\n    colorConsole.log('\\n');\n  }\n\n  if (result.warnings.length > 0) {\n    colorConsole.log(styleText(['yellow', 'bold'], '=== Warnings: ===\\n'));\n    for (const w of result.warnings) {\n      colorConsole.log(styleText('yellow', w));\n    }\n  }\n\n  if (result.joinPlans && result.joinPlans.length > 0) {\n    colorConsole.log(styleText(['blue', 'bold'], '\\n=== Join Plans: ===\\n'));\n    colorConsole.log(formatPlannerEvents(result.joinPlans));\n  }\n}\n\nfunction colorTime(duration: number) {\n  if (duration < 100) {\n    return styleText('green', duration.toFixed(2) + 'ms');\n  } else if (duration < 1000) {\n    return styleText('yellow', duration.toFixed(2) + 'ms');\n  }\n  return styleText('red', duration.toFixed(2) + 'ms');\n}\n\nfunction colorRowsConsidered(n: number) {\n  if (n < 1000) {\n    return styleText('green', n.toString());\n  } else if (n < 10000) {\n    return styleText('yellow', n.toString());\n  }\n  return styleText('red', n.toString());\n}\n\nfunction colorPlanRow(row: string, i: number) {\n  if (row.includes('SCAN')) {\n    if (i === 0) {\n      return styleText('yellow', row);\n    }\n    return styleText('red', row);\n  }\n  return styleText('green', row);\n}\n"],"mappings":";;;;;;;;;;;;;AA0BA,IAAM,UAAU;CACd,cAAc;EACZ,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM,CACJ,oDACA,wEACF;CACF;CACA,eAAe;EACb,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM,CACJ,kCACA,uEACF;CACF;CACA,WAAW;EACT,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM,CACJ,oCACA,8DACF;CACF;CACA,QAAQ;EACN,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM;GACJ;GACA;GACA;GACA;EACF;CACF;CACA,aAAa;EACX,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM;GACJ;GACA;GACA;EACF;CACF;CACA,QAAQ;EACN,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM,CACJ,4CACA,8BACF;CACF;CACA,KAAK;EACH,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM,CACJ,gFACA,oFACF;CACF;CACA,OAAO;EACL,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM,CACJ,0EACA,yDACF;CACF;CACA,WAAW;EACT,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM,CACJ,qDACA,uEACF;CACF;CACA,WAAW;EACT,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM,CACJ,qEACF;CACF;CACA,kBAAkB;EAChB,MAAM,eAAE,QAAQ,EAAE,eAAe,KAAK;EACtC,MAAM,CACJ,gEACA,iCACF;CACF;CACA,kBAAkB;EAChB,MAAM,eAAE,QAAQ,EAAE,eAAe,KAAK;EACtC,MAAM,CAAC,sDAAsD;CAC/D;CACA,WAAW;EACT,MAAM,eAAE,QAAQ,EAAE,eAAe,KAAK;EACtC,MAAM,CAAC,mCAAmC;CAC5C;CACA,KAAK;EACH,GAAG;EACH,OAAO,SAAS,eAAe,OAAO;CACxC;AACF;AAUA,IAAM,gBAAgB,IAAI,QAAQ;CAChC,QAAQ,QAAQ;CAChB,QAAQ,QAAQ;AAClB,CAAC;AACD,IAAM,gBAAyB,EAC7B,IAAI,OAAO,SAAS,GAAG,MAAM;CAC3B,MAAM,MAAM,UACR,OAAO,QAAQ,OAAO,EAAE,KAAK,CAAC,GAAG,OAC/B,MAAM,KAAA,IAAY,IAAI,GAAG,EAAE,GAAG,GAChC,IACA,CAAC;CACL,cAAc,OAAO,GAAG,KAAK,GAAG,IAAI;AACtC,EACF;;;;;;;;;;;;;;;AAgBA,eAAsB,cAAc,MAAwC;CAK1E,MAAM,SAAS,aAAa,SAAS;EACnC,OALY,KAAK,QAAQ,QAAQ,KAAK,MAAM,CAAC,GAAG,KAAI,MACpD,EAAE,WAAW,MAAM,GAAG,CAItB;EACA,eAAe;EACf,aAAa,CACX;GACE,QAAQ;GACR,SAAS;;;;EAIX,GACA;GACE,QAAQ;GACR,SAAS;;;;;;;;;EASX,CACF;CACF,CAAC;CAED,IAAI,CAAC,OAAO,cAAc;EACxB,aAAa,MAAM,qDAAqD;EACxE,QAAQ,KAAK,CAAC;CAChB;CAEA,MAAM,OAAO,eAAe,MAAM;CAElC,MAAM,mBAAmB,wBAAwB,MAAM;CACvD,IAAI,OAAO,KAAK,gBAAgB,EAAE,SAAS,GACzC,2BAA2B,gBAAgB;CAM7C,WAAoC,YAAY;CAEhD,MAAM,IAAI,IAAI,KAAK;EACjB,QAAQ,KAAK;EACb,QAAQ,OAAO;EACf,MAAM,OAAO;EACb,QAAQ,OAAO;EACf,SAAS;EACT,UAAU,OAAO,IAAI;EACrB,SAAS;CACX,CAAC;CAED,IAAI;CACJ,IAAI;EAEF,IAAI,CAAC,MADgB,EAAE,UAAU,aAAa,OAAO,iBAAiB,EAAE,GAEtE,MAAM,IAAI,MACR,2DACF;EAGF,MAAM,aAAa;GACjB,YAAY,OAAO;GACnB,YAAY,OAAO;GACnB,WAAW,OAAO;EACpB;EAEA,IAAI,KAAK,SAAS,OAChB,SAAS,MAAM,EAAE,UAAU,iBAAiB,KAAK,KAAK,UAAU;OAC3D,IAAI,KAAK,SAAS,SACvB,SAAS,MAAM,EAAE,UAAU,kBACzB,KAAK,MACL,KAAK,MACL,UACF;OACK;GACL,MAAM,QAAQ,cAAc,KAAK,MAAM,cAAc,KAAK,MAAM,CAAC;GACjE,SAAS,MAAM,EAAE,UAAU,aAAa,OAAO,UAAU;EAC3D;CACF,SAAS,GAAG;EACV,aAAa,MAAM,aAAa,QAAQ,EAAE,UAAU,OAAO,CAAC,CAAC;EAC7D,MAAM,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC;EAC9B,QAAQ,KAAK,CAAC;CAChB;CAEA,aAAa,QAAQ;EACnB,kBAAkB,OAAO;EACzB,kBAAkB,OAAO;CAC3B,CAAC;CAED,MAAM,EAAE,MAAM;AAChB;AAEA,SAAS,eAAe,QAKV;CACZ,MAAM,YAAY;EAChB,OAAO,QAAQ,KAAA,KAAa;EAC5B,OAAO,UAAU,KAAA,KAAa;EAC9B,OAAO,cAAc,KAAA,KAAa;CACpC,EAAE,OAAO,OAAO;CAEhB,IAAI,UAAU,WAAW,GAAG;EAC1B,aAAa,MACX,4DACF;EACA,QAAQ,KAAK,CAAC;CAChB;CACA,IAAI,UAAU,SAAS,GAAG;EACxB,aAAa,MACX,oEAAoE,UAAU,KAAK,IAAI,GACzF;EACA,QAAQ,KAAK,CAAC;CAChB;CAEA,IAAI,OAAO,QAAQ,KAAA,GACjB,OAAO;EAAC,MAAM;EAAO,KAAK,KAAK,MAAM,OAAO,GAAG;CAAQ;CAEzD,IAAI,OAAO,UAAU,KAAA,GACnB,OAAO;EAAC,MAAM;EAAO,MAAM,OAAO;CAAK;CAEzC,MAAM,OAAO,OAAO,YACf,KAAK,MAAM,OAAO,SAAS,IAC5B,CAAC;CACL,OAAO;EAAC,MAAM;EAAS,MAAM,OAAO;EAAqB;CAAI;AAC/D;AAEA,SAAS,cACP,aACA,SACU;CAEV,OAAO,IADO,SAAS,WAAW,kBAAkB,YAAY,EACzD,EAAE,OAAO;AAClB;AAEA,SAAS,wBAAwB,QAGN;CACzB,MAAM,UAAkC,CAAC;CACzC,IAAI,OAAO,gBAAgB,KAAA,GAAW;EACpC,IAAI;EACJ,IAAI;GACF,SAAS,KAAK,MAAM,OAAO,WAAW;EACxC,SAAS,GAAG;GACV,aAAa,MACX,qCAAqC,aAAa,QAAQ,EAAE,UAAU,OAAO,CAAC,GAChF;GACA,QAAQ,KAAK,CAAC;EAChB;EACA,IACE,WAAW,QACX,OAAO,WAAW,YAClB,MAAM,QAAQ,MAAM,GACpB;GACA,aAAa,MAAM,uCAAuC;GAC1D,QAAQ,KAAK,CAAC;EAChB;EACA,KAAK,MAAM,CAAC,GAAG,QAAQ,OAAO,QAAQ,MAAM,GAAG;GAC7C,IAAI,OAAO,QAAQ,UAAU;IAC3B,aAAa,MACX,8CAA8C,OAAO,IAAI,QAAQ,EAAE,GACrE;IACA,QAAQ,KAAK,CAAC;GAChB;GACA,QAAQ,KAAK;EACf;CACF;CACA,IAAI,OAAO,WAAW,KAAA,GACpB,QAAQ,SAAS,OAAO;CAE1B,OAAO;AACT;AAEA,SAAS,2BAA2B,SAAuC;CACzE,MAAM,iCAAiC,UAAc;EACnD,YAAY,KAAmB,WAA+B;GAC5D,MAAM,KAAK,WAAW,EAAC,QAAO,CAAC;EACjC;CACF;CACA,WAAsC,YAAY;AACpD;AAEA,SAAS,aACP,QACA,MACA;CACA,IAAI,KAAK,kBAAkB;EACzB,aAAa,IAAI,UAAU,CAAC,QAAQ,MAAM,GAAG,wBAAwB,CAAC;EACtE,KAAK,MAAM,CAAC,OAAO,SAAS,OAAO,QAAQ,OAAO,cAAc,CAAC,CAAC,GAChE,aAAa,IAAI,UAAU,QAAQ,QAAQ,GAAG,GAAG,IAAI;CAEzD;CAEA,aAAa,IAAI,UAAU,CAAC,QAAQ,MAAM,GAAG,wBAAwB,CAAC;CACtE,aAAa,IACX,UAAU,QAAQ,oBAAoB,GACtC,OAAO,cACT;CAEA,MAAM,uBAAuB,OAAO,wBAAwB,CAAC;CAC7D,IAAI,gBAAgB;CACpB,KAAK,MAAM,SAAS,OAAO,KAAK,oBAAoB,EAAE,KAAK,GAAG;EAC5D,MAAM,SAAS,qBAAqB;EACpC,KAAK,MAAM,KAAK,OAAO,OAAO,MAAM,GAClC,iBAAiB;EAEnB,aAAa,IAAI,UAAU,QAAQ,GAAG,MAAM,SAAS,GAAG,MAAM;CAChE;CACA,aAAa,IACX,UAAU,QAAQ,sBAAsB,GACxC,oBAAoB,aAAa,CACnC;CACA,MAAM,WAAW,OAAO,WAAW,OAAO,MAAM,OAAO;CACvD,aAAa,IAAI,UAAU,QAAQ,OAAO,GAAG,UAAU,QAAQ,GAAG,IAAI;CAEtE,IAAI,KAAK,kBAAkB;EACzB,aAAa,IACX,UAAU,CAAC,QAAQ,MAAM,GAAG,+BAA+B,CAC7D;EACA,KAAK,MAAM,CAAC,OAAO,SAAS,OAAO,QAAQ,OAAO,YAAY,CAAC,CAAC,GAC9D,aAAa,IAAI,UAAU,QAAQ,GAAG,MAAM,EAAE,GAAG,IAAI;CAEzD;CAEA,aAAa,IACX,UAAU,CAAC,QAAQ,MAAM,GAAG,uCAAuC,CACrE;CACA,MAAM,iBAAiB,OAAO,kBAAkB,CAAC;CACjD,IAAI,cAAc;CAClB,KAAK,MAAM,CAAC,OAAO,YAAY,OAAO,QAAQ,cAAc,GAAG;EAC7D,aAAa,IAAI,UAAU,QAAQ,GAAG,MAAM,EAAE,GAAG,OAAO;EACxD,KAAK,MAAM,SAAS,OAAO,OAAO,OAAO,GACvC,eAAe;CAEnB;CACA,aAAa,IACX,UAAU,QAAQ,qBAAqB,GACvC,oBAAoB,WAAW,CACjC;CAEA,aAAa,IAAI,UAAU,CAAC,QAAQ,MAAM,GAAG,4BAA4B,CAAC;CAC1E,MAAM,QAAQ,OAAO,eAAe,CAAC;CACrC,KAAK,MAAM,CAAC,OAAO,SAAS,OAAO,QAAQ,KAAK,GAAG;EACjD,aAAa,IAAI,UAAU,QAAQ,OAAO,GAAG,KAAK;EAClD,aAAa,IAAI,KAAK,KAAK,KAAK,MAAM,aAAa,KAAK,CAAC,CAAC,EAAE,KAAK,IAAI,CAAC;EACtE,aAAa,IAAI,IAAI;CACvB;CAEA,IAAI,OAAO,SAAS,SAAS,GAAG;EAC9B,aAAa,IAAI,UAAU,CAAC,UAAU,MAAM,GAAG,qBAAqB,CAAC;EACrE,KAAK,MAAM,KAAK,OAAO,UACrB,aAAa,IAAI,UAAU,UAAU,CAAC,CAAC;CAE3C;CAEA,IAAI,OAAO,aAAa,OAAO,UAAU,SAAS,GAAG;EACnD,aAAa,IAAI,UAAU,CAAC,QAAQ,MAAM,GAAG,yBAAyB,CAAC;EACvE,aAAa,IAAI,oBAAoB,OAAO,SAAS,CAAC;CACxD;AACF;AAEA,SAAS,UAAU,UAAkB;CACnC,IAAI,WAAW,KACb,OAAO,UAAU,SAAS,SAAS,QAAQ,CAAC,IAAI,IAAI;MAC/C,IAAI,WAAW,KACpB,OAAO,UAAU,UAAU,SAAS,QAAQ,CAAC,IAAI,IAAI;CAEvD,OAAO,UAAU,OAAO,SAAS,QAAQ,CAAC,IAAI,IAAI;AACpD;AAEA,SAAS,oBAAoB,GAAW;CACtC,IAAI,IAAI,KACN,OAAO,UAAU,SAAS,EAAE,SAAS,CAAC;MACjC,IAAI,IAAI,KACb,OAAO,UAAU,UAAU,EAAE,SAAS,CAAC;CAEzC,OAAO,UAAU,OAAO,EAAE,SAAS,CAAC;AACtC;AAEA,SAAS,aAAa,KAAa,GAAW;CAC5C,IAAI,IAAI,SAAS,MAAM,GAAG;EACxB,IAAI,MAAM,GACR,OAAO,UAAU,UAAU,GAAG;EAEhC,OAAO,UAAU,OAAO,GAAG;CAC7B;CACA,OAAO,UAAU,SAAS,GAAG;AAC/B"}

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

@@ -51,7 +51,7 @@ var cfg = parseOptions({
 		]
 	},
 	applyPermissions: {
-		type: valita_exports.boolean().default(false),
+		type: valita_exports.boolean().optional(() => false),
 		desc: ["Whether to apply permissions (from your schema file) to the provided query."]
 	},
 	authData: {
@@ -59,11 +59,11 @@ var cfg = parseOptions({
 		desc: ["JSON encoded payload of the auth data.", "This will be used to fill permission variables if the \"applyPermissions\" option is set"]
 	},
 	outputVendedRows: {
-		type: valita_exports.boolean().default(false),
+		type: valita_exports.boolean().optional(() => false),
 		desc: ["Whether to output the rows which were read from the replica in order to execute the analyzed query. ", "If the same row is read more than once it will be logged once for each time it was read."]
 	},
 	outputSyncedRows: {
-		type: valita_exports.boolean().default(false),
+		type: valita_exports.boolean().optional(() => false),
 		desc: ["Whether to output the rows which would be synced to the client for the analyzed query."]
 	},
 	cvr: { db: {
@@ -82,7 +82,7 @@ var cfg = parseOptions({
 	enableCorrelatedPredicatePushdown: zeroOptions.enableCorrelatedPredicatePushdown,
 	log: {
 		...logOptions,
-		level: logLevel.default("error")
+		level: logLevel.optional(() => "error")
 	}
 }, {
 	argv: process.argv.slice(2).map((s) => s.replaceAll("\n", " ")),

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

@@ -1 +1 @@
-{"version":3,"file":"bin-analyze.js","names":[],"sources":["../../../../analyze-query/src/bin-analyze.ts"],"sourcesContent":["import '../../shared/src/dotenv.ts';\n\nimport fs from 'node:fs';\nimport {styleText} from 'node:util';\nimport {astToZQL} from '../../ast-to-zql/src/ast-to-zql.ts';\nimport {formatOutput} from '../../ast-to-zql/src/format.ts';\nimport {logLevel, logOptions} from '../../otel/src/log-options.ts';\nimport {colorConsole, createLogContext} from '../../shared/src/logging.ts';\nimport {getOrInsertComputed} from '../../shared/src/map.ts';\nimport {must} from '../../shared/src/must.ts';\nimport {parseOptions} from '../../shared/src/options.ts';\nimport * as v from '../../shared/src/valita.ts';\nimport {\n  appOptions,\n  shardOptions,\n  ZERO_ENV_VAR_PREFIX,\n  zeroOptions,\n} from '../../zero-cache/src/config/zero-config.ts';\nimport {\n  computeZqlSpecs,\n  mustGetTableSpec,\n} from '../../zero-cache/src/db/lite-tables.ts';\nimport {\n  deployPermissionsOptions,\n  loadSchemaAndPermissions,\n} from '../../zero-cache/src/scripts/permissions.ts';\nimport {runAst} from '../../zero-cache/src/services/run-ast.ts';\nimport {pgClient} from '../../zero-cache/src/types/pg.ts';\nimport {getShardID, upstreamSchema} from '../../zero-cache/src/types/shards.ts';\nimport type {AnalyzeQueryResult} from '../../zero-protocol/src/analyze-query-result.ts';\nimport {type AST} from '../../zero-protocol/src/ast.ts';\nimport {clientSchemaFrom} from '../../zero-schema/src/builder/schema-builder.ts';\nimport {clientToServer} from '../../zero-schema/src/name-mapper.ts';\nimport type {Schema} from '../../zero-types/src/schema.ts';\nimport {\n  Debug,\n  runtimeDebugFlags,\n} from '../../zql/src/builder/debug-delegate.ts';\nimport type {Source} from '../../zql/src/ivm/source.ts';\nimport {QueryDelegateBase} from '../../zql/src/query/query-delegate-base.ts';\nimport {newQuery} from '../../zql/src/query/query-impl.ts';\nimport {asQueryInternals} from '../../zql/src/query/query-internals.ts';\nimport {type PullRow, type Query} from '../../zql/src/query/query.ts';\nimport {Database} from '../../zqlite/src/db.ts';\nimport {explainQueries} from '../../zqlite/src/explain-queries.ts';\nimport {TableSource} from '../../zqlite/src/table-source.ts';\n\nconst options = {\n  schema: deployPermissionsOptions.schema,\n  replicaFile: {\n    ...zeroOptions.replica.file,\n    desc: ['File path to the SQLite replica to test queries against.'],\n  },\n  ast: {\n    type: v.string().optional(),\n    desc: [\n      'AST for the query to be analyzed.  Only one of ast/query/hash should be provided.',\n    ],\n  },\n  query: {\n    type: v.string().optional(),\n    desc: [\n      'Query to be analyzed in the form of: table.where(...).related(...).etc. ',\n      'Only one of ast/query/hash should be provided.',\n    ],\n  },\n  hash: {\n    type: v.string().optional(),\n    desc: [\n      'Hash of the query to be analyzed. This is used to look up the query in the database. ',\n      'Only one of ast/query/hash should be provided.',\n      'You should run this script from the directory containing your .env file to reduce the amount of',\n      'configuration required. The .env file should contain the connection URL to the CVR database.',\n    ],\n  },\n  applyPermissions: {\n    type: v.boolean().default(false),\n    desc: [\n      'Whether to apply permissions (from your schema file) to the provided query.',\n    ],\n  },\n  authData: {\n    type: v.string().optional(),\n    desc: [\n      'JSON encoded payload of the auth data.',\n      'This will be used to fill permission variables if the \"applyPermissions\" option is set',\n    ],\n  },\n  outputVendedRows: {\n    type: v.boolean().default(false),\n    desc: [\n      'Whether to output the rows which were read from the replica in order to execute the analyzed query. ',\n      'If the same row is read more than once it will be logged once for each time it was read.',\n    ],\n  },\n  outputSyncedRows: {\n    type: v.boolean().default(false),\n    desc: [\n      'Whether to output the rows which would be synced to the client for the analyzed query.',\n    ],\n  },\n  cvr: {\n    db: {\n      type: v.string().optional(),\n      desc: [\n        'Connection URL to the CVR database. If using --hash, either this or --upstream-db',\n        'must be specified.',\n      ],\n    },\n  },\n  upstream: {\n    db: {\n      desc: [\n        `Connection URL to the \"upstream\" authoritative postgres database. If using --hash, `,\n        'either this or --cvr-db must be specified.',\n      ],\n      type: v.string().optional(),\n    },\n    type: zeroOptions.upstream.type,\n  },\n  app: appOptions,\n  shard: shardOptions,\n  // Read from the same env var as zero-cache, so the analysis matches what\n  // the server runs.\n  enableCorrelatedPredicatePushdown:\n    zeroOptions.enableCorrelatedPredicatePushdown,\n  log: {\n    ...logOptions,\n    level: logLevel.default('error'),\n  },\n};\n\nconst cfg = parseOptions(options, {\n  argv: process.argv.slice(2).map(s => s.replaceAll('\\n', ' ')),\n  envNamePrefix: ZERO_ENV_VAR_PREFIX,\n  description: [\n    {\n      header: 'analyze-query',\n      content: `Analyze a ZQL query and show information about how it runs against a SQLite replica.\n\n  analyze-query uses the same environment variables and flags as zero-cache-dev. If run from your development environment, it will pick up your ZERO_REPLICA_FILE, ZERO_SCHEMA_PATH, and other env vars automatically.\n\n  If run in another environment (e.g., production) you will have to specify these flags. In particular, you must have a copy of the appropriate Zero schema file to give to the --schema-path flag.`,\n    },\n    {\n      header: 'Examples',\n      content: `# In development\n  npx analyze-query --query='issue.related(\"comments\").limit(10)'\n  npx analyze-query --ast='\\\\{\"table\": \"artist\",\"limit\": 10\\\\}'\n  npx analyze-query --hash=1234567890\n\n  # In production\n  # First copy schema.ts to your production environment, then run:\n  npx analyze-query \\\\\n    --schema-path='./schema.ts' \\\\\n    --replica-file='/path/to/replica.db' \\\\\n    --query='issue.related(\"comments\").limit(10)'\n\n  npx analyze-query \\\\\n    --schema-path='./schema.ts' \\\\\n    --replica-file='/path/to/replica.db' \\\\\n    --ast='\\\\{\"table\": \"artist\",\"limit\": 10\\\\}'\n\n  # cvr-db is required when using the hash option.\n  # It is typically the same as your upstream db.\n  npx analyze-query \\\\\n    --schema-path='./schema.ts' \\\\\n    --replica-file='/path/to/replica.db' \\\\\n    --cvr-db='postgres://user:pass@host:port/db' \\\\\n    --hash=1234567890\n  `,\n    },\n  ],\n});\nconst config = {\n  ...cfg,\n  cvr: {\n    ...cfg.cvr,\n    db: cfg.cvr.db ?? cfg.upstream.db,\n  },\n};\n\nruntimeDebugFlags.trackRowCountsVended = true;\nruntimeDebugFlags.trackRowsVended = config.outputVendedRows;\n\nconst lc = createLogContext({\n  log: config.log,\n});\n\ncolorConsole.warn(\n  'DEPRECATED: `analyze-query` is deprecated. Please migrate to a project-specific analyze command built with `runAnalyzeCLI` from `@rocicorp/zero/analyze`.',\n);\n\nif (!fs.existsSync(config.replicaFile)) {\n  colorConsole.error(`Replica file ${config.replicaFile} does not exist`);\n  process.exit(1);\n}\nconst db = new Database(lc, config.replicaFile);\n\nconst {schema, permissions} = await loadSchemaAndPermissions(\n  config.schema.path,\n);\nconst clientSchema = clientSchemaFrom(schema).clientSchema;\n\nconst sources = new Map<string, TableSource>();\nconst clientToServerMapper = clientToServer(schema.tables);\nconst debug = new Debug(config.outputVendedRows);\nconst tableSpecs = computeZqlSpecs(lc, db, {includeBackfillingColumns: false});\n\nclass AnalyzeQueryDelegate extends QueryDelegateBase {\n  readonly debug = debug;\n  readonly defaultQueryComplete = true;\n  readonly disableCorrelatedPredicatePushdown =\n    !config.enableCorrelatedPredicatePushdown;\n\n  getSource(serverTableName: string): Source | undefined {\n    return getOrInsertComputed(sources, serverTableName, serverTableName => {\n      const tableSpec = mustGetTableSpec(tableSpecs, serverTableName);\n      const {primaryKey} = tableSpec.tableSpec;\n      return new TableSource(\n        lc,\n        config.log,\n        db,\n        serverTableName,\n        tableSpec.zqlSpec,\n        primaryKey,\n      );\n    });\n  }\n}\n\nconst host = new AnalyzeQueryDelegate();\n\nlet result: AnalyzeQueryResult;\n\nif (config.ast) {\n  result = await runAst(\n    lc,\n    clientSchema,\n    JSON.parse(config.ast),\n    true,\n    {\n      applyPermissions: config.applyPermissions,\n      auth: config.authData\n        ? {type: 'jwt' as const, raw: '', decoded: JSON.parse(config.authData)}\n        : undefined,\n      clientToServerMapper,\n      permissions,\n      syncedRows: config.outputSyncedRows,\n      db,\n      tableSpecs,\n      host,\n    },\n    async () => {},\n  );\n} else if (config.query) {\n  result = await runQuery(config.query);\n} else if (config.hash) {\n  result = await runHash(config.hash);\n} else {\n  colorConsole.error('No query or AST or hash provided');\n  process.exit(1);\n}\n\nfunction runQuery(queryString: string): Promise<AnalyzeQueryResult> {\n  const z = {\n    query: Object.fromEntries(\n      Object.entries(schema.tables).map(([name]) => [\n        name,\n        newQuery(schema, name),\n      ]),\n    ),\n  };\n\n  const f = new Function('z', `return z.query.${queryString};`);\n  const q: Query<string, Schema, PullRow<string, Schema>> = f(z);\n\n  const ast = asQueryInternals(q).ast;\n  return runAst(\n    lc,\n    clientSchema,\n    ast,\n    false,\n    {\n      applyPermissions: config.applyPermissions,\n      auth: config.authData\n        ? {type: 'jwt' as const, raw: '', decoded: JSON.parse(config.authData)}\n        : undefined,\n      clientToServerMapper,\n      permissions,\n      syncedRows: config.outputSyncedRows,\n      db,\n      tableSpecs,\n      host,\n    },\n    async () => {},\n  );\n}\n\nasync function runHash(hash: string) {\n  const cvrDB = pgClient(\n    lc,\n    must(config.cvr.db, 'CVR DB must be provided when using the hash option'),\n    'analyze-query-hash-cvr',\n  );\n\n  const rows = await cvrDB`select \"clientAST\", \"internal\" from ${cvrDB(\n    upstreamSchema(getShardID(config)) + '/cvr',\n  )}.\"queries\" where \"queryHash\" = ${must(hash)} limit 1;`;\n  await cvrDB.end();\n\n  colorConsole.log('ZQL from Hash:');\n  const ast = rows[0].clientAST as AST;\n  colorConsole.log(await formatOutput(ast.table + astToZQL(ast)));\n\n  return runAst(\n    lc,\n    clientSchema,\n    ast,\n    true,\n    {\n      applyPermissions: config.applyPermissions,\n      auth: config.authData\n        ? {type: 'jwt' as const, raw: '', decoded: JSON.parse(config.authData)}\n        : undefined,\n      clientToServerMapper,\n      permissions,\n      syncedRows: config.outputSyncedRows,\n      db,\n      tableSpecs,\n      host,\n    },\n    async () => {},\n  );\n}\n\nif (config.outputSyncedRows) {\n  colorConsole.log(styleText(['blue', 'bold'], '=== Synced Rows: ===\\n'));\n  for (const [table, rows] of Object.entries(result.syncedRows ?? {})) {\n    colorConsole.log(styleText('bold', table + ':'), rows);\n  }\n}\n\ncolorConsole.log(styleText(['blue', 'bold'], '=== Query Stats: ===\\n'));\ncolorConsole.log(\n  styleText('bold', 'total synced rows:'),\n  result.syncedRowCount,\n);\nshowStats();\nif (config.outputVendedRows) {\n  colorConsole.log(\n    styleText(['blue', 'bold'], '=== JS Row Scan Values: ===\\n'),\n  );\n  for (const source of sources.values()) {\n    colorConsole.log(\n      styleText('bold', `${source.tableSchema.name}:`),\n      debug.getVendedRows()?.[source.tableSchema.name] ?? {},\n    );\n  }\n}\n\ncolorConsole.log(\n  styleText(['blue', 'bold'], '\\n=== Rows Scanned (by SQLite): ===\\n'),\n);\nconst nvisitCounts = debug.getNVisitCounts();\nlet totalNVisit = 0;\nfor (const [table, queries] of Object.entries(nvisitCounts)) {\n  colorConsole.log(styleText('bold', `${table}:`), queries);\n  for (const count of Object.values(queries)) {\n    totalNVisit += count;\n  }\n}\ncolorConsole.log(\n  styleText('bold', 'total rows scanned:'),\n  colorRowsConsidered(totalNVisit),\n);\n\ncolorConsole.log(styleText(['blue', 'bold'], '\\n\\n=== Query Plans: ===\\n'));\nconst fallbackPlans = explainQueries(debug.getVendedRowCounts() ?? {}, db);\nconst capturedPlans = debug.getSQLitePlans();\nconst plans: Record<string, string[]> = {...fallbackPlans, ...capturedPlans};\nfor (const [query, plan] of Object.entries(plans)) {\n  colorConsole.log(styleText('bold', 'query'), query);\n  colorConsole.log(plan.map((row, i) => colorPlanRow(row, i)).join('\\n'));\n  colorConsole.log('\\n');\n}\n\nfunction showStats() {\n  let totalRowsConsidered = 0;\n  for (const source of sources.values()) {\n    const values = Object.values(\n      debug.getVendedRowCounts()?.[source.tableSchema.name] ?? {},\n    );\n    for (const v of values) {\n      totalRowsConsidered += v;\n    }\n    colorConsole.log(\n      styleText('bold', source.tableSchema.name + ' vended:'),\n      debug.getVendedRowCounts()?.[source.tableSchema.name] ?? {},\n    );\n  }\n\n  colorConsole.log(\n    styleText('bold', 'Rows Read (into JS):'),\n    colorRowsConsidered(totalRowsConsidered),\n  );\n  colorConsole.log(\n    styleText('bold', 'time:'),\n    colorTime(result.end - result.start),\n    'ms',\n  );\n}\n\nfunction colorTime(duration: number) {\n  if (duration < 100) {\n    return styleText('green', duration.toFixed(2) + 'ms');\n  } else if (duration < 1000) {\n    return styleText('yellow', duration.toFixed(2) + 'ms');\n  }\n  return styleText('red', duration.toFixed(2) + 'ms');\n}\n\nfunction colorRowsConsidered(n: number) {\n  if (n < 1000) {\n    return styleText('green', n.toString());\n  } else if (n < 10000) {\n    return styleText('yellow', n.toString());\n  }\n  return styleText('red', n.toString());\n}\n\nfunction colorPlanRow(row: string, i: number) {\n  if (row.includes('SCAN')) {\n    if (i === 0) {\n      return styleText('yellow', row);\n    }\n    return styleText('red', row);\n  }\n  return styleText('green', row);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoIA,IAAM,MAAM,aAAa;CApFvB,QAAQ,yBAAyB;CACjC,aAAa;EACX,GAAG,YAAY,QAAQ;EACvB,MAAM,CAAC,0DAA0D;CACnE;CACA,KAAK;EACH,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM,CACJ,mFACF;CACF;CACA,OAAO;EACL,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM,CACJ,4EACA,gDACF;CACF;CACA,MAAM;EACJ,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM;GACJ;GACA;GACA;GACA;EACF;CACF;CACA,kBAAkB;EAChB,MAAM,eAAE,QAAQ,EAAE,QAAQ,KAAK;EAC/B,MAAM,CACJ,6EACF;CACF;CACA,UAAU;EACR,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM,CACJ,0CACA,0FACF;CACF;CACA,kBAAkB;EAChB,MAAM,eAAE,QAAQ,EAAE,QAAQ,KAAK;EAC/B,MAAM,CACJ,wGACA,0FACF;CACF;CACA,kBAAkB;EAChB,MAAM,eAAE,QAAQ,EAAE,QAAQ,KAAK;EAC/B,MAAM,CACJ,wFACF;CACF;CACA,KAAK,EACH,IAAI;EACF,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM,CACJ,qFACA,oBACF;CACF,EACF;CACA,UAAU;EACR,IAAI;GACF,MAAM,CACJ,uFACA,4CACF;GACA,MAAM,eAAE,OAAO,EAAE,SAAS;EAC5B;EACA,MAAM,YAAY,SAAS;CAC7B;CACA,KAAK;CACL,OAAO;CAGP,mCACE,YAAY;CACd,KAAK;EACH,GAAG;EACH,OAAO,SAAS,QAAQ,OAAO;CACjC;AAGuB,GAAS;CAChC,MAAM,QAAQ,KAAK,MAAM,CAAC,EAAE,KAAI,MAAK,EAAE,WAAW,MAAM,GAAG,CAAC;CAC5D,eAAe;CACf,aAAa,CACX;EACE,QAAQ;EACR,SAAS;;;;;CAKX,GACA;EACE,QAAQ;EACR,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;CAyBX,CACF;AACF,CAAC;AACD,IAAM,SAAS;CACb,GAAG;CACH,KAAK;EACH,GAAG,IAAI;EACP,IAAI,IAAI,IAAI,MAAM,IAAI,SAAS;CACjC;AACF;AAEA,kBAAkB,uBAAuB;AACzC,kBAAkB,kBAAkB,OAAO;AAE3C,IAAM,KAAK,iBAAiB,EAC1B,KAAK,OAAO,IACd,CAAC;AAED,aAAa,KACX,2JACF;AAEA,IAAI,CAAC,GAAG,WAAW,OAAO,WAAW,GAAG;CACtC,aAAa,MAAM,gBAAgB,OAAO,YAAY,gBAAgB;CACtE,QAAQ,KAAK,CAAC;AAChB;AACA,IAAM,KAAK,IAAI,SAAS,IAAI,OAAO,WAAW;AAE9C,IAAM,EAAC,QAAQ,gBAAe,MAAM,yBAClC,OAAO,OAAO,IAChB;AACA,IAAM,eAAe,iBAAiB,MAAM,EAAE;AAE9C,IAAM,0BAAU,IAAI,IAAyB;AAC7C,IAAM,uBAAuB,eAAe,OAAO,MAAM;AACzD,IAAM,QAAQ,IAAI,MAAM,OAAO,gBAAgB;AAC/C,IAAM,aAAa,gBAAgB,IAAI,IAAI,EAAC,2BAA2B,MAAK,CAAC;AAE7E,IAAM,uBAAN,cAAmC,kBAAkB;CACnD,QAAiB;CACjB,uBAAgC;CAChC,qCACE,CAAC,OAAO;CAEV,UAAU,iBAA6C;EACrD,OAAO,oBAAoB,SAAS,kBAAiB,oBAAmB;GACtE,MAAM,YAAY,iBAAiB,YAAY,eAAe;GAC9D,MAAM,EAAC,eAAc,UAAU;GAC/B,OAAO,IAAI,YACT,IACA,OAAO,KACP,IACA,iBACA,UAAU,SACV,UACF;EACF,CAAC;CACH;AACF;AAEA,IAAM,OAAO,IAAI,qBAAqB;AAEtC,IAAI;AAEJ,IAAI,OAAO,KACT,SAAS,MAAM,OACb,IACA,cACA,KAAK,MAAM,OAAO,GAAG,GACrB,MACA;CACE,kBAAkB,OAAO;CACzB,MAAM,OAAO,WACT;EAAC,MAAM;EAAgB,KAAK;EAAI,SAAS,KAAK,MAAM,OAAO,QAAQ;CAAC,IACpE,KAAA;CACJ;CACA;CACA,YAAY,OAAO;CACnB;CACA;CACA;AACF,GACA,YAAY,CAAC,CACf;KACK,IAAI,OAAO,OAChB,SAAS,MAAM,SAAS,OAAO,KAAK;KAC/B,IAAI,OAAO,MAChB,SAAS,MAAM,QAAQ,OAAO,IAAI;KAC7B;CACL,aAAa,MAAM,kCAAkC;CACrD,QAAQ,KAAK,CAAC;AAChB;AAEA,SAAS,SAAS,aAAkD;CAClE,MAAM,IAAI,EACR,OAAO,OAAO,YACZ,OAAO,QAAQ,OAAO,MAAM,EAAE,KAAK,CAAC,UAAU,CAC5C,MACA,SAAS,QAAQ,IAAI,CACvB,CAAC,CACH,EACF;CAKA,MAAM,MAAM,iBAF8C,IAD5C,SAAS,KAAK,kBAAkB,YAAY,EACA,EAAE,CAE/B,CAAC,EAAE;CAChC,OAAO,OACL,IACA,cACA,KACA,OACA;EACE,kBAAkB,OAAO;EACzB,MAAM,OAAO,WACT;GAAC,MAAM;GAAgB,KAAK;GAAI,SAAS,KAAK,MAAM,OAAO,QAAQ;EAAC,IACpE,KAAA;EACJ;EACA;EACA,YAAY,OAAO;EACnB;EACA;EACA;CACF,GACA,YAAY,CAAC,CACf;AACF;AAEA,eAAe,QAAQ,MAAc;CACnC,MAAM,QAAQ,SACZ,IACA,KAAK,OAAO,IAAI,IAAI,oDAAoD,GACxE,wBACF;CAEA,MAAM,OAAO,MAAM,KAAK,uCAAuC,MAC7D,eAAe,WAAW,MAAM,CAAC,IAAI,MACvC,EAAE,iCAAiC,KAAK,IAAI,EAAE;CAC9C,MAAM,MAAM,IAAI;CAEhB,aAAa,IAAI,gBAAgB;CACjC,MAAM,MAAM,KAAK,GAAG;CACpB,aAAa,IAAI,MAAM,aAAa,IAAI,QAAQ,SAAS,GAAG,CAAC,CAAC;CAE9D,OAAO,OACL,IACA,cACA,KACA,MACA;EACE,kBAAkB,OAAO;EACzB,MAAM,OAAO,WACT;GAAC,MAAM;GAAgB,KAAK;GAAI,SAAS,KAAK,MAAM,OAAO,QAAQ;EAAC,IACpE,KAAA;EACJ;EACA;EACA,YAAY,OAAO;EACnB;EACA;EACA;CACF,GACA,YAAY,CAAC,CACf;AACF;AAEA,IAAI,OAAO,kBAAkB;CAC3B,aAAa,IAAI,UAAU,CAAC,QAAQ,MAAM,GAAG,wBAAwB,CAAC;CACtE,KAAK,MAAM,CAAC,OAAO,SAAS,OAAO,QAAQ,OAAO,cAAc,CAAC,CAAC,GAChE,aAAa,IAAI,UAAU,QAAQ,QAAQ,GAAG,GAAG,IAAI;AAEzD;AAEA,aAAa,IAAI,UAAU,CAAC,QAAQ,MAAM,GAAG,wBAAwB,CAAC;AACtE,aAAa,IACX,UAAU,QAAQ,oBAAoB,GACtC,OAAO,cACT;AACA,UAAU;AACV,IAAI,OAAO,kBAAkB;CAC3B,aAAa,IACX,UAAU,CAAC,QAAQ,MAAM,GAAG,+BAA+B,CAC7D;CACA,KAAK,MAAM,UAAU,QAAQ,OAAO,GAClC,aAAa,IACX,UAAU,QAAQ,GAAG,OAAO,YAAY,KAAK,EAAE,GAC/C,MAAM,cAAc,IAAI,OAAO,YAAY,SAAS,CAAC,CACvD;AAEJ;AAEA,aAAa,IACX,UAAU,CAAC,QAAQ,MAAM,GAAG,uCAAuC,CACrE;AACA,IAAM,eAAe,MAAM,gBAAgB;AAC3C,IAAI,cAAc;AAClB,KAAK,MAAM,CAAC,OAAO,YAAY,OAAO,QAAQ,YAAY,GAAG;CAC3D,aAAa,IAAI,UAAU,QAAQ,GAAG,MAAM,EAAE,GAAG,OAAO;CACxD,KAAK,MAAM,SAAS,OAAO,OAAO,OAAO,GACvC,eAAe;AAEnB;AACA,aAAa,IACX,UAAU,QAAQ,qBAAqB,GACvC,oBAAoB,WAAW,CACjC;AAEA,aAAa,IAAI,UAAU,CAAC,QAAQ,MAAM,GAAG,4BAA4B,CAAC;AAC1E,IAAM,gBAAgB,eAAe,MAAM,mBAAmB,KAAK,CAAC,GAAG,EAAE;AACzE,IAAM,gBAAgB,MAAM,eAAe;AAC3C,IAAM,QAAkC;CAAC,GAAG;CAAe,GAAG;AAAa;AAC3E,KAAK,MAAM,CAAC,OAAO,SAAS,OAAO,QAAQ,KAAK,GAAG;CACjD,aAAa,IAAI,UAAU,QAAQ,OAAO,GAAG,KAAK;CAClD,aAAa,IAAI,KAAK,KAAK,KAAK,MAAM,aAAa,KAAK,CAAC,CAAC,EAAE,KAAK,IAAI,CAAC;CACtE,aAAa,IAAI,IAAI;AACvB;AAEA,SAAS,YAAY;CACnB,IAAI,sBAAsB;CAC1B,KAAK,MAAM,UAAU,QAAQ,OAAO,GAAG;EACrC,MAAM,SAAS,OAAO,OACpB,MAAM,mBAAmB,IAAI,OAAO,YAAY,SAAS,CAAC,CAC5D;EACA,KAAK,MAAM,KAAK,QACd,uBAAuB;EAEzB,aAAa,IACX,UAAU,QAAQ,OAAO,YAAY,OAAO,UAAU,GACtD,MAAM,mBAAmB,IAAI,OAAO,YAAY,SAAS,CAAC,CAC5D;CACF;CAEA,aAAa,IACX,UAAU,QAAQ,sBAAsB,GACxC,oBAAoB,mBAAmB,CACzC;CACA,aAAa,IACX,UAAU,QAAQ,OAAO,GACzB,UAAU,OAAO,MAAM,OAAO,KAAK,GACnC,IACF;AACF;AAEA,SAAS,UAAU,UAAkB;CACnC,IAAI,WAAW,KACb,OAAO,UAAU,SAAS,SAAS,QAAQ,CAAC,IAAI,IAAI;MAC/C,IAAI,WAAW,KACpB,OAAO,UAAU,UAAU,SAAS,QAAQ,CAAC,IAAI,IAAI;CAEvD,OAAO,UAAU,OAAO,SAAS,QAAQ,CAAC,IAAI,IAAI;AACpD;AAEA,SAAS,oBAAoB,GAAW;CACtC,IAAI,IAAI,KACN,OAAO,UAAU,SAAS,EAAE,SAAS,CAAC;MACjC,IAAI,IAAI,KACb,OAAO,UAAU,UAAU,EAAE,SAAS,CAAC;CAEzC,OAAO,UAAU,OAAO,EAAE,SAAS,CAAC;AACtC;AAEA,SAAS,aAAa,KAAa,GAAW;CAC5C,IAAI,IAAI,SAAS,MAAM,GAAG;EACxB,IAAI,MAAM,GACR,OAAO,UAAU,UAAU,GAAG;EAEhC,OAAO,UAAU,OAAO,GAAG;CAC7B;CACA,OAAO,UAAU,SAAS,GAAG;AAC/B"}
+{"version":3,"file":"bin-analyze.js","names":[],"sources":["../../../../analyze-query/src/bin-analyze.ts"],"sourcesContent":["import '../../shared/src/dotenv.ts';\n\nimport fs from 'node:fs';\nimport {styleText} from 'node:util';\nimport {astToZQL} from '../../ast-to-zql/src/ast-to-zql.ts';\nimport {formatOutput} from '../../ast-to-zql/src/format.ts';\nimport {logLevel, logOptions} from '../../otel/src/log-options.ts';\nimport {colorConsole, createLogContext} from '../../shared/src/logging.ts';\nimport {getOrInsertComputed} from '../../shared/src/map.ts';\nimport {must} from '../../shared/src/must.ts';\nimport {parseOptions} from '../../shared/src/options.ts';\nimport * as v from '../../shared/src/valita.ts';\nimport {\n  appOptions,\n  shardOptions,\n  ZERO_ENV_VAR_PREFIX,\n  zeroOptions,\n} from '../../zero-cache/src/config/zero-config.ts';\nimport {\n  computeZqlSpecs,\n  mustGetTableSpec,\n} from '../../zero-cache/src/db/lite-tables.ts';\nimport {\n  deployPermissionsOptions,\n  loadSchemaAndPermissions,\n} from '../../zero-cache/src/scripts/permissions.ts';\nimport {runAst} from '../../zero-cache/src/services/run-ast.ts';\nimport {pgClient} from '../../zero-cache/src/types/pg.ts';\nimport {getShardID, upstreamSchema} from '../../zero-cache/src/types/shards.ts';\nimport type {AnalyzeQueryResult} from '../../zero-protocol/src/analyze-query-result.ts';\nimport {type AST} from '../../zero-protocol/src/ast.ts';\nimport {clientSchemaFrom} from '../../zero-schema/src/builder/schema-builder.ts';\nimport {clientToServer} from '../../zero-schema/src/name-mapper.ts';\nimport type {Schema} from '../../zero-types/src/schema.ts';\nimport {\n  Debug,\n  runtimeDebugFlags,\n} from '../../zql/src/builder/debug-delegate.ts';\nimport type {Source} from '../../zql/src/ivm/source.ts';\nimport {QueryDelegateBase} from '../../zql/src/query/query-delegate-base.ts';\nimport {newQuery} from '../../zql/src/query/query-impl.ts';\nimport {asQueryInternals} from '../../zql/src/query/query-internals.ts';\nimport {type PullRow, type Query} from '../../zql/src/query/query.ts';\nimport {Database} from '../../zqlite/src/db.ts';\nimport {explainQueries} from '../../zqlite/src/explain-queries.ts';\nimport {TableSource} from '../../zqlite/src/table-source.ts';\n\nconst options = {\n  schema: deployPermissionsOptions.schema,\n  replicaFile: {\n    ...zeroOptions.replica.file,\n    desc: ['File path to the SQLite replica to test queries against.'],\n  },\n  ast: {\n    type: v.string().optional(),\n    desc: [\n      'AST for the query to be analyzed.  Only one of ast/query/hash should be provided.',\n    ],\n  },\n  query: {\n    type: v.string().optional(),\n    desc: [\n      'Query to be analyzed in the form of: table.where(...).related(...).etc. ',\n      'Only one of ast/query/hash should be provided.',\n    ],\n  },\n  hash: {\n    type: v.string().optional(),\n    desc: [\n      'Hash of the query to be analyzed. This is used to look up the query in the database. ',\n      'Only one of ast/query/hash should be provided.',\n      'You should run this script from the directory containing your .env file to reduce the amount of',\n      'configuration required. The .env file should contain the connection URL to the CVR database.',\n    ],\n  },\n  applyPermissions: {\n    type: v.boolean().optional(() => false),\n    desc: [\n      'Whether to apply permissions (from your schema file) to the provided query.',\n    ],\n  },\n  authData: {\n    type: v.string().optional(),\n    desc: [\n      'JSON encoded payload of the auth data.',\n      'This will be used to fill permission variables if the \"applyPermissions\" option is set',\n    ],\n  },\n  outputVendedRows: {\n    type: v.boolean().optional(() => false),\n    desc: [\n      'Whether to output the rows which were read from the replica in order to execute the analyzed query. ',\n      'If the same row is read more than once it will be logged once for each time it was read.',\n    ],\n  },\n  outputSyncedRows: {\n    type: v.boolean().optional(() => false),\n    desc: [\n      'Whether to output the rows which would be synced to the client for the analyzed query.',\n    ],\n  },\n  cvr: {\n    db: {\n      type: v.string().optional(),\n      desc: [\n        'Connection URL to the CVR database. If using --hash, either this or --upstream-db',\n        'must be specified.',\n      ],\n    },\n  },\n  upstream: {\n    db: {\n      desc: [\n        `Connection URL to the \"upstream\" authoritative postgres database. If using --hash, `,\n        'either this or --cvr-db must be specified.',\n      ],\n      type: v.string().optional(),\n    },\n    type: zeroOptions.upstream.type,\n  },\n  app: appOptions,\n  shard: shardOptions,\n  // Read from the same env var as zero-cache, so the analysis matches what\n  // the server runs.\n  enableCorrelatedPredicatePushdown:\n    zeroOptions.enableCorrelatedPredicatePushdown,\n  log: {\n    ...logOptions,\n    level: logLevel.optional(() => 'error'),\n  },\n};\n\nconst cfg = parseOptions(options, {\n  argv: process.argv.slice(2).map(s => s.replaceAll('\\n', ' ')),\n  envNamePrefix: ZERO_ENV_VAR_PREFIX,\n  description: [\n    {\n      header: 'analyze-query',\n      content: `Analyze a ZQL query and show information about how it runs against a SQLite replica.\n\n  analyze-query uses the same environment variables and flags as zero-cache-dev. If run from your development environment, it will pick up your ZERO_REPLICA_FILE, ZERO_SCHEMA_PATH, and other env vars automatically.\n\n  If run in another environment (e.g., production) you will have to specify these flags. In particular, you must have a copy of the appropriate Zero schema file to give to the --schema-path flag.`,\n    },\n    {\n      header: 'Examples',\n      content: `# In development\n  npx analyze-query --query='issue.related(\"comments\").limit(10)'\n  npx analyze-query --ast='\\\\{\"table\": \"artist\",\"limit\": 10\\\\}'\n  npx analyze-query --hash=1234567890\n\n  # In production\n  # First copy schema.ts to your production environment, then run:\n  npx analyze-query \\\\\n    --schema-path='./schema.ts' \\\\\n    --replica-file='/path/to/replica.db' \\\\\n    --query='issue.related(\"comments\").limit(10)'\n\n  npx analyze-query \\\\\n    --schema-path='./schema.ts' \\\\\n    --replica-file='/path/to/replica.db' \\\\\n    --ast='\\\\{\"table\": \"artist\",\"limit\": 10\\\\}'\n\n  # cvr-db is required when using the hash option.\n  # It is typically the same as your upstream db.\n  npx analyze-query \\\\\n    --schema-path='./schema.ts' \\\\\n    --replica-file='/path/to/replica.db' \\\\\n    --cvr-db='postgres://user:pass@host:port/db' \\\\\n    --hash=1234567890\n  `,\n    },\n  ],\n});\nconst config = {\n  ...cfg,\n  cvr: {\n    ...cfg.cvr,\n    db: cfg.cvr.db ?? cfg.upstream.db,\n  },\n};\n\nruntimeDebugFlags.trackRowCountsVended = true;\nruntimeDebugFlags.trackRowsVended = config.outputVendedRows;\n\nconst lc = createLogContext({\n  log: config.log,\n});\n\ncolorConsole.warn(\n  'DEPRECATED: `analyze-query` is deprecated. Please migrate to a project-specific analyze command built with `runAnalyzeCLI` from `@rocicorp/zero/analyze`.',\n);\n\nif (!fs.existsSync(config.replicaFile)) {\n  colorConsole.error(`Replica file ${config.replicaFile} does not exist`);\n  process.exit(1);\n}\nconst db = new Database(lc, config.replicaFile);\n\nconst {schema, permissions} = await loadSchemaAndPermissions(\n  config.schema.path,\n);\nconst clientSchema = clientSchemaFrom(schema).clientSchema;\n\nconst sources = new Map<string, TableSource>();\nconst clientToServerMapper = clientToServer(schema.tables);\nconst debug = new Debug(config.outputVendedRows);\nconst tableSpecs = computeZqlSpecs(lc, db, {includeBackfillingColumns: false});\n\nclass AnalyzeQueryDelegate extends QueryDelegateBase {\n  readonly debug = debug;\n  readonly defaultQueryComplete = true;\n  readonly disableCorrelatedPredicatePushdown =\n    !config.enableCorrelatedPredicatePushdown;\n\n  getSource(serverTableName: string): Source | undefined {\n    return getOrInsertComputed(sources, serverTableName, serverTableName => {\n      const tableSpec = mustGetTableSpec(tableSpecs, serverTableName);\n      const {primaryKey} = tableSpec.tableSpec;\n      return new TableSource(\n        lc,\n        config.log,\n        db,\n        serverTableName,\n        tableSpec.zqlSpec,\n        primaryKey,\n      );\n    });\n  }\n}\n\nconst host = new AnalyzeQueryDelegate();\n\nlet result: AnalyzeQueryResult;\n\nif (config.ast) {\n  result = await runAst(\n    lc,\n    clientSchema,\n    JSON.parse(config.ast),\n    true,\n    {\n      applyPermissions: config.applyPermissions,\n      auth: config.authData\n        ? {type: 'jwt' as const, raw: '', decoded: JSON.parse(config.authData)}\n        : undefined,\n      clientToServerMapper,\n      permissions,\n      syncedRows: config.outputSyncedRows,\n      db,\n      tableSpecs,\n      host,\n    },\n    async () => {},\n  );\n} else if (config.query) {\n  result = await runQuery(config.query);\n} else if (config.hash) {\n  result = await runHash(config.hash);\n} else {\n  colorConsole.error('No query or AST or hash provided');\n  process.exit(1);\n}\n\nfunction runQuery(queryString: string): Promise<AnalyzeQueryResult> {\n  const z = {\n    query: Object.fromEntries(\n      Object.entries(schema.tables).map(([name]) => [\n        name,\n        newQuery(schema, name),\n      ]),\n    ),\n  };\n\n  const f = new Function('z', `return z.query.${queryString};`);\n  const q: Query<string, Schema, PullRow<string, Schema>> = f(z);\n\n  const ast = asQueryInternals(q).ast;\n  return runAst(\n    lc,\n    clientSchema,\n    ast,\n    false,\n    {\n      applyPermissions: config.applyPermissions,\n      auth: config.authData\n        ? {type: 'jwt' as const, raw: '', decoded: JSON.parse(config.authData)}\n        : undefined,\n      clientToServerMapper,\n      permissions,\n      syncedRows: config.outputSyncedRows,\n      db,\n      tableSpecs,\n      host,\n    },\n    async () => {},\n  );\n}\n\nasync function runHash(hash: string) {\n  const cvrDB = pgClient(\n    lc,\n    must(config.cvr.db, 'CVR DB must be provided when using the hash option'),\n    'analyze-query-hash-cvr',\n  );\n\n  const rows = await cvrDB`select \"clientAST\", \"internal\" from ${cvrDB(\n    upstreamSchema(getShardID(config)) + '/cvr',\n  )}.\"queries\" where \"queryHash\" = ${must(hash)} limit 1;`;\n  await cvrDB.end();\n\n  colorConsole.log('ZQL from Hash:');\n  const ast = rows[0].clientAST as AST;\n  colorConsole.log(await formatOutput(ast.table + astToZQL(ast)));\n\n  return runAst(\n    lc,\n    clientSchema,\n    ast,\n    true,\n    {\n      applyPermissions: config.applyPermissions,\n      auth: config.authData\n        ? {type: 'jwt' as const, raw: '', decoded: JSON.parse(config.authData)}\n        : undefined,\n      clientToServerMapper,\n      permissions,\n      syncedRows: config.outputSyncedRows,\n      db,\n      tableSpecs,\n      host,\n    },\n    async () => {},\n  );\n}\n\nif (config.outputSyncedRows) {\n  colorConsole.log(styleText(['blue', 'bold'], '=== Synced Rows: ===\\n'));\n  for (const [table, rows] of Object.entries(result.syncedRows ?? {})) {\n    colorConsole.log(styleText('bold', table + ':'), rows);\n  }\n}\n\ncolorConsole.log(styleText(['blue', 'bold'], '=== Query Stats: ===\\n'));\ncolorConsole.log(\n  styleText('bold', 'total synced rows:'),\n  result.syncedRowCount,\n);\nshowStats();\nif (config.outputVendedRows) {\n  colorConsole.log(\n    styleText(['blue', 'bold'], '=== JS Row Scan Values: ===\\n'),\n  );\n  for (const source of sources.values()) {\n    colorConsole.log(\n      styleText('bold', `${source.tableSchema.name}:`),\n      debug.getVendedRows()?.[source.tableSchema.name] ?? {},\n    );\n  }\n}\n\ncolorConsole.log(\n  styleText(['blue', 'bold'], '\\n=== Rows Scanned (by SQLite): ===\\n'),\n);\nconst nvisitCounts = debug.getNVisitCounts();\nlet totalNVisit = 0;\nfor (const [table, queries] of Object.entries(nvisitCounts)) {\n  colorConsole.log(styleText('bold', `${table}:`), queries);\n  for (const count of Object.values(queries)) {\n    totalNVisit += count;\n  }\n}\ncolorConsole.log(\n  styleText('bold', 'total rows scanned:'),\n  colorRowsConsidered(totalNVisit),\n);\n\ncolorConsole.log(styleText(['blue', 'bold'], '\\n\\n=== Query Plans: ===\\n'));\nconst fallbackPlans = explainQueries(debug.getVendedRowCounts() ?? {}, db);\nconst capturedPlans = debug.getSQLitePlans();\nconst plans: Record<string, string[]> = {...fallbackPlans, ...capturedPlans};\nfor (const [query, plan] of Object.entries(plans)) {\n  colorConsole.log(styleText('bold', 'query'), query);\n  colorConsole.log(plan.map((row, i) => colorPlanRow(row, i)).join('\\n'));\n  colorConsole.log('\\n');\n}\n\nfunction showStats() {\n  let totalRowsConsidered = 0;\n  for (const source of sources.values()) {\n    const values = Object.values(\n      debug.getVendedRowCounts()?.[source.tableSchema.name] ?? {},\n    );\n    for (const v of values) {\n      totalRowsConsidered += v;\n    }\n    colorConsole.log(\n      styleText('bold', source.tableSchema.name + ' vended:'),\n      debug.getVendedRowCounts()?.[source.tableSchema.name] ?? {},\n    );\n  }\n\n  colorConsole.log(\n    styleText('bold', 'Rows Read (into JS):'),\n    colorRowsConsidered(totalRowsConsidered),\n  );\n  colorConsole.log(\n    styleText('bold', 'time:'),\n    colorTime(result.end - result.start),\n    'ms',\n  );\n}\n\nfunction colorTime(duration: number) {\n  if (duration < 100) {\n    return styleText('green', duration.toFixed(2) + 'ms');\n  } else if (duration < 1000) {\n    return styleText('yellow', duration.toFixed(2) + 'ms');\n  }\n  return styleText('red', duration.toFixed(2) + 'ms');\n}\n\nfunction colorRowsConsidered(n: number) {\n  if (n < 1000) {\n    return styleText('green', n.toString());\n  } else if (n < 10000) {\n    return styleText('yellow', n.toString());\n  }\n  return styleText('red', n.toString());\n}\n\nfunction colorPlanRow(row: string, i: number) {\n  if (row.includes('SCAN')) {\n    if (i === 0) {\n      return styleText('yellow', row);\n    }\n    return styleText('red', row);\n  }\n  return styleText('green', row);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoIA,IAAM,MAAM,aAAa;CApFvB,QAAQ,yBAAyB;CACjC,aAAa;EACX,GAAG,YAAY,QAAQ;EACvB,MAAM,CAAC,0DAA0D;CACnE;CACA,KAAK;EACH,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM,CACJ,mFACF;CACF;CACA,OAAO;EACL,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM,CACJ,4EACA,gDACF;CACF;CACA,MAAM;EACJ,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM;GACJ;GACA;GACA;GACA;EACF;CACF;CACA,kBAAkB;EAChB,MAAM,eAAE,QAAQ,EAAE,eAAe,KAAK;EACtC,MAAM,CACJ,6EACF;CACF;CACA,UAAU;EACR,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM,CACJ,0CACA,0FACF;CACF;CACA,kBAAkB;EAChB,MAAM,eAAE,QAAQ,EAAE,eAAe,KAAK;EACtC,MAAM,CACJ,wGACA,0FACF;CACF;CACA,kBAAkB;EAChB,MAAM,eAAE,QAAQ,EAAE,eAAe,KAAK;EACtC,MAAM,CACJ,wFACF;CACF;CACA,KAAK,EACH,IAAI;EACF,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM,CACJ,qFACA,oBACF;CACF,EACF;CACA,UAAU;EACR,IAAI;GACF,MAAM,CACJ,uFACA,4CACF;GACA,MAAM,eAAE,OAAO,EAAE,SAAS;EAC5B;EACA,MAAM,YAAY,SAAS;CAC7B;CACA,KAAK;CACL,OAAO;CAGP,mCACE,YAAY;CACd,KAAK;EACH,GAAG;EACH,OAAO,SAAS,eAAe,OAAO;CACxC;AAGuB,GAAS;CAChC,MAAM,QAAQ,KAAK,MAAM,CAAC,EAAE,KAAI,MAAK,EAAE,WAAW,MAAM,GAAG,CAAC;CAC5D,eAAe;CACf,aAAa,CACX;EACE,QAAQ;EACR,SAAS;;;;;CAKX,GACA;EACE,QAAQ;EACR,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;CAyBX,CACF;AACF,CAAC;AACD,IAAM,SAAS;CACb,GAAG;CACH,KAAK;EACH,GAAG,IAAI;EACP,IAAI,IAAI,IAAI,MAAM,IAAI,SAAS;CACjC;AACF;AAEA,kBAAkB,uBAAuB;AACzC,kBAAkB,kBAAkB,OAAO;AAE3C,IAAM,KAAK,iBAAiB,EAC1B,KAAK,OAAO,IACd,CAAC;AAED,aAAa,KACX,2JACF;AAEA,IAAI,CAAC,GAAG,WAAW,OAAO,WAAW,GAAG;CACtC,aAAa,MAAM,gBAAgB,OAAO,YAAY,gBAAgB;CACtE,QAAQ,KAAK,CAAC;AAChB;AACA,IAAM,KAAK,IAAI,SAAS,IAAI,OAAO,WAAW;AAE9C,IAAM,EAAC,QAAQ,gBAAe,MAAM,yBAClC,OAAO,OAAO,IAChB;AACA,IAAM,eAAe,iBAAiB,MAAM,EAAE;AAE9C,IAAM,0BAAU,IAAI,IAAyB;AAC7C,IAAM,uBAAuB,eAAe,OAAO,MAAM;AACzD,IAAM,QAAQ,IAAI,MAAM,OAAO,gBAAgB;AAC/C,IAAM,aAAa,gBAAgB,IAAI,IAAI,EAAC,2BAA2B,MAAK,CAAC;AAE7E,IAAM,uBAAN,cAAmC,kBAAkB;CACnD,QAAiB;CACjB,uBAAgC;CAChC,qCACE,CAAC,OAAO;CAEV,UAAU,iBAA6C;EACrD,OAAO,oBAAoB,SAAS,kBAAiB,oBAAmB;GACtE,MAAM,YAAY,iBAAiB,YAAY,eAAe;GAC9D,MAAM,EAAC,eAAc,UAAU;GAC/B,OAAO,IAAI,YACT,IACA,OAAO,KACP,IACA,iBACA,UAAU,SACV,UACF;EACF,CAAC;CACH;AACF;AAEA,IAAM,OAAO,IAAI,qBAAqB;AAEtC,IAAI;AAEJ,IAAI,OAAO,KACT,SAAS,MAAM,OACb,IACA,cACA,KAAK,MAAM,OAAO,GAAG,GACrB,MACA;CACE,kBAAkB,OAAO;CACzB,MAAM,OAAO,WACT;EAAC,MAAM;EAAgB,KAAK;EAAI,SAAS,KAAK,MAAM,OAAO,QAAQ;CAAC,IACpE,KAAA;CACJ;CACA;CACA,YAAY,OAAO;CACnB;CACA;CACA;AACF,GACA,YAAY,CAAC,CACf;KACK,IAAI,OAAO,OAChB,SAAS,MAAM,SAAS,OAAO,KAAK;KAC/B,IAAI,OAAO,MAChB,SAAS,MAAM,QAAQ,OAAO,IAAI;KAC7B;CACL,aAAa,MAAM,kCAAkC;CACrD,QAAQ,KAAK,CAAC;AAChB;AAEA,SAAS,SAAS,aAAkD;CAClE,MAAM,IAAI,EACR,OAAO,OAAO,YACZ,OAAO,QAAQ,OAAO,MAAM,EAAE,KAAK,CAAC,UAAU,CAC5C,MACA,SAAS,QAAQ,IAAI,CACvB,CAAC,CACH,EACF;CAKA,MAAM,MAAM,iBAF8C,IAD5C,SAAS,KAAK,kBAAkB,YAAY,EACA,EAAE,CAE/B,CAAC,EAAE;CAChC,OAAO,OACL,IACA,cACA,KACA,OACA;EACE,kBAAkB,OAAO;EACzB,MAAM,OAAO,WACT;GAAC,MAAM;GAAgB,KAAK;GAAI,SAAS,KAAK,MAAM,OAAO,QAAQ;EAAC,IACpE,KAAA;EACJ;EACA;EACA,YAAY,OAAO;EACnB;EACA;EACA;CACF,GACA,YAAY,CAAC,CACf;AACF;AAEA,eAAe,QAAQ,MAAc;CACnC,MAAM,QAAQ,SACZ,IACA,KAAK,OAAO,IAAI,IAAI,oDAAoD,GACxE,wBACF;CAEA,MAAM,OAAO,MAAM,KAAK,uCAAuC,MAC7D,eAAe,WAAW,MAAM,CAAC,IAAI,MACvC,EAAE,iCAAiC,KAAK,IAAI,EAAE;CAC9C,MAAM,MAAM,IAAI;CAEhB,aAAa,IAAI,gBAAgB;CACjC,MAAM,MAAM,KAAK,GAAG;CACpB,aAAa,IAAI,MAAM,aAAa,IAAI,QAAQ,SAAS,GAAG,CAAC,CAAC;CAE9D,OAAO,OACL,IACA,cACA,KACA,MACA;EACE,kBAAkB,OAAO;EACzB,MAAM,OAAO,WACT;GAAC,MAAM;GAAgB,KAAK;GAAI,SAAS,KAAK,MAAM,OAAO,QAAQ;EAAC,IACpE,KAAA;EACJ;EACA;EACA,YAAY,OAAO;EACnB;EACA;EACA;CACF,GACA,YAAY,CAAC,CACf;AACF;AAEA,IAAI,OAAO,kBAAkB;CAC3B,aAAa,IAAI,UAAU,CAAC,QAAQ,MAAM,GAAG,wBAAwB,CAAC;CACtE,KAAK,MAAM,CAAC,OAAO,SAAS,OAAO,QAAQ,OAAO,cAAc,CAAC,CAAC,GAChE,aAAa,IAAI,UAAU,QAAQ,QAAQ,GAAG,GAAG,IAAI;AAEzD;AAEA,aAAa,IAAI,UAAU,CAAC,QAAQ,MAAM,GAAG,wBAAwB,CAAC;AACtE,aAAa,IACX,UAAU,QAAQ,oBAAoB,GACtC,OAAO,cACT;AACA,UAAU;AACV,IAAI,OAAO,kBAAkB;CAC3B,aAAa,IACX,UAAU,CAAC,QAAQ,MAAM,GAAG,+BAA+B,CAC7D;CACA,KAAK,MAAM,UAAU,QAAQ,OAAO,GAClC,aAAa,IACX,UAAU,QAAQ,GAAG,OAAO,YAAY,KAAK,EAAE,GAC/C,MAAM,cAAc,IAAI,OAAO,YAAY,SAAS,CAAC,CACvD;AAEJ;AAEA,aAAa,IACX,UAAU,CAAC,QAAQ,MAAM,GAAG,uCAAuC,CACrE;AACA,IAAM,eAAe,MAAM,gBAAgB;AAC3C,IAAI,cAAc;AAClB,KAAK,MAAM,CAAC,OAAO,YAAY,OAAO,QAAQ,YAAY,GAAG;CAC3D,aAAa,IAAI,UAAU,QAAQ,GAAG,MAAM,EAAE,GAAG,OAAO;CACxD,KAAK,MAAM,SAAS,OAAO,OAAO,OAAO,GACvC,eAAe;AAEnB;AACA,aAAa,IACX,UAAU,QAAQ,qBAAqB,GACvC,oBAAoB,WAAW,CACjC;AAEA,aAAa,IAAI,UAAU,CAAC,QAAQ,MAAM,GAAG,4BAA4B,CAAC;AAC1E,IAAM,gBAAgB,eAAe,MAAM,mBAAmB,KAAK,CAAC,GAAG,EAAE;AACzE,IAAM,gBAAgB,MAAM,eAAe;AAC3C,IAAM,QAAkC;CAAC,GAAG;CAAe,GAAG;AAAa;AAC3E,KAAK,MAAM,CAAC,OAAO,SAAS,OAAO,QAAQ,KAAK,GAAG;CACjD,aAAa,IAAI,UAAU,QAAQ,OAAO,GAAG,KAAK;CAClD,aAAa,IAAI,KAAK,KAAK,KAAK,MAAM,aAAa,KAAK,CAAC,CAAC,EAAE,KAAK,IAAI,CAAC;CACtE,aAAa,IAAI,IAAI;AACvB;AAEA,SAAS,YAAY;CACnB,IAAI,sBAAsB;CAC1B,KAAK,MAAM,UAAU,QAAQ,OAAO,GAAG;EACrC,MAAM,SAAS,OAAO,OACpB,MAAM,mBAAmB,IAAI,OAAO,YAAY,SAAS,CAAC,CAC5D;EACA,KAAK,MAAM,KAAK,QACd,uBAAuB;EAEzB,aAAa,IACX,UAAU,QAAQ,OAAO,YAAY,OAAO,UAAU,GACtD,MAAM,mBAAmB,IAAI,OAAO,YAAY,SAAS,CAAC,CAC5D;CACF;CAEA,aAAa,IACX,UAAU,QAAQ,sBAAsB,GACxC,oBAAoB,mBAAmB,CACzC;CACA,aAAa,IACX,UAAU,QAAQ,OAAO,GACzB,UAAU,OAAO,MAAM,OAAO,KAAK,GACnC,IACF;AACF;AAEA,SAAS,UAAU,UAAkB;CACnC,IAAI,WAAW,KACb,OAAO,UAAU,SAAS,SAAS,QAAQ,CAAC,IAAI,IAAI;MAC/C,IAAI,WAAW,KACpB,OAAO,UAAU,UAAU,SAAS,QAAQ,CAAC,IAAI,IAAI;CAEvD,OAAO,UAAU,OAAO,SAAS,QAAQ,CAAC,IAAI,IAAI;AACpD;AAEA,SAAS,oBAAoB,GAAW;CACtC,IAAI,IAAI,KACN,OAAO,UAAU,SAAS,EAAE,SAAS,CAAC;MACjC,IAAI,IAAI,KACb,OAAO,UAAU,UAAU,EAAE,SAAS,CAAC;CAEzC,OAAO,UAAU,OAAO,EAAE,SAAS,CAAC;AACtC;AAEA,SAAS,aAAa,KAAa,GAAW;CAC5C,IAAI,IAAI,SAAS,MAAM,GAAG;EACxB,IAAI,MAAM,GACR,OAAO,UAAU,UAAU,GAAG;EAEhC,OAAO,UAAU,OAAO,GAAG;CAC7B;CACA,OAAO,UAAU,SAAS,GAAG;AAC/B"}

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

@@ -14,7 +14,7 @@ import { LogContext, consoleLogSink } from "@rocicorp/logger";
 var config = parseOptions({
 	cvr: { db: valita_exports.string() },
 	schema: {
-		type: valita_exports.string().default("./schema.ts"),
+		type: valita_exports.string().optional(() => "./schema.ts"),
 		desc: ["Path to the schema file."]
 	},
 	app: appOptions,

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

@@ -1 +1 @@
-{"version":3,"file":"bin-transform.js","names":[],"sources":["../../../../analyze-query/src/bin-transform.ts"],"sourcesContent":["import '../../shared/src/dotenv.ts';\n\nimport {consoleLogSink, LogContext} from '@rocicorp/logger';\nimport {astToZQL} from '../../ast-to-zql/src/ast-to-zql.ts';\nimport {formatOutput} from '../../ast-to-zql/src/format.ts';\nimport {must} from '../../shared/src/must.ts';\nimport {parseOptions} from '../../shared/src/options.ts';\nimport * as v from '../../shared/src/valita.ts';\nimport {transformAndHashQuery} from '../../zero-cache/src/auth/read-authorizer.ts';\nimport {\n  appOptions,\n  shardOptions,\n  ZERO_ENV_VAR_PREFIX,\n} from '../../zero-cache/src/config/zero-config.ts';\nimport {loadSchemaAndPermissions} from '../../zero-cache/src/scripts/permissions.ts';\nimport {pgClient} from '../../zero-cache/src/types/pg.ts';\nimport {getShardID, upstreamSchema} from '../../zero-cache/src/types/shards.ts';\n\nconst options = {\n  cvr: {db: v.string()},\n  schema: {\n    type: v.string().default('./schema.ts'),\n    desc: ['Path to the schema file.'],\n  },\n  app: appOptions,\n  shard: shardOptions,\n  hash: {\n    type: v.string().optional(),\n    desc: ['Hash of the query to fetch the AST for.'],\n  },\n};\n\nconst config = parseOptions(options, {envNamePrefix: ZERO_ENV_VAR_PREFIX});\n\nconst lc = new LogContext('debug', {}, consoleLogSink);\nconst {permissions} = await loadSchemaAndPermissions(config.schema);\n\nconst cvrDB = pgClient(lc, config.cvr.db, 'analyze-query-transform-cvr');\n\nconst rows =\n  await cvrDB`select \"clientAST\", \"internal\" from ${cvrDB(upstreamSchema(getShardID(config)) + '/cvr')}.\"queries\" where \"queryHash\" = ${must(\n    config.hash,\n  )} limit 1;`;\n\nconst queryAst = transformAndHashQuery(\n  lc,\n  '',\n  rows[0].clientAST,\n  permissions,\n  {\n    type: 'jwt',\n    raw: '',\n    decoded: {},\n  },\n  rows[0].internal,\n).transformedAst;\n\n// oxlint-disable no-console\nconsole.log('\\n=== AST ===\\n');\nconsole.log(JSON.stringify(queryAst, null, 2));\nconsole.log('\\n=== ZQL ===\\n');\nconsole.log(await formatOutput(queryAst.table + astToZQL(queryAst)));\n// oxlint-enable no-console\n\nawait cvrDB.end();\n"],"mappings":";;;;;;;;;;;;;AAgCA,IAAM,SAAS,aAAa;CAb1B,KAAK,EAAC,IAAI,eAAE,OAAO,EAAC;CACpB,QAAQ;EACN,MAAM,eAAE,OAAO,EAAE,QAAQ,aAAa;EACtC,MAAM,CAAC,0BAA0B;CACnC;CACA,KAAK;CACL,OAAO;CACP,MAAM;EACJ,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM,CAAC,yCAAyC;CAClD;AAG0B,GAAS,EAAC,eAAe,oBAAmB,CAAC;AAEzE,IAAM,KAAK,IAAI,WAAW,SAAS,CAAC,GAAG,cAAc;AACrD,IAAM,EAAC,gBAAe,MAAM,yBAAyB,OAAO,MAAM;AAElE,IAAM,QAAQ,SAAS,IAAI,OAAO,IAAI,IAAI,6BAA6B;AAEvE,IAAM,OACJ,MAAM,KAAK,uCAAuC,MAAM,eAAe,WAAW,MAAM,CAAC,IAAI,MAAM,EAAE,iCAAiC,KACpI,OAAO,IACT,EAAE;AAEJ,IAAM,WAAW,sBACf,IACA,IACA,KAAK,GAAG,WACR,aACA;CACE,MAAM;CACN,KAAK;CACL,SAAS,CAAC;AACZ,GACA,KAAK,GAAG,QACV,EAAE;AAGF,QAAQ,IAAI,iBAAiB;AAC7B,QAAQ,IAAI,KAAK,UAAU,UAAU,MAAM,CAAC,CAAC;AAC7C,QAAQ,IAAI,iBAAiB;AAC7B,QAAQ,IAAI,MAAM,aAAa,SAAS,QAAQ,SAAS,QAAQ,CAAC,CAAC;AAGnE,MAAM,MAAM,IAAI"}
+{"version":3,"file":"bin-transform.js","names":[],"sources":["../../../../analyze-query/src/bin-transform.ts"],"sourcesContent":["import '../../shared/src/dotenv.ts';\n\nimport {consoleLogSink, LogContext} from '@rocicorp/logger';\nimport {astToZQL} from '../../ast-to-zql/src/ast-to-zql.ts';\nimport {formatOutput} from '../../ast-to-zql/src/format.ts';\nimport {must} from '../../shared/src/must.ts';\nimport {parseOptions} from '../../shared/src/options.ts';\nimport * as v from '../../shared/src/valita.ts';\nimport {transformAndHashQuery} from '../../zero-cache/src/auth/read-authorizer.ts';\nimport {\n  appOptions,\n  shardOptions,\n  ZERO_ENV_VAR_PREFIX,\n} from '../../zero-cache/src/config/zero-config.ts';\nimport {loadSchemaAndPermissions} from '../../zero-cache/src/scripts/permissions.ts';\nimport {pgClient} from '../../zero-cache/src/types/pg.ts';\nimport {getShardID, upstreamSchema} from '../../zero-cache/src/types/shards.ts';\n\nconst options = {\n  cvr: {db: v.string()},\n  schema: {\n    type: v.string().optional(() => './schema.ts'),\n    desc: ['Path to the schema file.'],\n  },\n  app: appOptions,\n  shard: shardOptions,\n  hash: {\n    type: v.string().optional(),\n    desc: ['Hash of the query to fetch the AST for.'],\n  },\n};\n\nconst config = parseOptions(options, {envNamePrefix: ZERO_ENV_VAR_PREFIX});\n\nconst lc = new LogContext('debug', {}, consoleLogSink);\nconst {permissions} = await loadSchemaAndPermissions(config.schema);\n\nconst cvrDB = pgClient(lc, config.cvr.db, 'analyze-query-transform-cvr');\n\nconst rows =\n  await cvrDB`select \"clientAST\", \"internal\" from ${cvrDB(upstreamSchema(getShardID(config)) + '/cvr')}.\"queries\" where \"queryHash\" = ${must(\n    config.hash,\n  )} limit 1;`;\n\nconst queryAst = transformAndHashQuery(\n  lc,\n  '',\n  rows[0].clientAST,\n  permissions,\n  {\n    type: 'jwt',\n    raw: '',\n    decoded: {},\n  },\n  rows[0].internal,\n).transformedAst;\n\n// oxlint-disable no-console\nconsole.log('\\n=== AST ===\\n');\nconsole.log(JSON.stringify(queryAst, null, 2));\nconsole.log('\\n=== ZQL ===\\n');\nconsole.log(await formatOutput(queryAst.table + astToZQL(queryAst)));\n// oxlint-enable no-console\n\nawait cvrDB.end();\n"],"mappings":";;;;;;;;;;;;;AAgCA,IAAM,SAAS,aAAa;CAb1B,KAAK,EAAC,IAAI,eAAE,OAAO,EAAC;CACpB,QAAQ;EACN,MAAM,eAAE,OAAO,EAAE,eAAe,aAAa;EAC7C,MAAM,CAAC,0BAA0B;CACnC;CACA,KAAK;CACL,OAAO;CACP,MAAM;EACJ,MAAM,eAAE,OAAO,EAAE,SAAS;EAC1B,MAAM,CAAC,yCAAyC;CAClD;AAG0B,GAAS,EAAC,eAAe,oBAAmB,CAAC;AAEzE,IAAM,KAAK,IAAI,WAAW,SAAS,CAAC,GAAG,cAAc;AACrD,IAAM,EAAC,gBAAe,MAAM,yBAAyB,OAAO,MAAM;AAElE,IAAM,QAAQ,SAAS,IAAI,OAAO,IAAI,IAAI,6BAA6B;AAEvE,IAAM,OACJ,MAAM,KAAK,uCAAuC,MAAM,eAAe,WAAW,MAAM,CAAC,IAAI,MAAM,EAAE,iCAAiC,KACpI,OAAO,IACT,EAAE;AAEJ,IAAM,WAAW,sBACf,IACA,IACA,KAAK,GAAG,WACR,aACA;CACE,MAAM;CACN,KAAK;CACL,SAAS,CAAC;AACZ,GACA,KAAK,GAAG,QACV,EAAE;AAGF,QAAQ,IAAI,iBAAiB;AAC7B,QAAQ,IAAI,KAAK,UAAU,UAAU,MAAM,CAAC,CAAC;AAC7C,QAAQ,IAAI,iBAAiB;AAC7B,QAAQ,IAAI,MAAM,aAAa,SAAS,QAAQ,SAAS,QAAQ,CAAC,CAAC;AAGnE,MAAM,MAAM,IAAI"}

package/out/otel/src/log-options.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"log-options.d.ts","sourceRoot":"","sources":["../../../../otel/src/log-options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,MAAM,EAAC,MAAM,mCAAmC,CAAC;AAC9D,OAAO,KAAK,CAAC,MAAM,4BAA4B,CAAC;AAEhD,eAAO,MAAM,QAAQ,6CAAmD,CAAC;AAEzE,eAAO,MAAM,UAAU;IACrB,KAAK;IAEL,MAAM;QACJ,IAAI;QACJ,IAAI;;IAMN,gBAAgB;QACd,IAAI;QACJ,IAAI;;IAKN,oBAAoB;QAClB,IAAI;QACJ,IAAI;;IASN,oBAAoB;QAClB,IAAI;QACJ,IAAI;;IAYN,uBAAuB;QACrB,IAAI;QACJ,IAAI;;IAWN,wBAAwB;QACtB,IAAI;QACJ,IAAI;;IAON,yBAAyB;QACvB,IAAI;QACJ,IAAI;;IAaN,WAAW;QACT,IAAI;QACJ,IAAI;;CAIP,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,UAAU,CAAC,CAAC"}
+{"version":3,"file":"log-options.d.ts","sourceRoot":"","sources":["../../../../otel/src/log-options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,MAAM,EAAC,MAAM,mCAAmC,CAAC;AAC9D,OAAO,KAAK,CAAC,MAAM,4BAA4B,CAAC;AAEhD,eAAO,MAAM,QAAQ,6CAAmD,CAAC;AAEzE,eAAO,MAAM,UAAU;IACrB,KAAK;IAEL,MAAM;QACJ,IAAI;QACJ,IAAI;;IAMN,gBAAgB;QACd,IAAI;QACJ,IAAI;;IAKN,oBAAoB;QAClB,IAAI;QACJ,IAAI;;IASN,oBAAoB;QAClB,IAAI;QACJ,IAAI;;IAYN,uBAAuB;QACrB,IAAI;QACJ,IAAI;;IAWN,wBAAwB;QACtB,IAAI;QACJ,IAAI;;IAON,yBAAyB;QACvB,IAAI;QACJ,IAAI;;IAcN,WAAW;QACT,IAAI;QACJ,IAAI;;CAIP,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,UAAU,CAAC,CAAC"}

package/out/otel/src/log-options.js

@@ -2,17 +2,17 @@ import { literalUnion, valita_exports } from "../../shared/src/valita.js";
 //#region ../otel/src/log-options.ts
 var logLevel = literalUnion("debug", "info", "warn", "error");
 var logOptions = {
-	level: logLevel.default("info"),
+	level: logLevel.optional(() => "info"),
 	format: {
-		type: literalUnion("text", "json").default("text"),
+		type: literalUnion("text", "json").optional(() => "text"),
 		desc: [`Use {bold text} for developer-friendly console logging`, `and {bold json} for consumption by structured-logging services`]
 	},
 	slowRowThreshold: {
-		type: valita_exports.number().default(2),
+		type: valita_exports.number().optional(() => 2),
 		desc: [`The number of ms a row must take to fetch from table-source before it is considered slow.`]
 	},
 	slowHydrateThreshold: {
-		type: valita_exports.number().default(100),
+		type: valita_exports.number().optional(() => 100),
 		desc: [
 			`The number of milliseconds a query hydration must take to print a slow warning.`,
 			``,
@@ -22,7 +22,7 @@ var logOptions = {
 		]
 	},
 	slowAdvanceThreshold: {
-		type: valita_exports.number().default(100),
+		type: valita_exports.number().optional(() => 100),
 		desc: [
 			`The number of milliseconds a query must take to process one advancement`,
 			`(the changes of a replicated transaction, or a batch of them) to print a`,
@@ -35,7 +35,7 @@ var logOptions = {
 		]
 	},
 	planWarningRowThreshold: {
-		type: valita_exports.number().default(1e4),
+		type: valita_exports.number().optional(() => 1e4),
 		desc: [
 			`Log a warning when the query planner estimates that one read of a table`,
 			`scans or sorts at least this many rows: a read that scans the whole`,
@@ -47,7 +47,7 @@ var logOptions = {
 		]
 	},
 	planWarningCostThreshold: {
-		type: valita_exports.number().default(1e6),
+		type: valita_exports.number().optional(() => 1e6),
 		desc: [
 			`Log a warning when the best plan the query planner finds for a query is`,
 			`still estimated to process at least this many rows. Throttled like`,
@@ -55,7 +55,7 @@ var logOptions = {
 		]
 	},
 	queryStatsIntervalSeconds: {
-		type: valita_exports.number().default(60),
+		type: valita_exports.number().optional(() => 60),
 		desc: [
 			`How often each view-syncer worker logs the work done per query shape (the`,
 			`query with its values redacted): the number of hydrations and`,
@@ -65,11 +65,12 @@ var logOptions = {
 			`summed across workers and over time to rank queries by the time they take.`,
 			`Logged at the info level as {bold query-stats} events, for the 100 shapes`,
 			`that took the most time in the interval, plus a {bold query-stats-summary}`,
-			`event with the totals. Set to 0 to disable.`
+			`event with the totals and how often each index of the replica was read.`,
+			`Set to 0 to disable.`
 		]
 	},
 	ivmSampling: {
-		type: valita_exports.number().default(5e3),
+		type: valita_exports.number().optional(() => 5e3),
 		desc: [`How often to collect IVM metrics. 1 out of N requests will be sampled where N is this value.`]
 	}
 };

package/out/otel/src/log-options.js.map

@@ -1 +1 @@
-{"version":3,"file":"log-options.js","names":[],"sources":["../../../../otel/src/log-options.ts"],"sourcesContent":["import {type Config} from '../../shared/src/options-types.ts';\nimport * as v from '../../shared/src/valita.ts';\n\nexport const logLevel = v.literalUnion('debug', 'info', 'warn', 'error');\n\nexport const logOptions = {\n  level: logLevel.default('info'),\n\n  format: {\n    type: v.literalUnion('text', 'json').default('text'),\n    desc: [\n      `Use {bold text} for developer-friendly console logging`,\n      `and {bold json} for consumption by structured-logging services`,\n    ],\n  },\n\n  slowRowThreshold: {\n    type: v.number().default(2),\n    desc: [\n      `The number of ms a row must take to fetch from table-source before it is considered slow.`,\n    ],\n  },\n\n  slowHydrateThreshold: {\n    type: v.number().default(100),\n    desc: [\n      `The number of milliseconds a query hydration must take to print a slow warning.`,\n      ``,\n      `The warning logs the query with its literal values redacted, and is logged`,\n      `at most once every 5 minutes per query shape (the query with its values`,\n      `redacted), with a count of the slow hydrations suppressed in between.`,\n    ],\n  },\n\n  slowAdvanceThreshold: {\n    type: v.number().default(100),\n    desc: [\n      `The number of milliseconds a query must take to process one advancement`,\n      `(the changes of a replicated transaction, or a batch of them) to print a`,\n      `slow warning.`,\n      ``,\n      `Like {bold slowHydrateThreshold}, the warning logs the query with its values`,\n      `redacted, at most once every 5 minutes per query shape. When an advancement`,\n      `times out and resets the pipelines, the queries that took the most time are`,\n      `logged regardless of this threshold.`,\n    ],\n  },\n\n  planWarningRowThreshold: {\n    type: v.number().default(10_000),\n    desc: [\n      `Log a warning when the query planner estimates that one read of a table`,\n      `scans or sorts at least this many rows: a read that scans the whole`,\n      `table because no index covers the columns it looks rows up by, or that`,\n      `sorts every matching row because no index covers the ordering.`,\n      ``,\n      `The warning is logged at most once an hour per query shape (the query`,\n      `with its values redacted). Set to 0 to disable. Requires the query planner.`,\n    ],\n  },\n\n  planWarningCostThreshold: {\n    type: v.number().default(1_000_000),\n    desc: [\n      `Log a warning when the best plan the query planner finds for a query is`,\n      `still estimated to process at least this many rows. Throttled like`,\n      `{bold planWarningRowThreshold}. Set to 0 to disable.`,\n    ],\n  },\n\n  queryStatsIntervalSeconds: {\n    type: v.number().default(60),\n    desc: [\n      `How often each view-syncer worker logs the work done per query shape (the`,\n      `query with its values redacted): the number of hydrations and`,\n      `advancements, the time they took, and the rows they read and output.`,\n      ``,\n      `Unlike the slow query warnings, every query is counted, so the logs can be`,\n      `summed across workers and over time to rank queries by the time they take.`,\n      `Logged at the info level as {bold query-stats} events, for the 100 shapes`,\n      `that took the most time in the interval, plus a {bold query-stats-summary}`,\n      `event with the totals. Set to 0 to disable.`,\n    ],\n  },\n\n  ivmSampling: {\n    type: v.number().default(5000),\n    desc: [\n      `How often to collect IVM metrics. 1 out of N requests will be sampled where N is this value.`,\n    ],\n  },\n};\n\nexport type LogConfig = Config<typeof logOptions>;\n"],"mappings":";;AAGA,IAAa,WAAW,aAAe,SAAS,QAAQ,QAAQ,OAAO;AAEvE,IAAa,aAAa;CACxB,OAAO,SAAS,QAAQ,MAAM;CAE9B,QAAQ;EACN,MAAM,aAAe,QAAQ,MAAM,EAAE,QAAQ,MAAM;EACnD,MAAM,CACJ,0DACA,gEACF;CACF;CAEA,kBAAkB;EAChB,MAAM,eAAE,OAAO,EAAE,QAAQ,CAAC;EAC1B,MAAM,CACJ,2FACF;CACF;CAEA,sBAAsB;EACpB,MAAM,eAAE,OAAO,EAAE,QAAQ,GAAG;EAC5B,MAAM;GACJ;GACA;GACA;GACA;GACA;EACF;CACF;CAEA,sBAAsB;EACpB,MAAM,eAAE,OAAO,EAAE,QAAQ,GAAG;EAC5B,MAAM;GACJ;GACA;GACA;GACA;GACA;GACA;GACA;GACA;EACF;CACF;CAEA,yBAAyB;EACvB,MAAM,eAAE,OAAO,EAAE,QAAQ,GAAM;EAC/B,MAAM;GACJ;GACA;GACA;GACA;GACA;GACA;GACA;EACF;CACF;CAEA,0BAA0B;EACxB,MAAM,eAAE,OAAO,EAAE,QAAQ,GAAS;EAClC,MAAM;GACJ;GACA;GACA;EACF;CACF;CAEA,2BAA2B;EACzB,MAAM,eAAE,OAAO,EAAE,QAAQ,EAAE;EAC3B,MAAM;GACJ;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;EACF;CACF;CAEA,aAAa;EACX,MAAM,eAAE,OAAO,EAAE,QAAQ,GAAI;EAC7B,MAAM,CACJ,8FACF;CACF;AACF"}
+{"version":3,"file":"log-options.js","names":[],"sources":["../../../../otel/src/log-options.ts"],"sourcesContent":["import {type Config} from '../../shared/src/options-types.ts';\nimport * as v from '../../shared/src/valita.ts';\n\nexport const logLevel = v.literalUnion('debug', 'info', 'warn', 'error');\n\nexport const logOptions = {\n  level: logLevel.optional(() => 'info'),\n\n  format: {\n    type: v.literalUnion('text', 'json').optional(() => 'text'),\n    desc: [\n      `Use {bold text} for developer-friendly console logging`,\n      `and {bold json} for consumption by structured-logging services`,\n    ],\n  },\n\n  slowRowThreshold: {\n    type: v.number().optional(() => 2),\n    desc: [\n      `The number of ms a row must take to fetch from table-source before it is considered slow.`,\n    ],\n  },\n\n  slowHydrateThreshold: {\n    type: v.number().optional(() => 100),\n    desc: [\n      `The number of milliseconds a query hydration must take to print a slow warning.`,\n      ``,\n      `The warning logs the query with its literal values redacted, and is logged`,\n      `at most once every 5 minutes per query shape (the query with its values`,\n      `redacted), with a count of the slow hydrations suppressed in between.`,\n    ],\n  },\n\n  slowAdvanceThreshold: {\n    type: v.number().optional(() => 100),\n    desc: [\n      `The number of milliseconds a query must take to process one advancement`,\n      `(the changes of a replicated transaction, or a batch of them) to print a`,\n      `slow warning.`,\n      ``,\n      `Like {bold slowHydrateThreshold}, the warning logs the query with its values`,\n      `redacted, at most once every 5 minutes per query shape. When an advancement`,\n      `times out and resets the pipelines, the queries that took the most time are`,\n      `logged regardless of this threshold.`,\n    ],\n  },\n\n  planWarningRowThreshold: {\n    type: v.number().optional(() => 10_000),\n    desc: [\n      `Log a warning when the query planner estimates that one read of a table`,\n      `scans or sorts at least this many rows: a read that scans the whole`,\n      `table because no index covers the columns it looks rows up by, or that`,\n      `sorts every matching row because no index covers the ordering.`,\n      ``,\n      `The warning is logged at most once an hour per query shape (the query`,\n      `with its values redacted). Set to 0 to disable. Requires the query planner.`,\n    ],\n  },\n\n  planWarningCostThreshold: {\n    type: v.number().optional(() => 1_000_000),\n    desc: [\n      `Log a warning when the best plan the query planner finds for a query is`,\n      `still estimated to process at least this many rows. Throttled like`,\n      `{bold planWarningRowThreshold}. Set to 0 to disable.`,\n    ],\n  },\n\n  queryStatsIntervalSeconds: {\n    type: v.number().optional(() => 60),\n    desc: [\n      `How often each view-syncer worker logs the work done per query shape (the`,\n      `query with its values redacted): the number of hydrations and`,\n      `advancements, the time they took, and the rows they read and output.`,\n      ``,\n      `Unlike the slow query warnings, every query is counted, so the logs can be`,\n      `summed across workers and over time to rank queries by the time they take.`,\n      `Logged at the info level as {bold query-stats} events, for the 100 shapes`,\n      `that took the most time in the interval, plus a {bold query-stats-summary}`,\n      `event with the totals and how often each index of the replica was read.`,\n      `Set to 0 to disable.`,\n    ],\n  },\n\n  ivmSampling: {\n    type: v.number().optional(() => 5000),\n    desc: [\n      `How often to collect IVM metrics. 1 out of N requests will be sampled where N is this value.`,\n    ],\n  },\n};\n\nexport type LogConfig = Config<typeof logOptions>;\n"],"mappings":";;AAGA,IAAa,WAAW,aAAe,SAAS,QAAQ,QAAQ,OAAO;AAEvE,IAAa,aAAa;CACxB,OAAO,SAAS,eAAe,MAAM;CAErC,QAAQ;EACN,MAAM,aAAe,QAAQ,MAAM,EAAE,eAAe,MAAM;EAC1D,MAAM,CACJ,0DACA,gEACF;CACF;CAEA,kBAAkB;EAChB,MAAM,eAAE,OAAO,EAAE,eAAe,CAAC;EACjC,MAAM,CACJ,2FACF;CACF;CAEA,sBAAsB;EACpB,MAAM,eAAE,OAAO,EAAE,eAAe,GAAG;EACnC,MAAM;GACJ;GACA;GACA;GACA;GACA;EACF;CACF;CAEA,sBAAsB;EACpB,MAAM,eAAE,OAAO,EAAE,eAAe,GAAG;EACnC,MAAM;GACJ;GACA;GACA;GACA;GACA;GACA;GACA;GACA;EACF;CACF;CAEA,yBAAyB;EACvB,MAAM,eAAE,OAAO,EAAE,eAAe,GAAM;EACtC,MAAM;GACJ;GACA;GACA;GACA;GACA;GACA;GACA;EACF;CACF;CAEA,0BAA0B;EACxB,MAAM,eAAE,OAAO,EAAE,eAAe,GAAS;EACzC,MAAM;GACJ;GACA;GACA;EACF;CACF;CAEA,2BAA2B;EACzB,MAAM,eAAE,OAAO,EAAE,eAAe,EAAE;EAClC,MAAM;GACJ;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;EACF;CACF;CAEA,aAAa;EACX,MAAM,eAAE,OAAO,EAAE,eAAe,GAAI;EACpC,MAAM,CACJ,8FACF;CACF;AACF"}

package/out/replicache/src/persist/clients.d.ts

@@ -20,7 +20,7 @@ declare const clientV5Schema: valita.ObjectType<Readonly<{
      * The hash of a commit we are in the middle of refreshing into this client's
      * memdag.
      */
-    tempRefreshHash: valita.Type<Hash | null>;
+    tempRefreshHash: valita.UnionType<[valita.Type<null>, valita.Type<Hash>]>;
     /**
      * ID of this client's perdag client group. This needs to be sent in pull
      * request (to enable syncing all last mutation ids in the client group).
@@ -47,7 +47,7 @@ declare const clientV6Schema: valita.ObjectType<Readonly<{
      * The hash of the last snapshot commit persisted by this client to this
      * client's client group, or null if has never persisted a snapshot.
      */
-    persistHash: valita.Type<Hash | null>;
+    persistHash: valita.UnionType<[valita.Type<null>, valita.Type<Hash>]>;
     /**
      * ID of this client's perdag client group. This needs to be sent in pull
      * request (to enable syncing all last mutation ids in the client group).

package/out/shared/src/options-types.d.ts

@@ -29,13 +29,13 @@ export type Group = Record<string, Option>;
  *
  * ```ts
  * {
- *   port: v.number().default(8080),
+ *   port: v.number().optional(() => 8080),
  *
  *   numWorkers: v.number(),
  *
  *   log: {
  *     level: v.union(v.literal('debug'), v.literal('info'), ...),
- *     format: v.union(v.literal('text'), v.literal('json')).default('text'),
+ *     format: v.union(v.literal('text'), v.literal('json')).optional(() => 'text'),
  *   }
  * }
  * ```

package/out/shared/src/options.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../../../shared/src/options.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,kBAAkB,CAAC;AASrD,OAAO,KAAK,EACV,MAAM,EACN,KAAK,EACL,MAAM,EACN,OAAO,EACP,iBAAiB,EAClB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,CAAC,MAAM,aAAa,CAAC;AAEjC,YAAY,EAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,EAAC,CAAC;AAiFhE;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,aAAa,SAAK;;cAgC1E;AAeD,MAAM,MAAM,YAAY,GAAG;IACzB,wCAAwC;IACxC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,WAAW,CAAC,EAAE;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAC,EAAE,CAAC;IAElD,0BAA0B;IAC1B,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,0BAA0B;IAC1B,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,iCAAiC;IACjC,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;IAExB,0BAA0B;IAC1B,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC,sGAAsG;IACtG,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,4BAA4B;IAC5B,MAAM,CAAC,EAAE,cAAc,CAAC;IAExB,iCAAiC;IACjC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,KAAK,KAAK,CAAC;CACjD,CAAC;AAEF,wBAAgB,YAAY,CAAC,CAAC,SAAS,OAAO,EAC5C,UAAU,EAAE,CAAC,EACb,IAAI,GAAE,YAAiB,GACtB,MAAM,CAAC,CAAC,CAAC,CAEX;AAED,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,OAAO,EACpD,UAAU,EAAE,CAAC,EACb,IAAI,GAAE,YAAiB,GACtB;IAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;CAAC,CA0KtE;AA6FD,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAE9D;AAED,wBAAgB,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,WAQ7D"}
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../../../shared/src/options.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,kBAAkB,CAAC;AASrD,OAAO,KAAK,EACV,MAAM,EACN,KAAK,EACL,MAAM,EACN,OAAO,EACP,iBAAiB,EAClB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,CAAC,MAAM,aAAa,CAAC;AAEjC,YAAY,EAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,EAAC,CAAC;AAiFhE;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,aAAa,SAAK;;cAgC1E;AAUD,MAAM,MAAM,YAAY,GAAG;IACzB,wCAAwC;IACxC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,WAAW,CAAC,EAAE;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAC,EAAE,CAAC;IAElD,0BAA0B;IAC1B,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,0BAA0B;IAC1B,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,iCAAiC;IACjC,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;IAExB,0BAA0B;IAC1B,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC,sGAAsG;IACtG,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,4BAA4B;IAC5B,MAAM,CAAC,EAAE,cAAc,CAAC;IAExB,iCAAiC;IACjC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,KAAK,KAAK,CAAC;CACjD,CAAC;AAEF,wBAAgB,YAAY,CAAC,CAAC,SAAS,OAAO,EAC5C,UAAU,EAAE,CAAC,EACb,IAAI,GAAE,YAAiB,GACtB,MAAM,CAAC,CAAC,CAAC,CAEX;AAED,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,OAAO,EACpD,UAAU,EAAE,CAAC,EACb,IAAI,GAAE,YAAiB,GACtB;IAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;CAAC,CA+KtE;AA6FD,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAE9D;AAED,wBAAgB,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,WAQ7D"}

package/out/shared/src/options.js

@@ -1,5 +1,5 @@
 import { assert } from "./asserts.js";
-import { deepPartial, instanceOfAbstractType, parse, testOptional, valita_exports } from "./valita.js";
+import { deepPartial, instanceOfAbstractType, parse, testOptional, toTerminals, valita_exports } from "./valita.js";
 import { must } from "./must.js";
 import { stripVTControlCharacters } from "node:util";
 import { template } from "chalk-template";
@@ -57,16 +57,16 @@ function parseOptionsAdvanced(appOptions, opts = {}) {
 		let multiple = type.name === "array";
 		const literals = /* @__PURE__ */ new Set();
 		const terminalTypes = /* @__PURE__ */ new Set();
-		type.toTerminals(getTerminalTypes);
+		toTerminals(type, getTerminalTypes);
 		function getTerminalTypes(t) {
 			switch (t.name) {
 				case "undefined":
 				case "optional": break;
 				case "array":
 					multiple = true;
-					t.prefix.forEach((t) => t.toTerminals(getTerminalTypes));
-					t.rest?.toTerminals(getTerminalTypes);
-					t.suffix.forEach((t) => t.toTerminals(getTerminalTypes));
+					t.prefix.forEach((t) => toTerminals(t, getTerminalTypes));
+					if (t.restType) toTerminals(t.restType, getTerminalTypes);
+					t.suffix.forEach((t) => toTerminals(t, getTerminalTypes));
 					break;
 				case "literal":
 					literals.add(String(t.value));
@@ -81,8 +81,11 @@ function parseOptionsAdvanced(appOptions, opts = {}) {
 		if (terminalTypes.size > 1) throw new TypeError(`${env} has mixed types ${[...terminalTypes]}`);
 		assert(terminalTypes.size === 1, "Expected exactly one terminal type");
 		const terminalType = [...terminalTypes][0];
-		if (processEnv[env]) if (multiple) envArgv.push(`--${flag}`, ...processEnv[env].split(","));
-		else envArgv.push(`--${flag}`, processEnv[env]);
+		const value = processEnv[env];
+		if (value) {
+			const values = multiple ? value.split(",") : [value];
+			envArgv.push(...values.map((val) => `--${flag}=${val}`));
+		}
 		names.set(flag, {
 			field,
 			env

package/out/shared/src/options.js.map

@@ -1 +1 @@
-{"version":3,"file":"options.js","names":[],"sources":["../../../../shared/src/options.ts"],"sourcesContent":["import {stripVTControlCharacters as stripAnsi} from 'node:util';\nimport type {OptionalLogger} from '@rocicorp/logger';\nimport {template} from 'chalk-template';\nimport type {OptionDefinition} from 'command-line-args';\nimport commandLineArgs from 'command-line-args';\nimport commandLineUsage, {type Section} from 'command-line-usage';\nimport {createDefu} from 'defu';\nimport {toKebabCase, toSnakeCase} from 'kasi';\nimport {assert} from './asserts.ts';\nimport {must} from './must.ts';\nimport type {\n  Config,\n  Group,\n  Option,\n  Options,\n  WrappedOptionType,\n} from './options-types.ts';\nimport * as v from './valita.ts';\n\nexport type {Config, Group, Option, Options, WrappedOptionType};\n\ntype Primitive = number | string | boolean;\ntype Value = Primitive | Array<Primitive>;\n\ntype RequiredOptionType =\n  | v.Type<string>\n  | v.Type<number>\n  | v.Type<boolean>\n  | v.Type<string[]>\n  | v.Type<number[]>\n  | v.Type<boolean[]>;\n\ntype OptionalOptionType =\n  | v.Optional<string>\n  | v.Optional<number>\n  | v.Optional<boolean>\n  | v.Optional<string[]>\n  | v.Optional<number[]>\n  | v.Optional<boolean[]>;\n\ntype OptionType = RequiredOptionType | OptionalOptionType;\n\n/**\n * Creates a defu instance that overrides arrays instead of merging them.\n */\nconst defu = createDefu((obj, key, value) => {\n  if (!Array.isArray(value)) return;\n\n  obj[key] = value;\n  return true;\n});\n\n/**\n * Converts an Options instance into its corresponding {@link Config} schema.\n */\nfunction configSchema<T extends Options>(\n  options: T,\n  envNamePrefix: string,\n): v.Type<Config<T>> {\n  function makeObjectType(options: Options | Group, group?: string) {\n    return v.object(\n      Object.fromEntries(\n        Object.entries(options).map(\n          ([name, value]): [string, OptionType | v.Type] => {\n            const addErrorMessage = (t: OptionType) => {\n              const {required} = getRequiredOrDefault(t);\n              if (required) {\n                // Adds an error message for required options that includes the\n                // actual name of the option.\n                const optionName = toSnakeCase(\n                  `${envNamePrefix}${group ? group + '_' : ''}${name}`,\n                ).toUpperCase();\n                return (t as v.Type<string>)\n                  .optional()\n                  .assert(\n                    val => val !== undefined,\n                    `Missing required option ${optionName}`,\n                  );\n              }\n              return t;\n            };\n            // OptionType\n            if (v.instanceOfAbstractType(value)) {\n              return [name, addErrorMessage(value)];\n            }\n            // WrappedOptionType\n            const {type} = value;\n            if (v.instanceOfAbstractType(type)) {\n              return [name, addErrorMessage(type)];\n            }\n            // OptionGroup\n            return [name, makeObjectType(value as Group, name)];\n          },\n        ),\n      ),\n    );\n  }\n  return makeObjectType(options) as v.Type<Config<T>>;\n}\n\n/**\n * Converts an Options instance into an \"env schema\", which is an object with\n * ENV names as its keys, mapped to optional or required string values\n * (corresponding to the optionality of the corresponding options).\n *\n * This is used as a format for encoding options for a multi-tenant version\n * of an app, with an envSchema for each tenant.\n */\nexport function envSchema<T extends Options>(options: T, envNamePrefix = '') {\n  const fields: [string, v.Type<string> | v.Optional<string>][] = [];\n\n  function addField(name: string, type: OptionType, group?: string) {\n    const flag = group ? `${group}_${name}` : name;\n    const env = toSnakeCase(`${envNamePrefix}${flag}`).toUpperCase();\n\n    const {required} = getRequiredOrDefault(type);\n    fields.push([env, required ? v.string() : v.string().optional()]);\n  }\n\n  function addFields(o: Options | Group, group?: string) {\n    Object.entries(o).forEach(([name, value]) => {\n      // OptionType\n      if (v.instanceOfAbstractType(value)) {\n        addField(name, value, group);\n        return;\n      }\n      // WrappedOptionType\n      const {type} = value;\n      if (v.instanceOfAbstractType(type)) {\n        addField(name, type, group);\n        return;\n      }\n      // OptionGroup\n      addFields(value as Group, name);\n    });\n  }\n\n  addFields(options);\n\n  return v.object(Object.fromEntries(fields));\n}\n\n// type TerminalType is not exported from badrap/valita\ntype TerminalType = Parameters<\n  Parameters<v.Type<unknown>['toTerminals']>[0]\n>[0];\n\nfunction getRequiredOrDefault(type: OptionType) {\n  const defaultResult = v.testOptional<Value>(undefined, type);\n  return {\n    required: !defaultResult.ok,\n    defaultValue: defaultResult.ok ? defaultResult.value : undefined,\n  };\n}\n\nexport type ParseOptions = {\n  /** Defaults to process.argv.slice(2) */\n  argv?: string[];\n\n  envNamePrefix?: string;\n\n  description?: {header: string; content: string}[];\n\n  /** Defaults to `false` */\n  allowUnknown?: boolean;\n\n  /** Defaults to `false` */\n  allowPartial?: boolean;\n\n  /** Defaults to `process.env`. */\n  env?: NodeJS.ProcessEnv;\n\n  /** Defaults to `true`. */\n  emitDeprecationWarnings?: boolean;\n\n  /** Defaults to `true`. When false, excludes default values from both config and env return values. */\n  includeDefaults?: boolean;\n\n  /** Defaults to `console` */\n  logger?: OptionalLogger;\n\n  /** Defaults to `process.exit` */\n  exit?: (code?: number | string | null) => never;\n};\n\nexport function parseOptions<T extends Options>(\n  appOptions: T,\n  opts: ParseOptions = {},\n): Config<T> {\n  return parseOptionsAdvanced(appOptions, opts).config;\n}\n\nexport function parseOptionsAdvanced<T extends Options>(\n  appOptions: T,\n  opts: ParseOptions = {},\n): {config: Config<T>; env: Record<string, string>; unknown?: string[]} {\n  const {\n    argv = process.argv.slice(2),\n    envNamePrefix = '',\n    description = [],\n    allowUnknown = false,\n    allowPartial = false,\n    env: processEnv = process.env,\n    emitDeprecationWarnings = true,\n    includeDefaults = true,\n    logger = console,\n    exit = process.exit,\n  } = opts;\n  // The main logic for converting a valita Type spec to an Option (i.e. flag) spec.\n  function addOption(field: string, option: WrappedOptionType, group?: string) {\n    const {type, desc = [], deprecated, alias, hidden} = option;\n\n    // The group name is prepended to the flag name.\n    const flag = group ? toKebabCase(`${group}-${field}`) : toKebabCase(field);\n\n    const {required, defaultValue} = getRequiredOrDefault(type);\n    let multiple = type.name === 'array';\n    const literals = new Set<string>();\n    const terminalTypes = new Set<string>();\n\n    type.toTerminals(getTerminalTypes);\n\n    function getTerminalTypes(t: TerminalType) {\n      switch (t.name) {\n        case 'undefined':\n        case 'optional':\n          break;\n        case 'array': {\n          multiple = true;\n          t.prefix.forEach(t => t.toTerminals(getTerminalTypes));\n          t.rest?.toTerminals(getTerminalTypes);\n          t.suffix.forEach(t => t.toTerminals(getTerminalTypes));\n          break;\n        }\n        case 'literal':\n          literals.add(String(t.value));\n          terminalTypes.add(typeof t.value);\n          break;\n        default:\n          terminalTypes.add(t.name);\n          break;\n      }\n    }\n    const env = toSnakeCase(`${envNamePrefix}${flag}`).toUpperCase();\n    if (terminalTypes.size > 1) {\n      throw new TypeError(`${env} has mixed types ${[...terminalTypes]}`);\n    }\n    assert(terminalTypes.size === 1, 'Expected exactly one terminal type');\n    const terminalType = [...terminalTypes][0];\n\n    if (processEnv[env]) {\n      if (multiple) {\n        // Technically not water-tight; assumes values for the string[] flag don't contain commas.\n        envArgv.push(`--${flag}`, ...processEnv[env].split(','));\n      } else {\n        envArgv.push(`--${flag}`, processEnv[env]);\n      }\n    }\n    names.set(flag, {field, env});\n\n    const spec = [\n      (required\n        ? '{italic required}'\n        : defaultValue !== undefined\n          ? `default: ${JSON.stringify(defaultValue)}`\n          : 'optional') + '\\n',\n    ];\n    if (desc) {\n      spec.push(...desc);\n    }\n\n    const typeLabel = [\n      literals.size\n        ? String(Array.from(literals, l => `{underline ${l}}`))\n        : multiple\n          ? `{underline ${terminalType}[]}`\n          : `{underline ${terminalType}}`,\n      `  ${env} env`,\n    ];\n\n    const opt = {\n      name: flag,\n      alias,\n      type: valueParser(\n        env,\n        terminalType,\n        logger,\n        emitDeprecationWarnings ? deprecated : undefined,\n      ),\n      multiple,\n      group,\n      description: spec.join('\\n') + '\\n',\n      typeLabel: typeLabel.join('\\n') + '\\n',\n      hidden: hidden === undefined ? deprecated !== undefined : hidden,\n    };\n    optsWithoutDefaults.push(opt);\n    optsWithDefaults.push({...opt, defaultValue});\n  }\n\n  const names = new Map<string, {field: string; env: string}>();\n  const optsWithDefaults: DescribedOptionDefinition[] = [];\n  const optsWithoutDefaults: DescribedOptionDefinition[] = [];\n  const envArgv: string[] = [];\n\n  try {\n    for (const [name, val] of Object.entries(appOptions)) {\n      const {type} = val as {type: unknown};\n      if (v.instanceOfAbstractType(val)) {\n        addOption(name, {type: val});\n      } else if (v.instanceOfAbstractType(type)) {\n        addOption(name, val as WrappedOptionType);\n      } else {\n        const group = name;\n        for (const [name, option] of Object.entries(val as Group)) {\n          const wrapped = v.instanceOfAbstractType(option)\n            ? {type: option}\n            : option;\n          addOption(name, wrapped, group);\n        }\n      }\n    }\n\n    const [defaults, env1, unknown] = parseArgs(optsWithDefaults, argv, names);\n    const [fromEnv, env2] = parseArgs(optsWithoutDefaults, envArgv, names);\n    const [withoutDefaults, env3] = parseArgs(optsWithoutDefaults, argv, names);\n\n    switch (unknown?.[0]) {\n      case undefined:\n        break;\n      case '--help':\n      case '-h':\n        showUsage(optsWithDefaults, description, logger);\n        exit(0);\n        break;\n      default:\n        if (!allowUnknown) {\n          logger.error?.('Invalid arguments:', unknown);\n          showUsage(optsWithDefaults, description, logger);\n          exit(0);\n        }\n        break;\n    }\n\n    const parsedArgs = includeDefaults\n      ? defu(withoutDefaults, fromEnv, defaults)\n      : defu(withoutDefaults, fromEnv);\n    const env = includeDefaults\n      ? {...env1, ...env2, ...env3}\n      : {...env2, ...env3};\n\n    let schema = configSchema(appOptions, envNamePrefix);\n    if (allowPartial || !includeDefaults) {\n      // TODO: Type configSchema() to return a v.ObjectType<...>\n      schema = v.deepPartial(schema as v.ObjectType) as v.Type<Config<T>>;\n    }\n    return {\n      config: v.parse(parsedArgs, schema),\n      env,\n      ...(unknown ? {unknown} : {}),\n    };\n  } catch (e) {\n    logger.error?.(String(e));\n    showUsage(optsWithDefaults, description, logger);\n    throw e;\n  }\n}\n\nfunction valueParser(\n  optionName: string,\n  typeName: string,\n  logger: OptionalLogger,\n  deprecated: string[] | undefined,\n) {\n  return (input: string) => {\n    if (deprecated) {\n      logger.warn?.(\n        template(\n          `\\n${optionName} is deprecated:\\n` + deprecated.join('\\n') + '\\n',\n        ),\n      );\n    }\n    switch (typeName) {\n      case 'string':\n        return input;\n      case 'boolean':\n        return parseBoolean(optionName, input);\n      case 'number': {\n        const val = Number(input);\n        if (Number.isNaN(val)) {\n          throw new TypeError(`Invalid input for ${optionName}: \"${input}\"`);\n        }\n        return val;\n      }\n      default:\n        // Should be impossible given the constraints of `Option`\n        throw new TypeError(\n          `${optionName} option has unsupported type ${typeName}`,\n        );\n    }\n  };\n}\n\nfunction parseArgs(\n  optionDefs: DescribedOptionDefinition[],\n  argv: string[],\n  names: Map<string, {field: string; env: string}>,\n) {\n  function normalizeFlagValue(value: unknown) {\n    // A --flag without value is parsed by commandLineArgs() to `null`,\n    // but this is a common convention to set a boolean flag to true.\n    return value === null ? true : value;\n  }\n\n  const {\n    _all,\n    _none: ungrouped,\n    _unknown: unknown,\n    ...config\n  } = commandLineArgs(optionDefs, {\n    argv,\n    partial: true,\n  });\n\n  // oxlint-disable-next-line @typescript-eslint/no-explicit-any\n  const result: Record<string, any> = {};\n  const envObj: Record<string, string> = {};\n\n  function addFlag(flagName: string, value: unknown, group?: string) {\n    const {field, env} = must(names.get(flagName));\n    const normalized = normalizeFlagValue(value);\n    if (group) {\n      result[group][field] = normalized;\n    } else {\n      result[field] = normalized;\n    }\n    envObj[env] = String(normalized);\n  }\n\n  for (const [flagName, value] of Object.entries(ungrouped ?? {})) {\n    addFlag(flagName, value);\n  }\n\n  // Then handle (potentially) grouped flags\n  for (const [name, value] of Object.entries(config)) {\n    if (typeof value !== 'object' || value === null || Array.isArray(value)) {\n      addFlag(name, value); // Flag, not a group\n    } else {\n      const group = name;\n      result[group] = {};\n      for (const [flagName, flagValue] of Object.entries(value)) {\n        addFlag(flagName, flagValue, group);\n      }\n    }\n  }\n\n  return [result, envObj, unknown] as const;\n}\n\nexport function flagToEnv(prefix: string, flag: string): string {\n  return toSnakeCase(prefix + flag).toUpperCase();\n}\n\nexport function parseBoolean(optionName: string, input: string) {\n  const bool = input.toLowerCase();\n  if (['true', '1'].includes(bool)) {\n    return true;\n  } else if (['false', '0'].includes(bool)) {\n    return false;\n  }\n  throw new TypeError(`Invalid input for ${optionName}: \"${input}\"`);\n}\n\nfunction showUsage(\n  optionList: DescribedOptionDefinition[],\n  description: {header: string; content: string}[] = [],\n  logger: OptionalLogger = console,\n) {\n  const hide: string[] = [];\n  let leftWidth = 35;\n  let rightWidth = 70;\n  optionList.forEach(({name, typeLabel, description, hidden}) => {\n    if (hidden) {\n      hide.push(name);\n    }\n    const text = template(`${name} ${typeLabel ?? ''}`);\n    const lines = stripAnsi(text).split('\\n');\n    for (const l of lines) {\n      leftWidth = Math.max(leftWidth, l.length + 2);\n    }\n    const desc = stripAnsi(template(description ?? '')).split('\\n');\n    for (const l of desc) {\n      rightWidth = Math.max(rightWidth, l.length + 2);\n    }\n  });\n\n  const sections: Section[] = [\n    {\n      optionList,\n      reverseNameOrder: true, // Display --flag-name before -alias\n      hide,\n      tableOptions: {\n        columns: [\n          {name: 'option', width: leftWidth},\n          {name: 'description', width: rightWidth},\n        ],\n        noTrim: true,\n      },\n    },\n  ];\n\n  if (description) {\n    sections.unshift(...description);\n  }\n\n  logger.info?.(commandLineUsage(sections));\n}\n\ntype DescribedOptionDefinition = OptionDefinition & {\n  // Additional fields recognized by command-line-usage\n  description?: string;\n  typeLabel?: string | undefined;\n  hidden?: boolean | undefined;\n};\n"],"mappings":";;;;;;;;;;;;;AA6CA,IAAM,SAAO,YAAY,KAAK,KAAK,UAAU;CAC3C,IAAI,CAAC,MAAM,QAAQ,KAAK,GAAG;CAE3B,IAAI,OAAO;CACX,OAAO;AACT,CAAC;;;;AAKD,SAAS,aACP,SACA,eACmB;CACnB,SAAS,eAAe,SAA0B,OAAgB;EAChE,OAAO,eAAE,OACP,OAAO,YACL,OAAO,QAAQ,OAAO,EAAE,KACrB,CAAC,MAAM,WAA0C;GAChD,MAAM,mBAAmB,MAAkB;IACzC,MAAM,EAAC,aAAY,qBAAqB,CAAC;IACzC,IAAI,UAAU;KAGZ,MAAM,aAAa,YACjB,GAAG,gBAAgB,QAAQ,QAAQ,MAAM,KAAK,MAChD,EAAE,YAAY;KACd,OAAQ,EACL,SAAS,EACT,QACC,QAAO,QAAQ,KAAA,GACf,2BAA2B,YAC7B;IACJ;IACA,OAAO;GACT;GAEA,IAAI,uBAAyB,KAAK,GAChC,OAAO,CAAC,MAAM,gBAAgB,KAAK,CAAC;GAGtC,MAAM,EAAC,SAAQ;GACf,IAAI,uBAAyB,IAAI,GAC/B,OAAO,CAAC,MAAM,gBAAgB,IAAI,CAAC;GAGrC,OAAO,CAAC,MAAM,eAAe,OAAgB,IAAI,CAAC;EACpD,CACF,CACF,CACF;CACF;CACA,OAAO,eAAe,OAAO;AAC/B;AAiDA,SAAS,qBAAqB,MAAkB;CAC9C,MAAM,gBAAgB,aAAsB,KAAA,GAAW,IAAI;CAC3D,OAAO;EACL,UAAU,CAAC,cAAc;EACzB,cAAc,cAAc,KAAK,cAAc,QAAQ,KAAA;CACzD;AACF;AAgCA,SAAgB,aACd,YACA,OAAqB,CAAC,GACX;CACX,OAAO,qBAAqB,YAAY,IAAI,EAAE;AAChD;AAEA,SAAgB,qBACd,YACA,OAAqB,CAAC,GACgD;CACtE,MAAM,EACJ,OAAO,QAAQ,KAAK,MAAM,CAAC,GAC3B,gBAAgB,IAChB,cAAc,CAAC,GACf,eAAe,OACf,eAAe,OACf,KAAK,aAAa,QAAQ,KAC1B,0BAA0B,MAC1B,kBAAkB,MAClB,SAAS,SACT,OAAO,QAAQ,SACb;CAEJ,SAAS,UAAU,OAAe,QAA2B,OAAgB;EAC3E,MAAM,EAAC,MAAM,OAAO,CAAC,GAAG,YAAY,OAAO,WAAU;EAGrD,MAAM,OAAO,QAAQ,YAAY,GAAG,MAAM,GAAG,OAAO,IAAI,YAAY,KAAK;EAEzE,MAAM,EAAC,UAAU,iBAAgB,qBAAqB,IAAI;EAC1D,IAAI,WAAW,KAAK,SAAS;EAC7B,MAAM,2BAAW,IAAI,IAAY;EACjC,MAAM,gCAAgB,IAAI,IAAY;EAEtC,KAAK,YAAY,gBAAgB;EAEjC,SAAS,iBAAiB,GAAiB;GACzC,QAAQ,EAAE,MAAV;IACE,KAAK;IACL,KAAK,YACH;IACF,KAAK;KACH,WAAW;KACX,EAAE,OAAO,SAAQ,MAAK,EAAE,YAAY,gBAAgB,CAAC;KACrD,EAAE,MAAM,YAAY,gBAAgB;KACpC,EAAE,OAAO,SAAQ,MAAK,EAAE,YAAY,gBAAgB,CAAC;KACrD;IAEF,KAAK;KACH,SAAS,IAAI,OAAO,EAAE,KAAK,CAAC;KAC5B,cAAc,IAAI,OAAO,EAAE,KAAK;KAChC;IACF;KACE,cAAc,IAAI,EAAE,IAAI;KACxB;GACJ;EACF;EACA,MAAM,MAAM,YAAY,GAAG,gBAAgB,MAAM,EAAE,YAAY;EAC/D,IAAI,cAAc,OAAO,GACvB,MAAM,IAAI,UAAU,GAAG,IAAI,mBAAmB,CAAC,GAAG,aAAa,GAAG;EAEpE,OAAO,cAAc,SAAS,GAAG,oCAAoC;EACrE,MAAM,eAAe,CAAC,GAAG,aAAa,EAAE;EAExC,IAAI,WAAW,MACb,IAAI,UAEF,QAAQ,KAAK,KAAK,QAAQ,GAAG,WAAW,KAAK,MAAM,GAAG,CAAC;OAEvD,QAAQ,KAAK,KAAK,QAAQ,WAAW,IAAI;EAG7C,MAAM,IAAI,MAAM;GAAC;GAAO;EAAG,CAAC;EAE5B,MAAM,OAAO,EACV,WACG,sBACA,iBAAiB,KAAA,IACf,YAAY,KAAK,UAAU,YAAY,MACvC,cAAc,IACtB;EACA,IAAI,MACF,KAAK,KAAK,GAAG,IAAI;EAGnB,MAAM,YAAY,CAChB,SAAS,OACL,OAAO,MAAM,KAAK,WAAU,MAAK,cAAc,EAAE,EAAE,CAAC,IACpD,WACE,cAAc,aAAa,OAC3B,cAAc,aAAa,IACjC,KAAK,IAAI,KACX;EAEA,MAAM,MAAM;GACV,MAAM;GACN;GACA,MAAM,YACJ,KACA,cACA,QACA,0BAA0B,aAAa,KAAA,CACzC;GACA;GACA;GACA,aAAa,KAAK,KAAK,IAAI,IAAI;GAC/B,WAAW,UAAU,KAAK,IAAI,IAAI;GAClC,QAAQ,WAAW,KAAA,IAAY,eAAe,KAAA,IAAY;EAC5D;EACA,oBAAoB,KAAK,GAAG;EAC5B,iBAAiB,KAAK;GAAC,GAAG;GAAK;EAAY,CAAC;CAC9C;CAEA,MAAM,wBAAQ,IAAI,IAA0C;CAC5D,MAAM,mBAAgD,CAAC;CACvD,MAAM,sBAAmD,CAAC;CAC1D,MAAM,UAAoB,CAAC;CAE3B,IAAI;EACF,KAAK,MAAM,CAAC,MAAM,QAAQ,OAAO,QAAQ,UAAU,GAAG;GACpD,MAAM,EAAC,SAAQ;GACf,IAAI,uBAAyB,GAAG,GAC9B,UAAU,MAAM,EAAC,MAAM,IAAG,CAAC;QACtB,IAAI,uBAAyB,IAAI,GACtC,UAAU,MAAM,GAAwB;QACnC;IACL,MAAM,QAAQ;IACd,KAAK,MAAM,CAAC,MAAM,WAAW,OAAO,QAAQ,GAAY,GAItD,UAAU,MAHM,uBAAyB,MAAM,IAC3C,EAAC,MAAM,OAAM,IACb,QACqB,KAAK;GAElC;EACF;EAEA,MAAM,CAAC,UAAU,MAAM,WAAW,UAAU,kBAAkB,MAAM,KAAK;EACzE,MAAM,CAAC,SAAS,QAAQ,UAAU,qBAAqB,SAAS,KAAK;EACrE,MAAM,CAAC,iBAAiB,QAAQ,UAAU,qBAAqB,MAAM,KAAK;EAE1E,QAAQ,UAAU,IAAlB;GACE,KAAK,KAAA,GACH;GACF,KAAK;GACL,KAAK;IACH,UAAU,kBAAkB,aAAa,MAAM;IAC/C,KAAK,CAAC;IACN;GACF;IACE,IAAI,CAAC,cAAc;KACjB,OAAO,QAAQ,sBAAsB,OAAO;KAC5C,UAAU,kBAAkB,aAAa,MAAM;KAC/C,KAAK,CAAC;IACR;IACA;EACJ;EAEA,MAAM,aAAa,kBACf,OAAK,iBAAiB,SAAS,QAAQ,IACvC,OAAK,iBAAiB,OAAO;EACjC,MAAM,MAAM,kBACR;GAAC,GAAG;GAAM,GAAG;GAAM,GAAG;EAAI,IAC1B;GAAC,GAAG;GAAM,GAAG;EAAI;EAErB,IAAI,SAAS,aAAa,YAAY,aAAa;EACnD,IAAI,gBAAgB,CAAC,iBAEnB,SAAS,YAAc,MAAsB;EAE/C,OAAO;GACL,QAAQ,MAAQ,YAAY,MAAM;GAClC;GACA,GAAI,UAAU,EAAC,QAAO,IAAI,CAAC;EAC7B;CACF,SAAS,GAAG;EACV,OAAO,QAAQ,OAAO,CAAC,CAAC;EACxB,UAAU,kBAAkB,aAAa,MAAM;EAC/C,MAAM;CACR;AACF;AAEA,SAAS,YACP,YACA,UACA,QACA,YACA;CACA,QAAQ,UAAkB;EACxB,IAAI,YACF,OAAO,OACL,SACE,KAAK,WAAW,qBAAqB,WAAW,KAAK,IAAI,IAAI,IAC/D,CACF;EAEF,QAAQ,UAAR;GACE,KAAK,UACH,OAAO;GACT,KAAK,WACH,OAAO,aAAa,YAAY,KAAK;GACvC,KAAK,UAAU;IACb,MAAM,MAAM,OAAO,KAAK;IACxB,IAAI,OAAO,MAAM,GAAG,GAClB,MAAM,IAAI,UAAU,qBAAqB,WAAW,KAAK,MAAM,EAAE;IAEnE,OAAO;GACT;GACA,SAEE,MAAM,IAAI,UACR,GAAG,WAAW,+BAA+B,UAC/C;EACJ;CACF;AACF;AAEA,SAAS,UACP,YACA,MACA,OACA;CACA,SAAS,mBAAmB,OAAgB;EAG1C,OAAO,UAAU,OAAO,OAAO;CACjC;CAEA,MAAM,EACJ,MACA,OAAO,WACP,UAAU,SACV,GAAG,WACD,gBAAgB,YAAY;EAC9B;EACA,SAAS;CACX,CAAC;CAGD,MAAM,SAA8B,CAAC;CACrC,MAAM,SAAiC,CAAC;CAExC,SAAS,QAAQ,UAAkB,OAAgB,OAAgB;EACjE,MAAM,EAAC,OAAO,QAAO,KAAK,MAAM,IAAI,QAAQ,CAAC;EAC7C,MAAM,aAAa,mBAAmB,KAAK;EAC3C,IAAI,OACF,OAAO,OAAO,SAAS;OAEvB,OAAO,SAAS;EAElB,OAAO,OAAO,OAAO,UAAU;CACjC;CAEA,KAAK,MAAM,CAAC,UAAU,UAAU,OAAO,QAAQ,aAAa,CAAC,CAAC,GAC5D,QAAQ,UAAU,KAAK;CAIzB,KAAK,MAAM,CAAC,MAAM,UAAU,OAAO,QAAQ,MAAM,GAC/C,IAAI,OAAO,UAAU,YAAY,UAAU,QAAQ,MAAM,QAAQ,KAAK,GACpE,QAAQ,MAAM,KAAK;MACd;EACL,MAAM,QAAQ;EACd,OAAO,SAAS,CAAC;EACjB,KAAK,MAAM,CAAC,UAAU,cAAc,OAAO,QAAQ,KAAK,GACtD,QAAQ,UAAU,WAAW,KAAK;CAEtC;CAGF,OAAO;EAAC;EAAQ;EAAQ;CAAO;AACjC;AAEA,SAAgB,UAAU,QAAgB,MAAsB;CAC9D,OAAO,YAAY,SAAS,IAAI,EAAE,YAAY;AAChD;AAEA,SAAgB,aAAa,YAAoB,OAAe;CAC9D,MAAM,OAAO,MAAM,YAAY;CAC/B,IAAI,CAAC,QAAQ,GAAG,EAAE,SAAS,IAAI,GAC7B,OAAO;MACF,IAAI,CAAC,SAAS,GAAG,EAAE,SAAS,IAAI,GACrC,OAAO;CAET,MAAM,IAAI,UAAU,qBAAqB,WAAW,KAAK,MAAM,EAAE;AACnE;AAEA,SAAS,UACP,YACA,cAAmD,CAAC,GACpD,SAAyB,SACzB;CACA,MAAM,OAAiB,CAAC;CACxB,IAAI,YAAY;CAChB,IAAI,aAAa;CACjB,WAAW,SAAS,EAAC,MAAM,WAAW,aAAa,aAAY;EAC7D,IAAI,QACF,KAAK,KAAK,IAAI;EAGhB,MAAM,QAAQ,yBADD,SAAS,GAAG,KAAK,GAAG,aAAa,IACtB,CAAI,EAAE,MAAM,IAAI;EACxC,KAAK,MAAM,KAAK,OACd,YAAY,KAAK,IAAI,WAAW,EAAE,SAAS,CAAC;EAE9C,MAAM,OAAO,yBAAU,SAAS,eAAe,EAAE,CAAC,EAAE,MAAM,IAAI;EAC9D,KAAK,MAAM,KAAK,MACd,aAAa,KAAK,IAAI,YAAY,EAAE,SAAS,CAAC;CAElD,CAAC;CAED,MAAM,WAAsB,CAC1B;EACE;EACA,kBAAkB;EAClB;EACA,cAAc;GACZ,SAAS,CACP;IAAC,MAAM;IAAU,OAAO;GAAS,GACjC;IAAC,MAAM;IAAe,OAAO;GAAU,CACzC;GACA,QAAQ;EACV;CACF,CACF;CAEA,IAAI,aACF,SAAS,QAAQ,GAAG,WAAW;CAGjC,OAAO,OAAO,iBAAiB,QAAQ,CAAC;AAC1C"}
+{"version":3,"file":"options.js","names":[],"sources":["../../../../shared/src/options.ts"],"sourcesContent":["import {stripVTControlCharacters as stripAnsi} from 'node:util';\nimport type {OptionalLogger} from '@rocicorp/logger';\nimport {template} from 'chalk-template';\nimport type {OptionDefinition} from 'command-line-args';\nimport commandLineArgs from 'command-line-args';\nimport commandLineUsage, {type Section} from 'command-line-usage';\nimport {createDefu} from 'defu';\nimport {toKebabCase, toSnakeCase} from 'kasi';\nimport {assert} from './asserts.ts';\nimport {must} from './must.ts';\nimport type {\n  Config,\n  Group,\n  Option,\n  Options,\n  WrappedOptionType,\n} from './options-types.ts';\nimport * as v from './valita.ts';\n\nexport type {Config, Group, Option, Options, WrappedOptionType};\n\ntype Primitive = number | string | boolean;\ntype Value = Primitive | Array<Primitive>;\n\ntype RequiredOptionType =\n  | v.Type<string>\n  | v.Type<number>\n  | v.Type<boolean>\n  | v.Type<string[]>\n  | v.Type<number[]>\n  | v.Type<boolean[]>;\n\ntype OptionalOptionType =\n  | v.Optional<string>\n  | v.Optional<number>\n  | v.Optional<boolean>\n  | v.Optional<string[]>\n  | v.Optional<number[]>\n  | v.Optional<boolean[]>;\n\ntype OptionType = RequiredOptionType | OptionalOptionType;\n\n/**\n * Creates a defu instance that overrides arrays instead of merging them.\n */\nconst defu = createDefu((obj, key, value) => {\n  if (!Array.isArray(value)) return;\n\n  obj[key] = value;\n  return true;\n});\n\n/**\n * Converts an Options instance into its corresponding {@link Config} schema.\n */\nfunction configSchema<T extends Options>(\n  options: T,\n  envNamePrefix: string,\n): v.Type<Config<T>> {\n  function makeObjectType(options: Options | Group, group?: string) {\n    return v.object(\n      Object.fromEntries(\n        Object.entries(options).map(\n          ([name, value]): [string, OptionType | v.Type] => {\n            const addErrorMessage = (t: OptionType) => {\n              const {required} = getRequiredOrDefault(t);\n              if (required) {\n                // Adds an error message for required options that includes the\n                // actual name of the option.\n                const optionName = toSnakeCase(\n                  `${envNamePrefix}${group ? group + '_' : ''}${name}`,\n                ).toUpperCase();\n                return (t as v.Type<string>)\n                  .optional()\n                  .assert(\n                    val => val !== undefined,\n                    `Missing required option ${optionName}`,\n                  );\n              }\n              return t;\n            };\n            // OptionType\n            if (v.instanceOfAbstractType(value)) {\n              return [name, addErrorMessage(value)];\n            }\n            // WrappedOptionType\n            const {type} = value;\n            if (v.instanceOfAbstractType(type)) {\n              return [name, addErrorMessage(type)];\n            }\n            // OptionGroup\n            return [name, makeObjectType(value as Group, name)];\n          },\n        ),\n      ),\n    );\n  }\n  return makeObjectType(options) as v.Type<Config<T>>;\n}\n\n/**\n * Converts an Options instance into an \"env schema\", which is an object with\n * ENV names as its keys, mapped to optional or required string values\n * (corresponding to the optionality of the corresponding options).\n *\n * This is used as a format for encoding options for a multi-tenant version\n * of an app, with an envSchema for each tenant.\n */\nexport function envSchema<T extends Options>(options: T, envNamePrefix = '') {\n  const fields: [string, v.Type<string> | v.Optional<string>][] = [];\n\n  function addField(name: string, type: OptionType, group?: string) {\n    const flag = group ? `${group}_${name}` : name;\n    const env = toSnakeCase(`${envNamePrefix}${flag}`).toUpperCase();\n\n    const {required} = getRequiredOrDefault(type);\n    fields.push([env, required ? v.string() : v.string().optional()]);\n  }\n\n  function addFields(o: Options | Group, group?: string) {\n    Object.entries(o).forEach(([name, value]) => {\n      // OptionType\n      if (v.instanceOfAbstractType(value)) {\n        addField(name, value, group);\n        return;\n      }\n      // WrappedOptionType\n      const {type} = value;\n      if (v.instanceOfAbstractType(type)) {\n        addField(name, type, group);\n        return;\n      }\n      // OptionGroup\n      addFields(value as Group, name);\n    });\n  }\n\n  addFields(options);\n\n  return v.object(Object.fromEntries(fields));\n}\n\nfunction getRequiredOrDefault(type: OptionType) {\n  const defaultResult = v.testOptional<Value>(undefined, type);\n  return {\n    required: !defaultResult.ok,\n    defaultValue: defaultResult.ok ? defaultResult.value : undefined,\n  };\n}\n\nexport type ParseOptions = {\n  /** Defaults to process.argv.slice(2) */\n  argv?: string[];\n\n  envNamePrefix?: string;\n\n  description?: {header: string; content: string}[];\n\n  /** Defaults to `false` */\n  allowUnknown?: boolean;\n\n  /** Defaults to `false` */\n  allowPartial?: boolean;\n\n  /** Defaults to `process.env`. */\n  env?: NodeJS.ProcessEnv;\n\n  /** Defaults to `true`. */\n  emitDeprecationWarnings?: boolean;\n\n  /** Defaults to `true`. When false, excludes default values from both config and env return values. */\n  includeDefaults?: boolean;\n\n  /** Defaults to `console` */\n  logger?: OptionalLogger;\n\n  /** Defaults to `process.exit` */\n  exit?: (code?: number | string | null) => never;\n};\n\nexport function parseOptions<T extends Options>(\n  appOptions: T,\n  opts: ParseOptions = {},\n): Config<T> {\n  return parseOptionsAdvanced(appOptions, opts).config;\n}\n\nexport function parseOptionsAdvanced<T extends Options>(\n  appOptions: T,\n  opts: ParseOptions = {},\n): {config: Config<T>; env: Record<string, string>; unknown?: string[]} {\n  const {\n    argv = process.argv.slice(2),\n    envNamePrefix = '',\n    description = [],\n    allowUnknown = false,\n    allowPartial = false,\n    env: processEnv = process.env,\n    emitDeprecationWarnings = true,\n    includeDefaults = true,\n    logger = console,\n    exit = process.exit,\n  } = opts;\n  // The main logic for converting a valita Type spec to an Option (i.e. flag) spec.\n  function addOption(field: string, option: WrappedOptionType, group?: string) {\n    const {type, desc = [], deprecated, alias, hidden} = option;\n\n    // The group name is prepended to the flag name.\n    const flag = group ? toKebabCase(`${group}-${field}`) : toKebabCase(field);\n\n    const {required, defaultValue} = getRequiredOrDefault(type);\n    let multiple = type.name === 'array';\n    const literals = new Set<string>();\n    const terminalTypes = new Set<string>();\n\n    v.toTerminals(type, getTerminalTypes);\n\n    function getTerminalTypes(t: v.TerminalType) {\n      switch (t.name) {\n        case 'undefined':\n        case 'optional':\n          break;\n        case 'array': {\n          multiple = true;\n          t.prefix.forEach(t => v.toTerminals(t, getTerminalTypes));\n          if (t.restType) {\n            v.toTerminals(t.restType, getTerminalTypes);\n          }\n          t.suffix.forEach(t => v.toTerminals(t, getTerminalTypes));\n          break;\n        }\n        case 'literal':\n          literals.add(String(t.value));\n          terminalTypes.add(typeof t.value);\n          break;\n        default:\n          terminalTypes.add(t.name);\n          break;\n      }\n    }\n    const env = toSnakeCase(`${envNamePrefix}${flag}`).toUpperCase();\n    if (terminalTypes.size > 1) {\n      throw new TypeError(`${env} has mixed types ${[...terminalTypes]}`);\n    }\n    assert(terminalTypes.size === 1, 'Expected exactly one terminal type');\n    const terminalType = [...terminalTypes][0];\n\n    const value = processEnv[env];\n    if (value) {\n      // Use the `--flag=value` form so that a value starting with `-` (e.g. a\n      // nanoid) is not parsed as a cluster of short flags, leaving `--flag`\n      // with a `null` value. Array values are comma-separated; technically not\n      // water-tight, as it assumes the values themselves don't contain commas.\n      const values = multiple ? value.split(',') : [value];\n      envArgv.push(...values.map(val => `--${flag}=${val}`));\n    }\n    names.set(flag, {field, env});\n\n    const spec = [\n      (required\n        ? '{italic required}'\n        : defaultValue !== undefined\n          ? `default: ${JSON.stringify(defaultValue)}`\n          : 'optional') + '\\n',\n    ];\n    if (desc) {\n      spec.push(...desc);\n    }\n\n    const typeLabel = [\n      literals.size\n        ? String(Array.from(literals, l => `{underline ${l}}`))\n        : multiple\n          ? `{underline ${terminalType}[]}`\n          : `{underline ${terminalType}}`,\n      `  ${env} env`,\n    ];\n\n    const opt = {\n      name: flag,\n      alias,\n      type: valueParser(\n        env,\n        terminalType,\n        logger,\n        emitDeprecationWarnings ? deprecated : undefined,\n      ),\n      multiple,\n      group,\n      description: spec.join('\\n') + '\\n',\n      typeLabel: typeLabel.join('\\n') + '\\n',\n      hidden: hidden === undefined ? deprecated !== undefined : hidden,\n    };\n    optsWithoutDefaults.push(opt);\n    optsWithDefaults.push({...opt, defaultValue});\n  }\n\n  const names = new Map<string, {field: string; env: string}>();\n  const optsWithDefaults: DescribedOptionDefinition[] = [];\n  const optsWithoutDefaults: DescribedOptionDefinition[] = [];\n  const envArgv: string[] = [];\n\n  try {\n    for (const [name, val] of Object.entries(appOptions)) {\n      const {type} = val as {type: unknown};\n      if (v.instanceOfAbstractType(val)) {\n        addOption(name, {type: val});\n      } else if (v.instanceOfAbstractType(type)) {\n        addOption(name, val as WrappedOptionType);\n      } else {\n        const group = name;\n        for (const [name, option] of Object.entries(val as Group)) {\n          const wrapped = v.instanceOfAbstractType(option)\n            ? {type: option}\n            : option;\n          addOption(name, wrapped, group);\n        }\n      }\n    }\n\n    const [defaults, env1, unknown] = parseArgs(optsWithDefaults, argv, names);\n    const [fromEnv, env2] = parseArgs(optsWithoutDefaults, envArgv, names);\n    const [withoutDefaults, env3] = parseArgs(optsWithoutDefaults, argv, names);\n\n    switch (unknown?.[0]) {\n      case undefined:\n        break;\n      case '--help':\n      case '-h':\n        showUsage(optsWithDefaults, description, logger);\n        exit(0);\n        break;\n      default:\n        if (!allowUnknown) {\n          logger.error?.('Invalid arguments:', unknown);\n          showUsage(optsWithDefaults, description, logger);\n          exit(0);\n        }\n        break;\n    }\n\n    const parsedArgs = includeDefaults\n      ? defu(withoutDefaults, fromEnv, defaults)\n      : defu(withoutDefaults, fromEnv);\n    const env = includeDefaults\n      ? {...env1, ...env2, ...env3}\n      : {...env2, ...env3};\n\n    let schema = configSchema(appOptions, envNamePrefix);\n    if (allowPartial || !includeDefaults) {\n      // TODO: Type configSchema() to return a v.ObjectType<...>\n      schema = v.deepPartial(\n        schema as v.ObjectType<Record<string, v.Type | v.Optional>, undefined>,\n      ) as v.Type<Config<T>>;\n    }\n    return {\n      config: v.parse(parsedArgs, schema),\n      env,\n      ...(unknown ? {unknown} : {}),\n    };\n  } catch (e) {\n    logger.error?.(String(e));\n    showUsage(optsWithDefaults, description, logger);\n    throw e;\n  }\n}\n\nfunction valueParser(\n  optionName: string,\n  typeName: string,\n  logger: OptionalLogger,\n  deprecated: string[] | undefined,\n) {\n  return (input: string) => {\n    if (deprecated) {\n      logger.warn?.(\n        template(\n          `\\n${optionName} is deprecated:\\n` + deprecated.join('\\n') + '\\n',\n        ),\n      );\n    }\n    switch (typeName) {\n      case 'string':\n        return input;\n      case 'boolean':\n        return parseBoolean(optionName, input);\n      case 'number': {\n        const val = Number(input);\n        if (Number.isNaN(val)) {\n          throw new TypeError(`Invalid input for ${optionName}: \"${input}\"`);\n        }\n        return val;\n      }\n      default:\n        // Should be impossible given the constraints of `Option`\n        throw new TypeError(\n          `${optionName} option has unsupported type ${typeName}`,\n        );\n    }\n  };\n}\n\nfunction parseArgs(\n  optionDefs: DescribedOptionDefinition[],\n  argv: string[],\n  names: Map<string, {field: string; env: string}>,\n) {\n  function normalizeFlagValue(value: unknown) {\n    // A --flag without value is parsed by commandLineArgs() to `null`,\n    // but this is a common convention to set a boolean flag to true.\n    return value === null ? true : value;\n  }\n\n  const {\n    _all,\n    _none: ungrouped,\n    _unknown: unknown,\n    ...config\n  } = commandLineArgs(optionDefs, {\n    argv,\n    partial: true,\n  });\n\n  // oxlint-disable-next-line @typescript-eslint/no-explicit-any\n  const result: Record<string, any> = {};\n  const envObj: Record<string, string> = {};\n\n  function addFlag(flagName: string, value: unknown, group?: string) {\n    const {field, env} = must(names.get(flagName));\n    const normalized = normalizeFlagValue(value);\n    if (group) {\n      result[group][field] = normalized;\n    } else {\n      result[field] = normalized;\n    }\n    envObj[env] = String(normalized);\n  }\n\n  for (const [flagName, value] of Object.entries(ungrouped ?? {})) {\n    addFlag(flagName, value);\n  }\n\n  // Then handle (potentially) grouped flags\n  for (const [name, value] of Object.entries(config)) {\n    if (typeof value !== 'object' || value === null || Array.isArray(value)) {\n      addFlag(name, value); // Flag, not a group\n    } else {\n      const group = name;\n      result[group] = {};\n      for (const [flagName, flagValue] of Object.entries(value)) {\n        addFlag(flagName, flagValue, group);\n      }\n    }\n  }\n\n  return [result, envObj, unknown] as const;\n}\n\nexport function flagToEnv(prefix: string, flag: string): string {\n  return toSnakeCase(prefix + flag).toUpperCase();\n}\n\nexport function parseBoolean(optionName: string, input: string) {\n  const bool = input.toLowerCase();\n  if (['true', '1'].includes(bool)) {\n    return true;\n  } else if (['false', '0'].includes(bool)) {\n    return false;\n  }\n  throw new TypeError(`Invalid input for ${optionName}: \"${input}\"`);\n}\n\nfunction showUsage(\n  optionList: DescribedOptionDefinition[],\n  description: {header: string; content: string}[] = [],\n  logger: OptionalLogger = console,\n) {\n  const hide: string[] = [];\n  let leftWidth = 35;\n  let rightWidth = 70;\n  optionList.forEach(({name, typeLabel, description, hidden}) => {\n    if (hidden) {\n      hide.push(name);\n    }\n    const text = template(`${name} ${typeLabel ?? ''}`);\n    const lines = stripAnsi(text).split('\\n');\n    for (const l of lines) {\n      leftWidth = Math.max(leftWidth, l.length + 2);\n    }\n    const desc = stripAnsi(template(description ?? '')).split('\\n');\n    for (const l of desc) {\n      rightWidth = Math.max(rightWidth, l.length + 2);\n    }\n  });\n\n  const sections: Section[] = [\n    {\n      optionList,\n      reverseNameOrder: true, // Display --flag-name before -alias\n      hide,\n      tableOptions: {\n        columns: [\n          {name: 'option', width: leftWidth},\n          {name: 'description', width: rightWidth},\n        ],\n        noTrim: true,\n      },\n    },\n  ];\n\n  if (description) {\n    sections.unshift(...description);\n  }\n\n  logger.info?.(commandLineUsage(sections));\n}\n\ntype DescribedOptionDefinition = OptionDefinition & {\n  // Additional fields recognized by command-line-usage\n  description?: string;\n  typeLabel?: string | undefined;\n  hidden?: boolean | undefined;\n};\n"],"mappings":";;;;;;;;;;;;;AA6CA,IAAM,SAAO,YAAY,KAAK,KAAK,UAAU;CAC3C,IAAI,CAAC,MAAM,QAAQ,KAAK,GAAG;CAE3B,IAAI,OAAO;CACX,OAAO;AACT,CAAC;;;;AAKD,SAAS,aACP,SACA,eACmB;CACnB,SAAS,eAAe,SAA0B,OAAgB;EAChE,OAAO,eAAE,OACP,OAAO,YACL,OAAO,QAAQ,OAAO,EAAE,KACrB,CAAC,MAAM,WAA0C;GAChD,MAAM,mBAAmB,MAAkB;IACzC,MAAM,EAAC,aAAY,qBAAqB,CAAC;IACzC,IAAI,UAAU;KAGZ,MAAM,aAAa,YACjB,GAAG,gBAAgB,QAAQ,QAAQ,MAAM,KAAK,MAChD,EAAE,YAAY;KACd,OAAQ,EACL,SAAS,EACT,QACC,QAAO,QAAQ,KAAA,GACf,2BAA2B,YAC7B;IACJ;IACA,OAAO;GACT;GAEA,IAAI,uBAAyB,KAAK,GAChC,OAAO,CAAC,MAAM,gBAAgB,KAAK,CAAC;GAGtC,MAAM,EAAC,SAAQ;GACf,IAAI,uBAAyB,IAAI,GAC/B,OAAO,CAAC,MAAM,gBAAgB,IAAI,CAAC;GAGrC,OAAO,CAAC,MAAM,eAAe,OAAgB,IAAI,CAAC;EACpD,CACF,CACF,CACF;CACF;CACA,OAAO,eAAe,OAAO;AAC/B;AA4CA,SAAS,qBAAqB,MAAkB;CAC9C,MAAM,gBAAgB,aAAsB,KAAA,GAAW,IAAI;CAC3D,OAAO;EACL,UAAU,CAAC,cAAc;EACzB,cAAc,cAAc,KAAK,cAAc,QAAQ,KAAA;CACzD;AACF;AAgCA,SAAgB,aACd,YACA,OAAqB,CAAC,GACX;CACX,OAAO,qBAAqB,YAAY,IAAI,EAAE;AAChD;AAEA,SAAgB,qBACd,YACA,OAAqB,CAAC,GACgD;CACtE,MAAM,EACJ,OAAO,QAAQ,KAAK,MAAM,CAAC,GAC3B,gBAAgB,IAChB,cAAc,CAAC,GACf,eAAe,OACf,eAAe,OACf,KAAK,aAAa,QAAQ,KAC1B,0BAA0B,MAC1B,kBAAkB,MAClB,SAAS,SACT,OAAO,QAAQ,SACb;CAEJ,SAAS,UAAU,OAAe,QAA2B,OAAgB;EAC3E,MAAM,EAAC,MAAM,OAAO,CAAC,GAAG,YAAY,OAAO,WAAU;EAGrD,MAAM,OAAO,QAAQ,YAAY,GAAG,MAAM,GAAG,OAAO,IAAI,YAAY,KAAK;EAEzE,MAAM,EAAC,UAAU,iBAAgB,qBAAqB,IAAI;EAC1D,IAAI,WAAW,KAAK,SAAS;EAC7B,MAAM,2BAAW,IAAI,IAAY;EACjC,MAAM,gCAAgB,IAAI,IAAY;EAEtC,YAAc,MAAM,gBAAgB;EAEpC,SAAS,iBAAiB,GAAmB;GAC3C,QAAQ,EAAE,MAAV;IACE,KAAK;IACL,KAAK,YACH;IACF,KAAK;KACH,WAAW;KACX,EAAE,OAAO,SAAQ,MAAK,YAAc,GAAG,gBAAgB,CAAC;KACxD,IAAI,EAAE,UACJ,YAAc,EAAE,UAAU,gBAAgB;KAE5C,EAAE,OAAO,SAAQ,MAAK,YAAc,GAAG,gBAAgB,CAAC;KACxD;IAEF,KAAK;KACH,SAAS,IAAI,OAAO,EAAE,KAAK,CAAC;KAC5B,cAAc,IAAI,OAAO,EAAE,KAAK;KAChC;IACF;KACE,cAAc,IAAI,EAAE,IAAI;KACxB;GACJ;EACF;EACA,MAAM,MAAM,YAAY,GAAG,gBAAgB,MAAM,EAAE,YAAY;EAC/D,IAAI,cAAc,OAAO,GACvB,MAAM,IAAI,UAAU,GAAG,IAAI,mBAAmB,CAAC,GAAG,aAAa,GAAG;EAEpE,OAAO,cAAc,SAAS,GAAG,oCAAoC;EACrE,MAAM,eAAe,CAAC,GAAG,aAAa,EAAE;EAExC,MAAM,QAAQ,WAAW;EACzB,IAAI,OAAO;GAKT,MAAM,SAAS,WAAW,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK;GACnD,QAAQ,KAAK,GAAG,OAAO,KAAI,QAAO,KAAK,KAAK,GAAG,KAAK,CAAC;EACvD;EACA,MAAM,IAAI,MAAM;GAAC;GAAO;EAAG,CAAC;EAE5B,MAAM,OAAO,EACV,WACG,sBACA,iBAAiB,KAAA,IACf,YAAY,KAAK,UAAU,YAAY,MACvC,cAAc,IACtB;EACA,IAAI,MACF,KAAK,KAAK,GAAG,IAAI;EAGnB,MAAM,YAAY,CAChB,SAAS,OACL,OAAO,MAAM,KAAK,WAAU,MAAK,cAAc,EAAE,EAAE,CAAC,IACpD,WACE,cAAc,aAAa,OAC3B,cAAc,aAAa,IACjC,KAAK,IAAI,KACX;EAEA,MAAM,MAAM;GACV,MAAM;GACN;GACA,MAAM,YACJ,KACA,cACA,QACA,0BAA0B,aAAa,KAAA,CACzC;GACA;GACA;GACA,aAAa,KAAK,KAAK,IAAI,IAAI;GAC/B,WAAW,UAAU,KAAK,IAAI,IAAI;GAClC,QAAQ,WAAW,KAAA,IAAY,eAAe,KAAA,IAAY;EAC5D;EACA,oBAAoB,KAAK,GAAG;EAC5B,iBAAiB,KAAK;GAAC,GAAG;GAAK;EAAY,CAAC;CAC9C;CAEA,MAAM,wBAAQ,IAAI,IAA0C;CAC5D,MAAM,mBAAgD,CAAC;CACvD,MAAM,sBAAmD,CAAC;CAC1D,MAAM,UAAoB,CAAC;CAE3B,IAAI;EACF,KAAK,MAAM,CAAC,MAAM,QAAQ,OAAO,QAAQ,UAAU,GAAG;GACpD,MAAM,EAAC,SAAQ;GACf,IAAI,uBAAyB,GAAG,GAC9B,UAAU,MAAM,EAAC,MAAM,IAAG,CAAC;QACtB,IAAI,uBAAyB,IAAI,GACtC,UAAU,MAAM,GAAwB;QACnC;IACL,MAAM,QAAQ;IACd,KAAK,MAAM,CAAC,MAAM,WAAW,OAAO,QAAQ,GAAY,GAItD,UAAU,MAHM,uBAAyB,MAAM,IAC3C,EAAC,MAAM,OAAM,IACb,QACqB,KAAK;GAElC;EACF;EAEA,MAAM,CAAC,UAAU,MAAM,WAAW,UAAU,kBAAkB,MAAM,KAAK;EACzE,MAAM,CAAC,SAAS,QAAQ,UAAU,qBAAqB,SAAS,KAAK;EACrE,MAAM,CAAC,iBAAiB,QAAQ,UAAU,qBAAqB,MAAM,KAAK;EAE1E,QAAQ,UAAU,IAAlB;GACE,KAAK,KAAA,GACH;GACF,KAAK;GACL,KAAK;IACH,UAAU,kBAAkB,aAAa,MAAM;IAC/C,KAAK,CAAC;IACN;GACF;IACE,IAAI,CAAC,cAAc;KACjB,OAAO,QAAQ,sBAAsB,OAAO;KAC5C,UAAU,kBAAkB,aAAa,MAAM;KAC/C,KAAK,CAAC;IACR;IACA;EACJ;EAEA,MAAM,aAAa,kBACf,OAAK,iBAAiB,SAAS,QAAQ,IACvC,OAAK,iBAAiB,OAAO;EACjC,MAAM,MAAM,kBACR;GAAC,GAAG;GAAM,GAAG;GAAM,GAAG;EAAI,IAC1B;GAAC,GAAG;GAAM,GAAG;EAAI;EAErB,IAAI,SAAS,aAAa,YAAY,aAAa;EACnD,IAAI,gBAAgB,CAAC,iBAEnB,SAAS,YACP,MACF;EAEF,OAAO;GACL,QAAQ,MAAQ,YAAY,MAAM;GAClC;GACA,GAAI,UAAU,EAAC,QAAO,IAAI,CAAC;EAC7B;CACF,SAAS,GAAG;EACV,OAAO,QAAQ,OAAO,CAAC,CAAC;EACxB,UAAU,kBAAkB,aAAa,MAAM;EAC/C,MAAM;CACR;AACF;AAEA,SAAS,YACP,YACA,UACA,QACA,YACA;CACA,QAAQ,UAAkB;EACxB,IAAI,YACF,OAAO,OACL,SACE,KAAK,WAAW,qBAAqB,WAAW,KAAK,IAAI,IAAI,IAC/D,CACF;EAEF,QAAQ,UAAR;GACE,KAAK,UACH,OAAO;GACT,KAAK,WACH,OAAO,aAAa,YAAY,KAAK;GACvC,KAAK,UAAU;IACb,MAAM,MAAM,OAAO,KAAK;IACxB,IAAI,OAAO,MAAM,GAAG,GAClB,MAAM,IAAI,UAAU,qBAAqB,WAAW,KAAK,MAAM,EAAE;IAEnE,OAAO;GACT;GACA,SAEE,MAAM,IAAI,UACR,GAAG,WAAW,+BAA+B,UAC/C;EACJ;CACF;AACF;AAEA,SAAS,UACP,YACA,MACA,OACA;CACA,SAAS,mBAAmB,OAAgB;EAG1C,OAAO,UAAU,OAAO,OAAO;CACjC;CAEA,MAAM,EACJ,MACA,OAAO,WACP,UAAU,SACV,GAAG,WACD,gBAAgB,YAAY;EAC9B;EACA,SAAS;CACX,CAAC;CAGD,MAAM,SAA8B,CAAC;CACrC,MAAM,SAAiC,CAAC;CAExC,SAAS,QAAQ,UAAkB,OAAgB,OAAgB;EACjE,MAAM,EAAC,OAAO,QAAO,KAAK,MAAM,IAAI,QAAQ,CAAC;EAC7C,MAAM,aAAa,mBAAmB,KAAK;EAC3C,IAAI,OACF,OAAO,OAAO,SAAS;OAEvB,OAAO,SAAS;EAElB,OAAO,OAAO,OAAO,UAAU;CACjC;CAEA,KAAK,MAAM,CAAC,UAAU,UAAU,OAAO,QAAQ,aAAa,CAAC,CAAC,GAC5D,QAAQ,UAAU,KAAK;CAIzB,KAAK,MAAM,CAAC,MAAM,UAAU,OAAO,QAAQ,MAAM,GAC/C,IAAI,OAAO,UAAU,YAAY,UAAU,QAAQ,MAAM,QAAQ,KAAK,GACpE,QAAQ,MAAM,KAAK;MACd;EACL,MAAM,QAAQ;EACd,OAAO,SAAS,CAAC;EACjB,KAAK,MAAM,CAAC,UAAU,cAAc,OAAO,QAAQ,KAAK,GACtD,QAAQ,UAAU,WAAW,KAAK;CAEtC;CAGF,OAAO;EAAC;EAAQ;EAAQ;CAAO;AACjC;AAEA,SAAgB,UAAU,QAAgB,MAAsB;CAC9D,OAAO,YAAY,SAAS,IAAI,EAAE,YAAY;AAChD;AAEA,SAAgB,aAAa,YAAoB,OAAe;CAC9D,MAAM,OAAO,MAAM,YAAY;CAC/B,IAAI,CAAC,QAAQ,GAAG,EAAE,SAAS,IAAI,GAC7B,OAAO;MACF,IAAI,CAAC,SAAS,GAAG,EAAE,SAAS,IAAI,GACrC,OAAO;CAET,MAAM,IAAI,UAAU,qBAAqB,WAAW,KAAK,MAAM,EAAE;AACnE;AAEA,SAAS,UACP,YACA,cAAmD,CAAC,GACpD,SAAyB,SACzB;CACA,MAAM,OAAiB,CAAC;CACxB,IAAI,YAAY;CAChB,IAAI,aAAa;CACjB,WAAW,SAAS,EAAC,MAAM,WAAW,aAAa,aAAY;EAC7D,IAAI,QACF,KAAK,KAAK,IAAI;EAGhB,MAAM,QAAQ,yBADD,SAAS,GAAG,KAAK,GAAG,aAAa,IACtB,CAAI,EAAE,MAAM,IAAI;EACxC,KAAK,MAAM,KAAK,OACd,YAAY,KAAK,IAAI,WAAW,EAAE,SAAS,CAAC;EAE9C,MAAM,OAAO,yBAAU,SAAS,eAAe,EAAE,CAAC,EAAE,MAAM,IAAI;EAC9D,KAAK,MAAM,KAAK,MACd,aAAa,KAAK,IAAI,YAAY,EAAE,SAAS,CAAC;CAElD,CAAC;CAED,MAAM,WAAsB,CAC1B;EACE;EACA,kBAAkB;EAClB;EACA,cAAc;GACZ,SAAS,CACP;IAAC,MAAM;IAAU,OAAO;GAAS,GACjC;IAAC,MAAM;IAAe,OAAO;GAAU,CACzC;GACA,QAAQ;EACV;CACF,CACF;CAEA,IAAI,aACF,SAAS,QAAQ,GAAG,WAAW;CAGjC,OAAO,OAAO,iBAAiB,QAAQ,CAAC;AAC1C"}