Add old version alert to docs views (boostorg#1795) (boostorg#1960)

Author: daveoconnor

core/views.py

@@ -1,4 +1,5 @@
 import os
+
 from django.utils import timezone
 
 from urllib.parse import urljoin
@@ -24,12 +25,14 @@
 
 from config.settings import ENABLE_DB_CACHE
 from libraries.constants import LATEST_RELEASE_URL_PATH_STR
+from libraries.mixins import VersionAlertMixin
 from libraries.utils import (
     legacy_path_transform,
     get_prioritized_library_view,
     generate_canonical_library_uri,
+    set_selected_boost_version,
 )
-from versions.models import Version
+from versions.models import Version, docs_path_to_boost_name
 
 from .asciidoc import convert_adoc_to_html
 from .boostrenderer import (
@@ -343,14 +346,30 @@ def get_context_data(self, **kwargs):
         if content_type == "text/asciidoc":
             content_type = "text/html"
 
-        context.update({"content": content, "content_type": content_type})
-
+        context.update(
+            {
+                "content": content,
+                "content_type": content_type,
+                "selected_version": self.get_selected_version(),
+            }
+        )
         logger.info(
             "get_content_from_s3_view_success", key=self.kwargs.get("content_path")
         )
 
         return context
 
+    def get_selected_version(self) -> Version | None:
+        content_path = self.kwargs.get("content_path")
+        boost_name = docs_path_to_boost_name(content_path)
+        if not boost_name:
+            return None
+        try:
+            version = Version.objects.get(name=boost_name)
+        except Version.DoesNotExist:
+            version = None
+        return version
+
     def get_from_cache(self, static_content_cache, cache_key):
         cached_result = static_content_cache.get(cache_key)
         return cached_result if cached_result else None
@@ -487,20 +506,28 @@ def normalize_boost_doc_path(content_path: str) -> str:
     return f"/archives/{content_path}"
 
 
-class DocLibsTemplateView(BaseStaticContentTemplateView):
+class DocLibsTemplateView(VersionAlertMixin, BaseStaticContentTemplateView):
     allowed_db_save_types = {
         "text/asciidoc",
         "text/html",
         "text/html; charset=utf-8",
         "text/css; charset=utf-8",
     }
 
+    def dispatch(self, request, *args, **kwargs):
+        response = super().dispatch(request, *args, **kwargs)
+        set_selected_boost_version(
+            self.kwargs.get("content_path").split("/", 1)[0], response
+        )
+        return response
+
     def get_from_s3(self, content_path):
         legacy_url = normalize_boost_doc_path(content_path)
         return super().get_from_s3(legacy_url)
 
     def process_content(self, content: bytes):
         """Replace page header with the local one."""
+        context = super().get_context_data()
         content_type = self.content_dict.get("content_type")
         modernize = self.request.GET.get("modernize", "med").lower()
         if (
@@ -522,10 +549,12 @@ def process_content(self, content: bytes):
 
         soup = self._required_modernization_changes(soup)
 
-        context = {
-            "content": str(soup),
-            "canonical_uri": canonical_uri if canonical_uri != req_uri else None,
-        }
+        context.update(
+            {
+                "content": str(soup),
+                "canonical_uri": canonical_uri if canonical_uri != req_uri else None,
+            }
+        )
         template_name = "original_docs.html"
 
         if is_in_fully_modernized_libs(self.request.path):

frontend/styles.css

@@ -117,6 +117,16 @@
 }
 
 #docsiframe {
-  @apply w-full mx-0 my-auto overflow-hidden p-0 mt-[1px];
+  @apply w-full mx-0 my-auto overflow-hidden p-0;
   height: calc(100vh - 2.6rem)
 }
+
+.version_alert {
+  @apply py-2 px-3 mt-2 mb-3 text-center rounded-sm bg-yellow-200/70
+}
+.version_alert p {
+  @apply p-0 m-0 text-center;
+}
+.version_alert a {
+  @apply font-semibold underline dark:text-white text-charcoal
+}

libraries/github.py

@@ -506,7 +506,7 @@ def handle_commit(commit: ParsedCommit):
                 )
 
             except KeyError:
-                logger.error(f"KeyError {commit.version=}")
+                logger.warning(f"KeyError {commit.version=}")
                 return None
 
         def handle_version_diff_stat(diff: VersionDiffStat):

libraries/mixins.py

@@ -1,3 +1,5 @@
+import re
+
 import structlog
 from types import SimpleNamespace
 
@@ -32,11 +34,27 @@ def get_context_data(self, **kwargs):
         if url_name in {"libraries", "releases-most-recent"}:
             return context
         current_version_kwargs = self.kwargs.copy()
