Detectando estáticamente errores en aplicaciones de React con TypeScript y ESLint

en herramientas de análisis estático para JavaScript y TypeScript. Específicamente, trabajo en TypeScript ES, que te permite ejecutar ESLint en tu código TypeScript. También soy el autor del libro publicado recientemente por O'Reilly. Y sinceramente, React Debra Lynn, tengo algo de enojo dentro de mí. Tengo muchos problemas con la industria tecnológica, y ahora los van a escuchar. Como desarrolladores de software, nos hemos acostumbrado a que muchos de nuestros amigos y familiares nunca van a entender lo que hacemos. No nos gusta. No estamos de acuerdo con su falta de voluntad para aprender, pero algunas personas simplemente no pueden o no quieren entender las computadoras o incluso aprender a programar. Aquí hay una cita real de mis fantásticos y amorosos padres: no sabemos qué es el código TypeScript, pero estamos muy orgullosos de Josh y estamos seguros de que será un libro encantador. Refiriéndose, por supuesto, a Learning TypeScript, disponible en Amazon O'Reilly y otras tiendas, cómpralo hoy.

De acuerdo. La programación puede ser falsamente intimidante, el problema no es que el concepto de usar una computadora sea inusualmente difícil por sí solo, muchas personas pueden entender eso, es que muchas personas asumen incorrectamente que es difícil. Muchas personas que no son capaces en tecnología encuentran difícil imaginar el uso de una computadora en absoluto, incluso, Dios no lo quiera, incluso aprender a programar, y por lo tanto se sienten intimidados y desanimados. Una gran fuente del problema es que muchas personas crecieron acostumbradas a la idea de que las computadoras son difíciles, inventos imposibles de entender. Y luego tienen a un montón de personas gritándoles, oh, envía un archivo, abre Facebook, adjunta un archivo, presiona iniciar, lo que sea, eso es difícil. ¿Qué demonios? Y el problema empeora porque muchos desarrolladores, porque muchas personas, no explican bien temas técnicos o complejos. Es algo con lo que muchos de nosotros luchamos. Y una persona no técnica solo puede pasar por tantas explicaciones malas, descripciones complicadas, antes de decidir que el problema soy yo, simplemente nunca voy a entender esto.

Y que eso sea contexto para ustedes, mientras hablo de dos problemas, cambio de contexto y malas explicaciones, para el análisis estático, herramientas que analizan tu código sin ejecutarlo. Porque en paralelo, muchos desarrolladores de software experimentan esa misma intimidación falsa, incluso cuando ya han aprendido a programar, saben cómo usar computadoras, cuando intentan pensar en el análisis estático. Durante muchos años, se pensó que el análisis estático era solo competencia de académicos o ingenieros de lenguaje hardcore. Y cuando intentaron buscar recursos para el análisis estático, lo que obtuvieron fueron explicaciones teóricas de alto nivel, trucos académicos, cosas que son teóricas en lugar de introductorias y prácticas. Pero eso no es cierto. Tal vez nunca lo fue. Ciertamente no lo es ahora. El análisis estático no tiene por qué ser intimidante. El panorama del análisis estático hoy en día, especialmente para bases de código modernas de TypeScript, les prometo que es mucho más accesible de lo que nunca ha sido. Creo que encontrarán que los conceptos que les voy a presentar hoy son muy relevantes y aplicables para sus proyectos, e incluso podrían disfrutar usándolos cuando los

volvamos a trabajar en ellos. Así que este análisis estático es increíble, también conocido como detección estática de errores de aplicaciones React con TypeScript y ESLint. Conmigo, Josh Goldberg. Te mostraré cómo combinar ESLint y TypeScript permite detectar grandes cantidades de defectos y errores de aplicación, como código no utilizado o código asíncrono innecesario, a través de errores reales en tu código, que encontrarás antes de que tu aplicación se rompa misteriosamente solo para algunos usuarios en algunos momentos.

