Websocket bug: PING to server sends PING Frame instead of PONG Frame

[srasul]

Motivation:

There is a bug in the Websocket Server PING/PONG handing. When a PING message is sent to Server, the Server incorrectly sends out another PING message as a reply. This is because the code to create the PONG message has a bug in it. The problem is that when testing the PING/PONG mechanism, the Server incorrectly send a PING as a reply for a PING. And this caused whoever was sending the initial PING to receive an incorrect reply to the PING. This was only happening for the case when the PING message has data.

Modifications:

• In the method: com.linecorp.armeria.common.websocket.WebSocketFrame#ofPong(byte[]), there is the bug. I modified the code to return the correct Frame. See the files changed.
• I also created unit test for this case

Result:

• Websocker PING that contain data are now correctly handled and a PONG Frame sent out.
• This means that when testing with a websocket cli tool, I now get the correct frame.
  BEFORE:

$ websocat --print-ping-rtts --ping-interval 5 ws://localhost:8080/ws
[WARN  websocat::ws_peer] Received a pong with a strange content from websocket
[WARN  websocat::ws_peer] Received a pong with a strange content from websocket
[WARN  websocat::ws_peer] Received a pong with a strange content from websocket

AFTER:

$ websocat --print-ping-rtts --ping-interval 5 ws://localhost:8080/ws
RTT 0.003123 s
RTT 0.000542 s
RTT 0.000530 s

[CLAassistant]

All committers have signed the CLA.

[minwoox]

Thanks!

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.05%. Comparing base (0ab1721) to head (55a4733).
Report is 5 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #5533      +/-   ##
============================================
+ Coverage     74.03%   74.05%   +0.01%     
- Complexity    20854    20871      +17     
============================================
  Files          1807     1808       +1     
  Lines         76754    76808      +54     
  Branches       9790     9800      +10     
============================================
+ Hits          56827    56877      +50     
+ Misses        15301    15295       -6     
- Partials       4626     4636      +10     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[github-actions]

🔍 Build Scan® (commit: 55a4733)

Job name	Status	Build Scan®
build-windows-latest-jdk-19	✅	https://ge.armeria.dev/s/hc3rjz3jtubf4
build-self-hosted-unsafe-jdk-8	✅	https://ge.armeria.dev/s/gdgiaaalgxgzs
build-self-hosted-unsafe-jdk-19-snapshot-blockhound	✅	https://ge.armeria.dev/s/5mz2grmijy5ty
build-self-hosted-unsafe-jdk-17-min-java-17-coverage	✅	https://ge.armeria.dev/s/u55jollmjyef6
build-self-hosted-unsafe-jdk-17-min-java-11	✅	https://ge.armeria.dev/s/o3ysu7fv3gfdm
build-self-hosted-unsafe-jdk-17-leak	✅	https://ge.armeria.dev/s/ucbtejno5ie5m
build-self-hosted-unsafe-jdk-11	✅	https://ge.armeria.dev/s/bur7iegt3hg42
build-macos-12-jdk-19	✅	https://ge.armeria.dev/s/pgedmk6xofjgo

[ikhoon]

Oops... Nice catch! 🙇‍♂️🙇‍♂️

[jrhee17]

👍 👍 👍