Commit be56a0f

authored

chore: Add X-Goog-Api-Client metric header to requests (#826)

1 parent 32e8dd2 commit be56a0fCopy full SHA for be56a0f

File tree

+255

-279

lines changed

+255

-279

lines changed

Lines changed: 5 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@`
`21`	`21`	`import requests`
`22`	`22`	`from requests.packages.urllib3.util import retry # pylint: disable=import-error`
`23`	`23`
	`24`	`+from firebase_admin import _utils`
`24`	`25`
`25`	`26`	`if hasattr(retry.Retry.DEFAULT, 'allowed_methods'):`
`26`	`27`	`_ANY_METHOD = {'allowed_methods': None}`
`@@ -36,6 +37,9 @@`
`36`	`37`
`37`	`38`	`DEFAULT_TIMEOUT_SECONDS = 120`
`38`	`39`
	`40`	`+METRICS_HEADERS = {`
	`41`	`+ 'X-GOOG-API-CLIENT': _utils.get_metrics_header(),`
	`42`	`+}`
`39`	`43`
`40`	`44`	`class HttpClient:`
`41`	`45`	`"""Base HTTP client used to make HTTP calls.`
`@@ -72,6 +76,7 @@ def __init__(`
`72`	`76`
`73`	`77`	`if headers:`
`74`	`78`	`self._session.headers.update(headers)`
	`79`	`+ self._session.headers.update(METRICS_HEADERS)`
`75`	`80`	`if retries:`
`76`	`81`	`self._session.mount('http://', requests.adapters.HTTPAdapter(max_retries=retries))`
`77`	`82`	`self._session.mount('https://', requests.adapters.HTTPAdapter(max_retries=retries))`

Lines changed: 3 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@`
`15`	`15`	`"""Internal utilities common to all modules."""`
`16`	`16`
`17`	`17`	`import json`
	`18`	`+from platform import python_version`
`18`	`19`
`19`	`20`	`import google.auth`
`20`	`21`	`import requests`
`@@ -75,6 +76,8 @@`
`75`	`76`	`16: exceptions.UNAUTHENTICATED,`
`76`	`77`	`}`
`77`	`78`
	`79`	`+def get_metrics_header():`
	`80`	`+ return f'gl-python/{python_version()} fire-admin/{firebase_admin.__version__}'`
`78`	`81`
`79`	`82`	`def _get_initialized_app(app):`
`80`	`83`	`"""Returns a reference to an initialized App instance."""`

Lines changed: 6 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,10 @@ class _AppCheckService:`
`51`	`51`	`_scoped_project_id = None`
`52`	`52`	`_jwks_client = None`
`53`	`53`
	`54`	`+ _APP_CHECK_HEADERS = {`
	`55`	`+ 'X-GOOG-API-CLIENT': _utils.get_metrics_header(),`
	`56`	`+ }`
	`57`	`+`
`54`	`58`	`def __init__(self, app):`
`55`	`59`	`# Validate and store the project_id to validate the JWT claims`
`56`	`60`	`self._project_id = app.project_id`
`@@ -62,7 +66,8 @@ def __init__(self, app):`
`62`	`66`	`'GOOGLE_CLOUD_PROJECT environment variable.')`
`63`	`67`	`self._scoped_project_id = 'projects/' + app.project_id`
`64`	`68`	`# Default lifespan is 300 seconds (5 minutes) so we change it to 21600 seconds (6 hours).`
`65`		`- self._jwks_client = PyJWKClient(self._JWKS_URL, lifespan=21600)`
	`69`	`+ self._jwks_client = PyJWKClient(`
	`70`	`+ self._JWKS_URL, lifespan=21600, headers=self._APP_CHECK_HEADERS)`
`66`	`71`
`67`	`72`
`68`	`73`	`def verify_token(self, token: str) -> Dict[str, Any]:`

Lines changed: 6 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -55,8 +55,13 @@ def bucket(name=None, app=None) -> storage.Bucket:`
`55`	`55`	`class _StorageClient:`
`56`	`56`	`"""Holds a Google Cloud Storage client instance."""`
`57`	`57`
	`58`	`+ STORAGE_HEADERS = {`
	`59`	`+ 'X-GOOG-API-CLIENT': _utils.get_metrics_header(),`
	`60`	`+ }`
	`61`	`+`
`58`	`62`	`def __init__(self, credentials, project, default_bucket):`
`59`		`- self._client = storage.Client(credentials=credentials, project=project)`
	`63`	`+ self._client = storage.Client(`
	`64`	`+ credentials=credentials, project=project, extra_headers=self.STORAGE_HEADERS)`
`60`	`65`	`self._default_bucket = default_bucket`
`61`	`66`
`62`	`67`	`@classmethod`

Comments

(0)