import study #1057
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| /** | ||
| * Copyright (c) 2026, RTE (http://www.rte-france.com) | ||
| * This Source Code Form is subject to the terms of the Mozilla Public | ||
| * License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| * file, You can obtain one at http://mozilla.org/MPL/2.0/. | ||
| */ | ||
| package org.gridsuite.study.server.service; | ||
|
|
||
| import org.gridsuite.study.server.dto.CaseInfos; | ||
| import org.gridsuite.study.server.dto.NetworkInfos; | ||
| import org.gridsuite.study.server.dto.RootNetworkInfos; | ||
| import org.gridsuite.study.server.dto.RootNetworkLoadStatus; | ||
| import org.gridsuite.study.server.dto.studyexport.RootNetworkExportInfos; | ||
| import org.gridsuite.study.server.dto.studyexport.TreeExportInfos; | ||
| import org.gridsuite.study.server.notification.NotificationService; | ||
| import org.gridsuite.study.server.repository.StudyEntity; | ||
| import org.gridsuite.study.server.repository.rootnetwork.RootNetworkEntity; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
| import org.springframework.stereotype.Service; | ||
| import org.springframework.transaction.annotation.Transactional; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.Comparator; | ||
| import java.util.List; | ||
| import java.util.UUID; | ||
|
|
||
| /** | ||
| * @author Ghazwa Rehili <ghazwa.rehili at rte-france.com> | ||
| */ | ||
| @Service | ||
| public class StudyImportService { | ||
| private static final Logger LOGGER = LoggerFactory.getLogger(StudyImportService.class); | ||
|
|
||
| private final StudyService studyService; | ||
| private final RootNetworkService rootNetworkService; | ||
| private final CaseService caseService; | ||
| private final NotificationService notificationService; | ||
|
|
||
| public StudyImportService(StudyService studyService, RootNetworkService rootNetworkService, | ||
| CaseService caseService, NotificationService notificationService) { | ||
| this.studyService = studyService; | ||
| this.rootNetworkService = rootNetworkService; | ||
| this.caseService = caseService; | ||
| this.notificationService = notificationService; | ||
| } | ||
|
|
||
| @Transactional | ||
| public void importStudy(TreeExportInfos treeExportInfos, String userId) { | ||
| StudyEntity studyEntity = studyService.createStudyEntityWithTree(treeExportInfos.studyUuid(), userId, treeExportInfos.nodeTree()); | ||
|
There was a problem hiding this comment. 🔒 Security & Privacy | 🛡️ Analyzed with Security Review | 🔴 Critical | ⚡ Quick win IDOR Reachability: External Do not persist the imported study under the request UUID.
Generate a new UUID or reject collisions before persistence. #!/bin/bash
set -euo pipefail
rg -n -C 12 'importStudy\(|createStudyEntityWithTree\(|buildStudyEntity\(' src/main/java
rg -n -C 8 '`@Id`|GeneratedValue|UUID id' src/main/java/org/gridsuite/study/server/repository/StudyEntity.java🤖 Prompt for AI Agents🗄️ Data Integrity & Integration | 🟠 Major | 🏗️ Heavy lift 🔎 Supported by static analysis🏁 Script executed: #!/bin/bash
set -euo pipefail
rg -n -C 15 'createStudyEntityWithTree|studyInfosService\.add|studyInfosService\.(delete|remove)' \
src/main/java src/test/java
rg -n -C 8 'interface StudyInfosRepository|ElasticsearchRepository|TransactionManager' \
src/main/javaRepository: gridsuite/study-server Length of output: 44566 🤖 get_repo_knowledge executed:
Length of output: 35202 🏁 Script executed: #!/bin/bash
set -euo pipefail
printf '%s\n' '--- StudyImportService ---'
cat -n src/main/java/org/gridsuite/study/server/service/StudyImportService.java | sed -n '1,130p'
printf '%s\n' '--- StudyInfosService ---'
fd -i 'StudyInfosService.java' src/main/java src/test/java -x sh -c 'cat -n "$1"' sh {}
printf '%s\n' '--- transaction and delete bindings ---'
rg -n -C 12 'class StudyInfosService|studyInfosRepository|deleteByUuid|`@Transactional`|TransactionSynchronization|afterCommit|createStudyEntityWithTree' src/main/java/org/gridsuite/study/server/service src/main/java/org/gridsuite/study/server/elasticsearchRepository: gridsuite/study-server Length of output: 50379 🏁 Script executed: #!/bin/bash
set -euo pipefail
printf '%s\n' '--- import flow ---'
cat -n src/main/java/org/gridsuite/study/server/service/StudyImportService.java | sed -n '1,115p'
printf '%s\n' '--- StudyInfosService candidates ---'
git ls-files | rg 'StudyInfosService\.java$'
printf '%s\n' '--- StudyInfosService implementation ---'
service_file="$(git ls-files | rg 'StudyInfosService\.java$' | head -n 1)"
test -n "$service_file"
cat -n "$service_file"
printf '%s\n' '--- transaction synchronization in relevant sources ---'
rg -n -C 5 'TransactionSynchronization|afterCommit|TransactionSynchronizationManager' \
src/main/java/org/gridsuite/study/server/service/StudyImportService.java \
src/main/java/org/gridsuite/study/server/service/StudyService.java \
"$service_file" || trueRepository: gridsuite/study-server Length of output: 7932 Create the search entry only after a successful import.
Move the Elasticsearch write to an after-commit step, or delete it when the import fails. 🤖 Prompt for AI Agents |
||
| List<RootNetworkExportInfos> orderedRootNetworks = treeExportInfos.rootNetworks().stream() | ||
| .sorted(Comparator.comparing(RootNetworkExportInfos::index)) | ||
| .toList(); | ||
| List<UUID> duplicatedCaseUuids = new ArrayList<>(); | ||
| try { | ||
| for (RootNetworkExportInfos rootNetworkInfos : orderedRootNetworks) { | ||
| UUID newCaseUuid = caseService.duplicateCase(rootNetworkInfos.caseInfos().getCaseUuid(), true); | ||
|
There was a problem hiding this comment. 🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win 🔎 Supported by static analysis🏁 Script executed: #!/bin/bash
set -euo pipefail
ast-grep outline src/main/java/org/gridsuite/study/server/service/CaseService.java \
--match 'duplicateCase|disableCaseExpiration' --view expanded
rg -n -C 8 'duplicateCase\(|disableCaseExpiration\(' src/main/java src/test/javaRepository: gridsuite/study-server Length of output: 44480 🤖 get_repo_knowledge executed:
Length of output: 46683 🏁 Script executed: #!/bin/bash
set -euo pipefail
printf '%s\n' '--- StudyImportService ---'
cat -n src/main/java/org/gridsuite/study/server/service/StudyImportService.java | sed -n '40,105p'
printf '%s\n' '--- CaseService ---'
cat -n src/main/java/org/gridsuite/study/server/service/CaseService.java | sed -n '50,84p'
printf '%s\n' '--- import-path expiration calls ---'
rg -n -C 6 'disableCaseExpiration|importStudy\(' src/main/java/org/gridsuite/study/server/service src/main/java/org/gridsuite/study/server/controllerRepository: gridsuite/study-server Length of output: 11372 Disable expiration for successfully imported cases.
🤖 Prompt for AI Agents |
||
| duplicatedCaseUuids.add(newCaseUuid); | ||
| RootNetworkEntity rootNetworkEntity = rootNetworkService.createRootNetwork(studyEntity, RootNetworkInfos.builder() | ||
| .id(UUID.randomUUID()) | ||
| .name(rootNetworkInfos.name()) | ||
| .tag(rootNetworkInfos.tag()) | ||
| .caseInfos(new CaseInfos(newCaseUuid, rootNetworkInfos.caseInfos().getOriginalCaseUuid(), | ||
| rootNetworkInfos.caseInfos().getCaseName(), rootNetworkInfos.caseInfos().getCaseFormat())) | ||
| .importParameters(rootNetworkInfos.importParameters()) | ||
| .networkInfos(new NetworkInfos(UUID.randomUUID(), "")) | ||
| .build()); | ||
| rootNetworkService.updateNetworkLoadStatus(rootNetworkEntity.getId(), RootNetworkLoadStatus.UNLOADED); | ||
| } | ||
|
There was a problem hiding this comment. 🗄️ Data Integrity & Integration | 🟠 Major | 🏗️ Heavy lift Isolate each root-network import transactionally
Use a separate transaction boundary for each root network. Catch failures around that boundary and continue with the remaining entries. Delete the study and emit 🤖 Prompt for AI Agents |
||
| } catch (Exception e) { | ||
| duplicatedCaseUuids.forEach(caseUuid -> { | ||
| try { | ||
| caseService.deleteCase(caseUuid); | ||
| } catch (Exception exception) { | ||
| LOGGER.error(String.format("Could not clean up orphaned case '%s' after import failure", caseUuid), exception); | ||
| } | ||
| }); | ||
| throw e; | ||
| } | ||
| notificationService.emitStudyCreationFinished(studyEntity.getId(), userId); | ||
| } | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Update the OpenAPI response description for the synchronous import.
StudyController.importStudyreturns200only afterStudyImportService.importStudycompletes. Springdoc exposes this annotation in the repository's OpenAPI documentation, so the current description can mislead API consumers.📝 Proposed documentation fix
🤖 Prompt for AI Agents