feat!: remove chromium and use puppeteer (#24)

* feat: remove chromium and use puppeteer

* docs: update readme

Author: atinux

README.md

@@ -82,12 +82,6 @@ You can use `vue-telemetry-analyzer` locally on your project:
 npm install vue-telemetry-analyzer # Or yarn add vue-telemetry
 ```
 
-Since this module is made to work on serverless environement by using [puppeteer-core](https://www.npmjs.com/package/puppeteer-core) and [chrome-aws-lambda](http://npmjs.com/package/chrome-aws-lambda), you need to install [puppeteer](https://www.npmjs.com/package/puppeteer) locally as a dev dependency:
-
-```bash
-npm install --save-dev puppeteer # Or yarn add --dev puppeteer
-```
-
 Then you can use the module in your project:
 
 ```js

bin/vta.js

@@ -3,8 +3,6 @@
 const ora = require('ora')
 const consola = require('consola')
 const yargs = require('yargs')
-const { setRootDir, install } = require('lmify')
-const { join } = require('path')
 
 yargs
   .usage('$0 [url]', 'analyze an url', (yargs) => {
@@ -17,12 +15,6 @@ yargs
       consola.error('Please provide an url to analyze')
       return yargs.showHelp()
     }
-    // Check if puppeteer is installed
-    try { require('puppeteer') }
-    catch(err) {
-      setRootDir(join(__dirname, '..'))
-      await install('puppeteer')
-    }
 
     const spinner = ora(`Detecting Vue on ${argv.url}`).start()
     setTimeout(() => spinner.color = 'magenta', 2500)

package.json

@@ -19,17 +19,14 @@
   "author": "NuxtJS Company",
   "license": "MIT",
   "dependencies": {
-    "chrome-aws-lambda": "^3.1.1",
-    "consola": "^2.13.0",
-    "lmify": "^0.3.0",
+    "consola": "^2.15.0",
     "make-dir": "^3.1.0",
-    "ora": "^4.0.4",
-    "puppeteer-core": "^3.3.0",
-    "tld-extract": "^1.1.2",
-    "yargs": "^15.3.1"
+    "ora": "^5.1.0",
+    "puppeteer": "^5.3.0",
+    "tld-extract": "^2.0.0",
+    "yargs": "^16.0.3"
   },
   "devDependencies": {
-    "puppeteer": "^3.3.0",
-    "standard-version": "^8.0.0"
+    "standard-version": "^9.0.0"
   }
 }

src/index.js

@@ -1,11 +1,11 @@
-const chromium = require('chrome-aws-lambda')
+const puppeteer = require('puppeteer')
 const tldParser = require('tld-extract')
 const makeDir = require('make-dir')
 const { createHash } = require('crypto')
 const { URL } = require('url')
 const { join } = require('path')
 const { tmpdir } = require('os')
-const { isCrawlable } = require('./utils')
+const { isCrawlable, puppeteerArgs, puppeteerViewport } = require('./utils')
 const { hasVue, getVueMeta, getFramework, getPlugins, getUI, getNuxtMeta, getNuxtModules } = require('./detectors')
 const consola = require('consola')
 
@@ -15,25 +15,9 @@ const ERROR_CODES = Object.freeze({
   NOT_CRAWLABLE: 3,
   VUE_NOT_DETECTED: 4
 })
+let browser = null
 
-async function getPuppeteerPath() {
-  let executablePath = await chromium.executablePath
-
-  if (process.env.NETLIFY_DEV) {
-    executablePath = null // forces to use local puppeteer
-  }
-
-  return executablePath
-}
-
-module.exports = async function (originalUrl) {
-  const executablePath = await getPuppeteerPath()
-  const browser = await chromium.puppeteer.launch({
-    executablePath,
-    args: chromium.args,
-    defaultViewport: chromium.defaultViewport,
-    headless: true
-  })
+async function analyze (originalUrl) {
   // Parse url
   let url
   try {
@@ -43,6 +27,17 @@ module.exports = async function (originalUrl) {
     error.code = ERROR_CODES.INVALID_URL
     throw error
   }
+  // Start browser if not launched
+  if (!browser) {
+    browser = await puppeteer.launch({
+      args: puppeteerArgs,
+      defaultViewport: puppeteerViewport,
+      headless: true
+    })
+    browser.on('disconnected', () => {
+      browser = null
+    })
+  }
   // Force https
   originalUrl = 'https://' + url.hostname + url.pathname
   const domain = tldParser(url.origin).domain
@@ -172,9 +167,15 @@ module.exports = async function (originalUrl) {
     quality: 90
   })
 
-  // Close browser
-  await browser.close()
+  await page.close()
 
   return infos
 }
+
+module.exports = analyze
 module.exports.ERROR_CODES = ERROR_CODES
+module.exports.close = async function () {
+  if (browser) {
+    await browser.close()
+  }
+}

src/utils.js

@@ -61,3 +61,51 @@ exports.isCrawlable = async function (htmlHeaders) {
 
   return tag ? !patterns.test(tag) : true
 }
+
+// From https://github.com/alixaxel/chrome-aws-lambda/blob/master/source/index.js#L83
+exports.puppeteerArgs = [
+  '--autoplay-policy=user-gesture-required',
+  '--disable-background-networking',
+  '--disable-background-timer-throttling',
+  '--disable-backgrounding-occluded-windows',
+  '--disable-breakpad',
+  '--disable-client-side-phishing-detection',
+  '--disable-component-update',
+  '--disable-default-apps',
+  '--disable-dev-shm-usage',
+  '--disable-domain-reliability',
+  '--disable-extensions',
+  '--disable-features=AudioServiceOutOfProcess',
+  '--disable-hang-monitor',
+  '--disable-ipc-flooding-protection',
+  '--disable-notifications',
+  '--disable-offer-store-unmasked-wallet-cards',
+  '--disable-popup-blocking',
+  '--disable-print-preview',
+  '--disable-prompt-on-repost',
+  '--disable-renderer-backgrounding',
+  '--disable-setuid-sandbox',
+  '--disable-speech-api',
+  '--disable-sync',
+  '--disk-cache-size=33554432',
+  '--hide-scrollbars',
+  '--ignore-gpu-blacklist',
+  '--metrics-recording-only',
+  '--mute-audio',
+  '--no-default-browser-check',
+  '--no-first-run',
+  '--no-pings',
+  '--no-sandbox',
+  '--no-zygote',
+  '--password-store=basic',
+  '--use-gl=swiftshader',
+  '--use-mock-keychain'
+]
+exports.puppeteerViewport = {
+  deviceScaleFactor: 1,
+  hasTouch: false,
+  height: 1080,
+  isLandscape: true,
+  isMobile: false,
+  width: 1920,
+}