Subdirección de las Tecnologías de la Información y Comunicaciones
Área de Gobernanza y Calidad
Versión
Guía de implementación Vigente
Versión: 1.0.1
Estado: ACTIVO
Entrada en vigor desde: 11/07/2024
Guía de implementación PRE-RELEASE
Versión: -
Estado: -
Entrada en vigor desde: N/A
Histórico de cambios
Los cambios en la normativa vendrán acompañados de un registro de las modificaciones. De este modo se podrá realizar un seguimiento y consultar su evolución. Ordenándose de mas recientes a menos recientes, prestando especial cuidado a las cabeceras de la tablas dónde se indican las fechas de entrada en vigor y versión.
Está desarrollado, implementado y gestionado de forma independiente.
Permiten dividir una aplicación web en varias partes más pequeñas, cada una de las cuales puede tener su propio ciclo de vida, stack tecnológico, y equipo de desarrollo.
Es responsable de una funcionalidad o una sección específica de la interfaz de usuario y se integra con otras partes de la aplicación para formar una experiencia de usuario cohesiva.
Un Web Component es una tecnología estándar de la web que permite crear componentes de interfaz de usuario encapsulados y reutilizables que pueden integrarse fácilmente en cualquier aplicación web, independientemente del framework, tecnología o biblioteca de JavaScript utilizada.
La composición de los web components, viene determinada por la metodología de Atomic Web Design. En función de su granularidad. composición y la funcionalidad que implementen podemos tener:
Sin lógica de negocio: un componente general y trasversal cuya lógica es puramente visual y marcada por lo definido por el sistema de diseño (un botón, una tabla genérica, etc). El catálogo ofrecido por el se encuentra en el Storybook de la STIC.
Atomo
Molécula
Organismo Estructural
Template
Con lógica de negocio: un componente (organismo de negocio) que implementa una lógica de negocio relacionada con el negocio de la aplicación donde se integra (tabla de usuarios, tabla de pacientes etc). En caso de ser reutilizable, entonces consideraríamos ese componente web component como un fragment o un microfrontend en función de su granularidad y componibilidad (búsqueda de paciente, botón para generar una incidencia en CGES de forma automática).
Un microfrontend es un web component y como todo web component puede ser utilizado para componer nuevos componentes.
En caso de que un microfrontend forme parte de otro microfrontend, conceptualmente para este nuevo microfrontend, dejará de ser un microfrontend y pasará a ser un fragment.
Aunque oficialmente entre las versiones actuales (2 y 3) no existen diferencias de calado que puedan generar incompatibilidades o conflictos, no garantizamos el correcto funcionamiento de los recursos ofrecidos por parte de la STIC
Tampoco ofrecemos soporte para aquellos desarrollos que no se encuentren en la misma X.Y.Z (mayor.minor.path)
Estamos trabajando para ofrecer un mecanismo de actualización del framework dentro de una misma mayor, que reduzca el impacto en los proyectos que hagan uso de dicha tecnología.
Si no hay ninguna personalización que lo justifique el host deberá usar el componente stic-isolated-microfrontend, que recibe una url, a través de la propiedad src, donde está desplegado el microfrontend a integrar.
En caso de necesitar una adaptación que justifique un desarrollo personalizado,se debe crear ticket Jira de decisión técnica (Tarea genera → tipo: decisión → subtipo: técnica) y asignársela al responsable del departamento LUIS MARTINEZ FONTIVEROS
Si el departamento considera justificada la creación personalizada, el componente creado deberá extender, OBLIGATORIAMENTE, del view proporcionado por el componente stic-isolated-microfrontend,
En caso de necesitar un nuevo componente que no se encuentra dentro de los desarrollados por el equipo del catálogo de componentes, se debe crear un ticket Jira de decisión técnica (Tarea genera → tipo: decisión → subtipo: técnica) y asignársela al responsable del departamento LUIS MARTINEZ FONTIVEROS
El ticket deberá contener:
La explicación de la necesidad funcional
El diseño, alineado con las directrices marcadas por el sistema de diseño, por parte del equipo de UX asignado al proyecto
Una entrada en la tabla que identifica los componentes utilizados en el proyecto
Una vez creado y asignado el ticket al departamento con la información se procederá a:
Evaluar si es un componente con carácter general, o solo tienen cabida dentro del catálogo del proyecto.
En caso de determinar que es un componente general
Analizar la necesidad y evaluar si algún componente existente cubre la necesidad
Se responderá al ticket con la estimación (fecha y versión) de diseño (en caso de ser necesario) y del desarrollo del componente
En caso de ser necesario, se realizará el diseño del componente y se publicará en el sistema de diseño.
En caso de necesitar una nueva funcionalidad de un componente dentro de los desarrollados por el equipo del catálogo de componentes, se debe crear un ticket Jira de decisión técnica (Tarea genera → tipo: decisión → subtipo: técnica) y asignársela al responsable del departamento LUIS MARTINEZ FONTIVEROS
El ticket deberá contener:
La explicación de la necesidad funcional
El diseño, alineado con las directrices marcadas por el sistema de diseño, por parte del equipo de UX asignado al proyecto
Una entrada en la tabla que identifica los componentes utilizados en el proyecto
Una vez creado y asignado el ticket al departo con la información se procederá a:
Si es un necesidad que encaja dentro de un componente con carácter general, o solo tienen cabida dentro del catálogo del proyecto.
En caso de determinar que es un componente general
Analizar la necesidad y evaluar si algún otro componente existente cubre la necesidad
Se responderá al ticket con la estimación (fecha y versión) de diseño (en caso de ser necesario) y del desarrollo de la nueva funcionalidad del componente
En caso de ser necesario, se realizará el diseño de la nueva funcionalidad del componente y se publicará en el sistema de diseño.
En caso de detectar un error en alguno de los componentes desarrollados por el equipo del catálogo de componentes, se debe comunicar al responsable técnico del proveedor para que se ponga en contacto con el departamento de arquitectura.
En caso de que el proveedor no disponga de un referente tecnológico, se debe crear una CGES al departamento de arquitectura de la stic con la incidencia y la mayor información de contexto posible que nos permita evaluar el error y reproducirlo y dar una estimación (fecha y versión) de resolución del error
En caso de que un proyecto tenga una necesidad que entre en conflicto con la normativa de desarrollo redactada, se deberá crear un ticket Jira de decisión técnica (Tarea genera → tipo: decisión → subtipo: técnica) y asignársela al responsable del departamento LUIS MARTINEZ FONTIVEROS .
Una vez asignada, el departamento analizará la necesidad y dará respuesta dentro del mismo ticket.
Existe un equipo encargado de desarrollar y mantener un catálogo de componentes, el cual se puede consultar, ver la información, probar y configurar en directo a través de su playground.
Tanto los nuevos componentes como los existentes se busca alinearlos con las directrices marcadas en el sistema de diseño.
Los componentes están con constante evolución tratando de mantener una retrocompatibilidad dentro de la misma versión mayor.
Si quiere mantenerse al día de los cambios que ocurren en el catálogo suscríbase al blog
Inicialmente, se barajó la implementación del concepto del app-shell (referencia 1, referencia 2). Pero después de varias aproximaciones, el departamento de arquitectura de la STIC, decidió descartarla por la dificultad que añadía a la solución y dada la lista variopinta de las tecnologías con las que están desarrolladas las aplicaciones del SAS.
Se consideró que gracias a la uniformidad tecnológica en el desarrollo de los microfrontend y el conjunto de estándares, normativas, herramientas, componentes y capabilities ofrecidas daba un marco suficientemente completo de trabajo para poder integrar los microfrontends en el heterogéneo catálogo tecnológico del SAS
Un microfrontend aislado se integra como un web component normal,
Se debe
Se debe hacer uso de la versión aislada del microfrontend, importar su modulo y hacer uso de su tag, propiedades y eventos tal y como esté definido en el api proporcionado.
Si, para ello debe existir, o se debe crear, un web component que exponga la aplicación en modo microfrontend.
El web component debe tener una propiedad que permita configurar al host el tipo de integración que quiere hacer:
Stand-Alone: El MICROFRONTEND se encarga de renderizar: header, footer, menú y notificaciones de la aplicación embebida
Integrada: El HOST se encarga de renderizar: header, footer, menú y notificaciones de la aplicación embebida. El microfrontend enviará a través de eventos definidos en el api, las notificaciones que el host debe visualizar
Todos los microfrontales están desarrollados en base a las directrices marcadas por el sistema de diseño e instanciando para ello el componente de theme de la stic
Alineamiento Tecnológico: Desde el host se dispone de capacidad para poder alinear a nivel tecnológico y a nivel de versiones los diferentes conflictos tecnológicos
NO Alineamiento Tecnológico: El host debe utilizar la versión aislada del microfrontend, que le permita cargar en un contexto independiente y evitar los conflictos tecnológicos
Para aquellos microfrontend que requieran de seguridad y no tengan un acceso anónimo, el host debe obtener y transmitir el token JWT para integrarse de forma segura con el microfrontend.
Se debe consultar la documentación del microfrontend, donde se especificará el mecanismo de integración segura.
La comunicación entre dos microfrontend se realiza de la misma forma estandarizada que para un web component, a través de un padre. En este caso es el host el que debe actuar como tal escuchando los eventos de un microfrontend y transformando la respuesta a una propiedad del otro microfrontend.
En un microfrontend hay dos tipos de configuraciones:
Interna: Es responsabilidad del microfrontend establecer los valores
Externa: Es responsabilidad del host establecer los valores
Se debe consultar la documentación del microfrontend para revisar las configuraciones que se deben realizar en el microfrontend y los mecanismos que se determinen
El estado entre el host y el microfrontend NUNCA será compartido, es decir, un host NUNCA podrá acceder a la información de contexto de un microfrontend de manera directa y viceversa.
En caso de necesitar un mecanismo de conocimiento del estado, cada elemento (host y microfrontend) deberá persistir en su propio contexto la información del otro.
En caso de considerar relevante compartir información sobre su estado, ambos elementos deberán usar los mecanismos de comunicación estándar para un web component:
Host → Microfrontend: a través de las propiedades definidas en el api del microfrontend.
Microfrontend → Host: a través de los eventos, definidos en el api del microfrontend, que emite el microfrontend.
Un microfrontend se versiona siguiendo las pautas marcadas por el versionado semántico[mayor.minor.patch]. Con esto se garantiza la retrocompatibilidad del microfrontend en cualquier versión dentro de una misma mayor.