Updated WebAgg JS to check and send request over wss if using HTTPS #25039
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.
PR Summary
Added a small change to the JavaScript for the WebAgg backend. The added JavaScript code will check the protocol and updated the websocket uri to
wss:
ifhttps:
is being used.This is to fix an issue with matplotlib running behind a reverse proxy that adds HTTPS and secure HTTP headers like HSTS. The connection to the insecure websocket i.e.
ws:
is blocked by the browser with the message:PR Checklist
Documentation and Tests
Has pytest style unit tests (andN/Apytest
passes)Documentation is sphinx and numpydoc compliant (the docs should build without error).N/ANew plotting related features are documented with examples.N/ARelease Notes
New features are marked with aN/A.. versionadded::
directive in the docstring and documented indoc/users/next_whats_new/
API changes are marked with aN/A.. versionchanged::
directive in the docstring and documented indoc/api/next_api_changes/
Release notes conform with instructions inN/Anext_whats_new/README.rst
ornext_api_changes/README.rst
Not sure whether or not I need to update any documentation, so please let me know if I do.
Thank you