feat: enhance execute_command example with asynchronous log streaming and environment status checks

Author: akosyakov

examples/execute_command.py

@@ -1,17 +1,8 @@
 #!/usr/bin/env python
 
 from gitpod import Gitpod
-from utils import get_context_url, get_authenticated_user, get_environment_class_id, get_environment_class, create_environment
-import time
-import requests
-
-def check_environment_status(client, environment_id):
-    environment = client.environments.retrieve(environment_id=environment_id).environment
-    print(f"Environment status: {environment.status.phase}")
-    if environment.status.phase in ["ENVIRONMENT_PHASE_STOPPING", "ENVIRONMENT_PHASE_STOPPED", "ENVIRONMENT_PHASE_DELETING", "ENVIRONMENT_PHASE_DELETED"]:
-        raise RuntimeError(f"Environment {environment_id} is in an unexpected phase: {environment.status.phase}")
-    elif environment.status.failure_message and len(environment.status.failure_message) > 0:
-        raise RuntimeError(f"Environment {environment_id} failed: {'; '.join(environment.status.failure_message)}")
+from utils import get_context_url, get_authenticated_user, get_environment_class_id, get_environment_class, create_environment, check_environment_status, stream_logs
+import asyncio
 
 def main() -> None:
     client: Gitpod = Gitpod()
@@ -61,7 +52,7 @@ def main() -> None:
         )
 
         log_url = None
-        for event in event_stream:
+        for event in event_stream._raw_iterator:
             print(f"Received event: {event}")
             if event.resource_type == "RESOURCE_TYPE_ENVIRONMENT" and event.resource_id == environment_id:
                 check_environment_status(client, environment_id)
@@ -78,14 +69,11 @@ def main() -> None:
         print(f"Task logs are available at: {log_url}")
 
         # Stream the log URL and print the logs
-        response = requests.get(log_url, stream=True, headers={"Authorization": f"Bearer {logs_access_token}"})
-        for line in response.iter_lines():
-            if line:
-                print(line.decode('utf-8'))
+        asyncio.run(stream_logs(log_url, logs_access_token))
 
     finally:
         client.environments.delete(environment_id=environment_id)
         print(f"Deleted environment: {environment_id}")
 
 if __name__ == "__main__":
-    main()
+    main()

examples/utils.py

@@ -5,6 +5,7 @@
 from gitpod.types.environment_retrieve_response import Environment
 from gitpod.types.user_get_authenticated_user_response import User
 from gitpod.types.environments.class_list_response import ClassListResponse
+import httpx
 
 def get_context_url() -> str:
     return os.environ.get("CONTEXT_URL", "https://github.com/gitpod-io/empty")
@@ -75,3 +76,10 @@ def check_environment_status(client: Gitpod, environment_id: str) -> None:
     elif environment.status.failure_message and len(environment.status.failure_message) > 0:
         raise RuntimeError(f"Environment {environment_id} failed: {'; '.join(environment.status.failure_message)}")
 
+async def stream_logs(log_url: str, logs_access_token: str) -> None:
+    async with httpx.AsyncClient() as client:
+        async with client.stream("GET", log_url, headers={"Authorization": f"Bearer {logs_access_token}"}) as response:
+            async for line in response.aiter_lines():
+                if line:
+                    print(line)
+