prefect-client 3.0.0rc10__py3-none-any.whl → 3.0.0rc11__py3-none-any.whl

prefect/runner/server.py

@@ -16,7 +16,6 @@ from prefect.runner.utils import (
     inject_schemas_into_openapi,
 )
 from prefect.settings import (
-    PREFECT_EXPERIMENTAL_ENABLE_EXTRA_RUNNER_ENDPOINTS,
     PREFECT_RUNNER_POLL_FREQUENCY,
     PREFECT_RUNNER_SERVER_HOST,
     PREFECT_RUNNER_SERVER_LOG_LEVEL,
@@ -202,7 +201,7 @@ def _build_generic_endpoint_for_flows(
 
         try:
             flow = load_flow_from_entrypoint(body.entrypoint)
-        except (MissingFlowError, ScriptError, ModuleNotFoundError):
+        except (FileNotFoundError, MissingFlowError, ScriptError, ModuleNotFoundError):
             return JSONResponse(
                 status_code=status.HTTP_404_NOT_FOUND,
                 content={"message": "Flow not found"},
@@ -261,29 +260,28 @@ async def build_server(runner: "Runner") -> FastAPI:
     router.add_api_route("/shutdown", shutdown(runner=runner), methods=["POST"])
     webserver.include_router(router)
 
-    if PREFECT_EXPERIMENTAL_ENABLE_EXTRA_RUNNER_ENDPOINTS.value():
-        deployments_router, deployment_schemas = await get_deployment_router(runner)
-        webserver.include_router(deployments_router)
-
-        subflow_schemas = await get_subflow_schemas(runner)
-        webserver.add_api_route(
-            "/flow/run",
-            _build_generic_endpoint_for_flows(runner=runner, schemas=subflow_schemas),
-            methods=["POST"],
-            name="Run flow in background",
-            description="Trigger any flow run as a background task on the runner.",
-            summary="Run flow",
-        )
-
-        def customize_openapi():
-            if webserver.openapi_schema:
-                return webserver.openapi_schema
+    deployments_router, deployment_schemas = await get_deployment_router(runner)
+    webserver.include_router(deployments_router)
+
+    subflow_schemas = await get_subflow_schemas(runner)
+    webserver.add_api_route(
+        "/flow/run",
+        _build_generic_endpoint_for_flows(runner=runner, schemas=subflow_schemas),
+        methods=["POST"],
+        name="Run flow in background",
+        description="Trigger any flow run as a background task on the runner.",
+        summary="Run flow",
+    )
 
-            openapi_schema = inject_schemas_into_openapi(webserver, deployment_schemas)
-            webserver.openapi_schema = openapi_schema
+    def customize_openapi():
+        if webserver.openapi_schema:
             return webserver.openapi_schema
 
-        webserver.openapi = customize_openapi
+        openapi_schema = inject_schemas_into_openapi(webserver, deployment_schemas)
+        webserver.openapi_schema = openapi_schema
+        return webserver.openapi_schema
+
+    webserver.openapi = customize_openapi
 
     return webserver
 

prefect/runner/submit.py

@@ -14,7 +14,6 @@ from prefect.context import FlowRunContext
 from prefect.flows import Flow
 from prefect.logging import get_logger
 from prefect.settings import (
-    PREFECT_EXPERIMENTAL_ENABLE_EXTRA_RUNNER_ENDPOINTS,
     PREFECT_RUNNER_PROCESS_LIMIT,
     PREFECT_RUNNER_SERVER_HOST,
     PREFECT_RUNNER_SERVER_PORT,
@@ -131,13 +130,6 @@ async def submit_to_runner(
             "The `submit_to_runner` utility only supports submitting flows and tasks."
         )
 
-    if not PREFECT_EXPERIMENTAL_ENABLE_EXTRA_RUNNER_ENDPOINTS.value():
-        raise ValueError(
-            "The `submit_to_runner` utility requires the `Runner` webserver to be"
-            " running and built with extra endpoints enabled. To enable this, set the"
-            " `PREFECT_EXPERIMENTAL_ENABLE_EXTRA_RUNNER_ENDPOINTS` setting to `True`."
-        )
-
     parameters = parameters or {}
     if isinstance(parameters, List):
         return_single = False

prefect/runtime/flow_run.py

@@ -38,6 +38,7 @@ __all__ = [
     "parameters",
     "parent_flow_run_id",
     "parent_deployment_id",
+    "root_flow_run_id",
     "run_count",
     "api_url",
     "ui_url",
@@ -237,11 +238,12 @@ def get_parent_flow_run_id() -> Optional[str]:
         parent_task_run = from_sync.call_soon_in_loop_thread(
             create_call(_get_task_run, parent_task_run_id)
         ).result()
-        return parent_task_run.flow_run_id
+        return str(parent_task_run.flow_run_id) if parent_task_run.flow_run_id else None
+
     return None
 
 
-def get_parent_deployment_id() -> Dict[str, Any]:
+def get_parent_deployment_id() -> Optional[str]:
     parent_flow_run_id = get_parent_flow_run_id()
     if parent_flow_run_id is None:
         return None
@@ -249,7 +251,39 @@ def get_parent_deployment_id() -> Dict[str, Any]:
     parent_flow_run = from_sync.call_soon_in_loop_thread(
         create_call(_get_flow_run, parent_flow_run_id)
     ).result()
-    return parent_flow_run.deployment_id if parent_flow_run else None
+
+    if parent_flow_run:
+        return (
+            str(parent_flow_run.deployment_id)
+            if parent_flow_run.deployment_id
+            else None
+        )
+
+    return None
+
+
+def get_root_flow_run_id() -> str:
+    run_id = get_id()
+    parent_flow_run_id = get_parent_flow_run_id()
+    if parent_flow_run_id is None:
+        return run_id
+
+    def _get_root_flow_run_id(flow_run_id):
+        flow_run = from_sync.call_soon_in_loop_thread(
+            create_call(_get_flow_run, flow_run_id)
+        ).result()
+
+        if flow_run.parent_task_run_id is None:
+            return str(flow_run_id)
+        else:
+            parent_task_run = from_sync.call_soon_in_loop_thread(
+                create_call(_get_task_run, flow_run.parent_task_run_id)
+            ).result()
+            return _get_root_flow_run_id(parent_task_run.flow_run_id)
+
+    root_flow_run_id = _get_root_flow_run_id(parent_flow_run_id)
+
+    return root_flow_run_id
 
 
 def get_flow_run_api_url() -> Optional[str]:
@@ -275,6 +309,7 @@ FIELDS = {
     "parameters": get_parameters,
     "parent_flow_run_id": get_parent_flow_run_id,
     "parent_deployment_id": get_parent_deployment_id,
+    "root_flow_run_id": get_root_flow_run_id,
     "run_count": get_run_count,
     "api_url": get_flow_run_api_url,
     "ui_url": get_flow_run_ui_url,

prefect/settings.py

@@ -1160,6 +1160,11 @@ polled."""
 PREFECT_API_LOG_RETRYABLE_ERRORS = Setting(bool, default=False)
 """If `True`, log retryable errors in the API and it's services."""
 
+PREFECT_API_SERVICES_TASK_RUN_RECORDER_ENABLED = Setting(bool, default=True)
+"""
+Whether or not to start the task run recorder service in the server application.
+"""
+
 
 PREFECT_API_DEFAULT_LIMIT = Setting(
     int,
@@ -1309,17 +1314,13 @@ The maximum number of artifacts to show on a flow run graph on the v2 API
 """
 
 
-PREFECT_EXPERIMENTAL_ENABLE_ENHANCED_CANCELLATION = Setting(bool, default=True)
-"""
-Whether or not to enable experimental enhanced flow run cancellation.
-"""
-
-PREFECT_EXPERIMENTAL_WARN_ENHANCED_CANCELLATION = Setting(bool, default=False)
+PREFECT_EXPERIMENTAL_ENABLE_CLIENT_SIDE_TASK_ORCHESTRATION = Setting(
+    bool, default=False
+)
 """
-Whether or not to warn when experimental enhanced flow run cancellation is used.
+Whether or not to enable experimental client side task run orchestration.
 """
 
-
 # Prefect Events feature flags
 
 PREFECT_RUNNER_PROCESS_LIMIT = Setting(int, default=5)
@@ -1437,11 +1438,6 @@ a task worker should move a task from PENDING to RUNNING very quickly, so runs s
 PENDING for a while is a sign that the task worker may have crashed.
 """
 
-PREFECT_EXPERIMENTAL_ENABLE_EXTRA_RUNNER_ENDPOINTS = Setting(bool, default=False)
-"""
-Whether or not to enable experimental worker webserver endpoints.
-"""
-
 PREFECT_EXPERIMENTAL_DISABLE_SYNC_COMPAT = Setting(bool, default=False)
 """
 Whether or not to disable the sync_compatible decorator utility.

prefect/task_worker.py

@@ -325,7 +325,7 @@ class TaskWorker:
 
         if task_run_url := url_for(task_run):
             logger.info(
-                f"Submitting task run {task_run.name!r} to engine. View run in the UI at {task_run_url!r}"
+                f"Submitting task run {task_run.name!r} to engine. View in the UI: {task_run_url}"
             )
 
         if task.isasync:

prefect/transactions.py

@@ -187,8 +187,16 @@ class Transaction(ContextModel):
 
             for hook in self.on_commit_hooks:
                 hook_name = _get_hook_name(hook)
+                if self.logger:
+                    self.logger.info(f"Running commit hook {hook_name!r}")
+
                 hook(self)
 
+                if self.logger:
+                    self.logger.info(
+                        f"Commit hook {hook_name!r} finished running successfully"
+                    )
+
             if self.store and self.key:
                 self.store.write(key=self.key, value=self._staged_value)
             self.state = TransactionState.COMMITTED
@@ -235,8 +243,16 @@ class Transaction(ContextModel):
         try:
             for hook in reversed(self.on_rollback_hooks):
                 hook_name = _get_hook_name(hook)
+                if self.logger:
+                    self.logger.info(f"Running rollback hook {hook_name!r}")
+
                 hook(self)
 
+                if self.logger:
+                    self.logger.info(
+                        f"Rollback hook {hook_name!r} finished running successfully"
+                    )
+
             self.state = TransactionState.ROLLED_BACK
 
             for child in reversed(self.children):

prefect/utilities/asyncutils.py

@@ -249,6 +249,7 @@ def run_coro_as_sync(
             return call.result()
         except KeyboardInterrupt:
             call.cancel()
+
             logger.debug("Coroutine cancelled due to KeyboardInterrupt.")
             raise
 

prefect/utilities/engine.py

@@ -51,6 +51,7 @@ from prefect.logging.loggers import (
 )
 from prefect.results import BaseResult
 from prefect.settings import (
+    PREFECT_EXPERIMENTAL_ENABLE_CLIENT_SIDE_TASK_ORCHESTRATION,
     PREFECT_LOGGING_LOG_PRINTS,
 )
 from prefect.states import (
@@ -558,7 +559,7 @@ def propose_state_sync(
         )
 
 
-def _dynamic_key_for_task_run(context: FlowRunContext, task: Task) -> int:
+def _dynamic_key_for_task_run(context: FlowRunContext, task: Task) -> Union[int, str]:
     if context.detached:  # this task is running on remote infrastructure
         return str(uuid4())
     elif context.flow_run is None:  # this is an autonomous task run
@@ -744,6 +745,12 @@ def emit_task_run_state_change_event(
                     "message": truncated_to(
                         state_message_truncation_length, initial_state.message
                     ),
+                    "state_details": initial_state.state_details.model_dump(
+                        mode="json",
+                        exclude_none=True,
+                        exclude_unset=True,
+                        exclude={"flow_run_id", "task_run_id"},
+                    ),
                 }
                 if initial_state
                 else None
@@ -754,7 +761,30 @@ def emit_task_run_state_change_event(
                 "message": truncated_to(
                     state_message_truncation_length, validated_state.message
                 ),
+                "state_details": validated_state.state_details.model_dump(
+                    mode="json",
+                    exclude_none=True,
+                    exclude_unset=True,
+                    exclude={"flow_run_id", "task_run_id"},
+                ),
+                "data": validated_state.data.model_dump(mode="json")
+                if isinstance(validated_state.data, BaseResult)
+                else None,
             },
+            "task_run": task_run.model_dump(
+                mode="json",
+                exclude_none=True,
+                exclude={
+                    "id",
+                    "created",
+                    "updated",
+                    "flow_run_id",
+                    "state_id",
+                    "state_type",
+                    "state_name",
+                    "state",
+                },
+            ),
         },
         resource={
             "prefect.resource.id": f"prefect.task-run.{task_run.id}",
@@ -769,6 +799,9 @@ def emit_task_run_state_change_event(
                 else ""
             ),
             "prefect.state-type": str(validated_state.type.value),
+            "prefect.orchestration": "client"
+            if PREFECT_EXPERIMENTAL_ENABLE_CLIENT_SIDE_TASK_ORCHESTRATION
+            else "server",
         },
         follows=follows,
     )