feat(generator): add _compat.py fallback for setup_request_id

Author: hebaalazzeh

packages/gapic-generator/gapic/generator/generator.py

@@ -120,7 +120,7 @@ def get_response(self, api_schema: api.API, opts: Options) -> CodeGeneratorRespo
         for template_name in client_templates:
             # Quick check: Skip "private" templates.
             filename = template_name.split("/")[-1]
-            if filename.startswith("_") and filename != "__init__.py.j2":
+            if filename.startswith("_") and filename not in ("__init__.py.j2", "_compat.py.j2"):
                 continue
 
             # Append to the output files dictionary.

packages/gapic-generator/gapic/templates/%namespace/%name_%version/%sub/_compat.py.j2

@@ -0,0 +1,36 @@
+# {% include '_license.j2' %}
+
+import uuid
+
+try:
+    from google.api_core.gapic_v1.requests import setup_request_id
+except ImportError:
+    # TODO: Remove this fallback when google-api-core >= 2.18.0 is the minimum required version.
+    def setup_request_id(request, field_name: str, is_proto3_optional: bool):
+        """Populate a UUID4 field in the request if it is not already set.
+
+        Args:
+            request (Union[google.protobuf.message.Message, dict]): The request object.
+            field_name (str): The name of the field to populate.
+            is_proto3_optional (bool): Whether the field is proto3 optional.
+        """
+        if isinstance(request, dict):
+            if is_proto3_optional:
+                if field_name not in request:
+                    request[field_name] = str(uuid.uuid4())
+            elif not request.get(field_name):
+                request[field_name] = str(uuid.uuid4())
+            return
+
+        if is_proto3_optional:
+            try:
+                # Pure protobuf messages
+                if not request.HasField(field_name):
+                    setattr(request, field_name, str(uuid.uuid4()))
+            except (AttributeError, ValueError):
+                # Proto-plus messages or other objects
+                if field_name not in request:
+                    setattr(request, field_name, str(uuid.uuid4()))
+        else:
+            if not getattr(request, field_name):
+                setattr(request, field_name, str(uuid.uuid4()))

packages/gapic-generator/gapic/templates/%namespace/%name_%version/%sub/services/%service/async_client.py.j2

@@ -27,7 +27,7 @@ from google.api_core.client_options import ClientOptions
 from google.api_core import exceptions as core_exceptions
 from google.api_core import gapic_v1
 {% if has_auto_populated_fields.value %}
-from google.api_core.gapic_v1.requests import setup_request_id
+from {{package_path}}._compat import setup_request_id
 {% endif %}
 from google.api_core import retry_async as retries
 from google.auth import credentials as ga_credentials   # type: ignore

packages/gapic-generator/gapic/templates/%namespace/%name_%version/%sub/services/%service/client.py.j2

@@ -36,7 +36,7 @@ from google.api_core import extended_operation
 {% endif %}
 from google.api_core import gapic_v1
 {% if has_auto_populated_fields.value %}
-from google.api_core.gapic_v1.requests import setup_request_id
+from {{package_path}}._compat import setup_request_id
 {% endif %}
 from google.api_core import retry as retries
 from google.auth import credentials as ga_credentials             # type: ignore