[webpubsubclient] Fix a bug that 0 sequenceId won't be sent to service

sdk/web-pubsub/web-pubsub-client/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History
 
+## 1.0.2 (2024-05-01)
+
+### Bugs Fixed
+
+- Fix the bug that `sequenceAck` ping won't be sent if nothing has been received for a client
+
 ## 1.0.1 (2024-04-24)
 
 ### Other Changes

sdk/web-pubsub/web-pubsub-client/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure/web-pubsub-client",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Azure Web PubSub Client",
   "sdk-type": "client",
   "main": "dist/index.js",

sdk/web-pubsub/web-pubsub-client/src/webPubSubClient.ts

@@ -541,7 +541,8 @@ export class WebPubSubClient {
       return;
     }
     const [isUpdated, seqId] = this._sequenceId.tryGetSequenceId();
-    if (isUpdated && seqId) {
+    if (isUpdated && seqId !== null && seqId !== undefined) {
+      // seqId can be 0
       const message: SequenceAckMessage = {
         kind: "sequenceAck",
         sequenceId: seqId!,

sdk/web-pubsub/web-pubsub-client/test/client.lifetime.spec.ts

@@ -438,6 +438,28 @@ describe("WebPubSubClient", function () {
       mock.verify();
       client.stop();
     });
+
+    it("SequenceAck as ping", async () => {
+      const client = new WebPubSubClient("wss://service.com");
+      const testWs = new TestWebSocketClient(client);
+      makeStartable(testWs);
+
+      const writeMessageSpy = sinon.spy(client["_protocol"], "writeMessage");
+      await client.start();
+
+      // simulate a update
+      client["_sequenceId"].tryUpdate(0);
+
+      // simulate a call
+      client["_trySendSequenceAck"]();
+
+      // expect quick sequenceAck message
+      sinon.assert.calledWith(
+        writeMessageSpy,
+        sinon.match.has("kind", "sequenceAck").and(sinon.match.has("sequenceId", 0)),
+      );
+      client.stop();
+    });
   });
 
   function makeStartable(ws: TestWebSocketClient): sinon.SinonStub<[fn: () => void], void> {