Empecemos. Primero, un poco de contexto sobre las propias herramientas, TypeScript y ESLint. ¿Por qué querrías mejorar las reglas de ESLint con TypeScript en primer lugar? ESLint solo ve la sintaxis cruda de tu código. Puede verificar problemas rudimentarios, como variables no utilizadas, violaciones de convenciones de nomenclatura, y así sucesivamente, pero realmente no entiende lo que ese código significa. TypeScript entiende lo que ese código significa. Hace una inmersión profunda en tu código, entiende tus tipos, entiende lo que todo debe ser, y luego tiene API que podemos usar en nuestras reglas de linting para tomar decisiones mucho más informadas basadas en esos tipos. Hoy te guiaré a través de algunos componentes que se parecen mucho a este ejemplo de mi botón, y vamos a jugar uno de mis juegos de programación favoritos, ¿Es esto seguro? Se supone que este componente debe recibir aproximadamente dos props, he ocultado todo lo que no es relevante. Acción e hijos, esta acción en particular es relevante e interesante, se supone que es una llamada de función entre dos registros en la consola. A primera vista, este código parece seguro, está bien, recibimos dos props, renderizamos los hijos, pasamos este callback de clic a un botón, todo está bien. Pero sin el profundo conocimiento de TypeScript sobre el sistema de tipos y este código, no tenemos forma de hacer linting sobre una gran cantidad de posibles problemas. Estamos confundidos. Tal vez las acciones asíncronas no están permitidas en esta aplicación. Tal vez la acción no siempre se proporciona. Si es una función en primer lugar, lo cual no sabemos, tal vez se supone que debe recibir argumentos. Tal vez realmente queremos manejar explícitamente las promesas rechazadas. Hay todo tipo de cosas que no podemos saber sin entender cuál es el tipo real de nuestro objeto. Cuáles son los tipos en nuestro código. Así que ahora vamos a hacer algunas comprobaciones de tipos. Usaremos TypeScript para analizar nuestro proyecto completo y entender los posibles tipos de objetos. Y luego haremos que esos tipos estén disponibles para las reglas de ESLint usando el complemento TypeScript ESLint. Ahora, si has configurado ESLint en código TypeScript antes, es probable que hayas hecho algo como esto. Has instalado el paquete analizador de TypeScript ESLint, que es el analizador que permite a ESLint y, dato curioso, también a Prettier, leer la sintaxis de TypeScript en tus archivos. Y tal vez también hayas instalado el complemento ESLint de TypeScript ESLint. El paquete que contiene un montón de reglas de linting adaptadas al código de TypeScript. Es posible que hayas configurado en tu archivo de configuración de ESLint, la configuración del analizador y el complemento. Si todo esto es nuevo para ti, dato curioso, así es como se hace. Pero hay otro paso que recomiendo que tomen muchos proyectos de código, que es extender las reglas recomendadas tanto del núcleo de ESLint como de TypeScript ESLint.

ESLint y TypeScript ESLint. Para la mayoría de los proyectos, generalmente se recomiendan las buenas reglas estándar recomendadas de ambos. El núcleo de ESLint habilita cosas en todo JavaScript, mientras que las reglas de TypeScript ESLint están adaptadas al código de TypeScript, y estas son excelentes piezas de información. Recomiendo usarlas. Pero, un detalle, no incluimos reglas que requieran información de tipos en los conjuntos de reglas recomendadas de TypeScript ESLint, porque solicitar información de tipos a TypeScript hace que tu linting tarde un poco más y requiere una configuración adicional, por lo que si deseas habilitar esas reglas, puedes extender el conjunto de reglas recomendadas que requieren comprobación de tipos, configurar y agregar la opción del analizador 'project' a tu configuración, apuntando a tu tsconfig. Esto permite que nuestras reglas de complemento sepan que ese es el tsconfig que se debe utilizar para obtener información de tipos y conocer las opciones del compilador de TypeScript. Bien, hemos terminado. Con cuatro configuraciones de proyecto y medio, estamos listos para ver algo de código. La demostración que vamos a ver hoy es de código abierto. No es necesario clonarlo para asistir a esta charla, pero si quieres seguir, puedes hacerlo. GitHub.com/JoshRoke-Goldberg/TypeScriptESLintReactDemo. También está disponible en TypeScriptESLintReactDemo.Vercel.app. Me encantan mis empleados de Vercel. Y es una aplicación create-next-app bastante rudimentaria. Solo tiene una página. Tenemos un estado de contador de llamadas y un estado de color personalizado, que se establecen en cero y sin definir, respectivamente. En esta página, tenemos algunos botones. Cuando hago clic en un botón, incremento el contador de llamadas y establezco un color personalizado en un color aleatorio, lo que también cambia el fondo de la página. Genial. La primera regla que voy a revisar es awaitAvailable. Desde typescript.io/rules/awaitAvailable, la página de documentación para esta regla. Si se utiliza la palabra clave await en un valor que no está disponible, el valor se resuelve directamente de inmediato. Si bien esto es válido en JavaScript, a menudo es un error del programador. Dato curioso, 'Available' se utiliza comúnmente como promesas. 'Available' es una descripción del tipo de promesas de la clase real. Aquí te muestro el ejemplo de código. En nuestra página de inicio, perdón, tenemos esta función aquí, esta acción de ejemplo, que crea una variable de color igual a un color aleatorio, incrementa el estado de contador de llamadas que se establece aquí en uno, establece el color como el estado de color personalizado y devuelve ese color. Esta función luego es utilizada por nuestros componentes await thenable. Ahora, await thenable recibe una acción y elementos secundarios, al igual que en mi ejemplo de botón, y establece un estado de ejecución en verdadero o falso.

