@stim-cli/server 1.10.1 → 1.11.0

package/dist/protocol.schema.json

@@ -28,7 +28,11 @@
             "status-failed",
             "logs-failed",
             "stim-failed",
-            "frames-failed"
+            "frames-failed",
+            "forbidden",
+            "unknown-action",
+            "action-busy",
+            "action-failed"
           ]
         },
         "message": {
@@ -104,6 +108,7 @@
         "protocol",
         "server",
         "capabilities",
+        "actions",
         "device"
       ],
       "additionalProperties": false,
@@ -116,7 +121,8 @@
           "required": [
             "name",
             "version",
-            "stim"
+            "stim",
+            "home"
           ],
           "additionalProperties": false,
           "properties": {
@@ -128,6 +134,9 @@
             },
             "stim": {
               "type": "string"
+            },
+            "home": {
+              "type": "string"
             }
           }
         },
@@ -135,7 +144,17 @@
           "type": "array",
           "items": {
             "enum": [
-              "read"
+              "read",
+              "control"
+            ]
+          }
+        },
+        "actions": {
+          "type": "array",
+          "items": {
+            "enum": [
+              "reload",
+              "stop"
             ]
           }
         },
@@ -197,7 +216,8 @@
               "metro",
               "client",
               "device",
-              "build"
+              "build",
+              "agent"
             ]
           }
         },
@@ -251,6 +271,120 @@
           "type": "string",
           "minLength": 1,
           "default": "default"
+        },
+        "fps": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 60,
+          "default": 5,
+          "description": "At most 30 unless the result offers video."
+        },
+        "maxEdge": {
+          "type": "integer",
+          "minimum": 240,
+          "maximum": 2048,
+          "default": 1280
+        },
+        "video": {
+          "type": "array",
+          "items": {
+            "enum": [
+              "h264"
+            ]
+          }
+        }
+      }
+    },
+    "ActionParams": {
+      "oneOf": [
+        {
+          "type": "object",
+          "required": [
+            "action",
+            "workspace"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "action": {
+              "const": "reload"
+            },
+            "workspace": {
+              "type": "string",
+              "description": "An environment path from a status payload."
+            },
+            "platform": {
+              "enum": [
+                "ios",
+                "android"
+              ]
+            }
+          }
+        },
+        {
+          "type": "object",
+          "required": [
+            "action",
+            "workspace"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "action": {
+              "const": "stop"
+            },
+            "workspace": {
+              "type": "string",
+              "description": "An environment path from a status payload."
+            }
+          }
+        }
+      ]
+    },
+    "ActionResult": {
+      "type": "object",
+      "required": [
+        "action",
+        "workspace",
+        "output"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "action": {
+          "enum": [
+            "reload",
+            "stop"
+          ]
+        },
+        "workspace": {
+          "type": "string"
+        },
+        "output": {
+          "type": "object",
+          "description": "The JSON the command printed."
+        }
+      }
+    },
+    "BuildPlanParams": {
+      "type": "object",
+      "required": [
+        "workspace",
+        "platform"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "workspace": {
+          "type": "string",
+          "description": "An environment path from a status payload."
+        },
+        "platform": {
+          "enum": [
+            "ios",
+            "android"
+          ]
+        },
+        "slot": {
+          "type": "string",
+          "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
+          "default": "default"
         }
       }
     },
@@ -264,6 +398,182 @@
         }
       }
     },
