Skip to content

Home

Jump to bottom
Rodny Estrada edited this page Dec 4, 2025 · 1 revision

Welcome to the stressor wiki!

Wiki del Proyecto

📚 Contenido

🚀 Objetivo

Explicar de forma clara cómo usar, mantener y mejorar el proyecto.

Guía de instalación

  • Requisitos:

    • Node.js >= 16
    • pnpm o npm
    • (Opcional para Auditorías) Google Chrome instalado; puedes especificar su ruta vía la variable de entorno CHROME_PATH o el archivo .chromepath en la raíz del proyecto.

  • Instalación del paquete (como dependencia):

npm install stressor-core
# o
pnpm add stressor-core
  • Construcción local del proyecto (si vas a desarrollar en este repositorio):
pnpm install
pnpm build

Scripts disponibles: build (compila TypeScript) y prepublishOnly.

Manual de usuario

Stressor orquesta pruebas de carga (k6) y auditorías (Lighthouse) mediante adaptadores y un pipeline tipado.

Uso básico

import { Stressor } from 'stressor-core';

const stressor = new Stressor({
  name: 'mi-test',
  load: {
    scenario: {
      executor: 'ramping-vus',
      stages: [
        { duration: '30s', target: 10 },
        { duration: '1m', target: 50 },
      ],
    },
    options: {
      vus: 50,
      duration: '1m30s',
    },
  },
});

const report = await stressor.run();

Configuración completa (ejemplo)

{
  "id": "test-completo",
  "name": "Prueba Ecommerce",
  "load": {
    "scenario": {
      "executor": "constant-vus",
      "vus": 20,
      "duration": "5m"
    },
    "options": {
      "thresholds": {
        "http_req_duration": ["p(95)<500"]
      }
    }
  },
  "audit": {
    "url": "https://mi-sitio.com",
    "categories": ["performance", "seo"],
    "settings": {
      "formFactor": "desktop"
    }
  }
}

Adaptadores disponibles

  • Load (k6):

    • LoadAdapterConfig: scenario (uno o varios escenarios k6) y options (parámetros k6 como vus, iterations, duration, thresholds, etc.).
    • Genera LoadAdapterReport: métricas sanitizadas (por ejemplo, http_req_duration, puntos temporales y resumen).

  • Audit (Lighthouse):

    • AuditAdapterConfig: url obligatorio; categories (performance, seo, accessibility, best-practices); settings (formFactor, throttlingMethod, screenEmulation); chrome.chromePath opcional.
    • Genera AuditAdapterReport: puntajes por categoría y, opcionalmente, auditorías no perfectas cuando showAudits es true.

Pipeline y ejecución

  • AdapterPipeline permite registrar adaptadores y ejecutar en serie o paralelo (options.runInParallel).
  • Stressor.run(changes?) fusiona configuración (deepMerge) y ejecuta los trabajos definidos:
    • Forma corta: load y/o audit dentro de StressorConfig.
    • Forma larga: jobs como array con entradas { type: 'load' | 'audit', id, ...config }.

Consideraciones de entorno

  • Auditorías Lighthouse requieren Chrome; define la ruta con CHROME_PATH o .chromepath.
  • k6-node se usa para construir y ejecutar los escenarios; los resultados se exportan temporalmente en un .log JSON y se sanitizan.

Contribuciones

  • Flujo básico:

    • Haz un fork y crea una rama descriptiva.
    • Instala dependencias y compila: pnpm install y pnpm build.
    • Asegúrate de mantener el estilo del código: TypeScript, nombres claros, sin cambios innecesarios.
    • Añade pruebas o ejemplos cuando modifiques adaptadores o el pipeline.
    • Abre un Pull Request con una descripción clara del cambio.

  • Guías de código:

    • Evita complejidad innecesaria; corrige la raíz del problema.
    • No agregues cabeceras de licencia nuevas.
    • No uses variables de una sola letra.
    • Mantén las APIs públicas estables.

  • Entorno y compatibilidad:

    • Node >=16.
    • Verifica que Lighthouse y Chrome funcionen en tu sistema.

¡Gracias por contribuir! 🚀

Clone this wiki locally