Django urlconf callback

sentry_sdk/integrations/django/__init__.py

@@ -60,6 +60,7 @@
 
     from sentry_sdk.integrations.wsgi import _ScopedResponse
     from sentry_sdk._types import Event, Hint, EventProcessor, NotImplementedType
+    from sentry_sdk.integrations.django._types import CustomUrlconf
 
 
 if DJANGO_VERSION < (1, 10):
@@ -85,15 +86,21 @@ class DjangoIntegration(Integration):
     transaction_style = None
     middleware_spans = None
 
-    def __init__(self, transaction_style="url", middleware_spans=True):
-        # type: (str, bool) -> None
+    # a custom urlconf can be a string pointing to a module
+    # or a callback returning a string pointing to a module
+    # or a list of url_patterns themselves
+    urlconf = None
+
+    def __init__(self, transaction_style="url", middleware_spans=True, urlconf=None):
+        # type: (str, bool, Optional[CustomUrlconf]) -> None
         if transaction_style not in TRANSACTION_STYLE_VALUES:
             raise ValueError(
                 "Invalid value for transaction_style: %s (must be in %s)"
                 % (transaction_style, TRANSACTION_STYLE_VALUES)
             )
         self.transaction_style = transaction_style
         self.middleware_spans = middleware_spans
+        self.urlconf = urlconf
 
     @staticmethod
     def setup_once():
@@ -337,7 +344,9 @@ def _before_get_response(request):
                     getattr(fn, "view_class", fn)
                 )
             elif integration.transaction_style == "url":
-                scope.transaction = LEGACY_RESOLVER.resolve(request.path_info)
+                scope.transaction = LEGACY_RESOLVER.resolve(
+                    request.path_info, integration.urlconf
+                )
         except Exception:
             pass
 

sentry_sdk/integrations/django/_types.py

@@ -0,0 +1,12 @@
+from sentry_sdk._types import MYPY
+
+if MYPY:
+    from typing import Callable, Union, Tuple
+    from django.urls.resolvers import URLPattern, URLResolver
+
+    CustomUrlconf = Union[
+        str,
+        Callable[[], str],
+        Tuple[URLPattern, URLPattern, URLResolver],
+        Tuple[URLPattern],
+    ]

sentry_sdk/integrations/django/transactions.py

@@ -15,9 +15,9 @@
     from typing import List
     from typing import Optional
     from django.urls.resolvers import URLPattern
-    from typing import Tuple
     from typing import Union
     from re import Pattern
+    from sentry_sdk.integrations.django._types import CustomUrlconf
 
 try:
     from django.urls import get_resolver
@@ -125,10 +125,11 @@ def _resolve(self, resolver, path, parents=None):
     def resolve(
         self,
         path,  # type: str
-        urlconf=None,  # type: Union[None, Tuple[URLPattern, URLPattern, URLResolver], Tuple[URLPattern]]
+        urlconf=None,  # type: Optional[CustomUrlconf]
     ):
         # type: (...) -> str
-        resolver = get_resolver(urlconf)
+        resolver_urlconf = urlconf() if callable(urlconf) else urlconf
+        resolver = get_resolver(resolver_urlconf)
         match = self._resolve(resolver, path)
         return match or path
 

tests/integrations/django/myapp/custom_urls.py

@@ -0,0 +1,15 @@
+from __future__ import absolute_import
+
+import django
+
+if django.VERSION >= (2, 0):
+    # TODO: once we stop supporting django < 2, use the real name of this
+    # function (re_path)
+    from django.urls import re_path as url
+else:
+    from django.conf.urls import url
+
+
+urlpatterns = [
+    url(r"^foo/bar/baz/(?P<param>[\d]+)", lambda x: ""),
+]

tests/integrations/django/test_transactions.py

@@ -61,3 +61,19 @@ def test_legacy_resolver_newstyle_django20_urlconf():
     resolver = RavenResolver()
     result = resolver.resolve("/api/v2/1234/store/", url_conf)
     assert result == "/api/v2/{project_id}/store/"
+
+
+def test_legacy_resolver_custom_urlconf_module_name():
+    resolver = RavenResolver()
+    custom_urlconf_module = "tests.integrations.django.myapp.custom_urls"
+    result = resolver.resolve("/foo/bar/baz/1234", custom_urlconf_module)
+    assert result == "/foo/bar/baz/{param}"
+
+
+def test_legacy_resolver_custom_urlconf_callback():
+    def custom_urlconf_callback():
+        return "tests.integrations.django.myapp.custom_urls"
+
+    resolver = RavenResolver()
+    result = resolver.resolve("/foo/bar/baz/1234", custom_urlconf_callback)
+    assert result == "/foo/bar/baz/{param}"