Improve EventsDB error handling

This commit is contained in:
Alex Gleason 2024-05-16 10:29:14 -05:00
parent 2ede439005
commit 4df2c7ba9c
No known key found for this signature in database
GPG Key ID: 7211D1F99744FBB7
4 changed files with 90 additions and 20 deletions

View File

@ -122,17 +122,8 @@ async function storeEvent(event: DittoEvent, signal?: AbortSignal): Promise<void
if (NKinds.ephemeral(event.kind)) return; if (NKinds.ephemeral(event.kind)) return;
const store = await Storages.db(); const store = await Storages.db();
const [deletion] = await store.query( await updateStats(event).catch(debug);
[{ kinds: [5], authors: [Conf.pubkey, event.pubkey], '#e': [event.id], limit: 1 }], await store.event(event, { signal });
{ signal },
);
if (deletion) {
return Promise.reject(new RelayError('blocked', 'event was deleted'));
} else {
await updateStats(event).catch(debug);
await store.event(event, { signal }).catch(debug);
}
} }
/** Parse kind 0 metadata and track indexes in the database. */ /** Parse kind 0 metadata and track indexes in the database. */

View File

@ -6,10 +6,13 @@ import { Kysely } from 'kysely';
import { Conf } from '@/config.ts'; import { Conf } from '@/config.ts';
import { DittoDB } from '@/db/DittoDB.ts'; import { DittoDB } from '@/db/DittoDB.ts';
import { DittoTables } from '@/db/DittoTables.ts'; import { DittoTables } from '@/db/DittoTables.ts';
import { RelayError } from '@/RelayError.ts';
import { EventsDB } from '@/storages/EventsDB.ts'; import { EventsDB } from '@/storages/EventsDB.ts';
import { genEvent } from '@/test.ts';
import event0 from '~/fixtures/events/event-0.json' with { type: 'json' }; import event0 from '~/fixtures/events/event-0.json' with { type: 'json' };
import event1 from '~/fixtures/events/event-1.json' with { type: 'json' }; import event1 from '~/fixtures/events/event-1.json' with { type: 'json' };
import { generateSecretKey } from 'nostr-tools';
/** Create in-memory database for testing. */ /** Create in-memory database for testing. */
const createDB = async () => { const createDB = async () => {
@ -140,16 +143,51 @@ Deno.test('admin can delete any event', async () => {
assertEquals(await eventsDB.query([{ kinds: [1] }]), [two]); assertEquals(await eventsDB.query([{ kinds: [1] }]), [two]);
}); });
Deno.test('throws a RelayError when inserting an event deleted by the admin', async () => {
const { eventsDB } = await createDB();
const event = genEvent();
await eventsDB.event(event);
const deletion = genEvent({ kind: 5, tags: [['e', event.id]] }, Conf.seckey);
await eventsDB.event(deletion);
await assertRejects(
() => eventsDB.event(event),
RelayError,
'event deleted by admin',
);
});
Deno.test('throws a RelayError when inserting an event deleted by a user', async () => {
const { eventsDB } = await createDB();
const sk = generateSecretKey();
const event = genEvent({}, sk);
await eventsDB.event(event);
const deletion = genEvent({ kind: 5, tags: [['e', event.id]] }, sk);
await eventsDB.event(deletion);
await assertRejects(
() => eventsDB.event(event),
RelayError,
'event deleted by user',
);
});
Deno.test('inserting replaceable events', async () => { Deno.test('inserting replaceable events', async () => {
const { eventsDB } = await createDB(); const { eventsDB } = await createDB();
assertEquals((await eventsDB.count([{ kinds: [0], authors: [event0.pubkey] }])).count, 0); const event = event0;
await eventsDB.event(event);
await eventsDB.event(event0); const olderEvent = { ...event, id: '123', created_at: event.created_at - 1 };
await assertRejects(() => eventsDB.event(event0)); await eventsDB.event(olderEvent);
assertEquals((await eventsDB.count([{ kinds: [0], authors: [event0.pubkey] }])).count, 1); assertEquals(await eventsDB.query([{ kinds: [0], authors: [event.pubkey] }]), [event]);
const changeEvent = { ...event0, id: '123', created_at: event0.created_at + 1 }; const newerEvent = { ...event, id: '123', created_at: event.created_at + 1 };
await eventsDB.event(changeEvent); await eventsDB.event(newerEvent);
assertEquals(await eventsDB.query([{ kinds: [0] }]), [changeEvent]); assertEquals(await eventsDB.query([{ kinds: [0] }]), [newerEvent]);
}); });

