Release v0.3.2

center-key · Jul 17, 2021 · c8babcc · c8babcc
1 parent a813b34
commit c8babcc
Show file tree

Hide file tree

Showing 8 changed files with 25 additions and 9 deletions.
diff --git a/dist/puppeteer-browser-ready.d.ts b/dist/puppeteer-browser-ready.d.ts
@@ -8,6 +8,7 @@ export declare type StartWebServerOptions = {
     folder?: string;
     port?: number;
     verbose?: boolean;
+    autoCleanup?: boolean;
 };
 export declare type Http = {
     server: Server;

diff --git a/dist/puppeteer-browser-ready.js b/dist/puppeteer-browser-ready.js
@@ -6,10 +6,11 @@ import httpTerminator from 'http-terminator';
 // Package
 const browserReady = {
     log(...args) {
-        console.log('  [' + new Date().toISOString() + ']', ...args);
+        const indent = typeof globalThis['describe'] === 'function' ? '  [' : '[';
+        console.log(indent + new Date().toISOString() + ']', ...args);
     },
     startWebServer(options) {
-        const defaults = { folder: '.', port: 0, verbose: true };
+        const defaults = { folder: '.', port: 0, verbose: true, autoCleanup: true };
         const settings = { ...defaults, ...options };
         const server = express().use(express.static(settings.folder)).listen(settings.port);
         const terminator = httpTerminator.createHttpTerminator({ server });
@@ -29,6 +30,12 @@ const browserReady = {
         server.on('listening', () => done(http()));
         if (settings.verbose)
             server.on('listening', logListening).on('close', logClose);
+        const cleanup = () => {
+            console.log('[SIGINT]');
+            terminator.terminate();
+        };
+        if (settings.autoCleanup)
+            process.on('SIGINT', cleanup);
         return new Promise(resolve => done = resolve);
     },
     shutdownWebServer(http) {

diff --git a/dist/puppeteer-browser-ready.umd.cjs b/dist/puppeteer-browser-ready.umd.cjs
@@ -21,10 +21,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     // Package
     const browserReady = {
         log(...args) {
-            console.log('  [' + new Date().toISOString() + ']', ...args);
+            const indent = typeof globalThis['describe'] === 'function' ? '  [' : '[';
+            console.log(indent + new Date().toISOString() + ']', ...args);
         },
         startWebServer(options) {
-            const defaults = { folder: '.', port: 0, verbose: true };
+            const defaults = { folder: '.', port: 0, verbose: true, autoCleanup: true };
             const settings = { ...defaults, ...options };
             const server = express_1.default().use(express_1.default.static(settings.folder)).listen(settings.port);
             const terminator = http_terminator_1.default.createHttpTerminator({ server });
@@ -44,6 +45,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
             server.on('listening', () => done(http()));
             if (settings.verbose)
                 server.on('listening', logListening).on('close', logClose);
+            const cleanup = () => {
+                console.log('[SIGINT]');
+                terminator.terminate();
+            };
+            if (settings.autoCleanup)
+                process.on('SIGINT', cleanup);
             return new Promise(resolve => done = resolve);
         },
         shutdownWebServer(http) {

diff --git a/hello-world/index.js b/hello-world/index.js
@@ -2,9 +2,10 @@
 
 // To run:
 //    $ git clone https://github.com/center-key/puppeteer-browser-ready.git
+//    $ cd puppeteer-browser-ready
 //    $ cd hello-world
 //    $ npm install
-//    $ node index
+//    $ node index.js
 //    Hello, World!
 //    web fields: browser, page, response, url, status, statusText, html, $
 //    The HTML from https://pretty-print-json.js.org/ is 7556 characters

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
    "name": "puppeteer-browser-ready",
-   "version": "0.3.1",
+   "version": "0.3.2",
    "description": "Simple utility to go to a URL and wait for the HTTP response (written in TypeScript)",
    "license": "MIT",
    "type": "module",

diff --git a/spec/combo-server-browser.spec.js b/spec/combo-server-browser.spec.js
@@ -14,7 +14,7 @@ describe('Combo Server/Browser specification suite', () => {
 /////////////////////////////////////////////////////////////////////////////////////
 describe('The sample web page', () => {
    let http;  //fields: server, terminator, folder, url, port, verbose
-   let web;   //fields: browser, page, response, title, html, $
+   let web;   //fields: browser, page, response, location, title, html, $
    before(async () => {
       http = await browserReady.startWebServer(options);
       web =  await puppeteer.launch().then(browserReady.goto(http.url + webPath));

diff --git a/spec/load-web-page.spec.js b/spec/load-web-page.spec.js
@@ -7,7 +7,7 @@ import { browserReady } from '../dist/puppeteer-browser-ready.js';  //replace wi
 
 // Setup
 const url = 'https://pretty-print-json.js.org/';
-let web;  //fields: browser, page, response, title, html, $
+let web;  //fields: browser, page, response, location, title, html, $
 const loadWebPage =  async () => web = await puppeteer.launch().then(browserReady.goto(url));
 const closeWebPage = async () => await browserReady.close(web);
 

diff --git a/spec/start-web-server.spec.js b/spec/start-web-server.spec.js
@@ -16,7 +16,7 @@ describe('Start Web Server specification suite', () => {
 
 /////////////////////////////////////////////////////////////////////////////////////
 describe('The sample web page', () => {
-   let web;  //fields: browser, page, response, title, html, $
+   let web;  //fields: browser, page, response, location, title, html, $
    before(async () => web = await puppeteer.launch().then(browserReady.goto(http.url + webPath)));
    after(async () =>  await browserReady.close(web));