parsek-cdp-server 0.1.0__tar.gz

parsek_cdp_server-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

parsek_cdp_server-0.1.0/PKG-INFO

@@ -0,0 +1,139 @@
+Metadata-Version: 2.4
+Name: parsek-cdp-server
+Version: 0.1.0
+Summary: Parsek CDP server — launch, supervise and proxy a browser; server-side feature producers.
+Author: xa1era
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/xa1era/parsek-cdp
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: parsek-cdp~=0.1.0
+Requires-Dist: aiohttp>=3.9
+Requires-Dist: psutil>=5
+Requires-Dist: prometheus-client>=0.19
+Dynamic: license-file
+
+# parsek-cdp-server
+
+The server side of **parsek-cdp**: launching, supervising and proxying a
+browser, plus the server-side feature *producers* that digest raw CDP into
+`Parsek.*` events.
+
+A separate distribution from `parsek-cdp` (the client); installed via
+`pip install parsek-cdp[server]`. It depends on `parsek-cdp` and reuses its
+shared layers wholesale — the generated `cdp` protocol, the `core` primitives
+(`CDPConnection`, `Target`, `DataType`) and the `parsek` contract — adding only
+what must live next to the browser.
+
+> Документация на русском: [README.ru.md](README.ru.md).
+
+## Running
+
+```python
+import asyncio
+from parsek_cdp_server import ParsekServer
+from parsek_cdp.features import RequestListener
+
+
+async def main():
+    server = ParsekServer(idle_timeout=300)    # a browser self-closes after 5 min idle
+    server.register_feature(RequestListener)   # make the feature selectable via ?feature=
+    await server.start("127.0.0.1", 9333)
+    try:
+        await asyncio.Event().wait()           # keep the server alive
+    finally:
+        await server.stop()
+
+
+asyncio.run(main())
+```
+
+A client connects to this server with
+`Browser.get_distant_browser("http://127.0.0.1:9333", ...)` — the API is
+identical to a local browser (see the client README). Every `POST /browsers`
+spins up its own supervised browser; `idle_timeout` (on the server or in the
+request body) closes a browser that sits with no connection.
+
+### Where the browser comes from
+
+`launcher` finds a Chromium-compatible binary on its own. By default it walks
+the usual install paths; the `PARSEK_CHROMES_PATH` env var (directories
+separated by `os.pathsep`, like `PATH`) overrides the search — each launch picks
+a **random** one of the browsers it finds (a cheap way to spread load and
+fingerprints). An explicit path and flags go through `LaunchOptions`
+(`executable`, `headless`, `extra_args`, ...) — either on the server or
+per-request in the `POST /browsers` body.
+
+## Modules
+
+| Module | Responsibility |
+| --- | --- |
+| `launcher` | Start Chrome/Chromium, wait for the DevTools endpoint, read the browser-level websocket from `/json/version`. |
+| `supervisor` | Browser lifecycle: health, crash detection, restart, idle shutdown, and `Parsek.browserStateChanged` broadcast. |
+| `proxy` | Accept client websockets and bridge each 1:1 to a Chrome target; host feature producers and serve the `Parsek.*` surface. |
+| `metrics` | Prometheus exposition at `/metrics`. |
+| `reaper` | A separate subprocess that kills leaked (zombie/orphaned) parsek-launched Chrome processes. |
+
+## Connection model
+
+As in the client, **every target gets its own websocket** (no `sessionId`
+multiplexing). One parsing flow = one `browser_context`; pages within it each
+connect over their own websocket. The proxy bridges a page's client socket to
+the corresponding Chrome socket **1:1**.
+
+## Endpoints
+
+```
+HTTP POST /browsers                                   create a task -> browser_uuid
+HTTP GET  /metrics                                    Prometheus metrics
+ws        /cdp/{browser_uuid}/control                 browser-level pipe + Parsek.browserStateChanged
+ws        /cdp/{browser_uuid}/page/{target_id}        CDP proxy (per-page) + Parsek.*
+```
+
+The control channel is a raw pipe to the browser endpoint plus the
+`Parsek.browserStateChanged` broadcast, so a parser learns when its browser
+crashed/restarted instead of hanging; browser-level CDP (creating/disposing
+contexts, etc.) passes straight through it.
+
+## Features
+
+The server is **pure passthrough** by default (`ParsekServer` has no `features`
+argument). Feature producers are added with `register_feature(...)` and selected
+per browser with `POST /browsers?feature=<name>`. On a page pipe a producer
+digests the raw CDP burst into a couple of aggregated `Parsek.*` events and
+*suppresses* the raw events it consumed; `?raw=1` opts out of suppression.
+
+## Metrics (`GET /metrics`)
+
+| Metric | Type | What |
+| --- | --- | --- |
+| `parsek_browsers` | gauge | number of supervised browsers |
+| `parsek_targets{browser,type}` | gauge | targets per browser, by type |
+| `parsek_nested_targets{browser}` | gauge | nested targets (with a `parentId`) |
+| `parsek_browser_cpu_percent{browser}` | gauge | CPU% of the browser process tree |
+| `parsek_browser_memory_bytes{browser}` | gauge | RSS of the browser process tree |
+| `parsek_cdp_events_total{browser,target,domain}` | counter | CDP events by target and domain |
+
+Targets and CPU/RAM are sampled by a background task (polling `/json/list` +
+`psutil`), so a scrape only reads cached values and does not block the event
+loop. The event counter is labelled by target id — series for dead targets are
+pruned on every snapshot.
+
+## Zombie reaper
+
+On start the server spawns a **separate subprocess** (`reaper`) that
+periodically scans for Chrome processes we launched (recognised by the
+`--user-data-dir=…parsek-cdp-…` marker) that became zombies or orphans
+(`ppid == 1`), and kills them along with their subtree. Controlled by
+`ParsekServer(reap_zombies=..., reap_interval=...)`; it can also be run by hand:
+`python -m parsek_cdp_server.reaper --once`.
+
+## Notes
+
+The `Parsek.*` contract lives in the client distribution (`parsek_cdp.parsek`)
+and is shared by both sides.
+
+## License
+
+Apache-2.0.

