Merge pull request #1 from boostorg/v3

V3 Website to QA

Author: fromagge

config/urls.py

@@ -1,6 +1,7 @@
 import logging
 
 from django.conf import settings
+from django.contrib.admin.views.decorators import staff_member_required
 from django.conf.urls.static import static
 from django.contrib import admin
 from django.urls import include, path, re_path, register_converter, reverse_lazy
@@ -21,22 +22,23 @@
 from config.settings import DEBUG_TOOLBAR
 from core.views import (
     BSLView,
+    BoostDevelopmentView,
     CalendarView,
     ClearCacheView,
     DocLibsTemplateView,
     ImageView,
     MarkdownTemplateView,
+    V3ComponentDemoView,
+    ModernizedDocsView,
     RedirectToDocsView,
     RedirectToHTMLDocsView,
     RedirectToHTMLToolsView,
     RedirectToLibrariesView,
+    RedirectToLibraryDetailView,
     RedirectToReleaseView,
     RedirectToToolsView,
     StaticContentTemplateView,
     UserGuideTemplateView,
-    BoostDevelopmentView,
-    ModernizedDocsView,
-    RedirectToLibraryDetailView,
 )
 from marketing.views import PlausibleRedirectView, WhitePaperView
 from libraries.api import LibrarySearchView
@@ -241,6 +243,11 @@
             TemplateView.as_view(template_name="style_guide.html"),
             name="style-guide",
         ),
