pycodex-ws 0.3.3__tar.gz → 0.4.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. pycodex_ws-0.4.1/LICENSE +201 -0
  2. pycodex_ws-0.4.1/PKG-INFO +119 -0
  3. pycodex_ws-0.4.1/README.md +108 -0
  4. pycodex_ws-0.4.1/pycodex_router/__init__.py +1 -0
  5. pycodex_ws-0.4.1/pycodex_router/__main__.py +3 -0
  6. pycodex_ws-0.4.1/pycodex_router/browser.py +175 -0
  7. pycodex_ws-0.4.1/pycodex_router/client.py +250 -0
  8. pycodex_ws-0.4.1/pycodex_router/index.html +315 -0
  9. pycodex_ws-0.4.1/pycodex_router/protocol.py +152 -0
  10. pycodex_ws-0.4.1/pycodex_router/server.py +449 -0
  11. pycodex_ws-0.4.1/pycodex_ws/__init__.py +55 -0
  12. pycodex_ws-0.4.1/pycodex_ws/feishu_card.py +806 -0
  13. pycodex_ws-0.4.1/pycodex_ws/feishu_link.py +441 -0
  14. pycodex_ws-0.4.1/pycodex_ws/feishu_oauth.py +189 -0
  15. pycodex_ws-0.4.1/pyproject.toml +40 -0
  16. pycodex_ws-0.4.1/workspace_server/__init__.py +39 -0
  17. pycodex_ws-0.4.1/workspace_server/__main__.py +4 -0
  18. pycodex_ws-0.4.1/workspace_server/app.py +2021 -0
  19. pycodex_ws-0.4.1/workspace_server/content_views.LICENSE.txt +470 -0
  20. pycodex_ws-0.4.1/workspace_server/content_views.css +1 -0
  21. pycodex_ws-0.4.1/workspace_server/content_views.mjs +31 -0
  22. pycodex_ws-0.4.1/workspace_server/editor.css +1 -0
  23. pycodex_ws-0.4.1/workspace_server/editor.mjs +1261 -0
  24. pycodex_ws-0.4.1/workspace_server/frontend/.gitignore +1 -0
  25. pycodex_ws-0.4.1/workspace_server/frontend/build.mjs +98 -0
  26. pycodex_ws-0.4.1/workspace_server/frontend/composer.mjs +306 -0
  27. pycodex_ws-0.4.1/workspace_server/frontend/content_views.css +83 -0
  28. pycodex_ws-0.4.1/workspace_server/frontend/content_views.mjs +643 -0
  29. pycodex_ws-0.4.1/workspace_server/frontend/editor.css +62 -0
  30. pycodex_ws-0.4.1/workspace_server/frontend/editor.mjs +392 -0
  31. pycodex_ws-0.4.1/workspace_server/frontend/editor_context.mjs +51 -0
  32. pycodex_ws-0.4.1/workspace_server/frontend/package-lock.json +541 -0
  33. pycodex_ws-0.4.1/workspace_server/frontend/package.json +17 -0
  34. pycodex_ws-0.4.1/workspace_server/frontend/view_labels.mjs +50 -0
  35. pycodex_ws-0.4.1/workspace_server/owned_process.py +27 -0
  36. pycodex_ws-0.4.1/workspace_server/workspace.html +2496 -0
  37. pycodex_ws-0.4.1/workspace_server/workspace_views.py +534 -0
  38. pycodex_ws-0.4.1/workspace_server/workspaces.html +565 -0
  39. pycodex_ws-0.4.1/workspace_server/workspaces.py +598 -0
  40. pycodex_ws-0.3.3/PKG-INFO +0 -29
  41. pycodex_ws-0.3.3/README.md +0 -21
  42. pycodex_ws-0.3.3/pycodex_ws_meta/__init__.py +0 -1
  43. pycodex_ws-0.3.3/pyproject.toml +0 -16
  44. {pycodex_ws-0.3.3 → pycodex_ws-0.4.1}/.gitignore +0 -0
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2025 OpenAI
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,119 @@
1
+ Metadata-Version: 2.1
2
+ Name: pycodex-ws
3
+ Version: 0.4.1
4
+ Summary: Browser workspace and optional Feishu integration for python-codex
5
+ License-File: LICENSE
6
+ Requires-Python: >=3.7
7
+ Requires-Dist: pillow>=9.0.0
8
+ Requires-Dist: python-codex==0.4.1
9
+ Requires-Dist: websockets<16,>=11
10
+ Description-Content-Type: text/markdown
11
+
12
+ # pycodex-ws
13
+
14
+ `pycodex-ws` provides the browser workspace, Canvas and file/diff viewer,
15
+ and optional Feishu integration for
16
+ [`python-codex`](https://pypi.org/project/python-codex/). It installs the exact
17
+ matching core version.
18
+
19
+ Pillow is a direct dependency of this package for image preview validation.
20
+ Core can run without it; `view_image` then sends original image bytes.
21
+
22
+ The HTTP and WebSocket server uses Starlette and Uvicorn, provided by core,
23
+ without FastAPI, Pydantic or `pydantic-core`.
24
+
25
+ ```bash
26
+ python3 -m pip install pycodex-ws
27
+ pycodex-ws --help
28
+ ```
29
+
30
+ Requires Python 3.7 or newer. With multiple Python installations, use the
31
+ installing interpreter to launch either frontend directly:
32
+
33
+ ```bash
34
+ python3 -m workspace_server --help
35
+ python3 -m pycodex --help
36
+ ```
37
+
38
+ This distribution owns `workspace_server`, `pycodex_ws`, the frontend assets,
39
+ and the `pycodex-ws` console script. The core owns `pycodex`, `responses_server`,
40
+ the `pycodex` command and portable storage.
41
+
42
+ The [VS Code extension](extensions/vscode/README.md) lives in this package's
43
+ source directory. It starts the workspace server and uses its HTTP API.
44
+ It is built and distributed separately as a VSIX, outside both Python wheels
45
+ and source distributions.
46
+
47
+ In the browser's code and diff viewer, right-click **Insert into chat**, or
48
+ select text and click the toolbar button, to insert context into the current
49
+ conversation's draft. Context uses the full view label, including both revisions
50
+ of a diff, and identifies the selected side. It includes either selected text and
51
+ its range, or only the cursor position. Context appears as a separate block among the message
52
+ text; click a block to edit or remove it before sending.
53
+
54
+ Workspace sessions include `/link` and `/unlink` for Feishu. Python callers use
55
+ `pycodex_ws.build_runtime(agent)` for the same assembly.
56
+
57
+ The Feishu SDK is optional and is not installed automatically. To enable
58
+ `/link`, install it in the same Python environment as the workspace:
59
+
60
+ ```bash
61
+ python3 -m pip install lark-oapi
62
+ ```
63
+
64
+ `/link` checks that `lark_oapi` can be imported before creating a connection.
65
+ If it cannot, the command reports that it is unavailable and shows the manual
66
+ installation command. Other workspace features work without the SDK.
67
+
68
+ For initial Feishu user authorization, run the module included in this package:
69
+
70
+ ```bash
71
+ python3 -m pycodex_ws.feishu_oauth
72
+ ```
73
+
74
+ It reads app credentials from `~/.codex/.env` and stores the refresh token in
75
+ `~/.codex/.feishu_refresh_token` with mode `0600`. `--help` works without
76
+ credentials. In a development checkout, use
77
+ `uv run --dev python -m pycodex_ws.feishu_oauth`.
78
+
79
+ Use a filename prefix and a separate Canvas switch in `workspaces.json`:
80
+
81
+ ```json
82
+ {
83
+ "workspaces": [
84
+ {"id": "demo", "work_dir": ".", "state_path": "demo", "enable_board": true}
85
+ ]
86
+ }
87
+ ```
88
+
89
+ Start it with `pycodex-ws --workspace-config workspaces.json`.
90
+ Relative paths resolve from the configuration directory. This example uses
91
+ `demo.pycodex-ws.json` for session titles and rollout references,
92
+ `demo.pycodex-views.json` for file views, and `demo.html` for Canvas.
93
+ All suffixes are appended to the complete prefix, including any dots.
94
+ The resolved `state_path` identifies the workspace; two entries cannot share it.
95
+ Creating a workspace through the management page or API without a prefix
96
+ generates a `/tmp/pcws-*` prefix and saves it in the configuration.
97
+
98
+ `enable_board` defaults to `true`. Setting it to `false` disables the Canvas
99
+ tab, HTML/image/status routes, polling and Canvas context injection. Sessions
100
+ and file views still save and restore from the same prefix, so changing this
101
+ switch preserves their state.
102
+
103
+ Existing `board: "demo.html"` configurations load as `state_path: "demo"`.
104
+ Existing `board: false` entries use `<config-stem>.<workspace-id>` as their
105
+ prefix, preserving their session index. Loading leaves files in place; later
106
+ configuration saves write only `state_path` and `enable_board`.
107
+ Do not mix the old and new fields. For an old Canvas path with an extension
108
+ other than `.html`, rename it to `<prefix>.html` and set `state_path` explicitly.
109
+ Conversation contents remain in their original rollout files.
110
+ Malformed session state stops restoration and leaves the saved file intact.
111
+
112
+ Both packages are developed in the same repository. Run `uv sync --dev` at its
113
+ root to install both, then `uv run pycodex-ws --help`. Build this package with
114
+ `uv build packages/pycodex-ws`.
115
+
116
+ Run `uv run --dev pytest packages/pycodex-ws/tests` from the repository root for
117
+ workspace, Feishu and cross-frontend integration tests. Core tests live
118
+ in the root `tests/` directory and use the independent `test` dependency group.
119
+ `uv run --dev pytest` runs both suites; see [test documentation](../../tests/TESTS.md).
@@ -0,0 +1,108 @@
1
+ # pycodex-ws
2
+
3
+ `pycodex-ws` provides the browser workspace, Canvas and file/diff viewer,
4
+ and optional Feishu integration for
5
+ [`python-codex`](https://pypi.org/project/python-codex/). It installs the exact
6
+ matching core version.
7
+
8
+ Pillow is a direct dependency of this package for image preview validation.
9
+ Core can run without it; `view_image` then sends original image bytes.
10
+
11
+ The HTTP and WebSocket server uses Starlette and Uvicorn, provided by core,
12
+ without FastAPI, Pydantic or `pydantic-core`.
13
+
14
+ ```bash
15
+ python3 -m pip install pycodex-ws
16
+ pycodex-ws --help
17
+ ```
18
+
19
+ Requires Python 3.7 or newer. With multiple Python installations, use the
20
+ installing interpreter to launch either frontend directly:
21
+
22
+ ```bash
23
+ python3 -m workspace_server --help
24
+ python3 -m pycodex --help
25
+ ```
26
+
27
+ This distribution owns `workspace_server`, `pycodex_ws`, the frontend assets,
28
+ and the `pycodex-ws` console script. The core owns `pycodex`, `responses_server`,
29
+ the `pycodex` command and portable storage.
30
+
31
+ The [VS Code extension](extensions/vscode/README.md) lives in this package's
32
+ source directory. It starts the workspace server and uses its HTTP API.
33
+ It is built and distributed separately as a VSIX, outside both Python wheels
34
+ and source distributions.
35
+
36
+ In the browser's code and diff viewer, right-click **Insert into chat**, or
37
+ select text and click the toolbar button, to insert context into the current
38
+ conversation's draft. Context uses the full view label, including both revisions
39
+ of a diff, and identifies the selected side. It includes either selected text and
40
+ its range, or only the cursor position. Context appears as a separate block among the message
41
+ text; click a block to edit or remove it before sending.
42
+
43
+ Workspace sessions include `/link` and `/unlink` for Feishu. Python callers use
44
+ `pycodex_ws.build_runtime(agent)` for the same assembly.
45
+
46
+ The Feishu SDK is optional and is not installed automatically. To enable
47
+ `/link`, install it in the same Python environment as the workspace:
48
+
49
+ ```bash
50
+ python3 -m pip install lark-oapi
51
+ ```
52
+
53
+ `/link` checks that `lark_oapi` can be imported before creating a connection.
54
+ If it cannot, the command reports that it is unavailable and shows the manual
55
+ installation command. Other workspace features work without the SDK.
56
+
57
+ For initial Feishu user authorization, run the module included in this package:
58
+
59
+ ```bash
60
+ python3 -m pycodex_ws.feishu_oauth
61
+ ```
62
+
63
+ It reads app credentials from `~/.codex/.env` and stores the refresh token in
64
+ `~/.codex/.feishu_refresh_token` with mode `0600`. `--help` works without
65
+ credentials. In a development checkout, use
66
+ `uv run --dev python -m pycodex_ws.feishu_oauth`.
67
+
68
+ Use a filename prefix and a separate Canvas switch in `workspaces.json`:
69
+
70
+ ```json
71
+ {
72
+ "workspaces": [
73
+ {"id": "demo", "work_dir": ".", "state_path": "demo", "enable_board": true}
74
+ ]
75
+ }
76
+ ```
77
+
78
+ Start it with `pycodex-ws --workspace-config workspaces.json`.
79
+ Relative paths resolve from the configuration directory. This example uses
80
+ `demo.pycodex-ws.json` for session titles and rollout references,
81
+ `demo.pycodex-views.json` for file views, and `demo.html` for Canvas.
82
+ All suffixes are appended to the complete prefix, including any dots.
83
+ The resolved `state_path` identifies the workspace; two entries cannot share it.
84
+ Creating a workspace through the management page or API without a prefix
85
+ generates a `/tmp/pcws-*` prefix and saves it in the configuration.
86
+
87
+ `enable_board` defaults to `true`. Setting it to `false` disables the Canvas
88
+ tab, HTML/image/status routes, polling and Canvas context injection. Sessions
89
+ and file views still save and restore from the same prefix, so changing this
90
+ switch preserves their state.
91
+
92
+ Existing `board: "demo.html"` configurations load as `state_path: "demo"`.
93
+ Existing `board: false` entries use `<config-stem>.<workspace-id>` as their
94
+ prefix, preserving their session index. Loading leaves files in place; later
95
+ configuration saves write only `state_path` and `enable_board`.
96
+ Do not mix the old and new fields. For an old Canvas path with an extension
97
+ other than `.html`, rename it to `<prefix>.html` and set `state_path` explicitly.
98
+ Conversation contents remain in their original rollout files.
99
+ Malformed session state stops restoration and leaves the saved file intact.
100
+
101
+ Both packages are developed in the same repository. Run `uv sync --dev` at its
102
+ root to install both, then `uv run pycodex-ws --help`. Build this package with
103
+ `uv build packages/pycodex-ws`.
104
+
105
+ Run `uv run --dev pytest packages/pycodex-ws/tests` from the repository root for
106
+ workspace, Feishu and cross-frontend integration tests. Core tests live
107
+ in the root `tests/` directory and use the independent `test` dependency group.
108
+ `uv run --dev pytest` runs both suites; see [test documentation](../../tests/TESTS.md).
@@ -0,0 +1 @@
1
+ """Reverse connections for pycodex workspaces."""
@@ -0,0 +1,3 @@
1
+ from .server import main
2
+
3
+ raise SystemExit(main())
@@ -0,0 +1,175 @@
1
+ """Separate device origins while sharing the router's HttpOnly login."""
2
+
3
+ import ipaddress
4
+ import re
5
+ from http.cookies import SimpleCookie
6
+ from urllib.parse import urlencode, urlsplit
7
+
8
+ from starlette.exceptions import HTTPException
9
+ from starlette.requests import HTTPConnection
10
+ from starlette.responses import JSONResponse, RedirectResponse
11
+
12
+ from .protocol import route_path
13
+
14
+
15
+ def origins(connection):
16
+ try:
17
+ parsed = urlsplit("//" + connection.headers["host"])
18
+ port = parsed.port
19
+ except ValueError:
20
+ raise HTTPException(400, "Invalid router host.")
21
+ host = parsed.hostname
22
+ if (
23
+ not host
24
+ or parsed.username is not None
25
+ or parsed.password is not None
26
+ or parsed.path
27
+ or parsed.query
28
+ or parsed.fragment
29
+ ):
30
+ raise HTTPException(400, "Invalid router host.")
31
+ try:
32
+ ipaddress.ip_address(host)
33
+ except ValueError:
34
+ if len(host) > 253 or any(
35
+ not re.fullmatch(r"[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?", label)
36
+ for label in host.split(".")
37
+ ):
38
+ raise HTTPException(400, "Invalid router host.")
39
+ scheme = "https" if connection.scope["scheme"] in {"https", "wss"} else "http"
40
+ suffix = "" if port in (None, 443 if scheme == "https" else 80) else ":" + str(port)
41
+ authority = "[" + host + "]" if ":" in host else host
42
+ origin = scheme + "://" + authority + suffix
43
+ first, separator, parent = host.partition(".")
44
+ node_id = first[2:] if separator and re.fullmatch("n-[a-z2-7]{52}", first) else None
45
+ base = scheme + "://" + parent + suffix if node_id else origin
46
+ return origin, base, node_id
47
+
48
+
49
+ def device_url(connection, node_id, path):
50
+ if not re.fullmatch("[a-z2-7]{52}", node_id):
51
+ raise HTTPException(404, "Invalid device id.")
52
+ unused_origin, base, unused_node = origins(connection)
53
+ parsed = urlsplit(base)
54
+ if len("n-" + node_id + "." + parsed.hostname) > 253:
55
+ raise HTTPException(400, "Router domain is too long for device subdomains.")
56
+ try:
57
+ ipaddress.ip_address(parsed.hostname)
58
+ except ValueError:
59
+ pass
60
+ else:
61
+ raise HTTPException(
62
+ 400,
63
+ "Device isolation requires a dedicated router domain with wildcard DNS "
64
+ "and, for HTTPS, a wildcard certificate; a bare IP cannot isolate pages.",
65
+ )
66
+ return parsed.scheme + "://n-" + node_id + "." + parsed.netloc + path
67
+
68
+
69
+ class BrowserOrigins:
70
+ def __init__(self, router, admin_app, node_app):
71
+ self.router = router
72
+ self.admin_app = admin_app
73
+ self.node_app = node_app
74
+
75
+ async def __call__(self, scope, receive, send):
76
+ connection = HTTPConnection(scope)
77
+ origin, base, node_id = origins(connection)
78
+ path = route_path(scope)
79
+
80
+ async def secured_send(message):
81
+ if message["type"] == "http.response.start":
82
+ headers = []
83
+ for name, value in message["headers"]:
84
+ if name.lower() == b"set-cookie" and node_id is None:
85
+ # Only router-controlled subdomains share this cookie;
86
+ # request_scope() never forwards it to a device.
87
+ cookies = SimpleCookie()
88
+ cookies.load(value.decode("latin-1"))
89
+ if "pycodex_router_auth" in cookies:
90
+ cookie = cookies["pycodex_router_auth"]
91
+ try:
92
+ ipaddress.ip_address(connection.url.hostname)
93
+ except ValueError:
94
+ cookie["domain"] = connection.url.hostname
95
+ value = cookie.OutputString().encode("latin-1")
96
+ headers.append((name, value))
97
+ message = dict(
98
+ message,
99
+ headers=headers
100
+ + [
101
+ (b"content-security-policy", b"frame-ancestors 'self'"),
102
+ (b"x-frame-options", b"SAMEORIGIN"),
103
+ (b"x-content-type-options", b"nosniff"),
104
+ (b"referrer-policy", b"no-referrer"),
105
+ (b"permissions-policy", b"document-domain=()"),
106
+ (b"origin-agent-cluster", b"?1"),
107
+ ],
108
+ )
109
+ await send(message)
110
+
111
+ try:
112
+ if connection.client.host in self.router.blocked_ips:
113
+ raise HTTPException(
114
+ 403,
115
+ "Too many incorrect passwords. This IP is blocked "
116
+ "until the router restarts.",
117
+ )
118
+ if connection.headers.get("origin") not in (None, origin):
119
+ raise HTTPException(
120
+ 403, "Cross-origin router requests are not allowed."
121
+ )
122
+ if node_id:
123
+ prefix = "/n/" + node_id
124
+ if path != prefix and not path.startswith(prefix + "/"):
125
+ raise HTTPException(
126
+ 404, "Workspace route not found on this origin."
127
+ )
128
+ await self.node_app(scope, receive, secured_send)
129
+ else:
130
+ await self.admin_app(scope, receive, secured_send)
131
+ except HTTPException as exc:
132
+ if scope["type"] == "websocket":
133
+ await send({"type": "websocket.close", "code": 1008})
134
+ else:
135
+ await JSONResponse({"error": exc.detail}, exc.status_code)(
136
+ scope, receive, secured_send
137
+ )
138
+
139
+
140
+ async def redirect_device(scope, receive, send):
141
+ if scope["type"] != "http" or scope["method"] not in {"GET", "HEAD"}:
142
+ if scope["type"] == "websocket":
143
+ await send({"type": "websocket.close", "code": 1008})
144
+ else:
145
+ await JSONResponse({"error": "Use the device's own origin."}, 403)(
146
+ scope, receive, send
147
+ )
148
+ return
149
+ connection = HTTPConnection(scope)
150
+ target = scope.get("root_path", "") + route_path(scope)
151
+ if connection.url.query:
152
+ target += "?" + connection.url.query
153
+ await RedirectResponse(
154
+ device_url(connection, scope["path_params"]["node_id"], target), 307
155
+ )(scope, receive, send)
156
+
157
+
158
+ async def require_login(scope, receive, send):
159
+ connection = HTTPConnection(scope)
160
+ if scope["type"] == "websocket":
161
+ await send({"type": "websocket.close", "code": 1008})
162
+ elif "/api/" in route_path(scope) or scope["method"] not in {"GET", "HEAD"}:
163
+ await JSONResponse({"error": "authentication required"}, 401)(
164
+ scope, receive, send
165
+ )
166
+ else:
167
+ unused_origin, base, node_id = origins(connection)
168
+ prefix = scope.get("root_path", "")
169
+ root = prefix[: -len("/n/" + node_id)]
170
+ target = prefix + route_path(scope)
171
+ if connection.url.query:
172
+ target += "?" + connection.url.query
173
+ await RedirectResponse(
174
+ base + root + "/login?" + urlencode({"next": target}), 303
175
+ )(scope, receive, send)