Merge pull request #6768 from readthedocs/force-use-proxied-api

Force to use proxied API for footer and search

Author: stsewd

readthedocs/core/static-src/core/js/doc-embed/footer.js

@@ -62,17 +62,9 @@ function init() {
         get_data['subproject'] = true;
     }
 
-    // Check for new logic around proxying requests.
-    // ``proxied_api_host`` won't exist on existing built docs,
-    // so default to ``api_host`` in those cases
-    var real_api_host = rtd.api_host;
-    if ("proxied_api_host" in rtd) {
-        real_api_host = rtd.proxied_api_host;
-    }
-
     // Get footer HTML from API and inject it into the page.
     $.ajax({
-        url: real_api_host + "/api/v2/footer_html/",
+        url: rtd.proxied_api_host + "/api/v2/footer_html/",
         crossDomain: true,
         xhrFields: {
             withCredentials: true,

readthedocs/core/static-src/core/js/doc-embed/rtd-data.js

@@ -59,6 +59,9 @@ function get() {
 
     $.extend(config, defaults, window.READTHEDOCS_DATA);
 
+    // Force to use new settings
+    config.proxied_api_host = '/_';
+
     return config;
 }
 

readthedocs/core/static-src/core/js/doc-embed/search.js

@@ -44,14 +44,12 @@ function attach_elastic_search_query(data) {
     var project = data.project;
     var version = data.version;
     var language = data.language || 'en';
-    var api_host = data.api_host;
 
     var query_override = function (query) {
         var search_def = $.Deferred();
         var search_url = document.createElement('a');
 
-        search_url.href = api_host;
-        search_url.pathname = '/api/v2/docsearch/';
+        search_url.href = data.proxied_api_host + '/api/v2/docsearch/';
         search_url.search = '?q=' + $.urlencode(query) + '&project=' + project +
                             '&version=' + version + '&language=' + language;
 

readthedocs/core/static/core/js/readthedocs-doc-embed.js

@@ -249,7 +249,6 @@ def generate_rtd_data(self, docs_dir, mkdocs_config):
             'docroot': docs_dir,
             'source_suffix': '.md',
             'api_host': settings.PUBLIC_API_URL,
-            'proxied_api_host': settings.RTD_PROXIED_API_URL,
             'ad_free': not self.project.show_advertising,
             'commit': self.version.project.vcs_repo(self.version.slug).commit,
             'global_analytics_code': settings.GLOBAL_ANALYTICS_CODE,

readthedocs/doc_builder/backends/mkdocs.py

@@ -151,7 +151,6 @@ def get_config_params(self):
             'settings': settings,
             'conf_py_path': conf_py_path,
             'api_host': settings.PUBLIC_API_URL,
-            'proxied_api_host': settings.RTD_PROXIED_API_URL,
             'commit': self.project.vcs_repo(self.version.slug).commit,
             'versions': versions,
             'downloads': downloads,

readthedocs/doc_builder/backends/sphinx.py

@@ -96,7 +96,6 @@ context = {
     'single_version': {{ project.single_version }},
     'conf_py_path': '{{ conf_py_path }}',
     'api_host': '{{ api_host }}',
-    'proxied_api_host': '{{ proxied_api_host }}',
     'github_user': '{{ github_user }}',
     'github_repo': '{{ github_repo }}',
     'github_version': '{{ github_version }}',

readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl

@@ -41,10 +41,6 @@ class CommunityBaseSettings(Settings):
     PUBLIC_DOMAIN_USES_HTTPS = False
     USE_SUBDOMAIN = False
     PUBLIC_API_URL = 'https://{}'.format(PRODUCTION_DOMAIN)
-    # Some endpoints from the API can be proxied on other domain
-    # or use the same domain where the docs are being served
-    # (omit the host if that's the case).
-    RTD_PROXIED_API_URL = PUBLIC_API_URL
     RTD_EXTERNAL_VERSION_DOMAIN = 'external-builds.readthedocs.io'
 
     # Doc Builder Backends

readthedocs/settings/base.py

@@ -18,7 +18,6 @@ class DockerBaseSettings(CommunityDevSettings):
     PRODUCTION_DOMAIN = 'community.dev.readthedocs.io'
     PUBLIC_DOMAIN = 'community.dev.readthedocs.io'
     PUBLIC_API_URL = f'http://{PRODUCTION_DOMAIN}'
-    RTD_PROXIED_API_URL = PUBLIC_API_URL
     SLUMBER_API_HOST = 'http://web:8000'
     RTD_EXTERNAL_VERSION_DOMAIN = 'org.dev.readthedocs.build'