@ogygia/devtools 0.11.4 → 0.13.0

package/dist/profiler/storage/postgres.js

@@ -1,94 +1,133 @@
 import { MAX_VISITS_PER_KEY } from "./visits.js";
+import { STALE, flights } from "@ogygia/machine";
 // src/profiler/storage/postgres.ts
 async function resolve(client) {
 	if (typeof client !== "string") return client;
 	const pg = await import("pg");
 	const Pool = pg.Pool ?? pg.default?.Pool;
-	if (!Pool) throw new Error("ogygia/profiler: postgresStore needs the 'pg' package.");
+	if (!Pool) throw new Error("ogygia/profiler: PostgresStore needs the 'pg' package.");
 	return new Pool({ connectionString: client });
 }
-function postgresStore(client, opts = {}) {
-	const base = opts.table ?? "ogygia";
-	const q = (n) => opts.schema ? `"${opts.schema}"."${base}_${n}"` : `"${base}_${n}"`;
-	const R = q("reports");
-	const V = q("visits");
-	let c = null;
-	let ready = null;
-	const need = async () => {
-		c ??= await resolve(client);
-		ready ??= (async () => {
-			if (opts.schema) await c.query(`CREATE SCHEMA IF NOT EXISTS "${opts.schema}"`);
-			await c.query(`CREATE TABLE IF NOT EXISTS ${R} (id TEXT PRIMARY KEY, created BIGINT NOT NULL, page TEXT, trigger TEXT, label TEXT, median DOUBLE PRECISION, dump JSONB NOT NULL)`);
-			await c.query(`CREATE INDEX IF NOT EXISTS ${base}_reports_created ON ${R} (created DESC)`);
-			await c.query(`CREATE TABLE IF NOT EXISTS ${V} (key TEXT PRIMARY KEY, page TEXT NOT NULL, at BIGINT NOT NULL, visit JSONB NOT NULL)`);
-			await c.query(`CREATE INDEX IF NOT EXISTS ${base}_visits_page ON ${V} (page, at DESC)`);
-		})();
-		await ready;
+var PostgresStore = class {
+	kind = "postgres";
+	#client;
+	#schema;
+	#base;
+	#R;
+	#V;
+	/** the client, made once: two first calls share it, and a failure to make it is not kept */
+	#connect;
+	/** the client made, for `close` */
+	#made = null;
+	/** the tables, made once: a setup that failed (a connection blip) is made again by the next call */
+	#setup;
+	constructor(client, opts = {}) {
+		const base = opts.table ?? "ogygia";
+		const q = (n) => opts.schema ? `"${opts.schema}"."${base}_${n}"` : `"${base}_${n}"`;
+		this.#client = client;
+		this.#schema = opts.schema;
+		this.#base = base;
+		this.#R = q("reports");
+		this.#V = q("visits");
+		this.#connect = this.#connector();
+		this.#setup = flights({
+			name: "profiler postgres tables",
+			run: () => this.#create_tables()
+		});
+	}
+	async init() {
+		await this.#need();
+	}
+	async putReport(rec) {
+		await (await this.#need()).query(`INSERT INTO ${this.#R} (id,created,page,trigger,label,median,dump) VALUES ($1,$2,$3,$4,$5,$6,$7::jsonb)
+			 ON CONFLICT (id) DO UPDATE SET created=EXCLUDED.created,page=EXCLUDED.page,trigger=EXCLUDED.trigger,label=EXCLUDED.label,median=EXCLUDED.median,dump=EXCLUDED.dump`, [
+			rec.id,
+			rec.created,
+			rec.page,
+			rec.trigger,
+			rec.label,
+			rec.median,
+			rec.dump
+		]);
+	}
+	async getReport(id) {
+		const { rows } = await (await this.#need()).query(`SELECT dump FROM ${this.#R} WHERE id = $1`, [id]);
+		if (!rows.length) return null;
+		const d = rows[0].dump;
+		return typeof d === "string" ? d : JSON.stringify(d);
+	}
+	async listReports(limit = 30) {
+		const { rows } = await (await this.#need()).query(`SELECT id,created,page,trigger,label,median FROM ${this.#R} ORDER BY created DESC LIMIT $1`, [limit]);
+		return rows.map((r) => ({
+			id: r.id,
+			created: Number(r.created),
+			page: r.page ?? null,
+			trigger: r.trigger,
+			label: r.label,
+			median: r.median === null ? null : Number(r.median)
+		}));
+	}
+	async deleteReport(id) {
+		await (await this.#need()).query(`DELETE FROM ${this.#R} WHERE id = $1`, [id]);
+	}
+	async prune(keep) {
+		const R = this.#R;
+		await (await this.#need()).query(`DELETE FROM ${R} WHERE id NOT IN (SELECT id FROM ${R} ORDER BY created DESC LIMIT $1)`, [keep]);
+	}
+	async putVisit(rec) {
+		const V = this.#V;
+		const db = await this.#need();
+		await db.query(`INSERT INTO ${V} (key,page,at,visit) VALUES ($1,$2,$3,$4::jsonb) ON CONFLICT (key) DO UPDATE SET at=EXCLUDED.at,visit=EXCLUDED.visit`, [
+			rec.key,
+			rec.page,
+			rec.at,
+			rec.visit
+		]);
+		await db.query(`DELETE FROM ${V} WHERE page = $1 AND key NOT IN (SELECT key FROM ${V} WHERE page = $1 ORDER BY at DESC LIMIT $2)`, [rec.page, MAX_VISITS_PER_KEY]);
+	}
+	async listVisits(page, limit = 10) {
+		const { rows } = await (await this.#need()).query(`SELECT key,page,at,visit FROM ${this.#V} WHERE page = $1 ORDER BY at DESC LIMIT $2`, [page, limit]);
+		return rows.map((r) => ({
+			key: r.key,
+			page: r.page,
+			at: Number(r.at),
+			visit: typeof r.visit === "string" ? r.visit : JSON.stringify(r.visit)
+		}));
+	}
+	async close() {
+		const made = this.#made;
+		this.#made = null;
+		this.#connect = this.#connector();
+		await made?.end?.();
+	}
+	#connector() {
+		return flights({
+			name: "profiler postgres client",
+			run: async () => this.#made = await resolve(this.#client)
+		});
+	}
+	/** The client (nothing drops a connector, so it is never STALE; were it, the current one is
+	*  asked). */
+	async #client_made() {
+		const c = await this.#connect.get();
+		return c === STALE ? this.#client_made() : c;
+	}
+	async #need() {
+		const c = await this.#client_made();
+		await this.#setup.get();
 		return c;
-	};
-	return {
-		kind: "postgres",
-		async init() {
-			await need();
-		},
-		async putReport(rec) {
-			await (await need()).query(`INSERT INTO ${R} (id,created,page,trigger,label,median,dump) VALUES ($1,$2,$3,$4,$5,$6,$7::jsonb)
-				 ON CONFLICT (id) DO UPDATE SET created=EXCLUDED.created,page=EXCLUDED.page,trigger=EXCLUDED.trigger,label=EXCLUDED.label,median=EXCLUDED.median,dump=EXCLUDED.dump`, [
-				rec.id,
-				rec.created,
-				rec.page,
-				rec.trigger,
-				rec.label,
-				rec.median,
-				rec.dump
-			]);
-		},
-		async getReport(id) {
-			const { rows } = await (await need()).query(`SELECT dump FROM ${R} WHERE id = $1`, [id]);
-			if (!rows.length) return null;
-			const d = rows[0].dump;
-			return typeof d === "string" ? d : JSON.stringify(d);
-		},
-		async listReports(limit = 30) {
-			const { rows } = await (await need()).query(`SELECT id,created,page,trigger,label,median FROM ${R} ORDER BY created DESC LIMIT $1`, [limit]);
-			return rows.map((r) => ({
-				id: r.id,
-				created: Number(r.created),
-				page: r.page ?? null,
-				trigger: r.trigger,
-				label: r.label,
-				median: r.median === null ? null : Number(r.median)
-			}));
-		},
-		async deleteReport(id) {
-			await (await need()).query(`DELETE FROM ${R} WHERE id = $1`, [id]);
-		},
-		async prune(keep) {
-			await (await need()).query(`DELETE FROM ${R} WHERE id NOT IN (SELECT id FROM ${R} ORDER BY created DESC LIMIT $1)`, [keep]);
-		},
-		async putVisit(rec) {
-			const db = await need();
-			await db.query(`INSERT INTO ${V} (key,page,at,visit) VALUES ($1,$2,$3,$4::jsonb) ON CONFLICT (key) DO UPDATE SET at=EXCLUDED.at,visit=EXCLUDED.visit`, [
-				rec.key,
-				rec.page,
-				rec.at,
-				rec.visit
-			]);
-			await db.query(`DELETE FROM ${V} WHERE page = $1 AND key NOT IN (SELECT key FROM ${V} WHERE page = $1 ORDER BY at DESC LIMIT $2)`, [rec.page, MAX_VISITS_PER_KEY]);
-		},
-		async listVisits(page, limit = 10) {
-			const { rows } = await (await need()).query(`SELECT key,page,at,visit FROM ${V} WHERE page = $1 ORDER BY at DESC LIMIT $2`, [page, limit]);
-			return rows.map((r) => ({
-				key: r.key,
-				page: r.page,
-				at: Number(r.at),
-				visit: typeof r.visit === "string" ? r.visit : JSON.stringify(r.visit)
-			}));
-		},
-		async close() {
-			await c?.end?.();
-			c = null;
-		}
-	};
-}
-export { postgresStore };
+	}
+	async #create_tables() {
+		const c = await this.#client_made();
+		const R = this.#R;
+		const V = this.#V;
+		const base = this.#base;
+		const schema = this.#schema;
+		if (schema) await c.query(`CREATE SCHEMA IF NOT EXISTS "${schema}"`);
+		await c.query(`CREATE TABLE IF NOT EXISTS ${R} (id TEXT PRIMARY KEY, created BIGINT NOT NULL, page TEXT, trigger TEXT, label TEXT, median DOUBLE PRECISION, dump JSONB NOT NULL)`);
+		await c.query(`CREATE INDEX IF NOT EXISTS ${base}_reports_created ON ${R} (created DESC)`);
+		await c.query(`CREATE TABLE IF NOT EXISTS ${V} (key TEXT PRIMARY KEY, page TEXT NOT NULL, at BIGINT NOT NULL, visit JSONB NOT NULL)`);
+		await c.query(`CREATE INDEX IF NOT EXISTS ${base}_visits_page ON ${V} (page, at DESC)`);
+	}
+};
+export { PostgresStore };

