Skip to content

feat(bigtable): pass Python client version to accelerator daemon for User-Agent prefixing #6

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

Open
mutianf wants to merge 1 commit into from
+27 −0
Open

feat(bigtable): pass Python client version to accelerator daemon for User-Agent prefixing #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions packages/google-cloud-bigtable/google/cloud/bigtable/data/_async/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -420,6 +420,14 @@ def _init_accelerator_config(
credentials_file
)

# Identify this client to the daemon so it can construct the full
# User-Agent prefix (e.g. "python-v3.0.0a0-go-accelerator-v3.x.x").
# The daemon appends its own "-go-accelerator-vX.Y.Z" suffix.
self._accelerator_flags += [
"--caller-user-agent",
f"python-v{google.cloud.bigtable.__version__}",
]

def _resolve_principal(self) -> str | None:
"""Resolve this client's identity to a principal, using only local
signals — never a token-introspection or other external network call.
Expand Down
4 changes: 4 additions & 0 deletions packages/google-cloud-bigtable/google/cloud/bigtable/data/_sync_autogen/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,10 @@ def _init_accelerator_config(
self._accelerator_env["GOOGLE_APPLICATION_CREDENTIALS"] = (
credentials_file
)
self._accelerator_flags += [
"--caller-user-agent",
f"python-v{google.cloud.bigtable.__version__}",
]

def _resolve_principal(self) -> str | None:
"""Resolve this client's identity to a principal, using only local
Expand Down
15 changes: 15 additions & 0 deletions packages/google-cloud-bigtable/tests/unit/data/test_accelerator_credentials.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
from google.api_core.client_options import ClientOptions
from google.auth import compute_engine

import google.cloud.bigtable
from google.cloud.bigtable.data._async.client import (
BigtableDataClientAsync,
_AcceleratorUnverified,
Expand Down Expand Up @@ -110,6 +111,20 @@ def test_credentials_file_forwarded_as_env_path(self):
# The path is not a "secret" that blocks acceleration.
assert c._accelerator_blocked_reason is None

def test_caller_user_agent_always_forwarded(self):
c = _bare_client()
c._init_accelerator_config(explicit_credentials=False, client_options=None)
flags = c._accelerator_flags
expected = f"python-v{google.cloud.bigtable.__version__}"
assert flags[flags.index("--caller-user-agent") + 1] == expected

def test_caller_user_agent_forwarded_even_when_blocked(self):
c = _bare_client()
c._init_accelerator_config(explicit_credentials=True, client_options=None)
flags = c._accelerator_flags
expected = f"python-v{google.cloud.bigtable.__version__}"
assert flags[flags.index("--caller-user-agent") + 1] == expected


class TestResolvePrincipal:
def test_service_account_email(self):
Expand Down
Loading