Add Joi for environment variable validation and update lifecycle service cron expression

Author: tacxou

package.json

@@ -82,6 +82,7 @@
     "hibp": "^14.1.2",
     "ioredis": "^5.4.1",
     "is-plain-object": "^5.0.0",
+    "joi": "^18.0.1",
     "loglevel": "^1.9.1",
     "lru-cache": "^11.0.2",
     "microdiff": "^1.5.0",

src/config.ts

@@ -2,12 +2,133 @@ import { MongooseModuleOptions } from '@nestjs/mongoose';
 import { RedisOptions } from 'ioredis';
 import { HelmetOptions } from 'helmet';
 import { SwaggerCustomOptions } from '@nestjs/swagger';
+import Joi from 'joi';
 import { IAuthModuleOptions } from '@nestjs/passport';
 import { JwtModuleOptions } from '@nestjs/jwt';
 import { StorageManagerConfig } from '~/_common/factorydrive';
 import { AmazonWebServicesS3StorageConfig } from '~/_common/factorydrive';
 import { HttpModuleOptions } from '@nestjs/axios';
 
+export const validationSchema = Joi.object({
+  LANG: Joi
+    .string()
+    .default('en'),
+
+  SESAME_LOG_LEVEL: Joi
+    .string()
+    .valid('error', 'warn', 'info', 'debug')
+    .default('info'),
+
+  SESAME_NAME_QUEUE: Joi
+    .string()
+    .default('sesame'),
+
+  SESAME_HTTPS_ENABLED: Joi
+    .string()
+    .valid('0', '1', 'true', 'false', 'on', 'off')
+    .default('false'),
+
+  SESAME_HTTPS_PATH_KEY: Joi
+    .string()
+    .when('SESAME_HTTPS_ENABLED', {
+      is: /yes|1|on|true/i,
+      then: Joi.required(),
+      otherwise: Joi.optional().allow(''),
+    })
+    .default(''),
+
+  SESAME_HTTPS_PATH_CERT: Joi
+    .string()
+    .when('SESAME_HTTPS_ENABLED', {
+      is: /yes|1|on|true/i,
+      then: Joi.required(),
+      otherwise: Joi.optional().allow(''),
+    })
+    .default(''),
+
+  SESAME_REDIS_URI: Joi
+    .string()
+    .uri()
+    .default('redis://localhost:6379/0'),
+
+  SESAME_MONGO_URI: Joi
+    .string()
+    .uri()
+    .default('mongodb://localhost:27017/backend'),
+
+  SESAME_AXIOS_TIMEOUT: Joi
+    .number()
+    .integer()
+    .min(1)
+    .default(5000),
+
+  SESAME_AXIOS_MAX_REDIRECTS: Joi
+    .number()
+    .integer()
+    .min(0)
+    .default(5),
+
+  SESAME_JWT_SECRET: Joi
+    .string()
+    .required(),
+
+  SESAME_SMTP_SERVER: Joi
+    .string()
+    .hostname()
+    .required(),
+
+  SESAME_SMTP_PORT: Joi
+    .number()
+    .integer()
+    .min(1)
+    .max(65535)
+    .default(25),
+
+  SESAME_MDP_SENDER: Joi
+    .string()
+    .email()
+    .default(''),
+
+  SESAME_FRONT_MDP: Joi
+    .string()
+    .uri()
+    .required(),
+
+  SESAME_RESET_PWD_MAIL: Joi
+    .string()
+    .default(''),
+
+  SESAME_RESET_PWD_MOBILE: Joi
+    .string()
+    .default(''),
+
+  SESAME_LIFECYCLE_TRIGGER_CRON: 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('*/5 * * * *'),
+
+  SESAME_SMPP_SERVER: Joi
+    .string()
+    .hostname()
+    .default(''),
+
+  SESAME_SMPP_SYSTEMID: Joi
+    .string()
+    .default(''),
+
+  SESAME_SMPP_PASSWORD: Joi
+    .string()
+    .default(''),
+
+  SESAME_SMPP_SOURCEADDR: Joi
+    .string()
+    .default(''),
+
+  SESAME_SMPP_REGIONCODE: Joi
+    .string()
+    .default('FR'),
+});
+
 export interface MongoosePlugin {
   package: string;
   enabled?: boolean;
@@ -75,6 +196,9 @@ export interface ConfigInstance {
     identityMailAttribute: string;
     identityMobileAttribute: string;
   };
+  lifecycle: {
+    triggerCronExpression: string;
+  };
   swagger: {
     path: string;
     api: string;
@@ -184,6 +308,9 @@ export default (): ConfigInstance => ({
     identityMailAttribute: process.env['SESAME_RESET_PWD_MAIL'] || '',
     identityMobileAttribute: process.env['SESAME_RESET_PWD_MOBILE'] || '',
   },
+  lifecycle: {
+    triggerCronExpression: process.env['SESAME_LIFECYCLE_TRIGGER_CRON'] || '*/5 * * * *',
+  },
   sms: {
     host: process.env['SESAME_SMPP_SERVER'] || '',
     systemId: process.env['SESAME_SMPP_SYSTEMID'] || '',

src/management/lifecycle/lifecycle.service.ts

@@ -14,6 +14,7 @@ import { Identities } from '../identities/_schemas/identities.schema';
 import { IdentitiesCrudService } from '../identities/identities-crud.service';
 import { ConfigObjectIdentitiesDTO, ConfigObjectSchemaDTO } from './_dto/config.dto';
 import { Lifecycle, LifecycleRefId } from './_schemas/lifecycle.schema';
+import { ConfigService } from '@nestjs/config';
 
 interface LifecycleSource {
   [source: string]: Partial<ConfigObjectIdentitiesDTO>[];
@@ -27,6 +28,7 @@ export class LifecycleService extends AbstractServiceSchema implements OnApplica
     @InjectModel(Lifecycle.name) protected _model: Model<Lifecycle>,
     protected readonly identitiesService: IdentitiesCrudService,
     private schedulerRegistry: SchedulerRegistry,
+    private configService: ConfigService,
   ) {
     super();
   }
@@ -79,8 +81,10 @@ export class LifecycleService extends AbstractServiceSchema implements OnApplica
 
     const lifecycleRules = await this.loadLifecycleRules();
 
-    const job = new CronJob('*/5 * * * * *', this.handleCron.bind(this, { lifecycleRules }));
+    const cronExpression = this.configService.get<string>('lifecycle.triggerCronExpression') || '*/5 * * * *';
+    const job = new CronJob(cronExpression, this.handleCron.bind(this, { lifecycleRules }));
     this.schedulerRegistry.addCronJob(`lifecycle-trigger`, job);
+    this.logger.warn(`Lifecycle trigger cron job scheduled with expression: <${cronExpression}>`);
     job.start();
 
     this.logger.log('LifecycleService bootstraped');

yarn.lock

@@ -2079,6 +2079,40 @@
   dependencies:
     lodash "^4.17.21"
 
+"@hapi/address@^5.1.1":
+  version "5.1.1"
+  resolved "https://registry.yarnpkg.com/@hapi/address/-/address-5.1.1.tgz#e9925fc1b65f5cc3fbea821f2b980e4652e84cb6"
+  integrity sha512-A+po2d/dVoY7cYajycYI43ZbYMXukuopIsqCjh5QzsBCipDtdofHntljDlpccMjIfTy6UOkg+5KPriwYch2bXA==
+  dependencies:
+    "@hapi/hoek" "^11.0.2"
+
+"@hapi/formula@^3.0.2":
+  version "3.0.2"
+  resolved "https://registry.yarnpkg.com/@hapi/formula/-/formula-3.0.2.tgz#81b538060ee079481c906f599906d163c4badeaf"
+  integrity sha512-hY5YPNXzw1He7s0iqkRQi+uMGh383CGdyyIGYtB+W5N3KHPXoqychklvHhKCC9M3Xtv0OCs/IHw+r4dcHtBYWw==
+
+"@hapi/hoek@^11.0.2", "@hapi/hoek@^11.0.7":
+  version "11.0.7"
+  resolved "https://registry.yarnpkg.com/@hapi/hoek/-/hoek-11.0.7.tgz#56a920793e0a42d10e530da9a64cc0d3919c4002"
+  integrity sha512-HV5undWkKzcB4RZUusqOpcgxOaq6VOAH7zhhIr2g3G8NF/MlFO75SjOr2NfuSx0Mh40+1FqCkagKLJRykUWoFQ==
+
+"@hapi/pinpoint@^2.0.1":
+  version "2.0.1"
+  resolved "https://registry.yarnpkg.com/@hapi/pinpoint/-/pinpoint-2.0.1.tgz#32077e715655fc00ab8df74b6b416114287d6513"
+  integrity sha512-EKQmr16tM8s16vTT3cA5L0kZZcTMU5DUOZTuvpnY738m+jyP3JIUj+Mm1xc1rsLkGBQ/gVnfKYPwOmPg1tUR4Q==
+
+"@hapi/tlds@^1.1.1":
+  version "1.1.3"
+  resolved "https://registry.yarnpkg.com/@hapi/tlds/-/tlds-1.1.3.tgz#bf5fee927d213f140cd54d4650965e504a546789"
+  integrity sha512-QIvUMB5VZ8HMLZF9A2oWr3AFM430QC8oGd0L35y2jHpuW6bIIca6x/xL7zUf4J7L9WJ3qjz+iJII8ncaeMbpSg==
+
+"@hapi/topo@^6.0.2":
+  version "6.0.2"
+  resolved "https://registry.yarnpkg.com/@hapi/topo/-/topo-6.0.2.tgz#f219c1c60da8430228af4c1f2e40c32a0d84bbb4"
+  integrity sha512-KR3rD5inZbGMrHmgPxsJ9dbi6zEK+C3ZwUwTa+eMwWLz7oijWUTWD2pMSNNYJAU6Qq+65NkxXjqHr/7LM2Xkqg==
+  dependencies:
+    "@hapi/hoek" "^11.0.2"
+
 "@humanfs/core@^0.19.1":
   version "0.19.1"
   resolved "https://registry.yarnpkg.com/@humanfs/core/-/core-0.19.1.tgz#17c55ca7d426733fe3c561906b8173c336b40a77"
@@ -3247,6 +3281,11 @@
   dependencies:
     tslib "^2.6.2"
 
+"@standard-schema/spec@^1.0.0":
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/@standard-schema/spec/-/spec-1.0.0.tgz#f193b73dc316c4170f2e82a881da0f550d551b9c"
+  integrity sha512-m2bOd0f2RT9k8QJx1JN85cZYyH1RqFBdlwtkSlf4tBDYLCiiZnv1fIIwacK6cqwXavOydf0NPToMQgpKq+dVlA==
+
 "@swc/cli@^0.5.1":
   version "0.5.1"
   resolved "https://registry.yarnpkg.com/@swc/cli/-/cli-0.5.1.tgz#911dc47f68baaa2bdffc259c4fa2cc7fe48bb825"
@@ -7604,6 +7643,19 @@ jest@^29.7.0:
     import-local "^3.0.2"
     jest-cli "^29.7.0"
 
+joi@^18.0.1:
+  version "18.0.1"
+  resolved "https://registry.yarnpkg.com/joi/-/joi-18.0.1.tgz#1e1885d035cc6ca1624e81bf22112e7c1ee38e1b"
+  integrity sha512-IiQpRyypSnLisQf3PwuN2eIHAsAIGZIrLZkd4zdvIar2bDyhM91ubRjy8a3eYablXsh9BeI/c7dmPYHca5qtoA==
+  dependencies:
+    "@hapi/address" "^5.1.1"
+    "@hapi/formula" "^3.0.2"
+    "@hapi/hoek" "^11.0.7"
+    "@hapi/pinpoint" "^2.0.1"
+    "@hapi/tlds" "^1.1.1"
+    "@hapi/topo" "^6.0.2"
+    "@standard-schema/spec" "^1.0.0"
+
 js-beautify@^1.6.14:
   version "1.15.1"
   resolved "https://registry.yarnpkg.com/js-beautify/-/js-beautify-1.15.1.tgz#4695afb508c324e1084ee0b952a102023fc65b64"