View File

@ -11,6 +11,7 @@ import { purifyEvent } from '@/storages/hydrate.ts';
import { getTagSet } from '@/tags.ts'; import { getTagSet } from '@/tags.ts';
import { isNostrId, isURL } from '@/utils.ts'; import { isNostrId, isURL } from '@/utils.ts';
import { abortError } from '@/utils/abort.ts'; import { abortError } from '@/utils/abort.ts';
import { RelayError } from '@/RelayError.ts';
/** Function to decide whether or not to index a tag. */ /** Function to decide whether or not to index a tag. */
type TagCondition = ({ event, count, value }: { type TagCondition = ({ event, count, value }: {
@ -52,12 +53,36 @@ class EventsDB implements NStore {
async event(event: NostrEvent, _opts?: { signal?: AbortSignal }): Promise<void> { async event(event: NostrEvent, _opts?: { signal?: AbortSignal }): Promise<void> {
event = purifyEvent(event); event = purifyEvent(event);
this.console.debug('EVENT', JSON.stringify(event)); this.console.debug('EVENT', JSON.stringify(event));
if (await this.isDeletedAdmin(event)) {
throw new RelayError('blocked', 'event deleted by admin');
}
await this.deleteEventsAdmin(event); await this.deleteEventsAdmin(event);
return this.store.event(event);
try {
await this.store.event(event);
} catch (e) {
if (e.message === 'Cannot add a deleted event') {
throw new RelayError('blocked', 'event deleted by user');
} else if (e.message === 'Cannot replace an event with an older event') {
return;
} else {
this.console.debug('ERROR', e.message);
}
}
}
/** Check if an event has been deleted by the admin. */
private async isDeletedAdmin(event: NostrEvent): Promise<boolean> {
const [deletion] = await this.query([
{ kinds: [5], authors: [Conf.pubkey], '#e': [event.id], limit: 1 },
]);
return !!deletion;
} }
/** The DITTO_NSEC can delete any event from the database. NDatabase already handles user deletions. */ /** The DITTO_NSEC can delete any event from the database. NDatabase already handles user deletions. */
async deleteEventsAdmin(event: NostrEvent): Promise<void> { private async deleteEventsAdmin(event: NostrEvent): Promise<void> {
if (event.kind === 5 && event.pubkey === Conf.pubkey) { if (event.kind === 5 && event.pubkey === Conf.pubkey) {
const ids = getTagSet(event.tags, 'e'); const ids = getTagSet(event.tags, 'e');
await this.remove([{ ids: [...ids] }]); await this.remove([{ ids: [...ids] }]);

View File

@ -1,7 +1,23 @@
import { NostrEvent } from '@nostrify/nostrify'; import { NostrEvent } from '@nostrify/nostrify';
import { finalizeEvent, generateSecretKey } from 'nostr-tools';
import { purifyEvent } from '@/storages/hydrate.ts';
/** Import an event fixture by name in tests. */ /** Import an event fixture by name in tests. */
export async function eventFixture(name: string): Promise<NostrEvent> { export async function eventFixture(name: string): Promise<NostrEvent> {
const result = await import(`~/fixtures/events/${name}.json`, { with: { type: 'json' } }); const result = await import(`~/fixtures/events/${name}.json`, { with: { type: 'json' } });
return structuredClone(result.default); return structuredClone(result.default);
} }
/** Generate an event for use in tests. */
export function genEvent(t: Partial<NostrEvent> = {}, sk: Uint8Array = generateSecretKey()): NostrEvent {
const event = finalizeEvent({
kind: 255,
created_at: 0,
content: '',
tags: [],
...t,
}, sk);
return purifyEvent(event);
}