2848073902

Build Type

github

Committed by GitHub

Commit Message

<a href="https://github.com/microlinkhq/browserless/commit/<a class=hub.com/microlinkhq/browserless/commit/61d5ec61d119a6f262d59a5c3ab1c8cbe4530939">61d5ec61d<a href="https://github.com/microlinkhq/browserless/commit/61d5ec61d119a6f262d59a5c3ab1c8cbe4530939">">Merge </a><a class="double-link" href="https://github.com/microlinkhq/browserless/commit/<a class="double-link" href="https://github.com/microlinkhq/browserless/commit/2b7cdaa7bbd08e356d2a9887a9576a9d63984ff9">2b7cdaa7b</a>">2b7cdaa7b</a><a href="https://github.com/microlinkhq/browserless/commit/61d5ec61d119a6f262d59a5c3ab1c8cbe4530939"> into e29ac9d5b">e29ac9d5b</a>

Pull Request Pull Request #404: fix(browserless): pass context options

Run Details

240 of 286 branches covered (83.92%)

Branch coverage included in aggregate %.

8 of 8 new or added lines in 1 file covered. (100.0%)

1468 of 2090 relevant lines covered (70.24%)

177.13 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

96.48

/packages/browserless/src/index.js

'use strict'

const { ensureError, browserTimeout } = require('@browserless/errors')
const createScreenshot = require('@browserless/screenshot')
const debug = require('debug-logfmt')('browserless')
const createGoto = require('@browserless/goto')
const createPdf = require('@browserless/pdf')
const { withLock } = require('superlock')
const pReflect = require('p-reflect')
const pTimeout = require('p-timeout')
const pRetry = require('p-retry')

const { AbortError } = pRetry

const driver = require('./driver')

const lock = withLock()

module.exports = ({ timeout: globalTimeout = 30000, ...launchOpts } = {}) => {
  const goto = createGoto({ timeout: globalTimeout, ...launchOpts })
  const { defaultViewport } = goto

  let isClosed = false

  const close = opts => {
    isClosed = true
    return browserProcessPromise.then(browserProcess => driver.close(browserProcess, opts))
  }

  const respawn = () =>
    !isClosed &&
    Promise.all([
      browserProcessPromise.then(driver.close),
      (browserProcessPromise = spawn({ respawn: true }))
    ])

  const spawn = ({ respawn: isRespawn = false } = {}) => {
    const promise = driver.spawn({
      defaultViewport,
      handleSIGINT: false,
      handleSIGTERM: false,
      handleSIGHUP: false,
      timeout: globalTimeout,
      ...launchOpts
    })

    promise.then(async browser => {
      browser.once('disconnected', getBrowser)
      debug('spawn', {
        respawn: isRespawn,
        pid: driver.pid(browser) || launchOpts.mode,
        version: await browser.version()
      })
    })

    return promise
  }

  let browserProcessPromise = spawn()

  const createBrowserContext = contextOpts =>
    getBrowser().then(browser => browser.createIncognitoBrowserContext(contextOpts))

  const getBrowser = async () => {
    if (isClosed) return browserProcessPromise

    const browserProcess = await lock(async () => {
      const browserProcess = await browserProcessPromise
      if (browserProcess.isConnected()) return browserProcess
      respawn()
    })

    return browserProcess || getBrowser()
  }

  const createContext = async ({ retry = 2, timeout: contextTimeout, ...contextOpts } = {}) => {
    let _contextPromise = createBrowserContext(contextOpts)

    const getBrowserContext = () => _contextPromise

    getBrowserContext().then(context => {
      const browserProcess = context.browser()
      browserProcess.once('disconnected', async () => {
        await getBrowser()
        _contextPromise = createBrowserContext(contextOpts)
      })
    })

    const createPage = async () => {
      const [browserProcess, browserContext] = await Promise.all([
        getBrowser(),
        getBrowserContext()
      ])
      const page = await browserContext.newPage()
      debug('createPage', { pid: driver.pid(browserProcess), id: browserContext._id })
      return page
    }

    const closePage = async page => {
      if (page && !page.isClosed()) {
        const [browserProcess, browserContext] = await Promise.all([
          getBrowser(),
          getBrowserContext(),
          pReflect(page.close())
        ])
        debug('closePage', { pid: driver.pid(browserProcess), id: browserContext._id })
      }
    }

    const wrapError = (fn, { timeout: evaluateTimeout } = {}) => async (...args) => {
      let isRejected = false

      async function run () {
        let page

        try {
          page = await createPage(args)
          setTimeout(() => closePage(page), timeout)
          const value = await fn(page)(...args)
          await closePage(page)
          return value
        } catch (error) {
          await closePage(page)
          if (!isRejected) throw ensureError(error)
        }
      }

      const task = () =>
        pRetry(run, {
          retries: retry,
          onFailedAttempt: async error => {
            debug('onFailedAttempt', { name: error.name, code: error.code, isRejected })
            if (error.name === 'AbortError') throw error
            if (isRejected) throw new AbortError()
            if (error.code === 'EBRWSRCONTEXTCONNRESET') {
              _contextPromise = createBrowserContext(contextOpts)
            }
            const { message, attemptNumber, retriesLeft } = error
            debug('retry', { attemptNumber, retriesLeft, message })
          }
        })

      const timeout = evaluateTimeout || contextTimeout || globalTimeout

      return pTimeout(task(), timeout, () => {
        isRejected = true
        throw browserTimeout({ timeout })
      })
    }

    const evaluate = (fn, gotoOpts) =>
      wrapError(
        page => async (url, opts) => {
          const { response, error } = await goto(page, { url, ...gotoOpts, ...opts })
          return fn(page, response, error)
        },
        gotoOpts
      )

    const destroyContext = async () => {
      const [browserProcess, browserContext] = await Promise.all([
        getBrowser(),
        getBrowserContext()
      ])
      const id = browserContext._id
      await pReflect(browserContext.close())

      debug('destroyContext', { pid: driver.pid(browserProcess), id })
    }

    return {
      respawn,
      context: getBrowserContext,
      browser: getBrowser,
      evaluate,
      goto,
      html: evaluate(page => page.content(), { animations: true }),
      page: createPage,
      pdf: wrapError(createPdf({ goto })),
      screenshot: wrapError(createScreenshot({ goto })),
      text: evaluate(page => page.evaluate(() => document.body.innerText)),
      getDevice: goto.getDevice,
      destroyContext
    }
  }

  return { createContext, respawn, browser: getBrowser, close }
}

