[chores:fix] Fixed recent duplication of routes and urls #608

The recent changes to implement asynchronous batches,
duplicated the websocket routes and URL routes for
the notification module.

URL and websocket routes must be added at project level.

I took advantage to update the extending docs page too.

Related to #608

Author: nemesifier

docs/developer/extending.rst

@@ -90,11 +90,13 @@ Now you need to add ``myradius`` to ``INSTALLED_APPS`` in your
         # social login
         "allauth.socialaccount.providers.facebook",  # optional, can be removed if social login is not needed
         "allauth.socialaccount.providers.google",  # optional, can be removed if social login is not needed
-        # SAML login
-        "djangosaml2",  # optional, can be removed if SAML login is not needed
+        # openwisp notifications
+        "openwisp_notifications",
         # openwisp
         # 'myradius', <-- replace with your app-name here
         "openwisp_users",
+        # SAML login
+        "djangosaml2",  # optional, can be removed if SAML login is not needed
         "private_storage",
         "drf_yasg",
     ]
@@ -105,7 +107,8 @@ Now you need to add ``myradius`` to ``INSTALLED_APPS`` in your
 
     AUTHENTICATION_BACKENDS = (
         "openwisp_users.backends.UsersAuthenticationBackend",
-        "openwisp_radius.saml.backends.OpenwispRadiusSaml2Backend",  # optional, can be removed if SAML login is not needed
+        "openwisp_radius.saml.backends.OpenwispRadiusSaml2Backend",
+        "sesame.backends.ModelBackend",
     )
 
 4. Add ``EXTENDED_APPS``
@@ -154,6 +157,8 @@ Add ``openwisp_utils.loaders.DependencyLoader`` to ``TEMPLATES`` in your
                     "django.template.context_processors.request",
                     "django.contrib.auth.context_processors.auth",
                     "django.contrib.messages.context_processors.messages",
+                    "openwisp_utils.admin_theme.context_processor.menu_groups",
+                    "openwisp_notifications.context_processors.notification_api_settings",
                 ],
             },
         }
@@ -445,9 +450,10 @@ comments):
     urlpatterns = [
         # ... other urls in your project ...
         path("admin/", admin.site.urls),
-        # openwisp-radius urls
+        # URLs of other OpenWISP modules
         path("accounts/", include("openwisp_users.accounts.urls")),
         path("api/v1/", include("openwisp_utils.api.urls")),
+        path("", include("openwisp_notifications.urls", namespace="notifications")),
         # Use only when extending views (discussed below)
         # path('', include((get_urls(api_views, social_views, saml_views), 'radius'), namespace='radius')),
         # Remove when extending views

openwisp_radius/routing.py

@@ -1,7 +1,4 @@
 from django.urls import path
-from openwisp_notifications.websockets.routing import (
-    get_routes as get_notification_routes,
-)
 
 from . import consumers
 
@@ -10,4 +7,4 @@
         "ws/radius/batch/<uuid:batch_id>/",
         consumers.RadiusBatchConsumer.as_asgi(),
     ),
-] + get_notification_routes()
+]

openwisp_radius/urls.py

@@ -28,11 +28,4 @@ def get_urls(api_views=None, social_views=None, saml_views=None):
 namespace = "radius"
 urlpatterns = [
     path("", include((get_urls(), namespace), namespace=namespace)),
-    path(
-        "",
-        include(
-            ("openwisp_notifications.urls", "openwisp_notifications"),
-            namespace="notifications",
-        ),
-    ),
 ]

tests/openwisp2/routing.py

@@ -4,17 +4,20 @@
 from channels.routing import ProtocolTypeRouter, URLRouter
 from channels.security.websocket import AllowedHostsOriginValidator
 from django.core.asgi import get_asgi_application
+from openwisp_notifications.websockets.routing import (
+    get_routes as get_notification_routes,
+)
 
 from openwisp_radius.routing import (
     websocket_urlpatterns as radius_websocket_urlpatterns,
 )
 
-ws_routes = list(radius_websocket_urlpatterns)
+ws_routes = radius_websocket_urlpatterns + get_notification_routes()
 
 if os.environ.get("MONITORING_INTEGRATION"):
-    from openwisp_controller.routing import get_routes
+    from openwisp_controller.routing import get_routes as get_controller_routes
 
-    ws_routes.extend(get_routes())
+    ws_routes.extend(get_controller_routes())
 
 application = ProtocolTypeRouter(
     {

tests/openwisp2/urls.py

@@ -33,13 +33,6 @@
     path("api/v1/", include("openwisp_users.api.urls")),
     path("accounts/", include("openwisp_users.accounts.urls")),
     radius_urls,
-    path(
-        "",
-        include(
-            ("openwisp_notifications.urls", "openwisp_notifications"),
-            namespace="notifications",
-        ),
-    ),
     path(
         "captive-portal-mock/login/",
         views.captive_portal_login,
@@ -55,10 +48,17 @@
 urlpatterns += staticfiles_urlpatterns()
 
 if os.environ.get("MONITORING_INTEGRATION"):
-    urlpatterns = [
+    urlpatterns += [
         path("", include("openwisp_controller.urls")),
         path("", include("openwisp_monitoring.urls")),
-    ] + urlpatterns
+    ]
+else:
+    # openwisp_controller.urls ships notification URLs,
+    # if monitoring integration is not enabled we need
+    # to add the URLs here
+    urlpatterns += [
+        path("", include("openwisp_notifications.urls", namespace="notifications")),
+    ]
 
 if settings.DEBUG and "debug_toolbar" in settings.INSTALLED_APPS:
     import debug_toolbar