Skip to content

Commit e4bba1f

Browse files
committed
docs(android): state when the no-rebind refusal carries its typed reason
Name adb reverse --list as the condition in the noRebind JSDoc, and scope the Limrun docs guarantee to attached Android instances.
1 parent 588ecc6 commit e4bba1f

2 files changed

Lines changed: 5 additions & 4 deletions

File tree

‎packages/platform-android/src/adb-port-reverse.ts‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,10 @@ import type {
1717
export type AndroidExecPortReverseOptions = Readonly<{
1818
/**
1919
* Refuses to replace any existing device mapping, including one this provider created
20-
* (`adb reverse --no-rebind`), for a device that other adb clients also drive. A refusal the
21-
* device listing confirms throws `COMMAND_FAILED` with
22-
* `details.reason: 'android_port_reverse_rebind_refused'`.
20+
* (`adb reverse --no-rebind`), for a device that other adb clients also drive. When
21+
* `adb reverse --list` shows the endpoint after a refusal, the provider throws `COMMAND_FAILED`
22+
* with `details.reason: 'android_port_reverse_rebind_refused'`; otherwise it throws the adb
23+
* failure.
2324
*/
2425
noRebind?: boolean;
2526
}>;

‎website/docs/docs/limrun.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ agent-device disconnect
4141

4242
`connect` checks the instance credentials. agent-device never creates or deletes that instance: `disconnect` leaves it running, and its owner deletes it. When the variables for a platform are set, they take precedence over `LIMRUN_API_KEY` for that platform.
4343

44-
On Android, agent-device does not replace an existing port reverse mapping. If the owner already maps a device port, such as `tcp:8081` for their Metro server, a reverse to that port fails and the owner's mapping stays in place. The error has `details.reason: 'android_port_reverse_rebind_refused'` when `adb reverse --list` shows the mapping. Otherwise it is a plain ADB failure.
44+
On an attached Android instance, agent-device does not replace an existing port reverse mapping. If the owner already maps a device port, such as `tcp:8081` for their Metro server, a reverse to that port fails and the owner's mapping stays in place. The error has `details.reason: 'android_port_reverse_rebind_refused'` when `adb reverse --list` shows the mapping. Otherwise it is a plain ADB failure.
4545

4646
`install`, and `apps` before the first `open`, still need `LIMRUN_API_KEY`, because they use Limrun asset storage. After `open`, `apps` lists the apps installed on the instance without the key. Install the app before you hand over the instance. From the Node.js runtime, `getDeviceSession(device).installRemoteApp(url)` installs from a signed asset URL without the API key.
4747

0 commit comments

Comments
 (0)