Extra features: allow to display them conditionally (#7715)

Author: stsewd

readthedocs/projects/views/private.py

@@ -39,10 +39,7 @@
     Version,
     VersionAutomationRule,
 )
-from readthedocs.core.mixins import (
-    ListViewWithForm,
-    PrivateViewMixin,
-)
+from readthedocs.core.mixins import ListViewWithForm, PrivateViewMixin
 from readthedocs.core.utils import broadcast, trigger_build
 from readthedocs.core.utils.extend import SettingsOverrideObject
 from readthedocs.integrations.models import HttpExchange, Integration
@@ -976,7 +973,7 @@ class RegexAutomationRuleUpdate(RegexAutomationRuleMixin, UpdateView):
     pass
 
 
-class SearchAnalytics(ProjectAdminMixin, PrivateViewMixin, TemplateView):
+class SearchAnalyticsBase(ProjectAdminMixin, PrivateViewMixin, TemplateView):
 
     template_name = 'projects/projects_search_analytics.html'
     http_method_names = ['get']
@@ -990,6 +987,10 @@ def get(self, request, *args, **kwargs):
     def get_context_data(self, **kwargs):
         context = super().get_context_data(**kwargs)
         project = self.get_project()
+        enabled = self._is_enabled(project)
+        context.update({'enabled': enabled})
+        if not enabled:
+            return context
 
         # data for plotting the line-chart
         query_count_of_1_month = SearchQuery.generate_queries_count_of_one_month(
@@ -1054,8 +1055,16 @@ def _search_analytics_csv_data(self):
         response['Content-Disposition'] = f'attachment; filename="{file_name}"'
         return response
 
+    def _is_enabled(self, project):
+        """Should we show search analytics for this project?"""
+        return True
+
+
+class SearchAnalytics(SettingsOverrideObject):
+    _default_class = SearchAnalyticsBase
+
 
-class TrafficAnalyticsView(ProjectAdminMixin, PrivateViewMixin, TemplateView):
+class TrafficAnalyticsViewBase(ProjectAdminMixin, PrivateViewMixin, TemplateView):
 
     template_name = 'projects/project_traffic_analytics.html'
     http_method_names = ['get']
@@ -1079,6 +1088,15 @@ def get_context_data(self, **kwargs):
         context.update({
             'top_viewed_pages': top_viewed_pages,
             'page_data': page_data,
+            'enabled': self._is_enabled(project),
         })
 
         return context
+
+    def _is_enabled(self, project):
+        """Should we show traffic analytics for this project?"""
+        return project.has_feature(Feature.STORE_PAGEVIEWS)
+
+
+class TrafficAnalyticsView(SettingsOverrideObject):
+    _default_class = TrafficAnalyticsViewBase

readthedocs/templates/projects/includes/feature_disabled.html

@@ -0,0 +1,3 @@
+<p class="empty">
+  This is a beta feature, it can be enabled by <a href="mailto:{{ SUPPORT_EMAIL }}">asking support</a>.
+</p>

readthedocs/templates/projects/project_traffic_analytics.html

@@ -11,10 +11,15 @@
 {% block project_edit_content_header %}{% trans "Traffic Analytics" %}{% endblock %}
 
 {% block project_edit_content %}
+
+  {% if not enabled %}
+    {% block disabled %}
+      {% include 'projects/includes/feature_disabled.html' %}
+    {% endblock %}
+  {% endif %}
+
   <h3>{% trans "Top viewed pages of the past month" %}</h3>
-    <p>
-      This beta feature can be enabled by <a href="mailto:{{ SUPPORT_EMAIL }}">asking support</a>.
-    </p>
+
     <div class="module-list">
       <div class="module-list-wrapper">
         <ul class="long-list-overflow">

readthedocs/templates/projects/projects_search_analytics.html

@@ -12,6 +12,12 @@
 
 {% block project_edit_content %}
 
+  {% if not enabled %}
+    {% block disabled %}
+      {% include 'projects/includes/feature_disabled.html' with project=project %}
+    {% endblock %}
+  {% endif %}
+
   <h3>{% trans "Top queries" %}</h3>
   <div class="module-list">
     <div class="module-list-wrapper">