[FIX] session: always return a Promise

If the implementation of `transportService` doesn't
return a Promise when calling `sendMessage`, the session breaks.

With this commit, we ensure we always get a Promise which allows
to safely call `.then` or `.catch`

closes #7721

Task: 0
Signed-off-by: Vincent Schippefilt (vsc) <vsc@odoo.com>

Author: LucasLefevre

src/collaborative/readonly_transport_filter.ts

@@ -14,7 +14,7 @@ export class ReadonlyTransportFilter implements TransportService<CollaborationMe
       message.type === "CLIENT_LEFT" ||
       message.type === "CLIENT_MOVED"
     ) {
-      this.transportService.sendMessage(message);
+      await this.transportService.sendMessage(message);
     }
     // ignore all other messages
   }

src/collaborative/session.ts

@@ -195,7 +195,7 @@ export class Session extends EventBus<CollaborativeEvent> {
     }
     delete this.clients[this.clientId];
     this.transportService.leave(this.clientId);
-    this.transportService.sendMessage({
+    this.sendToTransport({
       type: "CLIENT_LEFT",
       clientId: this.clientId,
       version: MESSAGE_VERSION,
@@ -210,7 +210,7 @@ export class Session extends EventBus<CollaborativeEvent> {
       return;
     }
     const snapshotId = this.uuidGenerator.uuidv4();
-    await this.transportService.sendMessage({
+    await this.sendToTransport({
       type: "SNAPSHOT",
       nextRevisionId: snapshotId,
       serverRevisionId: this.serverRevisionId,
@@ -267,17 +267,15 @@ export class Session extends EventBus<CollaborativeEvent> {
     const type = currentPosition ? "CLIENT_MOVED" : "CLIENT_JOINED";
     const client = this.getCurrentClient();
     this.clients[this.clientId] = { ...client, position };
-    this.transportService
-      .sendMessage({
-        type,
-        version: MESSAGE_VERSION,
-        client: { ...client, position },
-      })
-      .then(() => {
-        if (this.pendingMessages.length > 0 && !this.waitingAck) {
-          this.sendPendingMessage();
-        }
-      });
+    this.sendToTransport({
+      type,
+      version: MESSAGE_VERSION,
+      client: { ...client, position },
+    }).then(() => {
+      if (this.pendingMessages.length > 0 && !this.waitingAck) {
+        this.sendPendingMessage();
+      }
+    });
   }
 
   /**
@@ -382,7 +380,7 @@ export class Session extends EventBus<CollaborativeEvent> {
       if (client) {
         const { position } = client;
         if (position) {
-          this.transportService.sendMessage({
+          this.sendToTransport({
             type: "CLIENT_MOVED",
             version: MESSAGE_VERSION,
             client: { ...client, position },
@@ -406,6 +404,11 @@ export class Session extends EventBus<CollaborativeEvent> {
     this.sendPendingMessage();
   }
 
+  private async sendToTransport(message: CollaborationMessage) {
+    // wrap in an async function to ensure it returns a promise
+    return this.transportService.sendMessage(message);
+  }
+
   /**
    * Send the next pending message
    */
@@ -433,17 +436,15 @@ export class Session extends EventBus<CollaborativeEvent> {
       ${JSON.stringify(message)}`);
     }
     this.waitingAck = true;
-    this.transportService
-      .sendMessage({
-        ...message,
-        serverRevisionId: this.serverRevisionId,
-      })
-      .catch((e: Error) => {
-        if (!(e instanceof ClientDisconnectedError)) {
-          throw e.cause || e;
-        }
-        this.waitingAck = false;
-      });
+    this.sendToTransport({
+      ...message,
+      serverRevisionId: this.serverRevisionId,
+    }).catch((e: Error) => {
+      if (!(e instanceof ClientDisconnectedError)) {
+        throw e.cause || e;
+      }
+      this.waitingAck = false;
+    });
   }
 
   private acknowledge(message: CollaborationMessage) {