Arquitectura de complementos: cómo TypeScript nos permite pintar por números

Rate this content
Bookmark

Agregar una nueva funcionalidad a una base de código desconocida puede ser extremadamente lento. ¿Qué tal si pudieras confiar en TypeScript para guiarte?

En Snyk, la arquitectura de complementos es un patrón común para extender el soporte de lenguaje en diferentes productos y bases de código. Agregar TypeScript a la mezcla nos ha permitido agregar nuevas funcionalidades rápidamente y puede ser tan simple como pintar por números cuando se trata de extender el código.

Acompáñame mientras creamos una biblioteca simple utilizando la arquitectura de complementos y seguimos las pistas de TypeScript para agregar una nueva funcionalidad.

15 min
29 Apr, 2022

Video Summary and Transcription

Cuando nos enfrentamos a desafíos en el soporte de múltiples administradores de paquetes y mantenernos al día con el crecimiento, implementar una arquitectura de complementos puede ayudar. La extensión de una interfaz de línea de comandos (CLI) para sistemas de control de versiones como GitHub y GitLab se puede hacer utilizando TypeScript y Oclef CLI. Los errores de TypeScript se pueden resolver agregando propiedades faltantes e implementando funciones requeridas para los complementos. El soporte de múltiples repositorios siguiendo los errores de TypeScript y teniendo la configuración correcta puede reducir el tiempo de producción y la incorporación. La arquitectura de complementos con TypeScript puede ser una herramienta valiosa para un desarrollo y una incorporación más rápidos en los repositorios.

Available in English

1. Introducción a los Desafíos y la Arquitectura de Plugins

Short description:

Hola. Mi nombre es Lilia y soy una gerente de ingeniería en Snyk. Cuando comencé en Snyk, tenía poco entendimiento de los desafíos que se avecinaban. Necesitábamos soportar múltiples administradores de paquetes y mantenernos al día con nuestro propio crecimiento. Para acelerar el soporte, implementamos una arquitectura de plugins. Con TypeScript, pudimos seguir la pista de los errores para ayudarnos.

Hola. Mi nombre es Lilia y soy una gerente de ingeniería en Snyk que lidera el equipo de servicios técnicos. Cuando comencé en Snyk hace aproximadamente cuatro años, tenía muy poco entendimiento de los desafíos que tendría por delante. Después de liderar un equipo de ingeniería que construía sitios web predefinidos en una pequeña agencia, mis expectativas eran que Snyk sería similar, pero tal vez más desafiante. Y ciertamente no estaba preparada para tener que entender de repente cada administrador de paquetes, como un registro y un sistema de gestión de control de código fuente que se haya construido alguna vez. Y todo esto porque me uní al equipo de ecosistemas.

Recuerdo que una de las primeras características fue agregar soporte para npm6. Esta es la primera vez que npm introdujo archivos de registro. Así que esto agregó un nuevo sabor de npm a la plataforma. Luego vinieron Yarn, Yarn Workspaces, Gradle, Go, diferentes sabores de Go, Kotlin, SPT, Cocoapods. Parecía ser una corriente interminable de administradores de paquetes y herramientas que necesitaban ser soportados. Y a veces las nuevas versiones eran completamente incompatibles con las versiones anteriores y requerían reescribir completamente el soporte.

No solo necesitábamos extender el soporte y mantenernos al día con los clientes que migraban a todas estas diferentes herramientas y versiones, también necesitábamos mantenernos al día con nuestro propio crecimiento. Nuevos miembros del equipo se unen todo el tiempo, y la incorporación al código puede llevar tiempo, ya que es complejo. Una vez que hemos agregado soporte para el administrador de paquetes una o dos veces, comenzamos a ver algunos patrones, y luego podemos acelerar. Sin embargo, cuando un nuevo miembro del equipo se une, tienen que comenzar desde cero, y les lleva otras 2 o 3 veces antes de comenzar a ver esos mismos patrones que tú. Así que necesitábamos pensar en cómo acelerar. A medida que el soporte llevaba más tiempo, a veces se pasaban por alto ciertas áreas del producto donde se necesitaba extender el soporte. Así que necesitábamos acelerar, pero también necesitábamos asegurarnos de cubrir cada área del producto donde se necesitaba extender el soporte. Necesitábamos una arquitectura de plugins.

