Merge pull request #29 from Libertech-FR/25-gestion-ui-jsonschema

25 gestion UI jsonschema

Author: RICHARD-Quentin

Dockerfile

@@ -16,9 +16,6 @@ RUN yarn install \
   --non-interactive \
   --production=false
 
-RUN apt-get update -y \
-  && apt-get install -y python3
-
 RUN yarn run build
 
 FROM node:18-bookworm-slim AS production
@@ -51,7 +48,9 @@ RUN apt clean -y \
   git \
   jq \
   nano \
-  openssl
+  openssl \
+  python3 \
+  build-essential
 
 RUN yarn install \
   --prefer-offline \

Makefile

@@ -1,9 +1,9 @@
-include .env
 APP_PORT = 4002
 IMG_NAME = "ghcr.io/libertech-fr/sesame-orchestrator"
 BASE_NAME = "sesame"
 APP_NAME = "sesame-orchestrator"
 PLATFORM = "linux/amd64"
+include .env
 
 .DEFAULT_GOAL := help
 help:
@@ -76,7 +76,7 @@ dbs: ## Start databases
 		--health-retries=3 \
 		--health-cmd="redis-cli ping || exit 1" \
 		redis || true
-	@docker exec -it $(BASE_NAME)-mongodb mongosh --eval "rs.initiate({_id: 'rs0', members: [{_id: 0, host: '127.0.0.1:27017'}]})" || true
+	@docker exec -it $(BASE_NAME)-mongodb mongosh --eval "rs.initiate({_id: \"rs0\", members: [{_id: 0, host: \"$(BASE_NAME)-mongodb\"}]})" || true
 
 stop: ## Stop the container
 	@docker stop $(APP_NAME) || true

src/_common/abstracts/abstract.queue.processor.ts

@@ -1,6 +1,7 @@
 import { Queue, QueueEvents } from 'bullmq';
 import { AbstractService, AbstractServiceContext } from './abstract.service';
-import { Redis, getRedisConnectionToken } from '@nestjs-modules/ioredis';
+import { getRedisConnectionToken } from '@nestjs-modules/ioredis';
+import { Redis } from 'ioredis';
 import { OnModuleInit } from '@nestjs/common';
 import { ConfigService } from '@nestjs/config';
 

src/_common/abstracts/abstract.service.schema.ts

@@ -4,6 +4,7 @@ import {
   FilterQuery,
   Model,
   ModifyResult,
+  MongooseBaseQueryOptions,
   ProjectionType,
   Query,
   QueryOptions,
@@ -15,6 +16,7 @@ import { EventEmitterSeparator } from '~/_common/constants/event-emitter.constan
 import { AbstractService, AbstractServiceContext } from './abstract.service';
 import { ServiceSchemaInterface } from './interfaces/service.schema.interface';
 import { AbstractSchema } from './schemas/abstract.schema';
+import mongodb from 'mongodb';
 
 @Injectable()
 export abstract class AbstractServiceSchema extends AbstractService implements ServiceSchemaInterface {
@@ -39,7 +41,7 @@ export abstract class AbstractServiceSchema extends AbstractService implements S
     return await this._model.find<Query<Array<T>, T, any, T>>(filter, projection, options).exec()
   }
 
-  public async count<T extends AbstractSchema | Document>(filter?: FilterQuery<T>, options?: QueryOptions<T>): Promise<number> {
+  public async count<T extends AbstractSchema | Document>(filter?: FilterQuery<T>, options?: (mongodb.CountOptions & MongooseBaseQueryOptions<T>) | null): Promise<number> {
     //TODO: add event emitter
     this.logger.debug(['count', JSON.stringify(Object.values(arguments))].join(' '))
     return await this._model.countDocuments(filter, options).exec()
@@ -243,7 +245,7 @@ export abstract class AbstractServiceSchema extends AbstractService implements S
       }
     }
     return updated
-  }    
+  }
 
   public async upsert<T extends AbstractSchema | Document>(
   filter: FilterQuery<T>,
@@ -299,7 +301,7 @@ export abstract class AbstractServiceSchema extends AbstractService implements S
 
     return result;
   }
