fix(plugins): bind a plugin's own SQLite arguments exactly again, NUL included

5ff5e7660 stripped U+0000 from every argument a plugin bound to its own
SQLite file, but left the rows it had stored alone. A key written with a
NUL (through a bound arg or char(0) in the plugin's SQL) could no longer be
found by the same key, upserts added duplicates, and keys that differ only
in where a NUL sits ('a\0bc', 'ab\0c') collapsed into one and collided.

A plugin's data is the plugin's, so its file binds the arguments exactly as
sent again, as before that commit. TREK's own data still holds no NUL; the
Postgres store, whose text cannot hold the character, refuses it instead.
This commit is contained in:
Maurice
2026-11-17 22:28:26 +01:00
parent 28f93f2539
commit 2b14fe1a2a
2 changed files with 35 additions and 17 deletions
@@ -1,6 +1,5 @@
import { openDatabase } from '../../../db/connection';
import { PLUGIN_DATA_CAPS, type PluginDataStore } from '../../../db/engine/plugin-data';
import { nulFreeParameter } from '../../../db/nul-free';
import { pluginDataDir, pluginDbFile, pluginsDataRoot } from '../paths';
import { splitAfterSemicolons } from './sql-script';
@@ -11,19 +10,6 @@ import path from 'node:path';
// The port, re-exported for the RPC kit, which may import from this file only (eslint.config.mjs).
export type { PluginDataStore };
/**
* A plugin's bound arguments without NUL, as TREK binds its own and as a
* plugin's schema on Postgres receives them (`db/nul-free.ts`): positional
* values, or the values of an object of named ones.
*/
function nulFreeArgs(args: readonly unknown[]): never[] {
return args.map((arg) =>
arg !== null && typeof arg === 'object' && Object.getPrototypeOf(arg) === Object.prototype
? Object.fromEntries(Object.entries(arg).map(([name, value]) => [name, nulFreeParameter(value)]))
: nulFreeParameter(arg),
) as never[];
}
/**
* A plugin's own sqlite database (#plugins, db:own): the SQLite side of the
* `PluginDataStore` port (`db/engine/plugin-data.ts`; the Postgres side is a
@@ -37,6 +23,12 @@ function nulFreeArgs(args: readonly unknown[]): never[] {
* (ATTACH another db, VACUUM INTO elsewhere, PRAGMA fiddling) or DoS via
* oversize SQL, every read is held to a row cap, and query(), tx() and an exec()
* script are held to a time budget (below).
*
* Bound arguments reach SQLite exactly as the plugin sent them, U+0000 (NUL)
* included: the data is the plugin's own, so a key it stored with a NUL is
* found again by the same key, and `'a\0bc'` and `'ab\0c'` stay two keys. TREK
* drops NUL only from its own data (`db/nul-free.ts`); the Postgres store,
* whose text cannot hold the character, refuses such an argument instead.
*/
const MAX_SQL_LENGTH = PLUGIN_DATA_CAPS.maxSqlLength;
@@ -156,7 +148,7 @@ export class PluginDataDb implements PluginDataStore {
// clock is read between rows. It is read only once another row has come back, so
// a result that has been read to its end is returned, however long that took.
const rows: unknown[] = [];
for (const row of this.db.prepare(sql).iterate(...nulFreeArgs(args))) {
for (const row of this.db.prepare(sql).iterate(...(args as never[]))) {
if (rows.length > 0) checkTime();
rows.push(row);
if (rows.length > maxRows) throw new Error(`query returned more than ${maxRows} rows`);
@@ -172,7 +164,7 @@ export class PluginDataDb implements PluginDataStore {
exec(sql: string, args: unknown[] = []): { changes: number } {
this.guard(sql);
if (args.length > 0) {
const info = this.db.prepare(sql).run(...nulFreeArgs(args));
const info = this.db.prepare(sql).run(...(args as never[]));
return { changes: info.changes };
}
this.runScript(sql, this.startBudget('exec'));
@@ -256,7 +248,7 @@ export class PluginDataDb implements PluginDataStore {
const results: Array<{ changes?: number; rows?: unknown[] }> = [];
for (const op of batch) {
const stmt = this.db.prepare(op.sql);
const args = nulFreeArgs(op.args ?? []);
const args = (op.args ?? []) as never[];
if (stmt.reader) {
const rows: unknown[] = [];
for (const row of stmt.iterate(...args)) {