Merge pull request #39 from Raekkeri/ignore-users

Allow ignoring entry from specific users
Raekkeri · Jun 13, 2022 · df729dc · df729dc
2 parents adcd7c9 + b49cd05
commit df729dc
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 6 deletions.
diff --git a/requestlogs/base.py b/requestlogs/base.py
@@ -13,6 +13,8 @@
     'REQUEST_ID_HTTP_HEADER': None,
     'METHODS': ('GET', 'PUT', 'PATCH', 'POST', 'DELETE'),
     'JSON_ENSURE_ASCII': True,
+    'IGNORE_USER_FIELD': None,
+    'IGNORE_USERS': [],
 }
 
 

diff --git a/requestlogs/entries.py b/requestlogs/entries.py
@@ -102,12 +102,20 @@ def finalize(self, response):
             self.request = self.django_request_handler(self.django_request)
 
         self.response = self.response_handler(response)
+
+        if self.skip_entry():
+            return
+
         self.store()
 
     def store(self):
         storage = SETTINGS['STORAGE_CLASS']()
         storage.store(self)
 
+    def skip_entry(self):
+        if SETTINGS['IGNORE_USER_FIELD']:
+            return self.user.get(SETTINGS['IGNORE_USER_FIELD'], None) in SETTINGS['IGNORE_USERS']
+
     @property
     def user(self):
         ret = {

diff --git a/tests/test_views.py b/tests/test_views.py
@@ -65,8 +65,9 @@ def w_logging(self, request):
 
 class SimpleAuth(BaseAuthentication):
     def authenticate(self, request):
-        if request.META.get('HTTP_AUTHORIZATION') == 'Password 123':
-            return get_user_model().objects.get(), ('simple',)
+        auth = request.META.get('HTTP_AUTHORIZATION')
+        if auth:
+            return get_user_model().objects.get(password=auth), ('simple',)
 
 
 class SetUserManually(APIView):
@@ -412,8 +413,8 @@ class UserSerializer(serializers.Serializer):
 })
 class TestAuthenticationAndPermissions(APITestCase):
     def test_authenticated_user(self):
-        user = get_user_model().objects.create_user('u1')
-        self.client.credentials(HTTP_AUTHORIZATION='Password 123')
+        user = get_user_model().objects.create(username='u1', password='pw1')
+        self.client.credentials(HTTP_AUTHORIZATION='pw1')
 
         with patch('tests.test_views.UserStorage.do_store') as mocked_store:
             response = self.client.get('/user/')
@@ -462,6 +463,38 @@ def test_set_user_automatically_on_login(self):
             'user': {'id': user.id, 'username': 'u1'}}
 
 
+@override_settings(
+    ROOT_URLCONF=__name__,
+    REQUESTLOGS={
+        'STORAGE_CLASS': 'tests.test_views.UserStorage',
+        'IGNORE_USER_FIELD': 'username',
+        'IGNORE_USERS': ['u1'],
+    },
+)
+@modify_settings(MIDDLEWARE={
+    'append': 'requestlogs.middleware.RequestLogsMiddleware',
+})
+class TestIgnoreUser(APITestCase):
+    def test_ignore_entry_of_user(self):
+        user1 = get_user_model().objects.create(username='u1', password='pw1')
+        user2 = get_user_model().objects.create(username='other', password='pw2')
+
+        with patch('tests.test_views.TestStorage.do_store') as mocked_store:
+            self.client.credentials(HTTP_AUTHORIZATION='pw1')
+            response = self.client.get('/user/')
+            assert response.status_code == 200
+
+        assert mocked_store.call_args_list == []
+
+        with patch('tests.test_views.TestStorage.do_store') as mocked_store:
+            self.client.credentials(HTTP_AUTHORIZATION='pw2')
+            response = self.client.get('/user/')
+            assert response.status_code == 200
+
+        call, = mocked_store.call_args_list
+        assert call[0][0]['user']['id'] == user2.pk
+
+
 @override_settings(
     ROOT_URLCONF=__name__,
     REQUESTLOGS={'STORAGE_CLASS': 'tests.test_views.TestStorage'},
@@ -472,8 +505,8 @@ def test_set_user_automatically_on_login(self):
 class TestServerError(RequestLogsTestMixin, APITestCase):
     def setUp(self):
         super().setUp()
-        self.user = get_user_model().objects.create_user('u1')
-        self.client.credentials(HTTP_AUTHORIZATION='Password 123')
+        self.user = get_user_model().objects.create(username='u1', password='pw1')
+        self.client.credentials(HTTP_AUTHORIZATION='pw1')
         self.expected = {
             'action_name': None,
             'request': {