API: send project-slug= and version-slug= to the backend

humitos · humitos · commit 49ce8de9cc20 · 2023-10-16T16:56:15.000+02:00
Follow the plan discussed in readthedocs/readthedocs.org#10536 Grab the `project-slug` and `version-slug` from the `meta` tag injected by CF and send it back to the backend. If there is any addons that can be enabled in the current page that depends on the URL, it will send it also. Each Addon class should implement `requireUrlParam` to decide whether or not to send the `url=` to the backend API or not.
diff --git a/dist/readthedocs-addons.js b/dist/readthedocs-addons.js
diff --git a/dist/readthedocs-addons.js.map b/dist/readthedocs-addons.js.map
diff --git a/public/index.html b/public/index.html
@@ -1,6 +1,8 @@
 <html>
   <head>
     <title>Documentation Addons - Read the Docs</title>
+    <meta name="readthedocs-project-slug" content="test-builds" />
+    <meta name="readthedocs-version-slug" content="latest" />
   </head>
   <body>
 
diff --git a/src/docdiff.js b/src/docdiff.js
@@ -205,4 +205,8 @@ export class DocDiffAddon extends AddonBase {
   static isEnabled(config) {
     return config.addons && config.addons.doc_diff.enabled === true;
   }
+
+  static requiresUrlParam() {
+    return window.location.host.endsWith(".readthedocs.build");
+  }
 }
diff --git a/src/index.js b/src/index.js
@@ -14,22 +14,31 @@ export function setup() {
     return false;
   }
 
+  const addons = [
+    flyout.FlyoutAddon,
+    notification.NotificationAddon,
+    analytics.AnalyticsAddon,
+    ethicalads.EthicalAdsAddon,
+    search.SearchAddon,
+    docdiff.DocDiffAddon,
+    hotkeys.HotKeysAddon,
+  ];
+
   return new Promise((resolve) => {
     domReady
       .then(() => {
-        return getReadTheDocsConfig();
+        let sendUrlParam = false;
+        for (const addon of addons) {
+          if (addon.requiresUrlParam()) {
+            sendUrlParam = true;
+            break;
+          }
+        }
+
+        return getReadTheDocsConfig(sendUrlParam);
       })
       .then((config) => {
         let promises = [];
-        let addons = [
-          flyout.FlyoutAddon,
-          notification.NotificationAddon,
-          analytics.AnalyticsAddon,
-          ethicalads.EthicalAdsAddon,
-          search.SearchAddon,
-          docdiff.DocDiffAddon,
-          hotkeys.HotKeysAddon,
-        ];
 
         // IS_PRODUCTION comes from Webpack and is undeclared otherwise
         if (typeof IS_PRODUCTION === "undefined" ? false : IS_PRODUCTION) {
diff --git a/src/readthedocs-config.js b/src/readthedocs-config.js
@@ -4,14 +4,34 @@ import { CLIENT_VERSION, ADDONS_API_VERSION } from "./utils";
  * Load Read the Docs configuration from API endpoint.
  *
  */
-export function getReadTheDocsConfig() {
-  let url =
-    "/_/addons/?" +
-    new URLSearchParams({
-      url: window.location.href,
-      "client-version": CLIENT_VERSION,
-      "api-version": ADDONS_API_VERSION,
-    });
+export function getReadTheDocsConfig(sendUrlParam) {
+  const metaProject = document.querySelector(
+    "meta[name='readthedocs-project-slug']",
+  );
+  const metaVersion = document.querySelector(
+    "meta[name='readthedocs-version-slug']",
+  );
+
+  let projectSlug;
+  let versionSlug;
+  let params = {
+    "client-version": CLIENT_VERSION,
+    "api-version": ADDONS_API_VERSION,
+  };
+
+  if (sendUrlParam) {
+    params["url"] = window.location.href;
+  }
+
+  if (metaProject && metaVersion) {
+    projectSlug = metaProject.content;
+    versionSlug = metaVersion.content;
+
+    params["project-slug"] = projectSlug;
+    params["version-slug"] = versionSlug;
+  }
+
+  let url = "/_/addons/?" + new URLSearchParams(params);
 
   // Retrieve a static JSON file when working in development mode
   if (window.location.href.startsWith("http://localhost")) {
diff --git a/src/utils.js b/src/utils.js
@@ -48,6 +48,14 @@ export class AddonBase {
   static isEnabled(config) {
     return false;
   }
+
+  static requiresUrlParam() {
+    // Decide whether or not this addons requires sending `url=` parameter to the API endpoint.
+    // Sending this attribute will make the API response to contain extra data (e.g. resolved URLs that depend on the exact URL)
+    //
+    // Note that sending `url=` attribute reduces the possibilities to use a cached response accross all the pages for the same project/version.
+    return false;
+  }
 }
 
 /**

Original file line number	Diff line number	Diff line change
`@@ -205,4 +205,8 @@ export class DocDiffAddon extends AddonBase {`
`205`	`205`	`static isEnabled(config) {`
`206`	`206`	`return config.addons && config.addons.doc_diff.enabled === true;`
`207`	`207`	`}`
	`208`	`+`
	`209`	`+ static requiresUrlParam() {`
	`210`	`+ return window.location.host.endsWith(".readthedocs.build");`
	`211`	`+ }`
`208`	`212`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,14 @@ export class AddonBase {`
`48`	`48`	`static isEnabled(config) {`
`49`	`49`	`return false;`
`50`	`50`	`}`
	`51`	`+`
	`52`	`+ static requiresUrlParam() {`
	`53`	+ // Decide whether or not this addons requires sending `url=` parameter to the API endpoint.
	`54`	`+ // Sending this attribute will make the API response to contain extra data (e.g. resolved URLs that depend on the exact URL)`
	`55`	`+ //`
	`56`	+ // Note that sending `url=` attribute reduces the possibilities to use a cached response accross all the pages for the same project/version.
	`57`	`+ return false;`
	`58`	`+ }`
`51`	`59`	`}`
`52`	`60`
`53`	`61`	`/**`