Merge pull request #7097 from readthedocs/add-pageview-settings

Add a setting for storing pageviews

Author: ericholscher

readthedocs/api/v2/views/footer_views.py

@@ -16,7 +16,7 @@
 from readthedocs.builds.models import Version
 from readthedocs.core.utils.extend import SettingsOverrideObject
 from readthedocs.projects.constants import MKDOCS, SPHINX_HTMLDIR
-from readthedocs.projects.models import Project
+from readthedocs.projects.models import Project, Feature
 from readthedocs.projects.version_handling import (
     highest_version,
     parse_version_failsafe,
@@ -225,7 +225,7 @@ def get(self, request, format=None):
 
         # increase the page view count for the given page
         page_slug = request.GET.get('page', '')
-        if page_slug:
+        if page_slug and project.has_feature(Feature.STORE_PAGEVIEWS):
             increase_page_view_count.delay(
                 project_slug=context['project'].slug,
                 version_slug=context['version'].slug,

readthedocs/projects/models.py

@@ -1468,6 +1468,7 @@ def add_features(sender, **kwargs):
     FORCE_SPHINX_FROM_VENV = 'force_sphinx_from_venv'
     LIST_PACKAGES_INSTALLED_ENV = 'list_packages_installed_env'
     VCS_REMOTE_LISTING = 'vcs_remote_listing'
+    STORE_PAGEVIEWS = 'store_pageviews'
 
     FEATURES = (
         (USE_SPHINX_LATEST, _('Use latest version of Sphinx')),
@@ -1557,6 +1558,10 @@ def add_features(sender, **kwargs):
             VCS_REMOTE_LISTING,
             _('Use remote listing in VCS (e.g. git ls-remote) if supported for sync versions'),
         ),
+        (
+            STORE_PAGEVIEWS,
+            _('Store pageviews for this project'),
+        ),
     )
 
     projects = models.ManyToManyField(

readthedocs/rtd_tests/tests/test_footer.py

@@ -418,7 +418,7 @@ class TestFooterPerformance(APITestCase):
 
     # The expected number of queries for generating the footer
     # This shouldn't increase unless we modify the footer API
-    EXPECTED_QUERIES = 13
+    EXPECTED_QUERIES = 14
 
     def setUp(self):
         self.pip = Project.objects.get(slug='pip')

readthedocs/settings/base.py

@@ -1,6 +1,5 @@
 # pylint: disable=missing-docstring
 
-import getpass
 import os
 import subprocess
 

readthedocs/templates/projects/project_traffic_analytics.html

@@ -12,6 +12,9 @@
 
 {% block project_edit_content %}
   <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">