nest feat(ws): add regex path support on platform ws path

trafficstars

PR Checklist

Please check if your PR fulfills the following requirements:

[x] The commit message follows our guidelines: https://github.com/nestjs/nest/blob/master/CONTRIBUTING.md
[x] Tests for the changes have been added (for bug fixes / features)
[ ] Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Other... Please describe:

What is the current behavior?

Currently Websocket Adaptor only takes strict pathname as parameter but common use case like YJS works on random websocket route /ws/:room_id which makes it hard nest js to be used in those scenario. This PR will help fixing that use case.

Issue Number: N/A

What is the new behavior?

Websocket Adaptor path parameter can now take pathregex as input like ws/:room_id and it will allow request url which match that pathregex.

import { SubscribeMessage, WebSocketGateway } from '@nestjs/websockets';

@WebSocketGateway({
  path: '/ws-path/:room_id',
})
export class WsPathGatewayRegex {
  @SubscribeMessage('push')
  onPush(client, data) {
    return {
      event: 'pop',
      data,
    };
  }
}

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

I tried running integration test on my local system with docker up but still there were few failing tests for me. I'm new to mocha ( have use jest ) ws-gateway, rpc integration are failing for me even if I roll back my changes. I ran ws-gateway test cases individually as it was not dependent on any docker container with this command

npx mocha --watch integration/websockets/e2e/ws-gateway.spec.ts