Flesh out subscribe

packages/net2/src/adapter.ts

@@ -3,9 +3,7 @@ import {call, on} from "@welshman/lib"
 import {Relay, LOCAL_RELAY_URL} from "@welshman/util"
 import {RelayMessage, ClientMessage} from "./message.js"
 import {Socket, SocketEventType} from "./socket.js"
-import {TypedEmitter} from "./util.js"
+import {TypedEmitter, Unsubscriber} from "./util.js"
-
-type Unsubscriber = () => void
 
 export enum AdapterEventType {
   Receive = "adapter:event:receive",
@@ -18,6 +16,7 @@ export type AdapterEvents = {
 export abstract class AbstractAdapter extends (EventEmitter as new () => TypedEmitter<AdapterEvents>) {
   _unsubscribers: Unsubscriber[] = []
 
+  abstract urls: string[]
   abstract sockets: Socket[]
   abstract send(message: ClientMessage): void
 
@@ -37,6 +36,10 @@ export class SocketsAdapter extends AbstractAdapter {
     })
   }
 
+  get urls() {
+    return this.sockets.map(socket => socket.url)
+  }
+
   send(message: ClientMessage) {
     for (const socket of this.sockets) {
       socket.send(message)
@@ -55,6 +58,10 @@ export class LocalAdapter extends AbstractAdapter {
     ]
   }
 
+  get urls() {
+    return [LOCAL_RELAY_URL]
+  }
+
   get sockets() {
     return []
   }
@@ -77,6 +84,10 @@ export class MultiAdapter extends AbstractAdapter {
     })
   }
 
+  get urls() {
+    return this.adapters.flatMap(t => t.urls)
+  }
+
   get sockets() {
     return this.adapters.flatMap(t => t.sockets)
   }

packages/net2/src/auth.ts

@@ -3,8 +3,8 @@ import {on, call, sleep} from "@welshman/lib"
 import type {SignedEvent, StampedEvent} from "@welshman/util"
 import {makeEvent, CLIENT_AUTH} from "@welshman/util"
 import {isRelayAuth, isClientAuth, isRelayOk, RelayMessage} from "./message.js"
