Actualizar Api de v1 a v2
Esta versión de Usuarios, presenta muchos cambios a nivel estructural y de Api.
A continuación se describen los pasos para realizar la actualización de versión.
Consideraciones iniciales
Es necesario contar con una instalación de SIU-Araí: Usuarios en la versión 3.0
.
Se debe tener en cuenta que el proceso de actualización puede involucrar cambios en los datos que mantiene su proyecto, por lo que debe considerar si su estructura esta acorde para los mismos.
Diferencias v1-v2
Identificación del usuario
- v1: identificador con formato por convención (ej:
amartinez
,gredondas
) - v2: identificador con formato uuid (ej:
dbb5e1d9-f6a0-42ac-b35b-7911d5d983e9
)
- v1: identificador con formato por convención (ej:
Recursos extra
- v2: recurso
uuid
para convertir identificadores v1 -> v2
- v2: recurso
Que debo migrar?
Se deben migrar todas aquellas estructuras que almacenen el identificador utilizado por SIU-Araí: Usuarios dentro del sistema, llamese:
- Tablas propias donde conste un mapeo entre usuario del sistema y usuario en SIU-Araí: Usuarios
- Tablas propias que almacenen el identificador de SIU-Araí: Usuarios por distinto motivo
- Tablas de auditoria donde conste el identificador de SIU-Araí: Usuarios
El motivo de la migración es poder asegurar la trazabilidad a futuro de las acciones llevadas a cabo durante un momento previo y la correcta interacción del sistema con SIU-Araí: Usuarios.
Si no almaceno el identificador, debo migrar?
En caso de no almacenar nunca el identificador provisto por SIU-Araí: Usuarios y obtenerlo en runtime previo a su utilización, únicamente se debe cambiar el endpoint de los web services /v1
--> /v2
(a chequear)
Requerimientos para la migración
- Tener actualizada la version de SIU-Araí: Usuarios
- Tener configurados los web services adecuadamente para acceder al endpoint v1
- Contar con acceso a los archivos de configuración correspondientes
- Tener un script sql con las modificaciones en estructura de base de datos de ser necesarias
Procedimiento
NO OLVIDE REALIZAR UNA COPIA DE SEGURIDAD DE LA BASE DE DATOS ANTES DE CONTINUAR
- Colocar sistema en
modo mantenimiento
- Actualizar bases de datos
- Ejecutar el script de modificación de estructura de ser necesario
- Modificar la configuración de los web services para acceder al endpoint v2
- Ejecutar script de migración de identificadores
- Quitar el sistema de
modo mantenimiento
Importante: El script de migración debe poder ejecutarse aún con el sistema en mantenimiento.
Script de migración
- Obtener los usuarios del sistema con identificador SIU-Araí: Usuarios
- Instanciar un web service que acceda al endpoint
/urlApi/v2/uuid/{identificador}
- Ciclar por los usuarios recuperados
- Invocar el web service con el identificador de usuario anterior como parámetro
- Si se recibe un error 404, el usuario ya no forma parte del sistema continuar al próximo
- Recuperar de la respuesta el campo
uid
- Utilizar dicho valor para actualizar en orden
- Tablas de auditoria
- Tablas internas
- Tabla con mapeo de usuarios
Instalaciones que utilizan Registry
Si está utilizando una instalación con Registry, al ejecutar el comando registry:sync
debe hacerlo de la siguiente manera:
source entorno_toba.env
bin/arai-cli registry:sync
Esto configurará los endpoints de servicios con la nueva URL, sin embargo deberá especificar la versión del endpoint al que desea acceder.