Addons: allow users to opt-in into the beta addons

readthedocs/projects/forms.py

@@ -27,6 +27,7 @@
     EnvironmentVariable,
     Feature,
     Project,
+    ProjectAddonsConfig,
     ProjectRelationship,
     WebHook,
 )
@@ -493,6 +494,35 @@ def clean_alias(self):
         return alias
 
 
+class ProjectAddonsForm(forms.ModelForm):
+
+    """Form to opt-in into new beta addons."""
+
+    enabled = forms.BooleanField(
+        label="Enable Read the Docs beta addons",
+        help_text="Opt-in into new beta addons",
+        required=False,
+    )
+
+    class Meta:
+        model = Project
+        fields = ()
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        enabled = bool(self.instance.addons)
+        self.fields["enabled"].initial = enabled
+
+    def save(self, commit=True):
+        instance = super().save(commit)
+        if self.cleaned_data.get("enabled", False):
+            self.instance.addons = ProjectAddonsConfig.objects.create()
+            self.instance.save()
+        elif self.instance.addons:
+            self.instance.addons.delete()
+        return instance
+
+
 class UserForm(forms.Form):
 
     """Project owners form."""

readthedocs/projects/migrations/0106_add_addons_config.py

@@ -0,0 +1,120 @@
+# Generated by Django 4.2.5 on 2023-09-13 14:21
+
+import django.db.models.deletion
+import django_extensions.db.fields
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("projects", "0105_remove_project_urlconf"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="ProjectAddonsConfig",
+            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"
+                    ),
+                ),
+                ("analytics_enabled", models.BooleanField(default=True)),
+                ("doc_diff_enabled", models.BooleanField(default=True)),
+                ("doc_diff_show_additions", models.BooleanField(default=True)),
+                ("doc_diff_show_deletions", models.BooleanField(default=True)),
+                ("doc_diff_root_selector", models.CharField(blank=True, null=True)),
+                ("external_version_warning", models.BooleanField(default=True)),
+                ("ethicalads_enabled", models.BooleanField(default=True)),
+                ("flyout_enabled", models.BooleanField(default=True)),
+                ("hotkeys_enabled", models.BooleanField(default=True)),
+                ("search_enabled", models.BooleanField(default=True)),
+                ("search_default_filter", models.CharField(blank=True, null=True)),
+                ("stable_latest_version_warning", models.BooleanField(default=True)),
+            ],
+            options={
+                "get_latest_by": "modified",
+                "abstract": False,
+            },
+        ),
+        migrations.CreateModel(
+            name="AddonSearchFilter",
+            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)),
+                ("syntaxt", models.CharField(max_length=128)),
+                (
+                    "addons",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to="projects.projectaddonsconfig",
+                    ),
+                ),
+            ],
+            options={
+                "get_latest_by": "modified",
+                "abstract": False,
+            },
+        ),
+        migrations.AddField(
+            model_name="historicalproject",
+            name="addons",
+            field=models.ForeignKey(
+                blank=True,
+                db_constraint=False,
+                null=True,
+                on_delete=django.db.models.deletion.DO_NOTHING,
+                related_name="+",
+                to="projects.projectaddonsconfig",
+                verbose_name="Addons project configuration",
+            ),
+        ),
+        migrations.AddField(
+            model_name="project",
+            name="addons",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="project",
+                to="projects.projectaddonsconfig",
+                verbose_name="Addons project configuration",
+            ),
+        ),
+    ]

readthedocs/projects/models.py

@@ -123,6 +123,60 @@ def subproject_prefix(self):
         return unsafe_join_url_path(prefix, self.alias, "/")
 
 
+class ProjectAddonsConfig(TimeStampedModel):
+
+    """
+    Addons project configuration.
+
+    Store all the configuration for each of the addons.
+    Everything is enabled by default.
+    """
+
+    DOC_DIFF_DEFAULT_ROOT_SELECTOR = "[role=main]"
+
+    # Analytics
+    analytics_enabled = models.BooleanField(default=True)
+
+    # Docdiff
+    doc_diff_enabled = models.BooleanField(default=True)
+    doc_diff_root_selector = models.CharField(null=True, blank=True)
+    doc_diff_show_additions = models.BooleanField(default=True)
+    doc_diff_show_deletions = models.BooleanField(default=True)
+    doc_diff_root_selector = models.CharField(null=True, blank=True)
+
+    # External version warning
+    external_version_warning = models.BooleanField(default=True)
+
+    # EthicalAds
+    ethicalads_enabled = models.BooleanField(default=True)
+
+    # Flyout
+    flyout_enabled = models.BooleanField(default=True)
+
+    # Hotkeys
+    hotkeys_enabled = models.BooleanField(default=True)
+
+    # Search
+    search_enabled = models.BooleanField(default=True)
+    search_default_filter = models.CharField(null=True, blank=True)
+
+    # Stable/Latest version warning
+    stable_latest_version_warning = models.BooleanField(default=True)
+
+
+class AddonSearchFilter(TimeStampedModel):
+
+    """
+    Addon search user defined filter.
+
+    Specific filter defined by the user to show on the search modal.
+    """
+
+    addons = models.ForeignKey("ProjectAddonsConfig", on_delete=models.CASCADE)
+    name = models.CharField(max_length=128)
+    syntaxt = models.CharField(max_length=128)
+
+
 class Project(models.Model):
 
     """Project model."""
