diff --git a/CHANGELOG.md b/CHANGELOG.md index 9cab925d8..b5808e4b0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,13 @@ [1]: https://pypi.org/project/google-cloud-logging/#history +### [2.1.1](https://www.github.com/googleapis/python-logging/compare/v2.1.0...v2.1.1) (2021-01-14) + + +### Bug Fixes + +* use dict for http request ([#156](https://www.github.com/googleapis/python-logging/issues/156)) ([dc26668](https://www.github.com/googleapis/python-logging/commit/dc266688b1e465112de0e3fe2e8d98003f6e7033)) + ## [2.1.0](https://www.github.com/googleapis/python-logging/compare/v2.0.2...v2.1.0) (2021-01-12) diff --git a/LICENSE b/LICENSE index a8ee855de..d64569567 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,7 @@ - Apache License + + Apache License Version 2.0, January 2004 - https://www.apache.org/licenses/ + http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION @@ -192,7 +193,7 @@ you may not use this file except in compliance with the License. You may obtain a copy of the License at - https://www.apache.org/licenses/LICENSE-2.0 + http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, diff --git a/docs/_static/custom.css b/docs/_static/custom.css index 0abaf229f..bcd37bbd3 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -1,4 +1,9 @@ div#python2-eol { border-color: red; border-width: medium; -} \ No newline at end of file +} + +/* Ensure minimum width for 'Parameters' / 'Returns' column */ +dl.field-list > dt { + min-width: 100px +} diff --git a/google/cloud/logging_v2/handlers/_helpers.py b/google/cloud/logging_v2/handlers/_helpers.py index 9821e95af..5a4abdbcc 100644 --- a/google/cloud/logging_v2/handlers/_helpers.py +++ b/google/cloud/logging_v2/handlers/_helpers.py @@ -23,7 +23,6 @@ flask = None from google.cloud.logging_v2.handlers.middleware.request import _get_django_request -from google.logging.type.http_request_pb2 import HttpRequest _DJANGO_TRACE_HEADER = "HTTP_X_CLOUD_TRACE_CONTEXT" _DJANGO_USERAGENT_HEADER = "HTTP_USER_AGENT" @@ -55,7 +54,7 @@ def get_request_data_from_flask(): """Get http_request and trace data from flask request headers. Returns: - Tuple[Optional[google.logging.type.http_request_pb2.HttpRequest], Optional[str]]: + Tuple[Optional[dict], Optional[str]]: Data related to the current http request and the trace_id for the request. Both fields will be None if a flask request isn't found. """ @@ -63,15 +62,15 @@ def get_request_data_from_flask(): return None, None # build http_request - http_request = HttpRequest( - request_method=flask.request.method, - request_url=flask.request.url, - request_size=flask.request.content_length, - user_agent=flask.request.user_agent.string, - remote_ip=flask.request.remote_addr, - referer=flask.request.referrer, - protocol=flask.request.environ.get(_PROTOCOL_HEADER), - ) + http_request = { + "requestMethod": flask.request.method, + "requestUrl": flask.request.url, + "requestSize": flask.request.content_length, + "userAgent": flask.request.user_agent.string, + "remoteIp": flask.request.remote_addr, + "referer": flask.request.referrer, + "protocol": flask.request.environ.get(_PROTOCOL_HEADER), + } # find trace id trace_id = None @@ -86,7 +85,7 @@ def get_request_data_from_django(): """Get http_request and trace data from django request headers. Returns: - Tuple[Optional[google.logging.type.http_request_pb2.HttpRequest], Optional[str]]: + Tuple[Optional[dict], Optional[str]]: Data related to the current http request and the trace_id for the request. Both fields will be None if a django request isn't found. """ @@ -95,15 +94,15 @@ def get_request_data_from_django(): if request is None: return None, None # build http_request - http_request = HttpRequest( - request_method=request.method, - request_url=request.build_absolute_uri(), - request_size=len(request.body), - user_agent=request.META.get(_DJANGO_USERAGENT_HEADER), - remote_ip=request.META.get(_DJANGO_REMOTE_ADDR_HEADER), - referer=request.META.get(_DJANGO_REFERER_HEADER), - protocol=request.META.get(_PROTOCOL_HEADER), - ) + http_request = { + "requestMethod": request.method, + "requestUrl": request.build_absolute_uri(), + "requestSize": len(request.body), + "userAgent": request.META.get(_DJANGO_USERAGENT_HEADER), + "remoteIp": request.META.get(_DJANGO_REMOTE_ADDR_HEADER), + "referer": request.META.get(_DJANGO_REFERER_HEADER), + "protocol": request.META.get(_PROTOCOL_HEADER), + } # find trace id trace_id = None @@ -119,7 +118,7 @@ def get_request_data(): frameworks (currently supported: Flask and Django). Returns: - Tuple[Optional[google.logging.type.http_request_pb2.HttpRequest], Optional[str]]: + Tuple[Optional[dict], Optional[str]]: Data related to the current http request and the trace_id for the request. Both fields will be None if a supported web request isn't found. """ diff --git a/samples/snippets/requirements.txt b/samples/snippets/requirements.txt index b071a67f3..759dba97e 100644 --- a/samples/snippets/requirements.txt +++ b/samples/snippets/requirements.txt @@ -1,4 +1,4 @@ google-cloud-logging==2.0.2 google-cloud-storage==1.35.0 google-cloud-pubsub==2.2.0 -google-cloud-bigquery==2.6.1 +google-cloud-bigquery==2.6.2 diff --git a/setup.py b/setup.py index 96df33d25..4009bca9a 100644 --- a/setup.py +++ b/setup.py @@ -22,7 +22,7 @@ name = "google-cloud-logging" description = "Stackdriver Logging API client library" -version = "2.1.0" +version = "2.1.1" # Should be one of: # 'Development Status :: 3 - Alpha' # 'Development Status :: 4 - Beta' diff --git a/synth.metadata b/synth.metadata index d3cd0a5cc..a74610af8 100644 --- a/synth.metadata +++ b/synth.metadata @@ -4,7 +4,7 @@ "git": { "name": ".", "remote": "https://github.com/googleapis/python-logging.git", - "sha": "f81e7a694d24f3ba2ad4380bbf500b8bc463e314" + "sha": "212b4143d4e681356efc4bccff35cf7a435717ca" } }, { @@ -19,14 +19,14 @@ "git": { "name": "synthtool", "remote": "https://github.com/googleapis/synthtool.git", - "sha": "373861061648b5fe5e0ac4f8a38b32d639ee93e4" + "sha": "41a4e56982620d3edcf110d76f4fcdfdec471ac8" } }, { "git": { "name": "synthtool", "remote": "https://github.com/googleapis/synthtool.git", - "sha": "373861061648b5fe5e0ac4f8a38b32d639ee93e4" + "sha": "41a4e56982620d3edcf110d76f4fcdfdec471ac8" } } ], diff --git a/tests/unit/handlers/test__helpers.py b/tests/unit/handlers/test__helpers.py index 8fb37305b..f1d89dffc 100644 --- a/tests/unit/handlers/test__helpers.py +++ b/tests/unit/handlers/test__helpers.py @@ -17,9 +17,9 @@ import mock _FLASK_TRACE_ID = "flask-id" -_FLASK_HTTP_REQUEST = {"request_url": "https://flask.palletsprojects.com/en/1.1.x/"} +_FLASK_HTTP_REQUEST = {"requestUrl": "https://flask.palletsprojects.com/en/1.1.x/"} _DJANGO_TRACE_ID = "django-id" -_DJANGO_HTTP_REQUEST = {"request_url": "https://www.djangoproject.com/"} +_DJANGO_HTTP_REQUEST = {"requestUrl": "https://www.djangoproject.com/"} class Test_get_request_data_from_flask(unittest.TestCase): @@ -47,7 +47,7 @@ def test_no_context_header(self): http_request, trace_id = self._call_fut() self.assertIsNone(trace_id) - self.assertEqual(http_request.request_method, "GET") + self.assertEqual(http_request["requestMethod"], "GET") def test_valid_context_header(self): flask_trace_header = "X_CLOUD_TRACE_CONTEXT" @@ -63,7 +63,7 @@ def test_valid_context_header(self): http_request, trace_id = self._call_fut() self.assertEqual(trace_id, expected_trace_id) - self.assertEqual(http_request.request_method, "GET") + self.assertEqual(http_request["requestMethod"], "GET") def test_http_request_populated(self): expected_path = "http://testserver/123" @@ -86,13 +86,13 @@ def test_http_request_populated(self): ) http_request, trace_id = self._call_fut() - self.assertEqual(http_request.request_method, "PUT") - self.assertEqual(http_request.request_url, expected_path) - self.assertEqual(http_request.user_agent, expected_agent) - self.assertEqual(http_request.referer, expected_referrer) - self.assertEqual(http_request.remote_ip, expected_ip) - self.assertEqual(http_request.request_size, len(body_content)) - self.assertEqual(http_request.protocol, "HTTP/1.1") + self.assertEqual(http_request["requestMethod"], "PUT") + self.assertEqual(http_request["requestUrl"], expected_path) + self.assertEqual(http_request["userAgent"], expected_agent) + self.assertEqual(http_request["referer"], expected_referrer) + self.assertEqual(http_request["remoteIp"], expected_ip) + self.assertEqual(http_request["requestSize"], len(body_content)) + self.assertEqual(http_request["protocol"], "HTTP/1.1") def test_http_request_sparse(self): expected_path = "http://testserver/123" @@ -100,9 +100,9 @@ def test_http_request_sparse(self): with app.test_client() as c: c.put(path=expected_path) http_request, trace_id = self._call_fut() - self.assertEqual(http_request.request_method, "PUT") - self.assertEqual(http_request.request_url, expected_path) - self.assertEqual(http_request.protocol, "HTTP/1.1") + self.assertEqual(http_request["requestMethod"], "PUT") + self.assertEqual(http_request["requestUrl"], expected_path) + self.assertEqual(http_request["protocol"], "HTTP/1.1") class Test_get_request_data_from_django(unittest.TestCase): @@ -136,7 +136,7 @@ def test_no_context_header(self): middleware = request.RequestMiddleware(None) middleware.process_request(django_request) http_request, trace_id = self._call_fut() - self.assertEqual(http_request.request_method, "GET") + self.assertEqual(http_request["requestMethod"], "GET") self.assertIsNone(trace_id) def test_valid_context_header(self): @@ -156,7 +156,7 @@ def test_valid_context_header(self): http_request, trace_id = self._call_fut() self.assertEqual(trace_id, expected_trace_id) - self.assertEqual(http_request.request_method, "GET") + self.assertEqual(http_request["requestMethod"], "GET") def test_http_request_populated(self): from django.test import RequestFactory @@ -176,13 +176,13 @@ def test_http_request_populated(self): middleware = request.RequestMiddleware(None) middleware.process_request(django_request) http_request, trace_id = self._call_fut() - self.assertEqual(http_request.request_method, "PUT") - self.assertEqual(http_request.request_url, expected_path) - self.assertEqual(http_request.user_agent, expected_agent) - self.assertEqual(http_request.referer, expected_referrer) - self.assertEqual(http_request.remote_ip, "127.0.0.1") - self.assertEqual(http_request.request_size, len(body_content)) - self.assertEqual(http_request.protocol, "HTTP/1.1") + self.assertEqual(http_request["requestMethod"], "PUT") + self.assertEqual(http_request["requestUrl"], expected_path) + self.assertEqual(http_request["userAgent"], expected_agent) + self.assertEqual(http_request["referer"], expected_referrer) + self.assertEqual(http_request["remoteIp"], "127.0.0.1") + self.assertEqual(http_request["requestSize"], len(body_content)) + self.assertEqual(http_request["protocol"], "HTTP/1.1") def test_http_request_sparse(self): from django.test import RequestFactory @@ -193,10 +193,10 @@ def test_http_request_sparse(self): middleware = request.RequestMiddleware(None) middleware.process_request(django_request) http_request, trace_id = self._call_fut() - self.assertEqual(http_request.request_method, "PUT") - self.assertEqual(http_request.request_url, expected_path) - self.assertEqual(http_request.remote_ip, "127.0.0.1") - self.assertEqual(http_request.protocol, "HTTP/1.1") + self.assertEqual(http_request["requestMethod"], "PUT") + self.assertEqual(http_request["requestUrl"], expected_path) + self.assertEqual(http_request["remoteIp"], "127.0.0.1") + self.assertEqual(http_request["protocol"], "HTTP/1.1") class Test_get_request_data(unittest.TestCase):