Fix dynamic route param handling and add pretty logs

Author: paulcruse3

acai_aws/apigateway/request.py

@@ -14,7 +14,7 @@ def __init__(self, event, lambda_context=None, timeout=None):
         self.__timeout = timeout
         self.__body = event['body'] if event.get('body') is not None else {}
         self.__route = event['path'] if event.get('path') is not None else ''
-        self.__path_params = event['pathParameters'] if event.get('pathParameters') is not None else ''
+        self.__path_params = event['pathParameters'] if isinstance(event.get('pathParameters'), dict) else {}
         self.__request_context = event['requestContext'] if event.get('requestContext') is not None else {}
         self.__domain = event.get('requestContext', {}).get('domainName', '')
         self.__stage = event.get('requestContext', {}).get('stage', '')
@@ -152,6 +152,8 @@ def path_params(self):
     @path_params.setter
     def path_params(self, path_params):
         key, value = path_params
+        if not isinstance(self.__path_params, dict):
+            self.__path_params = {}
         self.__path_params[key] = value
 
     @property

acai_aws/apigateway/resolver/__init__.py

@@ -1,3 +1,5 @@
+from urllib.parse import unquote
+
 from acai_aws.apigateway.resolver.cache import ResolverCache
 from acai_aws.apigateway.endpoint import Endpoint
 from acai_aws.apigateway.exception import ApiException
@@ -99,4 +101,4 @@ def __apply_dynamic_route_params(self, request, required_route_parts):
                     message='no route found; endpoint does not have proper variables in required_route'
                 )
             dynamic_name = variable_name.strip('{').strip('}')
-            request.path_params = dynamic_name, self.__resolver.dynamic_parts[part]
+            request.path_params = dynamic_name, unquote(self.__resolver.dynamic_parts[part])

acai_aws/common/logger/common_logger.py

@@ -19,13 +19,15 @@ def __init__(self):
             'WARN': 2,
             'ERROR': 3
         }
-        if self.__format not in ['JSON', 'INLINE']:
-            raise ValueError(f'LOG_FORMAT ENV must be either `JSON` or `INLINE`, recieved: {self.__format}')
+        if self.__format not in ['JSON', 'PRETTY', 'INLINE']:
+            raise ValueError(f'LOG_FORMAT ENV must be either `JSON`, `PRETTY`, or `INLINE`, recieved: {self.__format}')
 
     def log(self, **kwargs):
         default_log = {'level': kwargs.get('level', 'INFO'), 'log': kwargs.get('log', {})}
         if self.__should_log(default_log['level']) and self.__format == 'JSON':
             self.__log_json(**kwargs)
+        elif self.__should_log(default_log['level']) and self.__format == 'PRETTY':
+            self.__log_json(pretty=True, **kwargs)
         elif self.__should_log(default_log['level']) and self.__format == 'INLINE':
             self.__log_inline(**kwargs)
 
@@ -40,13 +42,13 @@ def __should_log(self, level):
         log_level_setting = self.log_levels[self.__log_level]
         return current_log_level >= log_level_setting
 
-    def __log_json(self, **kwargs):
+    def __log_json(self, pretty=False, **kwargs):
         print(self.__json.encode({
             'level': kwargs['level'],
             'time': datetime.datetime.now(datetime.timezone.utc).isoformat(),
             'trace': [trace.strip() for trace in self.__get_traceback().split('\n') if trace],
             'log': kwargs['log']
-        }, indent=4))
+        }, indent=4 if pretty else None))
 
     def __log_inline(self, **kwargs):
         timestamp = datetime.datetime.now(datetime.timezone.utc).isoformat()

tests/acai_aws/apigateway/router/test_directory_router.py

@@ -70,6 +70,45 @@ def test_basic_directory_routing_works_with_single_dynamic_route(self):
         self.assertDictEqual(self.expected_open_headers, result['headers'])
         self.assertDictEqual({'directory_user_id': {'proxy': 'user', 'user_id': '1'}}, json_dict_response)
 
+    def test_basic_directory_routing_works_with_single_dynamic_route_when_path_parameters_is_none(self):
+        dynamic_event = self.mock_request.get_dynamic_event(
+            headers={'x-api-key': 'some-key'},
+            path='unit-test/v1/user/auth0|12312490845',
+            proxy='user',
+            method='get'
+        )
+        dynamic_event['pathParameters'] = None
+        router = Router(
+            base_path=self.base_path,
+            handlers=self.handler_path,
+            output_error=True
+        )
+        result = router.route(dynamic_event, None)
+        json_dict_response = json.loads(result['body'])
+        self.assertFalse(result['isBase64Encoded'])
+        self.assertEqual(200, result['statusCode'])
+        self.assertDictEqual(self.expected_open_headers, result['headers'])
+        self.assertDictEqual({'directory_user_id': {'user_id': 'auth0|12312490845'}}, json_dict_response)
+
+    def test_basic_directory_routing_decodes_encoded_dynamic_route_values(self):
+        dynamic_event = self.mock_request.get_dynamic_event(
+            headers={'x-api-key': 'some-key'},
+            path='unit-test/v1/user/auth0%7C12312490845',
+            proxy='user',
+            method='get'
+        )
+        dynamic_event['pathParameters'] = {}
+        router = Router(
+            base_path=self.base_path,
+            handlers=self.handler_path
+        )
+        result = router.route(dynamic_event, None)
+        json_dict_response = json.loads(result['body'])
+        self.assertFalse(result['isBase64Encoded'])
+        self.assertEqual(200, result['statusCode'])
+        self.assertDictEqual(self.expected_open_headers, result['headers'])
+        self.assertDictEqual({'directory_user_id': {'user_id': 'auth0|12312490845'}}, json_dict_response)
+
     def test_basic_directory_routing_works_with_double_dynamic_route(self):
         dynamic_event = self.mock_request.get_dynamic_event(
             headers={'x-api-key': 'some-key'},

tests/acai_aws/common/test_logger.py

@@ -67,6 +67,18 @@ def test_logger_json_output(self):
         with redirect_stdout(buffer):
             logger.log(level='WARN', log={'json': True})
         log_output = buffer.getvalue().strip()
+        self.assertNotIn('\n', log_output)
+        parsed = json.loads(log_output)
+        self.assertEqual('WARN', parsed['level'])
+        self.assertEqual({'json': True}, parsed['log'])
+
+    @mock.patch.dict(os.environ, {'RUN_MODE': 'SEE-LOGS', 'LOG_STAGE_VARIABLE': 'STAGE', 'STAGE': 'local', 'LOG_FORMAT': 'PRETTY'})
+    def test_logger_pretty_output(self):
+        buffer = io.StringIO()
+        with redirect_stdout(buffer):
+            logger.log(level='WARN', log={'json': True})
+        log_output = buffer.getvalue().strip()
+        self.assertIn('\n', log_output)
         parsed = json.loads(log_output)
         self.assertEqual('WARN', parsed['level'])
         self.assertEqual({'json': True}, parsed['log'])