fix(api-core): filter bound path and body fields from required fields in query params

Author: hebaalazzeh

packages/google-api-core/google/api_core/rest_helpers.py

@@ -160,9 +160,33 @@ def transcode_request(
         )
 
     if required_fields_default_values:
-        for k, v in required_fields_default_values.items():
-            if k not in query_params_json:
-                query_params_json[k] = v
+        matched_option = None
+        for option in http_options:
+            if option.get("method", "").lower() == transcoded_request.get("method", "").lower():
+                if path_template.validate(option.get("uri", ""), transcoded_request.get("uri", "")):
+                    matched_option = option
+                    break
+
+        bound_fields = set()
+        if matched_option:
+            uri_template = matched_option.get("uri", "")
+            for m in path_template._VARIABLE_RE.finditer(uri_template):
+                name = m.group("name")
+                if name:
+                    bound_fields.add(name.split(".")[0])
+            body_param = matched_option.get("body")
+            if body_param:
+                if body_param == "*":
+                    bound_fields = None
+                else:
+                    bound_fields.add(body_param.split(".")[0])
+
+        if bound_fields is not None:
+            for k, v in required_fields_default_values.items():
+                if k in bound_fields:
+                    continue
+                if k not in query_params_json:
+                    query_params_json[k] = v
 
     if rest_numeric_enums:
         query_params_json["$alt"] = "json;enum-encoding=int"

packages/google-api-core/tests/unit/test_rest_helpers.py

@@ -276,3 +276,32 @@ def test_transcode_request_proto_plus_wrapper():
 
     transcoded, _, _ = transcode_request(http_options, mock_proto_plus)
     assert transcoded["uri"] == "/v1/test/proto-plus-field"
+
+
+def test_transcode_required_fields_bound_to_path():
+    http_options = [{"method": "get", "uri": "/v1/test/{name}"}]
+    request = descriptor_pb2.FieldDescriptorProto()
+    request.name = "my-name"
+
+    required_defaults = {"name": "default-name", "filter": "default-filter"}
+    transcoded, _, query_params = transcode_request(
+        http_options, request, required_fields_default_values=required_defaults
+    )
+
+    assert transcoded["uri"] == "/v1/test/my-name"
+    assert "name" not in query_params
+    assert query_params["filter"] == "default-filter"
+
+
+def test_transcode_required_fields_bound_to_body_star():
+    http_options = [{"method": "post", "uri": "/v1/test", "body": "*"}]
+    request = descriptor_pb2.FieldDescriptorProto()
+    request.name = "my-name"
+
+    required_defaults = {"name": "default-name"}
+    _, body, query_params = transcode_request(
+        http_options, request, required_fields_default_values=required_defaults
+    )
+
+    assert body is not None
+    assert query_params == {}