Move shortcircuit parameters

[Tristan-WorkGH]

Move entity and related functions to shortcircuit-server and link to new endpoints.

cf gridsuite/shortcircuit-server#81

Sequences

sequenceDiagram
    box rgb(75,75,75) study-server
        participant Controller
        participant StudySrv
        participant StudyRepository
        participant SCService
    end
    participant SCServer
    #autonumber

    Note over Controller,StudySrv: PUT /studies/{studyUuid}/nodes/{nodeUuid}/shortcircuit/run
    Note right of Controller: runShortCircuit(studyUuid, nodeUuid, busId?, userId)
    Controller-->>StudySrv: studyService.assertIsNodeNotReadOnly
    activate Controller
    Controller-->>+StudySrv: runShortCircuit(studyUuid, nodeUuid, userId, busId?)
    StudySrv->>+StudyRepository: findById(studyUuid)
    StudyRepository-->>-StudySrv: optional<entity>
    alt old: entity repo
        StudySrv->>+SCService: fromEntity(studyEntity.shortCircuitParameters)
        SCService-->>-StudySrv: powsybl obj params
        StudySrv->>+SCService: runShortCircuit(studyUuid, nodeUuid, busId, objParameters, userId)
    else new: rest service
        StudySrv->>+SCService: runShortCircuit(studyUuid, nodeUuid, busId, parametersUuid, withFortescueResult, userId)
    end
    SCService->>+SCServer: /vX/networks/{networkUuid}/run-and-save
    SCServer-->>-SCService: uuid result
    SCService-->>-StudySrv: uuid result
    StudySrv->>StudySrv: updateComputationResultUuid(...)
    Note over StudySrv: notificationService.emitElementUpdated(studyUuid, userId)
    StudySrv-->>-Controller: uuid
    deactivate Controller

Loading

sequenceDiagram
    box rgb(75,75,75) study-server
        participant Controller
        participant StudySrv
        participant StudyRepository
        participant SCService
    end
    participant SCServer
    Note over Controller,StudySrv: POST /studies/{studyUuid}/short-circuit-analysis/parameters
    Note right of Controller: setShortCircuitParameters(studyUuid, shortCircuitParametersInfos, userId)
    activate Controller
    Controller-->>+StudySrv: setShortCircuitParameters(studyUuid, shortCircuitParametersInfos, userId)
    alt old: entity repo
        StudySrv->>+SCService: toEntity(dto.parameters, dto.predefinedParameters)
        SCService-->>-StudySrv: entity
        %%StudySrv->>+StudySrv: updateShortCircuitParameters(studyUuid, shortCircuitParametersEntity)
        StudySrv->>+StudyRepository: findById(studyUuid)
        StudyRepository-->>-StudySrv: optional<entity>
        StudySrv->>StudyRepository: entity.setShortCircuitParameters(scParametersEntity)
        %%deactivate StudySrv
    else new: rest service
        StudySrv->>+StudyRepository: findById(studyUuid)
        StudyRepository-->>-StudySrv: optional<entity>
        alt studyEntity.shortCircuitParametersUuid != null
            StudySrv->>SCService: updateParameters(paramsUuid, params)
            SCService->>SCServer: uuid <br/> + sc parameters
        else studyEntity.shortCircuitParametersUuid == null
            StudySrv->>+SCService: createParameters(shortCircuitParametersInfos)
            SCService->>+SCServer: sc parameters
            SCServer-->>-SCService: uuid
            SCService-->>-StudySrv: uuid
            StudySrv->>StudyRepository: entity.setShortCircuitParametersUuid(uuid)
        end
    end
    Note right of StudySrv: notificationService.emitElementUpdated(studyUuid, userId)
    StudySrv->>-Controller: dto
    deactivate Controller

Loading

sequenceDiagram
    box rgb(75,75,75) study-server
        participant Controller
        participant StudySrv
        participant StudyRepository
        participant SCService
    end
    participant SCServer
    Note over Controller,StudySrv: GET /studies/{studyUuid}/short-circuit-analysis/parameters
    Note right of Controller: getShortCircuitParameters(studyUuid)
    activate Controller
    Controller->>+StudySrv: getShortCircuitParametersInfo(studyUuid)
