@things-factory/integration-headless 8.0.0-alpha.31 → 8.0.0-alpha.35

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/integration-headless",
-  "version": "8.0.0-alpha.31",
+  "version": "8.0.0-alpha.35",
   "main": "dist-server/index.js",
   "things-factory": true,
   "author": "heartyoh <heartyoh@hatiolab.com>",
@@ -22,12 +22,12 @@
     "clean": "npm run clean:server"
   },
   "dependencies": {
-    "@things-factory/attachment-base": "^8.0.0-alpha.29",
-    "@things-factory/board-service": "^8.0.0-alpha.31",
-    "@things-factory/integration-base": "^8.0.0-alpha.31",
+    "@things-factory/attachment-base": "^8.0.0-alpha.35",
+    "@things-factory/board-service": "^8.0.0-alpha.35",
+    "@things-factory/integration-base": "^8.0.0-alpha.35",
     "@things-factory/shell": "^8.0.0-alpha.29",
     "ejs": "^3.1.10",
     "pdf-lib": "^1.17.1"
   },
-  "gitHead": "3d8df8131f3b0c1898c525d2928b7f9dc846840e"
+  "gitHead": "94fe243a5c99837a1e6f98de2c454c351ac8e6fd"
 }

package/server/engine/index.ts

@@ -1,2 +1 @@
-import './connector'
 import './task'

package/server/engine/task/pdf-capture-util.ts

