feat(cron): add cron module for scheduled tasks management

- Introduced CronModule to manage scheduled tasks with cron expressions.
- Added DTOs for cron task configuration and creation.
- Implemented load function to read and validate cron tasks from YAML files.
- Created CronHooksService to handle the scheduling and execution of cron jobs.
- Added CronController for manual triggering of cron tasks.
- Integrated lifecycle management with cron tasks execution.
- Enhanced error handling and logging for cron operations.
- Updated lifecycle command to include execution of lifecycle rules for sources.

Author: tacxou

.cursor/release.mdc

@@ -0,0 +1,24 @@
+# Fichier MDC pour génération de message de release
+
+# Ce fichier permet de générer un message de release en français basé sur le changelog GitHub complet entre la version précédente et la version cible.
+# Utilisation typique : automatisation de la génération de notes de version lors d'une release.
+
+[release]
+lang = "fr"
+source = "github-fullchangelog"
+template = "release-fr"
+
+# Variables disponibles :
+# - previous_version : la version précédente
+# - target_version : la version cible
+# - changelog : le changelog complet entre les deux versions
+
+message = """
+## Notes de version pour la version {target_version}
+
+Voici les changements apportés depuis la version {previous_version} :
+
+{changelog}
+
+Merci à tous les contributeurs !
+"""

.cursor/release_notes.md

@@ -0,0 +1,29 @@
+# Fichier MDC pour génération de message de release
+
+# Ce fichier permet de générer un message de release en français basé sur le changelog GitHub complet entre la version précédente et la version cible.
+# Utilisation typique : automatisation de la génération de notes de version lors d'une release.
+
+[release]
+lang = "fr"
+source = "github-fullchangelog"
+template = "release-fr"
+
+# Variables disponibles :
+# - previous_version : la version précédente
+# - target_version : la version cible
+# - changelog : le changelog complet entre les deux versions
+
+message = """
+## Notes de version pour la version 2.0.3
+
+Voici les changements apportés depuis la version 2.0.2 :
+
+- v2.0.3 (0d3c5db)
+- feat: add deletedFlag update in executeJob for identity state management (3039903)
+- refactor: comment out unused settings dialog and related function (638e4cb)
+- refactor: restructure settings components and pages (05268c2)
+
+Merci à tous les contributeurs !
+"""
+
+Comparaison complète : https://github.com/Libertech-FR/sesame-orchestrator/compare/2.0.2...2.0.3

Makefile

@@ -75,6 +75,7 @@ prod: ## Start production environment
 		$(IMG_NAME) yarn start:prod
 
 dev: ## Start development environment
+	@mkdir -p $(CURDIR)/apps/api/logs/handlers
 	@docker run --rm -it \
 		-e NODE_ENV=development \
 		-e NODE_TLS_REJECT_UNAUTHORIZED=0 \

apps/api/configs/cron/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

apps/api/defaults/cron/lifecycle-execute-check-identities.yml

@@ -0,0 +1,7 @@
+tasks:
+  - name: "lifecycle-execute-check-identities"
+    description: "Execute lifecycle trigger for check identities"
+    enabled: false
+    schedule: "0 2 15 6 *"  # Le 15 juin de chaque année à 02:00
+    handler: "lifecycle-execute"
+    options:

…ons/format-validation-errors.function.ts …ons/format-validation-errors.function.tsapps/api/src/management/lifecycle/_functions/format-validation-errors.function.ts renamed to apps/api/src/_common/functions/format-validation-errors.function.ts apps/api/src/management/lifecycle/_functions/format-validation-errors.function.ts renamed to apps/api/src/_common/functions/format-validation-errors.function.ts

