Added more options to control and debug the headless browser. Can now override logging.

ashleydavis · ashleydavis · commit bcb443664b36 · 2018-09-14T14:12:22.000+10:00
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "capture-template",
-    "version": "1.0.8",
+    "version": "1.0.9",
     "description": "This library is responsible for expanding a template web page and then capturing it PNG or PDF.",
     "main": "build/index.js",
     "types": "build/index.d.ts",
diff --git a/src/index.ts b/src/index.ts
@@ -4,11 +4,67 @@ import * as fs from 'fs-extra';
 import * as path from 'path';
 const promisify = require('promisify-any');
 
+/**
+ * Allows caller to override logging.
+ */
+export interface ILog {
+    /**
+     * Log an info message.
+     */
+    info(msg: string): void;
+
+    /**
+     * Log a warning message.
+     */
+    warn(msg: string): void;
+
+    /**
+     * Log an error message.
+     */
+    error(msg: string): void;
+}
+
+/**
+ * Specifies options that can be passed to the capture function.
+ */
+export interface ICaptureOptions {
+
+    /**
+     * Optionally override logging.
+     */
+    log?: ILog;
+
+    /**
+     * Optional timeout for Electron's wait function.
+     */
+    waitTimeout?: number;
+    
+    /**
+     * Optional timeout for Electron's goto function.
+     */
+    gotoTimeout?: number;
+
+    /**
+     * Opens Electron's devtools, this only helps if show browser is also enabled!
+     */
+    openDevTools?: boolean;
+
+    /**
+     * Set to true to show the headless browser.
+     */
+    showBrowser?: boolean;
+
+    /**
+     * Specify the path to Electron if that's necessary for you.
+     */
+    electronPath?: string;
+}
+
 //
 // Initalise the template renderer.
 //
