Copy all the pipeline logic into DittoAPIStore (and some into DittoPgStore)

This commit is contained in:
Alex Gleason 2025-02-22 12:01:50 -06:00
parent 48bd7618f7
commit 2f0dbc44e4
No known key found for this signature in database
GPG key ID: 7211D1F99744FBB7
2 changed files with 302 additions and 12 deletions

View file

@ -1,5 +1,6 @@
import { DittoConf } from '@ditto/conf'; import { DittoConf } from '@ditto/conf';
import { pipelineEventsCounter } from '@ditto/metrics'; import { DittoDB, DittoTables } from '@ditto/db';
import { pipelineEventsCounter, policyEventsCounter, webPushNotificationsCounter } from '@ditto/metrics';
import { import {
NKinds, NKinds,
NostrEvent, NostrEvent,
@ -9,17 +10,33 @@ import {
NostrRelayEOSE, NostrRelayEOSE,
NostrRelayEVENT, NostrRelayEVENT,
NRelay, NRelay,
NSchema as n,
} from '@nostrify/nostrify'; } from '@nostrify/nostrify';
import { logi } from '@soapbox/logi'; import { logi } from '@soapbox/logi';
import { UpdateObject } from 'kysely';
import { LRUCache } from 'lru-cache'; import { LRUCache } from 'lru-cache';
import tldts from 'tldts';
import { z } from 'zod';
import { DittoPush } from '@/DittoPush.ts';
import { DittoEvent } from '@/interfaces/DittoEvent.ts';
import { RelayError } from '@/RelayError.ts'; import { RelayError } from '@/RelayError.ts';
import { hydrateEvents } from '@/storages/hydrate.ts';
import { eventAge, Time } from '@/utils.ts'; import { eventAge, Time } from '@/utils.ts';
import { getAmount } from '@/utils/bolt11.ts';
import { errorJson } from '@/utils/log.ts';
import { purifyEvent } from '@/utils/purify.ts'; import { purifyEvent } from '@/utils/purify.ts';
import { getTagSet } from '@/utils/tags.ts'; import { getTagSet } from '@/utils/tags.ts';
import { policyWorker } from '@/workers/policy.ts';
import { verifyEventWorker } from '@/workers/verify.ts'; import { verifyEventWorker } from '@/workers/verify.ts';
import { faviconCache } from '@/utils/favicon.ts';
import { parseNoteContent, stripimeta } from '@/utils/note.ts';
import { unfurlCardCached } from '@/utils/unfurl.ts';
import { nip05Cache } from '@/utils/nip05.ts';
import { renderWebPushNotification } from '@/views/mastodon/push.ts';
interface DittoAPIStoreOpts { interface DittoAPIStoreOpts {
db: DittoDB;
conf: DittoConf; conf: DittoConf;
pool: NRelay; pool: NRelay;
relay: NRelay; relay: NRelay;
@ -27,8 +44,13 @@ interface DittoAPIStoreOpts {
export class DittoAPIStore implements NRelay { export class DittoAPIStore implements NRelay {
private encounters = new LRUCache<string, true>({ max: 5000 }); private encounters = new LRUCache<string, true>({ max: 5000 });
private controller = new AbortController();
constructor(private opts: DittoAPIStoreOpts) {} constructor(private opts: DittoAPIStoreOpts) {
this.listen().catch((e: unknown) => {
logi({ level: 'error', ns: 'ditto.apistore', source: 'listen', error: errorJson(e) });
});
}
req( req(
filters: NostrFilter[], filters: NostrFilter[],
@ -52,11 +74,24 @@ export class DittoAPIStore implements NRelay {
})(); })();
} }
/** Open a firehose to the relay. */
private async listen(): Promise<void> {
const { relay } = this.opts;
const { signal } = this.controller;
for await (const msg of relay.req([{}], { signal })) {
if (msg[0] === 'EVENT') {
const [, , event] = msg;
await this.handleEvent(event, { signal });
}
}
}
/** /**
* Common pipeline function to process (and maybe store) events. * Common pipeline function to process (and maybe store) events.
* It is idempotent, so it can be called multiple times for the same event. * It is idempotent, so it can be called multiple times for the same event.
*/ */
async handleEvent(event: NostrEvent, opts?: { signal?: AbortSignal }): Promise<void> { private async handleEvent(event: DittoEvent, opts: { signal?: AbortSignal } = {}): Promise<void> {
const { conf, relay } = this.opts; const { conf, relay } = this.opts;
const { signal } = opts; const { signal } = opts;
@ -78,7 +113,7 @@ export class DittoAPIStore implements NRelay {
throw new RelayError('invalid', 'event too old'); throw new RelayError('invalid', 'event too old');
} }
// Block NIP-70 events, because we have no way to `AUTH`. // Block NIP-70 events, because we have no way to `AUTH`.
if (isProtectedEvent(event)) { if (event.tags.some(([name]) => name === '-')) {
throw new RelayError('invalid', 'protected event'); throw new RelayError('invalid', 'protected event');
} }
// Validate the event's signature. // Validate the event's signature.
@ -110,7 +145,7 @@ export class DittoAPIStore implements NRelay {
// Prepare the event for additional checks. // Prepare the event for additional checks.
// FIXME: This is kind of hacky. Should be reorganized to fetch only what's needed for each stage. // FIXME: This is kind of hacky. Should be reorganized to fetch only what's needed for each stage.
await hydrateEvent(event, signal); await this.hydrateEvent(event, signal);
// Ensure that the author is not banned. // Ensure that the author is not banned.
const n = getTagSet(event.user?.tags ?? [], 'n'); const n = getTagSet(event.user?.tags ?? [], 'n');
@ -118,14 +153,12 @@ export class DittoAPIStore implements NRelay {
throw new RelayError('blocked', 'author is blocked'); throw new RelayError('blocked', 'author is blocked');
} }
const kysely = await Storages.kysely();
try { try {
await this.storeEvent(purifyEvent(event), signal); await relay.event(purifyEvent(event), { signal });
} finally { } finally {
// This needs to run in steps, and should not block the API from responding. // This needs to run in steps, and should not block the API from responding.
Promise.allSettled([ Promise.allSettled([
this.handleZaps(kysely, event), this.handleZaps(event),
this.updateAuthorData(event, signal), this.updateAuthorData(event, signal),
this.prewarmLinkPreview(event, signal), this.prewarmLinkPreview(event, signal),
this.generateSetEvents(event), this.generateSetEvents(event),
@ -135,6 +168,232 @@ export class DittoAPIStore implements NRelay {
} }
} }
private async policyFilter(event: NostrEvent, signal?: AbortSignal): Promise<void> {
try {
const result = await policyWorker.call(event, signal);
const [, , ok, reason] = result;
logi({ level: 'debug', ns: 'ditto.policy', id: event.id, kind: event.kind, ok, reason });
policyEventsCounter.inc({ ok: String(ok) });
RelayError.assert(result);
} catch (e) {
if (e instanceof RelayError) {
throw e;
} else {
logi({ level: 'error', ns: 'ditto.policy', id: event.id, kind: event.kind, error: errorJson(e) });
throw new RelayError('blocked', 'policy error');
}
}
}
/** Stores the event in the 'event_zaps' table */
private async handleZaps(event: NostrEvent) {
if (event.kind !== 9735) return;
const { db } = this.opts;
const zapRequestString = event?.tags?.find(([name]) => name === 'description')?.[1];
if (!zapRequestString) return;
const zapRequest = n.json().pipe(n.event()).optional().catch(undefined).parse(zapRequestString);
if (!zapRequest) return;
const amountSchema = z.coerce.number().int().nonnegative().catch(0);
const amount_millisats = amountSchema.parse(getAmount(event?.tags.find(([name]) => name === 'bolt11')?.[1]));
if (!amount_millisats || amount_millisats < 1) return;
const zappedEventId = zapRequest.tags.find(([name]) => name === 'e')?.[1];
if (!zappedEventId) return;
try {
await db.kysely.insertInto('event_zaps').values({
receipt_id: event.id,
target_event_id: zappedEventId,
sender_pubkey: zapRequest.pubkey,
amount_millisats,
comment: zapRequest.content,
}).execute();
} catch {
// receipt_id is unique, do nothing
}
}
/** Parse kind 0 metadata and track indexes in the database. */
private async updateAuthorData(event: NostrEvent, signal?: AbortSignal): Promise<void> {
if (event.kind !== 0) return;
const { db } = this.opts;
// Parse metadata.
const metadata = n.json().pipe(n.metadata()).catch({}).safeParse(event.content);
if (!metadata.success) return;
const { name, nip05 } = metadata.data;
const updates: UpdateObject<DittoTables, 'author_stats'> = {};
const authorStats = await db.kysely
.selectFrom('author_stats')
.selectAll()
.where('pubkey', '=', event.pubkey)
.executeTakeFirst();
const lastVerified = authorStats?.nip05_last_verified_at;
const eventNewer = !lastVerified || event.created_at > lastVerified;
try {
if (nip05 !== authorStats?.nip05 && eventNewer || !lastVerified) {
if (nip05) {
const tld = tldts.parse(nip05);
if (tld.isIcann && !tld.isIp && !tld.isPrivate) {
const pointer = await nip05Cache.fetch(nip05, { signal });
if (pointer.pubkey === event.pubkey) {
updates.nip05 = nip05;
updates.nip05_domain = tld.domain;
updates.nip05_hostname = tld.hostname;
updates.nip05_last_verified_at = event.created_at;
}
}
} else {
updates.nip05 = null;
updates.nip05_domain = null;
updates.nip05_hostname = null;
updates.nip05_last_verified_at = event.created_at;
}
}
} catch {
// Fallthrough.
}
// Fetch favicon.
const domain = nip05?.split('@')[1].toLowerCase();
if (domain) {
try {
await faviconCache.fetch(domain, { signal });
} catch {
// Fallthrough.
}
}
const search = [name, nip05].filter(Boolean).join(' ').trim();
if (search !== authorStats?.search) {
updates.search = search;
}
if (Object.keys(updates).length) {
await db.kysely.insertInto('author_stats')
.values({
pubkey: event.pubkey,
followers_count: 0,
following_count: 0,
notes_count: 0,
search,
...updates,
})
.onConflict((oc) => oc.column('pubkey').doUpdateSet(updates))
.execute();
}
}
private async prewarmLinkPreview(event: NostrEvent, signal?: AbortSignal): Promise<void> {
const { firstUrl } = parseNoteContent(stripimeta(event.content, event.tags), []);
if (firstUrl) {
await unfurlCardCached(firstUrl, signal);
}
}
private async generateSetEvents(event: NostrEvent): Promise<void> {
const { conf } = this.opts;
const signer = conf.signer;
const pubkey = await signer.getPublicKey();
const tagsAdmin = event.tags.some(([name, value]) => ['p', 'P'].includes(name) && value === pubkey);
if (event.kind === 1984 && tagsAdmin) {
const rel = await signer.signEvent({
kind: 30383,
content: '',
tags: [
['d', event.id],
['p', event.pubkey],
['k', '1984'],
['n', 'open'],
...[...getTagSet(event.tags, 'p')].map((value) => ['P', value]),
...[...getTagSet(event.tags, 'e')].map((value) => ['e', value]),
],
created_at: Math.floor(Date.now() / 1000),
});
await this.handleEvent(rel, { signal: AbortSignal.timeout(1000) });
}
if (event.kind === 3036 && tagsAdmin) {
const rel = await signer.signEvent({
kind: 30383,
content: '',
tags: [
['d', event.id],
['p', event.pubkey],
['k', '3036'],
['n', 'pending'],
],
created_at: Math.floor(Date.now() / 1000),
});
await this.handleEvent(rel, { signal: AbortSignal.timeout(1000) });
}
}
private async webPush(event: NostrEvent): Promise<void> {
if (!this.isFresh(event)) {
throw new RelayError('invalid', 'event too old');
}
const { db } = this.opts;
const pubkeys = getTagSet(event.tags, 'p');
if (!pubkeys.size) {
return;
}
const rows = await db.kysely
.selectFrom('push_subscriptions')
.selectAll()
.where('pubkey', 'in', [...pubkeys])
.execute();
for (const row of rows) {
const viewerPubkey = row.pubkey;
if (viewerPubkey === event.pubkey) {
continue; // Don't notify authors about their own events.
}
const message = await renderWebPushNotification(event, viewerPubkey);
if (!message) {
continue;
}
const subscription = {
endpoint: row.endpoint,
keys: {
auth: row.auth,
p256dh: row.p256dh,
},
};
await DittoPush.push(subscription, message);
webPushNotificationsCounter.inc({ type: message.notification_type });
}
}
/** Hydrate the event with the user, if applicable. */
private async hydrateEvent(event: NostrEvent, signal?: AbortSignal): Promise<DittoEvent> {
const { relay } = this.opts;
const [hydrated] = await hydrateEvents({ events: [event], relay, signal });
return hydrated;
}
/** Determine if the event is being received in a timely manner. */ /** Determine if the event is being received in a timely manner. */
private isFresh(event: NostrEvent): boolean { private isFresh(event: NostrEvent): boolean {
return eventAge(event) < Time.minutes(1); return eventAge(event) < Time.minutes(1);
@ -161,7 +420,16 @@ export class DittoAPIStore implements NRelay {
return relay.remove(filters, opts); return relay.remove(filters, opts);
} }
close(): Promise<void> { async close(): Promise<void> {
return Promise.reject(new Error('Method not implemented.')); const { relay, pool } = this.opts;
this.controller.abort();
await pool.close();
await relay.close();
}
[Symbol.asyncDispose](): Promise<void> {
return this.close();
} }
} }

View file

@ -31,6 +31,7 @@ import { abortError } from '@/utils/abort.ts';
import { purifyEvent } from '@/utils/purify.ts'; import { purifyEvent } from '@/utils/purify.ts';
import { DittoEvent } from '@/interfaces/DittoEvent.ts'; import { DittoEvent } from '@/interfaces/DittoEvent.ts';
import { getMediaLinks } from '@/utils/note.ts'; import { getMediaLinks } from '@/utils/note.ts';
import { updateStats } from '@/utils/stats.ts';
/** Function to decide whether or not to index a tag. */ /** Function to decide whether or not to index a tag. */
type TagCondition = (opts: TagConditionOpts) => boolean; type TagCondition = (opts: TagConditionOpts) => boolean;
@ -144,7 +145,7 @@ export class DittoPgStore extends NPostgres {
await this.deleteEventsAdmin(event); await this.deleteEventsAdmin(event);
try { try {
await super.event(event, { ...opts, timeout: opts.timeout ?? this.opts.timeout }); await this.storeEvent(event, { ...opts, timeout: opts.timeout ?? this.opts.timeout });
this.fulfill(event); // don't await or catch (should never reject) this.fulfill(event); // don't await or catch (should never reject)
} catch (e) { } catch (e) {
if (e instanceof Error && e.message === 'Cannot add a deleted event') { if (e instanceof Error && e.message === 'Cannot add a deleted event') {
@ -157,6 +158,27 @@ export class DittoPgStore extends NPostgres {
} }
} }
/** Maybe store the event, if eligible. */
private async storeEvent(
event: NostrEvent,
opts: { signal?: AbortSignal; timeout?: number } = {},
): Promise<undefined> {
try {
await this.transaction(async (store, kysely) => {
await updateStats({ event, store, kysely });
await super.event(event, opts);
});
} catch (e) {
// If the failure is only because of updateStats (which runs first), insert the event anyway.
// We can't catch this in the transaction because the error aborts the transaction on the Postgres side.
if (e instanceof Error && e.message.includes('event_stats' satisfies keyof DittoTables)) {
await super.event(event, opts);
} else {
throw e;
}
}
}
/** Fulfill active subscriptions with this event. */ /** Fulfill active subscriptions with this event. */
protected async fulfill(event: NostrEvent): Promise<void> { protected async fulfill(event: NostrEvent): Promise<void> {
const { maxAge = 60, batchSize = 500 } = this.opts; const { maxAge = 60, batchSize = 500 } = this.opts;