766 store circuit inputs translation schema

examples/bri-3/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "typescript.tsdk": "node_modules/typescript/lib"
+}

examples/bri-3/prisma/migrations/20240411211906_add_circuitinputstranslationschema_to_workstep/migration.sql

@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "Workstep" ADD COLUMN     "circuitInputsTranslationSchema" JSONB;

examples/bri-3/prisma/schema.prisma

@@ -70,6 +70,7 @@ model Workstep {
   workgroupId    String
   securityPolicy String
   privacyPolicy  String
+  circuitInputsTranslationSchema Json?
   workflow       Workflow[]
   workgroup      Workgroup  @relation(fields: [workgroupId], references: [id])
 }

examples/bri-3/src/bri/communication/agents/messaging.agent.spec.ts

@@ -31,14 +31,12 @@
     const rawMessage = 'test';
 
     // Act
     const [resultDto, validationErrors] =
       messagingAgent.tryDeserializeToBpiMessageCandidate(rawMessage);
 
     // Assert
     expect(validationErrors.length).toBe(1);
-    expect(validationErrors[0]).toEqual(
-      'test is not valid JSON. Error: SyntaxError: Unexpected token e in JSON at position 1',
-    );
+    expect(validationErrors[0]).toMatch(/^test is not valid JSON./);
   });
 
   it('Should return error when validating correct JSON raw message with invalid UUID in id field', () => {

examples/bri-3/src/bri/workgroup/worksteps/agents/worksteps.agent.ts

@@ -1,13 +1,21 @@
-import { Injectable, NotFoundException } from '@nestjs/common';
+import {
+  BadRequestException,
+  Injectable,
+  NotFoundException,
+} from '@nestjs/common';
 import { Workstep } from '../models/workstep';
 
 import { v4 } from 'uuid';
+import { CircuitInputsParserService } from '../../../zeroKnowledgeProof/services/circuit/circuitInputsParser/circuitInputParser.service';
 import { NOT_FOUND_ERR_MESSAGE } from '../api/err.messages';
 import { WorkstepStorageAgent } from './workstepsStorage.agent';
 
 @Injectable()
 export class WorkstepAgent {
-  constructor(private storageAgent: WorkstepStorageAgent) {}
+  constructor(
+    private storageAgent: WorkstepStorageAgent,
+    private cips: CircuitInputsParserService,
+  ) {}
 
   public createNewWorkstep(
     name: string,
@@ -57,6 +65,20 @@ export class WorkstepAgent {
     workstepToUpdate.updatePrivacyPolicy(privacyPolicy);
   }
 
+  public throwIfCircuitInputTranslationSchemaInvalid(schema): void {
+    const error = this.cips.validateCircuitInputTranslationSchema(schema);
+    if (error) {
+      throw new BadRequestException(error);
+    }
+  }
+
+  public updateCircuitInputTranslationSchema(
+    workstepToUpdate: Workstep,
+    schema: string,
+  ): void {
+    workstepToUpdate.updateCircuitInputTranslationSchema(schema);
+  }
+
   public async fetchDeleteCandidateAndThrowIfDeleteValidationFails(
     id: string,
   ): Promise<Workstep> {

examples/bri-3/src/bri/workgroup/worksteps/api/dtos/request/updateCircuitInputsSchema.dto.spec.ts

@@ -0,0 +1,40 @@
+import { plainToInstance } from 'class-transformer';
+import { validate } from 'class-validator';
+import { SHOULD_NOT_BE_EMPTY_VALIDATION_MESSAGE } from '../../../../../shared/constants';
+import { UpdateCircuitInputsSchemaDto } from './updateCircuitInputsSchema.dto';
+
+describe('UpdateCircuitInputsSchemaDto', () => {
+  it('should return error in case schema not provided.', async () => {
+    // Arrange
+    const dto = { wrong: '1' };
+    const setCircuitInputsSchemaDto = plainToInstance(
+      UpdateCircuitInputsSchemaDto,
+      dto,
+    );
+
+    // Act
+    const errors = await validate(setCircuitInputsSchemaDto);
+
+    // Assert
+    expect(errors.length).toBe(1);
+    expect(errors[0].property).toEqual('schema');
+    expect(errors[0].constraints?.isNotEmpty).toContain(
+      'schema ' + SHOULD_NOT_BE_EMPTY_VALIDATION_MESSAGE,
+    );
+  });
+
+  it('should return no error if all required properties provided.', async () => {
+    // Arrange
+    const dto = { schema: 'test' };
+    const setCircuitInputsSchemaDto = plainToInstance(
+      UpdateCircuitInputsSchemaDto,
+      dto,
+    );
+
+    // Act
+    const errors = await validate(setCircuitInputsSchemaDto);
+
+    // Assert
+    expect(errors.length).toBe(0);
+  });
+});

examples/bri-3/src/bri/workgroup/worksteps/api/dtos/request/updateCircuitInputsSchema.dto.ts

@@ -0,0 +1,6 @@
+import { IsNotEmpty } from 'class-validator';
+
+export class UpdateCircuitInputsSchemaDto {
+  @IsNotEmpty()
+  schema: string;
+}

examples/bri-3/src/bri/workgroup/worksteps/api/dtos/response/workstep.dto.ts

@@ -21,4 +21,7 @@ export class WorkstepDto {
 
   @AutoMap()
   privacyPolicy: string;
+
+  @AutoMap()
+  circuitInputsTranslationSchema: string;
 }

examples/bri-3/src/bri/workgroup/worksteps/api/worksteps.controller.spec.ts

@@ -1,24 +1,26 @@
+import { classes } from '@automapper/classes';
+import { AutomapperModule } from '@automapper/nestjs';
 import { NotFoundException } from '@nestjs/common';
 import { CqrsModule } from '@nestjs/cqrs';
 import { Test, TestingModule } from '@nestjs/testing';
+import { DeepMockProxy, mockDeep } from 'jest-mock-extended';
+import { validate as uuidValidate, version as uuidVersion } from 'uuid';
+import { uuid } from 'uuidv4';
+import { LoggingService } from '../../../../shared/logging/logging.service';
+import { CircuitInputsParserService } from '../../../zeroKnowledgeProof/services/circuit/circuitInputsParser/circuitInputParser.service';
 import { WorkstepAgent } from '../agents/worksteps.agent';
+import { WorkstepStorageAgent } from '../agents/workstepsStorage.agent';
 import { CreateWorkstepCommandHandler } from '../capabilities/createWorkstep/createWorkstepCommand.handler';
 import { DeleteWorkstepCommandHandler } from '../capabilities/deleteWorkstep/deleteWorkstepCommand.handler';
 import { GetAllWorkstepsQueryHandler } from '../capabilities/getAllWorksteps/getAllWorkstepsQuery.handler';
 import { GetWorkstepByIdQueryHandler } from '../capabilities/getWorkstepById/getWorkstepByIdQuery.handler';
 import { UpdateWorkstepCommandHandler } from '../capabilities/updateWorkstep/updateWorkstep.command.handler';
-import { WorkstepStorageAgent } from '../agents/workstepsStorage.agent';
+import { Workstep } from '../models/workstep';
+import { WorkstepProfile } from '../workstep.profile';
 import { CreateWorkstepDto } from './dtos/request/createWorkstep.dto';
 import { UpdateWorkstepDto } from './dtos/request/updateWorkstep.dto';
 import { NOT_FOUND_ERR_MESSAGE } from './err.messages';
 import { WorkstepController } from './worksteps.controller';
-import { validate as uuidValidate, version as uuidVersion } from 'uuid';
-import { WorkstepProfile } from '../workstep.profile';
-import { classes } from '@automapper/classes';
-import { AutomapperModule } from '@automapper/nestjs';
-import { mockDeep, DeepMockProxy } from 'jest-mock-extended';
-import { Workstep } from '../models/workstep';
-import { uuid } from 'uuidv4';
 
 describe('WorkstepController', () => {
   let wController: WorkstepController;
@@ -47,6 +49,8 @@ describe('WorkstepController', () => {
       controllers: [WorkstepController],
       providers: [
         WorkstepAgent,
+        CircuitInputsParserService,
+        LoggingService,
         CreateWorkstepCommandHandler,
         UpdateWorkstepCommandHandler,
         DeleteWorkstepCommandHandler,

examples/bri-3/src/bri/workgroup/worksteps/api/worksteps.controller.ts

@@ -9,11 +9,13 @@ import {
 } from '@nestjs/common';
 import { CommandBus, QueryBus } from '@nestjs/cqrs';
 import { CheckAuthz } from '../../../authz/guards/authz.decorator';
+import { UpdateCircuitInputsSchemaCommand } from '../capabilities/updateCircuitInputsSchema/updateCircuitInputsSchema.command';
 import { CreateWorkstepCommand } from '../capabilities/createWorkstep/createWorkstep.command';
 import { DeleteWorkstepCommand } from '../capabilities/deleteWorkstep/deleteWorkstep.command';
 import { GetAllWorkstepsQuery } from '../capabilities/getAllWorksteps/getAllWorksteps.query';
 import { GetWorkstepByIdQuery } from '../capabilities/getWorkstepById/getWorkstepById.query';
 import { UpdateWorkstepCommand } from '../capabilities/updateWorkstep/updateWorkstep.command';
+import { UpdateCircuitInputsSchemaDto } from './dtos/request/updateCircuitInputsSchema.dto';
 import { CreateWorkstepDto } from './dtos/request/createWorkstep.dto';
 import { UpdateWorkstepDto } from './dtos/request/updateWorkstep.dto';
 import { WorkstepDto } from './dtos/response/workstep.dto';
@@ -71,6 +73,17 @@ export class WorkstepController {
     );
   }
 
+  @Put('/:id/circuitinputsschema')
+  @CheckAuthz({ action: 'update', type: 'Workstep' })
+  async updateCircuitInputsSchemaCommand(
+    @Param('id') id: string,
+    @Body() requestDto: UpdateCircuitInputsSchemaDto,
+  ): Promise<WorkstepDto> {
+    return await this.commandBus.execute(
+      new UpdateCircuitInputsSchemaCommand(id, requestDto.schema),
+    );
+  }
+
   @Delete('/:id')
   @CheckAuthz({ action: 'delete', type: 'Workstep' })
   async deleteWorkstep(@Param('id') id: string): Promise<void> {

examples/bri-3/src/bri/workgroup/worksteps/capabilities/updateCircuitInputsSchema/updateCircuitInputsSchema.command.handler.ts

@@ -0,0 +1,39 @@
+import { CommandHandler, ICommandHandler } from '@nestjs/cqrs';
+import { WorkstepAgent } from '../../agents/worksteps.agent';
+import { WorkstepStorageAgent } from '../../agents/workstepsStorage.agent';
+import { UpdateCircuitInputsSchemaCommand } from './updateCircuitInputsSchema.command';
+import { InjectMapper } from '@automapper/nestjs';
+import { Mapper } from '@automapper/core';
+import { Workstep } from '../../models/workstep';
+import { WorkstepDto } from '../../api/dtos/response/workstep.dto';
+
+@CommandHandler(UpdateCircuitInputsSchemaCommand)
+export class UpdateCircuitInputsSchemaCommandHandler
+  implements ICommandHandler<UpdateCircuitInputsSchemaCommand>
+{
+  constructor(
+    @InjectMapper() private readonly mapper: Mapper,
+    private agent: WorkstepAgent,
+    private storageAgent: WorkstepStorageAgent,
+  ) {}
+
+  async execute(command: UpdateCircuitInputsSchemaCommand) {
+    const workstepToUpdate =
+      await this.agent.fetchUpdateCandidateAndThrowIfUpdateValidationFails(
+        command.workstepId,
+      );
+
+    this.agent.throwIfCircuitInputTranslationSchemaInvalid(command.schema);
+
+    this.agent.updateCircuitInputTranslationSchema(
+      workstepToUpdate,
+      command.schema,
+    );
+
+    const updatedWorkstep = await this.storageAgent.updateWorkstep(
+      workstepToUpdate,
+    );
+
+    return this.mapper.map(updatedWorkstep, Workstep, WorkstepDto);
+  }
+}

examples/bri-3/src/bri/workgroup/worksteps/capabilities/updateCircuitInputsSchema/updateCircuitInputsSchema.command.ts

@@ -0,0 +1,6 @@
+export class UpdateCircuitInputsSchemaCommand {
+  constructor(
+    public readonly workstepId: string,
+    public readonly schema: string,
+  ) {}
+}

examples/bri-3/src/bri/workgroup/worksteps/models/workstep.ts

@@ -22,6 +22,9 @@ export class Workstep {
   @AutoMap()
   privacyPolicy: string; // TODO Implement simple privacy policy inhereted from workgroup #487
 
+  @AutoMap()
+  circuitInputsTranslationSchema: string;
+
   constructor(
     id: string,
     name: string,
@@ -63,4 +66,8 @@ export class Workstep {
   public updatePrivacyPolicy(newPrivacyPolicy: string): void {
     this.privacyPolicy = newPrivacyPolicy;
   }
+
+  public updateCircuitInputTranslationSchema(schema): void {
+    this.circuitInputsTranslationSchema = schema;
+  }
 }

examples/bri-3/src/bri/workgroup/worksteps/worksteps.module.ts

@@ -2,20 +2,23 @@ import { Module } from '@nestjs/common';
 import { CqrsModule } from '@nestjs/cqrs';
 import { LoggingModule } from '../../../../src/shared/logging/logging.module';
 import { PrismaModule } from '../../../shared/prisma/prisma.module';
+import { ZeroKnowledgeProofModule } from '../../zeroKnowledgeProof/zeroKnowledgeProof.module';
 import { WorkstepAgent } from './agents/worksteps.agent';
 import { WorkstepStorageAgent } from './agents/workstepsStorage.agent';
 import { WorkstepController } from './api/worksteps.controller';
 import { CreateWorkstepCommandHandler } from './capabilities/createWorkstep/createWorkstepCommand.handler';
 import { DeleteWorkstepCommandHandler } from './capabilities/deleteWorkstep/deleteWorkstepCommand.handler';
 import { GetAllWorkstepsQueryHandler } from './capabilities/getAllWorksteps/getAllWorkstepsQuery.handler';
 import { GetWorkstepByIdQueryHandler } from './capabilities/getWorkstepById/getWorkstepByIdQuery.handler';
+import { UpdateCircuitInputsSchemaCommandHandler } from './capabilities/updateCircuitInputsSchema/updateCircuitInputsSchema.command.handler';
 import { UpdateWorkstepCommandHandler } from './capabilities/updateWorkstep/updateWorkstep.command.handler';
 import { WorkstepProfile } from './workstep.profile';
 
 export const CommandHandlers = [
   CreateWorkstepCommandHandler,
   UpdateWorkstepCommandHandler,
   DeleteWorkstepCommandHandler,
+  UpdateCircuitInputsSchemaCommandHandler,
 ];
 
 export const QueryHandlers = [
@@ -24,7 +27,7 @@ export const QueryHandlers = [
 ];
 
 @Module({
-  imports: [CqrsModule, LoggingModule, PrismaModule],
+  imports: [CqrsModule, LoggingModule, PrismaModule, ZeroKnowledgeProofModule],
   controllers: [WorkstepController],
   providers: [
     ...CommandHandlers,