-  
+
 
   public async delete<T extends AbstractSchema | Document>(_id: Types.ObjectId | any, options?: QueryOptions<T> | null | undefined): Promise<Query<T, T, any, T>> {
     this.logger.debug(['delete', JSON.stringify(Object.values(arguments))].join(' '))

src/management/identities/_dto/_parts/additionalFields.dto.ts

@@ -14,4 +14,10 @@ export class additionalFieldsPartDto {
     name: 'attributes',
   })
   attributes: { [key: string]: any };
+
+  @ApiProperty({
+    type: 'object',
+    name: 'validations',
+  })
+  validations?: { [key: string]: { [key: string]: string } };
 }

src/management/identities/_dto/identities.dto.ts

@@ -5,8 +5,9 @@ import { IdentityState } from '../_enums/states.enum';
 import { IdentityLifecycle } from '../_enums/lifecycle.enum';
 import { Type } from 'class-transformer';
 import { additionalFieldsPartDto } from './_parts/additionalFields.dto';
+import { MetadataDto } from '~/_common/abstracts/dto/metadata.dto';
 
-export class IdentitiesCreateDto {
+export class IdentitiesCreateDto extends MetadataDto {
   @IsNumber()
   @IsEnum(IdentityState)
   @ApiProperty({ enum: IdentityState })

src/management/identities/identities.controller.ts

@@ -121,25 +121,28 @@ export class IdentitiesController extends AbstractController {
     @Res() res: Response,
     @SearchFilterSchema() searchFilterSchema: FilterSchema,
     @SearchFilterOptions() searchFilterOptions: FilterOptions,
-  ): Promise<Response> {
-    try {
-      const [data, total] = await this._service.findAndCount(
-        searchFilterSchema,
-        IdentitiesController.projection,
-        searchFilterOptions,
-      );
-      return res.status(HttpStatus.OK).json({
-        statusCode: HttpStatus.OK,
-        total,
-        data,
-      });
-    } catch (error) {
-      return res.status(HttpStatus.BAD_REQUEST).json({
-        statusCode: HttpStatus.BAD_REQUEST,
-        message: error.message,
-        validations: error.validations,
-      });
-    }
+  ): Promise<
+    Response<
+      {
+        statusCode: number;
+        data?: Document<Identities, any, Identities>;
+        total?: number;
+        message?: string;
+        validations?: MixedValue;
+      },
+      any
+    >
+  > {
+    const [data, total] = await this._service.findAndCount(
+      searchFilterSchema,
+      IdentitiesController.projection,
+      searchFilterOptions,
+    );
+    return res.status(HttpStatus.OK).json({
+      statusCode: HttpStatus.OK,
+      total,
+      data,
+    });
   }
 
   @Get(':_id([0-9a-fA-F]{24})')

src/management/identities/identities.module.ts

@@ -1,12 +1,12 @@
-import { HttpException, Logger, Module } from '@nestjs/common';
+import { Module } from '@nestjs/common';
 import { MongooseModule } from '@nestjs/mongoose';
-import { IdentitiesSchema, Identities } from './_schemas/identities.schema';
+import { Identities, IdentitiesSchema } from './_schemas/identities.schema';
 import { IdentitiesService } from './identities.service';
 import { IdentitiesController } from './identities.controller';
 import { IdentitiesValidationService } from './validations/identities.validation.service';
 import { IdentitiesValidationModule } from './validations/identities.validation.module';
-import { IdentityState } from './_enums/states.enum';
-import { ValidationConfigException, ValidationSchemaException } from '~/_common/errors/ValidationException';
+import { IdentitiesJsonformsService } from './jsonforms/identities.jsonforms.service';
+import { IdentitiesJsonformsModule } from './jsonforms/identities.jsonforms.module';
 import { APP_FILTER } from '@nestjs/core';
 import { IdentitiesValidationFilter } from '~/_common/filters/identities-validation.filter';
 
@@ -15,32 +15,9 @@ import { IdentitiesValidationFilter } from '~/_common/filters/identities-validat
     MongooseModule.forFeatureAsync([
       {
         name: Identities.name,
-        imports: [IdentitiesValidationModule],
-        inject: [IdentitiesValidationService],
-        useFactory: (validationService: IdentitiesValidationService) => {
-          const schema = IdentitiesSchema;
-
-          schema.pre('validate', async function (next) {
-            const logPrefix = `Validation [${this.inetOrgPerson.cn}]:`;
-            try {
-              Logger.log(`${logPrefix} Starting additionalFields validation.`);
-              await validationService.validate(this.additionalFields);
-              Logger.log(`${logPrefix} AdditionalFields validation successful.`);
-            } catch (error) {
-              handleValidationError(error, this, logPrefix);
-            }
-            next();
-          });
-
-          schema.pre('save', async function (next) {
-            if (this.state === IdentityState.TO_CREATE) {
-              this.state = IdentityState.TO_VALIDATE;
-            }
-            next();
-          });
-
-          return schema;
-        },
+        imports: [IdentitiesValidationModule, IdentitiesJsonformsModule],
+        inject: [IdentitiesValidationService, IdentitiesJsonformsService],
+        useFactory: () => IdentitiesSchema,
       },
     ]),
   ],
@@ -51,29 +28,8 @@ import { IdentitiesValidationFilter } from '~/_common/filters/identities-validat
       provide: APP_FILTER,
       useClass: IdentitiesValidationFilter,
     },
