Version warning banner: disable it for project not using it already (#10483)

* Version warning banner: disable it for project not using it already

We disccussed about this in readthedocs/meta#125

Basically, I want to disable it because it's more confusing than useful
currently. Besides, it will be completely replaced by the new addons work we are
doing.

This is the first step we are taking here: stop keep confusing users. The
following step would be to contact (if required) projects already using this feature and
migrate them to the new addons.

This commit includes a migration that creates the feature flag and assign all
the projects that are already using `Show version banner` to that flag.

* Hardcode feature id

Author: humitos

readthedocs/projects/forms.py

@@ -143,8 +143,8 @@ def clean_remote_repository(self):
                 pk=remote_repo,
                 users=self.user,
             )
-        except RemoteRepository.DoesNotExist:
-            raise forms.ValidationError(_('Repository invalid'))
+        except RemoteRepository.DoesNotExist as exc:
+            raise forms.ValidationError(_("Repository invalid")) from exc
 
     def placehold_repo(self):
         return choice([
@@ -248,6 +248,14 @@ def __init__(self, *args, **kwargs):
         )
 
         per_project_settings = list(self.Meta.per_project_settings)
+
+        # NOTE: we are deprecating this feature.
+        # However, we will keep it available for projects that already using it.
+        # Old projects not using it already or new projects won't be able to enable.
+        if not self.instance.has_feature(Feature.ALLOW_VERSION_WARNING_BANNER):
+            self.fields.pop("show_version_warning")
+            per_project_settings.remove("show_version_warning")
+
         if not settings.ALLOW_PRIVATE_REPOS:
             for field in ['privacy_level', 'external_builds_privacy_level']:
                 self.fields.pop(field)
@@ -595,8 +603,10 @@ def clean_payload(self):
         try:
             payload = json.loads(payload)
             payload = json.dumps(payload, indent=2)
-        except Exception:
-            raise forms.ValidationError(_('The payload must be a valid JSON object.'))
+        except Exception as exc:
+            raise forms.ValidationError(
+                _("The payload must be a valid JSON object.")
+            ) from exc
         return payload
 
 

readthedocs/projects/migrations/0102_allow_version_warning_banner.py

@@ -0,0 +1,23 @@
+# Generated by Django 3.2.19 on 2023-06-27 15:52
+
+from django.db import migrations
+
+
+def forwards_func(apps, schema_editor):
+    """Create ALLOW_VERSION_WARNING_BANNER feature flag and assign projects."""
+    Project = apps.get_model("projects", "Project")
+    Feature = apps.get_model("projects", "Feature")
+
+    feature = Feature.objects.create(feature_id="allow_version_warning_banner")
+    for project in Project.objects.filter(show_version_warning=True).iterator():
+        feature.projects.add(project)
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("projects", "0101_add_path_prefixes"),
+    ]
+
+    operations = [
+        migrations.RunPython(forwards_func),
+    ]

readthedocs/projects/models.py

@@ -1915,6 +1915,7 @@ def add_features(sender, **kwargs):
     DISABLE_PAGEVIEWS = "disable_pageviews"
     RESOLVE_PROJECT_FROM_HEADER = "resolve_project_from_header"
     USE_UNRESOLVER_WITH_PROXITO = "use_unresolver_with_proxito"
+    ALLOW_VERSION_WARNING_BANNER = "allow_version_warning_banner"
 
     # Versions sync related features
     SKIP_SYNC_TAGS = 'skip_sync_tags'
@@ -2007,6 +2008,10 @@ def add_features(sender, **kwargs):
                 "Proxito: Use new unresolver implementation for serving documentation files."
             ),
         ),
+        (
+            ALLOW_VERSION_WARNING_BANNER,
+            _("Dashboard: Allow project to use the version warning banner."),
+        ),
 
         # Versions sync related features
         (