Files
snort/packages/worker-relay/src/sqlite-relay.ts
kieran b764cc1535 feat: worker-relay delete
fix: worker-relay insert replacable events duplicate
2024-05-23 11:59:48 +01:00

383 lines
11 KiB
TypeScript

import sqlite3InitModule, { Database, Sqlite3Static } from "@sqlite.org/sqlite-wasm";
import { EventEmitter } from "eventemitter3";
import { EventMetadata, NostrEvent, RelayHandler, RelayHandlerEvents, ReqFilter, unixNowMs } from "./types";
import migrate from "./migrations";
import { debugLog } from "./debug";
// import wasm file directly, this needs to be copied from https://sqlite.org/download.html
import SqlitePath from "./sqlite3.wasm?url";
export class SqliteRelay extends EventEmitter<RelayHandlerEvents> implements RelayHandler {
#sqlite?: Sqlite3Static;
#log = (msg: string, ...args: Array<any>) => debugLog("SqliteRelay", msg, ...args);
db?: Database;
#seenInserts = new Set<string>();
/**
* Initialize the SQLite driver
*/
async init(path: string) {
if (this.#sqlite) return;
this.#sqlite = await sqlite3InitModule({
locateFile: (path, prefix) => {
if (path === "sqlite3.wasm") {
return SqlitePath;
}
return prefix + path;
},
print: msg => this.#log(msg),
printErr: msg => this.#log(msg),
});
this.#log(`Got SQLite version: ${this.#sqlite.version.libVersion}`);
await this.#open(path);
this.db && migrate(this);
}
/**
* Open the database from its path
*/
async #open(path: string) {
if (!this.#sqlite) throw new Error("Must call init first");
if (this.db) return;
const pool = await this.#sqlite.installOpfsSAHPoolVfs({});
this.db = new pool.OpfsSAHPoolDb(path);
this.#log(`Opened ${this.db.filename}`);
/*this.db.exec(
`PRAGMA cache_size=${32 * 1024
}; PRAGMA page_size=8192; PRAGMA journal_mode=MEMORY; PRAGMA temp_store=MEMORY;`,
);*/
}
close() {
this.db?.close();
this.db = undefined;
}
/**
* Insert an event to the database
*/
event(ev: NostrEvent) {
if (this.#insertEvent(this.db!, ev)) {
this.#log(`Inserted: kind=${ev.kind},authors=${ev.pubkey},id=${ev.id}`);
this.emit("event", [ev]);
return true;
}
return false;
}
sql(sql: string, params: Array<any>) {
return this.db?.selectArrays(sql, params) as Array<Array<string | number>>;
}
/**
* Write multiple events
*/
eventBatch(evs: Array<NostrEvent>) {
const start = unixNowMs();
let eventsInserted: Array<NostrEvent> = [];
this.db?.transaction(db => {
for (const ev of evs) {
if (this.#insertEvent(db, ev)) {
eventsInserted.push(ev);
}
}
});
if (eventsInserted.length > 0) {
this.#log(`Inserted Batch: ${eventsInserted.length}/${evs.length}, ${(unixNowMs() - start).toLocaleString()}ms`);
this.emit("event", eventsInserted);
}
return eventsInserted.length > 0;
}
setEventMetadata(id: string, meta: EventMetadata) {
if (meta.seen_at) {
this.db?.exec("update events set seen_at = ? where id = ?", {
bind: [meta.seen_at, id],
});
}
}
#deleteById(db: Database, ids: Array<string>) {
if (ids.length === 0) return;
db.exec(`delete from events where id in (${this.#repeatParams(ids.length)})`, {
bind: ids,
});
db.exec(`delete from search_content where id in (${this.#repeatParams(ids.length)})`, {
bind: ids,
});
this.#log("Deleted", ids, db.changes());
}
#insertEvent(db: Database, ev: NostrEvent) {
if (this.#seenInserts.has(ev.id)) return false;
const legacyReplacable = [0, 3, 41];
if (legacyReplacable.includes(ev.kind) || (ev.kind >= 10_000 && ev.kind < 20_000)) {
const oldEvents = db.selectValues("select id from events where kind = ? and pubkey = ? and created <= ?", [
ev.kind,
ev.pubkey,
ev.created_at,
]) as Array<string>;
if (oldEvents.includes(ev.id)) {
// we already have this event, return
this.#seenInserts.add(ev.id);
if (oldEvents.length > 1) {
const toDelete = oldEvents.filter(a => a !== ev.id);
this.#deleteById(db, toDelete);
}
return false;
} else {
// delete older versions
this.#deleteById(db, oldEvents);
}
}
if (ev.kind >= 30_000 && ev.kind < 40_000) {
const dTag = ev.tags.find(a => a[0] === "d")![1];
const oldEvents = db.selectValues(
"select id from events where id in (select id from events, tags where events.id = tags.event_id and tags.key = ? and tags.value = ?)",
["d", dTag],
) as Array<string>;
if (oldEvents.includes(ev.id)) {
// we have this version
this.#seenInserts.add(ev.id);
if (oldEvents.length > 1) {
const toDelete = oldEvents.filter(a => a !== ev.id);
this.#deleteById(db, toDelete);
}
return false;
} else {
// delete older versions
this.#deleteById(db, oldEvents);
}
}
db.exec("insert or ignore into events(id, pubkey, created, kind, json) values(?,?,?,?,?)", {
bind: [ev.id, ev.pubkey, ev.created_at, ev.kind, JSON.stringify(ev)],
});
let eventInserted = (this.db?.changes() as number) > 0;
if (eventInserted) {
for (const t of ev.tags.filter(a => a[0].length === 1)) {
db.exec("insert into tags(event_id, key, value) values(?, ?, ?)", {
bind: [ev.id, t[0], t[1]],
});
}
this.insertIntoSearchIndex(db, ev);
}
this.#seenInserts.add(ev.id);
return eventInserted;
}
/**
* Query relay by nostr filter
*/
req(id: string, req: ReqFilter) {
const start = unixNowMs();
const [sql, params] = this.#buildQuery(req);
const res = this.db?.selectArrays(sql, params);
const results =
res?.map(a => {
if (req.ids_only === true) {
return a[0] as string;
}
return JSON.parse(a[0] as string) as NostrEvent;
}) ?? [];
const time = unixNowMs() - start;
this.#log(`Query ${id} results took ${time.toLocaleString()}ms`);
return results;
}
/**
* Count results by nostr filter
*/
count(req: ReqFilter) {
const start = unixNowMs();
const [sql, params] = this.#buildQuery(req, true);
const rows = this.db?.exec(sql, {
bind: params,
returnValue: "resultRows",
});
const results = (rows?.at(0)?.at(0) as number | undefined) ?? 0;
const time = unixNowMs() - start;
this.#log(`Query count results took ${time.toLocaleString()}ms`);
return results;
}
/**
* Delete events by nostr filter
*/
delete(req: ReqFilter) {
this.#log(`Starting delete of ${JSON.stringify(req)}`);
const start = unixNowMs();
const for_delete = this.req("ids-for-delete", { ...req, ids_only: true }) as Array<string>;
const grouped = for_delete.reduce(
(acc, v, i) => {
const batch = (i / 1000).toFixed(0);
acc[batch] ??= [];
acc[batch].push(v);
return acc;
},
{} as Record<string, Array<string>>,
);
this.#log(`Starting delete of ${Object.keys(grouped).length} batches`);
Object.entries(grouped).forEach(([batch, ids]) => {
this.#deleteById(this.db!, ids);
});
const time = unixNowMs() - start;
this.#log(`Delete ${for_delete.length} events took ${time.toLocaleString()}ms`);
return for_delete;
}
/**
* Get a summary about events table
*/
summary() {
const res = this.db?.exec("select kind, count(*) from events group by kind", {
returnValue: "resultRows",
});
return Object.fromEntries(res?.map(a => [String(a[0]), a[1] as number]) ?? []);
}
/**
* Dump the database file
*/
async dump() {
const filePath = String(this.db?.filename ?? "");
try {
this.db?.close();
this.db = undefined;
const dir = await navigator.storage.getDirectory();
// @ts-expect-error
for await (const [name, file] of dir) {
if (`/${name}` === filePath) {
const fh = await (file as FileSystemFileHandle).getFile();
const ret = new Uint8Array(await fh.arrayBuffer());
return ret;
}
}
} catch (e) {
console.error(e);
} finally {
await this.#open(filePath);
}
return new Uint8Array();
}
#buildQuery(req: ReqFilter, count = false, remove = false): [string, Array<any>] {
const conditions: Array<string> = [];
const params: Array<any> = [];
let resultType = "json";
if (count) {
resultType = "count(json)";
} else if (req.ids_only === true) {
resultType = "id";
}
let operation = `select ${resultType}`;
if (remove) {
operation = "delete";
}
let sql = `${operation} from events`;
const tags = Object.entries(req).filter(([k]) => k.startsWith("#"));
let tx = 0;
for (const [key, values] of tags) {
const vArray = values as Array<string>;
sql += ` inner join tags t_${tx} on events.id = t_${tx}.event_id and t_${tx}.key = ? and t_${tx}.value in (${this.#repeatParams(
vArray.length,
)})`;
params.push(key.slice(1));
params.push(...vArray);
tx++;
}
if (req.search) {
sql += " inner join search_content on search_content.id = events.id";
conditions.push("search_content match ?");
params.push(req.search.replaceAll(".", "+").replaceAll("@", "+"));
}
if (req.ids) {
conditions.push(`id in (${this.#repeatParams(req.ids.length)})`);
params.push(...req.ids);
}
if (req.authors) {
conditions.push(`pubkey in (${this.#repeatParams(req.authors.length)})`);
params.push(...req.authors);
}
if (req.kinds) {
conditions.push(`kind in (${this.#repeatParams(req.kinds.length)})`);
params.push(...req.kinds);
}
if (req.since) {
conditions.push("created >= ?");
params.push(req.since);
}
if (req.until) {
conditions.push("created < ?");
params.push(req.until);
}
if (conditions.length > 0) {
sql += ` where ${conditions.join(" and ")}`;
}
if (req.limit) {
sql += ` order by created desc limit ${req.limit}`;
}
return [sql, params];
}
#repeatParams(n: number) {
const ret: Array<string> = [];
for (let x = 0; x < n; x++) {
ret.push("?");
}
return ret.join(", ");
}
#replaceParamsDebug(sql: string, params: Array<number | string>) {
let res = "";
let cIdx = 0;
for (const chr of sql) {
if (chr === "?") {
const px = params[cIdx++];
if (typeof px === "number") {
res += px.toString();
} else if (typeof px === "string") {
res += `'${px}'`;
}
} else {
res += chr;
}
}
return res;
}
insertIntoSearchIndex(db: Database, ev: NostrEvent) {
if (ev.kind === 0) {
const profile = JSON.parse(ev.content) as {
name?: string;
display_name?: string;
lud16?: string;
nip05?: string;
website?: string;
about?: string;
};
if (profile) {
const indexContent = [
profile.name,
profile.display_name,
profile.about,
profile.website,
profile.lud16,
profile.nip05,
].join(" ");
db.exec("insert into search_content values(?,?)", {
bind: [ev.id, indexContent],
});
}
} else if (ev.kind === 1) {
db.exec("insert into search_content values(?,?)", {
bind: [ev.id, ev.content],
});
}
}
}