module.exports.driver = driver

1	'use strict'	10✔
2		10✔
3	const { ensureError, browserTimeout } = require('@browserless/errors')	10✔
4	const createScreenshot = require('@browserless/screenshot')	10✔
5	const debug = require('debug-logfmt')('browserless')	10✔
6	const createGoto = require('@browserless/goto')	10✔
7	const createPdf = require('@browserless/pdf')	10✔
8	const { withLock } = require('superlock')	10✔
9	const pReflect = require('p-reflect')	10✔
10	const pTimeout = require('p-timeout')	10✔
11	const pRetry = require('p-retry')	10✔
12		10✔
13	const { AbortError } = pRetry	10✔
14		10✔
15	const driver = require('./driver')	10✔
16		10✔
17	const lock = withLock()	10✔
18		10✔
19	module.exports = ({ timeout: globalTimeout = 30000, ...launchOpts } = {}) => {	10✔
20	const goto = createGoto({ timeout: globalTimeout, ...launchOpts })	22✔
21	const { defaultViewport } = goto	22✔
22		22✔
23	let isClosed = false	22✔
24		22✔
25	const close = opts => {	22✔
26	isClosed = true	7✔
27	return browserProcessPromise.then(browserProcess => driver.close(browserProcess, opts))	7✔
28	}	7✔
29		22✔
30	const respawn = () =>	22✔
31	!isClosed &&	1✔
32	Promise.all([	1✔
33	browserProcessPromise.then(driver.close),	1✔
34	(browserProcessPromise = spawn({ respawn: true }))	1✔
35	])	1✔
36		22✔
37	const spawn = ({ respawn: isRespawn = false } = {}) => {	22✔
38	const promise = driver.spawn({	23✔
39	defaultViewport,	23✔
40	handleSIGINT: false,	23✔
41	handleSIGTERM: false,	23✔
42	handleSIGHUP: false,	23✔
43	timeout: globalTimeout,	23✔
44	...launchOpts	23✔
45	})	23✔
46		23✔
47	promise.then(async browser => {	23✔
48	browser.once('disconnected', getBrowser)	23✔
49	debug('spawn', {	23✔
50	respawn: isRespawn,	23✔
51	pid: driver.pid(browser) \|\| launchOpts.mode,	23✔
52	version: await browser.version()	23✔
53	})	23✔
54	})	23✔
55		23✔
56	return promise	23✔
57	}	23✔
58		22✔
59	let browserProcessPromise = spawn()	22✔
60		22✔
61	const createBrowserContext = contextOpts =>	22✔
62	getBrowser().then(browser => browser.createIncognitoBrowserContext(contextOpts))	44✔
63		22✔
64	const getBrowser = async () => {	22✔
65	if (isClosed) return browserProcessPromise	192!
66		192✔
67	const browserProcess = await lock(async () => {	192✔
68	const browserProcess = await browserProcessPromise	192✔
69	if (browserProcess.isConnected()) return browserProcess	192✔
70	respawn()	1✔
71	})	192✔
72		192✔
73	return browserProcess \|\| getBrowser()	192✔
74	}	192✔
75		22✔
76	const createContext = async ({ retry = 2, timeout: contextTimeout, ...contextOpts } = {}) => {	22✔
77	let _contextPromise = createBrowserContext(contextOpts)	43✔
78		43✔
79	const getBrowserContext = () => _contextPromise	43✔
80		43✔
81	getBrowserContext().then(context => {	43✔
82	const browserProcess = context.browser()	43✔
83	browserProcess.once('disconnected', async () => {	43✔
84	await getBrowser()	1✔
85	_contextPromise = createBrowserContext(contextOpts)	1✔
86	})	43✔
87	})	43✔
88		43✔
89	const createPage = async () => {	43✔
90	const [browserProcess, browserContext] = await Promise.all([	51✔
91	getBrowser(),	51✔
92	getBrowserContext()	51✔
93	])	51✔
94	const page = await browserContext.newPage()	51✔
95	debug('createPage', { pid: driver.pid(browserProcess), id: browserContext._id })	51✔
96	return page	51✔
97	}	51✔
98		43✔
99	const closePage = async page => {	43✔
100	if (page && !page.isClosed()) {	32✔
101	const [browserProcess, browserContext] = await Promise.all([	32✔
102	getBrowser(),	32✔
103	getBrowserContext(),	32✔
104	pReflect(page.close())	32✔
105	])	32✔
106	debug('closePage', { pid: driver.pid(browserProcess), id: browserContext._id })	32✔
107	}	32✔
108	}	32✔
109		43✔
110	const wrapError = (fn, { timeout: evaluateTimeout } = {}) => async (...args) => {	43✔
111	let isRejected = false	23✔
112		23✔
113	async function run () {	23✔
114	let page	32✔
115		32✔
116	try {	32✔
117	page = await createPage(args)	32✔
118	setTimeout(() => closePage(page), timeout)	32✔
119	const value = await fn(page)(...args)	32✔
120	await closePage(page)	23✔
121	return value	23✔
122	} catch (error) {	32✔
123	await closePage(page)	9✔
124	if (!isRejected) throw ensureError(error)	9✔
125	}	9✔
126	}	32✔
127		23✔
128	const task = () =>	23✔
129	pRetry(run, {	23✔
130	retries: retry,	23✔
131	onFailedAttempt: async error => {	23✔
132	debug('onFailedAttempt', { name: error.name, code: error.code, isRejected })	9✔
133	if (error.name === 'AbortError') throw error	9!
134	if (isRejected) throw new AbortError()	9!
135	if (error.code === 'EBRWSRCONTEXTCONNRESET') {	9!
136	_contextPromise = createBrowserContext(contextOpts)	×
137	}	×
138	const { message, attemptNumber, retriesLeft } = error	9✔
139	debug('retry', { attemptNumber, retriesLeft, message })	9✔
140	}	9✔
141	})	23✔
142		23✔
143	const timeout = evaluateTimeout \|\| contextTimeout \|\| globalTimeout	23✔
144		23✔
145	return pTimeout(task(), timeout, () => {	23✔
146	isRejected = true	×
147	throw browserTimeout({ timeout })	×
148	})	23✔
149	}	23✔
150		43✔
151	const evaluate = (fn, gotoOpts) =>	43✔
152	wrapError(	102✔
153	page => async (url, opts) => {	102✔
154	const { response, error } = await goto(page, { url, ...gotoOpts, ...opts })	29✔
155	return fn(page, response, error)	29✔
156	},	102✔
157	gotoOpts	102✔
158	)	102✔
159		43✔
160	const destroyContext = async () => {	43✔
161	const [browserProcess, browserContext] = await Promise.all([	42✔
162	getBrowser(),	42✔
163	getBrowserContext()	42✔
164	])	42✔
165	const id = browserContext._id	42✔
166	await pReflect(browserContext.close())	42✔
167		42✔
168	debug('destroyContext', { pid: driver.pid(browserProcess), id })	42✔
169	}	42✔
170		43✔
171	return {	43✔
172	respawn,	43✔
173	context: getBrowserContext,	43✔
174	browser: getBrowser,	43✔
175	evaluate,	43✔
176	goto,	43✔
177	html: evaluate(page => page.content(), { animations: true }),	43✔
178	page: createPage,	43✔
179	pdf: wrapError(createPdf({ goto })),	43✔
180	screenshot: wrapError(createScreenshot({ goto })),	43✔
181	text: evaluate(page => page.evaluate(() => document.body.innerText)),	43✔
182	getDevice: goto.getDevice,	43✔
183	destroyContext	43✔
184	}	43✔
185	}	43✔
186		22✔
187	return { createContext, respawn, browser: getBrowser, close }	22✔
188	}	22✔
189		10✔
190	module.exports.driver = driver	10✔

microlinkhq / browserless / 2848073902

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous