feat: Add errorCallback config option to VivliostylePrint/printHTML()

packages/core/src/vivliostyle/core-viewer.ts

@@ -23,12 +23,13 @@ import * as Constants from "./constants";
 import * as Epub from "./epub";
 import * as Profile from "./profile";
 import * as Toc from "./toc";
+import { ErrorInfo } from "./logging";
 
 export interface Payload {
   type: string;
   internal: boolean;
   href: string;
-  content: string;
+  content: ErrorInfo;
   cfi: string;
   first: boolean;
   last: boolean;
@@ -251,11 +252,20 @@ export class CoreViewer {
     opt_documentOptions?: DocumentOptions,
     opt_viewerOptions?: CoreViewerOptions,
   ) {
-    if (!singleDocumentOptions) {
+    if (
+      !singleDocumentOptions ||
+      (Array.isArray(singleDocumentOptions)
+        ? !singleDocumentOptions[0] ||
+          (typeof singleDocumentOptions[0] !== "string" &&
+            !singleDocumentOptions[0].url)
+        : typeof singleDocumentOptions !== "string" &&
+          !singleDocumentOptions.url)
+    ) {
       this.eventTarget.dispatchEvent({
         type: "error",
-        content: "No URL specified",
+        content: { error: new Error("No URL specified") },
       });
+      return;
     }
     this.loadDocumentOrPublication(
       singleDocumentOptions,
@@ -276,8 +286,9 @@ export class CoreViewer {
     if (!pubUrl) {
       this.eventTarget.dispatchEvent({
         type: "error",
-        content: "No URL specified",
+        content: { error: new Error("No URL specified") },
       });
+      return;
     }
     this.loadDocumentOrPublication(
       null,

packages/core/src/vivliostyle/logging.ts

@@ -38,7 +38,7 @@ export type ErrorInfo = {
  * Class logging error, warning, information or debug messages.
  */
 export class Logger {
-  private listeners: { [key in LogLevel]?: ((p1: ErrorInfo) => void)[] } = {};
+  private listeners: { [key in LogLevel]?: (p1: ErrorInfo) => void } = {};
 
   constructor(private opt_console?: Console) {}
 
@@ -91,11 +91,9 @@ export class Logger {
   }
 
   private triggerListeners(level: LogLevel, args: ErrorInfo) {
-    const listeners = this.listeners[level];
-    if (listeners) {
-      listeners.forEach((listener) => {
-        listener(args);
-      });
+    const listener = this.listeners[level];
+    if (listener) {
+      listener(args);
     }
   }
 
@@ -104,11 +102,7 @@ export class Logger {
    * occurs.
    */
   addListener(level: LogLevel, listener: (p1: ErrorInfo) => void) {
-    let listeners = this.listeners[level];
-    if (!listeners) {
-      listeners = this.listeners[level] = [];
-    }
-    listeners.push(listener);
+    this.listeners[level] = listener;
   }
 
   debug(...var_args: any[]) {

packages/core/src/vivliostyle/print.ts

@@ -10,6 +10,7 @@ interface IFrameWindowForPrint {
 export interface PrintConfig {
   title: string;
   printCallback: (iframeWin: Window) => void;
+  errorCallback: (message: string) => void | null;
   hideIframe: boolean;
   removeIframe: boolean;
 }
@@ -18,6 +19,7 @@ class VivliostylePrint {
   htmlDoc: string;
   title: string;
   printCallback: (iframeWin: Window) => void;
+  errorCallback: (message: string) => void;
   hideIframe: boolean;
   removeIframe: boolean;
   iframe: HTMLIFrameElement;
@@ -29,13 +31,15 @@ class VivliostylePrint {
     {
       title = "",
       printCallback = (iframeWin: Window) => iframeWin.print(),
+      errorCallback = null,
       hideIframe = true,
       removeIframe = true,
     }: PrintConfig,
   ) {
     this.htmlDoc = htmlDoc;
     this.title = title;
     this.printCallback = printCallback;
+    this.errorCallback = errorCallback;
     this.hideIframe = hideIframe;
     this.removeIframe = removeIframe;
   }
@@ -110,6 +114,15 @@ class VivliostylePrint {
         }
       });
 
+      if (this.errorCallback) {
+        Viewer.addListener("error", (payload) => {
+          const message =
+            payload.content.error?.toString() ??
+            payload.content.messages.join("\n");
+          this.errorCallback(message);
+        });
+      }
+
       Viewer.loadDocument({
         url: docURL,
       });

packages/react/src/renderer.tsx

@@ -138,16 +138,19 @@ export const Renderer = ({
   }
 
   function registerEventHandlers() {
+    const getMessage = (payload: Payload) =>
+      payload.content.error?.toString() ?? payload.content.messages.join("\n");
+
     function handleMessage(payload: Payload, type: MessageType) {
-      onMessage && onMessage(payload.content, type);
+      onMessage && onMessage(getMessage(payload), type);
     }
 
     const handleDebug = (payload: Payload) => handleMessage(payload, "debug");
     const handleInfo = (payload: Payload) => handleMessage(payload, "info");
     const handleWarn = (payload: Payload) => handleMessage(payload, "warn");
 
     function handleError(payload: Payload) {
-      onError && onError(payload.content);
+      onError && onError(getMessage(payload));
     }
 
     function handleReadyStateChange() {

packages/react/src/stories/Renderer.stories.js

@@ -39,7 +39,7 @@ export const Basic = () => (
     onLoad={action("loaded")}
     onError={action("error")}
     onNavigation={action("navigation")}
-    onMessage={(msg, type) => action("message")(type, msg.messages[0])}
+    onMessage={(msg, type) => action("message")(type, msg)}
     onReadyStateChange={action("readyStateChange")}
     onHyperlink={action("hyperlink")}
   />

packages/viewer/src/viewmodels/message-dialog.ts

@@ -39,15 +39,7 @@ class MessageDialog {
   }
 
   getDisplayMessage(errorInfo: ErrorInfo): string {
-    const e = errorInfo.error;
-    let msg = e && (e.toString() || e.frameTrace || e.stack);
-    if (msg) {
-      msg = msg.split("\n", 1)[0];
-    }
-    if (!msg) {
-      msg = errorInfo.messages.join("\n");
-    }
-    return msg;
+    return errorInfo.error?.toString() ?? errorInfo.messages.join("\n");
   }
 }