-async function initTemplateRenderer(data: any, templatePath: string, port: number, electronPath?: string): Promise<ITemplateRenderer> {
-    const templateRenderer = new TemplateRenderer(electronPath);
+async function initTemplateRenderer(data: any, templatePath: string, port: number, options?: ICaptureOptions): Promise<ITemplateRenderer> {
+    const templateRenderer = new TemplateRenderer(options);
     await templateRenderer.start();
     await templateRenderer.loadTemplate(data, templatePath, port);
     return templateRenderer;
@@ -25,21 +81,21 @@ async function deinitTemplateRenderer(templateRenderer: ITemplateRenderer): Prom
 //
 // Expand a template web page and capture it to an image file.
 //
-export async function captureImage(data: any, templatePath: string, outputPath: string, electronPath?: string): Promise<void> {
+export async function captureImage(data: any, templatePath: string, outputPath: string, options?: ICaptureOptions): Promise<void> {
     await fs.ensureDir(path.dirname(outputPath));
     const autoAssignPortNo = 0; // Use port no 0, to automatically assign a port number.
-    const templateRenderer = await initTemplateRenderer(data, templatePath, autoAssignPortNo, electronPath);
+    const templateRenderer = await initTemplateRenderer(data, templatePath, autoAssignPortNo, options);
     await templateRenderer.renderImage(outputPath);
     await deinitTemplateRenderer(templateRenderer);
 }
 
 //
 // Expand a template web page and capture it to a PDF file.
 //
-export async function capturePDF(data: any, templatePath: string, outputPath: string, electronPath?: string): Promise<void> {
+export async function capturePDF(data: any, templatePath: string, outputPath: string, options?: ICaptureOptions): Promise<void> {
     await fs.ensureDir(path.dirname(outputPath));
     const autoAssignPortNo = 0; // Use port no 0, to automatically assign a port number.
-    const templateRenderer = await initTemplateRenderer(data, templatePath, autoAssignPortNo, electronPath);
+    const templateRenderer = await initTemplateRenderer(data, templatePath, autoAssignPortNo, options);
     await templateRenderer.renderPDF(outputPath);
     await deinitTemplateRenderer(templateRenderer);
 }
diff --git a/src/template-renderer.ts b/src/template-renderer.ts
@@ -1,5 +1,6 @@
 import { IWebPageRenderer, WebPageRenderer } from "./web-page-renderer";
 import { ITemplateWebServer, TemplateWebServer } from "./template-web-server";
+import { ICaptureOptions } from "./index";
 
 declare const document: any;
 
@@ -56,9 +57,9 @@ export interface ITemplateRenderer {
 export class TemplateRenderer implements ITemplateRenderer {
 
     /**
-     * Specifies the path to load Electron from or null to use default path.
+     * Options for capturing.
      */
-    electronPath?: string;
+    private options?: ICaptureOptions;
     
     /**
      * Renders the web page.
@@ -70,8 +71,8 @@ export class TemplateRenderer implements ITemplateRenderer {
      */
     private templateWebServer: ITemplateWebServer | null = null;
 
-    constructor (electronPath?: string) {
-        this.electronPath = electronPath;
+    constructor (options?: ICaptureOptions) {
+        this.options = options;
     }
 
     /**
@@ -86,7 +87,7 @@ export class TemplateRenderer implements ITemplateRenderer {
      * For performance reasons the template render can be reused to render multiple web pages.
      */
     async start (): Promise<void> {
-        this.webPageRenderer = new WebPageRenderer(this.electronPath);
+        this.webPageRenderer = new WebPageRenderer(this.options);
         await this.webPageRenderer.start();
     }
 
@@ -110,7 +111,7 @@ export class TemplateRenderer implements ITemplateRenderer {
     async loadTemplate(data: any, templatePath: string, port: number): Promise<void> {
         this.unloadTemplate();
 
-        this.templateWebServer = new TemplateWebServer();
+        this.templateWebServer = new TemplateWebServer(this.options && this.options.log);
         await this.templateWebServer.start(data, templatePath, port);
     }
 
diff --git a/src/template-web-server.ts b/src/template-web-server.ts
@@ -2,6 +2,7 @@ import { WebServer, IWebServer }  from "./web-server";
 import { inflateTemplate } from "inflate-template";
 import * as fs from 'fs-extra';
 import * as path from 'path';
+import { ILog } from "./index";
 const promisify = require('promisify-any');        
 
 declare const document: any;
@@ -39,15 +40,24 @@ export interface ITemplateWebServer {
  */
 export class TemplateWebServer implements ITemplateWebServer {
 
+    /**
+     * Optinally override logging.
+     */
+    private log?: ILog;
+
     /**
      * For performance reasons this can be reused to instantiate and render multiple web pages.
      */
-    webServer: IWebServer | null = null;
+    private webServer: IWebServer | null = null;
 
     /**
      * Template configuration, once web server is started and template has been inflated.
      */
-    templateConfig: any | null = null;
+    private templateConfig: any | null = null;
+
+    constructor(log?: ILog) {
+        this.log = log;
+    }
 
     /**
      * Get the URL to access the web-sever.
diff --git a/src/web-page-renderer.ts b/src/web-page-renderer.ts
@@ -1,3 +1,5 @@
+import { ICaptureOptions } from "./index";
+
 const Nightmare = require("nightmare");
 
 declare const document: any;
@@ -52,17 +54,53 @@ export interface IWebPageRenderer {
 export class WebPageRenderer implements IWebPageRenderer {
 
     /**
-     * Specifies the path to load Electron from or null to use default path.
+     * Options for capturing.
      */
-    electronPath?: string;
+    private options?: ICaptureOptions;
 
     /**
      * Nightmare headless browser instance.
      */
-    nightmare: any | null = null;
+    private nightmare: any | null = null;
+
+    constructor (options?: ICaptureOptions) {
+        this.options = options;
+    }
+
+    /**
+     * Log an info message.
+     */
+    info(msg: string): void {
+        if (this.options && this.options.log) {
+            this.options.log.info(msg);
+        }
+        else {
+            console.info(msg);
+        }
+    }
 
-    constructor (electronPath?: string) {
-        this.electronPath = electronPath;
+    /**
+     * Log a warning message.
+     */
+    warn(msg: string): void {
+        if (this.options && this.options.log) {
+            this.options.log.warn(msg);
+        }
+        else {
+            console.warn(msg);
+        }
+    }
+
+    /**
+     * Log an error message.
+     */
+    error(msg: string): void {
+        if (this.options && this.options.log) {
+            this.options.log.error(msg);
+        }
+        else {
+            console.error(msg);
+        }
     }
 
     /**
@@ -71,15 +109,18 @@ export class WebPageRenderer implements IWebPageRenderer {
      */
     async start (): Promise<void> {
         const nightmareOptions: any = {
-            show: false,
+            show: this.options && this.options.showBrowser,
             frame: false,
             maxHeight: 1000000,
             maxWidth: 1000000,
+            waitTimeout: this.options && this.options.waitTimeout,
+            gotoTimeout: this.options && this.options.gotoTimeout,
+            openDevTools: this.options && this.options.openDevTools,
         };
 
-        if (this.electronPath) {
+        if (this.options && this.options.electronPath) {
             // Include Electron path if specified.
-            nightmareOptions.electronPath = this.electronPath;
+            nightmareOptions.electronPath = this.options.electronPath;
         }
 
         this.nightmare = new Nightmare(nightmareOptions);
@@ -90,34 +131,34 @@ export class WebPageRenderer implements IWebPageRenderer {
 
         this.nightmare.on('page', (type: string, message: string, stack: any) => {
             if (type === "error") {
-                console.error("Browser page error: " + message);
-                console.error(stack);
+                this.error("Browser page error: " + message);
+                this.error(stack);
             }
         });
 
         this.nightmare.on("did-fail-load", (event: any, errorCode: number, errorDescription: string, validatedURL: string, isMainFrame: boolean) => {
-            console.error("Browser page failed to load.");
-            console.error("Error code: " + errorCode);
-            console.error("Error description: " + errorDescription);
-            console.error("Validated URL: " + validatedURL);
-            console.error("Is main frame: " + isMainFrame);
+            this.error("Browser page failed to load.");
+            this.error("Error code: " + errorCode);
+            this.error("Error description: " + errorDescription);
+            this.error("Validated URL: " + validatedURL);
+            this.error("Is main frame: " + isMainFrame);
         });
 
         this.nightmare.on('console', (type: string, message: string) => {
 
             if (type === 'log') {
-                console.log('LOG: ' + message);
+                this.info('LOG: ' + message);
                 return;
             }
     
             if (type === 'warn') {
-                console.warn('LOG: ' + message);
+                this.warn('LOG: ' + message);
                 return;
             }
     
             if (type === 'error') {
-                console.error("Browser JavaScript error:");
-                console.error(message);
+                this.error("Browser JavaScript error:");
+                this.error(message);
             }
         });
     }
diff --git a/src/web-server.ts b/src/web-server.ts
@@ -2,6 +2,7 @@ import * as express from "express";
 import * as http from 'http';
 import * as path from "path";
 import { ITemplate } from 'inflate-template';
+import { ILog } from "./index";
 
 /**
  * Web-server component. Serves the chart interative chart.
@@ -29,30 +30,48 @@ export interface IWebServer {
  */
 export class WebServer implements IWebServer {
 
+    /**
+     * Optinally override logging.
+     */
+    private log?: ILog;
+
     /**
      * The requested port number for the web server.
      */
-    requestedPortNo: number;
+    private requestedPortNo: number;
 
     /**
      * The assigned port number for the web server.
      */
-    assignedPortNo: number;
+    private assignedPortNo: number;
 
     /**
      * The Express server instance that implements the web-server.
      */
-    server: any | null = null;
+    private server: any | null = null;
 
     /**
      * The data that defines the chart.
      * Passed to the browser-based chart via REST API.
      */
-    chartDef: any = {};
+    private chartDef: any = {};
 
-    constructor (portNo: number) {
+    constructor (portNo: number, log?: ILog) {
         this.requestedPortNo = portNo;
         this.assignedPortNo = portNo;
+        this.log = log;
+    }
+
+    /**
+     * Log an error message.
+     */
+    error(msg: string): void {
+        if (this.log) {
+            this.log.error(msg);
+        }
+        else {
+            console.error(msg);
+        }
     }
 
     /**
@@ -100,8 +119,8 @@ export class WebServer implements IWebServer {
                     response.send(fileContent);
                 }
                 catch (err) {
-                    console.error("Error loading template file.");
-                    console.error(err && err.stack || err);
+                    this.error("Error loading template file.");
+                    this.error(err && err.stack || err);
 
                     response.sendStatus(404);
                 }

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "capture-template",`
`3`		`- "version": "1.0.8",`
	`3`	`+ "version": "1.0.9",`
`4`	`4`	`"description": "This library is responsible for expanding a template web page and then capturing it PNG or PDF.",`
`5`	`5`	`"main": "build/index.js",`
`6`	`6`	`"types": "build/index.d.ts",`