[Nestjs] 네스트js 프로젝트 websocket 구축해서 postman 테스트 해보기

[Snow-ball]server/NestJS

[Nestjs] 네스트js 프로젝트 websocket 구축해서 postman 테스트 해보기

Snow-ball 2023. 10. 30. 20:10

nestjs 프로젝트로 websocket을 구현해서 postman으로 테스트를 해보겠다.

간단하게 테스트를 해볼것이기 때문에 코드레벨은 간단히 정의해보았다.

88번 포트로 웹소켓 통신을 시작할 것이고, 연결이 되기 시작했다면 'message'라는 값으로 통신을 시작할 것이다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

@WebSocketGateway(88, {
  transports: ['websocket'],
  cors: {
    origin: '*',
    methods: ['GET', 'POST'],
    transports: ['websocket', 'polling'],
    credentials: true,
  },
  allowEIO3: true,
})
 
export class ChatGateway
  implements OnGatewayConnection, OnGatewayDisconnect, OnGatewayInit
{
  @WebSocketServer() private readonly server: Server;
 
  public handleConnection(client: Socket): void {
    const roomId: string = client?.handshake?.query['id'] as string;
    
    client.connected && client.join(roomId);
  }
 
  public handleDisconnect(client: Socket): void {
    !client.disconnected && client.disconnect();
  }
 
  public afterInit(): void {
    instrument(this.server, {
      auth: false,
      mode: 'development',
    });
  }
 
  @SubscribeMessage<string>('message')
  private message(@MessageBody() message: Message) {
    this.server.to(message.roomId).emit('message', message);
  }
}
Colored by Color Scripter

cs

위에처럼 코드를 작성해서 서버를 실행한다면 이제 postman으로 테스트 할 수 있는 상황이 되었다.

1. 포스트맨을 접속한다.

2. 왼쪽 상단의 [ New ] 버튼을 눌러서 뜨는 창에서 [ Socket.IO ]를 눌러주자.

3. 그러면 이렇게 빈 창이 뜨는데 하나씩 채워보자!

(1) 맨위의 url 창부터 확인해보자.

- host: 나는 로컬에서 우선적으로 테스트 하기 위해서 127.0.0.1(localhost)를 사용하였다.

- port: 포트번호는 위에와 동일하게 88번 포트를 사용하였다.

- query: handleConnection 함수가 실행될때 사용할 id값과 nickname값을 쿼리로 같이 사용하였다.

(2) Message 창

- 메시지창은 구성하기 나름이다. 그렇기 때문에 정해진 규격없이 팀이나 회사가 정하는 방식으로 보내면 된다.

- 본문의 메시지창은 message 함수에서 사용하기 위해 보낸다.

- 나의 경우에는 메시지 타입을 정의해 놓는것을 선호한다.

1
2
3
4
5
6
7
8

export type Message = Readonly<{
  roomId: string;
  nickname: string;
  message: string;
  profileImage?: string;
  createdAt: Date;
  level: string;
}>;

cs