feat: List Pending Runners in cli (#590)

* feat: List Pending Runners in cli

* Make RunnerInfo State an enum

* Bump isolate_proto maximum version

* Correctly set isolate_proto minumum version

* check only running runners in test_kill_runner

Author: Warlord-K

projects/fal/pyproject.toml

@@ -23,7 +23,7 @@ readme = "README.md"
 requires-python = ">=3.8"
 dependencies = [
     "isolate[build]>=0.18.0,<0.19.0",
-    "isolate-proto>=0.10.2,<0.11.0",
+    "isolate-proto>=0.11.0,<0.12.0",
     "grpcio>=1.64.0,<2",
     "dill==0.3.7",
     "cloudpickle==3.0.0",

projects/fal/src/fal/cli/apps.py

@@ -5,6 +5,7 @@
 from typing import TYPE_CHECKING
 
 import fal.cli.runners as runners
+from fal.sdk import RunnerState
 
 from ._utils import get_client
 from .parser import FalClientParser
@@ -298,7 +299,11 @@ def _runners(args):
         alias_runners = connection.list_alias_runners(alias=args.app_name)
 
     runners_table = runners.runners_table(alias_runners)
-    args.console.print(f"Runners: {len(alias_runners)}")
+    pending_runners = [
+        runner for runner in alias_runners if runner.state == RunnerState.PENDING
+    ]
+    args.console.print(f"Runners: {len(alias_runners) - len(pending_runners)}")
+    args.console.print(f"Pending Runners: {len(pending_runners)}")
     # Drop the alias column, which is the first column
     runners_table.columns.pop(0)
     args.console.print(runners_table)

projects/fal/src/fal/cli/runners.py

@@ -2,7 +2,7 @@
 
 from typing import List
 
-from fal.sdk import RunnerInfo
+from fal.sdk import RunnerInfo, RunnerState
 
 from ._utils import get_client
 from .parser import FalClientParser
@@ -19,6 +19,7 @@ def runners_table(runners: List[RunnerInfo]):
     table.add_column("Expires In")
     table.add_column("Uptime")
     table.add_column("Revision")
+    table.add_column("State")
 
     for runner in runners:
         external_metadata = runner.external_metadata
@@ -45,6 +46,7 @@ def runners_table(runners: List[RunnerInfo]):
             ),
             f"{runner.uptime} ({runner.uptime.total_seconds()}s)",
             runner.revision,
+            runner.state.value,
         )
 
     return table
@@ -82,7 +84,11 @@ def _list(args):
     client = get_client(args.host, args.team)
     with client.connect() as connection:
         runners = connection.list_runners()
-        args.console.print(f"Runners: {len(runners)}")
+        pending_runners = [
+            runner for runner in runners if runner.state == RunnerState.PENDING
+        ]
+        args.console.print(f"Runners: {len(runners) - len(pending_runners)}")
+        args.console.print(f"Pending Runners: {len(pending_runners)}")
         args.console.print(runners_table(runners))
 
         requests_table = runners_requests_table(runners)

projects/fal/src/fal/sdk.py

@@ -261,6 +261,21 @@ class AliasInfo:
     valid_regions: list[str]
 
 
+class RunnerState(Enum):
+    RUNNING = "running"
+    PENDING = "pending"
+    UNKNOWN = "unknown"
+
+    @staticmethod
+    def from_proto(proto: isolate_proto.RunnerInfo.State) -> RunnerState:
+        if proto is isolate_proto.RunnerInfo.State.RUNNING:
+            return RunnerState.RUNNING
+        elif proto is isolate_proto.RunnerInfo.State.PENDING:
+            return RunnerState.PENDING
+        else:
+            return RunnerState.UNKNOWN
+
+
 @dataclass
 class RunnerInfo:
     runner_id: str
@@ -270,6 +285,7 @@ class RunnerInfo:
     external_metadata: dict[str, Any]
     revision: str
     alias: str
+    state: RunnerState
 
 
 @dataclass
@@ -421,6 +437,7 @@ def _from_grpc_runner_info(message: isolate_proto.RunnerInfo) -> RunnerInfo:
         external_metadata=external_metadata,
         revision=message.revision,
         alias=message.alias,
+        state=RunnerState.from_proto(message.state),
     )
 
 
@@ -769,7 +786,7 @@ def list_aliases(self) -> list[AliasInfo]:
         return [from_grpc(alias) for alias in response.aliases]
 
     def list_alias_runners(self, alias: str) -> list[RunnerInfo]:
-        request = isolate_proto.ListAliasRunnersRequest(alias=alias)
+        request = isolate_proto.ListAliasRunnersRequest(alias=alias, list_pending=True)
         response = self.stub.ListAliasRunners(request)
         return [from_grpc(runner) for runner in response.runners]
 
@@ -797,6 +814,6 @@ def kill_runner(self, runner_id: str) -> None:
         self.stub.KillRunner(request)
 
     def list_runners(self) -> list[RunnerInfo]:
-        request = isolate_proto.ListRunnersRequest()
+        request = isolate_proto.ListRunnersRequest(list_pending=True)
         response = self.stub.ListRunners(request)
         return [from_grpc(runner) for runner in response.runners]

projects/fal/tests/test_apps.py

@@ -1015,7 +1015,8 @@ def test_kill_runner(host: api.FalServerlessHost, test_sleep_app: str):
         client.kill_runner(runners[0].runner_id)
 
         runners = client.list_alias_runners(app_alias)
-        assert len(runners) == 0
+        num_runners = len([runner for runner in runners if runner.state == "running"])
+        assert num_runners == 0
 
 
 def test_container_app_client(test_container_app: str):