Deprecate CloudRunJob and VertexAICustomTrainingJob infrastructure blocks

prefect_gcp/aiplatform.py

@@ -1,5 +1,10 @@
 """
-<span class="badge-api experimental"/>
+DEPRECATION WARNING:
+
+This module is deprecated as of March 2024 and will not be available after September 2024.
+It has been replaced by the Vertex AI worker, which offers enhanced functionality and better performance.
+
+For upgrade instructions, see https://docs.prefect.io/latest/guides/upgrade-guide-agents-to-workers/.
 
 Integrations with Google AI Platform.
 
@@ -50,7 +55,7 @@
     )
     job.preview()
     ```
-"""
+"""  # noqa
 
 import datetime
 import re
@@ -60,6 +65,7 @@
 from uuid import uuid4
 
 from anyio.abc import TaskStatus
+from prefect._internal.compatibility.deprecated import deprecated_class
 from prefect.exceptions import InfrastructureNotFound
 from prefect.infrastructure import Infrastructure, InfrastructureResult
 from prefect.utilities.asyncutils import run_sync_in_worker_thread, sync_compatible
@@ -107,6 +113,14 @@ class VertexAICustomTrainingJobResult(InfrastructureResult):
     """Result from a Vertex AI custom training job."""
 
 
+@deprecated_class(
+    start_date="Mar 2024",
+    help=(
+        "Use the Vertex AI worker instead."
+        " Refer to the upgrade guide for more information:"
+        " https://docs.prefect.io/latest/guides/upgrade-guide-agents-to-workers/."
+    ),
+)
 class VertexAICustomTrainingJob(Infrastructure):
     """
     Infrastructure block used to run Vertex AI custom training jobs.

prefect_gcp/cloud_run.py

@@ -1,5 +1,10 @@
 """
-<span class="badge-api experimental"/>
+DEPRECATION WARNING:
+
+This module is deprecated as of March 2024 and will not be available after September 2024.
+It has been replaced by the Cloud Run and Cloud Run V2 workers, which offer enhanced functionality and better performance.
+
+For upgrade instructions, see https://docs.prefect.io/latest/guides/upgrade-guide-agents-to-workers/.
 
 Integrations with Google Cloud Run Job.
 
@@ -26,7 +31,7 @@
     ).run()
     ```
 
-"""
+"""  # noqa
 
 from __future__ import annotations
 
@@ -42,6 +47,7 @@
 from google.api_core.client_options import ClientOptions
 from googleapiclient import discovery
 from googleapiclient.discovery import Resource
+from prefect._internal.compatibility.deprecated import deprecated_class
 from prefect.exceptions import InfrastructureNotFound
 from prefect.infrastructure.base import Infrastructure, InfrastructureResult
 from prefect.utilities.asyncutils import run_sync_in_worker_thread, sync_compatible
@@ -210,6 +216,14 @@ class CloudRunJobResult(InfrastructureResult):
     """Result from a Cloud Run Job."""
 
 
+@deprecated_class(
+    start_date="Mar 2024",
+    help=(
+        "Use the Cloud Run or Cloud Run v2 worker instead."
+        " Refer to the upgrade guide for more information:"
+        " https://docs.prefect.io/latest/guides/upgrade-guide-agents-to-workers/."
+    ),
+)
 class CloudRunJob(Infrastructure):
     """
     <span class="badge-api experimental"/>

requirements.txt

@@ -1,4 +1,4 @@
-prefect>=2.14.10
+prefect>=2.16.4
 google-api-python-client>=2.20.0
 google-cloud-storage>=2.0.0
 tenacity>=8.0.0

tests/test_deprecation.py

@@ -0,0 +1,36 @@
+import pytest
+from prefect._internal.compatibility.deprecated import PrefectDeprecationWarning
+
+from prefect_gcp.aiplatform import VertexAICustomTrainingJob
+from prefect_gcp.cloud_run import CloudRunJob
+
+
+@pytest.mark.parametrize(
+    "InfraBlock, kwargs, expected_message",
+    [
+        (
+            CloudRunJob,
+            {"image": "foo", "region": "us-central1"},
+            "prefect_gcp.cloud_run.CloudRunJob has been deprecated."
+            " It will not be available after Sep 2024."
+            " Use the Cloud Run or Cloud Run v2 worker instead."
+            " Refer to the upgrade guide for more information",
+        ),
+        (
+            VertexAICustomTrainingJob,
+            {"image": "foo", "region": "us-central1"},
+            "prefect_gcp.aiplatform.VertexAICustomTrainingJob has been deprecated."
+            " It will not be available after Sep 2024."
+            " Use the Vertex AI worker instead."
+            " Refer to the upgrade guide for more information",
+        ),
+    ],
+)
+def test_infra_blocks_emit_a_deprecation_warning(
+    InfraBlock, kwargs, expected_message, gcp_credentials
+):
+    with pytest.warns(PrefectDeprecationWarning, match=expected_message):
+        if InfraBlock == CloudRunJob:
+            InfraBlock(**kwargs, credentials=gcp_credentials)
+        else:
+            InfraBlock(**kwargs, gcp_credentials=gcp_credentials)