Zod === TypeScript, pero en tiempo de ejecución en tus aplicaciones React

Rate this content
Bookmark

Muchos desarrolladores de Javascript han añadido typescript a sus proyectos en los últimos años. ¿Pero cuántos de ellos están seguros de sus tipos en tiempo de ejecución? ¿Pueden garantizarse los tipos también en tiempo de ejecución?


¡Usando Zod eso puede realizarse! Veamos juntos cómo podemos usar Zod para mejorar la conciencia de nuestro código durante su ejecución y prevenir errores extraños o una mala experiencia de usuario.

20 min
23 Oct, 2023

AI Generated Video Summary

Zotter es una herramienta poderosa para trabajar con TypeScript en aplicaciones React, proporcionando un concepto de esquema simple para la validación. Te permite convertir los esquemas de Zod en tipos de TypeScript y comprobar si los objetos coinciden con el esquema. Zod puede ser utilizado para la validación y la aplicación de contratos, asegurando la consistencia de los datos y previniendo problemas. También puede ser utilizado en aplicaciones React para crear una capa de validación y prevenir que el código se ejecute con datos incorrectos. El orador anima a hacer preguntas y proporciona información de contacto para más discusión.

1. Introducción a Zotter y TypeScript en React

Short description:

Hola a todos, y bienvenidos a esta charla sobre Zotter y TypeScript en su aplicación React. Hace casi un año, nació TypeScript. Comenzamos a crear interfaces para mapear nuestro modelo. En nuestro proyecto todo era perfecto. Hasta que un día, un desarrollador de backend decidió cambiar la API. El superhéroe es Zod. Zod es un simple paquete NPM que puedes instalar en tu aplicación React. Tiene un concepto simple, el concepto de esquema.

Hola a todos, y bienvenidos a esta charla sobre Zotter y TypeScript en su aplicación React. Así que, quiero comenzar con una historia. Hace casi un año, nació TypeScript. Y probablemente todos los desarrolladores de JavaScript en el mundo estaban contentos. Así que, comenzamos a crear interfaces para mapear nuestro modelo. Así que, empezamos a usar números, cadenas, booleanos y así sucesivamente. O tal vez tipos, dependiendo del escenario puedes usar interfaz o tipos. Lo que prefieras, no es un problema.

Y en nuestro proyecto todo era perfecto. Teníamos todos los tipos perfectos en nuestra base de código. Y fue un trabajo perfecto para nosotros. Hasta que un día, un desarrollador de backend decidió cambiar la API. Y desafortunadamente, él o ella decidió cambiar la firma de la API. El resultado en nuestra aplicación React es algo como esto. No es un número, no es una cadena de fragmento, o todo tipo de extraño error de JavaScript que puedes imaginar en tu aplicación React. Estos son porque sí, Tileset es fantástico. Me encanta. Pero después de la transpilación, pierdes todos los tipos y el código se convierte en código JavaScript, porque en tu navegador, solo se ejecuta código JavaScript y no código de tileset. A veces los desarrolladores olvidan esto y no se dan cuenta hasta que en producción, no reciben este tipo de error.

Entonces, ¿cómo podemos resolver este problema en nuestras aplicaciones React o JavaScript o Tilescript? Así que, el superhéroe es Zod. ¿Qué es Zod, en primer lugar? Zod es un simple paquete NPM que puedes instalar en tu aplicación React, en tu proyecto, usando tu gestor de paquetes. Puedes usar NPM, instalar, Zod, y todo está listo para usar. Zod tiene un concepto simple, el concepto de esquema. El esquema es un objeto, un verdadero objeto JavaScript en este caso, como puedes notar, que describe tu objeto. En este caso, un esquema de cliente es un esquema Zod que describe que el cliente es un objeto con cuatro propiedades, el ID, con el tipo de número, el nombre con el tipo cadena, el correo electrónico con el tipo cadena de nuevo, y lo mismo para el teléfono. También puedes agregar diferentes restricciones. Por ejemplo, la cadena puede aceptar también una restricción de que esto es un correo electrónico, el teléfono es un teléfono y así sucesivamente. O también puedes construir si quieres tu propio tipo personalizado. Por ejemplo, quieres un caso específico para describir, puedes hacer esto. Pero también puedes, por ejemplo, crear un num, tipo literal, lo que quieras.