@@ -131,6 +185,18 @@ class Project(models.Model):
     pub_date = models.DateTimeField(_('Publication date'), auto_now_add=True, db_index=True)
     modified_date = models.DateTimeField(_('Modified date'), auto_now=True, db_index=True)
 
+    # NOTE: we are defaulting this field to ``NULL``, meaning the "new beta addons" are disabled.
+    # When the user enables the beta addons, we create a ``AddonsProjectConfig`` and attach it
+    # to this ``Project`` to override the "old integration" at serve time.
+    addons = models.ForeignKey(
+        "ProjectAddonsConfig",
+        verbose_name=_("Addons project configuration"),
+        related_name="project",
+        null=True,
+        blank=True,
+        on_delete=models.SET_NULL,
+    )
+
     # Generally from conf.py
     users = models.ManyToManyField(
         User,

readthedocs/projects/urls/private.py

@@ -26,6 +26,7 @@
     IntegrationExchangeDetail,
     IntegrationList,
     IntegrationWebhookSync,
+    ProjectAddonsUpdate,
     ProjectAdvancedUpdate,
     ProjectAdvertisingUpdate,
     ProjectDashboard,
@@ -204,6 +205,16 @@
 
 urlpatterns += domain_urls
 
+addons_urls = [
+    re_path(
+        r"^(?P<project_slug>[-\w]+)/addons/edit/$$",
+        ProjectAddonsUpdate.as_view(),
+        name="projects_addons",
+    ),
+]
+
+urlpatterns += addons_urls
+
 integration_urls = [
     re_path(
         r"^(?P<project_slug>{project_slug})/integrations/$".format(**pattern_opts),

readthedocs/projects/views/private.py

@@ -50,6 +50,7 @@
     EmailHookForm,
     EnvironmentVariableForm,
     IntegrationForm,
+    ProjectAddonsForm,
     ProjectAdvancedForm,
     ProjectAdvertisingForm,
     ProjectBasicsForm,
@@ -168,6 +169,15 @@ def get_success_url(self):
         return reverse('projects_detail', args=[self.object.slug])
 
 
+class ProjectAddonsUpdate(ProjectMixin, UpdateView):
+    form_class = ProjectAddonsForm
+    success_message = _("Project addons updated")
+    template_name = "projects/addons_form.html"
+
+    def get_success_url(self):
+        return reverse("projects_addons", args=[self.object.slug])
+
+
 class ProjectDelete(UpdateChangeReasonPostView, ProjectMixin, DeleteView):
 
     success_message = _('Project deleted')

readthedocs/proxito/middleware.py

@@ -25,6 +25,7 @@
     unresolver,
 )
 from readthedocs.core.utils import get_cache_tag
+from readthedocs.projects.models import Project
 from readthedocs.proxito.cache import add_cache_tags, cache_response, private_response
 from readthedocs.proxito.redirects import redirect_to_https
 
@@ -269,12 +270,22 @@ def add_hosting_integrations_headers(self, request, response):
         project_slug = getattr(request, "path_project_slug", "")
         version_slug = getattr(request, "path_version_slug", "")
 
-        if project_slug and version_slug:
-            addons = Version.objects.filter(
+        if project_slug:
+            force_addons = Project.objects.filter(
                 project__slug=project_slug,
-                slug=version_slug,
-                addons=True,
+                addons__isnull=False,
             ).exists()
+            if force_addons:
+                response["X-RTD-Force-Addons"] = "true"
+                return
+
+            if version_slug:
+                addons = Version.objects.filter(
+                    project__slug=project_slug,
+                    slug=version_slug,
+                    addons=True,
+                ).exists()
+
             if addons:
                 response["X-RTD-Hosting-Integrations"] = "true"
 

readthedocs/proxito/views/hosting.py

@@ -239,6 +239,7 @@ def _v0(self, project, version, build, filename, user):
             project.translations.all().only("language").order_by("language")
         )
         # Make one DB query here and then check on Python code
+        # TODO: make usage of ``Project.addons.<name>_enabled`` to decide if enabled
         project_features = project.features.all().values_list("feature_id", flat=True)
 
         data = {