@waku/core 0.0.24 → 0.0.25-a42b7be.0

package/src/lib/filter/index.ts

@@ -22,7 +22,7 @@ import {
   groupByContentTopic,
   toAsyncIterator
 } from "@waku/utils";
-import debug from "debug";
+import { Logger } from "@waku/utils";
 import all from "it-all";
 import * as lp from "it-length-prefixed";
 import { pipe } from "it-pipe";
@@ -36,7 +36,7 @@ import {
   FilterSubscribeRpc
 } from "./filter_rpc.js";
 
-const log = debug("waku:filter:v2");
+const log = new Logger("filter:v2");
 
 type SubscriptionCallback<T extends IDecodedMessage> = {
   decoders: IDecoder<T>[];
@@ -74,6 +74,16 @@ class Subscription {
     callback: Callback<T>
   ): Promise<void> {
     const decodersArray = Array.isArray(decoders) ? decoders : [decoders];
+
+    // check that all decoders are configured for the same pubsub topic as this subscription
+    decodersArray.forEach((decoder) => {
+      if (decoder.pubsubTopic !== this.pubsubTopic) {
+        throw new Error(
+          `Pubsub topic not configured: decoder is configured for pubsub topic ${decoder.pubsubTopic} but this subscription is for pubsub topic ${this.pubsubTopic}. Please create a new Subscription for the different pubsub topic.`
+        );
+      }
+    });
+
     const decodersGroupedByCT = groupByContentTopic(decodersArray);
     const contentTopics = Array.from(decodersGroupedByCT.keys());
 
@@ -108,7 +118,7 @@ class Subscription {
         );
       }
 
-      log(
+      log.info(
         "Subscribed to peer ",
         this.peer.id.toString(),
         "for content topics",
@@ -174,6 +184,12 @@ class Subscription {
         async (source) => await all(source)
       );
 
+      if (!res || !res.length) {
+        throw Error(
+          `No response received for request ${request.requestId}: ${res}`
+        );
+      }
+
       const { statusCode, requestId, statusDesc } =
         FilterSubscribeResponse.decode(res[0].slice());
 
@@ -183,9 +199,9 @@ class Subscription {
         );
       }
 
-      log("Ping successful");
+      log.info("Ping successful");
     } catch (error) {
-      log("Error pinging: ", error);
+      log.error("Error pinging: ", error);
       throw new Error("Error pinging: " + error);
     }
   }
@@ -206,6 +222,12 @@ class Subscription {
         async (source) => await all(source)
       );
 
+      if (!res || !res.length) {
+        throw Error(
+          `No response received for request ${request.requestId}: ${res}`
+        );
+      }
+
       const { statusCode, requestId, statusDesc } =
         FilterSubscribeResponse.decode(res[0].slice());
 
@@ -216,7 +238,7 @@ class Subscription {
       }
 
       this.subscriptionCallbacks.clear();
-      log("Unsubscribed from all content topics");
+      log.info("Unsubscribed from all content topics");
     } catch (error) {
       throw new Error("Error unsubscribing from all content topics: " + error);
     }
@@ -226,7 +248,7 @@ class Subscription {
     const contentTopic = message.contentTopic;
     const subscriptionCallback = this.subscriptionCallbacks.get(contentTopic);
     if (!subscriptionCallback) {
-      log("No subscription callback available for ", contentTopic);
+      log.error("No subscription callback available for ", contentTopic);
       return;
     }
     await pushMessage(subscriptionCallback, this.pubsubTopic, message);
@@ -260,7 +282,7 @@ class Filter extends BaseProtocol implements IReceiver {
     this.pubsubTopics = options?.pubsubTopics || [DefaultPubSubTopic];
 
     libp2p.handle(FilterCodecs.PUSH, this.onRequest.bind(this)).catch((e) => {
-      log("Failed to register ", FilterCodecs.PUSH, e);
+      log.error("Failed to register ", FilterCodecs.PUSH, e);
     });
 
     this.activeSubscriptions = new Map();
@@ -332,7 +354,6 @@ class Filter extends BaseProtocol implements IReceiver {
   }
 
   private onRequest(streamData: IncomingStreamData): void {
-    log("Receiving message push");
     try {
       pipe(streamData.stream, lp.decode, async (source) => {
         for await (const bytes of source) {
@@ -341,12 +362,12 @@ class Filter extends BaseProtocol implements IReceiver {
           const { pubsubTopic, wakuMessage } = response;
 
           if (!wakuMessage) {
-            log("Received empty message");
+            log.error("Received empty message");
             return;
           }
 
           if (!pubsubTopic) {
-            log("PubSub topic missing from push message");
+            log.error("PubSub topic missing from push message");
             return;
           }
 
@@ -357,7 +378,9 @@ class Filter extends BaseProtocol implements IReceiver {
           );
 
           if (!subscription) {
-            log(`No subscription locally registered for topic ${pubsubTopic}`);
+            log.error(
+              `No subscription locally registered for topic ${pubsubTopic}`
+            );
             return;
           }
 
@@ -365,14 +388,14 @@ class Filter extends BaseProtocol implements IReceiver {
         }
       }).then(
         () => {
-          log("Receiving pipe closed.");
+          log.info("Receiving pipe closed.");
         },
         (e) => {
-          log("Error with receiving pipe", e);
+          log.error("Error with receiving pipe", e);
         }
       );
     } catch (e) {
-      log("Error decoding message", e);
+      log.error("Error decoding message", e);
     }
   }
 }
@@ -392,7 +415,7 @@ async function pushMessage<T extends IDecodedMessage>(
 
   const { contentTopic } = message;
   if (!contentTopic) {
-    log("Message has no content topic, skipping");
+    log.warn("Message has no content topic, skipping");
     return;
   }
 
@@ -407,6 +430,6 @@ async function pushMessage<T extends IDecodedMessage>(
 
     await callback(decodedMessage);
   } catch (e) {
-    log("Error decoding message", e);
+    log.error("Error decoding message", e);
   }
 }

package/src/lib/keep_alive_manager.ts

@@ -2,14 +2,14 @@ import type { PeerId } from "@libp2p/interface/peer-id";
 import type { PeerStore } from "@libp2p/interface/peer-store";
 import type { IRelay, PeerIdStr } from "@waku/interfaces";
 import type { KeepAliveOptions } from "@waku/interfaces";
+import { Logger } from "@waku/utils";
 import { utf8ToBytes } from "@waku/utils/bytes";
-import debug from "debug";
 import type { PingService } from "libp2p/ping";
 
 import { createEncoder } from "./message/version_0.js";
 
 export const RelayPingContentTopic = "/relay-ping/1/ping/null";
-const log = debug("waku:keep-alive");
+const log = new Logger("keep-alive");
 
 export class KeepAliveManager {
   private pingKeepAliveTimers: Map<string, ReturnType<typeof setInterval>>;
@@ -48,9 +48,9 @@ export class KeepAliveManager {
             // also update the peer store with the latency
             try {
               ping = await libp2pPing.ping(peerId);
-              log(`Ping succeeded (${peerIdStr})`, ping);
+              log.info(`Ping succeeded (${peerIdStr})`, ping);
             } catch (error) {
-              log(`Ping failed for peer (${peerIdStr}).
+              log.error(`Ping failed for peer (${peerIdStr}).
                 Next ping will be attempted in ${pingPeriodSecs} seconds.
               `);
               return;
@@ -63,10 +63,10 @@ export class KeepAliveManager {
                 }
               });
             } catch (e) {
-              log("Failed to update ping", e);
+              log.error("Failed to update ping", e);
             }
           } catch (e) {
-            log(`Ping failed (${peerIdStr})`, e);
+            log.error(`Ping failed (${peerIdStr})`, e);
           }
         })();
       }, pingPeriodSecs * 1000);
@@ -128,10 +128,10 @@ export class KeepAliveManager {
         ephemeral: true
       });
       const interval = setInterval(() => {
-        log("Sending Waku Relay ping message");
+        log.info("Sending Waku Relay ping message");
         relay
           .send(encoder, { payload: new Uint8Array([1]) })
-          .catch((e) => log("Failed to send relay ping", e));
+          .catch((e) => log.error("Failed to send relay ping", e));
       }, relayPeriodSecs * 1000);
       intervals.push(interval);
     }

package/src/lib/light_push/index.ts

@@ -11,8 +11,11 @@ import {
   SendResult
 } from "@waku/interfaces";
 import { PushResponse } from "@waku/proto";
-import { ensurePubsubTopicIsConfigured, isSizeValid } from "@waku/utils";
-import debug from "debug";
+import {
+  ensurePubsubTopicIsConfigured,
+  isMessageSizeUnderCap
+} from "@waku/utils";
+import { Logger } from "@waku/utils";
 import all from "it-all";
 import * as lp from "it-length-prefixed";
 import { pipe } from "it-pipe";
@@ -23,7 +26,7 @@ import { DefaultPubSubTopic } from "../constants.js";
 
 import { PushRpc } from "./push_rpc.js";
 
-const log = debug("waku:light-push");
+const log = new Logger("light-push");
 
 export const LightPushCodec = "/vac/waku/lightpush/2.0.0-beta1";
 export { PushResponse };
@@ -56,14 +59,19 @@ class LightPush extends BaseProtocol implements ILightPush {
     pubsubTopic: string
   ): Promise<PreparePushMessageResult> {
     try {
-      if (!isSizeValid(message.payload)) {
-        log("Failed to send waku light push: message is bigger than 1MB");
+      if (!message.payload || message.payload.length === 0) {
+        log.error("Failed to send waku light push: payload is empty");
+        return { query: null, error: SendError.EMPTY_PAYLOAD };
+      }
+
+      if (!(await isMessageSizeUnderCap(encoder, message))) {
+        log.error("Failed to send waku light push: message is bigger than 1MB");
         return { query: null, error: SendError.SIZE_TOO_BIG };
       }
 
       const protoMessage = await encoder.toProtoObj(message);
       if (!protoMessage) {
-        log("Failed to encode to protoMessage, aborting push");
+        log.error("Failed to encode to protoMessage, aborting push");
         return {
           query: null,
           error: SendError.ENCODE_FAILED
@@ -73,7 +81,7 @@ class LightPush extends BaseProtocol implements ILightPush {
       const query = PushRpc.createRequest(protoMessage, pubsubTopic);
       return { query, error: null };
     } catch (error) {
-      log("Failed to prepare push message", error);
+      log.error("Failed to prepare push message", error);
 
       return {
         query: null,
@@ -119,7 +127,10 @@ class LightPush extends BaseProtocol implements ILightPush {
       try {
         stream = await this.getStream(peer);
       } catch (err) {
-        log(`Failed to get a stream for remote peer${peer.id.toString()}`, err);
+        log.error(
+          `Failed to get a stream for remote peer${peer.id.toString()}`,
+          err
+        );
         return { recipients, error: SendError.REMOTE_PEER_FAULT };
       }
 
@@ -133,7 +144,7 @@ class LightPush extends BaseProtocol implements ILightPush {
           async (source) => await all(source)
         );
       } catch (err) {
-        log("Failed to send waku light push request", err);
+        log.error("Failed to send waku light push request", err);
         return { recipients, error: SendError.GENERIC_FAIL };
       }
 
@@ -146,17 +157,17 @@ class LightPush extends BaseProtocol implements ILightPush {
       try {
         response = PushRpc.decode(bytes).response;
       } catch (err) {
-        log("Failed to decode push reply", err);
+        log.error("Failed to decode push reply", err);
         return { recipients, error: SendError.DECODE_FAILED };
       }
 
       if (!response) {
-        log("Remote peer fault: No response in PushRPC");
+        log.error("Remote peer fault: No response in PushRPC");
         return { recipients, error: SendError.REMOTE_PEER_FAULT };
       }
 
       if (!response.isSuccess) {
-        log("Remote peer rejected the message: ", response.info);
+        log.error("Remote peer rejected the message: ", response.info);
         return { recipients, error: SendError.REMOTE_PEER_REJECTED };
       }
 

package/src/lib/message/version_0.ts

@@ -10,11 +10,11 @@ import type {
   PubSubTopic
 } from "@waku/interfaces";
 import { proto_message as proto } from "@waku/proto";
-import debug from "debug";
+import { Logger } from "@waku/utils";
 
 import { DefaultPubSubTopic } from "../constants.js";
 
-const log = debug("waku:message:version-0");
+const log = new Logger("message:version-0");
 const OneMillion = BigInt(1_000_000);
 
 export const Version = 0;
@@ -139,7 +139,6 @@ export class Decoder implements IDecoder<DecodedMessage> {
 
   fromWireToProtoObj(bytes: Uint8Array): Promise<IProtoMessage | undefined> {
     const protoMessage = proto.WakuMessage.decode(bytes);
-    log("Message decoded", protoMessage);
     return Promise.resolve({
       payload: protoMessage.payload,
       contentTopic: protoMessage.contentTopic,
@@ -158,7 +157,7 @@ export class Decoder implements IDecoder<DecodedMessage> {
     // https://rfc.vac.dev/spec/14/
     // > If omitted, the value SHOULD be interpreted as version 0.
     if (proto.version ?? 0 !== Version) {
-      log(
+      log.error(
         "Failed to decode due to incorrect version, expected:",
         Version,
         ", actual:",

package/src/lib/store/index.ts

@@ -11,8 +11,8 @@ import {
 } from "@waku/interfaces";
 import { proto_store as proto } from "@waku/proto";
 import { ensurePubsubTopicIsConfigured, isDefined } from "@waku/utils";
+import { Logger } from "@waku/utils";
 import { concat, utf8ToBytes } from "@waku/utils/bytes";
-import debug from "debug";
 import all from "it-all";
 import * as lp from "it-length-prefixed";
 import { pipe } from "it-pipe";
@@ -26,7 +26,7 @@ import { HistoryRpc, PageDirection, Params } from "./history_rpc.js";
 
 import HistoryError = proto.HistoryResponse.HistoryError;
 
-const log = debug("waku:store");
+const log = new Logger("store");
 
 export const StoreCodec = "/vac/waku/store/2.0.0-beta4";
 
@@ -284,8 +284,6 @@ class Store extends BaseProtocol implements IStore {
       { contentTopics, startTime, endTime }
     );
 
-    log("Querying history with the following options", options);
-
     const peer = (
       await this.getPeers({
         numPeers: this.NUM_PEERS_PROTOCOL,
@@ -325,7 +323,7 @@ async function* paginate<T extends IDecodedMessage>(
 
     const historyRpcQuery = HistoryRpc.createQuery(queryOpts);
 
-    log(
+    log.info(
       "Querying store peer",
       `for (${queryOpts.pubsubTopic})`,
       queryOpts.contentTopics
@@ -349,7 +347,7 @@ async function* paginate<T extends IDecodedMessage>(
     const reply = historyRpcQuery.decode(bytes);
 
     if (!reply.response) {
-      log("Stopping pagination due to store `response` field missing");
+      log.warn("Stopping pagination due to store `response` field missing");
       break;
     }
 
@@ -360,13 +358,13 @@ async function* paginate<T extends IDecodedMessage>(
     }
 
     if (!response.messages || !response.messages.length) {
-      log(
+      log.warn(
         "Stopping pagination due to store `response.messages` field missing or empty"
       );
       break;
     }
 
-    log(`${response.messages.length} messages retrieved from store`);
+    log.error(`${response.messages.length} messages retrieved from store`);
 
     yield response.messages.map((protoMsg) => {
       const contentTopic = protoMsg.contentTopic;
@@ -386,7 +384,7 @@ async function* paginate<T extends IDecodedMessage>(
     if (typeof nextCursor === "undefined") {
       // If the server does not return cursor then there is an issue,
       // Need to abort, or we end up in an infinite loop
-      log(
+      log.warn(
         "Stopping pagination due to `response.pagingInfo.cursor` missing from store response"
       );
       break;

package/src/lib/stream_manager.ts

@@ -2,19 +2,19 @@ import type { PeerUpdate } from "@libp2p/interface";
 import type { Stream } from "@libp2p/interface/connection";
 import { Peer } from "@libp2p/interface/peer-store";
 import { Libp2p } from "@waku/interfaces";
+import { Logger } from "@waku/utils";
 import { selectConnection } from "@waku/utils/libp2p";
-import debug from "debug";
 
 export class StreamManager {
   private streamPool: Map<string, Promise<Stream | void>>;
-  private readonly log: debug.Debugger;
+  private readonly log: Logger;
 
   constructor(
     public multicodec: string,
     public getConnections: Libp2p["getConnections"],
     public addEventListener: Libp2p["addEventListener"]
   ) {
-    this.log = debug(`waku:stream-manager:${multicodec}`);
+    this.log = new Logger(`stream-manager:${multicodec}`);
     this.addEventListener(
       "peer:update",
       this.handlePeerUpdateStreamPool.bind(this)
@@ -57,7 +57,9 @@ export class StreamManager {
   private prepareNewStream(peer: Peer): void {
     const streamPromise = this.newStream(peer).catch(() => {
       // No error thrown as this call is not triggered by the user
-      this.log(`Failed to prepare a new stream for ${peer.id.toString()}`);
+      this.log.error(
+        `Failed to prepare a new stream for ${peer.id.toString()}`
+      );
     });
     this.streamPool.set(peer.id.toString(), streamPromise);
   }
@@ -65,7 +67,7 @@ export class StreamManager {
   private handlePeerUpdateStreamPool = (evt: CustomEvent<PeerUpdate>): void => {
     const peer = evt.detail.peer;
     if (peer.protocols.includes(this.multicodec)) {
-      this.log(`Preemptively opening a stream to ${peer.id.toString()}`);
+      this.log.info(`Preemptively opening a stream to ${peer.id.toString()}`);
       this.prepareNewStream(peer);
     }
   };

package/src/lib/wait_for_remote_peer.ts

@@ -1,10 +1,10 @@
 import type { IdentifyResult } from "@libp2p/interface";
 import type { IBaseProtocol, IRelay, Waku } from "@waku/interfaces";
 import { Protocols } from "@waku/interfaces";
-import debug from "debug";
+import { Logger } from "@waku/utils";
 import { pEvent } from "p-event";
 
-const log = debug("waku:wait-for-remote-peer");
+const log = new Logger("wait-for-remote-peer");
 
 /**
  * Wait for a remote peer to be ready given the passed protocols.
@@ -79,14 +79,13 @@ async function waitForConnectedPeer(protocol: IBaseProtocol): Promise<void> {
   const peers = await protocol.peers();
 
   if (peers.length) {
-    log(`${codec} peer found: `, peers[0].id.toString());
+    log.info(`${codec} peer found: `, peers[0].id.toString());
     return;
   }
 
   await new Promise<void>((resolve) => {
     const cb = (evt: CustomEvent<IdentifyResult>): void => {
       if (evt.detail?.protocols?.includes(codec)) {
-        log("Resolving for", codec, evt.detail.protocols);
         protocol.removeLibp2pEventListener("peer:identify", cb);
         resolve();
       }

package/src/lib/waku.ts

@@ -11,7 +11,7 @@ import type {
   Waku
 } from "@waku/interfaces";
 import { Protocols } from "@waku/interfaces";
-import debug from "debug";
+import { Logger } from "@waku/utils";
 
 import { ConnectionManager } from "./connection_manager.js";
 
@@ -19,7 +19,7 @@ export const DefaultPingKeepAliveValueSecs = 5 * 60;
 export const DefaultRelayKeepAliveValueSecs = 5 * 60;
 export const DefaultUserAgent = "js-waku";
 
-const log = debug("waku:waku");
+const log = new Logger("waku");
 
 export interface WakuOptions {
   /**
@@ -92,7 +92,7 @@ export class WakuNode implements Waku {
       this.relay
     );
 
-    log(
+    log.info(
       "Waku node created",
       peerId,
       `relay: ${!!this.relay}, store: ${!!this.store}, light push: ${!!this
@@ -127,7 +127,7 @@ export class WakuNode implements Waku {
           codecs.push(codec)
         );
       } else {
-        log(
+        log.error(
           "Relay codec not included in dial codec: protocol not mounted locally"
         );
       }
@@ -136,7 +136,7 @@ export class WakuNode implements Waku {
       if (this.store) {
         codecs.push(this.store.multicodec);
       } else {
-        log(
+        log.error(
           "Store codec not included in dial codec: protocol not mounted locally"
         );
       }
@@ -145,7 +145,7 @@ export class WakuNode implements Waku {
       if (this.lightPush) {
         codecs.push(this.lightPush.multicodec);
       } else {
-        log(
+        log.error(
           "Light Push codec not included in dial codec: protocol not mounted locally"
         );
       }
@@ -154,13 +154,13 @@ export class WakuNode implements Waku {
       if (this.filter) {
         codecs.push(this.filter.multicodec);
       } else {
-        log(
+        log.error(
           "Filter codec not included in dial codec: protocol not mounted locally"
         );
       }
     }
 
-    log(`Dialing to ${peerId.toString()} with protocols ${_protocols}`);
+    log.info(`Dialing to ${peerId.toString()} with protocols ${_protocols}`);
 
     return this.libp2p.dialProtocol(peerId, codecs);
   }