+    "MachineHistory": {
+      "type": "object",
+      "required": [
+        "intervalMs",
+        "samples"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "intervalMs": {
+          "type": "integer"
+        },
+        "samples": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": [
+              "at",
+              "cpu",
+              "memoryUsedBytes",
+              "memoryPressure",
+              "diskFreeBytes"
+            ],
+            "additionalProperties": false,
+            "properties": {
+              "at": {
+                "type": "integer"
+              },
+              "cpu": {
+                "type": [
+                  "number",
+                  "null"
+                ]
+              },
+              "memoryUsedBytes": {
+                "type": [
+                  "number",
+                  "null"
+                ]
+              },
+              "memoryPressure": {
+                "enum": [
+                  0,
+                  1,
+                  2,
+                  null
+                ]
+              },
+              "diskFreeBytes": {
+                "type": [
+                  "number",
+                  "null"
+                ]
+              }
+            }
+          }
+        }
+      }
+    },
+    "MachineUsage": {
+      "type": "object",
+      "required": [
+        "volumes",
+        "memory",
+        "load",
+        "cpu",
+        "sampledAt"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "volumes": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": [
+              "mount",
+              "holds",
+              "freeBytes",
+              "totalBytes"
+            ],
+            "additionalProperties": false,
+            "properties": {
+              "mount": {
+                "type": "string"
+              },
+              "holds": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "freeBytes": {
+                "type": "number"
+              },
+              "totalBytes": {
+                "type": "number"
+              }
+            }
+          }
+        },
+        "memory": {
+          "type": "object",
+          "required": [
+            "totalBytes",
+            "usedBytes",
+            "pressure"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "totalBytes": {
+              "type": "number"
+            },
+            "usedBytes": {
+              "type": [
+                "number",
+                "null"
+              ]
+            },
+            "pressure": {
+              "enum": [
+                "normal",
+                "warning",
+                "critical",
+                null
+              ]
+            }
+          }
+        },
+        "load": {
+          "type": "object",
+          "required": [
+            "avg1",
+            "avg5",
+            "avg15",
+            "cpus"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "avg1": {
+              "type": "number"
+            },
+            "avg5": {
+              "type": "number"
+            },
+            "avg15": {
+              "type": "number"
+            },
+            "cpus": {
+              "type": "integer"
+            }
+          }
+        },
+        "cpu": {
+          "type": "object",
+          "required": [
+            "usage",
+            "cores"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "usage": {
+              "type": [
+                "number",
+                "null"
+              ]
+            },
+            "cores": {
+              "type": "integer"
+            }
+          }
+        },
+        "sampledAt": {
+          "type": "string",
+          "format": "date-time"
+        }
+      }
+    },
     "ClientRequest": {
       "oneOf": [
         {
@@ -381,6 +691,112 @@
             }
           }
         },
+        {
+          "type": "object",
+          "required": [
+            "id",
+            "method",
+            "params"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "id": {
+              "type": [
+                "integer",
+                "string"
+              ]
+            },
+            "method": {
+              "const": "frames.keyframe"
+            },
+            "params": {
+              "type": "object",
+              "required": [
+                "subscription"
+              ],
+              "additionalProperties": false,
+              "properties": {
+                "subscription": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        },
+        {
+          "type": "object",
+          "required": [
+            "id",
+            "method",
+            "params"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "id": {
+              "type": [
+                "integer",
+                "string"
+              ]
+            },
+            "method": {
+              "const": "build.plan"
+            },
+            "params": {
+              "$ref": "#/$defs/BuildPlanParams"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "required": [
+            "id",
+            "method"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "id": {
+              "type": [
+                "integer",
+                "string"
+              ]
+            },
+            "method": {
+              "const": "machine.get"
+            },
+            "params": {
+              "type": "object",
+              "maxProperties": 0
+            }
+          }
+        },
+        {
+          "type": "object",
+          "required": [
+            "id",
+            "method"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "id": {
+              "type": [
+                "integer",
+                "string"
+              ]
+            },
+            "method": {
+              "const": "machine.history"
+            },
+            "params": {
+              "type": "object",
+              "additionalProperties": false,
+              "properties": {
+                "sinceMs": {
+                  "type": "number"
+                }
+              }
+            }
+          }
+        },
         {
           "type": "object",
           "required": [
@@ -456,6 +872,29 @@
               }
             }
           }
+        },
+        {
+          "type": "object",
+          "required": [
+            "id",
+            "method",
+            "params"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "id": {
+              "type": [
+                "integer",
+                "string"
+              ]
+            },
+            "method": {
+              "const": "action"
+            },
+            "params": {
+              "$ref": "#/$defs/ActionParams"
+            }
+          }
         }
       ]
     },
@@ -480,6 +919,15 @@
                 {
                   "$ref": "#/$defs/HelloResult"
                 },
+                {
+                  "$ref": "#/$defs/ActionResult"
+                },
+                {
+                  "$ref": "#/$defs/MachineUsage"
+                },
+                {
+                  "$ref": "#/$defs/MachineHistory"
+                },
                 {
                   "type": "object",
                   "required": [
@@ -489,6 +937,11 @@
                   "properties": {
                     "subscription": {
                       "type": "string"
+                    },
+                    "video": {
+                      "enum": [
+                        "h264"
+                      ]
                     }
                   }
                 },
@@ -509,7 +962,7 @@
                 },
                 {
                   "type": "object",
-                  "description": "The payload of `stim stats --json` or `stim settings --json`, or {} for unsubscribe."
+                  "description": "The payload of `stim stats --json`, `stim settings --json` or `stim ios|android --plan --json`, or {} for unsubscribe."
                 }
               ]
             }
