feat: add option control page navigate to about:blank to free resources

Author: halwu(吴浩麟)

README.md

@@ -39,7 +39,7 @@ see more demo in [unit test](test/index.test.js)
 - `script`: `string` is an option param. inject script source to evaluate when page on load
 - `renderTimeout`: `number` in ms, `render()` will throw error if html string can't be resolved after `renderTimeout`, default is 5000ms.
 - `deviceMetricsOverride`: `object` overrides the values of device screen dimensions for responsive websites, detail use see [here](https://chromedevtools.github.io/devtools-protocol/tot/Emulation/#method-setDeviceMetricsOverride)
-- `clearPool`: `boolean` if `true` after render chrome instance will navigate to `about:blank` to free resources. default is true. setting to `false` may increase page load speed when rendering the same website.
+- `clearTab`: `boolean` if `true` after render chrome instance will navigate to `about:blank` to free resources. default is `true`. setting to `false` may increase page load speed when rendering the same website.
 
 all request from chrome-render will take with a HTTP header `x-chrome-render:${version}`
 

index.d.ts

@@ -48,7 +48,7 @@ export default class ChromeRender {
     /**
      * `boolean` if `true` after render chrome instance will navigate to `about:blank` to free resources. default is true. setting to `false` may increase page load speed when rendering the same website.
      */
-    clearPool?: boolean,
+    clearTab?: boolean,
   }): Promise<string>;
 
   /**

index.js

@@ -157,10 +157,10 @@ new Promise((fulfill) => {
         referrer: headers['referrer']
       });
     }).then((html) => {
-      this.chromePoll.release(client.tabId, params.clearPool);
+      this.chromePoll.release(client.tabId, params.clearTab);
       return Promise.resolve(html);
     }).catch((err) => {
-      this.chromePoll.release(client.tabId, params.clearPool);
+      this.chromePoll.release(client.tabId, params.clearTab);
       return Promise.reject(err);
     });
   }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "chrome-render",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "description": "General server render base on chrome",
   "keywords": [
     "headless",
@@ -23,7 +23,7 @@
     "test": "mocha test"
   },
   "dependencies": {
-    "chrome-pool": "^1.1.3"
+    "chrome-pool": "^1.2.0"
   },
   "devDependencies": {
     "koa": "^2.2.0",

test/index.test.js

@@ -84,49 +84,22 @@ describe('#ChromeRender', function () {
     await chromeRender.destroyRender();
   });
 
-  it('#render() proper release', async function () {
-    this.timeout(15000);
-    const chromeRender = await ChromeRender.new({
-      maxTab: 8
-    });
-    await chromeRender.render({
-      url: 'https://gwuhaolin.github.io/redemo/',
-      useReady: true,
-      script: `setTimeout(function(){ window.isPageReady=1 }, 1000);`,
-      renderTimeout: 5000
-    });
-
-    await chromeRender.render({
-      url: 'https://gwuhaolin.github.io/redemo/',
-      useReady: true,
-      script: `setTimeout(function(){ window.isPageReady=1 }, 1000);`,
-      renderTimeout: 5000
-    });
-    await chromeRender.destroyRender();
-  });
-
-  it('#render() proper release', async function () {
+  it('#render() clearTab=false', async function () {
+    this.timeout(20000);
     const chromeRender = await ChromeRender.new({
-      maxTab: 8
-    });
-    await chromeRender.render({
-      url: 'https://gwuhaolin.github.io/redemo/?a=1',
-      useReady: true,
-      script: `setTimeout(function(){window.isPageReady = 1;}, 1000);`,
-      renderTimeout: 5000
-    });
-    await chromeRender.render({
-      url: 'https://gwuhaolin.github.io/redemo/?a=2',
-      useReady: true,
-      script: `setTimeout(function(){window.isPageReady = 1;}, 1000);`,
-      renderTimeout: 5000
-    });
-    await chromeRender.render({
-      url: 'https://gwuhaolin.github.io/redemo/?a=3',
-      useReady: true,
-      script: `setTimeout(function(){window.isPageReady = 1;}, 1000);`,
-      renderTimeout: 5000
+      maxTab: 2
     });
+    let task = [];
+    for (let i = 0; i < 10; i++) {
+      task.push(chromeRender.render({
+        url: `https://gwuhaolin.github.io/redemo/?${i}`,
+        useReady: true,
+        script: `setTimeout(function(){window.isPageReady = 1;}, 1000);`,
+        renderTimeout: 5000,
+        clearTab: false,
+      }));
+    }
+    await Promise.all(task);
     await chromeRender.destroyRender();
   });