package/dist/profiler/storage/redis.d.ts

@@ -1,4 +1,4 @@
-import { ProfilerStore } from "./index.js";
+import { ProfilerRecord, ProfilerStore, ProfilerSummary, ProfilerVisitRecord } from "./index.js";
 /** The subset of a Redis client this store uses — node-redis and ioredis both satisfy it (their
  *  method names differ in case, and a few calls take options objects on one and arguments on the
  *  other; the flavour is read once, below). */
@@ -12,8 +12,21 @@ interface RedisLike {
   zcard?(key: string): Promise<number>;
   connect?(): Promise<void>;
 }
-export declare function redisStore(client: RedisLike | string, opts?: {
-  ttlSeconds?: number;
-  prefix?: string;
-}): ProfilerStore;
+export declare class RedisStore implements ProfilerStore {
+  #private;
+  readonly kind: string;
+  constructor(client: RedisLike | string, opts?: {
+    ttlSeconds?: number;
+    prefix?: string;
+  });
+  init(): Promise<void>;
+  putReport(rec: ProfilerRecord): Promise<void>;
+  getReport(id: string): Promise<string | null>;
+  listReports(limit?: number): Promise<ProfilerSummary[]>;
+  deleteReport(id: string): Promise<void>;
+  prune(keep: number): Promise<void>;
+  putVisit(rec: ProfilerVisitRecord): Promise<void>;
+  listVisits(page: string, limit?: number): Promise<ProfilerVisitRecord[]>;
+  close(): Promise<void>;
+}
 export {};

