|
| 1 | +import { readFileSync, statSync } from 'node:fs' |
| 2 | +import { plainToInstance } from 'class-transformer' |
| 3 | +import { parse } from 'yaml' |
| 4 | +import { validateOrReject } from 'class-validator' |
| 5 | +import { ConfigStatesDTO, LifecycleStateDTO } from '../_dto/config-states.dto' |
| 6 | +import { formatValidationErrors } from './format-validation-errors.function' |
| 7 | +import { IdentityLifecycleDefault } from '../../identities/_enums/lifecycle.enum' |
| 8 | +import { Logger } from '@nestjs/common' |
| 9 | + |
| 10 | +// Cache simple en mémoire pour éviter les relectures inutiles du fichier states.yml |
| 11 | +// Le cache est invalidé automatiquement si la date de modification (mtimeMs) change. |
| 12 | +let __customStatesCache: LoadCustomStatesResult | null = null |
| 13 | +let __customStatesCacheMtime: number | null = null |
| 14 | + |
| 15 | +/** |
| 16 | + * Résultat du chargement des états personnalisés |
| 17 | + * |
| 18 | + * @interface LoadCustomStatesResult |
| 19 | + * @property {LifecycleStateDTO[]} customStates - Tableau des états personnalisés chargés |
| 20 | + * @property {number} stateFileAge - Timestamp de la dernière modification du fichier |
| 21 | + */ |
| 22 | +export interface LoadCustomStatesResult { |
| 23 | + customStates: LifecycleStateDTO[] |
| 24 | + stateFileAge: number |
| 25 | +} |
| 26 | + |
| 27 | +/** |
| 28 | + * Charge les états personnalisés depuis le fichier states.yml |
| 29 | + * |
| 30 | + * @export |
| 31 | + * @async |
| 32 | + * @function loadCustomStates |
| 33 | + * @param {Logger} logger - Instance du logger pour tracer les opérations |
| 34 | + * @returns {Promise<LoadCustomStatesResult>} Objet contenant les états chargés et l'âge du fichier |
| 35 | + * |
| 36 | + * @description Lit le fichier states.yml depuis `configs/lifecycle`, le parse, |
| 37 | + * le valide et retourne les états personnalisés. Également retourne l'âge du fichier |
| 38 | + * pour le cache HTTP. |
| 39 | + * |
| 40 | + * Validations effectuées : |
| 41 | + * - Clé d'état doit être exactement 1 caractère |
| 42 | + * - Clés doivent être uniques |
| 43 | + * - Clés ne doivent pas entrer en conflit avec les états par défaut |
| 44 | + * |
| 45 | + * @throws {Error} Si la validation échoue ou si une clé est en conflit |
| 46 | + * |
| 47 | + * @example |
| 48 | + * const { customStates, stateFileAge } = await loadCustomStates(logger); |
| 49 | + * // Charge states.yml |
| 50 | + * // Valide que les clés sont uniques et non conflictuelles |
| 51 | + * // Retourne les états pour utilisation par l'API |
| 52 | + */ |
| 53 | +export async function loadCustomStates(): Promise<LoadCustomStatesResult> { |
| 54 | + const logger = new Logger(loadCustomStates.name) |
| 55 | + |
| 56 | + const customStates: LifecycleStateDTO[] = [] |
| 57 | + let stateFileAge = 0 |
| 58 | + logger.verbose('Loading custom lifecycle states from states.yml...') |
| 59 | + |
| 60 | + try { |
| 61 | + const statesFilePath = `${process.cwd()}/configs/lifecycle/states.yml` |
| 62 | + // Vérifier l'âge du fichier pour décider d'utiliser le cache |
| 63 | + const { mtimeMs } = statSync(statesFilePath) |
| 64 | + // Si le cache est présent et que le mtime n'a pas changé, retourner directement |
| 65 | + if (__customStatesCache && __customStatesCacheMtime === mtimeMs) { |
| 66 | + logger.debug('Returning cached custom lifecycle states (states.yml unchanged)') |
| 67 | + return __customStatesCache |
| 68 | + } |
| 69 | + |
| 70 | + const data = readFileSync(statesFilePath, 'utf-8') |
| 71 | + stateFileAge = mtimeMs |
| 72 | + logger.debug('Loaded custom states config: states.yml') |
| 73 | + |
| 74 | + const yml = parse(data) |
| 75 | + const configStates = plainToInstance(ConfigStatesDTO, yml) |
| 76 | + |
| 77 | + if (!configStates || !configStates.states || !Array.isArray(configStates.states)) { |
| 78 | + logger.error('Invalid schema in states.yml file') |
| 79 | + return { customStates, stateFileAge } |
| 80 | + } |
| 81 | + |
| 82 | + try { |
| 83 | + logger.verbose('Validating schema for states.yml', JSON.stringify(configStates, null, 2)) |
| 84 | + await validateOrReject(configStates, { |
| 85 | + whitelist: true, |
| 86 | + }) |
| 87 | + logger.debug('Validated schema for states.yml') |
| 88 | + } catch (errors) { |
| 89 | + const formattedErrors = formatValidationErrors(errors, 'states.yml') |
| 90 | + const err = new Error(`Validation errors in states.yml:\n${formattedErrors}`) |
| 91 | + throw err |
| 92 | + } |
| 93 | + |
| 94 | + // Valider que chaque clé est unique et d'une seule lettre |
| 95 | + const usedKeys = new Set<string>() |
| 96 | + for (const state of configStates.states) { |
| 97 | + if (state.key.length !== 1) { |
| 98 | + throw new Error(`State key '${state.key}' must be exactly one character`) |
| 99 | + } |
| 100 | + |
| 101 | + if (usedKeys.has(state.key)) { |
| 102 | + throw new Error(`Duplicate state key '${state.key}' found in states.yml`) |
| 103 | + } |
| 104 | + |
| 105 | + // Vérifier que la clé n'existe pas déjà dans l'enum par défaut |
| 106 | + if (Object.values(IdentityLifecycleDefault).includes(state.key as IdentityLifecycleDefault)) { |
| 107 | + throw new Error(`State key '${state.key}' conflicts with default lifecycle state`) |
| 108 | + } |
| 109 | + |
| 110 | + usedKeys.add(state.key) |
| 111 | + customStates.push(state) |
| 112 | + } |
| 113 | + |
| 114 | + logger.log(`Loaded <${customStates.length}> custom lifecycle states from states.yml`) |
| 115 | + |
| 116 | + // Mettre à jour le cache après chargement et validation réussis |
| 117 | + __customStatesCache = { customStates, stateFileAge } |
| 118 | + __customStatesCacheMtime = stateFileAge |
| 119 | + |
| 120 | + } catch (error) { |
| 121 | + logger.error('Error loading custom states from states.yml', error.message, error.stack) |
| 122 | + // En cas d'erreur, ne pas empoisonner le cache : on l'invalide |
| 123 | + __customStatesCache = null |
| 124 | + __customStatesCacheMtime = null |
| 125 | + } |
| 126 | + |
| 127 | + return { customStates, stateFileAge } |
| 128 | +} |
0 commit comments