Add JupyterHub deployment docs and cross-origin regression tests (issue #196)#386
Merged
blink1073 merged 3 commits intoCalysto:mainfrom Mar 15, 2026
Merged
Add JupyterHub deployment docs and cross-origin regression tests (issue #196)#386blink1073 merged 3 commits intoCalysto:mainfrom
blink1073 merged 3 commits intoCalysto:mainfrom
Conversation
Calysto#196 with Calysto#375) Adds docs/jupyterhub.md covering kernel installation, Apache/nginx reverse-proxy config, and an explanation of the Jigsaw CORS fix. Adds two unit tests that demonstrate the window.parent cross-origin issue and verify _fix_cross_origin eliminates every direct property access in favour of postMessage and embedded XML.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #386 +/- ##
=======================================
Coverage 90.79% 90.79%
=======================================
Files 51 51
Lines 2943 2943
Branches 414 414
=======================================
Hits 2672 2672
Misses 190 190
Partials 81 81 🚀 New features to boost your workflow:
|
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
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.
References
Closes #196 in combination with #375 (the code fixes already merged in #375 + this PR together fully address the issue).
Description
Adds a dedicated
docs/jupyterhub.mdpage covering MetaKernel deployment on JupyterHub and behind an Apache or nginx reverse proxy. Also adds two unit tests that demonstrate the cross-origin (window.parent) bug reported in #196 and verify the fix introduced in #375 (_fix_cross_origin) handles every affected pattern.Changes
docs/jupyterhub.md— new page covering:mod_proxy_wstunnel) and nginx reverse-proxy configuration with WebSocket supportmkdocs.yml— adds the new page to the navtests/magics/test_jigsaw_magic.py— two new offline tests:test_fix_cross_origin_jupyterhub— asserts allwindow.parent.*accesses are replaced by postMessage helpers (issue Hosting Jigsaw on Apache #196)test_fix_cross_origin_embeds_saved_xml— asserts saved workspace XML is embedded as a JS variable instead of requiring an XHRBackwards-incompatible changes
None
Testing
just test tests/magics/test_jigsaw_magic.py— all 5 tests pass, including the two new ones which run offline (no network required).AI usage