ADB proxies (#1451)

* whitelist additional commands

* spike on ADB proxy functionality

* Spike with working utterance collection via stream

* Cleanup, finalize

* Setup env variables and remove unused shell scripts

* Updates config-sandbox's REACT_APP_EXTERNAL_HOST to aria-at-app-sandbox.bocoup.com

* General cleanup of original PR

* Summary of changes:
* There'll be a need to expose the local proxy out to the internet to get a public URL for this prototype to work as it should (eg. using ngrok or similar)
* This supports having users having their own specific proxies
* Adds a field to the TestRenderer for a user to provide that public url
* Continue using the originally intended debug window on TestRenderer to be an output area that utterances can be copied from to avoid any clipboard management issues
* TODOs and many logging messages added

* Bundle ngrok into the adb-proxy build process

* Additional support for running proxy and adb on windows from built resources

* Simplify proxy auto detection

* Prefer localtunnel over ngrok to avoid unneeded account creation

* Misc

* Conditionally include ngrok and build start adb server on server script start

* Re-save proxy url on auto-detect

* Focus on copy utterances button when utterances process is completed

* Announce the clipboard copy happen

* Update android testing device section notes

* Additional feedback after selecting the open on android button

* Better sanitize of output

* Don't end start script on fatal error

* Allow waking screen if needed

* Remove unnecessary fetch to /proxy-url

* Add zip files creation to build process

* Preserve history of utterances

* Remove get-network-ip.js

* Standardize auto detect proxy status colors

* Only show Android Device Testing section when the at.key is talkback_android

---------

Co-authored-by: Howard Edwards <[email protected]>

Author: stalgiag

.eslintrc.json

@@ -32,7 +32,7 @@
     "no-console": [
       "error",
       {
-        "allow": ["warn", "error"]
+        "allow": ["warn", "error", "info"]
       }
     ],
     "no-use-before-define": ["off"],

adb-proxy/README.md

@@ -1,45 +1,79 @@
-# adb-proxy
+# ADB Proxy - Portable Executable
 
-Lightweight local proxy to be packaged and used for working with adb commands.
+This ADB proxy creates portable executables that don't require Node.js or ADB to be installed locally.
 
-## Prerequisites
+## For End Users
 
-1. [ADB Tools](https://developer.android.com/tools/releases/platform-tools) are locally available.
-2. Ensure Android device has USB Debugging enabled.
+### Quick Start
 
-## How to use
+1. **Download** the appropriate build for your platform from releases
+2. **Extract** the archive to any folder
+3. **Connect** your Android device with USB debugging enabled
+4. **Double-click** the startup script:
+   - **Windows**: `start.bat`
+   - **macOS**: `start.command`
+   - **Linux**: `start.sh`
 
-```sh
-cd adb-proxy
+The proxy will start on `http://localhost:3080`
+
+## For Developers
+
+### Building Executables
+
+```bash
+# Install dependencies
 yarn install
-yarn start
+
+# Build for specific platforms
+yarn build-windows   # Creates dist/windows/
+yarn build-linux     # Creates dist/linux/
+yarn build-macos     # Creates dist/macos/
+
+# Build for all platforms
+yarn build-all
 ```
 
-Local proxy should now be running on http://localhost:3080.
+### How It Works
 
-To confirm it works:
+The build process uses [@yao-pkg/pkg](https://github.com/yao-pkg/pkg) (maintained fork) to create standalone executables:
 
-First, connect your Android device to the computer (and allow any relevant permissions related to debugging)
+1. **pkg** bundles the Node.js application into a single executable
+2. **build-platforms.js** downloads platform-specific ADB binaries
+3. **Everything** is packaged together with startup scripts
 
-1. Run the following to display the id(s) of the currently connected Android device(s):
+### Distribution
 
-```sh
-curl -X POST http://localhost:3080/run-adb \
-     -H "Content-Type: application/json" \
-     -d '{ "command": "devices" }'
+Each platform build creates a `dist/{platform}/` directory with:
+
+```
+📁 dist/windows/          📁 dist/macos/            📁 dist/linux/
+├── 🟢 start.bat          ├── 🟢 start.command      ├── 🟢 start.sh
+├── 🔧 adb.exe            ├── 🔧 adb                ├── 🔧 adb
+├── ⚙️ adb-proxy.exe      ├── ⚙️ adb-proxy          ├── ⚙️ adb-proxy
+├── 📄 adbwinapi.dll      ├── 📄 README.txt         ├── 📄 README.txt
+├── 📄 adbwinusbapi.dll   └── 📚 USER-GUIDE.md      └── 📚 USER-GUIDE.md
+├── 📄 README.txt
+└── 📚 USER-GUIDE.md
 ```
 
-2. Observe that the connected device(s) is returned in the result.
+### File Sizes
 
-OR
+- **Windows**: ~52MB
+- **macOS**: ~75MB
+- **Linux**: ~63MB
 
-1. Navigate to the Test Queue, inspect the page and remove the `display: none` style from the last `<div>` in the `<main>`.
-1. That should reveal a 'List Devices' button. Pressing that button displays the device id(s) of the Android device(s) currently connected to the computer.
+## Development
 
-TODO:
+### Project Structure
 
-1. Whitelist the remaining adb commands currently used in the `aria-at-talkback-capture` scripts
-1. Rework the current server's `api/scripts` endpoints and the capture utterances web socket implementation to be usable by this proxy
-1. Package this proxy as a portable executable so testers won't have to install node (or adb) locally
-1. If the above cannot be easily done for adb, provide an easy way to pull and add ADB to a tester's PATH depending on platform, and easily remove afterwards
-1. Tests(?)
+```
+adb-proxy/
+├── adb-proxy.js           # Main server application
+├── capture-utterances.js  # TalkBack capture logic
+├── build-platforms.js     # Build system for all platforms
+├── package.json           # Dependencies and build scripts
+└── dist/                  # Built executables (generated)
+    ├── windows/
+    ├── linux/
+    └── macos/
+```