@@ -0,0 +1,70 @@
+import fs from 'fs'
+import path from 'path'
+import { ConfigService } from '@nestjs/config'
+import { Logger } from '@nestjs/common'
+
+function ensureDir(dir: string) {
+  try {
+    fs.mkdirSync(dir, { recursive: true, mode: 0o777 })
+  } catch (err) {
+    Logger.warn(`Could not create log directory ${dir}: ${(err as Error).message}`, 'ensureDir')
+    throw err
+  }
+}
+
+function stripAnsiCodes(str: string): string {
+  // eslint-disable-next-line no-control-regex
+  return str.replace(/\x1b\[[0-9;?]*[A-Za-z]/g, '')
+}
+
+export function createHandlerLogger(config: ConfigService, handler: string) {
+  const safeHandler = handler.replace(/[^a-zA-Z0-9-_]/g, '_').toLowerCase()
+  const logDir = config.get('cron.logDirectory') || path.join(process.cwd(), 'logs', 'handlers')
+  const logFile = path.join(logDir, `${safeHandler}.log`)
+
+  let stream: fs.WriteStream | null = null
+  let streamError: Error | null = null
+
+  try {
+    ensureDir(logDir)
+    stream = fs.createWriteStream(logFile, { flags: 'a' })
+
+    stream.on('error', (err) => {
+      streamError = err
+      Logger.error(`Error writing to handler log file ${logFile}: ${err.message}`, createHandlerLogger.name)
+    })
+
+    Logger.debug(`Handler logger created for <${handler}> at ${logFile}`, createHandlerLogger.name)
+  } catch (err) {
+    streamError = err as Error
+    Logger.error(`Failed to create handler logger for <${handler}>: ${(err as Error).message}`, createHandlerLogger.name)
+  }
+
+  const log = (msg: string) => {
+    if (stream && !streamError) {
+      stream.write(`${stripAnsiCodes(msg)}`)
+    }
+  }
+
+  const error = (msg: string) => {
+    if (stream && !streamError) {
+      stream.write(`⚠ ${stripAnsiCodes(msg)}`)
+    }
+  }
+
+  const jump = (quantity: number) => {
+    if (stream && !streamError) {
+      stream.write(`${stripAnsiCodes('\n'.repeat(quantity))}`)
+    }
+  }
+
+  return {
+    log: (msg: string) => log(msg),
+    error: (msg: string) => error(msg),
+    close: () => () => {
+      jump(2)
+      stream?.close()
+    },
+    file: logFile,
+  }
+}

apps/api/src/_common/functions/handler-logger.ts

@@ -8,7 +8,8 @@ import { JwtModuleOptions } from '@nestjs/jwt'
 import { StorageManagerConfig } from '~/_common/factorydrive'
 import { AmazonWebServicesS3StorageConfig } from '~/_common/factorydrive'
 import { HttpModuleOptions } from '@nestjs/axios'
-import { join } from 'path'
+import path, { join } from 'path'
+import { CronExpression } from '@nestjs/schedule'
 
 /**
  * Répertoire de base de l'application API
@@ -147,6 +148,15 @@ export const validationSchema = Joi.object({
   SESAME_SMPP_REGIONCODE: Joi
     .string()
     .default('FR'),
+
+  SESAME_CRON_HANDLER_EXPRESSION: Joi
+    .string()
+    .pattern(/^(\*|([0-5]?\d))(\/\d+)? (\*|([01]?\d|2[0-3]))(\/\d+)? (\*|([01]?\d|2[0-9]|3[01]))(\/\d+)? (\*|(1[0-2]|0?[1-9]))(\/\d+)? (\*|([0-6]))(\/\d+)?$/)
+    .default(CronExpression.EVERY_HOUR),
+
+  SESAME_CRON_LOG_DIRECTORY: Joi
+    .string()
+    .default(path.join(process.cwd(), 'logs', 'handlers')),
 });
 
 /**
@@ -189,14 +199,18 @@ export interface ConfigInstance {
     uri: string;
     options: MongooseModuleOptions
     plugins: MongoosePlugin[]
-  };
+  }
   ioredis: {
     uri: string
     options: RedisOptions
-  };
+  }
   axios: {
     options: HttpModuleOptions
-  };
+  }
+  cron: {
+    handlerExpression: string
+    logDirectory: string
+  }
   factorydrive: {
     options:
     | StorageManagerConfig
@@ -307,6 +321,10 @@ export default (): ConfigInstance => ({
       maxRedirects: parseInt(process.env['SESAME_AXIOS_MAX_REDIRECTS'], 10) || 5,
     },
   },
+  cron: {
+    handlerExpression: process.env['SESAME_CRON_HANDLER_EXPRESSION'] || CronExpression.EVERY_HOUR,
+    logDirectory: process.env['SESAME_CRON_LOG_DIRECTORY'] || path.join(process.cwd(), 'logs', 'handlers'),
+  },
   factorydrive: {
     options: {
       default: 'local',

apps/api/src/config.ts

@@ -3,6 +3,7 @@ import { ModuleRef } from '@nestjs/core'
 import { Command, CommandRunner, InquirerService, Question, QuestionSet, SubCommand } from 'nest-commander'
 import { AgentsCreateDto } from '~/core/agents/_dto/agents.dto'
 import { AgentsService } from '~/core/agents/agents.service'
+import { Agents } from './_schemas/agents.schema'
 
 /**
  * Ensemble de questions interactives pour la création d'un agent.
@@ -116,6 +117,33 @@ export class AgentsCreateCommand extends CommandRunner {
   }
 }
 
+@SubCommand({ name: 'list' })
+export class AgentsListCommand extends CommandRunner {
+  private readonly logger = new Logger(AgentsListCommand.name)
+
+  public constructor(
+    protected moduleRef: ModuleRef,
+    private readonly agentsService: AgentsService,
+  ) {
+    super()
+  }
+
+  async run(_inputs: string[], _options: any): Promise<void> {
+    this.logger.log('Listing agents...')
+    try {
+      const agents = await this.agentsService.find<Agents>({})
+      console.table(agents.map((agent: any) => ({
+        username: agent.username,
+        email: agent.email,
+        displayName: agent.displayName,
+        currentState: agent.state.current,
+      })), ['username', 'email', 'displayName', 'currentState'])
+    } catch (error) {
+      console.error('Error listing agents', error)
+    }
+  }
+}
+
 /**
  * Commande principale pour la gestion des agents.
  *
@@ -127,9 +155,10 @@ export class AgentsCreateCommand extends CommandRunner {
  * @example
  * ```bash
  * yarn run console agents create
+ * yarn run console agents list
  * ```
  */
-@Command({ name: 'agents', arguments: '<task>', subCommands: [AgentsCreateCommand] })
+@Command({ name: 'agents', arguments: '<task>', subCommands: [AgentsCreateCommand, AgentsListCommand] })
 export class AgentsCommand extends CommandRunner {
   /**
    * Constructeur de la commande agents

apps/api/src/core/agents/agents.command.ts

@@ -1,4 +1,4 @@
-import { Body, Controller, Delete, Get, HttpStatus, Param, Patch, Post, Res } from '@nestjs/common'
+import { Body, Controller, Delete, Get, HttpStatus, Param, Patch, Post, Query, Res } from '@nestjs/common'
 import { ApiParam, ApiTags } from '@nestjs/swagger'
 import {
   FilterOptions,
@@ -52,6 +52,12 @@ export class AgentsController extends AbstractController {
     hidden: 1,
   }
 
+  protected static readonly searchFields: PartialProjectionType<any> = {
+    username: 1,
+    displayName: 1,
+    email: 1,
+  };
+
   /**
    * Constructeur du contrôleur agents
    *
@@ -99,12 +105,26 @@ export class AgentsController extends AbstractController {
   @ApiPaginatedDecorator(PickProjectionHelper(AgentsDto, AgentsController.projection))
   public async search(
     @Res() res: Response,
+    @Query('search') search: string,
     @SearchFilterSchema() searchFilterSchema: FilterSchema,
     @SearchFilterOptions() searchFilterOptions: FilterOptions,
   ): Promise<Response> {
-    //TODO: search tree by parentId
+
+    const searchFilter = {}
+
+    if (search && search.trim().length > 0) {
+      const searchRequest = {}
+      searchRequest['$or'] = Object.keys(AgentsController.searchFields).map((key) => {
+        return { [key]: { $regex: `^${search}`, $options: 'i' } }
+      }).filter(item => item !== undefined)
+      searchFilter['$and'] = [searchRequest]
+      searchFilter['$and'].push(searchFilterSchema)
+    } else {
+      Object.assign(searchFilter, searchFilterSchema)
+    }
+
     const [data, total] = await this._service.findAndCount(
-      searchFilterSchema,
+      searchFilter,
       AgentsController.projection,
       searchFilterOptions,
     )