Analytics: move page views to its own endpoint

This allow us to cache the footer response and keep receiving page
views.

Author: stsewd

readthedocs/analytics/apps.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 """Django app config for the analytics app."""
 
 from django.apps import AppConfig
@@ -11,6 +9,3 @@ class AnalyticsAppConfig(AppConfig):
 
     name = 'readthedocs.analytics'
     verbose_name = 'Analytics'
-
-    def ready(self):
-        from . import signals  # noqa

readthedocs/analytics/proxied_api.py

@@ -0,0 +1,98 @@
+"""Analytics views that are severd from the same domain as the docs."""
+
+from django.db.models import F
+from django.shortcuts import get_object_or_404
+from django.utils import timezone
+from rest_framework.response import Response
+from rest_framework.views import APIView
+
+from readthedocs.analytics.models import PageView
+from readthedocs.api.v2.permissions import IsAuthorizedToViewVersion
+from readthedocs.core.unresolver import unresolve_from_request
+from readthedocs.core.utils.extend import SettingsOverrideObject
+from readthedocs.projects.models import Feature, Project
+
+
+class BaseAnalyticsView(APIView):
+
+    """
+    Track page views.
+
+    Query parameters:
+
+    - project
+    - version
+    - absolute_uri: Full path with domain.
+    """
+
+    http_method_names = ['get']
+    permission_classes = [IsAuthorizedToViewVersion]
+
+    def _get_project(self):
+        cache_key = '__cached_project'
+        project = getattr(self, cache_key, None)
+
+        if not project:
+            project_slug = self.request.GET.get('project')
+            project = get_object_or_404(Project, slug=project_slug)
+            setattr(self, cache_key, project)
+
+        return project
+
+    def _get_version(self):
+        cache_key = '__cached_version'
+        version = getattr(self, cache_key, None)
+
+        if not version:
+            version_slug = self.request.GET.get('version')
+            project = self._get_project()
+            version = get_object_or_404(
+                project.versions.all(),
+                slug=version_slug,
+            )
+            setattr(self, cache_key, version)
+
+        return version
+
+    # pylint: disable=unused-argument
+    def get(self, request, *args, **kwargs):
+        project = self._get_project()
+        version = self._get_version()
+        absolute_uri = self.request.GET.get('absolute_uri')
+        self.increase_page_view_count(
+            request=request,
+            project=project,
+            version=version,
+            absolute_uri=absolute_uri,
+        )
+        return Response(status=200)
+
+    # pylint: disable=no-self-use
+    def increase_page_view_count(self, request, project, version, absolute_uri):
+        """Increase the page view count for the given project."""
+        if not absolute_uri or not project.has_feature(Feature.STORE_PAGEVIEWS):
+            return
+
+        unresolved = unresolve_from_request(request, absolute_uri)
+        if not unresolved:
+            return
+
+        path = unresolved.filename
+
+        fields = dict(
+            project=project,
+            version=version,
+            path=path,
+            date=timezone.now().date(),
+        )
+        page_view = PageView.objects.filter(**fields).first()
+        if page_view:
+            page_view.view_count = F('view_count') + 1
+            page_view.save(update_fields=['view_count'])
+        else:
+            PageView.objects.create(**fields, view_count=1)
+
+
+class AnalyticsView(SettingsOverrideObject):
+
+    _default_class = BaseAnalyticsView

readthedocs/analytics/signals.py

@@ -109,8 +109,8 @@ def setUp(self):
         self.absolute_uri = f'https://{self.project.slug}.readthedocs.io/en/latest/index.html'
         self.host = f'{self.project.slug}.readthedocs.io'
         self.url = (
-            reverse('footer_html') +
-            f'?project={self.project.slug}&version={self.version.slug}&page=index&docroot=/docs/' +
+            reverse('analytics_api') +
+            f'?project={self.project.slug}&version={self.version.slug}'
             f'&absolute_uri={self.absolute_uri}'
         )
 

readthedocs/analytics/tests.py

@@ -8,12 +8,15 @@
 from django.conf import settings
 from django.conf.urls import include, url
 
-from .views.proxied import ProxiedFooterHTML
+from readthedocs.analytics.proxied_api import AnalyticsView
 from readthedocs.search.proxied_api import ProxiedPageSearchAPIView
 
+from .views.proxied import ProxiedFooterHTML
+
 api_footer_urls = [
     url(r'footer_html/', ProxiedFooterHTML.as_view(), name='footer_html'),
     url(r'search/$', ProxiedPageSearchAPIView.as_view(), name='search_api'),
+    url(r'analytics/$', AnalyticsView.as_view(), name='analytics_api'),
 ]
 
 urlpatterns = api_footer_urls

readthedocs/api/v2/proxied_urls.py

@@ -11,12 +11,11 @@
 from rest_framework_jsonp.renderers import JSONPRenderer
 
 from readthedocs.api.v2.permissions import IsAuthorizedToViewVersion
-from readthedocs.api.v2.signals import footer_response
 from readthedocs.builds.constants import LATEST, TAG
 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 Feature, Project
+from readthedocs.projects.models import Project
 from readthedocs.projects.version_handling import (
     highest_version,
     parse_version_failsafe,
@@ -243,16 +242,6 @@ def get(self, request, format=None):
             'version_supported': version.supported,
         }
 
-        # Allow folks to hook onto the footer response for various information
-        # collection, or to modify the resp_data.
-        footer_response.send(
-            sender=None,
-            request=request,
-            context=context,
-            response_data=resp_data,
-            absolute_uri=self.request.GET.get('absolute_uri'),
-        )
-
         return Response(resp_data)
 
 

readthedocs/api/v2/signals.py

@@ -83,6 +83,19 @@ function init() {
             console.error('Error loading Read the Docs footer');
         }
     });
+
+    // Register page view.
+    $.ajax({
+        url: rtd.proxied_api_host + "/api/v2/analytics/",
+        data: {
+            project: rtd['project'],
+            version: rtd['version'],
+            absolute_uri: window.location.href,
+        },
+        error: function () {
+            console.error('Error registering page view');
+        }
+    });
 }
 
 module.exports = {

readthedocs/api/v2/views/footer_views.py

@@ -427,7 +427,7 @@ def test_highest_version_without_tags(self):
 class TestFooterPerformance(TestCase):
     # The expected number of queries for generating the footer
     # This shouldn't increase unless we modify the footer API
-    EXPECTED_QUERIES = 18
+    EXPECTED_QUERIES = 14
 
     def setUp(self):
         self.pip = get(