js-waku/packages/tests/tests/light-push/index.node.spec.ts

import { createEncoder } from "@waku/core";
import { IRateLimitProof, LightNode, ProtocolError } from "@waku/interfaces";
import { utf8ToBytes } from "@waku/sdk";
import { expect } from "chai";

import {
  afterEachCustom,
  beforeEachCustom,
  generateRandomUint8Array,
  runMultipleNodes,
  ServiceNodesFleet,
  teardownNodesWithRedundancy,
  TEST_STRING
} from "../../src/index.js";

import {
  messagePayload,
  messageText,
  TestContentTopic,
  TestEncoder,
  TestPubsubTopic,
  TestShardInfo
} from "./utils.js";

const runTests = (strictNodeCheck: boolean): void => {
  const numServiceNodes = 2;
  describe(`Waku Light Push: Multiple Nodes: Strict Check: ${strictNodeCheck}`, function () {
    // Set the timeout for all tests in this suite. Can be overwritten at test level
    this.timeout(15000);
    let waku: LightNode;
    let serviceNodes: ServiceNodesFleet;

    beforeEachCustom(this, async () => {
      [serviceNodes, waku] = await runMultipleNodes(
        this.ctx,
        TestShardInfo,
        { lightpush: true, filter: true },
        strictNodeCheck,
        numServiceNodes,
        true
      );
    });

    afterEachCustom(this, async () => {
      await teardownNodesWithRedundancy(serviceNodes, waku);
    });

    TEST_STRING.forEach((testItem) => {
      it(`Push message with ${testItem.description} payload`, async function () {
        const pushResponse = await waku.lightPush.send(TestEncoder, {
          payload: utf8ToBytes(testItem.value)
        });
        expect(pushResponse.successes.length).to.greaterThanOrEqual(1);

        expect(
          await serviceNodes.messageCollector.waitForMessages(1, {
            pubsubTopic: TestPubsubTopic
          })
        ).to.eq(true);
        serviceNodes.messageCollector.verifyReceivedMessage(0, {
          expectedMessageText: testItem.value,
          expectedContentTopic: TestContentTopic,
          expectedPubsubTopic: TestPubsubTopic
        });
      });
    });

    it("Push 30 different messages", async function () {
      const generateMessageText = (index: number): string => `M${index}`;

      for (let i = 0; i < 30; i++) {
        const pushResponse = await waku.lightPush.send(TestEncoder, {
          payload: utf8ToBytes(generateMessageText(i))
        });

        expect(pushResponse.successes.length).to.greaterThanOrEqual(1);
      }

      expect(
        await serviceNodes.messageCollector.waitForMessages(30, {
          pubsubTopic: TestPubsubTopic
        })
      ).to.eq(true);

      for (let i = 0; i < 30; i++) {
        serviceNodes.messageCollector.verifyReceivedMessage(i, {
          expectedMessageText: generateMessageText(i),
          expectedContentTopic: TestContentTopic,
          expectedPubsubTopic: TestPubsubTopic
        });
      }
    });

    it("Throws when trying to push message with empty payload", async function () {
      const pushResponse = await waku.lightPush.send(TestEncoder, {
        payload: new Uint8Array()
      });

      expect(pushResponse.successes.length).to.eq(0);

      expect(pushResponse.failures?.map((failure) => failure.error)).to.include(
        ProtocolError.EMPTY_PAYLOAD
      );

      expect(
        await serviceNodes.messageCollector.waitForMessages(1, {
          pubsubTopic: TestPubsubTopic
        })
      ).to.eq(false);
    });

    TEST_STRING.forEach((testItem) => {
      it(`Push message with content topic containing ${testItem.description}`, async function () {
        const customEncoder = createEncoder({
          contentTopic: testItem.value,
          pubsubTopic: TestPubsubTopic
        });
        const pushResponse = await waku.lightPush.send(
          customEncoder,
          messagePayload
        );
        expect(pushResponse.successes.length).to.greaterThanOrEqual(1);

        expect(
          await serviceNodes.messageCollector.waitForMessages(1, {
            pubsubTopic: TestPubsubTopic
          })
        ).to.eq(true);
        serviceNodes.messageCollector.verifyReceivedMessage(0, {
          expectedMessageText: messageText,
          expectedContentTopic: testItem.value,
          expectedPubsubTopic: TestPubsubTopic
        });
      });
    });

    it("Fails to push message with empty content topic", async function () {
      try {
        createEncoder({ contentTopic: "" });
        expect.fail("Expected an error but didn't get one");
      } catch (error) {
        expect((error as Error).message).to.equal(
          "Content topic must be specified"
        );
      }
    });

    it("Push message with meta", async function () {
      const customTestEncoder = createEncoder({
        contentTopic: TestContentTopic,
        metaSetter: () => new Uint8Array(10),
        pubsubTopic: TestPubsubTopic
      });

      const pushResponse = await waku.lightPush.send(
        customTestEncoder,
        messagePayload
      );
      expect(pushResponse.successes.length).to.greaterThanOrEqual(1);

      expect(
        await serviceNodes.messageCollector.waitForMessages(1, {
          pubsubTopic: TestPubsubTopic
        })
      ).to.eq(true);
      serviceNodes.messageCollector.verifyReceivedMessage(0, {
        expectedMessageText: messageText,
        expectedContentTopic: TestContentTopic,
        expectedPubsubTopic: TestPubsubTopic
      });
    });

    it("Fails to push message with large meta", async function () {
      const customTestEncoder = createEncoder({
        contentTopic: TestContentTopic,
        pubsubTopic: TestPubsubTopic,
        metaSetter: () => new Uint8Array(105024) // see the note below ***
      });

      // *** note: this test used 10 ** 6 when `nwaku` node had MaxWakuMessageSize == 1MiB ( 1*2^20 .)
      // `nwaku` establishes the max lightpush msg size as `const MaxRpcSize* = MaxWakuMessageSize + 64 * 1024`
      // see: https://github.com/waku-org/nwaku/blob/07beea02095035f4f4c234ec2dec1f365e6955b8/waku/waku_lightpush/rpc_codec.nim#L15
      // In the PR https://github.com/waku-org/nwaku/pull/2298 we reduced the MaxWakuMessageSize
      // from 1MiB to 150KiB. Therefore, the 105024 number comes from substracting ( 1*2^20 - 150*2^10 )
      // to the original 10^6 that this test had when MaxWakuMessageSize == 1*2^20

      const pushResponse = await waku.lightPush.send(
        customTestEncoder,
        messagePayload
      );

      if (serviceNodes.type == "go-waku") {
        expect(pushResponse.successes.length).to.greaterThanOrEqual(1);
        expect(
          await serviceNodes.messageCollector.waitForMessages(1, {
            pubsubTopic: TestPubsubTopic
          })
        ).to.eq(true);
        serviceNodes.messageCollector.verifyReceivedMessage(0, {
          expectedMessageText: messageText,
          expectedContentTopic: TestContentTopic,
          expectedPubsubTopic: TestPubsubTopic
        });
      } else {
        expect(pushResponse.successes.length).to.eq(0);
        expect(
          pushResponse.failures?.map((failure) => failure.error)
        ).to.include(ProtocolError.REMOTE_PEER_REJECTED);
        expect(
          await serviceNodes.messageCollector.waitForMessages(1, {
            pubsubTopic: TestPubsubTopic
          })
        ).to.eq(false);
      }
    });

    it("Push message with rate limit", async function () {
      const rateLimitProof: IRateLimitProof = {
        proof: utf8ToBytes("proofData"),
        merkleRoot: utf8ToBytes("merkleRootData"),
        epoch: utf8ToBytes("epochData"),
        shareX: utf8ToBytes("shareXData"),
        shareY: utf8ToBytes("shareYData"),
        nullifier: utf8ToBytes("nullifierData"),
        rlnIdentifier: utf8ToBytes("rlnIdentifierData")
      };

      const pushResponse = await waku.lightPush.send(TestEncoder, {
        payload: utf8ToBytes(messageText),
        rateLimitProof: rateLimitProof
      });
      expect(pushResponse.successes.length).to.greaterThanOrEqual(1);

      expect(
        await serviceNodes.messageCollector.waitForMessages(1, {
          pubsubTopic: TestPubsubTopic
        })
      ).to.eq(true);
      serviceNodes.messageCollector.verifyReceivedMessage(0, {
        expectedMessageText: messageText,
        expectedContentTopic: TestContentTopic,
        expectedPubsubTopic: TestPubsubTopic
      });
    });

    [
      Date.now() - 3600000 * 24 * 356,
      Date.now() - 3600000,
      Date.now() + 3600000
    ].forEach((testItem) => {
      it(`Push message with custom timestamp: ${testItem}`, async function () {
        const pushResponse = await waku.lightPush.send(TestEncoder, {
          payload: utf8ToBytes(messageText),
          timestamp: new Date(testItem)
        });
        expect(pushResponse.successes.length).to.greaterThanOrEqual(1);

        expect(
          await serviceNodes.messageCollector.waitForMessages(1, {
            pubsubTopic: TestPubsubTopic
          })
        ).to.eq(true);
        serviceNodes.messageCollector.verifyReceivedMessage(0, {
          expectedMessageText: messageText,
          expectedTimestamp: testItem,
          expectedContentTopic: TestContentTopic,
          expectedPubsubTopic: TestPubsubTopic
        });
      });
    });

    it("Push message equal or less that 1MB", async function () {
      const bigPayload = generateRandomUint8Array(65536);
      const pushResponse = await waku.lightPush.send(TestEncoder, {
        payload: bigPayload
      });
      expect(pushResponse.successes.length).to.greaterThanOrEqual(1);
    });

    it("Fails to push message bigger that 1MB", async function () {
      const MB = 1024 ** 2;

      const pushResponse = await waku.lightPush.send(TestEncoder, {
        payload: generateRandomUint8Array(MB + 65536)
      });
      expect(pushResponse.successes.length).to.eq(0);
      expect(pushResponse.failures?.map((failure) => failure.error)).to.include(
        ProtocolError.SIZE_TOO_BIG
      );
      expect(
        await serviceNodes.messageCollector.waitForMessages(1, {
          pubsubTopic: TestPubsubTopic
        })
      ).to.eq(false);
    });
  });
};

[true].map(runTests);