-import {Socket, SocketStatus, SocketEventType, SocketUnsubscriber} from "./socket.js"
+import {Socket, SocketStatus, SocketEventType} from "./socket.js"
-import {TypedEmitter} from "./util.js"
+import {TypedEmitter, Unsubscriber} from "./util.js"
 
 export const makeAuthEvent = (url: string, challenge: string) =>
   makeEvent(CLIENT_AUTH, {
@@ -42,7 +42,7 @@ export class AuthState extends (EventEmitter as new () => TypedEmitter<AuthState
   request: string | undefined
   details: string | undefined
   status = AuthStatus.None
-  _unsubscribers: SocketUnsubscriber[] = []
+  _unsubscribers: Unsubscriber[] = []
 
   constructor(readonly socket: Socket) {
     super()

packages/net2/src/socket.ts

@@ -29,8 +29,6 @@ export type SocketEvents = {
   [SocketEventType.Receive]: (message: RelayMessage, url: string) => void
 }
 
-export type SocketUnsubscriber = () => void
-
 export class Socket extends (EventEmitter as new () => TypedEmitter<SocketEvents>) {
   _ws?: WebSocket
   _sendQueue: TaskQueue<ClientMessage>

packages/net2/src/subscribe.ts

@@ -1,40 +1,68 @@
 import {EventEmitter} from "events"
-import {on, randomId} from "@welshman/lib"
+import {on, call, randomId} from "@welshman/lib"
-import {Filter, SignedEvent} from "@welshman/util"
+import {Filter, matchFilter, SignedEvent} from "@welshman/util"
 import {RelayMessage, isRelayEvent, isRelayEose} from "./message.js"
 import {AbstractAdapter, AdapterEventType} from "./adapter.js"
-import {TypedEmitter} from "./util.js"
+import {SocketEventType, SocketStatus} from "./socket.js"
+import {TypedEmitter, Unsubscriber} from "./util.js"
+import {Tracker} from "./tracker.js"
 
-export enum SubscribeEventType {
+export enum SubscriptionEventType {
-  Event = "subscribe:event:event",
+  Close = "subscription:event:close",
-  Eose = "subscribe:event:eose",
+  Disconnect = "subscription:event:disconnect",
+  Duplicate = "subscription:event:duplicate",
+  Eose = "subscription:event:eose",
+  Event = "subscription:event:event",
+  Filtered = "subscription:event:filtered",
+  Invalid = "subscription:event:invalid",
 }
 
-export type SubscribeEvents = {
+export type SubscriptionEvents = {
-  [SubscribeEventType.Event]: (event: SignedEvent, url: string) => void
+  [SubscriptionEventType.Close]: () => void
-  [SubscribeEventType.Eose]: (url: string) => void
+  [SubscriptionEventType.Disconnect]: (url: string) => void
+  [SubscriptionEventType.Duplicate]: (event: SignedEvent, url: string) => void
+  [SubscriptionEventType.Eose]: (url: string) => void
+  [SubscriptionEventType.Event]: (event: SignedEvent, url: string) => void
+  [SubscriptionEventType.Filtered]: (event: SignedEvent, url: string) => void
+  [SubscriptionEventType.Invalid]: (event: SignedEvent, url: string) => void
 }
 
-export class Subscribe extends (EventEmitter as new () => TypedEmitter<SubscribeEvents>) {
+export type SubscriptionOptions = {
+  adapter: AbstractAdapter
+  autoClose?: boolean
+  filter: Filter
+  timeout?: number
+  tracker?: Tracker
+  verifyEvent?: (event: SignedEvent) => boolean
+  events?: Partial<SubscriptionEvents>
+}
+
+export class Subscription extends (EventEmitter as new () => TypedEmitter<SubscriptionEvents>) {
   _id = `REQ-${randomId().slice(0, 8)}`
-  _unsubscriber: () => void
+  _unsubscribers: Unsubscriber[] = []
   _closed = false
 
-  constructor(
+  constructor(readonly options: SubscriptionOptions) {
-    readonly adapter: AbstractAdapter,
-    readonly filter: Filter,
-  ) {
     super()
 
-    this._unsubscriber = on(
+    const done = new Set<string>()
-      adapter,
+    const urls = new Set(options.adapter.urls)
-      AdapterEventType.Receive,
+
-      (message: RelayMessage, url: string) => {
+    this._unsubscribers.push(
+      on(options.adapter, AdapterEventType.Receive, (message: RelayMessage, url: string) => {
         if (isRelayEvent(message)) {
           const [_, id, event] = message
 
-          if (id === this._id) {
+          if (id !== this._id) return
-            this.emit(SubscribeEventType.Event, event, url)
+
+          if (options.tracker?.track(event.id, url)) {
+            this.emit(SubscriptionEventType.Duplicate, event, url)
+          } else if (options.verifyEvent?.(event) === false) {
+            this.emit(SubscriptionEventType.Invalid, event, url)
+          } else if (!matchFilter(options.filter, event)) {
+            this.emit(SubscriptionEventType.Filtered, event, url)
+          } else {
+            this.emit(SubscriptionEventType.Event, event, url)
           }
         }
 
@@ -42,20 +70,54 @@ export class Subscribe extends (EventEmitter as new () => TypedEmitter<Subscribe
           const [_, id] = message
 
           if (id === this._id) {
-            this.emit(SubscribeEventType.Eose, url)
+            this.emit(SubscriptionEventType.Eose, url)
+
+            done.add(url)
+
+            if (options.autoClose && done.size === urls.size) {
+              this.close()
+            }
           }
         }
-      },
+      }),
     )
 
-    adapter.send(["REQ", this._id, filter])
+    for (const socket of options.adapter.sockets) {
+      this._unsubscribers.push(
+        on(socket, SocketEventType.Status, (status: SocketStatus) => {
+          if (![SocketStatus.Open, SocketStatus.Opening].includes(status)) {
+            this.emit(SubscriptionEventType.Disconnect, socket.url)
+
+            done.add(socket.url)
+
+            if (options.autoClose && done.size === urls.size) {
+              this.close()
+            }
+          }
+        }),
+      )
+    }
+
+    if (options.timeout) {
+      setTimeout(() => this.close(), options.timeout)
+    }
+
+    if (options.events) {
+      for (const [k, listener] of Object.entries(options.events)) {
+        this.on(k as keyof SubscriptionEvents, listener)
+      }
+    }
+
+    options.adapter.send(["REQ", this._id, options.filter])
   }
 
   close() {
     if (this._closed) return
 
-    this.adapter.send(["CLOSE", this._id])
+    this.options.adapter.send(["CLOSE", this._id])
-    this._unsubscriber()
+    this.emit(SubscriptionEventType.Close)
+    this.removeAllListeners()
+    this._unsubscribers.map(call)
     this._closed = true
   }
 }

packages/net2/src/tracker.ts

@@ -0,0 +1,85 @@
+import {Emitter, addToMapKey} from "@welshman/lib"
+
+export class Tracker extends Emitter {
+  relaysById = new Map<string, Set<string>>()
+  idsByRelay = new Map<string, Set<string>>()
+
+  constructor() {
+    super()
+
+    this.setMaxListeners(100)
+  }
+
+  getIds = (relay: string) => this.idsByRelay.get(relay) || new Set<string>()
+
+  getRelays = (eventId: string) => this.relaysById.get(eventId) || new Set<string>()
+
+  hasRelay = (eventId: string, relay: string) => this.relaysById.get(eventId)?.has(relay)
+
+  addRelay = (eventId: string, relay: string) => {
+    let relays = this.relaysById.get(eventId)
+    let ids = this.idsByRelay.get(relay)
+
+    if (relays?.has(relay) && ids?.has(eventId)) return
+
+    if (!relays) {
+      relays = new Set()
+    }
+
+    if (!ids) {
+      ids = new Set()
+    }
+
+    relays.add(relay)
+    ids.add(eventId)
+
+    this.relaysById.set(eventId, relays)
+    this.idsByRelay.set(relay, ids)
+
+    this.emit("update")
+  }
+
+  removeRelay = (eventId: string, relay: string) => {
+    const didDeleteRelay = this.relaysById.get(eventId)?.delete(relay)
+    const didDeleteId = this.idsByRelay.get(relay)?.delete(eventId)
+
+    if (!didDeleteRelay && !didDeleteId) return
+
+    this.emit("update")
+  }
+
+  track = (eventId: string, relay: string) => {
+    const seen = this.relaysById.has(eventId)
+
+    this.addRelay(eventId, relay)
+
+    return seen
+  }
+
+  copy = (eventId1: string, eventId2: string) => {
+    for (const relay of this.getRelays(eventId1)) {
+      this.addRelay(eventId2, relay)
+    }
+  }
+
+  load = (relaysById: Tracker["relaysById"]) => {
+    this.relaysById.clear()
+    this.idsByRelay.clear()
+
+    for (const [id, relays] of relaysById.entries()) {
+      for (const relay of relays) {
+        addToMapKey(this.relaysById, id, relay)
+        addToMapKey(this.idsByRelay, relay, id)
+      }
+    }
+
+    this.emit("update")
+  }
+
+  clear = () => {
+    this.relaysById.clear()
+    this.idsByRelay.clear()
+
+    this.emit("update")
+  }
+}

packages/net2/src/util.ts

@@ -1,3 +1,5 @@
 import TypedEventEmitter, {EventMap} from "typed-emitter"
 
 export type TypedEmitter<T extends EventMap> = TypedEventEmitter.default<T>
+
+export type Unsubscriber = () => void