Cómo informar un buen error del navegador

Informar a los proveedores de navegadores sobre los problemas que encuentras en sus navegadores es una parte integral de mejorar la plataforma web.

Presentar un buen informe de error requiere un poco de trabajo. Tu objetivo debe ser facilitarles lo más posible a los ingenieros de navegadores encontrar lo que está roto, llegar a la causa raíz y, lo que es más importante, encontrar una forma de solucionarlo. Los errores que se resuelven rápido suelen ser fáciles de reproducir y tienen un comportamiento esperado claro.

Verifica que se trate de un error

El primer paso es determinar cuál debería ser el comportamiento "correcto".

¿Cuál es el comportamiento correcto?

Consulta los documentos de la API correspondientes en MDN o intenta encontrar especificaciones relacionadas. Esta información puede ayudarte a decidir qué API está dañada, dónde está dañada y cuál es el comportamiento esperado.

¿Funciona en otro navegador?

Por lo general, el comportamiento que difiere entre los navegadores se prioriza como un problema de interoperabilidad, en especial cuando el navegador que contiene el error es el que se destaca. Intenta realizar pruebas en las versiones más recientes de Chrome, Firefox, Safari y Edge, posiblemente con una herramienta como BrowserStack.

Si es posible, verifica que la página no se comporte de manera diferente de forma intencional debido a la detección del usuario-agente. En las Herramientas para desarrolladores de Chrome, intenta establecer la cadena User-Agent en otro navegador.

¿Se rompió en una versión reciente?

¿Esto funcionaba como se esperaba en el pasado, pero dejó de funcionar en una versión reciente del navegador? Estas regresiones se pueden corregir mucho más rápido, en especial si proporcionas un número de versión en el que funcionó y una versión en la que falló. Puedes usar herramientas como BrowserStack para verificar versiones anteriores del navegador. Usa herramientas como la herramienta bisect-builds (para Chromium) para buscar el cambio.

Si un problema es una regresión y se puede reproducir, por lo general, la causa raíz se puede encontrar y corregir con rapidez.

¿Otras personas tienen el mismo problema?

Si tienes problemas, es probable que otros desarrolladores también los tengan. Primero, intenta buscar el error en Stack Overflow. Esto puede ayudarte a traducir un problema abstracto en una API rota específica y a encontrar una solución alternativa a corto plazo hasta que se corrija el error.

¿Se informó antes?

Una vez que tengas una idea de cuál es el error, busca en la base de datos de errores del navegador para verificar si ya se informó.

Si encuentras un error existente que describa el problema, agrega tu apoyo destacándolo, agregándolo a favoritos o comentándolo. Además, en muchos sitios, puedes agregarte a la lista de CC y recibir actualizaciones cuando cambie el error.

Si decides comentar el error, incluye información sobre cómo afecta a tu sitio web. Evita agregar comentarios del estilo "+1", ya que los sistemas de seguimiento de errores suelen enviar correos electrónicos por cada comentario.

Informa el error

Si el error no se informó antes, es momento de informarlo al proveedor del navegador.

Crea un caso de prueba minimizado

Mozilla tiene un excelente artículo sobre cómo crear un caso de prueba minimizado. En resumen, si bien una descripción del problema es un excelente comienzo, lo mejor es proporcionar una demostración vinculada en el error que muestre el problema. Para maximizar las posibilidades de un progreso rápido, el ejemplo debe contener el mínimo código posible necesario para demostrar el problema. Una muestra de código mínima es lo más importante que puedes hacer para aumentar las probabilidades de que se corrija el error.

A continuación, se incluyen algunas sugerencias para minimizar un caso de prueba:

  • Descarga la página web, agrega <base href="https://original.url"> y verifica que el error exista de forma local. Esto puede requerir un servidor HTTPS activo si la URL usa HTTPS.
  • Prueba los archivos locales en las compilaciones más recientes de la mayor cantidad posible de navegadores.
  • Intenta condensar todo en 1 archivo.
  • Quita el código (comenzando por lo que sabes que es innecesario) hasta que desaparezca el error.
  • Usa el control de versiones para guardar tu trabajo y deshacer los cambios que salgan mal.

Aloja un caso de prueba reducido

Si buscas un buen lugar para alojar tu caso de prueba reducido, hay varias opciones disponibles:

Ten en cuenta que varios de esos sitios muestran contenido en un iframe, lo que puede hacer que las funciones o los errores se comporten de manera diferente.

Informa el problema

Una vez que tengas tu caso de prueba minimizado, podrás informar el error. Ve al sitio de seguimiento de errores correcto y crea un problema nuevo.

Agrega descripciones claras y pasos para replicar el problema.

Primero, proporciona una descripción clara para ayudar a los ingenieros a comprender rápidamente cuál es el problema y ayudar a clasificarlo.

When installing a PWA using the `beforeinstallprompt.prompt()`, the
`appinstalled` event fires before the call to `prompt()` resolves.

Luego, proporciona los pasos detallados necesarios para reproducir el problema y describe el resultado esperado y el real.

What is the expected result? In the console:
0. INSTALL: Available (logged when `beforeinstallprompt` event fired)
1. INSTALL_PROMPT_RESPONSE: {outcome: "accepted", platform: "web"}
   (logged when beforeinstallprompt.prompt()` resolves)
2. INSTALL: Success (logged when `appinstalled` event fired)

What is the actual result? In the console:
0. INSTALL: Available (logged when `beforeinstallprompt` event fired)
1. INSTALL: Success (logged when `appinstalled` event fired)
2. INSTALL_PROMPT_RESPONSE: {outcome: "accepted", platform: "web"}
   (logged when beforeinstallprompt.prompt()` resolves)

Para obtener más información, consulta los Lineamientos para escribir informes de errores en MDN.

Opcional: Agrega una captura de pantalla o una grabación de pantalla del problema

Aunque no es obligatorio, suele ser útil agregar una captura de pantalla o una grabación de pantalla del problema. Esto es especialmente útil cuando se producen errores después de varios pasos o de una actividad inusual. Las grabaciones y capturas de pantalla suelen mostrar mejor lo que sucedió a los ingenieros del navegador.

Incluye detalles del entorno

Algunos errores solo se pueden reproducir en ciertos sistemas operativos o en tipos específicos de pantallas (por ejemplo, con DPI bajo o alto). Asegúrate de incluir los detalles de los entornos de prueba que usaste.

Envía el error

Por último, envía el error. Revisa tu correo electrónico para ver las respuestas sobre el error. Por lo general, durante la investigación, los ingenieros pueden tener preguntas adicionales. Si tienen dificultades para reproducir el problema, es posible que se comuniquen contigo.