Notifications: allow disable latest and/or non-stable (#414)

Closes #133 Requires readthedocs/readthedocs.org#11718
readthedocs · Nov 4, 2024 · 81c058c · 81c058c
1 parent 6c86cb0
commit 81c058c
Show file tree

Hide file tree

Showing 6 changed files with 96 additions and 95 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/public/_/readthedocs-addons.json b/public/_/readthedocs-addons.json
@@ -112,13 +112,11 @@
       "enabled": true,
       "code": "UA-12345"
     },
-    "external_version_warning": {
+    "notifications": {
       "enabled": true,
-      "query_selector": "[role=main]"
-    },
-    "non_latest_version_warning": {
-      "enabled": true,
-      "query_selector": "[role=main]"
+      "show_on_latest": true,
+      "show_on_non_stable": true,
+      "show_on_external": true
     },
     "doc_diff": {
       "enabled": true,

diff --git a/src/data-validation.js b/src/data-validation.js
@@ -285,15 +285,9 @@ const addons_notifications = {
   properties: {
     addons: {
       type: "object",
-      required: ["external_version_warning", "non_latest_version_warning"],
+      required: ["notifications"],
       properties: {
-        external_version_warning: {
-          type: "object",
-          properties: {
-            enabled: { type: "boolean" },
-          },
-        },
-        non_latest_version_warning: {
+        enabled: {
           type: "object",
           properties: {
             enabled: { type: "boolean" },

diff --git a/src/notification.js b/src/notification.js
@@ -7,6 +7,7 @@ import {
   faHourglassHalf,
 } from "@fortawesome/free-solid-svg-icons";
 import { html, nothing, render, LitElement } from "lit";
+import { default as objectPath } from "object-path";
 
 import styleSheet from "./notification.css";
 import { AddonBase, addUtmParameters, getLinkWithFilename } from "./utils";
@@ -135,7 +136,7 @@ export class NotificationElement extends LitElement {
     this.config = config;
 
     if (
-      this.config.addons.external_version_warning.enabled &&
+      this.config.addons.notifications.enabled &&
       this.config.versions.current.type === "external"
     ) {
       this.urls = {
@@ -150,7 +151,11 @@ export class NotificationElement extends LitElement {
     }
 
     if (
-      config.addons.non_latest_version_warning.enabled &&
+      objectPath.get(
+        this.config,
+        "addons.notifications.show_on_latest",
+        false,
+      ) &&
       config.projects.current.versioning_scheme !==
         "single_version_without_translations" &&
       config.versions.current.type !== "external"
@@ -189,16 +194,42 @@ export class NotificationElement extends LitElement {
       return nothing;
     }
 
+    if (!this.config.addons.notifications.enabled) {
+      return nothing;
+    }
+
     if (this.config.versions.current.type === "external") {
-      if (this.config.addons.external_version_warning.enabled) {
+      if (
+        objectPath.get(
+          this.config,
+          "addons.notifications.show_on_external",
+          false,
+        )
+      ) {
         return this.renderExternalVersionWarning();
       }
-    } else if (
-      this.config.addons.non_latest_version_warning.enabled &&
-      (this.readingLatestVersion || this.stableVersionAvailable)
+    }
+
+    if (
+      this.readingLatestVersion &&
+      this.stableVersionAvailable &&
+      objectPath.get(this.config, "addons.notifications.show_on_latest", false)
     ) {
-      return this.renderStableLatestVersionWarning();
+      return this.renderLatestVersionWarning();
     }
+
+    if (
+      !this.readingStableVersion &&
+      this.stableVersionAvailable &&
+      objectPath.get(
+        this.config,
+        "addons.notifications.show_on_non_stable",
+        false,
+      )
+    ) {
+      return this.renderStableVersionWarning();
+    }
+
     return nothing;
   }
 
@@ -247,56 +278,51 @@ export class NotificationElement extends LitElement {
     }
   }
 
-  renderStableLatestVersionWarning() {
-    library.add(faHourglassHalf);
+  renderLatestVersionWarning() {
     library.add(faFlask);
-    if (this.readingLatestVersion && this.stableVersionAvailable) {
-      const iconFlask = icon(faFlask, {
-        classes: ["header", "icon"],
-      });
-
-      return html`
-        <div>
-          ${iconFlask.node[0]}
-          <div class="title">
-            This is the <span>latest development version</span>
-            ${this.renderCloseButton()}
-          </div>
-          <div class="content">
-            Some features may not yet be available in the published stable
-            version. Read the
-            <a href="${this.urls.stable}"
-              >stable version of this documentation</a
-            >.
-          </div>
-        </div>
-      `;
-    }
+    const iconFlask = icon(faFlask, {
+      classes: ["header", "icon"],
+    });
 
-    if (!this.readingStableVersion && this.stableVersionAvailable) {
-      const iconHourglassHalf = icon(faHourglassHalf, {
-        classes: ["header", "icon"],
-      });
-
-      return html`
-        <div>
-          ${iconHourglassHalf.node[0]}
-          <div class="title">
-            This <em>may</em> be an
-            <span>old version of this documentation</span>
-            ${this.renderCloseButton()}
-          </div>
-          <div class="content">
-            You may be reading an old version of this documentation. Read the
-            <a href="${this.urls.stable}"
-              >latest stable version of this documentation</a
-            >.
-          </div>
+    return html`
+      <div>
+        ${iconFlask.node[0]}
+        <div class="title">
+          This is the <span>latest development version</span>
+          ${this.renderCloseButton()}
         </div>
-      `;
-    }
+        <div class="content">
+          Some features may not yet be available in the published stable
+          version. Read the
+          <a href="${this.urls.stable}">stable version of this documentation</a
+          >.
+        </div>
+      </div>
+    `;
+  }
 
-    return nothing;
+  renderStableVersionWarning() {
+    library.add(faHourglassHalf);
+    const iconHourglassHalf = icon(faHourglassHalf, {
+      classes: ["header", "icon"],
+    });
+
+    return html`
+      <div>
+        ${iconHourglassHalf.node[0]}
+        <div class="title">
+          This <em>may</em> be an
+          <span>old version of this documentation</span>
+          ${this.renderCloseButton()}
+        </div>
+        <div class="content">
+          You may be reading an old version of this documentation. Read the
+          <a href="${this.urls.stable}"
+            >latest stable version of this documentation</a
+          >.
+        </div>
+      </div>
+    `;
   }
 
   renderExternalVersionWarning() {
@@ -376,6 +402,7 @@ export class NotificationElement extends LitElement {
 export class NotificationAddon extends AddonBase {
   static jsonValidationURI =
     "http://v1.schemas.readthedocs.org/addons.notifications.json";
+  static addonEnabledPath = "addons.notifications.enabled";
   static addonName = "Notification";
 
   constructor(config) {
@@ -393,24 +420,6 @@ export class NotificationAddon extends AddonBase {
       elem.loadConfig(config);
     }
   }
-
-  /**
-   * Test if addon is enabled in the configuration
-   *
-   * @param {Object} config - Addon configuration object
-   */
-  static isEnabled(config) {
-    if (!super.isConfigValid(config)) {
-      return false;
-    }
-
-    return (
-      (config.addons.external_version_warning.enabled === true &&
-        config.versions.current.type === "external") ||
-      (config.addons.non_latest_version_warning.enabled === true &&
-        config.versions.current.type !== "external")
-    );
-  }
 }
 
 customElements.define("readthedocs-notification", NotificationElement);
diff --git a/tests/notification.test.html b/tests/notification.test.html
@@ -32,11 +32,11 @@
           setLocalStorageStub.reset();
           config = {
             addons: {
-              external_version_warning: {
-                enabled: true,
-              },
-              non_latest_version_warning: {
+              notifications: {
                 enabled: true,
+                show_on_latest: true,
+                show_on_non_stable: true,
+                show_on_external: true,
               },
             },
             builds: {
@@ -144,7 +144,7 @@
   </div>
   <div class="content">
     Some features may not yet be available in the published stable
-            version. Read the
+          version. Read the
     <a href="https://project.readthedocs.io/en/stable/section/page.html">
       stable version of this documentation
     </a>
@@ -180,7 +180,7 @@
   </div>
   <div class="content">
     Some features may not yet be available in the published stable
-            version. Read the
+          version. Read the
     <a href="https://project.readthedocs.io/en/stable/section/page.html">
       stable version of this documentation
     </a>