responding to code review

Author: GSmithApps

custom_metric/README.md

@@ -3,25 +3,25 @@
 This sample deminstrates two things: (1) how to make a custom metric, and (2) how to use an interceptor.
 The custom metric in this sample is an activity schedule-to-start-latency with a workflow type tag.
 
-Please see the top-level README for prerequisites such as Python, uv, starting the local temporal development server, etc.
+Please see the top-level [README](../README.md) for prerequisites such as Python, uv, starting the local temporal development server, etc. 
 
 1. Run the worker with `uv run custom_metric/worker.py`
-2. Request execution of the workflow with `temporal workflow start --type ExecuteActivityWorkflow --task-queue custom-metric-task-queue`
+2. Request execution of the workflow with `uv run custom_metric/starter.py`
 3. Go to `http://127.0.0.1:9090/metrics` in your browser
 
 You'll get something like the following:
 
 ```txt
-custom_activity_schedule_to_start_latency_bucket{activity_type="print_message",namespace="default",service_name="temporal-core-sdk",task_queue="custom-metric-task-queue",workflow_type="ExecuteActivityWorkflow",le="100"} 1
-custom_activity_schedule_to_start_latency_bucket{activity_type="print_message",namespace="default",service_name="temporal-core-sdk",task_queue="custom-metric-task-queue",workflow_type="ExecuteActivityWorkflow",le="500"} 1
-custom_activity_schedule_to_start_latency_bucket{activity_type="print_message",namespace="default",service_name="temporal-core-sdk",task_queue="custom-metric-task-queue",workflow_type="ExecuteActivityWorkflow",le="1000"} 1
-custom_activity_schedule_to_start_latency_bucket{activity_type="print_message",namespace="default",service_name="temporal-core-sdk",task_queue="custom-metric-task-queue",workflow_type="ExecuteActivityWorkflow",le="5000"} 2
-custom_activity_schedule_to_start_latency_bucket{activity_type="print_message",namespace="default",service_name="temporal-core-sdk",task_queue="custom-metric-task-queue",workflow_type="ExecuteActivityWorkflow",le="10000"} 2
-custom_activity_schedule_to_start_latency_bucket{activity_type="print_message",namespace="default",service_name="temporal-core-sdk",task_queue="custom-metric-task-queue",workflow_type="ExecuteActivityWorkflow",le="100000"} 2
-custom_activity_schedule_to_start_latency_bucket{activity_type="print_message",namespace="default",service_name="temporal-core-sdk",task_queue="custom-metric-task-queue",workflow_type="ExecuteActivityWorkflow",le="1000000"} 2
-custom_activity_schedule_to_start_latency_bucket{activity_type="print_message",namespace="default",service_name="temporal-core-sdk",task_queue="custom-metric-task-queue",workflow_type="ExecuteActivityWorkflow",le="+Inf"} 2
-custom_activity_schedule_to_start_latency_sum{activity_type="print_message",namespace="default",service_name="temporal-core-sdk",task_queue="custom-metric-task-queue",workflow_type="ExecuteActivityWorkflow"} 1010
-custom_activity_schedule_to_start_latency_count{activity_type="print_message",namespace="default",service_name="temporal-core-sdk",task_queue="custom-metric-task-queue",workflow_type="ExecuteActivityWorkflow"} 2
+custom_activity_schedule_to_start_latency_bucket{activity_type="print_and_sleep",namespace="default",service_name="temporal-core-sdk",task_queue="custom-metric-task-queue",workflow_type="StartTwoActivitiesWorkflow",le="100"} 1
+custom_activity_schedule_to_start_latency_bucket{activity_type="print_and_sleep",namespace="default",service_name="temporal-core-sdk",task_queue="custom-metric-task-queue",workflow_type="StartTwoActivitiesWorkflow",le="500"} 1
+custom_activity_schedule_to_start_latency_bucket{activity_type="print_and_sleep",namespace="default",service_name="temporal-core-sdk",task_queue="custom-metric-task-queue",workflow_type="StartTwoActivitiesWorkflow",le="1000"} 1
+custom_activity_schedule_to_start_latency_bucket{activity_type="print_and_sleep",namespace="default",service_name="temporal-core-sdk",task_queue="custom-metric-task-queue",workflow_type="StartTwoActivitiesWorkflow",le="5000"} 2
+custom_activity_schedule_to_start_latency_bucket{activity_type="print_and_sleep",namespace="default",service_name="temporal-core-sdk",task_queue="custom-metric-task-queue",workflow_type="StartTwoActivitiesWorkflow",le="10000"} 2
+custom_activity_schedule_to_start_latency_bucket{activity_type="print_and_sleep",namespace="default",service_name="temporal-core-sdk",task_queue="custom-metric-task-queue",workflow_type="StartTwoActivitiesWorkflow",le="100000"} 2
+custom_activity_schedule_to_start_latency_bucket{activity_type="print_and_sleep",namespace="default",service_name="temporal-core-sdk",task_queue="custom-metric-task-queue",workflow_type="StartTwoActivitiesWorkflow",le="1000000"} 2
+custom_activity_schedule_to_start_latency_bucket{activity_type="print_and_sleep",namespace="default",service_name="temporal-core-sdk",task_queue="custom-metric-task-queue",workflow_type="StartTwoActivitiesWorkflow",le="+Inf"} 2
+custom_activity_schedule_to_start_latency_sum{activity_type="print_and_sleep",namespace="default",service_name="temporal-core-sdk",task_queue="custom-metric-task-queue",workflow_type="StartTwoActivitiesWorkflow"} 1010
+custom_activity_schedule_to_start_latency_count{activity_type="print_and_sleep",namespace="default",service_name="temporal-core-sdk",task_queue="custom-metric-task-queue",workflow_type="StartTwoActivitiesWorkflow"} 2
 ...
 temporal_activity_schedule_to_start_latency_bucket{namespace="default",service_name="temporal-core-sdk",task_queue="custom-metric-task-queue",le="100"} 1
 temporal_activity_schedule_to_start_latency_bucket{namespace="default",service_name="temporal-core-sdk",task_queue="custom-metric-task-queue",le="500"} 1

custom_metric/activity.py

@@ -0,0 +1,9 @@
+import time
+
+from temporalio import activity
+
+
+@activity.defn
+def print_and_sleep():
+    print("In the activity.")
+    time.sleep(1)

custom_metric/starter.py

@@ -0,0 +1,23 @@
+import asyncio
+import uuid
+
+from temporalio.client import Client
+
+from custom_metric.workflow import StartTwoActivitiesWorkflow
+
+
+async def main():
+
+    client = await Client.connect(
+        "localhost:7233",
+    )
+
+    await client.start_workflow(
+        StartTwoActivitiesWorkflow.run,
+        id="execute-activity-workflow-" + str(uuid.uuid4()),
+        task_queue="custom-metric-task-queue",
+    )
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

custom_metric/worker.py

@@ -1,9 +1,7 @@
 import asyncio
-import time
 from concurrent.futures import ThreadPoolExecutor
-from datetime import timedelta
 
-from temporalio import activity, workflow
+from temporalio import activity
 from temporalio.client import Client
 from temporalio.runtime import PrometheusConfig, Runtime, TelemetryConfig
 from temporalio.worker import (
@@ -13,30 +11,8 @@
     Worker,
 )
 
-
-@activity.defn
-def print_message():
-    print("In the activity.")
-    time.sleep(1)
-
-
-@workflow.defn
-class ExecuteActivityWorkflow:
-
-    @workflow.run
-    async def run(self):
-        # Request two concurrent activities with only one task slot so
-        # we can see nontrivial schedule to start times.
-        activity1 = workflow.execute_activity(
-            print_message,
-            start_to_close_timeout=timedelta(seconds=5),
-        )
-        activity2 = workflow.execute_activity(
-            print_message,
-            start_to_close_timeout=timedelta(seconds=5),
-        )
-        await asyncio.gather(activity1, activity2)
-        return None
+from custom_metric.activity import print_and_sleep
+from custom_metric.workflow import StartTwoActivitiesWorkflow
 
 
 class SimpleWorkerInterceptor(Interceptor):
@@ -82,8 +58,8 @@ async def main():
         client,
         task_queue="custom-metric-task-queue",
         interceptors=[SimpleWorkerInterceptor()],
-        workflows=[ExecuteActivityWorkflow],
-        activities=[print_message],
+        workflows=[StartTwoActivitiesWorkflow],
+        activities=[print_and_sleep],
         # only one activity executor with two concurrently scheduled activities
         # to force a nontrivial schedule to start times
         activity_executor=ThreadPoolExecutor(1),

custom_metric/workflow.py

@@ -0,0 +1,26 @@
+import asyncio
+from datetime import timedelta
+
+from temporalio import workflow
+
+with workflow.unsafe.imports_passed_through():
+    from custom_metric.activity import print_and_sleep
+
+
+@workflow.defn
+class StartTwoActivitiesWorkflow:
+
+    @workflow.run
+    async def run(self):
+        # Request two concurrent activities with only one task slot so
+        # we can see nontrivial schedule to start times.
+        activity1 = workflow.execute_activity(
+            print_and_sleep,
+            start_to_close_timeout=timedelta(seconds=5),
+        )
+        activity2 = workflow.execute_activity(
+            print_and_sleep,
+            start_to_close_timeout=timedelta(seconds=5),
+        )
+        await asyncio.gather(activity1, activity2)
+        return None

tests/custom_metric/workflow_test.py

@@ -1,33 +1,31 @@
 import uuid
 
 from temporalio import activity
-from temporalio.testing import WorkflowEnvironment
+from temporalio.client import Client
 from temporalio.worker import Worker
 
-from custom_metric.worker import ExecuteActivityWorkflow
+from custom_metric.worker import StartTwoActivitiesWorkflow
 
 _TASK_QUEUE = "custom-metric-task-queue"
 
 activity_counter = 0
 
 
-async def test_sleep_for_days_workflow():
+async def test_custom_metric_workflow(client: Client):
 
     @activity.defn(name="print_message")
     async def print_message_mock():
         global activity_counter
         activity_counter += 1
 
-    async with await WorkflowEnvironment.start_time_skipping() as env:
-
         async with Worker(
-            env.client,
+            client,
             task_queue=_TASK_QUEUE,
-            workflows=[ExecuteActivityWorkflow],
+            workflows=[StartTwoActivitiesWorkflow],
             activities=[print_message_mock],
         ):
-            result = await env.client.execute_workflow(
-                ExecuteActivityWorkflow.run,
+            result = await client.execute_workflow(
+                StartTwoActivitiesWorkflow.run,
                 id=str(uuid.uuid4()),
                 task_queue=_TASK_QUEUE,
             )