parsek_cdp_server-0.1.0/README.md

@@ -0,0 +1,123 @@
+# parsek-cdp-server
+
+The server side of **parsek-cdp**: launching, supervising and proxying a
+browser, plus the server-side feature *producers* that digest raw CDP into
+`Parsek.*` events.
+
+A separate distribution from `parsek-cdp` (the client); installed via
+`pip install parsek-cdp[server]`. It depends on `parsek-cdp` and reuses its
+shared layers wholesale — the generated `cdp` protocol, the `core` primitives
+(`CDPConnection`, `Target`, `DataType`) and the `parsek` contract — adding only
+what must live next to the browser.
+
+> Документация на русском: [README.ru.md](README.ru.md).
+
+## Running
+
+```python
+import asyncio
+from parsek_cdp_server import ParsekServer
+from parsek_cdp.features import RequestListener
+
+
+async def main():
+    server = ParsekServer(idle_timeout=300)    # a browser self-closes after 5 min idle
+    server.register_feature(RequestListener)   # make the feature selectable via ?feature=
+    await server.start("127.0.0.1", 9333)
+    try:
+        await asyncio.Event().wait()           # keep the server alive
+    finally:
+        await server.stop()
+
+
+asyncio.run(main())
+```
+
+A client connects to this server with
+`Browser.get_distant_browser("http://127.0.0.1:9333", ...)` — the API is
+identical to a local browser (see the client README). Every `POST /browsers`
+spins up its own supervised browser; `idle_timeout` (on the server or in the
+request body) closes a browser that sits with no connection.
+
+### Where the browser comes from
+
+`launcher` finds a Chromium-compatible binary on its own. By default it walks
+the usual install paths; the `PARSEK_CHROMES_PATH` env var (directories
+separated by `os.pathsep`, like `PATH`) overrides the search — each launch picks
+a **random** one of the browsers it finds (a cheap way to spread load and
+fingerprints). An explicit path and flags go through `LaunchOptions`
+(`executable`, `headless`, `extra_args`, ...) — either on the server or
+per-request in the `POST /browsers` body.
+
+## Modules
+
+| Module | Responsibility |
+| --- | --- |
+| `launcher` | Start Chrome/Chromium, wait for the DevTools endpoint, read the browser-level websocket from `/json/version`. |
+| `supervisor` | Browser lifecycle: health, crash detection, restart, idle shutdown, and `Parsek.browserStateChanged` broadcast. |
+| `proxy` | Accept client websockets and bridge each 1:1 to a Chrome target; host feature producers and serve the `Parsek.*` surface. |
+| `metrics` | Prometheus exposition at `/metrics`. |
+| `reaper` | A separate subprocess that kills leaked (zombie/orphaned) parsek-launched Chrome processes. |
+
+## Connection model
+
+As in the client, **every target gets its own websocket** (no `sessionId`
+multiplexing). One parsing flow = one `browser_context`; pages within it each
+connect over their own websocket. The proxy bridges a page's client socket to
+the corresponding Chrome socket **1:1**.
+
+## Endpoints
+
+```
+HTTP POST /browsers                                   create a task -> browser_uuid
+HTTP GET  /metrics                                    Prometheus metrics
+ws        /cdp/{browser_uuid}/control                 browser-level pipe + Parsek.browserStateChanged
+ws        /cdp/{browser_uuid}/page/{target_id}        CDP proxy (per-page) + Parsek.*
+```
+
+The control channel is a raw pipe to the browser endpoint plus the
+`Parsek.browserStateChanged` broadcast, so a parser learns when its browser
+crashed/restarted instead of hanging; browser-level CDP (creating/disposing
+contexts, etc.) passes straight through it.
+
+## Features
+
+The server is **pure passthrough** by default (`ParsekServer` has no `features`
+argument). Feature producers are added with `register_feature(...)` and selected
+per browser with `POST /browsers?feature=<name>`. On a page pipe a producer
+digests the raw CDP burst into a couple of aggregated `Parsek.*` events and
+*suppresses* the raw events it consumed; `?raw=1` opts out of suppression.
+
+## Metrics (`GET /metrics`)
+
+| Metric | Type | What |
+| --- | --- | --- |
+| `parsek_browsers` | gauge | number of supervised browsers |
+| `parsek_targets{browser,type}` | gauge | targets per browser, by type |
+| `parsek_nested_targets{browser}` | gauge | nested targets (with a `parentId`) |
+| `parsek_browser_cpu_percent{browser}` | gauge | CPU% of the browser process tree |
+| `parsek_browser_memory_bytes{browser}` | gauge | RSS of the browser process tree |
+| `parsek_cdp_events_total{browser,target,domain}` | counter | CDP events by target and domain |
+
+Targets and CPU/RAM are sampled by a background task (polling `/json/list` +
+`psutil`), so a scrape only reads cached values and does not block the event
+loop. The event counter is labelled by target id — series for dead targets are
+pruned on every snapshot.
+
+## Zombie reaper
+
+On start the server spawns a **separate subprocess** (`reaper`) that
+periodically scans for Chrome processes we launched (recognised by the
+`--user-data-dir=…parsek-cdp-…` marker) that became zombies or orphans
+(`ppid == 1`), and kills them along with their subtree. Controlled by
+`ParsekServer(reap_zombies=..., reap_interval=...)`; it can also be run by hand:
+`python -m parsek_cdp_server.reaper --once`.
+
+## Notes
+
+The `Parsek.*` contract lives in the client distribution (`parsek_cdp.parsek`)
+and is shared by both sides.
+
+## License
+
+Apache-2.0.