#activate StudySrv
    StudySrv->>+StudyRepository: findById(studyUuid)
    StudyRepository-->>-StudySrv: optional<entity>
    alt old: entity repo
        StudySrv->>+StudyRepository: entity.getShortCircuitParameters()
        StudyRepository-->>-StudySrv: ShortCircuitParametersEntity <br/> or new+saved default params
        StudySrv->>+SCService: toShortCircuitParametersInfo(scp_entity)
        SCService-->>-StudySrv: dto
    else new: rest service
    #create participant SCServer
        alt studyEntity.shortCircuitParametersUuid == null
            StudySrv->>+SCService: createParameters()
            SCService->>+SCServer: createParameters
            SCServer-->>-SCService: uuid
            SCService-->>-StudySrv: uuid
            StudySrv->>StudyRepository: entity.setShortCircuitParametersUuid(uuid)
        end
        StudySrv->>+SCService: getOrCreateParameters(entity.shortCircuitParametersUuid)
        SCService-)+SCServer: study uuid
        SCServer--)-SCService: dto
        SCService-->>-StudySrv: dto
    #destroy participant SCServer
    end
    StudySrv->>-Controller: dto
#deactivate StudySrv
    deactivate Controller

Loading

sequenceDiagram
    box rgb(75,75,75) study-server
        participant Controller
        participant StudySrv
        participant StudyRepository
        participant SCService
    end
    participant SCServer
    Note over Controller,StudySrv: /studies
    Note right of Controller: duplicateStudy(studyUuid)
    activate Controller
    
    Controller->>+StudySrv: duplicateStudy(...)
    StudySrv->>+StudyRepository: findById(studyUuid)
    StudyRepository-->>-StudySrv: optional<entity>
    StudySrv->>StudySrv: insertStudyCreationRequest(studyEntity)
    StudySrv->>StudySrv: toBasicStudyInfos(StudyCreationRequestEntity)
    StudySrv-->>-Controller: uuid
    StudySrv->>+StudySrv: duplicateStudyAsync(...)
    deactivate Controller
    StudySrv->>+StudySrv: insertDuplicatedStudy(...)
    StudySrv->>+StudyRepository: findById(studyUuid)
    StudyRepository-->>-StudySrv: optional<entity>
    StudySrv->>StudySrv: [...]
    alt old: entity repo
        StudySrv->>+SCService: fromEntity(sourceStudy.shortCircuitParameters)
        SCService-->>-StudySrv: dto
        StudySrv->>+SCService: toEntity(sourceStudy.shortCircuitParameters)
        SCService-->>-StudySrv: entity
        StudySrv->>StudyRepository: ...
    else new: rest service
        StudySrv->>+SCService: duplicateParameters(uuid)
        SCService->>+SCServer: parameters uuid
        SCServer-->>-SCService: new uuid
        SCService-->>-StudySrv: uuid
        StudySrv->>StudyRepository: ...
    end
    StudySrv->>StudySrv: reindexStudy(entity)
    deactivate StudySrv
    deactivate StudySrv

Loading

sequenceDiagram
    box rgb(75,75,75) study-server
        participant ConsumerSrv
        participant StudySrv
        participant StudyRepository
        participant SCService
    end
    participant SCServer
    Note right of ConsumerSrv: consumeCaseImportSucceeded()
    activate ConsumerSrv
    ConsumerSrv->>ConsumerSrv: [...]
    ConsumerSrv->>+StudyRepository: findById(studyUuid)
    StudyRepository-->>-ConsumerSrv: optional<entity>
    alt entity != null
        ConsumerSrv->>StudySrv: updateStudyNetwork(studyEntity, ...)
    else entity == null
        ConsumerSrv->>ConsumerSrv: [...]
        alt old: entity repo
            ConsumerSrv->>+SCService: getDefaultShortCircuitParameters()
            SCService-->>-ConsumerSrv: powsybl obj
            ConsumerSrv->>+SCService: toEntity(powsyblParams)
            SCService-->>-ConsumerSrv: entity
            ConsumerSrv->>+StudySrv: insertStudy(..., scEntity, ...)
        else new: rest service
            ConsumerSrv->>+SCService: createDefaultParameters()
            SCService-->>-ConsumerSrv: uuid
            ConsumerSrv->>+StudySrv: insertStudy(..., scParamsUuid, ...)
        end
        StudySrv->>StudyRepository: save(new entity)
        deactivate StudySrv
    end

Loading

[Tristan-WorkGH]

Code extracted in PRs:

• Refactor constant USER_ID #584 (+ Refactor constant USER_ID (bis) #585)
• Fix constants not static final #586
• Refactor Jackson TypeReference #587

[sonarqubecloud]

Quality Gate passed

Issues
3 New issues
0 Accepted issues

Measures
0 Security Hotspots
81.2% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

reverted