Merge pull request #6353 from stsewd/dont-link-to-dashboard-from-footer

Dont link to dashboard from footer

Author: ericholscher

readthedocs/api/v2/views/footer_views.py

@@ -44,7 +44,9 @@ def get_version_compare_data(project, base_version=None):
         'is_highest': True,
     }
     if highest_version_obj:
-        ret_val['url'] = highest_version_obj.get_absolute_url()
+        # Never link to the dashboard,
+        # users reading the docs may don't have access to the dashboard.
+        ret_val['url'] = highest_version_obj.get_absolute_url(link_to_dashboard=False)
         ret_val['slug'] = highest_version_obj.slug
     if base_version and base_version.slug != LATEST:
         try:

readthedocs/builds/models.py

@@ -78,7 +78,6 @@
 from readthedocs.projects.models import APIProject, Project
 from readthedocs.projects.version_handling import determine_stable_version
 
-
 log = logging.getLogger(__name__)
 
 
@@ -290,7 +289,13 @@ def commit_name(self):
         )
         return self.identifier
 
-    def get_absolute_url(self):
+    def get_absolute_url(self, link_to_dashboard=True):
+        """
+        Get absolute url to the docs of the version.
+
+        :param link_to_dashboard: If `False` we never try to link to the dashboard,
+                                  we link to the docs even if they result in a 404.
+        """
         # Hack external versions for now.
         # TODO: We can integrate them into the resolver
         # but this is much simpler to handle since we only link them a couple places for now
@@ -300,7 +305,7 @@ def get_absolute_url(self):
                 f'{self.project.slug}/{self.slug}/index.html'
             return url
 
-        if not self.built and not self.uploaded:
+        if not self.built and not self.uploaded and link_to_dashboard:
             return reverse(
                 'project_version_detail',
                 kwargs={

readthedocs/rtd_tests/tests/test_footer.py

@@ -1,6 +1,7 @@
 import mock
 from django.contrib.sessions.backends.base import SessionBase
 from django.test import TestCase
+from django.test.utils import override_settings
 from rest_framework.test import APIRequestFactory, APITestCase
 
 from readthedocs.api.v2.views.footer_views import (
@@ -114,6 +115,10 @@ def test_not_show_edit_on_github(self):
         self.assertNotIn('Edit', response.data['html'])
 
 
+@override_settings(
+    USE_SUBDOMAIN=True,
+    PUBLIC_DOMAIN='readthedocs.io',
+)
 class TestVersionCompareFooter(TestCase):
     fixtures = ['test_data']
 
@@ -124,7 +129,7 @@ def test_highest_version_from_stable(self):
         base_version = self.pip.get_stable_version()
         valid_data = {
             'project': 'Version 0.8.1 of Pip (19)',
-            'url': '/dashboard/pip/version/0.8.1/',
+            'url': 'http://pip.readthedocs.io/en/0.8.1/',
             'slug': '0.8.1',
             'version': '0.8.1',
             'is_highest': True,
@@ -136,7 +141,7 @@ def test_highest_version_from_lower(self):
         base_version = self.pip.versions.get(slug='0.8')
         valid_data = {
             'project': 'Version 0.8.1 of Pip (19)',
-            'url': '/dashboard/pip/version/0.8.1/',
+            'url': 'http://pip.readthedocs.io/en/0.8.1/',
             'slug': '0.8.1',
             'version': '0.8.1',
             'is_highest': False,
@@ -149,7 +154,7 @@ def test_highest_version_from_latest(self):
         base_version = self.pip.versions.get(slug=LATEST)
         valid_data = {
             'project': 'Version 0.8.1 of Pip (19)',
-            'url': '/dashboard/pip/version/0.8.1/',
+            'url': 'http://pip.readthedocs.io/en/0.8.1/',
             'slug': '0.8.1',
             'version': '0.8.1',
             'is_highest': True,
@@ -177,7 +182,7 @@ def test_highest_version_over_branches(self):
         base_version = self.pip.versions.get(slug='0.8.1')
         valid_data = {
             'project': 'Version 1.0.0 of Pip ({})'.format(version.pk),
-            'url': '/dashboard/pip/version/1.0.0/',
+            'url': 'http://pip.readthedocs.io/en/1.0.0/',
             'slug': '1.0.0',
             'version': '1.0.0',
             'is_highest': False,
@@ -191,7 +196,7 @@ def test_highest_version_without_tags(self):
         base_version = self.pip.versions.get(slug='0.8.1')
         valid_data = {
             'project': 'Version 0.8.1 of Pip (19)',
-            'url': '/dashboard/pip/version/0.8.1/',
+            'url': 'http://pip.readthedocs.io/en/0.8.1/',
             'slug': '0.8.1',
             'version': '0.8.1',
             'is_highest': True,
@@ -202,7 +207,7 @@ def test_highest_version_without_tags(self):
         base_version = self.pip.versions.get(slug='0.8')
         valid_data = {
             'project': 'Version 0.8.1 of Pip (19)',
-            'url': '/dashboard/pip/version/0.8.1/',
+            'url': 'http://pip.readthedocs.io/en/0.8.1/',
             'slug': '0.8.1',
             'version': '0.8.1',
             'is_highest': False,
@@ -219,7 +224,7 @@ def test_highest_version_without_tags(self):
         )
         valid_data = {
             'project': 'Version 2.0.0 of Pip ({})'.format(version.pk),
-            'url': '/dashboard/pip/version/2.0.0/',
+            'url': 'http://pip.readthedocs.io/en/2.0.0/',
             'slug': '2.0.0',
             'version': '2.0.0',
             'is_highest': False,
@@ -235,11 +240,12 @@ class TestFooterPerformance(APITestCase):
 
     # The expected number of queries for generating the footer
     # This shouldn't increase unless we modify the footer API
-    EXPECTED_QUERIES = 9
+    EXPECTED_QUERIES = 13
 
     def setUp(self):
         self.pip = Project.objects.get(slug='pip')
         self.pip.versions.create_latest()
+        self.pip.versions.update(built=True)
 
     def render(self):
         request = self.factory.get(self.url)