-        current_version_kwargs.update({"version_slug": LATEST_RELEASE_URL_PATH_STR})
+
+        if url_name == "docs-libs-page":
+            alert_visible = not current_version_kwargs.get("content_path").startswith(
+                LATEST_RELEASE_URL_PATH_STR
+            )
+            current_version_kwargs.update(
+                {
+                    "content_path": re.sub(
+                        r"([_0-9]+)/(\S+)",
+                        rf"{LATEST_RELEASE_URL_PATH_STR}/\2",
+                        current_version_kwargs.get("content_path"),
+                    )
+                }
+            )
+        else:
+            current_version_kwargs.update({"version_slug": LATEST_RELEASE_URL_PATH_STR})
+            alert_visible = (
+                self.kwargs.get("version_slug") != LATEST_RELEASE_URL_PATH_STR
+            )
         context["version_alert_url"] = reverse(url_name, kwargs=current_version_kwargs)
-        context["version_alert"] = (
-            self.kwargs.get("version_slug") != LATEST_RELEASE_URL_PATH_STR
-        )
+        context["version_alert"] = alert_visible
         return context
 
 

templates/docsiframe.html

@@ -10,6 +10,10 @@
 {% endblock %}
 
 {% block content %}
+    {# alert for non-current Boost versions #}
+    <div class="bg-white dark:text-white text-slate dark:bg-charcoal dark:bg-neutral-700 py-1">
+      {% include "libraries/includes/version_alert.html" %}
+    </div>
     <iframe
         {% if iframe_url %}
           src="{{ iframe_url }}"

templates/includes/_legacy_docs_header.html

@@ -27,3 +27,5 @@ <h1 class="heading-title">
     </div>
   </div>
 </div>
+{# alert for non-current Boost versions #}
+{% include "libraries/includes/version_alert.html" %}

templates/libraries/_library_vertical_list_item.html

@@ -21,7 +21,7 @@
   <td class="w-8 align-top">
     {% include "libraries/includes/_documentation_link_icon.html" %}
   </td>
-  <td class="align-top hidden md:block mt-2 pl-3 md:h-20 md:items-center h-full">{{ library_version.description|default:"No description provided for this version." }}</td>
+  <td class="align-top hidden md:block mt-2 pl-3 md:items-center h-full">{{ library_version.description|default:"No description provided for this version." }}</td>
 </tr>
 <tr class="block md:hidden pl-1 align-top">
   <td>{{ library_version.description|default:"No description provided for this version." }}</td>

templates/libraries/includes/version_alert.html

@@ -1,6 +1,6 @@
 {% if version_alert %}
-  <div role="alert" class="py-2 px-3 mb-3 text-center rounded-sm bg-yellow-200/70">
-    <p class="p-0 m-0">
+  <div role="alert" class="version_alert">
+    <p>
       <i class="fas fa-exclamation-circle"></i>
       {% if selected_version == current_version %}
         You've currently chosen the {{ current_version.display_name }} version. If a newer release comes out, you will continue to view the {{ current_version.display_name }} version, not the new <a href="{{ version_alert_url }}" class="font-semibold underline dark:text-white text-charcoal">latest release</a>.
@@ -12,7 +12,7 @@
         {% else %}
           This version of Boost is under active development.
         {% endif %}
-      The <a href="{{ version_alert_url }}" class="font-semibold underline dark:text-white text-charcoal">current version</a> is {{ current_version.display_name }}.
+      The <a href="{{ version_alert_url }}">current version</a> is {{ current_version.display_name }}.
       {% endif %}
     </p>
   </div>

templates/original_docs.html

@@ -6,6 +6,7 @@
   <head>
     <meta charset="utf-8">
     <link href="{% static 'css/header.css' %}">
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.6.0/css/all.min.css">
     <script defer data-domain="boost.org" src="https://plausible.io/js/script.manual.js"></script>
     <script src="{% static 'js/boost-gecko/main.C3hPHS6-.js' %}" defer></script>
     {% if canonical_uri %}<link rel="canonical" href="{{ canonical_uri }}">{% endif %}
@@ -217,6 +218,23 @@
             margin-left: 300px;
         }
     }
+    .version_alert {
+      background-color: hsla(53,98%,77%,.7);
+      border-radius: 0.125rem;
+      font-family: ui-sans-serif,system-ui,-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Helvetica Neue,Arial,Noto Sans,sans-serif,Apple Color Emoji,Segoe UI Emoji,Segoe UI Symbol,Noto Color Emoji;
+      font-size: 1rem !important;
+      margin-bottom: 0.75rem !important;
+      padding: 0.5rem !important;
+      text-align: center;
+    }
+    .version_alert p {
+      text-align: center;
+      margin: 0px;
+    }
+    .version_alert a {
+      font-weight: 600;
+      text-decoration-line: underline;
+    }
   </style>
 
   {% if no_wrapper %}

versions/models.py

@@ -319,3 +319,12 @@ def display_name(self):
 
     def __str__(self):
         return self.version
+
+
+def docs_path_to_boost_name(content_path):
+    """
+    Convert a documentation content path to the Boost version name.
+    e.g. "1_79_0/doc/html/accumulators.html" to "boost-1.79.0"
+    """
+    result = re.sub(r"^([_0-9]+)(/\S+)", r"boost-\1", content_path)
+    return result.replace("_", ".")