feat: resolve socket options

Author: MatthewPattell

__tests__/services/socket-test.ts

@@ -228,6 +228,27 @@ describe('services/socket', () => {
     expect(ioServerUseStub).to.calledTwice;
   });
 
+  it('should correctly start microservice with async io params', async () => {
+    const listenStub = sandbox.stub(ms.getIoServer(), 'listen');
+
+    // Configure io server stubs
+    const ioServerUseStub = sandbox.stub(ms.getIoServer(), 'use');
+    const ioServerOnStub = sandbox.stub(ms.getIoServer(), 'on');
+
+    ms.setParams({
+      ioServerOptions: () => ioServerOptions,
+    });
+
+    // Skip startWorkers
+    sandbox.stub(axios, 'request').rejects(new Error('ECONNREFUSED'));
+
+    await ms.start();
+
+    expect(listenStub).to.calledOnceWith(ms.getHttpServer(), ioServerOptions);
+    expect(ioServerOnStub).to.calledOnce;
+    expect(ioServerUseStub).to.calledTwice;
+  });
+
   it('should correctly apply connection middlewares', async () => {
     const socket = { handshake: { headers: {} }, data: {} } as IoSocket;
     const nextStub = sandbox.stub();

src/interfaces/services/i-socket.ts

@@ -7,6 +7,7 @@ import type {
   IAbstractMicroserviceParams,
 } from '@interfaces/services/i-abstract-microservice';
 import type { TJsonRPC } from '@interfaces/services/i-gateway';
+import type SocketMs from '@services/socket';
 
 export interface ISocketOptions extends IAbstractMicroserviceOptions {
   listener: string;
@@ -16,7 +17,9 @@ export interface ISocketOptions extends IAbstractMicroserviceOptions {
 }
 
 export interface ISocketParams extends IAbstractMicroserviceParams {
-  ioServerOptions?: Partial<ServerOptions>;
+  ioServerOptions?:
+    | Partial<ServerOptions>
+    | ((ms: SocketMs) => Partial<ServerOptions> | Promise<Partial<ServerOptions>>);
   signRoomOptions: { secretKey: string };
   makeRoomName?: (
     roomName: string,

src/services/socket.ts

@@ -533,15 +533,18 @@ class Socket extends AbstractMicroservice {
   /**
    * Run microservice
    */
-  public start(): Promise<void | void[]> {
+  public async start(): Promise<void | void[]> {
     const { name, version, listener, eventWorkers } = this.options;
     const { ioServerOptions } = this.params;
     const [host, port] = listener.split(':');
 
     this.logDriver(() => `${name} start. Version: ${version}`, LogType.INFO);
 
     this.configureIoServer();
-    this.ioServer.listen(this.httpServer, ioServerOptions);
+    this.ioServer.listen(
+      this.httpServer,
+      typeof ioServerOptions === 'function' ? await ioServerOptions(this) : ioServerOptions,
+    );
 
     const server = this.httpServer.listen(Number(port), host, () => {
       this.logDriver(