@@ -629,6 +1082,12 @@
             "data": {
               "type": "string",
               "contentEncoding": "base64"
+            },
+            "posture": {
+              "enum": [
+                "folded",
+                "unfolded"
+              ]
             }
           }
         },

package/dist/stim-frames/EmulatorDiscovery.swift

@@ -0,0 +1,49 @@
+import Foundation
+
+/// The gRPC endpoint a running Android emulator advertises in its discovery file.
+public struct EmulatorEndpoint: Equatable, Sendable {
+  public var consolePort: Int
+  public var grpcPort: Int
+  public var token: String?
+}
+
+public enum EmulatorDiscovery {
+  // The emulator writes pid_<pid>.ini here on macOS, ignoring XDG_RUNTIME_DIR,
+  // and only when it was started with -grpc. `adb emu avd discoverypath`
+  // prints the same path.
+  static var directory: URL {
+    FileManager.default.homeDirectoryForCurrentUser
+      .appendingPathComponent("Library/Caches/TemporaryItems/avd/running", isDirectory: true)
+  }
+
+  public static func parse(_ contents: String) -> EmulatorEndpoint? {
+    var values: [Substring: Substring] = [:]
+    for line in contents.split(whereSeparator: \.isNewline) {
+      guard let separator = line.firstIndex(of: "=") else { continue }
+      values[line[..<separator]] = line[line.index(after: separator)...]
+    }
+    guard let console = values["port.serial"].flatMap({ Int($0) }),
+      let grpc = values["grpc.port"].flatMap({ Int($0) })
+    else { return nil }
+    return EmulatorEndpoint(consolePort: console, grpcPort: grpc, token: values["grpc.token"].map(String.init))
+  }
+
+  public static func consolePort(serial: String) -> Int? {
+    guard serial.hasPrefix("emulator-") else { return nil }
+    return Int(serial.dropFirst("emulator-".count))
+  }
+
+  public static func endpoint(serial: String) -> EmulatorEndpoint? {
+    guard let console = consolePort(serial: serial),
+      let names = try? FileManager.default.contentsOfDirectory(atPath: directory.path)
+    else { return nil }
+    for name in names where name.hasPrefix("pid_") && name.hasSuffix(".ini") {
+      guard let pid = Int32(name.dropFirst(4).dropLast(4)), kill(pid, 0) == 0,
+        let contents = try? String(contentsOf: directory.appendingPathComponent(name), encoding: .utf8),
+        let endpoint = parse(contents), endpoint.consolePort == console
+      else { continue }
+      return endpoint
+    }
+    return nil
+  }
+}