antes y después de la acción. Y tiene este pequeño botón disabled igual a running que se refiere a ese fragmento de estado para que el botón esté deshabilitado mientras se ejecuta la acción. Para código asíncrono, esto es totalmente razonable, pero si volvemos a la demostración, nunca vemos que el botón esté deshabilitado. Entonces esto puede o no considerarse un error. Algunos simplemente lo llamarían código muerto, pero de cualquier manera, es un problema que debemos solucionar en nuestra aplicación. Y de hecho, estamos recibiendo una queja de nuestra regla de ESLint aquí. Tenemos la extensión de ESLint ejecutándose en VS Code. Await inesperado de un valor no promesa no ventable. Se queja de que mi acción está tipada como una función que devuelve void, lo que significa que ignoramos lo que devuelve. No nos importa. Pero lo estoy esperando, lo cual es incorrecto, porque no es una promesa. No está disponible. Entonces, si eliminara los awaits, el código debería seguir funcionando, y si voy a la demostración, incluso si actualizo. Sí, sigue viéndose bien. Porque ese await no hizo nada. De hecho, si uso el pequeño popover de la extensión aquí, puedo solucionarlo rápidamente, como nos dice la regla, para eliminar los awaits. Y luego, nuestra función async on click no tiene ninguna expresión await, me queja de otra regla de ESLint, impulsada por TypeScript, nuestra regla de require rate, que me informa que esta función ni siquiera necesita ser asíncrona en primer lugar, porque no hay ninguna llamada await en ella. E incluso puedo llevar esto un paso más allá al darme cuenta de que estoy estableciendo el estado en verdadero, llamando a una función de forma síncrona, y luego estableciendo el estado en falso. Entonces este estado ni siquiera es necesario en primer lugar. Puedo deshacerme completamente de mis estados. Siempre va a ser falso, lo que significa que el botón disabled igual a false ni siquiera necesita estar allí. Mi on click es una función que simplemente llama a la acción. Así que puedo simplificar el código a una línea dentro de la función. Boom. Increíble. Me encanta. Solo para asegurarme, volviendo a la demostración. Sí, todo aquí se ve bien. Genial. Ese es un ejemplo de tres en los que ESLint con TypeScript puede informarnos de información sorprendentemente profunda sobre los defectos del código.

¡Yay! Pero sigamos adelante. La siguiente regla que quiero analizar es la de no promesas flotantes. Mi regla favorita personal de ESLint. En la página de documentación, notarás que esta es una pauta. Todas nuestras reglas están bajo TypeScript. Una promesa flotante es aquella que se crea sin ningún código configurado para manejar errores en mi lanzamiento. Las promesas flotantes pueden causar varios problemas como operaciones desincronizadas incorrectas, rechazos de promesas ignorados y más.

Veremos ambas cosas en esta demostración. Primero, quiero mostrar una violación directa aquí en este botón que es un poco más avanzado que el anterior. Se supone que debe esperar un segundo antes de hacer cosas. Y aunque funciona bien si simplemente hacemos clic una vez, si hacemos clic varias veces la demostración no se rompe como debería. Si hacemos clic varias veces veremos que en realidad no se deshabilita. ¿Qué está sucediendo aquí? Bueno, en esta versión sin promesas flotantes, llamamos a esta acción de ejemplo asíncrona que espera un segundo antes de llamar a esa misma acción de ejemplo y olvidamos agregar el 'await' antes de la acción. Observa cómo en esta está tipada como una función que devuelve una promesa void. Perdón. Entonces, nuestro código en realidad no espera la función antes de establecer los estados. Así que obtenemos este bonito efecto de discoteca si hacemos clic varias veces. Y si habilitamos la regla de no promesas flotantes, simplemente desactivo eso en la configuración para que no obtengamos un subrayado inmediatamente en los otros archivos. Obtenemos esta queja agradable, las promesas deben ser una lista de cosas que puedes hacer, como esperarlas, debes esperarlas. Así que voy a agregar un 'await' aquí, lo que significa que ahora esperamos la acción antes de que se llame a 'running false' y sí, nuestro código está arreglado como antes. ¡Yay! Ahora, las promesas flotantes no son honestamente mi regla favorita porque puede detectar muchas cosas realmente intensas, pero es muy similar en teoría a la última de las tres reglas que quiero mostrarte, que es la de no promesas mal utilizadas. Esta regla prohíbe proporcionar promesas en ubicaciones lógicas como declaraciones 'if' en lugares donde el compilador de TypeScript las permite, pero no se manejan correctamente. Las promesas flotantes son aquellas que se crean y luego no se manejan en absoluto, nadie las usa. Las promesas mal utilizadas son cuando manejas una promesa técnicamente, la proporcionas a algún lugar, pero ese lugar no tiene ninguna lógica para manejar promesas. Y para ilustrar la diferencia, te mostraré la última demostración que es nuestro componente de no promesas mal utilizadas. Aquí, pasamos esto a 'onClick' del botón, igual que antes. Y observa cómo tenemos el pequeño subrayado aquí, la queja, se esperaba una función que devuelve una promesa para el atributo o evitar el retorno, porque los eventos 'onClick' y 'on' en elementos DOM en frameworks como React no manejan funciones asíncronas. No manejan la idea de que la función podría tomar más tiempo síncrono constante para ejecutarse. Y en esta función, he hecho algo malvado. Dije que si el recuento de llamadas es mayor que dos y math.random es mayor que 0.5, vamos a lanzar un error, ¡atrapado!, lo que significa que debido a que este código asíncrono es

