js-waku/packages/tests/tests/relay.node.spec.ts

import type { PeerId } from "@libp2p/interface/peer-id";
import {
  createDecoder,
  createEncoder,
  DecodedMessage,
  DefaultPubSubTopic,
  waitForRemotePeer
} from "@waku/core";
import { RelayNode, SendError } from "@waku/interfaces";
import { Protocols } from "@waku/interfaces";
import {
  createDecoder as createEciesDecoder,
  createEncoder as createEciesEncoder,
  generatePrivateKey,
  getPublicKey
} from "@waku/message-encryption/ecies";
import {
  createDecoder as createSymDecoder,
  createEncoder as createSymEncoder,
  generateSymmetricKey
} from "@waku/message-encryption/symmetric";
import { createRelayNode } from "@waku/sdk";
import { bytesToUtf8, utf8ToBytes } from "@waku/utils/bytes";
import { expect } from "chai";
import debug from "debug";

import {
  delay,
  makeLogFileName,
  NOISE_KEY_1,
  NOISE_KEY_2,
  NOISE_KEY_3
} from "../src/index.js";
import { MessageRpcResponse } from "../src/node/interfaces.js";
import { base64ToUtf8, NimGoNode } from "../src/node/node.js";
import { generateRandomUint8Array } from "../src/random_array.js";

const log = debug("waku:test");

const TestContentTopic = "/test/1/waku-relay/utf8";
const TestEncoder = createEncoder({ contentTopic: TestContentTopic });
const TestDecoder = createDecoder(TestContentTopic);