2. Uso de Zod con TypeScript

Short description:

La sintaxis de Zod es similar a TypeScript, lo que facilita su aprendizaje. Al usar el método typeof, puedes convertir tu esquema Zod en un tipo TypeScript. Esto te permite trabajar con TypeScript mientras mantienes la definición del esquema en tiempo de ejecución.

Como puedes notar, la sintaxis es bastante similar a la sintaxis de TypeScript. Por lo tanto, no es difícil aprender Zod en este caso. Y puedes importarlo y usarlo usando el objeto Zed en este caso, que puedes importar directamente de la biblioteca Zod.

Luego, sí, en este caso, en este momento, Zod tiene un esquema. Y ahora, tenemos que usarlo. Pero es importante recordar que esto es una const o let, lo que prefieras, pero es un esquema de JavaScript. Así que este esquema permanece vivo también en producción, también durante la ejecución de tu código. Sigue vivo también en producción.

Bien, perfecto. Pero pierdo el beneficio de usar TypeScript, probablemente estás pensando. No, porque usando un método simple llamado typeof, expuesto por la tercera biblioteca, puedes convertir tu esquema en un tipo de TypeScript. Así que en este caso, usando el typeof, podemos convertir el esquema del cliente en un modelo de cliente usando una simple línea de código, bastante simple. Y usando este enfoque, ahora tenemos un tipo de TypeScript, así que el modelo del cliente, y también el esquema del cliente. Entonces, tenemos las cosas para trabajar de la mejor manera con TypeScript, pero también algo que podemos usar en nuestro código para mantener y mantener viva esta definición también en runtime.

3. Uso del método parse y manejo de errores

Short description:

Utilizando el método parse, Zod puede verificar si un objeto coincide con el esquema que has creado. Si es así, el método parse devuelve el objeto con el tipo esperado. Sin embargo, si una propiedad no coincide con el esquema, se genera una excepción. Es crucial capturar y manejar estos errores, especialmente en producción, para identificar y resolver rápidamente cualquier problema inesperado.

¿Cómo? Usando un método simple llamado parse. Cada esquema que creas usando Thud es un objeto. Este objeto expone una función simple llamada parse que acepta un objeto, algo, un objeto, una cadena, lo que quieras, depende de tu esquema. Y esta función parsea tu objeto. Si tu objeto respeta el esquema que has creado durante tu desarrollo, el parse devuelve el objeto, y en este caso, la variable cliente es de tipo modelo de cliente. Así que el parse devuelve exactamente el tipo que esperabas en una tarea.

¿Qué sucede si el parse encuentra una propiedad que no coincide con tu esquema? En este caso, el parse genera un error a través de una excepción, bastante simple. Así que si algo salió mal, recibes una excepción y tienes que manejarla de alguna manera. La excepción es un error de punto. En este caso, el error de punto es una excepción simple, excepto un error, un error de JavaScript con dos propiedades, los problemas y el error. En este caso, puedes encontrar información sobre el problema en el problema y el error, bastante simple. Y es importante capturar y manejar este error porque si tienes un error, tienes que entender qué no se esperaba durante la ejecución de tu código. Y si estás en producción, tienes que react lo antes posible a este problema.

4. Uso de Zod para Validación y Cumplimiento de Contratos

Short description:

Zod proporciona una sencilla capa de validación entre tu aplicación React y las APIs externas, asegurando que los datos recibidos coinciden con el esquema esperado. Esto te permite ejecutar con confianza el resto de tu código, ya que cualquier objeto inesperado generará errores y podrá ser corregido rápidamente. Además, Zod puede ayudar con el cumplimiento de contratos en bibliotecas como React-Router-DOM, donde los tipos de parámetros pueden no coincidir con tus expectativas. Al crear esquemas personalizados con Zod, puedes asegurarte de que los parámetros cumplen tus requisitos y tienen los tipos correctos.

Bien, ahora tenemos toda la noción sobre Zod y es hora de entender dónde podemos usar Zod y todo esto en nuestra aplicación. Así que el primer beneficio que quiero describir hoy es este. Es normal que una aplicación obtenga los data de una API o de un socket. Así que de algo externo a la aplicación. Esta capa de tu aplicación es probablemente la mejor manera de crear una capa para comprobar si tus data que no dependen de ti son como se esperaba durante el desarrollo o durante la creación de la firma. ¿De acuerdo? Así que en este caso, entre tu aplicación y la API externa en este caso, puedes crear una simple capa de validation usando, por ejemplo, un ejemplo simple, tienes una API que recibe una lista de pedidos. Cuando recibes la respuesta, puedes comprobar si el resultado es como se esperaba durante el modo de desarrollo, o durante el desarrollo de tu característica. Así que si esperabas que el pedido tenga un ID, una cantidad, y la lista de productos, también quieres en producción y durante la ejecución, que la respuesta contenga todas estas propiedades. Y este es el primer beneficio de usar VOD. Así que puedes crear una simple capa entre tu aplicación react y el externo. Y cada vez que recibes algunos data, un objeto desde fuera, puedes comprobar si son como se esperaba. Y si es cierto, puedes ejecutar el resto del código con confianza con confianza porque cada objeto es como se esperaba en tu firma, en tus tipos. Como puedes generar un error y enviar una notificación a tu sentry, por ejemplo, y comprobar lo antes posible cuál es el problema y solucionarlo lo antes posible porque probablemente hay un cliente con el problema en tu aplicación, con tu aplicación en este caso. Bien, y este es el primer beneficio.

Pero Zod también puede ayudarte con algunos contratos expuestos por algunas bibliotecas que normalmente usas en tu aplicación. Por ejemplo, ¿cuántos de ustedes usan el UseParamHook expuesto por React-RouterDAO? Bien, este hook es fantástico. Pero, por ejemplo, en este caso, si pides el ID, el ID, el tipo de ID es string o undefined. Y lo mismo ocurre con todos todos los parámetros que decides poner en el UseParam. Y tal vez estás seguro de que el ID es un número, por ejemplo. Y si estás en esta página, el ID es un número y no está indefinido porque el router entra en esta ruta solo si el ID está definido. Para solucionar este problema, puedes usar, por ejemplo, Zot. Por ejemplo, puedes crear tu propio UseParams tipo shape. En este caso, puedes definir el esquema para tus parámetros. En este caso, OrderParamsSchema es un objeto simple que describe que los parámetros contienen un ID. Usando el método Course y Number, comprueba si el ID existe y si es un string. Por ejemplo, convierte este string en un número. Y luego en tu componente React, puedes usar el UseParam tipo shape con el esquema. Y el resultado es que tienes un ID, y el tipo de este ID, en este caso, es un número, como se esperaba. Esta es la implementación. Usando los genéricos, puedes usar el esquema, y puedes pasar el esquema, y la salida y la definición y la entrada del tipo.

5. Uso de Zod en la Aplicación React

Short description:

Luego pasas el esquema como parámetro y la devolución es el Z.INF del esquema. Este es solo uno de los casos de uso. No soy un fan de los tipos de prop. Puedes usar esto con validación de esta manera simple. Si ejecutas esta verificación cada vez que ejecutas el componente, tu código comenzará a verificar el objeto. Este es el último escenario donde puedes usar Zod en tu aplicación React. TypeScript es increíble, pero con Zod, es un poco más. Crear una capa de validación entre tu aplicación y el exterior es la mejor manera de prevenir que tu código se ejecute con los datos incorrectos.

