Skip to content
This repository has been archived by the owner on Mar 1, 2024. It is now read-only.

Update cirrus.js - More informative error messages - Fixes EpicGames/PixelStreamingInfrastructure#184 #441

Merged
merged 3 commits into from
Dec 10, 2023

Conversation

alien299
Copy link
Contributor

Relevant components:

  • Signalling server
  • Frontend library
  • Frontend UI library
  • Matchmaker
  • Platform scripts
  • SFU

Problem statement:

Fixed an Issue regarding the WebSocket disconnect error messages. I made them more informative so they can assist with debugging. Issue #184
"Currently, all websocket disconnects are presented with the same "Websocket disconnected: 1006" error (see screenshot). This is a generic error, but not overly useful to assist with debugging whether UE disconnected or the browser disconnected."

Solution

On abnormal closure the cirrus.js called ws.close(1006, error). I insterted more information/explanation about the error and then added the error at the end of the message. Example: ws.close(1006, "SFU connection error: ${error}");
It makes the default error message more informative as described in Issue #184
Affected Lines:
Line 662
Line 826
Line 954

Documentation

Test Plan and Compatibility

Fixed an Issue regarding the Websocket disconnect error messages. I made them more informative so they can assist with debugging.
[Issue EpicGames#184](EpicGames#184)
Fixed an Issue regarding the Websocket disconnect error messages. I made them more informative so they can assist with debugging.
[Issue EpicGames#184](EpicGames#184)
@alien299
Copy link
Contributor Author

alien299 commented Nov 30, 2023

Hi!
@mcottontensor Should I reopen the pull request with signed commits?
The contributing guidelines didn't contain all commits have to be Verified. I fixed it in the latest 2 commits, but the original commit stayed unverified.

@alien299 alien299 changed the title Update cirrus.js - More informative error messages Update cirrus.js - More informative error messages - Closes #184 Dec 7, 2023
@alien299 alien299 changed the title Update cirrus.js - More informative error messages - Closes #184 Update cirrus.js - More informative error messages - Fixes EpicGames/PixelStreamingInfrastructure#184 Dec 7, 2023
@mcottontensor
Copy link
Contributor

It's no problem. We've just been busy lately and haven't gotten around to some things.

@mcottontensor mcottontensor merged commit c05f3b1 into EpicGames:master Dec 10, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants