outerbounds 0.3.109rc1__py3-none-any.whl → 0.3.111__py3-none-any.whl

outerbounds/command_groups/apps_cli.py

@@ -1,15 +1,16 @@
-import json
 import os
 from os import path
 from outerbounds._vendor import click
 import requests
+import time
+import random
 
 from ..utils import metaflowconfig
-from ..utils.schema import (
-    CommandStatus,
-    OuterboundsCommandResponse,
-    OuterboundsCommandStatus,
-)
+
+APP_READY_POLL_TIMEOUT_SECONDS = 300
+# Even after our backend validates that the app routes are ready, it takes a few seconds for
+# the app to be accessible via the browser. Till we hunt down this delay, add an extra buffer.
+APP_READY_EXTRA_BUFFER_SECONDS = 30
 
 
 @click.group()
@@ -48,14 +49,7 @@ def app(**kwargs):
     help="Name of your app",
     type=str,
 )
-@click.option(
-    "-o",
-    "--output",
-    default="",
-    help="Show output in the specified format.",
-    type=click.Choice(["json", ""]),
-)
-def start(config_dir=None, profile=None, port=-1, name="", output=""):
+def start(config_dir=None, profile=None, port=-1, name=""):
     if len(name) == 0 or len(name) >= 20:
         click.secho(
             "App name should not be more than 20 characters long.",
@@ -71,49 +65,16 @@ def start(config_dir=None, profile=None, port=-1, name="", output=""):
         )
         return
 
-    start_app_response = OuterboundsCommandResponse()
-
-    validate_workstation_step = CommandStatus(
-        "ValidateRunningOnWorkstation",
-        OuterboundsCommandStatus.OK,
-        "Command is being run on a workstation.",
-    )
-
-    list_workstations_step = CommandStatus(
-        "ListWorkstations",
-        OuterboundsCommandStatus.OK,
-        "List of workstations fetched.",
-    )
-
-    validate_request = CommandStatus(
-        "ValidateRequest",
-        OuterboundsCommandStatus.OK,
-        "Start app request is valid.",
-    )
-
-    start_app_step = CommandStatus(
-        "StartApp",
-        OuterboundsCommandStatus.OK,
-        f"App {name} started on port {port}!",
-    )
-
     if "WORKSTATION_ID" not in os.environ:
-        validate_workstation_step.update(
-            OuterboundsCommandStatus.FAIL,
-            "All outerbounds app commands can only be run from a workstation.",
-            "",
-        )
-        start_app_response.add_step(validate_workstation_step)
         click.secho(
             "All outerbounds app commands can only be run from a workstation.",
             fg="red",
             err=True,
         )
-
-        if output == "json":
-            click.echo(json.dumps(start_app_response.as_dict(), indent=4))
         return
 
+    workstation_id = os.environ["WORKSTATION_ID"]
+
     try:
         try:
             metaflow_token = metaflowconfig.get_metaflow_token_from_config(
@@ -127,15 +88,8 @@ def start(config_dir=None, profile=None, port=-1, name="", output=""):
                 f"{api_url}/v1/workstations", headers={"x-api-key": metaflow_token}
             )
             workstations_response.raise_for_status()
-            start_app_response.add_step(list_workstations_step)
         except:
             click.secho("Failed to list workstations!", fg="red", err=True)
-            list_workstations_step.update(
-                OuterboundsCommandStatus.FAIL, "Failed to list workstations!", ""
-            )
-            start_app_response.add_step(list_workstations_step)
-            if output == "json":
-                click.echo(json.dumps(start_app_response.as_dict(), indent=4))
             return
 
         workstations_json = workstations_response.json()["workstations"]
@@ -148,20 +102,8 @@ def start(config_dir=None, profile=None, port=-1, name="", output=""):
                         )
                     except ValueError as e:
                         click.secho(str(e), fg="red", err=True)
-                        validate_request.update(
-                            OuterboundsCommandStatus.FAIL,
-                            str(e),
-                            "",
-                        )
-                        start_app_response.add_step(validate_request)
-                        if output == "json":
-                            click.echo(
-                                json.dumps(start_app_response.as_dict(), indent=4)
-                            )
                         return
 
-                    start_app_response.add_step(validate_request)
-
                     for named_port in workstation["spec"]["named_ports"]:
                         if int(named_port["port"]) == port:
                             if named_port["enabled"] and named_port["name"] == name:
@@ -171,22 +113,15 @@ def start(config_dir=None, profile=None, port=-1, name="", output=""):
                                     err=True,
                                 )
                                 click.secho(
-                                    f"App URL: {api_url.replace('api', 'ui')}/apps/{os.environ['WORKSTATION_ID']}/{name}/",
+                                    f"App URL: {api_url.replace('api', 'ui')}/apps/{workstation_id}/{name}/",
                                     fg="green",
                                     err=True,
                                 )
-                                start_app_response.add_step(start_app_step)
-                                if output == "json":
-                                    click.echo(
-                                        json.dumps(
-                                            start_app_response.as_dict(), indent=4
-                                        )
-                                    )
                                 return
                             else:
                                 try:
                                     response = requests.put(
-                                        f"{api_url}/v1/workstations/update/{os.environ['WORKSTATION_ID']}/namedports",
+                                        f"{api_url}/v1/workstations/update/{workstation_id}/namedports",
                                         headers={"x-api-key": metaflow_token},
                                         json={
                                             "port": port,
@@ -196,46 +131,40 @@ def start(config_dir=None, profile=None, port=-1, name="", output=""):
                                     )
 
                                     response.raise_for_status()
-                                    click.secho(
-                                        f"App {name} started on port {port}!",
-                                        fg="green",
-                                        err=True,
-                                    )
-                                    click.secho(
-                                        f"App URL: {api_url.replace('api', 'ui')}/apps/{os.environ['WORKSTATION_ID']}/{name}/",
-                                        fg="green",
-                                        err=True,
+                                    poll_success = wait_for_app_port_to_be_accessible(
+                                        api_url,
+                                        metaflow_token,
+                                        workstation_id,
+                                        name,
+                                        APP_READY_POLL_TIMEOUT_SECONDS,
                                     )
+                                    if poll_success:
+                                        click.secho(
+                                            f"App {name} started on port {port}!",
+                                            fg="green",
+                                            err=True,
+                                        )
+                                        click.secho(
+                                            f"App URL: {api_url.replace('api', 'ui')}/apps/{os.environ['WORKSTATION_ID']}/{name}/",
+                                            fg="green",
+                                            err=True,
+                                        )
+                                    else:
+                                        click.secho(
+                                            f"The app could not be deployed in {APP_READY_POLL_TIMEOUT_SECONDS / 60} minutes. Please try again later.",
+                                            fg="red",
+                                            err=True,
+                                        )
+                                        return
                                 except Exception:
                                     click.secho(
                                         f"Failed to start app {name} on port {port}!",
                                         fg="red",
                                         err=True,
                                     )
-                                    start_app_step.update(
-                                        OuterboundsCommandStatus.FAIL,
-                                        f"Failed to start app {name} on port {port}!",
-                                        "",
-                                    )
-
-                                start_app_response.add_step(start_app_step)
-                                if output == "json":
-                                    click.echo(
-                                        json.dumps(
-                                            start_app_response.as_dict(), indent=4
-                                        )
-                                    )
                                 return
     except Exception as e:
         click.secho(f"Failed to start app {name} on port {port}!", fg="red", err=True)
-        start_app_step.update(
-            OuterboundsCommandStatus.FAIL,
-            f"Failed to start app {name} on port {port}!",
-            "",
-        )
-        start_app_response.add_step(start_app_step)
-        if output == "json":
-            click.secho(json.dumps(start_app_response.as_dict(), indent=4))
 
 
 @app.command(help="Stop an app using its port number")
@@ -266,14 +195,7 @@ def start(config_dir=None, profile=None, port=-1, name="", output=""):
     default="",
     type=str,
 )
-@click.option(
-    "-o",
-    "--output",
-    default="",
-    help="Show output in the specified format.",
-    type=click.Choice(["json", ""]),
-)
-def stop(config_dir=None, profile=None, port=-1, name="", output=""):
+def stop(config_dir=None, profile=None, port=-1, name=""):
     if port == -1 and not name:
         click.secho(
             "Please provide either a port number or a name to stop the app.",
@@ -289,47 +211,13 @@ def stop(config_dir=None, profile=None, port=-1, name="", output=""):
         )
         return
 
-    stop_app_response = OuterboundsCommandResponse()
-
-    validate_workstation_step = CommandStatus(
-        "ValidateRunningOnWorkstation",
-        OuterboundsCommandStatus.OK,
-        "Command is being run on a workstation.",
-    )
-
-    list_workstations_step = CommandStatus(
-        "ListWorkstations",
-        OuterboundsCommandStatus.OK,
-        "List of workstations fetched.",
-    )
-
-    validate_port_exists = CommandStatus(
-        "ValidatePortExists",
-        OuterboundsCommandStatus.OK,
-        "Port exists on workstation",
-    )
-
-    stop_app_step = CommandStatus(
-        "StopApp",
-        OuterboundsCommandStatus.OK,
-        f"App stopped on port {port}!",
-    )
-
     if "WORKSTATION_ID" not in os.environ:
-        validate_workstation_step.update(
-            OuterboundsCommandStatus.FAIL,
-            "All outerbounds app commands can only be run from a workstation.",
-            "",
-        )
-        stop_app_response.add_step(validate_workstation_step)
         click.secho(
             "All outerbounds app commands can only be run from a workstation.",
             fg="red",
             err=True,
         )
 
-        if output == "json":
-            click.echo(json.dumps(stop_app_response.as_dict(), indent=4))
         return
 
     try:
@@ -345,15 +233,8 @@ def stop(config_dir=None, profile=None, port=-1, name="", output=""):
                 f"{api_url}/v1/workstations", headers={"x-api-key": metaflow_token}
             )
             workstations_response.raise_for_status()
-            stop_app_response.add_step(list_workstations_step)
         except:
             click.secho("Failed to list workstations!", fg="red", err=True)
-            list_workstations_step.update(
-                OuterboundsCommandStatus.FAIL, "Failed to list workstations!", ""
-            )
-            stop_app_response.add_step(list_workstations_step)
-            if output == "json":
-                click.echo(json.dumps(stop_app_response.as_dict(), indent=4))
             return
 
         app_found = False
@@ -367,7 +248,6 @@ def stop(config_dir=None, profile=None, port=-1, name="", output=""):
                             or named_port["name"] == name
                         ):
                             app_found = True
-                            stop_app_response.add_step(validate_port_exists)
                             if named_port["enabled"]:
                                 try:
                                     response = requests.put(
@@ -391,19 +271,6 @@ def stop(config_dir=None, profile=None, port=-1, name="", output=""):
                                         fg="red",
                                         err=True,
                                     )
-                                    stop_app_step.update(
-                                        OuterboundsCommandStatus.FAIL,
-                                        f"Failed to stop app {named_port['name']} on port {named_port['port']}!",
-                                        "",
-                                    )
-
-                                stop_app_response.add_step(stop_app_step)
-                                if output == "json":
-                                    click.echo(
-                                        json.dumps(
-                                            stop_app_response.as_dict(), indent=4
-                                        )
-                                    )
                                 return
 
         if app_found:
@@ -417,9 +284,6 @@ def stop(config_dir=None, profile=None, port=-1, name="", output=""):
                 fg="green",
                 err=True,
             )
-            stop_app_response.add_step(stop_app_step)
-            if output == "json":
-                click.echo(json.dumps(stop_app_response.as_dict(), indent=4))
             return
 
         err_message = (
@@ -433,26 +297,11 @@ def stop(config_dir=None, profile=None, port=-1, name="", output=""):
             fg="red",
             err=True,
         )
-
-        validate_port_exists.update(
-            OuterboundsCommandStatus.FAIL,
-            err_message,
-            "",
-        )
-        stop_app_response.add_step(validate_port_exists)
-        if output == "json":
-            click.echo(json.dumps(stop_app_response.as_dict(), indent=4))
     except Exception as e:
         click.secho(f"Failed to stop app on port {port}!", fg="red", err=True)
-        stop_app_step.update(
-            OuterboundsCommandStatus.FAIL, f"Failed to stop on port {port}!", ""
-        )
-        stop_app_response.add_step(stop_app_step)
-        if output == "json":
-            click.echo(json.dumps(stop_app_response.as_dict(), indent=4))
 
 
-@app.command(help="Stop an app using its port number")
+@app.command(help="List all apps on the workstation")
 @click.option(
     "-d",
     "--config-dir",
@@ -466,43 +315,14 @@ def stop(config_dir=None, profile=None, port=-1, name="", output=""):
     default=os.environ.get("METAFLOW_PROFILE", ""),
     help="The named metaflow profile in which your workstation exists",
 )
-@click.option(
-    "-o",
-    "--output",
-    default="",
-    help="Show output in the specified format.",
-    type=click.Choice(["json", ""]),
-)
-def list(config_dir=None, profile=None, output=""):
-    list_app_response = OuterboundsCommandResponse()
-
-    validate_workstation_step = CommandStatus(
-        "ValidateRunningOnWorkstation",
-        OuterboundsCommandStatus.OK,
-        "Command is being run on a workstation.",
-    )
-
-    list_workstations_step = CommandStatus(
-        "ListWorkstations",
-        OuterboundsCommandStatus.OK,
-        "List of workstations fetched.",
-    )
-
+def list(config_dir=None, profile=None):
     if "WORKSTATION_ID" not in os.environ:
-        validate_workstation_step.update(
-            OuterboundsCommandStatus.FAIL,
-            "All outerbounds app commands can only be run from a workstation.",
-            "",
-        )
-        list_app_response.add_step(validate_workstation_step)
         click.secho(
             "All outerbounds app commands can only be run from a workstation.",
             fg="red",
             err=True,
         )
 
-        if output == "json":
-            click.echo(json.dumps(list_app_response.as_dict(), indent=4))
         return
 
     try:
@@ -518,15 +338,8 @@ def list(config_dir=None, profile=None, output=""):
                 f"{api_url}/v1/workstations", headers={"x-api-key": metaflow_token}
             )
             workstations_response.raise_for_status()
-            list_app_response.add_step(list_workstations_step)
         except:
             click.secho("Failed to list workstations!", fg="red", err=True)
-            list_workstations_step.update(
-                OuterboundsCommandStatus.FAIL, "Failed to list workstations!", ""
-            )
-            list_app_response.add_step(list_workstations_step)
-            if output == "json":
-                click.echo(json.dumps(list_app_response.as_dict(), indent=4))
             return
 
         workstations_json = workstations_response.json()["workstations"]
@@ -562,8 +375,6 @@ def list(config_dir=None, profile=None, output=""):
                         click.echo("\n", err=True)
     except Exception as e:
         click.secho(f"Failed to list apps!", fg="red", err=True)
-        if output == "json":
-            click.echo(json.dumps(list_app_response.as_dict(), indent=4))
 
 
 def ensure_app_start_request_is_valid(existing_named_ports, port: int, name: str):
@@ -583,4 +394,57 @@ def ensure_app_start_request_is_valid(existing_named_ports, port: int, name: str
             )
 
 
+def wait_for_app_port_to_be_accessible(
+    api_url, metaflow_token, workstation_id, app_name, poll_timeout_seconds
+) -> bool:
+    num_retries_per_request = 3
+    start_time = time.time()
+    retry_delay = 1.0
+    poll_interval = 10
+    wait_message = f"App {app_name} is currently being deployed..."
+    while time.time() - start_time < poll_timeout_seconds:
+        for _ in range(num_retries_per_request):
+            try:
+                workstations_response = requests.get(
+                    f"{api_url}/v1/workstations", headers={"x-api-key": metaflow_token}
+                )
+                workstations_response.raise_for_status()
+                if is_app_ready(workstations_response.json(), workstation_id, app_name):
+                    click.secho(
+                        wait_message,
+                        fg="yellow",
+                        err=True,
+                    )
+                    time.sleep(APP_READY_EXTRA_BUFFER_SECONDS)
+                    return True
+                else:
+                    click.secho(
+                        wait_message,
+                        fg="yellow",
+                        err=True,
+                    )
+                    time.sleep(poll_interval)
+            except (
+                requests.exceptions.ConnectionError,
+                requests.exceptions.ReadTimeout,
+            ):
+                time.sleep(retry_delay)
+                retry_delay *= 2  # Double the delay for the next attempt
+                retry_delay += random.uniform(0, 1)  # Add jitter
+                retry_delay = min(retry_delay, 10)
+    return False
+
+
+def is_app_ready(response_json: dict, workstation_id: str, app_name: str) -> bool:
+    """Checks if the app is ready in the given workstation's response."""
+    workstations = response_json.get("workstations", [])
+    for workstation in workstations:
+        if workstation.get("instance_id") == workstation_id:
+            hosted_apps = workstation.get("status", {}).get("hosted_apps", [])
+            for hosted_app in hosted_apps:
+                if hosted_app.get("name") == app_name:
+                    return bool(hosted_app.get("ready"))
+    return False
+
+
 cli.add_command(app, name="app")

{outerbounds-0.3.109rc1.dist-info → outerbounds-0.3.111.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: outerbounds
-Version: 0.3.109rc1
+Version: 0.3.111
 Summary: More Data Science, Less Administration
 License: Proprietary
 Keywords: data science,machine learning,MLOps
@@ -25,10 +25,10 @@ Requires-Dist: google-api-core (>=2.16.1,<3.0.0) ; extra == "gcp"
 Requires-Dist: google-auth (>=2.27.0,<3.0.0) ; extra == "gcp"
 Requires-Dist: google-cloud-secret-manager (>=2.20.0,<3.0.0) ; extra == "gcp"
 Requires-Dist: google-cloud-storage (>=2.14.0,<3.0.0) ; extra == "gcp"
-Requires-Dist: metaflow-checkpoint (==0.0.13)
-Requires-Dist: ob-metaflow (==2.12.25.1)
-Requires-Dist: ob-metaflow-extensions (==1.1.98)
-Requires-Dist: ob-metaflow-stubs (==6.0.3.109rc1)
+Requires-Dist: metaflow-checkpoint (==0.1.0)
+Requires-Dist: ob-metaflow (==2.12.25.2)
+Requires-Dist: ob-metaflow-extensions (==1.1.99)
+Requires-Dist: ob-metaflow-stubs (==6.0.3.111)
 Requires-Dist: opentelemetry-distro (==0.41b0)
 Requires-Dist: opentelemetry-exporter-otlp-proto-http (==1.20.0)
 Requires-Dist: opentelemetry-instrumentation-requests (==0.41b0)

{outerbounds-0.3.109rc1.dist-info → outerbounds-0.3.111.dist-info}/RECORD

@@ -41,7 +41,7 @@ outerbounds/_vendor/yaml/serializer.py,sha256=8wFZRy9SsQSktF_f9OOroroqsh4qVUe53r
 outerbounds/_vendor/yaml/tokens.py,sha256=JBSu38wihGr4l73JwbfMA7Ks1-X84g8-NskTz7KwPmA,2578
 outerbounds/cli_main.py,sha256=e9UMnPysmc7gbrimq2I4KfltggyU7pw59Cn9aEguVcU,74
 outerbounds/command_groups/__init__.py,sha256=QPWtj5wDRTINDxVUL7XPqG3HoxHNvYOg08EnuSZB2Hc,21
-outerbounds/command_groups/apps_cli.py,sha256=iXaLnO-FwU_zK2ZjE-gBu1ZQdOYDLCbT0HJXJJZckeE,21895
+outerbounds/command_groups/apps_cli.py,sha256=8jmQufa0bK2sfRfs7DiWjoJ1oWiqZAixsL4Dte_KY4Y,17201
 outerbounds/command_groups/cli.py,sha256=q0hdJO4biD3iEOdyJcxnRkeleA8AKAhx842kQ49I6kk,365
 outerbounds/command_groups/local_setup_cli.py,sha256=tuuqJRXQ_guEwOuQSIf9wkUU0yg8yAs31myGViAK15s,36364
 outerbounds/command_groups/perimeters_cli.py,sha256=iF_Uw7ROiSctf6FgoJEy30iDBLVE1j9FKuR3shgJRmc,19050
@@ -53,7 +53,7 @@ outerbounds/utils/metaflowconfig.py,sha256=l2vJbgPkLISU-XPGZFaC8ZKmYFyJemlD6bwB-
 outerbounds/utils/schema.py,sha256=lMUr9kNgn9wy-sO_t_Tlxmbt63yLeN4b0xQXbDUDj4A,2331
 outerbounds/utils/utils.py,sha256=4Z8cszNob_8kDYCLNTrP-wWads_S_MdL3Uj3ju4mEsk,501
 outerbounds/vendor.py,sha256=gRLRJNXtZBeUpPEog0LOeIsl6GosaFFbCxUvR4bW6IQ,5093
-outerbounds-0.3.109rc1.dist-info/METADATA,sha256=y_w5rsXhyL29ELQT7xiktXegZB5GrFO69ZvxwEDunoA,1742
-outerbounds-0.3.109rc1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-outerbounds-0.3.109rc1.dist-info/entry_points.txt,sha256=7ye0281PKlvqxu15rjw60zKg2pMsXI49_A8BmGqIqBw,47
-outerbounds-0.3.109rc1.dist-info/RECORD,,
+outerbounds-0.3.111.dist-info/METADATA,sha256=v6zcvET5H7gPPNFcR-Gqy_QDh6EB_XYq0N6htQdfVBA,1735
+outerbounds-0.3.111.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+outerbounds-0.3.111.dist-info/entry_points.txt,sha256=7ye0281PKlvqxu15rjw60zKg2pMsXI49_A8BmGqIqBw,47
+outerbounds-0.3.111.dist-info/RECORD,,