Pass session_id during Websocket connect #1440

gogasca · 2024-06-29T15:33:29Z

Pass HTTP query param session_id during Websocket channel connection.
Example:

GET /api/kernels/342eba8f-aa8c-47a9-8fee-8541cee8ddfe/channels

vs

GET /api/kernels/342eba8f-aa8c-47a9-8fee-8541cee8ddfe/channels?session_id=4feb3f46-4e83-4fba-bebd-3aba95e96fc0

krassowski · 2024-06-29T15:38:37Z

jupyter_server/gateway/connections.py

@@ -47,6 +47,8 @@ async def connect(self):
            url_escape(self.kernel_id),
            "channels",
        )
+        if self.session_id:
+            ws_url += f"?session_id={self.session_id}"


Should session_id be escaped with escape_url? Also a test case would be nice :)

@krassowski thanks for the feedback, used url_escape and added a test

Added a test, but looks like Windows tests are failing for unrelated reason?

The windows tests were fixed in #1441

Thanks @blink1073 I synced to main and Windows tests work now, but now I get some coverage error. https://github.com/jupyter-server/jupyter_server/actions/runs/9821413970/job/27117179741?pr=1440 any pointers?

Error: Failed to ListArtifacts: Unable to make request: ECONNRESET If you are using self-hosted runners, please make sure your runner has access to all GitHub endpoints: https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#communication-between-self-hosted-runners-and-github

Thanks

for more information, see https://pre-commit.ci

blink1073 · 2024-07-07T00:54:56Z

I kicked the coverage test, it looks like it was a temporary connectivity issue.

gogasca · 2024-07-10T00:47:29Z

@krassowski would you mind taking another look? Thanks!

krassowski

Looks good to me. It might be worth bringing it up on the server and kernels meeting tomorrow to check for other ideas.

gogasca · 2024-07-11T23:34:12Z

@krassowski is it ok to merge? Thanks!

krassowski · 2024-07-12T10:23:58Z

It looks like @Zsailer commented during the meeting, maybe he can approve and merge (I do not have merge rights here).

Zsailer

LGTM. Thanks @gogasca!

Pinging @lresende here too, since he's most familiar with the gateways. Luciano, do you know if e.g. enterprise_gateway tracks individual kernel (ZMQ connection) sessions in any way?

Note, this is different than "sessions" from the server's sessions API, which maps documents to kernels.

The sessions we are dealing with in this PR are tracking ZMQ client sessions. This flows a unique session_id from the browser-->server-->kernel's session client (i.e. at the ZQM interface). I think (?) that JupyterLab uses this type of session_id to distinguish messages coming from the same kernel to different documents, but I'm not totally sure.

We use the word "session" in too many places 😅

gogasca · 2024-07-12T17:00:58Z

@Zsailer thanks! do you know when is the next jupyter_server release? Thanks

Zsailer · 2024-07-12T20:23:32Z

Released 😎 https://github.com/jupyter-server/jupyter_server/releases/tag/v2.14.2

