chore: use pubsubTopic/pubsubTopics across the codebase (#1653)

* chore: change all references of pubSubTopic to pubsubTopic

* change references of pubSubTopics to pubsubTopics

* flag words in cspell

Author: danisharora099

.cspell.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.1",
+  "version": "0.2",
   "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/master/cspell.schema.json",
   "language": "en",
   "words": [
@@ -123,7 +123,7 @@
     "Привет",
     "مرحبا"
   ],
-  "flagWords": [],
+  "flagWords": ["pubSub", "pubSubTopics", "pubSubTopic"],
   "ignorePaths": [
     "package.json",
     "package-lock.json",

packages/core/src/lib/connection_manager.ts

@@ -45,7 +45,7 @@ export class ConnectionManager
     peerId: string,
     libp2p: Libp2p,
     keepAliveOptions: KeepAliveOptions,
-    pubSubTopics: PubSubTopic[],
+    pubsubTopics: PubSubTopic[],
     relay?: IRelay,
     options?: ConnectionManagerOptions
   ): ConnectionManager {
@@ -54,7 +54,7 @@ export class ConnectionManager
       instance = new ConnectionManager(
         libp2p,
         keepAliveOptions,
-        pubSubTopics,
+        pubsubTopics,
         relay,
         options
       );
@@ -500,9 +500,9 @@ export class ConnectionManager
     // If there's no shard information, simply return true
     if (!shardInfo) return true;
 
-    const pubSubTopics = shardInfoToPubSubTopics(shardInfo);
+    const pubsubTopics = shardInfoToPubSubTopics(shardInfo);
 
-    const isTopicConfigured = pubSubTopics.some((topic) =>
+    const isTopicConfigured = pubsubTopics.some((topic) =>
       this.configuredPubSubTopics.includes(topic)
     );
     return isTopicConfigured;

packages/core/src/lib/filter/index.ts

@@ -50,7 +50,7 @@ export const FilterCodecs = {
 
 class Subscription {
   private readonly peer: Peer;
-  private readonly pubSubTopic: PubSubTopic;
+  private readonly pubsubTopic: PubSubTopic;
   private newStream: (peer: Peer) => Promise<Stream>;
 
   private subscriptionCallbacks: Map<
@@ -59,12 +59,12 @@ class Subscription {
   >;
 
   constructor(
-    pubSubTopic: PubSubTopic,
+    pubsubTopic: PubSubTopic,
     remotePeer: Peer,
     newStream: (peer: Peer) => Promise<Stream>
   ) {
     this.peer = remotePeer;
-    this.pubSubTopic = pubSubTopic;
+    this.pubsubTopic = pubsubTopic;
     this.newStream = newStream;
     this.subscriptionCallbacks = new Map();
   }
@@ -80,7 +80,7 @@ class Subscription {
     const stream = await this.newStream(this.peer);
 
     const request = FilterSubscribeRpc.createSubscribeRequest(
-      this.pubSubTopic,
+      this.pubsubTopic,
       contentTopics
     );
 
@@ -145,7 +145,7 @@ class Subscription {
   async unsubscribe(contentTopics: ContentTopic[]): Promise<void> {
     const stream = await this.newStream(this.peer);
     const unsubscribeRequest = FilterSubscribeRpc.createUnsubscribeRequest(
-      this.pubSubTopic,
+      this.pubsubTopic,
       contentTopics
     );
 
@@ -194,7 +194,7 @@ class Subscription {
     const stream = await this.newStream(this.peer);
 
     const request = FilterSubscribeRpc.createUnsubscribeAllRequest(
-      this.pubSubTopic
+      this.pubsubTopic
     );
 
     try {
@@ -229,35 +229,35 @@ class Subscription {
       log("No subscription callback available for ", contentTopic);
       return;
     }
-    await pushMessage(subscriptionCallback, this.pubSubTopic, message);
+    await pushMessage(subscriptionCallback, this.pubsubTopic, message);
   }
 }
 
 class Filter extends BaseProtocol implements IReceiver {
-  private readonly pubSubTopics: PubSubTopic[] = [];
+  private readonly pubsubTopics: PubSubTopic[] = [];
   private activeSubscriptions = new Map<string, Subscription>();
   private readonly NUM_PEERS_PROTOCOL = 1;
 
   private getActiveSubscription(
-    pubSubTopic: PubSubTopic,
+    pubsubTopic: PubSubTopic,
     peerIdStr: PeerIdStr
   ): Subscription | undefined {
-    return this.activeSubscriptions.get(`${pubSubTopic}_${peerIdStr}`);
+    return this.activeSubscriptions.get(`${pubsubTopic}_${peerIdStr}`);
   }
 
   private setActiveSubscription(
-    pubSubTopic: PubSubTopic,
+    pubsubTopic: PubSubTopic,
     peerIdStr: PeerIdStr,
     subscription: Subscription
   ): Subscription {
-    this.activeSubscriptions.set(`${pubSubTopic}_${peerIdStr}`, subscription);
+    this.activeSubscriptions.set(`${pubsubTopic}_${peerIdStr}`, subscription);
     return subscription;
   }
 
   constructor(libp2p: Libp2p, options?: ProtocolCreateOptions) {
     super(FilterCodecs.SUBSCRIBE, libp2p.components);
 
-    this.pubSubTopics = options?.pubSubTopics || [DefaultPubSubTopic];
+    this.pubsubTopics = options?.pubsubTopics || [DefaultPubSubTopic];
 
     libp2p.handle(FilterCodecs.PUSH, this.onRequest.bind(this)).catch((e) => {
       log("Failed to register ", FilterCodecs.PUSH, e);
@@ -267,9 +267,9 @@ class Filter extends BaseProtocol implements IReceiver {
   }
 
   async createSubscription(
-    pubSubTopic: string = DefaultPubSubTopic
+    pubsubTopic: string = DefaultPubSubTopic
   ): Promise<Subscription> {
-    ensurePubsubTopicIsConfigured(pubSubTopic, this.pubSubTopics);
+    ensurePubsubTopicIsConfigured(pubsubTopic, this.pubsubTopics);
 
     //TODO: get a relevant peer for the topic/shard
     // https://github.com/waku-org/js-waku/pull/1586#discussion_r1336428230
@@ -281,11 +281,11 @@ class Filter extends BaseProtocol implements IReceiver {
     )[0];
 
     const subscription =
-      this.getActiveSubscription(pubSubTopic, peer.id.toString()) ??
+      this.getActiveSubscription(pubsubTopic, peer.id.toString()) ??
       this.setActiveSubscription(
-        pubSubTopic,
+        pubsubTopic,
         peer.id.toString(),
-        new Subscription(pubSubTopic, peer, this.getStream.bind(this, peer))
+        new Subscription(pubsubTopic, peer, this.getStream.bind(this, peer))
       );
 
     return subscription;
@@ -385,7 +385,7 @@ export function wakuFilter(
 
 async function pushMessage<T extends IDecodedMessage>(
   subscriptionCallback: SubscriptionCallback<T>,
-  pubSubTopic: PubSubTopic,
+  pubsubTopic: PubSubTopic,
   message: WakuMessage
 ): Promise<void> {
   const { decoders, callback } = subscriptionCallback;
@@ -399,7 +399,7 @@ async function pushMessage<T extends IDecodedMessage>(
   try {
     const decodePromises = decoders.map((dec) =>
       dec
-        .fromProtoObj(pubSubTopic, message as IProtoMessage)
+        .fromProtoObj(pubsubTopic, message as IProtoMessage)
         .then((decoded) => decoded || Promise.reject("Decoding failed"))
     );
 

packages/core/src/lib/keep_alive_manager.ts

@@ -118,12 +118,12 @@ export class KeepAliveManager {
   ): NodeJS.Timeout[] {
     // send a ping message to each PubSubTopic the peer is part of
     const intervals: NodeJS.Timeout[] = [];
-    for (const topic of relay.pubSubTopics) {
+    for (const topic of relay.pubsubTopics) {
       const meshPeers = relay.getMeshPeers(topic);
       if (!meshPeers.includes(peerIdStr)) continue;
 
       const encoder = createEncoder({
-        pubSubTopic: topic,
+        pubsubTopic: topic,
         contentTopic: RelayPingContentTopic,
         ephemeral: true
       });

packages/core/src/lib/light_push/index.ts

@@ -42,18 +42,18 @@ type PreparePushMessageResult =
  * Implements the [Waku v2 Light Push protocol](https://rfc.vac.dev/spec/19/).
  */
 class LightPush extends BaseProtocol implements ILightPush {
-  private readonly pubSubTopics: PubSubTopic[];
+  private readonly pubsubTopics: PubSubTopic[];
   private readonly NUM_PEERS_PROTOCOL = 1;
 
   constructor(libp2p: Libp2p, options?: ProtocolCreateOptions) {
     super(LightPushCodec, libp2p.components);
-    this.pubSubTopics = options?.pubSubTopics ?? [DefaultPubSubTopic];
+    this.pubsubTopics = options?.pubsubTopics ?? [DefaultPubSubTopic];
   }
 
   private async preparePushMessage(
     encoder: IEncoder,
     message: IMessage,
-    pubSubTopic: string
+    pubsubTopic: string
   ): Promise<PreparePushMessageResult> {
     try {
       if (!isSizeValid(message.payload)) {
@@ -70,7 +70,7 @@ class LightPush extends BaseProtocol implements ILightPush {
         };
       }
 
-      const query = PushRpc.createRequest(protoMessage, pubSubTopic);
+      const query = PushRpc.createRequest(protoMessage, pubsubTopic);
       return { query, error: null };
     } catch (error) {
       log("Failed to prepare push message", error);
@@ -83,15 +83,15 @@ class LightPush extends BaseProtocol implements ILightPush {
   }
 
   async send(encoder: IEncoder, message: IMessage): Promise<SendResult> {
-    const { pubSubTopic } = encoder;
-    ensurePubsubTopicIsConfigured(pubSubTopic, this.pubSubTopics);
+    const { pubsubTopic } = encoder;
+    ensurePubsubTopicIsConfigured(pubsubTopic, this.pubsubTopics);
 
     const recipients: PeerId[] = [];
 
     const { query, error: preparationError } = await this.preparePushMessage(
       encoder,
       message,
-      pubSubTopic
+      pubsubTopic
     );
 
     if (preparationError || !query) {

packages/core/src/lib/light_push/push_rpc.ts

@@ -7,13 +7,13 @@ export class PushRpc {
 
   static createRequest(
     message: proto.WakuMessage,
-    pubSubTopic: string
+    pubsubTopic: string
   ): PushRpc {
     return new PushRpc({
       requestId: uuid(),
       request: {
         message: message,
-        pubsubTopic: pubSubTopic
+        pubsubTopic: pubsubTopic
       },
       response: undefined
     });

packages/core/src/lib/message/version_0.spec.ts

@@ -11,20 +11,20 @@ describe("Waku Message version 0", function () {
         fc.string({ minLength: 1 }),
         fc.string({ minLength: 1 }),
         fc.uint8Array({ minLength: 1 }),
-        async (contentTopic, pubSubTopic, payload) => {
+        async (contentTopic, pubsubTopic, payload) => {
           const encoder = createEncoder({
             contentTopic
           });
           const bytes = await encoder.toWire({ payload });
           const decoder = createDecoder(contentTopic);
           const protoResult = await decoder.fromWireToProtoObj(bytes);
           const result = (await decoder.fromProtoObj(
-            pubSubTopic,
+            pubsubTopic,
             protoResult!
           )) as DecodedMessage;
 
           expect(result.contentTopic).to.eq(contentTopic);
-          expect(result.pubSubTopic).to.eq(pubSubTopic);
+          expect(result.pubsubTopic).to.eq(pubsubTopic);
           expect(result.version).to.eq(0);
           expect(result.ephemeral).to.be.false;
           expect(result.payload).to.deep.eq(payload);
@@ -40,7 +40,7 @@ describe("Waku Message version 0", function () {
         fc.string({ minLength: 1 }),
         fc.string({ minLength: 1 }),
         fc.uint8Array({ minLength: 1 }),
-        async (contentTopic, pubSubTopic, payload) => {
+        async (contentTopic, pubsubTopic, payload) => {
           const encoder = createEncoder({
             contentTopic,
             ephemeral: true
@@ -49,7 +49,7 @@ describe("Waku Message version 0", function () {
           const decoder = createDecoder(contentTopic);
           const protoResult = await decoder.fromWireToProtoObj(bytes);
           const result = (await decoder.fromProtoObj(
-            pubSubTopic,
+            pubsubTopic,
             protoResult!
           )) as DecodedMessage;
 
@@ -65,7 +65,7 @@ describe("Waku Message version 0", function () {
         fc.string({ minLength: 1 }),
         fc.string({ minLength: 1 }),
         fc.uint8Array({ minLength: 1 }),
-        async (contentTopic, pubSubTopic, payload) => {
+        async (contentTopic, pubsubTopic, payload) => {
           // Encode the length of the payload
           // Not a relevant real life example
           const metaSetter = (
@@ -86,7 +86,7 @@ describe("Waku Message version 0", function () {
           const decoder = createDecoder(contentTopic);
           const protoResult = await decoder.fromWireToProtoObj(bytes);
           const result = (await decoder.fromProtoObj(
-            pubSubTopic,
+            pubsubTopic,
             protoResult!
           )) as DecodedMessage;
 

packages/core/src/lib/message/version_0.ts

@@ -22,7 +22,7 @@ export { proto };
 
 export class DecodedMessage implements IDecodedMessage {
   constructor(
-    public pubSubTopic: string,
+    public pubsubTopic: string,
     protected proto: proto.WakuMessage
   ) {}
 
@@ -76,7 +76,7 @@ export class Encoder implements IEncoder {
   constructor(
     public contentTopic: string,
     public ephemeral: boolean = false,
-    public pubSubTopic: PubSubTopic,
+    public pubsubTopic: PubSubTopic,
     public metaSetter?: IMetaSetter
   ) {
     if (!contentTopic || contentTopic === "") {
@@ -119,17 +119,17 @@ export class Encoder implements IEncoder {
  * messages.
  */
 export function createEncoder({
-  pubSubTopic = DefaultPubSubTopic,
+  pubsubTopic = DefaultPubSubTopic,
   contentTopic,
   ephemeral,
   metaSetter
 }: EncoderOptions): Encoder {
-  return new Encoder(contentTopic, ephemeral, pubSubTopic, metaSetter);
+  return new Encoder(contentTopic, ephemeral, pubsubTopic, metaSetter);
 }
 
 export class Decoder implements IDecoder<DecodedMessage> {
   constructor(
-    public pubSubTopic: PubSubTopic,
+    public pubsubTopic: PubSubTopic,
     public contentTopic: string
   ) {
     if (!contentTopic || contentTopic === "") {
@@ -152,7 +152,7 @@ export class Decoder implements IDecoder<DecodedMessage> {
   }
 
   async fromProtoObj(
-    pubSubTopic: string,
+    pubsubTopic: string,
     proto: IProtoMessage
   ): Promise<DecodedMessage | undefined> {
     // https://rfc.vac.dev/spec/14/
@@ -167,7 +167,7 @@ export class Decoder implements IDecoder<DecodedMessage> {
       return Promise.resolve(undefined);
     }
 
-    return new DecodedMessage(pubSubTopic, proto);
+    return new DecodedMessage(pubsubTopic, proto);
   }
 }