Files
reverse-engineering-anything/src/cli/sqliteCommands.ts
T
Phonandmorluto 2fe0c9eb6a fix(cli): align local paths and SQLite selection validation (#9882)
fix(cli): batch of small fixes for #9714, #9718, #9759, #9856 and #9809

#9714: replace bare z.string().min(1) local paths in ADB CLI commands with localPathStringSchema so NUL bytes are rejected at the CLI boundary.
#9718: decode-android-resources path uses localPathStringSchema, matching apktoolInputSchemas.
#9759: inspect-sqlite-database CLI options now reject an empty column array and reject rowLimit/rowOffset/column/schemaScope=selected_table without --table via superRefine, mirroring inspectSqliteDatabaseInputSchema.
#9856 and #9809: shared snapshotSelectionOption is now localPathStringSchema.optional(), so every analyze/inspect/decompile/xrefs/trace/function/instructions/search --snapshot rejects NUL bytes.

Tests: tests/boundary/cli/overnightBatch1CliSchemas.test.ts (15 tests) proves empty/NUL input returns VALIDATION_ERROR before any provider runs and valid input is admitted.

Co-authored-by: morluto <76467478+morluto@users.noreply.github.com>
2026-11-11 23:40:01 +08:00

135 lines
5.0 KiB
TypeScript

import { projectCliAnalysisResult } from "./projectCliAnalysisResult.js";
import { z } from "incur";
import { createSqliteDatabaseService } from "../composition/sqlite.js";
import { CLI_COMMANDS } from "../cliCommandNames.js";
import { logCliCommand } from "../cliLogging.js";
import type { Logger } from "pino";
import type { CliInstance } from "./types.js";
import { withCommandCancellation } from "./commandCancellation.js";
import { localPathStringSchema } from "../domain/localPath.js";
import { absoluteCallerPath } from "../filesystem/callerPath.js";
import { finishCliEvidenceCommand } from "./cliEvidenceCallerPath.js";
import { cliDecimalField } from "./options.js";
import {
inspectSqliteDatabaseInputSchema,
sqliteTableSelectionSchema,
SQLITE_TABLE_REQUIRED_SELECTION_FIELDS,
} from "../domain/sqlite/sqliteDatabase.js";
const selectionAliases = {
table: "table",
columns: "column",
schema_scope: "schemaScope",
row_limit: "rowLimit",
row_offset: "rowOffset",
} as const;
/** Resolve an operator-selected SQLite snapshot through the shared inspection workflow. */
export const registerSqliteCommands = (
cli: CliInstance,
logger: Logger,
environment: Readonly<NodeJS.ProcessEnv>,
): void => {
const service = createSqliteDatabaseService(environment);
cli.command(CLI_COMMANDS.inspectSqliteDatabase, {
description:
"Inspect SQLite schema and optional ordinary-table rows from a local snapshot",
args: z.object({
path: localPathStringSchema.describe("Local SQLite database snapshot"),
}),
options: z
.object({
workerTimeoutMs: cliDecimalField(
inspectSqliteDatabaseInputSchema.shape.worker_timeout_ms,
),
table: sqliteTableSelectionSchema.shape.table.describe(
"Exact ordinary table name to read",
),
column: sqliteTableSelectionSchema.shape.columns.describe(
"Repeat to select exact row columns in the requested order; requires table",
),
schemaScope: sqliteTableSelectionSchema.shape.schema_scope.describe(
"Compact inventory by default, or selected-table details when table is supplied; database requests full schema",
),
rowLimit: cliDecimalField(
inspectSqliteDatabaseInputSchema.shape.row_limit,
).describe(
"Positive safe integer row count; default 20; requires table",
),
rowOffset: cliDecimalField(
inspectSqliteDatabaseInputSchema.shape.row_offset,
).describe(
"Non-negative safe integer rows to skip before the window; default 0; requires table",
),
})
.superRefine((options, context) => {
const selection = sqliteTableSelectionSchema.safeParse({
table: options.table,
columns: options.column,
schema_scope: options.schemaScope,
row_limit: options.rowLimit,
row_offset: options.rowOffset,
});
if (selection.success) return;
for (const issue of selection.error.issues) {
const path = issue.path.map((field) =>
typeof field === "string" && field in selectionAliases
? selectionAliases[field as keyof typeof selectionAliases]
: field,
);
context.addIssue({ ...issue, path });
}
})
.meta({
dependentRequired: Object.fromEntries(
SQLITE_TABLE_REQUIRED_SELECTION_FIELDS.map((field) => [
selectionAliases[field],
["table"],
]),
),
if: {
properties: { schemaScope: { const: "selected_table" } },
required: ["schemaScope"],
},
then: { required: ["table"] },
}),
run: ({ args, options }) =>
withCommandCancellation((signal) =>
logCliCommand(logger, CLI_COMMANDS.inspectSqliteDatabase, () =>
finishCliEvidenceCommand(
args.path,
() =>
service.inspect(
{
path: absoluteCallerPath(args.path),
...(options.workerTimeoutMs === undefined
? {}
: { worker_timeout_ms: options.workerTimeoutMs }),
...(options.table === undefined
? {}
: { table: options.table }),
...(options.rowLimit === undefined
? {}
: { row_limit: options.rowLimit }),
...(options.rowOffset === undefined
? {}
: { row_offset: options.rowOffset }),
...(options.column === undefined
? {}
: { columns: options.column }),
...(options.schemaScope === undefined
? {}
: { schema_scope: options.schemaScope }),
},
{ signal },
),
service,
"sqlite",
"inspect_sqlite_database",
signal,
).then(projectCliAnalysisResult),
),
),
});
};