Luego pasas el esquema como parámetro, y la devolución es el Z.INF del esquema, por lo tanto, el tipo del esquema. Y la línea nueve y diez es el código real que se ejecuta en el runtime. Así que useParam, obtén todos los UseParam, y usando el schema.pass, puedes pasar el resultado. Vale. Este es solo uno de los casos de uso.

¿A quién le encantan los tipos de prop? No soy un fan de los tipos de prop. Así que creé un with.validation. Este es un componente iOrder que acepta un esquema y un componente. Usando esta sintaxis bastante no simple, puedes pasar el esquema y luego también un componente React y construir una función que cuando recibes una prop, puedes verificar si las props son como se esperaba en tu esquema y si es cierto, puedes alquilar tu componente como puedes generar un error en este caso. Puedes usar esto con.validation de esta manera simple, por lo que puedes definir las props en el esquema y luego cuando exportas el componente, puedes usar el with.validation, puedes pasar el esquema y luego puedes pasar tu componente. Así que has construido un componente React que verifica cada vez si las props del componente respetan el esquema que tienes en mente.

Sí, todo está bien, todo funciona, pero obviamente hay una compensación. Si ejecutas esta verificación cada vez que ejecutas el componente, tu código comenzará a verificar el objeto. Tienes que entender dónde quieres poner este control. Típicamente, en mi proyecto, me encanta poner este control en todos los componentes que reciben data o que son utilizados por una aplicación externa. Quizás, no sé, estás construyendo un pequeño componente que debe ser incluido en otra aplicación. Es importante, en este caso, crear esta capa porque de esta manera, puedes verificar si tu componente se ejecuta como se esperaba, con los data correctos, o si el problema es porque alguien llamó a tu componente React de una manera incorrecta.

Eso es todo. Este es el último escenario donde puedes usar Zod en tu aplicación React. Sí, no solo hay estos tres ejemplos, pero puedes imaginar tu proyecto. Si necesitas algo que valide tus data, esta es probablemente la biblioteca perfecta para ti. Simple conclusión. Esta es mi conclusión personal. Nuestra personal aún, pero espero que estés de acuerdo conmigo. El TypeScript es increíble, pero con Zod, es un poco más. Es un poco más porque me encanta TypeScript, pero estar seguro de que también el código durante la ejecución se ejecuta con los data esperados es perfecto para mí, porque estoy seguro de que todas las suposiciones están bien también en tiempo de ejecución. Crear una capa de validation entre tu aplicación y el exterior es la mejor manera de prevenir que tu código se ejecute con los data incorrectos. Si tienes un problema, puedes enviar una notificación a tu Sentry y react a este problema lo antes posible. Puedes garantizar tu tipo tanto en el runtime como en tiempo breve y esto es fantástico para mí. Si quieres, también puedes mejorar la biblioteca, como en el ejemplo de Reactor-Router-DOM, o también puedes agregar lo que quieras en tu aplicación si necesitas garantizar tu sistema de tipos también en runtime.

6. Conclusión e Información de Contacto

Short description:

Espero que hayan disfrutado de esta charla. Si tienen alguna pregunta, no duden en contactarme en Twitter o LinkedIn. También pueden seguirme en YouTube para más contenido. Gracias a todos y adiós.

Creo que eso es todo. Espero que disfruten de esta charla, y si tienen alguna pregunta, estoy abierto y son bienvenidos. Aquí pueden encontrar el sitio de esta masterclass.

Antes de dejar esta charla, soy Luca Del Pupo, un Desarrollador de Software Senior en NearForm. Soy un MVP de Microsoft, y un Embajador de GitHub. Estos son mis contactos. Twitter y LinkedIn están abiertos, así que si quieren charlar conmigo o dejar un mensaje, no duden en contactarme y son bienvenidos. Si quieren seguirme en YouTube, este es mi canal de YouTube. Si quieren leer algo en mi cuenta de WTO, pueden encontrar algo para leer sobre temas técnicos.

