Refactor getReadTheDocsConfig to use Promise

Follow Anthony's suggestion from #64 (comment)
readthedocs · Apr 9, 2024 · eb5506b · eb5506b
1 parent 81e0dc0
commit eb5506b
Show file tree

Hide file tree

Showing 3 changed files with 69 additions and 62 deletions.
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/src/readthedocs-config.js b/src/readthedocs-config.js
@@ -27,7 +27,7 @@ function _getMetadataAddonsAPIVersion() {
  * It uses META HTML tags to get project/version slugs and `sendUrlParam` to
  * decide whether or not sending `url=`.
  */
-function _getAPIURL(sendUrlParam) {
+function _getApiUrl(sendUrlParam) {
   const metaProject = document.querySelector(
     "meta[name='readthedocs-project-slug']",
   );
@@ -69,65 +69,72 @@ function _getAPIURL(sendUrlParam) {
  *
  */
 export function getReadTheDocsConfig(sendUrlParam) {
-  const url = _getAPIURL(sendUrlParam);
-
-  return fetch(url, {
-    method: "GET",
-  })
-    .then((response) => {
-      if (!response.ok) {
-        throw "Error parsing configuration data";
-      }
-      return response.json();
+  return new Promise((resolve, reject) => {
+    let dataUser;
+    const defaultApiUrl = _getApiUrl(sendUrlParam);
+
+    fetch(defaultApiUrl, {
+      method: "GET",
     })
-    .then((data) => {
-      // We force the user to define the `<meta>` tag to be able to use Read the Docs data directly.
-      // This is to keep forward/backward compatibility without breaking integrations.
-      const metadataAddonsAPIVersion = _getMetadataAddonsAPIVersion();
-      if (metadataAddonsAPIVersion !== undefined) {
-        if (metadataAddonsAPIVersion !== data.api_version) {
-          // When the API scheme version returned doesn't match the one defined via `<meta>` tag by the user,
-          // we perform another request to get the Read the Docs response in the structure
-          // that's supported by the user and dispatch a custom event letting them know
-          // this data is ready to be consumed under `event.detail`.
-
-          url =
-            ADDONS_API_ENDPOINT +
-            new URLSearchParams({
-              url: window.location.href,
-              "client-version": CLIENT_VERSION,
-              "api-version": metadataAddonsAPIVersion,
-            });
+      .then((response) => {
+        if (!response.ok) {
+          reject("Error hitting addons API endpoint");
+        }
+        // Use the addons API data response as `dataUser`
+        dataUser = response.json();
+        return dataUser;
+      })
+      .then((data) => {
+        // Create a new Promise here to handle the user request in a different async task.
+        // This allows us to start executing our integration independently from the use one.
+        new Promise((resolve, reject) => {
+          // We force the user to define the `<meta>` tag to be able to use Read the Docs data directly.
+          // This is to keep forward/backward compatibility without breaking integrations.
+          const metadataAddonsAPIVersion = _getMetadataAddonsAPIVersion();
+
+          if (
+            metadataAddonsAPIVersion !== undefined &&
+            metadataAddonsAPIVersion !== data.api_version
+          ) {
+            // When the API scheme version returned doesn't match the one defined via `<meta>` tag by the user,
+            // we perform another request to get the Read the Docs response in the structure
+            // that's supported by the user and dispatch a custom event letting them know
+            // this data is ready to be consumed under `event.detail`.
+            const userApiUrl =
+              ADDONS_API_ENDPOINT +
+              new URLSearchParams({
+                url: window.location.href,
+                "client-version": CLIENT_VERSION,
+                "api-version": metadataAddonsAPIVersion,
+              });
 
-          fetch(url, {
-            method: "GET",
-          })
-            .then((response) => {
+            fetch(userApiUrl, {
+              method: "GET",
+            }).then((response) => {
               if (!response.ok) {
-                throw "Error parsing configuration data";
+                reject(
+                  "Error hitting addons API endpoint for user api-version",
+                );
               }
-              return response.json();
-            })
-            .then((data) => {
-              dispatchEvent(
-                EVENT_READTHEDOCS_ADDONS_DATA_READY,
-                document,
-                data,
-              );
-            })
-            .catch((error) => {
-              console.error(error);
+              // If the user defined a meta HTML tag with a different api-version,
+              // use the new API data response as `dataUser`
+              dataUser = response.json();
             });
-        } else {
-          dispatchEvent(EVENT_READTHEDOCS_ADDONS_DATA_READY, document, data);
-        }
-      }
+          }
 
-      return data;
-    })
-    .catch((error) => {
-      console.error(error);
-    });
+          // Trigger the addons data ready CustomEvent to with the data the user is expecting.
+          dispatchEvent(
+            EVENT_READTHEDOCS_ADDONS_DATA_READY,
+            document,
+            dataUser,
+          );
+        });
+
+        resolve(data);
+      });
+  }).catch((error) => {
+    console.error(error);
+  });
 }
 
 function dispatchEvent(eventName, element, data) {