Notifications: respect project.versioning_scheme for links (#265)

This is a workaround for now since the backend API is not returning this
URLs due to readthedocs/readthedocs-ops#1323.
However, we cannot fix that quickly.

I'm re-implementing a small version of the resolver for this by
generating the URL based on the `project.versioning_scheme` for now.

We should come back to this once the API returns the URLs we need.

Closes #243

Author: humitos

dist/readthedocs-addons.js

@@ -67,17 +67,22 @@
       }
     ],
     "current": {
+      "aliases": [],
       "slug": "v1.0",
       "type": "external",
       "downloads": {
         "pdf": "https://localhost:8000/_/downloads/en/v1.0/pdf/"
+      },
+      "urls": {
+        "documentation": "https://example.readthedocs.io/en/v1.0/"
       }
     }
   },
   "builds": {
     "current": {
+      "id": 1,
       "urls": {
-        "build": "https://localhost:8000/projects/example/builds/1234/"
+        "build": "https://readthedocs.org/dashboard/example/builds/1/"
       }
     }
   },

dist/readthedocs-addons.js.map

@@ -311,8 +311,11 @@ const addons_notifications = {
           properties: {
             urls: {
               type: "object",
+              required: ["build"],
               properties: {
-                build: { type: "string" },
+                build: {
+                  type: "string",
+                },
               },
             },
           },
@@ -375,11 +378,23 @@ const addons_notifications = {
         },
         current: {
           type: "object",
-          required: ["slug", "type", "aliases"],
+          required: ["slug", "urls", "type", "aliases"],
           properties: {
+            aliases: { type: "array" },
             slug: { type: "string" },
             type: { enum: ["branch", "tag", "external"] },
-            aliases: { type: "array" },
+            urls: {
+              type: "object",
+              required: ["documentation", "vcs"],
+              properties: {
+                documentation: {
+                  type: "string",
+                },
+                vcs: {
+                  type: "string",
+                },
+              },
+            },
           },
         },
       },

public/_/readthedocs-addons.json

@@ -53,15 +53,9 @@ export class NotificationElement extends LitElement {
       this.config.addons.external_version_warning.enabled &&
       this.config.versions.current.type === "external"
     ) {
-      // TODO: this URL should come from the backend API.
-      // Doing a simple replacement for now to solve the most common cases.
-      const vcs_external_url = this.config.projects.current.repository.url
-        .replace(".git", "")
-        .replace("[email protected]:", "https://github.com/");
-
       this.urls = {
-        build: this.config.builds.current.urls.build,
-        external: `${vcs_external_url}/pull/${this.config.versions.current.slug}`,
+        build: config.builds.current.urls.build,
+        external: config.versions.current.urls.vcs,
       };
     }
 

src/data-validation.js

@@ -64,8 +64,12 @@
               ],
               current: {
                 slug: "stable",
-                type: "branch",
                 aliases: [],
+                type: "branch",
+                urls: {
+                  documentation: "https://project.readthedocs.io/en/stable/",
+                  vcs: "https://github.com/readthedocs/project/",
+                },
               },
             },
           };
@@ -74,8 +78,15 @@
         describe("Notification addon", () => {
           it("on stable version", async () => {
             // Set current version as non-stable and non-latest
-            config.versions.current.slug = "v3.x";
-            config.versions.current.type = "tag";
+            config.versions.current = {
+              slug: "v3.x",
+              aliases: [],
+              type: "tag",
+              urls: {
+                documentation: "https://project.readthedocs.io/en/v3.x/",
+                vcs: "https://github.com/readthedocs/project/",
+              },
+            };
 
             const addon = new notification.NotificationAddon(config);
             const element = document.querySelector("readthedocs-notification");
@@ -89,7 +100,7 @@
             );
           });
 
-          it("on latest version", async () => {
+          it("on latest version (multiple_versions_with_translations)", async () => {
             config.versions.current.slug = "latest";
 
             const addon = new notification.NotificationAddon(config);
@@ -98,10 +109,64 @@
             // We need to wait for the element to renders/updates before querying it
             await elementUpdated(element);
 
-            const title = element.shadowRoot.querySelector("div.title");
-            expect(title.innerText).to.be.equal(
-              "This is the latest development version",
-            );
+            expect(element).shadowDom.to.equal(`
+<div>
+  <div class="title">
+    This is the
+    <span>
+      latest development version
+    </span>
+    <a
+      class="right"
+      href="#"
+    >
+    </a>
+  </div>
+  <div class="content">
+    Some features may not yet be available in the published stable
+            version. Read the
+    <a href="https://project.readthedocs.io/en/stable/">
+      stable version of this documentation
+    </a>
+    .
+  </div>
+</div>
+      `);
+          });
+
+          it("on latest version (multiple_versions_without_translations)", async () => {
+            config.versions.current.slug = "latest";
+            config.projects.current.versioning_scheme =
+              "multiple_versions_without_translations";
+
+            const addon = new notification.NotificationAddon(config);
+            const element = document.querySelector("readthedocs-notification");
+
+            // We need to wait for the element to renders/updates before querying it
+            await elementUpdated(element);
+
+            expect(element).shadowDom.to.equal(`
+<div>
+  <div class="title">
+    This is the
+    <span>
+      latest development version
+    </span>
+    <a
+      class="right"
+      href="#"
+    >
+    </a>
+  </div>
+  <div class="content">
+    Some features may not yet be available in the published stable
+            version. Read the
+    <a href="https://project.readthedocs.io/en/stable/">
+      stable version of this documentation
+    </a>
+    .
+ </div>
+`);
           });
 
           it("on external version", async () => {