feat: support #e, #p & generic tag search

migrations/20220524_221800_add_events_table_indexes.js

@@ -1,6 +1,6 @@
 exports.up = function (knex) {
   return knex.raw(
-    `CREATE INDEX event_tags_idx ON events USING GIN ( event_tags );`,
+    'CREATE INDEX event_tags_idx ON events USING GIN ( event_tags );',
   )
 }
 

src/adapters/web-socket-server-adapter.ts

@@ -1,7 +1,7 @@
 import { Server } from 'http'
 import WebSocket, { WebSocketServer } from 'ws'
 
-import { isEventMatchingFilter } from '../event'
+import { isEventMatchingFilter } from '../utils/event'
 import { createOutgoingEventMessage } from '../messages'
 import { Event } from '../types/event'
 import { IMessageHandler } from '../types/message-handlers'
@@ -68,6 +68,7 @@ export class WebSocketServerAdapter extends WebServerAdapter implements IWebSock
   }
 
   private onWebSocketServerConnection(client: WebSocket) {
+    this.heartbeats.set(client, true)
     this.subscriptions.set(client, new Map())
 
     client.on('message', (raw: WebSocket.RawData) => {
@@ -89,7 +90,7 @@ export class WebSocketServerAdapter extends WebServerAdapter implements IWebSock
   private async onWebSocketClientMessage(client: WebSocket, message: Message) {
     for (const handler of this.handlers) {
       if (handler.canHandleMessageType(message[0])) {
-        const handled = await handler.handleMessage(message, client)
+        const handled = await handler.handleMessage(message, client, this)
         if (handled) {
           break
         }
@@ -104,6 +105,7 @@ export class WebSocketServerAdapter extends WebServerAdapter implements IWebSock
   private onWebSocketServerHeartbeat() {
     this.webSocketServer.clients.forEach((client) => {
       if (!this.heartbeats.get(client)) {
+        console.warn('terminating client')
         client.terminate()
         return
       }

src/event.ts

@@ -1,64 +0,0 @@
-import * as secp256k1 from '@noble/secp256k1'
-import { CanonicalEvent, Event } from './types/event'
-import { SubscriptionFilter } from './types/subscription'
-
-export const serializeEvent = (event: Partial<Event>): CanonicalEvent => [
-  0,
-  event.pubkey,
-  event.created_at,
-  event.kind,
-  event.tags,
-  event.content,
-]
-
-export const isEventMatchingFilter =
-  (filter: SubscriptionFilter) =>
-  (event: Event): boolean => {
-    if (Array.isArray(filter.ids) && !filter.ids.includes(event.id)) {
-      return false
-    }
-
-    if (Array.isArray(filter.kinds) && !filter.kinds.includes(event.kind)) {
-      return false
-    }
-
-    if (
-      Array.isArray(filter.authors) &&
-      !filter.authors.includes(event.pubkey)
-    ) {
-      return false
-    }
-
-    if (typeof filter.since === 'number' && event.created_at < filter.since) {
-      return false
-    }
-
-    if (typeof filter.until === 'number' && event.created_at > filter.until) {
-      return false
-    }
-
-    // NIP-01: Support #e and #p tags
-    // NIP-12: Support generic tag queries
-    const isGenericTagQuery = (key: string) => /^#[a-z]$/.test(key)
-
-    if (
-      Object.entries(filter)
-        .filter(
-          ([key, criteria]) =>
-            isGenericTagQuery(key) && Array.isArray(criteria),
-        )
-        .some(([key, criteria]) => {
-          return !event.tags.some(
-            (tag) => tag[0] === key[1] && criteria.includes(tag[1]),
-          )
-        })
-    ) {
-      return false
-    }
-
-    return true
-  }
-
-export const isEventSignatureValid = async (event: Event): Promise<boolean> => {
-  return secp256k1.schnorr.verify(event.sig, event.id, event.pubkey)
-}

src/handlers/event-message-handler.ts

@@ -2,11 +2,11 @@ import { IMessageHandler } from '../types/message-handlers'
 import { MessageType, IncomingEventMessage } from '../types/messages'
 import { IWebSocketServerAdapter } from '../types/servers'
 import { IEventRepository } from '../types/repositories'
-import { isEventSignatureValid } from '../event'
+import { isEventSignatureValid } from '../utils/event'
+import { WebSocket } from 'ws'
 
 export class EventMessageHandler implements IMessageHandler {
   public constructor(
-    private readonly adapter: IWebSocketServerAdapter,
     private readonly eventRepository: IEventRepository,
   ) { }
 
@@ -14,7 +14,7 @@ export class EventMessageHandler implements IMessageHandler {
     return messageType === MessageType.EVENT
   }
 
-  public async handleMessage(message: IncomingEventMessage): Promise<boolean> {
+  public async handleMessage(message: IncomingEventMessage, _client: WebSocket, adapter: IWebSocketServerAdapter): Promise<boolean> {
     if (!await isEventSignatureValid(message[1])) {
       console.warn(`Event ${message[1].id} from ${message[1].pubkey} with signature ${message[1].sig} is not valid`)
       return
@@ -26,7 +26,7 @@ export class EventMessageHandler implements IMessageHandler {
         return true
       }
 
-      await this.adapter.broadcastEvent(message[1])
+      await adapter.broadcastEvent(message[1])
 
       return true
     } catch (error) {

src/handlers/subscribe-message-handler.ts

@@ -11,7 +11,6 @@ import { SubscriptionId, SubscriptionFilter } from '../types/subscription'
 
 export class SubscribeMessageHandler implements IMessageHandler {
   public constructor(
-    private readonly adapter: IWebSocketServerAdapter,
     private readonly eventRepository: IEventRepository,
   ) { }
 
@@ -19,13 +18,13 @@ export class SubscribeMessageHandler implements IMessageHandler {
     return messageType === MessageType.REQ
   }
 
-  public async handleMessage(message: SubscribeMessage, client: WebSocket): Promise<boolean> {
+  public async handleMessage(message: SubscribeMessage, client: WebSocket, adapter: IWebSocketServerAdapter): Promise<boolean> {
     const subscriptionId = message[1] as SubscriptionId
     const filters = message.slice(2) as SubscriptionFilter[]
 
-    const exists = this.adapter.getSubscriptions(client)?.get(subscriptionId)
+    const exists = adapter.getSubscriptions(client)?.get(subscriptionId)
 
-    this.adapter.getSubscriptions(client)?.set(subscriptionId, filters)
+    adapter.getSubscriptions(client)?.set(subscriptionId, filters)
 
     console.log(
       `Subscription ${subscriptionId} ${exists ? 'updated' : 'created'

src/handlers/unsubscribe-message-handler.ts

@@ -6,18 +6,14 @@ import { IWebSocketServerAdapter } from '../types/servers'
 
 
 export class UnsubscribeMessageHandler implements IMessageHandler {
-  public constructor(
-    private readonly adapter: IWebSocketServerAdapter,
-  ) { }
-
   public canHandleMessageType(messageType: MessageType): boolean {
     return messageType === MessageType.CLOSE
   }
 
-  public async handleMessage(message: UnsubscribeMessage, client: WebSocket): Promise<boolean> {
+  public async handleMessage(message: UnsubscribeMessage, client: WebSocket, adapter: IWebSocketServerAdapter): Promise<boolean> {
     const subscriptionId = message[1]
 
-    this.adapter.getSubscriptions(client)?.delete(subscriptionId)
+    adapter.getSubscriptions(client)?.delete(subscriptionId)
 
     return true
   }

src/index.ts

@@ -17,9 +17,9 @@ const adapter = new WebSocketServerAdapter(
   server,
   wss,
 )
-adapter.addMessageHandler(new SubscribeMessageHandler(adapter, eventRepository))
+adapter.addMessageHandler(new SubscribeMessageHandler(eventRepository))
-adapter.addMessageHandler(new UnsubscribeMessageHandler(adapter))
+adapter.addMessageHandler(new UnsubscribeMessageHandler())
-adapter.addMessageHandler(new EventMessageHandler(adapter, eventRepository))
+adapter.addMessageHandler(new EventMessageHandler(eventRepository))
 
 const port = Number(process.env.SERVER_PORT) || 8008
 adapter.listen(port)

src/repositories/event-repository.ts

@@ -4,6 +4,7 @@ import { applySpec, pipe, prop } from 'ramda'
 import { DBEvent, Event } from '../types/event'
 import { IEventRepository } from '../types/repositories'
 import { SubscriptionFilter } from '../types/subscription'
+import { isGenericTagQuery } from '../utils/filter'
 
 const toBuffer = (input: any) => Buffer.from(input, 'hex')
 
@@ -42,6 +43,17 @@ export class EventRepository implements IEventRepository {
         builder.orderBy('event_created_at', 'asc')
       }
 
+      Object.entries(filter)
+        .filter(([key, criteria]) => isGenericTagQuery(key) && Array.isArray(criteria))
+        .forEach(([key, criteria]) => {
+          builder.andWhere(function (bd) {
+            criteria.forEach((criterion) => {
+              bd.orWhereRaw('"event_tags" @> ?', [JSON.stringify([[key[1], criterion]])])
+            })
+          })
+        })
+
+
       return builder
     })
 
@@ -52,8 +64,8 @@ export class EventRepository implements IEventRepository {
 
     console.log('Query', query.toString())
 
-    return query.then((rows) =>
+    return query.then((rows) => {
-      rows.map(
+      const result = rows.map(
         (row) =>
           applySpec({
             id: pipe(prop('event_id'), fromBuffer),
@@ -64,8 +76,12 @@ export class EventRepository implements IEventRepository {
             tags: prop('event_tags'),
             sig: pipe(prop('event_signature'), fromBuffer),
           })(row) as Event,
-      ),
+      )
-    )
+
+      console.debug('result', result[0])
+
+      return result
+    })
   }
 
   public async create(event: Event): Promise<number> {

src/settings.ts

@@ -51,7 +51,7 @@ const createSettings = (): Settings => {
   try {
     return createSettingsFromFile(defaultSettings)
   } catch (err) {
-    console.error(`Unable to read config file. Reason: %s`, err.message)
+    console.error('Unable to read config file. Reason: %s', err.message)
 
     return defaultSettings
   }

src/types/message-handlers.ts

@@ -1,8 +1,9 @@
 import { WebSocket } from 'ws'
 
 import { Message, MessageType } from './messages'
+import { IWebSocketServerAdapter } from './servers'
 
 export interface IMessageHandler {
   canHandleMessageType(messageType: MessageType): boolean
-  handleMessage(message: Message, client: WebSocket): Promise<boolean>
+  handleMessage(message: Message, client: WebSocket, adapter: IWebSocketServerAdapter): Promise<boolean>
 }

src/utils/event.ts

@@ -0,0 +1,64 @@
+import * as secp256k1 from '@noble/secp256k1'
+import { CanonicalEvent, Event } from '../types/event'
+import { SubscriptionFilter } from '../types/subscription'
+import { isGenericTagQuery } from './filter'
+
+export const serializeEvent = (event: Partial<Event>): CanonicalEvent => [
+  0,
+  event.pubkey,
+  event.created_at,
+  event.kind,
+  event.tags,
+  event.content,
+]
+
+export const isEventMatchingFilter =
+  (filter: SubscriptionFilter) =>
+    (event: Event): boolean => {
+      if (Array.isArray(filter.ids) && !filter.ids.includes(event.id)) {
+        return false
+      }
+
+      if (Array.isArray(filter.kinds) && !filter.kinds.includes(event.kind)) {
+        return false
+      }
+
+      if (
+        Array.isArray(filter.authors) &&
+        !filter.authors.includes(event.pubkey)
+      ) {
+        return false
+      }
+
+      if (typeof filter.since === 'number' && event.created_at < filter.since) {
+        return false
+      }
+
+      if (typeof filter.until === 'number' && event.created_at > filter.until) {
+        return false
+      }
+
+      // NIP-01: Support #e and #p tags
+      // NIP-12: Support generic tag queries
+
+      if (
+        Object.entries(filter)
+          .filter(
+            ([key, criteria]) =>
+              isGenericTagQuery(key) && Array.isArray(criteria),
+          )
+          .some(([key, criteria]) => {
+            return !event.tags.some(
+              (tag) => tag[0] === key[1] && criteria.includes(tag[1]),
+            )
+          })
+      ) {
+        return false
+      }
+
+      return true
+    }
+
+export const isEventSignatureValid = async (event: Event): Promise<boolean> => {
+  return secp256k1.schnorr.verify(event.sig, event.id, event.pubkey)
+}

src/utils/filter.ts

@@ -0,0 +1 @@
+export const isGenericTagQuery = (key: string) => /^#[a-z]$/.test(key)

test/unit/events.spec.ts

@@ -1,6 +1,6 @@
 import { expect } from 'chai'
 import { Event, CanonicalEvent } from '../../src/types/event'
-import { isEventMatchingFilter, isEventSignatureValid, serializeEvent } from '../../src/event'
+import { isEventMatchingFilter, isEventSignatureValid, serializeEvent } from '../../src/utils/event'
 import { EventKinds } from '../../src/constants/base'
 
 describe('serializeEvent', () => {