fix(socketio): injecting the session into $onDisconnect

closes #2383
tsedio · Jul 16, 2023 · c4c2a01 · c4c2a01
1 parent aa4e717
commit c4c2a01
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 12 deletions.
diff --git a/packages/third-parties/socketio/src/class/SocketHandlersBuilder.spec.ts b/packages/third-parties/socketio/src/class/SocketHandlersBuilder.spec.ts
@@ -109,7 +109,7 @@ describe("SocketHandlersBuilder", () => {
     });
   });
   describe("onConnection()", () => {
-    it("should build handler and invoke onConnection instance method", () => {
+    it("should build handler and invoke onConnection instance method", async () => {
       const instance = {
         $onConnection: jest.fn()
       };
@@ -140,7 +140,7 @@ describe("SocketHandlersBuilder", () => {
       const buildHandlersStub = jest.spyOn(builder, "buildHandlers").mockReturnValue(undefined);
       const createSessionStub = jest.spyOn(builder, "createSession").mockReturnValue(undefined);
 
-      builder.onConnection(socketStub, nspStub);
+      await builder.onConnection(socketStub, nspStub);
 
       expect(buildHandlersStub).toBeCalledWith(socketStub, nspStub);
       expect(createSessionStub).toBeCalledWith(socketStub);
@@ -155,7 +155,7 @@ describe("SocketHandlersBuilder", () => {
     });
   });
   describe("onDisconnect()", () => {
-    it("should call the createSession method and create the $onDisconnect method if is missing", () => {
+    it("should call the createSession method and create the $onDisconnect method if is missing", async () => {
       const instance = {
         $onDisconnect: jest.fn()
       };
@@ -185,7 +185,7 @@ describe("SocketHandlersBuilder", () => {
       const invokeStub = jest.spyOn(builder, "invoke").mockReturnValue(undefined);
       const destroySessionStub = jest.spyOn(builder, "destroySession").mockReturnValue(undefined);
 
-      builder.onDisconnect(socketStub, nspStub);
+      await builder.onDisconnect(socketStub, nspStub);
 
       expect(destroySessionStub).toBeCalledWith(socketStub);
       expect(invokeStub).toBeCalledWith(
@@ -198,7 +198,7 @@ describe("SocketHandlersBuilder", () => {
       );
     });
 
-    it("should pass the disconnection reason", () => {
+    it("should pass the disconnection reason", async () => {
       const instance = {
         $onDisconnect: jest.fn()
       };
@@ -229,7 +229,7 @@ describe("SocketHandlersBuilder", () => {
       const invokeStub = jest.spyOn(builder, "invoke").mockReturnValue(undefined);
       jest.spyOn(builder, "destroySession").mockReturnValue(undefined);
 
-      builder.onDisconnect(socketStub, nspStub, reason);
+      await builder.onDisconnect(socketStub, nspStub, reason);
 
       expect(invokeStub).toBeCalledWith(
         instance,
@@ -241,6 +241,41 @@ describe("SocketHandlersBuilder", () => {
         }
       );
     });
+
+    it("should destroy the session only when $onDisconnect is completed invocation", async () => {
+      const instance = {
+        $onDisconnect: jest.fn()
+      };
+
+      const provider: any = {
+        store: {
+          get: jest.fn().mockReturnValue({
+            injectNamespace: "nsp",
+            handlers: {
+              $onDisconnect: {
+                eventName: "onDisconnect"
+              }
+            }
+          })
+        }
+      };
+      const nspStub: any = {nsp: "nsp"};
+      const socketStub: any = {
+        on: jest.fn()
+      };
+
+      const builder: any = new SocketHandlersBuilder(provider, {
+        get() {
+          return instance;
+        }
+      } as any);
+      const invokeStub = jest.spyOn(builder, "invoke").mockReturnValue(undefined);
+      const destroySessionStub = jest.spyOn(builder, "destroySession").mockReturnValue(undefined);
+
+      await builder.onDisconnect(socketStub, nspStub);
+
+      expect(destroySessionStub.mock.invocationCallOrder[0]).toBeGreaterThan(invokeStub.mock.invocationCallOrder[0]);
+    });
   });
   describe("createSession()", () => {
     it("should create session for the socket", () => {

diff --git a/packages/third-parties/socketio/src/class/SocketHandlersBuilder.ts b/packages/third-parties/socketio/src/class/SocketHandlersBuilder.ts
@@ -80,24 +80,24 @@ export class SocketHandlersBuilder {
    * @param {Socket} socket
    * @param {Namespace} nsp
    */
-  public onConnection(socket: Socket, nsp: Namespace) {
+  public async onConnection(socket: Socket, nsp: Namespace) {
     const {socketProviderMetadata} = this;
     const instance = this.injector.get(this.provider.token);
 
     this.buildHandlers(socket, nsp);
     this.createSession(socket);
 
     if (instance.$onConnection) {
-      this.invoke(instance, socketProviderMetadata.$onConnection, {socket, nsp});
+      await this.invoke(instance, socketProviderMetadata.$onConnection, {socket, nsp});
     }
   }
 
-  public onDisconnect(socket: Socket, nsp: Namespace, reason?: string) {
+  public async onDisconnect(socket: Socket, nsp: Namespace, reason?: string) {
     const instance = this.injector.get(this.provider.token);
     const {socketProviderMetadata} = this;
 
     if (instance.$onDisconnect) {
-      this.invoke(instance, socketProviderMetadata.$onDisconnect, {socket, nsp, reason});
+      await this.invoke(instance, socketProviderMetadata.$onDisconnect, {socket, nsp, reason});
     }
 
     this.destroySession(socket);
@@ -136,7 +136,6 @@ export class SocketHandlersBuilder {
   }
 
   private runQueue(handlerMetadata: SocketHandlerMetadata, args: any[], socket: Socket, nsp: Namespace) {
-    let promise: any = Promise.resolve(args);
     const instance = this.injector.get(this.provider.token);
     const {useBefore, useAfter} = this.socketProviderMetadata;
     const scope = {
@@ -146,7 +145,7 @@ export class SocketHandlersBuilder {
       eventName: handlerMetadata.eventName
     };
 
-    promise = promise.then(() => this.deserialize(handlerMetadata, scope));
+    let promise = Promise.resolve().then(() => this.deserialize(handlerMetadata, scope));
 
     if (useBefore) {
       useBefore.forEach((target: any) => (promise = this.bindMiddleware(target, scope, promise)));