feat: add legacy flag to enable lightpushv2 only

Author: adklempner

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

@@ -32,9 +32,14 @@ export class LightPushCore {
   private readonly streamManagerV2: StreamManager;
   public readonly multicodec = [CODECS.v3, CODECS.v2];
 
-  public constructor(private libp2p: Libp2p) {
-    this.streamManager = new StreamManager(CODECS.v3, libp2p.components);
+  public constructor(
+    private libp2p: Libp2p,
+    legacy?: boolean
+  ) {
     this.streamManagerV2 = new StreamManager(CODECS.v2, libp2p.components);
+    this.streamManager = legacy
+      ? this.streamManagerV2
+      : new StreamManager(CODECS.v3, libp2p.components);
   }
 
   public async send(
@@ -48,7 +53,10 @@ export class LightPushCore {
     try {
       const peer = await this.libp2p.peerStore.get(peerId);
 
-      if (peer.protocols.includes(CODECS.v3)) {
+      if (
+        this.streamManager.multicodec === CODECS.v3 &&
+        peer.protocols.includes(CODECS.v3)
+      ) {
         stream = await this.streamManager.getStream(peerId);
         protocol = CODECS.v3;
       } else {

packages/core/src/lib/stream_manager/stream_manager.ts

@@ -13,7 +13,7 @@ export class StreamManager {
   private streamPool: Map<string, Promise<void>> = new Map();
 
   public constructor(
-    private multicodec: string,
+    public multicodec: string,
     private readonly libp2p: Libp2pComponents
   ) {
     this.log = new Logger(`stream-manager:${multicodec}`);

packages/sdk/src/light_push/light_push.spec.ts

@@ -1,5 +1,10 @@
 import { Peer, PeerId } from "@libp2p/interface";
-import { createEncoder, Encoder, LightPushCodec } from "@waku/core";
+import {
+  createEncoder,
+  Encoder,
+  LightPushCodec,
+  LightPushCodecV2
+} from "@waku/core";
 import { Libp2p, LightPushError, LightPushStatusCode } from "@waku/interfaces";
 import { createRoutingInfo } from "@waku/utils";
 import { utf8ToBytes } from "@waku/utils/bytes";
@@ -243,7 +248,7 @@ function mockV3Peer(id: string): Peer {
 }
 
 function mockV2AndV3Peer(id: string): Peer {
-  return mockPeer(id, [LightPushCodec, LightPushCodec]);
+  return mockPeer(id, [LightPushCodec, LightPushCodecV2]);
 }
 
 function mockV3SuccessResponse(relayPeerCount?: number): {

packages/sdk/src/light_push/light_push.ts

@@ -34,6 +34,7 @@ type LightPushConstructorParams = {
   peerManager: PeerManager;
   libp2p: Libp2p;
   options?: Partial<LightPushProtocolOptions>;
+  legacy?: boolean;
 };
 
 export class LightPush implements ILightPush {
@@ -49,7 +50,7 @@ export class LightPush implements ILightPush {
     } as LightPushProtocolOptions;
 
     this.peerManager = params.peerManager;
-    this.protocol = new LightPushCore(params.libp2p);
+    this.protocol = new LightPushCore(params.libp2p, params.legacy);
     this.retryManager = new RetryManager({
       peerManager: params.peerManager,
       retryIntervalMs: this.config.retryIntervalMs

packages/sdk/src/waku/waku.ts

@@ -111,10 +111,12 @@ export class WakuNode implements IWaku {
     }
 
     if (protocolsEnabled.lightpush) {
+      const legacyFlag = (options?.lightPush as any)?.legacy;
       this.lightPush = new LightPush({
         libp2p,
         peerManager: this.peerManager,
-        options: options?.lightPush
+        options: options?.lightPush,
+        legacy: legacyFlag
       });
     }
 

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

@@ -21,9 +21,9 @@ import {
   TestRoutingInfo
 } from "./utils.js";
 
-const runTests = (strictNodeCheck: boolean): void => {
+const runTests = (strictNodeCheck: boolean, legacy: boolean): void => {
   const numServiceNodes = 2;
-  describe(`Waku Light Push: Multiple Nodes: Strict Check: ${strictNodeCheck}`, function () {
+  describe(`Waku Light Push (legacy=${legacy ? "v2" : "v3"}): 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;
@@ -36,7 +36,11 @@ const runTests = (strictNodeCheck: boolean): void => {
         { lightpush: true, filter: true },
         strictNodeCheck,
         numServiceNodes,
-        true
+        true,
+        {
+          // Pass legacy flag to createLightNode so that LightPush uses v2 when true
+          lightPush: { legacy }
+        } as any
       );
     });
 
@@ -257,4 +261,6 @@ const runTests = (strictNodeCheck: boolean): void => {
   });
 };
 
-[true, false].map(runTests);
+[true, false].forEach((strictNodeCheck) => {
+  [true, false].forEach((legacy) => runTests(strictNodeCheck, legacy));
+});