Deprecation: opt-out from config file email (#10440)

* Deprecation: opt-out from config file email

This is the minimal version without spending too much time.
If we are fine with this, we can merge it for now and grow from here.
It does not look too complex, to keep or to remove it later :)

* Make the field nullable

* Update text from the email to mention opt-out

* Minor copy feedback

Author: humitos

readthedocs/core/forms.py

@@ -1,7 +1,8 @@
 """Forms for core app."""
 
 import structlog
-
+from crispy_forms.helper import FormHelper
+from crispy_forms.layout import Fieldset, Layout, Submit
 from django import forms
 from django.contrib.auth.models import User
 from django.forms.fields import CharField
@@ -21,7 +22,12 @@ class UserProfileForm(forms.ModelForm):
     class Meta:
         model = UserProfile
         # Don't allow users edit someone else's user page
-        fields = ['first_name', 'last_name', 'homepage']
+        profile_fields = ["first_name", "last_name", "homepage"]
+        optout_email_fields = ["optout_email_config_file_deprecation"]
+        fields = (
+            *profile_fields,
+            *optout_email_fields,
+        )
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
@@ -31,6 +37,20 @@ def __init__(self, *args, **kwargs):
         except AttributeError:
             pass
 
+        self.helper = FormHelper()
+        field_sets = [
+            Fieldset(
+                _("User settings"),
+                *self.Meta.profile_fields,
+            ),
+            Fieldset(
+                _("Email settings"),
+                *self.Meta.optout_email_fields,
+            ),
+        ]
+        self.helper.layout = Layout(*field_sets)
+        self.helper.add_input(Submit("save", _("Save")))
+
     def save(self, commit=True):
         first_name = self.cleaned_data.pop('first_name', None)
         last_name = self.cleaned_data.pop('last_name', None)

readthedocs/core/migrations/0013_add_optout_email_config_file_deprecation.py

@@ -0,0 +1,30 @@
+# Generated by Django 3.2.19 on 2023-06-14 17:17
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("core", "0012_add_newsletter_setting"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="historicaluserprofile",
+            name="optout_email_config_file_deprecation",
+            field=models.BooleanField(
+                default=False,
+                null=True,
+                verbose_name="Opt-out from email about 'Config file deprecation'",
+            ),
+        ),
+        migrations.AddField(
+            model_name="userprofile",
+            name="optout_email_config_file_deprecation",
+            field=models.BooleanField(
+                default=False,
+                null=True,
+                verbose_name="Opt-out from email about 'Config file deprecation'",
+            ),
+        ),
+    ]

readthedocs/core/models.py

@@ -43,6 +43,15 @@ class UserProfile(TimeStampedModel):
     whitelisted = models.BooleanField(_("Whitelisted"), default=False)
     banned = models.BooleanField(_("Banned"), default=False)
 
+    # Opt-out on emails
+    # NOTE: this is a temporary field that we can remove after September 25, 2023
+    # See https://blog.readthedocs.com/migrate-configuration-v2/
+    optout_email_config_file_deprecation = models.BooleanField(
+        _("Opt-out from email about 'Config file deprecation'"),
+        default=False,
+        null=True,
+    )
+
     # Model history
     history = ExtraHistoricalRecords()
 

readthedocs/projects/tasks/utils.py

@@ -269,9 +269,11 @@ def deprecated_config_file_used_notification():
     # Only send 1 email per user,
     # even if that user has multiple projects without a configuration file.
     # The notification will mention all the projects.
-    queryset = User.objects.filter(username__in=users, profile__banned=False).order_by(
-        "id"
-    )
+    queryset = User.objects.filter(
+        username__in=users,
+        profile__banned=False,
+        profile__optout_email_config_file_deprecation=False,
+    ).order_by("id")
 
     n_users = queryset.count()
     for i, user in enumerate(queryset.iterator()):

readthedocs/templates/profiles/private/edit_profile.html

@@ -1,4 +1,5 @@
 {% extends "profiles/base_profile_edit.html" %}
+{% load crispy_forms_tags %}
 
 {% load i18n %}
 
@@ -9,8 +10,5 @@
 {% block edit_content_header %} {% trans "Edit your profile" %} {% endblock %}
 
 {% block edit_content %}
-  <form method="POST" action=".">{% csrf_token %}
-    {{ form.as_p }}
-    <input type="submit" name="submit" value="{% trans "OK, save it!" %}" id="submit"/>
-  </form>
+    {% crispy form %}
 {% endblock %}

readthedocs/templates/projects/notifications/deprecated_config_file_used_email.html

@@ -25,6 +25,7 @@
 </ul>
 
 Please add a configuration file to your projects to ensure that they continue building successfully and to stop receiving these notifications.
+If you want to opt-out from these emails, you can <a href="https://readthedocs.org/accounts/edit/"> edit your preferences in your account settings</a>.
 
 For more information on how to create a required configuration file,
 <a href="https://blog.readthedocs.com/migrate-configuration-v2/">read our blog post</a>

readthedocs/templates/projects/notifications/deprecated_config_file_used_email.txt

@@ -21,6 +21,7 @@ We have identified that the following projects which you maintain, and were buil
 {% endif %}
 
 Please add a configuration file to your projects to ensure that they continue building successfully and to stop receiving these notifications.
+If you want to opt-out from these emails, you can edit your preferences in your account settings, at https://readthedocs.org/accounts/edit/.
 
 For more information on how to create a required configuration file,
 read our blog post at https://blog.readthedocs.com/migrate-configuration-v2/