Regex support added for IGNORE_URLS with test cases

django_guid/utils.py

@@ -102,12 +102,12 @@ def is_url_in_ignored_list(request: Union['HttpRequest', 'HttpResponse']) -> boo
     :return: Boolean
     """
     endpoint = request.path.strip('/')
-    for ignore_url in settings.ignore_urls:
-        pattern = ignore_url.replace('*', r'[\s\S]+')  # noqa
-        pattern = '^' + pattern + '$'
-        search = re.search(pattern, endpoint)
-        if search:
-            # logger.info("URL Ignored")
-            return True
-    # logger.info("URL not Ignored")
+
+    IGNORE_URLS = []
+    for url in settings.ignore_urls:
+        url_regex = url.replace('*', r'[\s\S]*')  # noqa
+        url_regex = '^' + url_regex + '$'
+        IGNORE_URLS.append(re.compile(url_regex))
+    if any(url.match(endpoint) for url in IGNORE_URLS):
+        return True
     return False

tests/functional/test_sync_middleware.py

@@ -307,3 +307,47 @@ def test_url_ignored(client, caplog):
             ('Received signal `request_finished`, clearing guid', None),
         ]
         assert [(x.message, x.correlation_id) for x in caplog.records] == expected
+
+
+def test_url_ignored_without_regex(client, caplog):
+    """
+    Test that a URL without regex pattern specified in IGNORE_URLS is ignored.
+    :param client: Django client
+    :param caplog: Caplog fixture
+    """
+    from django.conf import settings as django_settings
+
+    mocked_settings = deepcopy(django_settings.DJANGO_GUID)
+    mocked_settings['IGNORE_URLS'] = {'no-guid'}
+    with override_settings(DJANGO_GUID=mocked_settings):
+        client.get('/no-guid', **{'HTTP_Correlation-ID': 'bad-guid'})
+        # No log message should have a GUID, aka `None` on index 1.
+        expected = [
+            ('sync middleware called', None),
+            ('This log message should NOT have a GUID - the URL is in IGNORE_URLS', None),
+            ('Some warning in a function', None),
+            ('Received signal `request_finished`, clearing guid', None),
+        ]
+        assert [(x.message, x.correlation_id) for x in caplog.records] == expected
+
+
+def test_url_ignored_with_regex(client, caplog):
+    """
+    Test that a URL with regex pattern specified in IGNORE_URLS is ignored.
+    :param client: Django client
+    :param caplog: Caplog fixture
+    """
+    from django.conf import settings as django_settings
+
+    mocked_settings = deepcopy(django_settings.DJANGO_GUID)
+    mocked_settings['IGNORE_URLS'] = {'no-guid/*'}
+    with override_settings(DJANGO_GUID=mocked_settings):
+        client.get('/no-guid/regex-test', **{'HTTP_Correlation-ID': 'bad-guid'})
+        # No log message should have a GUID, aka `None` on index 1.
+        expected = [
+            ('sync middleware called', None),
+            ('This log message should NOT have a GUID - the URL is in IGNORE_URLS', None),
+            ('Some warning in a function', None),
+            ('Received signal `request_finished`, clearing guid', None),
+        ]
+        assert [(x.message, x.correlation_id) for x in caplog.records] == expected