Introdução

Ao trabalhar com estruturas de teste ponta a ponta como o Playwright, lidar com solicitações de rede costuma ser uma tarefa complexa. Os testes que dependem de APIs externas podem ser lentos e inconsistentes, introduzindo instabilidade desnecessária. As chamadas de rede bem-sucedidas em uma execução de teste poderão falhar na próxima devido a um servidor lento ou não confiável, resultando em resultados inconsistentes. Para resolver isso, os desenvolvedores muitas vezes recorrem a simulações de solicitações de rede, o que introduz outro desafio: gerenciar simulações.

Não seria ótimo ter uma maneira automatizada de lidar com o cache e a reutilização de respostas de rede sem configurar estratégias complexas de simulação? Investiguei as abordagens existentes e desenvolvi uma ferramenta que desejo apresentar. Ele resolve exatamente esses problemas armazenando em cache as solicitações de rede no sistema de arquivos, permitindo testes Playwright mais rápidos e confiáveis.

O problema com solicitações de rede em testes

As solicitações de rede costumam ser a parte mais lenta da execução do teste. Ao executar vários conjuntos de testes, a consulta repetida de APIs externas pode aumentar drasticamente a duração dos testes. Além disso, as APIs do mundo real podem ser instáveis, com intervalos ocasionais, tornando seus testes frágeis e não confiáveis.

Uma abordagem comum para mitigar isso é simular respostas da API. Embora útil, a simulação requer intervenção manual – você precisa construir cuidadosamente respostas simuladas, mantê-las atualizadas e garantir que cada cenário potencial de rede seja tratado. Isso pode se tornar um enorme fardo de manutenção à medida que a API evolui ou os casos de teste mudam. O Playwright oferece suporte a arquivos HAR para capturar e reproduzir o tráfego de rede, mas trabalhar com HAR pode ser tedioso e carece de flexibilidade para modificar respostas em tempo real.

Digite dramaturgo-rede-cache

playwright-network-cache foi projetado para agilizar o processo de armazenamento em cache de respostas de rede em testes do Playwright, eliminando a necessidade de simulações manuais ou arquivos HAR rígidos. Com esta biblioteca, as respostas da rede são armazenadas automaticamente no sistema de arquivos durante a primeira execução de teste e podem ser reutilizadas em execuções subsequentes, acelerando significativamente a execução do teste. Além disso, as respostas são salvas em uma estrutura de pastas clara e organizada, facilitando a inspeção e modificação conforme necessário.

Como isso resolve o problema

1. Cache Automático: A biblioteca armazena automaticamente em cache as respostas da rede quando os testes são executados pela primeira vez. Isso significa que seus testes não terão que esperar que APIs externas respondam em execuções futuras — os dados armazenados em cache serão usados, resultando em testes mais rápidos e confiáveis.

2. Modificações dinâmicas: precisa ajustar uma resposta para um caso de teste específico? playwright-network-cache permite modificar dinamicamente as respostas armazenadas em cache. Se você deseja alterar o código de status, os cabeçalhos ou o corpo da resposta, a biblioteca oferece opções para ajustar os dados armazenados em cache dinamicamente, sem manter manualmente simulações separadas.

3. Estrutura flexível: O sistema de cache organiza arquivos com base no nome do host, método de solicitação e caminho de URL, garantindo que você possa navegar e gerenciar facilmente os dados armazenados em cache. Para casos mais complexos, você pode até dividir arquivos de cache por parâmetros de consulta de solicitação, corpos de solicitação ou outros campos personalizados, garantindo total flexibilidade na forma como os dados são armazenados e reutilizados.

4. Speed ​​Boost: Ao reutilizar respostas armazenadas em cache, seus testes não precisam mais esperar a conclusão das chamadas de rede, tornando-os dramaticamente mais rápidos. Isso é especialmente útil ao trabalhar com grandes conjuntos de testes ou ao executar testes em ambientes de CI onde a velocidade é crítica.

5. No More Mock Hell: Esqueça a manutenção manual de simulações. A biblioteca cuida de tudo para você – desde o armazenamento em cache até a reprodução e até mesmo a modificação de respostas. Você não precisará mais criar respostas simuladas manualmente para cada cenário de teste e poderá se concentrar mais em sua lógica de teste.

6. Sem complexidade HAR: os arquivos HAR podem ser úteis para gravar e reproduzir interações de rede, mas rapidamente se tornam complicados, especialmente quando você precisa modificar respostas. playwright-network-cache fornece uma alternativa mais limpa e flexível ao HAR, permitindo gerenciar respostas individuais como arquivos JSON simples.

Exemplo

Imagine que você está testando um aplicativo que busca uma lista de gatos de uma API. Sem cache, cada execução de teste exigiria uma solicitação ativa à API, adicionando latência e possíveis pontos de falha aos seus testes.

Com playwright-network-cache, você pode facilmente armazenar em cache a resposta da API:

test('test', async ({ page, cacheRoute }) => {
  await cacheRoute.GET('https://example.com/api/cats');
  // Perform usual test actions...
});

Na primeira execução, a resposta é armazenada em cache no diretório .network-cache, com uma estrutura como esta:

.network-cache
└── example.com
    └── api-cats
        └── GET
            ├── headers.json
            └── body.json

Nas execuções subsequentes, a resposta armazenada em cache é reutilizada, tornando o teste mais rápido e eliminando a necessidade de acessar a API real.

Você pode modificar a resposta em cache para necessidades específicas de teste:

test('test', async ({ page, cacheRoute }) => {
  await cacheRoute.GET('https://example.com/api/cats', {
    modify: async (route, response) => {
      const json = await response.json();
      json[0].name = 'Kitty-1';
      await route.fulfill({ json });
    }
  });
  // Perform usual test actions...
});

Para obter a variável cacheRoute disponível em seus testes, instancie-a como qualquer outro acessório do Playwright:

// fixtures.js
import { test as base } from '@playwright/test';
import { CacheRoute } from 'playwright-network-cache';

export const test = base.extend({
  cacheRoute: async ({ page }, use) => {
    const cacheRoute = new CacheRoute(page, { /* cache options */ });
    await use(cacheRoute);
  },
});

Existem muitos outros exemplos e casos de uso na documentação da biblioteca.

Mais do que apenas cache

playwright-network-cache não se trata apenas de cache. Oferece recursos avançados como:

• Modificando respostas: ajuste os dados nas respostas armazenadas em cache dinamicamente usando funções personalizadas.
• Tratamento de códigos de status: armazena respostas em cache com base em códigos de status HTTP específicos, incluindo erros.
• Estrutura de diretório flexível: Personalize como e onde os arquivos de cache são armazenados, permitindo que você adapte estratégias de cache às suas necessidades.
• Desativar ou atualizar cache: desative temporariamente o cache para testes específicos ou force atualizações no cache quando necessário.

Com esses recursos poderosos, você pode controlar com precisão como as solicitações de rede são gerenciadas em seus testes.

Recapitular

Se você deseja tornar seus testes do Playwright mais rápidos e confiáveis, experimente o cache de rede do dramaturgo. Ao armazenar em cache as respostas da rede no sistema de arquivos e permitir modificações dinâmicas, elimina a necessidade de simulações manuais e fornece uma alternativa flexível e fácil de usar aos arquivos HAR.

Obrigado por ler ❤️