+    IdentitiesJsonformsService,
   ],
   controllers: [IdentitiesController],
 })
 export class IdentitiesModule {}
-
-function handleValidationError(error: Error | HttpException, identity: Identities, logPrefix: string) {
-  if (error instanceof ValidationConfigException) {
-    Logger.error(`${logPrefix} Validation config error. ${JSON.stringify(error.getValidations())}`);
-    throw new ValidationConfigException(error.getPayload());
-  }
-
-  if (error instanceof ValidationSchemaException) {
-    Logger.warn(`${logPrefix} Validation schema error. ${JSON.stringify(error.getValidations())}`);
-    if (identity.state === IdentityState.TO_CREATE) {
-      Logger.warn(`${logPrefix} State set to TO_COMPLETE.`);
-      identity.state = IdentityState.TO_COMPLETE;
-      identity.additionalFields.validations = error.getValidations();
-    } else {
-      Logger.error(`${logPrefix} Validation schema error. ${JSON.stringify(error.getValidations())}`);
-      throw new ValidationSchemaException(error.getPayload());
-    }
-  } else {
-    Logger.error(`${logPrefix} Unhandled error: ${error.message}`);
-    throw error; // Rethrow the original error if it's not one of the handled types.
-  }
-}

src/management/identities/identities.service.ts