parsek_cdp_server-0.1.0/parsek_cdp_server/__init__.py

@@ -0,0 +1,46 @@
+"""parsek-cdp-server -- the server scope: launch, supervise and proxy a browser.
+
+Separate distribution from ``parsek-cdp`` (the client); installed via
+``pip install parsek-cdp[server]``.  It *depends on* ``parsek-cdp`` and reuses
+its shared layers wholesale -- the generated ``cdp`` protocol, the ``core``
+primitives (``CDPConnection``, ``Target``, ``DataType``) and the ``parsek``
+contract -- adding only what must live next to the browser:
+
+* :mod:`~parsek_cdp_server.launcher`   -- spawn Chrome, find its websocket;
+* :mod:`~parsek_cdp_server.supervisor` -- own the browser lifecycle: health,
+  crash detection, restart, idle shutdown, and ``Parsek.browserStateChanged``
+  broadcast;
+* :mod:`~parsek_cdp_server.proxy`      -- accept client websockets and bridge
+  each one 1:1 to a Chrome target (no ``sessionId`` multiplexing, no id remap),
+  hosting feature producers on page pipes and serving the ``Parsek.*`` surface;
+* :mod:`~parsek_cdp_server.metrics`    -- Prometheus exposition at ``/metrics``
+  (browsers, targets/types, nested targets, per-target CDP events, CPU/RAM);
+* :mod:`~parsek_cdp_server.reaper`     -- a separate subprocess that kills leaked
+  (zombie/orphaned) parsek-launched Chrome processes.
+
+Feature *producers* (raw CDP -> ``Parsek.*``) are shared code shipped in the
+client distribution (:mod:`parsek_cdp.features`); the server hosts them but does
+not define them.  ``ParsekServer`` registers none by default -- it is a pure
+passthrough until features are added via ``register_feature``.
+
+Endpoints (see :mod:`~parsek_cdp_server.proxy`)::
+
+    HTTP POST /browsers                            create task -> browser_uuid
+    HTTP GET  /metrics                             Prometheus metrics
+    ws        /cdp/{browser_uuid}/control          lifecycle + Parsek.*
+    ws        /cdp/{browser_uuid}/page/{target_id} CDP proxy (per-target) + Parsek.*
+"""
+
+from __future__ import annotations
+
+from .launcher import ChromeLauncher
+from .metrics import ServerMetrics
+from .proxy import ParsekServer
+from .supervisor import BrowserSupervisor
+
+__all__ = [
+    "ParsekServer",
+    "ChromeLauncher",
+    "BrowserSupervisor",
+    "ServerMetrics",
+]