* ContentsHandler return 404 rather than raise exc (jupyter-server#1357) * Add more typings (jupyter-server#1356) * Publish 2.10.1 SHA256 hashes: jupyter_server-2.10.1-py3-none-any.whl: 20519e355d951fc5e1b6ac5952854fe7620d0cfb56588fa4efe362a758977ed3 jupyter_server-2.10.1.tar.gz: e6da2657a954a7879eed28cc08e0817b01ffd81d7eab8634660397b55f926472 * Bump to 2.11.0.dev0 * typo: ServerApp (jupyter-server#1361) * Support get file(notebook) md5 (jupyter-server#1363) * Update ruff and typings (jupyter-server#1365) * Update api docs with md5 param (jupyter-server#1364) * Publish 2.11.0 SHA256 hashes: jupyter_server-2.11.0-py3-none-any.whl: c9bd6e6d71dc5a2a25df167dc323422997f14682b008bfecb5d7920a55020ea7 jupyter_server-2.11.0.tar.gz: 78c97ec8049f9062f0151725bc8a1364dfed716646a66819095e0e8a24793eba * Bump to 2.12.0.dev0 * Change md5 to hash and hash_algorithm, fix incompatibility (jupyter-server#1367) Co-authored-by: Frédéric Collonval <[email protected]> * avoid unhandled error on some invalid paths (jupyter-server#1369) * Publish 2.11.1 SHA256 hashes: jupyter_server-2.11.1-py3-none-any.whl: 4b3a16e3ed16fd202588890f10b8ca589bd3e29405d128beb95935f059441373 jupyter_server-2.11.1.tar.gz: fe80bab96493acf5f7d6cd9a1575af8fbd253dc2591aa4d015131a1e03b5799a * Bump to 2.12.0.dev0 * Merge pull request from GHSA-h56g-gq9v-vc8r Co-authored-by: Steven Silvester <[email protected]> * Publish 2.11.2 SHA256 hashes: jupyter_server-2.11.2-py3-none-any.whl: 0c548151b54bcb516ca466ec628f7f021545be137d01b5467877e87f6fff4374 jupyter_server-2.11.2.tar.gz: 0c99f9367b0f24141e527544522430176613f9249849be80504c6d2b955004bb * Bump to 2.12.0.dev0 * chore: update pre-commit hooks (jupyter-server#1370) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Steven Silvester <[email protected]> * Update for tornado 6.4 (jupyter-server#1372) * Support async Authorizers (jupyter-server#1373) * Publish 2.12.0 SHA256 hashes: jupyter_server-2.12.0-py3-none-any.whl: 3482912efa4387bb1edc23ba60531796aff3b6d6a6e93a5810f5719e2bdb48b7 jupyter_server-2.12.0.tar.gz: 9fa74ed3bb931cf33f42b3d9046e2788328ec9e6dcc59d48aa3e0910a491e3e4 * Bump to 2.13.0.dev0 * log extension import time at debug level unless it's actually slow (jupyter-server#1375) * Add support for async Authorizers (part 2) (jupyter-server#1374) * Publish 2.12.1 SHA256 hashes: jupyter_server-2.12.1-py3-none-any.whl: fd030dd7be1ca572e4598203f718df6630c12bd28a599d7f1791c4d7938e1010 jupyter_server-2.12.1.tar.gz: dc77b7dcc5fc0547acba2b2844f01798008667201eea27c6319ff9257d700a6d * Bump to 2.13.0.dev0 * Use ruff docstring-code-format (jupyter-server#1377) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * Enable htmlzip and epub on readthedocs (jupyter-server#1379) * Update pre-commit deps (jupyter-server#1380) * Fix a typo in error message (jupyter-server#1381) * Force legacy ws subprotocol when using gateway (jupyter-server#1311) Co-authored-by: Emmanuel Pignot <[email protected]> Co-authored-by: Zachary Sailer <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Zachary Sailer <[email protected]> * Publish 2.12.2 SHA256 hashes: jupyter_server-2.12.2-py3-none-any.whl: abcfa33f98a959f908c8733aa2d9fa0101d26941cbd49b148f4cef4d3046fc61 jupyter_server-2.12.2.tar.gz: 5eae86be15224b5375cdec0c3542ce72ff20f7a25297a2a8166a250bb455a519 * Bump to 2.13.0.dev0 * Fix test param for pytest-xdist (jupyter-server#1382) * Simplify the jupytext downstream test (jupyter-server#1383) * Import User unconditionally (jupyter-server#1384) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * Publish 2.12.3 SHA256 hashes: jupyter_server-2.12.3-py3-none-any.whl: 6f85310ea5e6068568a521f079fba99d8d17e4884dd1d602ab0f43b3115204a8 jupyter_server-2.12.3.tar.gz: a1d2d51e497b1a6256c48b6940b0dd49b2553981baf1690077c37792f1fa23a1 * Bump to 2.13.0.dev0 * Fix log arguments for gateway client error (jupyter-server#1385) * Publish 2.12.4 SHA256 hashes: jupyter_server-2.12.4-py3-none-any.whl: a125ae18a60de568f78f55c84dd58759901a18ef279abf0418ac220653ca1320 jupyter_server-2.12.4.tar.gz: 41f4a1e6b912cc24a7c6c694851b37d3d8412b180f43d72315fe422cb2b85cc2 * Bump to 2.13.0.dev0 * Improve warning handling (jupyter-server#1386) * Publish 2.12.5 SHA256 hashes: jupyter_server-2.12.5-py3-none-any.whl: 184a0f82809a8522777cfb6b760ab6f4b1bb398664c5860a27cec696cb884923 jupyter_server-2.12.5.tar.gz: 0edb626c94baa22809be1323f9770cf1c00a952b17097592e40d03e6a3951689 * Bump to 2.13.0.dev0 * fix "Shutdown" -> "Shut down" (jupyter-server#1389) * chore: update pre-commit hooks (jupyter-server#1390) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * websockets: add configurations for ping interval and timeout (jupyter-server#1391) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * Add deprecation note for `ServerApp.preferred_dir` (jupyter-server#1396) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * Fix color in windows log console with colorama (jupyter-server#1397) * Replace _jupyter_server_extension_paths in apidocs (jupyter-server#1393) * Add an option to have authentication enabled for all endpoints by default (jupyter-server#1392) * Update release workflows (jupyter-server#1399) * Publish 2.13.0 SHA256 hashes: jupyter_server-2.13.0-py3-none-any.whl: 77b2b49c3831fbbfbdb5048cef4350d12946191f833a24e5f83e5f8f4803e97b jupyter_server-2.13.0.tar.gz: c80bfb049ea20053c3d9641c2add4848b38073bf79f1729cea1faed32fc1c78e * Bump to 2.14.0.dev0 * Pin to Pytest 7 (jupyter-server#1401) * Update pytest requirement from <8,>=7.0 to >=7.0,<9 (jupyter-server#1402) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Don't crash on invalid JSON in page_config (jupyter-server#1403) (jupyter-server#1404) * Ignore zero-length page_config.json, restore previous behavior of crashing for invalid JSON (jupyter-server#1405) * don't include token in dashboard link, when available (jupyter-server#1406) * chore: update pre-commit hooks (jupyter-server#1409) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * Update simple extension README to cd into correct subdirectory (jupyter-server#1410) Co-authored-by: Mark Pizzutillo <[email protected]> * Set all min deps (jupyter-server#1411) * Fix jupytext and lint CI failures (jupyter-server#1413) * docs: list server extensions (jupyter-server#1412) * Link to GitHub repo from the docs (jupyter-server#1415) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * Publish 2.14.0 SHA256 hashes: jupyter_server-2.14.0-py3-none-any.whl: fb6be52c713e80e004fac34b35a0990d6d36ba06fd0a2b2ed82b899143a64210 jupyter_server-2.14.0.tar.gz: 659154cea512083434fd7c93b7fe0897af7a2fd0b9dd4749282b42eaac4ae677 * Bump to 2.15.0.dev0 * chore: update pre-commit hooks (jupyter-server#1421) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Steven Silvester <[email protected]> * Removing excessive logging from reading local files (jupyter-server#1420) Co-authored-by: Kevin Bates <[email protected]> * Use hatch fmt command (jupyter-server#1424) * Merge pull request from GHSA-hrw6-wg82-cm62 * filefind: avoid handling absolute paths we don't need or want absolute path support, which we inherited from generic ipython_genutils only supporting relative paths lets us avoid attempting to accessing files we know we won't accept * Apply suggestions from code review Co-authored-by: M Bussonnier <[email protected]> * filefind: only accept Sequence[str] we only call it one place, might as well be simple about it * version_info gate for is_relative_to * clarify docstring Co-authored-by: Carol Willing <[email protected]> --------- Co-authored-by: M Bussonnier <[email protected]> Co-authored-by: Carol Willing <[email protected]> * Publish 2.14.1 SHA256 hashes: jupyter_server-2.14.1-py3-none-any.whl: 16f7177c3a4ea8fe37784e2d31271981a812f0b2874af17339031dc3510cc2a5 jupyter_server-2.14.1.tar.gz: 12558d158ec7a0653bf96cc272bc7ad79e0127d503b982ed144399346694f726 * Bump to 2.15.0.dev0 * Update simple extension examples: _jupyter_server_extension_points (jupyter-server#1426) * chore: update pre-commit hooks (jupyter-server#1427) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Steven Silvester <[email protected]> * Add Changelog for 2.14.1 (jupyter-server#1430) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * chore: update pre-commit hooks (jupyter-server#1441) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Steven Silvester <[email protected]> * Update documentation for `cookie_secret` (jupyter-server#1433) * Do not log environment variables passed to kernels (jupyter-server#1437) * Pass session_id during Websocket connect (jupyter-server#1440) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * Publish 2.14.2 SHA256 hashes: jupyter_server-2.14.2-py3-none-any.whl: 47ff506127c2f7851a17bf4713434208fc490955d0e8632e95014a9a9afbeefd jupyter_server-2.14.2.tar.gz: 66095021aa9638ced276c248b1d81862e4c50f292d575920bbe960de1c56b12b --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Sam Bloomquist <[email protected]> Co-authored-by: Steven Silvester <[email protected]> Co-authored-by: blink1073 <[email protected]> Co-authored-by: IITII <[email protected]> Co-authored-by: Zhongsheng Ji <[email protected]> Co-authored-by: Frédéric Collonval <[email protected]> Co-authored-by: Min RK <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Zachary Sailer <[email protected]> Co-authored-by: Zsailer <[email protected]> Co-authored-by: Nicholas Bollweg <[email protected]> Co-authored-by: Michał Krassowski <[email protected]> Co-authored-by: Manu <[email protected]> Co-authored-by: Emmanuel Pignot <[email protected]> Co-authored-by: Zachary Sailer <[email protected]> Co-authored-by: Gonzalo Tornaría <[email protected]> Co-authored-by: Marc Wouts <[email protected]> Co-authored-by: Yuvi Panda <[email protected]> Co-authored-by: Alex Meiburg <[email protected]> Co-authored-by: Oliver Sanders <[email protected]> Co-authored-by: hansepac <[email protected]> Co-authored-by: Simon Li <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Burt Holzman <[email protected]> Co-authored-by: Mark <[email protected]> Co-authored-by: Mark Pizzutillo <[email protected]> Co-authored-by: Luciano Resende <[email protected]> Co-authored-by: Kevin Bates <[email protected]> Co-authored-by: M Bussonnier <[email protected]> Co-authored-by: Carol Willing <[email protected]> Co-authored-by: Steven Silvester <[email protected]> Co-authored-by: Gonzalo Gasca Meza <[email protected]>

Pass session_id during Websocket connect

bc68875

krassowski reviewed Jun 29, 2024

View reviewed changes

gogasca and others added 2 commits June 29, 2024 10:17

Add tests

ecfadec

[pre-commit.ci] auto fixes from pre-commit.com hooks

64e08f2

for more information, see https://pre-commit.ci

blink1073 added the bug label Jul 4, 2024

Merge branch 'jupyter-server:main' into pass_session_id

54e413d

gogasca requested review from krassowski and blink1073 July 7, 2024 20:44

krassowski reviewed Jul 10, 2024

View reviewed changes

Zsailer mentioned this pull request Jul 11, 2024

Meeting Notes 2024 jupyter-server/team-compass#57

Open

Zsailer approved these changes Jul 12, 2024

View reviewed changes

Zsailer merged commit b961d4e into jupyter-server:main Jul 12, 2024
36 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Pass session_id during Websocket connect #1440

Pass session_id during Websocket connect #1440

gogasca commented Jun 29, 2024

krassowski Jun 29, 2024

gogasca Jun 29, 2024 •

edited

Loading

gogasca Jul 4, 2024

blink1073 Jul 4, 2024

gogasca Jul 6, 2024 •

edited

Loading

blink1073 commented Jul 7, 2024

gogasca commented Jul 10, 2024 •

edited

Loading

krassowski left a comment

gogasca commented Jul 11, 2024

krassowski commented Jul 12, 2024

Zsailer left a comment

gogasca commented Jul 12, 2024

Zsailer commented Jul 12, 2024

Pass session_id during Websocket connect #1440

Pass session_id during Websocket connect #1440

Conversation

gogasca commented Jun 29, 2024

krassowski Jun 29, 2024

Choose a reason for hiding this comment

gogasca Jun 29, 2024 • edited Loading

Choose a reason for hiding this comment

gogasca Jul 4, 2024

Choose a reason for hiding this comment

blink1073 Jul 4, 2024

Choose a reason for hiding this comment

gogasca Jul 6, 2024 • edited Loading

Choose a reason for hiding this comment

blink1073 commented Jul 7, 2024

gogasca commented Jul 10, 2024 • edited Loading

krassowski left a comment

Choose a reason for hiding this comment

gogasca commented Jul 11, 2024

krassowski commented Jul 12, 2024

Zsailer left a comment

Choose a reason for hiding this comment

gogasca commented Jul 12, 2024

Zsailer commented Jul 12, 2024

gogasca Jun 29, 2024 •

edited

Loading

gogasca Jul 6, 2024 •

edited

Loading

gogasca commented Jul 10, 2024 •

edited

Loading