chore: new relay tests (#1649)

* make relay folder * make relay folder * adjust message collector for relay * small fix * small fix * small fix * split tests more * small fixes * small fix * new test * fix pubsubtopic name * new subscribe tests * new subscribe tests * new tests * small fix after ci run * small fix after ci run2 * fix skipped test * added issue for skipped test
waku-org · Oct 23, 2023 · 1ec0c20 · 1ec0c20
1 parent 80a33b9
commit 1ec0c20
Show file tree

Hide file tree

Showing 16 changed files with 1,222 additions and 829 deletions.
diff --git a/packages/tests/src/constants.ts b/packages/tests/src/constants.ts
@@ -50,7 +50,8 @@ export const TEST_STRING = [
   { description: "JSON", value: '{"user":"admin","password":"123456"}' },
   { description: "shell command", value: "`rm -rf /`" },
   { description: "escaped characters", value: "\\n\\t\\0" },
-  { description: "unicode special characters", value: "\u202Ereverse" }
+  { description: "unicode special characters", value: "\u202Ereverse" },
+  { description: "emoji", value: "🤫 🤥 😶 😶‍🌫️ 😐 😑 😬 🫨 🫠 🙄 😯 😦 😧 😮" }
 ];
 
 export const TEST_TIMESTAMPS = [

diff --git a/packages/tests/src/index.ts b/packages/tests/src/index.ts
@@ -12,3 +12,4 @@ export * from "./log_file.js";
 export * from "./node/node.js";
 export * from "./teardown.js";
 export * from "./message_collector.js";
+export * from "./utils.js";
diff --git a/packages/tests/src/message_collector.ts b/packages/tests/src/message_collector.ts
@@ -113,7 +113,7 @@ export class MessageCollector {
       expectedVersion?: number;
       expectedMeta?: Uint8Array;
       expectedEphemeral?: boolean;
-      expectedTimestamp?: bigint;
+      expectedTimestamp?: bigint | number;
       checkTimestamp?: boolean; // Used to determine if we need to check the timestamp
     }
   ): void {
@@ -148,6 +148,38 @@ export class MessageCollector {
       );
     }
 
+    const shouldCheckTimestamp =
+      options.checkTimestamp !== undefined ? options.checkTimestamp : true;
+    if (shouldCheckTimestamp && message.timestamp) {
+      // In we send timestamp in the request we assert that it matches the timestamp in the response +- 1 sec
+      // We take the 1s deviation because there are some ms diffs in timestamps, probably because of conversions
+      let timestampAsNumber: number;
+
+      if (message.timestamp instanceof Date) {
+        timestampAsNumber = message.timestamp.getTime();
+      } else {
+        timestampAsNumber = Number(message.timestamp) / 1_000_000;
+      }
+
+      let lowerBound: number;
+      let upperBound: number;
+
+      // Define the bounds based on the expectedTimestamp
+      if (options.expectedTimestamp !== undefined) {
+        lowerBound = Number(options.expectedTimestamp) - 1000;
+        upperBound = Number(options.expectedTimestamp) + 1000;
+      } else {
+        upperBound = Date.now();
+        lowerBound = upperBound - 10000;
+      }
+
+      if (timestampAsNumber < lowerBound || timestampAsNumber > upperBound) {
+        throw new AssertionError(
+          `Message timestamp not within the expected range. Expected between: ${lowerBound} and ${upperBound}. Got: ${timestampAsNumber}`
+        );
+      }
+    }
+
     if (this.isMessageRpcResponse(message)) {
       // nwaku message specific assertions
       const receivedMessageText = message.payload
@@ -158,37 +190,6 @@ export class MessageCollector {
         options.expectedMessageText,
         `Message text mismatch. Expected: ${options.expectedMessageText}. Got: ${receivedMessageText}`
       );
-
-      if (message.timestamp) {
-        // In we send timestamp in the request we assert that it matches the timestamp in the response +- 1 sec
-        // We take the 1s deviation because there are some ms diffs in timestamps, probably because of conversions
-        if (options.expectedTimestamp !== undefined) {
-          const lowerBound =
-            BigInt(options.expectedTimestamp) - BigInt(1000000000);
-          const upperBound =
-            BigInt(options.expectedTimestamp) + BigInt(1000000000);
-
-          if (
-            message.timestamp < lowerBound ||
-            message.timestamp > upperBound
-          ) {
-            throw new AssertionError(
-              `Message timestamp not within the expected range. Expected between: ${lowerBound} and ${upperBound}. Got: ${message.timestamp}`
-            );
-          }
-        }
-        // In we don't send timestamp in the request we assert that the timestamp in the response is between now and (now-10s)
-        else {
-          const now = BigInt(Date.now()) * BigInt(1_000_000);
-          const tenSecondsAgo = now - BigInt(10_000_000_000);
-
-          if (message.timestamp < tenSecondsAgo || message.timestamp > now) {
-            throw new AssertionError(
-              `Message timestamp not within the expected range. Expected between: ${tenSecondsAgo} and ${now}. Got: ${message.timestamp}`
-            );
-          }
-        }
-      }
     } else {
       // js-waku message specific assertions
       expect(message.pubsubTopic).to.eq(
@@ -205,18 +206,6 @@ export class MessageCollector {
         }. Got: ${bytesToUtf8(message.payload)}`
       );
 
-      const shouldCheckTimestamp =
-        options.checkTimestamp !== undefined ? options.checkTimestamp : true;
-      if (shouldCheckTimestamp && message.timestamp) {
-        const now = Date.now();
-        const tenSecondsAgo = now - 10000;
-        expect(message.timestamp.getTime()).to.be.within(
-          tenSecondsAgo,
-          now,
-          `Message timestamp not within the expected range. Expected between: ${tenSecondsAgo} and ${now}. Got: ${message.timestamp.getTime()}`
-        );
-      }
-
       expect([
         options.expectedMeta,
         undefined,

diff --git a/packages/tests/src/utils.ts b/packages/tests/src/utils.ts
@@ -0,0 +1,22 @@
+import { createDecoder, createEncoder, Decoder, Encoder } from "@waku/core";
+
+// Utility to generate test data for multiple topics tests.
+export function generateTestData(topicCount: number): {
+  contentTopics: string[];
+  encoders: Encoder[];
+  decoders: Decoder[];
+} {
+  const contentTopics = Array.from(
+    { length: topicCount },
+    (_, i) => `/test/${i + 1}/waku-multi`
+  );
+  const encoders = contentTopics.map((topic) =>
+    createEncoder({ contentTopic: topic })
+  );
+  const decoders = contentTopics.map((topic) => createDecoder(topic));
+  return {
+    contentTopics,
+    encoders,
+    decoders
+  };
+}
diff --git a/packages/tests/tests/filter/push.node.spec.ts b/packages/tests/tests/filter/push.node.spec.ts
@@ -88,7 +88,7 @@ describe("Waku Filter V2: FilterPush", function () {
     });
   });
 
-  it("Check received message with invalid timestamp is not received", async function () {
+  it("Check message with invalid timestamp is not received", async function () {
     await subscription.subscribe([TestDecoder], messageCollector.callback);
     await delay(400);
 
@@ -105,7 +105,7 @@ describe("Waku Filter V2: FilterPush", function () {
     expect(await messageCollector.waitForMessages(1)).to.eq(false);
   });
 
-  it("Check received message on other pubsub topic is not received", async function () {
+  it("Check message on other pubsub topic is not received", async function () {
     await subscription.subscribe([TestDecoder], messageCollector.callback);
     await delay(400);
 
@@ -121,7 +121,7 @@ describe("Waku Filter V2: FilterPush", function () {
     expect(await messageCollector.waitForMessages(1)).to.eq(false);
   });
 
-  it("Check received message with no pubsub topic is not received", async function () {
+  it("Check message with no pubsub topic is not received", async function () {
     await subscription.subscribe([TestDecoder], messageCollector.callback);
     await delay(400);
 
@@ -136,7 +136,7 @@ describe("Waku Filter V2: FilterPush", function () {
     expect(await messageCollector.waitForMessages(1)).to.eq(false);
   });
 
-  it("Check received message with no content topic is not received", async function () {
+  it("Check message with no content topic is not received", async function () {
     await subscription.subscribe([TestDecoder], messageCollector.callback);
     await delay(400);
 
@@ -151,7 +151,7 @@ describe("Waku Filter V2: FilterPush", function () {
     expect(await messageCollector.waitForMessages(1)).to.eq(false);
   });
 
-  it("Check received message with no payload is not received", async function () {
+  it("Check message with no payload is not received", async function () {
     await subscription.subscribe([TestDecoder], messageCollector.callback);
     await delay(400);
 
@@ -171,7 +171,7 @@ describe("Waku Filter V2: FilterPush", function () {
     }
   });
 
-  it("Check received message with non string payload is not received", async function () {
+  it("Check message with non string payload is not received", async function () {
     await subscription.subscribe([TestDecoder], messageCollector.callback);
     await delay(400);
 
@@ -187,7 +187,7 @@ describe("Waku Filter V2: FilterPush", function () {
     expect(await messageCollector.waitForMessages(1)).to.eq(false);
   });
 
-  it("Check received message with extra parameter is not received", async function () {
+  it("Check message with extra parameter is not received", async function () {
     await subscription.subscribe([TestDecoder], messageCollector.callback);
     await delay(400);
 
@@ -226,7 +226,7 @@ describe("Waku Filter V2: FilterPush", function () {
   });
 
   // Will be skipped until https://github.com/waku-org/js-waku/issues/1464 si done
-  it.skip("Check received message received after jswaku node is restarted", async function () {
+  it.skip("Check message received after jswaku node is restarted", async function () {
     // Subscribe and send message
     await subscription.subscribe([TestDecoder], messageCollector.callback);
     await waku.lightPush.send(TestEncoder, { payload: utf8ToBytes("M1") });
@@ -259,7 +259,7 @@ describe("Waku Filter V2: FilterPush", function () {
   });
 
   // Will be skipped until https://github.com/waku-org/js-waku/issues/1464 si done
-  it.skip("Check received message received after nwaku node is restarted", async function () {
+  it.skip("Check message received after nwaku node is restarted", async function () {
     await subscription.subscribe([TestDecoder], messageCollector.callback);
     await waku.lightPush.send(TestEncoder, { payload: utf8ToBytes("M1") });
     expect(await messageCollector.waitForMessages(1)).to.eq(true);

diff --git a/packages/tests/tests/filter/subscribe.node.spec.ts b/packages/tests/tests/filter/subscribe.node.spec.ts
@@ -12,6 +12,7 @@ import { expect } from "chai";
 
 import {
   delay,
+  generateTestData,
   makeLogFileName,
   MessageCollector,
   NimGoNode,
@@ -20,7 +21,6 @@ import {
 } from "../../src/index.js";
 
 import {
-  generateTestData,
   messagePayload,
   messageText,
   runNodes,
@@ -295,7 +295,9 @@ describe("Waku Filter V2: Subscribe", function () {
 
     // Check if all messages were received.
     // Since there are overlapping topics, there should be 6 messages in total (2 from the first set + 4 from the second set).
-    expect(await messageCollector.waitForMessages(6)).to.eq(true);
+    expect(await messageCollector.waitForMessages(6, { exact: true })).to.eq(
+      true
+    );
   });
 
   it("Refresh subscription", async function () {
@@ -307,7 +309,9 @@ describe("Waku Filter V2: Subscribe", function () {
     await waku.lightPush.send(TestEncoder, { payload: utf8ToBytes("M2") });
 
     // Confirm both messages were received.
-    expect(await messageCollector.waitForMessages(2)).to.eq(true);
+    expect(await messageCollector.waitForMessages(2, { exact: true })).to.eq(
+      true
+    );
     messageCollector.verifyReceivedMessage(0, {
       expectedMessageText: "M1",
       expectedContentTopic: TestContentTopic

diff --git a/packages/tests/tests/filter/unsubscribe.node.spec.ts b/packages/tests/tests/filter/unsubscribe.node.spec.ts
@@ -3,10 +3,14 @@ import type { IFilterSubscription, LightNode } from "@waku/interfaces";
 import { utf8ToBytes } from "@waku/utils/bytes";
 import { expect } from "chai";
 
-import { MessageCollector, NimGoNode, tearDownNodes } from "../../src/index.js";
-
 import {
   generateTestData,
+  MessageCollector,
+  NimGoNode,
+  tearDownNodes
+} from "../../src/index.js";
+
+import {
   messagePayload,
   messageText,
   runNodes,

diff --git a/packages/tests/tests/filter/utils.ts b/packages/tests/tests/filter/utils.ts
@@ -1,10 +1,4 @@
-import {
-  createDecoder,
-  createEncoder,
-  Decoder,
-  Encoder,
-  waitForRemotePeer
-} from "@waku/core";
+import { createDecoder, createEncoder, waitForRemotePeer } from "@waku/core";
 import { IFilterSubscription, LightNode, Protocols } from "@waku/interfaces";
 import { createLightNode } from "@waku/sdk";
 import { Logger } from "@waku/utils";
@@ -21,27 +15,6 @@ export const TestDecoder = createDecoder(TestContentTopic);
 export const messageText = "Filtering works!";
 export const messagePayload = { payload: utf8ToBytes(messageText) };
 
-// Utility to generate test data for multiple topics tests.
-export function generateTestData(topicCount: number): {
-  contentTopics: string[];
-  encoders: Encoder[];
-  decoders: Decoder[];
-} {
-  const contentTopics = Array.from(
-    { length: topicCount },
-    (_, i) => `/test/${i + 1}/waku-multi`
-  );
-  const encoders = contentTopics.map((topic) =>
-    createEncoder({ contentTopic: topic })
-  );
-  const decoders = contentTopics.map((topic) => createDecoder(topic));
-  return {
-    contentTopics,
-    encoders,
-    decoders
-  };
-}
-
 // Utility to validate errors related to pings in the subscription.
 export async function validatePingError(
   subscription: IFilterSubscription

diff --git a/packages/tests/tests/light-push/index.node.spec.ts b/packages/tests/tests/light-push/index.node.spec.ts
@@ -188,7 +188,6 @@ describe("Waku Light Push", function () {
     Date.now() + 3600000
   ].forEach((testItem) => {
     it(`Push message with custom timestamp: ${testItem}`, async function () {
-      const customTimeNanos = BigInt(testItem) * BigInt(1000000);
       const pushResponse = await waku.lightPush.send(TestEncoder, {
         payload: utf8ToBytes(messageText),
         timestamp: new Date(testItem)
@@ -198,7 +197,7 @@ describe("Waku Light Push", function () {
       expect(await messageCollector.waitForMessages(1)).to.eq(true);
       messageCollector.verifyReceivedMessage(0, {
         expectedMessageText: messageText,
-        expectedTimestamp: customTimeNanos,
+        expectedTimestamp: testItem,
         expectedContentTopic: TestContentTopic
       });
     });