Bueno, eso es todo. Gracias a todos y adiós. Gracias por ver.

Check out more articles and videos

We constantly think of articles and videos that might spark Git people interest / skill us up or help building a stellar career

React Advanced Conference 2022React Advanced Conference 2022
25 min
A Guide to React Rendering Behavior
React is a library for "rendering" UI from components, but many users find themselves confused about how React rendering actually works. What do terms like "rendering", "reconciliation", "Fibers", and "committing" actually mean? When do renders happen? How does Context affect rendering, and how do libraries like Redux cause updates? In this talk, we'll clear up the confusion and provide a solid foundation for understanding when, why, and how React renders. We'll look at: - What "rendering" actually is - How React queues renders and the standard rendering behavior - How keys and component types are used in rendering - Techniques for optimizing render performance - How context usage affects rendering behavior| - How external libraries tie into React rendering
React Summit Remote Edition 2021React Summit Remote Edition 2021
33 min
Building Better Websites with Remix
Remix is a new web framework from the creators of React Router that helps you build better, faster websites through a solid understanding of web fundamentals. Remix takes care of the heavy lifting like server rendering, code splitting, prefetching, and navigation and leaves you with the fun part: building something awesome!
React Advanced Conference 2022React Advanced Conference 2022
30 min
Using useEffect Effectively
Can useEffect affect your codebase negatively? From fetching data to fighting with imperative APIs, side effects are one of the biggest sources of frustration in web app development. And let’s be honest, putting everything in useEffect hooks doesn’t help much. In this talk, we'll demystify the useEffect hook and get a better understanding of when (and when not) to use it, as well as discover how declarative effects can make effect management more maintainable in even the most complex React apps.
React Summit 2022React Summit 2022
20 min
Routing in React 18 and Beyond
Concurrent React and Server Components are changing the way we think about routing, rendering, and fetching in web applications. Next.js recently shared part of its vision to help developers adopt these new React features and take advantage of the benefits they unlock.In this talk, we’ll explore the past, present and future of routing in front-end applications and discuss how new features in React and Next.js can help us architect more performant and feature-rich applications.
React Advanced Conference 2021React Advanced Conference 2021
27 min
(Easier) Interactive Data Visualization in React
If you’re building a dashboard, analytics platform, or any web app where you need to give your users insight into their data, you need beautiful, custom, interactive data visualizations in your React app. But building visualizations hand with a low-level library like D3 can be a huge headache, involving lots of wheel-reinventing. In this talk, we’ll see how data viz development can get so much easier thanks to tools like Plot, a high-level dataviz library for quick & easy charting, and Observable, a reactive dataviz prototyping environment, both from the creator of D3. Through live coding examples we’ll explore how React refs let us delegate DOM manipulation for our data visualizations, and how Observable’s embedding functionality lets us easily repurpose community-built visualizations for our own data & use cases. By the end of this talk we’ll know how to get a beautiful, customized, interactive data visualization into our apps with a fraction of the time & effort!

Workshops on related topic

React Summit 2023React Summit 2023
170 min
React Performance Debugging Masterclass
Featured WorkshopFree
Ivan’s first attempts at performance debugging were chaotic. He would see a slow interaction, try a random optimization, see that it didn't help, and keep trying other optimizations until he found the right one (or gave up).
Back then, Ivan didn’t know how to use performance devtools well. He would do a recording in Chrome DevTools or React Profiler, poke around it, try clicking random things, and then close it in frustration a few minutes later. Now, Ivan knows exactly where and what to look for. And in this workshop, Ivan will teach you that too.
Here’s how this is going to work. We’ll take a slow app → debug it (using tools like Chrome DevTools, React Profiler, and why-did-you-render) → pinpoint the bottleneck → and then repeat, several times more. We won’t talk about the solutions (in 90% of the cases, it’s just the ol’ regular useMemo() or memo()). But we’ll talk about everything that comes before – and learn how to analyze any React performance problem, step by step.
(Note: This workshop is best suited for engineers who are already familiar with how useMemo() and memo() work – but want to get better at using the performance tools around React. Also, we’ll be covering interaction performance, not load speed, so you won’t hear a word about Lighthouse 🤐)
React Advanced Conference 2021React Advanced Conference 2021
132 min
Concurrent Rendering Adventures in React 18
Featured WorkshopFree
With the release of React 18 we finally get the long awaited concurrent rendering. But how is that going to affect your application? What are the benefits of concurrent rendering in React? What do you need to do to switch to concurrent rendering when you upgrade to React 18? And what if you don’t want or can’t use concurrent rendering yet?

