Skip to content

chore: allow custom routing header metadata #2079

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
daniel-sanche wants to merge 17 commits into from
Closed

chore: allow custom routing header metadata #2079

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
fd89824
chore: allow custom routing header metadata
daniel-sanche Jul 26, 2024
aa946fd
fixed format
daniel-sanche Jul 27, 2024
cdf2508
fix tuple output
daniel-sanche Jul 27, 2024
d2390fa
Merge branch 'main' into routing_headers
daniel-sanche Jul 27, 2024
b67603f
updated goldens
daniel-sanche Jul 27, 2024
b99f318
added test
daniel-sanche Jul 27, 2024
9d1229c
fixed typo
daniel-sanche Jul 27, 2024
c95f9d1
update all instances
daniel-sanche Jul 30, 2024
f076d02
updated goldens
daniel-sanche Jul 30, 2024
f1a7c35
Merge branch 'main' into routing_headers
daniel-sanche Jul 30, 2024
96870ef
generate tests for all methods
daniel-sanche Jul 31, 2024
59b5545
added conditional to explicit routing
daniel-sanche Aug 1, 2024
6c1252d
added async routing header test
daniel-sanche Aug 1, 2024
f17458c
gate async behind full_extended_lro
daniel-sanche Aug 1, 2024
8ee23e3
removed unneeded line
daniel-sanche Aug 1, 2024
3a54caf
removed space
daniel-sanche Aug 1, 2024
09a0d01
generated goldens
daniel-sanche Aug 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
150 changes: 90 additions & 60 deletions gapic/templates/%namespace/%name_%version/%sub/services/%service/_async_mixins.py.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,15 @@
client_info=DEFAULT_CLIENT_INFO,
)

# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata(
(("name", request.name),)),
)
# Attach routing header to metadata if not already present
metadata = tuple(metadata)
if all(m[0] != gapic_v1.routing_header.ROUTING_METADATA_KEY for m in metadata):
metadata = (
*metadata,
gapic_v1.routing_header.to_grpc_metadata((
(("name", request.name),)
))
)

# Validate the universe domain.
self._client._validate_universe_domain()
Expand Down Expand Up @@ -97,12 +100,15 @@
client_info=DEFAULT_CLIENT_INFO,
)

# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata(
(("name", request.name),)),
)
# Attach routing header to metadata if not already present
metadata = tuple(metadata)
if all(m[0] != gapic_v1.routing_header.ROUTING_METADATA_KEY for m in metadata):
metadata = (
*metadata,
gapic_v1.routing_header.to_grpc_metadata((
(("name", request.name),)
))
)

# Validate the universe domain.
self._client._validate_universe_domain()
Expand Down Expand Up @@ -157,12 +163,15 @@
client_info=DEFAULT_CLIENT_INFO,
)

# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata(
(("name", request.name),)),
)
# Attach routing header to metadata if not already present
metadata = tuple(metadata)
if all(m[0] != gapic_v1.routing_header.ROUTING_METADATA_KEY for m in metadata):
metadata = (
*metadata,
gapic_v1.routing_header.to_grpc_metadata((
(("name", request.name),)
))
)

# Validate the universe domain.
self._client._validate_universe_domain()
Expand Down Expand Up @@ -212,12 +221,15 @@
client_info=DEFAULT_CLIENT_INFO,
)

# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata(
(("name", request.name),)),
)
# Attach routing header to metadata if not already present
metadata = tuple(metadata)
if all(m[0] != gapic_v1.routing_header.ROUTING_METADATA_KEY for m in metadata):
metadata = (
*metadata,
gapic_v1.routing_header.to_grpc_metadata((
(("name", request.name),)
))
)

# Validate the universe domain.
self._client._validate_universe_domain()
Expand Down Expand Up @@ -270,12 +282,15 @@
client_info=DEFAULT_CLIENT_INFO,
)

# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata(
(("name", request.name),)),
)
# Attach routing header to metadata if not already present
metadata = tuple(metadata)
if all(m[0] != gapic_v1.routing_header.ROUTING_METADATA_KEY for m in metadata):
metadata = (
*metadata,
gapic_v1.routing_header.to_grpc_metadata((
(("name", request.name),)
))
)

# Validate the universe domain.
self._client._validate_universe_domain()
Expand Down Expand Up @@ -397,12 +412,15 @@
client_info=DEFAULT_CLIENT_INFO,
)

# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata(
(("resource", request.resource),)),
)
# Attach routing header to metadata if not already present
metadata = tuple(metadata)
if all(m[0] != gapic_v1.routing_header.ROUTING_METADATA_KEY for m in metadata):
metadata = (
*metadata,
gapic_v1.routing_header.to_grpc_metadata((
("resource", request.resource),)
)
)

# Validate the universe domain.
self._client._validate_universe_domain()
Expand Down Expand Up @@ -520,12 +538,15 @@
client_info=DEFAULT_CLIENT_INFO,
)

# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata(
(("resource", request.resource),)),
)
# Attach routing header to metadata if not already present
metadata = tuple(metadata)
if all(m[0] != gapic_v1.routing_header.ROUTING_METADATA_KEY for m in metadata):
metadata = (
*metadata,
gapic_v1.routing_header.to_grpc_metadata((
("resource", request.resource),)
)
)

# Validate the universe domain.
self._client._validate_universe_domain()
Expand Down Expand Up @@ -581,12 +602,15 @@
client_info=DEFAULT_CLIENT_INFO,
)

# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata(
(("resource", request.resource),)),
)
# Attach routing header to metadata if not already present
metadata = tuple(metadata)
if all(m[0] != gapic_v1.routing_header.ROUTING_METADATA_KEY for m in metadata):
metadata = (
*metadata,
gapic_v1.routing_header.to_grpc_metadata((
("resource", request.resource),)
)
)

# Validate the universe domain.
self._client._validate_universe_domain()
Expand Down Expand Up @@ -641,12 +665,15 @@
client_info=DEFAULT_CLIENT_INFO,
)

# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata(
(("name", request.name),)),
)
# Attach routing header to metadata if not already present
metadata = tuple(metadata)
if all(m[0] != gapic_v1.routing_header.ROUTING_METADATA_KEY for m in metadata):
metadata = (
*metadata,
gapic_v1.routing_header.to_grpc_metadata((
("name", request.name),)
)
)

# Validate the universe domain.
self._client._validate_universe_domain()
Expand Down Expand Up @@ -697,12 +724,15 @@
client_info=DEFAULT_CLIENT_INFO,
)

# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata(
(("name", request.name),)),
)
# Attach routing header to metadata if not already present
metadata = tuple(metadata)
if all(m[0] != gapic_v1.routing_header.ROUTING_METADATA_KEY for m in metadata):
metadata = (
*metadata,
gapic_v1.routing_header.to_grpc_metadata((
("name", request.name),)
)
)

# Validate the universe domain.
self._client._validate_universe_domain()
Expand Down
67 changes: 36 additions & 31 deletions gapic/templates/%namespace/%name_%version/%sub/services/%service/_client_macros.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,43 +144,48 @@
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.{{ method.transport_safe_name|snake_case}}]

metadata = tuple(metadata)
{% if method.explicit_routing %}
header_params = {}
{% if not method.client_streaming %}
{% for routing_param in method.routing_rule.routing_parameters %}
{% if routing_param.path_template %} {# Need to match. #}
# Attach routing header to metadata if not already present
if all(m[0] != gapic_v1.routing_header.ROUTING_METADATA_KEY for m in metadata):
header_params = {}
{% if not method.client_streaming %}
{% for routing_param in method.routing_rule.routing_parameters %}
{% if routing_param.path_template %} {# Need to match. #}

routing_param_regex = {{ routing_param.to_regex() }}
regex_match = routing_param_regex.match(request.{{ routing_param.field }})
if regex_match and regex_match.group("{{ routing_param.key }}"):
header_params["{{ routing_param.key }}"] = regex_match.group("{{ routing_param.key }}")
routing_param_regex = {{ routing_param.to_regex() }}
regex_match = routing_param_regex.match(request.{{ routing_param.field }})
if regex_match and regex_match.group("{{ routing_param.key }}"):
header_params["{{ routing_param.key }}"] = regex_match.group("{{ routing_param.key }}")

{% else %}
{% else %}

if request.{{ routing_param.field }}:
header_params["{{ routing_param.key }}"] = request.{{ routing_param.field }}
if request.{{ routing_param.field }}:
header_params["{{ routing_param.key }}"] = request.{{ routing_param.field }}

{% endif %}
{% endfor %} {# method.routing_rule.routing_parameters #}
{% endif %} {# if not method.client_streaming #}

if header_params:
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata(header_params),
{% endif %}
{% endfor %} {# method.routing_rule.routing_parameters #}
{% endif %} {# if not method.client_streaming #}

if header_params:
metadata = (
*metadata,
gapic_v1.routing_header.to_grpc_metadata(header_params),
)

{% elif method.field_headers %}{# implicit routing #}
# Attach routing header to metadata if not already present
if all(m[0] != gapic_v1.routing_header.ROUTING_METADATA_KEY for m in metadata):
metadata = (
*metadata,
gapic_v1.routing_header.to_grpc_metadata((
{% for field_header in method.field_headers %}
{% if not method.client_streaming %}
("{{ field_header.raw }}", request.{{ field_header.disambiguated }}),
{% endif %}
{% endfor %}
))
)

{% elif method.field_headers %} {# implicit routing #}
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((
{% for field_header in method.field_headers %}
{% if not method.client_streaming %}
("{{ field_header.raw }}", request.{{ field_header.disambiguated }}),
{% endif %}
{% endfor %}
)),
)
{% endif %} {# method.explicit_routing #}

{{ shared_macros.add_api_version_header_to_metadata(service.version) }}
Expand Down
Loading