portholejs 0.1.0 → 0.2.0

package/LICENSE

@@ -0,0 +1,186 @@
+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.

package/README.md

@@ -0,0 +1,285 @@
+# Porthole
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/giolaq/porthole/main/assets/porthole-logo.png" alt="Porthole logo" width="220">
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/portholejs"><img src="https://img.shields.io/npm/v/portholejs" alt="npm version"></a>
+  <a href="https://github.com/giolaq/porthole/actions/workflows/ci.yml"><img src="https://github.com/giolaq/porthole/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
+  <a href="https://github.com/giolaq/porthole/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/portholejs" alt="license"></a>
+  <a href="https://www.npmjs.com/package/portholejs"><img src="https://img.shields.io/node/v/portholejs" alt="node"></a>
+</p>
+
+A window into your Android emulator — `npx portholejs`.
+
+Porthole boots or attaches to Android phone and TV AVDs, streams them to a browser,
+and forwards touch, keyboard, D-pad remote, screenshots, logcat, and file drops
+through one local tool. It is the Android sibling of
+[serve-sim](https://github.com/EvanBacon/serve-sim).
+
+## Quick Start
+
+Prerequisites:
+
+- Node.js 20 or newer
+- Android Studio or Android SDK command line tools
+- `emulator` and `adb` installed under the SDK
+- Chrome, Edge, or another browser with WebCodecs for H.264 playback
+
+Porthole finds the SDK from `ANDROID_HOME`, then `ANDROID_SDK_ROOT`, then the
+platform defaults:
+
+- macOS: `~/Library/Android/sdk`
+- Linux: `~/Android/Sdk`
+- Windows: `%LOCALAPPDATA%\Android\Sdk`
+
+```sh
+npx portholejs
+```
+
+With no running emulator, Porthole prompts for an AVD. To boot a specific AVD:
+
+### The scrcpy-server component
+
+Porthole mirrors and controls the emulator by speaking the
+[scrcpy](https://github.com/Genymobile/scrcpy) protocol. At runtime it pushes a
+small server jar (`scrcpy-server`, Apache-2.0, by Genymobile) to the emulator
+over adb and connects to its video and control sockets — no scrcpy CLI or
+native binary is involved.
+
+The jar is **not** bundled in this repository or in the npm package. It is
+downloaded automatically during `npm install` (a `postinstall` step) from the
+official Genymobile/scrcpy GitHub release, pinned to **v3.1** and verified
+against a SHA-256 checksum. If the download was skipped (for example, an
+offline install), fetch it later with:
+
+```sh
+node node_modules/portholejs/scripts/download-scrcpy-server.mjs
+```
+
+`porthole doctor` reports whether the jar is present. To bump the pinned
+version, update `SCRCPY_VERSION` and `SCRCPY_SHA256` in
+`scripts/download-scrcpy-server.mjs` and keep the engine's scrcpy options class
+in sync (see `src/engine/scrcpy-engine.ts`).
+
+```sh
+npx portholejs start Pixel_8_Pro_API_34
+npx portholejs start Pixel_8_Pro_API_34 Television_1080p_API_34
+```
+
+For a headless agent workflow:
+
+```sh
+npx portholejs start Android_TV_1080p --detach -q
+npx portholejs remote dpad_down
+npx portholejs screenshot -q
+npx portholejs kill -q
+```
+
+## Things to try
+
+Test a TV app **without touching a remote**: `porthole focus-on "Library"
+--select` walks the D-pad focus to any element by its text and presses OK —
+then `porthole focused -q` tells you exactly where leanback focus landed, as
+JSON. Record a bug repro as a real video with
+`porthole record repro.mp4 --duration 30s` while you swipe, scroll, and
+long-press the phone from the CLI (`porthole scroll down`,
+`porthole swipe 0.5 0.05 0.5 0.7` opens the notification shade). Catch visual
+regressions in one line: save a baseline with `porthole screenshot -o good.png`,
+then `porthole assert-screen good.png --threshold 0.02` exits non-zero and
+writes a diff image the moment the screen drifts. Stream a **phone and a TV
+side by side** from one command — `porthole start Pixel_8 Tv_1080p` puts both
+in the same browser tab with a device picker. And the whole loop works with no
+human at all: add the MCP server to Claude Code (below) and ask it to _"open
+my app on the TV emulator, navigate to Settings, and check nothing crashed"_ —
+it will drive the D-pad, read the UI as JSON (`dump_ui`), and pull
+`get_crashes` on its own. If anything misbehaves, `porthole doctor` diagnoses
+your setup in seconds.
+
+## CLI Reference
+
+| Command                              | Purpose                                             |
+| ------------------------------------ | --------------------------------------------------- |
+| `porthole start [avd...]`            | Boot or attach one or more emulators and serve them |
+| `porthole list`                      | List AVDs, running emulators, and known sessions    |
+| `porthole kill [avd]`                | Stop emulators Porthole booted and detached servers |
+| `porthole tap <x> <y>`               | Touch normalized phone coordinates from `0..1`      |
+| `porthole swipe <x1> <y1> <x2> <y2>` | Swipe between normalized phone coordinates          |
+| `porthole longpress <x> <y>`         | Long-press normalized phone coordinates             |
+| `porthole scroll <direction>`        | Scroll phone content up, down, left, or right       |
+| `porthole key <keycode>`             | Send an Android keycode down/up pair                |
+| `porthole remote <button>`           | Press a TV D-pad/media button                       |
+| `porthole text "<string>"`           | Type text into the active session                   |
+| `porthole screenshot [-o file.png]`  | Save a PNG screenshot                               |
+| `porthole assert-screen <png>`       | Compare the current screen with a PNG baseline      |
+| `porthole record <out.mp4>`          | Record the current H.264 stream to MP4              |
+| `porthole focused`                   | Print the currently focused UI node                 |
+| `porthole focus-on <text>`           | Move TV D-pad focus to matching text                |
+| `porthole dump-ui [--filter text]`   | Dump the Android UI hierarchy                       |
+| `porthole wait-for <text>`           | Wait until UI text appears                          |
+| `porthole open-url <url>`            | Open a URL or Android deep link                     |
+| `porthole stop-app <package>`        | Force-stop an app                                   |
+| `porthole clear-app <package>`       | Clear app data                                      |
+| `porthole rotate <orientation>`      | Rotate a phone emulator                             |
+| `porthole emu <args...>`             | Pass through to `adb emu`                           |
+| `porthole doctor`                    | Diagnose Node/SDK/adb/AVD/session problems          |
+| `porthole mcp`                       | Run the MCP server over stdio                       |
+
+Common options:
+
+| Option                  | Meaning                                                 |
+| ----------------------- | ------------------------------------------------------- |
+| `-p, --port <port>`     | Preview/control port, default `3200`                    |
+| `-d, --device <serial>` | Target a running emulator serial; comma-list on `start` |
+| `--host <host>`         | Bind address, default `127.0.0.1`                       |
+| `--no-preview`          | Do not open the browser automatically                   |
+| `--detach`              | Start the preview server in the background              |
+| `--mjpeg`               | Force MJPEG screenshot polling                          |
+| `-q, --quiet`           | Emit one JSON object/array on stdout                    |
+| `--max-size <px>`       | Maximum scrcpy stream dimension                         |
+| `--max-fps <fps>`       | Maximum scrcpy FPS                                      |
+| `--bitrate <bps>`       | Scrcpy video bitrate                                    |
+| `--wipe-data`           | Wipe emulator data before boot                          |
+| `--no-snapshot`         | Disable loading/saving emulator snapshots               |
+| `--cold-boot`           | Alias for `--no-snapshot`                               |
+| `--gpu <mode>`          | Pass emulator GPU mode                                  |
+| `--keep-alive`          | Leave a Porthole-booted emulator running on exit        |
+
+Quiet schemas are intentionally simple: `list -q` returns
+`{ "devices": [...], "sessions": [...] }`; single-device `start --detach -q`
+returns the session record with `url`, `pid`, `serial`, `avdName`, `port`, and
+`profile`; multi-device detached starts return `{ "sessions": [...] }`; input
+commands return `{ "ok": true, "session": ... }`; `screenshot -q` returns
+`{ "ok": true, "path": "...", "session": ... }`. Pass `-d <serial>` to
+port-scoped commands when a server is streaming more than one emulator.
+
+## MCP Setup
+
+`.mcp.json`:
+
+```json
+{
+  "mcpServers": {
+    "porthole": {
+      "command": "npx",
+      "args": ["portholejs", "mcp"]
+    }
+  }
+}
+```
+
+Claude Code:
+
+```sh
+claude mcp add porthole -- npx portholejs mcp
+```
+
+Useful MCP tools: `list_devices`, `boot_device`, `wait_for_boot`,
+`attach_device`, `tap`, `swipe`, `long_press`, `scroll`, `key`, `remote`,
+`type_text`, `screenshot`, `assert_screen`, `start_recording`, `stop_recording`,
+`dump_ui`, `get_focused`, `focus_on`, `find_element`, `wait_for`, `open_url`,
+`stop_app`, `clear_app`, `get_crashes`, `read_logcat`, and `install_apk`.
+
+## Agent Skill
+
+Porthole ships an agent skill (`skills/porthole/`) that teaches agents the full workflow: doctor triage,
+boot/attach, semantic UI assertions, TV navigation, and cleanup.
+
+Install it by copying the skill directory into your skills folder — for the
+current project:
+
+```sh
+mkdir -p .claude/skills
+cp -r node_modules/portholejs/skills/porthole .claude/skills/
+```
+
+or for all your projects:
+
+```sh
+mkdir -p ~/.claude/skills
+cp -r node_modules/portholejs/skills/porthole ~/.claude/skills/
+```
+
+From a clone of this repository, copy `skills/porthole` instead. Claude Code
+picks the skill up automatically; ask it to "test my app on the Android
+emulator" and it will follow the Porthole workflow.
+
+## GitHub Action
+
+Porthole ships an in-repo GitHub Action for CI smoke tests. It wraps
+`reactivecircus/android-emulator-runner`, starts `npx --yes portholejs` against
+the booted emulator, and runs your script while the emulator is alive.
+
+```yaml
+jobs:
+  tv-smoke:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - id: porthole
+        uses: giolaq/porthole@main
+        with:
+          avd-name: porthole-tv
+          api-level: "35"
+          profile: tv
+          script: |
+            mkdir -p artifacts
+            "$PORTHOLE_CLI" focus-on "Library" --select -q -p "$PORTHOLE_PORT"
+            "$PORTHOLE_CLI" screenshot -o artifacts/library.png -q -p "$PORTHOLE_PORT"
+```
+
+The action exposes `url`, `serial`, and `port` outputs, and also sets
+`PORTHOLE_URL`, `PORTHOLE_SERIAL`, `PORTHOLE_PORT`, and `PORTHOLE_CLI` for the
+smoke script. See `docs/github-action-example.yml` for a fuller `focus-on` /
+`assert-screen` workflow that uploads screenshot artifacts on failure.
+
+## Browser UI
+
+The preview shows device tabs, stream status, screenshots, copy-to-clipboard,
+stream stats, logcat, drag-and-drop APK install/file push, phone hardware keys,
+and a TV D-pad remote. Switching tabs re-subscribes to that device's stream
+without reloading the page. TV sessions reject touch input server-side.
+
+Video uses WebCodecs by default. Browsers without `VideoDecoder` automatically
+fall back to `/stream.mjpeg`, and `--mjpeg` or `?video=mjpeg` forces that mode.
+MJPEG is implemented with shared `adb screencap` polling at roughly 3 fps,
+re-encoded server-side to downscaled JPEG (pure JS, max 800 px) to keep
+per-frame payloads small; it is a compatibility fallback, not a
+high-frame-rate stream.
+
+When serving on a LAN with `--host 0.0.0.0`, Porthole prints a tokenized URL.
+Non-local requests must present that token.
+
+Two capability notes:
+
+- `porthole emu` / `POST /api/emu` is a raw passthrough to the emulator
+  console (`adb emu`) — including commands like `kill`. Treat it as
+  operator-level access; anyone who can reach the (token-protected) API can
+  use it.
+- `porthole focused` / `get_focused` reads D-pad focus, which is a TV/leanback
+  concept. On phone profiles it usually returns `null` unless a view holds
+  keyboard focus — that is expected, not an error.
+
+## Troubleshooting
+
+| Problem                       | Fix                                                                         |
+| ----------------------------- | --------------------------------------------------------------------------- |
+| SDK not found                 | Set `ANDROID_HOME` or `ANDROID_SDK_ROOT` to your Android SDK                |
+| `adb devices` shows `offline` | Porthole runs `adb reconnect offline`; if it persists, restart the emulator |
+| Port `3200` is taken          | Pass `-p 3201` or another free port                                         |
+| Blank video                   | Use a WebCodecs-capable browser and check DevTools for decoder errors       |
+| TV taps do nothing            | Use `porthole remote <button>`; TV profiles reject touch                    |
+
+## Development
+
+```sh
+npm install
+npm run build
+npm run test
+npm run lint
+npm run typecheck
+```
+
+Integration tests that require a booted emulator are gated behind
+`PORTHOLE_EMU=1`.