fix(core/pubsubhub): account for all message types (#3908)

src/core/dfn-index.js

@@ -49,6 +49,8 @@ const CODE_TYPES = new Set([
 export function run() {
   const index = document.querySelector("section#index");
   if (!index) {
+    // See below...
+    sub("toc", () => {}, { once: true });
     return;
   }
 

src/core/examples.js

@@ -9,7 +9,6 @@
 import { addId, getIntlData } from "./utils.js";
 import css from "../styles/examples.css.js";
 import { html } from "./import-maps.js";
-import { pub } from "./pubsubhub.js";
 
 export const name = "core/examples";
 
@@ -93,7 +92,6 @@ export function run() {
       const id = addId(example, "example", title || String(number));
       const selfLink = div.querySelector("a.self-link");
       selfLink.href = `#${id}`;
-      pub("example", report);
     } else {
       const inAside = !!example.closest("aside");
       if (!inAside) ++number;
@@ -113,7 +111,6 @@ export function run() {
       const selfLink = div.querySelector("a.self-link");
       selfLink.href = `#${div.id}`;
       example.replaceWith(div);
-      if (!inAside) pub("example", report);
     }
   });
 }

src/core/issues-notes.js

@@ -20,8 +20,6 @@ import {
 } from "./utils.js";
 import css from "../styles/issues-notes.css.js";
 import { html } from "./import-maps.js";
-import { pub } from "./pubsubhub.js";
-
 export const name = "core/issues-notes";
 
 const localizationStrings = {
@@ -186,7 +184,6 @@ function handleIssues(ins, ghIssues, conf) {
       const level = parents(titleParent, "section").length + 2;
       titleParent.setAttribute("aria-level", level);
     }
-    pub(report.type, report);
   });
   makeIssueSectionSummary(issueList);
 }

src/core/pubsubhub.js

@@ -12,9 +12,14 @@ export const name = "core/pubsubhub";
 
 const subscriptions = new Map();
 
+/**
+ *
+ * @param {EventTopic} topic
+ * @param  {...any} data
+ */
 export function pub(topic, ...data) {
   if (!subscriptions.has(topic)) {
-    return; // Nothing to do...
+    throw new Error(`No subscribers for topic "${topic}".`);
   }
   Array.from(subscriptions.get(topic)).forEach(cb => {
     try {
@@ -37,8 +42,7 @@ export function pub(topic, ...data) {
 }
 /**
  * Subscribes to a message type.
- *
- * @param  {string} topic        The topic to subscribe to (e.g., "start-all")
+ * @param  {EventTopic} topic The topic to subscribe to
  * @param  {Function} cb         Callback function
  * @param  {Object} [opts]
  * @param  {Boolean} [opts.once] Add prop "once" for single notification.

src/type-helper.d.ts

@@ -134,7 +134,7 @@ type LicenseInfo = {
    * The short linking text of license.
    */
   short: string;
-}
+};
 
 type ResourceHintOption = {
   /**
@@ -223,6 +223,16 @@ type PersonExtras = {
   href?: string;
 };
 
+type EventTopic =
+  | "amend-user-config"
+  | "beforesave"
+  | "end-all"
+  | "error"
+  | "plugins-done"
+  | "start-all"
+  | "toc"
+  | "warn";
+
 type DefinitionValidator = (
   /** Text to validate. */
   text: string,
@@ -231,4 +241,5 @@ type DefinitionValidator = (
   /** The element from which the validation originated. */
   element: HTMLElement,
   /** The name of the plugin originating the validation. */
-  pluginName: string) => boolean;
+  pluginName: string
+) => boolean;

tests/spec/core/validators-spec.js

@@ -4,6 +4,7 @@ import {
   validateMimeType,
   validateQuotedString,
 } from "../../../src/core/dfn-validators.js";
+import { sub } from "../../../src/core/pubsubhub.js";
 
 describe("Core - Validators", () => {
   describe("validateDOMName", () => {
@@ -30,6 +31,7 @@ describe("Core - Validators", () => {
     it("generates an error if the element name is not valid", () => {
       const elements = ["my element", "crypto$", "🪳", "-something", ""];
       for (const element of elements) {
+        sub("error", () => {}, { once: true });
         const dfn = document.createElement("dfn");
         const context = `element name: ${element}`;
         expect(validateDOMName(element, "element", dfn, "foo/bar"))
@@ -58,6 +60,7 @@ describe("Core - Validators", () => {
     it("generates an error if the attribute name is invalid", () => {
       const attributes = ["-crossorigin", "-whatever-", "aria-😇"];
       for (const attribute of attributes) {
+        sub("error", () => {}, { once: true });
         const context = `attribute name: ${attribute}`;
         const dfn = document.createElement("dfn");
         expect(validateDOMName(attribute, "attribute", dfn, "foo/bar"))
@@ -79,6 +82,7 @@ describe("Core - Validators", () => {
         "text/plain",
       ];
       for (const mimeType of mimeTypes) {
+        sub("error", () => {}, { once: true });
         const dfn = document.createElement("dfn");
         const context = `mimeType: ${mimeType}`;
         expect(validateMimeType(mimeType, "mimetype", dfn, "foo/bar"))
@@ -133,6 +137,7 @@ describe("Core - Validators", () => {
         "-something",
       ];
       for (const name of names) {
+        sub("error", () => {}, { once: true });
         const dfn = document.createElement("dfn");
         const context = `invalid name: ${name}`;
         expect(validateQuotedString(name, "permission", dfn, "foo/bar"))
@@ -149,6 +154,7 @@ describe("Core - Validators", () => {
     it("generates no error if the name is valid", () => {
       const names = ["foo", "bar", "baz", "quux"];
       for (const name of names) {
+        sub("error", () => {}, { once: true });
         const dfn = document.createElement("dfn");
         const context = `name: ${name}`;
         expect(validateCommonName(name, "event", dfn, "foo/bar"))
@@ -163,6 +169,7 @@ describe("Core - Validators", () => {
     it("it generates an error if the name is not valid", () => {
       const names = ["my event", "crypto$", "🪳", "-something"];
       for (const name of names) {
+        sub("error", () => {}, { once: true });
         const dfn = document.createElement("dfn");
         const context = `invalid name: ${name}`;
         expect(validateCommonName(name, "event", dfn, "foo/bar"))

tests/unit/SpecHelper.js

@@ -14,6 +14,12 @@ export function makePluginDoc(
   plugins,
   { config = {}, head = `<meta charset="UTF-8" />`, body = "" } = {}
 ) {
+  plugins = [
+    "/src/core/base-runner.js",
+    "/src/core/ui.js", // Needed for "start-all" event
+    "/src/core/dfn.js", // Needed for "plugins-done" event,
+    ...plugins,
+  ];
   return getDoc(`
     <!DOCTYPE html>
     <html lang="en">
@@ -24,9 +30,7 @@ export function makePluginDoc(
         </script>
         <script type="module">
           async function run(plugins) {
-            const allPlugins = ["/src/core/base-runner.js"]
-              .concat(plugins)
-              .map(p => "/base" + p);
+            const allPlugins = plugins.map(p => "/base" + p);
             try {
               const [baseRunner, ...plugs] = await Promise.all(
                 allPlugins.map(plug => import(plug))

tests/unit/core/show-people-spec.js

@@ -1,9 +1,11 @@
 import { html } from "../../../src/core/import-maps.js";
 import showPeople from "../../../src/core/templates/show-people.js";
+import { sub } from "../../../src/core/pubsubhub.js";
 
 describe("Core - Templates - Show People", () => {
   describe("showPeople", () => {
     it("handles empty person", () => {
+      sub("error", () => {}, { once: true });
       const render = html.bind(document.createDocumentFragment());
       const person = {};
       const result = render`${showPeople({ people: [person] }, "people")}`;
@@ -96,6 +98,7 @@ describe("Core - Templates - Show People", () => {
     });
 
     it("identifies valid and invalid ORCIDs", async () => {
+      sub("error", () => {}, { once: true });
       const people = [
         {
           name: "Valid 1",
@@ -136,6 +139,7 @@ describe("Core - Templates - Show People", () => {
     });
 
     it("ignores companyURL when company is missing", () => {
+      sub("warn", () => {}, { once: true });
       const render = html.bind(document.createDocumentFragment());
       const person = {
         name: "name",
@@ -177,6 +181,7 @@ describe("Core - Templates - Show People", () => {
     });
 
     it("filters out editors with invalid extras", () => {
+      sub("error", () => {}, { once: true });
       const render = html.bind(document.createDocumentFragment());
       const people = [
         { name: "wrong type", extras: "" },