chore: refactor setting of auto-populated field in request

Author: parthea

packages/gapic-generator/gapic/ads-templates/%namespace/%name/%version/%sub/services/%service/_shared_macros.j2

@@ -21,7 +21,7 @@
  # Do not diverge from the copy of `_shared_macros.j2` in standard templates.
 #}
 
-{% macro auto_populate_uuid4_fields(api, method) %}
+{% macro auto_populate_uuid4_fields(api, method, is_async=False) %}
 {#
     Automatically populate UUID4 fields according to
     https://google.aip.dev/client-libraries/4235 when the
@@ -34,12 +34,12 @@
 {% with method_settings = api.all_method_settings.get(method.meta.address.proto) %}
 {% if method_settings is not none %}
 {% for auto_populated_field in method_settings.auto_populated_fields %}
-    {% if method.input.fields[auto_populated_field].proto3_optional %}
-        if '{{ auto_populated_field }}' not in request:
+    {% set is_proto3_optional = method.input.fields[auto_populated_field].proto3_optional %}
+    {% if is_async %}
+        self._client._setup_request_id(request, '{{ auto_populated_field }}', {{ is_proto3_optional }})
     {% else %}
-        if not request.{{ auto_populated_field }}:
+        self._setup_request_id(request, '{{ auto_populated_field }}', {{ is_proto3_optional }})
     {% endif %}
-            request.{{ auto_populated_field }} = str(uuid.uuid4())
 {% endfor %}
 {% endif %}{# if method_settings is not none #}
 {% endwith %}{# method_settings #}

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

@@ -227,6 +227,24 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
 
     {% endfor %} {# common resources #}
 
+    {% if api.all_method_settings.values()|map(attribute="auto_populated_fields", default=[])|list %}
+    @staticmethod
+    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 is_proto3_optional:
+            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()))
+    {% endif %}
+
     def __init__(self, *,
             credentials: Optional[ga_credentials.Credentials] = None,
             transport: Optional[Union[str, {{ service.name }}Transport]] = None,

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

@@ -14,7 +14,7 @@
  # limitations under the License.
 #}
 
-{% macro auto_populate_uuid4_fields(api, method) %}
+{% macro auto_populate_uuid4_fields(api, method, is_async=False) %}
 {#
     Automatically populate UUID4 fields according to
     https://google.aip.dev/client-libraries/4235 when the
@@ -27,12 +27,12 @@
 {% with method_settings = api.all_method_settings.get(method.meta.address.proto) %}
 {% if method_settings is not none %}
 {% for auto_populated_field in method_settings.auto_populated_fields %}
-    {% if method.input.fields[auto_populated_field].proto3_optional %}
-        if '{{ auto_populated_field }}' not in request:
+    {% set is_proto3_optional = method.input.fields[auto_populated_field].proto3_optional %}
+    {% if is_async %}
+        self._client._setup_request_id(request, '{{ auto_populated_field }}', {{ is_proto3_optional }})
     {% else %}
-        if not request.{{ auto_populated_field }}:
+        self._setup_request_id(request, '{{ auto_populated_field }}', {{ is_proto3_optional }})
     {% endif %}
-            request.{{ auto_populated_field }} = str(uuid.uuid4())
 {% endfor %}
 {% endif %}{# if method_settings is not none #}
 {% endwith %}{# method_settings #}

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

@@ -395,7 +395,7 @@ class {{ service.async_client_name }}:
 
 {{ shared_macros.create_metadata(method) }}
 {{ shared_macros.add_api_version_header_to_metadata(service.version) }}
-{{ shared_macros.auto_populate_uuid4_fields(api, method) }}
+{{ shared_macros.auto_populate_uuid4_fields(api, method, is_async=True) }}
 
         # Validate the universe domain.
         self._client._validate_universe_domain()

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

@@ -453,6 +453,24 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
         # NOTE (b/349488459): universe validation is disabled until further notice.
         return True
 
+    {% if api.all_method_settings.values()|map(attribute="auto_populated_fields", default=[])|list %}
+    @staticmethod
+    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 is_proto3_optional:
+            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()))
+    {% endif %}
+
     def _add_cred_info_for_auth_errors(
         self,
         error: core_exceptions.GoogleAPICallError

packages/gapic-generator/tests/integration/goldens/storagebatchoperations/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/async_client.py

@@ -621,8 +621,7 @@ async def sample_create_job():
             )),
         )
 
-        if not request.request_id:
-            request.request_id = str(uuid.uuid4())
+        self._client._setup_request_id(request, 'request_id', False)
 
         # Validate the universe domain.
         self._client._validate_universe_domain()
@@ -728,8 +727,7 @@ async def sample_delete_job():
             )),
         )
 
-        if not request.request_id:
-            request.request_id = str(uuid.uuid4())
+        self._client._setup_request_id(request, 'request_id', False)
 
         # Validate the universe domain.
         self._client._validate_universe_domain()
@@ -831,8 +829,7 @@ async def sample_cancel_job():
             )),
         )
 
-        if not request.request_id:
-            request.request_id = str(uuid.uuid4())
+        self._client._setup_request_id(request, 'request_id', False)
 
         # Validate the universe domain.
         self._client._validate_universe_domain()

packages/gapic-generator/tests/integration/goldens/storagebatchoperations/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/client.py

@@ -471,6 +471,22 @@ def _validate_universe_domain(self):
         # NOTE (b/349488459): universe validation is disabled until further notice.
         return True
 
+    @staticmethod
+    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 is_proto3_optional:
+            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()))
+
     def _add_cred_info_for_auth_errors(
         self,
         error: core_exceptions.GoogleAPICallError
@@ -1005,8 +1021,7 @@ def sample_create_job():
             )),
         )
 
-        if not request.request_id:
-            request.request_id = str(uuid.uuid4())
+        self._setup_request_id(request, 'request_id', False)
 
         # Validate the universe domain.
         self._validate_universe_domain()
@@ -1111,8 +1126,7 @@ def sample_delete_job():
             )),
         )
 
-        if not request.request_id:
-            request.request_id = str(uuid.uuid4())
+        self._setup_request_id(request, 'request_id', False)
 
         # Validate the universe domain.
         self._validate_universe_domain()
@@ -1213,8 +1227,7 @@ def sample_cancel_job():
             )),
         )
 
-        if not request.request_id:
-            request.request_id = str(uuid.uuid4())
+        self._setup_request_id(request, 'request_id', False)
 
         # Validate the universe domain.
         self._validate_universe_domain()