Fix: WebSocket: Correctly serialize JSON response payload #520
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reasoning:
The previous implementation used manual string concatenation to build the WebSocket response payload ({moduleName:..., output:...}).
This method failed to correctly escape special characters (e.g., quotes, newlines, control characters) potentially present in the 'output' data from backend modules.
This resulted in corrupted JSON strings, causing frontend clients (JavaScript's JSON.parse) to fail parsing the message, leading to "module output not found" or display errors in the UI.
Solution:
Replaced manual string concatenation with standard JSON.stringify(responsePayload) to ensure automatic and correct character escaping, guaranteeing valid JSON transmission to the frontend client.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Reasoning:
The previous implementation used manual string concatenation to build the WebSocket response payload ({moduleName:..., output:...}).
This method failed to correctly escape special characters (e.g., quotes, newlines, control characters) potentially present in the 'output' data from backend modules.
This resulted in corrupted JSON strings, causing frontend clients (JavaScript's JSON.parse) to fail parsing the message, leading to "module output not found" or display errors in the UI.
Solution:
Replaced manual string concatenation with standard JSON.stringify(responsePayload) to ensure automatic and correct character escaping, guaranteeing valid JSON transmission to the frontend client.