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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Relevant components:
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