describe("Waku Relay [node only]", () => {
  // Node needed as we don't have a way to connect 2 js waku
  // nodes in the browser yet
  describe("2 js nodes", () => {
    afterEach(function () {
      if (this.currentTest?.state === "failed") {
        console.log(`Test failed, log file name is ${makeLogFileName(this)}`);
      }
    });

    let waku1: RelayNode;
    let waku2: RelayNode;
    beforeEach(async function () {
      this.timeout(10000);

      log("Starting JS Waku instances");
      [waku1, waku2] = await Promise.all([
        createRelayNode({ staticNoiseKey: NOISE_KEY_1 }).then((waku) =>
          waku.start().then(() => waku)
        ),
        createRelayNode({
          staticNoiseKey: NOISE_KEY_2,
          libp2p: { addresses: { listen: ["/ip4/0.0.0.0/tcp/0/ws"] } }
        }).then((waku) => waku.start().then(() => waku))
      ]);
      log("Instances started, adding waku2 to waku1's address book");
      await waku1.libp2p.peerStore.merge(waku2.libp2p.peerId, {
        multiaddrs: waku2.libp2p.getMultiaddrs()
      });
      await waku1.dial(waku2.libp2p.peerId);

      log("Wait for mutual pubsub subscription");
      await Promise.all([
        waitForRemotePeer(waku1, [Protocols.Relay]),
        waitForRemotePeer(waku2, [Protocols.Relay])
      ]);
      log("before each hook done");
    });

    afterEach(async function () {
      !!waku1 &&
        waku1.stop().catch((e) => console.log("Waku failed to stop", e));
      !!waku2 &&
        waku2.stop().catch((e) => console.log("Waku failed to stop", e));
    });

    it("Subscribe", async function () {
      log("Getting subscribers");
      const subscribers1 = waku1.libp2p.services
        .pubsub!.getSubscribers(DefaultPubSubTopic)
        .map((p) => p.toString());
      const subscribers2 = waku2.libp2p.services
        .pubsub!.getSubscribers(DefaultPubSubTopic)
        .map((p) => p.toString());

      log("Asserting mutual subscription");
      expect(subscribers1).to.contain(waku2.libp2p.peerId.toString());
      expect(subscribers2).to.contain(waku1.libp2p.peerId.toString());
    });

    it("Register correct protocols", async function () {
      const protocols = waku1.libp2p.getProtocols();

      expect(protocols).to.contain("/vac/waku/relay/2.0.0");
      expect(protocols.findIndex((value) => value.match(/sub/))).to.eq(-1);
    });

    it("Publish", async function () {
      this.timeout(10000);

      const messageText = "JS to JS communication works";
      const messageTimestamp = new Date("1995-12-17T03:24:00");
      const message = {
        payload: utf8ToBytes(messageText),
        timestamp: messageTimestamp
      };

      const receivedMsgPromise: Promise<DecodedMessage> = new Promise(
        (resolve) => {
          void waku2.relay.subscribe([TestDecoder], resolve);
        }
      );

      await waku1.relay.send(TestEncoder, message);

      const receivedMsg = await receivedMsgPromise;

      expect(receivedMsg.contentTopic).to.eq(TestContentTopic);
      expect(bytesToUtf8(receivedMsg.payload)).to.eq(messageText);
      expect(receivedMsg.timestamp?.valueOf()).to.eq(
        messageTimestamp.valueOf()
      );
    });

    it("Filter on content topics", async function () {
      this.timeout(10000);

      const fooMessageText = "Published on content topic foo";
      const barMessageText = "Published on content topic bar";

      const fooContentTopic = "foo";
      const barContentTopic = "bar";

      const fooEncoder = createEncoder({ contentTopic: fooContentTopic });
      const barEncoder = createEncoder({ contentTopic: barContentTopic });

      const fooDecoder = createDecoder(fooContentTopic);
      const barDecoder = createDecoder(barContentTopic);

      const fooMessages: DecodedMessage[] = [];
      void waku2.relay.subscribe([fooDecoder], (msg) => {
        fooMessages.push(msg);
      });

      const barMessages: DecodedMessage[] = [];
      void waku2.relay.subscribe([barDecoder], (msg) => {
        barMessages.push(msg);
      });

      await waku1.relay.send(barEncoder, {
        payload: utf8ToBytes(barMessageText)
      });
      await waku1.relay.send(fooEncoder, {
        payload: utf8ToBytes(fooMessageText)
      });

      while (!fooMessages.length && !barMessages.length) {
        await delay(100);
      }

      expect(fooMessages[0].contentTopic).to.eq(fooContentTopic);
      expect(bytesToUtf8(fooMessages[0].payload)).to.eq(fooMessageText);

      expect(barMessages[0].contentTopic).to.eq(barContentTopic);
      expect(bytesToUtf8(barMessages[0].payload)).to.eq(barMessageText);

      expect(fooMessages.length).to.eq(1);
      expect(barMessages.length).to.eq(1);
    });

    it("Decrypt messages", async function () {
      this.timeout(10000);

      const asymText = "This message is encrypted using asymmetric";
      const asymTopic = "/test/1/asymmetric/proto";
      const symText = "This message is encrypted using symmetric encryption";
      const symTopic = "/test/1/symmetric/proto";

      const privateKey = generatePrivateKey();
      const symKey = generateSymmetricKey();
      const publicKey = getPublicKey(privateKey);

      const eciesEncoder = createEciesEncoder({
        contentTopic: asymTopic,
        publicKey
      });
      const symEncoder = createSymEncoder({
        contentTopic: symTopic,
        symKey
      });

      const eciesDecoder = createEciesDecoder(asymTopic, privateKey);
      const symDecoder = createSymDecoder(symTopic, symKey);

      const msgs: DecodedMessage[] = [];
      void waku2.relay.subscribe([eciesDecoder], (wakuMsg) => {
        msgs.push(wakuMsg);
      });
      void waku2.relay.subscribe([symDecoder], (wakuMsg) => {
        msgs.push(wakuMsg);
      });

      await waku1.relay.send(eciesEncoder, { payload: utf8ToBytes(asymText) });
      await delay(200);
      await waku1.relay.send(symEncoder, { payload: utf8ToBytes(symText) });

      while (msgs.length < 2) {
        await delay(200);
      }

      expect(msgs[0].contentTopic).to.eq(asymTopic);
      expect(bytesToUtf8(msgs[0].payload!)).to.eq(asymText);
      expect(msgs[1].contentTopic).to.eq(symTopic);
      expect(bytesToUtf8(msgs[1].payload!)).to.eq(symText);
    });

    it("Delete observer", async function () {
      this.timeout(10000);

      const messageText =
        "Published on content topic with added then deleted observer";

      const contentTopic = "added-then-deleted-observer";

      // The promise **fails** if we receive a message on this observer.
      const receivedMsgPromise: Promise<DecodedMessage> = new Promise(
        (resolve, reject) => {
          const deleteObserver = waku2.relay.subscribe(
            [createDecoder(contentTopic)],
            reject
          ) as () => void;
          deleteObserver();
          setTimeout(resolve, 500);
        }
      );
      await waku1.relay.send(createEncoder({ contentTopic }), {
        payload: utf8ToBytes(messageText)
      });

      await receivedMsgPromise;
      // If it does not throw then we are good.
    });
  });

  describe("Custom pubsub topic", () => {
    let waku1: RelayNode;
    let waku2: RelayNode;
    let waku3: RelayNode;

    const pubSubTopic = "/some/pubsub/topic";

    const CustomTopicEncoder = createEncoder({
      contentTopic: TestContentTopic,
      pubSubTopic: pubSubTopic
    });
    const CustomTopicDecoder = createDecoder(TestContentTopic, pubSubTopic);

    afterEach(async function () {
      !!waku1 &&
        waku1.stop().catch((e) => console.log("Waku failed to stop", e));
      !!waku2 &&
        waku2.stop().catch((e) => console.log("Waku failed to stop", e));
      !!waku3 &&
        waku3.stop().catch((e) => console.log("Waku failed to stop", e));
    });

    it("Publish", async function () {
      this.timeout(10000);

      // 1 and 2 uses a custom pubsub
      // 3 uses the default pubsub
      [waku1, waku2, waku3] = await Promise.all([
        createRelayNode({
          pubSubTopics: [pubSubTopic],
          staticNoiseKey: NOISE_KEY_1
        }).then((waku) => waku.start().then(() => waku)),
        createRelayNode({
          pubSubTopics: [pubSubTopic],
          staticNoiseKey: NOISE_KEY_2,
          libp2p: { addresses: { listen: ["/ip4/0.0.0.0/tcp/0/ws"] } }
        }).then((waku) => waku.start().then(() => waku)),
        createRelayNode({
          staticNoiseKey: NOISE_KEY_3
        }).then((waku) => waku.start().then(() => waku))
      ]);

      await waku1.libp2p.peerStore.merge(waku2.libp2p.peerId, {
        multiaddrs: waku2.libp2p.getMultiaddrs()
      });
      await waku3.libp2p.peerStore.merge(waku2.libp2p.peerId, {
        multiaddrs: waku2.libp2p.getMultiaddrs()
      });
      await Promise.all([
        waku1.dial(waku2.libp2p.peerId),
        waku3.dial(waku2.libp2p.peerId)
      ]);

      await Promise.all([
        waitForRemotePeer(waku1, [Protocols.Relay]),
        waitForRemotePeer(waku2, [Protocols.Relay])
      ]);

      const messageText = "Communicating using a custom pubsub topic";

      const waku2ReceivedMsgPromise: Promise<DecodedMessage> = new Promise(
        (resolve) => {
          void waku2.relay.subscribe([CustomTopicDecoder], resolve);
        }
      );

      // The promise **fails** if we receive a message on the default
      // pubsub topic.
      const waku3NoMsgPromise: Promise<DecodedMessage> = new Promise(
        (resolve, reject) => {
          void waku3.relay.subscribe([TestDecoder], reject);
          setTimeout(resolve, 1000);
        }
      );

      await waku1.relay.send(CustomTopicEncoder, {
        payload: utf8ToBytes(messageText)
      });

      const waku2ReceivedMsg = await waku2ReceivedMsgPromise;
      await waku3NoMsgPromise;

      expect(bytesToUtf8(waku2ReceivedMsg.payload!)).to.eq(messageText);
      expect(waku2ReceivedMsg.pubSubTopic).to.eq(pubSubTopic);
    });

    it("Publishes <= 1 MB and rejects others", async function () {
      this.timeout(10000);
      const MB = 1024 ** 2;

      // 1 and 2 uses a custom pubsub
      [waku1, waku2] = await Promise.all([
        createRelayNode({
          pubSubTopics: [pubSubTopic],
          staticNoiseKey: NOISE_KEY_1
        }).then((waku) => waku.start().then(() => waku)),
        createRelayNode({
          pubSubTopics: [pubSubTopic],
          staticNoiseKey: NOISE_KEY_2,
          libp2p: { addresses: { listen: ["/ip4/0.0.0.0/tcp/0/ws"] } }
        }).then((waku) => waku.start().then(() => waku))
      ]);

      await waku1.libp2p.peerStore.merge(waku2.libp2p.peerId, {
        multiaddrs: waku2.libp2p.getMultiaddrs()
      });
      await Promise.all([waku1.dial(waku2.libp2p.peerId)]);

      await Promise.all([
        waitForRemotePeer(waku1, [Protocols.Relay]),
        waitForRemotePeer(waku2, [Protocols.Relay])
      ]);

      const waku2ReceivedMsgPromise: Promise<DecodedMessage> = new Promise(
        (resolve) => {
          void waku2.relay.subscribe([CustomTopicDecoder], () =>
            resolve({
              payload: new Uint8Array([])
            } as DecodedMessage)
          );
        }
      );

      let sendResult = await waku1.relay.send(CustomTopicEncoder, {
        payload: generateRandomUint8Array(1 * MB)
      });
      expect(sendResult.recipients.length).to.eq(1);

      sendResult = await waku1.relay.send(CustomTopicEncoder, {
        payload: generateRandomUint8Array(1 * MB + 65536)
      });
      expect(sendResult.recipients.length).to.eq(0);
      expect(sendResult.errors).to.include(SendError.SIZE_TOO_BIG);

      sendResult = await waku1.relay.send(CustomTopicEncoder, {
        payload: generateRandomUint8Array(2 * MB)
      });
      expect(sendResult.recipients.length).to.eq(0);
      expect(sendResult.errors).to.include(SendError.SIZE_TOO_BIG);

      const waku2ReceivedMsg = await waku2ReceivedMsgPromise;
      expect(waku2ReceivedMsg?.payload?.length).to.eq(0);
    });
  });

  describe("Interop: NimGoNode", function () {
    let waku: RelayNode;
    let nwaku: NimGoNode;

    beforeEach(async function () {
      this.timeout(30_000);
      waku = await createRelayNode({
        staticNoiseKey: NOISE_KEY_1
      });
      await waku.start();

      nwaku = new NimGoNode(this.test?.ctx?.currentTest?.title + "");
      await nwaku.start({ relay: true });

      await waku.dial(await nwaku.getMultiaddrWithId());
      await waitForRemotePeer(waku, [Protocols.Relay]);

      // Nwaku subscribe to the default pubsub topic
      await nwaku.ensureSubscriptions();
    });

    afterEach(async function () {
      !!nwaku &&
        nwaku.stop().catch((e) => console.log("Nwaku failed to stop", e));
      !!waku && waku.stop().catch((e) => console.log("Waku failed to stop", e));
    });

    it("nwaku subscribes", async function () {
      let subscribers: PeerId[] = [];

      while (subscribers.length === 0) {
        await delay(200);
        subscribers =
          waku.libp2p.services.pubsub!.getSubscribers(DefaultPubSubTopic);
      }

      const nimPeerId = await nwaku.getPeerId();
      expect(subscribers.map((p) => p.toString())).to.contain(
        nimPeerId.toString()
      );
    });

    it("Publishes to nwaku", async function () {
      this.timeout(30000);

      const messageText = "This is a message";
      await waku.relay.send(TestEncoder, { payload: utf8ToBytes(messageText) });

      let msgs: MessageRpcResponse[] = [];

      while (msgs.length === 0) {
        console.log("Waiting for messages");
        await delay(200);
        msgs = await nwaku.messages();
      }

      expect(msgs[0].contentTopic).to.equal(TestContentTopic);
      expect(msgs[0].version).to.equal(0);
      expect(base64ToUtf8(msgs[0].payload)).to.equal(messageText);
    });

    it("Nwaku publishes", async function () {
      await delay(200);

      const messageText = "Here is another message.";

      const receivedMsgPromise: Promise<DecodedMessage> = new Promise(
        (resolve) => {
          void waku.relay.subscribe<DecodedMessage>(TestDecoder, (msg) =>
            resolve(msg)
          );
        }
      );

      await nwaku.sendMessage(
        NimGoNode.toMessageRpcQuery({
          contentTopic: TestContentTopic,
          payload: utf8ToBytes(messageText)
        })
      );

      const receivedMsg = await receivedMsgPromise;

      expect(receivedMsg.contentTopic).to.eq(TestContentTopic);
      expect(receivedMsg.version!).to.eq(0);
      expect(bytesToUtf8(receivedMsg.payload!)).to.eq(messageText);
    });

    describe.skip("Two nodes connected to nwaku", function () {
      let waku1: RelayNode;
      let waku2: RelayNode;
      let nwaku: NimGoNode;

      afterEach(async function () {
        !!nwaku &&
          nwaku.stop().catch((e) => console.log("Nwaku failed to stop", e));
        !!waku1 &&
          waku1.stop().catch((e) => console.log("Waku failed to stop", e));
        !!waku2 &&
          waku2.stop().catch((e) => console.log("Waku failed to stop", e));
      });

      it("Js publishes, other Js receives", async function () {
        this.timeout(60_000);
        [waku1, waku2] = await Promise.all([
          createRelayNode({
            staticNoiseKey: NOISE_KEY_1,
            emitSelf: true
          }).then((waku) => waku.start().then(() => waku)),
          createRelayNode({
            staticNoiseKey: NOISE_KEY_2
          }).then((waku) => waku.start().then(() => waku))
        ]);

        nwaku = new NimGoNode(makeLogFileName(this));
        await nwaku.start();

        const nwakuMultiaddr = await nwaku.getMultiaddrWithId();
        await Promise.all([
          waku1.dial(nwakuMultiaddr),
          waku2.dial(nwakuMultiaddr)
        ]);

        // Wait for identify protocol to finish
        await Promise.all([
          waitForRemotePeer(waku1, [Protocols.Relay]),
          waitForRemotePeer(waku2, [Protocols.Relay])
        ]);

        await delay(2000);
        // Check that the two JS peers are NOT directly connected
        expect(await waku1.libp2p.peerStore.has(waku2.libp2p.peerId)).to.be
          .false;
        expect(waku2.libp2p.peerStore.has(waku1.libp2p.peerId)).to.be.false;

        const msgStr = "Hello there!";
        const message = { payload: utf8ToBytes(msgStr) };

        const waku2ReceivedMsgPromise: Promise<DecodedMessage> = new Promise(
          (resolve) => {
            void waku2.relay.subscribe(TestDecoder, resolve);
          }
        );

        await waku1.relay.send(TestEncoder, message);
        console.log("Waiting for message");
        const waku2ReceivedMsg = await waku2ReceivedMsgPromise;

        expect(waku2ReceivedMsg.payload).to.eq(msgStr);
      });
    });
  });
});