+        path(
+            "v3/demo/components/",
+            staff_member_required(V3ComponentDemoView.as_view()),
+            name="v3-demo-components",
+        ),
         path("libraries/", LibraryListDispatcher.as_view(), name="libraries"),
         path(
             "libraries/<boostversionslug:version_slug>/<str:library_view_str>/",

core/views.py

@@ -1,3 +1,4 @@
+import json
 import os
 import re
 
@@ -1034,3 +1035,51 @@ def get(self, request: HttpRequest, campaign_identifier: str, main_path: str = "
             redirect_path = f"{redirect_path}?{qs}"
 
         return HttpResponseRedirect(redirect_path)
+
+
+class V3ComponentDemoView(TemplateView):
+    """Demo page for V3 design system components."""
+
+    template_name = "base.html"
+
+    def get_context_data(self, **kwargs):
+        context = super().get_context_data(**kwargs)
+        context["popular_terms"] = [
+            {"label": "Networking"},
+            {"label": "Math"},
+            {"label": "Data processing"},
+            {"label": "Concurrency"},
+            {"label": "File systems"},
+            {"label": "Testing"},
+        ]
+        context["demo_libs_json"] = json.dumps(
+            [
+                {"value": "asio", "label": "Asio"},
+                {"value": "beast", "label": "Beast"},
+                {"value": "filesystem", "label": "Filesystem"},
+                {"value": "json", "label": "JSON"},
+                {"value": "spirit", "label": "Spirit"},
+            ]
+        )
+        context["demo_cats_json"] = json.dumps(
+            [
+                {"value": "algorithms", "label": "Algorithms"},
+                {"value": "containers", "label": "Containers"},
+                {"value": "io", "label": "I/O"},
+                {"value": "math", "label": "Math & Numerics"},
+                {"value": "networking", "label": "Networking"},
+            ]
+        )
+        from libraries.models import LibraryVersion
+        from libraries.utils import build_library_intro_context
+
+        latest = Version.objects.most_recent()
+        if latest:
+            lv = (
+                LibraryVersion.objects.filter(version=latest, library__slug="beast")
+                .select_related("library")
+                .first()
+            )
+            if lv:
+                context["library_intro"] = build_library_intro_context(lv)
+        return context

docs/django-waffle-v3-flag.md

@@ -0,0 +1,133 @@
+# Django Waffle — Feature flags
+
+This document describes how **feature flags** work in the Boost website project (django-waffle), how to assign and manage them, and how the **v3** flag is set up.
+
+---
+
+## How feature flags work in this project
+
+- **Library:** [django-waffle](https://github.com/jazzband/django-waffle) (v5.0.0). Flags are stored in the database and evaluated per request (and optionally per user, group, or session).
+- **Middleware:** `waffle.middleware.WaffleMiddleware` runs on each request so that flag state is available in templates and views.
+- **Settings** (`config/settings.py`):
+  - **`WAFFLE_CREATE_MISSING_FLAGS = True`** — The first time a flag name is used in code (e.g. `{% flag "v3" %}` or `flag_is_active(request, "v3")`), it is auto-created in the database with default **off**.
+  - **`WAFFLE_FLAG_DEFAULT = False`** — Newly created flags have “Everyone” = No; they only become active when explicitly enabled for users, groups, percentage, etc.
+- **Evaluation:** For each request, waffle checks the flag’s rules (everyone, superusers, staff, authenticated, groups, users, percentage, testing cookie). If any rule matches, the flag is **active** for that request; otherwise it is **inactive**. Anonymous users only get a flag if “Everyone” is Yes or a percentage/testing rule applies; group-based activation applies only to authenticated users in the chosen groups.
+
+So in short: **flags are off by default**, and you turn them on by assigning **groups**, **users**, or other options in the Django admin.
+
+---
+
+## How to assign feature flags
+
+Feature flags are managed in the **Django Admin** under **Waffle**.
+
+### 1. Create or open a flag
+
+- Go to **Django Admin** → **Waffle** → **Flags** (`/admin/waffle/flag/`).
+- Either:
+  - **Create** a new flag (Name = e.g. `v3`), or
+  - **Open** an existing flag (e.g. `v3`).
+
+With `WAFFLE_CREATE_MISSING_FLAGS = True`, the flag may already exist because it was used in code; you only need to edit it.
+
+### 2. Choose who gets the flag
+
+On the flag’s edit page you can enable the flag for:
+
+- **Everyone** — Yes/No/Unknown. “Yes” turns the flag on for all requests (use with care).
+- **Superusers** — If checked, the flag is always on for superusers.
+- **Staff** — If checked, the flag is on for staff users.
+- **Authenticated** — If checked, the flag is on for any logged-in user.
+- **Groups (Chosen groups)** — The flag is on only for users who belong to at least one of the selected groups. This is the usual way to target testers (e.g. `v3_testers`).
+- **Users (Chosen users)** — The flag is on only for the selected users.
+- **Percentage** — Roll out to a percentage of users (0.0–99.9).
+- **Testing** — When enabled, the flag can be toggled via a query/cookie for testing (see waffle docs).
+
+For a **group-based** flag (e.g. v3):
+
+1. In **Chosen groups**, move the desired group (e.g. **v3_testers**) from “Available groups” to “Chosen groups”.
+2. Leave **Everyone** as “No” (or “Unknown”) so only the chosen group sees the flag.
+3. Click **Save**.
+
+### 3. Put users into the group
+
+Group-based flags only apply to **authenticated** users who are **members** of one of the chosen groups.
+
+- Go to **Users** (or **Auth** → **Users** / **Users** → **Users**, depending on your project).
+- Open the **user** that should see the flag.
+- In **Groups** (or “User groups”), add the group (e.g. **v3_testers**).
+- Save.
+
+After that, when that user is logged in, the flag is active for their requests. Log out and back in (or use a fresh session) if you don’t see the change.
+
+---
+
+## The “v3” flag and banner
+
+The **v3** flag is used to show a banner to users who are part of the v3 rollout.
+
+### What was added in the repo
+
+- **django-waffle** in `requirements.txt` (v5.0.0).
+- **Config** in `config/settings.py`: `waffle` in `INSTALLED_APPS`, `waffle.middleware.WaffleMiddleware` in `MIDDLEWARE`, `WAFFLE_CREATE_MISSING_FLAGS = True`, `WAFFLE_FLAG_DEFAULT = False`.
+- **Banner** in `templates/base.html`: `{% load waffle_tags %}` and a block `{% flag "v3" %} ... {% endflag %}` that shows a grey “v3 flag enabled” bar at the top of the page when the flag is active for the requesting user.
+- **Data migration** `users/migrations/0021_add_v3_testers_group.py` creates the Django auth group **v3_testers**, which can be assigned to the v3 flag.
+
+### How to enable the v3 banner for yourself
+
+1. **Apply migrations** (so the `v3_testers` group exists):
+   ```bash
+   just migrate
+   # or: docker compose run --rm web python manage.py migrate
+   ```
+2. **Admin** → **Waffle** → **Flags** → open (or create) the **v3** flag.
+3. In **Chosen groups**, add **v3_testers** and save.
+4. **Admin** → **Users** → open **your user** → add **v3_testers** to Groups → save.
+5. Log in on the site and reload; the **“v3 flag enabled”** banner should appear at the top.
+
+### If the “v3 flag enabled” banner does not appear
+
+- You must be **logged in**; group-based flags do not apply to anonymous users.
+- Your **user** must be in the **v3_testers** group (Users → your user → Groups).
+- **Log out and log back in** (or use a new incognito session) so the session reflects the group.
+- Confirm the **v3** flag is saved with **v3_testers** in Chosen groups.
+
+---
+
+## Where it is in the codebase
+
+| What | Where |
+|------|--------|
+| Conditional banner | `templates/base.html`: `{% load waffle_tags %}` and `{% flag "v3" %} ... {% endflag %}` |
+| Waffle config | `config/settings.py`: `INSTALLED_APPS`, `MIDDLEWARE`, `WAFFLE_*` |
+| v3_testers group | `users/migrations/0021_add_v3_testers_group.py` |
+| Package | `requirements.txt`: `django-waffle==5.0.0` |
+
+---
+
+## Using flags in Python (views)
+
+```python
+from waffle import flag_is_active
+
+def my_view(request):
+    if flag_is_active(request, "v3"):
+        # Flag is active for this request (e.g. user in v3_testers)
+        ...
+    else:
+        ...
+```
+
+---
+
+## Using flags in templates
+
+```django
+{% load waffle_tags %}
+
+{% flag "v3" %}
+  <div>Content only shown when the v3 flag is active for this user.</div>
+{% endflag %}
+```
+
+You can use the same pattern for any flag name (e.g. `{% flag "my_feature" %}`) and assign it via groups or users in the admin as described above.

libraries/mixins.py

@@ -1,10 +1,8 @@
 import re
 
 import structlog
-from types import SimpleNamespace
 
 from django.db.models import Count, Exists, OuterRef
-from django.db.models.functions import Lower
 from django.shortcuts import get_object_or_404
 from django.urls import reverse
 
@@ -17,11 +15,11 @@
 from libraries.models import (
     Commit,
     CommitAuthor,
-    CommitAuthorEmail,
     Library,
     LibraryVersion,
 )
 from libraries.path_matcher.utils import determine_latest_url
+from libraries.utils import patch_commit_authors
 from versions.models import Version
 
 logger = structlog.get_logger()
@@ -232,23 +230,7 @@ def get_related(self, library_version, relation="maintainers", exclude_ids=None)
         if exclude_ids:
             qs = qs.exclude(id__in=exclude_ids)
         qs = list(qs)
-        commit_authors = {
-            author_email.email: author_email
-            for author_email in CommitAuthorEmail.objects.annotate(
-                email_lower=Lower("email")
-            )
-            .filter(email_lower__in=[x.email.lower() for x in qs])
-            .select_related("author")
-        }
-        for user in qs:
-            if author_email := commit_authors.get(user.email.lower(), None):
-                user.commitauthor = author_email.author
-            else:
-                user.commitauthor = SimpleNamespace(
-                    github_profile_url="",
-                    avatar_url="",
-                    display_name=f"{user.display_name}",
-                )
+        patch_commit_authors(qs)
         return qs
 
     def get_author_tag(self, library_version):