Move shortcircuit parameters #569

Tristan-WorkGH · 2024-05-23T00:38:35Z

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

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

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

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

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

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

src/main/java/org/gridsuite/study/server/StudyController.java

src/test/java/org/gridsuite/study/server/StudyServiceTest.java

src/test/java/org/gridsuite/study/server/utils/WireMockUtils.java

src/test/java/org/gridsuite/study/server/repository/RepositoriesTest.java

Tristan-WorkGH · 2024-06-10T22:58:50Z

Code extracted in PRs:

src/test/java/org/gridsuite/study/server/utils/WireMockUtils.java

src/main/java/org/gridsuite/study/server/StudyController.java

…ameters

sonarqubecloud · 2024-06-19T15:03:28Z

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

Tristan-WorkGH added the help wanted Extra attention is needed label May 23, 2024

Tristan-WorkGH self-assigned this May 23, 2024

Tristan-WorkGH requested a review from ayolab May 23, 2024 00:42

This was referenced May 27, 2024

Fix shortcircuit tests matchers #575

Open

re-indent file #576

Closed

Tristan-WorkGH force-pushed the move_shortcircuit_parameters branch from c67a7da to aa038ff Compare June 3, 2024 08:56

TheMaskedTurtle requested changes Jun 4, 2024

View reviewed changes

BIG REDO SQUASH!

4c4e6f0

Tristan-WorkGH force-pushed the move_shortcircuit_parameters branch from 324f5d7 to 4c4e6f0 Compare June 11, 2024 14:59

sonar fix

8fc9567

TheMaskedTurtle previously requested changes Jun 13, 2024

View reviewed changes

review

43b122d

Tristan-WorkGH force-pushed the move_shortcircuit_parameters branch from 56f705f to 43b122d Compare June 14, 2024 15:10

Tristan-WorkGH added 2 commits June 19, 2024 15:42

Merge remote-tracking branch 'origin/main' into move_shortcircuit_par…

d36509d

…ameters

review

f4770e7

Tristan-WorkGH force-pushed the move_shortcircuit_parameters branch from de1cee5 to f4770e7 Compare June 19, 2024 14:57

Tristan-WorkGH requested review from TheMaskedTurtle and removed request for TheMaskedTurtle June 19, 2024 14:57

ayolab approved these changes Jun 19, 2024

View reviewed changes

Tristan-WorkGH merged commit c02ea74 into main Jun 21, 2024
3 checks passed

Tristan-WorkGH deleted the move_shortcircuit_parameters branch June 21, 2024 14:33

Tristan-WorkGH mentioned this pull request Jun 24, 2024

Fix unwanted constraint #591

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move shortcircuit parameters #569

Move shortcircuit parameters #569

Tristan-WorkGH commented May 23, 2024 •

edited

Loading

Tristan-WorkGH commented Jun 10, 2024

sonarqubecloud bot commented Jun 19, 2024

Move shortcircuit parameters #569

Move shortcircuit parameters #569

Conversation

Tristan-WorkGH commented May 23, 2024 • edited Loading

Tristan-WorkGH commented Jun 10, 2024

sonarqubecloud bot commented Jun 19, 2024

Quality Gate passed

Tristan-WorkGH commented May 23, 2024 •

edited

Loading