feat: Controllable ROOT_URLCONF

api/app/settings/common.py

@@ -414,8 +414,6 @@
     )
     MIDDLEWARE.append("core.middleware.admin.AdminWhitelistMiddleware")
 
-ROOT_URLCONF = "app.urls"
-
 TEMPLATES = [
     {
         "BACKEND": "django.template.backends.django.DjangoTemplates",
@@ -1153,6 +1151,8 @@
     default=5,
 )
 
+ROOT_URLCONF = "app.urls.common" if TASK_PROCESSOR_MODE else "app.urls.api"
+
 # Webhook settings
 DISABLE_WEBHOOKS = env.bool("DISABLE_WEBHOOKS", False)
 RETRY_WEBHOOKS = TASK_RUN_METHOD == TaskRunMethod.TASK_PROCESSOR

api/app/urls.py → api/app/urls/api.py

@@ -1,50 +1,42 @@
 import importlib
 
-from common.core.urls import urlpatterns as core_urlpatterns
 from django.conf import settings
 from django.contrib import admin
 from django.urls import include, path, re_path
 from django.views.generic.base import TemplateView
 
+from app import views
+from app.urls.common import urlpatterns as common_urlpatterns
 from users.views import password_reset_redirect
 
-from . import views
-
 urlpatterns = [
-    *core_urlpatterns,
-    path("processor/", include("task_processor.urls")),
+    *common_urlpatterns,
+    re_path(r"^api/v1/", include("api.urls.deprecated", namespace="api-deprecated")),
+    re_path(r"^api/v1/", include("api.urls.v1", namespace="api-v1")),
+    re_path(r"^api/v2/", include("api.urls.v2", namespace="api-v2")),
+    re_path(r"^admin/", admin.site.urls),
+    re_path(
+        r"^sales-dashboard/",
+        include("sales_dashboard.urls", namespace="sales_dashboard"),
+    ),
+    # this url is used to generate email content for the password reset workflow
+    re_path(
+        r"^password-reset/confirm/(?P<uidb64>[0-9A-Za-z_\-]+)/(?P<token>[0-9A-Za-z]{1,"
+        r"13}-[0-9A-Za-z]{1,20})/$",
+        password_reset_redirect,
+        name="password_reset_confirm",
+    ),
+    re_path(
+        r"^config/project-overrides",
+        views.project_overrides,
+        name="project_overrides",
+    ),
+    path(
+        "robots.txt",
+        TemplateView.as_view(template_name="robots.txt", content_type="text/plain"),
+    ),
 ]
 
-if not settings.TASK_PROCESSOR_MODE:
-    urlpatterns += [
-        re_path(
-            r"^api/v1/", include("api.urls.deprecated", namespace="api-deprecated")
-        ),
-        re_path(r"^api/v1/", include("api.urls.v1", namespace="api-v1")),
-        re_path(r"^api/v2/", include("api.urls.v2", namespace="api-v2")),
-        re_path(r"^admin/", admin.site.urls),
-        re_path(
-            r"^sales-dashboard/",
-            include("sales_dashboard.urls", namespace="sales_dashboard"),
-        ),
-        # this url is used to generate email content for the password reset workflow
-        re_path(
-            r"^password-reset/confirm/(?P<uidb64>[0-9A-Za-z_\-]+)/(?P<token>[0-9A-Za-z]{1,"
-            r"13}-[0-9A-Za-z]{1,20})/$",
-            password_reset_redirect,
-            name="password_reset_confirm",
-        ),
-        re_path(
-            r"^config/project-overrides",
-            views.project_overrides,
-            name="project_overrides",
-        ),
-        path(
-            "robots.txt",
-            TemplateView.as_view(template_name="robots.txt", content_type="text/plain"),
-        ),
-    ]
-
 if settings.DEBUG:
     urlpatterns = [
         re_path(r"^__debug__/", include("debug_toolbar.urls")),

api/app/urls/common.py

@@ -0,0 +1,7 @@
+from common.core.urls import urlpatterns as core_urlpatterns
+from django.urls import include, path
+
+urlpatterns = [
+    *core_urlpatterns,
+    path("processor/", include("task_processor.urls")),
+]

api/tests/unit/onboarding/conftest.py

@@ -2,12 +2,11 @@
 
 import pytest
 from django.urls import clear_url_caches
-from pytest_mock import MockerFixture
 
 
 def reload_onboarding_urls() -> None:
     import api.urls.v1 as v1_urls
-    import app.urls as root_urls
+    import app.urls.api as root_urls
     import onboarding.urls as onboarding_urls
 
     reload(onboarding_urls)
@@ -18,12 +17,10 @@ def reload_onboarding_urls() -> None:
 
 
 @pytest.fixture()
-def is_oss(mocker: MockerFixture) -> None:
-    mocker.patch("common.core.utils.is_oss", return_value=True)
+def oss_mode() -> None:
     reload_onboarding_urls()
 
 
 @pytest.fixture()
-def is_saas(mocker: MockerFixture) -> None:
-    mocker.patch("common.core.utils.is_saas", return_value=True)
+def saas_mode(saas_mode: None) -> None:
     reload_onboarding_urls()

api/tests/unit/onboarding/test_views.py

@@ -12,7 +12,8 @@
 
 
 def test_send_onboarding_request_to_saas_flagsmith_view_for_non_admin_user(
-    test_user_client: APIClient, is_oss: MagicMock
+    test_user_client: APIClient,
+    oss_mode: None,
 ) -> None:
     # Given
     url = reverse("api-v1:onboarding:send-onboarding-request")
@@ -25,7 +26,8 @@ def test_send_onboarding_request_to_saas_flagsmith_view_for_non_admin_user(
 
 
 def test_send_onboarding_request_to_saas_flagsmith_view_without_org(
-    admin_client_original: APIClient, is_oss: MagicMock
+    admin_client_original: APIClient,
+    oss_mode: None,
 ) -> None:
     # Given
     url = reverse("api-v1:onboarding:send-onboarding-request")
@@ -46,7 +48,7 @@ def test_send_onboarding_request_to_saas_flagsmith_view(
     mocker: MockerFixture,
     organisation: Organisation,
     admin_user: FFAdminUser,
-    is_oss: MagicMock,
+    oss_mode: None,
 ) -> None:
     # Given
     mocked_requests = mocker.patch("onboarding.tasks.requests")
@@ -73,7 +75,7 @@ def test_receive_support_request_from_self_hosted_view_without_hubspot_token(
     settings: SettingsWrapper,
     api_client: APIClient,
     db: None,
-    is_saas: MagicMock,
+    saas_mode: MagicMock,
 ) -> None:
     # Given
     settings.HUBSPOT_ACCESS_TOKEN = None
@@ -93,7 +95,7 @@ def test_receive_support_request_from_self_hosted_view(
     api_client: APIClient,
     mocker: MockerFixture,
     db: None,
-    is_saas: None,
+    saas_mode: None,
 ) -> None:
     # Given
     settings.HUBSPOT_ACCESS_TOKEN = "some-token"
@@ -123,7 +125,7 @@ def test_receive_support_request_throttling(
     api_client: APIClient,
     mocker: MockerFixture,
     db: None,
-    is_saas: MagicMock,
+    saas_mode: MagicMock,
 ) -> None:
     # Given
     settings.HUBSPOT_ACCESS_TOKEN = "some-token"