fix: Middlewares not executed when setting up with useSocketServer

[sittingbool]

Description

Hi, I wanted to use a middleware for doing authentication.

The problem is: The middleware is never ever being called.

Following setup:

const io = require('socket.io')(server, {
      cors: {
          origin: '*', // ['http://localhost:4200', 'http://localhost:63342'],
          credentials: true
      }
  });

  useSocketServer(io, {
      controllers: [__dirname + '/controller/socket/*.js'],
      middlewares: [SocketAuthenticationMiddleware]
  });

@Middleware()
export class SocketAuthenticationMiddleware implements MiddlewareInterface {

    use(socket: Socket, next: express.NextFunction): void {
        const token = <string>socket.request.headers['x-api-token']; // break point here -> never called
        if(stringIsEmpty(token)) {
            console.error('denied connection due to  missing token ' + token);
            next(new Error(UserErrors.tokenInvalid));
        }
        console.log('Successfully connected socket for ' + token);
        next();
    }
}

@SocketController('/chat')
export class ChatController extends RootController {
    @OnConnect()
    connection(@ConnectedSocket() socket: Socket): void {
        console.log('client connected to chat: ' + socket.id); // <<< this one is called despite missing token
    }

Expected behavior

Middleware code being executed

Actual behavior

Middleware code not being executed

[yakovets-evgeny]

I have a similar problem

[ltrillaud]

Me too

[sittingbool]

This is now almost a year old. I am having this again in another project. Using socket.io 4. Ist this project still being maintained?

[attilaorosz]

Yes, but unfortunately the time we can allocate is limited. I’m planning some refactoring and support for latest socket.io in the near future.

[sittingbool]

I am doing some research currently.

My setup: Node LTS, express server.

The problem is located here:

socket-controllers/src/SocketControllerExecutor.ts

Line 74 in eea8d95

middleware.instance.use(socket, next);

The middleware is not called, because the socket.io middleware in which it is wrapped is not called. So this might be a problem with the combination socket.io on an express server. I will dig deeper.

[sittingbool]

One other suggestion: I am using a custom namespace. It seems like the middleware is namespace-specific:

socketio/socket.io#3082

[sittingbool]

Confirmed last statement:

Tested with code like this:

    io.of('/my-namespace')
        .use((socket, next) => {
            console.log('middleware running with namespace...');
            next();
        });


    io.use((socket, next) => {
        console.log('middleware running in general...');
        next();
    });

    useSocketServer(io, {
        controllers: [__dirname + '/controllers/*.ctrl.js'],
        middlewares: [__dirname + '/middlewares/*.mw.js']
    });

leads to following output:

Listening on port 3000
Database loaded
middleware running with namespace...

[sittingbool]

I'll propose a solution in a PR

[attilaorosz]

Closing as this has been resolved in #511

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.