La arquitectura de plugins consta de dos componentes principales, el sistema central y los propios módulos de plugins. Y los plugins interactúan con el sistema central a través de una interfaz predefinida. En ese momento, teníamos algo de eso en su lugar, pero no en la medida que queríamos. Con algo de tiempo, pudimos comenzar a ver cuál es la responsabilidad del sistema central y cuál es la responsabilidad de los plugins. Sin embargo, algunos de estos comportamientos aún pueden ser bastante confusos. Así que también tienes un poco de desafío allí. Entonces, cuando se presentó una oportunidad para construir una nueva biblioteca, utilizando la arquitectura de plugins, pudimos utilizar lo que aprendimos al introducir TypeScript muy temprano en nuestra aplicación, así como lo que aprendimos y las partes que nos gustaron y no nos gustaron de nuestra arquitectura de plugins existente. Y pudimos juntar todos nuestros aprendizajes y crear algo nuevo e intentarlo de nuevo. Y descubrimos que con una configuración inicial, podíamos apoyarnos en TypeScript y seguir la pista de los errores de TypeScript para ayudarnos. Así que veamos un ejemplo para entender cómo puedes seguir los errores de TypeScript como pistas.

2. Extending CLI for Source Control Management

Short description:

Vamos a extender un CLI llamado el Asistente de Gestión de Control de Origen (SEM Helper) para trabajar con diferentes sistemas de gestión de control de origen como GitHub y GitLab. El CLI tiene un comando llamado Describir GitHub, que proporciona información simple sobre un repositorio, como si está bifurcado o archivado. El código está configurado utilizando TypeScript y Oclef CLI, con directorios separados para comandos y plugins. El comando describir GitHub carga el plugin de GitHub y llama a su función de descripción. El plugin utiliza la biblioteca de reposo OctoKit para realizar llamadas a la API de GitHub. También tenemos un archivo de índice y tipos que nos permiten admitir otros SCM como GitLab.

Vamos a extender un CLI que proporciona alguna funcionalidad simple relevante para trabajar con diferentes sistemas de gestión de control de origen, herramientas como GitHub y GitLab. Así que vamos a sumergirnos.

Entonces, nuestro ejemplo de hoy es un CLI realmente simple llamado Asistente de Gestión de Control de Origen. Lo llamaremos SEM Helper abreviado. Así que echemos un vistazo aquí y básicamente tenemos un comando llamado Describir y estamos llamando a Describir GitHub y luego espera un par de parámetros, el propietario y el repositorio. Así que estamos tratando de describir un repositorio. Así que si le damos un propietario y un repositorio también, estamos devolviendo información muy simple, si el repositorio está bifurcado y si está archivado también.

Así que si lo vemos conceptualmente, básicamente tenemos un sistema central que puede decir repo.describe, por ejemplo. Y luego tenemos un conjunto de plugins que se pueden llamar, en este caso, es específicamente GitHub. Y devolvemos algunos metadatos muy simples, por ejemplo, para verdadero, archivado, falso. Así que vamos a entrar en el código y echemos un vistazo a lo que hemos configurado aquí.

Es una configuración muy simple, básica, lista para usar, siguiendo la documentación de TypeScript. Verás aquí que tenemos un índice de origen y estamos usando Oclef CLI. Así que no tenemos que preocuparnos por el análisis de parámetros ni nada de eso. Verás que también hay un directorio de comandos, así como un directorio de plugins de librería. En los comandos aquí, tenemos describir GitHub, que es lo que acabas de ver ejecutándose. Y en describir GitHub, tiene algunos argumentos, tiene un ejemplo, una descripción y la funcionalidad principal aquí es cargar un plugin, cargar un plugin de GitHub, y luego estamos llamando a plugin.describir y enviándole el repositorio y eso. Y eso es todo. Y luego en los plugins de librería, hay un directorio de GitHub en el que hay un poco de código, que es obtener credenciales y luego la llamada a la API de descripción en sí. Así que necesitamos poder obtener el token y luego estamos llamando en este caso, OctoKit rest, que es una biblioteca de GitHub y llamando al repositorio específico para obtener la información que queremos. Así que echemos un vistazo de nuevo dentro de los plugins. También tenemos un archivo de índice y tipos. Así que en el archivo de índice, verás que hay nuestra función de carga de plugin y toma un tipo de SCM, que son todos los SCM admitidos. Este es un enum de todos los SCM admitidos. Y queremos poder admitir también GitLab. Así que hagámoslo. Así que vamos a agregar y registrar GitHub así como GitLab como un plugin admitido aquí. Así que vamos a decir, GitLab equals GitLab. De acuerdo, y veamos qué pasa. Así que ahora que hemos hecho eso, verás que hay en nuestro archivo de carga de plugin en ese índice.

3. TypeScript Errors and GitLab Plugin Implementation

Short description:

Tenemos un par de errores de TypeScript relacionados con propiedades faltantes en el tipo. Necesitamos agregar los equivalentes de repositorio y organización de GitLab, así como registrar GitLab como un plugin. Sin embargo, también necesitamos implementar dos funciones requeridas, obtener credenciales y describir, para el plugin. Una vez que completemos estas piezas faltantes, podemos verificar si los errores se resuelven.

Tenemos un par de errores de TypeScript. Y verás lo mismo si ejecutas npm run build. Así que tenemos tres lugares donde ahora tenemos un error. Y dice que falta la propiedad GitLab en el tipo pero es requerida. Así que aquí puedes ver que se espera que llenemos el nombre de la entidad con la que estamos tratando. Entonces, para GitHub es un repositorio, para GitLab también es un repositorio. Así que agreguemos eso, repositorio de GitLab.

Bien, luego el tipo de entidad principal para GitHub es la organización. Así que para GitLab también necesitamos el equivalente que también es organización. Y el último es los plugins. Así que aquí tenemos un tipo que básicamente dice que cada SCM admitido debe registrarse aquí como un plugin. Así que registremos nuestro nuevo plugin de GitLab. Y parece que ahora tenemos que crear un archivo para que GitLab tenga plugins.

Bien, hagámoslo. Así que en GitLab index, exportemos nada. Solo un objeto vacío por ahora. Y registremoslo aquí. Y veamos qué obtenemos. Bien, eso está todo hecho. Oh espera, hay un error aquí. ¿Qué no le gusta? Oh, perfecto. Nos está diciendo que nos faltan dos funciones que son requeridas para cada plugin. Una llamada obtener credenciales y otra llamada describir. Y puedes ver que están definidas aquí. Así que cada una de estas debe ser una performance a la interfaz cliente SCM, donde necesitamos tener una función llamada obtener credenciales que devuelva credenciales de una forma determinada, así como la función describir que devolverá si está archivado o bifurcado. Y hasta que completemos esto y devolvamos el tipo correcto, este error no desaparecerá. Entonces, básicamente, al registrar un nuevo tipo de plugin que se va a admitir, TypeScript nos ha indicado los tres lugares donde necesitábamos registrar o tener una implementación específica de GitLab. E incluso cuando hemos agregado solo un plugin básico, no fue suficiente porque hemos definido una interfaz. Por lo tanto, se espera que devolvamos la información correcta. Así que vamos a implementar todas las partes faltantes, y luego veamos si todos los errores han desaparecido.

4. Soporte de GitHub y GitLab con TypeScript

Short description:

Ahora soportamos tanto los repositorios de GitHub como los repositorios de GitLab siguiendo los errores de TypeScript y teniendo la configuración correcta. Registrar la funcionalidad necesaria con tipos permite agregar fácilmente nuevos plugins. Solo necesitas saber dónde registrar el soporte para el nuevo plugin. Al hacer estas cosas simples, puedes reducir el tiempo de producción y unirte al repositorio más rápido. Prueba la arquitectura de plugins con TypeScript en tu próximo proyecto.

