<img> tag, any alt "
+ "attribute must the last in the tag, else the image "
+ "will not preview"
+)
+
+
+class NoteAdminForm(forms.ModelForm):
+ note = forms.CharField(
+ widget=AdminPagedownWidget(),
+ help_text=pagedown_widget_help_text,
+ )
+ bug = forms.IntegerField(
+ widget=forms.NumberInput(attrs={"style": "width: 12em;"}),
+ required=False,
+ )
+
+ class Meta:
+ model = models.Note
+ fields = "__all__" # noqa: DJ007
+
+
+class NoteAdmin(admin.ModelAdmin):
+ form = NoteAdminForm
+ filter_horizontal = ["releases", "relevant_countries"]
+ list_display = ("id", "bug", "tag", "note", "created")
+ list_display_links = ("id",)
+ list_filter = ("tag", "is_known_issue", "releases__product", "releases__version", "progressive_rollout")
+ search_fields = ("bug", "note", "releases__version")
+
+
+class ReleaseAdminForm(forms.ModelForm):
+ system_requirements = forms.CharField(
+ widget=AdminPagedownWidget(),
+ required=False,
+ help_text=pagedown_widget_help_text,
+ )
+ text = forms.CharField(
+ widget=AdminPagedownWidget(),
+ required=False,
+ help_text=pagedown_widget_help_text,
+ )
+ release_date = forms.DateTimeField(widget=admin.widgets.AdminDateWidget)
+
+ class Meta:
+ model = models.Release
+ fields = (
+ "is_public",
+ "product",
+ "channel",
+ "version",
+ "release_date",
+ "text",
+ "bug_list",
+ "bug_search_url",
+ "system_requirements",
+ "reviewed_by_release_manager",
+ )
+
+
+class ReleaseAdmin(admin.ModelAdmin):
+ actions = ["copy_releases", "set_to_public", "set_to_private"]
+ form = ReleaseAdminForm
+ list_display = ("version", "product", "channel", "is_public", "release_date", "text", "url")
+ list_filter = ("product", "channel", "is_public")
+ ordering = ("-release_date",)
+ search_fields = ("version", "text")
+
+ class Media:
+ js = ["js/release-notes.js"]
+
+ def url(self, obj):
+ base_url_staging = "https://www-dev.allizom.org/en-US"
+ base_url_prod = "https://www.mozilla.com/en-US"
+ product = ""
+
+ if obj.product == "Firefox for Android":
+ product = "firefox/android"
+ if obj.product == "Firefox for iOS":
+ product = "firefox/ios"
+ elif obj.product == "Firefox" or obj.product == "Firefox Extended Support Release":
+ product = "firefox"
+ elif obj.product == "Thunderbird":
+ product = "thunderbird"
+ elif obj.product == "Firefox OS":
+ # Special case for Firefox OS. URL are different
+ return format_html(
+ 'Staging / Public',
+ staging=base_url_staging,
+ product=product,
+ version=obj.version,
+ prod=base_url_prod,
+ )
+
+ return format_html(
+ 'Staging / Public',
+ staging=base_url_staging,
+ product=product,
+ version=obj.version,
+ prod=base_url_prod,
+ )
+
+ def copy_releases(self, request, queryset):
+ release_count = 0
+ for release in queryset:
+ release_count += 1
+ copy_count = self.model.objects.filter(version__endswith=release.version, product=release.product).count()
+ notes = list(release.note_set.all())
+ copy = release
+ copy.id = None
+ if copy_count > 1:
+ copy.version = f"copy{copy_count}-{copy.version}"
+ else:
+ copy.version = "copy-" + copy.version
+ # By default, set it to public. Usually, the copy feature is
+ # used when copying beta => release. We want to review it
+ # before going live.
+ copy.is_public = False
+ copy.save()
+ copy.note_set.add(*notes)
+ copy.note_set.update(modified=now())
+ if release_count == 1:
+ self.message_user(request, "Copied Release")
+ else:
+ self.message_user(request, "Copied %s Releases" % release_count)
+
+ def set_to_public(self, request, queryset):
+ """Set one or several releases to public"""
+ # save them individually so that signals are sent
+ for obj in queryset:
+ obj.is_public = True
+ obj.save()
+
+ def set_to_private(self, request, queryset):
+ """Set one or several releases to private"""
+ # save them individually so that signals are sent
+ for obj in queryset:
+ obj.is_public = False
+ obj.save()
+
+
+class CountryAdmin(admin.ModelAdmin):
+ search_fields = ("name", "code")
+
+ class Meta:
+ model = models.Country
+
+
+admin.site.register(models.Country, CountryAdmin)
+admin.site.register(models.Note, NoteAdmin)
+admin.site.register(models.Release, ReleaseAdmin)
diff --git a/springfield/releasenotes/management/__init__.py b/springfield/releasenotes/management/__init__.py
deleted file mode 100644
index 448bb8652..000000000
--- a/springfield/releasenotes/management/__init__.py
+++ /dev/null
@@ -1,3 +0,0 @@
-# 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/.
diff --git a/springfield/releasenotes/management/commands/__init__.py b/springfield/releasenotes/management/commands/__init__.py
deleted file mode 100644
index 448bb8652..000000000
--- a/springfield/releasenotes/management/commands/__init__.py
+++ /dev/null
@@ -1,3 +0,0 @@
-# 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/.
diff --git a/springfield/releasenotes/management/commands/update_release_notes.py b/springfield/releasenotes/management/commands/update_release_notes.py
deleted file mode 100644
index 744b9a237..000000000
--- a/springfield/releasenotes/management/commands/update_release_notes.py
+++ /dev/null
@@ -1,40 +0,0 @@
-# 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 django.conf import settings
-from django.core.management.base import BaseCommand
-
-from springfield.releasenotes.models import ProductRelease
-from springfield.utils.git import GitRepo
-from springfield.utils.management.decorators import alert_sentry_on_exception
-
-
-@alert_sentry_on_exception
-class Command(BaseCommand):
- def add_arguments(self, parser):
- parser.add_argument("-q", "--quiet", action="store_true", dest="quiet", default=False, help="If no error occurs, swallow all output.")
- parser.add_argument("-f", "--force", action="store_true", dest="force", default=False, help="Load the data even if nothing new from git.")
-
- def output(self, msg):
- if not self.quiet:
- print(msg)
-
- def handle(self, *args, **options):
- self.quiet = options["quiet"]
- repo = GitRepo(settings.RELEASE_NOTES_PATH, settings.RELEASE_NOTES_REPO, branch_name=settings.RELEASE_NOTES_BRANCH, name="Release Notes")
- self.output("Updating git repo")
- self.output(repo.update())
- if not (options["force"] or repo.has_changes()):
- self.output("No release note updates")
- return
-
- self.output("Loading releases into database")
- count = ProductRelease.objects.refresh()
-
- self.output(f"{count} release notes successfully loaded")
-
- repo.set_db_latest()
-
- self.output("Saved latest git repo state to database")
- self.output("Done!")
diff --git a/springfield/releasenotes/middleware.py b/springfield/releasenotes/middleware.py
new file mode 100644
index 000000000..a0be1160d
--- /dev/null
+++ b/springfield/releasenotes/middleware.py
@@ -0,0 +1,14 @@
+# 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 django.utils.deprecation import MiddlewareMixin
+
+
+METHOD_OVERRIDE_HEADER = "HTTP_X_HTTP_METHOD_OVERRIDE"
+
+
+class PatchOverrideMiddleware(MiddlewareMixin):
+ def process_view(self, request, callback, callback_args, callback_kwargs):
+ if request.method == "POST" and request.META.get(METHOD_OVERRIDE_HEADER) == "PATCH":
+ request.method = "PATCH"
diff --git a/springfield/releasenotes/migrations/0003_country_release_note.py b/springfield/releasenotes/migrations/0003_country_release_note.py
new file mode 100644
index 000000000..85b9df774
--- /dev/null
+++ b/springfield/releasenotes/migrations/0003_country_release_note.py
@@ -0,0 +1,74 @@
+# Generated by Django 5.2 on 2025-05-22 15:35
+
+import django.db.models.deletion
+import django_extensions.db.fields
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('releasenotes', '0002_auto_20200122_0957'),
+ ]
+
+ operations = [
+ migrations.CreateModel(
+ name='Country',
+ fields=[
+ ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+ ('created', django_extensions.db.fields.CreationDateTimeField(auto_now_add=True, verbose_name='created')),
+ ('modified', django_extensions.db.fields.ModificationDateTimeField(auto_now=True, verbose_name='modified')),
+ ('name', models.CharField(max_length=128)),
+ ('code', models.CharField(help_text='3166-1-alpha-2 code', max_length=2)),
+ ],
+ options={
+ 'verbose_name_plural': 'Countries',
+ 'ordering': ['name'],
+ 'constraints': [models.UniqueConstraint(fields=('name', 'code'), name='unique_country_name_for_code')],
+ },
+ ),
+ migrations.CreateModel(
+ name='Release',
+ fields=[
+ ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+ ('created', django_extensions.db.fields.CreationDateTimeField(auto_now_add=True, verbose_name='created')),
+ ('modified', django_extensions.db.fields.ModificationDateTimeField(auto_now=True, verbose_name='modified')),
+ ('product', models.CharField(choices=[('Firefox', 'Firefox'), ('Firefox for Android', 'Firefox for Android'), ('Firefox for iOS', 'Firefox for iOS'), ('Firefox Extended Support Release', 'Firefox Extended Support Release'), ('Thunderbird', 'Thunderbird')], max_length=255)),
+ ('channel', models.CharField(choices=[('Nightly', 'Nightly'), ('Beta', 'Beta'), ('Release', 'Release'), ('ESR', 'ESR')], max_length=255)),
+ ('version', models.CharField(max_length=255)),
+ ('release_date', models.DateTimeField()),
+ ('text', models.TextField(blank=True)),
+ ('is_public', models.BooleanField(default=False, help_text='Note: If checked, these Release Notes will be visible on www.firefox.com')),
+ ('bug_list', models.TextField(blank=True)),
+ ('bug_search_url', models.CharField(blank=True, max_length=2000)),
+ ('system_requirements', models.TextField(blank=True)),
+ ('reviewed_by_release_manager', models.BooleanField(default=False, help_text='Purely a visual indicator in the admin - does not show on firefox.com', null=True)),
+ ],
+ options={
+ 'ordering': ['-release_date'],
+ 'get_latest_by': 'modified',
+ 'unique_together': {('product', 'version')},
+ },
+ ),
+ migrations.CreateModel(
+ name='Note',
+ fields=[
+ ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+ ('created', django_extensions.db.fields.CreationDateTimeField(auto_now_add=True, verbose_name='created')),
+ ('modified', django_extensions.db.fields.ModificationDateTimeField(auto_now=True, verbose_name='modified')),
+ ('bug', models.IntegerField(blank=True, null=True)),
+ ('note', models.TextField(blank=True)),
+ ('is_known_issue', models.BooleanField(default=False)),
+ ('tag', models.CharField(blank=True, choices=[('New', 'New'), ('Changed', 'Changed'), ('HTML5', 'HTML5'), ('Feature', 'Feature'), ('Language', 'Language'), ('Developer', 'Developer'), ('Enterprise', 'Enterprise'), ('Fixed', 'Fixed'), ('Community', 'Community')], max_length=255)),
+ ('sort_num', models.IntegerField(default=0)),
+ ('is_public', models.BooleanField(default=True)),
+ ('progressive_rollout', models.BooleanField(default=False)),
+ ('relevant_countries', models.ManyToManyField(blank=True, help_text="Select the countries where this Note applies, as part of a progressive rollout. This info will only be shown on the Release page if 'Progressive rollout', above, is ticked.", to='releasenotes.country')),
+ ('fixed_in_release', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='fixed_note_set', to='releasenotes.release')),
+ ('releases', models.ManyToManyField(blank=True, to='releasenotes.release')),
+ ],
+ options={
+ 'get_latest_by': 'modified',
+ },
+ ),
+ ]
diff --git a/springfield/releasenotes/migrations/0004_data_bootstrap_countries.py b/springfield/releasenotes/migrations/0004_data_bootstrap_countries.py
new file mode 100644
index 000000000..603643063
--- /dev/null
+++ b/springfield/releasenotes/migrations/0004_data_bootstrap_countries.py
@@ -0,0 +1,280 @@
+# Generated by Django 5.2 on 2025-05-06 20:52
+
+from django.db import migrations
+from django.utils.timezone import now
+
+
+iso_3166_1_alpha_2_country_codes = (
+ # Source https://datahub.io/core/country-list
+ # Public domain license: https://opendatacommons.org/licenses/pddl/
+ ("Afghanistan", "AF"),
+ ("Åland Islands", "AX"),
+ ("Albania", "AL"),
+ ("Algeria", "DZ"),
+ ("American Samoa", "AS"),
+ ("Andorra", "AD"),
+ ("Angola", "AO"),
+ ("Anguilla", "AI"),
+ ("Antarctica", "AQ"),
+ ("Antigua and Barbuda", "AG"),
+ ("Argentina", "AR"),
+ ("Armenia", "AM"),
+ ("Aruba", "AW"),
+ ("Australia", "AU"),
+ ("Austria", "AT"),
+ ("Azerbaijan", "AZ"),
+ ("Bahamas", "BS"),
+ ("Bahrain", "BH"),
+ ("Bangladesh", "BD"),
+ ("Barbados", "BB"),
+ ("Belarus", "BY"),
+ ("Belgium", "BE"),
+ ("Belize", "BZ"),
+ ("Benin", "BJ"),
+ ("Bermuda", "BM"),
+ ("Bhutan", "BT"),
+ ("Bolivia, Plurinational State of", "BO"),
+ ("Bonaire, Sint Eustatius and Saba", "BQ"),
+ ("Bosnia and Herzegovina", "BA"),
+ ("Botswana", "BW"),
+ ("Bouvet Island", "BV"),
+ ("Brazil", "BR"),
+ ("British Indian Ocean Territory", "IO"),
+ ("Brunei Darussalam", "BN"),
+ ("Bulgaria", "BG"),
+ ("Burkina Faso", "BF"),
+ ("Burundi", "BI"),
+ ("Cambodia", "KH"),
+ ("Cameroon", "CM"),
+ ("Canada", "CA"),
+ ("Cape Verde", "CV"),
+ ("Cayman Islands", "KY"),
+ ("Central African Republic", "CF"),
+ ("Chad", "TD"),
+ ("Chile", "CL"),
+ ("China", "CN"),
+ ("Christmas Island", "CX"),
+ ("Cocos (Keeling) Islands", "CC"),
+ ("Colombia", "CO"),
+ ("Comoros", "KM"),
+ ("Congo", "CG"),
+ ("Congo, the Democratic Republic of the", "CD"),
+ ("Cook Islands", "CK"),
+ ("Costa Rica", "CR"),
+ ("Côte d'Ivoire", "CI"),
+ ("Croatia", "HR"),
+ ("Cuba", "CU"),
+ ("Curaçao", "CW"),
+ ("Cyprus", "CY"),
+ ("Czech Republic", "CZ"),
+ ("Denmark", "DK"),
+ ("Djibouti", "DJ"),
+ ("Dominica", "DM"),
+ ("Dominican Republic", "DO"),
+ ("Ecuador", "EC"),
+ ("Egypt", "EG"),
+ ("El Salvador", "SV"),
+ ("Equatorial Guinea", "GQ"),
+ ("Eritrea", "ER"),
+ ("Estonia", "EE"),
+ ("Ethiopia", "ET"),
+ ("Falkland Islands (Malvinas)", "FK"),
+ ("Faroe Islands", "FO"),
+ ("Fiji", "FJ"),
+ ("Finland", "FI"),
+ ("France", "FR"),
+ ("French Guiana", "GF"),
+ ("French Polynesia", "PF"),
+ ("French Southern Territories", "TF"),
+ ("Gabon", "GA"),
+ ("Gambia", "GM"),
+ ("Georgia", "GE"),
+ ("Germany", "DE"),
+ ("Ghana", "GH"),
+ ("Gibraltar", "GI"),
+ ("Greece", "GR"),
+ ("Greenland", "GL"),
+ ("Grenada", "GD"),
+ ("Guadeloupe", "GP"),
+ ("Guam", "GU"),
+ ("Guatemala", "GT"),
+ ("Guernsey", "GG"),
+ ("Guinea", "GN"),
+ ("Guinea-Bissau", "GW"),
+ ("Guyana", "GY"),
+ ("Haiti", "HT"),
+ ("Heard Island and McDonald Islands", "HM"),
+ ("Holy See (Vatican City State)", "VA"),
+ ("Honduras", "HN"),
+ ("Hong Kong", "HK"),
+ ("Hungary", "HU"),
+ ("Iceland", "IS"),
+ ("India", "IN"),
+ ("Indonesia", "ID"),
+ ("Iran, Islamic Republic of", "IR"),
+ ("Iraq", "IQ"),
+ ("Ireland", "IE"),
+ ("Isle of Man", "IM"),
+ ("Israel", "IL"),
+ ("Italy", "IT"),
+ ("Jamaica", "JM"),
+ ("Japan", "JP"),
+ ("Jersey", "JE"),
+ ("Jordan", "JO"),
+ ("Kazakhstan", "KZ"),
+ ("Kenya", "KE"),
+ ("Kiribati", "KI"),
+ ("Korea, Democratic People's Republic of", "KP"),
+ ("Korea, Republic of", "KR"),
+ ("Kuwait", "KW"),
+ ("Kyrgyzstan", "KG"),
+ ("Lao People's Democratic Republic", "LA"),
+ ("Latvia", "LV"),
+ ("Lebanon", "LB"),
+ ("Lesotho", "LS"),
+ ("Liberia", "LR"),
+ ("Libya", "LY"),
+ ("Liechtenstein", "LI"),
+ ("Lithuania", "LT"),
+ ("Luxembourg", "LU"),
+ ("Macao", "MO"),
+ ("Macedonia, the Former Yugoslav Republic of", "MK"),
+ ("Madagascar", "MG"),
+ ("Malawi", "MW"),
+ ("Malaysia", "MY"),
+ ("Maldives", "MV"),
+ ("Mali", "ML"),
+ ("Malta", "MT"),
+ ("Marshall Islands", "MH"),
+ ("Martinique", "MQ"),
+ ("Mauritania", "MR"),
+ ("Mauritius", "MU"),
+ ("Mayotte", "YT"),
+ ("Mexico", "MX"),
+ ("Micronesia, Federated States of", "FM"),
+ ("Moldova, Republic of", "MD"),
+ ("Monaco", "MC"),
+ ("Mongolia", "MN"),
+ ("Montenegro", "ME"),
+ ("Montserrat", "MS"),
+ ("Morocco", "MA"),
+ ("Mozambique", "MZ"),
+ ("Myanmar", "MM"),
+ ("Namibia", "NA"),
+ ("Nauru", "NR"),
+ ("Nepal", "NP"),
+ ("Netherlands", "NL"),
+ ("New Caledonia", "NC"),
+ ("New Zealand", "NZ"),
+ ("Nicaragua", "NI"),
+ ("Niger", "NE"),
+ ("Nigeria", "NG"),
+ ("Niue", "NU"),
+ ("Norfolk Island", "NF"),
+ ("Northern Mariana Islands", "MP"),
+ ("Norway", "NO"),
+ ("Oman", "OM"),
+ ("Pakistan", "PK"),
+ ("Palau", "PW"),
+ ("Palestine, State of", "PS"),
+ ("Panama", "PA"),
+ ("Papua New Guinea", "PG"),
+ ("Paraguay", "PY"),
+ ("Peru", "PE"),
+ ("Philippines", "PH"),
+ ("Pitcairn", "PN"),
+ ("Poland", "PL"),
+ ("Portugal", "PT"),
+ ("Puerto Rico", "PR"),
+ ("Qatar", "QA"),
+ ("Réunion", "RE"),
+ ("Romania", "RO"),
+ ("Russian Federation", "RU"),
+ ("Rwanda", "RW"),
+ ("Saint Barthélemy", "BL"),
+ ("Saint Helena, Ascension and Tristan da Cunha", "SH"),
+ ("Saint Kitts and Nevis", "KN"),
+ ("Saint Lucia", "LC"),
+ ("Saint Martin (French part)", "MF"),
+ ("Saint Pierre and Miquelon", "PM"),
+ ("Saint Vincent and the Grenadines", "VC"),
+ ("Samoa", "WS"),
+ ("San Marino", "SM"),
+ ("Sao Tome and Principe", "ST"),
+ ("Saudi Arabia", "SA"),
+ ("Senegal", "SN"),
+ ("Serbia", "RS"),
+ ("Seychelles", "SC"),
+ ("Sierra Leone", "SL"),
+ ("Singapore", "SG"),
+ ("Sint Maarten (Dutch part)", "SX"),
+ ("Slovakia", "SK"),
+ ("Slovenia", "SI"),
+ ("Solomon Islands", "SB"),
+ ("Somalia", "SO"),
+ ("South Africa", "ZA"),
+ ("South Georgia and the South Sandwich Islands", "GS"),
+ ("South Sudan", "SS"),
+ ("Spain", "ES"),
+ ("Sri Lanka", "LK"),
+ ("Sudan", "SD"),
+ ("Suriname", "SR"),
+ ("Svalbard and Jan Mayen", "SJ"),
+ ("Swaziland", "SZ"),
+ ("Sweden", "SE"),
+ ("Switzerland", "CH"),
+ ("Syrian Arab Republic", "SY"),
+ ("Taiwan, Province of China", "TW"),
+ ("Tajikistan", "TJ"),
+ ("Tanzania, United Republic of", "TZ"),
+ ("Thailand", "TH"),
+ ("Timor-Leste", "TL"),
+ ("Togo", "TG"),
+ ("Tokelau", "TK"),
+ ("Tonga", "TO"),
+ ("Trinidad and Tobago", "TT"),
+ ("Tunisia", "TN"),
+ ("Turkey", "TR"),
+ ("Turkmenistan", "TM"),
+ ("Turks and Caicos Islands", "TC"),
+ ("Tuvalu", "TV"),
+ ("Uganda", "UG"),
+ ("Ukraine", "UA"),
+ ("United Arab Emirates", "AE"),
+ ("United Kingdom", "GB"),
+ ("United States", "US"),
+ ("United States Minor Outlying Islands", "UM"),
+ ("Uruguay", "UY"),
+ ("Uzbekistan", "UZ"),
+ ("Vanuatu", "VU"),
+ ("Venezuela, Bolivarian Republic of", "VE"),
+ ("Viet Nam", "VN"),
+ ("Virgin Islands, British", "VG"),
+ ("Virgin Islands, U.S.", "VI"),
+ ("Wallis and Futuna", "WF"),
+ ("Western Sahara", "EH"),
+ ("Yemen", "YE"),
+ ("Zambia", "ZM"),
+ ("Zimbabwe", "ZW"),
+)
+
+
+def forwards(apps, schema_editor):
+ Country = apps.get_model("releasenotes.Country")
+ for name, code in iso_3166_1_alpha_2_country_codes:
+ Country.objects.create(name=name, code=code, modified=now())
+
+
+def backwards(apps, schema_editor):
+ Country = apps.get_model("releasenotes.Country")
+ Country.objects.all().delete()
+
+
+class Migration(migrations.Migration):
+ dependencies = [
+ ('releasenotes', '0003_country_release_note'),
+ ]
+
+ operations = [
+ migrations.RunPython(forwards, backwards),
+ ]
diff --git a/springfield/releasenotes/migrations/0005_delete_productrelease.py b/springfield/releasenotes/migrations/0005_delete_productrelease.py
new file mode 100644
index 000000000..dd92eca11
--- /dev/null
+++ b/springfield/releasenotes/migrations/0005_delete_productrelease.py
@@ -0,0 +1,16 @@
+# Generated by Django 5.2 on 2025-05-22 19:53
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('releasenotes', '0004_data_bootstrap_countries'),
+ ]
+
+ operations = [
+ migrations.DeleteModel(
+ name='ProductRelease',
+ ),
+ ]
diff --git a/springfield/releasenotes/migrations/__init__.py b/springfield/releasenotes/migrations/__init__.py
index 448bb8652..e69de29bb 100644
--- a/springfield/releasenotes/migrations/__init__.py
+++ b/springfield/releasenotes/migrations/__init__.py
@@ -1,3 +0,0 @@
-# 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/.
diff --git a/springfield/releasenotes/models.py b/springfield/releasenotes/models.py
index 8e378a721..4307cd326 100644
--- a/springfield/releasenotes/models.py
+++ b/springfield/releasenotes/models.py
@@ -7,26 +7,32 @@
import os
import re
import xml.etree.ElementTree as etree
+from datetime import timedelta
from glob import glob
+from itertools import chain
from operator import attrgetter
from django.conf import settings
from django.core.cache import caches
from django.db import models, transaction
+from django.db.models import Q, UniqueConstraint
+from django.forms.models import model_to_dict
from django.http import Http404
from django.utils.dateparse import parse_datetime
from django.utils.functional import cached_property
+from django.utils.text import slugify
+from django.utils.timezone import now
import bleach
import markdown
from django_extensions.db.fields.json import JSONField
+from django_extensions.db.models import TimeStampedModel
from markdown.extensions import Extension
from markdown.inlinepatterns import InlineProcessor
from product_details.version_compare import Version
from springfield.base.urlresolvers import reverse
from springfield.releasenotes import version_re
-from springfield.releasenotes.utils import memoize
class StrikethroughInlineProcessor(InlineProcessor):
@@ -102,55 +108,6 @@ def process_markdown(value):
return bleach.clean(rendered_html, tags=ALLOWED_TAGS, attributes=ALLOWED_ATTRS)
-def process_notes(notes):
- notes = [Note(d) for d in notes]
- return [n for n in notes if n.is_public]
-
-
-def process_is_public(is_public):
- if settings.DEV:
- return True
-
- return is_public
-
-
-def process_note_release(rel_data):
- return ProductRelease(**rel_data)
-
-
-FIELD_PROCESSORS = {
- "created": parse_datetime,
- "modified": parse_datetime,
- "is_public": process_is_public,
- "note": process_markdown,
- "fixed_in_release": process_note_release,
-}
-
-
-class RNModel:
- def __init__(self, data):
- for key, value in data.items():
- if not hasattr(self, key):
- continue
- if key in FIELD_PROCESSORS:
- value = FIELD_PROCESSORS[key](value)
- setattr(self, key, value)
-
-
-class Note(RNModel):
- id = None
- bug = None
- note = ""
- tag = None
- is_public = True
- fixed_in_release = None
- sort_num = None
- created = None
- modified = None
- progressive_rollout = False
- relevant_countries = []
-
-
class MarkdownField(models.TextField):
"""Field that takes Markdown text as input and saves HTML to the database"""
@@ -161,7 +118,7 @@ def pre_save(self, model_instance, add):
return value
-class ProductReleaseQuerySet(models.QuerySet):
+class ReleaseQuerySet(models.QuerySet):
def product(self, product_name, channel_name=None, version=None):
if product_name.lower() == "firefox extended support release":
product_name = "firefox"
@@ -172,13 +129,12 @@ def product(self, product_name, channel_name=None, version=None):
if version:
q = q.filter(version=version)
- return q
+ return q.prefetch_related("note_set")
-
-class ProductReleaseManager(models.Manager):
+class ReleaseManager(models.Manager):
def get_queryset(self, include_drafts=False):
- qs = ProductReleaseQuerySet(self.model, using=self._db)
- if settings.DEV or include_drafts:
+ qs = ReleaseQuerySet(self.model, using=self._db)
+ if settings.DEV or settings.WAGTAIL_ENABLE_ADMIN or include_drafts:
return qs
return qs.filter(is_public=True)
@@ -186,61 +142,39 @@ def get_queryset(self, include_drafts=False):
def product(self, product_name, channel_name=None, version=None, include_drafts=False):
return self.get_queryset(include_drafts).product(product_name, channel_name, version)
- def refresh(self):
- version_regex = re.compile(version_re)
- release_objs = []
- rn_path = os.path.join(settings.RELEASE_NOTES_PATH, "releases")
- with transaction.atomic(using=self.db):
- self.get_queryset(include_drafts=True).delete()
- releases = glob(os.path.join(rn_path, "*.json"))
- for release_file in releases:
- with codecs.open(release_file, "r", encoding="utf-8") as rel_fh:
- data = json.load(rel_fh)
- # Make sure the version is valid and publicly accessible.
- if not version_regex.match(data["version"]):
- continue
- # doing this to simplify queries for Firefox since it is always
- # looked up with product=Firefox and relies on the version number
- # and channel to determine ESR.
- if data["product"] == "Firefox Extended Support Release":
- data["product"] = "Firefox"
- data["channel"] = "ESR"
- # make all releases public on non-production environments
- if settings.DEV:
- data["is_public"] = True
- release_objs.append(ProductRelease(**data))
-
- self.bulk_create(release_objs)
-
- return len(release_objs)
-
-
-class ProductRelease(models.Model):
- CHANNELS = ("Nightly", "Aurora", "Beta", "Release", "ESR")
- PRODUCTS = ("Firefox", "Firefox for Android", "Firefox Extended Support Release", "Firefox OS", "Thunderbird", "Firefox for iOS")
-
- product = models.CharField(max_length=50)
- channel = models.CharField(max_length=50)
- version = models.CharField(max_length=25)
- slug = models.CharField(max_length=255)
- title = models.CharField(max_length=255)
- release_date = models.DateField()
- text = MarkdownField(blank=True)
- is_public = models.BooleanField(default=False)
- bug_list = models.TextField(blank=True)
- bug_search_url = models.CharField(max_length=2000, blank=True)
- system_requirements = MarkdownField(blank=True)
- created = models.DateTimeField()
- modified = models.DateTimeField()
- notes = JSONField(blank=True)
+ def all_as_list(self):
+ """Return all releases as a list of dicts"""
+ return [r.to_dict() for r in self.prefetch_related("note_set").all()]
- objects = ProductReleaseManager()
+ def recently_modified_list(self, days_ago=7, mod_date=None):
+ if mod_date is None:
+ mod_date = now() - timedelta(days=days_ago)
- class Meta:
- ordering = ["-release_date"]
+ query = self.filter(Q(modified__gte=mod_date) | Q(note__modified__gte=mod_date) | Q(fixed_note_set__modified__gte=mod_date)).distinct()
+ return [r.to_dict() for r in query.prefetch_related("note_set")]
- def __str__(self):
- return self.title
+
+class Release(TimeStampedModel):
+ CHANNELS = ("Nightly", "Beta", "Release", "ESR")
+ PRODUCTS = ("Firefox", "Firefox for Android", "Firefox for iOS", "Firefox Extended Support Release", "Thunderbird")
+ PUBLIC_ONLY = not (settings.DEV or settings.WAGTAIL_ENABLE_ADMIN)
+
+ product = models.CharField(max_length=255, choices=[(p, p) for p in PRODUCTS])
+ channel = models.CharField(max_length=255, choices=[(c, c) for c in CHANNELS])
+ version = models.CharField(max_length=255)
+ release_date = models.DateTimeField()
+ text = models.TextField(blank=True)
+ is_public = models.BooleanField(default=False, help_text="Note: If checked, these Release Notes will be visible on www.firefox.com")
+ bug_list = models.TextField(blank=True)
+ bug_search_url = models.CharField(max_length=2000, blank=True)
+ system_requirements = models.TextField(blank=True)
+ reviewed_by_release_manager = models.BooleanField(
+ null=True,
+ default=False,
+ help_text="Purely a visual indicator in the admin - does not show on firefox.com",
+ )
+
+ objects = ReleaseManager()
def get_absolute_url(self):
if self.product == "Firefox for Android":
@@ -253,6 +187,23 @@ def get_absolute_url(self):
prefix = "aurora" if self.channel == "Aurora" else "release"
return reverse(urlname, args=[self.version, prefix])
+ @property
+ def slug(self):
+ product = slugify(self.product)
+ channel = self.channel.lower()
+ if product.lower() == "firefox-extended-support-release":
+ product = "firefox"
+ channel = "esr"
+ return "-".join([product, self.version, channel])
+
+ @property
+ def text_html(self):
+ return process_markdown(self.text)
+
+ @property
+ def system_requirements_html(self):
+ return process_markdown(self.system_requirements)
+
@cached_property
def major_version(self):
return str(self.version_obj.major)
@@ -265,23 +216,19 @@ def major_version_int(self):
def version_obj(self):
return Version(self.version)
- @property
- def is_latest(self):
- return self == get_latest_release(self.product, self.channel)
-
- def get_sysreq_url(self):
- if self.product == "Firefox for Android":
- urlname = "firefox.android.system_requirements"
- elif self.product == "Firefox for iOS":
- urlname = "firefox.ios.system_requirements"
- else:
- urlname = "firefox.system_requirements"
-
- return reverse(urlname, args=[self.version])
-
def get_bug_search_url(self):
if self.bug_search_url:
return self.bug_search_url
+
+ if self.product == "Thunderbird":
+ return (
+ "https://bugzilla.mozilla.org/buglist.cgi?"
+ "classification=Client%20Software&query_format=advanced&"
+ "bug_status=RESOLVED&bug_status=VERIFIED&bug_status=CLOSED&"
+ "target_milestone=Thunderbird%20{version}.0&product=Thunderbird"
+ "&resolution=FIXED"
+ ).format(version=self.major_version)
+
return (
"https://bugzilla.mozilla.org/buglist.cgi?"
"j_top=OR&f1=target_milestone&o3=equals&v3=Firefox%20{version}&"
@@ -297,11 +244,15 @@ def equivalent_release_for_product(self, product):
channel and major version with the highest minor version,
or None if no such releases exist
"""
- releases = ProductRelease.objects.product(product, self.channel).filter(version__startswith=f"{self.major_version}.")
+ releases = Release.objects.filter(version__startswith=self.major_version + ".", channel=self.channel, product=product).order_by(
+ "-version"
+ )
+ if not getattr(settings, "DEV", False):
+ releases = releases.filter(is_public=True)
if releases:
- return sorted(releases, reverse=True, key=attrgetter("version_obj"))[0]
-
- return None
+ return sorted(
+ sorted(releases, reverse=True, key=lambda r: len(r.version.split("."))), reverse=True, key=lambda r: r.version.split(".")[1]
+ )[0]
def equivalent_android_release(self):
if self.product == "Firefox":
@@ -311,21 +262,175 @@ def equivalent_desktop_release(self):
if self.product == "Firefox for Android":
return self.equivalent_release_for_product("Firefox")
+ def notes(self, public_only=None):
+ """
+ Retrieve a list of Note instances that should be shown for this
+ release, grouped as either new features or known issues, and sorted
+ first by sort_num highest to lowest and then by created date,
+ which is applied to both groups,
+ and then for new features we also sort by tag in the order specified
+ by Note.TAGS, with untagged notes coming first, then finally moving
+ any note with the fixed tag that starts with the release version to
+ the top, for what we call "dot fixes".
+ """
+ if public_only is None:
+ public_only = self.PUBLIC_ONLY
+
+ tag_index = {tag: i for i, tag in enumerate(Note.TAGS)}
+ notes = self.note_set.order_by("-sort_num", "created")
+ if public_only:
+ notes = notes.filter(is_public=True)
+ known_issues = [n for n in notes if n.is_known_issue_for(self)]
+ new_features = sorted(
+ sorted((n for n in notes if not n.is_known_issue_for(self)), key=lambda note: tag_index.get(note.tag, 0)),
+ key=lambda n: n.tag == "Fixed" and n.note.startswith(self.version),
+ reverse=True,
+ )
+
+ return new_features, known_issues
+
def get_notes(self):
- if not self.notes:
- return self.notes
- return process_notes(self.notes)
+ new_features, known_issues = self.notes(public_only=False)
+ return list(chain(new_features, known_issues))
+
+ def to_dict(self):
+ """Return a dict all all data about the release"""
+ data = model_to_dict(self, exclude=["id", "reviewed_by_release_manager"])
+ data["title"] = str(self)
+ data["slug"] = self.slug
+ data["release_date"] = self.release_date.date().isoformat()
+ data["created"] = self.created.isoformat()
+ data["modified"] = self.modified.isoformat()
+ new_features, known_issues = self.notes(public_only=False)
+ for note in known_issues:
+ note.tag = "Known"
+ data["notes"] = [n.to_dict(self) for n in chain(new_features, known_issues)]
+ return data
+
+ def to_simple_dict(self):
+ """Return a dict of only the basic data about the release"""
+ return {
+ "version": self.version,
+ "product": self.product,
+ "channel": self.channel,
+ "is_public": self.is_public,
+ "slug": self.slug,
+ "title": str(self),
+ }
+
+ def __str__(self):
+ return f"{self.product} {self.version} {self.channel}"
+
+ class Meta:
+ ordering = ["-release_date"]
+ unique_together = (("product", "version"),)
+ get_latest_by = "modified"
+
+
+class Note(TimeStampedModel):
+ TAGS = ("New", "Changed", "HTML5", "Feature", "Language", "Developer", "Enterprise", "Fixed", "Community")
+
+ bug = models.IntegerField(null=True, blank=True)
+ note = models.TextField(blank=True)
+ releases = models.ManyToManyField(Release, blank=True)
+ is_known_issue = models.BooleanField(default=False)
+ fixed_in_release = models.ForeignKey(Release, on_delete=models.SET_NULL, null=True, blank=True, related_name="fixed_note_set")
+ tag = models.CharField(max_length=255, blank=True, choices=[(t, t) for t in TAGS])
+ sort_num = models.IntegerField(default=0)
+ is_public = models.BooleanField(default=True)
+ progressive_rollout = models.BooleanField(default=False)
+ relevant_countries = models.ManyToManyField(
+ "Country",
+ blank=True,
+ help_text=(
+ "Select the countries where this Note applies, as part of a "
+ "progressive rollout. This info will only be shown on the Release "
+ "page if 'Progressive rollout', above, is ticked."
+ ),
+ )
+
+ related_field_to_github = "releases"
+
+ @property
+ def note_html(self):
+ return process_markdown(self.note)
+
+ def is_known_issue_for(self, release):
+ return self.is_known_issue and self.fixed_in_release != release
+
+ def to_dict(self, release=None):
+ data = model_to_dict(
+ self,
+ exclude=[
+ "releases",
+ "is_known_issue",
+ ],
+ )
+ data["created"] = self.created.isoformat()
+ data["modified"] = self.modified.isoformat()
+ if self.fixed_in_release:
+ data["fixed_in_release"] = self.fixed_in_release.to_simple_dict()
+ else:
+ del data["fixed_in_release"]
+
+ if release and self.is_known_issue_for(release):
+ data["tag"] = "Known"
+
+ if self.relevant_countries.count():
+ data["relevant_countries"] = [x.to_dict() for x in self.relevant_countries.all()]
+
+ return data
+
+ def __str__(self):
+ return self.note
+
+ class Meta:
+ get_latest_by = "modified"
+
+
+class Country(TimeStampedModel):
+ # Simple model for associating a Country with a Note
+
+ name = models.CharField(
+ blank=False,
+ max_length=128,
+ )
+ code = models.CharField(
+ blank=False,
+ help_text="3166-1-alpha-2 code",
+ max_length=2,
+ )
+
+ def __str__(self):
+ return f"{self.name} ({self.code})"
+
+ class Meta:
+ verbose_name_plural = "Countries"
+ ordering = ["name"]
+ constraints = [
+ UniqueConstraint(
+ fields=["name", "code"],
+ name="unique_country_name_for_code",
+ ),
+ ]
+
+ def to_dict(self):
+ data = model_to_dict(self)
+ del data["id"] # no need to dump out the internal ID for a Country
+ return data
+
+
+### END RNA MODELS
-@memoize(LONG_RN_CACHE_TIMEOUT)
def get_release(product, version, channel=None, include_drafts=False):
- channels = [channel] if channel else ProductRelease.CHANNELS
+ channels = [channel] if channel else Release.CHANNELS
if product.lower() == "firefox extended support release":
channels = ["esr"]
for channel in channels:
try:
- return ProductRelease.objects.product(product, channel, version, include_drafts).get()
- except ProductRelease.DoesNotExist:
+ return Release.objects.product(product, channel, version, include_drafts).get()
+ except Release.DoesNotExist:
continue
return None
@@ -339,9 +444,8 @@ def get_release_or_404(version, product, include_drafts=False):
return release
-@memoize(LONG_RN_CACHE_TIMEOUT)
def get_releases(product, channel, num_results=10):
- return ProductRelease.objects.product(product, channel)[:num_results]
+ return Release.objects.product(product, channel)[:num_results]
def get_releases_or_404(product, channel, num_results=10):
@@ -352,10 +456,9 @@ def get_releases_or_404(product, channel, num_results=10):
raise Http404
-@memoize(LONG_RN_CACHE_TIMEOUT)
def get_latest_release(product, channel="release"):
try:
- release = ProductRelease.objects.product(product, channel)[0]
+ release = Release.objects.product(product, channel)[0]
except IndexError:
release = None
diff --git a/springfield/releasenotes/serializers.py b/springfield/releasenotes/serializers.py
new file mode 100644
index 000000000..c3c942fb3
--- /dev/null
+++ b/springfield/releasenotes/serializers.py
@@ -0,0 +1,40 @@
+# 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 http://mozilla.org/MPL/2.0/.
+
+from rest_framework import serializers
+
+from .models import Country, Note, Release
+
+
+class HyperlinkedModelSerializerWithPkField(serializers.HyperlinkedModelSerializer):
+ def get_default_field_names(self, declared_fields, model_info):
+ fields = super().get_default_field_names(declared_fields, model_info)
+ fields.append("id")
+ return fields
+
+
+class CountrySerializer(serializers.ModelSerializer):
+ class Meta:
+ model = Country
+ fields = [
+ "name",
+ "code",
+ ]
+
+
+class NoteSerializer(HyperlinkedModelSerializerWithPkField):
+ relevant_countries = CountrySerializer(
+ read_only=True,
+ many=True,
+ )
+
+ class Meta:
+ model = Note
+ fields = "__all__"
+
+
+class ReleaseSerializer(HyperlinkedModelSerializerWithPkField):
+ class Meta:
+ model = Release
+ fields = "__all__"
diff --git a/springfield/releasenotes/templates/admin/base_site.html b/springfield/releasenotes/templates/admin/base_site.html
new file mode 100644
index 000000000..3832a0431
--- /dev/null
+++ b/springfield/releasenotes/templates/admin/base_site.html
@@ -0,0 +1,6 @@
+{% extends "admin/base_site.html" %}
+{% load static %}
+
+{% block extrastyle %}
+
+{% endblock %}
\ No newline at end of file
diff --git a/springfield/releasenotes/templates/admin/releasenotes/note/change_form.html b/springfield/releasenotes/templates/admin/releasenotes/note/change_form.html
new file mode 100644
index 000000000..6939fe4b5
--- /dev/null
+++ b/springfield/releasenotes/templates/admin/releasenotes/note/change_form.html
@@ -0,0 +1,20 @@
+{% extends "admin/change_form.html" %}
+
+{% block footer %}
+ {{ block.super }}
+
+{% endblock %}
+
+{% comment %}
+vim: filetype=htmldjango
+{% endcomment %}
diff --git a/springfield/releasenotes/templates/admin/releasenotes/release/change_form.html b/springfield/releasenotes/templates/admin/releasenotes/release/change_form.html
new file mode 100644
index 000000000..66eb703bf
--- /dev/null
+++ b/springfield/releasenotes/templates/admin/releasenotes/release/change_form.html
@@ -0,0 +1,33 @@
+{% extends "admin/change_form.html" %}
+{% load static %}
+
+{% block extrahead %}
+ {{ block.super }}
+
+{% endblock %}
+
+{% block after_related_objects %}
+{% if original %}
+
+Firefox Nightly") - assert note.id == 787203 - - @override_settings(DEV=False) - def test_is_public_query(self): - """Should not return the release value when DEV is false. - - Should also only include public notes.""" - assert models.get_release("firefox for android", "56.0.3") is None - rel = models.get_release("firefox", "57.0a1") - assert len(rel.get_notes()) == 4 - - @override_settings(DEV=True) - def test_is_public_field_processor_dev_true(self): - """Should always be true when DEV is true.""" - models.get_release("firefox for android", "56.0.3") - rel = models.get_release("firefox", "57.0a1") - assert len(rel.get_notes()) == 6 - - @override_settings(DEV=True) - def test_invalid_version(self): - """Should not load data for invalid versions.""" - models.ProductRelease.objects.refresh() - release_cache.clear() - assert models.get_release("firefox", "copy-56.0") is None - - -@patch.object(models.ProductRelease, "objects") +@patch.object(models.Release, "objects") class TestGetRelease(TestCase): def setUp(self): release_cache.clear() @@ -151,7 +46,7 @@ def setUp(self): def test_get_release(self, manager_mock): manager_mock.product().get.return_value = "dude is released" assert models.get_release("Firefox", "57.0") == "dude is released" - manager_mock.product.assert_called_with("Firefox", models.ProductRelease.CHANNELS[0], "57.0", False) + manager_mock.product.assert_called_with("Firefox", models.Release.CHANNELS[0], "57.0", False) def test_get_release_esr(self, manager_mock): manager_mock.product().get.return_value = "dude is released" @@ -160,17 +55,17 @@ def test_get_release_esr(self, manager_mock): def test_get_release_none_match(self, manager_mock): """Make sure the proper exception is raised if no file matches the query""" - manager_mock.product().get.side_effect = models.ProductRelease.DoesNotExist + manager_mock.product().get.side_effect = models.Release.DoesNotExist assert models.get_release("Firefox", "57.0") is None - expected_calls = chain.from_iterable((call("Firefox", ch, "57.0", False), call().get()) for ch in models.ProductRelease.CHANNELS) + expected_calls = chain.from_iterable((call("Firefox", ch, "57.0", False), call().get()) for ch in models.Release.CHANNELS) manager_mock.product.assert_has_calls(expected_calls) @override_settings(RELEASE_NOTES_PATH=RELEASES_PATH, DEV=False) class TestGetLatestRelease(TestCase): def setUp(self): - models.ProductRelease.objects.refresh() + models.Release.objects.refresh() release_cache.clear() def test_latest_release(self): @@ -179,7 +74,7 @@ def test_latest_release(self): def test_non_public_release_not_duped(self): # refresh again - models.ProductRelease.objects.refresh() + models.Release.objects.refresh() release_cache.clear() # non public release # should NOT raise multiple objects error @@ -199,3 +94,134 @@ def test_strikethrough_rendered_to_del(self): markdown.markdown("*hello~~test~~*"), "
hello~~test~~
", ) + + +class TestReleaseQueries(TestCase): + def setUp(self): + one_week_ago = now() - timedelta(days=7) + two_weeks_ago = now() - timedelta(days=14) + self.r1 = models.Release.objects.create( + product="Firefox", + channel="Nightly", + version="87.0a2", + release_date=now(), + ) + self.r2 = models.Release.objects.create( + product="Firefox", + channel="Nightly", + version="88.0a2", + release_date=now(), + ) + # modified now + self.r3 = models.Release.objects.create( + product="Firefox", + channel="Nightly", + version="89.0a2", + release_date=now(), + ) + self.r1.modified = two_weeks_ago + self.r1.save(modified=False) + self.r2.modified = one_week_ago + self.r2.save(modified=False) + + def test_recently_modified_release(self): + """Should only return releases modified more recently than `days_ago`""" + data = models.Release.objects.recently_modified_list(days_ago=5) + versions = [o["version"] for o in data] + assert self.r1.version not in versions + assert self.r2.version not in versions + assert self.r3.version in versions + + def test_recently_modified_note(self): + """Should also return releases with notes modified more recently than `days_ago`""" + self.r1.note_set.create(note="The Dude minds, man") + data = models.Release.objects.recently_modified_list(days_ago=5) + versions = [o["version"] for o in data] + assert self.r1.version in versions + assert self.r2.version not in versions + assert self.r3.version in versions + + def test_recently_modified_fixed_in_note(self): + """Should also return releases with notes modified more recently than `days_ago`""" + self.r2.fixed_note_set.create(note="The Dude minds, man") + data = models.Release.objects.recently_modified_list(days_ago=5) + versions = [o["version"] for o in data] + assert self.r1.version not in versions + assert self.r2.version in versions + assert self.r3.version in versions + + def test_distinct_recently_modified(self): + note = models.Note.objects.create(note="The Dude minds, man") + note2 = models.Note.objects.create(note="Careful, man, there’s a beverage here.") + self.r3.note_set.add(note) + self.r2.note_set.add(note) + self.r3.note_set.add(note2) + data = models.Release.objects.recently_modified_list(days_ago=5) + versions = [o["version"] for o in data] + assert self.r1.version not in versions + assert self.r2.version in versions + assert self.r3.version in versions + assert len(versions) == 2 + + +class TestNote(TestCase): + def test_to_dict__simple__no_relations(self): + # Very simple test of the to_dict() method, mainly + # to prove that progressive_rollout is included + data = dict( + bug=1234, + note="Test note", + tag="this is a tag", + sort_num=1, + is_public=True, + progressive_rollout=True, + ) + + note = Note(**data) + note.save() + + dumped_dict = note.to_dict() + for key in [ + "bug", + "note", + "tag", + "sort_num", + "is_public", + "progressive_rollout", + ]: + assert dumped_dict[key] == data[key] + + assert "created" in dumped_dict + assert "modified" in dumped_dict + + def test_to_dict__relevant_country_field(self): + # Country data is bootstrapped by a data migration + + iceland = models.Country.objects.get(code="IS") + india = models.Country.objects.get(code="IN") + + data = dict( + bug=1234, + note="Test note", + tag="this is a tag", + sort_num=1, + is_public=True, + progressive_rollout=True, + ) + + note = models.Note(**data) + note.save() + + assert note.relevant_countries.count() == 0 + dumped_dict = note.to_dict() + assert dumped_dict["relevant_countries"] == [] + + note.relevant_countries.add(india) + note.relevant_countries.add(iceland) + assert note.relevant_countries.count() == 2 + + dumped_dict = note.to_dict() + assert dumped_dict["relevant_countries"] == [ + {"name": "Iceland", "code": "IS"}, + {"name": "India", "code": "IN"}, + ] diff --git a/springfield/releasenotes/tests/test_views.py b/springfield/releasenotes/tests/test_views.py index 11c1617df..e775492a9 100644 --- a/springfield/releasenotes/tests/test_views.py +++ b/springfield/releasenotes/tests/test_views.py @@ -2,11 +2,19 @@ # 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/. + +import json +from datetime import timedelta from unittest.mock import patch +from django.test import RequestFactory, TestCase +from django.utils.http import http_date +from django.utils.timezone import now + import pytest -from springfield.releasenotes.views import releases_index, show_android_sys_req +from springfield.releasenotes.models import Note, Release +from springfield.releasenotes.views import releases_index, show_android_sys_req, export_json @pytest.mark.parametrize( @@ -161,3 +169,121 @@ def test_releases_index__product_other_than_firefox(render_mock, rf): "someproduct/releases/index.html", {"releases": []}, ) + + +class TestExportJSON(TestCase): + def setUp(self): + over_20_days = now() - timedelta(days=22) + over_30_days = now() - timedelta(days=32) + over_40_days = now() - timedelta(days=42) + self.r1 = Release.objects.create( + product="Firefox", + channel="Nightly", + version="87.0a2", + release_date=now(), + ) + self.r2 = Release.objects.create( + product="Firefox", + channel="Nightly", + version="88.0a2", + release_date=now(), + ) + # modified now + self.r3 = Release.objects.create( + product="Firefox", + channel="Nightly", + version="89.0a2", + release_date=now(), + ) + self.r1.modified = over_40_days + self.r1.save(modified=False) + self.r2.modified = over_30_days + self.r2.save(modified=False) + self.r3.modified = over_20_days + self.r3.save(modified=False) + self.rf = RequestFactory() + + def test_recently_modified_release(self): + """Should only return releases modified more recently than 30 days ago""" + resp = export_json(self.rf.get("/")) + data = json.loads(resp.content) + release_versions = [o["version"] for o in data] + assert self.r1.version not in release_versions + assert self.r2.version not in release_versions + assert self.r3.version in release_versions + + def test_if_modified_since(self): + """Should only return releases modified more recently than last-modified param""" + over_30_days_ago = now() - timedelta(days=34) + header_date = http_date(over_30_days_ago.timestamp()) + resp = export_json(self.rf.get("/", HTTP_IF_MODIFIED_SINCE=header_date)) + data = json.loads(resp.content) + release_versions = [o["version"] for o in data] + assert self.r1.version not in release_versions + assert self.r2.version in release_versions + assert self.r3.version in release_versions + + def test_if_modified_since_not_modified(self): + """Should return an empty list if nothing has been modified since""" + header_date = http_date(now().timestamp()) + resp = export_json(self.rf.get("/", HTTP_IF_MODIFIED_SINCE=header_date)) + data = json.loads(resp.content) + assert data == [] + + def test_invalid_if_modified_since_header(self): + """Should go back to 14 day default if param is not ISO date""" + header_date = "this is our concern Dude" + resp = export_json(self.rf.get("/", HTTP_IF_MODIFIED_SINCE=header_date)) + data = json.loads(resp.content) + release_versions = [o["version"] for o in data] + assert self.r1.version not in release_versions + assert self.r2.version not in release_versions + assert self.r3.version in release_versions + + def test_recently_modified_note(self): + """Should also return releases with notes modified more recently than 14 days ago""" + self.r1.note_set.create(note="The Dude minds, man") + resp = export_json(self.rf.get("/")) + data = json.loads(resp.content) + release_versions = [o["version"] for o in data] + assert self.r1.version in release_versions + assert self.r2.version not in release_versions + assert self.r3.version in release_versions + + def test_recently_modified_note_distinct(self): + """Should also return releases with notes modified more recently than 14 days ago""" + note = Note.objects.create(note="The Dude minds, man") + note2 = Note.objects.create(note="Careful, man, there’s a beverage here.") + self.r1.note_set.add(note) + self.r1.note_set.add(note2) + resp = export_json(self.rf.get("/")) + data = json.loads(resp.content) + release_versions = [o["version"] for o in data] + assert self.r1.version in release_versions + assert self.r2.version not in release_versions + assert self.r3.version in release_versions + assert len(release_versions) == 2 + + def test_recently_modified_fixed_in_note(self): + """Should also return releases with notes modified more recently than 14 days ago""" + self.r2.fixed_note_set.create(note="The Dude minds, man") + resp = export_json(self.rf.get("/")) + data = json.loads(resp.content) + release_versions = [o["version"] for o in data] + assert self.r1.version not in release_versions + assert self.r2.version in release_versions + assert self.r3.version in release_versions + + def test_all_as_list(self): + """Should return all releases with no dupes""" + note = Note.objects.create(note="The Dude minds, man") + note2 = Note.objects.create(note="Careful, man, there’s a beverage here.") + self.r1.note_set.add(note) + self.r1.note_set.add(note2) + resp = export_json(self.rf.get("/", {"all": "true"})) + data = json.loads(resp.content) + release_versions = [o["version"] for o in data] + assert self.r1.version in release_versions + assert self.r2.version in release_versions + assert self.r3.version in release_versions + assert len(release_versions) == 3 diff --git a/springfield/releasenotes/urls.py b/springfield/releasenotes/urls.py new file mode 100644 index 000000000..2ec60289b --- /dev/null +++ b/springfield/releasenotes/urls.py @@ -0,0 +1,19 @@ +# 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 http://mozilla.org/MPL/2.0/. +from django.urls import include, path + +from rest_framework import routers + +from . import views + +router = routers.DefaultRouter() +router.register("notes", views.NoteViewSet) +router.register("releases", views.ReleaseViewSet) + +urlpatterns = [ + path("", include(router.urls)), + path("releases/