@lcrespilho/puppeteer-utils v1.82.0

Classes

Functions

Typedefs

PuppeteerVideoRecorder

Kind: global class

• PuppeteerVideoRecorder
  • new PuppeteerVideoRecorder()
  • instance
    • .screencastFrameHandler()
  • static
    • .PuppeteerVideoRecorder
      • new PuppeteerVideoRecorder(page, [label])
    • .PuppeteerVideoRecorder : Array.<Frame>
      • new PuppeteerVideoRecorder(page, [label])
    • .normalizeFrames(frames)

new PuppeteerVideoRecorder()

Utiliza ffmpeg para gravar a sessão.

Example

const record = new PuppeteerVideoRecorder(page, 'myRecord');
  await record.start();
  await page.goto(...);
  await record.stop();
  // será criado o arquivo myRecord.mp4 no diretório atual.

puppeteerVideoRecorder.screencastFrameHandler()

Listener para o evento 'Page.screencastframe'.

Kind: instance method of PuppeteerVideoRecorder
Pardam: puppeteer.Protocol.Page.ScreencastFrameEvent _

PuppeteerVideoRecorder.PuppeteerVideoRecorder

Kind: static class of PuppeteerVideoRecorder

new PuppeteerVideoRecorder(page, label)

Creates an instance of PuppeteerVideoRecorder.

PuppeteerVideoRecorder.PuppeteerVideoRecorder : Array.<Frame>

Kind: static property of PuppeteerVideoRecorder

new PuppeteerVideoRecorder(page, label)

Creates an instance of PuppeteerVideoRecorder.

PuppeteerVideoRecorder.normalizeFrames(frames)

Normaliza o array de Frame's realizando as seguintes ações: 1. transforma a propriedade timestamp, de float para natural, fazendo: - subtrai, de todos os timestamps, o timestamp do primeiro Frame. - divide todos os timestamps por 0.04s, que corresponde a 25fps: taxa escolhida para criar o vídeo de saída. 2. expande o array original, preenchendo os frames ausentes para formar um vídeo com 25fps. 3. adiciona 2s de repetição do último frame, para dar tempo de vê-lo antes do player fechar.

Kind: static method of PuppeteerVideoRecorder

Example

Entrada: [{frameBuffer: f1, timestamp: 10.6}, {frameBuffer: f2, timestamp: 10.68}, {frameBuffer: f3, timestamp: 10.76}]
  Saída: [{frameBuffer: f1, timestamp: 0}, {frameBuffer: f1, timestamp: 1}, {frameBuffer: f2, timestamp: 2}, {frameBuffer: f2, timestamp: 3}, {frameBuffer: f3, timestamp: 4}]

getFrameBlockTypes(page, site)

Verifica se o site do cliente bloqueia iframes same-origin ou other-origin, e se implementa Frame Busting.

Kind: global function

waitForNetworkIdle(page, timeout, maxInflightRequests) ⇒ Promise.<string>

Network-idle watcher. Wait until inflight requests <= maxInflightRequests for at least timeout ms. Returns the last seen resource. E.g.:

• waitForNetworkIdle(page, 500, 0), // equivalent to 'networkidle0'
• waitForNetworkIdle(page, 500, 2), // equivalent to 'networkidle2' https://github.com/GoogleChrome/puppeteer/issues/1353#issuecomment-356561654

Kind: global function
Returns: Promise.<string> - the last seen resource.

waitForEvent(page, event, timeout)

The methods page.waitForNavigation and frame.waitForNavigation wait for the page event domcontentloaded at minimum. This function returns a promise that resolves as soon as the specified page event happens.

Kind: global function

waitForRequestFinished(page, requestUrl, timeout)

The methods page.waitForNavigation and frame.waitForNavigation wait for the page event domcontentloaded at minimum. This function returns a promise that resolves as soon as the specified requestUrl resource has finished downloading, or timeout elapses.

Kind: global function

createFrame(page, frameName)

Cria um iframe novo e o retorna.

Kind: global function

waitForFrame(page, frameName, timeout) ⇒ Promise.<puppeteer.Frame> | Promise.<undefined>

Retorna uma promise que resolve com o primeiro frame que surgir em page com nome frameName. Aguarda no máximo timeout ms, ou infinito se timout for omitido.

Kind: global function

getPerformanceMetrics(page)

Retorna um objeto contendo algumas métricas importantes de performance. Como essa função retorna métricas de carregamento, é importante garantir que essa função só será chamada após a página terminar de carregar, preferencialmente por completo. Esta função não garante isso; quem tem que garantir é o código chamador.

Kind: global function

getRedirectChain(response) ⇒ Array.<string>

Retorna o chain de redirects de uma requisição fetch (qualquer recurso, não somente navegações).

Kind: global function
Returns: Array.<string> - Array de urls que participaram do chain de redirects. Se não teve redirects, retorna a url do response passado como argumento.

pageRedirectRequest(page, redirects, requestAlreadyHandled) ⇒

Cria redirect(s) 307.

Kind: global function
Returns: Retorna uma função que desativa o(s) redirect(s).

waitForSelector(page, selector)

Extensão ao método page.waitForSelector que aceita seletores AND (comma). Tem o funcionamento similar ao expect(page).toClick(selector, options) do pacote expect-puppeteer.

Kind: global function

emulateMobile(page)

Emula um mobile "Nexus 5X".

Kind: global function

emulateDesktop(page) ⇒ Promise.<any>

Emula um desktop 1800x900, userAgent Chrome 83.

Kind: global function

closeOtherPages(page) ⇒ Promise.<any>

Fecha todas as abas do BrowserContext de page passada como parâmetro, com exceção dela própria.

Kind: global function

closeAllOtherPages(page) ⇒ Promise.<any>

Fecha todas as abas do browser (de todos os contextos), com exceção de page passada como parâmetro.

Kind: global function

beaconizeCollectHits(page)

Transform POST collect requests into GET requests, in order to facilitate in matching its contents.

Kind: global function

defineDataLayerUtils(page)

Define dataModel and Observe dataLayer on the page.

Kind: global function

toMatchDatalayerObject(mockFn, expectObjectSubset)

Matcher para push de dataLayer. Uso: expect(mockFn).toMatchDatalayerObject({event: 'sendTransaction'})

Kind: global function

get(path)

Data Layer Model get method.

Kind: global function

set(path, value)

Data Layer Model set method.

Kind: global function

validateCollectEvent(category, action, label, value, regexesOrStrings)

Helper para validação de eventos de collects

Kind: global function

validateCollectEvent~predicate(req)

Kind: inner method of validateCollectEvent

redirect : Object

Regra de redirect.

Kind: global typedef
Properties

dlPushListener : function

Generic callback for dataLayer push.

Kind: global typedef

Frame : Object

Objeto contendo 1 Buffer representando o frame/imagem, e seu timestamp correspondente.

Kind: global typedef
Properties