simplify encoder/decoder creation logic + update tests

waku-org · Nov 22, 2023 · 25964a8 · 25964a8
1 parent 9d3e34b
commit 25964a8
Show file tree

Hide file tree

Showing 10 changed files with 35 additions and 112 deletions.
diff --git a/packages/core/src/lib/message/version_0.ts b/packages/core/src/lib/message/version_0.ts
@@ -120,23 +120,17 @@ export class Encoder implements IEncoder {
  * messages.
  */
 export function createEncoder({
-  pubsubTopic = DefaultPubsubTopic,
+  pubsubTopicShardInfo,
   contentTopic,
   ephemeral,
   metaSetter
 }: EncoderOptions): Encoder {
-  if (typeof pubsubTopic === "string" && pubsubTopic !== DefaultPubsubTopic) {
-    throw new Error(
-      `Error: cannot use custom named pubsub topic: ${pubsubTopic}, must be ${DefaultPubsubTopic}`
-    );
-  }
-
   return new Encoder(
     contentTopic,
     ephemeral,
-    typeof pubsubTopic === "string"
-      ? pubsubTopic
-      : singleTopicShardInfoToPubsubTopic(pubsubTopic),
+    pubsubTopicShardInfo?.index
+      ? singleTopicShardInfoToPubsubTopic(pubsubTopicShardInfo)
+      : DefaultPubsubTopic,
     metaSetter
   );
 }
@@ -196,17 +190,12 @@ export class Decoder implements IDecoder<DecodedMessage> {
  */
 export function createDecoder(
   contentTopic: string,
-  pubsubTopic: SingleTopicShardInfo | PubsubTopic = DefaultPubsubTopic
+  pubsubTopicShardInfo: SingleTopicShardInfo
 ): Decoder {
-  if (typeof pubsubTopic === "string" && pubsubTopic !== DefaultPubsubTopic) {
-    throw new Error(
-      `Error: cannot use custom named pubsub topic: ${pubsubTopic}, must be ${DefaultPubsubTopic}`
-    );
-  }
   return new Decoder(
-    typeof pubsubTopic === "string"
-      ? pubsubTopic
-      : singleTopicShardInfoToPubsubTopic(pubsubTopic),
+    pubsubTopicShardInfo?.index
+      ? singleTopicShardInfoToPubsubTopic(pubsubTopicShardInfo)
+      : DefaultPubsubTopic,
     contentTopic
   );
 }
diff --git a/packages/message-encryption/src/ecies.ts b/packages/message-encryption/src/ecies.ts
@@ -98,23 +98,17 @@ export interface EncoderOptions extends BaseEncoderOptions {
  * in [26/WAKU2-PAYLOAD](https://rfc.vac.dev/spec/26/).
  */
 export function createEncoder({
-  pubsubTopic = DefaultPubsubTopic,
+  pubsubTopicShardInfo,
   contentTopic,
   publicKey,
   sigPrivKey,
   ephemeral = false,
   metaSetter
 }: EncoderOptions): Encoder {
-  if (typeof pubsubTopic === "string" && pubsubTopic !== DefaultPubsubTopic) {
-    throw new Error(
-      `Error: cannot use custom named pubsub topic: ${pubsubTopic}, must be ${DefaultPubsubTopic}`
-    );
-  }
-
   return new Encoder(
-    typeof pubsubTopic === "string"
-      ? pubsubTopic
-      : singleTopicShardInfoToPubsubTopic(pubsubTopic),
+    pubsubTopicShardInfo?.index
+      ? singleTopicShardInfoToPubsubTopic(pubsubTopicShardInfo)
+      : DefaultPubsubTopic,
     contentTopic,
     publicKey,
     sigPrivKey,
@@ -202,18 +196,12 @@ class Decoder extends DecoderV0 implements IDecoder<DecodedMessage> {
 export function createDecoder(
   contentTopic: string,
   privateKey: Uint8Array,
-  pubsubTopic: SingleTopicShardInfo | PubsubTopic = DefaultPubsubTopic
+  pubsubTopicShardInfo?: SingleTopicShardInfo
 ): Decoder {
-  if (typeof pubsubTopic === "string" && pubsubTopic !== DefaultPubsubTopic) {
-    throw new Error(
-      `Error: cannot use custom named pubsub topic: ${pubsubTopic}, must be ${DefaultPubsubTopic}`
-    );
-  }
-
   return new Decoder(
-    typeof pubsubTopic === "string"
-      ? pubsubTopic
-      : singleTopicShardInfoToPubsubTopic(pubsubTopic),
+    pubsubTopicShardInfo?.index
+      ? singleTopicShardInfoToPubsubTopic(pubsubTopicShardInfo)
+      : DefaultPubsubTopic,
     contentTopic,
     privateKey
   );

diff --git a/packages/message-encryption/src/symmetric.ts b/packages/message-encryption/src/symmetric.ts
@@ -94,22 +94,17 @@ export interface EncoderOptions extends BaseEncoderOptions {
  * in [26/WAKU2-PAYLOAD](https://rfc.vac.dev/spec/26/).
  */
 export function createEncoder({
-  pubsubTopic = DefaultPubsubTopic,
+  pubsubTopicShardInfo,
   contentTopic,
   symKey,
   sigPrivKey,
   ephemeral = false,
   metaSetter
 }: EncoderOptions): Encoder {
-  if (typeof pubsubTopic === "string" && pubsubTopic !== DefaultPubsubTopic) {
-    throw new Error(
-      `Error: cannot use custom named pubsub topic: ${pubsubTopic}, must be ${DefaultPubsubTopic}`
-    );
-  }
   return new Encoder(
-    typeof pubsubTopic === "string"
-      ? pubsubTopic
-      : singleTopicShardInfoToPubsubTopic(pubsubTopic),
+    pubsubTopicShardInfo?.index
+      ? singleTopicShardInfoToPubsubTopic(pubsubTopicShardInfo)
+      : DefaultPubsubTopic,
     contentTopic,
     symKey,
     sigPrivKey,
@@ -197,18 +192,12 @@ class Decoder extends DecoderV0 implements IDecoder<DecodedMessage> {
 export function createDecoder(
   contentTopic: string,
   symKey: Uint8Array,
-  pubsubTopic: SingleTopicShardInfo | PubsubTopic = DefaultPubsubTopic
+  pubsubTopicShardInfo?: SingleTopicShardInfo
 ): Decoder {
-  if (typeof pubsubTopic === "string" && pubsubTopic !== DefaultPubsubTopic) {
-    throw new Error(
-      `Error: cannot use custom named pubsub topic: ${pubsubTopic}, must be ${DefaultPubsubTopic}`
-    );
-  }
-
   return new Decoder(
-    typeof pubsubTopic === "string"
-      ? pubsubTopic
-      : singleTopicShardInfoToPubsubTopic(pubsubTopic),
+    pubsubTopicShardInfo?.index
+      ? singleTopicShardInfoToPubsubTopic(pubsubTopicShardInfo)
+      : DefaultPubsubTopic,
     contentTopic,
     symKey
   );

diff --git a/packages/tests/tests/filter/multiple_pubsub.node.spec.ts b/packages/tests/tests/filter/multiple_pubsub.node.spec.ts
@@ -36,15 +36,15 @@ describe("Waku Filter V2: Multiple PubsubTopics", function () {
   const customContentTopic1 = "/test/2/waku-filter";
   const customContentTopic2 = "/test/3/waku-filter";
   const customEncoder1 = createEncoder({
-    pubsubTopic: singleTopicShardInfo1,
+    pubsubTopicShardInfo: singleTopicShardInfo1,
     contentTopic: customContentTopic1
   });
   const customDecoder1 = createDecoder(
     customContentTopic1,
     singleTopicShardInfo1
   );
   const customEncoder2 = createEncoder({
-    pubsubTopic: singleTopicShardInfo2,
+    pubsubTopicShardInfo: singleTopicShardInfo2,
     contentTopic: customContentTopic2
   });
   const customDecoder2 = createDecoder(

diff --git a/packages/tests/tests/light-push/multiple_pubsub.node.spec.ts b/packages/tests/tests/light-push/multiple_pubsub.node.spec.ts
@@ -35,11 +35,11 @@ describe("Waku Light Push : Multiple PubsubTopics", function () {
   const customContentTopic1 = "/test/2/waku-light-push/utf8";
   const customContentTopic2 = "/test/3/waku-light-push/utf8";
   const customEncoder1 = createEncoder({
-    pubsubTopic: singleTopicShardInfo1,
+    pubsubTopicShardInfo: singleTopicShardInfo1,
     contentTopic: customContentTopic1
   });
   const customEncoder2 = createEncoder({
-    pubsubTopic: singleTopicShardInfo2,
+    pubsubTopicShardInfo: singleTopicShardInfo2,
     contentTopic: customContentTopic2
   });
 

diff --git a/packages/tests/tests/relay/multiple_pubsub.node.spec.ts b/packages/tests/tests/relay/multiple_pubsub.node.spec.ts
@@ -41,15 +41,15 @@ describe("Waku Relay, multiple pubsub topics", function () {
     index: 2
   };
   const customEncoder1 = createEncoder({
-    pubsubTopic: singleTopicShardInfo1,
+    pubsubTopicShardInfo: singleTopicShardInfo1,
     contentTopic: customContentTopic1
   });
   const customDecoder1 = createDecoder(
     customContentTopic1,
     singleTopicShardInfo1
   );
   const customEncoder2 = createEncoder({
-    pubsubTopic: singleTopicShardInfo2,
+    pubsubTopicShardInfo: singleTopicShardInfo2,
     contentTopic: customContentTopic2
   });
   const customDecoder2 = createDecoder(

diff --git a/packages/tests/tests/relay/publish.node.spec.ts b/packages/tests/tests/relay/publish.node.spec.ts
@@ -128,7 +128,7 @@ describe("Waku Relay, Publish", function () {
 
   it("Fails to publish message with wrong pubsubtopic", async function () {
     const wrong_encoder = createEncoder({
-      pubsubTopic: { cluster: 3, index: 1 },
+      pubsubTopicShardInfo: { cluster: 3, index: 1 },
       contentTopic: TestContentTopic
     });
     const pushResponse = await waku1.relay.send(wrong_encoder, {

diff --git a/packages/tests/tests/sharding/error_handling.node.spec.ts b/packages/tests/tests/sharding/error_handling.node.spec.ts
diff --git a/packages/tests/tests/sharding/running_nodes.spec.ts b/packages/tests/tests/sharding/running_nodes.spec.ts
@@ -37,12 +37,12 @@ describe("Static Sharding: Running Nodes", () => {
 
     const encoder1 = createEncoder({
       contentTopic: ContentTopic,
-      pubsubTopic: singleTopicShardInfo1
+      pubsubTopicShardInfo: singleTopicShardInfo1
     });
 
     const encoder2 = createEncoder({
       contentTopic: ContentTopic,
-      pubsubTopic: singleTopicShardInfo2
+      pubsubTopicShardInfo: singleTopicShardInfo2
     });
 
     const request1 = await waku.lightPush.send(encoder1, {
@@ -66,7 +66,7 @@ describe("Static Sharding: Running Nodes", () => {
     // use a pubsub topic that is not configured
     const encoder = createEncoder({
       contentTopic: ContentTopic,
-      pubsubTopic: singleTopicShardInfo2
+      pubsubTopicShardInfo: singleTopicShardInfo2
     });
 
     try {

diff --git a/packages/tests/tests/store/index.node.spec.ts b/packages/tests/tests/store/index.node.spec.ts
@@ -43,7 +43,7 @@ import {
   totalMsgs
 } from "./utils.js";
 
-const secondDecoder = createDecoder(customContentTopic1, DefaultPubsubTopic);
+const secondDecoder = createDecoder(customContentTopic1);
 
 describe("Waku Store, general", function () {
   this.timeout(15000);