applesauce-relay 1.1.0 → 1.2.0

package/dist/__tests__/exports.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/exports.test.js

@@ -0,0 +1,19 @@
+import { describe, expect, it } from "vitest";
+import * as exports from "../index.js";
+describe("exports", () => {
+    it("should export the expected functions", () => {
+        expect(Object.keys(exports).sort()).toMatchInlineSnapshot(`
+      [
+        "Relay",
+        "RelayGroup",
+        "RelayPool",
+        "ReqCloseError",
+        "completeOnEose",
+        "markFromRelay",
+        "onlyEvents",
+        "storeEvents",
+        "toEventStore",
+      ]
+    `);
+    });
+});

package/dist/__tests__/pool.test.js

@@ -1,4 +1,4 @@
-import { test, expect, beforeEach, afterEach } from "vitest";
+import { expect, beforeEach, afterEach, describe, it } from "vitest";
 import { subscribeSpyTo } from "@hirez_io/observer-spy";
 import { WS } from "vitest-websocket-mock";
 import { RelayPool } from "../pool.js";
@@ -27,55 +27,70 @@ afterEach(async () => {
     // Clean up WebSocket mocks
     await WS.clean();
 });
-test("creates new relay connections", () => {
-    const url = "wss://relay1.example.com";
-    const relay = pool.relay(url);
-    expect(relay).toBeDefined();
-    expect(pool.relays.get(url)).toBe(relay);
+describe("relay", () => {
+    it("should create a new relay", () => {
+        const url = "wss://relay1.example.com/";
+        const relay = pool.relay(url);
+        expect(relay).toBeDefined();
+        expect(pool.relays.get(url)).toBe(relay);
+    });
+    it("should return existing relay connection if already exists", () => {
+        const url = "wss://relay1.example.com";
+        const relay1 = pool.relay(url);
+        const relay2 = pool.relay(url);
+        expect(relay1).toBe(relay2);
+        expect(pool.relays.size).toBe(1);
+    });
+    it("should normalize relay urls", () => {
+        expect(pool.relay("wss://relay.example.com")).toBe(pool.relay("wss://relay.example.com/"));
+        expect(pool.relay("wss://relay.example.com:443")).toBe(pool.relay("wss://relay.example.com/"));
+        expect(pool.relay("ws://relay.example.com:80")).toBe(pool.relay("ws://relay.example.com/"));
+    });
 });
-test("returns existing relay connection if already exists", () => {
-    const url = "wss://relay1.example.com";
-    const relay1 = pool.relay(url);
-    const relay2 = pool.relay(url);
-    expect(relay1).toBe(relay2);
-    expect(pool.relays.size).toBe(1);
+describe("group", () => {
+    it("should create a relay group", () => {
+        const urls = ["wss://relay1.example.com/", "wss://relay2.example.com/"];
+        const group = pool.group(urls);
+        expect(group).toBeDefined();
+        expect(pool.groups.get(urls.sort().join(","))).toBe(group);
+    });
 });
-test("creates relay group with multiple relays", () => {
-    const urls = ["wss://relay1.example.com", "wss://relay2.example.com"];
-    const group = pool.group(urls);
-    expect(group).toBeDefined();
-    expect(pool.groups.get(urls.sort().join(","))).toBe(group);
+describe("req", () => {
+    it("should send subscription to multiple relays", async () => {
+        const urls = ["wss://relay1.example.com", "wss://relay2.example.com"];
+        const filters = { kinds: [1] };
+        const spy = subscribeSpyTo(pool.req(urls, filters));
+        // Verify REQ was sent to both relays
+        const req1 = await mockServer1.nextMessage;
+        const req2 = await mockServer2.nextMessage;
+        // Both messages should be REQ messages with the same filter
+        expect(JSON.parse(req1)[0]).toBe("REQ");
+        expect(JSON.parse(req2)[0]).toBe("REQ");
+        expect(JSON.parse(req1)[2]).toEqual(filters);
+        expect(JSON.parse(req2)[2]).toEqual(filters);
+        // Send EVENT from first relay
+        mockServer1.send(JSON.stringify(["EVENT", JSON.parse(req1)[1], mockEvent]));
+        // Send EOSE from both relays
+        mockServer1.send(JSON.stringify(["EOSE", JSON.parse(req1)[1]]));
+        mockServer2.send(JSON.stringify(["EOSE", JSON.parse(req2)[1]]));
+        expect(spy.getValues()).toContainEqual(expect.objectContaining(mockEvent));
+    });
 });
-test("req method sends subscription to multiple relays", async () => {
-    const urls = ["wss://relay1.example.com", "wss://relay2.example.com"];
-    const filters = { kinds: [1] };
-    const spy = subscribeSpyTo(pool.req(urls, filters));
-    // Verify REQ was sent to both relays
-    const req1 = await mockServer1.nextMessage;
-    const req2 = await mockServer2.nextMessage;
-    // Both messages should be REQ messages with the same filter
-    expect(JSON.parse(req1)[0]).toBe("REQ");
-    expect(JSON.parse(req2)[0]).toBe("REQ");
-    expect(JSON.parse(req1)[2]).toEqual(filters);
-    expect(JSON.parse(req2)[2]).toEqual(filters);
-    // Send EVENT from first relay
-    mockServer1.send(JSON.stringify(["EVENT", JSON.parse(req1)[1], mockEvent]));
-    // Send EOSE from both relays
-    mockServer1.send(JSON.stringify(["EOSE", JSON.parse(req1)[1]]));
-    mockServer2.send(JSON.stringify(["EOSE", JSON.parse(req2)[1]]));
-    expect(spy.getValues()).toContainEqual(expect.objectContaining(mockEvent));
-});
-test("event method publishes to multiple relays", async () => {
-    const urls = ["wss://relay1.example.com", "wss://relay2.example.com"];
-    const spy = subscribeSpyTo(pool.event(urls, mockEvent));
-    // Verify EVENT was sent to both relays
-    const event1 = await mockServer1.nextMessage;
-    const event2 = await mockServer2.nextMessage;
-    expect(JSON.parse(event1)).toEqual(["EVENT", mockEvent]);
-    expect(JSON.parse(event2)).toEqual(["EVENT", mockEvent]);
-    // Send OK responses from both relays
-    mockServer1.send(JSON.stringify(["OK", mockEvent.id, true, ""]));
-    mockServer2.send(JSON.stringify(["OK", mockEvent.id, true, ""]));
-    expect(spy.getValues()).toContainEqual({ ok: true, from: "wss://relay1.example.com", message: "" });
-    expect(spy.getValues()).toContainEqual({ ok: true, from: "wss://relay2.example.com", message: "" });
+describe("event", () => {
+    it("should publish to multiple relays", async () => {
+        const urls = ["wss://relay1.example.com/", "wss://relay2.example.com/"];
+        const spy = subscribeSpyTo(pool.event(urls, mockEvent));
+        // Verify EVENT was sent to both relays
+        const event1 = await mockServer1.nextMessage;
+        const event2 = await mockServer2.nextMessage;
+        expect(JSON.parse(event1)).toEqual(["EVENT", mockEvent]);
+        expect(JSON.parse(event2)).toEqual(["EVENT", mockEvent]);
+        // Send OK responses from both relays
+        mockServer1.send(JSON.stringify(["OK", mockEvent.id, true, ""]));
+        mockServer2.send(JSON.stringify(["OK", mockEvent.id, true, ""]));
+        expect(spy.getValues()).toEqual([
+            { ok: true, from: "wss://relay1.example.com/", message: "" },
+            { ok: true, from: "wss://relay2.example.com/", message: "" },
+        ]);
+    });
 });

package/dist/__tests__/relay.test.js

@@ -4,7 +4,7 @@ import { getSeenRelays } from "applesauce-core/helpers";
 import { WS } from "vitest-websocket-mock";
 import { Relay } from "../relay.js";
 import { filter } from "rxjs/operators";
-import { firstValueFrom, of, throwError, timer } from "rxjs";
+import { firstValueFrom, of, Subject, throwError, timer } from "rxjs";
 const defaultMockInfo = {
     name: "Test Relay",
     description: "Test Relay Description",
@@ -49,9 +49,7 @@ describe("req", () => {
     });
     it("should send expected messages to relay", async () => {
         subscribeSpyTo(relay.req([{ kinds: [1] }], "sub1"));
-        // Wait for all message to be sent
-        await new Promise((resolve) => setTimeout(resolve, 10));
-        expect(server.messages).toEqual([["REQ", "sub1", { kinds: [1] }]]);
+        await expect(server).toReceiveMessage(["REQ", "sub1", { kinds: [1] }]);
     });
     it("should not close the REQ when EOSE is received", async () => {
         // Create subscription that completes after first EOSE
@@ -210,6 +208,41 @@ describe("req", () => {
         relay.ready$.next(true);
         await expect(server).toReceiveMessage(["REQ", "sub1", { kinds: [1] }]);
     });
+    it("should wait for filters if filters are provided as an observable", async () => {
+        const filters = new Subject();
+        subscribeSpyTo(relay.req(filters, "sub1"));
+        // Wait 10sm and ensure no messages were sent yet
+        await new Promise((resolve) => setTimeout(resolve, 10));
+        expect(server.messagesToConsume.pendingItems.length).toBe(0);
+        // Send REQ message with filters
+        filters.next([{ kinds: [1] }]);
+        // Wait for the REQ message to be sent
+        await expect(server).toReceiveMessage(["REQ", "sub1", { kinds: [1] }]);
+    });
+    it("should update filters if filters are provided as an observable", async () => {
+        const filters = new Subject();
+        subscribeSpyTo(relay.req(filters, "sub1"));
+        // Send REQ message with filters
+        filters.next([{ kinds: [1] }]);
+        // Should send REQ message with new filters
+        await expect(server).toReceiveMessage(["REQ", "sub1", { kinds: [1] }]);
+        // Send REQ message with filters
+        filters.next([{ kinds: [2] }]);
+        // Should send new REQ message with new filters
+        await expect(server).toReceiveMessage(["REQ", "sub1", { kinds: [2] }]);
+        // It should not send CLOSE message
+        await expect(server.messages).not.toContain(["CLOSE", "sub1"]);
+    });
+    it("should complete if filters are provided as an observable that completes", async () => {
+        const filters = new Subject();
+        const sub = subscribeSpyTo(relay.req(filters, "sub1"));
+        // Send REQ message with filters
+        filters.next([{ kinds: [1] }]);
+        // Complete the observable
+        filters.complete();
+        await sub.onComplete();
+        expect(sub.receivedComplete()).toBe(true);
+    });
 });
 describe("event", () => {
     it("should wait for authentication if relay responds with auth-required", async () => {

package/dist/group.d.ts

@@ -1,19 +1,19 @@
-import { Filter, NostrEvent } from "nostr-tools";
+import { type NostrEvent } from "nostr-tools";
 import { Observable } from "rxjs";
-import { IGroup, IRelay, PublishResponse, SubscriptionResponse, PublishOptions, RequestOptions, SubscriptionOptions } from "./types.js";
+import { IGroup, IRelay, PublishResponse, SubscriptionResponse, PublishOptions, RequestOptions, SubscriptionOptions, FilterInput } from "./types.js";
 export declare class RelayGroup implements IGroup {
     relays: IRelay[];
     constructor(relays: IRelay[]);
     /** Takes an array of observables and only emits EOSE when all observables have emitted EOSE */
     protected mergeEOSE(...requests: Observable<SubscriptionResponse>[]): Observable<import("nostr-tools").Event | "EOSE">;
     /** Make a request to all relays */
-    req(filters: Filter | Filter[], id?: string): Observable<SubscriptionResponse>;
+    req(filters: FilterInput, id?: string): Observable<SubscriptionResponse>;
     /** Send an event to all relays */
     event(event: NostrEvent): Observable<PublishResponse>;
     /** Publish an event to all relays with retries ( default 3 retries ) */
     publish(event: NostrEvent, opts?: PublishOptions): Observable<PublishResponse>;
     /** Request events from all relays with retries ( default 3 retries ) */
-    request(filters: Filter | Filter[], opts?: RequestOptions): Observable<NostrEvent>;
+    request(filters: FilterInput, opts?: RequestOptions): Observable<NostrEvent>;
     /** Open a subscription to all relays with retries ( default 3 retries ) */
-    subscription(filters: Filter | Filter[], opts?: SubscriptionOptions): Observable<SubscriptionResponse>;
+    subscription(filters: FilterInput, opts?: SubscriptionOptions): Observable<SubscriptionResponse>;
 }

package/dist/operators/__tests__/exports.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/operators/__tests__/exports.test.js

@@ -0,0 +1,15 @@
+import { describe, expect, it } from "vitest";
+import * as exports from "../index.js";
+describe("exports", () => {
+    it("should export the expected functions", () => {
+        expect(Object.keys(exports).sort()).toMatchInlineSnapshot(`
+      [
+        "completeOnEose",
+        "markFromRelay",
+        "onlyEvents",
+        "storeEvents",
+        "toEventStore",
+      ]
+    `);
+    });
+});

package/dist/pool.d.ts

@@ -1,8 +1,8 @@
-import { NostrEvent, type Filter } from "nostr-tools";
+import { type NostrEvent } from "nostr-tools";
 import { BehaviorSubject, Observable } from "rxjs";
 import { RelayGroup } from "./group.js";
 import { Relay, RelayOptions } from "./relay.js";
-import { IPool, PublishResponse, PublishOptions, RequestOptions, SubscriptionOptions, SubscriptionResponse } from "./types.js";
+import { IPool, PublishResponse, PublishOptions, RequestOptions, SubscriptionOptions, SubscriptionResponse, FilterInput } from "./types.js";
 export declare class RelayPool implements IPool {
     options?: RelayOptions | undefined;
     groups$: BehaviorSubject<Map<string, RelayGroup>>;
@@ -18,13 +18,13 @@ export declare class RelayPool implements IPool {
     /** Create a group of relays */
     group(relays: string[]): RelayGroup;
     /** Make a REQ to multiple relays that does not deduplicate events */
-    req(relays: string[], filters: Filter | Filter[], id?: string): Observable<SubscriptionResponse>;
+    req(relays: string[], filters: FilterInput, id?: string): Observable<SubscriptionResponse>;
     /** Send an EVENT message to multiple relays */
     event(relays: string[], event: NostrEvent): Observable<PublishResponse>;
     /** Publish an event to multiple relays */
     publish(relays: string[], event: NostrEvent, opts?: PublishOptions): Observable<PublishResponse>;
     /** Request events from multiple relays */
-    request(relays: string[], filters: Filter | Filter[], opts?: RequestOptions): Observable<NostrEvent>;
+    request(relays: string[], filters: FilterInput, opts?: RequestOptions): Observable<NostrEvent>;
     /** Open a subscription to multiple relays */
-    subscription(relays: string[], filters: Filter | Filter[], opts?: SubscriptionOptions): Observable<SubscriptionResponse>;
+    subscription(relays: string[], filters: FilterInput, opts?: SubscriptionOptions): Observable<SubscriptionResponse>;
 }

package/dist/pool.js

@@ -1,6 +1,7 @@
 import { BehaviorSubject } from "rxjs";
 import { RelayGroup } from "./group.js";
 import { Relay } from "./relay.js";
+import { normalizeURL } from "applesauce-core/helpers";
 export class RelayPool {
     options;
     groups$ = new BehaviorSubject(new Map());
@@ -21,19 +22,25 @@ export class RelayPool {
     }
     /** Get or create a new relay connection */
     relay(url) {
+        // Normalize the url
+        url = normalizeURL(url);
+        // Check if the url is blacklisted
         if (this.blacklist.has(url))
             throw new Error("Relay is on blacklist");
+        // Check if the relay already exists
         let relay = this.relays.get(url);
         if (relay)
             return relay;
-        else {
-            relay = new Relay(url, this.options);
-            this.relays$.next(this.relays.set(url, relay));
-            return relay;
-        }
+        // Create a new relay
+        relay = new Relay(url, this.options);
+        this.relays$.next(this.relays.set(url, relay));
+        return relay;
     }
     /** Create a group of relays */
     group(relays) {
+        // Normalize all urls
+        relays = relays.map((url) => normalizeURL(url));
+        // Filter out any blacklisted relays
         relays = this.filterBlacklist(relays);
         const key = relays.sort().join(",");
         let group = this.groups.get(key);

package/dist/relay.d.ts

@@ -3,7 +3,7 @@ import { type Filter, type NostrEvent } from "nostr-tools";
 import { BehaviorSubject, Observable } from "rxjs";
 import { WebSocketSubject, WebSocketSubjectConfig } from "rxjs/webSocket";
 import { RelayInformation } from "nostr-tools/nip11";
-import { AuthSigner, IRelay, PublishOptions, PublishResponse, RequestOptions, SubscriptionOptions, SubscriptionResponse } from "./types.js";
+import { AuthSigner, FilterInput, IRelay, PublishOptions, PublishResponse, RequestOptions, SubscriptionOptions, SubscriptionResponse } from "./types.js";
 /** An error that is thrown when a REQ is closed from the relay side */
 export declare class ReqCloseError extends Error {
 }
@@ -74,7 +74,7 @@ export declare class Relay implements IRelay {
     /** Send a message to the relay */
     next(message: any): void;
     /** Create a REQ observable that emits events or "EOSE" or errors */
-    req(filters: Filter | Filter[], id?: string): Observable<SubscriptionResponse>;
+    req(filters: FilterInput, id?: string): Observable<SubscriptionResponse>;
     /** Send an EVENT or AUTH message and return an observable of PublishResponse that completes or errors */
     event(event: NostrEvent, verb?: "EVENT" | "AUTH"): Observable<PublishResponse>;
     /** send and AUTH message */

package/dist/relay.js

@@ -2,7 +2,7 @@ import { logger } from "applesauce-core";
 import { simpleTimeout } from "applesauce-core/observable";
 import { nanoid } from "nanoid";
 import { nip42 } from "nostr-tools";
-import { BehaviorSubject, catchError, combineLatest, defer, filter, from, ignoreElements, map, merge, mergeMap, NEVER, of, retry, scan, share, shareReplay, Subject, switchMap, take, tap, throwError, timeout, timer, } from "rxjs";
+import { BehaviorSubject, catchError, combineLatest, defer, endWith, filter, finalize, from, ignoreElements, isObservable, map, merge, mergeMap, NEVER, of, retry, scan, share, shareReplay, Subject, switchMap, take, takeUntil, tap, throwError, timeout, timer, } from "rxjs";
 import { webSocket } from "rxjs/webSocket";
 import { completeOnEose } from "./operators/complete-on-eose.js";
 import { markFromRelay } from "./operators/mark-from-relay.js";
@@ -225,10 +225,24 @@ export class Relay {
     }
     /** Create a REQ observable that emits events or "EOSE" or errors */
     req(filters, id = nanoid()) {
-        const request = this.socket.multiplex(() => (Array.isArray(filters) ? ["REQ", id, ...filters] : ["REQ", id, filters]), () => ["CLOSE", id], (message) => (message[0] === "EVENT" || message[0] === "CLOSED" || message[0] === "EOSE") && message[1] === id);
-        // Start the watch tower with the observable
-        const withWatchTower = merge(this.watchTower, request);
-        const observable = withWatchTower.pipe(
+        // Convert filters input into an observable, if its a normal value merge it with NEVER so it never completes
+        const input = isObservable(filters) ? filters : merge(of(filters), NEVER);
+        // Create an observable that completes when the upstream observable completes
+        const complete = input.pipe(ignoreElements(), endWith(null));
+        // Create an observable that filters responses from the relay to just the ones for this REQ
+        const messages = this.socket.pipe(filter((m) => Array.isArray(m) && (m[0] === "EVENT" || m[0] === "CLOSED" || m[0] === "EOSE") && m[1] === id));
+        // Create an observable that controls sending the filters and closing the REQ
+        const control = input.pipe(
+        // Send the filters when they change
+        tap((filters) => this.socket.next(Array.isArray(filters) ? ["REQ", id, ...filters] : ["REQ", id, filters])), 
+        // Close the req when unsubscribed
+        finalize(() => this.socket.next(["CLOSE", id])), 
+        // Once filters have been sent, switch to listening for messages
+        switchMap(() => messages));
+        // Start the watch tower with the observables
+        const observable = merge(this.watchTower, control).pipe(
+        // Complete the subscription when the input is completed
+        takeUntil(complete), 
         // Map the messages to events, EOSE, or throw an error
         map((message) => {
             if (message[0] === "EOSE")

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import { EventTemplate, Filter, NostrEvent } from "nostr-tools";
+import { type EventTemplate, type Filter, type NostrEvent } from "nostr-tools";
 import { Observable } from "rxjs";
 import { WebSocketSubject } from "rxjs/webSocket";
 export type SubscriptionResponse = NostrEvent | "EOSE";
@@ -28,11 +28,13 @@ export type SubscriptionOptions = {
 export type AuthSigner = {
     signEvent: (event: EventTemplate) => NostrEvent | Promise<NostrEvent>;
 };
+/** The type of input the REQ method accepts */
+export type FilterInput = Filter | Filter[] | Observable<Filter | Filter[]>;
 export interface Nip01Actions {
     /** Send an EVENT message */
     event(event: NostrEvent): Observable<PublishResponse>;
     /** Send a REQ message */
-    req(filters: Filter | Filter[], id?: string): Observable<SubscriptionResponse>;
+    req(filters: FilterInput, id?: string): Observable<SubscriptionResponse>;
 }
 export interface IRelay extends MultiplexWebSocket, Nip01Actions, IRelayState {
     url: string;
@@ -52,12 +54,12 @@ export interface IRelay extends MultiplexWebSocket, Nip01Actions, IRelayState {
         retries?: number;
     }): Observable<PublishResponse>;
     /** Send a REQ message with retries */
-    request(filters: Filter | Filter[], opts?: {
+    request(filters: FilterInput, opts?: {
         id?: string;
         retries?: number;
     }): Observable<NostrEvent>;
     /** Open a subscription with retries */
-    subscription(filters: Filter | Filter[], opts?: {
+    subscription(filters: FilterInput, opts?: {
         id?: string;
         retries?: number;
     }): Observable<SubscriptionResponse>;
@@ -68,12 +70,12 @@ export interface IGroup extends Nip01Actions {
         retries?: number;
     }): Observable<PublishResponse>;
     /** Send a REQ message with retries */
-    request(filters: Filter | Filter[], opts?: {
+    request(filters: FilterInput, opts?: {
         id?: string;
         retries?: number;
     }): Observable<NostrEvent>;
     /** Open a subscription with retries */
-    subscription(filters: Filter | Filter[], opts?: {
+    subscription(filters: FilterInput, opts?: {
         id?: string;
         retries?: number;
     }): Observable<SubscriptionResponse>;
@@ -82,7 +84,7 @@ export interface IPool {
     /** Send an EVENT message */
     event(relays: string[], event: NostrEvent): Observable<PublishResponse>;
     /** Send a REQ message */
-    req(relays: string[], filters: Filter | Filter[], id?: string): Observable<SubscriptionResponse>;
+    req(relays: string[], filters: FilterInput, id?: string): Observable<SubscriptionResponse>;
     /** Get or create a relay */
     relay(url: string): IRelay;
     /** Create a relay group */
@@ -92,12 +94,12 @@ export interface IPool {
         retries?: number;
     }): Observable<PublishResponse>;
     /** Send a REQ message to relays with retries */
-    request(relays: string[], filters: Filter | Filter[], opts?: {
+    request(relays: string[], filters: FilterInput, opts?: {
         id?: string;
         retries?: number;
     }): Observable<NostrEvent>;
     /** Open a subscription to relays with retries */
-    subscription(relays: string[], filters: Filter | Filter[], opts?: {
+    subscription(relays: string[], filters: FilterInput, opts?: {
         id?: string;
         retries?: number;
     }): Observable<SubscriptionResponse>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-relay",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "nostr relay communication framework built on rxjs",
   "type": "module",
   "main": "dist/index.js",
@@ -54,7 +54,7 @@
   },
   "dependencies": {
     "@noble/hashes": "^1.7.1",
-    "applesauce-core": "^1.0.0",
+    "applesauce-core": "^1.2.0",
     "nanoid": "^5.0.9",
     "nostr-tools": "^2.10.4",
     "rxjs": "^7.8.1"