package/dist/profiler/storage/redis.js

@@ -1,4 +1,5 @@
 import { MAX_VISITS_PER_KEY } from "./visits.js";
+import { STALE, flights } from "@ogygia/machine";
 // src/profiler/storage/redis.ts
 /** reports kept at most, whatever the host prunes to (a store used on its own still has a cap) */
 const MAX_REPORTS = 1e3;
@@ -6,143 +7,171 @@ async function resolve(client) {
 	if (typeof client !== "string") return client;
 	const nodeRedis = "redis";
 	const ioRedis = "ioredis";
+	let node_redis = null;
 	try {
-		const { createClient } = await import(nodeRedis);
-		const c = createClient({ url: client });
+		node_redis = await import(nodeRedis);
+	} catch {}
+	if (node_redis) {
+		const c = node_redis.createClient({ url: client });
 		await c.connect?.();
 		return c;
-	} catch {}
+	}
 	return new (await (import(ioRedis))).default(client);
 }
-function redisStore(client, opts = {}) {
-	const ttl = opts.ttlSeconds;
-	const prefix = opts.prefix ?? "og:";
-	const R = `${prefix}report:`;
-	const RZ = `${prefix}reports`;
-	const V = `${prefix}visit:`;
-	const VZ = (page) => `${V}z:${page}`;
-	let c = null;
-	const need = async () => c ??= await resolve(client);
-	const node = (r) => typeof r.zAdd === "function" ? r : null;
-	const setStr = async (r, key, val) => {
+const node = (r) => typeof r.zAdd === "function" ? r : null;
+const zadd = (r, key, score, member) => {
+	const n = node(r);
+	return n ? n.zAdd(key, {
+		score,
+		value: member
+	}) : r.zadd(key, score, member);
+};
+const zrem = (r, key, members) => {
+	if (!members.length) return Promise.resolve();
+	const n = node(r);
+	return n ? n.zRem(key, members) : r.zrem(key, ...members);
+};
+const zrange = (r, key, a, b, rev = false) => {
+	const n = node(r);
+	if (n) return rev ? n.zRange(key, a, b, { REV: true }) : n.zRange(key, a, b);
+	return rev ? r.zrange(key, a, b, "REV") : r.zrange(key, a, b);
+};
+const zcard = (r, key) => {
+	const n = node(r);
+	return n ? n.zCard(key) : r.zcard(key);
+};
+/** drop every member but the newest `keep`, with the keys they name */
+const trim = async (r, key, item, keep) => {
+	const stale = await zrange(r, key, 0, -(keep + 1));
+	if (!stale.length) return;
+	await r.del(stale.map((m) => item + m));
+	await zrem(r, key, stale);
+};
+var RedisStore = class {
+	kind = "redis";
+	#client;
+	#ttl;
+	#R;
+	#RZ;
+	#V;
+	/** the client, made once: two first calls share it, and a failure to make it is not kept */
+	#connect;
+	/** the client made, for `close` */
+	#made = null;
+	constructor(client, opts = {}) {
+		const prefix = opts.prefix ?? "og:";
+		this.#client = client;
+		this.#ttl = opts.ttlSeconds;
+		this.#R = `${prefix}report:`;
+		this.#RZ = `${prefix}reports`;
+		this.#V = `${prefix}visit:`;
+		this.#connect = this.#connector();
+	}
+	async init() {
+		await this.#need();
+	}
+	async putReport(rec) {
+		const r = await this.#need();
+		const summary = {
+			id: rec.id,
+			created: rec.created,
+			page: rec.page,
+			trigger: rec.trigger,
+			label: rec.label,
+			median: rec.median
+		};
+		await this.#set_str(r, this.#R + rec.id, JSON.stringify({
+			summary,
+			dump: rec.dump
+		}));
+		await zadd(r, this.#RZ, rec.created, rec.id);
+		if (await zcard(r, this.#RZ) > MAX_REPORTS) await trim(r, this.#RZ, this.#R, MAX_REPORTS);
+	}
+	async getReport(id) {
+		const raw = await (await this.#need()).get(this.#R + id);
+		if (!raw) return null;
+		try {
+			return JSON.parse(raw).dump;
+		} catch {
+			return null;
+		}
+	}
+	async listReports(limit = 30) {
+		const r = await this.#need();
+		const ids = await zrange(r, this.#RZ, 0, limit - 1, true);
+		const out = [];
+		const gone = [];
+		for (const id of ids) {
+			const raw = await r.get(this.#R + id);
+			if (!raw) {
+				gone.push(id);
+				continue;
+			}
+			try {
+				out.push(JSON.parse(raw).summary);
+			} catch {}
+		}
+		await zrem(r, this.#RZ, gone);
+		return out;
+	}
+	async deleteReport(id) {
+		const r = await this.#need();
+		await r.del(this.#R + id);
+		await zrem(r, this.#RZ, [id]);
+	}
+	async prune(keep) {
+		await trim(await this.#need(), this.#RZ, this.#R, keep);
+	}
+	async putVisit(rec) {
+		const r = await this.#need();
+		const vz = this.#VZ(rec.page);
+		await this.#set_str(r, this.#V + rec.key, JSON.stringify(rec));
+		await zadd(r, vz, rec.at, rec.key);
+		if (await zcard(r, vz) > 2e3) await trim(r, vz, this.#V, MAX_VISITS_PER_KEY);
+	}
+	async listVisits(page, limit = 10) {
+		const r = await this.#need();
+		const keys = await zrange(r, this.#VZ(page), 0, limit - 1, true);
+		const out = [];
+		const gone = [];
+		for (const k of keys) {
+			const raw = await r.get(this.#V + k);
+			if (!raw) {
+				gone.push(k);
+				continue;
+			}
+			try {
+				out.push(JSON.parse(raw));
+			} catch {}
+		}
+		await zrem(r, this.#VZ(page), gone);
+		return out;
+	}
+	async close() {
+		const made = this.#made;
+		this.#made = null;
+		this.#connect = this.#connector();
+		await made?.quit?.().catch(() => {});
+	}
+	#connector() {
+		return flights({
+			name: "profiler redis client",
+			run: async () => this.#made = await resolve(this.#client)
+		});
+	}
+	async #need() {
+		const c = await this.#connect.get();
+		return c === STALE ? this.#need() : c;
+	}
+	#VZ(page) {
+		return `${this.#V}z:${page}`;
+	}
+	async #set_str(r, key, val) {
 		const n = node(r);
+		const ttl = this.#ttl;
 		if (!ttl) await r.set(key, val);
 		else if (n) await n.set(key, val, { EX: ttl });
 		else await r.set(key, val, "EX", ttl);
-	};
-	const zadd = (r, key, score, member) => {
-		const n = node(r);
-		return n ? n.zAdd(key, {
-			score,
-			value: member
-		}) : r.zadd(key, score, member);
-	};
-	const zrem = (r, key, members) => {
-		if (!members.length) return Promise.resolve();
-		const n = node(r);
-		return n ? n.zRem(key, members) : r.zrem(key, ...members);
-	};
-	const zrange = (r, key, a, b, rev = false) => {
-		const n = node(r);
-		if (n) return rev ? n.zRange(key, a, b, { REV: true }) : n.zRange(key, a, b);
-		return rev ? r.zrange(key, a, b, "REV") : r.zrange(key, a, b);
-	};
-	const zcard = (r, key) => {
-		const n = node(r);
-		return n ? n.zCard(key) : r.zcard(key);
-	};
-	/** drop every member but the newest `keep`, with the keys they name */
-	const trim = async (r, key, item, keep) => {
-		const stale = await zrange(r, key, 0, -(keep + 1));
-		if (!stale.length) return;
-		await r.del(stale.map((m) => item + m));
-		await zrem(r, key, stale);
-	};
-	return {
-		kind: "redis",
-		async init() {
-			await need();
-		},
-		async putReport(rec) {
-			const r = await need();
-			const summary = {
-				id: rec.id,
-				created: rec.created,
-				page: rec.page,
-				trigger: rec.trigger,
-				label: rec.label,
-				median: rec.median
-			};
-			await setStr(r, R + rec.id, JSON.stringify({
-				summary,
-				dump: rec.dump
-			}));
-			await zadd(r, RZ, rec.created, rec.id);
-			if (await zcard(r, RZ) > MAX_REPORTS) await trim(r, RZ, R, MAX_REPORTS);
-		},
-		async getReport(id) {
-			const raw = await (await need()).get(R + id);
-			if (!raw) return null;
-			try {
-				return JSON.parse(raw).dump;
-			} catch {
-				return null;
-			}
-		},
-		async listReports(limit = 30) {
-			const r = await need();
-			const ids = await zrange(r, RZ, 0, limit - 1, true);
-			const out = [];
-			const gone = [];
-			for (const id of ids) {
-				const raw = await r.get(R + id);
-				if (!raw) {
-					gone.push(id);
-					continue;
-				}
-				try {
-					out.push(JSON.parse(raw).summary);
-				} catch {}
-			}
-			await zrem(r, RZ, gone);
-			return out;
-		},
-		async deleteReport(id) {
-			const r = await need();
-			await r.del(R + id);
-			await zrem(r, RZ, [id]);
-		},
-		async prune(keep) {
-			await trim(await need(), RZ, R, keep);
-		},
-		async putVisit(rec) {
-			const r = await need();
-			await setStr(r, V + rec.key, JSON.stringify(rec));
-			await zadd(r, VZ(rec.page), rec.at, rec.key);
-			if (await zcard(r, VZ(rec.page)) > 2e3) await trim(r, VZ(rec.page), V, MAX_VISITS_PER_KEY);
-		},
-		async listVisits(page, limit = 10) {
-			const r = await need();
-			const keys = await zrange(r, VZ(page), 0, limit - 1, true);
-			const out = [];
-			const gone = [];
-			for (const k of keys) {
-				const raw = await r.get(V + k);
-				if (!raw) {
-					gone.push(k);
-					continue;
-				}
-				try {
-					out.push(JSON.parse(raw));
-				} catch {}
-			}
-			await zrem(r, VZ(page), gone);
-			return out;
-		},
-		async close() {
-			await c?.quit?.().catch(() => {});
-			c = null;
-		}
-	};
-}
-export { redisStore };
+	}
+};
+export { RedisStore };

package/dist/profiler/storage/sqlite.d.ts

@@ -1,2 +1,15 @@
-import { ProfilerStore } from "./index.js";
-export declare function sqliteStore(filename?: string): ProfilerStore;
+import { ProfilerRecord, ProfilerStore, ProfilerSummary, ProfilerVisitRecord } from "./index.js";
+export declare class SqliteStore implements ProfilerStore {
+  #private;
+  readonly kind: string;
+  constructor(filename?: string);
+  init(): void;
+  putReport(rec: ProfilerRecord): void;
+  getReport(id: string): string | null;
+  listReports(limit?: number): ProfilerSummary[];
+  deleteReport(id: string): void;
+  prune(keep: number): void;
+  putVisit(rec: ProfilerVisitRecord): void;
+  listVisits(page: string, limit?: number): ProfilerVisitRecord[];
+  close(): void;
+}