There are some behavior changes you need to be aware of! In this workshop we will cover all of those subjects and more.

Join me with your laptop in this interactive workshop. You will see how easy it is to switch to concurrent rendering in your React application. You will learn all about concurrent rendering, SuspenseList, the startTransition API and more.
React Summit Remote Edition 2021React Summit Remote Edition 2021
177 min
React Hooks Tips Only the Pros Know
Featured Workshop
The addition of the hooks API to React was quite a major change. Before hooks most components had to be class based. Now, with hooks, these are often much simpler functional components. Hooks can be really simple to use. Almost deceptively simple. Because there are still plenty of ways you can mess up with hooks. And it often turns out there are many ways where you can improve your components a better understanding of how each React hook can be used.You will learn all about the pros and cons of the various hooks. You will learn when to use useState() versus useReducer(). We will look at using useContext() efficiently. You will see when to use useLayoutEffect() and when useEffect() is better.
React Advanced Conference 2021React Advanced Conference 2021
174 min
React, TypeScript, and TDD
Featured WorkshopFree
ReactJS is wildly popular and thus wildly supported. TypeScript is increasingly popular, and thus increasingly supported.

The two together? Not as much. Given that they both change quickly, it's hard to find accurate learning materials.

React+TypeScript, with JetBrains IDEs? That three-part combination is the topic of this series. We'll show a little about a lot. Meaning, the key steps to getting productive, in the IDE, for React projects using TypeScript. Along the way we'll show test-driven development and emphasize tips-and-tricks in the IDE.
React Advanced Conference 2021React Advanced Conference 2021
145 min
Web3 Workshop - Building Your First Dapp
Featured WorkshopFree
In this workshop, you'll learn how to build your first full stack dapp on the Ethereum blockchain, reading and writing data to the network, and connecting a front end application to the contract you've deployed. By the end of the workshop, you'll understand how to set up a full stack development environment, run a local node, and interact with any smart contract using React, HardHat, and Ethers.js.
React Summit 2023React Summit 2023
151 min
Designing Effective Tests With React Testing Library
Featured Workshop
React Testing Library is a great framework for React component tests because there are a lot of questions it answers for you, so you don’t need to worry about those questions. But that doesn’t mean testing is easy. There are still a lot of questions you have to figure out for yourself: How many component tests should you write vs end-to-end tests or lower-level unit tests? How can you test a certain line of code that is tricky to test? And what in the world are you supposed to do about that persistent act() warning?
In this three-hour workshop we’ll introduce React Testing Library along with a mental model for how to think about designing your component tests. This mental model will help you see how to test each bit of logic, whether or not to mock dependencies, and will help improve the design of your components. You’ll walk away with the tools, techniques, and principles you need to implement low-cost, high-value component tests.
Table of contents- The different kinds of React application tests, and where component tests fit in- A mental model for thinking about the inputs and outputs of the components you test- Options for selecting DOM elements to verify and interact with them- The value of mocks and why they shouldn’t be avoided- The challenges with asynchrony in RTL tests and how to handle them
Prerequisites- Familiarity with building applications with React- Basic experience writing automated tests with Jest or another unit testing framework- You do not need any experience with React Testing Library- Machine setup: Node LTS, Yarn