feat(networks): per-network domain overrides for nav links

Most networks live at {slug}.{NAV_DEFAULT_DOMAIN}, but some have their
own external Commons domains that differ per environment — MSU is
msucommons-dev.org on dev and commons.msu.edu on production. Adds
NETWORK_DOMAIN_OVERRIDES ({slug: {environment: domain}}, env-
overridable JSON, MSU seeded as default) consulted with the new
NETWORK_DOMAIN_ENVIRONMENT key (main by default, dev on the dev
settings module, anything else via env var). Networks or environments
without an entry fall back to the subdomain form, and the Works link
never follows these overrides — it stays on the hcommons domains.

Author: MartinPaulEve

config/settings/base.py

@@ -634,6 +634,29 @@
 # the nav URLs so environment-tracking defaults can derive from it.
 NAV_DEFAULT_DOMAIN = env("NAV_DEFAULT_DOMAIN", default="hcommons.org")
 
+# Which environment key NETWORK_DOMAIN_OVERRIDES is consulted with:
+# "main" on production, "dev" on dev (overridden in dev.py), and any
+# other key a deployment chooses (e.g. "test") via the env var.
+NETWORK_DOMAIN_ENVIRONMENT = env(
+    "NETWORK_DOMAIN_ENVIRONMENT", default="main"
+)
+
+# Per-network domain overrides for the network-aware nav links, keyed
+# by network slug then environment. Most networks live at
+# {slug}.{NAV_DEFAULT_DOMAIN}; networks listed here use their own
+# external domain instead (per environment, falling back to the
+# subdomain form when the environment has no entry). The Works link
+# never follows these — it stays on the hcommons domains.
+NETWORK_DOMAIN_OVERRIDES = env.json(
+    "NETWORK_DOMAIN_OVERRIDES",
+    default={
+        "msu": {
+            "dev": "msucommons-dev.org",
+            "main": "commons.msu.edu",
+        },
+    },
+)
+
 NAV_NEWS_FEED_URL = env(
     "NAV_NEWS_FEED_URL", default="https://hcommons.org/activity/"
 )

config/settings/dev.py

@@ -34,6 +34,9 @@
     "https://*.profile.hcommons-dev.org",
 ]
 
+# Consult NETWORK_DOMAIN_OVERRIDES with this environment's key
+NETWORK_DOMAIN_ENVIRONMENT = env("NETWORK_DOMAIN_ENVIRONMENT", default="dev")
+
 # Share the login session (and CSRF cookie) between the apex and the
 # network subdomains (e.g. stemedplus.profile.hcommons-dev.org). The
 # IDMS broker service inherits this module (config.settings.idms_dev),

knowledge_commons_profiles/newprofile/context_processors.py

@@ -34,6 +34,21 @@ def _rewrite_domain(url, default_domain, target_domain):
 )
 
 
+def _network_domain(network_slug, default_domain):
+    """
+    The Commons domain for a network's community links.
+
+    Most networks live at {slug}.{default_domain}; networks with an
+    entry in NETWORK_DOMAIN_OVERRIDES for this deployment's
+    NETWORK_DOMAIN_ENVIRONMENT use their own external domain instead
+    (e.g. msu -> commons.msu.edu on main, msucommons-dev.org on dev).
+    """
+    overrides = getattr(settings, "NETWORK_DOMAIN_OVERRIDES", {})
+    environment = getattr(settings, "NETWORK_DOMAIN_ENVIRONMENT", "main")
+    override = overrides.get(network_slug.lower(), {}).get(environment)
+    return override or f"{network_slug}.{default_domain}"
+
+
 def nav_links(request):
     urls = {
         "NAV_NEWS_FEED_URL": settings.NAV_NEWS_FEED_URL,
@@ -53,7 +68,7 @@ def nav_links(request):
     # precedence over the referer-derived session domain below
     network_slug = getattr(request, "network_slug", None)
     if network_slug:
-        network_domain = f"{network_slug}.{default_domain}"
+        network_domain = _network_domain(network_slug, default_domain)
         return {
             key: (
                 _rewrite_domain(url, default_domain, network_domain)

knowledge_commons_profiles/newprofile/tests/test_network_nav_links.py

@@ -91,6 +91,67 @@ def test_network_beats_referer_session_domain(self):
         )
 
 
+DOMAIN_OVERRIDES = {
+    "msu": {
+        "dev": "msucommons-dev.org",
+        "main": "commons.msu.edu",
+    },
+}
+
+
+@override_settings(**NAV_SETTINGS, NETWORK_DOMAIN_OVERRIDES=DOMAIN_OVERRIDES)
+class NetworkDomainOverrideTests(TestCase):
+    def _nav_for_network(self, slug):
+        request = RequestFactory().get("/members/")
+        request.network_slug = slug
+        request.network = slug
+        request.session = {}
+        return nav_links(request)
+
+    @override_settings(NETWORK_DOMAIN_ENVIRONMENT="dev")
+    def test_overridden_network_uses_environment_domain_on_dev(self):
+        urls = self._nav_for_network("msu")
+        self.assertEqual(
+            urls["NAV_GROUPS_URL"], "https://msucommons-dev.org/groups/"
+        )
+        self.assertEqual(
+            urls["NAV_NEWS_FEED_URL"],
+            "https://msucommons-dev.org/activity/",
+        )
+        self.assertEqual(
+            urls["NAV_SITES_URL"], "https://msucommons-dev.org/sites/"
+        )
+
+    @override_settings(NETWORK_DOMAIN_ENVIRONMENT="main")
+    def test_overridden_network_uses_environment_domain_on_main(self):
+        urls = self._nav_for_network("msu")
+        self.assertEqual(
+            urls["NAV_GROUPS_URL"], "https://commons.msu.edu/groups/"
+        )
+
+    @override_settings(NETWORK_DOMAIN_ENVIRONMENT="dev")
+    def test_works_link_ignores_domain_overrides(self):
+        urls = self._nav_for_network("msu")
+        self.assertEqual(
+            urls["NAV_WORKS_URL"], "https://works.hcommons.org/"
+        )
+
+    @override_settings(NETWORK_DOMAIN_ENVIRONMENT="dev")
+    def test_network_without_override_uses_subdomain_of_default(self):
+        urls = self._nav_for_network("up")
+        self.assertEqual(
+            urls["NAV_GROUPS_URL"], "https://up.hcommons.org/groups/"
+        )
+
+    @override_settings(NETWORK_DOMAIN_ENVIRONMENT="test")
+    def test_override_without_environment_entry_falls_back(self):
+        # msu has dev/main entries but nothing for this environment
+        urls = self._nav_for_network("msu")
+        self.assertEqual(
+            urls["NAV_GROUPS_URL"], "https://msu.hcommons.org/groups/"
+        )
+
+
 @override_settings(
     **NAV_SETTINGS,
     ALLOWED_HOSTS=["*"],