Ahora que hemos agregado todo el código necesario para que GitLab también funcione llamando a las API relevantes de GitLab, podemos ejecutar una CLI con el comando describe-gitlab como puedes ver, y estamos obteniendo los mismos resultados. Así que ahora soportamos tanto los repositorios de GitHub como los repositorios de GitLab. Y todo esto siguiendo un par de errores, realmente de TypeScript.

Entonces, ¿cómo pudimos hacer eso? El truco estaba realmente en tener la configuración correcta, donde cualquier variable, cualquier funcionalidad que necesite provenir del plugin debe registrarse como requerida. Así que tenemos nuestros SCM admitidos. Y verás que lo estamos usando en todas partes donde esperamos que la funcionalidad se extienda para el SCM. Así que aquí en el nombre de la entidad, aquí en el nombre de la entidad principal, aquí en el propio plugin. Y para el plugin, hemos tipado lo que se espera. Así que tenemos toda la interfaz escrita. Tenemos las funciones esperadas que debe implementar, que son obtener credenciales y describir. También podemos extender y agregar una nueva función que debe implementar. Tal vez sea un delete para eliminar el repositorio. Y tan pronto como hagamos eso, vamos a obtener errores de TypeScript en todos los plugins, porque ahora estos plugins ya no se ajustan a la interfaz definida.

Entonces, al tener la configuración correcta de antemano y asegurarse de registrar toda la funcionalidad necesaria con tipos, puedes registrar un nuevo plugin y luego seguir la pista de los errores de TypeScript para completar los espacios en blanco. Y eso significa que solo necesitas saber el lugar donde debes agregar el nuevo plugin como registrado, como admitido. Y no necesitas leer el resto del código porque ya tienes interfaces definidas que puedes implementar y completar los espacios en blanco. Así que no es necesario entender cómo funciona el plugin de GitHub, no es necesario entender cómo funciona el código principal del sistema también. Siempre y cuando sepas dónde registrar el soporte para el nuevo plugin. Al hacer estas cosas simples, pudimos agregar el plugin sin profundizar demasiado en el funcionamiento interno del código principal. Así que puedes reducir el tiempo de producción porque si sabes exactamente en qué parámetros necesitas escribir el código, las funciones que necesitas implementar, qué devuelven esas funciones, dónde se usan esas funciones, en qué caso aquí TypeScript te lo dirá. Entonces no necesitas familiarizarte con el código principal en absoluto. Preparar todo esto de antemano cuando estás configurando la arquitectura del repositorio tiene enormes beneficios más adelante, y puedes reducir el tiempo de incorporación al repositorio. No es necesario aprender cómo funciona todo el código en conjunto antes de poder contribuir a él. Solo necesitas aprender las áreas necesarias si te apoyas en TypeScript, y si realmente necesitas cambiar el código principal del sistema, puedes familiarizarte con él en ese momento. Así que te pido que ahorres tiempo para ti mismo en el futuro. Prueba la arquitectura de plugins con TypeScript en tu próximo proyecto. Gracias. ♪MÚSICA♪

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

Remix Conf Europe 2022Remix Conf Europe 2022
23 min
Scaling Up with Remix and Micro Frontends
Top Content
Do you have a large product built by many teams? Are you struggling to release often? Did your frontend turn into a massive unmaintainable monolith? If, like me, you’ve answered yes to any of those questions, this talk is for you! I’ll show you exactly how you can build a micro frontend architecture with Remix to solve those challenges.
Remix Conf Europe 2022Remix Conf Europe 2022
37 min
Full Stack Components
Top Content
Remix is a web framework that gives you the simple mental model of a Multi-Page App (MPA) but the power and capabilities of a Single-Page App (SPA). One of the big challenges of SPAs is network management resulting in a great deal of indirection and buggy code. This is especially noticeable in application state which Remix completely eliminates, but it's also an issue in individual components that communicate with a single-purpose backend endpoint (like a combobox search for example).
In this talk, Kent will demonstrate how Remix enables you to build complex UI components that are connected to a backend in the simplest and most powerful way you've ever seen. Leaving you time to chill with your family or whatever else you do for fun.
React Advanced Conference 2022React Advanced Conference 2022
29 min
Understanding React’s Fiber Architecture
Top Content
We've heard a lot about React's Fiber Architecture, but it feels like few of us understand it in depth (or have the time to). In this talk, Tejas will go over his best attempt at understanding Fiber (reviewed by other experts), and present it in an 'explain-like-I'm-five years old' way.
TechLead Conference 2023TechLead Conference 2023
35 min
A Framework for Managing Technical Debt
Let’s face it: technical debt is inevitable and rewriting your code every 6 months is not an option. Refactoring is a complex topic that doesn't have a one-size-fits-all solution. Frontend applications are particularly sensitive because of frequent requirements and user flows changes. New abstractions, updated patterns and cleaning up those old functions - it all sounds great on paper, but it often fails in practice: todos accumulate, tickets end up rotting in the backlog and legacy code crops up in every corner of your codebase. So a process of continuous refactoring is the only weapon you have against tech debt.In the past three years, I’ve been exploring different strategies and processes for refactoring code. In this talk I will describe the key components of a framework for tackling refactoring and I will share some of the learnings accumulated along the way. Hopefully, this will help you in your quest of improving the code quality of your codebases.

