Saltar al contenido principal

Introducción

Genera errores de prueba (404, 500) bajo demanda para verificar que tus páginas de error se renderizan correctamente y lee el conteo de solicitudes API del proyecto.

Más información sobre la interfaz de usuario del módulo https://doc.oneentry.cloud/docs/category/system


🎯 ¿Qué hace este módulo?

El módulo System proporciona utilidades a nivel de sistema. Te permite probar el manejo de páginas de error - simular errores 404 y 500 para verificar que tus páginas de error se muestran correctamente antes de que los usuarios encuentren problemas reales - y expone getApiStat() para leer el conteo de solicitudes API del proyecto.

Los métodos de error (test404, test500) provocan una redirección a la página de error correspondiente para que puedas confirmar que tu manejo de errores está implementado correctamente. Úsalos durante el desarrollo y las pruebas, no en el código de producción.

🚀 Inicio Rápido

Inicializa el módulo desde defineOneEntry:


const { System } = defineOneEntry(
"your-project-url", {
"token": "your-app-token"
}
);

Lee el conteo de solicitudes API del proyecto:

// Returns an object with the API request count for the project.
const stat = await System.getApiStat();

console.log('API usage:', stat);

test404() y test500() lanzan errores intencionalmente para ejercitar tu manejo de errores, así que llámalos dentro de un try/catch:

try {
await System.test404();
} catch (error) {
// Your 404 handling runs here.
console.log('404 handler fired', error);
}

✨ Conceptos Clave

¿Qué es el Módulo System?

El módulo System proporciona utilidades de prueba y diagnóstico:

  • Pruebas de error - Simula errores 404 / 500 con test404() / test500()
  • Validación de páginas de error - Confirma que tus páginas de error personalizadas se renderizan
  • Uso de API - Lee el conteo de solicitudes API del proyecto con getApiStat()
  • Herramienta de desarrollo - Usa los métodos de error durante el desarrollo/pruebas, no en producción

Tipos de Error

Código de ErrorNombreCuándo OcurreCaso de Uso
404No EncontradoEl recurso solicitado no existePágina no encontrada, producto faltante
500Error Interno del ServidorOcurrió un error del lado del servidorFallo en la base de datos, error de código

Flujo de Trabajo de Pruebas

1. Develop custom 404 and 500 pages

2. Implement error handling (try/catch, error boundaries)

3. Trigger errors with System.test404() / System.test500()

4. Verify your error pages display correctly

5. Remove the test calls before deploying to production

📋 Lo Que Necesitas Saber

Los métodos de error son solo para pruebas

Usa test404() y test500() solo durante desarrollo y pruebas - lanzan errores para ejercitar tu lógica de manejo. Ejecútalos en desarrollo/entorno de pruebas, y elimina las llamadas de prueba antes de la producción. Los errores reales 404/500 deben ser manejados con tu propio try/catch y límites de error.

El registro y la monitorización son tu responsabilidad

El módulo System no registra ni monitorea errores. El registro y la monitorización deben estar en tu propia aplicación o herramientas de terceros - usa los métodos de prueba para provocar errores y así poder confirmar que tu seguimiento se activa.

Las páginas de error personalizadas son tuyas para construir

El módulo solo provoca errores; debes crear las páginas personalizadas 404 y 500 y la lógica de manejo en tu aplicación.


📊 Tabla de Referencia Rápida

MétodoDescripciónLanzaCaso de Uso
test404()Simula error 404 No Encontrado404 ErrorProbar página de error 404
test500()Simula error 500 del Servidor500 ErrorProbar página de error 500
getApiStat()Obtener el conteo de solicitudes APIMonitorear uso de API

❓ Preguntas Comunes (FAQ)

¿Cuándo debo usar los métodos de error?

Usa test404() y test500() solo durante el desarrollo y las pruebas para verificar que tus páginas de error funcionan correctamente. Nunca los uses en código de producción - son puramente una herramienta de prueba para validar el manejo de errores.


¿Cómo pruebo mis páginas de error personalizadas?

Llama a System.test404() o System.test500() en tu entorno de desarrollo, dentro de un try/catch. Estos métodos lanzan, activando tu lógica de manejo de errores para que puedas verificar que las páginas de error personalizadas se renderizan correctamente.


¿Cuál es la diferencia entre test404() y test500()?

test404() simula un error "No Encontrado" (el recurso no existe), mientras que test500() simula un "Error Interno del Servidor" (fallo del lado del servidor). Prueba ambos para asegurarte de que todos los escenarios de error se manejan correctamente.


¿Qué devuelve getApiStat()?

Devuelve un objeto con el conteo de solicitudes API del proyecto, útil para monitorear el uso de la API.


🎓 Mejores Prácticas

  • Usa los métodos de error solo en entornos de prueba - Nunca provoca errores de prueba en producción.
  • Envuelve las llamadas de prueba en try/catch - Tanto test404() como test500() lanzan intencionalmente.
  • Implementa páginas de error personalizadas - El módulo solo provoca errores; las páginas son tuyas para construir.
  • Verifica el seguimiento de errores - Usa los métodos de prueba para confirmar que tu monitoreo/registro se activa.
  • Elimina las llamadas de prueba antes del despliegue - Limpia las llamadas a test404() / test500() antes de la producción.

🔗 Documentación Relacionada