10778: Add support for VRC pages to sitemap (#10806)

* 10778: Add support for VRC pages to sitemap

This changeset adds support for showing the VPN-specific resource center pages authored in Contentful in the sitemap, plus the index/landing page for the VPN Resource Center iff there are any articles available in the DB

TBC how one sees the results of the sitemap - that hasn't been manually checked yet

* 10778: Add trailing slash to VRC urls, so Django doesn't ave to 302 to the real page

* 10778: Remove the VRC landing page from the urls computed from the DB, because it's already included via a urls.py

bedrock/contentful/constants.py

@@ -34,3 +34,5 @@ ACTION_UNPUBLISH = "unpublish"
 ACTION_CREATE = "create"
 ACTION_SAVE = "save"
 ACTION_AUTO_SAVE = "auto_save"
+
+VRC_ROOT_PATH = "/products/vpn/resource-center/"

bedrock/sitemaps/tests/test_utils.py

@@ -0,0 +1,88 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+from unittest.mock import patch
+
+import pytest
+
+from bedrock.contentful.constants import (
+    CONTENT_CLASSIFICATION_VPN,
+    CONTENT_TYPE_PAGE_RESOURCE_CENTER,
+)
+from bedrock.contentful.models import ContentfulEntry
+from bedrock.sitemaps.utils import _get_vrc_urls, get_contentful_urls, update_sitemaps
+
+pytestmark = pytest.mark.django_db
+
+
+@pytest.fixture
+def dummy_vrc_pages():
+    # No content, just the bare data we need
+    for idx in range(5):
+        ContentfulEntry.objects.create(
+            contentful_id=f"DUMMY-{idx}",
+            slug=f"test-slug-{idx}",
+            # TODO: support different locales
+            locale="en-US",
+            content_type=CONTENT_TYPE_PAGE_RESOURCE_CENTER,
+            classification=CONTENT_CLASSIFICATION_VPN,
+            data={},
+            data_hash="dummy",
+        )
+
+
+def test__get_vrc_urls(dummy_vrc_pages):
+    # TODO: support different locales
+    output = _get_vrc_urls()
+    assert output == {
+        "/products/vpn/resource-center/test-slug-0/": ["en-US"],
+        "/products/vpn/resource-center/test-slug-1/": ["en-US"],
+        "/products/vpn/resource-center/test-slug-2/": ["en-US"],
+        "/products/vpn/resource-center/test-slug-3/": ["en-US"],
+        "/products/vpn/resource-center/test-slug-4/": ["en-US"],
+    }
+
+
+def test__get_vrc_urls__no_content():
+    output = _get_vrc_urls()
+    assert output == {}
+
+
+@patch("bedrock.sitemaps.utils._get_vrc_urls")
+def test_get_contentful_urls(mock__get_vrc_urls):
+    mock__get_vrc_urls.return_value = {"vrc-urls": "dummy-here"}
+
+    output = get_contentful_urls()
+    assert output == {"vrc-urls": "dummy-here"}
+    mock__get_vrc_urls.assert_called_once_with()
+
+
+@patch("bedrock.sitemaps.utils.get_static_urls")
+@patch("bedrock.sitemaps.utils.get_release_notes_urls")
+@patch("bedrock.sitemaps.utils.get_security_urls")
+@patch("bedrock.sitemaps.utils.get_contentful_urls")
+@patch("bedrock.sitemaps.utils.output_json")
+def test_update_sitemaps(
+    mock_output_json,
+    mock_get_contentful_urls,
+    mock_get_security_urls,
+    mock_get_release_notes_urls,
+    mock_get_static_urls,
+):
+    "Light check to ensure we've not added _new_ things we haven't added tests for"
+
+    mock_get_contentful_urls.return_value = {"contentful": "dummy"}
+    mock_get_security_urls.return_value = {"security": "dummy"}
+    mock_get_release_notes_urls.return_value = {"release_notes": "dummy"}
+    mock_get_static_urls.return_value = {"static_urls": "dummy"}
+
+    update_sitemaps()
+    expected = {
+        "contentful": "dummy",
+        "security": "dummy",
+        "release_notes": "dummy",
+        "static_urls": "dummy",
+    }
+
+    mock_output_json.assert_called_once_with(expected)

bedrock/sitemaps/utils.py

@@ -3,6 +3,7 @@
 # file, You can obtain one at https://mozilla.org/MPL/2.0/.
 import json
 import re
+from collections import defaultdict
 
 from django.conf import settings
 from django.http import HttpResponse
@@ -12,6 +13,12 @@ from django.urls import resolvers
 
 from mock import patch
 
+from bedrock.contentful.constants import (
+    CONTENT_CLASSIFICATION_VPN,
+    CONTENT_TYPE_PAGE_RESOURCE_CENTER,
+    VRC_ROOT_PATH,
+)
+from bedrock.contentful.models import ContentfulEntry
 from bedrock.releasenotes.models import ProductRelease
 from bedrock.security.models import SecurityAdvisory
 
@@ -150,10 +157,33 @@ def get_static_urls():
     return urls
 
 
+def _get_vrc_urls():
+    # URLs for individual VRC articles - the listing/landing page is declared
+    # separately in bedrock/products/urls.py so we don't need to include it here
+
+    urls = defaultdict(list)
+
+    for entry in ContentfulEntry.objects.filter(
+        content_type=CONTENT_TYPE_PAGE_RESOURCE_CENTER,
+        classification=CONTENT_CLASSIFICATION_VPN,
+    ):
+        _path = f"{VRC_ROOT_PATH}{entry.slug}/"
+        urls[_path].append(entry.locale)  # In the future one, slug may support multiple locales
+
+    return urls
+
+
+def get_contentful_urls():
+    urls = {}
+    urls.update(_get_vrc_urls())
+    return urls
+
+
 def update_sitemaps():
     urls = get_static_urls()
     urls.update(get_release_notes_urls())
     urls.update(get_security_urls())
+    urls.update(get_contentful_urls())
     # Output static files
     output_json(urls)