@@ -27,7 +27,12 @@ interface PDFContext {
 
 export class PDFCaptureUtil {
   private context: PDFContext
-  private headlessPool: any
+  private headlessConnection: {
+    acquireSessionPage: () => Promise<Page>
+    releasePage: (page: Page) => Promise<void>
+    acquireBrowser: () => Promise<Browser>
+    releaseBrowser: (browser: Browser) => Promise<void>
+  }
 
   public browser: Browser | null = null
 
@@ -37,14 +42,14 @@ export class PDFCaptureUtil {
 
   async initBrowser(connectionName: string) {
     const { domain } = this.context
-    this.headlessPool = ConnectionManager.getConnectionInstanceByName(domain, connectionName)
-    this.browser = await this.headlessPool.acquire()
+    this.headlessConnection = ConnectionManager.getConnectionInstanceByName(domain, connectionName)
+    this.browser = await this.headlessConnection.acquireBrowser()
   }
 
   async closeBrowser() {
     if (this.browser) {
       await this.browser.close()
-      this.headlessPool.release(this.browser)
+      this.headlessConnection.releaseBrowser(this.browser)
     }
   }
 

package/dist-server/engine/connector/headless-connector.d.ts

@@ -1,14 +0,0 @@
-import { Connector } from '@things-factory/integration-base';
-export declare class HeadlessConnector implements Connector {
-    ready(connectionConfigs: any): Promise<void>;
-    connect(connection: any): Promise<void>;
-    disconnect(connection: any): Promise<void>;
-    get parameterSpec(): {
-        type: string;
-        name: string;
-        label: string;
-    }[];
-    get taskPrefixes(): string[];
-    get description(): string;
-    get help(): string;
-}

package/dist-server/engine/connector/headless-connector.js

@@ -1,54 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HeadlessConnector = void 0;
-const integration_base_1 = require("@things-factory/integration-base");
-const headless_pool_1 = require("./headless-pool");
-class HeadlessConnector {
-    async ready(connectionConfigs) {
-        await Promise.all(connectionConfigs.map(this.connect.bind(this)));
-        integration_base_1.ConnectionManager.logger.info('headless-connector connections are ready');
-    }
-    async connect(connection) {
-        var { endpoint: uri = '1', params: { min = 2, max = 10 } } = connection;
-        const headlessPool = (0, headless_pool_1.createHeadlessPool)({
-            min,
-            max,
-            testOnBorrow: true,
-            acquireTimeoutMillis: 15000
-        });
-        integration_base_1.ConnectionManager.addConnectionInstance(connection, headlessPool);
-        integration_base_1.ConnectionManager.logger.info(`headless-connector connection(${connection.name}:${connection.endpoint}) is connected`);
-    }
-    async disconnect(connection) {
-        const headlessPool = integration_base_1.ConnectionManager.getConnectionInstance(connection);
-        (0, headless_pool_1.destroyHeadlessPool)(headlessPool);
-        integration_base_1.ConnectionManager.removeConnectionInstance(connection);
-        integration_base_1.ConnectionManager.logger.info(`headless-connector connection(${connection.name}) is disconnected`);
-    }
-    get parameterSpec() {
-        return [
-            {
-                type: 'number',
-                name: 'min',
-                label: 'pool-size-min'
-            },
-            {
-                type: 'number',
-                name: 'max',
-                label: 'pool-size-max'
-            }
-        ];
-    }
-    get taskPrefixes() {
-        return ['headless-pdf'];
-    }
-    get description() {
-        return 'Headless Pool Connector';
-    }
-    get help() {
-        return 'integration/connector/headless-connector';
-    }
-}
-exports.HeadlessConnector = HeadlessConnector;
-integration_base_1.ConnectionManager.registerConnector('headless-connector', new HeadlessConnector());
-//# sourceMappingURL=headless-connector.js.map

package/dist-server/engine/connector/headless-connector.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"headless-connector.js","sourceRoot":"","sources":["../../../server/engine/connector/headless-connector.ts"],"names":[],"mappings":";;;AAAA,uEAA+E;AAC/E,mDAAyE;AAEzE,MAAa,iBAAiB;IAC5B,KAAK,CAAC,KAAK,CAAC,iBAAiB;QAC3B,MAAM,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAEjE,oCAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAA;IAC3E,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,UAAU;QACtB,IAAI,EACF,QAAQ,EAAE,GAAG,GAAG,GAAG,EACnB,MAAM,EAAE,EAAE,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,EAAE,EAAE,EAC9B,GAAG,UAAU,CAAA;QAEd,MAAM,YAAY,GAAG,IAAA,kCAAkB,EAAC;YACtC,GAAG;YACH,GAAG;YACH,YAAY,EAAE,IAAI;YAClB,oBAAoB,EAAE,KAAK;SAC5B,CAAC,CAAA;QAEF,oCAAiB,CAAC,qBAAqB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAA;QAEjE,oCAAiB,CAAC,MAAM,CAAC,IAAI,CAC3B,iCAAiC,UAAU,CAAC,IAAI,IAAI,UAAU,CAAC,QAAQ,gBAAgB,CACxF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,UAAU;QACzB,MAAM,YAAY,GAAG,oCAAiB,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAA;QACxE,IAAA,mCAAmB,EAAC,YAAY,CAAC,CAAA;QAEjC,oCAAiB,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAA;QAEtD,oCAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,iCAAiC,UAAU,CAAC,IAAI,mBAAmB,CAAC,CAAA;IACpG,CAAC;IAED,IAAI,aAAa;QACf,OAAO;YACL;gBACE,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE,eAAe;aACvB;YACD;gBACE,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE,eAAe;aACvB;SACF,CAAA;IACH,CAAC;IAED,IAAI,YAAY;QACd,OAAO,CAAC,cAAc,CAAC,CAAA;IACzB,CAAC;IAED,IAAI,WAAW;QACb,OAAO,yBAAyB,CAAA;IAClC,CAAC;IAED,IAAI,IAAI;QACN,OAAO,0CAA0C,CAAA;IACnD,CAAC;CACF;AA9DD,8CA8DC;AAED,oCAAiB,CAAC,iBAAiB,CAAC,oBAAoB,EAAE,IAAI,iBAAiB,EAAE,CAAC,CAAA","sourcesContent":["import { ConnectionManager, Connector } from '@things-factory/integration-base'\nimport { createHeadlessPool, destroyHeadlessPool } from './headless-pool'\n\nexport class HeadlessConnector implements Connector {\n  async ready(connectionConfigs) {\n    await Promise.all(connectionConfigs.map(this.connect.bind(this)))\n\n    ConnectionManager.logger.info('headless-connector connections are ready')\n  }\n\n  async connect(connection) {\n    var {\n      endpoint: uri = '1',\n      params: { min = 2, max = 10 }\n    } = connection\n\n    const headlessPool = createHeadlessPool({\n      min,\n      max,\n      testOnBorrow: true,\n      acquireTimeoutMillis: 15000\n    })\n\n    ConnectionManager.addConnectionInstance(connection, headlessPool)\n\n    ConnectionManager.logger.info(\n      `headless-connector connection(${connection.name}:${connection.endpoint}) is connected`\n    )\n  }\n\n  async disconnect(connection) {\n    const headlessPool = ConnectionManager.getConnectionInstance(connection)\n    destroyHeadlessPool(headlessPool)\n\n    ConnectionManager.removeConnectionInstance(connection)\n\n    ConnectionManager.logger.info(`headless-connector connection(${connection.name}) is disconnected`)\n  }\n\n  get parameterSpec() {\n    return [\n      {\n        type: 'number',\n        name: 'min',\n        label: 'pool-size-min'\n      },\n      {\n        type: 'number',\n        name: 'max',\n        label: 'pool-size-max'\n      }\n    ]\n  }\n\n  get taskPrefixes() {\n    return ['headless-pdf']\n  }\n\n  get description() {\n    return 'Headless Pool Connector'\n  }\n\n  get help() {\n    return 'integration/connector/headless-connector'\n  }\n}\n\nConnectionManager.registerConnector('headless-connector', new HeadlessConnector())\n"]}

package/dist-server/engine/connector/headless-pool.d.ts

@@ -1,3 +0,0 @@
-import * as genericPool from 'generic-pool';
-export declare function createHeadlessPool(options: genericPool.Options): genericPool.Pool<any>;
-export declare function destroyHeadlessPool(headlessPool: genericPool.Pool<any>): Promise<void>;

package/dist-server/engine/connector/headless-pool.js

@@ -1,63 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createHeadlessPool = createHeadlessPool;
-exports.destroyHeadlessPool = destroyHeadlessPool;
-const tslib_1 = require("tslib");
-const genericPool = tslib_1.__importStar(require("generic-pool"));
-const env_1 = require("@things-factory/env");
-try {
-    var puppeteer = require('puppeteer');
-}
-catch (err) {
-    env_1.logger.error(err);
-}
-function createHeadlessPool(options) {
-    return genericPool.createPool({
-        create() {
-            console.log('headless instance in headless-pool-integration about to create');
-            return initializeChromium();
-        },
-        validate(browser) {
-            return Promise.race([
-                new Promise(res => setTimeout(() => res(false), 1500)),
-                browser
-                    //@ts-ignore
-                    .version()
-                    .then(_ => true)
-                    .catch(_ => false)
-            ]);
-        },
-        destroy(browser) {
-            //@ts-ignore
-            return browser.close();
-        }
-    }, options);
-}
-async function destroyHeadlessPool(headlessPool) {
-    if (headlessPool) {
-        console.log('headless-pool-integration about to destroy');
-        await headlessPool.drain();
-        await headlessPool.clear();
-    }
-}
-const CHROMIUM_PATH = env_1.config.get('CHROMIUM_PATH');
-async function initializeChromium() {
-    try {
-        if (!puppeteer) {
-            return;
-        }
-        var launchSetting = {
-            args: ['--hide-scrollbars', '--mute-audio', '--no-sandbox', '--use-gl=egl'],
-            headless: 'shell'
-        };
-        if (CHROMIUM_PATH) {
-            launchSetting['executablePath'] = CHROMIUM_PATH;
-        }
-        const browser = await puppeteer.launch(launchSetting);
-        return browser;
-    }
-    catch (err) {
-        env_1.logger.error(err);
-    }
-}
-//# sourceMappingURL=headless-pool.js.map

package/dist-server/engine/connector/headless-pool.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"headless-pool.js","sourceRoot":"","sources":["../../../server/engine/connector/headless-pool.ts"],"names":[],"mappings":";;AAUA,gDAwBC;AAED,kDAOC;;AA3CD,kEAA2C;AAE3C,6CAAoD;AAEpD,IAAI,CAAC;IACH,IAAI,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;AACtC,CAAC;AAAC,OAAO,GAAG,EAAE,CAAC;IACb,YAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;AACnB,CAAC;AAED,SAAgB,kBAAkB,CAAC,OAA4B;IAC7D,OAAO,WAAW,CAAC,UAAU,CAC3B;QACE,MAAM;YACJ,OAAO,CAAC,GAAG,CAAC,gEAAgE,CAAC,CAAA;YAC7E,OAAO,kBAAkB,EAAE,CAAA;QAC7B,CAAC;QACD,QAAQ,CAAC,OAAO;YACd,OAAO,OAAO,CAAC,IAAI,CAAC;gBAClB,IAAI,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;gBACtD,OAAO;oBACL,YAAY;qBACX,OAAO,EAAE;qBACT,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC;qBACf,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC;aACrB,CAAC,CAAA;QACJ,CAAC;QACD,OAAO,CAAC,OAAO;YACb,YAAY;YACZ,OAAO,OAAO,CAAC,KAAK,EAAE,CAAA;QACxB,CAAC;KAC0B,EAC7B,OAAO,CACR,CAAA;AACH,CAAC;AAEM,KAAK,UAAU,mBAAmB,CAAC,YAAmC;IAC3E,IAAI,YAAY,EAAE,CAAC;QACjB,OAAO,CAAC,GAAG,CAAC,4CAA4C,CAAC,CAAA;QAEzD,MAAM,YAAY,CAAC,KAAK,EAAE,CAAA;QAC1B,MAAM,YAAY,CAAC,KAAK,EAAE,CAAA;IAC5B,CAAC;AACH,CAAC;AAED,MAAM,aAAa,GAAG,YAAM,CAAC,GAAG,CAAC,eAAe,CAAC,CAAA;AAEjD,KAAK,UAAU,kBAAkB;IAC/B,IAAI,CAAC;QACH,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,OAAM;QACR,CAAC;QAED,IAAI,aAAa,GAAG;YAClB,IAAI,EAAE,CAAC,mBAAmB,EAAE,cAAc,EAAE,cAAc,EAAE,cAAc,CAAC;YAC3E,QAAQ,EAAE,OAAO;SAClB,CAAA;QAED,IAAI,aAAa,EAAE,CAAC;YAClB,aAAa,CAAC,gBAAgB,CAAC,GAAG,aAAa,CAAA;QACjD,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,CAAA;QAErD,OAAO,OAAO,CAAA;IAChB,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,YAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IACnB,CAAC;AACH,CAAC","sourcesContent":["import * as genericPool from 'generic-pool'\n\nimport { config, logger } from '@things-factory/env'\n\ntry {\n  var puppeteer = require('puppeteer')\n} catch (err) {\n  logger.error(err)\n}\n\nexport function createHeadlessPool(options: genericPool.Options) {\n  return genericPool.createPool(\n    {\n      create() {\n        console.log('headless instance in headless-pool-integration about to create')\n        return initializeChromium()\n      },\n      validate(browser) {\n        return Promise.race([\n          new Promise(res => setTimeout(() => res(false), 1500)),\n          browser\n            //@ts-ignore\n            .version()\n            .then(_ => true)\n            .catch(_ => false)\n        ])\n      },\n      destroy(browser) {\n        //@ts-ignore\n        return browser.close()\n      }\n    } as genericPool.Factory<any>,\n    options\n  )\n}\n\nexport async function destroyHeadlessPool(headlessPool: genericPool.Pool<any>) {\n  if (headlessPool) {\n    console.log('headless-pool-integration about to destroy')\n\n    await headlessPool.drain()\n    await headlessPool.clear()\n  }\n}\n\nconst CHROMIUM_PATH = config.get('CHROMIUM_PATH')\n\nasync function initializeChromium() {\n  try {\n    if (!puppeteer) {\n      return\n    }\n\n    var launchSetting = {\n      args: ['--hide-scrollbars', '--mute-audio', '--no-sandbox', '--use-gl=egl'],\n      headless: 'shell'\n    }\n\n    if (CHROMIUM_PATH) {\n      launchSetting['executablePath'] = CHROMIUM_PATH\n    }\n\n    const browser = await puppeteer.launch(launchSetting)\n\n    return browser\n  } catch (err) {\n    logger.error(err)\n  }\n}\n"]}

package/dist-server/engine/connector/index.d.ts

@@ -1 +0,0 @@
-import './headless-connector';

package/dist-server/engine/connector/index.js

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-require("./headless-connector");
-//# sourceMappingURL=index.js.map

package/dist-server/engine/connector/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../server/engine/connector/index.ts"],"names":[],"mappings":";;AAAA,gCAA6B","sourcesContent":["import './headless-connector'\n"]}

package/server/engine/connector/headless-connector.ts

@@ -1,68 +0,0 @@
-import { ConnectionManager, Connector } from '@things-factory/integration-base'
-import { createHeadlessPool, destroyHeadlessPool } from './headless-pool'
-
-export class HeadlessConnector implements Connector {
-  async ready(connectionConfigs) {
-    await Promise.all(connectionConfigs.map(this.connect.bind(this)))
-
-    ConnectionManager.logger.info('headless-connector connections are ready')
-  }
-
-  async connect(connection) {
-    var {
-      endpoint: uri = '1',
-      params: { min = 2, max = 10 }
-    } = connection
-
-    const headlessPool = createHeadlessPool({
-      min,
-      max,
-      testOnBorrow: true,
-      acquireTimeoutMillis: 15000
-    })
-
-    ConnectionManager.addConnectionInstance(connection, headlessPool)
-
-    ConnectionManager.logger.info(
-      `headless-connector connection(${connection.name}:${connection.endpoint}) is connected`
-    )
-  }
-
-  async disconnect(connection) {
-    const headlessPool = ConnectionManager.getConnectionInstance(connection)
-    destroyHeadlessPool(headlessPool)
-
-    ConnectionManager.removeConnectionInstance(connection)
-
-    ConnectionManager.logger.info(`headless-connector connection(${connection.name}) is disconnected`)
-  }
-
-  get parameterSpec() {
-    return [
-      {
-        type: 'number',
-        name: 'min',
-        label: 'pool-size-min'
-      },
-      {
-        type: 'number',
-        name: 'max',
-        label: 'pool-size-max'
-      }
-    ]
-  }
-
-  get taskPrefixes() {
-    return ['headless-pdf']
-  }
-
-  get description() {
-    return 'Headless Pool Connector'
-  }
-
-  get help() {
-    return 'integration/connector/headless-connector'
-  }
-}
-
-ConnectionManager.registerConnector('headless-connector', new HeadlessConnector())

package/server/engine/connector/headless-pool.ts

@@ -1,69 +0,0 @@
-import * as genericPool from 'generic-pool'
-
-import { config, logger } from '@things-factory/env'
-
-try {
-  var puppeteer = require('puppeteer')
-} catch (err) {
-  logger.error(err)
-}
-
-export function createHeadlessPool(options: genericPool.Options) {
-  return genericPool.createPool(
-    {
-      create() {
-        console.log('headless instance in headless-pool-integration about to create')
-        return initializeChromium()
-      },
-      validate(browser) {
-        return Promise.race([
-          new Promise(res => setTimeout(() => res(false), 1500)),
-          browser
-            //@ts-ignore
-            .version()
-            .then(_ => true)
-            .catch(_ => false)
-        ])
-      },
-      destroy(browser) {
-        //@ts-ignore
-        return browser.close()
-      }
-    } as genericPool.Factory<any>,
-    options
-  )
-}
-
-export async function destroyHeadlessPool(headlessPool: genericPool.Pool<any>) {
-  if (headlessPool) {
-    console.log('headless-pool-integration about to destroy')
-
-    await headlessPool.drain()
-    await headlessPool.clear()
-  }
-}
-
-const CHROMIUM_PATH = config.get('CHROMIUM_PATH')
-
-async function initializeChromium() {
-  try {
-    if (!puppeteer) {
-      return
-    }
-
-    var launchSetting = {
-      args: ['--hide-scrollbars', '--mute-audio', '--no-sandbox', '--use-gl=egl'],
-      headless: 'shell'
-    }
-
-    if (CHROMIUM_PATH) {
-      launchSetting['executablePath'] = CHROMIUM_PATH
-    }
-
-    const browser = await puppeteer.launch(launchSetting)
-
-    return browser
-  } catch (err) {
-    logger.error(err)
-  }
-}

package/server/engine/connector/index.ts

@@ -1 +0,0 @@
-import './headless-connector'