Introducción

Cuando se trabaja con marcos de pruebas de un extremo a otro como Playwright, manejar solicitudes de red suele ser una tarea compleja. Las pruebas que dependen de API externas pueden ser lentas e inconsistentes, lo que introduce errores innecesarios. Las llamadas de red que tienen éxito en una ejecución de prueba pueden fallar en la siguiente debido a un servidor lento o poco confiable, lo que genera resultados inconsistentes. Para solucionar este problema, los desarrolladores suelen recurrir a solicitudes de red simuladas, lo que introduce otro desafío: gestionar simulaciones.

¿No sería fantástico tener una forma automatizada de manejar el almacenamiento en caché y la reutilización de las respuestas de la red sin configurar estrategias complejas de burla? Investigué enfoques existentes y desarrollé una herramienta que quiero presentar. Resuelve exactamente estos problemas almacenando en caché las solicitudes de red en el sistema de archivos, lo que permite pruebas de Playwright más rápidas y confiables.

El problema con las solicitudes de red en las pruebas

Las solicitudes de red suelen ser la parte más lenta de la ejecución de la prueba. Cuando se ejecutan varios conjuntos de pruebas, las consultas repetidas de API externas pueden aumentar drásticamente la duración de las pruebas. Además, las API del mundo real pueden ser inestables, con tiempos de espera ocasionales, lo que hace que sus pruebas sean frágiles y poco confiables.

Un enfoque común para mitigar esto es simular las respuestas de la API. Si bien es útil, la burla requiere intervención manual: es necesario crear cuidadosamente respuestas simuladas, mantenerlas actualizadas y asegurarse de que se manejen todos los escenarios potenciales de la red. Esto puede convertirse en una enorme carga de mantenimiento a medida que la API evoluciona o cambian los casos de prueba. Playwright admite archivos HAR para capturar y reproducir el tráfico de red, pero trabajar con HAR puede ser tedioso y carece de flexibilidad para modificar las respuestas sobre la marcha.

Ingrese dramaturgo-red-cache

playwright-network-cache está diseñado para agilizar el proceso de almacenamiento en caché de las respuestas de la red en las pruebas de Playwright, eliminando la necesidad de simulaciones manuales o archivos HAR rígidos. Con esta biblioteca, las respuestas de la red se almacenan automáticamente en el sistema de archivos durante la primera ejecución de la prueba y se pueden reutilizar en ejecuciones posteriores, lo que acelera significativamente la ejecución de la prueba. Además, las respuestas se guardan en una estructura de carpetas clara y organizada, lo que facilita su inspección y modificación según sea necesario.

Cómo resuelve el problema

1. Almacenamiento en caché automático: la biblioteca almacena en caché automáticamente las respuestas de la red cuando se ejecutan las pruebas por primera vez. Esto significa que sus pruebas no tendrán que esperar a que las API externas respondan en ejecuciones futuras; en su lugar, se utilizarán los datos almacenados en caché, lo que dará como resultado pruebas más rápidas y confiables.

2. Modificaciones dinámicas: ¿Necesita modificar una respuesta para un caso de prueba específico? playwright-network-cache le permite modificar dinámicamente las respuestas almacenadas en caché. Ya sea que desee cambiar el código de estado, los encabezados o el cuerpo de la respuesta, la biblioteca brinda opciones para ajustar los datos almacenados en caché sobre la marcha sin mantener manualmente simulacros separados.

3. Estructura flexible: el sistema de almacenamiento en caché organiza los archivos según el nombre de host, el método de solicitud y la ruta URL, lo que garantiza que pueda navegar y administrar fácilmente los datos almacenados en caché. Para casos más complejos, incluso puede dividir los archivos de caché por parámetros de consulta de solicitud, cuerpos de solicitud u otros campos personalizados, lo que garantiza una flexibilidad total en la forma en que se almacenan y reutilizan los datos.

4. Aumento de velocidad: al reutilizar las respuestas almacenadas en caché, sus pruebas ya no necesitan esperar a que se completen las llamadas de red, lo que las hace dramáticamente más rápidas. Esto es especialmente útil cuando se trabaja con grandes conjuntos de pruebas o cuando se ejecutan pruebas en entornos de CI donde la velocidad es crítica.

5. No más simulacros: Olvídate de mantener simulacros manualmente. La biblioteca se encarga de todo por usted, desde el almacenamiento en caché hasta la reproducción e incluso la modificación de las respuestas. Ya no necesitarás crear manualmente respuestas simuladas para cada escenario de prueba y podrás concentrarte más en la lógica de tu prueba.

6. Sin complejidad HAR: Los archivos HAR pueden ser útiles para grabar y reproducir interacciones de red, pero rápidamente se vuelven engorrosos, especialmente cuando es necesario modificar las respuestas. playwright-network-cache proporciona una alternativa más limpia y flexible a HAR al permitirle administrar respuestas individuales como archivos JSON simples.

Ejemplo

Imagina que estás probando una aplicación que obtiene una lista de gatos de una API. Sin el almacenamiento en caché, cada ejecución de prueba requeriría una solicitud en vivo a la API, lo que agregaría latencia y posibles puntos de falla a sus pruebas.

Con playwright-network-cache, puedes almacenar en caché fácilmente la respuesta de la API:

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

En la primera ejecución, la respuesta se almacena en caché en el directorio .network-cache, con una estructura como esta:

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

En ejecuciones posteriores, la respuesta almacenada en caché se reutiliza, lo que hace que la prueba sea más rápida y elimina la necesidad de acceder a la API real.

Puedes modificar la respuesta almacenada en caché para las necesidades de prueba particulares:

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 que la variable cacheRoute esté disponible en tus pruebas, crea una instancia como cualquier otro dispositivo de 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);
  },
});

Hay muchos otros ejemplos y casos de uso en la documentación de la biblioteca.

Más que solo almacenamiento en caché

playwright-network-cache no se trata solo de almacenamiento en caché. Ofrece funciones avanzadas como:

• Modificación de respuestas: ajusta dinámicamente los datos de las respuestas almacenadas en caché utilizando funciones personalizadas.
• Manejo de códigos de estado: respuestas en caché basadas en códigos de estado HTTP específicos, incluidos los errores.
• Estructura de directorio flexible: personaliza cómo y dónde se almacenan los archivos de caché, lo que te permite adaptar las estrategias de almacenamiento en caché a tus necesidades.
• Deshabilitar o actualizar caché: deshabilite temporalmente el almacenamiento en caché para pruebas específicas o fuerce actualizaciones al caché cuando sea necesario.

Con estas poderosas capacidades, puedes controlar con precisión cómo se administran las solicitudes de red en tus pruebas.

Resumen

Si buscas que tus pruebas de Playwright sean más rápidas y confiables, prueba playwright-network-cache. Al almacenar en caché las respuestas de la red en el sistema de archivos y permitir modificaciones dinámicas, elimina la necesidad de simulaciones manuales y proporciona una alternativa flexible y fácil de usar a los archivos HAR.

Gracias por leer ❤️