@browserless/lighthouse 9.8.4 → 9.9.2

package/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright © 2019 Microlink <hello@microlink.io> (microlink.io)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -16,6 +16,10 @@ Using npm:
 npm install @browserless/lighthouse --save
 ```
 
+## Usage
+
+See [browseress#lighthouse](https://browserless.js.org/#/?id=runing-lighthouse).
+
 ## License
 
 **@browserless/lighthouse** © [Microlink](https://microlink.io), released under the [MIT](https://github.com/microlinkhq/browserless/blob/master/LICENSE.md) License.<br>

package/package.json

@@ -2,7 +2,7 @@
   "name": "@browserless/lighthouse",
   "description": "Browserless Lighthouse integration using puppeteer.",
   "homepage": "https://browserless.js.org",
-  "version": "9.8.4",
+  "version": "9.9.2",
   "main": "src",
   "repository": {
     "type": "git",
@@ -24,14 +24,10 @@
     "stats"
   ],
   "dependencies": {
-    "@browserless/errors": "^9.8.4",
-    "debug-logfmt": "~1.0.4",
-    "lighthouse": "~9.6.8",
-    "p-retry": "~4.6.1",
-    "p-timeout": "~4.1.0",
-    "serialize-error": "~8.1.0"
+    "lighthouse": "~10.0.0"
   },
   "devDependencies": {
+    "@browserless/test": "^9.7.2",
     "ava": "3",
     "browserless": "latest"
   },
@@ -50,5 +46,5 @@
     "timeout": "30s",
     "verbose": true
   },
-  "gitHead": "cd2a76f7ffaa3fbe676796b8777debe9a65d1961"
+  "gitHead": "77201bfd691e447ebd5580a8466fe77a82a039d2"
 }

package/src/get-config.js

@@ -0,0 +1,14 @@
+'use strict'
+
+const preset = name =>
+  name
+    ? import(`lighthouse/core/config/${name}-config.js`)
+      .then(mod => mod.default)
+      .catch(() => undefined)
+    : undefined
+
+module.exports = async ({ preset: presetName, ...settings } = {}) => {
+  const config = (await preset(presetName)) || { extends: 'lighthouse:default' }
+  if (Object.keys(settings).length > 0) config.settings = { ...config.settings, ...settings }
+  return config
+}

package/src/index.js

@@ -1,76 +1,20 @@
 'use strict'
 
-const { ensureError, browserTimeout } = require('@browserless/errors')
-const debug = require('debug-logfmt')('browserless:lighthouse')
-const pTimeout = require('p-timeout')
-const pRetry = require('p-retry')
-
 const lighthouse = require('./lighthouse')
+const getConfig = require('./get-config')
 
-const { AbortError } = pRetry
-
-const getConfig = ({ preset: presetName, ...settings } = {}) => {
-  const baseConfig = presetName
-    ? require(`lighthouse/lighthouse-core/config/${presetName}-config.js`)
-    : { extends: 'lighthouse:default' }
-
-  return { ...baseConfig, settings: { ...baseConfig.settings, ...settings } }
-}
-
-// See https://github.com/GoogleChrome/lighthouse/blob/master/docs/readme.md#configuration
-const getFlags = (
-  browser,
-  { disableStorageReset = true, logLevel = 'error', output = 'json' }
-) => ({
-  disableStorageReset,
-  logLevel,
-  output,
-  port: new URL(browser.wsEndpoint()).port
-})
+module.exports = getBrowserless => async (url, { output = 'json', timeout, ...opts } = {}) => {
+  let teardown
+  const browserless = await getBrowserless(fn => (teardown = fn))
 
-module.exports = async (
-  url,
-  {
-    disableStorageReset,
-    getBrowserless = require('browserless'),
-    logLevel,
-    output,
-    retry = 2,
-    timeout = 30000,
-    ...opts
-  } = {}
-) => {
-  const browserlessPromise = getBrowserless()
-  const config = getConfig(opts)
-  let isRejected = false
-
-  async function run () {
-    const browserless = await browserlessPromise
-    const browser = await browserless.browser()
-    const flags = await getFlags(browser, { disableStorageReset, logLevel, output })
-    const { value, reason, isFulfilled } = await lighthouse({ url, flags, config })
-    if (isFulfilled) return value
-    throw ensureError(reason)
-  }
-
-  const task = () =>
-    pRetry(run, {
-      retries: retry,
-      onFailedAttempt: async error => {
-        if (error.name === 'AbortError') throw error
-        if (isRejected) throw new AbortError()
-        await (await browserlessPromise).respawn()
-        const { message, attemptNumber, retriesLeft } = error
-        debug('retry', { attemptNumber, retriesLeft, message })
-      }
+  const fn = page => async () =>
+    lighthouse({
+      config: await getConfig({ ...opts, output }),
+      page,
+      url
     })
 
-  const result = await pTimeout(task(), timeout, () => {
-    isRejected = true
-    throw browserTimeout({ timeout })
-  })
-
+  const result = await browserless.withPage(fn, { timeout })()
+  if (teardown) await teardown()
   return result
 }
-
-module.exports.getConfig = getConfig

package/src/lighthouse.js

@@ -1,23 +1,8 @@
 'use strict'
 
-const { serializeError } = require('serialize-error')
-const lighthouse = require('lighthouse')
+const lighthouse = require('lighthouse/core/index.cjs')
 
-module.exports = async ({ url, flags, config }) => {
-  try {
-    const { lhr, report } = await lighthouse(url, flags, config)
-    const value = flags.output === 'json' ? lhr : report
-
-    return {
-      isFulfilled: true,
-      isRejected: false,
-      value
-    }
-  } catch (error) {
-    return {
-      isFulfilled: false,
-      isRejected: true,
-      reason: serializeError(error)
-    }
-  }
+module.exports = async ({ url, config, page }) => {
+  const { lhr, report } = await lighthouse(url, undefined, config, page)
+  return config.settings.output === 'json' ? lhr : report
 }