Skip to content

Commit

Permalink
use proto instead of dict for http_request
Browse files Browse the repository at this point in the history
  • Loading branch information
@daniel-sanche
daniel-sanche committed Dec 11, 2020
1 parent 5bb9e51 commit e462b5f
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 75 deletions.
47 changes: 22 additions & 25 deletions google/cloud/logging_v2/handlers/_helpers.py
View file
Expand Up @@ -23,6 +23,7 @@
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_LENGTH_HEADER = "CONTENT_LENGTH"
Expand Down Expand Up @@ -56,22 +57,19 @@ def get_request_data_from_flask():
Returns:
str: TraceID in HTTP request headers.
dict: data about the associated http request.
HttpRequest: data about the associated http request.
"""
if flask is None or not flask.request:
return None, None

# build http_request
length = flask.request.content_length
http_request = {
"request_method": flask.request.method,
"request_url": flask.request.url,
"request_size": str(length) if length else None,
"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 = 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),
)

# find trace id
trace_id = None
Expand All @@ -87,23 +85,22 @@ def get_request_data_from_django():
Returns:
str: TraceID in HTTP request headers.
dict: data about the associated http request.
HttpRequest: data about the associated http request.
"""
request = _get_django_request()

if request is None:
return None, None

# build http_request
http_request = {
"request_method": request.method,
"request_url": request.build_absolute_uri(),
"request_size": request.META.get(_DJANGO_LENGTH_HEADER),
"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 = 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),
)

# find trace id
trace_id = None
Expand All @@ -120,7 +117,7 @@ def get_request_data():
Returns:
str: TraceID in HTTP request headers.
dict: data about the associated http request.
HttpRequest: data about the associated http request.
"""
checkers = (
get_request_data_from_django,
Expand Down
75 changes: 25 additions & 50 deletions tests/unit/handlers/test__helpers.py
View file
Expand Up @@ -20,15 +20,6 @@
_FLASK_HTTP_REQUEST = {"request_url": "https://flask.palletsprojects.com/en/1.1.x/"}
_DJANGO_TRACE_ID = "django-id"
_DJANGO_HTTP_REQUEST = {"request_url": "https://www.djangoproject.com/"}
_HTTP_REQUEST_FIELDS = [
"request_method",
"request_url",
"request_size",
"user_agent",
"remote_ip",
"referer",
"protocol",
]


class Test_get_request_data_from_flask(unittest.TestCase):
Expand Down Expand Up @@ -56,10 +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(set(http_request.keys()), set(_HTTP_REQUEST_FIELDS))
for field in _HTTP_REQUEST_FIELDS:
self.assertTrue(field in http_request)
self.assertEqual(http_request.request_method, "GET")

def test_valid_context_header(self):
flask_trace_header = "X_CLOUD_TRACE_CONTEXT"
Expand All @@ -75,8 +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(set(http_request.keys()), set(_HTTP_REQUEST_FIELDS))
self.assertEqual(http_request.request_method, "GET")

def test_http_request_populated(self):
expected_path = "http://testserver/123"
Expand All @@ -99,27 +86,23 @@ 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"], str(len(body_content)))
self.assertEqual(http_request["protocol"], "HTTP/1.1")
self.assertEqual(set(http_request.keys()), set(_HTTP_REQUEST_FIELDS))
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")

def test_http_request_sparse(self):
expected_path = "http://testserver/123"
app = self.create_app()
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.assertIsNone(http_request["referer"])
self.assertIsNone(http_request["request_size"])
self.assertEqual(set(http_request.keys()), set(_HTTP_REQUEST_FIELDS))
self.assertEqual(http_request.request_method, "PUT")
self.assertEqual(http_request.request_url, expected_path)
self.assertEqual(http_request.protocol, "HTTP/1.1")


class Test_get_request_data_from_django(unittest.TestCase):
Expand Down Expand Up @@ -153,8 +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(set(http_request.keys()), set(_HTTP_REQUEST_FIELDS))
self.assertEqual(http_request.request_method, "GET")
self.assertIsNone(trace_id)

def test_valid_context_header(self):
Expand All @@ -174,10 +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(set(http_request.keys()), set(_HTTP_REQUEST_FIELDS))
for field in _HTTP_REQUEST_FIELDS:
self.assertTrue(field in http_request)
self.assertEqual(http_request.request_method, "GET")

def test_http_request_populated(self):
from django.test import RequestFactory
Expand All @@ -197,14 +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"], str(len(body_content)))
self.assertEqual(http_request["protocol"], "HTTP/1.1")
self.assertEqual(set(http_request.keys()), set(_HTTP_REQUEST_FIELDS))
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")

def test_http_request_sparse(self):
from django.test import RequestFactory
Expand All @@ -215,13 +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.assertIsNone(http_request["referer"])
self.assertEqual(http_request["remote_ip"], "127.0.0.1")
self.assertIsNone(http_request["request_size"])
self.assertEqual(http_request["protocol"], "HTTP/1.1")
self.assertEqual(set(http_request.keys()), set(_HTTP_REQUEST_FIELDS))
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")


class Test_get_request_data(unittest.TestCase):
Expand Down

0 comments on commit e462b5f

Please sign in to comment.