Si encontramos una queja, si tenemos un fallo, jaja, ahí vamos. Simplemente irá a la raíz del error listener. Nuestro código no sabrá qué hacer con eso. Dato curioso. Esto es muy similar al estilo de ventana emergente en muchas herramientas de desarrollo modernas donde obtienes esto, creo que informado por webpack, pequeña queja.

Ahora, la forma de hacer esto que podrías tener en un principio sería envolver todo en un bloque try-catch, lo cual es totalmente razonable. Oh, no, error. Y tal vez también running false allí. Lo cual solucionaría el error si actualizamos, hacemos clic un par de veces y finalmente obtenemos la queja. Vamos, aleatorización. Me estás matando aquí. Vamos. Oh, cielos. Bueno, genial. Parece que nunca se rompió. Apuesto a que si revisamos la consola, sí, tenemos algunos oh, no. Pero esto aún podría ser un problema porque ¿qué sucede si haces algo peligroso en tu bloque catch, que accidentalmente tiene un error, jaja? Y luego lo ejecutas nuevamente, y nuevamente te encuentras en el caso en el que, a pesar de try-catch, aún tienes una excepción potencial en tu código. Entonces, la única forma real de hacer esto de manera segura es crear algún tipo de controlador unificado para tus funciones asíncronas. Recomiendo encarecidamente que, si tu aplicación debe ser sólidamente segura y no se bloquee, incluso para los usuarios que exploran casos extremos, si realmente te importa que tus usuarios no experimenten bloqueos, haz alguna función como esta función runSafely, que recibe una acción, una función que crea una promesa, y un on error síncrono, luego llama a action.catch on error, para que puedas crear onClicks o otros controladores de eventos que sean un run safely de tu código asíncrono y luego algo que maneje el error. En este caso, solo para fines de demostración, he configurado un estado de error, que se muestra al usuario en un span con ARIA live assertive. Entonces, ahora, si vamos a nuestra demostración y hacemos clic, esto puede fallar de manera segura. Si falla, aún obtenemos el gotcha, y luego el botón vuelve a estar habilitado, incluso si el código tuvo un fallo. ¡Increíble! Esas son tres reglas fantásticas de ESLint del complemento TypeScript ESLint que recomiendo encarecidamente habilitar. Y eso es todo lo que quería mostrarte en la demostración. Para obtener más recursos, ESLint.org es fantástico, acaban de hacer una gran revisión del sitio con una excelente reescritura de la documentación y una nueva interfaz de usuario encantadora. Tuvimos un rediseño de sitio un poco menos impresionante en TypeScript. Y si quieres ver la aplicación de demostración, nuevamente, está enlazada en el lateral, demo de TypeScript ESLint React. Si quieres apoyarme en mi trabajo para mejorar todo esto para ti, puedes comprar mi libro Aprendiendo Typescript. Y por favor, patrocíname en GitHub, github.com/.sponsors/.JoshuaKGoldberg. Y si quieres apoyarnos como equipo detrás de TypeScript ESLint, tenemos un colectivo abierto, opencollective.com/.typescripteslint. Realmente necesitamos tu apoyo porque estamos muy subfinanciados y tenemos muy poco personal en este momento, y tenemos muchas características, problemas de performance y errores que nos gustaría abordar este próximo año. Dicho esto, muchas gracias por ver. Gracias a los organizadores de la conferencia por organizar todo esto. Puedes encontrarme en Twitter, Joshua K. Goldberg, y espero que disfrutes del resto de la conferencia. Adiós.