React Summit 2023React Summit 2023
24 min
Debugging JS
As developers, we spend much of our time debugging apps - often code we didn't even write. Sadly, few developers have ever been taught how to approach debugging - it's something most of us learn through painful experience.  The good news is you _can_ learn how to debug effectively, and there's several key techniques and tools you can use for debugging JS and React apps.

Workshops on related topic

React Advanced Conference 2021React Advanced Conference 2021
174 min
React, TypeScript, and TDD
Top Content
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 2022React Advanced Conference 2022
148 min
Best Practices and Advanced TypeScript Tips for React Developers
Top Content
Featured Workshop
Are you a React developer trying to get the most benefits from TypeScript? Then this is the workshop for you.In this interactive workshop, we will start at the basics and examine the pros and cons of different ways you can declare React components using TypeScript. After that we will move to more advanced concepts where we will go beyond the strict setting of TypeScript. You will learn when to use types like any, unknown and never. We will explore the use of type predicates, guards and exhaustive checking. You will learn about the built-in mapped types as well as how to create your own new type map utilities. And we will start programming in the TypeScript type system using conditional types and type inferring.
DevOps.js Conf 2024DevOps.js Conf 2024
163 min
AI on Demand: Serverless AI
Featured WorkshopFree
In this workshop, we discuss the merits of serverless architecture and how it can be applied to the AI space. We'll explore options around building serverless RAG applications for a more lambda-esque approach to AI. Next, we'll get hands on and build a sample CRUD app that allows you to store information and query it using an LLM with Workers AI, Vectorize, D1, and Cloudflare Workers.
React Summit Remote Edition 2021React Summit Remote Edition 2021
87 min
Building a Shopify App with React & Node
Top Content
WorkshopFree
Shopify merchants have a diverse set of needs, and developers have a unique opportunity to meet those needs building apps. Building an app can be tough work but Shopify has created a set of tools and resources to help you build out a seamless app experience as quickly as possible. Get hands on experience building an embedded Shopify app using the Shopify App CLI, Polaris and Shopify App Bridge.We’ll show you how to create an app that accesses information from a development store and can run in your local environment.
Node Congress 2024Node Congress 2024
83 min
Deep TypeScript Tips & Tricks
Workshop
TypeScript has a powerful type system with all sorts of fancy features for representing wild and wacky JavaScript states. But the syntax to do so isn't always straightforward, and the error messages aren't always precise in telling you what's wrong. Let's dive into how many of TypeScript's more powerful features really work, what kinds of real-world problems they solve, and how to wrestle the type system into submission so you can write truly excellent TypeScript code.
JSNation 2022JSNation 2022
41 min
Build a chat room with Appwrite and React
WorkshopFree
API's/Backends are difficult and we need websockets. You will be using VS Code as your editor, Parcel.js, Chakra-ui, React, React Icons, and Appwrite. By the end of this workshop, you will have the knowledge to build a real-time app using Appwrite and zero API development. Follow along and you'll have an awesome chat app to show off!