@@ -34,10 +34,10 @@ export class IdentitiesService extends AbstractServiceSchema {
     const logPrefix = `Validation [${data.inetOrgPerson.cn}]:`;
     data.additionalFields.validations = {};
     try {
-      Logger.log(`${logPrefix} Starting additionalFields validation.`);
+      this.logger.log(`${logPrefix} Starting additionalFields validation.`);
       const validations = await this._validation.validate(data.additionalFields);
-      Logger.log(`${logPrefix} AdditionalFields validation successful.`);
-      Logger.log(`Validations : ${validations}`);
+      this.logger.log(`${logPrefix} AdditionalFields validation successful.`);
+      this.logger.log(`Validations : ${validations}`);
       data.state = IdentityState.TO_VALIDATE;
     } catch (error) {
       data = this.handleValidationError(error, data, logPrefix);
@@ -46,7 +46,7 @@ export class IdentitiesService extends AbstractServiceSchema {
     //TODO: ameliorer la logique d'upsert
     const identity = await this._model.findOne({ 'inetOrgPerson.uid': data.inetOrgPerson.uid });
     if (identity) {
-      Logger.log(`${logPrefix} Identity already exists. Updating.`);
+      this.logger.log(`${logPrefix} Identity already exists. Updating.`);
       data.additionalFields.objectClasses = [
         ...new Set([...identity.additionalFields.objectClasses, ...data.additionalFields.objectClasses]),
       ];
@@ -71,6 +71,28 @@ export class IdentitiesService extends AbstractServiceSchema {
     options?: QueryOptions<T> & { rawResult: true },
   ): Promise<ModifyResult<Query<T, T, any, T>>> {
     // noinspection UnnecessaryLocalVariableJS
+    //TODO : add validation logic here
+    const logPrefix = `Validation [${update.inetOrgPerson.cn}]:`;
+    try {
+      this.logger.log(`${logPrefix} Starting additionalFields validation.`);
+      const validations = await this._validation.validate(update.additionalFields);
+      this.logger.log(`${logPrefix} AdditionalFields validation successful.`);
+      this.logger.log(`Validations : ${validations}`);
+    } catch (error) {
+      if (error instanceof ValidationConfigException) {
+        this.logger.error(`${logPrefix} Validation config error. ${JSON.stringify(error.getValidations())}`);
+        throw new ValidationConfigException(error.getPayload());
+      }
+      if (error instanceof ValidationSchemaException) {
+        this.logger.warn(`${logPrefix} Validation schema error. ${JSON.stringify(error.getValidations())}`);
+        update.additionalFields.validations = error.getValidations();
+        throw new ValidationSchemaException(error.getPayload());
+      } else {
+        this.logger.error(`${logPrefix} Unhandled error: ${error.message}`);
+        throw error; // Rethrow the original error if it's not one of the handled types.
+      }
+    }
+    //update.state = IdentityState.TO_VALIDATE;
     const updated = await super.update(_id, update, options);
     //TODO: add backends service logic here (TO_SYNC)
     return updated;
@@ -89,23 +111,23 @@ export class IdentitiesService extends AbstractServiceSchema {
 
   private handleValidationError(error: Error | HttpException, identity: Identities, logPrefix: string) {
     if (error instanceof ValidationConfigException) {
-      Logger.error(`${logPrefix} Validation config error. ${JSON.stringify(error.getValidations())}`);
+      this.logger.error(`${logPrefix} Validation config error. ${JSON.stringify(error.getValidations())}`);
       throw new ValidationConfigException(error.getPayload());
     }
 
     if (error instanceof ValidationSchemaException) {
-      Logger.warn(`${logPrefix} Validation schema error. ${JSON.stringify(error.getValidations())}`);
+      this.logger.warn(`${logPrefix} Validation schema error. ${JSON.stringify(error.getValidations())}`);
       identity.additionalFields.validations = error.getValidations();
       if (identity.state === IdentityState.TO_CREATE) {
-        Logger.warn(`${logPrefix} State set to TO_COMPLETE.`);
+        this.logger.warn(`${logPrefix} State set to TO_COMPLETE.`);
         identity.state = IdentityState.TO_COMPLETE;
         return identity;
       } else {
-        Logger.error(`${logPrefix} Validation schema error. ${JSON.stringify(error.getValidations())}`);
+        this.logger.error(`${logPrefix} Validation schema error. ${JSON.stringify(error.getValidations())}`);
         throw new ValidationSchemaException(error.getPayload());
       }
     } else {
-      Logger.error(`${logPrefix} Unhandled error: ${error.message}`);
+      this.logger.error(`${logPrefix} Unhandled error: ${error.message}`);
       throw error; // Rethrow the original error if it's not one of the handled types.
     }
   }