website-v2/config/v3_urls.py at 29dcc1b680b20a4be7d60feef309b0ab14fd232f · boostorg/website-v2 · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
"""
V3 URL Registry
===============

All URLs with the explicit `/v3/` prefix live here.

All V3 views inherit from `V3Mixin` (see `core/mixins.py`). The test
`core/tests/test_v3_registry.py` auto-discovers all `V3Mixin`
subclasses via the URL resolver and verifies their templates exist — no
manual registration needed.

`V3Mixin` handles two cases based on class attributes:

* **Both templates** (`template_name` + `v3_template_name`) — legacy
  template by default, V3 template when the `v3` waffle flag is active.
* **V3 template only** (`v3_template_name`, no `template_name`) —
  returns 404 when the flag is off.

Full-migration procedure
------------------------
The `v3` waffle flag and `V3Mixin` are migration scaffolding.

A. Convert each view that has both templates
     1. Set `template_name` to the V3 template path.
     2. Fold `get_v3_context_data` into `get_context_data`.
     3. Remove `V3Mixin` from the class bases.
     4. Remove `v3_template_name` and `get_v3_context_data`.
     5. Delete the legacy template.

B. Promote each `/v3/` route
   For each route in this file, move it into `config/urls.py` to
   replace the legacy route (or create a permanent route if none
   exists). Delete or rename the V3 view class as appropriate.

C. Remove the flag from templates and JS
   Unwrap every `{% flag "v3" %}` block and drop matching JS gates.

D. Delete the scaffolding
     1. `V3Mixin` from `core/mixins.py`.
     2. `core/tests/test_v3_registry.py`.
     3. The `v3` waffle flag record from the database.
     4. This file and its import in `config/urls.py`.

See `docs/django-waffle-v3-flag.md` for additional flag context.
"""

from django.contrib.admin.views.decorators import staff_member_required
from django.urls import path

from core.views import LearnPageView, V3ComponentDemoView
from news.views import V3AllTypesCreateView
from users.views import (
    V3LoginView,
    V3PasswordResetDoneView,
    V3PasswordResetFromKeyDoneView,
    V3PasswordResetFromKeyView,
    V3PasswordResetView,
)

v3_urlpatterns = [
    path(
        "v3/demo/components/",
        staff_member_required(V3ComponentDemoView.as_view()),
        name="v3-demo-components",
    ),
    path(
        "v3/demo/learn-page/",
        staff_member_required(LearnPageView.as_view()),
        name="v3-learn-page",
    ),
    path(
        "v3/news/add/",
        V3AllTypesCreateView.as_view(),
        name="v3-news-create",
    ),
    path(
        "v3/accounts/login/",
        V3LoginView.as_view(),
        name="v3-login",
    ),
    path(
        "v3/accounts/password/reset/",
        V3PasswordResetView.as_view(),
        name="v3-password-reset",
    ),
    path(
        "v3/accounts/password/reset/done/",
        V3PasswordResetDoneView.as_view(),
        name="v3-password-reset-done",
    ),
    path(
        "v3/accounts/password/reset/key/",
        V3PasswordResetFromKeyView.as_view(),
        name="v3-password-reset-from-key",
    ),
    path(
        "v3/accounts/password/reset/key/done/",
        V3PasswordResetFromKeyDoneView.as_view(),
        name="v3-password-reset-from-key-done",
    ),
]