lcrespilho / playwright-utils

Coleção de funções utilitárias que utilizo frequentemente com o Playwright

Functions

flatRequestUrl(req) ⇒ *

Returns a flattened request URL by combining the URL and postData parameters of the given Request object.

flatResponseUrl(res) ⇒ *

Returns a flattened request URL from Response object, by combining the URL and postData parameters of the given Response's Request object.

requestMatcher(pattern)

Accepts a pattern, and returns a function that returns true if a request is matched by the pattern.

responseMatcher(pattern)

Accepts a pattern, and returns a function that returns true if a response is matched by the pattern.

requestMatcherCb(pattern, cb)

Accepts a pattern and a callback function, and returns a function that returns true if a request is matched by the pattern, and executes the callback with the request object as parameter.

responseMatcherCb(pattern, cb)

Accepts a pattern and a callback function, and returns a function that returns true if a response is matched by the pattern, and executes the callback with the response object as parameter.

saveSessionCookies(context, key, [expires])

Salva os cookies do contexto no Glitch.

restoreSessionCookies(context, key)

Restaura, no contexto do browser, os cookies previamente salvos no Glitch.

previewGTM(context, tagAssistantUrl)

Realiza preview do GTM. Deve ser utilizada via test.beforeEach ou no próprio test.

enableGADebug()

Simula a extensão Google Analytics Debugger (https://chrome.google.com/webstore/detail/jnkmfdileelhofjcijamephohjechhna), habilitando debug de GA3 (analytics.js) e GA4 (gtag).

scrollToBottom()

Realiza scroll até o fundo da página, suavemente.

flatRequestUrl(req) ⇒ *

Returns a flattened request URL by combining the URL and postData parameters of the given Request object.

Kind: global function
Returns: * - {string} A string representing the flattened request URL.

Param	Type	Description
req	Request	The Request object containing the URL and postData.

flatResponseUrl(res) ⇒ *

Returns a flattened request URL from Response object, by combining the URL and postData parameters of the given Response's Request object.

Kind: global function
Returns: * - {string} A string representing the flattened request URL.

Param	Type	Description
res	Response	A Response object

requestMatcher(pattern)

Accepts a pattern, and returns a function that returns true if a request is matched by the pattern.

Kind: global function

Param	Description
pattern	pattern to match the request URL.

responseMatcher(pattern)

Accepts a pattern, and returns a function that returns true if a response is matched by the pattern.

Kind: global function

Param	Description
pattern	pattern to match the response URL.

requestMatcherCb(pattern, cb)

Accepts a pattern and a callback function, and returns a function that returns true if a request is matched by the pattern, and executes the callback with the request object as parameter.

Kind: global function

Param	Description
pattern	pattern to match the request URL.
cb	Callback function that will be executed after if the request is matched.

responseMatcherCb(pattern, cb)

Accepts a pattern and a callback function, and returns a function that returns true if a response is matched by the pattern, and executes the callback with the response object as parameter.

Kind: global function

Param	Description
pattern	Pattern to match the request URL.
cb	Callback function that will be executed after if the request is matched.

saveSessionCookies(context, key, [expires])

Salva os cookies do contexto no Glitch.

Kind: global function

Param	Type	Description
context	BrowserContext	Contexto do browser.
key	string	Nome da sessão no Glitch, usado para resgatar a sessão.
[expires]	number	tempo em s para guardar a sessão remotamente. Default 48h.

Example

import { saveSessionCookies, restoreSessionCookies } from '../../utils/helpers';
// antes de começar o teste, restaura a sessão anterior, se houver.
test.beforeEach(async ({ context }) => {
  await restoreSessionCookies(context, 'session-123');
});
// após o teste, salva a sessão atual, para que possa ser restaurada posteriormente.
test.afterEach(async ({ context }) => {
  await saveSessionCookies(context, 'session-123', 2 * 60 * 60);
});

restoreSessionCookies(context, key)

Restaura, no contexto do browser, os cookies previamente salvos no Glitch.

Kind: global function

Param	Type	Description
context	BrowserContext	Contexto do browser.
key	string	Nome da sessão no Glitch, usado para resgatar a sessão.

Example

import { saveSessionCookies, restoreSessionCookies } from '../../utils/helpers';
// antes de começar o teste, restaura a sessão anterior, se houver.
test.beforeEach(async ({ context }) => {
  await restoreSessionCookies(context, 'session-123');
});
// após o teste, salva a sessão atual, para que possa ser restaurada posteriormente.
test.afterEach(async ({ context }) => {
  await saveSessionCookies(context, 'session-123', 2 * 60 * 60);
});

previewGTM(context, tagAssistantUrl)

Realiza preview do GTM. Deve ser utilizada via test.beforeEach ou no próprio test.

Kind: global function

Param	Type	Description
context	BrowserContext	Contexto do browser.
tagAssistantUrl	string	url completa de preview do Tag Assistant.

Example

test.beforeEach(async ({ context }) => {
  await previewGTM(context, 'https://tagassistant.google.com/#/?source=TAG_MANAGER&id=GTM-123&gtm_auth=456&gtm_preview=env-913&cb=1051629219902535');
});

enableGADebug()

Simula a extensão Google Analytics Debugger (https://chrome.google.com/webstore/detail/jnkmfdileelhofjcijamephohjechhna), habilitando debug de GA3 (analytics.js) e GA4 (gtag).

Kind: global function

scrollToBottom()

Realiza scroll até o fundo da página, suavemente.

Kind: global function

---

Como criar pacotes NPM

https://www.youtube.com/watch?v=Nh9xW2-ZOEU