svs: default to SVS v3

Author: yoursunny

pkg/svs/README.md

@@ -5,10 +5,10 @@ This package is part of [NDNts](https://yoursunny.com/p/NDNts/), Named Data Netw
 This package contains **StateVectorSync** and related protocols, including:
 
 * [StateVectorSync v2](https://github.com/named-data/StateVectorSync/blob/98bb56661b98a1afa869a96d86715b9788e671a6/Specification.md), revision 2025-01-04
-  * complete unit test
+  * deprecated, enable with `svs3: false` option
+  * partial unit test
   * core synchronization logic only, does not deal with Data fetching
 * [StateVectorSync v3](https://named-data.github.io/StateVectorSync/Specification.html), revision 2025-01-14
-  * enable with `svs3: true` option
   * complete unit test
   * core synchronization logic only, does not deal with Data fetching
 * [SVS-PS](https://named-data.github.io/StateVectorSync/PubSubSpec.html), revision 2025-01-04

pkg/svs/src/sync.ts

@@ -36,11 +36,11 @@ export class SvSync extends TypedEventTarget<EventMap> implements SyncProtocol<S
     initialize,
     syncInterestLifetime = 1000,
     periodicTimeout = [30000, 0.1],
-    suppressionPeriod = 2200,
+    suppressionPeriod = 200,
     suppressionTimeout = SvSync.suppressionExpDelay(suppressionPeriod),
     signer = nullSigner,
     verifier = noopSigning,
-    svs3 = false,
+    svs3 = true, // eslint-disable-line @typescript-eslint/no-deprecated
   }: SvSync.Options): Promise<SvSync> {
     if (typeof periodicTimeout === "number") {
       periodicTimeout = [periodicTimeout, 0.1];
@@ -76,7 +76,7 @@ export class SvSync extends TypedEventTarget<EventMap> implements SyncProtocol<S
       private readonly verifier: Verifier,
   ) {
     super();
-    this.syncInterestName = groupPrefix.append(svs3 ? Version3 : Version2);
+    this.syncDataName = groupPrefix.append(svs3 ? Version3 : Version2);
   }
 
   private makeFace(fw: Forwarder): void {
@@ -87,12 +87,12 @@ export class SvSync extends TypedEventTarget<EventMap> implements SyncProtocol<S
       describe: this.describe,
       routeCapture: false,
     });
-    this.face.addRoute(this.syncInterestName, this.groupPrefix);
+    this.face.addRoute(this.syncDataName, this.groupPrefix);
   }
 
   private readonly maybeHaveEventListener = trackEventListener(this);
   private face?: FwFace;
-  private readonly syncInterestName: Name;
+  private readonly syncDataName: Name;
   private txStream = pushable<FwPacket>();
 
   /**
@@ -289,7 +289,7 @@ export class SvSync extends TypedEventTarget<EventMap> implements SyncProtocol<S
       }
       case l3TT.Data: { // SVS v3
         const data = d1.decode(Data);
-        assert(data.name.equals(this.syncInterestName));
+        assert(data.name.equals(this.syncDataName));
         await this.verifier.verify(data);
         recv = Decoder.decode(data.content, StateVector);
         break;
@@ -365,7 +365,7 @@ export class SvSync extends TypedEventTarget<EventMap> implements SyncProtocol<S
   /** Transmit a sync Interest. */
   private async sendSyncInterest(): Promise<void> {
     const interest = new Interest();
-    interest.name = this.syncInterestName;
+    interest.name = this.syncDataName;
     interest.canBePrefix = true;
     interest.mustBeFresh = true;
     interest.lifetime = this.syncInterestLifetime;
@@ -375,7 +375,7 @@ export class SvSync extends TypedEventTarget<EventMap> implements SyncProtocol<S
       this.own.encodeTo(encoder, 3);
 
       const data = new Data();
-      data.name = this.syncInterestName;
+      data.name = this.syncDataName;
       data.content = encoder.output;
       await this.signer.sign(data);
 
@@ -442,8 +442,8 @@ export namespace SvSync {
     periodicTimeout?: number | [median: number, jitter: number];
 
     /**
-     * Sync Interest timer in suppression state, maximum value.
-     * @defaultValue `200ms`
+     * Sync Interest timer in suppression state, maximum value in milliseconds.
+     * @defaultValue 200
      */
     suppressionPeriod?: number;
 
@@ -470,15 +470,17 @@ export namespace SvSync {
     verifier?: Verifier;
 
     /**
-     * Enable SVS v3 protocol.
-     * @defaultValue false
+     * Enable SVS v3 protocol instead of SVS v2.
+     * @defaultValue true
+     *
+     * @deprecated SVS v2 is deprecated.
      */
     svs3?: boolean;
   }
 
   /**
-   * SVS v2 suppression timeout exponential decay function.
-   * @param c - Constant factor.
+   * SVS v3 suppression timeout exponential decay function.
+   * @param c - Constant factor, aka SuppressionPeriod.
    * @param f - Decay factor.
    * @returns Function to generate suppression timeout values.
    */

pkg/svs/tests/svsps.t.ts

@@ -25,6 +25,7 @@ beforeAll(async () => {
     suppressionPeriod: 50,
     signer: signerS,
     verifier: verifierS,
+    svs3: false,
   };
   pubOpts = {
     innerSigner: signerI,

pkg/svs/tests/sync.t.ts

@@ -150,7 +150,7 @@ test("5.3", async () => {
   initialStateVector.set({ name: new Name("/B"), boot: 1636266412 }, 15);
   initialStateVector.set({ name: new Name("/C"), boot: 1636266115 }, 25);
 
-  const opts: SvSync.Options = { ...baseOpts, svs3: true, initialStateVector };
+  const opts: SvSync.Options = { ...baseOpts, initialStateVector };
 
   const pA0 = await SvSync.create({ ...opts, describe: "A0" });
   const pB0 = await SvSync.create({ ...opts, describe: "B0" });
@@ -198,22 +198,26 @@ test("initialize", async () => {
   closers.push(p0);
   debugHandler.start(p0);
 
-  const n0A = p0.get("/A");
+  const n0A = p0.get("/A", 10);
   n0A.seqNum = 11;
   n0A.remove(); // no effect
-  const n0B = p0.get("/B");
+  const n0B = p0.get("/N", 22);
   n0B.seqNum = 12;
-  const n0C = p0.get("/C");
+  const n0C = p0.get("/N", 23);
   n0C.seqNum = 13;
   n0C.seqNum = 3; // no effect
   await delay(200);
   expect(debugHandler.count("0:send")).toBe(1);
 
+  const idA = n0A.id;
+  const idB = n0B.id;
+  const idC = n0C.id;
+
   p0.close();
   const v0 = p0.currentStateVector;
-  expect(v0.get(new Name("/A"))).toBe(11);
-  expect(v0.get(new Name("/B"))).toBe(12);
-  expect(v0.get(new Name("/C"))).toBe(13);
+  expect(v0.get(idA)).toBe(11);
+  expect(v0.get(idB)).toBe(12);
+  expect(v0.get(idC)).toBe(13);
   expect(v0.get(new Name("/D"))).toBe(0);
 
   // eslint-disable-next-line unicorn/prefer-structured-clone
@@ -227,8 +231,8 @@ test("initialize", async () => {
       debugHandler.start(sync);
 
       const n1A = sync.get("/A");
-      const n1B = sync.get("/B");
-      const n1C = sync.get("/C");
+      const n1B = sync.get("/N", 22);
+      const n1C = sync.get("/N", 23);
       const n1D = sync.get("/D");
 
       expect(n1A.seqNum).toBe(11);
@@ -247,8 +251,8 @@ test("initialize", async () => {
   expect(debugHandler.count("1:send")).toBe(0);
 
   expect(p1.get("/A").seqNum).toBe(0);
-  expect(p1.get("/B").seqNum).toBe(22);
-  expect(p1.get("/C").seqNum).toBe(3);
+  expect(p1.get(idB).seqNum).toBe(22);
+  expect(p1.get(idC).seqNum).toBe(3);
   const n1D = p1.get("/D");
   expect(n1D.seqNum).toBe(4);
   ++n1D.seqNum;
@@ -262,7 +266,7 @@ test("get add", async () => {
   initialStateVector.set({ name: new Name("/A"), boot: 1736890910 }, 1);
   initialStateVector.set({ name: new Name("/B"), boot: 1736890920 }, 1);
 
-  const p = await SvSync.create({ ...baseOpts, svs3: true, initialStateVector });
+  const p = await SvSync.create({ ...baseOpts, initialStateVector });
   closers.push(p);
 
   // .get(id)
@@ -295,10 +299,8 @@ test("get add", async () => {
 test("future bootstrap time", async () => {
   const debugHandler = new DebugHandler();
 
-  const opts: SvSync.Options = { ...baseOpts, svs3: true };
-
-  const pA = await SvSync.create({ ...opts, describe: "A" });
-  const pB = await SvSync.create({ ...opts, describe: "B" });
+  const pA = await SvSync.create({ ...baseOpts, describe: "A" });
+  const pB = await SvSync.create({ ...baseOpts, describe: "B" });
 
   debugHandler.start(pA);
   debugHandler.start(pB);