applesauce-relay 0.0.0-next-20251231062646 → 0.0.0-next-20260116173453

package/dist/relay.d.ts

@@ -25,6 +25,12 @@ export type RelayOptions = {
     publishTimeout?: number;
     /** How long to keep the connection alive after nothing is subscribed (default 30s) */
     keepAlive?: number;
+    /** Enable/disable ping functionality (default false) */
+    enablePing?: boolean;
+    /** How often to send pings in milliseconds (default 29000) */
+    pingFrequency?: number;
+    /** How long to wait for EOSE response in milliseconds (default 20000) */
+    pingTimeout?: number;
     /** Default retry config for subscription() method */
     subscriptionRetry?: RetryConfig;
     /** Default retry config for request() method */
@@ -66,6 +72,8 @@ export declare class Relay implements IRelay {
      * @note Subscribing to this will not connect to the relay
      */
     notice$: Observable<string>;
+    /** Timestamp of the last message received from the relay */
+    private lastMessageReceivedAt;
     /** An observable that emits the NIP-11 information document for the relay */
     information$: Observable<RelayInformation | null>;
     protected _nip11: RelayInformation | null;
@@ -96,6 +104,12 @@ export declare class Relay implements IRelay {
     publishTimeout: number;
     /** How long to keep the connection alive after nothing is subscribed (default 30s) */
     keepAlive: number;
+    /** Enable/disable ping functionality (default false) */
+    enablePing: boolean;
+    /** How often to send pings in milliseconds (default 29000) */
+    pingFrequency: number;
+    /** How long to wait for EOSE response in milliseconds (default 20000) */
+    pingTimeout: number;
     /** Default retry config for subscription() method */
     protected subscriptionReconnect: RetryConfig;
     /** Default retry config for request() method */

package/dist/relay.js

@@ -24,6 +24,11 @@ export var SyncDirection;
 /** An error that is thrown when a REQ is closed from the relay side */
 export class ReqCloseError extends Error {
 }
+/** A dummy filter that will return empty results */
+const PING_FILTER = {
+    ids: ["aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"],
+    limit: 0,
+};
 export class Relay {
     url;
     log = logger.extend("Relay");
@@ -58,6 +63,8 @@ export class Relay {
      * @note Subscribing to this will not connect to the relay
      */
     notice$;
+    /** Timestamp of the last message received from the relay */
+    lastMessageReceivedAt = 0;
     /** An observable that emits the NIP-11 information document for the relay */
     information$;
     _nip11 = null;
@@ -103,6 +110,12 @@ export class Relay {
     publishTimeout = 30_000;
     /** How long to keep the connection alive after nothing is subscribed (default 30s) */
     keepAlive = 30_000;
+    /** Enable/disable ping functionality (default false) */
+    enablePing = false;
+    /** How often to send pings in milliseconds (default 29000) */
+    pingFrequency = 29_000;
+    /** How long to wait for EOSE response in milliseconds (default 20000) */
+    pingTimeout = 20_000;
     /** Default retry config for subscription() method */
     subscriptionReconnect;
     /** Default retry config for request() method */
@@ -142,6 +155,12 @@ export class Relay {
             this.publishTimeout = opts.publishTimeout;
         if (opts?.keepAlive !== undefined)
             this.keepAlive = opts.keepAlive;
+        if (opts?.enablePing !== undefined)
+            this.enablePing = opts.enablePing;
+        if (opts?.pingFrequency !== undefined)
+            this.pingFrequency = opts.pingFrequency;
+        if (opts?.pingTimeout !== undefined)
+            this.pingTimeout = opts.pingTimeout;
         // Set retry configs
         this.subscriptionReconnect = { ...DEFAULT_RETRY_CONFIG, ...(opts?.subscriptionRetry ?? {}) };
         this.requestReconnect = { ...DEFAULT_RETRY_CONFIG, ...(opts?.requestRetry ?? {}) };
@@ -228,7 +247,12 @@ export class Relay {
             this.challenge$.next(challenge);
         }));
         const allMessagesSubject = new Subject();
-        const listenForAllMessages = this.socket.pipe(tap((message) => allMessagesSubject.next(message)));
+        const listenForAllMessages = this.socket.pipe(tap((message) => {
+            // Update the last message received at timestamp
+            this.lastMessageReceivedAt = Date.now();
+            // Pass to the message subject
+            allMessagesSubject.next(message);
+        }));
         // Create passive observables for messages and notices
         this.message$ = allMessagesSubject.asObservable();
         this.notice$ = this.message$.pipe(
@@ -236,12 +260,44 @@ export class Relay {
         filter((m) => Array.isArray(m) && m[0] === "NOTICE"), 
         // pick the string out of the message
         map((m) => m[1]));
+        // Create ping health check observable
+        const pingHealthCheck = this.connected$.pipe(
+        // Switch based on connection state
+        switchMap((connected) => {
+            // Only run when connected and ping is enabled
+            if (!connected || !this.enablePing)
+                return NEVER;
+            // Start timer that emits periodically
+            return timer(this.pingFrequency, this.pingFrequency).pipe(
+            // For each ping, create a dummy REQ and wait for EOSE
+            mergeMap(() => {
+                // Skip ping if we have received a message in the last pingFrequency milliseconds
+                if (Date.now() - this.lastMessageReceivedAt < this.pingFrequency)
+                    return NEVER;
+                // Send a ping request
+                this.send(["REQ", "ping:" + nanoid(), PING_FILTER]);
+                // Wait for the EOSE response
+                return this.message$.pipe(
+                // Complete after first message received
+                take(1), 
+                // Add timeout to detect unresponsive connections
+                timeout({
+                    first: this.pingTimeout,
+                    with: () => {
+                        console.warn(`Relay connection has become unresponsive: ${this.url}`);
+                        return NEVER;
+                    },
+                }));
+            }));
+        }), 
+        // Catch errors to prevent breaking the watchTower
+        catchError(() => NEVER));
         // Merge all watchers
         this.watchTower = this.ready$.pipe(switchMap((ready) => {
             if (!ready)
                 return NEVER;
             // Only start the watch tower if the relay is ready
-            return merge(listenForAllMessages, listenForNotice, ListenForChallenge, this.information$).pipe(
+            return merge(listenForAllMessages, listenForNotice, ListenForChallenge, this.information$, pingHealthCheck).pipe(
             // Never emit any values
             ignoreElements(), 
             // Start the reconnect timer if the connection has an error

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-relay",
-  "version": "0.0.0-next-20251231062646",
+  "version": "0.0.0-next-20260116173453",
   "description": "nostr relay communication framework built on rxjs",
   "type": "module",
   "main": "dist/index.js",
@@ -57,14 +57,14 @@
   },
   "dependencies": {
     "@noble/hashes": "^1.7.1",
-    "applesauce-core": "0.0.0-next-20251231062646",
+    "applesauce-core": "0.0.0-next-20260116173453",
     "nanoid": "^5.0.9",
     "nostr-tools": "~2.19",
     "rxjs": "^7.8.1"
   },
   "devDependencies": {
     "@hirez_io/observer-spy": "^2.2.0",
-    "applesauce-signers": "0.0.0-next-20251231062646",
+    "applesauce-signers": "^5.0.0",
     "rimraf": "^6.0.1",
     "typescript": "^5.7.3",
     "vitest": "^4.0.15",