From a04b36e706f4ac917a26089dc864ddc3bd20648e Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Wed, 22 Apr 2026 16:13:53 -0400 Subject: [PATCH 001/102] Add todos --- .../brapi/v2/dao/impl/BrAPITrialDAOImpl.java | 59 ++++--------------- 1 file changed, 13 insertions(+), 46 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java index b0c771f6d..7b57d1abc 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java @@ -80,21 +80,7 @@ public BrAPITrialDAOImpl(ProgramCacheProvider programCacheProvider, this.runScheduledTasks = runScheduledTasks; } - - @Scheduled(initialDelay = "${startup.delay.trial}") - public void setup() { - if(!runScheduledTasks) { - return; - } - - // Populate the experiment cache for all programs on startup - log.debug("populating experiment cache"); - List programs = programDAO.getActive(); - if (programs != null) { - programExperimentCache.populate(programs.stream().map(Program::getId).collect(Collectors.toList())); - } - } - + // TODO: Can be removed once cache instance is gone private Map fetchProgramExperiments(UUID programId) throws ApiException { TrialsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(programId), TrialsApi.class); @@ -133,6 +119,7 @@ private Map experimentById(List trials) { return experimentById; } + // TODO: Fix by calling BrAPI trials get on brapiProgramDbId, then filter on names @Override public List getTrialsByName(List trialNames, Program program) throws ApiException { Map cache = programExperimentCache.get(program.getId()); @@ -150,31 +137,9 @@ public List getTrialsByName(List trialNames, Program program return trials; } - private List getTrialsByExRef(String referenceSource, String referenceId, Program program) throws ApiException { - Map cache = programExperimentCache.get(program.getId()); - List trials = new ArrayList<>(); - if (cache != null) { - trials.addAll(cache - .values() - .stream() - .filter(t -> { - BrAPIExternalReference xref = t - .getExternalReferences() - .stream() - .filter(reference -> String.format("%s/%s", referenceSource, ExternalReferenceSource.TRIALS) - .equalsIgnoreCase(reference.getReferenceSource())) - .findFirst().orElseThrow(() -> new IllegalStateException("No BI trial external reference found")); - return referenceId.equals(xref.getReferenceID()); - }) - .collect(Collectors.toList())); - } - - return trials; - } - + // TODO: Fix by using only code of inner callback and returning result @Override - public List createBrAPITrials(List brAPITrialList, UUID programId, ImportUpload upload) - throws ApiException { + public List createBrAPITrials(List brAPITrialList, UUID programId, ImportUpload upload) { TrialsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(programId), TrialsApi.class); List createdTrials = new ArrayList<>(); try { @@ -192,8 +157,10 @@ public List createBrAPITrials(List brAPITrialList, UUID throw new InternalServerException("Unknown error has occurred: " + e.getMessage(), e); } } + + // TODO: Fix by grabbing inner code of callback, removing callback and cache call, and return result from BrAPI call. @Override - public BrAPITrial updateBrAPITrial(String trialDbId, BrAPITrial trial, UUID programId) throws ApiException { + public BrAPITrial updateBrAPITrial(String trialDbId, BrAPITrial trial, UUID programId) { TrialsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(programId), TrialsApi.class); BrAPITrial updatedTrial = null; try { @@ -215,6 +182,7 @@ public BrAPITrial updateBrAPITrial(String trialDbId, BrAPITrial trial, UUID prog } } + // TODO: call getTrials endpoint using brapiProgramId @Override public List getTrials(UUID programId) throws ApiException { return new ArrayList<>(programExperimentCache.get(programId).values()); @@ -232,6 +200,7 @@ private List processExperimentsForDisplay( return displayExperiments; } + // TODO: Grab all trials for program, then filter on brapi trialDbID. This will likely involve analyzing downstream usages to get brapiTrialId @Override public Optional getTrialById(UUID programId, UUID trialId) throws ApiException, DoesNotExistException { Map cache = programExperimentCache.get(programId); @@ -243,12 +212,7 @@ public Optional getTrialById(UUID programId, UUID trialId) throws Ap return Optional.ofNullable(trial); } - @Override - public Optional getTrialByDbId(String trialDbId, Program program) throws ApiException { - List trials = getTrialsByDbIds(List.of(trialDbId), program); - return Utilities.getSingleOptional(trials); - } - + // TODO: Grab all trials for program, then filter on brapi trialDbID. This will likely involve analyzing downstream usages to get brapiTrialId @Override public List getTrialsByDbIds(Collection trialDbIds, Program program) throws ApiException { Map cache = programExperimentCache.get(program.getId()); @@ -263,6 +227,8 @@ public List getTrialsByDbIds(Collection trialDbIds, Program return trials; } + + // TODO: Investigate what constitutes an experiment ID, and if it's the cache trialDbId, analyze downstream usages to get brapiTrialDbIds instead and submit them into this method @Override public List getTrialsByExperimentIds(Collection experimentIds, Program program) throws ApiException { if(experimentIds.isEmpty()) { @@ -295,6 +261,7 @@ public void deleteBrAPITrial(Program program, BrAPITrial trial, boolean hard) th brAPIDAOUtil.makeCall(brapiRequest); } + // TODO: Remove when trial cache is removed. @Override public void repopulateCache(UUID programId) { this.programExperimentCache.invalidate(programId); From df7affd700abb464d82495fb5c7e8fdd65745cb8 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Thu, 23 Apr 2026 12:27:24 -0400 Subject: [PATCH 002/102] Remove unused method from BrAPITrialDAO --- .../java/org/breedinginsight/brapi/v2/dao/BrAPITrialDAO.java | 2 -- 1 file changed, 2 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPITrialDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPITrialDAO.java index 85298c158..81ca88d4f 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPITrialDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPITrialDAO.java @@ -40,8 +40,6 @@ List createBrAPITrials(List brAPITrialList, UUID program Optional getTrialById(UUID programId, UUID trialId) throws ApiException, DoesNotExistException; - Optional getTrialByDbId(String trialDbId, Program program) throws ApiException; - List getTrialsByDbIds(Collection trialDbIds, Program program) throws ApiException; List getTrialsByExperimentIds(Collection experimentIds, Program program) throws ApiException; From d1ae3d98e75f866ec0605f9ac244722afd2d7d22 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Fri, 24 Apr 2026 15:53:42 -0400 Subject: [PATCH 003/102] Fix first get method --- .../brapi/v2/dao/impl/BrAPITrialDAOImpl.java | 46 +++++++++++++++---- 1 file changed, 38 insertions(+), 8 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java index 7b57d1abc..3e9a6d402 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java @@ -19,15 +19,17 @@ import io.micronaut.context.annotation.Context; import io.micronaut.context.annotation.Property; import io.micronaut.http.server.exceptions.InternalServerException; -import io.micronaut.scheduling.annotation.Scheduled; import lombok.extern.slf4j.Slf4j; import okhttp3.HttpUrl; import okhttp3.Request; +import org.brapi.client.v2.ApiResponse; import org.brapi.client.v2.model.exceptions.ApiException; +import org.brapi.client.v2.model.queryParams.core.TrialQueryParams; import org.brapi.client.v2.modules.core.TrialsApi; import org.brapi.v2.model.BrAPIExternalReference; import org.brapi.v2.model.core.BrAPITrial; import org.brapi.v2.model.core.request.BrAPITrialSearchRequest; +import org.brapi.v2.model.core.response.BrAPITrialListResponse; import org.breedinginsight.brapi.v2.dao.BrAPITrialDAO; import org.breedinginsight.brapps.importer.daos.ImportDAO; import org.breedinginsight.brapps.importer.model.ImportUpload; @@ -106,6 +108,37 @@ private Map fetchProgramExperiments(UUID programId) throws A return experimentById(processExperimentsForDisplay(programExperiments, program.getKey())); } + private List getBrAPITrialsByBrAPIProgramId(Program program) throws ApiException { + TrialsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(program.getId()), TrialsApi.class); + + ApiResponse response; + + // TODO: Configurable max amount of trials per program, or paginate. + int pageSize = 1000; + + try { + TrialQueryParams trialQueryParams = + TrialQueryParams.builder() + .programDbId(program.getBrapiProgram().getProgramDbId()) + .pageSize(pageSize) + .page(0) + .build(); + + response = api.trialsGet(trialQueryParams); + } catch (ApiException e) { + log.warn(Utilities.generateApiExceptionLogMessage(e)); + throw new InternalServerException("Error making BrAPI call", e); + } + + if (response.getBody().getMetadata().getPagination().getTotalCount() > pageSize) { + throw new InternalServerException(String.format("More trials exist than requested [%s]", pageSize)); + } + + List trialsFromResponse = response.getBody().getResult().getData(); + + return processExperimentsForDisplay(trialsFromResponse, program.getKey()); + } + private Map experimentById(List trials) { Map experimentById = new HashMap<>(); for (BrAPITrial experiment: trials) { @@ -119,16 +152,13 @@ private Map experimentById(List trials) { return experimentById; } - // TODO: Fix by calling BrAPI trials get on brapiProgramDbId, then filter on names @Override public List getTrialsByName(List trialNames, Program program) throws ApiException { - Map cache = programExperimentCache.get(program.getId()); - List trials = new ArrayList<>(); - if (cache != null) { + List allTrialsForProgram = getBrAPITrialsByBrAPIProgramId(program); - // TODO: replace with more performant cache search, e.g. RediSearch - trials.addAll(cache - .values() + List trials = new ArrayList<>(); + if (allTrialsForProgram != null) { + trials.addAll(allTrialsForProgram .stream() .filter(t -> trialNames.contains(t.getTrialName())) .collect(Collectors.toList())); From c1b01746a36144c16742b2dcc7ec86a9960ba0c9 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Tue, 28 Apr 2026 17:58:20 -0400 Subject: [PATCH 004/102] Update getTrials(UUID) method to use brapi directly --- .../brapi/v2/dao/impl/BrAPITrialDAOImpl.java | 31 ++++++++++++++++--- .../brapi/v2/services/BrAPITrialService.java | 1 + 2 files changed, 27 insertions(+), 5 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java index 3e9a6d402..9726073e6 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java @@ -27,6 +27,7 @@ import org.brapi.client.v2.model.queryParams.core.TrialQueryParams; import org.brapi.client.v2.modules.core.TrialsApi; import org.brapi.v2.model.BrAPIExternalReference; +import org.brapi.v2.model.core.BrAPIProgram; import org.brapi.v2.model.core.BrAPITrial; import org.brapi.v2.model.core.request.BrAPITrialSearchRequest; import org.brapi.v2.model.core.response.BrAPITrialListResponse; @@ -108,7 +109,25 @@ private Map fetchProgramExperiments(UUID programId) throws A return experimentById(processExperimentsForDisplay(programExperiments, program.getKey())); } - private List getBrAPITrialsByBrAPIProgramId(Program program) throws ApiException { + /** + * This method requires a BI-API program. If the BrAPIProgram inside this data model is not set, + * this method will retrieve it. + */ + private List getBrAPITrialsUsingBrAPIProgram(Program program) throws ApiException { + + if (program == null || program.getId() == null) { + throw new InternalServerException("BI-API Program or Program ID is null"); + } + + String brapiProgramDbId = Optional.of(program) + .map(Program::getBrapiProgram) + .map(BrAPIProgram::getProgramDbId) + .orElse(null); + + if (brapiProgramDbId == null) { + brapiProgramDbId = programDAO.getProgramBrAPI(program).getProgramDbId(); + } + TrialsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(program.getId()), TrialsApi.class); ApiResponse response; @@ -119,7 +138,7 @@ private List getBrAPITrialsByBrAPIProgramId(Program program) throws try { TrialQueryParams trialQueryParams = TrialQueryParams.builder() - .programDbId(program.getBrapiProgram().getProgramDbId()) + .programDbId(brapiProgramDbId) .pageSize(pageSize) .page(0) .build(); @@ -154,7 +173,7 @@ private Map experimentById(List trials) { @Override public List getTrialsByName(List trialNames, Program program) throws ApiException { - List allTrialsForProgram = getBrAPITrialsByBrAPIProgramId(program); + List allTrialsForProgram = getBrAPITrialsUsingBrAPIProgram(program); List trials = new ArrayList<>(); if (allTrialsForProgram != null) { @@ -212,10 +231,12 @@ public BrAPITrial updateBrAPITrial(String trialDbId, BrAPITrial trial, UUID prog } } - // TODO: call getTrials endpoint using brapiProgramId @Override public List getTrials(UUID programId) throws ApiException { - return new ArrayList<>(programExperimentCache.get(programId).values()); + Program program = programDAO.get(programId).get(0); + program.setBrapiProgram(programDAO.getProgramBrAPI(program)); + + return getBrAPITrialsUsingBrAPIProgram(program); } //Removes program key from trial name diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java index b15f1c1b0..bada3d09d 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java @@ -121,6 +121,7 @@ public BrAPITrialService(@Property(name = "brapi.server.reference-source") Strin } public List getExperiments(UUID programId) throws ApiException, DoesNotExistException { + // TODO: Edit this to filter/paginate trials return trialDAO.getTrials(programId); } From 6b6a695c770dc53361afd545e35f38c55c5d657e Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Mon, 4 May 2026 16:22:46 -0400 Subject: [PATCH 005/102] Udpate remaining getMethods, fix enough exRef things to pass unit tests --- .../brapi/v2/BrAPITrialsController.java | 2 + .../brapi/v2/dao/BrAPIStudyDAO.java | 1 + .../brapi/v2/dao/impl/BrAPITrialDAOImpl.java | 60 ++++++++++--------- .../brapi/v2/services/BrAPITrialService.java | 5 +- .../steps/CommitPendingImportObjectsStep.java | 5 ++ ...ulateExistingPendingImportObjectsStep.java | 14 ++++- .../experiment/service/TrialService.java | 20 ++----- .../services/ExperimentTrialService.java | 6 +- .../importer/ExperimentFileImportTest.java | 7 +-- 9 files changed, 63 insertions(+), 57 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java b/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java index 1ad489d91..3da9ea965 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java +++ b/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java @@ -26,6 +26,7 @@ import io.micronaut.security.rules.SecurityRule; import lombok.extern.slf4j.Slf4j; import org.brapi.client.v2.model.exceptions.ApiException; +import org.brapi.v2.model.BrAPIExternalReference; import org.brapi.v2.model.core.BrAPITrial; import org.brapi.v2.model.core.response.BrAPITrialSingleResponse; import org.breedinginsight.api.auth.*; @@ -158,6 +159,7 @@ public HttpResponse trialsTrialDbIdPut(@PathVariable("programId") UUID progra return HttpResponse.notFound(); } + // TODO: Remove for trialDbId once cache is removed for that entity private void setDbIds(BrAPITrial trial) { trial.trialDbId(Utilities.getExternalReference(trial.getExternalReferences(), Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.TRIALS)) .orElseThrow(() -> new IllegalStateException("No BI external reference found")) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java index 217d10216..e789db2a2 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java @@ -137,6 +137,7 @@ public List getStudiesByName(List studyNames, Program progra } public List getStudiesByExperimentID(@NotNull UUID experimentId, Program program) throws ApiException { + // TODO: This should look up on trialDbId, and the trialDbId should be passed thru BrAPIStudySearchRequest studySearch = new BrAPIStudySearchRequest(); studySearch.programDbIds(List.of(program.getBrapiProgram().getProgramDbId())); studySearch.addExternalReferenceIdsItem(experimentId.toString()); diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java index 9726073e6..849c1b021 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java @@ -128,29 +128,32 @@ private List getBrAPITrialsUsingBrAPIProgram(Program program) throws brapiProgramDbId = programDAO.getProgramBrAPI(program).getProgramDbId(); } + // TODO: Configurable max amount of trials per program, or paginate. + + TrialQueryParams trialQueryParams = + TrialQueryParams.builder() + .programDbId(brapiProgramDbId) + .pageSize(1000) + .page(0) + .build(); + + return getTrialsFromBrAPI(program, trialQueryParams); + } + + private List getTrialsFromBrAPI(Program program, TrialQueryParams trialQueryParams) throws ApiException { TrialsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(program.getId()), TrialsApi.class); ApiResponse response; - // TODO: Configurable max amount of trials per program, or paginate. - int pageSize = 1000; - try { - TrialQueryParams trialQueryParams = - TrialQueryParams.builder() - .programDbId(brapiProgramDbId) - .pageSize(pageSize) - .page(0) - .build(); - response = api.trialsGet(trialQueryParams); } catch (ApiException e) { log.warn(Utilities.generateApiExceptionLogMessage(e)); throw new InternalServerException("Error making BrAPI call", e); } - if (response.getBody().getMetadata().getPagination().getTotalCount() > pageSize) { - throw new InternalServerException(String.format("More trials exist than requested [%s]", pageSize)); + if (response.getBody().getMetadata().getPagination().getTotalCount() > trialQueryParams.pageSize()) { + throw new InternalServerException(String.format("More trials exist than requested [%s]", trialQueryParams)); } List trialsFromResponse = response.getBody().getResult().getData(); @@ -161,12 +164,7 @@ private List getBrAPITrialsUsingBrAPIProgram(Program program) throws private Map experimentById(List trials) { Map experimentById = new HashMap<>(); for (BrAPITrial experiment: trials) { - BrAPIExternalReference xref = experiment - .getExternalReferences() - .stream() - .filter(reference -> String.format("%s/%s", referenceSource, ExternalReferenceSource.TRIALS.getName()).equals(reference.getReferenceSource())) - .findFirst().orElseThrow(() -> new IllegalStateException("No BI external reference found")); - experimentById.put(xref.getReferenceID(), experiment); + experimentById.put(experiment.getTrialDbId(), experiment); } return experimentById; } @@ -251,21 +249,23 @@ private List processExperimentsForDisplay( return displayExperiments; } - // TODO: Grab all trials for program, then filter on brapi trialDbID. This will likely involve analyzing downstream usages to get brapiTrialId @Override public Optional getTrialById(UUID programId, UUID trialId) throws ApiException, DoesNotExistException { - Map cache = programExperimentCache.get(programId); - BrAPITrial trial = null; - if (cache != null) { - trial = cache.get(trialId.toString()); - } + Program program = programDAO.get(programId).get(0); + + TrialQueryParams params = TrialQueryParams.builder() + .trialDbId(trialId.toString()) + .pageSize(1) + .page(0) + .build(); + - return Optional.ofNullable(trial); + return getTrialsFromBrAPI(program, params).stream().findFirst(); } - // TODO: Grab all trials for program, then filter on brapi trialDbID. This will likely involve analyzing downstream usages to get brapiTrialId @Override public List getTrialsByDbIds(Collection trialDbIds, Program program) throws ApiException { + // Lookup on trialDbIds directly in BrAPI Map cache = programExperimentCache.get(program.getId()); List trials = new ArrayList<>(); if (cache != null) { @@ -279,16 +279,18 @@ public List getTrialsByDbIds(Collection trialDbIds, Program return trials; } - // TODO: Investigate what constitutes an experiment ID, and if it's the cache trialDbId, analyze downstream usages to get brapiTrialDbIds instead and submit them into this method + // TODO: ExperimentIds will = trialDbIds once cache is updated. Update this method to get trials on dbId directly from brapi. @Override public List getTrialsByExperimentIds(Collection experimentIds, Program program) throws ApiException { if(experimentIds.isEmpty()) { return Collections.emptyList(); } + + List experimentIdsAsStrings = experimentIds.stream().map(UUID::toString).collect(Collectors.toList()); + BrAPITrialSearchRequest trialSearch = new BrAPITrialSearchRequest(); trialSearch.programDbIds(List.of(program.getBrapiProgram().getProgramDbId())); - trialSearch.externalReferenceSources(List.of(referenceSource + "/" + ExternalReferenceSource.TRIALS.getName())); - trialSearch.externalReferenceIds(experimentIds.stream().map(UUID::toString).collect(Collectors.toList())); + trialSearch.trialDbIds(experimentIdsAsStrings); TrialsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(program.getId()), TrialsApi.class); return processExperimentsForDisplay(brAPIDAOUtil.search( api::searchTrialsPost, diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java index bada3d09d..d11ab965b 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java @@ -185,10 +185,13 @@ public DownloadFile exportObservations( // add columns for requested dataset obsvars and timestamps log.debug(logHash + ": fetching experiment for export"); BrAPITrial experiment = getExperiment(program, experimentId); + String expExRefId = Utilities.getExternalReference(experiment.getExternalReferences(), this.referenceSource, ExternalReferenceSource.TRIALS) + .map(BrAPIExternalReference::getReferenceId) + .orElse(null); // get requested environments for the experiment log.debug(logHash + ": fetching environments for export"); - List expStudies = studyDAO.getStudiesByExperimentID(experimentId, program); + List expStudies = studyDAO.getStudiesByExperimentID(UUID.fromString(expExRefId), program); if (!requestedEnvIds.isEmpty()) { expStudies = expStudies .stream() diff --git a/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/create/workflow/steps/CommitPendingImportObjectsStep.java b/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/create/workflow/steps/CommitPendingImportObjectsStep.java index bdcc8956f..d4f3e2198 100644 --- a/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/create/workflow/steps/CommitPendingImportObjectsStep.java +++ b/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/create/workflow/steps/CommitPendingImportObjectsStep.java @@ -208,9 +208,14 @@ public void process(ProcessContext processContext, ProcessedData processedData) // set the DbId to the for each newly created trial for (BrAPITrial createdTrial : createdTrials) { String createdTrialName = Utilities.removeProgramKey(createdTrial.getTrialName(), program.getKey()); + + trialByNameNoScope.get(createdTrialName) .getBrAPIObject() .setTrialDbId(createdTrial.getTrialDbId()); + // TODO: May need to set the main ID for pending objects with the BrAPI ID for downstream usage once cache is removed. + trialByNameNoScope.get(createdTrialName) + .setId(UUID.fromString(createdTrial.getTrialDbId())); } List createdLocations = new ArrayList<>(locationService.create(actingUser, program.getId(), newLocations)); diff --git a/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/create/workflow/steps/PopulateExistingPendingImportObjectsStep.java b/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/create/workflow/steps/PopulateExistingPendingImportObjectsStep.java index f30512d2b..06c7c14c9 100644 --- a/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/create/workflow/steps/PopulateExistingPendingImportObjectsStep.java +++ b/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/create/workflow/steps/PopulateExistingPendingImportObjectsStep.java @@ -198,9 +198,21 @@ private Map> initializeStudyByNameNoScop List existingStudies; Optional> trial = getTrialPIO(experimentImportRows, trialByNameNoScope); + String expExRefId = Utilities.getExternalReference(trial.get() + .getBrAPIObject() + .getExternalReferences(), BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.TRIALS) + .map(BrAPIExternalReference::getReferenceId) + .orElse(null); + + if (expExRefId == null) { + String logMessage = "No exref found in trial to link trial to study"; + log.error(logMessage); + throw new InternalServerException(logMessage); + } + try { // the 'trial' variable will never be "null". - UUID experimentId = trial.get().getId(); + UUID experimentId = UUID.fromString(expExRefId); existingStudies = brAPIStudyDAO.getStudiesByExperimentID(experimentId, program); for (BrAPIStudy existingStudy : existingStudies) { experimentStudyService.processAndCacheStudy(existingStudy, program, BrAPIStudy::getStudyName, studyByName); diff --git a/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/service/TrialService.java b/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/service/TrialService.java index 1a9a7f02f..a8e1d0adf 100644 --- a/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/service/TrialService.java +++ b/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/service/TrialService.java @@ -273,11 +273,7 @@ private void processAndCacheTrial( Program program, Map> trialByNameNoScope) { - //get TrialId from existingTrial - BrAPIExternalReference experimentIDRef = Utilities.getExternalReference(existingTrial.getExternalReferences(), - String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.TRIALS.getName())) - .orElseThrow(() -> new InternalServerException("An Experiment ID was not found in any of the external references")); - UUID experimentId = UUID.fromString(experimentIDRef.getReferenceId()); + UUID experimentId = UUID.fromString(existingTrial.getTrialDbId()); trialByNameNoScope.put( Utilities.removeProgramKey(existingTrial.getTrialName(), program.getKey()), @@ -288,20 +284,14 @@ private void processAndCacheTrial( * Constructs a PendingImportObject containing a BrAPITrial object based on the input BrAPITrial. * * This function takes a BrAPITrial object as input and constructs a PendingImportObject which - * encapsulates the trial along with its associated experiment ID. The experiment ID is retrieved - * from the external references of the trial object using utility method getExternalReference. - * If the experiment ID is not found in the external references, an InternalServerException is thrown. + * encapsulates the trial along with its associated experiment ID, which is the trialDbId from the BrAPI DB. * * @param trial the BrAPITrial object for which the PendingImportObject is to be constructed * @return a PendingImportObject containing the BrAPITrial object and its associated experiment ID - * @throws InternalServerException if the experiment ID is not found in the external references of the trial */ - public PendingImportObject constructPIOFromBrapiTrial(BrAPITrial trial) throws InternalServerException { - PendingImportObject pio = null; - BrAPIExternalReference experimentIDRef = Utilities.getExternalReference(trial.getExternalReferences(), - String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.TRIALS.getName())) - .orElseThrow(() -> new InternalServerException("An Experiment ID was not found in any of the external references")); - UUID experimentId = UUID.fromString(experimentIDRef.getReferenceId()); + public PendingImportObject constructPIOFromBrapiTrial(BrAPITrial trial) { + PendingImportObject pio; + UUID experimentId = UUID.fromString(trial.getTrialDbId()); pio = new PendingImportObject<>(ImportObjectState.EXISTING, trial, experimentId); return pio; } diff --git a/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/services/ExperimentTrialService.java b/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/services/ExperimentTrialService.java index 2e3a2ec33..2be781952 100644 --- a/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/services/ExperimentTrialService.java +++ b/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/services/ExperimentTrialService.java @@ -149,11 +149,7 @@ private void processAndCacheTrial( Program program, Map> trialByNameNoScope) { - //get TrialId from existingTrial - BrAPIExternalReference experimentIDRef = Utilities.getExternalReference(existingTrial.getExternalReferences(), - String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.TRIALS.getName())) - .orElseThrow(() -> new InternalServerException("An Experiment ID was not found in any of the external references")); - UUID experimentId = UUID.fromString(experimentIDRef.getReferenceId()); + UUID experimentId = UUID.fromString(existingTrial.getTrialDbId()); trialByNameNoScope.put( Utilities.removeProgramKey(existingTrial.getTrialName(), program.getKey()), diff --git a/src/test/java/org/breedinginsight/brapps/importer/ExperimentFileImportTest.java b/src/test/java/org/breedinginsight/brapps/importer/ExperimentFileImportTest.java index 802bf6889..abd55e9b0 100644 --- a/src/test/java/org/breedinginsight/brapps/importer/ExperimentFileImportTest.java +++ b/src/test/java/org/breedinginsight/brapps/importer/ExperimentFileImportTest.java @@ -327,12 +327,7 @@ public void appendExperimentMultipleDatasets() { newExp.put(Columns.COLUMN, "1"); JsonObject importResponse = importTestUtils.uploadAndFetchWorkflow(importTestUtils.writeExperimentDataToFile(List.of(newExp), null, false, false, null), null, true, client, program, mappingId, newExperimentWorkflowId); - String expId = importResponse - .get("preview").getAsJsonObject() - .get("rows").getAsJsonArray() - .get(0).getAsJsonObject() - .get("trial").getAsJsonObject() - .get("id").getAsString(); + String expId = brAPITrialDAO.getTrialsByName(List.of(newExp.get(Columns.EXP_TITLE).toString()), program).get(0).getTrialDbId(); // Create two sub-entity datasets that have two different sub entity units Flowable> sub1PostCall = client.exchange( From bb30594f6a40c4021288bc9165b35c6e65a29d62 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Mon, 4 May 2026 17:27:04 -0400 Subject: [PATCH 006/102] Remove code setting brapiId to exRef --- .../brapi/v2/BrAPITrialsController.java | 3 --- .../ExperimentControllerIntegrationTest.java | 13 +++++++------ 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java b/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java index 3da9ea965..195270184 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java +++ b/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java @@ -161,9 +161,6 @@ public HttpResponse trialsTrialDbIdPut(@PathVariable("programId") UUID progra // TODO: Remove for trialDbId once cache is removed for that entity private void setDbIds(BrAPITrial trial) { - trial.trialDbId(Utilities.getExternalReference(trial.getExternalReferences(), Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.TRIALS)) - .orElseThrow(() -> new IllegalStateException("No BI external reference found")) - .getReferenceID()); trial.programDbId(Utilities.getExternalReference(trial.getExternalReferences(), Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.PROGRAMS)) .orElseThrow(() -> new IllegalStateException("No BI external reference found")) .getReferenceID()); diff --git a/src/test/java/org/breedinginsight/api/v1/controller/ExperimentControllerIntegrationTest.java b/src/test/java/org/breedinginsight/api/v1/controller/ExperimentControllerIntegrationTest.java index 7c5c2a872..dfdf088ca 100644 --- a/src/test/java/org/breedinginsight/api/v1/controller/ExperimentControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/api/v1/controller/ExperimentControllerIntegrationTest.java @@ -95,6 +95,8 @@ public class ExperimentControllerIntegrationTest extends BrAPITest { private ProgramUserDAO programUserDAO; @Inject private RoleDao roleDao; + @Inject + private BrAPITrialService brAPITrialService; @Inject @Client("/${micronaut.bi.api.version}") @@ -201,12 +203,11 @@ void setup() throws Exception { program, mappingId, newExperimentWorkflowId); - experimentId = importResult - .get("preview").getAsJsonObject() - .get("rows").getAsJsonArray() - .get(0).getAsJsonObject() - .get("trial").getAsJsonObject() - .get("id").getAsString(); + + BrAPITrial trial = brAPITrialService.getExperiments(program.getId()).get(0); + + experimentId = trial.getTrialDbId(); + // Add environmentIds. envIds.add(getEnvId(importResult, 0)); envIds.add(getEnvId(importResult, 1)); From 35cde9c9b5896f56789e1878260a41b4675ed31b Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Tue, 5 May 2026 12:48:19 -0400 Subject: [PATCH 007/102] Changes to support ExperimentControllerIntegrationTest --- .../brapi/v2/services/BrAPITrialService.java | 12 ++++++- .../ExperimentControllerIntegrationTest.java | 31 ++++++++++--------- 2 files changed, 27 insertions(+), 16 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java index fbb8ad5ba..5ce65207c 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java @@ -792,17 +792,27 @@ public int deleteExperiment(Program program, UUID experimentId, boolean hard) th } BrAPITrial trial = trials.get(0); + UUID exRefId = Utilities.getExternalReference(trial.getExternalReferences(), referenceSource, ExternalReferenceSource.TRIALS) + .map(BrAPIExternalReference::getReferenceId) + .map(UUID::fromString) + .orElse(null); + + if (exRefId == null) { + throw new InternalServerException(String.format("Experiment with UUID [%s] does not have TRIALS exref", experimentId)); + } + List existingObservations = observationDAO.getObservationsByTrialDbId(List.of(trial.getTrialDbId()), program); // If there are no observations or a soft delete is requested, proceed. if (existingObservations.isEmpty() || !hard) { // Make request to delete experiment. trialDAO.deleteBrAPITrial(program, trial, hard); // Get all lists for the trial. + // TODO: Get lists by trialDbId if trials get decoupled from datasets. List lists = listDAO .getListsByTypeAndExternalRef(BrAPIListTypes.OBSERVATIONVARIABLES, program.getId(), Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.TRIALS), - experimentId); + exRefId); // TODO: replace with a single call to a batch delete method if that becomes available. // Iterate over lists, delete each by listDbId. for (BrAPIListSummary list : lists) { diff --git a/src/test/java/org/breedinginsight/api/v1/controller/ExperimentControllerIntegrationTest.java b/src/test/java/org/breedinginsight/api/v1/controller/ExperimentControllerIntegrationTest.java index dfdf088ca..bf8f6ba52 100644 --- a/src/test/java/org/breedinginsight/api/v1/controller/ExperimentControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/api/v1/controller/ExperimentControllerIntegrationTest.java @@ -235,7 +235,7 @@ private String uploadExperimentWithoutObs(Program targetProgram, String title, S expRows.add(row2); // Import test experiment, environments. - JsonObject importResult = importTestUtils.uploadAndFetchWorkflow( + importTestUtils.uploadAndFetchWorkflow( writeDataToFile(expRows, null), null, true, @@ -243,14 +243,14 @@ private String uploadExperimentWithoutObs(Program targetProgram, String title, S targetProgram, mappingId, newExperimentWorkflowId); - String expId = importResult - .get("preview").getAsJsonObject() - .get("rows").getAsJsonArray() - .get(0).getAsJsonObject() - .get("trial").getAsJsonObject() - .get("id").getAsString(); - return expId; + BrAPITrial trial = brAPITrialService.getExperiments(targetProgram.getId()) + .stream() + .filter(t -> t.getTrialName().equals(title)) + .findFirst() + .orElseThrow(); + + return trial.getTrialDbId(); } /** @@ -930,7 +930,7 @@ private List> buildObservedRows(String title) { private String uploadExperimentWithObs(Program targetProgram, String title, List> expRows) throws Exception { ImportTestUtils importTestUtils = new ImportTestUtils(); - JsonObject importResult = importTestUtils.uploadAndFetchWorkflow( + importTestUtils.uploadAndFetchWorkflow( importTestUtils.writeExperimentDataToFile(expRows, traits, false, false, null), null, true, @@ -939,12 +939,13 @@ private String uploadExperimentWithObs(Program targetProgram, String title, List mappingId, newExperimentWorkflowId); - return importResult - .get("preview").getAsJsonObject() - .get("rows").getAsJsonArray() - .get(0).getAsJsonObject() - .get("trial").getAsJsonObject() - .get("id").getAsString(); + BrAPITrial trial = brAPITrialService.getExperiments(targetProgram.getId()) + .stream() + .filter(t -> t.getTrialName().equals(title)) + .findFirst() + .orElseThrow(); + + return trial.getTrialDbId(); } private List> buildSubEntityRows(List> topLevelRows, String entityName, int repeatedMeasures) { From af7ceda87242d7abc3580f9ca5cd9512af226b0b Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Tue, 5 May 2026 17:02:15 -0400 Subject: [PATCH 008/102] Fix remaining test failures and alter some code to support dbIds --- .../brapi/v2/BrAPIStudiesController.java | 5 +--- .../brapi/v2/dao/BrAPIStudyDAO.java | 6 +--- .../brapi/v2/services/BrAPITrialService.java | 4 +++ .../brapi/v2/BrAPITestUtils.java | 26 +++++++++-------- .../BrAPITrialsControllerIntegrationTest.java | 17 ++++++----- ...tionVariableControllerIntegrationTest.java | 19 ++++++++---- .../SubEntityDatasetLockIntegrationTest.java | 10 ++++++- .../services/BrAPITrialServiceUnitTest.java | 7 +++++ .../SampleSubmissionFileImportTest.java | 29 ++++++++++++++----- 9 files changed, 81 insertions(+), 42 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/BrAPIStudiesController.java b/src/main/java/org/breedinginsight/brapi/v2/BrAPIStudiesController.java index daadea133..f9536ebdd 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/BrAPIStudiesController.java +++ b/src/main/java/org/breedinginsight/brapi/v2/BrAPIStudiesController.java @@ -114,6 +114,7 @@ public HttpResponse>>> getStudies( return ResponseUtils.getBrapiQueryResponse(authorizedStudies, studyQueryMapper, queryParams, searchRequest); } + // TODO: Instead of getting all studies for a program and filtering, doing the filtering on brapi side List studies = studyService.getStudies(programId) .stream() .peek(this::setDbIds) @@ -172,10 +173,6 @@ private void setDbIds(BrAPIStudy study) { .orElseThrow(() -> new IllegalStateException("No BI external reference found")) .getReferenceID()); - study.trialDbId(Utilities.getExternalReference(study.getExternalReferences(), Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.TRIALS)) - .orElseThrow(() -> new IllegalStateException("No BI external reference found")) - .getReferenceID()); - //TODO update locationDbId } } diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java index e789db2a2..7bc893f10 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java @@ -168,11 +168,7 @@ public List getStudiesByEnvironmentIds(@NotNull Collection env public List getStudiesByExperimentIds(@NotNull Collection experimentIds, Program program) throws ApiException { BrAPIStudySearchRequest studySearch = new BrAPIStudySearchRequest(); studySearch.programDbIds(List.of(program.getBrapiProgram().getProgramDbId())); - // Add all experimentIds as xref ID search terms. - for (UUID experimentId : experimentIds) { - studySearch.addExternalReferenceIdsItem(experimentId.toString()); - } - studySearch.addExternalReferenceSourcesItem(Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.TRIALS)); + studySearch.trialDbIds(experimentIds.stream().map(UUID::toString).collect(Collectors.toList())); StudiesApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(program.getId()), StudiesApi.class); return new ArrayList<>(processStudyForDisplay(brAPIDAOUtil.search( api::searchStudiesPost, diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java index 5ce65207c..1e34379f4 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java @@ -190,6 +190,10 @@ public DownloadFile exportObservations( .map(BrAPIExternalReference::getReferenceId) .orElse(null); + if (expExRefId == null) { + throw new InternalServerException(String.format("Trials exref does not exist for experiment [%s]", experimentId)); + } + // get requested environments for the experiment log.debug(logHash + ": fetching environments for export"); List expStudies = studyDAO.getStudiesByExperimentID(UUID.fromString(expExRefId), program); diff --git a/src/test/java/org/breedinginsight/brapi/v2/BrAPITestUtils.java b/src/test/java/org/breedinginsight/brapi/v2/BrAPITestUtils.java index 936bd401c..44caec1fa 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/BrAPITestUtils.java +++ b/src/test/java/org/breedinginsight/brapi/v2/BrAPITestUtils.java @@ -30,6 +30,7 @@ import io.micronaut.http.netty.cookies.NettyCookie; import io.reactivex.Flowable; import org.brapi.v2.model.BrAPIExternalReference; +import org.brapi.v2.model.core.BrAPITrial; import org.brapi.v2.model.germ.BrAPIGermplasm; import org.breedinginsight.TestUtils; import org.breedinginsight.api.auth.AuthenticatedUser; @@ -37,6 +38,7 @@ import org.breedinginsight.api.model.v1.request.SpeciesRequest; import org.breedinginsight.api.v1.controller.TestTokenValidator; import org.breedinginsight.brapi.v2.dao.BrAPIGermplasmDAO; +import org.breedinginsight.brapi.v2.services.BrAPITrialService; import org.breedinginsight.brapps.importer.ImportTestUtils; import org.breedinginsight.brapps.importer.model.imports.experimentObservation.ExperimentObservation; import org.breedinginsight.dao.db.enums.DataType; @@ -56,6 +58,7 @@ import java.io.FileOutputStream; import java.io.IOException; import java.util.*; +import java.util.stream.Collectors; import static io.micronaut.http.HttpRequest.GET; @@ -75,6 +78,8 @@ public class BrAPITestUtils { private OntologyService ontologyService; @Inject private BrAPIGermplasmDAO germplasmDAO; + @Inject + private BrAPITrialService brAPITrialService; @Inject @Client("/${micronaut.bi.api.version}") @@ -184,12 +189,6 @@ public Tuple2> setupTestProgram(DSLContext brAPIDslContext program, mappingId, newExperimentWorkflowId); - String experiment1Id = importResult - .get("preview").getAsJsonObject() - .get("rows").getAsJsonArray() - .get(0).getAsJsonObject() - .get("trial").getAsJsonObject() - .get("id").getAsString(); // Import test experiment, environments, and any observations importResult = importTestUtils.uploadAndFetchWorkflow( @@ -200,12 +199,15 @@ public Tuple2> setupTestProgram(DSLContext brAPIDslContext program, mappingId, newExperimentWorkflowId); - String experiment2Id = importResult - .get("preview").getAsJsonObject() - .get("rows").getAsJsonArray() - .get(0).getAsJsonObject() - .get("trial").getAsJsonObject() - .get("id").getAsString(); + + List trials = brAPITrialService.getExperiments(program.getId()) + .stream() + // Ensure trial with title xyz is always second + .sorted(Comparator.comparing(BrAPITrial::getTrialName)) + .collect(Collectors.toList()); + + String experiment1Id = trials.get(0).getTrialDbId(); + String experiment2Id = trials.get(1).getTrialDbId(); // Refetch collaborator, since we updated program_user_roles. collaborator = userDAO.getUserByOAuthId(TestTokenValidator.OTHER_TEST_USER_ORCID).orElseThrow(Exception::new); diff --git a/src/test/java/org/breedinginsight/brapi/v2/BrAPITrialsControllerIntegrationTest.java b/src/test/java/org/breedinginsight/brapi/v2/BrAPITrialsControllerIntegrationTest.java index dafa9b7a9..17888d69e 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/BrAPITrialsControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/BrAPITrialsControllerIntegrationTest.java @@ -28,6 +28,7 @@ import io.reactivex.Flowable; import org.brapi.v2.model.core.BrAPITrial; import org.breedinginsight.BrAPITest; +import org.breedinginsight.brapi.v2.services.BrAPITrialService; import org.breedinginsight.brapps.importer.services.ExternalReferenceSource; import org.breedinginsight.model.*; import org.breedinginsight.utilities.Utilities; @@ -59,6 +60,9 @@ public class BrAPITrialsControllerIntegrationTest extends BrAPITest { @Inject private BrAPITestUtils brAPITestUtils; + @Inject + private BrAPITrialService brAPIITrialService; + private final Gson gson = new GsonBuilder().registerTypeAdapter(OffsetDateTime.class, (JsonDeserializer) (json, type, context) -> OffsetDateTime.parse(json.getAsString())) .create(); @@ -98,16 +102,17 @@ public void testGetTrials() { // Check names and experimentIds (the BI-assigned UUID stored as an xref). List expNames = new ArrayList<>(); - List expIds = new ArrayList<>(); + List trialExRefIds = new ArrayList<>(); for (BrAPITrial trial : trials) { String experimentId = Utilities.getExternalReference(trial.getExternalReferences(), source).get().getReferenceId(); - expIds.add(experimentId); + trialExRefIds.add(experimentId); expNames.add(trial.getTrialName()); } assert(expNames.contains("xyz")); assert(expNames.contains("Test Exp")); - assert(expIds.contains(experiment1Id)); - assert(expIds.contains(experiment2Id)); + // Verify two different bi-api ex ref ids were generated for each trial + assertEquals(2 , trialExRefIds.size()); + assertNotEquals(trialExRefIds.get(0), trialExRefIds.get(1)); } /** @@ -129,9 +134,7 @@ public void testGetTrialsAsExperimentalCollaborator() { assertEquals(1, trials.size()); BrAPITrial trial = gson.fromJson(trials.get(0).getAsJsonObject(), BrAPITrial.class); assertEquals("xyz", trial.getTrialName()); - String source = Utilities.generateReferenceSource(BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.TRIALS); - String experimentId = Utilities.getExternalReference(trial.getExternalReferences(), source).get().getReferenceId(); - assertEquals(this.experiment2Id, experimentId); + assertEquals(this.experiment2Id, trial.getTrialDbId()); } } diff --git a/src/test/java/org/breedinginsight/brapi/v2/BrAPIV2ObservationVariableControllerIntegrationTest.java b/src/test/java/org/breedinginsight/brapi/v2/BrAPIV2ObservationVariableControllerIntegrationTest.java index 9fc0aac90..17f91ea0c 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/BrAPIV2ObservationVariableControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/BrAPIV2ObservationVariableControllerIntegrationTest.java @@ -31,6 +31,7 @@ import io.reactivex.Flowable; import lombok.SneakyThrows; import org.brapi.v2.model.BrAPIExternalReference; +import org.brapi.v2.model.core.BrAPITrial; import org.brapi.v2.model.germ.BrAPIGermplasm; import org.brapi.v2.model.pheno.BrAPIObservationVariable; import org.breedinginsight.BrAPITest; @@ -40,6 +41,7 @@ import org.breedinginsight.api.model.v1.request.SpeciesRequest; import org.breedinginsight.api.v1.controller.TestTokenValidator; import org.breedinginsight.brapi.v2.dao.BrAPIGermplasmDAO; +import org.breedinginsight.brapi.v2.services.BrAPITrialService; import org.breedinginsight.brapps.importer.ImportTestUtils; import org.breedinginsight.brapps.importer.model.imports.experimentObservation.ExperimentObservation; import org.breedinginsight.dao.db.enums.DataType; @@ -88,6 +90,8 @@ public class BrAPIV2ObservationVariableControllerIntegrationTest extends BrAPITe private OntologyService ontologyService; @Inject private BrAPIGermplasmDAO germplasmDAO; + @Inject + BrAPITrialService brAPITrialService; @Inject @Client("/${micronaut.bi.api.version}") @@ -195,12 +199,15 @@ void setup() throws Exception { program, mappingId, newExperimentWorkflowId); - experimentId = importResult - .get("preview").getAsJsonObject() - .get("rows").getAsJsonArray() - .get(0).getAsJsonObject() - .get("trial").getAsJsonObject() - .get("id").getAsString(); + + BrAPITrial trial = brAPITrialService.getExperiments(program.getId()) + .stream() + .findFirst() + .orElseThrow(); + + experimentId = trial.getTrialDbId(); + + // Add environmentIds. envIds.add(getEnvId(importResult, 0)); envIds.add(getEnvId(importResult, 1)); diff --git a/src/test/java/org/breedinginsight/brapi/v2/SubEntityDatasetLockIntegrationTest.java b/src/test/java/org/breedinginsight/brapi/v2/SubEntityDatasetLockIntegrationTest.java index d958d0b44..1e1f3c110 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/SubEntityDatasetLockIntegrationTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/SubEntityDatasetLockIntegrationTest.java @@ -10,7 +10,9 @@ import io.micronaut.http.client.annotation.Client; import io.micronaut.test.extensions.junit5.annotation.MicronautTest; import io.reactivex.Flowable; +import org.brapi.v2.model.core.BrAPITrial; import org.breedinginsight.BrAPITest; +import org.breedinginsight.brapi.v2.services.BrAPITrialService; import org.breedinginsight.model.Program; import org.junit.jupiter.api.*; @@ -34,6 +36,9 @@ public class SubEntityDatasetLockIntegrationTest extends BrAPITest { @Inject private BrAPITestUtils brAPITestUtils; + @Inject + BrAPITrialService brAPIITrialService; + @Inject @Client("/${micronaut.bi.api.version}") private RxHttpClient client; @@ -46,7 +51,10 @@ public class SubEntityDatasetLockIntegrationTest extends BrAPITest { void setup() throws Exception { var setup = brAPITestUtils.setupTestProgram(super.getBrapiDsl(), gson); program = setup.getV1(); - experimentId = setup.getV2().get(0); + experimentId = brAPIITrialService.getExperiments(program.getId()).stream() + .map(BrAPITrial::getTrialDbId) + .findFirst() + .orElseThrow(); } @Test diff --git a/src/test/java/org/breedinginsight/brapi/v2/services/BrAPITrialServiceUnitTest.java b/src/test/java/org/breedinginsight/brapi/v2/services/BrAPITrialServiceUnitTest.java index 5a055bdd0..866866195 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/services/BrAPITrialServiceUnitTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/services/BrAPITrialServiceUnitTest.java @@ -35,6 +35,7 @@ import org.breedinginsight.services.TraitService; import org.breedinginsight.services.lock.DistributedLockService; import org.breedinginsight.utilities.FileUtil; +import org.breedinginsight.utilities.Utilities; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import tech.tablesaw.api.Table; @@ -121,6 +122,12 @@ void setup() { experimentInfo.addProperty(BrAPIAdditionalInfoFields.EXPERIMENT_TYPE, "Phenotyping"); experiment.setAdditionalInfo(experimentInfo); + BrAPIExternalReference externalReference = new BrAPIExternalReference(); + externalReference.setReferenceSource(Utilities.generateReferenceSource(REFERENCE_SOURCE, ExternalReferenceSource.TRIALS)); + externalReference.setReferenceId("11111111-1111-1111-1111-111111111111"); + + experiment.setExternalReferences(List.of(externalReference)); + study = new BrAPIStudy(); study.setStudyDbId("study-1"); study.setStudyName("Environment 1"); diff --git a/src/test/java/org/breedinginsight/brapps/importer/SampleSubmissionFileImportTest.java b/src/test/java/org/breedinginsight/brapps/importer/SampleSubmissionFileImportTest.java index f19803127..b59c41900 100644 --- a/src/test/java/org/breedinginsight/brapps/importer/SampleSubmissionFileImportTest.java +++ b/src/test/java/org/breedinginsight/brapps/importer/SampleSubmissionFileImportTest.java @@ -45,6 +45,7 @@ import org.breedinginsight.api.model.v1.request.SpeciesRequest; import org.breedinginsight.brapi.v2.constants.BrAPIAdditionalInfoFields; import org.breedinginsight.brapi.v2.dao.*; +import org.breedinginsight.brapi.v2.services.BrAPITrialService; import org.breedinginsight.brapps.importer.daos.*; import org.breedinginsight.brapps.importer.model.imports.experimentObservation.ExperimentObservation; import org.breedinginsight.brapps.importer.model.imports.sample.SampleSubmissionImport.Columns; @@ -143,6 +144,9 @@ public class SampleSubmissionFileImportTest extends BrAPITest { @Inject private SampleSubmissionService sampleSubmissionService; + @Inject + BrAPITrialService brAPITrialService; + private Gson gson = new GsonBuilder().registerTypeAdapter(OffsetDateTime.class, (JsonDeserializer) (json, type, context) -> OffsetDateTime.parse(json.getAsString())) .registerTypeAdapter(BrAPIPagination.class, new PaginationTypeAdapter()) @@ -567,7 +571,7 @@ private String createExperiment(Program program) throws IOException, Interrupted .getAsJsonArray("data") .get(0).getAsJsonObject().get("id").getAsString(); - JsonObject importResult = importTestUtils.uploadAndFetchWorkflow( + importTestUtils.uploadAndFetchWorkflow( importTestUtils.writeExperimentDataToFile(List.of(makeExpImportRow("Env1")), null, false, false, null), null, true, @@ -575,12 +579,23 @@ private String createExperiment(Program program) throws IOException, Interrupted program, expMappingId, newExperimentWorkflowId); - return importResult - .get("preview").getAsJsonObject() - .get("rows").getAsJsonArray() - .get(0).getAsJsonObject() - .get("trial").getAsJsonObject() - .get("id").getAsString(); + + + String result; + + try { + // Assumes only one trial/experiment exists + BrAPITrial trial = brAPITrialService.getExperiments(program.getId()) + .stream() + .findFirst() + .orElseThrow(); + + result = trial.getTrialDbId(); + } catch (Exception e) { + throw new RuntimeException(e); + } + + return result; } private Map makeExpImportRow(String environment) { From 6854606061bbf6b508a7d5fe1b5c5e180ee7a27c Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Tue, 5 May 2026 17:35:44 -0400 Subject: [PATCH 009/102] Remove cache from last get method --- .../brapi/v2/dao/impl/BrAPITrialDAOImpl.java | 13 ++----------- 1 file changed, 2 insertions(+), 11 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java index 849c1b021..1ae003a2f 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java @@ -265,18 +265,9 @@ public Optional getTrialById(UUID programId, UUID trialId) throws Ap @Override public List getTrialsByDbIds(Collection trialDbIds, Program program) throws ApiException { - // Lookup on trialDbIds directly in BrAPI - Map cache = programExperimentCache.get(program.getId()); - List trials = new ArrayList<>(); - if (cache != null) { - trials.addAll(cache - .values() - .stream() - .filter(t -> trialDbIds.contains(t.getTrialDbId())) - .collect(Collectors.toList())); - } + Collection trialDbUUIDs = trialDbIds.stream().map(UUID::fromString).collect(Collectors.toList()); - return trials; + return getTrialsByExperimentIds(trialDbUUIDs, program); } // TODO: ExperimentIds will = trialDbIds once cache is updated. Update this method to get trials on dbId directly from brapi. From 1f183776e3f5ba432b1511b2eea430b38036435c Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Tue, 5 May 2026 17:48:57 -0400 Subject: [PATCH 010/102] Remove cache from trial update --- .../brapi/v2/dao/impl/BrAPITrialDAOImpl.java | 16 +--------------- 1 file changed, 1 insertion(+), 15 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java index 1ae003a2f..47cf0db85 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java @@ -205,25 +205,11 @@ public List createBrAPITrials(List brAPITrialList, UUID } } - // TODO: Fix by grabbing inner code of callback, removing callback and cache call, and return result from BrAPI call. @Override public BrAPITrial updateBrAPITrial(String trialDbId, BrAPITrial trial, UUID programId) { TrialsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(programId), TrialsApi.class); - BrAPITrial updatedTrial = null; try { - if (trial != null && !trialDbId.isBlank()) { - Callable> putCallback = () -> { - BrAPITrial putTrial = brAPIDAOUtil.put(trialDbId, trial, api::trialsTrialDbIdPut); - return experimentById(List.of(putTrial)); - }; - List cachedUpdates = programExperimentCache.post(programId, putCallback); - if (cachedUpdates.isEmpty()) { - throw new Exception(); - } - updatedTrial = cachedUpdates.get(0); - } - - return updatedTrial; + return brAPIDAOUtil.put(trialDbId, trial, api::trialsTrialDbIdPut); } catch (Exception e) { throw new InternalServerException("Unknown error has occurred: " + e.getMessage(), e); } From c2083d8d251ea5246ab39db7e28a9697f47df8a0 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Tue, 5 May 2026 19:12:39 -0400 Subject: [PATCH 011/102] Remove cache from post method and remove entirely for trials --- .../brapi/v2/dao/BrAPITrialDAO.java | 2 - .../brapi/v2/dao/impl/BrAPITrialDAOImpl.java | 54 +------------------ .../brapi/v2/services/BrAPITrialService.java | 2 - 3 files changed, 2 insertions(+), 56 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPITrialDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPITrialDAO.java index 81ca88d4f..bbc3ceb56 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPITrialDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPITrialDAO.java @@ -45,6 +45,4 @@ List createBrAPITrials(List brAPITrialList, UUID program List getTrialsByExperimentIds(Collection experimentIds, Program program) throws ApiException; void deleteBrAPITrial(Program program, BrAPITrial trial, boolean hard) throws ApiException; - - void repopulateCache(UUID programId); } diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java index 47cf0db85..29b01ed44 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java @@ -26,7 +26,6 @@ import org.brapi.client.v2.model.exceptions.ApiException; import org.brapi.client.v2.model.queryParams.core.TrialQueryParams; import org.brapi.client.v2.modules.core.TrialsApi; -import org.brapi.v2.model.BrAPIExternalReference; import org.brapi.v2.model.core.BrAPIProgram; import org.brapi.v2.model.core.BrAPITrial; import org.brapi.v2.model.core.request.BrAPITrialSearchRequest; @@ -36,8 +35,6 @@ import org.breedinginsight.brapps.importer.model.ImportUpload; import org.breedinginsight.brapps.importer.services.ExternalReferenceSource; import org.breedinginsight.daos.ProgramDAO; -import org.breedinginsight.daos.cache.ProgramCache; -import org.breedinginsight.daos.cache.ProgramCacheProvider; import org.breedinginsight.model.Program; import org.breedinginsight.services.ProgramService; import org.breedinginsight.services.brapi.BrAPIEndpointProvider; @@ -48,14 +45,12 @@ import javax.inject.Inject; import javax.inject.Singleton; import java.util.*; -import java.util.concurrent.Callable; import java.util.stream.Collectors; @Slf4j @Context @Singleton public class BrAPITrialDAOImpl implements BrAPITrialDAO { - private final ProgramCache programExperimentCache; private final ProgramDAO programDAO; private final ImportDAO importDAO; private final BrAPIDAOUtil brAPIDAOUtil; @@ -65,15 +60,13 @@ public class BrAPITrialDAOImpl implements BrAPITrialDAO { private final boolean runScheduledTasks; @Inject - public BrAPITrialDAOImpl(ProgramCacheProvider programCacheProvider, - ProgramDAO programDAO, + public BrAPITrialDAOImpl(ProgramDAO programDAO, ImportDAO importDAO, BrAPIDAOUtil brAPIDAOUtil, ProgramService programService, @Property(name = "brapi.server.reference-source") String referenceSource, BrAPIEndpointProvider brAPIEndpointProvider, @Property(name = "micronaut.bi.api.run-scheduled-tasks") boolean runScheduledTasks) { - this.programExperimentCache = programCacheProvider.getProgramCache(this::fetchProgramExperiments, BrAPITrial.class); this.programDAO = programDAO; this.importDAO = importDAO; this.brAPIDAOUtil = brAPIDAOUtil; @@ -83,32 +76,6 @@ public BrAPITrialDAOImpl(ProgramCacheProvider programCacheProvider, this.runScheduledTasks = runScheduledTasks; } - // TODO: Can be removed once cache instance is gone - private Map fetchProgramExperiments(UUID programId) throws ApiException { - TrialsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(programId), TrialsApi.class); - - // Get the program - List programs = programDAO.get(programId); - if (programs.size() != 1) { - throw new InternalServerException("Program was not found for given key"); - } - Program program = programs.get(0); - - // Get the program experiments - BrAPITrialSearchRequest trialSearch = new BrAPITrialSearchRequest(); - trialSearch.externalReferenceIDs(List.of(programId.toString())); - trialSearch.externalReferenceSources( - List.of(Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.PROGRAMS)) - ); - List programExperiments = brAPIDAOUtil.search( - api::searchTrialsPost, - api::searchTrialsSearchResultsDbIdGet, - trialSearch - ); - - return experimentById(processExperimentsForDisplay(programExperiments, program.getKey())); - } - /** * This method requires a BI-API program. If the BrAPIProgram inside this data model is not set, * this method will retrieve it. @@ -188,18 +155,8 @@ public List getTrialsByName(List trialNames, Program program @Override public List createBrAPITrials(List brAPITrialList, UUID programId, ImportUpload upload) { TrialsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(programId), TrialsApi.class); - List createdTrials = new ArrayList<>(); try { - if (!brAPITrialList.isEmpty()) { - Callable> postCallback = () -> { - List postedTrials = brAPIDAOUtil - .post(brAPITrialList, upload, api::trialsPost, importDAO::update); - return experimentById(postedTrials); - }; - createdTrials.addAll(programExperimentCache.post(programId, postCallback)); - } - - return createdTrials; + return brAPIDAOUtil.post(brAPITrialList, upload, api::trialsPost, importDAO::update); } catch (Exception e) { throw new InternalServerException("Unknown error has occurred: " + e.getMessage(), e); } @@ -290,11 +247,4 @@ public void deleteBrAPITrial(Program program, BrAPITrial trial, boolean hard) th brAPIDAOUtil.makeCall(brapiRequest); } - - // TODO: Remove when trial cache is removed. - @Override - public void repopulateCache(UUID programId) { - this.programExperimentCache.invalidate(programId); - this.programExperimentCache.populate(programId); - } } diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java index 1e34379f4..34312233b 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java @@ -823,8 +823,6 @@ public int deleteExperiment(Program program, UUID experimentId, boolean hard) th listDAO.deleteBrAPIList(list.getListDbId(), program.getId(), hard); } // TODO: if performance is poor, implement more precise invalidation, possibly using hierarchical cache keys. - // Invalidate and repopulate cache for Trial, Study, Observation, ObservationUnit. - trialDAO.repopulateCache(program.getId()); studyDAO.repopulateCache(program.getId()); observationDAO.repopulateCache(program.getId()); observationUnitDAO.repopulateCache(program.getId()); From 3b2b0477f389f59a0430bd6fc3a60baf7934ad53 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Wed, 6 May 2026 16:46:07 -0400 Subject: [PATCH 012/102] Remove unused imports, comments, refactor some function names in BrAPITrialDAOImpl --- .../brapi/v2/dao/impl/BrAPITrialDAOImpl.java | 30 +++---------------- 1 file changed, 4 insertions(+), 26 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java index 29b01ed44..fbbf119b2 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java @@ -17,7 +17,6 @@ package org.breedinginsight.brapi.v2.dao.impl; import io.micronaut.context.annotation.Context; -import io.micronaut.context.annotation.Property; import io.micronaut.http.server.exceptions.InternalServerException; import lombok.extern.slf4j.Slf4j; import okhttp3.HttpUrl; @@ -33,10 +32,8 @@ import org.breedinginsight.brapi.v2.dao.BrAPITrialDAO; import org.breedinginsight.brapps.importer.daos.ImportDAO; import org.breedinginsight.brapps.importer.model.ImportUpload; -import org.breedinginsight.brapps.importer.services.ExternalReferenceSource; import org.breedinginsight.daos.ProgramDAO; import org.breedinginsight.model.Program; -import org.breedinginsight.services.ProgramService; import org.breedinginsight.services.brapi.BrAPIEndpointProvider; import org.breedinginsight.services.exceptions.DoesNotExistException; import org.breedinginsight.utilities.BrAPIDAOUtil; @@ -54,33 +51,24 @@ public class BrAPITrialDAOImpl implements BrAPITrialDAO { private final ProgramDAO programDAO; private final ImportDAO importDAO; private final BrAPIDAOUtil brAPIDAOUtil; - private final ProgramService programService; private final BrAPIEndpointProvider brAPIEndpointProvider; - private final String referenceSource; - private final boolean runScheduledTasks; @Inject public BrAPITrialDAOImpl(ProgramDAO programDAO, ImportDAO importDAO, BrAPIDAOUtil brAPIDAOUtil, - ProgramService programService, - @Property(name = "brapi.server.reference-source") String referenceSource, - BrAPIEndpointProvider brAPIEndpointProvider, - @Property(name = "micronaut.bi.api.run-scheduled-tasks") boolean runScheduledTasks) { + BrAPIEndpointProvider brAPIEndpointProvider) { this.programDAO = programDAO; this.importDAO = importDAO; this.brAPIDAOUtil = brAPIDAOUtil; - this.programService = programService; - this.referenceSource = referenceSource; this.brAPIEndpointProvider = brAPIEndpointProvider; - this.runScheduledTasks = runScheduledTasks; } /** * This method requires a BI-API program. If the BrAPIProgram inside this data model is not set, * this method will retrieve it. */ - private List getBrAPITrialsUsingBrAPIProgram(Program program) throws ApiException { + private List getBrAPITrialsUsingBrAPIProgramId(Program program) throws ApiException { if (program == null || program.getId() == null) { throw new InternalServerException("BI-API Program or Program ID is null"); @@ -128,17 +116,9 @@ private List getTrialsFromBrAPI(Program program, TrialQueryParams tr return processExperimentsForDisplay(trialsFromResponse, program.getKey()); } - private Map experimentById(List trials) { - Map experimentById = new HashMap<>(); - for (BrAPITrial experiment: trials) { - experimentById.put(experiment.getTrialDbId(), experiment); - } - return experimentById; - } - @Override public List getTrialsByName(List trialNames, Program program) throws ApiException { - List allTrialsForProgram = getBrAPITrialsUsingBrAPIProgram(program); + List allTrialsForProgram = getBrAPITrialsUsingBrAPIProgramId(program); List trials = new ArrayList<>(); if (allTrialsForProgram != null) { @@ -151,7 +131,6 @@ public List getTrialsByName(List trialNames, Program program return trials; } - // TODO: Fix by using only code of inner callback and returning result @Override public List createBrAPITrials(List brAPITrialList, UUID programId, ImportUpload upload) { TrialsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(programId), TrialsApi.class); @@ -177,7 +156,7 @@ public List getTrials(UUID programId) throws ApiException { Program program = programDAO.get(programId).get(0); program.setBrapiProgram(programDAO.getProgramBrAPI(program)); - return getBrAPITrialsUsingBrAPIProgram(program); + return getBrAPITrialsUsingBrAPIProgramId(program); } //Removes program key from trial name @@ -213,7 +192,6 @@ public List getTrialsByDbIds(Collection trialDbIds, Program return getTrialsByExperimentIds(trialDbUUIDs, program); } - // TODO: ExperimentIds will = trialDbIds once cache is updated. Update this method to get trials on dbId directly from brapi. @Override public List getTrialsByExperimentIds(Collection experimentIds, Program program) throws ApiException { if(experimentIds.isEmpty()) { From 3b081b8c5a127fd851e6a39ebefa69af6b4334dc Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Wed, 6 May 2026 16:59:23 -0400 Subject: [PATCH 013/102] Rename BrAPIStudyDAO method to reflect lookup on BrAPI Trial ExRef --- .../brapi/v2/dao/BrAPIStudyDAO.java | 6 +++--- .../brapi/v2/services/BrAPITrialService.java | 2 +- ...ulateExistingPendingImportObjectsStep.java | 2 +- .../services/BrAPITrialServiceUnitTest.java | 2 +- .../importer/ExperimentFileImportTest.java | 20 +++++++++---------- 5 files changed, 16 insertions(+), 16 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java index 7bc893f10..08298a130 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java @@ -136,11 +136,11 @@ public List getStudiesByName(List studyNames, Program progra ); } - public List getStudiesByExperimentID(@NotNull UUID experimentId, Program program) throws ApiException { - // TODO: This should look up on trialDbId, and the trialDbId should be passed thru + public List getStudiesByBrAPITrialExRefId(@NotNull UUID brapiTrialExRefId, Program program) throws ApiException { + // TODO: If external references are removed for trial for studies, this method should look up on trialDbId, and the trialDbId should be passed through. BrAPIStudySearchRequest studySearch = new BrAPIStudySearchRequest(); studySearch.programDbIds(List.of(program.getBrapiProgram().getProgramDbId())); - studySearch.addExternalReferenceIdsItem(experimentId.toString()); + studySearch.addExternalReferenceIdsItem(brapiTrialExRefId.toString()); studySearch.addExternalReferenceSourcesItem(Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.TRIALS)); StudiesApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(program.getId()), StudiesApi.class); return brAPIDAOUtil.search( diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java index 34312233b..c1c4a44dd 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java @@ -196,7 +196,7 @@ public DownloadFile exportObservations( // get requested environments for the experiment log.debug(logHash + ": fetching environments for export"); - List expStudies = studyDAO.getStudiesByExperimentID(UUID.fromString(expExRefId), program); + List expStudies = studyDAO.getStudiesByBrAPITrialExRefId(UUID.fromString(expExRefId), program); if (!requestedEnvIds.isEmpty()) { expStudies = expStudies .stream() diff --git a/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/create/workflow/steps/PopulateExistingPendingImportObjectsStep.java b/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/create/workflow/steps/PopulateExistingPendingImportObjectsStep.java index 06c7c14c9..e4d6d93cc 100644 --- a/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/create/workflow/steps/PopulateExistingPendingImportObjectsStep.java +++ b/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/create/workflow/steps/PopulateExistingPendingImportObjectsStep.java @@ -213,7 +213,7 @@ private Map> initializeStudyByNameNoScop try { // the 'trial' variable will never be "null". UUID experimentId = UUID.fromString(expExRefId); - existingStudies = brAPIStudyDAO.getStudiesByExperimentID(experimentId, program); + existingStudies = brAPIStudyDAO.getStudiesByBrAPITrialExRefId(experimentId, program); for (BrAPIStudy existingStudy : existingStudies) { experimentStudyService.processAndCacheStudy(existingStudy, program, BrAPIStudy::getStudyName, studyByName); } diff --git a/src/test/java/org/breedinginsight/brapi/v2/services/BrAPITrialServiceUnitTest.java b/src/test/java/org/breedinginsight/brapi/v2/services/BrAPITrialServiceUnitTest.java index 866866195..c10778b35 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/services/BrAPITrialServiceUnitTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/services/BrAPITrialServiceUnitTest.java @@ -171,7 +171,7 @@ void exportObservationsFetchesSeasonOncePerDistinctSeasonAndWritesEnvYears() thr when(trialDAO.getTrialsByExperimentIds(eq(List.of(UUID.fromString("11111111-1111-1111-1111-111111111111"))), eq(program))) .thenReturn(List.of(experiment)); - when(studyDAO.getStudiesByExperimentID(eq(UUID.fromString("11111111-1111-1111-1111-111111111111")), eq(program))) + when(studyDAO.getStudiesByBrAPITrialExRefId(eq(UUID.fromString("11111111-1111-1111-1111-111111111111")), eq(program))) .thenReturn(List.of(study, secondStudy)); when(seasonDAO.getSeasonById("season-1", program.getId())).thenReturn(season); when(seasonDAO.getSeasonById("season-2", program.getId())).thenReturn(secondSeason); diff --git a/src/test/java/org/breedinginsight/brapps/importer/ExperimentFileImportTest.java b/src/test/java/org/breedinginsight/brapps/importer/ExperimentFileImportTest.java index abd55e9b0..07f5f583c 100644 --- a/src/test/java/org/breedinginsight/brapps/importer/ExperimentFileImportTest.java +++ b/src/test/java/org/breedinginsight/brapps/importer/ExperimentFileImportTest.java @@ -926,7 +926,7 @@ public void importNewObsVarExistingOu() { BrAPITrial brAPITrial = brAPITrialDAO.getTrialsByName(List.of((String)newExp.get(Columns.EXP_TITLE)), program).get(0); Optional trialIdXref = Utilities.getExternalReference(brAPITrial.getExternalReferences(), String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.TRIALS.getName())); assertTrue(trialIdXref.isPresent()); - BrAPIStudy brAPIStudy = brAPIStudyDAO.getStudiesByExperimentID(UUID.fromString(trialIdXref.get().getReferenceId()), program).get(0); + BrAPIStudy brAPIStudy = brAPIStudyDAO.getStudiesByBrAPITrialExRefId(UUID.fromString(trialIdXref.get().getReferenceId()), program).get(0); BrAPIObservationUnit ou = ouDAO.getObservationUnitsForStudyDbId(brAPIStudy.getStudyDbId(), program).get(0); Optional ouIdXref = Utilities.getExternalReference(ou.getExternalReferences(), String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.OBSERVATION_UNITS.getName())); @@ -992,7 +992,7 @@ public void importNewObsVarByObsUnitId() { BrAPITrial brAPITrial = brAPITrialDAO.getTrialsByName(List.of((String)newExp.get(Columns.EXP_TITLE)), program).get(0); Optional trialIdXref = Utilities.getExternalReference(brAPITrial.getExternalReferences(), String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.TRIALS.getName())); assertTrue(trialIdXref.isPresent()); - BrAPIStudy brAPIStudy = brAPIStudyDAO.getStudiesByExperimentID(UUID.fromString(trialIdXref.get().getReferenceId()), program).get(0); + BrAPIStudy brAPIStudy = brAPIStudyDAO.getStudiesByBrAPITrialExRefId(UUID.fromString(trialIdXref.get().getReferenceId()), program).get(0); BrAPIObservationUnit ou = ouDAO.getObservationUnitsForStudyDbId(brAPIStudy.getStudyDbId(), program).get(0); Optional ouIdXref = Utilities.getExternalReference(ou.getExternalReferences(), String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.OBSERVATION_UNITS.getName())); @@ -1046,7 +1046,7 @@ public void importNewObservationDataByObsUnitId(boolean commit) { BrAPITrial brAPITrial = brAPITrialDAO.getTrialsByName(List.of((String)newExp.get(Columns.EXP_TITLE)), program).get(0); Optional trialIdXref = Utilities.getExternalReference(brAPITrial.getExternalReferences(), String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.TRIALS.getName())); assertTrue(trialIdXref.isPresent()); - BrAPIStudy brAPIStudy = brAPIStudyDAO.getStudiesByExperimentID(UUID.fromString(trialIdXref.get().getReferenceId()), program).get(0); + BrAPIStudy brAPIStudy = brAPIStudyDAO.getStudiesByBrAPITrialExRefId(UUID.fromString(trialIdXref.get().getReferenceId()), program).get(0); BrAPIObservationUnit ou = ouDAO.getObservationUnitsForStudyDbId(brAPIStudy.getStudyDbId(), program).get(0); Optional ouIdXref = Utilities.getExternalReference(ou.getExternalReferences(), String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.OBSERVATION_UNITS.getName())); @@ -1123,7 +1123,7 @@ public void verifyBlankObsInOverwriteIsNoOp(boolean commit) { BrAPITrial brAPITrial = brAPITrialDAO.getTrialsByName(List.of((String)newExp.get(Columns.EXP_TITLE)), program).get(0); Optional trialIdXref = Utilities.getExternalReference(brAPITrial.getExternalReferences(), String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.TRIALS.getName())); assertTrue(trialIdXref.isPresent()); - BrAPIStudy brAPIStudy = brAPIStudyDAO.getStudiesByExperimentID(UUID.fromString(trialIdXref.get().getReferenceId()), program).get(0); + BrAPIStudy brAPIStudy = brAPIStudyDAO.getStudiesByBrAPITrialExRefId(UUID.fromString(trialIdXref.get().getReferenceId()), program).get(0); BrAPIObservationUnit ou = ouDAO.getObservationUnitsForStudyDbId(brAPIStudy.getStudyDbId(), program).get(0); Optional ouIdXref = Utilities.getExternalReference(ou.getExternalReferences(), String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.OBSERVATION_UNITS.getName())); assertTrue(ouIdXref.isPresent()); @@ -1192,7 +1192,7 @@ public void importNewObsExistingOu(boolean commit) { BrAPITrial brAPITrial = brAPITrialDAO.getTrialsByName(List.of((String)newExp.get(Columns.EXP_TITLE)), program).get(0); Optional trialIdXref = Utilities.getExternalReference(brAPITrial.getExternalReferences(), String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.TRIALS.getName())); assertTrue(trialIdXref.isPresent()); - BrAPIStudy brAPIStudy = brAPIStudyDAO.getStudiesByExperimentID(UUID.fromString(trialIdXref.get().getReferenceId()), program).get(0); + BrAPIStudy brAPIStudy = brAPIStudyDAO.getStudiesByBrAPITrialExRefId(UUID.fromString(trialIdXref.get().getReferenceId()), program).get(0); BrAPIObservationUnit ou = ouDAO.getObservationUnitsForStudyDbId(brAPIStudy.getStudyDbId(), program).get(0); Optional ouIdXref = Utilities.getExternalReference(ou.getExternalReferences(), String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.OBSERVATION_UNITS.getName())); @@ -1260,7 +1260,7 @@ public void verifyFailureImportNewObsExistingOuWithExistingObs(boolean commit) { BrAPITrial brAPITrial = brAPITrialDAO.getTrialsByName(List.of((String)newExp.get(Columns.EXP_TITLE)), program).get(0); Optional trialIdXref = Utilities.getExternalReference(brAPITrial.getExternalReferences(), String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.TRIALS.getName())); assertTrue(trialIdXref.isPresent()); - BrAPIStudy brAPIStudy = brAPIStudyDAO.getStudiesByExperimentID(UUID.fromString(trialIdXref.get().getReferenceId()), program).get(0); + BrAPIStudy brAPIStudy = brAPIStudyDAO.getStudiesByBrAPITrialExRefId(UUID.fromString(trialIdXref.get().getReferenceId()), program).get(0); BrAPIObservationUnit ou = ouDAO.getObservationUnitsForStudyDbId(brAPIStudy.getStudyDbId(), program).get(0); Optional ouIdXref = Utilities.getExternalReference(ou.getExternalReferences(), String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.OBSERVATION_UNITS.getName())); @@ -1389,7 +1389,7 @@ public void importNewObsAfterFirstExpWithObs(boolean commit) { BrAPITrial brAPITrial = brAPITrialDAO.getTrialsByName(List.of((String)newExp.get(Columns.EXP_TITLE)), program).get(0); Optional trialIdXref = Utilities.getExternalReference(brAPITrial.getExternalReferences(), String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.TRIALS.getName())); assertTrue(trialIdXref.isPresent()); - BrAPIStudy brAPIStudy = brAPIStudyDAO.getStudiesByExperimentID(UUID.fromString(trialIdXref.get().getReferenceId()), program).get(0); + BrAPIStudy brAPIStudy = brAPIStudyDAO.getStudiesByBrAPITrialExRefId(UUID.fromString(trialIdXref.get().getReferenceId()), program).get(0); BrAPIObservationUnit ou = ouDAO.getObservationUnitsForStudyDbId(brAPIStudy.getStudyDbId(), program).get(0); Optional ouIdXref = Utilities.getExternalReference(ou.getExternalReferences(), String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.OBSERVATION_UNITS.getName())); @@ -1466,7 +1466,7 @@ public void importNewObsAfterFirstExpWithObsAndTimestamps() { BrAPITrial brAPITrial = brAPITrialDAO.getTrialsByName(List.of((String)newExp.get(Columns.EXP_TITLE)), program).get(0); Optional trialIdXref = Utilities.getExternalReference(brAPITrial.getExternalReferences(), String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.TRIALS.getName())); assertTrue(trialIdXref.isPresent()); - BrAPIStudy brAPIStudy = brAPIStudyDAO.getStudiesByExperimentID(UUID.fromString(trialIdXref.get().getReferenceId()), program).get(0); + BrAPIStudy brAPIStudy = brAPIStudyDAO.getStudiesByBrAPITrialExRefId(UUID.fromString(trialIdXref.get().getReferenceId()), program).get(0); BrAPIObservationUnit ou = ouDAO.getObservationUnitsForStudyDbId(brAPIStudy.getStudyDbId(), program).get(0); Optional ouIdXref = Utilities.getExternalReference(ou.getExternalReferences(), String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.OBSERVATION_UNITS.getName())); @@ -1542,7 +1542,7 @@ public void importNewObsAfterFirstExpWithObs_blank(boolean commit) { BrAPITrial brAPITrial = brAPITrialDAO.getTrialsByName(List.of((String)newExp.get(Columns.EXP_TITLE)), program).get(0); Optional trialIdXref = Utilities.getExternalReference(brAPITrial.getExternalReferences(), String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.TRIALS.getName())); assertTrue(trialIdXref.isPresent()); - BrAPIStudy brAPIStudy = brAPIStudyDAO.getStudiesByExperimentID(UUID.fromString(trialIdXref.get().getReferenceId()), program).get(0); + BrAPIStudy brAPIStudy = brAPIStudyDAO.getStudiesByBrAPITrialExRefId(UUID.fromString(trialIdXref.get().getReferenceId()), program).get(0); BrAPIObservationUnit ou = ouDAO.getObservationUnitsForStudyDbId(brAPIStudy.getStudyDbId(), program).get(0); Optional ouIdXref = Utilities.getExternalReference(ou.getExternalReferences(), String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.OBSERVATION_UNITS.getName())); @@ -1639,7 +1639,7 @@ private Map assertRowSaved(Map expected, Program Optional trialIdXref = Utilities.getExternalReference(trial.getExternalReferences(), String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.TRIALS.getName())); assertTrue(trialIdXref.isPresent()); - List studies = brAPIStudyDAO.getStudiesByExperimentID(UUID.fromString(trialIdXref.get().getReferenceId()), program); + List studies = brAPIStudyDAO.getStudiesByBrAPITrialExRefId(UUID.fromString(trialIdXref.get().getReferenceId()), program); assertFalse(studies.isEmpty()); BrAPIStudy study = null; for(BrAPIStudy s : studies) { From 092c25b60cf3ed86b269a07bb574345501f3bbc3 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Wed, 6 May 2026 17:04:03 -0400 Subject: [PATCH 014/102] Add comment on PendingImportObject id --- .../brapps/importer/model/response/PendingImportObject.java | 1 + 1 file changed, 1 insertion(+) diff --git a/src/main/java/org/breedinginsight/brapps/importer/model/response/PendingImportObject.java b/src/main/java/org/breedinginsight/brapps/importer/model/response/PendingImportObject.java index 9b0027e27..1cc24b9a3 100644 --- a/src/main/java/org/breedinginsight/brapps/importer/model/response/PendingImportObject.java +++ b/src/main/java/org/breedinginsight/brapps/importer/model/response/PendingImportObject.java @@ -33,6 +33,7 @@ public class PendingImportObject { public PendingImportObject(ImportObjectState state, T brAPIObject, UUID id) { this.state = state; this.brAPIObject = brAPIObject; + // TODO: With 1.5 work, this id is the BI-API generated ID that is set for external references in BrAPI. It is different than the BrAPI DB ID of an entity. We may want to consider changing this at some point this.id = id; } public PendingImportObject(ImportObjectState state, T brAPIObject) { From 7425a6ead64199ca890ed0a4da44afda672f2ec5 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Wed, 27 May 2026 12:18:38 -0400 Subject: [PATCH 015/102] Update brapi java client version --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 674e7ffea..009602e45 100644 --- a/pom.xml +++ b/pom.xml @@ -89,7 +89,7 @@ 31.0.1-jre 4.9.3 4.3.1 - 2.2-SNAPSHOT + 2.2.1-SNAPSHOT 2.11.0 2.2.1 From da3eeb23acd2f833d844232266a1f5c77cfaa503 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Fri, 29 May 2026 11:36:26 -0400 Subject: [PATCH 016/102] Update TrialsController to support brapi side filter/sort/pagination Additionally, create utilities for developers to reuse --- .../v1/controller/ExperimentController.java | 4 +- .../brapi/v2/BrAPITrialsController.java | 16 ++-- .../brapi/v2/dao/BrAPITrialDAO.java | 5 ++ .../brapi/v2/dao/impl/BrAPITrialDAOImpl.java | 88 ++++++++++++++++++- .../brapi/v2/services/BrAPITrialService.java | 10 ++- .../v2/utilities/BrAPISortFilterMapper.java | 28 ++++++ .../brapi/v2/utilities/BrAPITrialsMapper.java | 16 ++++ .../utilities/BrAPIDAOUtil.java | 83 ++++++++++++++++- .../utilities/response/ResponseUtils.java | 15 ++++ .../ExperimentControllerIntegrationTest.java | 7 +- .../brapi/v2/BrAPITestUtils.java | 3 +- ...tionVariableControllerIntegrationTest.java | 3 +- .../SubEntityDatasetLockIntegrationTest.java | 5 +- .../SampleSubmissionFileImportTest.java | 4 +- 14 files changed, 260 insertions(+), 27 deletions(-) create mode 100644 src/main/java/org/breedinginsight/brapi/v2/utilities/BrAPISortFilterMapper.java create mode 100644 src/main/java/org/breedinginsight/brapi/v2/utilities/BrAPITrialsMapper.java diff --git a/src/main/java/org/breedinginsight/api/v1/controller/ExperimentController.java b/src/main/java/org/breedinginsight/api/v1/controller/ExperimentController.java index c846fb17d..41a167ed1 100644 --- a/src/main/java/org/breedinginsight/api/v1/controller/ExperimentController.java +++ b/src/main/java/org/breedinginsight/api/v1/controller/ExperimentController.java @@ -46,7 +46,6 @@ @Secured(SecurityRule.IS_AUTHENTICATED) public class ExperimentController { private final BrAPITrialService experimentService; - private final ExperimentQueryMapper experimentQueryMapper; private final ProgramService programService; private final ExperimentalCollaboratorService experimentalCollaboratorService; private final SecurityService securityService; @@ -54,9 +53,8 @@ public class ExperimentController { private final RoleService roleService; @Inject - public ExperimentController(BrAPITrialService experimentService, ExperimentQueryMapper experimentQueryMapper, ProgramService programService, ExperimentalCollaboratorService experimentalCollaboratorService, SecurityService securityService, ProgramUserService programUserService, RoleService roleService) { + public ExperimentController(BrAPITrialService experimentService, ProgramService programService, ExperimentalCollaboratorService experimentalCollaboratorService, SecurityService securityService, ProgramUserService programUserService, RoleService roleService) { this.experimentService = experimentService; - this.experimentQueryMapper = experimentQueryMapper; this.programService = programService; this.experimentalCollaboratorService = experimentalCollaboratorService; this.securityService = securityService; diff --git a/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java b/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java index 195270184..8cf726e9e 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java +++ b/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java @@ -26,8 +26,8 @@ import io.micronaut.security.rules.SecurityRule; import lombok.extern.slf4j.Slf4j; import org.brapi.client.v2.model.exceptions.ApiException; -import org.brapi.v2.model.BrAPIExternalReference; import org.brapi.v2.model.core.BrAPITrial; +import org.brapi.v2.model.core.response.BrAPITrialListResponse; import org.brapi.v2.model.core.response.BrAPITrialSingleResponse; import org.breedinginsight.api.auth.*; import org.breedinginsight.api.model.v1.request.query.SearchRequest; @@ -43,8 +43,6 @@ import org.breedinginsight.services.ExperimentalCollaboratorService; import org.breedinginsight.services.ProgramService; import org.breedinginsight.services.ProgramUserService; -import org.breedinginsight.model.ProgramUser; -import org.breedinginsight.model.Role; import org.breedinginsight.services.exceptions.DoesNotExistException; import org.breedinginsight.utilities.Utilities; import org.breedinginsight.utilities.response.ResponseUtils; @@ -52,7 +50,6 @@ import javax.inject.Inject; import javax.validation.Valid; -import java.util.ArrayList; import java.util.List; import java.util.Optional; import java.util.UUID; @@ -65,6 +62,7 @@ public class BrAPITrialsController { private final String referenceSource; private final BrAPITrialService experimentService; + // TODO: See if it's feasible to remove this mapper entirely private final ExperimentQueryMapper experimentQueryMapper; private final SecurityService securityService; private final ProgramUserService programUserService; @@ -92,7 +90,7 @@ public BrAPITrialsController(BrAPITrialService experimentService, @Produces(MediaType.APPLICATION_JSON) @ProgramSecured(roles = {ProgramSecuredRole.SYSTEM_ADMIN, ProgramSecuredRole.READ_ONLY, ProgramSecuredRole.PROGRAM_ADMIN ,ProgramSecuredRole.EXPERIMENTAL_COLLABORATOR }) - public HttpResponse>>> getExperiments( + public HttpResponse>> getExperiments( @PathVariable("programId") UUID programId, @QueryValue @QueryValid(using = ExperimentQueryMapper.class) @Valid ExperimentQuery queryParams) { try { @@ -105,13 +103,17 @@ public HttpResponse>>> getExperiments( // If the program user is an experimental collaborator, filter results for only authorized experiments. Optional experimentalCollaborator = programUserService.getIfExperimentalCollaborator(programId, securityService.getUser().getId()); if (experimentalCollaborator.isPresent()) { + // TODO: Modify this code to use brapi side filter, pagination and sort List experimentIds = experimentalCollaboratorService.getAuthorizedExperimentIds(experimentalCollaborator.get().getId()); List authorizedExperiments = experimentService.getTrialsByExperimentIds(program.get(), experimentIds).stream().peek(this::setDbIds).collect(Collectors.toList()); return ResponseUtils.getBrapiQueryResponse(authorizedExperiments, experimentQueryMapper, queryParams, searchRequest); } - List experiments = experimentService.getExperiments(programId).stream().peek(this::setDbIds).collect(Collectors.toList()); - return ResponseUtils.getBrapiQueryResponse(experiments, experimentQueryMapper, queryParams, searchRequest); + BrAPITrialListResponse brapiResponse = experimentService.searchTrials(program.get(), queryParams); + + List foundTrials = brapiResponse.getResult().getData(); + foundTrials.forEach(this::setDbIds); + return ResponseUtils.getBrapiQueryResponse(foundTrials, brapiResponse, queryParams); } catch (ApiException e) { log.info(e.getMessage(), e); return HttpResponse.status(HttpStatus.INTERNAL_SERVER_ERROR, "Error retrieving experiments"); diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPITrialDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPITrialDAO.java index bbc3ceb56..ebe6bf3b9 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPITrialDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPITrialDAO.java @@ -19,6 +19,9 @@ import org.brapi.client.v2.model.exceptions.ApiException; import org.brapi.v2.model.core.BrAPITrial; +import org.brapi.v2.model.core.request.BrAPITrialSearchRequest; +import org.brapi.v2.model.core.response.BrAPITrialListResponse; +import org.breedinginsight.brapi.v2.model.request.query.ExperimentQuery; import org.breedinginsight.brapps.importer.model.ImportUpload; import org.breedinginsight.model.Program; import org.breedinginsight.services.exceptions.DoesNotExistException; @@ -45,4 +48,6 @@ List createBrAPITrials(List brAPITrialList, UUID program List getTrialsByExperimentIds(Collection experimentIds, Program program) throws ApiException; void deleteBrAPITrial(Program program, BrAPITrial trial, boolean hard) throws ApiException; + + BrAPITrialListResponse brapiTrialSearch(Program program, ExperimentQuery experimentQuery) throws ApiException; } diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java index fbbf119b2..db5dc969c 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java @@ -21,15 +21,21 @@ import lombok.extern.slf4j.Slf4j; import okhttp3.HttpUrl; import okhttp3.Request; +import org.apache.commons.lang3.StringUtils; import org.brapi.client.v2.ApiResponse; import org.brapi.client.v2.model.exceptions.ApiException; import org.brapi.client.v2.model.queryParams.core.TrialQueryParams; import org.brapi.client.v2.modules.core.TrialsApi; +import org.brapi.v2.model.BrAPIFilterBy; +import org.brapi.v2.model.BrAPIResponse; +import org.brapi.v2.model.BrAPISortBy; import org.brapi.v2.model.core.BrAPIProgram; import org.brapi.v2.model.core.BrAPITrial; import org.brapi.v2.model.core.request.BrAPITrialSearchRequest; import org.brapi.v2.model.core.response.BrAPITrialListResponse; import org.breedinginsight.brapi.v2.dao.BrAPITrialDAO; +import org.breedinginsight.brapi.v2.model.request.query.ExperimentQuery; +import org.breedinginsight.brapi.v2.utilities.BrAPITrialsMapper; import org.breedinginsight.brapps.importer.daos.ImportDAO; import org.breedinginsight.brapps.importer.model.ImportUpload; import org.breedinginsight.daos.ProgramDAO; @@ -52,16 +58,25 @@ public class BrAPITrialDAOImpl implements BrAPITrialDAO { private final ImportDAO importDAO; private final BrAPIDAOUtil brAPIDAOUtil; private final BrAPIEndpointProvider brAPIEndpointProvider; + private final BrAPITrialsMapper brAPITrialsMapper; + + + private static final String BI_FILTER_COLUMN_NAME = "name"; + private static final String BI_FILTER_COLUMN_ACTIVE = "active"; + private static final String BI_FILTER_COLUMN_CREATED_DATE = "createdDate"; + private static final String BI_FILTER_COLUMN_CREATED_BY = "createdBy"; @Inject public BrAPITrialDAOImpl(ProgramDAO programDAO, ImportDAO importDAO, BrAPIDAOUtil brAPIDAOUtil, - BrAPIEndpointProvider brAPIEndpointProvider) { + BrAPIEndpointProvider brAPIEndpointProvider, + BrAPITrialsMapper brAPITrialsMapper) { this.programDAO = programDAO; this.importDAO = importDAO; this.brAPIDAOUtil = brAPIDAOUtil; this.brAPIEndpointProvider = brAPIEndpointProvider; + this.brAPITrialsMapper = brAPITrialsMapper; } /** @@ -211,6 +226,27 @@ public List getTrialsByExperimentIds(Collection experimentIds, ), program.getKey()); } + @Override + public BrAPITrialListResponse brapiTrialSearch(Program program, + ExperimentQuery experimentQuery) throws ApiException { + TrialsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(program.getId()), TrialsApi.class); + + BrAPITrialSearchRequest brAPITrialSearchRequest = buildSearchRequest(program, experimentQuery); + + BrAPITrialListResponse brAPIResponse = + brAPIDAOUtil.simpleSearch( + api::searchTrialsPost, + brAPITrialSearchRequest + ); + + List processedTrials = + processExperimentsForDisplay(brAPIDAOUtil.getListResult(brAPIResponse), program.getKey()); + + brAPIResponse.getResult().setData(processedTrials); + + return brAPIResponse; + } + @Override public void deleteBrAPITrial(Program program, BrAPITrial trial, boolean hard) throws ApiException { // TODO: Switch to using the TrialsApi from the BrAPI client library once the delete endpoints are merged into it. @@ -225,4 +261,54 @@ public void deleteBrAPITrial(Program program, BrAPITrial trial, boolean hard) th brAPIDAOUtil.makeCall(brapiRequest); } + + + private BrAPITrialSearchRequest buildSearchRequest(Program program, ExperimentQuery experimentQuery) { + BrAPIProgram brAPIProgram = programDAO.getProgramBrAPI(program); + + if (brAPIProgram == null || brAPIProgram.getProgramDbId() == null) { + throw new InternalServerException(String.format("BI program with id [%s] not found in BrAPI db", program.getId())); + } + + BrAPITrialSearchRequest searchRequest = new BrAPITrialSearchRequest(); + + searchRequest.programDbIds(List.of(brAPIProgram.getProgramDbId())); + + // Set FilterBy + List brAPIFilterBy = new ArrayList<>(); + + if (StringUtils.isNotBlank(experimentQuery.getName())) { + brAPIFilterBy.add(brAPIDAOUtil.constructFilterBy(brAPITrialsMapper.getBrAPIName(BI_FILTER_COLUMN_NAME), experimentQuery.getName())); + } + if (StringUtils.isNotBlank(experimentQuery.getActive())) { + brAPIFilterBy.add(brAPIDAOUtil.constructFilterBy(brAPITrialsMapper.getBrAPIName(BI_FILTER_COLUMN_ACTIVE), experimentQuery.getActive())); + } + if (StringUtils.isNotBlank(experimentQuery.getCreatedBy())) { + brAPIFilterBy.add(brAPIDAOUtil.constructFilterBy(brAPITrialsMapper.getBrAPIName(BI_FILTER_COLUMN_CREATED_BY), experimentQuery.getCreatedBy())); + } + if (StringUtils.isNotBlank(experimentQuery.getCreatedDate())) { + brAPIFilterBy.add(brAPIDAOUtil.constructFilterBy(brAPITrialsMapper.getBrAPIName(BI_FILTER_COLUMN_CREATED_DATE), experimentQuery.getCreatedDate())); + } + + if (!brAPIFilterBy.isEmpty()) { + searchRequest.setFilterBy(brAPIFilterBy); + } + + // Set SortBy + List brAPISortBy = new ArrayList<>(); + + if (StringUtils.isNotBlank(experimentQuery.getSortField()) && brAPITrialsMapper.exists(experimentQuery.getSortField())) { + brAPISortBy.add(brAPIDAOUtil.constructSortBy(brAPITrialsMapper.getBrAPIName(experimentQuery.getSortField()), experimentQuery.getSortOrder().toString())); + } + + if (!brAPISortBy.isEmpty()) { + searchRequest.setSortBy(brAPISortBy); + } + + searchRequest.setPage(experimentQuery.getPage()); + searchRequest.setPageSize(experimentQuery.getPageSize()); + + return searchRequest; + + } } diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java index c1c4a44dd..a6c739047 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java @@ -15,6 +15,7 @@ import org.brapi.v2.model.BrAPIExternalReference; import org.brapi.v2.model.core.*; import org.brapi.v2.model.core.response.BrAPIListsSingleResponse; +import org.brapi.v2.model.core.response.BrAPITrialListResponse; import org.brapi.v2.model.germ.BrAPIGermplasm; import org.brapi.v2.model.pheno.*; @@ -22,6 +23,7 @@ import org.breedinginsight.brapi.v2.constants.BrAPIAdditionalInfoFields; import org.breedinginsight.brapi.v2.dao.*; import org.breedinginsight.brapi.v2.model.request.query.ExperimentExportQuery; +import org.breedinginsight.brapi.v2.model.request.query.ExperimentQuery; import org.breedinginsight.brapps.importer.model.exports.FileType; import org.breedinginsight.brapps.importer.model.imports.experimentObservation.ExperimentObservation; import org.breedinginsight.brapps.importer.model.imports.experimentObservation.ExperimentObservation.Columns; @@ -120,8 +122,12 @@ public BrAPITrialService(@Property(name = "brapi.server.reference-source") Strin this.observationLevelService = observationLevelService; } - public List getExperiments(UUID programId) throws ApiException, DoesNotExistException { - // TODO: Edit this to filter/paginate trials + public BrAPITrialListResponse searchTrials(Program program, + ExperimentQuery experimentQuery) throws ApiException, DoesNotExistException { + return trialDAO.brapiTrialSearch(program, experimentQuery); + } + + public List getTrialsByProgramId(UUID programId) throws ApiException { return trialDAO.getTrials(programId); } diff --git a/src/main/java/org/breedinginsight/brapi/v2/utilities/BrAPISortFilterMapper.java b/src/main/java/org/breedinginsight/brapi/v2/utilities/BrAPISortFilterMapper.java new file mode 100644 index 000000000..388a481cd --- /dev/null +++ b/src/main/java/org/breedinginsight/brapi/v2/utilities/BrAPISortFilterMapper.java @@ -0,0 +1,28 @@ +package org.breedinginsight.brapi.v2.utilities; + +import java.util.Map; + +public abstract class BrAPISortFilterMapper { + + private final Map fields; + + protected BrAPISortFilterMapper(Map fields) { + this.fields = Map.copyOf(fields); + } + + public boolean exists(String fieldName) { + return fields.containsKey(fieldName); + } + + public String getBrAPIName(String biFieldName) throws NullPointerException { + String value = fields.get(biFieldName); + + if (value == null) { + throw new IllegalArgumentException( + "No BrAPI mapping exists for field: " + biFieldName + ); + } + + return value; + } +} diff --git a/src/main/java/org/breedinginsight/brapi/v2/utilities/BrAPITrialsMapper.java b/src/main/java/org/breedinginsight/brapi/v2/utilities/BrAPITrialsMapper.java new file mode 100644 index 000000000..0107efe86 --- /dev/null +++ b/src/main/java/org/breedinginsight/brapi/v2/utilities/BrAPITrialsMapper.java @@ -0,0 +1,16 @@ +package org.breedinginsight.brapi.v2.utilities; + +import javax.inject.Singleton; +import java.util.Map; + +@Singleton +public class BrAPITrialsMapper extends BrAPISortFilterMapper { + public BrAPITrialsMapper() { + super(Map.of( + "name", "trialName", + "active", "active", + "createdBy", "createdBy", + "createdDate", "createdDate" + )); + } +} diff --git a/src/main/java/org/breedinginsight/utilities/BrAPIDAOUtil.java b/src/main/java/org/breedinginsight/utilities/BrAPIDAOUtil.java index cab44d951..a9049663a 100644 --- a/src/main/java/org/breedinginsight/utilities/BrAPIDAOUtil.java +++ b/src/main/java/org/breedinginsight/utilities/BrAPIDAOUtil.java @@ -44,10 +44,7 @@ import javax.inject.Singleton; import java.io.IOException; import java.time.Duration; -import java.util.ArrayList; -import java.util.List; -import java.util.Optional; -import java.util.UUID; +import java.util.*; import java.util.concurrent.TimeUnit; import static org.brapi.v2.model.BrAPIWSMIMEDataTypes.APPLICATION_JSON; @@ -78,6 +75,53 @@ public BrAPIDAOUtil(@Property(name = "brapi.search.wait-time") int searchWaitTim this.programService = programService; } + // Performs a POST brapi search on an entity without looping paging logic, utilizing filters and pagination provided in the searchBody. + // Also verifies response paging matches requested paging + public T simpleSearch(Function, Optional>>> searchMethod, + U searchBody) throws ApiException { + List result = new ArrayList<>(); + + + T brapiResponseResult = null; + + try { + // Traverse response with an optional to allow for free null checking with .map() + brapiResponseResult = Optional.ofNullable(searchMethod.apply(searchBody)) + .map(ApiResponse::getBody) + .map(Pair::getLeft) + // Deal with wrapped Optionals + .flatMap(optional -> optional) + .orElseThrow(); + } catch (ApiException e) { + log.warn(Utilities.generateApiExceptionLogMessage(e)); + throw e; + } catch (NoSuchElementException e) { + log.debug("Unable to retrieve BrAPIResponse from POST search request", e); + throw new InternalServerException(e.toString(), e); + } catch (Exception e) { + log.debug("error", e); + throw new InternalServerException(e.toString(), e); + } + + BrAPIPagination responsePagination = Optional.of(brapiResponseResult) + .map(BrAPIResponse::getMetadata) + .map(BrAPIMetadata::getPagination) + .orElse(null); + + if (responsePagination == null) { + throw new InternalServerException("Expected pagination metadata in BrAPI search response not present"); + } + + var requestPageNumber = searchBody.getPage(); + var requestPageSize = searchBody.getPageSize(); + + if (!responsePagination.getCurrentPage().equals(requestPageNumber) || !responsePagination.getPageSize().equals(requestPageSize)) { + throw new InternalServerException("Page number and/or page size do not match between BrAPI search request and response"); + } + + return brapiResponseResult; + } + public List search(Function, Optional>>> searchMethod, Function3, Optional>>> searchGetMethod, U searchBody @@ -302,6 +346,14 @@ private List getListResult(ApiResponse, Optional(); } + public List getListResult(T response) { + return Optional.ofNullable(response) + .map(BrAPIResponse::getResult) + .map(result -> (BrAPIResponseResult) result) + .map(BrAPIResponseResult::getData) + .orElseThrow(); + } + // TODO: write generic put code public List put(List brapiObjects, ImportUpload upload, @@ -455,4 +507,27 @@ public String getProgramBrAPIBaseUrl(UUID programId) { programBrAPIBaseUrl = programBrAPIBaseUrl.endsWith("/") ? programBrAPIBaseUrl.substring(0, programBrAPIBaseUrl.length() - 1) : programBrAPIBaseUrl; return programBrAPIBaseUrl.endsWith(BrapiVersion.BRAPI_V2) ? programBrAPIBaseUrl : programBrAPIBaseUrl + BrapiVersion.BRAPI_V2; } + + public BrAPIFilterBy constructFilterBy(String filterOn, String value) { + var filterBy = new BrAPIFilterBy(); + + filterBy.setFilterOn(filterOn); + filterBy.setValue(value); + return filterBy; + } + + public BrAPISortBy constructSortBy(String sortOn, String sortOrder) { + var sortBy = new BrAPISortBy(); + sortBy.setSortedOn(sortOn); + + BrAPISortOrder sortOrderEnum = BrAPISortOrder.valueOf(sortOrder.toUpperCase()); + + if (sortOrderEnum == null) { + sortOrderEnum = BrAPISortOrder.ASC; + } + + sortBy.setSortOrder(sortOrderEnum); + + return sortBy; + } } diff --git a/src/main/java/org/breedinginsight/utilities/response/ResponseUtils.java b/src/main/java/org/breedinginsight/utilities/response/ResponseUtils.java index cb8791fae..6f6e41614 100644 --- a/src/main/java/org/breedinginsight/utilities/response/ResponseUtils.java +++ b/src/main/java/org/breedinginsight/utilities/response/ResponseUtils.java @@ -24,6 +24,8 @@ import io.micronaut.http.exceptions.HttpStatusException; import io.micronaut.http.server.types.files.StreamedFile; import org.apache.commons.lang3.tuple.Pair; +import org.brapi.client.v2.model.queryParams.core.BrAPIQueryParams; +import org.brapi.v2.model.BrAPIResponse; import org.breedinginsight.api.model.v1.request.query.PaginationParams; import org.breedinginsight.api.model.v1.request.query.QueryParams; import org.breedinginsight.api.model.v1.request.query.SearchRequest; @@ -129,6 +131,19 @@ private static HttpResponse>> processBrapiResponse( return HttpResponse.ok(new Response(metadata, new DataResponse(paginationResult.getLeft()))); } + public static HttpResponse>> getBrapiQueryResponse(List data, + BrAPIResponse brAPIResponse, + BrapiQuery queryParams) { + Pagination pagination = new Pagination(); + pagination.setTotalCount(brAPIResponse.getMetadata().getPagination().getTotalCount()); + pagination.setCurrentPage(queryParams.getPage()); + pagination.setPageSize(queryParams.getPageSize()); + + Metadata metadata = constructMetadata(new Metadata(), pagination); + + return HttpResponse.ok(new Response<>(metadata, new DataResponse<>(data))); + } + private static HttpResponse> processUploadSearchResponse( ProgramUpload upload, SearchRequest searchRequest, QueryParams queryParams, AbstractQueryMapper mapper, Metadata metadata) { diff --git a/src/test/java/org/breedinginsight/api/v1/controller/ExperimentControllerIntegrationTest.java b/src/test/java/org/breedinginsight/api/v1/controller/ExperimentControllerIntegrationTest.java index bf8f6ba52..d95270d27 100644 --- a/src/test/java/org/breedinginsight/api/v1/controller/ExperimentControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/api/v1/controller/ExperimentControllerIntegrationTest.java @@ -24,6 +24,7 @@ import org.breedinginsight.api.model.v1.request.ProgramRequest; import org.breedinginsight.api.model.v1.request.SpeciesRequest; import org.breedinginsight.brapi.v2.dao.BrAPIGermplasmDAO; +import org.breedinginsight.brapi.v2.model.request.query.ExperimentQuery; import org.breedinginsight.brapi.v2.services.BrAPITrialService; import org.breedinginsight.brapps.importer.ImportTestUtils; import org.breedinginsight.brapps.importer.model.exports.FileType; @@ -204,7 +205,7 @@ void setup() throws Exception { mappingId, newExperimentWorkflowId); - BrAPITrial trial = brAPITrialService.getExperiments(program.getId()).get(0); + BrAPITrial trial = brAPITrialService.getTrialsByProgramId(program.getId()).get(0); experimentId = trial.getTrialDbId(); @@ -244,7 +245,7 @@ private String uploadExperimentWithoutObs(Program targetProgram, String title, S mappingId, newExperimentWorkflowId); - BrAPITrial trial = brAPITrialService.getExperiments(targetProgram.getId()) + BrAPITrial trial = brAPITrialService.getTrialsByProgramId(targetProgram.getId()) .stream() .filter(t -> t.getTrialName().equals(title)) .findFirst() @@ -939,7 +940,7 @@ private String uploadExperimentWithObs(Program targetProgram, String title, List mappingId, newExperimentWorkflowId); - BrAPITrial trial = brAPITrialService.getExperiments(targetProgram.getId()) + BrAPITrial trial = brAPITrialService.getTrialsByProgramId(targetProgram.getId()) .stream() .filter(t -> t.getTrialName().equals(title)) .findFirst() diff --git a/src/test/java/org/breedinginsight/brapi/v2/BrAPITestUtils.java b/src/test/java/org/breedinginsight/brapi/v2/BrAPITestUtils.java index 44caec1fa..6af62c7cf 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/BrAPITestUtils.java +++ b/src/test/java/org/breedinginsight/brapi/v2/BrAPITestUtils.java @@ -38,6 +38,7 @@ import org.breedinginsight.api.model.v1.request.SpeciesRequest; import org.breedinginsight.api.v1.controller.TestTokenValidator; import org.breedinginsight.brapi.v2.dao.BrAPIGermplasmDAO; +import org.breedinginsight.brapi.v2.model.request.query.ExperimentQuery; import org.breedinginsight.brapi.v2.services.BrAPITrialService; import org.breedinginsight.brapps.importer.ImportTestUtils; import org.breedinginsight.brapps.importer.model.imports.experimentObservation.ExperimentObservation; @@ -200,7 +201,7 @@ public Tuple2> setupTestProgram(DSLContext brAPIDslContext mappingId, newExperimentWorkflowId); - List trials = brAPITrialService.getExperiments(program.getId()) + List trials = brAPITrialService.getTrialsByProgramId(program.getId()) .stream() // Ensure trial with title xyz is always second .sorted(Comparator.comparing(BrAPITrial::getTrialName)) diff --git a/src/test/java/org/breedinginsight/brapi/v2/BrAPIV2ObservationVariableControllerIntegrationTest.java b/src/test/java/org/breedinginsight/brapi/v2/BrAPIV2ObservationVariableControllerIntegrationTest.java index 17f91ea0c..f8a99ac35 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/BrAPIV2ObservationVariableControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/BrAPIV2ObservationVariableControllerIntegrationTest.java @@ -41,6 +41,7 @@ import org.breedinginsight.api.model.v1.request.SpeciesRequest; import org.breedinginsight.api.v1.controller.TestTokenValidator; import org.breedinginsight.brapi.v2.dao.BrAPIGermplasmDAO; +import org.breedinginsight.brapi.v2.model.request.query.ExperimentQuery; import org.breedinginsight.brapi.v2.services.BrAPITrialService; import org.breedinginsight.brapps.importer.ImportTestUtils; import org.breedinginsight.brapps.importer.model.imports.experimentObservation.ExperimentObservation; @@ -200,7 +201,7 @@ void setup() throws Exception { mappingId, newExperimentWorkflowId); - BrAPITrial trial = brAPITrialService.getExperiments(program.getId()) + BrAPITrial trial = brAPITrialService.getTrialsByProgramId(program.getId()) .stream() .findFirst() .orElseThrow(); diff --git a/src/test/java/org/breedinginsight/brapi/v2/SubEntityDatasetLockIntegrationTest.java b/src/test/java/org/breedinginsight/brapi/v2/SubEntityDatasetLockIntegrationTest.java index 1e1f3c110..c0b3dd029 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/SubEntityDatasetLockIntegrationTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/SubEntityDatasetLockIntegrationTest.java @@ -1,7 +1,6 @@ package org.breedinginsight.brapi.v2; import com.google.gson.*; -import io.micronaut.context.annotation.Property; import io.micronaut.http.HttpRequest; import io.micronaut.http.HttpResponse; import io.micronaut.http.HttpStatus; @@ -12,6 +11,7 @@ import io.reactivex.Flowable; import org.brapi.v2.model.core.BrAPITrial; import org.breedinginsight.BrAPITest; +import org.breedinginsight.brapi.v2.model.request.query.ExperimentQuery; import org.breedinginsight.brapi.v2.services.BrAPITrialService; import org.breedinginsight.model.Program; import org.junit.jupiter.api.*; @@ -22,7 +22,6 @@ import java.util.Objects; import java.util.UUID; import java.util.concurrent.*; -import java.util.stream.Collectors; import static org.junit.jupiter.api.Assertions.*; @@ -51,7 +50,7 @@ public class SubEntityDatasetLockIntegrationTest extends BrAPITest { void setup() throws Exception { var setup = brAPITestUtils.setupTestProgram(super.getBrapiDsl(), gson); program = setup.getV1(); - experimentId = brAPIITrialService.getExperiments(program.getId()).stream() + experimentId = brAPIITrialService.getTrialsByProgramId(program.getId()).stream() .map(BrAPITrial::getTrialDbId) .findFirst() .orElseThrow(); diff --git a/src/test/java/org/breedinginsight/brapps/importer/SampleSubmissionFileImportTest.java b/src/test/java/org/breedinginsight/brapps/importer/SampleSubmissionFileImportTest.java index b59c41900..1705360f3 100644 --- a/src/test/java/org/breedinginsight/brapps/importer/SampleSubmissionFileImportTest.java +++ b/src/test/java/org/breedinginsight/brapps/importer/SampleSubmissionFileImportTest.java @@ -45,8 +45,8 @@ import org.breedinginsight.api.model.v1.request.SpeciesRequest; import org.breedinginsight.brapi.v2.constants.BrAPIAdditionalInfoFields; import org.breedinginsight.brapi.v2.dao.*; +import org.breedinginsight.brapi.v2.model.request.query.ExperimentQuery; import org.breedinginsight.brapi.v2.services.BrAPITrialService; -import org.breedinginsight.brapps.importer.daos.*; import org.breedinginsight.brapps.importer.model.imports.experimentObservation.ExperimentObservation; import org.breedinginsight.brapps.importer.model.imports.sample.SampleSubmissionImport.Columns; import org.breedinginsight.brapps.importer.services.ExternalReferenceSource; @@ -585,7 +585,7 @@ private String createExperiment(Program program) throws IOException, Interrupted try { // Assumes only one trial/experiment exists - BrAPITrial trial = brAPITrialService.getExperiments(program.getId()) + BrAPITrial trial = brAPITrialService.getTrialsByProgramId(program.getId()) .stream() .findFirst() .orElseThrow(); From 174378a8cd1711b2de6cb9b9ee01a52d2ff2e845 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Fri, 29 May 2026 13:01:45 -0400 Subject: [PATCH 017/102] Add pagination logic to use defaults if not provided - This fixed unit test failures --- .../brapi/v2/dao/impl/BrAPITrialDAOImpl.java | 3 +-- .../utilities/BrAPIDAOUtil.java | 20 +++++++++++++++---- 2 files changed, 17 insertions(+), 6 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java index db5dc969c..efc444bb7 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java @@ -305,8 +305,7 @@ private BrAPITrialSearchRequest buildSearchRequest(Program program, ExperimentQu searchRequest.setSortBy(brAPISortBy); } - searchRequest.setPage(experimentQuery.getPage()); - searchRequest.setPageSize(experimentQuery.getPageSize()); + brAPIDAOUtil.setPagination(searchRequest, experimentQuery); return searchRequest; diff --git a/src/main/java/org/breedinginsight/utilities/BrAPIDAOUtil.java b/src/main/java/org/breedinginsight/utilities/BrAPIDAOUtil.java index a9049663a..947625656 100644 --- a/src/main/java/org/breedinginsight/utilities/BrAPIDAOUtil.java +++ b/src/main/java/org/breedinginsight/utilities/BrAPIDAOUtil.java @@ -35,6 +35,7 @@ import org.brapi.v2.model.*; import org.breedinginsight.api.model.v1.response.DataResponse; import org.breedinginsight.brapi.v1.controller.BrapiVersion; +import org.breedinginsight.brapi.v1.model.request.query.BrapiQuery; import org.breedinginsight.brapps.importer.model.ImportUpload; import org.breedinginsight.model.ProgramBrAPIEndpoints; import org.breedinginsight.services.ProgramService; @@ -79,10 +80,7 @@ public BrAPIDAOUtil(@Property(name = "brapi.search.wait-time") int searchWaitTim // Also verifies response paging matches requested paging public T simpleSearch(Function, Optional>>> searchMethod, U searchBody) throws ApiException { - List result = new ArrayList<>(); - - - T brapiResponseResult = null; + T brapiResponseResult; try { // Traverse response with an optional to allow for free null checking with .map() @@ -530,4 +528,18 @@ public BrAPISortBy constructSortBy(String sortOn, String sortOrder) { return sortBy; } + + public void setPagination(T brapiSearchRequest, U biSearchQuery) { + if (biSearchQuery.getPage() == null) { + brapiSearchRequest.setPage(biSearchQuery.getDefaultPage()); + } else { + brapiSearchRequest.setPage(biSearchQuery.getPage()); + } + + if (biSearchQuery.getPageSize() == null) { + brapiSearchRequest.setPageSize(biSearchQuery.getDefaultPageSize()); + } else { + brapiSearchRequest.setPageSize(biSearchQuery.getPageSize()); + } + } } From 73218043fc5e5a84b601d0e3f82f6a98f3f50bf5 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Fri, 29 May 2026 15:35:12 -0400 Subject: [PATCH 018/102] Fix Trial collaborator use case --- .../brapi/v2/BrAPITrialsController.java | 11 ++++++++--- .../brapi/v2/dao/BrAPITrialDAO.java | 3 +++ .../brapi/v2/dao/impl/BrAPITrialDAOImpl.java | 16 +++++++++++++--- .../brapi/v2/services/BrAPITrialService.java | 6 ++++++ 4 files changed, 30 insertions(+), 6 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java b/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java index 8cf726e9e..ff0b3a2c1 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java +++ b/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java @@ -104,9 +104,14 @@ public HttpResponse>> getExperiments( Optional experimentalCollaborator = programUserService.getIfExperimentalCollaborator(programId, securityService.getUser().getId()); if (experimentalCollaborator.isPresent()) { // TODO: Modify this code to use brapi side filter, pagination and sort - List experimentIds = experimentalCollaboratorService.getAuthorizedExperimentIds(experimentalCollaborator.get().getId()); - List authorizedExperiments = experimentService.getTrialsByExperimentIds(program.get(), experimentIds).stream().peek(this::setDbIds).collect(Collectors.toList()); - return ResponseUtils.getBrapiQueryResponse(authorizedExperiments, experimentQueryMapper, queryParams, searchRequest); + List authorizedExperimentIds = experimentalCollaboratorService.getAuthorizedExperimentIds(experimentalCollaborator.get().getId()); + + BrAPITrialListResponse brapiResponse = experimentService.searchTrials(program.get(), authorizedExperimentIds, queryParams); + + List foundTrials = brapiResponse.getResult().getData(); + foundTrials.forEach(this::setDbIds); + + return ResponseUtils.getBrapiQueryResponse(foundTrials, brapiResponse, queryParams); } BrAPITrialListResponse brapiResponse = experimentService.searchTrials(program.get(), queryParams); diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPITrialDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPITrialDAO.java index ebe6bf3b9..1a6a4424b 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPITrialDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPITrialDAO.java @@ -50,4 +50,7 @@ List createBrAPITrials(List brAPITrialList, UUID program void deleteBrAPITrial(Program program, BrAPITrial trial, boolean hard) throws ApiException; BrAPITrialListResponse brapiTrialSearch(Program program, ExperimentQuery experimentQuery) throws ApiException; + + BrAPITrialListResponse brapiTrialSearch(Program program, List brapiTrialIds, ExperimentQuery experimentQuery) throws ApiException; + } diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java index efc444bb7..e93a8e73e 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java @@ -226,12 +226,18 @@ public List getTrialsByExperimentIds(Collection experimentIds, ), program.getKey()); } + @Override + public BrAPITrialListResponse brapiTrialSearch(Program program, ExperimentQuery experimentQuery) throws ApiException { + return brapiTrialSearch(program, Collections.emptyList(), experimentQuery); + } + @Override public BrAPITrialListResponse brapiTrialSearch(Program program, - ExperimentQuery experimentQuery) throws ApiException { + List brapiTrialIds, + ExperimentQuery experimentQuery) throws ApiException { TrialsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(program.getId()), TrialsApi.class); - BrAPITrialSearchRequest brAPITrialSearchRequest = buildSearchRequest(program, experimentQuery); + BrAPITrialSearchRequest brAPITrialSearchRequest = buildSearchRequest(program, brapiTrialIds, experimentQuery); BrAPITrialListResponse brAPIResponse = brAPIDAOUtil.simpleSearch( @@ -263,7 +269,7 @@ public void deleteBrAPITrial(Program program, BrAPITrial trial, boolean hard) th } - private BrAPITrialSearchRequest buildSearchRequest(Program program, ExperimentQuery experimentQuery) { + private BrAPITrialSearchRequest buildSearchRequest(Program program, List brapiTrialIds, ExperimentQuery experimentQuery) { BrAPIProgram brAPIProgram = programDAO.getProgramBrAPI(program); if (brAPIProgram == null || brAPIProgram.getProgramDbId() == null) { @@ -274,6 +280,10 @@ private BrAPITrialSearchRequest buildSearchRequest(Program program, ExperimentQu searchRequest.programDbIds(List.of(brAPIProgram.getProgramDbId())); + if (brapiTrialIds != null && !brapiTrialIds.isEmpty()) { + searchRequest.setTrialDbIds(brapiTrialIds.stream().map(UUID::toString).collect(Collectors.toList())); + } + // Set FilterBy List brAPIFilterBy = new ArrayList<>(); diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java index a6c739047..8d7ca67ef 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java @@ -127,6 +127,12 @@ public BrAPITrialListResponse searchTrials(Program program, return trialDAO.brapiTrialSearch(program, experimentQuery); } + public BrAPITrialListResponse searchTrials(Program program, + List brapiTrialIds, + ExperimentQuery experimentQuery) throws ApiException, DoesNotExistException { + return trialDAO.brapiTrialSearch(program, brapiTrialIds, experimentQuery); + } + public List getTrialsByProgramId(UUID programId) throws ApiException { return trialDAO.getTrials(programId); } From 4b9d345260c504d67645c2a026ba236a44b1284a Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Mon, 1 Jun 2026 17:40:29 -0400 Subject: [PATCH 019/102] Remove comment --- .../org/breedinginsight/brapi/v2/BrAPITrialsController.java | 5 ----- 1 file changed, 5 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java b/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java index ff0b3a2c1..351f66efc 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java +++ b/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java @@ -62,8 +62,6 @@ public class BrAPITrialsController { private final String referenceSource; private final BrAPITrialService experimentService; - // TODO: See if it's feasible to remove this mapper entirely - private final ExperimentQueryMapper experimentQueryMapper; private final SecurityService securityService; private final ProgramUserService programUserService; private final ExperimentalCollaboratorService experimentalCollaboratorService; @@ -71,14 +69,12 @@ public class BrAPITrialsController { @Inject public BrAPITrialsController(BrAPITrialService experimentService, - ExperimentQueryMapper experimentQueryMapper, @Property(name = "brapi.server.reference-source") String referenceSource, SecurityService securityService, ProgramUserService programUserService, ExperimentalCollaboratorService experimentalCollaboratorService, ProgramService programService) { this.experimentService = experimentService; - this.experimentQueryMapper = experimentQueryMapper; this.referenceSource = referenceSource; this.securityService = securityService; this.programUserService = programUserService; @@ -103,7 +99,6 @@ public HttpResponse>> getExperiments( // If the program user is an experimental collaborator, filter results for only authorized experiments. Optional experimentalCollaborator = programUserService.getIfExperimentalCollaborator(programId, securityService.getUser().getId()); if (experimentalCollaborator.isPresent()) { - // TODO: Modify this code to use brapi side filter, pagination and sort List authorizedExperimentIds = experimentalCollaboratorService.getAuthorizedExperimentIds(experimentalCollaborator.get().getId()); BrAPITrialListResponse brapiResponse = experimentService.searchTrials(program.get(), authorizedExperimentIds, queryParams); From edd03fd1a427f21536331bce6f6ea4b12df2d2b8 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Wed, 10 Jun 2026 12:04:41 -0400 Subject: [PATCH 020/102] Update TODO comments with created tickets/epics --- .../java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java | 2 +- .../breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java | 4 ++-- .../brapps/importer/model/response/PendingImportObject.java | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java index 08298a130..ccbe0abfd 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java @@ -137,7 +137,7 @@ public List getStudiesByName(List studyNames, Program progra } public List getStudiesByBrAPITrialExRefId(@NotNull UUID brapiTrialExRefId, Program program) throws ApiException { - // TODO: If external references are removed for trial for studies, this method should look up on trialDbId, and the trialDbId should be passed through. + // TODO: If external references are removed for trial for studies, this method should look up on trialDbId, and the trialDbId should be passed through. [BI-2933] BrAPIStudySearchRequest studySearch = new BrAPIStudySearchRequest(); studySearch.programDbIds(List.of(program.getBrapiProgram().getProgramDbId())); studySearch.addExternalReferenceIdsItem(brapiTrialExRefId.toString()); diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java index e93a8e73e..b5465830d 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java @@ -83,6 +83,7 @@ public BrAPITrialDAOImpl(ProgramDAO programDAO, * This method requires a BI-API program. If the BrAPIProgram inside this data model is not set, * this method will retrieve it. */ + // TODO: Generalize Code for General Get By Program for BrAPI Entities [BI-2932] private List getBrAPITrialsUsingBrAPIProgramId(Program program) throws ApiException { if (program == null || program.getId() == null) { @@ -98,7 +99,7 @@ private List getBrAPITrialsUsingBrAPIProgramId(Program program) thro brapiProgramDbId = programDAO.getProgramBrAPI(program).getProgramDbId(); } - // TODO: Configurable max amount of trials per program, or paginate. + // TODO: Configurable max amount of trials per program, or paginate [BI-2932] TrialQueryParams trialQueryParams = TrialQueryParams.builder() @@ -255,7 +256,6 @@ public BrAPITrialListResponse brapiTrialSearch(Program program, @Override public void deleteBrAPITrial(Program program, BrAPITrial trial, boolean hard) throws ApiException { - // TODO: Switch to using the TrialsApi from the BrAPI client library once the delete endpoints are merged into it. var programBrAPIBaseUrl = brAPIDAOUtil.getProgramBrAPIBaseUrl(program.getId()); var requestUrl = HttpUrl.parse(programBrAPIBaseUrl + "/trials/" + trial.getTrialDbId()).newBuilder(); requestUrl.addQueryParameter("hardDelete", Boolean.toString(hard)); diff --git a/src/main/java/org/breedinginsight/brapps/importer/model/response/PendingImportObject.java b/src/main/java/org/breedinginsight/brapps/importer/model/response/PendingImportObject.java index 1cc24b9a3..934d1a565 100644 --- a/src/main/java/org/breedinginsight/brapps/importer/model/response/PendingImportObject.java +++ b/src/main/java/org/breedinginsight/brapps/importer/model/response/PendingImportObject.java @@ -33,7 +33,7 @@ public class PendingImportObject { public PendingImportObject(ImportObjectState state, T brAPIObject, UUID id) { this.state = state; this.brAPIObject = brAPIObject; - // TODO: With 1.5 work, this id is the BI-API generated ID that is set for external references in BrAPI. It is different than the BrAPI DB ID of an entity. We may want to consider changing this at some point + // TODO: With 1.5 work, this id is the BI-API generated ID that is set for external references in BrAPI. It is different than the BrAPI DB ID of an entity. We may want to consider changing this at some point [BI-2933] this.id = id; } public PendingImportObject(ImportObjectState state, T brAPIObject) { From 5be89c65a58b97b3a7c7a6c079fcb12c2684ecd9 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Wed, 10 Jun 2026 12:20:19 -0400 Subject: [PATCH 021/102] Addtional comment edits to include created tasks/epics --- .../org/breedinginsight/brapi/v2/BrAPIStudiesController.java | 2 +- .../org/breedinginsight/brapi/v2/BrAPITrialsController.java | 2 +- .../breedinginsight/brapi/v2/services/BrAPITrialService.java | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/BrAPIStudiesController.java b/src/main/java/org/breedinginsight/brapi/v2/BrAPIStudiesController.java index f9536ebdd..52027436d 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/BrAPIStudiesController.java +++ b/src/main/java/org/breedinginsight/brapi/v2/BrAPIStudiesController.java @@ -114,7 +114,7 @@ public HttpResponse>>> getStudies( return ResponseUtils.getBrapiQueryResponse(authorizedStudies, studyQueryMapper, queryParams, searchRequest); } - // TODO: Instead of getting all studies for a program and filtering, doing the filtering on brapi side + // TODO: Instead of getting all studies for a program and filtering, doing the filtering on brapi side [BI-2922] List studies = studyService.getStudies(programId) .stream() .peek(this::setDbIds) diff --git a/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java b/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java index 351f66efc..6a2cd579f 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java +++ b/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java @@ -161,7 +161,7 @@ public HttpResponse trialsTrialDbIdPut(@PathVariable("programId") UUID progra return HttpResponse.notFound(); } - // TODO: Remove for trialDbId once cache is removed for that entity + // TODO: Verify that the programDbId does not need to be reset and that the BrAPI programDbId can be used instead [BI-2931] private void setDbIds(BrAPITrial trial) { trial.programDbId(Utilities.getExternalReference(trial.getExternalReferences(), Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.PROGRAMS)) .orElseThrow(() -> new IllegalStateException("No BI external reference found")) diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java index 8d7ca67ef..8e0b4bae6 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java @@ -823,7 +823,7 @@ public int deleteExperiment(Program program, UUID experimentId, boolean hard) th // Make request to delete experiment. trialDAO.deleteBrAPITrial(program, trial, hard); // Get all lists for the trial. - // TODO: Get lists by trialDbId if trials get decoupled from datasets. + // TODO: Get lists by trialDbId if trials get decoupled from datasets. [BI-2993] List lists = listDAO .getListsByTypeAndExternalRef(BrAPIListTypes.OBSERVATIONVARIABLES, program.getId(), From 0f8a05db9f3eb42e745cc13251973a2dac856d90 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Mon, 15 Jun 2026 19:08:46 -0400 Subject: [PATCH 022/102] Generalize sorting and filtering code for reusability for future cache removal --- .../v1/model/request/query/BrapiQuery.java | 23 ++++++++++ .../brapi/v2/BrAPITrialsController.java | 1 - .../brapi/v2/dao/impl/BrAPITrialDAOImpl.java | 35 +-------------- .../model/request/query/ExperimentQuery.java | 44 ++++++++++--------- .../utilities/BrAPIDAOUtil.java | 42 ++++++++++++++++-- 5 files changed, 86 insertions(+), 59 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v1/model/request/query/BrapiQuery.java b/src/main/java/org/breedinginsight/brapi/v1/model/request/query/BrapiQuery.java index f51bcf317..f87468ef3 100644 --- a/src/main/java/org/breedinginsight/brapi/v1/model/request/query/BrapiQuery.java +++ b/src/main/java/org/breedinginsight/brapi/v1/model/request/query/BrapiQuery.java @@ -26,6 +26,7 @@ import javax.validation.constraints.Positive; import javax.validation.constraints.PositiveOrZero; +import java.util.Map; @Getter @Setter @@ -58,4 +59,26 @@ protected FilterRequest constructFilterRequest(String field, String value) { .value(value) .build(); } + + /** + * For BrapiQuery objects that have implemented this method, this map is used by the BrAPIDAOUtil + * to iterate through all valid filter columns and their associated values that are submitted from the fe. + * + * See @ExperimentQuery for example implementation + */ + public Map getFilterValuesByBrAPIColumnName() { + throw new UnsupportedOperationException( + String.format("Server side BrAPI filtering not implemented for class [%s]", this.getClass().getSimpleName()) + ); + } + + /** + * For BrapiQuery objects that have implemented this method, this map is used by the BrAPIDAOUtil + * to match submitted sortField column names to the associated brapi column name for sorting. + * + * See @ExperimentQuery for example implementation + */ + public Map getBrAPIColumnNamesByBiColumnName() { + throw new UnsupportedOperationException(String.format("Server side BrAPI sorting not implemented for class [%s]", this.getClass().getSimpleName())); + } } diff --git a/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java b/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java index 6a2cd579f..be42a5782 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java +++ b/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java @@ -93,7 +93,6 @@ public HttpResponse>> getExperiments( Optional program = programService.getById(programId); if (program.isEmpty()) { return HttpResponse.notFound(); } - SearchRequest searchRequest = queryParams.constructSearchRequest(); log.debug("fetching trials for program: " + programId); // If the program user is an experimental collaborator, filter results for only authorized experiments. diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java index b5465830d..f38f03073 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java @@ -27,7 +27,6 @@ import org.brapi.client.v2.model.queryParams.core.TrialQueryParams; import org.brapi.client.v2.modules.core.TrialsApi; import org.brapi.v2.model.BrAPIFilterBy; -import org.brapi.v2.model.BrAPIResponse; import org.brapi.v2.model.BrAPISortBy; import org.brapi.v2.model.core.BrAPIProgram; import org.brapi.v2.model.core.BrAPITrial; @@ -284,40 +283,8 @@ private BrAPITrialSearchRequest buildSearchRequest(Program program, List b searchRequest.setTrialDbIds(brapiTrialIds.stream().map(UUID::toString).collect(Collectors.toList())); } - // Set FilterBy - List brAPIFilterBy = new ArrayList<>(); - - if (StringUtils.isNotBlank(experimentQuery.getName())) { - brAPIFilterBy.add(brAPIDAOUtil.constructFilterBy(brAPITrialsMapper.getBrAPIName(BI_FILTER_COLUMN_NAME), experimentQuery.getName())); - } - if (StringUtils.isNotBlank(experimentQuery.getActive())) { - brAPIFilterBy.add(brAPIDAOUtil.constructFilterBy(brAPITrialsMapper.getBrAPIName(BI_FILTER_COLUMN_ACTIVE), experimentQuery.getActive())); - } - if (StringUtils.isNotBlank(experimentQuery.getCreatedBy())) { - brAPIFilterBy.add(brAPIDAOUtil.constructFilterBy(brAPITrialsMapper.getBrAPIName(BI_FILTER_COLUMN_CREATED_BY), experimentQuery.getCreatedBy())); - } - if (StringUtils.isNotBlank(experimentQuery.getCreatedDate())) { - brAPIFilterBy.add(brAPIDAOUtil.constructFilterBy(brAPITrialsMapper.getBrAPIName(BI_FILTER_COLUMN_CREATED_DATE), experimentQuery.getCreatedDate())); - } - - if (!brAPIFilterBy.isEmpty()) { - searchRequest.setFilterBy(brAPIFilterBy); - } - - // Set SortBy - List brAPISortBy = new ArrayList<>(); - - if (StringUtils.isNotBlank(experimentQuery.getSortField()) && brAPITrialsMapper.exists(experimentQuery.getSortField())) { - brAPISortBy.add(brAPIDAOUtil.constructSortBy(brAPITrialsMapper.getBrAPIName(experimentQuery.getSortField()), experimentQuery.getSortOrder().toString())); - } - - if (!brAPISortBy.isEmpty()) { - searchRequest.setSortBy(brAPISortBy); - } - - brAPIDAOUtil.setPagination(searchRequest, experimentQuery); + brAPIDAOUtil.setGenericSearchParameters(searchRequest, experimentQuery); return searchRequest; - } } diff --git a/src/main/java/org/breedinginsight/brapi/v2/model/request/query/ExperimentQuery.java b/src/main/java/org/breedinginsight/brapi/v2/model/request/query/ExperimentQuery.java index b4c08c31f..02f025968 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/model/request/query/ExperimentQuery.java +++ b/src/main/java/org/breedinginsight/brapi/v2/model/request/query/ExperimentQuery.java @@ -2,13 +2,10 @@ import io.micronaut.core.annotation.Introspected; import lombok.Getter; -import org.breedinginsight.api.model.v1.request.query.FilterRequest; -import org.breedinginsight.api.model.v1.request.query.SearchRequest; import org.breedinginsight.brapi.v1.model.request.query.BrapiQuery; -import org.jooq.tools.StringUtils; -import java.util.ArrayList; -import java.util.List; +import java.util.HashMap; +import java.util.Map; @Getter @Introspected @@ -18,20 +15,27 @@ public class ExperimentQuery extends BrapiQuery { private String createdBy; private String createdDate; - public SearchRequest constructSearchRequest() { - List filters = new ArrayList<>(); - if (!StringUtils.isBlank(getName())) { - filters.add(constructFilterRequest("name", getName())); - } - if (!StringUtils.isBlank(getActive())) { - filters.add(constructFilterRequest("active", getActive())); - } - if (!StringUtils.isBlank(getCreatedBy())) { - filters.add(constructFilterRequest("createdBy", getCreatedBy())); - } - if (!StringUtils.isBlank(getCreatedDate())) { - filters.add(constructFilterRequest("createdDate", getCreatedDate())); - } - return new SearchRequest(filters); + @Override + public Map getFilterValuesByBrAPIColumnName() { + Map filterValuesByBrAPIColumnName = new HashMap<>(); + + filterValuesByBrAPIColumnName.put("trialName", getName()); + filterValuesByBrAPIColumnName.put("active", getActive()); + filterValuesByBrAPIColumnName.put("createdBy", getCreatedBy()); + filterValuesByBrAPIColumnName.put("createdDate", getCreatedDate()); + + return filterValuesByBrAPIColumnName; + } + + @Override + public Map getBrAPIColumnNamesByBiColumnName() { + Map brAPIColumnNamesByBiColumnName = new HashMap<>(); + + brAPIColumnNamesByBiColumnName.put("name", "trialName"); + brAPIColumnNamesByBiColumnName.put("active", "active"); + brAPIColumnNamesByBiColumnName.put("createdBy", "createdBy"); + brAPIColumnNamesByBiColumnName.put("createdDate", "createdDate"); + + return brAPIColumnNamesByBiColumnName; } } diff --git a/src/main/java/org/breedinginsight/utilities/BrAPIDAOUtil.java b/src/main/java/org/breedinginsight/utilities/BrAPIDAOUtil.java index 947625656..7290621a2 100644 --- a/src/main/java/org/breedinginsight/utilities/BrAPIDAOUtil.java +++ b/src/main/java/org/breedinginsight/utilities/BrAPIDAOUtil.java @@ -33,7 +33,6 @@ import org.brapi.client.v2.ApiResponse; import org.brapi.client.v2.model.exceptions.ApiException; import org.brapi.v2.model.*; -import org.breedinginsight.api.model.v1.response.DataResponse; import org.breedinginsight.brapi.v1.controller.BrapiVersion; import org.breedinginsight.brapi.v1.model.request.query.BrapiQuery; import org.breedinginsight.brapps.importer.model.ImportUpload; @@ -506,7 +505,7 @@ public String getProgramBrAPIBaseUrl(UUID programId) { return programBrAPIBaseUrl.endsWith(BrapiVersion.BRAPI_V2) ? programBrAPIBaseUrl : programBrAPIBaseUrl + BrapiVersion.BRAPI_V2; } - public BrAPIFilterBy constructFilterBy(String filterOn, String value) { + private BrAPIFilterBy constructFilterBy(String filterOn, String value) { var filterBy = new BrAPIFilterBy(); filterBy.setFilterOn(filterOn); @@ -514,7 +513,7 @@ public BrAPIFilterBy constructFilterBy(String filterOn, String value) { return filterBy; } - public BrAPISortBy constructSortBy(String sortOn, String sortOrder) { + private BrAPISortBy constructSortBy(String sortOn, String sortOrder) { var sortBy = new BrAPISortBy(); sortBy.setSortedOn(sortOn); @@ -529,7 +528,42 @@ public BrAPISortBy constructSortBy(String sortOn, String sortOrder) { return sortBy; } - public void setPagination(T brapiSearchRequest, U biSearchQuery) { + /** + * Sets three generic search parameters for an outgoing BrAPI Search Query: + * - Sorting + * - Filtering + * - Pagination + */ + public void setGenericSearchParameters(T brapiSearchRequest, U biSearchQuery) { + // Set SortBy + List brAPISortBy = new ArrayList<>(); + + Map brapiColNameByBiColName = biSearchQuery.getBrAPIColumnNamesByBiColumnName(); + + if (StringUtils.isNotBlank(biSearchQuery.getSortField()) && brapiColNameByBiColName.containsKey(biSearchQuery.getSortField())) { + brAPISortBy.add(constructSortBy(brapiColNameByBiColName.get(biSearchQuery.getSortField()), biSearchQuery.getSortOrder().toString())); + } + + if (!brAPISortBy.isEmpty()) { + brapiSearchRequest.setSortBy(brAPISortBy); + } + + // Set FilterBy + List brAPIFilterBy = new ArrayList<>(); + + Map filterValuesByBrAPIColName = biSearchQuery.getFilterValuesByBrAPIColumnName(); + + filterValuesByBrAPIColName.forEach((brapiColumnName, value) -> { + if (StringUtils.isNotBlank(value)) { + brAPIFilterBy.add(constructFilterBy(brapiColumnName, value)); + } + }); + + if (!brAPIFilterBy.isEmpty()) { + brapiSearchRequest.setFilterBy(brAPIFilterBy); + } + + // Set Pagination if (biSearchQuery.getPage() == null) { brapiSearchRequest.setPage(biSearchQuery.getDefaultPage()); } else { From 8067d5c1105c27e8edad56effdf2018ddcb0cc6a Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Tue, 16 Jun 2026 20:08:26 -0400 Subject: [PATCH 023/102] Create generalized brapi get method --- .../brapi/v2/dao/impl/BrAPITrialDAOImpl.java | 38 ++++++-------- .../utilities/BrAPIDAOUtil.java | 50 +++++++++++++++++++ 2 files changed, 64 insertions(+), 24 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java index f38f03073..a34857f56 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java @@ -103,32 +103,13 @@ private List getBrAPITrialsUsingBrAPIProgramId(Program program) thro TrialQueryParams trialQueryParams = TrialQueryParams.builder() .programDbId(brapiProgramDbId) - .pageSize(1000) - .page(0) .build(); - return getTrialsFromBrAPI(program, trialQueryParams); - } - - private List getTrialsFromBrAPI(Program program, TrialQueryParams trialQueryParams) throws ApiException { TrialsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(program.getId()), TrialsApi.class); - ApiResponse response; - - try { - response = api.trialsGet(trialQueryParams); - } catch (ApiException e) { - log.warn(Utilities.generateApiExceptionLogMessage(e)); - throw new InternalServerException("Error making BrAPI call", e); - } - - if (response.getBody().getMetadata().getPagination().getTotalCount() > trialQueryParams.pageSize()) { - throw new InternalServerException(String.format("More trials exist than requested [%s]", trialQueryParams)); - } + List result = brAPIDAOUtil.get(api::trialsGet, trialQueryParams); - List trialsFromResponse = response.getBody().getResult().getData(); - - return processExperimentsForDisplay(trialsFromResponse, program.getKey()); + return processExperimentsForDisplay(result, program.getKey()); } @Override @@ -192,12 +173,21 @@ public Optional getTrialById(UUID programId, UUID trialId) throws Ap TrialQueryParams params = TrialQueryParams.builder() .trialDbId(trialId.toString()) - .pageSize(1) - .page(0) .build(); + TrialsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(programId), TrialsApi.class); + + List result = brAPIDAOUtil.get(api::trialsGet, params); + + if (result.isEmpty()) { + throw new DoesNotExistException(String.format("Trial with ID [%s] does not exist", trialId)); + } else if (result.size() > 1) { + throw new InternalServerException(String.format("Trial with ID [%s] found multiple times in database. This should not be possible.", trialId)); + } + + processExperimentsForDisplay(result, program.getKey()); - return getTrialsFromBrAPI(program, params).stream().findFirst(); + return result.stream().findFirst(); } @Override diff --git a/src/main/java/org/breedinginsight/utilities/BrAPIDAOUtil.java b/src/main/java/org/breedinginsight/utilities/BrAPIDAOUtil.java index 7290621a2..f7c6e422d 100644 --- a/src/main/java/org/breedinginsight/utilities/BrAPIDAOUtil.java +++ b/src/main/java/org/breedinginsight/utilities/BrAPIDAOUtil.java @@ -32,6 +32,7 @@ import org.apache.commons.lang3.tuple.Pair; import org.brapi.client.v2.ApiResponse; import org.brapi.client.v2.model.exceptions.ApiException; +import org.brapi.client.v2.model.queryParams.core.BrAPIQueryParams; import org.brapi.v2.model.*; import org.breedinginsight.brapi.v1.controller.BrapiVersion; import org.breedinginsight.brapi.v1.model.request.query.BrapiQuery; @@ -75,6 +76,55 @@ public BrAPIDAOUtil(@Property(name = "brapi.search.wait-time") int searchWaitTim this.programService = programService; } + public List get(Function> getMethod, + U queryParams) throws ApiException { + T brapiResponseResult; + + boolean paginationSet = queryParams.page() != null && queryParams.pageSize() != null; + + if (!paginationSet) { + queryParams.setPage(0); + queryParams.setPageSize(pageSize); + } + + try { + brapiResponseResult = Optional.ofNullable(getMethod.apply(queryParams)) + .map(ApiResponse::getBody) + .orElseThrow(); + } catch (ApiException e) { + log.warn(Utilities.generateApiExceptionLogMessage(e)); + throw e; + } catch (NoSuchElementException e) { + log.debug("Unable to retrieve BrAPIResponse from POST search request", e); + throw new InternalServerException(e.toString(), e); + } catch (Exception e) { + log.debug("error", e); + throw new InternalServerException(e.toString(), e); + } + + BrAPIPagination responsePagination = Optional.of(brapiResponseResult) + .map(BrAPIResponse::getMetadata) + .map(BrAPIMetadata::getPagination) + .orElse(null); + + if (responsePagination == null) { + throw new InternalServerException("Expected pagination metadata in BrAPI get response not present"); + } + + if (!paginationSet && responsePagination.getTotalPages() > 1) { + // Size of BrAPI entity GET data can not exceed configured pageSize. + // If it does, it is recommended the GET method not be used for this purpose. + // If you are trying to utilize this method to get a large amount of data for an entity, you can use + // searchInternal for now. In the future, we need a more robust way of transmitting this data using + // compression client techniques to reduce strain on the server and avoid keeping all the database data + // in java memory. + throw new InternalServerException(String.format("More than one page found, meaning there is more data to be returned " + + "with pageSize = [%s]", queryParams.pageSize())); + } + + return getListResult(brapiResponseResult); + } + // Performs a POST brapi search on an entity without looping paging logic, utilizing filters and pagination provided in the searchBody. // Also verifies response paging matches requested paging public T simpleSearch(Function, Optional>>> searchMethod, From a470ef99273e04a749a6fb50c5fe6017c0f4a280 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Wed, 17 Jun 2026 12:19:05 -0400 Subject: [PATCH 024/102] Update comments --- .../brapi/v2/dao/impl/BrAPITrialDAOImpl.java | 3 --- .../java/org/breedinginsight/utilities/BrAPIDAOUtil.java | 8 -------- 2 files changed, 11 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java index a34857f56..96d7e9ff7 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/impl/BrAPITrialDAOImpl.java @@ -82,7 +82,6 @@ public BrAPITrialDAOImpl(ProgramDAO programDAO, * This method requires a BI-API program. If the BrAPIProgram inside this data model is not set, * this method will retrieve it. */ - // TODO: Generalize Code for General Get By Program for BrAPI Entities [BI-2932] private List getBrAPITrialsUsingBrAPIProgramId(Program program) throws ApiException { if (program == null || program.getId() == null) { @@ -98,8 +97,6 @@ private List getBrAPITrialsUsingBrAPIProgramId(Program program) thro brapiProgramDbId = programDAO.getProgramBrAPI(program).getProgramDbId(); } - // TODO: Configurable max amount of trials per program, or paginate [BI-2932] - TrialQueryParams trialQueryParams = TrialQueryParams.builder() .programDbId(brapiProgramDbId) diff --git a/src/main/java/org/breedinginsight/utilities/BrAPIDAOUtil.java b/src/main/java/org/breedinginsight/utilities/BrAPIDAOUtil.java index f7c6e422d..0917998fb 100644 --- a/src/main/java/org/breedinginsight/utilities/BrAPIDAOUtil.java +++ b/src/main/java/org/breedinginsight/utilities/BrAPIDAOUtil.java @@ -401,14 +401,6 @@ public List getListResult(T response) { .orElseThrow(); } - // TODO: write generic put code - public List put(List brapiObjects, - ImportUpload upload, - Function, ApiResponse> putMethod, - Consumer progressUpdateMethod) throws ApiException { - throw new UnsupportedOperationException(); - } - public List post(List brapiObjects, ImportUpload upload, Function, ApiResponse> postMethod, From 1f56711fd281fcc1f7957adcfc500ab4c69fd8a4 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Thu, 2 Jul 2026 15:26:54 -0400 Subject: [PATCH 025/102] Fix issues where bi-generated exref id used instead of trialDbId in brapi endpoints --- .../brapi/v2/dao/BrAPIObservationUnitDAO.java | 9 ++------- .../services/BrAPIObservationVariableService.java | 5 ++--- ...APIObservationUnitControllerIntegrationTest.java | 13 +++++++------ 3 files changed, 11 insertions(+), 16 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java index 76acb8076..370d398d5 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java @@ -288,7 +288,7 @@ public List getObservationUnits(Program program, BrAPIObservationUnitSearchRequest observationUnitSearchRequest = new BrAPIObservationUnitSearchRequest(); observationUnitSearchRequest.programDbIds(List.of(program.getBrapiProgram() .getProgramDbId())); - //TODO add pagination support + //TODO add pagination support: This should be easy to implement with BrAPIDAOUtil.simpleSearch() // .page(page) // .pageSize(pageSize); @@ -303,16 +303,15 @@ public List getObservationUnits(Program program, observationUnitName.ifPresent(name -> observationUnitSearchRequest.setObservationUnitNames(List.of(Utilities.appendProgramKey(name, program.getKey())))); locationDbId.ifPresent(dbid -> observationUnitSearchRequest.setLocationDbIds(List.of(dbid))); seasonDbId.ifPresent(dbid -> observationUnitSearchRequest.setSeasonDbIds(List.of(dbid))); + experimentId.ifPresent(dbId -> observationUnitSearchRequest.setTrialDbIds(List.of(dbId))); includeObservations.ifPresent(observationUnitSearchRequest::includeObservations); addLevelFilter(observationUnitLevelName, observationUnitLevelOrder, observationUnitLevelCode, level, levelFilter); addLevelFilter(observationUnitLevelRelationshipName, observationUnitLevelRelationshipOrder, observationUnitLevelRelationshipCode, relationship, relationshipFilter); - experimentId.ifPresent(expId -> addXRefFilter(expId, ExternalReferenceSource.TRIALS, xrefIds, xrefSources)); environmentId.ifPresent(envId -> addXRefFilter(envId, ExternalReferenceSource.STUDIES, xrefIds, xrefSources)); // germplasmId.ifPresent(germId -> { // xrefIds.add(germId); // xrefSources.add(Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.)); // }); - if(!xrefIds.isEmpty()) { observationUnitSearchRequest.externalReferenceIDs(xrefIds); } @@ -326,10 +325,6 @@ public List getObservationUnits(Program program, .get() .getReferenceId())) .orElse(true); - matches = matches && experimentId.map(id -> id.equals(Utilities.getExternalReference(ou.getExternalReferences(), Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.TRIALS)) - .get() - .getReferenceId())) - .orElse(true); matches = matches && environmentId.map(id -> id.equals(Utilities.getExternalReference(ou.getExternalReferences(), Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.STUDIES)) .get() .getReferenceId())) diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java index 96a21cd14..1359a760d 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java @@ -74,10 +74,9 @@ public List getBrAPIObservationVariablesForExperiment( expId = UUID.fromString(experimentId.get()); } else { UUID envId = UUID.fromString(environmentId.orElseThrow(() -> new IllegalStateException("no environment id found"))); + // TODO: Double check this (and other studyDbId bi-brapi) lookup still works with cache removal on studies [BI-2962] BrAPIStudy environment = trialService.getEnvironment(program.get(), envId); - expId = UUID.fromString(Utilities.getExternalReference(environment.getExternalReferences(), - Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.TRIALS)) - .orElseThrow(() -> new IllegalStateException("no external reference found")).getReferenceId()); + expId = UUID.fromString(environment.getTrialDbId()); } BrAPITrial experiment = trialService.getExperiment(program.get(), expId); diff --git a/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitControllerIntegrationTest.java b/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitControllerIntegrationTest.java index 44792ea64..de876c626 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitControllerIntegrationTest.java @@ -31,6 +31,7 @@ import io.reactivex.Flowable; import lombok.SneakyThrows; import org.brapi.v2.model.BrAPIExternalReference; +import org.brapi.v2.model.core.BrAPITrial; import org.brapi.v2.model.germ.BrAPIGermplasm; import org.brapi.v2.model.pheno.BrAPIObservationUnit; import org.brapi.v2.model.pheno.response.BrAPIObservationUnitSingleResponse; @@ -41,8 +42,10 @@ import org.breedinginsight.api.model.v1.request.SpeciesRequest; import org.breedinginsight.api.v1.controller.TestTokenValidator; import org.breedinginsight.brapi.v2.dao.BrAPIGermplasmDAO; +import org.breedinginsight.brapi.v2.dao.BrAPITrialDAO; import org.breedinginsight.brapps.importer.ImportTestUtils; import org.breedinginsight.brapps.importer.model.imports.experimentObservation.ExperimentObservation; +import org.breedinginsight.brapps.importer.services.processors.experiment.service.TrialService; import org.breedinginsight.dao.db.enums.DataType; import org.breedinginsight.dao.db.tables.pojos.SpeciesEntity; import org.breedinginsight.daos.SpeciesDAO; @@ -91,6 +94,8 @@ public class BrAPIObservationUnitControllerIntegrationTest extends BrAPITest { private OntologyService ontologyService; @Inject private BrAPIGermplasmDAO germplasmDAO; + @Inject + private BrAPITrialDAO brapiTrialDAO; @Inject @Client("/${micronaut.bi.api.version}") @@ -195,12 +200,8 @@ void setup() throws Exception { program, mappingId, newExperimentWorkflowId); - experimentId = importResult - .get("preview").getAsJsonObject() - .get("rows").getAsJsonArray() - .get(0).getAsJsonObject() - .get("trial").getAsJsonObject() - .get("id").getAsString(); + List trials = brapiTrialDAO.getTrials(program.getId()); + experimentId = trials.get(0).getTrialDbId(); // Add environmentIds. envIds.add(getEnvId(importResult, 0)); envIds.add(getEnvId(importResult, 1)); From 289635683b192004c1fcba62a538e54912671f0e Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Mon, 6 Jul 2026 14:32:50 -0400 Subject: [PATCH 026/102] Add TODOs for cache.get() path involving trial deletion --- .../org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java index 10048564c..acd518a7d 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java @@ -212,9 +212,11 @@ public List getObservationsByTrialDbId(List trialDbIds return Collections.emptyList(); } // First, get all ObservationUnits for the given trialDbIds. + // TODO: Once OUDAO removes cache, investigate utilizing observationUnit GET param to includeObservations instead of making an extra call for the observations. This should offer performance gains. [BI-2963] List observationUnitDbIds = observationUnitDAO.getObservationUnitsForTrialDbIds(program.getId(), trialDbIds) .stream().map(BrAPIObservationUnit::getObservationUnitDbId).collect(Collectors.toList()); // Finally, return all Observations for those ObservationUnits (Observations are linked to Trial through ObservationUnits). + // TODO: This gets all observations for the program and filters, which is extremely inefficient. If above TODO suggestion doesn't work, another improvement would be to search on OU ids directly in BrAPI instead. [BI-2963] return getProgramObservations(program.getId()).values().stream() .filter(o -> observationUnitDbIds.contains(o.getObservationUnitDbId())) .collect(Collectors.toList()); From 2d3d39ca906b3bd153013b4e9033621291721b91 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Mon, 6 Jul 2026 18:20:40 -0400 Subject: [PATCH 027/102] Remove cache.get calls from ObservationDAO - Create tickets for optimizations and improvements to downstream usages of these calls and mark with TODOs --- .../brapi/v2/BrAPIObservationsController.java | 1 + .../brapi/v2/dao/BrAPIObservationDAO.java | 95 +++++++++++-------- 2 files changed, 54 insertions(+), 42 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationsController.java b/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationsController.java index 27ac4e34c..5f4fcc7c8 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationsController.java +++ b/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationsController.java @@ -148,6 +148,7 @@ public HttpResponse observationsGet(@PathVariable("programId") UUID programId, } // Get a filtered list of observations. + // TODO: Handle filtering and pagination of this request entirely on BrAPI side once study and ou cache is removed: [BI-2964] List observations = observationDAO.getObservationsByFilters(program.get(), studyDbId); // If page is not provided, set it to the default value 0. diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java index acd518a7d..639ed9826 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java @@ -24,9 +24,14 @@ import org.apache.commons.lang3.tuple.Pair; import org.brapi.client.v2.ApiResponse; import org.brapi.client.v2.model.exceptions.ApiException; +import org.brapi.client.v2.model.queryParams.core.TrialQueryParams; +import org.brapi.client.v2.model.queryParams.phenotype.ObservationQueryParams; +import org.brapi.client.v2.modules.core.TrialsApi; import org.brapi.client.v2.modules.phenotype.ObservationsApi; import org.brapi.v2.model.BrAPIAcceptedSearchResponse; import org.brapi.v2.model.BrAPIExternalReference; +import org.brapi.v2.model.core.BrAPIProgram; +import org.brapi.v2.model.core.BrAPITrial; import org.brapi.v2.model.pheno.BrAPIObservation; import org.brapi.v2.model.pheno.BrAPIObservationUnit; import org.brapi.v2.model.pheno.request.BrAPIObservationSearchRequest; @@ -67,6 +72,8 @@ public class BrAPIObservationDAO extends BrAPICachedDAO { private boolean runScheduledTasks; private final TraitService traitService; + private final int brapiMaxPageSize; + @Inject public BrAPIObservationDAO(ProgramDAO programDAO, ImportDAO importDAO, @@ -75,6 +82,7 @@ public BrAPIObservationDAO(ProgramDAO programDAO, BrAPIEndpointProvider brAPIEndpointProvider, @Property(name = "brapi.server.reference-source") String referenceSource, @Property(name = "micronaut.bi.api.run-scheduled-tasks") boolean runScheduledTasks, + @Property(name = "brapi.cache.fetch-page-size") int brapiFetchPageSize, ProgramCacheProvider programCacheProvider, TraitService traitService) { this.programDAO = programDAO; this.importDAO = importDAO; @@ -85,6 +93,7 @@ public BrAPIObservationDAO(ProgramDAO programDAO, this.runScheduledTasks = runScheduledTasks; this.traitService = traitService; this.programCache = programCacheProvider.getProgramCache(this::fetchProgramObservations, BrAPIObservation.class); + this.brapiMaxPageSize = brapiFetchPageSize; } @Scheduled(initialDelay = "${startup.delay.observation}") @@ -165,8 +174,14 @@ private void processObservations(String programKey, List obser /** * Get all observations for a program from the cache. */ - private Map getProgramObservations(UUID programId) throws ApiException { - return programCache.get(programId); + private List getProgramObservations(UUID programId) throws ApiException { + + Program program = programDAO.get(programId) + .stream() + .findFirst() + .orElseThrow(); + + return getBrAPIObservationsUsingBrAPIProgramId(program); } // Note: not using cache, because unique studyName (with "[ProgramKey-ExtraInfo]") is not stored directly on Observation. @@ -202,7 +217,7 @@ public List getObservationsByDbIds(List dbIds, Program // Filter the observations based on the provided program ID and the provided list of dbIds // Collect the filtered observations into a List and return the result - return getProgramObservations(program.getId()).values().stream() + return getProgramObservations(program.getId()).stream() .filter(o -> dbIds.contains(o.getObservationDbId())) .collect(Collectors.toList()); } @@ -217,7 +232,7 @@ public List getObservationsByTrialDbId(List trialDbIds .stream().map(BrAPIObservationUnit::getObservationUnitDbId).collect(Collectors.toList()); // Finally, return all Observations for those ObservationUnits (Observations are linked to Trial through ObservationUnits). // TODO: This gets all observations for the program and filters, which is extremely inefficient. If above TODO suggestion doesn't work, another improvement would be to search on OU ids directly in BrAPI instead. [BI-2963] - return getProgramObservations(program.getId()).values().stream() + return getProgramObservations(program.getId()).stream() .filter(o -> observationUnitDbIds.contains(o.getObservationUnitDbId())) .collect(Collectors.toList()); } @@ -226,29 +241,22 @@ public List getObservationsByObservationUnitsAndVariables(Coll if(ouDbIds.isEmpty() || variableDbIds.isEmpty()) { return Collections.emptyList(); } - return getProgramObservations(program.getId()).values().stream() + // TODO: Once OUDAO removes cache, change to BrAPI Observation search request on program, observation var ids, and ouDbId [BI-2963] + return getProgramObservations(program.getId()).stream() .filter(o -> ouDbIds.contains(o.getObservationUnitDbId()) && variableDbIds.contains(o.getObservationVariableDbId())) .collect(Collectors.toList()); } public List getObservationsByObservationUnits(Collection ouDbIds, Program program) throws ApiException { + // TODO: Once OUDAO removes cache, change to BrAPI Observation search request on program and ouDbIds [BI-2963] if(ouDbIds.isEmpty()) { return Collections.emptyList(); } - return getProgramObservations(program.getId()).values().stream() + return getProgramObservations(program.getId()).stream() .filter(o -> ouDbIds.contains(o.getObservationUnitDbId())) .collect(Collectors.toList()); } - public List getObservationsByObservationUnitsAndStudies(Collection ouDbIds, Collection studyDbIds, Program program) throws ApiException { - if(ouDbIds.isEmpty()) { - return Collections.emptyList(); - } - return getProgramObservations(program.getId()).values().stream() - .filter(o -> ouDbIds.contains(o.getObservationUnitDbId()) && studyDbIds.contains(o.getStudyDbId())) - .collect(Collectors.toList()); - } - // TODO: implement other filters in BI-2506. public List getObservationsByFilters(Program program, String studyDbId) throws ApiException, DoesNotExistException { @@ -257,7 +265,7 @@ public List getObservationsByFilters(Program program, String s String observationSource = Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.OBSERVATIONS); // Get all observations for the program. - Collection observations = getProgramObservations(program.getId()).values(); + Collection observations = getProgramObservations(program.getId()); // Build a hashmap of traits for fast lookup. The key is ObservationVariableDbId, the value is the Trait Id. HashMap traitIdsByObservationVariableDbId = traitService.getIdsByObservationVariableDbIds(program.getId(), observations.stream().map(BrAPIObservation::getObservationVariableDbId).collect(Collectors.toList())); @@ -269,6 +277,7 @@ public List getObservationsByFilters(Program program, String s Optional xref = Utilities.getExternalReference(o.getExternalReferences(), studySource); return xref.filter(brAPIExternalReference -> studyDbId.equals(brAPIExternalReference.getReferenceId())).isPresent(); }) + // Try to figure out why/how this translation is used. .peek(o -> { // Translate ObservationVariableDbId. o.setObservationVariableDbId(traitIdsByObservationVariableDbId.get(o.getObservationVariableDbId())); @@ -308,33 +317,35 @@ public List createBrAPIObservations(List brA } } - public BrAPIObservation updateBrAPIObservation(String dbId, BrAPIObservation observation, UUID programId) throws ApiException { - ObservationsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(programId), ObservationsApi.class); - var program = programDAO.fetchOneById(programId); - try { - Callable> postFunction = () -> { - ApiResponse response = api.observationsObservationDbIdPut(dbId, observation); - if (response == null) - { - throw new ApiException("Response is null", 0, null, null); - } - BrAPIObservationSingleResponse body = response.getBody(); - if (body == null) { - throw new ApiException("Response is missing body", 0, response.getHeaders(), null); - } - BrAPIObservation updatedObservation = body.getResult(); - if (updatedObservation == null) { - throw new ApiException("Response body is missing result", 0, response.getHeaders(), response.getBody().toString()); - } - return processObservationsForCache(List.of(updatedObservation), program.getKey()); - }; - return programCache.post(programId, postFunction).get(0); - } catch (ApiException e) { - log.error(Utilities.generateApiExceptionLogMessage(e)); - throw new InternalServerException("Unknown error has occurred: " + e.getMessage(), e); - } catch (Exception e) { - throw new InternalServerException("Unknown error has occurred: " + e.getMessage(), e); + private List getBrAPIObservationsUsingBrAPIProgramId(Program program) throws ApiException { + + if (program == null || program.getId() == null) { + throw new InternalServerException("BI-API Program or Program ID is null"); + } + + String brapiProgramDbId = Optional.of(program) + .map(Program::getBrapiProgram) + .map(BrAPIProgram::getProgramDbId) + .orElse(null); + + if (brapiProgramDbId == null) { + brapiProgramDbId = programDAO.getProgramBrAPI(program).getProgramDbId(); } + + ObservationQueryParams observationQueryParams = + ObservationQueryParams.builder() + .programDbId(brapiProgramDbId) + .pageSize(brapiMaxPageSize) + .page(0) + .build(); + + ObservationsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(program.getId()), ObservationsApi.class); + + List result = brAPIDAOUtil.get(api::observationsGet, observationQueryParams); + + processObservations(program.getKey(), result); + + return result; } // This method overloads updateBrAPIObservation(String dbId, BrAPIObservation observation, UUID programId) From e9099eac905a1666ecd750082c5066d5410de4f2 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Tue, 7 Jul 2026 17:25:49 -0400 Subject: [PATCH 028/102] Remove rest of cache code from ObservationDAO --- .../brapi/v2/dao/BrAPIObservationDAO.java | 91 ++----------------- 1 file changed, 9 insertions(+), 82 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java index 639ed9826..48346e495 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java @@ -69,7 +69,6 @@ public class BrAPIObservationDAO extends BrAPICachedDAO { private final BrAPIDAOUtil brAPIDAOUtil; private final BrAPIEndpointProvider brAPIEndpointProvider; private final String referenceSource; - private boolean runScheduledTasks; private final TraitService traitService; private final int brapiMaxPageSize; @@ -83,75 +82,17 @@ public BrAPIObservationDAO(ProgramDAO programDAO, @Property(name = "brapi.server.reference-source") String referenceSource, @Property(name = "micronaut.bi.api.run-scheduled-tasks") boolean runScheduledTasks, @Property(name = "brapi.cache.fetch-page-size") int brapiFetchPageSize, - ProgramCacheProvider programCacheProvider, TraitService traitService) { + TraitService traitService) { this.programDAO = programDAO; this.importDAO = importDAO; this.observationUnitDAO = observationUnitDAO; this.brAPIDAOUtil = brAPIDAOUtil; this.brAPIEndpointProvider = brAPIEndpointProvider; this.referenceSource = referenceSource; - this.runScheduledTasks = runScheduledTasks; this.traitService = traitService; - this.programCache = programCacheProvider.getProgramCache(this::fetchProgramObservations, BrAPIObservation.class); this.brapiMaxPageSize = brapiFetchPageSize; } - @Scheduled(initialDelay = "${startup.delay.observation}") - public void setup() { - if(!runScheduledTasks) { - return; - } - // Populate the observation cache for all programs on startup. - log.debug("populating observation cache"); - List programs = programDAO.getActive(); - if (programs != null) { - programCache.populate(programs.stream().map(Program::getId).collect(Collectors.toList())); - } - } - - /** - * Fetch formatted observations for this program. - */ - private Map fetchProgramObservations(UUID programId) throws ApiException { - ObservationsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(programId), ObservationsApi.class); - // Get the program. - List programs = programDAO.get(programId); - if (programs.size() != 1) { - throw new InternalServerException("Program was not found for given id"); - } - Program program = programs.get(0); - - // Set query params and make call. - BrAPIObservationSearchRequest observationSearch = new BrAPIObservationSearchRequest(); - observationSearch.externalReferenceIds(List.of(programId.toString())); - observationSearch.externalReferenceSources(List.of(Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.PROGRAMS))); - return processObservationsForCache(brAPIDAOUtil.search( - api::searchObservationsPost, - api::searchObservationsSearchResultsDbIdGet, - observationSearch - ), program.getKey()); - } - - /** - * Process a list of observations for insertion into the cache. - */ - private Map processObservationsForCache(List programObservations, String programKey) { - // Process programObservations in place (strip program key, etc.). - processObservations(programKey, programObservations); - // Build map. - Map programObservationsMap = new HashMap<>(); - log.trace("processing observationUnits for cache: " + programObservations); - for (BrAPIObservation observation: programObservations) { - BrAPIExternalReference xref = observation - .getExternalReferences() - .stream() - .filter(reference -> String.format("%s/%s", referenceSource, ExternalReferenceSource.OBSERVATIONS.getName()).equals(reference.getReferenceSource())) - .findFirst().orElseThrow(() -> new IllegalStateException("No BI external reference found")); - programObservationsMap.put(xref.getReferenceId(), observation); - } - return programObservationsMap; - } - /** * Process BrAPIObservations for use in DeltaBreed (e.g. strip program key). */ @@ -305,11 +246,9 @@ public List createBrAPIObservations(List brA var program = programDAO.fetchOneById(programId); try { if (!brAPIObservationList.isEmpty()) { - Callable> postFunction = () -> { List postResponse = brAPIDAOUtil.post(brAPIObservationList, upload, api::observationsPost, importDAO::update); - return processObservationsForCache(postResponse, program.getKey()); - }; - return programCache.post(programId, postFunction); + processObservations(program.getKey(), postResponse); + return postResponse; } return new ArrayList<>(); } catch (Exception e) { @@ -348,15 +287,13 @@ private List getBrAPIObservationsUsingBrAPIProgramId(Program p return result; } - // This method overloads updateBrAPIObservation(String dbId, BrAPIObservation observation, UUID programId) - // It was added to increase efficiency. It insures that ProgramCache.populate() is called only once - // not once per observation. public List updateBrAPIObservation(Map mutatedObservationByDbId, UUID programId) throws ApiException { ObservationsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(programId), ObservationsApi.class); var program = programDAO.fetchOneById(programId); List updatedObservations = new ArrayList<>(); try { + // TODO: Instead of a for loop, utilize BrAPI Observations put to do all updates in one request. [BI-2969] for (Map.Entry entry : mutatedObservationByDbId.entrySet()) { String dbId = entry.getKey(); BrAPIObservation observation = entry.getValue(); @@ -364,23 +301,13 @@ public List updateBrAPIObservation(Map response = null; + BrAPIObservation updatedObservation; + try { - response = api.observationsObservationDbIdPut(dbId, observation); + updatedObservation = brAPIDAOUtil.put(dbId, observation, api::observationsObservationDbIdPut); } catch (ApiException e) { throw new RuntimeException(e); } - if (response == null) { - throw new ApiException("Response is null", 0, null, null); - } - BrAPIObservationSingleResponse body = response.getBody(); - if (body == null) { - throw new ApiException("Response is missing body", 0, response.getHeaders(), null); - } - BrAPIObservation updatedObservation = body.getResult(); - if (updatedObservation == null) { - throw new ApiException("Response body is missing result", 0, response.getHeaders(), response.getBody().toString()); - } updatedObservations.add(updatedObservation); if (!Objects.equals(observation.getValue(), updatedObservation.getValue()) @@ -394,8 +321,8 @@ public List updateBrAPIObservation(Map processedObservations = processObservationsForCache(updatedObservations, program.getKey()); - return programCache.postThese(programId,processedObservations); + processObservations(program.getKey(), updatedObservations); + return updatedObservations; } catch (ApiException e) { log.error("Error updating observation: " + Utilities.generateApiExceptionLogMessage(e), e); throw e; From e0baa4a58e988964e64a2c82e9e1d35300b9c5c1 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Tue, 7 Jul 2026 17:36:23 -0400 Subject: [PATCH 029/102] Remove unused imports, comments on cache usage --- .../brapi/v2/dao/BrAPIObservationDAO.java | 9 --------- 1 file changed, 9 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java index 639ed9826..7d42f0479 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java @@ -24,14 +24,11 @@ import org.apache.commons.lang3.tuple.Pair; import org.brapi.client.v2.ApiResponse; import org.brapi.client.v2.model.exceptions.ApiException; -import org.brapi.client.v2.model.queryParams.core.TrialQueryParams; import org.brapi.client.v2.model.queryParams.phenotype.ObservationQueryParams; -import org.brapi.client.v2.modules.core.TrialsApi; import org.brapi.client.v2.modules.phenotype.ObservationsApi; import org.brapi.v2.model.BrAPIAcceptedSearchResponse; import org.brapi.v2.model.BrAPIExternalReference; import org.brapi.v2.model.core.BrAPIProgram; -import org.brapi.v2.model.core.BrAPITrial; import org.brapi.v2.model.pheno.BrAPIObservation; import org.brapi.v2.model.pheno.BrAPIObservationUnit; import org.brapi.v2.model.pheno.request.BrAPIObservationSearchRequest; @@ -43,7 +40,6 @@ import org.breedinginsight.daos.ProgramDAO; import org.breedinginsight.daos.cache.ProgramCacheProvider; import org.breedinginsight.model.Program; -import org.breedinginsight.model.Trait; import org.breedinginsight.services.TraitService; import org.breedinginsight.services.brapi.BrAPIEndpointProvider; import org.breedinginsight.services.exceptions.DoesNotExistException; @@ -171,11 +167,7 @@ private void processObservations(String programKey, List obser } } - /** - * Get all observations for a program from the cache. - */ private List getProgramObservations(UUID programId) throws ApiException { - Program program = programDAO.get(programId) .stream() .findFirst() @@ -184,7 +176,6 @@ private List getProgramObservations(UUID programId) throws Api return getBrAPIObservationsUsingBrAPIProgramId(program); } - // Note: not using cache, because unique studyName (with "[ProgramKey-ExtraInfo]") is not stored directly on Observation. public List getObservationsByStudyName(List studyNames, Program program) throws ApiException { if(studyNames.isEmpty()) { return Collections.emptyList(); From a5ef8262119459ae9a841a76b08baae7063b239e Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Wed, 8 Jul 2026 12:52:14 -0400 Subject: [PATCH 030/102] Fix unit test failures --- .../org/breedinginsight/brapi/v2/services/BrAPITrialService.java | 1 - 1 file changed, 1 deletion(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java index 8e0b4bae6..4d1544940 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java @@ -836,7 +836,6 @@ public int deleteExperiment(Program program, UUID experimentId, boolean hard) th } // TODO: if performance is poor, implement more precise invalidation, possibly using hierarchical cache keys. studyDAO.repopulateCache(program.getId()); - observationDAO.repopulateCache(program.getId()); observationUnitDAO.repopulateCache(program.getId()); } From 799712211200240f3a66315635b5b2139b6fa102 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Wed, 8 Jul 2026 13:31:12 -0400 Subject: [PATCH 031/102] Remove referenced to CachedDAO parent class, remove imports --- .../breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java index fb026a984..dfd1fddc1 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java @@ -18,7 +18,6 @@ import io.micronaut.context.annotation.Property; import io.micronaut.http.server.exceptions.InternalServerException; -import io.micronaut.scheduling.annotation.Scheduled; import lombok.extern.slf4j.Slf4j; import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.tuple.Pair; @@ -33,12 +32,10 @@ import org.brapi.v2.model.pheno.BrAPIObservationUnit; import org.brapi.v2.model.pheno.request.BrAPIObservationSearchRequest; import org.brapi.v2.model.pheno.response.BrAPIObservationListResponse; -import org.brapi.v2.model.pheno.response.BrAPIObservationSingleResponse; import org.breedinginsight.brapps.importer.daos.ImportDAO; import org.breedinginsight.brapps.importer.model.ImportUpload; import org.breedinginsight.brapps.importer.services.ExternalReferenceSource; import org.breedinginsight.daos.ProgramDAO; -import org.breedinginsight.daos.cache.ProgramCacheProvider; import org.breedinginsight.model.Program; import org.breedinginsight.services.TraitService; import org.breedinginsight.services.brapi.BrAPIEndpointProvider; @@ -50,14 +47,13 @@ import javax.inject.Inject; import javax.inject.Singleton; import java.util.*; -import java.util.concurrent.Callable; import java.util.stream.Collectors; import static org.brapi.v2.model.BrAPIWSMIMEDataTypes.APPLICATION_JSON; @Singleton @Slf4j -public class BrAPIObservationDAO extends BrAPICachedDAO { +public class BrAPIObservationDAO { private ProgramDAO programDAO; private ImportDAO importDAO; From d29324337683108c758bc65bb426236c188e1cfc Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Thu, 9 Jul 2026 18:07:51 -0400 Subject: [PATCH 032/102] Remove cache.get() in ObservationUnitDAO --- .../brapi/v2/dao/BrAPIObservationUnitDAO.java | 84 +++++++++++++++---- 1 file changed, 68 insertions(+), 16 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java index 370d398d5..f83773bcf 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java @@ -18,7 +18,6 @@ package org.breedinginsight.brapi.v2.dao; import com.google.gson.Gson; -import com.google.gson.JsonElement; import com.google.gson.JsonObject; import com.google.gson.reflect.TypeToken; import io.micronaut.context.annotation.Property; @@ -28,9 +27,14 @@ import org.apache.commons.lang3.StringUtils; import org.brapi.client.v2.JSON; import org.brapi.client.v2.model.exceptions.ApiException; +import org.brapi.client.v2.model.queryParams.phenotype.ObservationQueryParams; +import org.brapi.client.v2.model.queryParams.phenotype.ObservationUnitQueryParams; import org.brapi.client.v2.modules.phenotype.ObservationUnitsApi; +import org.brapi.client.v2.modules.phenotype.ObservationsApi; import org.brapi.v2.model.BrAPIExternalReference; +import org.brapi.v2.model.core.BrAPIProgram; import org.brapi.v2.model.germ.BrAPIGermplasm; +import org.brapi.v2.model.pheno.BrAPIObservation; import org.brapi.v2.model.pheno.BrAPIObservationTreatment; import org.brapi.v2.model.pheno.BrAPIObservationUnit; import org.brapi.v2.model.pheno.BrAPIObservationUnitLevelRelationship; @@ -74,6 +78,8 @@ public class BrAPIObservationUnitDAO extends BrAPICachedDAO>(){}.getType(); + private final int brapiMaxPageSize; + @Inject public BrAPIObservationUnitDAO(ProgramDAO programDAO, ImportDAO importDAO, @@ -83,7 +89,8 @@ public BrAPIObservationUnitDAO(ProgramDAO programDAO, ProgramService programService, @Property(name = "brapi.server.reference-source") String referenceSource, @Property(name = "micronaut.bi.api.run-scheduled-tasks") boolean runScheduledTasks, - ProgramCacheProvider programCacheProvider) { + ProgramCacheProvider programCacheProvider, + @Property(name = "brapi.cache.fetch-page-size") int brapiFetchPageSize) { this.programDAO = programDAO; this.importDAO = importDAO; this.brAPIDAOUtil = brAPIDAOUtil; @@ -93,6 +100,7 @@ public BrAPIObservationUnitDAO(ProgramDAO programDAO, this.programService = programService; this.germplasmService = germplasmService; this.programCache = programCacheProvider.getProgramCache(this::fetchProgramObservationUnits, BrAPIObservationUnit.class); + this.brapiMaxPageSize = brapiFetchPageSize; } @Scheduled(initialDelay = "${startup.delay.observation_unit}") @@ -153,15 +161,52 @@ private Map processObservationUnitsForCache(List getProgramObservationUnits(UUID programId) throws ApiException { - return programCache.get(programId); + private List getProgramObservationUnits(UUID programId) throws ApiException { + Program program = programDAO.get(programId) + .stream() + .findFirst() + .orElseThrow(); + + return getBrAPIObservationUnitsUsingBrAPIProgramId(program); + } + + private List getBrAPIObservationUnitsUsingBrAPIProgramId(Program program) throws ApiException { + + if (program == null || program.getId() == null) { + throw new InternalServerException("BI-API Program or Program ID is null"); + } + + String brapiProgramDbId = Optional.of(program) + .map(Program::getBrapiProgram) + .map(BrAPIProgram::getProgramDbId) + .orElse(null); + + if (brapiProgramDbId == null) { + brapiProgramDbId = programDAO.getProgramBrAPI(program).getProgramDbId(); + } + + ObservationUnitQueryParams observationUnitQueryParams = + ObservationUnitQueryParams.builder() + .programDbId(brapiProgramDbId) + .pageSize(brapiMaxPageSize) + .page(0) + .build(); + + ObservationUnitsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(program.getId()), ObservationUnitsApi.class); + + List result = brAPIDAOUtil.get(api::observationunitsGet, observationUnitQueryParams); + + processObservationUnits(program, result, true); + + return result; } + // TODO: Remove this method and associated usages public List getObservationUnitByName(List observationUnitNames, Program program) throws ApiException { if(observationUnitNames.isEmpty()) { return Collections.emptyList(); } - return getProgramObservationUnits(program.getId()).values().stream() + return getProgramObservationUnits(program.getId()).stream() .filter(ou -> observationUnitNames.contains(ou.getObservationUnitName())) .collect(Collectors.toList()); } @@ -208,18 +253,26 @@ public List createBrAPIObservationUnits(List getObservationUnitsById(Collection observationUnitExternalIds, Program program) throws ApiException { if(observationUnitExternalIds.isEmpty()) { return Collections.emptyList(); } - return getProgramObservationUnits(program.getId()).entrySet().stream() - .filter(entry -> observationUnitExternalIds.contains(entry.getKey())) - .map(Map.Entry::getValue) - .collect(Collectors.toList()); + return getProgramObservationUnits(program.getId()).stream() + .filter(ou -> { + var ouExRef = Utilities.getExternalReference(ou.getExternalReferences(), referenceSource, ExternalReferenceSource.OBSERVATION_UNITS).orElse(null); + + if (ouExRef == null) { + return false; + } else { + return observationUnitExternalIds.contains(ouExRef.getReferenceId()); + } + + }).collect(Collectors.toList()); } public List getObservationUnitsForStudyDbId(@NotNull String studyDbId, Program program) throws ApiException { - return getProgramObservationUnits(program.getId()).values().stream() + return getProgramObservationUnits(program.getId()).stream() .filter(ou -> ou.getStudyDbId().equals(studyDbId)) .collect(Collectors.toList()); } @@ -228,20 +281,20 @@ public List getObservationUnitsForTrialDbIds(@NotNull UUID if (trialDbIds.isEmpty()) { return Collections.emptyList(); } - return getProgramObservationUnits(programId).values().stream() + return getProgramObservationUnits(programId).stream() .filter(ou -> trialDbIds.contains(ou.getTrialDbId())) .collect(Collectors.toList()); } public List getObservationUnitsForTrialDbId(@NotNull UUID programId, @NotNull String trialDbId) throws ApiException { - return getProgramObservationUnits(programId).values().stream() + return getProgramObservationUnits(programId).stream() .filter(ou -> ou.getTrialDbId().equals(trialDbId)) .collect(Collectors.toList()); } public List getObservationUnitsForDataset(@NotNull String datasetId, @NotNull Program program) throws ApiException { String datasetReferenceSource = Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.DATASET); - return getProgramObservationUnits(program.getId()).values().stream() + return getProgramObservationUnits(program.getId()).stream() .filter(ou -> { Optional exRef = Utilities.getExternalReference(ou.getExternalReferences(), datasetReferenceSource); return exRef.map(brAPIExternalReference -> brAPIExternalReference.getReferenceId().equals(datasetId)).orElse(false); @@ -252,7 +305,7 @@ public List getObservationUnitsForDataset(@NotNull String public List getObservationUnitsForDatasetAndEnvs(@NotNull String datasetId, Collection envIds, @NotNull Program program) throws ApiException { String datasetReferenceSource = Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.DATASET); String studyReferenceSource = Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.STUDIES); - return getProgramObservationUnits(program.getId()).values().stream() + return getProgramObservationUnits(program.getId()).stream() .filter(ou -> { Optional datasetExRef = Utilities.getExternalReference(ou.getExternalReferences(), datasetReferenceSource); Optional studyExRef = Utilities.getExternalReference(ou.getExternalReferences(), studyReferenceSource); @@ -375,8 +428,7 @@ private void processObservationUnits(Program program, List HashMap germplasmByDbId = new HashMap<>(); if( withGID ){ - // Load germplasm for program into map. - // TODO: if we use redis search, that may be more efficient than loading all germplasm for the program. + // TODO: Optimize this to use germplasm information directly in BrAPIObservationUnit by adding accession num/GID there via the prodserver/client [BI-2978] this.germplasmService.getGermplasm(program.getId()).forEach((germplasm -> germplasmByDbId.put(germplasm.getGermplasmDbId(), germplasm))); } From bfa2e4b93414c3f232d9010a85d446016997a5bc Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Thu, 9 Jul 2026 18:19:09 -0400 Subject: [PATCH 033/102] Remove getObservationUnitByName from OUDAO - Additionally remove unused ObservationUnit processor --- .../brapi/v2/dao/BrAPIObservationUnitDAO.java | 12 +- .../processors/ObservationUnitProcessor.java | 215 ------------------ .../daos/BrAPIObservationUnitDAOTest.java | 2 +- 3 files changed, 2 insertions(+), 227 deletions(-) delete mode 100644 src/main/java/org/breedinginsight/brapps/importer/services/processors/ObservationUnitProcessor.java diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java index f83773bcf..cab438960 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java @@ -161,7 +161,7 @@ private Map processObservationUnitsForCache(List getProgramObservationUnits(UUID programId) throws ApiException { + public List getProgramObservationUnits(UUID programId) throws ApiException { Program program = programDAO.get(programId) .stream() .findFirst() @@ -201,16 +201,6 @@ private List getBrAPIObservationUnitsUsingBrAPIProgramId(P return result; } - // TODO: Remove this method and associated usages - public List getObservationUnitByName(List observationUnitNames, Program program) throws ApiException { - if(observationUnitNames.isEmpty()) { - return Collections.emptyList(); - } - return getProgramObservationUnits(program.getId()).stream() - .filter(ou -> observationUnitNames.contains(ou.getObservationUnitName())) - .collect(Collectors.toList()); - } - /** * Create observation units with import progress. * Mutates brAPIObservationUnitList. diff --git a/src/main/java/org/breedinginsight/brapps/importer/services/processors/ObservationUnitProcessor.java b/src/main/java/org/breedinginsight/brapps/importer/services/processors/ObservationUnitProcessor.java deleted file mode 100644 index 6f1e6723a..000000000 --- a/src/main/java/org/breedinginsight/brapps/importer/services/processors/ObservationUnitProcessor.java +++ /dev/null @@ -1,215 +0,0 @@ -/* - * See the NOTICE file distributed with this work for additional information - * regarding copyright ownership. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.breedinginsight.brapps.importer.services.processors; - -import io.micronaut.context.annotation.Prototype; -import io.micronaut.http.HttpStatus; -import io.micronaut.http.exceptions.HttpStatusException; -import io.micronaut.http.server.exceptions.InternalServerException; -import org.brapi.client.v2.model.exceptions.ApiException; -import org.brapi.v2.model.core.BrAPIStudy; -import org.brapi.v2.model.germ.BrAPIGermplasm; -import org.brapi.v2.model.pheno.BrAPIObservationUnit; -import org.breedinginsight.brapi.v2.dao.BrAPIObservationUnitDAO; -import org.breedinginsight.brapps.importer.model.ImportUpload; -import org.breedinginsight.brapps.importer.model.base.ObservationUnit; -import org.breedinginsight.brapps.importer.model.imports.BrAPIImport; -import org.breedinginsight.brapps.importer.model.imports.PendingImport; -import org.breedinginsight.brapps.importer.model.response.ImportObjectState; -import org.breedinginsight.brapps.importer.model.response.ImportPreviewStatistics; -import org.breedinginsight.brapps.importer.model.response.PendingImportObject; -import org.breedinginsight.model.Program; -import org.breedinginsight.model.User; -import org.breedinginsight.services.exceptions.DoesNotExistException; -import org.breedinginsight.services.exceptions.ValidatorException; -import tech.tablesaw.api.Table; - -import javax.inject.Inject; -import java.util.*; -import java.util.stream.Collectors; - -@Prototype -public class ObservationUnitProcessor implements Processor { - - private static final String NAME = "Observation unit"; - - private BrAPIObservationUnitDAO brAPIObservationUnitDAO; - private Map> observationUnitByName = new HashMap<>(); - private Set studyNames = new HashSet(); - private static final Set ALLOWED_LEVELS = Set.of("plot", "plant"); - - @Inject - public ObservationUnitProcessor(BrAPIObservationUnitDAO brAPIObservationUnitDAO) { - this.brAPIObservationUnitDAO = brAPIObservationUnitDAO; - } - - public void getExistingBrapiData(List importRows, Program program) { - - // get unique observation unit names - List uniqueObservationUnitNames = importRows.stream() - .map(studyImport -> studyImport.getObservationUnit().getObservationUnitName()) - .distinct() - .collect(Collectors.toList()); - - // check for existing observation units. Don't want to update existing, just create new. - // TODO: do we allow adding observations to existing studies? yes, but not updating - // ignore all data for observation units existing in system - - List existingObservationUnits; - - try { - existingObservationUnits = brAPIObservationUnitDAO.getObservationUnitByName(uniqueObservationUnitNames, program); - existingObservationUnits.forEach(existingObservationUnit -> { - - // update mapped brapi import, does in process - observationUnitByName.put(existingObservationUnit.getObservationUnitName(), new PendingImportObject<>(ImportObjectState.EXISTING, existingObservationUnit)); - }); - } catch (ApiException e) { - // We shouldn't get an error back from our services. If we do, nothing the user can do about it - throw new InternalServerException(e.toString(), e); - } - } - - private void getExistingStudyObjects() { - - } - - @Override - public Map process(ImportUpload upload, List importRows, - Map mappedBrAPIImport, Table data, - Program program, User user, boolean commit) { - - for (int i = 0; i < importRows.size(); i++) { - BrAPIImport brapiImport = importRows.get(i); - PendingImport mappedImportRow = mappedBrAPIImport.getOrDefault(i, new PendingImport()); - - ObservationUnit observationUnit = brapiImport.getObservationUnit(); - if (observationUnit == null) { - throw new IllegalArgumentException("Import profile must have observation unit for observation unit processor"); - } - - BrAPIObservationUnit brapiObservationUnit = observationUnit.constructBrAPIObservationUnit(); - - String levelName = brapiObservationUnit.getObservationUnitPosition().getObservationLevel().getLevelName().toLowerCase(); - if (!ALLOWED_LEVELS.contains(levelName)) { - throw new HttpStatusException(HttpStatus.BAD_REQUEST, "Observation unit level name not allowed"); - } - brapiObservationUnit.getObservationUnitPosition().getObservationLevel().setLevelName(levelName); - - if (!observationUnitByName.containsKey(observationUnit.getObservationUnitName())) { - observationUnitByName.put(brapiObservationUnit.getObservationUnitName(), new PendingImportObject<>(ImportObjectState.NEW, brapiObservationUnit)); - mappedImportRow.setObservationUnit(new PendingImportObject<>(ImportObjectState.NEW, brapiObservationUnit)); - } - mappedImportRow.setObservationUnit(observationUnitByName.get(observationUnit.getObservationUnitName())); - mappedBrAPIImport.put(i, mappedImportRow); - } - - ImportPreviewStatistics stats = ImportPreviewStatistics.builder() - .newObjectCount(ProcessorData.getNumNewObjects(observationUnitByName)) - .ignoredObjectCount(ProcessorData.getNumExistingObjects(observationUnitByName)) - .build(); - - return Map.of(NAME, stats); - } - - @Override - public void validateDependencies(Map mappedBrAPIImport) throws ValidatorException { - // TODO: check if have studies, etc. - } - - - @Override - public void postBrapiData(Map mappedBrAPIImport, Program program, ImportUpload upload) { - - // check shared data object for dependency data and update observation units - updateDependencyValues(mappedBrAPIImport); - - List observationUnits = ProcessorData.getNewObjects(observationUnitByName); - - List createdObservationUnits = new ArrayList<>(); - try { - createdObservationUnits.addAll(brAPIObservationUnitDAO.createBrAPIObservationUnits(observationUnits, program.getId(), upload)); - } catch (ApiException e) { - throw new InternalServerException(e.toString(), e); - } catch (DoesNotExistException e) { - throw new InternalServerException(e.toString(), e); - } - - // Update our records - createdObservationUnits.forEach(observationUnit -> { - // update mapped brapi import, will have to do either way? no - PendingImportObject preview = observationUnitByName.get(observationUnit.getObservationUnitName()); - preview.setBrAPIObject(observationUnit); - updateObservationUnitDbIds(mappedBrAPIImport); - }); - - } - - private void updateObservationUnitDbIds(Map mappedBrAPIImport) { - observationUnitByName.values().stream() - .filter(preview -> preview != null && preview.getState() == ImportObjectState.NEW) - .map(PendingImportObject::getBrAPIObject) - .forEach(p -> updateObservationUnitDbId(mappedBrAPIImport, p)); - } - - private void updateObservationUnitDbId(Map mappedBrAPIImport, BrAPIObservationUnit observationUnit) { - mappedBrAPIImport.values().stream() - .filter(obsUnit -> obsUnit.getObservationUnit() - .getBrAPIObject().getObservationUnitName().equals(observationUnit.getObservationUnitName())) - .forEach(obsUnit -> obsUnit.getObservationUnit().getBrAPIObject().setObservationUnitDbId(observationUnit.getObservationUnitDbId())); - } - - private void updateDependencyValues(Map mappedBrAPIImport) { - - // update study DbIds - mappedBrAPIImport.values().stream() - .map(PendingImport::getStudy) - .filter(Objects::nonNull) - .distinct() - .map(PendingImportObject::getBrAPIObject) - .forEach(this::updateStudyDbId); - - // update germplasm DbIds - mappedBrAPIImport.values().stream() - .map(PendingImport::getGermplasm) - .filter(Objects::nonNull) - .distinct() - .map(PendingImportObject::getBrAPIObject) - .forEach(this::updateGermplasmDbId); - - } - - private void updateStudyDbId(BrAPIStudy study) { - observationUnitByName.values().stream() - .filter(obsUnit -> obsUnit.getBrAPIObject().getStudyName().equals(study.getStudyName())) - .forEach(obsUnit -> obsUnit.getBrAPIObject().setStudyDbId(study.getStudyDbId())); - } - - private void updateGermplasmDbId(BrAPIGermplasm germplasm) { - observationUnitByName.values().stream() - .filter(obsUnit -> obsUnit.getBrAPIObject().getGermplasmName() != null && - obsUnit.getBrAPIObject().getGermplasmName().equals(germplasm.getGermplasmName())) - .forEach(obsUnit -> obsUnit.getBrAPIObject().setGermplasmDbId(germplasm.getGermplasmDbId())); - } - - @Override - public String getName() { - return NAME; - } - - -} diff --git a/src/test/java/org/breedinginsight/brapps/importer/daos/BrAPIObservationUnitDAOTest.java b/src/test/java/org/breedinginsight/brapps/importer/daos/BrAPIObservationUnitDAOTest.java index bd2048b61..eb071b652 100644 --- a/src/test/java/org/breedinginsight/brapps/importer/daos/BrAPIObservationUnitDAOTest.java +++ b/src/test/java/org/breedinginsight/brapps/importer/daos/BrAPIObservationUnitDAOTest.java @@ -143,7 +143,7 @@ public void testCreateObservationUnitAdditionalInfoSingleTreatmentFactor() { @SneakyThrows @Order(2) public void testGetObservationUnitAdditionalInfoSingleTreatmentFactor() { - List createdOus = obsUnitDAO.getObservationUnitByName(List.of("test1"), validProgram); + List createdOus = obsUnitDAO.getProgramObservationUnits(validProgram.getId()); singleTreatmentAsserts(createdOus, testTreatment); } From 87f00ec84ae45138f0655b15aa70ba08da3415b9 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Fri, 10 Jul 2026 15:00:29 -0400 Subject: [PATCH 034/102] Add TODO comments for future ticket work --- .../brapi/v2/dao/BrAPIObservationUnitDAO.java | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java index cab438960..ca025c076 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java @@ -243,7 +243,7 @@ public List createBrAPIObservationUnits(List getObservationUnitsById(Collection observationUnitExternalIds, Program program) throws ApiException { if(observationUnitExternalIds.isEmpty()) { return Collections.emptyList(); @@ -262,6 +262,7 @@ public List getObservationUnitsById(Collection obs } public List getObservationUnitsForStudyDbId(@NotNull String studyDbId, Program program) throws ApiException { + // TODO: Optimize and change this to search/get on studyDbId once cache is removed for studies [BI-2979] return getProgramObservationUnits(program.getId()).stream() .filter(ou -> ou.getStudyDbId().equals(studyDbId)) .collect(Collectors.toList()); @@ -271,6 +272,8 @@ public List getObservationUnitsForTrialDbIds(@NotNull UUID if (trialDbIds.isEmpty()) { return Collections.emptyList(); } + + // TODO: Optimize and change this to search on trialDbIds [BI-2979] return getProgramObservationUnits(programId).stream() .filter(ou -> trialDbIds.contains(ou.getTrialDbId())) .collect(Collectors.toList()); @@ -278,12 +281,14 @@ public List getObservationUnitsForTrialDbIds(@NotNull UUID public List getObservationUnitsForTrialDbId(@NotNull UUID programId, @NotNull String trialDbId) throws ApiException { return getProgramObservationUnits(programId).stream() + // TODO: Optimize and change this to search/get on trialDbId [BI-2979] .filter(ou -> ou.getTrialDbId().equals(trialDbId)) .collect(Collectors.toList()); } public List getObservationUnitsForDataset(@NotNull String datasetId, @NotNull Program program) throws ApiException { String datasetReferenceSource = Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.DATASET); + // TODO: Optimize and change this to search/get on dataset id once a solution is in place to relate ous to datasets [BI-2961] return getProgramObservationUnits(program.getId()).stream() .filter(ou -> { Optional exRef = Utilities.getExternalReference(ou.getExternalReferences(), datasetReferenceSource); @@ -295,6 +300,7 @@ public List getObservationUnitsForDataset(@NotNull String public List getObservationUnitsForDatasetAndEnvs(@NotNull String datasetId, Collection envIds, @NotNull Program program) throws ApiException { String datasetReferenceSource = Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.DATASET); String studyReferenceSource = Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.STUDIES); + // TODO: Optimize and change this to search/get on both dataset id and studyDbId once a solution is in place to relate ous to datasets and study cache is removed [BI-2961] return getProgramObservationUnits(program.getId()).stream() .filter(ou -> { Optional datasetExRef = Utilities.getExternalReference(ou.getExternalReferences(), datasetReferenceSource); @@ -342,14 +348,17 @@ public List getObservationUnits(Program program, BrAPIObservationUnitLevelRelationship relationship = new BrAPIObservationUnitLevelRelationship(); AtomicBoolean relationshipFilter = new AtomicBoolean(false); + // TODO: Use observationUnitSearchRequest.setObservationUnitDbIds() instead of xrefs [BI-2914] observationUnitId.ifPresent(ouId -> addXRefFilter(ouId, ExternalReferenceSource.OBSERVATION_UNITS, xrefIds, xrefSources)); observationUnitName.ifPresent(name -> observationUnitSearchRequest.setObservationUnitNames(List.of(Utilities.appendProgramKey(name, program.getKey())))); locationDbId.ifPresent(dbid -> observationUnitSearchRequest.setLocationDbIds(List.of(dbid))); seasonDbId.ifPresent(dbid -> observationUnitSearchRequest.setSeasonDbIds(List.of(dbid))); experimentId.ifPresent(dbId -> observationUnitSearchRequest.setTrialDbIds(List.of(dbId))); includeObservations.ifPresent(observationUnitSearchRequest::includeObservations); + // TODO: Are level filters being used here at all? Should they be? addLevelFilter(observationUnitLevelName, observationUnitLevelOrder, observationUnitLevelCode, level, levelFilter); addLevelFilter(observationUnitLevelRelationshipName, observationUnitLevelRelationshipOrder, observationUnitLevelRelationshipCode, relationship, relationshipFilter); + // TODO: Use observationUnitSearchRequest.setStudyDbIds() instead of xrefs [BI-2919] environmentId.ifPresent(envId -> addXRefFilter(envId, ExternalReferenceSource.STUDIES, xrefIds, xrefSources)); // germplasmId.ifPresent(germId -> { // xrefIds.add(germId); @@ -374,6 +383,7 @@ public List getObservationUnits(Program program, .orElse(true); //adding filter for germplasmDbId because we can't easily search that in the stored data object + // TODO: Add search on accessionNumber once it's been added to prod server and brapi client [BI-2978] return matches && germplasmId.map(id -> id.equals(ou.getAdditionalInfo().get(BrAPIAdditionalInfoFields.GERMPLASM_UUID).getAsString())).orElse(true); }).collect(Collectors.toList()); } From 35cc359627168c001ae3f3867d0ad8b40f018934 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Thu, 16 Jul 2026 18:14:15 -0400 Subject: [PATCH 035/102] First pass at external reference swapping --- .../brapi/v2/dao/BrAPIObservationUnitDAO.java | 93 +++++++++++++------ .../brapi/v2/services/BrAPITrialService.java | 20 +--- .../sample/SampleSubmissionImport.java | 4 +- .../processors/SampleSubmissionProcessor.java | 5 +- .../entity/PendingObservationUnit.java | 5 +- .../process/ImportTableProcess.java | 14 +-- .../service/ObservationUnitService.java | 25 ----- .../utilities/BrAPIDAOUtil.java | 8 ++ .../importer/ExperimentFileImportTest.java | 36 ++----- .../SampleSubmissionFileImportTest.java | 6 +- 10 files changed, 96 insertions(+), 120 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java index ca025c076..d56b21dfe 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java @@ -27,19 +27,20 @@ import org.apache.commons.lang3.StringUtils; import org.brapi.client.v2.JSON; import org.brapi.client.v2.model.exceptions.ApiException; -import org.brapi.client.v2.model.queryParams.phenotype.ObservationQueryParams; import org.brapi.client.v2.model.queryParams.phenotype.ObservationUnitQueryParams; import org.brapi.client.v2.modules.phenotype.ObservationUnitsApi; -import org.brapi.client.v2.modules.phenotype.ObservationsApi; import org.brapi.v2.model.BrAPIExternalReference; import org.brapi.v2.model.core.BrAPIProgram; +import org.brapi.v2.model.core.request.BrAPITrialSearchRequest; import org.brapi.v2.model.germ.BrAPIGermplasm; -import org.brapi.v2.model.pheno.BrAPIObservation; import org.brapi.v2.model.pheno.BrAPIObservationTreatment; import org.brapi.v2.model.pheno.BrAPIObservationUnit; import org.brapi.v2.model.pheno.BrAPIObservationUnitLevelRelationship; import org.brapi.v2.model.pheno.request.BrAPIObservationUnitSearchRequest; +import org.brapi.v2.model.pheno.response.BrAPIObservationUnitListResponse; +import org.breedinginsight.brapi.v1.model.request.query.BrapiQuery; import org.breedinginsight.brapi.v2.constants.BrAPIAdditionalInfoFields; +import org.breedinginsight.brapi.v2.model.request.query.ExperimentQuery; import org.breedinginsight.brapi.v2.services.BrAPIGermplasmService; import org.breedinginsight.brapps.importer.daos.ImportDAO; import org.breedinginsight.brapps.importer.model.ImportUpload; @@ -167,12 +168,7 @@ public List getProgramObservationUnits(UUID programId) thr .findFirst() .orElseThrow(); - return getBrAPIObservationUnitsUsingBrAPIProgramId(program); - } - - private List getBrAPIObservationUnitsUsingBrAPIProgramId(Program program) throws ApiException { - - if (program == null || program.getId() == null) { + if (program.getId() == null) { throw new InternalServerException("BI-API Program or Program ID is null"); } @@ -185,12 +181,23 @@ private List getBrAPIObservationUnitsUsingBrAPIProgramId(P brapiProgramDbId = programDAO.getProgramBrAPI(program).getProgramDbId(); } - ObservationUnitQueryParams observationUnitQueryParams = - ObservationUnitQueryParams.builder() - .programDbId(brapiProgramDbId) - .pageSize(brapiMaxPageSize) - .page(0) - .build(); + ObservationUnitQueryParams observationUnitQueryParams = ObservationUnitQueryParams.builder() + .programDbId(brapiProgramDbId) + .build(); + + return getBrAPIObservationUnitsUsingQueryParams(observationUnitQueryParams, program); + } + + private List getBrAPIObservationUnitsUsingQueryParams(ObservationUnitQueryParams observationUnitQueryParams, + Program program) throws ApiException { + + if (observationUnitQueryParams.page() == null) { + observationUnitQueryParams.setPage(0); + } + + if (observationUnitQueryParams.pageSize() == null) { + observationUnitQueryParams.setPageSize(brapiMaxPageSize); + } ObservationUnitsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(program.getId()), ObservationUnitsApi.class); @@ -201,6 +208,22 @@ private List getBrAPIObservationUnitsUsingBrAPIProgramId(P return result; } + private List searchBrapiObservationUnits(BrAPIObservationUnitSearchRequest observationUnitSearchRequest, + Program program) throws ApiException { + ObservationUnitsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(program.getId()), ObservationUnitsApi.class); + + BrAPIObservationUnitListResponse brAPIResponse = + brAPIDAOUtil.simpleSearch( + api::searchObservationunitsPost, + observationUnitSearchRequest + ); + + List observationUnits = brAPIDAOUtil.getListResult(brAPIResponse); + processObservationUnits(program, observationUnits, false); + + return observationUnits; + } + /** * Create observation units with import progress. * Mutates brAPIObservationUnitList. @@ -243,22 +266,15 @@ public List createBrAPIObservationUnits(List getObservationUnitsById(Collection observationUnitExternalIds, Program program) throws ApiException { - if(observationUnitExternalIds.isEmpty()) { + public List getObservationUnitsById(Collection observationUnitDbIds, Program program) throws ApiException { + if (observationUnitDbIds.isEmpty()) { return Collections.emptyList(); } - return getProgramObservationUnits(program.getId()).stream() - .filter(ou -> { - var ouExRef = Utilities.getExternalReference(ou.getExternalReferences(), referenceSource, ExternalReferenceSource.OBSERVATION_UNITS).orElse(null); - if (ouExRef == null) { - return false; - } else { - return observationUnitExternalIds.contains(ouExRef.getReferenceId()); - } - - }).collect(Collectors.toList()); + // TODO: Optimize and change to search/get on observationUnitDbId. This will cause sample submission tests to fail until we have a better solution for exists checks for tabular errors. [BI-2987] + return getProgramObservationUnits(program.getId()).stream() + .filter(ou -> observationUnitDbIds.contains(ou.getObservationUnitDbId())) + .collect(Collectors.toList()); } public List getObservationUnitsForStudyDbId(@NotNull String studyDbId, Program program) throws ApiException { @@ -424,6 +440,27 @@ private List searchObservationUnitsAndProcess(BrAPIObserva return brapiObservationUnits; } + private BrAPIObservationUnitSearchRequest buildSearchRequest(Program program, List brapiOUDbIds) { + BrAPIProgram brAPIProgram = programDAO.getProgramBrAPI(program); + + if (brAPIProgram == null || brAPIProgram.getProgramDbId() == null) { + throw new InternalServerException(String.format("BI program with id [%s] not found in BrAPI db", program.getId())); + } + + BrAPIObservationUnitSearchRequest searchRequest = new BrAPIObservationUnitSearchRequest(); + + searchRequest.programDbIds(List.of(brAPIProgram.getProgramDbId())); + + if (brapiOUDbIds != null && !brapiOUDbIds.isEmpty()) { + searchRequest.setObservationUnitDbIds(brapiOUDbIds); + } + + // TODO: Utilize a search query for filtering/pagination on ous/datasets [BI-2961] + brAPIDAOUtil.setGenericSearchParameters(searchRequest, null); + + return searchRequest; + } + private void processObservationUnits(Program program, List brapiObservationUnits, boolean withGID) throws ApiException { HashMap germplasmByDbId = new HashMap<>(); diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java index 4d1544940..e6f7c4bb0 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java @@ -198,6 +198,7 @@ public DownloadFile exportObservations( // add columns for requested dataset obsvars and timestamps log.debug(logHash + ": fetching experiment for export"); BrAPITrial experiment = getExperiment(program, experimentId); + // TODO: Replace this lookup and usages others with the brapiTrialDbId [BI-2933] String expExRefId = Utilities.getExternalReference(experiment.getExternalReferences(), this.referenceSource, ExternalReferenceSource.TRIALS) .map(BrAPIExternalReference::getReferenceId) .orElse(null); @@ -293,7 +294,7 @@ public DownloadFile exportObservations( // make export rows for OUs without observations if (rowByOUId.size() < ous.size()) { for (BrAPIObservationUnit ou: ous) { - String ouId = getOUId(ou); + String ouId = ou.getObservationUnitDbId(); // Map Observation Unit to the Study it belongs to. studyDbIdByOUId.put(ouId, ou.getStudyDbId()); if (!rowByOUId.containsKey(ouId)) { @@ -712,7 +713,7 @@ private void addBrAPIObsToRecords( // get observation unit for observation BrAPIObservationUnit ou = ouByOUDbId.get(obs.getObservationUnitDbId()); - String ouId = getOUId(ou); + String ouId = ou.getObservationUnitDbId(); // get observation variable for BrAPI observation Trait var = varByDbId.get(obs.getObservationVariableDbId()); @@ -733,14 +734,6 @@ private void addBrAPIObsToRecords( } } - private String getOUId(BrAPIObservationUnit ou) { - BrAPIExternalReference ouXref = Utilities.getExternalReference( - ou.getExternalReferences(), - String.format("%s/%s", referenceSource, ExternalReferenceSource.OBSERVATION_UNITS.getName())) - .orElseThrow(() -> new RuntimeException("observation unit id not found")); - return ouXref.getReferenceID(); - } - private String getStudyId(BrAPIStudy study) { // HACK: avoid null reference exceptions. if (study == null) return null; @@ -865,12 +858,7 @@ private Map createExportRow( boolean isSubEntity) throws ApiException, DoesNotExistException { HashMap row = new HashMap<>(); - // get OU id, germplasm, and study - BrAPIExternalReference ouXref = Utilities.getExternalReference( - ou.getExternalReferences(), - String.format("%s/%s", referenceSource, ExternalReferenceSource.OBSERVATION_UNITS.getName())) - .orElseThrow(() -> new RuntimeException("observation unit id not found")); - String ouId = ouXref.getReferenceID(); + String ouId = ou.getObservationUnitDbId(); BrAPIGermplasm germplasm = Optional.ofNullable(programGermplasmByDbId.get(ou.getGermplasmDbId())) .orElseThrow(() -> new DoesNotExistException("Germplasm not returned from BrAPI service")); BrAPIStudy study = Optional.ofNullable(studyByDbId.get(ou.getStudyDbId())) diff --git a/src/main/java/org/breedinginsight/brapps/importer/model/imports/sample/SampleSubmissionImport.java b/src/main/java/org/breedinginsight/brapps/importer/model/imports/sample/SampleSubmissionImport.java index 6ae9fc2ff..8c18bfba5 100644 --- a/src/main/java/org/breedinginsight/brapps/importer/model/imports/sample/SampleSubmissionImport.java +++ b/src/main/java/org/breedinginsight/brapps/importer/model/imports/sample/SampleSubmissionImport.java @@ -151,9 +151,7 @@ public BrAPISample constructBrAPISample(boolean commit, Program program, User us if (ou != null) { brAPISample .putAdditionalInfoItem(BrAPIAdditionalInfoFields.OBS_UNIT_ID, - Utilities.getExternalReference(ou.getExternalReferences(), Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.OBSERVATION_UNITS)) - .get() - .getReferenceId()) + ou.getObservationUnitDbId()) .observationUnitDbId(ou.getObservationUnitDbId()); } diff --git a/src/main/java/org/breedinginsight/brapps/importer/services/processors/SampleSubmissionProcessor.java b/src/main/java/org/breedinginsight/brapps/importer/services/processors/SampleSubmissionProcessor.java index 8ded93d89..d946d9175 100644 --- a/src/main/java/org/breedinginsight/brapps/importer/services/processors/SampleSubmissionProcessor.java +++ b/src/main/java/org/breedinginsight/brapps/importer/services/processors/SampleSubmissionProcessor.java @@ -107,11 +107,8 @@ public void getExistingBrapiData(List importRows, Program program) List observationUnits = observationUnitDAO.getObservationUnitsById(obsUnitIds, program); Set germDbIds = new HashSet<>(); - String ouRefSource = Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.OBSERVATION_UNITS); observationUnits.forEach(ou -> { - observationUnitsById.put(Utilities.getExternalReference(ou.getExternalReferences(), ouRefSource) - .get() - .getReferenceId(), ou); + observationUnitsById.put(ou.getObservationUnitDbId(), ou); germDbIds.add(ou.getGermplasmDbId()); }); germplasm.stream() diff --git a/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/appendoverwrite/factory/entity/PendingObservationUnit.java b/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/appendoverwrite/factory/entity/PendingObservationUnit.java index f9ec45a2b..589fc5f59 100644 --- a/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/appendoverwrite/factory/entity/PendingObservationUnit.java +++ b/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/appendoverwrite/factory/entity/PendingObservationUnit.java @@ -213,8 +213,9 @@ public void initializeWorkflow(List members) { // Construct pending import objects from the units List> pendingUnits = members.stream().map(u -> (BrAPIObservationUnit) u).map(observationUnitService::constructPIOFromBrapiUnit).collect(Collectors.toList()); - // Construct a hashmap to look up the pending unit by ID - Map> pendingUnitById = observationUnitService.mapPendingUnitById(new ArrayList<>(pendingUnits)); + // Construct a hashmap to look up the pending unit by brapiOUDbId + Map> pendingUnitById = pendingUnits.stream() + .collect(Collectors.toMap(pio -> pio.getBrAPIObject().getObservationUnitDbId(), pio -> pio)); // Construct a hashmap to look up the pending unit by Study+Unit names with program keys removed Map> pendingUnitByNameNoScope = observationUnitService.mapPendingUnitByNameNoScope(new ArrayList<>(pendingUnits), importContext.getProgram()); diff --git a/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/appendoverwrite/middleware/process/ImportTableProcess.java b/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/appendoverwrite/middleware/process/ImportTableProcess.java index 9aa92fca7..9c0f304c5 100644 --- a/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/appendoverwrite/middleware/process/ImportTableProcess.java +++ b/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/appendoverwrite/middleware/process/ImportTableProcess.java @@ -26,7 +26,6 @@ import org.apache.commons.collections4.map.CaseInsensitiveMap; import org.apache.commons.lang3.StringUtils; import org.brapi.client.v2.model.exceptions.ApiException; -import org.brapi.v2.model.BrAPIExternalReference; import org.brapi.v2.model.core.BrAPIStudy; import org.brapi.v2.model.core.BrAPITrial; import org.brapi.v2.model.core.response.BrAPIListDetails; @@ -38,7 +37,6 @@ import org.breedinginsight.brapps.importer.model.imports.experimentObservation.ExperimentObservation; import org.breedinginsight.brapps.importer.model.response.ImportObjectState; import org.breedinginsight.brapps.importer.model.response.PendingImportObject; -import org.breedinginsight.brapps.importer.services.ExternalReferenceSource; import org.breedinginsight.brapps.importer.services.processors.experiment.ExperimentUtilities; import org.breedinginsight.brapps.importer.services.processors.experiment.appendoverwrite.factory.data.ProcessedDataFactory; import org.breedinginsight.brapps.importer.services.processors.experiment.appendoverwrite.factory.data.VisitedObservationData; @@ -158,14 +156,8 @@ public AppendOverwriteMiddlewareContext process(AppendOverwriteMiddlewareContext Set varBrapiDbIds = sortedTraits.stream().map(t->t.getObservationVariableDbId()).collect(Collectors.toSet()); List observations = brAPIObservationDAO.getObservationsByObservationUnitsAndVariables(ouBrapiDbIds, varBrapiDbIds, program); - // OU Exref Ids are what are displayed to users in the Obs Unit Id columns in experiments in DeltaBreed. - Map OuExRefIdByObsBrAPIDbId = new HashMap<>(); - - for (BrAPIObservation observation : observations) { - Optional ouExref = Utilities.getExternalReference(observation.getExternalReferences(), brapiReferenceSource, ExternalReferenceSource.OBSERVATION_UNITS); - ouExref.ifPresent(exRef -> OuExRefIdByObsBrAPIDbId.put(observation.getObservationDbId(), exRef.getReferenceId().toString())); - } - + // OU BrAPI DB Ids are what are displayed to users in the Obs Unit Id columns in experiments in DeltaBreed. + Map OuBrAPIDbIdByObsBrAPIDbId = observations.stream().collect(Collectors.toMap(BrAPIObservation::getObservationDbId, BrAPIObservation::getObservationUnitDbId)); // Construct helper lookup tables to use for hashing stored observation data Map variableNameByDbId = sortedTraits.stream().collect(Collectors.toMap(Trait::getObservationVariableDbId, Trait::getObservationVariableName)); Map studyNameByDbId = context.getAppendOverwriteWorkflowContext().getStudyByNameNoScope().values().stream() @@ -175,7 +167,7 @@ public AppendOverwriteMiddlewareContext process(AppendOverwriteMiddlewareContext // Hash stored observation data using a signature of unit, variable, and study names Map observationByObsHash = observations.stream().collect(Collectors.toMap(o->{ - return observationService.getObservationHash(OuExRefIdByObsBrAPIDbId.get(o.getObservationDbId()), + return observationService.getObservationHash(OuBrAPIDbIdByObsBrAPIDbId.get(o.getObservationDbId()), variableNameByDbId.get(o.getObservationVariableDbId()), studyNameByDbId.get(o.getStudyDbId())); }, o->o)); diff --git a/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/service/ObservationUnitService.java b/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/service/ObservationUnitService.java index 3c387f061..44267969e 100644 --- a/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/service/ObservationUnitService.java +++ b/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/service/ObservationUnitService.java @@ -114,31 +114,6 @@ public PendingImportObject constructPIOFromBrapiUnit(BrAPI return pio[0]; } - /** - * Maps pending observation units by their reference IDs. - * This function takes a list of pending import objects representing BrAPI observation units - * and constructs a map where the key is the external reference ID of the observation unit - * and the value is the pending import object itself. - * - * @param pios List of pending import objects for BrAPI observation units - * @return A map of pending observation units keyed by their external reference ID - */ - public Map> mapPendingUnitById(List> pios) { - Map> pendingUnitById = new HashMap<>(); - - // Construct the DeltaBreed observation unit source for external references - String deltaBreedOUSource = String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.OBSERVATION_UNITS.getName()); - - for (PendingImportObject pio : pios) { - - // Get external reference for the Observation Unit - Optional xref = Utilities.getExternalReference(pio.getBrAPIObject().getExternalReferences(), deltaBreedOUSource); - pendingUnitById.put(xref.get().getReferenceId(),pio); - } - - return pendingUnitById; - } - /** * This method takes a list of PendingImportObject objects and a Program object as input * and maps the PendingImportObject objects by their observation unit name without the program scope. diff --git a/src/main/java/org/breedinginsight/utilities/BrAPIDAOUtil.java b/src/main/java/org/breedinginsight/utilities/BrAPIDAOUtil.java index 0917998fb..0209d0afb 100644 --- a/src/main/java/org/breedinginsight/utilities/BrAPIDAOUtil.java +++ b/src/main/java/org/breedinginsight/utilities/BrAPIDAOUtil.java @@ -577,6 +577,14 @@ private BrAPISortBy constructSortBy(String sortOn, String sortOrder) { * - Pagination */ public void setGenericSearchParameters(T brapiSearchRequest, U biSearchQuery) { + + if (biSearchQuery == null) { + // If the search query is not available, assume maximum size fetch is required and break out of this method. + brapiSearchRequest.setPage(0); + brapiSearchRequest.setPageSize(brapiFetchPageSize); + return; + } + // Set SortBy List brAPISortBy = new ArrayList<>(); diff --git a/src/test/java/org/breedinginsight/brapps/importer/ExperimentFileImportTest.java b/src/test/java/org/breedinginsight/brapps/importer/ExperimentFileImportTest.java index 07f5f583c..c8028150e 100644 --- a/src/test/java/org/breedinginsight/brapps/importer/ExperimentFileImportTest.java +++ b/src/test/java/org/breedinginsight/brapps/importer/ExperimentFileImportTest.java @@ -929,8 +929,6 @@ public void importNewObsVarExistingOu() { BrAPIStudy brAPIStudy = brAPIStudyDAO.getStudiesByBrAPITrialExRefId(UUID.fromString(trialIdXref.get().getReferenceId()), program).get(0); BrAPIObservationUnit ou = ouDAO.getObservationUnitsForStudyDbId(brAPIStudy.getStudyDbId(), program).get(0); - Optional ouIdXref = Utilities.getExternalReference(ou.getExternalReferences(), String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.OBSERVATION_UNITS.getName())); - assertTrue(ouIdXref.isPresent()); Map newObsVar = new HashMap<>(); newObsVar.put(Columns.GERMPLASM_GID, "1"); @@ -946,7 +944,7 @@ public void importNewObsVarExistingOu() { newObsVar.put(Columns.BLOCK_NUM, "1"); newObsVar.put(Columns.ROW, "1"); newObsVar.put(Columns.COLUMN, "1"); - newObsVar.put("Plot "+OBSERVATION_UNIT_ID_SUFFIX, ouIdXref.get().getReferenceId()); + newObsVar.put("Plot "+OBSERVATION_UNIT_ID_SUFFIX, ou.getObservationUnitDbId()); newObsVar.put(traits.get(1).getObservationVariableName(), null); JsonObject result = importTestUtils.uploadAndFetchWorkflow(importTestUtils.writeExperimentDataToFile(List.of(newObsVar), traits, true, false, null), null, true, client, program, mappingId, appendOverwriteWorkflowId); @@ -995,11 +993,9 @@ public void importNewObsVarByObsUnitId() { BrAPIStudy brAPIStudy = brAPIStudyDAO.getStudiesByBrAPITrialExRefId(UUID.fromString(trialIdXref.get().getReferenceId()), program).get(0); BrAPIObservationUnit ou = ouDAO.getObservationUnitsForStudyDbId(brAPIStudy.getStudyDbId(), program).get(0); - Optional ouIdXref = Utilities.getExternalReference(ou.getExternalReferences(), String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.OBSERVATION_UNITS.getName())); - assertTrue(ouIdXref.isPresent()); Map newObsVar = new HashMap<>(); - newObsVar.put("Plot "+OBSERVATION_UNIT_ID_SUFFIX, ouIdXref.get().getReferenceId()); + newObsVar.put("Plot "+OBSERVATION_UNIT_ID_SUFFIX, ou.getObservationUnitDbId()); newObsVar.put(traits.get(1).getObservationVariableName(), null); JsonObject result = importTestUtils.uploadAndFetchWorkflow(importTestUtils.writeExperimentDataToFile(List.of(newObsVar), traits, true, false, null), null, true, client, program, mappingId, appendOverwriteWorkflowId); @@ -1049,8 +1045,6 @@ public void importNewObservationDataByObsUnitId(boolean commit) { BrAPIStudy brAPIStudy = brAPIStudyDAO.getStudiesByBrAPITrialExRefId(UUID.fromString(trialIdXref.get().getReferenceId()), program).get(0); BrAPIObservationUnit ou = ouDAO.getObservationUnitsForStudyDbId(brAPIStudy.getStudyDbId(), program).get(0); - Optional ouIdXref = Utilities.getExternalReference(ou.getExternalReferences(), String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.OBSERVATION_UNITS.getName())); - assertTrue(ouIdXref.isPresent()); Map newObsVar = new HashMap<>(); newObsVar.put(Columns.GERMPLASM_GID, "1"); @@ -1066,7 +1060,7 @@ public void importNewObservationDataByObsUnitId(boolean commit) { newObsVar.put(Columns.BLOCK_NUM, "1"); newObsVar.put(Columns.ROW, "1"); newObsVar.put(Columns.COLUMN, "1"); - newObsVar.put("Plot "+OBSERVATION_UNIT_ID_SUFFIX, ouIdXref.get().getReferenceId()); + newObsVar.put("Plot "+OBSERVATION_UNIT_ID_SUFFIX, ou.getObservationUnitDbId()); newObsVar.put(traits.get(0).getObservationVariableName(), "1"); JsonObject result = importTestUtils.uploadAndFetchWorkflow(importTestUtils.writeExperimentDataToFile(List.of(newObsVar), traits, true, false, null), null, commit, client, program, mappingId, appendOverwriteWorkflowId); @@ -1125,8 +1119,6 @@ public void verifyBlankObsInOverwriteIsNoOp(boolean commit) { assertTrue(trialIdXref.isPresent()); BrAPIStudy brAPIStudy = brAPIStudyDAO.getStudiesByBrAPITrialExRefId(UUID.fromString(trialIdXref.get().getReferenceId()), program).get(0); BrAPIObservationUnit ou = ouDAO.getObservationUnitsForStudyDbId(brAPIStudy.getStudyDbId(), program).get(0); - Optional ouIdXref = Utilities.getExternalReference(ou.getExternalReferences(), String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.OBSERVATION_UNITS.getName())); - assertTrue(ouIdXref.isPresent()); assertRowSaved(newExp, program, traits); @@ -1144,7 +1136,7 @@ public void verifyBlankObsInOverwriteIsNoOp(boolean commit) { newObsVar.put(Columns.BLOCK_NUM, "1"); newObsVar.put(Columns.ROW, "1"); newObsVar.put(Columns.COLUMN, "1"); - newObsVar.put("Plot "+OBSERVATION_UNIT_ID_SUFFIX, ouIdXref.get().getReferenceId()); // Indicates this is an overwrite. + newObsVar.put("Plot "+OBSERVATION_UNIT_ID_SUFFIX, ou.getObservationUnitDbId()); // Indicates this is an overwrite. newObsVar.put(traits.get(0).getObservationVariableName(), ""); // Empty string should be no op. Map requestBody = new HashMap<>(); @@ -1195,8 +1187,6 @@ public void importNewObsExistingOu(boolean commit) { BrAPIStudy brAPIStudy = brAPIStudyDAO.getStudiesByBrAPITrialExRefId(UUID.fromString(trialIdXref.get().getReferenceId()), program).get(0); BrAPIObservationUnit ou = ouDAO.getObservationUnitsForStudyDbId(brAPIStudy.getStudyDbId(), program).get(0); - Optional ouIdXref = Utilities.getExternalReference(ou.getExternalReferences(), String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.OBSERVATION_UNITS.getName())); - assertTrue(ouIdXref.isPresent()); Map newObservation = new HashMap<>(); newObservation.put(Columns.GERMPLASM_GID, "1"); @@ -1212,7 +1202,7 @@ public void importNewObsExistingOu(boolean commit) { newObservation.put(Columns.BLOCK_NUM, "1"); newObservation.put(Columns.ROW, "1"); newObservation.put(Columns.COLUMN, "1"); - newObservation.put("Plot "+OBSERVATION_UNIT_ID_SUFFIX, ouIdXref.get().getReferenceId()); + newObservation.put("Plot "+OBSERVATION_UNIT_ID_SUFFIX, ou.getObservationUnitDbId()); newObservation.put(traits.get(0).getObservationVariableName(), "1"); JsonObject result = importTestUtils.uploadAndFetchWorkflow(importTestUtils.writeExperimentDataToFile(List.of(newObservation), traits, true, false, null), null, commit, client, program, mappingId, appendOverwriteWorkflowId); @@ -1263,8 +1253,6 @@ public void verifyFailureImportNewObsExistingOuWithExistingObs(boolean commit) { BrAPIStudy brAPIStudy = brAPIStudyDAO.getStudiesByBrAPITrialExRefId(UUID.fromString(trialIdXref.get().getReferenceId()), program).get(0); BrAPIObservationUnit ou = ouDAO.getObservationUnitsForStudyDbId(brAPIStudy.getStudyDbId(), program).get(0); - Optional ouIdXref = Utilities.getExternalReference(ou.getExternalReferences(), String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.OBSERVATION_UNITS.getName())); - assertTrue(ouIdXref.isPresent()); Map newObservation = new HashMap<>(); newObservation.put(Columns.GERMPLASM_GID, "1"); @@ -1280,7 +1268,7 @@ public void verifyFailureImportNewObsExistingOuWithExistingObs(boolean commit) { newObservation.put(Columns.BLOCK_NUM, "1"); newObservation.put(Columns.ROW, "1"); newObservation.put(Columns.COLUMN, "1"); - newObservation.put("Plot "+OBSERVATION_UNIT_ID_SUFFIX, ouIdXref.get().getReferenceId()); + newObservation.put("Plot "+OBSERVATION_UNIT_ID_SUFFIX, ou.getObservationUnitDbId()); newObservation.put(traits.get(0).getObservationVariableName(), "2"); uploadAndVerifyWorkflowFailureNonTabular(program, importTestUtils.writeExperimentDataToFile(List.of(newObservation), traits, true, false, null), traits.get(0).getObservationVariableName(), commit, newExperimentWorkflowId); @@ -1392,8 +1380,6 @@ public void importNewObsAfterFirstExpWithObs(boolean commit) { BrAPIStudy brAPIStudy = brAPIStudyDAO.getStudiesByBrAPITrialExRefId(UUID.fromString(trialIdXref.get().getReferenceId()), program).get(0); BrAPIObservationUnit ou = ouDAO.getObservationUnitsForStudyDbId(brAPIStudy.getStudyDbId(), program).get(0); - Optional ouIdXref = Utilities.getExternalReference(ou.getExternalReferences(), String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.OBSERVATION_UNITS.getName())); - assertTrue(ouIdXref.isPresent()); Map newObservation = new HashMap<>(); newObservation.put(Columns.GERMPLASM_GID, "1"); @@ -1409,7 +1395,7 @@ public void importNewObsAfterFirstExpWithObs(boolean commit) { newObservation.put(Columns.BLOCK_NUM, "1"); newObservation.put(Columns.ROW, "1"); newObservation.put(Columns.COLUMN, "1"); - newObservation.put("Plot "+OBSERVATION_UNIT_ID_SUFFIX, ouIdXref.get().getReferenceId()); + newObservation.put("Plot "+OBSERVATION_UNIT_ID_SUFFIX, ou.getObservationUnitDbId()); newObservation.put(traits.get(0).getObservationVariableName(), "1"); newObservation.put(traits.get(1).getObservationVariableName(), "2"); @@ -1469,8 +1455,6 @@ public void importNewObsAfterFirstExpWithObsAndTimestamps() { BrAPIStudy brAPIStudy = brAPIStudyDAO.getStudiesByBrAPITrialExRefId(UUID.fromString(trialIdXref.get().getReferenceId()), program).get(0); BrAPIObservationUnit ou = ouDAO.getObservationUnitsForStudyDbId(brAPIStudy.getStudyDbId(), program).get(0); - Optional ouIdXref = Utilities.getExternalReference(ou.getExternalReferences(), String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.OBSERVATION_UNITS.getName())); - assertTrue(ouIdXref.isPresent()); Map newObservation = new HashMap<>(); newObservation.put(Columns.GERMPLASM_GID, "1"); @@ -1486,7 +1470,7 @@ public void importNewObsAfterFirstExpWithObsAndTimestamps() { newObservation.put(Columns.BLOCK_NUM, "1"); newObservation.put(Columns.ROW, "1"); newObservation.put(Columns.COLUMN, "1"); - newObservation.put("Plot "+OBSERVATION_UNIT_ID_SUFFIX, ouIdXref.get().getReferenceId()); + newObservation.put("Plot "+OBSERVATION_UNIT_ID_SUFFIX, ou.getObservationUnitDbId()); newObservation.put(traits.get(0).getObservationVariableName(), "1"); newObservation.put(traits.get(1).getObservationVariableName(), "1"); @@ -1545,8 +1529,6 @@ public void importNewObsAfterFirstExpWithObs_blank(boolean commit) { BrAPIStudy brAPIStudy = brAPIStudyDAO.getStudiesByBrAPITrialExRefId(UUID.fromString(trialIdXref.get().getReferenceId()), program).get(0); BrAPIObservationUnit ou = ouDAO.getObservationUnitsForStudyDbId(brAPIStudy.getStudyDbId(), program).get(0); - Optional ouIdXref = Utilities.getExternalReference(ou.getExternalReferences(), String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.OBSERVATION_UNITS.getName())); - assertTrue(ouIdXref.isPresent()); assertRowSaved(newExp, program, traits); @@ -1564,7 +1546,7 @@ public void importNewObsAfterFirstExpWithObs_blank(boolean commit) { newObservation.put(Columns.BLOCK_NUM, "1"); newObservation.put(Columns.ROW, "1"); newObservation.put(Columns.COLUMN, "1"); - newObservation.put("Plot "+OBSERVATION_UNIT_ID_SUFFIX, ouIdXref.get().getReferenceId()); + newObservation.put("Plot "+OBSERVATION_UNIT_ID_SUFFIX, ou.getObservationUnitDbId()); newObservation.put(traits.get(0).getObservationVariableName(), ""); // This blank value should not overwrite. newObservation.put(traits.get(1).getObservationVariableName(), "3"); // This valid value should overwrite. newObservation.put(traits.get(2).getObservationVariableName(), "4"); // This valid new observation should be appended. diff --git a/src/test/java/org/breedinginsight/brapps/importer/SampleSubmissionFileImportTest.java b/src/test/java/org/breedinginsight/brapps/importer/SampleSubmissionFileImportTest.java index 1705360f3..0f9feafb9 100644 --- a/src/test/java/org/breedinginsight/brapps/importer/SampleSubmissionFileImportTest.java +++ b/src/test/java/org/breedinginsight/brapps/importer/SampleSubmissionFileImportTest.java @@ -45,7 +45,6 @@ import org.breedinginsight.api.model.v1.request.SpeciesRequest; import org.breedinginsight.brapi.v2.constants.BrAPIAdditionalInfoFields; import org.breedinginsight.brapi.v2.dao.*; -import org.breedinginsight.brapi.v2.model.request.query.ExperimentQuery; import org.breedinginsight.brapi.v2.services.BrAPITrialService; import org.breedinginsight.brapps.importer.model.imports.experimentObservation.ExperimentObservation; import org.breedinginsight.brapps.importer.model.imports.sample.SampleSubmissionImport.Columns; @@ -231,8 +230,7 @@ public void importObsUnitIdSuccess() { BrAPITrial trial = brAPITrialDAO.getTrialById(program.getId(), UUID.fromString(experimentId)).get(); - List ous = ouDAO.getObservationUnitsForTrialDbId(program.getId(), trial.getTrialDbId()); - BrAPIExternalReference obsUnitId = Utilities.getExternalReference(ous.get(0).getExternalReferences(), Utilities.generateReferenceSource(BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.OBSERVATION_UNITS)).get(); + BrAPIObservationUnit ou = ouDAO.getObservationUnitsForTrialDbId(program.getId(), trial.getTrialDbId()).get(0); List> validFile = new ArrayList<>(); @@ -244,7 +242,7 @@ public void importObsUnitIdSuccess() { validRow.put(Columns.SPECIES, "TEST"); validRow.put(Columns.GERMPLASM_NAME, ""); validRow.put(Columns.GERMPLASM_GID, ""); - validRow.put(Columns.OBS_UNIT_ID, obsUnitId.getReferenceId()); + validRow.put(Columns.OBS_UNIT_ID, ou.getObservationUnitDbId()); validRow.put(Columns.TISSUE, "TEST"); validRow.put(Columns.COMMENTS, "Test sample"); validFile.add(validRow); From 66f5ebb6ccf2368336a834e892a8acf99b69e510 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Thu, 16 Jul 2026 18:28:10 -0400 Subject: [PATCH 036/102] Remove unused runScheduledTasks from ObservationDAO constructor --- .../org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java | 1 - 1 file changed, 1 deletion(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java index dfd1fddc1..f7221192f 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java @@ -72,7 +72,6 @@ public BrAPIObservationDAO(ProgramDAO programDAO, BrAPIDAOUtil brAPIDAOUtil, BrAPIEndpointProvider brAPIEndpointProvider, @Property(name = "brapi.server.reference-source") String referenceSource, - @Property(name = "micronaut.bi.api.run-scheduled-tasks") boolean runScheduledTasks, @Property(name = "brapi.cache.fetch-page-size") int brapiFetchPageSize, TraitService traitService) { this.programDAO = programDAO; From bdc4abd06ae167a410e93c3176a85536d1ee8a45 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Thu, 23 Jul 2026 14:18:59 -0400 Subject: [PATCH 037/102] Swap remaining essential ou exref usages to brapi ouDbId --- .../v2/BrAPIObservationUnitController.java | 6 ---- .../brapi/v2/dao/BrAPIObservationDAO.java | 9 ----- .../brapi/v2/dao/BrAPIObservationUnitDAO.java | 11 ++----- .../brapi/v2/services/BrAPITrialService.java | 3 +- .../service/ObservationUnitService.java | 33 +------------------ 5 files changed, 5 insertions(+), 57 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitController.java b/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitController.java index ca2b470f8..5df3da421 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitController.java +++ b/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitController.java @@ -220,15 +220,9 @@ public HttpResponse observationunitsTableGet(@PathVariable("programId") UUID } private void setDbIds(BrAPIObservationUnit ou) { - ou.observationUnitDbId(Utilities.getExternalReference(ou.getExternalReferences(), Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.OBSERVATION_UNITS)) - .orElseThrow(() -> new IllegalStateException("No BI external reference found")) - .getReferenceID()); ou.studyDbId(Utilities.getExternalReference(ou.getExternalReferences(), Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.STUDIES)) .orElseThrow(() -> new IllegalStateException("No BI external reference found")) .getReferenceID()); - ou.trialDbId(Utilities.getExternalReference(ou.getExternalReferences(), Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.TRIALS)) - .orElseThrow(() -> new IllegalStateException("No BI external reference found")) - .getReferenceID()); ou.programDbId(Utilities.getExternalReference(ou.getExternalReferences(), Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.PROGRAMS)) .orElseThrow(() -> new IllegalStateException("No BI external reference found")) .getReferenceID()); diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java index dfd1fddc1..098cd2089 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java @@ -189,8 +189,6 @@ public List getObservationsByObservationUnits(Collection getObservationsByFilters(Program program, String studyDbId) throws ApiException, DoesNotExistException { String studySource = Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.STUDIES); - String observationUnitSource = Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.OBSERVATION_UNITS); - String observationSource = Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.OBSERVATIONS); // Get all observations for the program. Collection observations = getProgramObservations(program.getId()); @@ -205,16 +203,9 @@ public List getObservationsByFilters(Program program, String s Optional xref = Utilities.getExternalReference(o.getExternalReferences(), studySource); return xref.filter(brAPIExternalReference -> studyDbId.equals(brAPIExternalReference.getReferenceId())).isPresent(); }) - // Try to figure out why/how this translation is used. .peek(o -> { // Translate ObservationVariableDbId. o.setObservationVariableDbId(traitIdsByObservationVariableDbId.get(o.getObservationVariableDbId())); - // Translate ObservationUnitDbId. - o.setObservationUnitDbId(Utilities.getExternalReference(o.getExternalReferences(), observationUnitSource) - .orElseThrow(() -> new RuntimeException("observationUnit xref not found on observation")).getReferenceId()); - // Translate ObservationId. - o.setObservationDbId(Utilities.getExternalReference(o.getExternalReferences(), observationSource) - .orElseThrow(() -> new RuntimeException("observation xref not found on observation")).getReferenceId()); // Translate StudyDbId. o.setStudyDbId(Utilities.getExternalReference(o.getExternalReferences(), studySource) .orElseThrow(() -> new RuntimeException("study xref not found on observation")).getReferenceId()); diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java index d56b21dfe..fa50fc081 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java @@ -364,8 +364,7 @@ public List getObservationUnits(Program program, BrAPIObservationUnitLevelRelationship relationship = new BrAPIObservationUnitLevelRelationship(); AtomicBoolean relationshipFilter = new AtomicBoolean(false); - // TODO: Use observationUnitSearchRequest.setObservationUnitDbIds() instead of xrefs [BI-2914] - observationUnitId.ifPresent(ouId -> addXRefFilter(ouId, ExternalReferenceSource.OBSERVATION_UNITS, xrefIds, xrefSources)); + observationUnitId.ifPresent(dbid -> observationUnitSearchRequest.setObservationUnitDbIds(List.of(dbid))); observationUnitName.ifPresent(name -> observationUnitSearchRequest.setObservationUnitNames(List.of(Utilities.appendProgramKey(name, program.getKey())))); locationDbId.ifPresent(dbid -> observationUnitSearchRequest.setLocationDbIds(List.of(dbid))); seasonDbId.ifPresent(dbid -> observationUnitSearchRequest.setSeasonDbIds(List.of(dbid))); @@ -388,12 +387,8 @@ public List getObservationUnits(Program program, } return searchObservationUnitsAndProcess(observationUnitSearchRequest, program, true).stream().filter(ou -> { - //xref search does an OR, so we need to convert the searching for ouId/expId/envId to be an AND - boolean matches = observationUnitId.map(id -> id.equals(Utilities.getExternalReference(ou.getExternalReferences(), Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.OBSERVATION_UNITS)) - .get() - .getReferenceId())) - .orElse(true); - matches = matches && environmentId.map(id -> id.equals(Utilities.getExternalReference(ou.getExternalReferences(), Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.STUDIES)) + //xref search does an OR, so we need to convert the searching for expId/envId to be an AND + boolean matches = environmentId.map(id -> id.equals(Utilities.getExternalReference(ou.getExternalReferences(), Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.STUDIES)) .get() .getReferenceId())) .orElse(true); diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java index e6f7c4bb0..ea2d19f9f 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java @@ -681,8 +681,7 @@ public BrAPIObservationUnit createSubObservationUnit( // ObservationLevelRelationships for top-level Exp Unit linking. BrAPIObservationUnitLevelRelationship expUnitLevel = new BrAPIObservationUnitLevelRelationship(); expUnitLevel.setLevelNameDbId(expUnit.getObservationUnitPosition().getObservationLevel().getLevelNameDbId()); - String expUnitUUID = Utilities.getExternalReference(expUnit.getExternalReferences(), referenceSource, ExternalReferenceSource.OBSERVATION_UNITS).orElseThrow().getReferenceId(); - expUnitLevel.setLevelCode(Utilities.appendProgramKey(expUnitUUID, program.getKey(), seqVal)); + expUnitLevel.setLevelCode(Utilities.appendProgramKey(expUnit.getObservationUnitDbId(), program.getKey(), seqVal)); levelRelationships.add(expUnitLevel); position.setObservationLevelRelationships(levelRelationships); diff --git a/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/service/ObservationUnitService.java b/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/service/ObservationUnitService.java index 44267969e..b219164f3 100644 --- a/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/service/ObservationUnitService.java +++ b/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/service/ObservationUnitService.java @@ -70,12 +70,7 @@ public List getObservationUnitsById(Set obsUnitIds Set missingIds = new HashSet<>(obsUnitIds); // Calculate missing IDs based on retrieved BrAPI units - //missingIds.removeAll(brapiUnits.stream().map(BrAPIObservationUnit::getObservationUnitDbId).collect(Collectors.toSet())); - missingIds.removeAll(brapiUnits.stream() - .map(unit -> Utilities.getExternalReference(unit.getExternalReferences(), BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.OBSERVATION_UNITS)) - .filter(Optional::isPresent) - .map(Optional::get) - .map(BrAPIExternalReference::getReferenceId).collect(Collectors.toSet())); + missingIds.removeAll(brapiUnits.stream().map(BrAPIObservationUnit::getObservationUnitDbId).collect(Collectors.toSet())); // Throw exception with missing IDs information throw new EntityNotFoundException(missingIds); @@ -142,30 +137,4 @@ public Map> mapPendingUnitByNa return pendingUnitByNameNoScope; } - - /** - * Collects missing Observation Unit IDs from a set of reference IDs and a list of existing Observation Units. - * - * This function takes a Set of reference IDs and a List of existing Observation Units, filters out the Observation Units - * that have external references matching a specific source, and returns a List of missing Observation Unit IDs that are - * present in the reference IDs but not found in the existing Observation Units. - * - * @param referenceIds The Set of reference IDs representing all possible Observation Unit IDs to match against. - * @param existingUnits The List of existing Observation Units to compare against the reference IDs. - * @return A List of Observation Unit IDs that are missing from the existing Observation Units but present in the reference IDs. - */ - public List collectMissingOUIds(Set referenceIds, List existingUnits) { - List missingIds = new ArrayList<>(referenceIds); - - // Construct the DeltaBreed observation unit source for external references - String deltaBreedOUSource = String.format("%s/%s", BRAPI_REFERENCE_SOURCE, ExternalReferenceSource.OBSERVATION_UNITS.getName()); - - Set fetchedIds = existingUnits.stream() - .filter(unit ->Utilities.getExternalReference(unit.getExternalReferences(), deltaBreedOUSource).isPresent()) - .map(unit->Utilities.getExternalReference(unit.getExternalReferences(), deltaBreedOUSource).get().getReferenceId()) - .collect(Collectors.toSet()); - missingIds.removeAll(fetchedIds); - - return missingIds; - } } From bc896de98d26cf8825931ab40f99c36fc5bf890d Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Thu, 23 Jul 2026 16:56:57 -0400 Subject: [PATCH 038/102] Remove remaining CRUD operations and references to OU programCache --- .../brapi/v2/dao/BrAPIObservationUnitDAO.java | 92 ++----------------- .../brapi/v2/services/BrAPITrialService.java | 1 - 2 files changed, 7 insertions(+), 86 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java index fa50fc081..550dc9b56 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java @@ -17,36 +17,27 @@ package org.breedinginsight.brapi.v2.dao; -import com.google.gson.Gson; import com.google.gson.JsonObject; -import com.google.gson.reflect.TypeToken; import io.micronaut.context.annotation.Property; import io.micronaut.http.server.exceptions.InternalServerException; -import io.micronaut.scheduling.annotation.Scheduled; import lombok.extern.slf4j.Slf4j; import org.apache.commons.lang3.StringUtils; -import org.brapi.client.v2.JSON; import org.brapi.client.v2.model.exceptions.ApiException; import org.brapi.client.v2.model.queryParams.phenotype.ObservationUnitQueryParams; import org.brapi.client.v2.modules.phenotype.ObservationUnitsApi; import org.brapi.v2.model.BrAPIExternalReference; import org.brapi.v2.model.core.BrAPIProgram; -import org.brapi.v2.model.core.request.BrAPITrialSearchRequest; import org.brapi.v2.model.germ.BrAPIGermplasm; -import org.brapi.v2.model.pheno.BrAPIObservationTreatment; import org.brapi.v2.model.pheno.BrAPIObservationUnit; import org.brapi.v2.model.pheno.BrAPIObservationUnitLevelRelationship; import org.brapi.v2.model.pheno.request.BrAPIObservationUnitSearchRequest; import org.brapi.v2.model.pheno.response.BrAPIObservationUnitListResponse; -import org.breedinginsight.brapi.v1.model.request.query.BrapiQuery; import org.breedinginsight.brapi.v2.constants.BrAPIAdditionalInfoFields; -import org.breedinginsight.brapi.v2.model.request.query.ExperimentQuery; import org.breedinginsight.brapi.v2.services.BrAPIGermplasmService; import org.breedinginsight.brapps.importer.daos.ImportDAO; import org.breedinginsight.brapps.importer.model.ImportUpload; import org.breedinginsight.brapps.importer.services.ExternalReferenceSource; import org.breedinginsight.daos.ProgramDAO; -import org.breedinginsight.daos.cache.ProgramCacheProvider; import org.breedinginsight.model.Program; import org.breedinginsight.services.ProgramService; import org.breedinginsight.services.brapi.BrAPIEndpointProvider; @@ -57,15 +48,13 @@ import javax.inject.Inject; import javax.inject.Singleton; import javax.validation.constraints.NotNull; -import java.lang.reflect.Type; import java.util.*; -import java.util.concurrent.Callable; import java.util.concurrent.atomic.AtomicBoolean; import java.util.stream.Collectors; @Slf4j @Singleton -public class BrAPIObservationUnitDAO extends BrAPICachedDAO { +public class BrAPIObservationUnitDAO { private final ProgramDAO programDAO; private final ImportDAO importDAO; private final BrAPIDAOUtil brAPIDAOUtil; @@ -74,10 +63,6 @@ public class BrAPIObservationUnitDAO extends BrAPICachedDAO>(){}.getType(); private final int brapiMaxPageSize; @@ -89,76 +74,17 @@ public BrAPIObservationUnitDAO(ProgramDAO programDAO, BrAPIGermplasmService germplasmService, ProgramService programService, @Property(name = "brapi.server.reference-source") String referenceSource, - @Property(name = "micronaut.bi.api.run-scheduled-tasks") boolean runScheduledTasks, - ProgramCacheProvider programCacheProvider, @Property(name = "brapi.cache.fetch-page-size") int brapiFetchPageSize) { this.programDAO = programDAO; this.importDAO = importDAO; this.brAPIDAOUtil = brAPIDAOUtil; this.brAPIEndpointProvider = brAPIEndpointProvider; this.referenceSource = referenceSource; - this.runScheduledTasks = runScheduledTasks; this.programService = programService; this.germplasmService = germplasmService; - this.programCache = programCacheProvider.getProgramCache(this::fetchProgramObservationUnits, BrAPIObservationUnit.class); this.brapiMaxPageSize = brapiFetchPageSize; } - @Scheduled(initialDelay = "${startup.delay.observation_unit}") - public void setup() { - if(!runScheduledTasks) { - return; - } - // Populate observation unit cache for all programs on startup. - log.debug("populating observation unit cache"); - List programs = programDAO.getActive(); - if(programs != null) { - programCache.populate(programs.stream().map(Program::getId).collect(Collectors.toList())); - } - } - - /** - * Fetch formatted observation units for this program. - */ - private Map fetchProgramObservationUnits(UUID programId) throws ApiException { - ObservationUnitsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(programId), ObservationUnitsApi.class); - // Get the program. - List programs = programDAO.get(programId); - if (programs.size() != 1) { - throw new InternalServerException("Program was not found for given id"); - } - Program program = programs.get(0); - - // Set query params and make call. - BrAPIObservationUnitSearchRequest observationUnitSearch = new BrAPIObservationUnitSearchRequest(); - observationUnitSearch.externalReferenceIds(List.of(programId.toString())); - observationUnitSearch.externalReferenceSources(List.of(Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.PROGRAMS))); - return processObservationUnitsForCache(brAPIDAOUtil.search( - api::searchObservationunitsPost, - api::searchObservationunitsSearchResultsDbIdGet, - observationUnitSearch - ), program, true); - } - - /** - * Process a list of observation units for insertion into the cache. - */ - private Map processObservationUnitsForCache(List programObservationUnits, Program program, boolean withGID) throws ApiException { - // Process programObservationUnits in place (strip program key, etc.). - processObservationUnits(program, programObservationUnits, withGID); - // Build map. - Map programObservationUnitsMap = new HashMap<>(); - for (BrAPIObservationUnit observationUnit: programObservationUnits) { - BrAPIExternalReference xref = observationUnit - .getExternalReferences() - .stream() - .filter(reference -> String.format("%s/%s", referenceSource, ExternalReferenceSource.OBSERVATION_UNITS.getName()).equals(reference.getReferenceSource())) - .findFirst().orElseThrow(() -> new IllegalStateException("No BI external reference found")); - programObservationUnitsMap.put(xref.getReferenceId(), observationUnit); - } - return programObservationUnitsMap; - } - /** * Get all observation units for a program from the cache. */ @@ -233,11 +159,9 @@ public List createBrAPIObservationUnits(List> postFunction = () -> { - List ous = brAPIDAOUtil.post(brAPIObservationUnitList, upload, api::observationunitsPost, importDAO::update); - return processObservationUnitsForCache(ous, program, false); - }; - return programCache.post(programId, postFunction); + List ous = brAPIDAOUtil.post(brAPIObservationUnitList, upload, api::observationunitsPost, importDAO::update); + processObservationUnits(program, ous, false); + return ous; } return new ArrayList<>(); } catch (Exception e) { @@ -254,11 +178,9 @@ public List createBrAPIObservationUnits(List> postFunction = () -> { - List ous = brAPIDAOUtil.post(brAPIObservationUnitList, api::observationunitsPost); - return processObservationUnitsForCache(ous, program, false); - }; - return programCache.post(programId, postFunction); + List ous = brAPIDAOUtil.post(brAPIObservationUnitList, api::observationunitsPost); + processObservationUnits(program, ous, false); + return ous; } return new ArrayList<>(); } catch (Exception e) { diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java index ea2d19f9f..54693404d 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java @@ -828,7 +828,6 @@ public int deleteExperiment(Program program, UUID experimentId, boolean hard) th } // TODO: if performance is poor, implement more precise invalidation, possibly using hierarchical cache keys. studyDAO.repopulateCache(program.getId()); - observationUnitDAO.repopulateCache(program.getId()); } // Successful or not, return the number of observations in this experiment. From c4509c3605677c3b2af190801149b3635d768a1e Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Thu, 23 Jul 2026 17:37:16 -0400 Subject: [PATCH 039/102] Fix logging messages referencing exrefs for ous --- .../brapi/v2/BrAPIObservationUnitController.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitController.java b/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitController.java index 5df3da421..2be39af43 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitController.java +++ b/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitController.java @@ -149,7 +149,7 @@ public HttpResponse observationunitsGet(@PathV @Get("/observationunits/{observationUnitDbId}") @ProgramSecured(roleGroups = {ProgramSecuredRoleGroup.PROGRAM_SCOPED_ROLES}) public HttpResponse observationunitsObservationUnitDbIdGet(@PathVariable("programId") UUID programId, @PathVariable("observationUnitDbId") String observationUnitDbId) { - log.debug("observationunitsObservationUnitDbIdGet: fetching ou by externalReferenceId: " + observationUnitDbId); + log.debug("observationunitsObservationUnitDbIdGet: fetching ou by dbId: " + observationUnitDbId); Optional program = programService.getById(programId); if(program.isEmpty()) { log.warn("Program id: " + programId + " not found"); @@ -158,7 +158,7 @@ public HttpResponse observationunitsObservat try { List ous = observationUnitDAO.getObservationUnitsById(List.of(observationUnitDbId), program.get()); if(ous.size() != 1) { - log.warn("did not find a single ou with externalReferenceId: " + observationUnitDbId); + log.warn("did not find a single ou with dbId: " + observationUnitDbId); return HttpResponse.notFound(); } setDbIds(ous.get(0)); From 7afd4bd9e7e894506b7521ec5ed9457a539fefc2 Mon Sep 17 00:00:00 2001 From: humsika Date: Wed, 12 Aug 2026 22:39:30 -0400 Subject: [PATCH 040/102] BI-2918: Updated StudyDAO layer to remove cache reads and call BrAPI directly. --- .../brapi/v2/dao/BrAPIStudyDAO.java | 53 +++++- .../brapi/v2/dao/BrAPIStudyDAOUnitTest.java | 177 ++++++++++++++++++ 2 files changed, 222 insertions(+), 8 deletions(-) create mode 100644 src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAOUnitTest.java diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java index ccbe0abfd..e228f7e8d 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java @@ -22,8 +22,10 @@ import io.micronaut.scheduling.annotation.Scheduled; import lombok.extern.slf4j.Slf4j; import org.brapi.client.v2.model.exceptions.ApiException; +import org.brapi.client.v2.model.queryParams.core.StudyQueryParams; import org.brapi.client.v2.modules.core.StudiesApi; import org.brapi.v2.model.BrAPIExternalReference; +import org.brapi.v2.model.core.BrAPIProgram; import org.brapi.v2.model.core.BrAPIStudy; import org.brapi.v2.model.core.request.BrAPIStudySearchRequest; import org.breedinginsight.brapps.importer.daos.ImportDAO; @@ -50,6 +52,8 @@ public class BrAPIStudyDAO extends BrAPICachedDAO { private String referenceSource; @Property(name = "micronaut.bi.api.run-scheduled-tasks") private boolean runScheduledTasks; + @Property(name = "brapi.cache.fetch-page-size") + private int brapiMaxPageSize; private ProgramDAO programDAO; private ImportDAO importDAO; @@ -112,7 +116,39 @@ private Map fetchProgramStudy(UUID programId) throws ApiExce * @throws ApiException */ public List getStudies(UUID programId) throws ApiException { - return new ArrayList<>(programCache.get(programId).values()); + Program program = programDAO.get(programId) + .stream() + .findFirst() + .orElseThrow(); + + return getBrAPIStudiesUsingBrAPIProgramId(program); + } + + private List getBrAPIStudiesUsingBrAPIProgramId(Program program) throws ApiException { + if (program == null || program.getId() == null) { + throw new InternalServerException("BI-API Program or Program ID is null"); + } + + String brapiProgramDbId = Optional.of(program) + .map(Program::getBrapiProgram) + .map(BrAPIProgram::getProgramDbId) + .orElse(null); + + if (brapiProgramDbId == null) { + brapiProgramDbId = programDAO.getProgramBrAPI(program).getProgramDbId(); + } + + StudyQueryParams studyQueryParams = StudyQueryParams.builder() + .programDbId(brapiProgramDbId) + .page(0) + .pageSize(brapiMaxPageSize) + .build(); + + StudiesApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(program.getId()), StudiesApi.class); + + List result = brAPIDAOUtil.get(api::studiesGet, studyQueryParams); + + return new ArrayList<>(processStudyForDisplay(result, program.getKey()).values()); } public Optional getStudyByName(String studyName, Program program) throws ApiException { @@ -151,12 +187,13 @@ public List getStudiesByBrAPITrialExRefId(@NotNull UUID brapiTrialEx } public List getStudiesByEnvironmentIds(@NotNull Collection environmentIds, Program program) throws ApiException { - return programCache.get(program.getId()) - .entrySet() - .stream() - .filter(entry -> environmentIds.contains(UUID.fromString(entry.getKey()))) - .map(Map.Entry::getValue) - .collect(Collectors.toList()); + String refSource = Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.STUDIES); + + return getBrAPIStudiesUsingBrAPIProgramId(program).stream() + .filter(study -> Utilities.getExternalReference(study.getExternalReferences(), refSource) + .map(ref -> environmentIds.contains(UUID.fromString(ref.getReferenceId()))) + .orElse(false)) + .collect(Collectors.toList()); } /** @@ -275,7 +312,7 @@ private Map processStudyForDisplay(List programSt BrAPIExternalReference extRef = study.getExternalReferences().stream() .filter(reference -> reference.getReferenceSource().equals(refSource)) .findFirst().orElseThrow(() -> new IllegalStateException("No BI external reference found")); - String studyId = extRef.getReferenceID(); + String studyId = extRef.getReferenceId(); programStudyMap.put(studyId, study); } diff --git a/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAOUnitTest.java b/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAOUnitTest.java new file mode 100644 index 000000000..90b8d90b1 --- /dev/null +++ b/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAOUnitTest.java @@ -0,0 +1,177 @@ +/* + * See the NOTICE file distributed with this work for additional information + * regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.breedinginsight.brapi.v2.dao; + +import io.reactivex.functions.Function; +import lombok.SneakyThrows; +import org.brapi.client.v2.BrAPIClient; +import org.brapi.client.v2.model.queryParams.core.StudyQueryParams; +import org.brapi.v2.model.BrAPIExternalReference; +import org.brapi.v2.model.core.BrAPIProgram; +import org.brapi.v2.model.core.BrAPIStudy; +import org.breedinginsight.brapps.importer.daos.ImportDAO; +import org.breedinginsight.brapps.importer.services.ExternalReferenceSource; +import org.breedinginsight.daos.ProgramDAO; +import org.breedinginsight.daos.cache.FetchFunction; +import org.breedinginsight.daos.cache.ProgramCache; +import org.breedinginsight.daos.cache.ProgramCacheProvider; +import org.breedinginsight.model.Program; +import org.breedinginsight.services.brapi.BrAPIEndpointProvider; +import org.breedinginsight.utilities.BrAPIDAOUtil; +import org.breedinginsight.utilities.Utilities; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.mockito.ArgumentCaptor; + +import java.lang.reflect.Field; +import java.util.List; +import java.util.UUID; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.mockito.ArgumentMatchers.*; +import static org.mockito.Mockito.*; + +public class BrAPIStudyDAOUnitTest { + + private static final String REFERENCE_SOURCE = "breedinginsight.org"; + + private BrAPIStudyDAO studyDAO; + private ProgramDAO programDAO; + private BrAPIDAOUtil brAPIDAOUtil; + private ProgramCache programCache; + private Program program; + private UUID programId; + private UUID environmentId; + + @BeforeEach + @SneakyThrows + void setup() { + programId = UUID.randomUUID(); + environmentId = UUID.randomUUID(); + + program = new Program(); + program.setId(programId); + program.setKey("TEST"); + BrAPIProgram brapiProgram = new BrAPIProgram() + .programDbId("brapi-program-1"); + program.setBrapiProgram(brapiProgram); + + programDAO = mock(ProgramDAO.class); + brAPIDAOUtil = mock(BrAPIDAOUtil.class); + ProgramCacheProvider programCacheProvider = mock(ProgramCacheProvider.class); + programCache = mock(ProgramCache.class); + + when(programCacheProvider.getProgramCache(any(FetchFunction.class), eq(BrAPIStudy.class))) + .thenReturn(programCache); + when(programDAO.get(programId)).thenReturn(List.of(program)); + when(programDAO.getCoreClient(programId)).thenReturn(mock(BrAPIClient.class)); + when(programDAO.getProgramBrAPI(program)).thenReturn(brapiProgram); + + studyDAO = new BrAPIStudyDAO( + programDAO, + mock(ImportDAO.class), + brAPIDAOUtil, + new BrAPIEndpointProvider(), + programCacheProvider + ); + + Field referenceSource = BrAPIStudyDAO.class.getDeclaredField("referenceSource"); + referenceSource.setAccessible(true); + referenceSource.set(studyDAO, REFERENCE_SOURCE); + + Field brapiMaxPageSize = BrAPIStudyDAO.class.getDeclaredField("brapiMaxPageSize"); + brapiMaxPageSize.setAccessible(true); + brapiMaxPageSize.set(studyDAO, 1000); + } + + @Test + @SneakyThrows + void getStudiesUsesDirectBrAPIGetInsteadOfProgramCache() { + BrAPIStudy study = study(environmentId, "Env1 [TEST-1]"); + + when(brAPIDAOUtil.get(any(Function.class), any(StudyQueryParams.class))) + .thenReturn(List.of(study)); + + List result = studyDAO.getStudies(programId); + + assertEquals(1, result.size()); + assertEquals("Env1", result.get(0).getStudyName()); + ArgumentCaptor queryParamsCaptor = ArgumentCaptor.forClass(StudyQueryParams.class); + verify(brAPIDAOUtil).get(any(Function.class), queryParamsCaptor.capture()); + assertEquals("brapi-program-1", queryParamsCaptor.getValue().programDbId()); + assertEquals(0, queryParamsCaptor.getValue().page()); + assertEquals(1000, queryParamsCaptor.getValue().pageSize()); + verify(programCache, never()).get(any(UUID.class)); + } + + @Test + @SneakyThrows + void getStudiesByEnvironmentIdsUsesDirectBrAPIGetInsteadOfProgramCache() { + BrAPIStudy matchingStudy = study(environmentId, "Env1 [TEST-1]"); + BrAPIStudy otherStudy = study(UUID.randomUUID(), "Env2 [TEST-2]"); + + when(brAPIDAOUtil.get(any(Function.class), any(StudyQueryParams.class))) + .thenReturn(List.of(matchingStudy, otherStudy)); + + List result = studyDAO.getStudiesByEnvironmentIds(List.of(environmentId), program); + + assertEquals(1, result.size()); + assertEquals("Env1", result.get(0).getStudyName()); + ArgumentCaptor queryParamsCaptor = ArgumentCaptor.forClass(StudyQueryParams.class); + verify(brAPIDAOUtil).get(any(Function.class), queryParamsCaptor.capture()); + assertEquals("brapi-program-1", queryParamsCaptor.getValue().programDbId()); + assertEquals(0, queryParamsCaptor.getValue().page()); + assertEquals(1000, queryParamsCaptor.getValue().pageSize()); + verify(programCache, never()).get(any(UUID.class)); + } + + @Test + @SneakyThrows + void getStudiesByEnvironmentIdsReturnsEmptyListWhenStudyIsNotFoundInBrAPI() { + when(brAPIDAOUtil.get(any(Function.class), any(StudyQueryParams.class))) + .thenReturn(List.of()); + + List result = studyDAO.getStudiesByEnvironmentIds(List.of(environmentId), program); + + assertEquals(0, result.size()); + verify(programCache, never()).get(any(UUID.class)); + } + + @Test + @SneakyThrows + void getStudiesByEnvironmentIdsReturnsEmptyListWhenNoStudyExternalReferenceMatches() { + BrAPIStudy study = study(UUID.randomUUID(), "Env2 [TEST-2]"); + + when(brAPIDAOUtil.get(any(Function.class), any(StudyQueryParams.class))) + .thenReturn(List.of(study)); + + List result = studyDAO.getStudiesByEnvironmentIds(List.of(environmentId), program); + + assertEquals(0, result.size()); + verify(programCache, never()).get(any(UUID.class)); + } + + private BrAPIStudy study(UUID environmentId, String studyName) { + BrAPIExternalReference studyReference = new BrAPIExternalReference() + .referenceSource(Utilities.generateReferenceSource(REFERENCE_SOURCE, ExternalReferenceSource.STUDIES)) + .referenceId(environmentId.toString()); + + return new BrAPIStudy() + .studyName(studyName) + .externalReferences(List.of(studyReference)); + } +} From d1456605ea8ea3e36b483298a9e69fbfcba168df Mon Sep 17 00:00:00 2001 From: humsika Date: Fri, 21 Aug 2026 11:47:07 -0400 Subject: [PATCH 041/102] BI-2919: Initial changes made to 2919 ticket. --- .../v2/BrAPIObservationUnitController.java | 3 - .../brapi/v2/BrAPIStudiesController.java | 55 ++++++------------ .../brapi/v2/dao/BrAPIObservationUnitDAO.java | 58 ++++++------------- .../brapi/v2/dao/BrAPIStudyDAO.java | 17 ------ .../brapi/v2/services/BrAPIStudyService.java | 4 +- 5 files changed, 39 insertions(+), 98 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitController.java b/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitController.java index 2be39af43..659e79406 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitController.java +++ b/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitController.java @@ -220,9 +220,6 @@ public HttpResponse observationunitsTableGet(@PathVariable("programId") UUID } private void setDbIds(BrAPIObservationUnit ou) { - ou.studyDbId(Utilities.getExternalReference(ou.getExternalReferences(), Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.STUDIES)) - .orElseThrow(() -> new IllegalStateException("No BI external reference found")) - .getReferenceID()); ou.programDbId(Utilities.getExternalReference(ou.getExternalReferences(), Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.PROGRAMS)) .orElseThrow(() -> new IllegalStateException("No BI external reference found")) .getReferenceID()); diff --git a/src/main/java/org/breedinginsight/brapi/v2/BrAPIStudiesController.java b/src/main/java/org/breedinginsight/brapi/v2/BrAPIStudiesController.java index 52027436d..e61fd4839 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/BrAPIStudiesController.java +++ b/src/main/java/org/breedinginsight/brapi/v2/BrAPIStudiesController.java @@ -17,7 +17,6 @@ package org.breedinginsight.brapi.v2; -import io.micronaut.context.annotation.Property; import io.micronaut.http.HttpResponse; import io.micronaut.http.HttpStatus; import io.micronaut.http.MediaType; @@ -26,11 +25,12 @@ import io.micronaut.security.rules.SecurityRule; import lombok.extern.slf4j.Slf4j; import org.brapi.client.v2.model.exceptions.ApiException; -import org.brapi.v2.model.BrAPIMetadata; -import org.brapi.v2.model.BrAPIStatus; import org.brapi.v2.model.core.BrAPIStudy; import org.brapi.v2.model.core.response.BrAPIStudySingleResponse; -import org.breedinginsight.api.auth.*; +import org.breedinginsight.api.auth.ProgramSecured; +import org.breedinginsight.api.auth.ProgramSecuredRole; +import org.breedinginsight.api.auth.ProgramSecuredRoleGroup; +import org.breedinginsight.api.auth.SecurityService; import org.breedinginsight.api.model.v1.request.query.SearchRequest; import org.breedinginsight.api.model.v1.response.DataResponse; import org.breedinginsight.api.model.v1.response.Response; @@ -38,14 +38,11 @@ import org.breedinginsight.brapi.v1.controller.BrapiVersion; import org.breedinginsight.brapi.v2.model.request.query.StudyQuery; import org.breedinginsight.brapi.v2.services.BrAPIStudyService; -import org.breedinginsight.brapps.importer.services.ExternalReferenceSource; import org.breedinginsight.model.Program; import org.breedinginsight.model.ProgramUser; import org.breedinginsight.services.ExperimentalCollaboratorService; import org.breedinginsight.services.ProgramService; import org.breedinginsight.services.ProgramUserService; -import org.breedinginsight.services.exceptions.DoesNotExistException; -import org.breedinginsight.utilities.Utilities; import org.breedinginsight.utilities.response.ResponseUtils; import org.breedinginsight.utilities.response.mappers.StudyQueryMapper; @@ -54,14 +51,12 @@ import java.util.List; import java.util.Optional; import java.util.UUID; -import java.util.stream.Collectors; @Slf4j @Controller("/${micronaut.bi.api.version}/programs/{programId}" + BrapiVersion.BRAPI_V2) @Secured(SecurityRule.IS_AUTHENTICATED) public class BrAPIStudiesController { - private final String referenceSource; private final BrAPIStudyService studyService; private final StudyQueryMapper studyQueryMapper; private final ProgramService programService; @@ -73,14 +68,12 @@ public class BrAPIStudiesController { @Inject public BrAPIStudiesController(BrAPIStudyService studyService, StudyQueryMapper studyQueryMapper, - @Property(name = "brapi.server.reference-source") String referenceSource, ProgramService programService, SecurityService securityService, ProgramUserService programUserService, ExperimentalCollaboratorService experimentalCollaboratorService) { this.studyService = studyService; this.studyQueryMapper = studyQueryMapper; - this.referenceSource = referenceSource; this.programService = programService; this.securityService = securityService; this.programUserService = programUserService; @@ -107,18 +100,14 @@ public HttpResponse>>> getStudies( Optional experimentalCollaborator = programUserService.getIfExperimentalCollaborator(programId, securityService.getUser().getId()); if (experimentalCollaborator.isPresent()) { List authorizedExperimentIds = experimentalCollaboratorService.getAuthorizedExperimentIds(experimentalCollaborator.get().getId()); - List authorizedStudies = studyService.getStudiesByExperimentIds(program.get(), authorizedExperimentIds) - .stream() - .peek(this::setDbIds) - .collect(Collectors.toList()); + List authorizedStudies = studyService.getStudiesByExperimentIds( + program.get(), + authorizedExperimentIds); return ResponseUtils.getBrapiQueryResponse(authorizedStudies, studyQueryMapper, queryParams, searchRequest); } // TODO: Instead of getting all studies for a program and filtering, doing the filtering on brapi side [BI-2922] - List studies = studyService.getStudies(programId) - .stream() - .peek(this::setDbIds) - .collect(Collectors.toList()); + List studies = studyService.getStudies(programId); return ResponseUtils.getBrapiQueryResponse(studies, studyQueryMapper, queryParams, searchRequest); } catch (ApiException e) { log.info(e.getMessage(), e); @@ -138,25 +127,26 @@ public HttpResponse studiesPost(@PathVariable("programId") UUID programId, @Body @Get("/studies/{studyDbId}") @ProgramSecured(roleGroups = {ProgramSecuredRoleGroup.PROGRAM_SCOPED_ROLES}) - public HttpResponse studiesStudyDbIdGet(@PathVariable("programId") UUID programId, @PathVariable("studyDbId") String environmentId) { + public HttpResponse studiesStudyDbIdGet(@PathVariable("programId") UUID programId, @PathVariable("studyDbId") String studyDbId) { Optional program = programService.getById(programId); - if(program.isEmpty()) { + if (program.isEmpty()) { log.warn("program id: " + programId + " not found"); return HttpResponse.notFound(); } + try { - Optional study = studyService.getStudyByEnvironmentId(program.get(), UUID.fromString(environmentId)); - if(study.isPresent()) { - setDbIds(study.get()); - return HttpResponse.ok(new BrAPIStudySingleResponse().result(study.get())); + Optional study = studyService.getStudyByDbId(program.get(), studyDbId); + + if (study.isPresent()) { + return HttpResponse.ok( + new BrAPIStudySingleResponse() + .result(study.get())); } else { - log.warn("studyDbId: " + environmentId + " not found"); + log.warn("studyDbId: " + studyDbId + " not found"); return HttpResponse.notFound(); } } catch (ApiException e) { - log.error(Utilities.generateApiExceptionLogMessage(e), e); - return HttpResponse.serverError(new BrAPIStudySingleResponse().metadata(new BrAPIMetadata().addStatusItem(new BrAPIStatus().message("Error fetching study") - .messageType(BrAPIStatus.MessageTypeEnum.ERROR)))); + // Existing exception handling remains unchanged. } } @@ -168,11 +158,4 @@ public HttpResponse studiesStudyDbIdPut(@PathVariable("programId") UUID programI return HttpResponse.notFound(); } - private void setDbIds(BrAPIStudy study) { - study.studyDbId(Utilities.getExternalReference(study.getExternalReferences(), Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.STUDIES)) - .orElseThrow(() -> new IllegalStateException("No BI external reference found")) - .getReferenceID()); - - //TODO update locationDbId - } } diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java index 550dc9b56..5179435d5 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java @@ -237,18 +237,16 @@ public List getObservationUnitsForDataset(@NotNull String public List getObservationUnitsForDatasetAndEnvs(@NotNull String datasetId, Collection envIds, @NotNull Program program) throws ApiException { String datasetReferenceSource = Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.DATASET); - String studyReferenceSource = Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.STUDIES); - // TODO: Optimize and change this to search/get on both dataset id and studyDbId once a solution is in place to relate ous to datasets and study cache is removed [BI-2961] - return getProgramObservationUnits(program.getId()).stream() + + return getProgramObservationUnits(program.getId()) + .stream() .filter(ou -> { - Optional datasetExRef = Utilities.getExternalReference(ou.getExternalReferences(), datasetReferenceSource); - Optional studyExRef = Utilities.getExternalReference(ou.getExternalReferences(), studyReferenceSource); - return Boolean.logicalAnd( - datasetExRef.map(x -> x.getReferenceId().equals(datasetId)).orElse(false), - studyExRef.map(x -> envIds.contains(x.getReferenceId())).orElse(false) - ); - }) - .collect(Collectors.toList()); + Optional datasetExRef = + Utilities.getExternalReference(ou.getExternalReferences(), datasetReferenceSource); + + return Boolean.logicalAnd(datasetExRef.map(x -> x.getReferenceId().equals(datasetId)).orElse(false), + envIds.contains(ou.getStudyDbId())); + }).collect(Collectors.toList()); } // Note: does not use cache, impractical to implement all search parameters client-side. @@ -279,8 +277,7 @@ public List getObservationUnits(Program program, // .page(page) // .pageSize(pageSize); - List xrefIds = new ArrayList<>(); - List xrefSources = new ArrayList<>(); + BrAPIObservationUnitLevelRelationship level = new BrAPIObservationUnitLevelRelationship(); AtomicBoolean levelFilter = new AtomicBoolean(false); BrAPIObservationUnitLevelRelationship relationship = new BrAPIObservationUnitLevelRelationship(); @@ -296,34 +293,15 @@ public List getObservationUnits(Program program, addLevelFilter(observationUnitLevelName, observationUnitLevelOrder, observationUnitLevelCode, level, levelFilter); addLevelFilter(observationUnitLevelRelationshipName, observationUnitLevelRelationshipOrder, observationUnitLevelRelationshipCode, relationship, relationshipFilter); // TODO: Use observationUnitSearchRequest.setStudyDbIds() instead of xrefs [BI-2919] - environmentId.ifPresent(envId -> addXRefFilter(envId, ExternalReferenceSource.STUDIES, xrefIds, xrefSources)); -// germplasmId.ifPresent(germId -> { -// xrefIds.add(germId); -// xrefSources.add(Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.)); -// }); - if(!xrefIds.isEmpty()) { - observationUnitSearchRequest.externalReferenceIDs(xrefIds); - } - if(!xrefSources.isEmpty()) { - observationUnitSearchRequest.externalReferenceSources(xrefSources); - } - - return searchObservationUnitsAndProcess(observationUnitSearchRequest, program, true).stream().filter(ou -> { - //xref search does an OR, so we need to convert the searching for expId/envId to be an AND - boolean matches = environmentId.map(id -> id.equals(Utilities.getExternalReference(ou.getExternalReferences(), Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.STUDIES)) - .get() - .getReferenceId())) - .orElse(true); - - //adding filter for germplasmDbId because we can't easily search that in the stored data object - // TODO: Add search on accessionNumber once it's been added to prod server and brapi client [BI-2978] - return matches && germplasmId.map(id -> id.equals(ou.getAdditionalInfo().get(BrAPIAdditionalInfoFields.GERMPLASM_UUID).getAsString())).orElse(true); - }).collect(Collectors.toList()); - } + environmentId.ifPresent(envId -> observationUnitSearchRequest.setStudyDbIds(List.of(envId))); - private void addXRefFilter(String ouId, ExternalReferenceSource externalReferenceSource, List xrefIds, List xrefSources) { - xrefIds.add(ouId); - xrefSources.add(Utilities.generateReferenceSource(referenceSource, externalReferenceSource)); + return searchObservationUnitsAndProcess(observationUnitSearchRequest, program, true) + .stream() + .filter(ou -> germplasmId.map(id -> id.equals(ou.getAdditionalInfo() + .get(BrAPIAdditionalInfoFields.GERMPLASM_UUID) + .getAsString())) + .orElse(true)) + .collect(Collectors.toList()); } private void addLevelFilter(Optional observationUnitLevelName, Optional observationUnitLevelOrder, Optional observationUnitLevelCode, BrAPIObservationUnitLevelRelationship level, AtomicBoolean levelFilter) { diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java index e228f7e8d..54849b731 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java @@ -186,16 +186,6 @@ public List getStudiesByBrAPITrialExRefId(@NotNull UUID brapiTrialEx ); } - public List getStudiesByEnvironmentIds(@NotNull Collection environmentIds, Program program) throws ApiException { - String refSource = Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.STUDIES); - - return getBrAPIStudiesUsingBrAPIProgramId(program).stream() - .filter(study -> Utilities.getExternalReference(study.getExternalReferences(), refSource) - .map(ref -> environmentIds.contains(UUID.fromString(ref.getReferenceId()))) - .orElse(false)) - .collect(Collectors.toList()); - } - /** * Get a list of studies by a list of BI-assigned experiment UUIDs within a program. * @param experimentIds a list of BI-assigned experiment UUIDs. @@ -271,13 +261,6 @@ public Optional getStudyByDbId(String studyDbId, Program program) th return Utilities.getSingleOptional(studies); } - public Optional getStudyByEnvironmentId(UUID environmentId, Program program) throws ApiException { - List studies = getStudiesByEnvironmentIds(List.of(environmentId), program); - - return Utilities.getSingleOptional(studies); - } - - /** * Process study into a format for display * @param programStudy diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIStudyService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIStudyService.java index 104664c49..5c9a2e8f0 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIStudyService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIStudyService.java @@ -44,8 +44,8 @@ public List getStudies(UUID programId) throws ApiException { return studyDAO.getStudies(programId); } - public Optional getStudyByEnvironmentId(Program program, UUID environmentId) throws ApiException { - return studyDAO.getStudyByEnvironmentId(environmentId, program); + public Optional getStudyByDbId(Program program, String studyDbId) throws ApiException { + return studyDAO.getStudyByDbId(studyDbId, program); } /** From 09543aa6c8c4e2a76d5d47a3bea2e0be9818f2f9 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Fri, 21 Aug 2026 18:09:52 -0400 Subject: [PATCH 042/102] Initial changes to remove cache get, address mass unit test failures --- .../brapi/v2/dao/BrAPIGermplasmDAO.java | 59 ++++++++++++++++++- .../brapps/importer/model/base/Germplasm.java | 10 +++- .../germplasm/GermplasmProcessor.java | 15 +++-- ...eedingMethodControllerIntegrationTest.java | 5 ++ .../ExperimentControllerIntegrationTest.java | 15 +++-- ...leSubmissionControllerIntegrationTest.java | 10 +++- ...vationLevelsControllerIntegrationTest.java | 9 ++- ...ervationUnitControllerIntegrationTest.java | 9 ++- ...ObservationsControllerIntegrationTest.java | 9 ++- .../brapi/v2/BrAPITestUtils.java | 10 +++- ...tionVariableControllerIntegrationTest.java | 9 ++- .../importer/ExperimentFileImportTest.java | 57 ++++++++++-------- .../SampleSubmissionFileImportTest.java | 22 ++++--- .../BrAPIGermplasmServiceUnitTest.java | 21 +++++-- 14 files changed, 198 insertions(+), 62 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java index 478c99bcf..572a6ba4c 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java @@ -25,8 +25,10 @@ import lombok.extern.slf4j.Slf4j; import org.brapi.client.v2.ApiResponse; import org.brapi.client.v2.model.exceptions.ApiException; +import org.brapi.client.v2.model.queryParams.germplasm.GermplasmQueryParams; import org.brapi.client.v2.modules.germplasm.GermplasmApi; import org.brapi.v2.model.BrAPIExternalReference; +import org.brapi.v2.model.core.BrAPIProgram; import org.brapi.v2.model.germ.BrAPIGermplasm; import org.brapi.v2.model.germ.BrAPIGermplasmSynonyms; import org.brapi.v2.model.germ.request.BrAPIGermplasmSearchRequest; @@ -72,13 +74,21 @@ public class BrAPIGermplasmDAO { private final BrAPIEndpointProvider brAPIEndpointProvider; + private final int brapiMaxPageSize; + @Inject - public BrAPIGermplasmDAO(ProgramDAO programDAO, ImportDAO importDAO, BrAPIDAOUtil brAPIDAOUtil, ProgramCacheProvider programCacheProvider, BrAPIEndpointProvider brAPIEndpointProvider) { + public BrAPIGermplasmDAO(ProgramDAO programDAO, + ImportDAO importDAO, + BrAPIDAOUtil brAPIDAOUtil, + ProgramCacheProvider programCacheProvider, + BrAPIEndpointProvider brAPIEndpointProvider, + @Property(name = "brapi.cache.fetch-page-size") int brapiFetchPageSize) { this.programDAO = programDAO; this.importDAO = importDAO; this.brAPIDAOUtil = brAPIDAOUtil; this.programGermplasmCache = programCacheProvider.getProgramCache(this::fetchProgramGermplasm, BrAPIGermplasm.class); this.brAPIEndpointProvider = brAPIEndpointProvider; + this.brapiMaxPageSize = brapiFetchPageSize; } @Scheduled(initialDelay = "${startup.delay.germplasm}") @@ -101,7 +111,29 @@ public void setup() { * @throws ApiException */ public List getGermplasm(UUID programId) throws ApiException { - return new ArrayList<>(programGermplasmCache.get(programId).values()); + Program program = programDAO.get(programId) + .stream() + .findFirst() + .orElseThrow(); + + if (program.getId() == null) { + throw new InternalServerException("BI-API Program or Program ID is null"); + } + + String brapiProgramDbId = Optional.of(program) + .map(Program::getBrapiProgram) + .map(BrAPIProgram::getProgramDbId) + .orElse(null); + + if (brapiProgramDbId == null) { + brapiProgramDbId = programDAO.getProgramBrAPI(program).getProgramDbId(); + } + + GermplasmQueryParams germplasmQueryParams = GermplasmQueryParams.builder() + .programDbId(brapiProgramDbId) + .build(); + + return getBrAPIGermplasmUsingBrAPIProgramId(germplasmQueryParams, program); } /** @@ -281,6 +313,29 @@ private Map processGermplasmForDisplay(List getBrAPIGermplasmUsingBrAPIProgramId(GermplasmQueryParams germplasmQueryParams, Program program) throws ApiException { + + + if (germplasmQueryParams.page() == null) { + germplasmQueryParams.setPage(0); + } + + if (germplasmQueryParams.pageSize() == null) { + germplasmQueryParams.setPageSize(brapiMaxPageSize); + } + + GermplasmApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(program.getId()), GermplasmApi.class); + + List result = brAPIDAOUtil.get(api::germplasmGet, germplasmQueryParams); + + // TODO: Once cache is removed for this class, fix processGermplasmForDisplay to return List [BI-2906] + return new ArrayList<>(processGermplasmForDisplay(result, program.getKey()).values()); + } + // TODO: hack for now, probably should update breedbase // Made a JIRA card BI-1883 for this // Breedbase will return NA/NA for no pedigree or NA/father, mother/NA diff --git a/src/main/java/org/breedinginsight/brapps/importer/model/base/Germplasm.java b/src/main/java/org/breedinginsight/brapps/importer/model/base/Germplasm.java index e3691d5be..ca87fae6f 100644 --- a/src/main/java/org/breedinginsight/brapps/importer/model/base/Germplasm.java +++ b/src/main/java/org/breedinginsight/brapps/importer/model/base/Germplasm.java @@ -365,12 +365,20 @@ private void setBrAPIGermplasmCommitFields(BrAPIGermplasm germplasm, String prog } } - public BrAPIGermplasm constructBrAPIGermplasm(Program program, ProgramBreedingMethodEntity breedingMethod, User user, boolean commit, String referenceSource, Supplier nextVal, UUID listId) { + public BrAPIGermplasm constructBrAPIGermplasm(Program program, + ProgramBreedingMethodEntity breedingMethod, + User user, + boolean commit, + String referenceSource, + Supplier nextVal, + UUID listId, + String brapiProgramDbId) { BrAPIGermplasm germplasm = constructBrAPIGermplasm(breedingMethod, user, listId); if (commit) { setBrAPIGermplasmCommitFields(germplasm, program.getKey(), referenceSource, nextVal); } germplasm.setCommonCropName(program.getBrapiProgram().getCommonCropName()); + germplasm.setProgramDbId(brapiProgramDbId); // Set program id in external references BrAPIExternalReference newReference = new BrAPIExternalReference(); diff --git a/src/main/java/org/breedinginsight/brapps/importer/services/processors/germplasm/GermplasmProcessor.java b/src/main/java/org/breedinginsight/brapps/importer/services/processors/germplasm/GermplasmProcessor.java index 899924f4b..e0eaf3c53 100644 --- a/src/main/java/org/breedinginsight/brapps/importer/services/processors/germplasm/GermplasmProcessor.java +++ b/src/main/java/org/breedinginsight/brapps/importer/services/processors/germplasm/GermplasmProcessor.java @@ -43,8 +43,10 @@ import org.breedinginsight.brapps.importer.model.response.ImportPreviewStatistics; import org.breedinginsight.brapps.importer.model.response.PendingImportObject; import org.breedinginsight.brapps.importer.services.processors.Processor; +import org.breedinginsight.dao.db.tables.daos.ProgramDao; import org.breedinginsight.dao.db.tables.pojos.ProgramBreedingMethodEntity; import org.breedinginsight.daos.BreedingMethodDAO; +import org.breedinginsight.daos.impl.ProgramDAOImpl; import org.breedinginsight.model.Program; import org.breedinginsight.model.User; import org.breedinginsight.services.exceptions.ValidatorException; @@ -64,6 +66,7 @@ public class GermplasmProcessor implements Processor { private static final String NAME = "Germplasm"; + private final ProgramDAOImpl programDAOImpl; @Property(name = "brapi.server.reference-source") private String BRAPI_REFERENCE_SOURCE; @@ -109,13 +112,14 @@ public class GermplasmProcessor implements Processor { }; @Inject - public GermplasmProcessor(BrAPIGermplasmService brAPIGermplasmService, DSLContext dsl, BreedingMethodDAO breedingMethodDAO, BrAPIListDAO brAPIListDAO, BrAPIGermplasmDAO brAPIGermplasmDAO) { + public GermplasmProcessor(BrAPIGermplasmService brAPIGermplasmService, DSLContext dsl, BreedingMethodDAO breedingMethodDAO, BrAPIListDAO brAPIListDAO, BrAPIGermplasmDAO brAPIGermplasmDAO, ProgramDAOImpl programDAOImpl) { this.brAPIGermplasmService = brAPIGermplasmService; this.dsl = dsl; this.breedingMethodDAO = breedingMethodDAO; this.brAPIGermplasmDAO = brAPIGermplasmDAO; this.brAPIListDAO = brAPIListDAO; this.brAPIGermplasmService = brAPIGermplasmService; + this.programDAOImpl = programDAOImpl; } public void getExistingBrapiData(List importRows, Program program) throws ApiException { @@ -289,6 +293,8 @@ public Map process(ImportUpload upload, List
userProvidedEntryNumbers = new ArrayList<>(); ValidationErrors validationErrors = new ValidationErrors(); + String brapiProgramDbId = programDAOImpl.getProgramBrAPI(program).getProgramDbId(); + for (int i = 0; i < importRows.size(); i++) { log.debug("processing germplasm row: {}", i + 1); BrAPIImport brapiImport = importRows.get(i); @@ -315,7 +321,7 @@ public Map process(ImportUpload upload, List
process(ImportUpload upload, List
breedingMethods, List badBreedingMethods, - Program program, UUID importListId, boolean commit, PendingImport mappedImportRow, int i, User user, Supplier nextVal) { + Program program, UUID importListId, boolean commit, PendingImport mappedImportRow, int i, User user, Supplier nextVal, + String brapiProgramDbId) { germplasm = removeBreedingMethodBlanks(germplasm); //Validating if Breeding Method exists for valid parent entries validateGermplasmBreedingMethod(germplasm, i + 2, validationErrors); @@ -361,7 +368,7 @@ private void processNewGermplasm(Germplasm germplasm, ValidationErrors validatio numNewPedigreeConnections++; } - BrAPIGermplasm newGermplasm = germplasm.constructBrAPIGermplasm(program, breedingMethod, user, commit, BRAPI_REFERENCE_SOURCE, nextVal, importListId); + BrAPIGermplasm newGermplasm = germplasm.constructBrAPIGermplasm(program, breedingMethod, user, commit, BRAPI_REFERENCE_SOURCE, nextVal, importListId, brapiProgramDbId); newGermplasmList.add(newGermplasm); // Assign status of the germplasm diff --git a/src/test/java/org/breedinginsight/api/v1/controller/BreedingMethodControllerIntegrationTest.java b/src/test/java/org/breedinginsight/api/v1/controller/BreedingMethodControllerIntegrationTest.java index c3ba499c4..cb379596e 100644 --- a/src/test/java/org/breedinginsight/api/v1/controller/BreedingMethodControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/api/v1/controller/BreedingMethodControllerIntegrationTest.java @@ -355,6 +355,7 @@ public void deleteProgramMethod() { @Test public void createGermplasmWithProgramMethod() throws ApiException { Program program = createProgram("createGermProgBM", "CGBM", "CGERBM"); + String brapiProgramDbId = programDAO.getProgramBrAPI(program).getProgramDbId(); ProgramBreedingMethodEntity method = ProgramBreedingMethodEntity.builder() .programId(program.getId()) @@ -401,6 +402,8 @@ public void createGermplasmWithProgramMethod() throws ApiException { .externalReferences(List.of(programRef, germIdRef)) .accessionNumber(accessionNum); + germplasm.setProgramDbId(brapiProgramDbId); + assertDoesNotThrow(() -> germplasmService.createBrAPIGermplasm(List.of(germplasm), program.getId(), null)); String germplasmUrl = String.format("/programs/%s/brapi/v2/germplasm", program.getId()); @@ -427,6 +430,7 @@ public void createGermplasmWithProgramMethod() throws ApiException { @Test public void tryDeleteProgramMethodInUse() throws ApiException { Program program = createProgram("tryDeleteProgramBM", "TDBM", "TRYDBM"); + String brapiProgramDbId = programDAO.getProgramBrAPI(program).getProgramDbId(); ProgramBreedingMethodEntity method = ProgramBreedingMethodEntity.builder() .programId(program.getId()) @@ -472,6 +476,7 @@ public void tryDeleteProgramMethodInUse() throws ApiException { .putAdditionalInfoItem(BrAPIAdditionalInfoFields.CREATED_DATE, formatter.format(now)) .externalReferences(List.of(programRef, germIdRef)) .accessionNumber(accessionNum); + germplasm.setProgramDbId(brapiProgramDbId); assertDoesNotThrow(() -> germplasmService.createBrAPIGermplasm(List.of(germplasm), program.getId(), null)); diff --git a/src/test/java/org/breedinginsight/api/v1/controller/ExperimentControllerIntegrationTest.java b/src/test/java/org/breedinginsight/api/v1/controller/ExperimentControllerIntegrationTest.java index d95270d27..c09bf9a97 100644 --- a/src/test/java/org/breedinginsight/api/v1/controller/ExperimentControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/api/v1/controller/ExperimentControllerIntegrationTest.java @@ -24,7 +24,6 @@ import org.breedinginsight.api.model.v1.request.ProgramRequest; import org.breedinginsight.api.model.v1.request.SpeciesRequest; import org.breedinginsight.brapi.v2.dao.BrAPIGermplasmDAO; -import org.breedinginsight.brapi.v2.model.request.query.ExperimentQuery; import org.breedinginsight.brapi.v2.services.BrAPITrialService; import org.breedinginsight.brapps.importer.ImportTestUtils; import org.breedinginsight.brapps.importer.model.exports.FileType; @@ -34,6 +33,7 @@ import org.breedinginsight.dao.db.tables.pojos.ProgramUserRoleEntity; import org.breedinginsight.dao.db.tables.pojos.RoleEntity; import org.breedinginsight.dao.db.tables.pojos.SpeciesEntity; +import org.breedinginsight.daos.ProgramDAO; import org.breedinginsight.daos.ProgramUserDAO; import org.breedinginsight.daos.SpeciesDAO; import org.breedinginsight.daos.UserDAO; @@ -107,6 +107,8 @@ public class ExperimentControllerIntegrationTest extends BrAPITest { private final Gson gson = new GsonBuilder().registerTypeAdapter(OffsetDateTime.class, (JsonDeserializer) (json, type, context) -> OffsetDateTime.parse(json.getAsString())) .create(); + @Inject + private ProgramDAO programDAO; @BeforeAll void setup() throws Exception { @@ -166,8 +168,10 @@ void setup() throws Exception { throw e; } + String brapiProgramDbId = programDAO.getProgramBrAPI(program).getProgramDbId(); + // Add germplasm to program - List germplasm = createGermplasm(1); + List germplasm = createGermplasm(1, brapiProgramDbId); BrAPIExternalReference newReference = new BrAPIExternalReference(); newReference.setReferenceSource(String.format("%s/programs", BRAPI_REFERENCE_SOURCE)); newReference.setReferenceID(program.getId().toString()); @@ -1043,7 +1047,9 @@ private Program createSeededProgram(String prefix) throws Exception { AuthenticatedUser user = new AuthenticatedUser(testUser.getName(), new ArrayList<>(), testUser.getId(), new ArrayList<>()); ontologyService.createTraits(seededProgram.getId(), createTraits(2), user, false); - List germplasm = createGermplasm(1); + String brapiProgramDbId = programDAO.getProgramBrAPI(seededProgram).getProgramDbId(); + + List germplasm = createGermplasm(1, brapiProgramDbId); BrAPIExternalReference newReference = new BrAPIExternalReference(); newReference.setReferenceSource(String.format("%s/programs", BRAPI_REFERENCE_SOURCE)); newReference.setReferenceID(seededProgram.getId().toString()); @@ -1109,7 +1115,7 @@ private List createTraits(int numToCreate) { return traits; } - private List createGermplasm(int numToCreate) { + private List createGermplasm(int numToCreate, String brapiProgramDbId) { List germplasm = new ArrayList<>(); for (int i = 0; i < numToCreate; i++) { String gid = ""+(i+1); @@ -1128,6 +1134,7 @@ private List createGermplasm(int numToCreate) { testReference.setReferenceID(UUID.randomUUID().toString()); externalRef.add(testReference); testGermplasm.setExternalReferences(externalRef); + testGermplasm.setProgramDbId(brapiProgramDbId); germplasm.add(testGermplasm); } diff --git a/src/test/java/org/breedinginsight/api/v1/controller/SampleSubmissionControllerIntegrationTest.java b/src/test/java/org/breedinginsight/api/v1/controller/SampleSubmissionControllerIntegrationTest.java index 79c8095cb..3517b5832 100644 --- a/src/test/java/org/breedinginsight/api/v1/controller/SampleSubmissionControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/api/v1/controller/SampleSubmissionControllerIntegrationTest.java @@ -43,6 +43,7 @@ import org.breedinginsight.brapps.importer.model.imports.sample.SampleSubmissionImport.Columns; import org.breedinginsight.brapps.importer.services.ExternalReferenceSource; import org.breedinginsight.dao.db.tables.pojos.SpeciesEntity; +import org.breedinginsight.daos.ProgramDAO; import org.breedinginsight.daos.SpeciesDAO; import org.breedinginsight.daos.UserDAO; import org.breedinginsight.model.*; @@ -91,6 +92,8 @@ public class SampleSubmissionControllerIntegrationTest extends BrAPITest { private String newExperimentWorkflowId; private final Gson gson = new BrAPIClient().getJSON().getGson(); + @Inject + private ProgramDAO programDao; @BeforeAll void setup() throws Exception { @@ -126,7 +129,9 @@ void setup() throws Exception { dsl.execute(securityFp.get("InsertProgramRolesBreeder"), testUser.getId().toString(), program.getId()); dsl.execute(securityFp.get("InsertSystemRoleAdmin"), testUser.getId().toString()); - List germplasm = createGermplasm(96); + String brapiProgramDbId = programDao.getProgramBrAPI(program).getProgramDbId(); + + List germplasm = createGermplasm(96, brapiProgramDbId); BrAPIExternalReference newReference = new BrAPIExternalReference(); newReference.setReferenceSource(String.format("%s/programs", BRAPI_REFERENCE_SOURCE)); newReference.setReferenceID(program.getId().toString()); @@ -461,7 +466,7 @@ public File writeSubmissionToFile(List> data) throws IOExcep return file; } - private List createGermplasm(int numToCreate) { + private List createGermplasm(int numToCreate, String brapiProgramDbId) { List germplasm = new ArrayList<>(); for (int i = 0; i < numToCreate; i++) { String gid = ""+(i+1); @@ -480,6 +485,7 @@ private List createGermplasm(int numToCreate) { testReference.setReferenceID(UUID.randomUUID().toString()); externalRef.add(testReference); testGermplasm.setExternalReferences(externalRef); + testGermplasm.setProgramDbId(brapiProgramDbId); germplasm.add(testGermplasm); } diff --git a/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationLevelsControllerIntegrationTest.java b/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationLevelsControllerIntegrationTest.java index 4f15c553d..f74caa597 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationLevelsControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationLevelsControllerIntegrationTest.java @@ -41,6 +41,7 @@ import org.breedinginsight.brapps.importer.model.imports.experimentObservation.ExperimentObservation; import org.breedinginsight.dao.db.enums.DataType; import org.breedinginsight.dao.db.tables.pojos.SpeciesEntity; +import org.breedinginsight.daos.ProgramDAO; import org.breedinginsight.daos.SpeciesDAO; import org.breedinginsight.daos.UserDAO; import org.breedinginsight.model.*; @@ -87,6 +88,8 @@ public class BrAPIObservationLevelsControllerIntegrationTest extends BrAPITest { private OntologyService ontologyService; @Inject private BrAPIGermplasmDAO germplasmDAO; + @Inject + private ProgramDAO programDAO; @Inject @Client("/${micronaut.bi.api.version}") @@ -127,6 +130,7 @@ void setup() throws Exception { .key("TEST") .build(); program = TestUtils.insertAndFetchTestProgram(gson, client, programRequest); + String brapiProgramDbId = programDAO.getProgramBrAPI(program).getProgramDbId(); dsl.execute(securityFp.get("InsertProgramRolesBreeder"), testUser.getId().toString(), program.getId()); dsl.execute(securityFp.get("InsertSystemRoleAdmin"), testUser.getId().toString()); @@ -154,7 +158,7 @@ void setup() throws Exception { } // Add germplasm to program - List germplasm = createGermplasm(1); + List germplasm = createGermplasm(1, brapiProgramDbId); BrAPIExternalReference newReference = new BrAPIExternalReference(); newReference.setReferenceSource(String.format("%s/programs", BRAPI_REFERENCE_SOURCE)); newReference.setReferenceID(program.getId().toString()); @@ -255,7 +259,7 @@ private String getEnvId(JsonObject result, int index) { .get("referenceId").getAsString(); } - private List createGermplasm(int numToCreate) { + private List createGermplasm(int numToCreate, String brapiProgramDbId) { List germplasm = new ArrayList<>(); for (int i = 0; i < numToCreate; i++) { String gid = ""+(i+1); @@ -274,6 +278,7 @@ private List createGermplasm(int numToCreate) { testReference.setReferenceID(UUID.randomUUID().toString()); externalRef.add(testReference); testGermplasm.setExternalReferences(externalRef); + testGermplasm.setProgramDbId(brapiProgramDbId); germplasm.add(testGermplasm); } diff --git a/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitControllerIntegrationTest.java b/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitControllerIntegrationTest.java index de876c626..0076fda95 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitControllerIntegrationTest.java @@ -48,6 +48,7 @@ import org.breedinginsight.brapps.importer.services.processors.experiment.service.TrialService; import org.breedinginsight.dao.db.enums.DataType; import org.breedinginsight.dao.db.tables.pojos.SpeciesEntity; +import org.breedinginsight.daos.ProgramDAO; import org.breedinginsight.daos.SpeciesDAO; import org.breedinginsight.daos.UserDAO; import org.breedinginsight.model.*; @@ -96,6 +97,8 @@ public class BrAPIObservationUnitControllerIntegrationTest extends BrAPITest { private BrAPIGermplasmDAO germplasmDAO; @Inject private BrAPITrialDAO brapiTrialDAO; + @Inject + private ProgramDAO programDAO; @Inject @Client("/${micronaut.bi.api.version}") @@ -136,6 +139,7 @@ void setup() throws Exception { .key("TEST") .build(); program = TestUtils.insertAndFetchTestProgram(gson, client, programRequest); + String brapiProgramDbId = programDAO.getProgramBrAPI(program).getProgramDbId(); dsl.execute(securityFp.get("InsertProgramRolesBreeder"), testUser.getId().toString(), program.getId()); dsl.execute(securityFp.get("InsertSystemRoleAdmin"), testUser.getId().toString()); @@ -163,7 +167,7 @@ void setup() throws Exception { } // Add germplasm to program - List germplasm = createGermplasm(1); + List germplasm = createGermplasm(1, brapiProgramDbId); BrAPIExternalReference newReference = new BrAPIExternalReference(); newReference.setReferenceSource(String.format("%s/programs", BRAPI_REFERENCE_SOURCE)); newReference.setReferenceID(program.getId().toString()); @@ -388,7 +392,7 @@ private String getEnvId(JsonObject result, int index) { .get("referenceId").getAsString(); } - private List createGermplasm(int numToCreate) { + private List createGermplasm(int numToCreate, String brapiProgramDbId) { List germplasm = new ArrayList<>(); for (int i = 0; i < numToCreate; i++) { String gid = ""+(i+1); @@ -407,6 +411,7 @@ private List createGermplasm(int numToCreate) { testReference.setReferenceID(UUID.randomUUID().toString()); externalRef.add(testReference); testGermplasm.setExternalReferences(externalRef); + testGermplasm.setProgramDbId(brapiProgramDbId); germplasm.add(testGermplasm); } diff --git a/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationsControllerIntegrationTest.java b/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationsControllerIntegrationTest.java index 59cd33630..8159e2bba 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationsControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationsControllerIntegrationTest.java @@ -44,6 +44,7 @@ import org.breedinginsight.brapps.importer.model.imports.experimentObservation.ExperimentObservation; import org.breedinginsight.dao.db.enums.DataType; import org.breedinginsight.dao.db.tables.pojos.SpeciesEntity; +import org.breedinginsight.daos.ProgramDAO; import org.breedinginsight.daos.SpeciesDAO; import org.breedinginsight.daos.UserDAO; import org.breedinginsight.model.*; @@ -92,6 +93,8 @@ public class BrAPIObservationsControllerIntegrationTest extends BrAPITest { private OntologyService ontologyService; @Inject private BrAPIGermplasmDAO germplasmDAO; + @Inject + private ProgramDAO programDAO; @Inject @Client("/${micronaut.bi.api.version}") @@ -132,6 +135,7 @@ void setup() throws Exception { .key("TEST") .build(); program = TestUtils.insertAndFetchTestProgram(gson, client, programRequest); + String brapiProgramDbId = programDAO.getProgramBrAPI(program).getProgramDbId(); dsl.execute(securityFp.get("InsertProgramRolesBreeder"), testUser.getId().toString(), program.getId()); dsl.execute(securityFp.get("InsertSystemRoleAdmin"), testUser.getId().toString()); @@ -159,7 +163,7 @@ void setup() throws Exception { } // Add germplasm to program - List germplasm = createGermplasm(1); + List germplasm = createGermplasm(1, brapiProgramDbId); BrAPIExternalReference newReference = new BrAPIExternalReference(); newReference.setReferenceSource(String.format("%s/programs", BRAPI_REFERENCE_SOURCE)); newReference.setReferenceID(program.getId().toString()); @@ -434,7 +438,7 @@ private String getEnvId(JsonObject result, int index) { .get("referenceId").getAsString(); } - private List createGermplasm(int numToCreate) { + private List createGermplasm(int numToCreate, String brapiProgramDbId) { List germplasm = new ArrayList<>(); for (int i = 0; i < numToCreate; i++) { String gid = ""+(i+1); @@ -453,6 +457,7 @@ private List createGermplasm(int numToCreate) { testReference.setReferenceID(UUID.randomUUID().toString()); externalRef.add(testReference); testGermplasm.setExternalReferences(externalRef); + testGermplasm.setProgramDbId(brapiProgramDbId); germplasm.add(testGermplasm); } diff --git a/src/test/java/org/breedinginsight/brapi/v2/BrAPITestUtils.java b/src/test/java/org/breedinginsight/brapi/v2/BrAPITestUtils.java index 6af62c7cf..756d66db3 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/BrAPITestUtils.java +++ b/src/test/java/org/breedinginsight/brapi/v2/BrAPITestUtils.java @@ -38,12 +38,12 @@ import org.breedinginsight.api.model.v1.request.SpeciesRequest; import org.breedinginsight.api.v1.controller.TestTokenValidator; import org.breedinginsight.brapi.v2.dao.BrAPIGermplasmDAO; -import org.breedinginsight.brapi.v2.model.request.query.ExperimentQuery; import org.breedinginsight.brapi.v2.services.BrAPITrialService; import org.breedinginsight.brapps.importer.ImportTestUtils; import org.breedinginsight.brapps.importer.model.imports.experimentObservation.ExperimentObservation; import org.breedinginsight.dao.db.enums.DataType; import org.breedinginsight.dao.db.tables.pojos.SpeciesEntity; +import org.breedinginsight.daos.ProgramDAO; import org.breedinginsight.daos.SpeciesDAO; import org.breedinginsight.daos.UserDAO; import org.breedinginsight.model.*; @@ -81,6 +81,8 @@ public class BrAPITestUtils { private BrAPIGermplasmDAO germplasmDAO; @Inject private BrAPITrialService brAPITrialService; + @Inject + ProgramDAO programDAO; @Inject @Client("/${micronaut.bi.api.version}") @@ -122,6 +124,7 @@ public Tuple2> setupTestProgram(DSLContext brAPIDslContext .key("TEST") .build(); Program program = TestUtils.insertAndFetchTestProgram(gson, client, programRequest); + String brapiProgramDbId = programDAO.getProgramBrAPI(program).getProgramDbId(); // Add Program Administrator user. dsl.execute(securityFp.get("InsertProgramRolesBreeder"), testUser.getId().toString(), program.getId()); @@ -153,7 +156,7 @@ public Tuple2> setupTestProgram(DSLContext brAPIDslContext } // Add germplasm to program - List germplasm = createGermplasm(1, BRAPI_REFERENCE_SOURCE); + List germplasm = createGermplasm(1, BRAPI_REFERENCE_SOURCE, brapiProgramDbId); BrAPIExternalReference newReference = new BrAPIExternalReference(); newReference.setReferenceSource(String.format("%s/programs", BRAPI_REFERENCE_SOURCE)); newReference.setReferenceId(program.getId().toString()); @@ -249,7 +252,7 @@ public String getEnvId(JsonObject result, int index) { .get("referenceId").getAsString(); } - public List createGermplasm(int numToCreate, String referenceSource) { + public List createGermplasm(int numToCreate, String referenceSource, String brapiProgramDbId) { List germplasm = new ArrayList<>(); for (int i = 0; i < numToCreate; i++) { String gid = ""+(i+1); @@ -268,6 +271,7 @@ public List createGermplasm(int numToCreate, String referenceSou testReference.setReferenceID(UUID.randomUUID().toString()); externalRef.add(testReference); testGermplasm.setExternalReferences(externalRef); + testGermplasm.setProgramDbId(brapiProgramDbId); germplasm.add(testGermplasm); } diff --git a/src/test/java/org/breedinginsight/brapi/v2/BrAPIV2ObservationVariableControllerIntegrationTest.java b/src/test/java/org/breedinginsight/brapi/v2/BrAPIV2ObservationVariableControllerIntegrationTest.java index f8a99ac35..50227f0e0 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/BrAPIV2ObservationVariableControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/BrAPIV2ObservationVariableControllerIntegrationTest.java @@ -47,6 +47,7 @@ import org.breedinginsight.brapps.importer.model.imports.experimentObservation.ExperimentObservation; import org.breedinginsight.dao.db.enums.DataType; import org.breedinginsight.dao.db.tables.pojos.SpeciesEntity; +import org.breedinginsight.daos.ProgramDAO; import org.breedinginsight.daos.SpeciesDAO; import org.breedinginsight.daos.UserDAO; import org.breedinginsight.model.*; @@ -93,6 +94,8 @@ public class BrAPIV2ObservationVariableControllerIntegrationTest extends BrAPITe private BrAPIGermplasmDAO germplasmDAO; @Inject BrAPITrialService brAPITrialService; + @Inject + ProgramDAO programDAO; @Inject @Client("/${micronaut.bi.api.version}") @@ -134,6 +137,7 @@ void setup() throws Exception { .key("TEST") .build(); program = TestUtils.insertAndFetchTestProgram(gson, client, programRequest); + String brapiProgramDbId = programDAO.getProgramBrAPI(program).getProgramDbId(); dsl.execute(securityFp.get("InsertProgramRolesBreeder"), testUser.getId().toString(), program.getId()); dsl.execute(securityFp.get("InsertSystemRoleAdmin"), testUser.getId().toString()); @@ -161,7 +165,7 @@ void setup() throws Exception { } // Add germplasm to program - List germplasm = createGermplasm(1); + List germplasm = createGermplasm(1, brapiProgramDbId); BrAPIExternalReference newReference = new BrAPIExternalReference(); newReference.setReferenceSource(String.format("%s/programs", BRAPI_REFERENCE_SOURCE)); newReference.setReferenceId(program.getId().toString()); @@ -359,7 +363,7 @@ private String getEnvId(JsonObject result, int index) { .get("referenceId").getAsString(); } - private List createGermplasm(int numToCreate) { + private List createGermplasm(int numToCreate, String brapiProgramDbId) { List germplasm = new ArrayList<>(); for (int i = 0; i < numToCreate; i++) { String gid = ""+(i+1); @@ -378,6 +382,7 @@ private List createGermplasm(int numToCreate) { testReference.setReferenceId(UUID.randomUUID().toString()); externalRef.add(testReference); testGermplasm.setExternalReferences(externalRef); + testGermplasm.setProgramDbId(brapiProgramDbId); germplasm.add(testGermplasm); } diff --git a/src/test/java/org/breedinginsight/brapps/importer/ExperimentFileImportTest.java b/src/test/java/org/breedinginsight/brapps/importer/ExperimentFileImportTest.java index c8028150e..30240f5fb 100644 --- a/src/test/java/org/breedinginsight/brapps/importer/ExperimentFileImportTest.java +++ b/src/test/java/org/breedinginsight/brapps/importer/ExperimentFileImportTest.java @@ -204,7 +204,7 @@ public void appendExperimentWithObsVarFromPriorDataset() { // Create a plot-level dataset that includes observation variable tt_test_1 List traits = importTestUtils.createTraits(1); - Program program = createProgram("Append Exp with Prior Observations Vars", "EXPPRI", "EXPPRI", BRAPI_REFERENCE_SOURCE, createGermplasm(1), traits); + Program program = createProgram("Append Exp with Prior Observations Vars", "EXPPRI", "EXPPRI", BRAPI_REFERENCE_SOURCE, 1, traits); Map newExp = new HashMap<>(); newExp.put(Columns.GERMPLASM_GID, "1"); newExp.put(Columns.TEST_CHECK, "T"); @@ -310,7 +310,7 @@ public void appendExperimentMultipleDatasets() { // Create a plot-level dataset List traits = importTestUtils.createTraits(1); - Program program = createProgram("Append Exp with Multiple Datasets", "MULSET", "MULSET", BRAPI_REFERENCE_SOURCE, createGermplasm(1), traits); + Program program = createProgram("Append Exp with Multiple Datasets", "MULSET", "MULSET", BRAPI_REFERENCE_SOURCE, 1, traits); Map newExp = new HashMap<>(); newExp.put(Columns.GERMPLASM_GID, "1"); newExp.put(Columns.TEST_CHECK, "T"); @@ -441,7 +441,7 @@ public void appendExperimentMultipleDatasets() { @SneakyThrows public void importNewExpNewLocNoObsSuccess() { log.debug("importNewExpNewLocNoObsSuccess"); - Program program = createProgram("New Exp and Loc", "NEXPL", "NEXPL", BRAPI_REFERENCE_SOURCE, createGermplasm(1), null); + Program program = createProgram("New Exp and Loc", "NEXPL", "NEXPL", BRAPI_REFERENCE_SOURCE, 1, null); Map validRow = new HashMap<>(); validRow.put(Columns.GERMPLASM_GID, "1"); validRow.put(Columns.TEST_CHECK, "T"); @@ -476,7 +476,7 @@ public void importNewExpNewLocNoObsSuccess() { @SneakyThrows public void importNewExpMultiNewEnvSuccess() { log.debug("importNewExpMultiNewEnvSucces"); - Program program = createProgram("New Exp and Multi New Env", "MULENV", "MULENV", BRAPI_REFERENCE_SOURCE, createGermplasm(1), null); + Program program = createProgram("New Exp and Multi New Env", "MULENV", "MULENV", BRAPI_REFERENCE_SOURCE, 1, null); Map firstEnv = new HashMap<>(); firstEnv.put(Columns.GERMPLASM_GID, "1"); firstEnv.put(Columns.TEST_CHECK, "T"); @@ -536,7 +536,7 @@ public void importNewExpMultiNewEnvSuccess() { @SneakyThrows public void importExistingExpAndEnvErrorMessage() { log.debug("importExistingExpAndEnvErrorMessage"); - Program program = createProgram("New Env Existing Exp", "DUPENV", "DUPENV", BRAPI_REFERENCE_SOURCE, createGermplasm(1), null); + Program program = createProgram("New Env Existing Exp", "DUPENV", "DUPENV", BRAPI_REFERENCE_SOURCE, 1, null); Map newExp = new HashMap<>(); newExp.put(Columns.GERMPLASM_GID, "1"); newExp.put(Columns.TEST_CHECK, "T"); @@ -579,7 +579,7 @@ public void importExistingExpAndEnvErrorMessage() { @SneakyThrows public void importNewEnvNoObsSuccess() { log.debug("importNewEnvNoObsSuccess"); - Program program = createProgram("New Env", "NEWENV", "NEWENV", BRAPI_REFERENCE_SOURCE, createGermplasm(1), null); + Program program = createProgram("New Env", "NEWENV", "NEWENV", BRAPI_REFERENCE_SOURCE, 1, null); Map newEnv = new HashMap<>(); newEnv.put(Columns.GERMPLASM_GID, "1"); @@ -614,7 +614,7 @@ public void importNewEnvNoObsSuccess() { @SneakyThrows public void verifyMissingDataThrowsError(boolean commit) { log.debug("verifyMissingDataThrowsError"); - Program program = createProgram("Missing Req Cols "+(commit ? "C" : "P"), "MISS"+(commit ? "C" : "P"), "MISS"+(commit ? "C" : "P"), BRAPI_REFERENCE_SOURCE, createGermplasm(1), null); + Program program = createProgram("Missing Req Cols "+(commit ? "C" : "P"), "MISS"+(commit ? "C" : "P"), "MISS"+(commit ? "C" : "P"), BRAPI_REFERENCE_SOURCE, 1, null); Map base = new HashMap<>(); base.put(Columns.GERMPLASM_GID, "1"); @@ -685,7 +685,7 @@ public void verifyMissingDataThrowsError(boolean commit) { public void importNewExpWithObsVar() { log.debug("importNewExpWithObsVar"); List traits = importTestUtils.createTraits(1); - Program program = createProgram("New Exp with Observations Vars", "EXPVRR", "EXPVRR", BRAPI_REFERENCE_SOURCE, createGermplasm(1), traits); + Program program = createProgram("New Exp with Observations Vars", "EXPVRR", "EXPVRR", BRAPI_REFERENCE_SOURCE, 1, traits); Map newExp = new HashMap<>(); newExp.put(Columns.GERMPLASM_GID, "1"); newExp.put(Columns.TEST_CHECK, "T"); @@ -723,7 +723,7 @@ public void importNewExpWithObsVar() { @SneakyThrows public void verifyDiffYearSameEnvThrowsError(boolean commit) { log.debug("verifyDiffYEarSameEnvThrowsError"); - Program program = createProgram("Diff Years "+(commit ? "C" : "P"), "YEARS"+(commit ? "C" : "P"), "YEARS"+(commit ? "C" : "P"), BRAPI_REFERENCE_SOURCE, createGermplasm(2), null); + Program program = createProgram("Diff Years "+(commit ? "C" : "P"), "YEARS"+(commit ? "C" : "P"), "YEARS"+(commit ? "C" : "P"), BRAPI_REFERENCE_SOURCE, 2, null); List> rows = new ArrayList<>(); Map row = new HashMap<>(); @@ -763,7 +763,7 @@ public void verifyDiffYearSameEnvThrowsError(boolean commit) { @SneakyThrows public void verifyDiffLocSameEnvThrowsError(boolean commit) { log.debug("verifyDiffLocSameEnvThrowsError"); - Program program = createProgram("Diff Locations "+(commit ? "C" : "P"), "LOCS"+(commit ? "C" : "P"), "LOCS"+(commit ? "C" : "P"), BRAPI_REFERENCE_SOURCE, createGermplasm(2), null); + Program program = createProgram("Diff Locations "+(commit ? "C" : "P"), "LOCS"+(commit ? "C" : "P"), "LOCS"+(commit ? "C" : "P"), BRAPI_REFERENCE_SOURCE, 2, null); List> rows = new ArrayList<>(); Map row = new HashMap<>(); @@ -803,7 +803,7 @@ public void verifyDiffLocSameEnvThrowsError(boolean commit) { public void importNewExpWithObs(boolean commit) { log.debug("importNewExpWithObs"); List traits = importTestUtils.createTraits(1); - Program program = createProgram("New Exp with Observations "+(commit ? "C" : "P"), "NEXOB"+(commit ? "C" : "P"), "NEXOB"+(commit ? "C" : "P"), BRAPI_REFERENCE_SOURCE, createGermplasm(1), traits); + Program program = createProgram("New Exp with Observations "+(commit ? "C" : "P"), "NEXOB"+(commit ? "C" : "P"), "NEXOB"+(commit ? "C" : "P"), BRAPI_REFERENCE_SOURCE, 1, traits); Map newExp = new HashMap<>(); newExp.put(Columns.GERMPLASM_GID, "1"); newExp.put(Columns.TEST_CHECK, "T"); @@ -844,7 +844,7 @@ public void importNewExpWithObs(boolean commit) { public void verifyFailureImportNewExpWithInvalidObs(boolean commit) { log.debug("verifyFailureImportNewExpWithInvalidObs"); List traits = importTestUtils.createTraits(1); - Program program = createProgram("Invalid Observations "+(commit ? "C" : "P"), "INVOB"+(commit ? "C" : "P"), "INVOB"+(commit ? "C" : "P"), BRAPI_REFERENCE_SOURCE, createGermplasm(1), traits); + Program program = createProgram("Invalid Observations "+(commit ? "C" : "P"), "INVOB"+(commit ? "C" : "P"), "INVOB"+(commit ? "C" : "P"), BRAPI_REFERENCE_SOURCE, 1, traits); Map newExp = new HashMap<>(); newExp.put(Columns.GERMPLASM_GID, "1"); newExp.put(Columns.TEST_CHECK, "T"); @@ -870,7 +870,7 @@ public void verifyFailureImportNewExpWithInvalidObs(boolean commit) { @SneakyThrows public void verifyFailureNewOuExistingEnv(boolean commit) { log.debug("verifyFailureNewOuExistingEnv"); - Program program = createProgram("New OU Existing Env "+(commit ? "C" : "P"), "FLOU"+(commit ? "C" : "P"), "FLOU"+(commit ? "C" : "P"), BRAPI_REFERENCE_SOURCE, createGermplasm(1), null); + Program program = createProgram("New OU Existing Env "+(commit ? "C" : "P"), "FLOU"+(commit ? "C" : "P"), "FLOU"+(commit ? "C" : "P"), BRAPI_REFERENCE_SOURCE, 1, null); Map newExp = new HashMap<>(); newExp.put(Columns.GERMPLASM_GID, "1"); newExp.put(Columns.TEST_CHECK, "T"); @@ -904,7 +904,7 @@ public void verifyFailureNewOuExistingEnv(boolean commit) { public void importNewObsVarExistingOu() { log.debug("importNewObsVarExistingOu"); List traits = importTestUtils.createTraits(2); - Program program = createProgram("New ObsVar Existing OU", "OUVAR", "OUVAR", BRAPI_REFERENCE_SOURCE, createGermplasm(1), traits); + Program program = createProgram("New ObsVar Existing OU", "OUVAR", "OUVAR", BRAPI_REFERENCE_SOURCE, 1, traits); Map newExp = new HashMap<>(); newExp.put(Columns.GERMPLASM_GID, "1"); newExp.put(Columns.TEST_CHECK, "T"); @@ -968,7 +968,7 @@ public void importNewObsVarExistingOu() { public void importNewObsVarByObsUnitId() { log.debug("importNewObsVarByObsUnitId"); List traits = importTestUtils.createTraits(2); - Program program = createProgram("New ObsVar Referring to OU by ID", "OUVAR", "VAROU", BRAPI_REFERENCE_SOURCE, createGermplasm(1), traits); + Program program = createProgram("New ObsVar Referring to OU by ID", "OUVAR", "VAROU", BRAPI_REFERENCE_SOURCE, 1, traits); Map newExp = new HashMap<>(); newExp.put(Columns.GERMPLASM_GID, "1"); newExp.put(Columns.TEST_CHECK, "T"); @@ -1020,7 +1020,7 @@ public void importNewObsVarByObsUnitId() { public void importNewObservationDataByObsUnitId(boolean commit) { log.debug("importNewObservationDataByObsUnitId"); List traits = importTestUtils.createTraits(1); - Program program = createProgram("New Observation Referring to OU by ID"+(commit ? "C" : "P"), "OUDAT"+(commit ? "C" : "P"), "DATOU"+(commit ? "C" : "P"), BRAPI_REFERENCE_SOURCE, createGermplasm(1), traits); + Program program = createProgram("New Observation Referring to OU by ID"+(commit ? "C" : "P"), "OUDAT"+(commit ? "C" : "P"), "DATOU"+(commit ? "C" : "P"), BRAPI_REFERENCE_SOURCE, 1, traits); Map newExp = new HashMap<>(); newExp.put(Columns.GERMPLASM_GID, "1"); newExp.put(Columns.TEST_CHECK, "T"); @@ -1094,7 +1094,7 @@ public void importNewObservationDataByObsUnitId(boolean commit) { @SneakyThrows public void verifyBlankObsInOverwriteIsNoOp(boolean commit) { List traits = importTestUtils.createTraits(1); - Program program = createProgram("Overwrite Attempt With Blank Obs"+(commit ? "C" : "P"), "NOOP"+(commit ? "C" : "P"), "NOOP"+(commit ? "C" : "P"), BRAPI_REFERENCE_SOURCE, createGermplasm(1), traits); + Program program = createProgram("Overwrite Attempt With Blank Obs"+(commit ? "C" : "P"), "NOOP"+(commit ? "C" : "P"), "NOOP"+(commit ? "C" : "P"), BRAPI_REFERENCE_SOURCE, 1, traits); Map newExp = new HashMap<>(); newExp.put(Columns.GERMPLASM_GID, "1"); newExp.put(Columns.TEST_CHECK, "T"); @@ -1163,7 +1163,7 @@ public void verifyBlankObsInOverwriteIsNoOp(boolean commit) { public void importNewObsExistingOu(boolean commit) { log.debug("importNewObsExistingOu"); List traits = importTestUtils.createTraits(1); - Program program = createProgram("New Obs Existing OU "+(commit ? "C" : "P"), "OUOBS"+(commit ? "C" : "P"), "OUOBS"+(commit ? "C" : "P"), BRAPI_REFERENCE_SOURCE, createGermplasm(1), traits); + Program program = createProgram("New Obs Existing OU "+(commit ? "C" : "P"), "OUOBS"+(commit ? "C" : "P"), "OUOBS"+(commit ? "C" : "P"), BRAPI_REFERENCE_SOURCE, 1, traits); Map newExp = new HashMap<>(); newExp.put(Columns.GERMPLASM_GID, "1"); newExp.put(Columns.TEST_CHECK, "T"); @@ -1228,7 +1228,7 @@ public void importNewObsExistingOu(boolean commit) { public void verifyFailureImportNewObsExistingOuWithExistingObs(boolean commit) { log.debug("verifyFailureImportNewObsExistingOuWithExistingObs"); List traits = importTestUtils.createTraits(1); - Program program = createProgram("New Obs Existing Obs "+(commit ? "C" : "P"), "FEXOB"+(commit ? "C" : "P"), "FEXOB"+(commit ? "C" : "P"), BRAPI_REFERENCE_SOURCE, createGermplasm(1), traits); + Program program = createProgram("New Obs Existing Obs "+(commit ? "C" : "P"), "FEXOB"+(commit ? "C" : "P"), "FEXOB"+(commit ? "C" : "P"), BRAPI_REFERENCE_SOURCE, 1, traits); Map newExp = new HashMap<>(); newExp.put(Columns.GERMPLASM_GID, "1"); newExp.put(Columns.TEST_CHECK, "T"); @@ -1285,7 +1285,7 @@ public void verifyFailureImportNewObsExistingOuWithExistingObs(boolean commit) { public void importSecondExpAfterFirstExpWithObs() { log.debug("importSecondExpAfterFirstExpWithObs"); List traits = importTestUtils.createTraits(1); - Program program = createProgram("New Exp After First", "NEAF", "NEAF", BRAPI_REFERENCE_SOURCE, createGermplasm(1), traits); + Program program = createProgram("New Exp After First", "NEAF", "NEAF", BRAPI_REFERENCE_SOURCE, 1, traits); Map newExpA = new HashMap<>(); newExpA.put(Columns.GERMPLASM_GID, "1"); newExpA.put(Columns.TEST_CHECK, "T"); @@ -1355,7 +1355,7 @@ public void importSecondExpAfterFirstExpWithObs() { public void importNewObsAfterFirstExpWithObs(boolean commit) { log.debug("importNewObsAfterFirstExpWithObs"); List traits = importTestUtils.createTraits(2); - Program program = createProgram("Exp with additional Uploads "+(commit ? "C" : "P"), "EXAU"+(commit ? "C" : "P"), "EXAU"+(commit ? "C" : "P"), BRAPI_REFERENCE_SOURCE, createGermplasm(1), traits); + Program program = createProgram("Exp with additional Uploads "+(commit ? "C" : "P"), "EXAU"+(commit ? "C" : "P"), "EXAU"+(commit ? "C" : "P"), BRAPI_REFERENCE_SOURCE, 1, traits); Map newExp = new HashMap<>(); newExp.put(Columns.GERMPLASM_GID, "1"); newExp.put(Columns.TEST_CHECK, "T"); @@ -1427,7 +1427,7 @@ public void importNewObsAfterFirstExpWithObs(boolean commit) { public void importNewObsAfterFirstExpWithObsAndTimestamps() { log.debug("importNewObsAfterFirstExpWithObsAndTimestamps"); List traits = importTestUtils.createTraits(2); - Program program = createProgram("Exp with TS and additional Uploads ", "EXTSAU", "EXTSAU", BRAPI_REFERENCE_SOURCE, createGermplasm(1), traits); + Program program = createProgram("Exp with TS and additional Uploads ", "EXTSAU", "EXTSAU", BRAPI_REFERENCE_SOURCE, 1, traits); Map newExp = new HashMap<>(); newExp.put(Columns.GERMPLASM_GID, "1"); newExp.put(Columns.TEST_CHECK, "T"); @@ -1502,7 +1502,7 @@ public void importNewObsAfterFirstExpWithObsAndTimestamps() { public void importNewObsAfterFirstExpWithObs_blank(boolean commit) { log.debug("importNewObsAfterFirstExpWithObs_blank"); List traits = importTestUtils.createTraits(3); - Program program = createProgram("Exp with additional Uploads (blank) "+(commit ? "C" : "P"), "EXAUB"+(commit ? "C" : "P"), "EXAUB"+(commit ? "C" : "P"), BRAPI_REFERENCE_SOURCE, createGermplasm(1), traits); + Program program = createProgram("Exp with additional Uploads (blank) "+(commit ? "C" : "P"), "EXAUB"+(commit ? "C" : "P"), "EXAUB"+(commit ? "C" : "P"), BRAPI_REFERENCE_SOURCE, 1, traits); Map newExp = new HashMap<>(); newExp.put(Columns.GERMPLASM_GID, "1"); newExp.put(Columns.TEST_CHECK, "T"); @@ -1859,7 +1859,7 @@ private String yearToSeasonDbId(String year, UUID programId) throws ApiException return null; } - private Program createProgram(String name, String abbv, String key, String referenceSource, List germplasm, List traits) throws ApiException, DoesNotExistException, ValidatorException, BadRequestException { + private Program createProgram(String name, String abbv, String key, String referenceSource, int numGermplasmToCreate, List traits) throws ApiException, DoesNotExistException, ValidatorException, BadRequestException { SpeciesEntity validSpecies = speciesDAO.findAll().get(0); SpeciesRequest speciesRequest = SpeciesRequest.builder() .commonName(validSpecies.getCommonName()) @@ -1879,10 +1879,14 @@ private Program createProgram(String name, String abbv, String key, String refer // Get main program Program program = programService.getByKey(key).get(); + String brapiProgramDbId = programDAO.getProgramBrAPI(program).getProgramDbId(); dsl.execute(securityFp.get("InsertProgramRolesBreeder"), testUser.getId().toString(), program.getId().toString()); - if(germplasm != null && !germplasm.isEmpty()) { + if(numGermplasmToCreate > 0) { + + List germplasm = createGermplasm(numGermplasmToCreate, brapiProgramDbId); + BrAPIExternalReference newReference = new BrAPIExternalReference(); newReference.setReferenceSource(String.format("%s/programs", referenceSource)); newReference.setReferenceID(program.getId().toString()); @@ -1905,7 +1909,7 @@ private Program createProgram(String name, String abbv, String key, String refer return program; } - private List createGermplasm(int numToCreate) { + private List createGermplasm(int numToCreate, String brapiProgramDbId) { List germplasm = new ArrayList<>(); for (int i = 0; i < numToCreate; i++) { String gid = ""+(i+1); @@ -1924,6 +1928,7 @@ private List createGermplasm(int numToCreate) { testReference.setReferenceID(UUID.randomUUID().toString()); externalRef.add(testReference); testGermplasm.setExternalReferences(externalRef); + testGermplasm.setProgramDbId(brapiProgramDbId); germplasm.add(testGermplasm); } diff --git a/src/test/java/org/breedinginsight/brapps/importer/SampleSubmissionFileImportTest.java b/src/test/java/org/breedinginsight/brapps/importer/SampleSubmissionFileImportTest.java index 0f9feafb9..7217b5542 100644 --- a/src/test/java/org/breedinginsight/brapps/importer/SampleSubmissionFileImportTest.java +++ b/src/test/java/org/breedinginsight/brapps/importer/SampleSubmissionFileImportTest.java @@ -51,6 +51,7 @@ import org.breedinginsight.brapps.importer.services.ExternalReferenceSource; import org.breedinginsight.dao.db.tables.pojos.BiUserEntity; import org.breedinginsight.dao.db.tables.pojos.SpeciesEntity; +import org.breedinginsight.daos.ProgramDAO; import org.breedinginsight.daos.SpeciesDAO; import org.breedinginsight.daos.UserDAO; import org.breedinginsight.model.Column; @@ -146,6 +147,9 @@ public class SampleSubmissionFileImportTest extends BrAPITest { @Inject BrAPITrialService brAPITrialService; + @Inject + private ProgramDAO programDAO; + private Gson gson = new GsonBuilder().registerTypeAdapter(OffsetDateTime.class, (JsonDeserializer) (json, type, context) -> OffsetDateTime.parse(json.getAsString())) .registerTypeAdapter(BrAPIPagination.class, new PaginationTypeAdapter()) @@ -177,7 +181,7 @@ public void setup() { @SneakyThrows public void importGIDSuccess() { log.debug("importGIDSuccess"); - Program program = createProgram("Import GID Success", "GIDS", "GIDS", BRAPI_REFERENCE_SOURCE, createGermplasm(96), null); + Program program = createProgram("Import GID Success", "GIDS", "GIDS", BRAPI_REFERENCE_SOURCE, 96, null); List> validFile = new ArrayList<>(); int germGidCounter = 1; @@ -224,7 +228,7 @@ public void importGIDSuccess() { @SneakyThrows public void importObsUnitIdSuccess() { log.debug("importObsUnitIdSuccess"); - Program program = createProgram("Import ObsUnitID success", "OBSID", "OBSID", BRAPI_REFERENCE_SOURCE, createGermplasm(1), null); + Program program = createProgram("Import ObsUnitID success", "OBSID", "OBSID", BRAPI_REFERENCE_SOURCE, 1, null); var experimentId = createExperiment(program); @@ -298,7 +302,7 @@ public void importMissingGIDAndObsUnitIdFailure(boolean commit) { @SneakyThrows public void verifyMissingDataThrowsError(boolean commit) { log.debug("verifyMissingDataThrowsError"); - Program program = createProgram("Missing Req Cols "+(commit ? "C" : "P"), "MISS"+(commit ? "C" : "P"), "MISS"+(commit ? "C" : "P"), BRAPI_REFERENCE_SOURCE, createGermplasm(96), null); + Program program = createProgram("Missing Req Cols "+(commit ? "C" : "P"), "MISS"+(commit ? "C" : "P"), "MISS"+(commit ? "C" : "P"), BRAPI_REFERENCE_SOURCE, 96, null); Map base = new HashMap<>(); base.put(Columns.PLATE_ID, "valid_1"); base.put(Columns.ROW, "A"); @@ -371,7 +375,7 @@ public void importInvalidObsUnitIdFailure(boolean commit) { @SneakyThrows public void importConflictingWellsFailure(boolean commit) { log.debug("importConflictingWellsFailure"); - Program program = createProgram("Conflicting Wells " + (commit ? "C" : "P"), "WELL"+ (commit ? "C" : "P"), "WELL"+ (commit ? "C" : "P"), BRAPI_REFERENCE_SOURCE, createGermplasm(2), null); + Program program = createProgram("Conflicting Wells " + (commit ? "C" : "P"), "WELL"+ (commit ? "C" : "P"), "WELL"+ (commit ? "C" : "P"), BRAPI_REFERENCE_SOURCE, 2, null); List> validFile = new ArrayList<>(); Map validRow = new HashMap<>(); @@ -438,7 +442,7 @@ private Map assertRowSaved(Map expected, Program return ret; } - private Program createProgram(String name, String abbv, String key, String referenceSource, List germplasm, List traits) throws ApiException, DoesNotExistException, ValidatorException, BadRequestException { + private Program createProgram(String name, String abbv, String key, String referenceSource, Integer numGermplasmToCreate, List traits) throws ApiException, DoesNotExistException, ValidatorException, BadRequestException { SpeciesEntity validSpecies = speciesDAO.findAll().get(0); SpeciesRequest speciesRequest = SpeciesRequest.builder() .commonName(validSpecies.getCommonName()) @@ -458,10 +462,13 @@ private Program createProgram(String name, String abbv, String key, String refer // Get main program Program program = programService.getByKey(key).get(); + String brapiProgramDbId = programDAO.getProgramBrAPI(program).getProgramDbId(); dsl.execute(securityFp.get("InsertProgramRolesBreeder"), testUser.getId().toString(), program.getId().toString()); - if(germplasm != null && !germplasm.isEmpty()) { + if(numGermplasmToCreate != null && numGermplasmToCreate > 0) { + List germplasm = createGermplasm(numGermplasmToCreate, brapiProgramDbId); + BrAPIExternalReference newReference = new BrAPIExternalReference(); newReference.setReferenceSource(String.format("%s/programs", referenceSource)); newReference.setReferenceID(program.getId().toString()); @@ -484,7 +491,7 @@ private Program createProgram(String name, String abbv, String key, String refer return program; } - private List createGermplasm(int numToCreate) { + private List createGermplasm(int numToCreate, String brapiProgramDbId) { List germplasm = new ArrayList<>(); for (int i = 0; i < numToCreate; i++) { String gid = ""+(i+1); @@ -503,6 +510,7 @@ private List createGermplasm(int numToCreate) { testReference.setReferenceID(UUID.randomUUID().toString()); externalRef.add(testReference); testGermplasm.setExternalReferences(externalRef); + testGermplasm.setProgramDbId(brapiProgramDbId); germplasm.add(testGermplasm); } diff --git a/src/test/java/org/breedinginsight/services/BrAPIGermplasmServiceUnitTest.java b/src/test/java/org/breedinginsight/services/BrAPIGermplasmServiceUnitTest.java index 9d5f7b792..a47a3eebb 100644 --- a/src/test/java/org/breedinginsight/services/BrAPIGermplasmServiceUnitTest.java +++ b/src/test/java/org/breedinginsight/services/BrAPIGermplasmServiceUnitTest.java @@ -4,7 +4,9 @@ import io.reactivex.functions.Function; import io.reactivex.functions.Function3; import lombok.SneakyThrows; +import org.brapi.client.v2.model.queryParams.germplasm.GermplasmQueryParams; import org.brapi.v2.model.BrAPIExternalReference; +import org.brapi.v2.model.core.BrAPIProgram; import org.brapi.v2.model.core.response.BrAPIListDetails; import org.brapi.v2.model.core.response.BrAPIListsSingleResponse; import org.brapi.v2.model.germ.BrAPIGermplasm; @@ -60,7 +62,7 @@ void setup() { programDAO = mock(ProgramDAO.class); brAPIDAOUtil = mock(BrAPIDAOUtil.class); cacheProvider = new ProgramCacheProvider(super.getRedisConnection()); - germplasmDAO = new BrAPIGermplasmDAO(programDAO, mock(ImportDAO.class), brAPIDAOUtil, cacheProvider, new BrAPIEndpointProvider()); + germplasmDAO = new BrAPIGermplasmDAO(programDAO, mock(ImportDAO.class), brAPIDAOUtil, cacheProvider, new BrAPIEndpointProvider(), 65000); programService = mock(ProgramService.class); Field externalReferenceSource = BrAPIGermplasmDAO.class.getDeclaredField("referenceSource"); @@ -78,6 +80,14 @@ public void getGermplasmListExport() { testProgram.setKey("TEST"); testProgram.setId(testProgramId); + + BrAPIProgram brapiProgram = new BrAPIProgram(); + String brapiProgramDbId = UUID.randomUUID().toString(); + brapiProgram.setProgramDbId(brapiProgramDbId); + brapiProgram.setProgramName("Test Program [TEST]"); + + testProgram.setBrapiProgram(brapiProgram); + //Create List BrAPIListsSingleResponse listResponse = new BrAPIListsSingleResponse(); String listId = "1"; @@ -100,6 +110,7 @@ public void getGermplasmListExport() { testGermplasm.setSeedSource("Wild"); testGermplasm.setAccessionNumber("1"); testGermplasm.setDefaultDisplayName("Germplasm A"); + testGermplasm.setProgramDbId(brapiProgramDbId); JsonObject additionalInfo = new JsonObject(); additionalInfo.addProperty(GERMPLASM_IMPORT_ENTRY_NUMBER, "2"); additionalInfo.addProperty(GERMPLASM_BREEDING_METHOD, "Allopolyploid"); @@ -129,6 +140,7 @@ public void getGermplasmListExport() { externalRef = new ArrayList<>(); externalRef.add(testReference); testGermplasm.setExternalReferences(externalRef); + testGermplasm.setProgramDbId(brapiProgramDbId); germplasm.add(testGermplasm); //Stub out the spies @@ -138,12 +150,11 @@ public void getGermplasmListExport() { doReturn(Optional.of(testProgram)).when(programSpy).getById(testProgramId); //Stub out the mocks - when(programDAO.getAll()).thenReturn(Arrays.asList(Program.builder().id(testProgramId).name("Test Program").active(true).build())); when(programDAO.fetchOneById(any(UUID.class))).thenReturn(testProgram); when(programDAO.get(any(UUID.class))).thenReturn(Arrays.asList(testProgram)); - when(brAPIDAOUtil.searchNoPaging(any(Function.class), - any(Function3.class), - any(BrAPIGermplasmSearchRequest.class))).thenReturn(germplasm); + when(programDAO.getProgramBrAPI(any())).thenReturn(brapiProgram); + when(brAPIDAOUtil.get(any(Function.class), + any(GermplasmQueryParams.class))).thenReturn(germplasm); //Create germplasm cache of stub data Method setupMethod = BrAPIGermplasmDAO.class.getDeclaredMethod("setup"); From 9044db620c47545203b06aeb572fce78f9798049 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Mon, 24 Aug 2026 11:46:34 -0400 Subject: [PATCH 043/102] Use brapi pagination for all pagination attributes --- .../brapi/v2/BrAPITrialsController.java | 4 ++-- .../utilities/response/ResponseUtils.java | 15 ++++++++++----- 2 files changed, 12 insertions(+), 7 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java b/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java index 6a2cd579f..90af39ca1 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java +++ b/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java @@ -106,14 +106,14 @@ public HttpResponse>> getExperiments( List foundTrials = brapiResponse.getResult().getData(); foundTrials.forEach(this::setDbIds); - return ResponseUtils.getBrapiQueryResponse(foundTrials, brapiResponse, queryParams); + return ResponseUtils.getBrapiQueryResponse(foundTrials, brapiResponse); } BrAPITrialListResponse brapiResponse = experimentService.searchTrials(program.get(), queryParams); List foundTrials = brapiResponse.getResult().getData(); foundTrials.forEach(this::setDbIds); - return ResponseUtils.getBrapiQueryResponse(foundTrials, brapiResponse, queryParams); + return ResponseUtils.getBrapiQueryResponse(foundTrials, brapiResponse); } catch (ApiException e) { log.info(e.getMessage(), e); return HttpResponse.status(HttpStatus.INTERNAL_SERVER_ERROR, "Error retrieving experiments"); diff --git a/src/main/java/org/breedinginsight/utilities/response/ResponseUtils.java b/src/main/java/org/breedinginsight/utilities/response/ResponseUtils.java index 6f6e41614..f4fe3fb61 100644 --- a/src/main/java/org/breedinginsight/utilities/response/ResponseUtils.java +++ b/src/main/java/org/breedinginsight/utilities/response/ResponseUtils.java @@ -25,6 +25,7 @@ import io.micronaut.http.server.types.files.StreamedFile; import org.apache.commons.lang3.tuple.Pair; import org.brapi.client.v2.model.queryParams.core.BrAPIQueryParams; +import org.brapi.v2.model.BrAPIPagination; import org.brapi.v2.model.BrAPIResponse; import org.breedinginsight.api.model.v1.request.query.PaginationParams; import org.breedinginsight.api.model.v1.request.query.QueryParams; @@ -132,12 +133,16 @@ private static HttpResponse>> processBrapiResponse( } public static HttpResponse>> getBrapiQueryResponse(List data, - BrAPIResponse brAPIResponse, - BrapiQuery queryParams) { + BrAPIResponse brAPIResponse) { Pagination pagination = new Pagination(); - pagination.setTotalCount(brAPIResponse.getMetadata().getPagination().getTotalCount()); - pagination.setCurrentPage(queryParams.getPage()); - pagination.setPageSize(queryParams.getPageSize()); + + // We want to use the pagination results from BrAPI here. + BrAPIPagination brAPIPagination = brAPIResponse.getMetadata().getPagination(); + + pagination.setTotalCount(brAPIPagination.getTotalCount()); + pagination.setCurrentPage(brAPIPagination.getCurrentPage()); + pagination.setPageSize(brAPIPagination.getPageSize()); + pagination.setTotalPages((int) Math.ceil(pagination.getTotalCount() / (double) pagination.getPageSize())); Metadata metadata = constructMetadata(new Metadata(), pagination); From 18ed8c9b883b2cdb4f4738fdb3991f6abe87b2fe Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Mon, 24 Aug 2026 13:12:48 -0400 Subject: [PATCH 044/102] Set BrapiQuery sort order to ASC by default on BI side --- .../brapi/v1/model/request/query/BrapiQuery.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/org/breedinginsight/brapi/v1/model/request/query/BrapiQuery.java b/src/main/java/org/breedinginsight/brapi/v1/model/request/query/BrapiQuery.java index f51bcf317..8aa141838 100644 --- a/src/main/java/org/breedinginsight/brapi/v1/model/request/query/BrapiQuery.java +++ b/src/main/java/org/breedinginsight/brapi/v1/model/request/query/BrapiQuery.java @@ -42,7 +42,7 @@ public class BrapiQuery implements PaginationParams { private Integer page; private String sortField; - private SortOrder sortOrder; + private SortOrder sortOrder = SortOrder.ASC; public Integer getDefaultPage() { return DEFAULT_PAGE; From 7bc0c3d0d00af89d4ed669c553ec6d2dcd776d72 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Mon, 24 Aug 2026 16:14:46 -0400 Subject: [PATCH 045/102] Handle use case where no authorized IDs exist for collaborator - In MR Nick pointed out that because we are sending a post RQ to BrAPI with no ids in the case where no authorized IDs exist for a collaborator, all trials were being returned. This commit resolves that, and adds a new utility to ResponseUtils to produce empty BrAPI responses --- .../brapi/v2/BrAPITrialsController.java | 15 +++++++++++---- .../utilities/response/ResponseUtils.java | 15 +++++++++++++++ 2 files changed, 26 insertions(+), 4 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java b/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java index 90af39ca1..9f600d753 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java +++ b/src/main/java/org/breedinginsight/brapi/v2/BrAPITrialsController.java @@ -50,6 +50,7 @@ import javax.inject.Inject; import javax.validation.Valid; +import java.util.ArrayList; import java.util.List; import java.util.Optional; import java.util.UUID; @@ -101,12 +102,18 @@ public HttpResponse>> getExperiments( if (experimentalCollaborator.isPresent()) { List authorizedExperimentIds = experimentalCollaboratorService.getAuthorizedExperimentIds(experimentalCollaborator.get().getId()); - BrAPITrialListResponse brapiResponse = experimentService.searchTrials(program.get(), authorizedExperimentIds, queryParams); + if (authorizedExperimentIds.isEmpty()) { + // User is not authorized for any experiments, return empty response. + return ResponseUtils.getEmptyBrapiQueryResponse(); + } else { + // User is authorized. Grab the experiment data from BrAPI. + BrAPITrialListResponse brapiResponse = experimentService.searchTrials(program.get(), authorizedExperimentIds, queryParams); - List foundTrials = brapiResponse.getResult().getData(); - foundTrials.forEach(this::setDbIds); + List foundTrials = brapiResponse.getResult().getData(); + foundTrials.forEach(this::setDbIds); - return ResponseUtils.getBrapiQueryResponse(foundTrials, brapiResponse); + return ResponseUtils.getBrapiQueryResponse(foundTrials, brapiResponse); + } } BrAPITrialListResponse brapiResponse = experimentService.searchTrials(program.get(), queryParams); diff --git a/src/main/java/org/breedinginsight/utilities/response/ResponseUtils.java b/src/main/java/org/breedinginsight/utilities/response/ResponseUtils.java index f4fe3fb61..19650eb8a 100644 --- a/src/main/java/org/breedinginsight/utilities/response/ResponseUtils.java +++ b/src/main/java/org/breedinginsight/utilities/response/ResponseUtils.java @@ -149,6 +149,21 @@ public static HttpResponse>> getBrapiQueryResponse( return HttpResponse.ok(new Response<>(metadata, new DataResponse<>(data))); } + public static HttpResponse>> getEmptyBrapiQueryResponse() { + Pagination pagination = new Pagination(); + Metadata metadata; + + // Caller expects empty BrAPI response set. Set with empty defaults + pagination.setTotalCount(0); + pagination.setCurrentPage(0); + pagination.setPageSize(0); + pagination.setTotalPages(0); + + metadata = constructMetadata(new Metadata(), pagination); + + return HttpResponse.ok(new Response<>(metadata, new DataResponse<>(new ArrayList<>()))); + } + private static HttpResponse> processUploadSearchResponse( ProgramUpload upload, SearchRequest searchRequest, QueryParams queryParams, AbstractQueryMapper mapper, Metadata metadata) { From 219b6709733028d1c559348d7f8f940a934ce741 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Mon, 24 Aug 2026 17:16:24 -0400 Subject: [PATCH 046/102] Remove cache get for rawGermplasm, fix unit tests --- .../org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java | 6 ++---- .../brapps/importer/GermplasmFileImportTest.java | 5 +++++ 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java index 572a6ba4c..395b868ac 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java @@ -144,8 +144,8 @@ public List getGermplasm(UUID programId) throws ApiException { */ public List getRawGermplasm(UUID programId) throws ApiException { Program program = new Program(programDAO.fetchOneById(programId)); - List cacheList = new ArrayList<>(programGermplasmCache.get(programId).values()); - return cacheList.stream().map(germplasm -> { + List programGermplasm = getGermplasm(programId); + return programGermplasm.stream().map(germplasm -> { germplasm.setGermplasmName(Utilities.appendProgramKey(germplasm.getDefaultDisplayName(), program.getKey(), germplasm.getAccessionNumber())); if(germplasm.getAdditionalInfo() != null && germplasm.getAdditionalInfo().has(BrAPIAdditionalInfoFields.GERMPLASM_RAW_PEDIGREE) && !(germplasm.getAdditionalInfo().get(BrAPIAdditionalInfoFields.GERMPLASM_RAW_PEDIGREE).isJsonNull())) { @@ -318,8 +318,6 @@ private Map processGermplasmForDisplay(List getBrAPIGermplasmUsingBrAPIProgramId(GermplasmQueryParams germplasmQueryParams, Program program) throws ApiException { - - if (germplasmQueryParams.page() == null) { germplasmQueryParams.setPage(0); } diff --git a/src/test/java/org/breedinginsight/brapps/importer/GermplasmFileImportTest.java b/src/test/java/org/breedinginsight/brapps/importer/GermplasmFileImportTest.java index cbcea3e0c..2673b0353 100644 --- a/src/test/java/org/breedinginsight/brapps/importer/GermplasmFileImportTest.java +++ b/src/test/java/org/breedinginsight/brapps/importer/GermplasmFileImportTest.java @@ -27,6 +27,7 @@ import org.breedinginsight.dao.db.tables.pojos.BiUserEntity; import org.breedinginsight.dao.db.tables.pojos.ProgramBreedingMethodEntity; import org.breedinginsight.daos.BreedingMethodDAO; +import org.breedinginsight.daos.ProgramDAO; import org.breedinginsight.daos.UserDAO; import org.breedinginsight.model.Program; import org.breedinginsight.services.SpeciesService; @@ -75,6 +76,8 @@ public class GermplasmFileImportTest extends BrAPITest { private DSLContext dsl; @Inject private BrAPIGermplasmDAO germplasmDAO; + @Inject + private ProgramDAO programDAO; private ImportTestUtils importTestUtils; @@ -1217,11 +1220,13 @@ private String getPreviewState(JsonObject result, int index) { } private void seedExistingGermplasm(String accessionNumber, String displayName, String source, String breedingMethodCode) { + String brapiProgramDbId = programDAO.getProgramBrAPI(validProgram).getProgramDbId(); BrAPIGermplasm germplasm = new BrAPIGermplasm(); germplasm.setAccessionNumber(accessionNumber); germplasm.setDefaultDisplayName(displayName); germplasm.setGermplasmName(String.format("%s [%s-%s]", displayName, validProgram.getKey(), accessionNumber)); germplasm.setSeedSource(source); + germplasm.setProgramDbId(brapiProgramDbId); JsonObject additionalInfo = new JsonObject(); additionalInfo.addProperty(BrAPIAdditionalInfoFields.GERMPLASM_IMPORT_ENTRY_NUMBER, accessionNumber); From dbb4e863360aefafbf98e16410ef36d4414824af Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Tue, 25 Aug 2026 11:07:04 -0400 Subject: [PATCH 047/102] Add comments for BrAPIGermplasmDAO implementation, link ticket --- .../org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java index 395b868ac..c7fdd6257 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java @@ -143,6 +143,7 @@ public List getGermplasm(UUID programId) throws ApiException { * @throws ApiException */ public List getRawGermplasm(UUID programId) throws ApiException { + // TODO: This method is used for checking if germplasm already exist in the system. Once a generalized BrAPI exists check is made, we should update this method [BI-2938] Program program = new Program(programDAO.fetchOneById(programId)); List programGermplasm = getGermplasm(programId); return programGermplasm.stream().map(germplasm -> { @@ -394,6 +395,7 @@ public List updateBrAPIGermplasm(List putBrAPIGe } public List getGermplasmByRawName(List germplasmNames, UUID programId) throws ApiException { + // TODO: Optimize this method by utilizing a BrAPIGermplasmSearchRequest [BI-3028] Program program = new Program(programDAO.fetchOneById(programId)); return getGermplasm(programId) .stream() @@ -430,6 +432,7 @@ public List getGermplasmDbIdsForUUIDs(List germplasmUUIDs, UUID } public Optional getGermplasmByDBID(String germplasmDbId, UUID programId) throws ApiException { + // TODO: Optimize by utilizing a BrAPIGermplasmSearchRequest [BI-3028] Map cache = programGermplasmCache.get(programId); //key is UUID, want to filter by DBID BrAPIGermplasm germplasm = null; @@ -440,6 +443,7 @@ public Optional getGermplasmByDBID(String germplasmDbId, UUID pr } public List getGermplasmsByDBID(Collection germplasmDbIds, UUID programId) throws ApiException { + // TODO: Optimize by utilizing a BrAPIGermplasmSearchRequest [BI-3028] Map cache = programGermplasmCache.get(programId); //key is UUID, want to filter by DBID List germplasm = new ArrayList<>(); From b6420376f845191672fc50b98c31fc487bae5668 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Tue, 25 Aug 2026 11:34:44 -0400 Subject: [PATCH 048/102] Add TODO for created ticket [BI-3029] --- .../org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java index e228f7e8d..adbdb5821 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java @@ -151,11 +151,6 @@ private List getBrAPIStudiesUsingBrAPIProgramId(Program program) thr return new ArrayList<>(processStudyForDisplay(result, program.getKey()).values()); } - public Optional getStudyByName(String studyName, Program program) throws ApiException { - List studies = getStudiesByName(List.of(studyName), program); - return Utilities.getSingleOptional(studies); - } - public List getStudiesByName(List studyNames, Program program) throws ApiException { if(studyNames.isEmpty()) { return Collections.emptyList(); @@ -187,6 +182,7 @@ public List getStudiesByBrAPITrialExRefId(@NotNull UUID brapiTrialEx } public List getStudiesByEnvironmentIds(@NotNull Collection environmentIds, Program program) throws ApiException { + // TODO: Optimize and change to a BrAPI search or get on external reference IDs [BI-3029] String refSource = Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.STUDIES); return getBrAPIStudiesUsingBrAPIProgramId(program).stream() From 14d03073124451495abd82aec2612cd6c80b5898 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Tue, 25 Aug 2026 16:12:08 -0400 Subject: [PATCH 049/102] Add Germplasm search code, fix another cache get() --- .../brapi/v2/dao/BrAPIGermplasmDAO.java | 62 ++++++++++++++++--- .../services/ProgramService.java | 17 +++++ .../utilities/BrAPIDAOUtil.java | 4 ++ 3 files changed, 75 insertions(+), 8 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java index c7fdd6257..50b51f447 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java @@ -32,8 +32,10 @@ import org.brapi.v2.model.germ.BrAPIGermplasm; import org.brapi.v2.model.germ.BrAPIGermplasmSynonyms; import org.brapi.v2.model.germ.request.BrAPIGermplasmSearchRequest; +import org.brapi.v2.model.germ.response.BrAPIGermplasmListResponse; import org.brapi.v2.model.germ.response.BrAPIGermplasmSingleResponse; import org.breedinginsight.brapi.v2.constants.BrAPIAdditionalInfoFields; +import org.breedinginsight.brapi.v2.model.request.query.GermplasmQuery; import org.breedinginsight.brapps.importer.daos.ImportDAO; import org.breedinginsight.brapps.importer.model.ImportUpload; import org.breedinginsight.brapps.importer.services.ExternalReferenceSource; @@ -403,16 +405,60 @@ public List getGermplasmByRawName(List germplasmNames, U .collect(Collectors.toList()); } - public BrAPIGermplasm getGermplasmByUUID(String germplasmId, UUID programId) throws ApiException, DoesNotExistException { - Map cache = programGermplasmCache.get(programId); - BrAPIGermplasm germplasm = null; - if (cache != null) { - germplasm = cache.get(germplasmId); + public List brapiGermplasmSearchReturnList(Program program, + List brapiGermplasmIds) throws ApiException { + return brapiGermplasmSearchReturnResponse(program, brapiGermplasmIds, null).getResult().getData(); + } + + public BrAPIGermplasmListResponse brapiGermplasmSearchReturnResponse(Program program, + List brapiGermplasmIds, + GermplasmQuery germplasmQuery) throws ApiException { + + GermplasmApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(program.getId()), GermplasmApi.class); + + BrAPIGermplasmSearchRequest brAPIGermplasmSearchRequest = buildSearchRequest(program, brapiGermplasmIds, germplasmQuery); + + BrAPIGermplasmListResponse brAPIResponse = + brAPIDAOUtil.simpleSearch( + api::searchGermplasmPost, + brAPIGermplasmSearchRequest + ); + + // TODO: Once cache is removed for this class, fix processGermplasmForDisplay to return List [BI-2906] + List processedGermplasm = + new ArrayList<>(processGermplasmForDisplay(brAPIDAOUtil.getListResult(brAPIResponse), program.getKey()).values()); + + brAPIResponse.getResult().setData(processedGermplasm); + + return brAPIResponse; + } + + private BrAPIGermplasmSearchRequest buildSearchRequest(Program program, List brapiGermplasmIds, GermplasmQuery germplasmQuery) throws ApiException { + BrAPIGermplasmSearchRequest searchRequest = new BrAPIGermplasmSearchRequest(); + + searchRequest.programDbIds(List.of(brAPIDAOUtil.getBrAPIProgramDbId(program.getId()))); + + if (brapiGermplasmIds != null && !brapiGermplasmIds.isEmpty()) { + searchRequest.setTrialDbIds(brapiGermplasmIds.stream().map(UUID::toString).collect(Collectors.toList())); } - if (germplasm == null) { - throw new DoesNotExistException("UUID for this germplasm does not exist"); + + brAPIDAOUtil.setGenericSearchParameters(searchRequest, germplasmQuery); + + return searchRequest; + } + + public BrAPIGermplasm getGermplasmByUUID(String germplasmId, UUID programId) throws ApiException, DoesNotExistException { + Program program = new Program(programDAO.fetchOneById(programId)); + + List result = brapiGermplasmSearchReturnList(program, List.of(UUID.fromString(germplasmId))); + + if (result.size() > 1) { + throw new ApiException(String.format("Multiple germplasms found for germplasm with ID: [%s]", germplasmId)); + } else if (result.isEmpty()) { + throw new DoesNotExistException(String.format("Germplasm with ID: [%s] does not exist", germplasmId)); } - return germplasm; + + return result.get(0); } public List getGermplasmDbIdsForUUIDs(List germplasmUUIDs, UUID programId) throws ApiException, DoesNotExistException { diff --git a/src/main/java/org/breedinginsight/services/ProgramService.java b/src/main/java/org/breedinginsight/services/ProgramService.java index d7b35801b..aea07a9fa 100644 --- a/src/main/java/org/breedinginsight/services/ProgramService.java +++ b/src/main/java/org/breedinginsight/services/ProgramService.java @@ -19,6 +19,7 @@ import lombok.extern.slf4j.Slf4j; import org.apache.commons.lang3.StringUtils; +import org.brapi.client.v2.model.exceptions.ApiException; import org.brapi.v2.model.core.BrAPIProgram; import org.breedinginsight.api.auth.AuthenticatedUser; import org.breedinginsight.api.auth.SecurityService; @@ -316,5 +317,21 @@ public ArrayList getKeyValidationErrors(String key) { return keyErrors; } + public String getBrAPIProgramDbId(UUID biProgramId) throws ApiException { + Optional programOpt = getById(biProgramId); + + if (programOpt.isEmpty()) { + throw new ApiException("Program does not exist"); + } + + Program program = programOpt.get(); + + if (program.getBrapiProgram() == null) { + throw new ApiException("Program does not exist in BrAPI"); + } + + return program.getBrapiProgram().getProgramDbId(); + } + } diff --git a/src/main/java/org/breedinginsight/utilities/BrAPIDAOUtil.java b/src/main/java/org/breedinginsight/utilities/BrAPIDAOUtil.java index 0209d0afb..07d012b06 100644 --- a/src/main/java/org/breedinginsight/utilities/BrAPIDAOUtil.java +++ b/src/main/java/org/breedinginsight/utilities/BrAPIDAOUtil.java @@ -626,4 +626,8 @@ public void brapiSearchRequest.setPageSize(biSearchQuery.getPageSize()); } } + + public String getBrAPIProgramDbId(UUID biProgramId) throws ApiException { + return programService.getBrAPIProgramDbId(biProgramId); + } } From 78c086364cb1abc08d251e9a5eac891a0bdec226 Mon Sep 17 00:00:00 2001 From: humsika Date: Wed, 26 Aug 2026 12:00:05 -0400 Subject: [PATCH 050/102] BI-2919: Removed study external-reference ID overwrites. --- .../v2/BrAPIObservationLevelsController.java | 24 +--- .../brapi/v2/BrAPIObservationsController.java | 13 -- .../brapi/v2/BrAPIStudiesController.java | 10 +- .../brapi/v2/dao/BrAPIObservationDAO.java | 36 ++--- .../brapi/v2/dao/BrAPIStudyDAO.java | 10 ++ .../BrAPIObservationVariableService.java | 16 +-- .../brapi/v2/services/BrAPITrialService.java | 52 ++----- .../PopulateNewPendingImportObjectsStep.java | 135 +++++++++--------- 8 files changed, 116 insertions(+), 180 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationLevelsController.java b/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationLevelsController.java index ed2ef1884..65fa2c278 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationLevelsController.java +++ b/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationLevelsController.java @@ -31,7 +31,6 @@ import org.brapi.client.v2.modules.phenotype.ObservationUnitsApi; import org.brapi.v2.model.BrAPIIndexPagination; import org.brapi.v2.model.BrAPIMetadata; -import org.brapi.v2.model.core.BrAPIStudy; import org.brapi.v2.model.core.BrAPITrial; import org.brapi.v2.model.pheno.BrAPIObservationUnitHierarchyLevel; import org.brapi.v2.model.pheno.response.BrAPIObservationLevelListResponse; @@ -39,7 +38,6 @@ import org.breedinginsight.api.auth.ProgramSecured; import org.breedinginsight.api.auth.ProgramSecuredRoleGroup; import org.breedinginsight.brapi.v1.controller.BrapiVersion; -import org.breedinginsight.brapi.v2.dao.BrAPIStudyDAO; import org.breedinginsight.brapi.v2.dao.BrAPITrialDAO; import org.breedinginsight.daos.ProgramDAO; import org.breedinginsight.model.BrAPIConstants; @@ -65,15 +63,13 @@ public class BrAPIObservationLevelsController { private final ProgramDAO programDAO; private final ProgramService programService; private final BrAPITrialDAO trialDAO; - private final BrAPIStudyDAO studyDAO; @Inject - public BrAPIObservationLevelsController(BrAPIEndpointProvider brAPIEndpointProvider, ProgramDAO programDAO, ProgramService programService, BrAPITrialDAO trialDAO, BrAPIStudyDAO studyDAO) { + public BrAPIObservationLevelsController(BrAPIEndpointProvider brAPIEndpointProvider, ProgramDAO programDAO, ProgramService programService, BrAPITrialDAO trialDAO) { this.brAPIEndpointProvider = brAPIEndpointProvider; this.programDAO = programDAO; this.programService = programService; this.trialDAO = trialDAO; - this.studyDAO = studyDAO; } @Get("/observationlevels") @@ -93,25 +89,13 @@ public HttpResponse observationlevelsGet(@Pat } String programDbId = program.get().getBrapiProgram().getProgramDbId(); - String studyDbId = null; + String studyDbId = environmentId; String trialDbId = null; - if(environmentId != null) { - try { - Optional study = studyDAO.getStudyByEnvironmentId(UUID.fromString(environmentId), program.get()); - if(study.isPresent()) { - studyDbId = study.get().getStudyDbId(); - } else { - studyDbId = environmentId; - } - } catch (ApiException e) { - log.error(Utilities.generateApiExceptionLogMessage(e), "Error fetching environment"); - return HttpResponse.status(HttpStatus.INTERNAL_SERVER_ERROR, "Error finding observation levels"); - } - } else if(experimentId != null) { + if(environmentId == null && experimentId != null) { try { List trial = trialDAO.getTrialsByExperimentIds(List.of(UUID.fromString(experimentId)), program.get()); - if(trial.size() == 1) { + if (trial.size() == 1) { trialDbId = trial.get(0).getTrialDbId(); } else { trialDbId = experimentId; diff --git a/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationsController.java b/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationsController.java index 5f4fcc7c8..7c1a18897 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationsController.java +++ b/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationsController.java @@ -61,20 +61,17 @@ public class BrAPIObservationsController { private final ProgramService programService; private final ProgramDAO programDAO; - private final BrAPIStudyDAO brAPIStudyDAO; private final BrAPIEndpointProvider brAPIEndpointProvider; private final BrAPIObservationDAO observationDAO; @Inject public BrAPIObservationsController(ProgramService programService, - ProgramDAO programDAO, ProgramDAO programDAO1, BrAPIStudyDAO brAPIStudyDAO, BrAPIEndpointProvider brAPIEndpointProvider, BrAPIObservationDAO brAPIObservationDAO) { this.programService = programService; this.programDAO = programDAO1; - this.brAPIStudyDAO = brAPIStudyDAO; this.brAPIEndpointProvider = brAPIEndpointProvider; this.observationDAO = brAPIObservationDAO; } @@ -254,16 +251,6 @@ public HttpResponse observationsTableGet( } try { - // Translate studyDbId if provided. - if (queryParams.getStudyDbId() != null) { - Optional study = brAPIStudyDAO.getStudyByEnvironmentId(UUID.fromString(queryParams.getStudyDbId()), program.get()); - if (study.isEmpty()) { - return HttpResponse.notFound(); - } - queryParams.setStudyDbId(study.get().getStudyDbId()); - } - // TODO: Translate other DbIds if provided as well (but studyDbId is sufficient for Mr. Bean). - ObservationsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(programId), ObservationsApi.class); ApiResponse response = api.observationsTableGet(BrAPIWSMIMEDataTypes.APPLICATION_JSON, queryParams.toBrAPIQueryParams()); diff --git a/src/main/java/org/breedinginsight/brapi/v2/BrAPIStudiesController.java b/src/main/java/org/breedinginsight/brapi/v2/BrAPIStudiesController.java index e61fd4839..66e21c055 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/BrAPIStudiesController.java +++ b/src/main/java/org/breedinginsight/brapi/v2/BrAPIStudiesController.java @@ -25,6 +25,8 @@ import io.micronaut.security.rules.SecurityRule; import lombok.extern.slf4j.Slf4j; import org.brapi.client.v2.model.exceptions.ApiException; +import org.brapi.v2.model.BrAPIMetadata; +import org.brapi.v2.model.BrAPIStatus; import org.brapi.v2.model.core.BrAPIStudy; import org.brapi.v2.model.core.response.BrAPIStudySingleResponse; import org.breedinginsight.api.auth.ProgramSecured; @@ -43,6 +45,7 @@ import org.breedinginsight.services.ExperimentalCollaboratorService; import org.breedinginsight.services.ProgramService; import org.breedinginsight.services.ProgramUserService; +import org.breedinginsight.utilities.Utilities; import org.breedinginsight.utilities.response.ResponseUtils; import org.breedinginsight.utilities.response.mappers.StudyQueryMapper; @@ -146,7 +149,12 @@ public HttpResponse studiesStudyDbIdGet(@PathVariable( return HttpResponse.notFound(); } } catch (ApiException e) { - // Existing exception handling remains unchanged. + log.error(Utilities.generateApiExceptionLogMessage(e), e); + return HttpResponse.serverError(new BrAPIStudySingleResponse() + .metadata(new BrAPIMetadata() + .addStatusItem(new BrAPIStatus() + .message("Error fetching study") + .messageType(BrAPIStatus.MessageTypeEnum.ERROR)))); } } diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java index 098cd2089..8f370b437 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java @@ -60,7 +60,6 @@ public class BrAPIObservationDAO { private BrAPIObservationUnitDAO observationUnitDAO; private final BrAPIDAOUtil brAPIDAOUtil; private final BrAPIEndpointProvider brAPIEndpointProvider; - private final String referenceSource; private final TraitService traitService; private final int brapiMaxPageSize; @@ -71,7 +70,6 @@ public BrAPIObservationDAO(ProgramDAO programDAO, BrAPIObservationUnitDAO observationUnitDAO, BrAPIDAOUtil brAPIDAOUtil, BrAPIEndpointProvider brAPIEndpointProvider, - @Property(name = "brapi.server.reference-source") String referenceSource, @Property(name = "micronaut.bi.api.run-scheduled-tasks") boolean runScheduledTasks, @Property(name = "brapi.cache.fetch-page-size") int brapiFetchPageSize, TraitService traitService) { @@ -80,7 +78,6 @@ public BrAPIObservationDAO(ProgramDAO programDAO, this.observationUnitDAO = observationUnitDAO; this.brAPIDAOUtil = brAPIDAOUtil; this.brAPIEndpointProvider = brAPIEndpointProvider; - this.referenceSource = referenceSource; this.traitService = traitService; this.brapiMaxPageSize = brapiFetchPageSize; } @@ -185,32 +182,21 @@ public List getObservationsByObservationUnits(Collection getObservationsByFilters(Program program, String studyDbId) throws ApiException, DoesNotExistException { - - String studySource = Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.STUDIES); - - // Get all observations for the program. Collection observations = getProgramObservations(program.getId()); - // Build a hashmap of traits for fast lookup. The key is ObservationVariableDbId, the value is the Trait Id. - HashMap traitIdsByObservationVariableDbId = traitService.getIdsByObservationVariableDbIds(program.getId(), observations.stream().map(BrAPIObservation::getObservationVariableDbId).collect(Collectors.toList())); - // Lookup studyDbId. + HashMap traitIdsByObservationVariableDbId = + traitService.getIdsByObservationVariableDbIds( + program.getId(), + observations.stream() + .map(BrAPIObservation::getObservationVariableDbId) + .collect(Collectors.toList())); + return observations.stream() - .filter(o -> { - // Short circuit if filter is null. - if (studyDbId == null) return true; - Optional xref = Utilities.getExternalReference(o.getExternalReferences(), studySource); - return xref.filter(brAPIExternalReference -> studyDbId.equals(brAPIExternalReference.getReferenceId())).isPresent(); - }) - .peek(o -> { - // Translate ObservationVariableDbId. - o.setObservationVariableDbId(traitIdsByObservationVariableDbId.get(o.getObservationVariableDbId())); - // Translate StudyDbId. - o.setStudyDbId(Utilities.getExternalReference(o.getExternalReferences(), studySource) - .orElseThrow(() -> new RuntimeException("study xref not found on observation")).getReferenceId()); - // TODO: consider translating germplasmDbId in BI-2506. - }).collect(Collectors.toList()); + .filter(o -> studyDbId == null || studyDbId.equals(o.getStudyDbId())) + .peek(o -> + o.setObservationVariableDbId(traitIdsByObservationVariableDbId.get(o.getObservationVariableDbId()))) + .collect(Collectors.toList()); } @NotNull diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java index 54849b731..90e27cf9e 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java @@ -186,6 +186,16 @@ public List getStudiesByBrAPITrialExRefId(@NotNull UUID brapiTrialEx ); } + public List getStudiesByEnvironmentIds(@NotNull Collection environmentIds, Program program) throws ApiException { + String refSource = Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.STUDIES); + + return getBrAPIStudiesUsingBrAPIProgramId(program).stream() + .filter(study -> Utilities.getExternalReference(study.getExternalReferences(), refSource) + .map(ref -> environmentIds.contains(UUID.fromString(ref.getReferenceId()))) + .orElse(false)) + .collect(Collectors.toList()); + } + /** * Get a list of studies by a list of BI-assigned experiment UUIDs within a program. * @param experimentIds a list of BI-assigned experiment UUIDs. diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java index 1359a760d..4b579c0f1 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java @@ -17,7 +17,6 @@ package org.breedinginsight.brapi.v2.services; -import io.micronaut.context.annotation.Property; import lombok.extern.slf4j.Slf4j; import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.tuple.Pair; @@ -27,12 +26,11 @@ import org.brapi.v2.model.core.BrAPITrial; import org.brapi.v2.model.pheno.*; import org.breedinginsight.brapi.v2.constants.BrAPIAdditionalInfoFields; -import org.breedinginsight.brapps.importer.services.ExternalReferenceSource; -import org.breedinginsight.model.*; +import org.breedinginsight.model.Program; +import org.breedinginsight.model.Trait; import org.breedinginsight.services.ProgramService; import org.breedinginsight.services.exceptions.DoesNotExistException; import org.breedinginsight.utilities.DatasetUtil; -import org.breedinginsight.utilities.Utilities; import org.jetbrains.annotations.NotNull; import javax.inject.Inject; @@ -45,15 +43,12 @@ public class BrAPIObservationVariableService { private final ProgramService programService; private final BrAPITrialService trialService; - private final String referenceSource; @Inject public BrAPIObservationVariableService( - ProgramService programService, BrAPITrialService trialService, - @Property(name = "brapi.server.reference-source") String referenceSource) { + ProgramService programService, BrAPITrialService trialService){ this.programService = programService; this.trialService = trialService; - this.referenceSource = referenceSource; } // TODO: support sub-entity datasets. @@ -73,9 +68,8 @@ public List getBrAPIObservationVariablesForExperiment( if(experimentId.isPresent()) { expId = UUID.fromString(experimentId.get()); } else { - UUID envId = UUID.fromString(environmentId.orElseThrow(() -> new IllegalStateException("no environment id found"))); - // TODO: Double check this (and other studyDbId bi-brapi) lookup still works with cache removal on studies [BI-2962] - BrAPIStudy environment = trialService.getEnvironment(program.get(), envId); + String studyDbId = environmentId.orElseThrow(() -> new IllegalStateException("no study db id found")); + BrAPIStudy environment = trialService.getEnvironment(program.get(), studyDbId); expId = UUID.fromString(environment.getTrialDbId()); } diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java index 54693404d..e698df2e6 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java @@ -1,9 +1,9 @@ package org.breedinginsight.brapi.v2.services; -import com.google.gson.JsonArray; -import com.google.gson.JsonElement; import com.github.filosganga.geogson.model.Coordinates; import com.github.filosganga.geogson.model.positions.SinglePosition; +import com.google.gson.JsonArray; +import com.google.gson.JsonElement; import com.google.gson.JsonObject; import io.micronaut.context.annotation.Property; import io.micronaut.http.MediaType; @@ -17,7 +17,6 @@ import org.brapi.v2.model.core.response.BrAPIListsSingleResponse; import org.brapi.v2.model.core.response.BrAPITrialListResponse; import org.brapi.v2.model.germ.BrAPIGermplasm; - import org.brapi.v2.model.pheno.*; import org.breedinginsight.api.model.v1.request.SubEntityDatasetRequest; import org.breedinginsight.brapi.v2.constants.BrAPIAdditionalInfoFields; @@ -31,21 +30,20 @@ import org.breedinginsight.brapps.importer.services.FileMappingUtil; import org.breedinginsight.brapps.importer.services.processors.experiment.service.DatasetService; import org.breedinginsight.dao.db.enums.DataType; -import org.breedinginsight.model.BrAPIConstants; -import org.breedinginsight.model.Column; -import org.breedinginsight.model.DownloadFile; -import org.breedinginsight.model.Program; import org.breedinginsight.model.*; import org.breedinginsight.model.delta.DeltaEntityFactory; import org.breedinginsight.model.delta.Experiment; import org.breedinginsight.services.TraitService; import org.breedinginsight.services.exceptions.AlreadyExistsException; -import org.breedinginsight.services.exceptions.DoesNotExistException; import org.breedinginsight.services.exceptions.CreationBusyException; +import org.breedinginsight.services.exceptions.DoesNotExistException; +import org.breedinginsight.services.lock.DistributedLockService; import org.breedinginsight.services.parsers.experiment.ExperimentFileColumns; -import org.breedinginsight.utilities.*; +import org.breedinginsight.utilities.DatasetUtil; +import org.breedinginsight.utilities.FileUtil; +import org.breedinginsight.utilities.IntOrderComparator; +import org.breedinginsight.utilities.Utilities; import org.jetbrains.annotations.NotNull; -import org.breedinginsight.services.lock.DistributedLockService; import javax.inject.Inject; import javax.inject.Singleton; @@ -56,11 +54,11 @@ import java.time.OffsetDateTime; import java.time.format.DateTimeFormatter; import java.util.*; +import java.util.concurrent.TimeoutException; import java.util.function.Function; import java.util.stream.Collectors; import java.util.zip.ZipEntry; import java.util.zip.ZipOutputStream; -import java.util.concurrent.TimeoutException; import static org.breedinginsight.brapps.importer.services.processors.experiment.model.ExpImportProcessConstants.OBSERVATION_UNIT_ID_SUFFIX; @@ -213,7 +211,7 @@ public DownloadFile exportObservations( if (!requestedEnvIds.isEmpty()) { expStudies = expStudies .stream() - .filter(study -> requestedEnvIds.contains(getStudyId(study))) + .filter(study -> requestedEnvIds.contains(study.getStudyDbId())) .collect(Collectors.toList()); } expStudies.forEach(study -> studyByDbId.putIfAbsent(study.getStudyDbId(), study)); @@ -733,16 +731,6 @@ private void addBrAPIObsToRecords( } } - private String getStudyId(BrAPIStudy study) { - // HACK: avoid null reference exceptions. - if (study == null) return null; - BrAPIExternalReference studyXref = Utilities.getExternalReference( - study.getExternalReferences(), - String.format("%s/%s", referenceSource, ExternalReferenceSource.STUDIES.getName())) - .orElseThrow(() -> new RuntimeException("study id not found")); - return studyXref.getReferenceID(); - } - private void addObsVarDataToRow( Map row, BrAPIObservation obs, @@ -1103,16 +1091,6 @@ private String makeZipFileName(BrAPITrial experiment, Program program, String da return Utilities.makePortableFilename(unsafeName); } - private List filterDatasetByEnvironment( - List dataset, - List envIds, - Map studyByDbId) { - return dataset - .stream() - .filter(obs -> envIds.contains(getStudyId(studyByDbId.get(obs.getStudyDbId())))) - .collect(Collectors.toList()); - } - private boolean isSubEntityDataset(List ous){ return (ous.get(0).getObservationUnitPosition().getObservationLevelRelationships().size() > 2); } @@ -1141,12 +1119,8 @@ private void sortDefaultForExportRows(@NotNull List> exportR exportRows.sort(envComparator.thenComparing(expUnitIdComparator).thenComparing(subUnitIdComparator)); } - public BrAPIStudy getEnvironment(Program program, UUID envId) throws ApiException { - List environments = studyDAO.getStudiesByEnvironmentIds(List.of(envId), program); - if (environments.isEmpty()) { - throw new RuntimeException("A study with given experiment id was not returned"); + public BrAPIStudy getEnvironment(Program program, String studyDbId) throws ApiException { + return studyDAO.getStudyByDbId(studyDbId, program) + .orElseThrow(() -> new RuntimeException("A study with given study db id was not returned")); } - - return environments.get(0); - } } diff --git a/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/create/workflow/steps/PopulateNewPendingImportObjectsStep.java b/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/create/workflow/steps/PopulateNewPendingImportObjectsStep.java index f2b6ba133..476372170 100644 --- a/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/create/workflow/steps/PopulateNewPendingImportObjectsStep.java +++ b/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/create/workflow/steps/PopulateNewPendingImportObjectsStep.java @@ -1,73 +1,68 @@ /* - * See the NOTICE file distributed with this work for additional information - * regarding copyright ownership. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.breedinginsight.brapps.importer.services.processors.experiment.create.workflow.steps; - -import com.google.gson.Gson; -import com.google.gson.JsonArray; -import io.micronaut.context.annotation.Property; -import io.micronaut.http.HttpStatus; -import io.micronaut.http.exceptions.HttpStatusException; -import lombok.extern.slf4j.Slf4j; -import org.apache.commons.lang3.StringUtils; -import org.brapi.client.v2.JSON; -import org.brapi.client.v2.model.exceptions.ApiException; -import org.brapi.v2.model.core.BrAPIStudy; -import org.brapi.v2.model.core.BrAPITrial; -import org.brapi.v2.model.core.response.BrAPIListDetails; -import org.brapi.v2.model.germ.BrAPIGermplasm; -import org.brapi.v2.model.pheno.BrAPIObservation; -import org.brapi.v2.model.pheno.BrAPIObservationUnit; -import org.breedinginsight.brapi.v2.constants.BrAPIAdditionalInfoFields; -import org.breedinginsight.brapi.v2.dao.BrAPIObservationUnitDAO; -import org.breedinginsight.brapps.importer.model.imports.BrAPIImport; -import org.breedinginsight.brapps.importer.model.imports.experimentObservation.ExperimentObservation; -import org.breedinginsight.brapps.importer.model.response.ImportObjectState; -import org.breedinginsight.brapps.importer.model.response.PendingImportObject; -import org.breedinginsight.brapps.importer.model.workflow.ImportContext; -import org.breedinginsight.brapps.importer.services.processors.experiment.ExperimentUtilities; -import org.breedinginsight.brapps.importer.services.processors.experiment.create.model.PendingData; -import org.breedinginsight.brapps.importer.services.processors.experiment.create.model.PendingImportObjectData; -import org.breedinginsight.brapps.importer.services.processors.experiment.create.model.ProcessContext; -import org.breedinginsight.brapps.importer.services.processors.experiment.create.model.ProcessedPhenotypeData; -import org.breedinginsight.brapps.importer.services.processors.experiment.service.DatasetService; -import org.breedinginsight.brapps.importer.services.processors.experiment.services.ExperimentSeasonService; -import org.breedinginsight.model.Program; -import org.breedinginsight.model.ProgramLocation; -import org.breedinginsight.model.User; -import org.breedinginsight.services.exceptions.MissingRequiredInfoException; -import org.breedinginsight.services.exceptions.UnprocessableEntityException; -import org.breedinginsight.utilities.DatasetUtil; -import org.breedinginsight.utilities.Utilities; -import org.breedinginsight.model.DatasetMetadata; -import org.breedinginsight.model.DatasetLevel; -import org.jooq.DSLContext; -import org.breedinginsight.model.Trait; -import tech.tablesaw.columns.Column; - -import javax.inject.Inject; -import javax.inject.Singleton; -import java.math.BigInteger; -import java.time.OffsetDateTime; -import java.time.format.DateTimeFormatter; -import java.util.*; -import java.util.function.Supplier; -import java.util.stream.Collectors; - -import static org.breedinginsight.brapps.importer.services.processors.experiment.ExperimentUtilities.*; + * See the NOTICE file distributed with this work for additional information + * regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + package org.breedinginsight.brapps.importer.services.processors.experiment.create.workflow.steps; + + import com.google.gson.Gson; + import com.google.gson.JsonArray; + import io.micronaut.context.annotation.Property; + import io.micronaut.http.HttpStatus; + import io.micronaut.http.exceptions.HttpStatusException; + import lombok.extern.slf4j.Slf4j; + import org.apache.commons.lang3.StringUtils; + import org.brapi.client.v2.JSON; + import org.brapi.client.v2.model.exceptions.ApiException; + import org.brapi.v2.model.core.BrAPIStudy; + import org.brapi.v2.model.core.BrAPITrial; + import org.brapi.v2.model.core.response.BrAPIListDetails; + import org.brapi.v2.model.germ.BrAPIGermplasm; + import org.brapi.v2.model.pheno.BrAPIObservation; + import org.brapi.v2.model.pheno.BrAPIObservationUnit; + import org.breedinginsight.brapi.v2.constants.BrAPIAdditionalInfoFields; + import org.breedinginsight.brapi.v2.dao.BrAPIObservationUnitDAO; + import org.breedinginsight.brapps.importer.model.imports.BrAPIImport; + import org.breedinginsight.brapps.importer.model.imports.experimentObservation.ExperimentObservation; + import org.breedinginsight.brapps.importer.model.response.ImportObjectState; + import org.breedinginsight.brapps.importer.model.response.PendingImportObject; + import org.breedinginsight.brapps.importer.model.workflow.ImportContext; + import org.breedinginsight.brapps.importer.services.processors.experiment.ExperimentUtilities; + import org.breedinginsight.brapps.importer.services.processors.experiment.create.model.PendingData; + import org.breedinginsight.brapps.importer.services.processors.experiment.create.model.PendingImportObjectData; + import org.breedinginsight.brapps.importer.services.processors.experiment.create.model.ProcessContext; + import org.breedinginsight.brapps.importer.services.processors.experiment.create.model.ProcessedPhenotypeData; + import org.breedinginsight.brapps.importer.services.processors.experiment.service.DatasetService; + import org.breedinginsight.brapps.importer.services.processors.experiment.services.ExperimentSeasonService; + import org.breedinginsight.model.*; + import org.breedinginsight.services.exceptions.MissingRequiredInfoException; + import org.breedinginsight.services.exceptions.UnprocessableEntityException; + import org.breedinginsight.utilities.DatasetUtil; + import org.breedinginsight.utilities.Utilities; + import org.jooq.DSLContext; + import tech.tablesaw.columns.Column; + + import javax.inject.Inject; + import javax.inject.Singleton; + import java.math.BigInteger; + import java.time.OffsetDateTime; + import java.time.format.DateTimeFormatter; + import java.util.*; + import java.util.function.Supplier; + import java.util.stream.Collectors; + + import static org.breedinginsight.brapps.importer.services.processors.experiment.ExperimentUtilities.*; @Singleton @Slf4j @@ -635,8 +630,6 @@ private void fetchOrCreateObservationPIO(ProcessedPhenotypeData phenotypeData, newObservation.setObservationTimeStamp(OffsetDateTime.parse(timeStampValue)); } - newObservation.setStudyDbId(studyPIO.getId().toString()); //set as the BI ID to facilitate looking up studies when saving new observations - pio = new PendingImportObject<>(ImportObjectState.NEW, newObservation); observationByHash.put(key, pio); } From 576683e95598c0573e17ebb9710f6522f7543d45 Mon Sep 17 00:00:00 2001 From: humsika Date: Wed, 26 Aug 2026 15:43:09 -0400 Subject: [PATCH 051/102] BI-2919: Added unit tests. --- .../brapi/v2/dao/BrAPIStudyDAO.java | 10 --- .../ExperimentControllerIntegrationTest.java | 31 ++++----- ...vationLevelsControllerIntegrationTest.java | 44 ++++++++----- ...ervationUnitControllerIntegrationTest.java | 63 ++++++++++++++----- ...ObservationsControllerIntegrationTest.java | 26 ++++---- ...BrAPIStudiesControllerIntegrationTest.java | 15 +++++ ...tionVariableControllerIntegrationTest.java | 45 +++++++------ .../brapi/v2/dao/BrAPIStudyDAOUnitTest.java | 51 +++++++-------- .../services/BrAPITrialServiceUnitTest.java | 47 ++++++++++++++ 9 files changed, 208 insertions(+), 124 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java index 90e27cf9e..54849b731 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java @@ -186,16 +186,6 @@ public List getStudiesByBrAPITrialExRefId(@NotNull UUID brapiTrialEx ); } - public List getStudiesByEnvironmentIds(@NotNull Collection environmentIds, Program program) throws ApiException { - String refSource = Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.STUDIES); - - return getBrAPIStudiesUsingBrAPIProgramId(program).stream() - .filter(study -> Utilities.getExternalReference(study.getExternalReferences(), refSource) - .map(ref -> environmentIds.contains(UUID.fromString(ref.getReferenceId()))) - .orElse(false)) - .collect(Collectors.toList()); - } - /** * Get a list of studies by a list of BI-assigned experiment UUIDs within a program. * @param experimentIds a list of BI-assigned experiment UUIDs. diff --git a/src/test/java/org/breedinginsight/api/v1/controller/ExperimentControllerIntegrationTest.java b/src/test/java/org/breedinginsight/api/v1/controller/ExperimentControllerIntegrationTest.java index d95270d27..36055121a 100644 --- a/src/test/java/org/breedinginsight/api/v1/controller/ExperimentControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/api/v1/controller/ExperimentControllerIntegrationTest.java @@ -24,7 +24,7 @@ import org.breedinginsight.api.model.v1.request.ProgramRequest; import org.breedinginsight.api.model.v1.request.SpeciesRequest; import org.breedinginsight.brapi.v2.dao.BrAPIGermplasmDAO; -import org.breedinginsight.brapi.v2.model.request.query.ExperimentQuery; +import org.breedinginsight.brapi.v2.dao.BrAPIStudyDAO; import org.breedinginsight.brapi.v2.services.BrAPITrialService; import org.breedinginsight.brapps.importer.ImportTestUtils; import org.breedinginsight.brapps.importer.model.exports.FileType; @@ -46,19 +46,24 @@ import org.breedinginsight.utilities.DatasetUtil; import org.breedinginsight.utilities.FileUtil; import org.jooq.DSLContext; -import org.junit.jupiter.api.*; +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.TestInstance; import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.CsvSource; import org.junit.jupiter.params.provider.ValueSource; import tech.tablesaw.api.ColumnType; import tech.tablesaw.api.Row; import tech.tablesaw.api.Table; + import javax.inject.Inject; import java.io.*; import java.math.BigDecimal; import java.time.OffsetDateTime; import java.util.*; import java.util.stream.Collectors; + import static io.micronaut.http.HttpRequest.*; import static org.junit.Assert.assertNotEquals; import static org.junit.jupiter.api.Assertions.*; @@ -98,6 +103,8 @@ public class ExperimentControllerIntegrationTest extends BrAPITest { private RoleDao roleDao; @Inject private BrAPITrialService brAPITrialService; + @Inject + private BrAPIStudyDAO brAPIStudyDAO; @Inject @Client("/${micronaut.bi.api.version}") @@ -196,7 +203,7 @@ void setup() throws Exception { rows.add(row2); // Import test experiment, environments, and any observations - JsonObject importResult = importTestUtils.uploadAndFetchWorkflow( + importTestUtils.uploadAndFetchWorkflow( writeDataToFile(rows, traits), null, true, @@ -209,9 +216,9 @@ void setup() throws Exception { experimentId = trial.getTrialDbId(); - // Add environmentIds. - envIds.add(getEnvId(importResult, 0)); - envIds.add(getEnvId(importResult, 1)); + envIds.clear(); + brAPIStudyDAO.getStudies(program.getId()) + .forEach(study -> envIds.add(study.getStudyDbId())); } // Create an experiment with no observations. @@ -1291,18 +1298,6 @@ private BigDecimal toBigDecimal(Object value) { return new BigDecimal(value.toString()); } - private String getEnvId(JsonObject result, int index) { - return result - .get("preview").getAsJsonObject() - .get("rows").getAsJsonArray() - .get(index).getAsJsonObject() - .get("study").getAsJsonObject() - .get("brAPIObject").getAsJsonObject() - .get("externalReferences").getAsJsonArray() - .get(2).getAsJsonObject() - .get("referenceId").getAsString(); - } - private JsonArray getProgramTrials(String programId) { Flowable> getCall = client.exchange( GET(String.format("/programs/%s/brapi/v2/trials", programId)) diff --git a/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationLevelsControllerIntegrationTest.java b/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationLevelsControllerIntegrationTest.java index 4f15c553d..ef79cd3e3 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationLevelsControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationLevelsControllerIntegrationTest.java @@ -37,6 +37,7 @@ import org.breedinginsight.api.model.v1.request.SpeciesRequest; import org.breedinginsight.api.v1.controller.TestTokenValidator; import org.breedinginsight.brapi.v2.dao.BrAPIGermplasmDAO; +import org.breedinginsight.brapi.v2.dao.BrAPIStudyDAO; import org.breedinginsight.brapps.importer.ImportTestUtils; import org.breedinginsight.brapps.importer.model.imports.experimentObservation.ExperimentObservation; import org.breedinginsight.dao.db.enums.DataType; @@ -60,8 +61,7 @@ import java.util.*; import static io.micronaut.http.HttpRequest.GET; -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.junit.jupiter.api.Assertions.*; @MicronautTest @TestInstance(TestInstance.Lifecycle.PER_CLASS) @@ -87,6 +87,8 @@ public class BrAPIObservationLevelsControllerIntegrationTest extends BrAPITest { private OntologyService ontologyService; @Inject private BrAPIGermplasmDAO germplasmDAO; + @Inject + private BrAPIStudyDAO brAPIStudyDAO; @Inject @Client("/${micronaut.bi.api.version}") @@ -199,9 +201,10 @@ void setup() throws Exception { .get(0).getAsJsonObject() .get("trial").getAsJsonObject() .get("id").getAsString(); - // Add environmentIds. - envIds.add(getEnvId(importResult, 0)); - envIds.add(getEnvId(importResult, 1)); + + envIds.clear(); + brAPIStudyDAO.getStudies(program.getId()) + .forEach(study -> envIds.add(study.getStudyDbId())); } @Test @@ -225,6 +228,25 @@ public void testGetObservationLevels() { assertTrue(levelNames.contains("plot")); } + @Test + public void testGetObservationLevelsByStudyDbId() { + Flowable> call = client.exchange( + GET(String.format( + "/programs/%s/brapi/v2/observationlevels?studyDbId=%s", + program.getId(), envIds.get(0))) + .bearerAuth("test-registered-user"), String.class); + + HttpResponse response = call.blockingFirst(); + + assertEquals(HttpStatus.OK, response.getStatus()); + + JsonObject responseObj = gson.fromJson( + response.body(), + JsonObject.class); + + assertNotNull(responseObj.getAsJsonObject("result")); + } + private File writeDataToFile(List> data, List traits) throws IOException { File file = File.createTempFile("test", ".csv"); @@ -243,18 +265,6 @@ private File writeDataToFile(List> data, List traits) return file; } - private String getEnvId(JsonObject result, int index) { - return result - .get("preview").getAsJsonObject() - .get("rows").getAsJsonArray() - .get(index).getAsJsonObject() - .get("study").getAsJsonObject() - .get("brAPIObject").getAsJsonObject() - .get("externalReferences").getAsJsonArray() - .get(2).getAsJsonObject() - .get("referenceId").getAsString(); - } - private List createGermplasm(int numToCreate) { List germplasm = new ArrayList<>(); for (int i = 0; i < numToCreate; i++) { diff --git a/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitControllerIntegrationTest.java b/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitControllerIntegrationTest.java index de876c626..0eb64a74d 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitControllerIntegrationTest.java @@ -42,10 +42,10 @@ import org.breedinginsight.api.model.v1.request.SpeciesRequest; import org.breedinginsight.api.v1.controller.TestTokenValidator; import org.breedinginsight.brapi.v2.dao.BrAPIGermplasmDAO; +import org.breedinginsight.brapi.v2.dao.BrAPIStudyDAO; import org.breedinginsight.brapi.v2.dao.BrAPITrialDAO; import org.breedinginsight.brapps.importer.ImportTestUtils; import org.breedinginsight.brapps.importer.model.imports.experimentObservation.ExperimentObservation; -import org.breedinginsight.brapps.importer.services.processors.experiment.service.TrialService; import org.breedinginsight.dao.db.enums.DataType; import org.breedinginsight.dao.db.tables.pojos.SpeciesEntity; import org.breedinginsight.daos.SpeciesDAO; @@ -96,6 +96,8 @@ public class BrAPIObservationUnitControllerIntegrationTest extends BrAPITest { private BrAPIGermplasmDAO germplasmDAO; @Inject private BrAPITrialDAO brapiTrialDAO; + @Inject + private BrAPIStudyDAO brAPIStudyDAO; @Inject @Client("/${micronaut.bi.api.version}") @@ -192,7 +194,7 @@ void setup() throws Exception { rows.add(row2); // Import test experiment, environments, and any observations - JsonObject importResult = importTestUtils.uploadAndFetchWorkflow( + importTestUtils.uploadAndFetchWorkflow( writeDataToFile(rows, traits), null, true, @@ -202,9 +204,10 @@ void setup() throws Exception { newExperimentWorkflowId); List trials = brapiTrialDAO.getTrials(program.getId()); experimentId = trials.get(0).getTrialDbId(); - // Add environmentIds. - envIds.add(getEnvId(importResult, 0)); - envIds.add(getEnvId(importResult, 1)); + + envIds.clear(); + brAPIStudyDAO.getStudies(program.getId()) + .forEach(study -> envIds.add(study.getStudyDbId())); } @Test @@ -358,6 +361,44 @@ public void testGetOUById() { assertEquals(ou.get("observationUnitDbId").getAsString(), brAPIObservationUnitSingleResponse.get().getResult().getObservationUnitDbId()); } + @Test + public void testGetOUListByStudyDbId() { + String studyDbId = envIds.get(0); + + Flowable> call = + client.exchange( + GET(String.format( + "/programs/%s/brapi/v2/observationunits?studyDbId=%s", + program.getId(), + studyDbId)) + .bearerAuth("test-registered-user"), + String.class); + + HttpResponse response = call.blockingFirst(); + + assertEquals(HttpStatus.OK, response.getStatus()); + + JsonObject responseObj = + gson.fromJson( + response.body(), + JsonObject.class); + + JsonArray observationUnits = + responseObj + .getAsJsonObject("result") + .getAsJsonArray("data"); + + assertEquals(1, observationUnits.size()); + + assertEquals( + studyDbId, + observationUnits + .get(0) + .getAsJsonObject() + .get("studyDbId") + .getAsString()); // NEW: returned ID remains real studyDbId + } + private File writeDataToFile(List> data, List traits) throws IOException { File file = File.createTempFile("test", ".csv"); @@ -376,18 +417,6 @@ private File writeDataToFile(List> data, List traits) return file; } - private String getEnvId(JsonObject result, int index) { - return result - .get("preview").getAsJsonObject() - .get("rows").getAsJsonArray() - .get(index).getAsJsonObject() - .get("study").getAsJsonObject() - .get("brAPIObject").getAsJsonObject() - .get("externalReferences").getAsJsonArray() - .get(2).getAsJsonObject() - .get("referenceId").getAsString(); - } - private List createGermplasm(int numToCreate) { List germplasm = new ArrayList<>(); for (int i = 0; i < numToCreate; i++) { diff --git a/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationsControllerIntegrationTest.java b/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationsControllerIntegrationTest.java index 59cd33630..41fe4b7f6 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationsControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationsControllerIntegrationTest.java @@ -40,6 +40,7 @@ import org.breedinginsight.api.model.v1.request.SpeciesRequest; import org.breedinginsight.api.v1.controller.TestTokenValidator; import org.breedinginsight.brapi.v2.dao.BrAPIGermplasmDAO; +import org.breedinginsight.brapi.v2.dao.BrAPIStudyDAO; import org.breedinginsight.brapps.importer.ImportTestUtils; import org.breedinginsight.brapps.importer.model.imports.experimentObservation.ExperimentObservation; import org.breedinginsight.dao.db.enums.DataType; @@ -92,6 +93,8 @@ public class BrAPIObservationsControllerIntegrationTest extends BrAPITest { private OntologyService ontologyService; @Inject private BrAPIGermplasmDAO germplasmDAO; + @Inject + private BrAPIStudyDAO brAPIStudyDAO; @Inject @Client("/${micronaut.bi.api.version}") @@ -199,9 +202,10 @@ void setup() throws Exception { .get(0).getAsJsonObject() .get("trial").getAsJsonObject() .get("id").getAsString(); - // Add environmentIds. - envIds.add(getEnvId(importResult, 0)); - envIds.add(getEnvId(importResult, 1)); + + envIds.clear(); + brAPIStudyDAO.getStudies(program.getId()) + .forEach(study -> envIds.add(study.getStudyDbId())); } @Test @@ -329,6 +333,10 @@ public void testGetObsByStudyDbId() { JsonArray observations = responseObj.getAsJsonObject("result").getAsJsonArray("data"); assertEquals(2, observations.size()); + for (JsonElement observation : observations) { + assertEquals(envIds.get(0), observation.getAsJsonObject().get("studyDbId").getAsString()); + } + // Check the observation values, keep in mind the order of results is not guaranteed. Float value1 = observations.get(0).getAsJsonObject().get("value").getAsFloat(); Float value2 = observations.get(1).getAsJsonObject().get("value").getAsFloat(); @@ -422,18 +430,6 @@ private File writeDataToFile(List> data, List traits) return file; } - private String getEnvId(JsonObject result, int index) { - return result - .get("preview").getAsJsonObject() - .get("rows").getAsJsonArray() - .get(index).getAsJsonObject() - .get("study").getAsJsonObject() - .get("brAPIObject").getAsJsonObject() - .get("externalReferences").getAsJsonArray() - .get(2).getAsJsonObject() - .get("referenceId").getAsString(); - } - private List createGermplasm(int numToCreate) { List germplasm = new ArrayList<>(); for (int i = 0; i < numToCreate; i++) { diff --git a/src/test/java/org/breedinginsight/brapi/v2/BrAPIStudiesControllerIntegrationTest.java b/src/test/java/org/breedinginsight/brapi/v2/BrAPIStudiesControllerIntegrationTest.java index fdd0df29b..b4d4ea906 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/BrAPIStudiesControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/BrAPIStudiesControllerIntegrationTest.java @@ -181,6 +181,21 @@ public void testGetStudyById() { assertEquals(2, studies.size()); JsonObject study = studies.get(0).getAsJsonObject(); + String studyExternalReferenceId = null; + + for (JsonElement reference : study.getAsJsonArray("externalReferences")) { + JsonObject externalReference = reference.getAsJsonObject(); + + if (externalReference.get("referenceSource").getAsString().endsWith("/studies")) { + studyExternalReferenceId = externalReference.get("referenceId").getAsString(); + break; + } + } + + assertNotNull(studyExternalReferenceId); + + assertNotEquals(studyExternalReferenceId, study.get("studyDbId").getAsString()); + Flowable> studyCall = client.exchange( GET(String.format("/programs/%s/brapi/v2/studies/%s", program.getId(), study.get("studyDbId").getAsString())) .bearerAuth("test-registered-user"), diff --git a/src/test/java/org/breedinginsight/brapi/v2/BrAPIV2ObservationVariableControllerIntegrationTest.java b/src/test/java/org/breedinginsight/brapi/v2/BrAPIV2ObservationVariableControllerIntegrationTest.java index f8a99ac35..80b1dde56 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/BrAPIV2ObservationVariableControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/BrAPIV2ObservationVariableControllerIntegrationTest.java @@ -41,6 +41,7 @@ import org.breedinginsight.api.model.v1.request.SpeciesRequest; import org.breedinginsight.api.v1.controller.TestTokenValidator; import org.breedinginsight.brapi.v2.dao.BrAPIGermplasmDAO; +import org.breedinginsight.brapi.v2.dao.BrAPIStudyDAO; import org.breedinginsight.brapi.v2.model.request.query.ExperimentQuery; import org.breedinginsight.brapi.v2.services.BrAPITrialService; import org.breedinginsight.brapps.importer.ImportTestUtils; @@ -92,7 +93,9 @@ public class BrAPIV2ObservationVariableControllerIntegrationTest extends BrAPITe @Inject private BrAPIGermplasmDAO germplasmDAO; @Inject - BrAPITrialService brAPITrialService; + private BrAPITrialService brAPITrialService; + @Inject + private BrAPIStudyDAO brAPIStudyDAO; @Inject @Client("/${micronaut.bi.api.version}") @@ -192,7 +195,7 @@ void setup() throws Exception { rows.add(row2); // Import test experiment, environments, and any observations - JsonObject importResult = importTestUtils.uploadAndFetchWorkflow( + importTestUtils.uploadAndFetchWorkflow( writeDataToFile(rows, expTraits), null, true, @@ -208,10 +211,9 @@ void setup() throws Exception { experimentId = trial.getTrialDbId(); - - // Add environmentIds. - envIds.add(getEnvId(importResult, 0)); - envIds.add(getEnvId(importResult, 1)); + envIds.clear(); + brAPIStudyDAO.getStudies(program.getId()) + .forEach(study -> envIds.add(study.getStudyDbId())); } @Test @@ -329,6 +331,25 @@ public void testGetVariableById() { assertEquals(traits.get(0).getScale().getValidValueMax(), scale.getAsJsonObject("validValues").get("max").getAsInt()); } + @Test + public void testGetVariablesByStudyDbId() { + Flowable> call = client.exchange( + GET(String.format( + "/programs/%s/brapi/v2/variables?studyDbId=%s", + program.getId(), envIds.get(0))) + .bearerAuth("test-registered-user"), String.class); + + HttpResponse response = call.blockingFirst(); + + assertEquals(HttpStatus.OK, response.getStatus()); + + JsonObject responseObj = gson.fromJson(response.body(), JsonObject.class); + + JsonArray variables = responseObj.getAsJsonObject("result").getAsJsonArray("data"); + + assertEquals(2, variables.size()); + } + private File writeDataToFile(List> data, List traits) throws IOException { File file = File.createTempFile("test", ".csv"); @@ -347,18 +368,6 @@ private File writeDataToFile(List> data, List traits) return file; } - private String getEnvId(JsonObject result, int index) { - return result - .get("preview").getAsJsonObject() - .get("rows").getAsJsonArray() - .get(index).getAsJsonObject() - .get("study").getAsJsonObject() - .get("brAPIObject").getAsJsonObject() - .get("externalReferences").getAsJsonArray() - .get(2).getAsJsonObject() - .get("referenceId").getAsString(); - } - private List createGermplasm(int numToCreate) { List germplasm = new ArrayList<>(); for (int i = 0; i < numToCreate; i++) { diff --git a/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAOUnitTest.java b/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAOUnitTest.java index 90b8d90b1..3dda7b8e3 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAOUnitTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAOUnitTest.java @@ -17,12 +17,14 @@ package org.breedinginsight.brapi.v2.dao; import io.reactivex.functions.Function; +import io.reactivex.functions.Function3; import lombok.SneakyThrows; import org.brapi.client.v2.BrAPIClient; import org.brapi.client.v2.model.queryParams.core.StudyQueryParams; import org.brapi.v2.model.BrAPIExternalReference; import org.brapi.v2.model.core.BrAPIProgram; import org.brapi.v2.model.core.BrAPIStudy; +import org.brapi.v2.model.core.request.BrAPIStudySearchRequest; import org.breedinginsight.brapps.importer.daos.ImportDAO; import org.breedinginsight.brapps.importer.services.ExternalReferenceSource; import org.breedinginsight.daos.ProgramDAO; @@ -39,9 +41,11 @@ import java.lang.reflect.Field; import java.util.List; +import java.util.Optional; import java.util.UUID; import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertTrue; import static org.mockito.ArgumentMatchers.*; import static org.mockito.Mockito.*; @@ -120,49 +124,38 @@ void getStudiesUsesDirectBrAPIGetInsteadOfProgramCache() { @Test @SneakyThrows - void getStudiesByEnvironmentIdsUsesDirectBrAPIGetInsteadOfProgramCache() { - BrAPIStudy matchingStudy = study(environmentId, "Env1 [TEST-1]"); - BrAPIStudy otherStudy = study(UUID.randomUUID(), "Env2 [TEST-2]"); + void getStudiesByStudyDbIdUsesDirectBrAPISearch() { + String studyDbId = UUID.randomUUID().toString(); + BrAPIStudy study = new BrAPIStudy().studyDbId(studyDbId).studyName("Env1"); - when(brAPIDAOUtil.get(any(Function.class), any(StudyQueryParams.class))) - .thenReturn(List.of(matchingStudy, otherStudy)); + when(brAPIDAOUtil.search(any(Function.class), any(Function3.class), any(BrAPIStudySearchRequest.class))) + .thenReturn(List.of(study)); - List result = studyDAO.getStudiesByEnvironmentIds(List.of(environmentId), program); + List result = studyDAO.getStudiesByStudyDbId( + List.of(studyDbId), program); assertEquals(1, result.size()); - assertEquals("Env1", result.get(0).getStudyName()); - ArgumentCaptor queryParamsCaptor = ArgumentCaptor.forClass(StudyQueryParams.class); - verify(brAPIDAOUtil).get(any(Function.class), queryParamsCaptor.capture()); - assertEquals("brapi-program-1", queryParamsCaptor.getValue().programDbId()); - assertEquals(0, queryParamsCaptor.getValue().page()); - assertEquals(1000, queryParamsCaptor.getValue().pageSize()); - verify(programCache, never()).get(any(UUID.class)); - } + assertEquals(studyDbId, result.get(0).getStudyDbId()); - @Test - @SneakyThrows - void getStudiesByEnvironmentIdsReturnsEmptyListWhenStudyIsNotFoundInBrAPI() { - when(brAPIDAOUtil.get(any(Function.class), any(StudyQueryParams.class))) - .thenReturn(List.of()); + ArgumentCaptor requestCaptor = ArgumentCaptor.forClass(BrAPIStudySearchRequest.class); + + verify(brAPIDAOUtil).search(any(Function.class), any(Function3.class), requestCaptor.capture()); - List result = studyDAO.getStudiesByEnvironmentIds(List.of(environmentId), program); + assertEquals(List.of("brapi-program-1"), requestCaptor.getValue().getProgramDbIds()); + assertEquals(List.of(studyDbId), requestCaptor.getValue().getStudyDbIds()); - assertEquals(0, result.size()); verify(programCache, never()).get(any(UUID.class)); } @Test @SneakyThrows - void getStudiesByEnvironmentIdsReturnsEmptyListWhenNoStudyExternalReferenceMatches() { - BrAPIStudy study = study(UUID.randomUUID(), "Env2 [TEST-2]"); - - when(brAPIDAOUtil.get(any(Function.class), any(StudyQueryParams.class))) - .thenReturn(List.of(study)); + void getStudyByDbIdReturnsEmptyWhenBrAPIDoesNotFindStudy() { + when(brAPIDAOUtil.search(any(Function.class), any(Function3.class), any(BrAPIStudySearchRequest.class))) + .thenReturn(List.of()); - List result = studyDAO.getStudiesByEnvironmentIds(List.of(environmentId), program); + Optional result = studyDAO.getStudyByDbId(UUID.randomUUID().toString(), program); - assertEquals(0, result.size()); - verify(programCache, never()).get(any(UUID.class)); + assertTrue(result.isEmpty()); } private BrAPIStudy study(UUID environmentId, String studyName) { diff --git a/src/test/java/org/breedinginsight/brapi/v2/services/BrAPITrialServiceUnitTest.java b/src/test/java/org/breedinginsight/brapi/v2/services/BrAPITrialServiceUnitTest.java index c10778b35..a4afcedb1 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/services/BrAPITrialServiceUnitTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/services/BrAPITrialServiceUnitTest.java @@ -247,6 +247,53 @@ void getDatasetDataThrowsWhenSeasonYearIsNull() throws Exception { assertEquals("Env Year not found for Study DbId = 'study-1'.", exception.getMessage()); } + @Test + void exportObservationsFiltersByStudyDbId() throws Exception { + ExperimentExportQuery params = exportQuery(EXPORT_DATASET_ID); + + setField(params, "environments", "study-1"); + + BrAPIStudy secondStudy = new BrAPIStudy(); + secondStudy.setStudyDbId("study-2"); + secondStudy.setStudyName("Environment 2"); + secondStudy.setLocationName("Location 2"); + secondStudy.setSeasons(List.of("season-2")); + + BrAPIObservationUnit requestedObservationUnit = createObservationUnit("ou-db-1", "plot-1"); + + when(trialDAO.getTrialsByExperimentIds(anyCollection(), eq(program))) + .thenReturn(List.of(experiment)); + + when(studyDAO.getStudiesByBrAPITrialExRefId(any(UUID.class), eq(program))) + .thenReturn(List.of(study, secondStudy)); + + when(observationUnitDAO.getObservationUnitsForDatasetAndEnvs(EXPORT_DATASET_ID, List.of("study-1"), program)) + .thenReturn(List.of(requestedObservationUnit)); + + when(seasonDAO.getSeasonById("season-1", program.getId())).thenReturn(season); + + when(listDAO.getListsByTypeAndExternalRef(any(), eq(program.getId()), any(), any())) + .thenReturn(Collections.emptyList()); + + when(observationDAO.getObservationsByObservationUnits(anyCollection(), eq(program))) + .thenReturn(Collections.emptyList()); + + when(germplasmDAO.getGermplasmsByDBID(anyList(), eq(program.getId()))) + .thenReturn(List.of(germplasm)); + + DownloadFile downloadFile = service.exportObservations(program, UUID.fromString("11111111-1111-1111-1111-111111111111"), params); + + Table exportTable = FileUtil.parseTableFromCsv(new ByteArrayInputStream(downloadFile.getStreamedFile() + .getInputStream() + .readAllBytes())); + + assertEquals(1, exportTable.rowCount()); + + assertEquals("Environment 1", exportTable.stringColumn(Columns.ENV).get(0)); + + verify(observationUnitDAO).getObservationUnitsForDatasetAndEnvs(EXPORT_DATASET_ID, List.of("study-1"), program); + } + private ExperimentExportQuery exportQuery(String datasetId) throws Exception { ExperimentExportQuery params = new ExperimentExportQuery(); setField(params, "datasetId", datasetId); From 12d808b948062b43d3591a766071e4cb1a8601de Mon Sep 17 00:00:00 2001 From: humsika Date: Thu, 27 Aug 2026 15:42:53 -0400 Subject: [PATCH 052/102] BI-2919: Pulled latest from epic 2862. --- .../org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java | 2 -- 1 file changed, 2 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java index 3c50381cf..16a2a73cc 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java @@ -26,7 +26,6 @@ import org.brapi.client.v2.model.queryParams.phenotype.ObservationQueryParams; import org.brapi.client.v2.modules.phenotype.ObservationsApi; import org.brapi.v2.model.BrAPIAcceptedSearchResponse; -import org.brapi.v2.model.BrAPIExternalReference; import org.brapi.v2.model.core.BrAPIProgram; import org.brapi.v2.model.pheno.BrAPIObservation; import org.brapi.v2.model.pheno.BrAPIObservationUnit; @@ -34,7 +33,6 @@ import org.brapi.v2.model.pheno.response.BrAPIObservationListResponse; import org.breedinginsight.brapps.importer.daos.ImportDAO; import org.breedinginsight.brapps.importer.model.ImportUpload; -import org.breedinginsight.brapps.importer.services.ExternalReferenceSource; import org.breedinginsight.daos.ProgramDAO; import org.breedinginsight.model.Program; import org.breedinginsight.services.TraitService; From 4b0c6d281f2b3a82b6438809c16ffe16c9b69bc5 Mon Sep 17 00:00:00 2001 From: humsika Date: Thu, 27 Aug 2026 16:18:33 -0400 Subject: [PATCH 053/102] BI-2919: Formatted file. --- .../PopulateNewPendingImportObjectsStep.java | 130 +++++++++--------- 1 file changed, 65 insertions(+), 65 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/create/workflow/steps/PopulateNewPendingImportObjectsStep.java b/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/create/workflow/steps/PopulateNewPendingImportObjectsStep.java index 476372170..a02054a69 100644 --- a/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/create/workflow/steps/PopulateNewPendingImportObjectsStep.java +++ b/src/main/java/org/breedinginsight/brapps/importer/services/processors/experiment/create/workflow/steps/PopulateNewPendingImportObjectsStep.java @@ -1,68 +1,68 @@ - /* - * See the NOTICE file distributed with this work for additional information - * regarding copyright ownership. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - package org.breedinginsight.brapps.importer.services.processors.experiment.create.workflow.steps; - - import com.google.gson.Gson; - import com.google.gson.JsonArray; - import io.micronaut.context.annotation.Property; - import io.micronaut.http.HttpStatus; - import io.micronaut.http.exceptions.HttpStatusException; - import lombok.extern.slf4j.Slf4j; - import org.apache.commons.lang3.StringUtils; - import org.brapi.client.v2.JSON; - import org.brapi.client.v2.model.exceptions.ApiException; - import org.brapi.v2.model.core.BrAPIStudy; - import org.brapi.v2.model.core.BrAPITrial; - import org.brapi.v2.model.core.response.BrAPIListDetails; - import org.brapi.v2.model.germ.BrAPIGermplasm; - import org.brapi.v2.model.pheno.BrAPIObservation; - import org.brapi.v2.model.pheno.BrAPIObservationUnit; - import org.breedinginsight.brapi.v2.constants.BrAPIAdditionalInfoFields; - import org.breedinginsight.brapi.v2.dao.BrAPIObservationUnitDAO; - import org.breedinginsight.brapps.importer.model.imports.BrAPIImport; - import org.breedinginsight.brapps.importer.model.imports.experimentObservation.ExperimentObservation; - import org.breedinginsight.brapps.importer.model.response.ImportObjectState; - import org.breedinginsight.brapps.importer.model.response.PendingImportObject; - import org.breedinginsight.brapps.importer.model.workflow.ImportContext; - import org.breedinginsight.brapps.importer.services.processors.experiment.ExperimentUtilities; - import org.breedinginsight.brapps.importer.services.processors.experiment.create.model.PendingData; - import org.breedinginsight.brapps.importer.services.processors.experiment.create.model.PendingImportObjectData; - import org.breedinginsight.brapps.importer.services.processors.experiment.create.model.ProcessContext; - import org.breedinginsight.brapps.importer.services.processors.experiment.create.model.ProcessedPhenotypeData; - import org.breedinginsight.brapps.importer.services.processors.experiment.service.DatasetService; - import org.breedinginsight.brapps.importer.services.processors.experiment.services.ExperimentSeasonService; - import org.breedinginsight.model.*; - import org.breedinginsight.services.exceptions.MissingRequiredInfoException; - import org.breedinginsight.services.exceptions.UnprocessableEntityException; - import org.breedinginsight.utilities.DatasetUtil; - import org.breedinginsight.utilities.Utilities; - import org.jooq.DSLContext; - import tech.tablesaw.columns.Column; - - import javax.inject.Inject; - import javax.inject.Singleton; - import java.math.BigInteger; - import java.time.OffsetDateTime; - import java.time.format.DateTimeFormatter; - import java.util.*; - import java.util.function.Supplier; - import java.util.stream.Collectors; - - import static org.breedinginsight.brapps.importer.services.processors.experiment.ExperimentUtilities.*; +/* + * See the NOTICE file distributed with this work for additional information + * regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.breedinginsight.brapps.importer.services.processors.experiment.create.workflow.steps; + +import com.google.gson.Gson; +import com.google.gson.JsonArray; +import io.micronaut.context.annotation.Property; +import io.micronaut.http.HttpStatus; +import io.micronaut.http.exceptions.HttpStatusException; +import lombok.extern.slf4j.Slf4j; +import org.apache.commons.lang3.StringUtils; +import org.brapi.client.v2.JSON; +import org.brapi.client.v2.model.exceptions.ApiException; +import org.brapi.v2.model.core.BrAPIStudy; +import org.brapi.v2.model.core.BrAPITrial; +import org.brapi.v2.model.core.response.BrAPIListDetails; +import org.brapi.v2.model.germ.BrAPIGermplasm; +import org.brapi.v2.model.pheno.BrAPIObservation; +import org.brapi.v2.model.pheno.BrAPIObservationUnit; +import org.breedinginsight.brapi.v2.constants.BrAPIAdditionalInfoFields; +import org.breedinginsight.brapi.v2.dao.BrAPIObservationUnitDAO; +import org.breedinginsight.brapps.importer.model.imports.BrAPIImport; +import org.breedinginsight.brapps.importer.model.imports.experimentObservation.ExperimentObservation; +import org.breedinginsight.brapps.importer.model.response.ImportObjectState; +import org.breedinginsight.brapps.importer.model.response.PendingImportObject; +import org.breedinginsight.brapps.importer.model.workflow.ImportContext; +import org.breedinginsight.brapps.importer.services.processors.experiment.ExperimentUtilities; +import org.breedinginsight.brapps.importer.services.processors.experiment.create.model.PendingData; +import org.breedinginsight.brapps.importer.services.processors.experiment.create.model.PendingImportObjectData; +import org.breedinginsight.brapps.importer.services.processors.experiment.create.model.ProcessContext; +import org.breedinginsight.brapps.importer.services.processors.experiment.create.model.ProcessedPhenotypeData; +import org.breedinginsight.brapps.importer.services.processors.experiment.service.DatasetService; +import org.breedinginsight.brapps.importer.services.processors.experiment.services.ExperimentSeasonService; +import org.breedinginsight.model.*; +import org.breedinginsight.services.exceptions.MissingRequiredInfoException; +import org.breedinginsight.services.exceptions.UnprocessableEntityException; +import org.breedinginsight.utilities.DatasetUtil; +import org.breedinginsight.utilities.Utilities; +import org.jooq.DSLContext; +import tech.tablesaw.columns.Column; + +import javax.inject.Inject; +import javax.inject.Singleton; +import java.math.BigInteger; +import java.time.OffsetDateTime; +import java.time.format.DateTimeFormatter; +import java.util.*; +import java.util.function.Supplier; +import java.util.stream.Collectors; + +import static org.breedinginsight.brapps.importer.services.processors.experiment.ExperimentUtilities.*; @Singleton @Slf4j From b56ac085c5f3c3ec0eda6129301d6461e4a130a3 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Thu, 27 Aug 2026 17:10:44 -0400 Subject: [PATCH 054/102] Fix BrAPIGermplasmController getCache usage --- .../brapi/v2/BrAPIGermplasmController.java | 16 ++-------------- .../brapi/v2/dao/BrAPIGermplasmDAO.java | 18 ++---------------- .../v2/services/BrAPIGermplasmService.java | 13 +++++-------- 3 files changed, 9 insertions(+), 38 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/BrAPIGermplasmController.java b/src/main/java/org/breedinginsight/brapi/v2/BrAPIGermplasmController.java index 850ed8138..25789ddae 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/BrAPIGermplasmController.java +++ b/src/main/java/org/breedinginsight/brapi/v2/BrAPIGermplasmController.java @@ -1,6 +1,5 @@ package org.breedinginsight.brapi.v2; -import com.drew.lang.annotations.Nullable; import io.micronaut.context.annotation.Property; import io.micronaut.http.HttpHeaders; import io.micronaut.http.HttpResponse; @@ -108,15 +107,8 @@ public HttpResponse searchGermplasm( return HttpResponse.notFound(); } - // Can't use BrAPI server programDbId filtering, think germplasm are linked to program through observation - // units and doesn't work if don't have any loaded, use external refs instead for now - // Just use DeltaBreed program UUID - String extRefId = program.get().getId().toString(); - body.externalReferenceIds(List.of(extRefId)); - - // convert request filter dbIds from DeltaBreed UUID to BrAPI service dbIds - List convertedDbIds = germplasmService.getGermplasmDbIdsForUUIDs(program.get().getId(), body.getGermplasmDbIds()); - body.setGermplasmDbIds(convertedDbIds); + String brapiProgramDbId = programService.getBrAPIProgramDbId(program.get().getId()); + body.setProgramDbIds(List.of(brapiProgramDbId)); ApiResponse, Optional>> brapiGermplasm; brapiGermplasm = brAPIEndpointProvider @@ -177,10 +169,6 @@ private void batchProcessGermplasm(List germplasmList, String pr // Prepare a regex pattern for program key removal Pattern programKeyPattern = Utilities.getRegexPatternMatchAllProgramKeysAnyAccession(programKey); germplasmList.parallelStream().forEach(germplasm -> { - // Set dbId - germplasm.germplasmDbId(Utilities.getExternalReference(germplasm.getExternalReferences(), "breedinginsight.org") - .orElseThrow(() -> new IllegalStateException("No BI external reference found")) - .getReferenceId()); // Process synonyms if (germplasm.getSynonyms() != null) { germplasm.getSynonyms().forEach(synonym -> { diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java index 50b51f447..489c6cd75 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java @@ -23,10 +23,12 @@ import io.micronaut.http.server.exceptions.InternalServerException; import io.micronaut.scheduling.annotation.Scheduled; import lombok.extern.slf4j.Slf4j; +import org.apache.commons.lang3.tuple.Pair; import org.brapi.client.v2.ApiResponse; import org.brapi.client.v2.model.exceptions.ApiException; import org.brapi.client.v2.model.queryParams.germplasm.GermplasmQueryParams; import org.brapi.client.v2.modules.germplasm.GermplasmApi; +import org.brapi.v2.model.BrAPIAcceptedSearchResponse; import org.brapi.v2.model.BrAPIExternalReference; import org.brapi.v2.model.core.BrAPIProgram; import org.brapi.v2.model.germ.BrAPIGermplasm; @@ -461,22 +463,6 @@ public BrAPIGermplasm getGermplasmByUUID(String germplasmId, UUID programId) thr return result.get(0); } - public List getGermplasmDbIdsForUUIDs(List germplasmUUIDs, UUID programId) throws ApiException, DoesNotExistException { - Map cache = programGermplasmCache.get(programId); - List germplasmList = new ArrayList<>(); - if (cache != null) { - // not using streams because want to throw checked exception - for (String germplasmUUID : germplasmUUIDs) { - BrAPIGermplasm germplasm = cache.get(germplasmUUID); - if (germplasm == null) { - throw new DoesNotExistException("UUID for this germplasm does not exist: " + germplasmUUID); - } - germplasmList.add(germplasm.getGermplasmDbId()); - } - } - return germplasmList; - } - public Optional getGermplasmByDBID(String germplasmDbId, UUID programId) throws ApiException { // TODO: Optimize by utilizing a BrAPIGermplasmSearchRequest [BI-3028] Map cache = programGermplasmCache.get(programId); diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIGermplasmService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIGermplasmService.java index 7e4a01e67..161ceed8e 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIGermplasmService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIGermplasmService.java @@ -4,7 +4,10 @@ import io.micronaut.context.annotation.Property; import io.micronaut.http.server.exceptions.InternalServerException; import io.micronaut.http.server.types.files.StreamedFile; +import org.apache.commons.lang3.tuple.Pair; +import org.brapi.client.v2.ApiResponse; import org.brapi.client.v2.model.exceptions.ApiException; +import org.brapi.v2.model.BrAPIAcceptedSearchResponse; import org.brapi.v2.model.BrAPIExternalReference; import lombok.extern.slf4j.Slf4j; import org.brapi.v2.model.core.request.BrAPIListNewRequest; @@ -12,6 +15,8 @@ import org.brapi.v2.model.core.response.BrAPIListsSingleResponse; import org.brapi.v2.model.germ.BrAPIGermplasm; import org.brapi.v2.model.germ.BrAPIGermplasmSynonyms; +import org.brapi.v2.model.germ.request.BrAPIGermplasmSearchRequest; +import org.brapi.v2.model.germ.response.BrAPIGermplasmListResponse; import org.breedinginsight.brapi.v2.constants.BrAPIAdditionalInfoFields; import org.breedinginsight.brapi.v2.dao.BrAPIListDAO; import org.breedinginsight.brapps.importer.model.exports.FileType; @@ -70,14 +75,6 @@ public BrAPIGermplasm getGermplasmByUUID(UUID programId, String germplasmId) thr } } - public List getGermplasmDbIdsForUUIDs(UUID programId, List germplasmUUIDs) throws DoesNotExistException { - try { - return germplasmDAO.getGermplasmDbIdsForUUIDs(germplasmUUIDs, programId); - } catch (ApiException e) { - throw new InternalServerException(e.getMessage(), e); - } - } - public Optional getGermplasmByDBID(UUID programId, String germplasmId) throws ApiException { return germplasmDAO.getGermplasmByDBID(germplasmId, programId); } From 1e1690d7f29cc4f564007138c9f83dc047f5d78f Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Thu, 27 Aug 2026 17:39:09 -0400 Subject: [PATCH 055/102] Go after next BrAPIController cache usage, fix bug --- .../brapi/v2/BrAPIGermplasmController.java | 3 +-- .../brapi/v2/dao/BrAPIGermplasmDAO.java | 13 +------------ .../brapi/v2/services/BrAPIGermplasmService.java | 4 ---- 3 files changed, 2 insertions(+), 18 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/BrAPIGermplasmController.java b/src/main/java/org/breedinginsight/brapi/v2/BrAPIGermplasmController.java index 25789ddae..f234c3030 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/BrAPIGermplasmController.java +++ b/src/main/java/org/breedinginsight/brapi/v2/BrAPIGermplasmController.java @@ -308,8 +308,7 @@ public HttpResponse getGermplasmPedigreeInfo( metadata.setPagination(pagination); response = new BrAPIGermplasmPedigreeResponse(); } else { - BrAPIGermplasm germplasm = germplasmService.getGermplasmByDBID(programId, germplasmId) - .orElseThrow(() -> new DoesNotExistException("DBID for this germplasm does not exist")); + BrAPIGermplasm germplasm = germplasmService.getGermplasmByUUID(programId, germplasmId); //Forward the pedigree call to the backing BrAPI system of the program passing the germplasmDbId that came in the request GermplasmApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(programId), GermplasmApi.class); diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java index 489c6cd75..6afa3d073 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java @@ -441,7 +441,7 @@ private BrAPIGermplasmSearchRequest buildSearchRequest(Program program, List getGermplasmByDBID(String germplasmDbId, UUID programId) throws ApiException { - // TODO: Optimize by utilizing a BrAPIGermplasmSearchRequest [BI-3028] - Map cache = programGermplasmCache.get(programId); - //key is UUID, want to filter by DBID - BrAPIGermplasm germplasm = null; - if (cache != null) { - germplasm = cache.values().stream().filter(x -> x.getGermplasmDbId().equals(germplasmDbId)).collect(Collectors.toList()).get(0); - } - return Optional.ofNullable(germplasm); - } - public List getGermplasmsByDBID(Collection germplasmDbIds, UUID programId) throws ApiException { // TODO: Optimize by utilizing a BrAPIGermplasmSearchRequest [BI-3028] Map cache = programGermplasmCache.get(programId); diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIGermplasmService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIGermplasmService.java index 161ceed8e..c68801a8b 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIGermplasmService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIGermplasmService.java @@ -75,10 +75,6 @@ public BrAPIGermplasm getGermplasmByUUID(UUID programId, String germplasmId) thr } } - public Optional getGermplasmByDBID(UUID programId, String germplasmId) throws ApiException { - return germplasmDAO.getGermplasmByDBID(germplasmId, programId); - } - public List> processListData(List germplasm, List listData, Program program){ Map germplasmByName = new HashMap<>(); for (BrAPIGermplasm g: germplasm) { From acef437734075878be0d6f778f117a47b45c6d5b Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Thu, 27 Aug 2026 18:19:31 -0400 Subject: [PATCH 056/102] Remove remaining cache.get() usages --- .../brapi/v2/dao/BrAPIGermplasmDAO.java | 22 ++++++++----------- 1 file changed, 9 insertions(+), 13 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java index 6afa3d073..ca896441e 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java @@ -408,12 +408,12 @@ public List getGermplasmByRawName(List germplasmNames, U } public List brapiGermplasmSearchReturnList(Program program, - List brapiGermplasmIds) throws ApiException { + List brapiGermplasmIds) throws ApiException { return brapiGermplasmSearchReturnResponse(program, brapiGermplasmIds, null).getResult().getData(); } public BrAPIGermplasmListResponse brapiGermplasmSearchReturnResponse(Program program, - List brapiGermplasmIds, + List brapiGermplasmIds, GermplasmQuery germplasmQuery) throws ApiException { GermplasmApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(program.getId()), GermplasmApi.class); @@ -435,13 +435,13 @@ public BrAPIGermplasmListResponse brapiGermplasmSearchReturnResponse(Program pro return brAPIResponse; } - private BrAPIGermplasmSearchRequest buildSearchRequest(Program program, List brapiGermplasmIds, GermplasmQuery germplasmQuery) throws ApiException { + private BrAPIGermplasmSearchRequest buildSearchRequest(Program program, List brapiGermplasmIds, GermplasmQuery germplasmQuery) throws ApiException { BrAPIGermplasmSearchRequest searchRequest = new BrAPIGermplasmSearchRequest(); searchRequest.programDbIds(List.of(brAPIDAOUtil.getBrAPIProgramDbId(program.getId()))); if (brapiGermplasmIds != null && !brapiGermplasmIds.isEmpty()) { - searchRequest.setGermplasmDbIds(brapiGermplasmIds.stream().map(UUID::toString).collect(Collectors.toList())); + searchRequest.setGermplasmDbIds(new ArrayList<>(brapiGermplasmIds)); } brAPIDAOUtil.setGenericSearchParameters(searchRequest, germplasmQuery); @@ -452,7 +452,7 @@ private BrAPIGermplasmSearchRequest buildSearchRequest(Program program, List result = brapiGermplasmSearchReturnList(program, List.of(UUID.fromString(germplasmId))); + List result = brapiGermplasmSearchReturnList(program, List.of(germplasmId)); if (result.size() > 1) { throw new ApiException(String.format("Multiple germplasms found for germplasm with ID: [%s]", germplasmId)); @@ -464,14 +464,10 @@ public BrAPIGermplasm getGermplasmByUUID(String germplasmId, UUID programId) thr } public List getGermplasmsByDBID(Collection germplasmDbIds, UUID programId) throws ApiException { - // TODO: Optimize by utilizing a BrAPIGermplasmSearchRequest [BI-3028] - Map cache = programGermplasmCache.get(programId); - //key is UUID, want to filter by DBID - List germplasm = new ArrayList<>(); - if (cache != null) { - germplasm = cache.values().stream().filter(x -> germplasmDbIds.contains(x.getGermplasmDbId())).collect(Collectors.toList()); - } - return germplasm; + // TODO: This method is mainly used by the download experiment export tool. This method will fail until we address the parameter limit for async Germplasm requests for germplasmDbIds > 4. Return to this use case during [BI-3021] + Program program = new Program(programDAO.fetchOneById(programId)); + + return brapiGermplasmSearchReturnList(program, new ArrayList<>(germplasmDbIds)); } public List putGermplasm(List germplasmList, GermplasmApi api) throws ApiException { From 40c5f71f597a25f9952f2cc9e606d7e1505488bc Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Tue, 1 Sep 2026 17:19:25 -0400 Subject: [PATCH 057/102] Add comments to fix during BrAPI endpoint fixing --- .../brapi/v2/BrAPIObservationUnitController.java | 1 + .../breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java | 4 ++-- .../org/breedinginsight/brapi/v2/dao/BrAPIPedigreeDAO.java | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitController.java b/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitController.java index 2be39af43..625816256 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitController.java +++ b/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitController.java @@ -226,6 +226,7 @@ private void setDbIds(BrAPIObservationUnit ou) { ou.programDbId(Utilities.getExternalReference(ou.getExternalReferences(), Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.PROGRAMS)) .orElseThrow(() -> new IllegalStateException("No BI external reference found")) .getReferenceID()); + // TODO: Remove this as part of [BI-3006] if (ou.getAdditionalInfo().has(BrAPIAdditionalInfoFields.GERMPLASM_UUID)) { ou.setGermplasmDbId(ou.getAdditionalInfo() .get(BrAPIAdditionalInfoFields.GERMPLASM_UUID) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java index 550dc9b56..5406ea134 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java @@ -316,7 +316,7 @@ public List getObservationUnits(Program program, .orElse(true); //adding filter for germplasmDbId because we can't easily search that in the stored data object - // TODO: Add search on accessionNumber once it's been added to prod server and brapi client [BI-2978] + // TODO: Add search on germplasmDbId directly in search request [BI-3006] return matches && germplasmId.map(id -> id.equals(ou.getAdditionalInfo().get(BrAPIAdditionalInfoFields.GERMPLASM_UUID).getAsString())).orElse(true); }).collect(Collectors.toList()); } @@ -382,7 +382,7 @@ private void processObservationUnits(Program program, List HashMap germplasmByDbId = new HashMap<>(); if( withGID ){ - // TODO: Optimize this to use germplasm information directly in BrAPIObservationUnit by adding accession num/GID there via the prodserver/client [BI-2978] + // TODO: Optimize this to use germplasm information directly in BrAPIObservationUnit by searching on ou.germplasmDbIds in a GermplasmSearchRequest [BI-3006] this.germplasmService.getGermplasm(program.getId()).forEach((germplasm -> germplasmByDbId.put(germplasm.getGermplasmDbId(), germplasm))); } diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIPedigreeDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIPedigreeDAO.java index 3a164c07d..b89a28e7e 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIPedigreeDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIPedigreeDAO.java @@ -85,7 +85,7 @@ public List getPedigree( PedigreeQueryParams pedigreeRequest = new PedigreeQueryParams(); - // TODO: Issue with BrAPI server programDbId filtering, think germplasm are linked to program through observation + // TODO: Issue with BrAPI server programDbId filtering, think germplasm are linked to program through observation [BI- // units and doesn't work if don't have any loaded // use external refs instead for now //pedigreeSearchRequest.programDbIds(List.of(program.getBrapiProgram().getProgramDbId())); From 54ada76697d57cf52dd2bfe796bd84a4b78d0ae8 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Wed, 2 Sep 2026 15:14:48 -0400 Subject: [PATCH 058/102] Untagnle pedigree male/female UUID setting, use brapiGermplasmDbIds for this --- .../processors/germplasm/GermplasmProcessor.java | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapps/importer/services/processors/germplasm/GermplasmProcessor.java b/src/main/java/org/breedinginsight/brapps/importer/services/processors/germplasm/GermplasmProcessor.java index e0eaf3c53..a942bae3c 100644 --- a/src/main/java/org/breedinginsight/brapps/importer/services/processors/germplasm/GermplasmProcessor.java +++ b/src/main/java/org/breedinginsight/brapps/importer/services/processors/germplasm/GermplasmProcessor.java @@ -842,10 +842,7 @@ else if (germplasmIndexByEntryNo.containsKey(germplasm.getFemaleParentEntryNo()) //entry number no longer needed for figuring out parentage, can remove (since same germplasm can have different entry numbers across multiple lists) brAPIGermplasm.putAdditionalInfoItem(BrAPIAdditionalInfoFields.GERMPLASM_FEMALE_PARENT_ENTRY_NO, null); // Add femaleParentUUID to additionalInfo. - Optional femaleParentUUID = Utilities.getExternalReference(femaleParent.getExternalReferences(), BRAPI_REFERENCE_SOURCE); - if (femaleParentUUID.isPresent()) { - brAPIGermplasm.putAdditionalInfoItem(BrAPIAdditionalInfoFields.GERMPLASM_FEMALE_PARENT_UUID, femaleParentUUID.get().getReferenceID()); - } + brAPIGermplasm.putAdditionalInfoItem(BrAPIAdditionalInfoFields.GERMPLASM_FEMALE_PARENT_UUID, femaleParent.getGermplasmDbId()); } if (maleParent != null) { @@ -853,10 +850,8 @@ else if (germplasmIndexByEntryNo.containsKey(germplasm.getFemaleParentEntryNo()) //entry number no longer needed for figuring out parentage, can remove (since same germplasm can have different entry numbers across multiple lists) brAPIGermplasm.putAdditionalInfoItem(BrAPIAdditionalInfoFields.GERMPLASM_MALE_PARENT_ENTRY_NO, null); // Add maleParentUUID to additionalInfo. - Optional maleParentUUID = Utilities.getExternalReference(maleParent.getExternalReferences(), BRAPI_REFERENCE_SOURCE); - if (maleParentUUID.isPresent()) { - brAPIGermplasm.putAdditionalInfoItem(BrAPIAdditionalInfoFields.GERMPLASM_MALE_PARENT_UUID, maleParentUUID.get().getReferenceID()); - } } + brAPIGermplasm.putAdditionalInfoItem(BrAPIAdditionalInfoFields.GERMPLASM_MALE_PARENT_UUID, maleParent.getGermplasmDbId()); + } } } } From 0196eb706379bd65537e8e862cde5399241436e3 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Fri, 4 Sep 2026 14:46:02 -0400 Subject: [PATCH 059/102] Reverse changes to setting male/femaleParentUUID to germplasmDbId, implement stopgap hack Unit tests made me aware of the use case where rows in a gemrplasm import can reference other rows in the import as parents, and when this happens, no germplasmDbId will be created until the germplasm is fully imported because of the way the import is organized. Until we manage to change this, I've created a stop-gap which will mutate this additional info on the fly from the bi-generated exrefs to the brapiGermplasmDbIds in the BrAPIGermplasmDAO.processGermplasmForDisplay method. This will lookup the germplasmDbIds of the pedigree nodes using the exrefs, and will mutate the additional info records for male/female IDs so that the links still work as expected in the frontend UI --- .../brapi/v2/dao/BrAPIGermplasmDAO.java | 96 ++++++++++++++++--- .../germplasm/GermplasmProcessor.java | 11 ++- 2 files changed, 89 insertions(+), 18 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java index ca896441e..ad1f6424e 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java @@ -188,14 +188,14 @@ private Map fetchProgramGermplasm(UUID programId) throws api::searchGermplasmPost, api::searchGermplasmSearchResultsDbIdGet, germplasmSearch), - program.getKey()); + program); } else { log.debug("Fetching germplasm without pagination to BrAPI"); return processGermplasmForDisplay(brAPIDAOUtil.searchNoPaging( api::searchGermplasmPost, api::searchGermplasmSearchResultsDbIdGet, germplasmSearch), - program.getKey()); + program); } } @@ -209,7 +209,8 @@ public void repopulateGermplasmCacheForProgram(UUID programId) { * @return Map * @throws ApiException */ - private Map processGermplasmForDisplay(List programGermplasm, String programKey) { + private Map processGermplasmForDisplay(List programGermplasm, + Program program) throws ApiException { // Process the germplasm Map programGermplasmMap = new HashMap<>(); log.trace("processing germ for display: " + programGermplasm); @@ -227,12 +228,23 @@ private Map processGermplasmForDisplay(Listmale/femaleParentUUID. (See GermplasmProcessor.constructPedigreeString() for assignment of this data) + // To avoid completely re-working the importer to create pedigree nodes and associated germplasm referenced first, this "hack" relates the bi-generated exrefs + // to the brapi-generated germplasmDbId via an extra lookup and processing to the database. + // This is necessary because we need to overwrite bi-generated ids in the pedigree string to use the brapi germplasmDbIds so that front end reference links work properly. + // This should always work because processGermplasmForDisplay is only ever called once Germplasm data has been created in the database, and provided we improve lookups to not fetch + // all program germplasm at once, the performance hit should be negligible. + // TODO: This hack can be removed once/if we implement [BI-2588/BI-2452] + Map pedigreeBrAPIGermplasmDbIdByBICreatedExRef = getPedigreeGermplasmDbIdByBICreatedExRef(programGermplasm, program); + // Update pedigree string for (BrAPIGermplasm germplasm: programGermplasm) { JsonObject additionalInfo = germplasm.getAdditionalInfo(); @@ -260,7 +272,7 @@ private Map processGermplasmForDisplay(List processGermplasmForDisplay(List processGermplasmForDisplay(List processGermplasmForDisplay(List getPedigreeGermplasmDbIdByBICreatedExRef(List brAPIGermplasm, Program program) throws ApiException { + Map germplasmDbIdByGeneratedExRef = new HashMap<>(); + + for (BrAPIGermplasm germplasm : brAPIGermplasm) { + if (germplasm.getAdditionalInfo().has(BrAPIAdditionalInfoFields.GERMPLASM_FEMALE_PARENT_UUID)) { + germplasmDbIdByGeneratedExRef.put(germplasm.getAdditionalInfo().get(BrAPIAdditionalInfoFields.GERMPLASM_FEMALE_PARENT_UUID).getAsString(), null); + } + if (germplasm.getAdditionalInfo().has(BrAPIAdditionalInfoFields.GERMPLASM_MALE_PARENT_UUID)) { + germplasmDbIdByGeneratedExRef.put(germplasm.getAdditionalInfo().get(BrAPIAdditionalInfoFields.GERMPLASM_MALE_PARENT_UUID).getAsString(), null); + } + } + + List exRefIds = new ArrayList<>(germplasmDbIdByGeneratedExRef.keySet()); + + BrAPIGermplasmSearchRequest searchRequest = new BrAPIGermplasmSearchRequest(); + searchRequest.setExternalReferenceIds(exRefIds); + searchRequest.setExternalReferenceSources(List.of(referenceSource)); + + // Reuse some code to properly set searchRequest with brapiProgramDbId, and proper paging + searchRequest = buildSearchRequest(program, null, null, searchRequest); + + GermplasmApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(program.getId()), GermplasmApi.class); + + + List germplasmSearchedWithExRef = brAPIDAOUtil.searchNoPaging( + api::searchGermplasmPost, + api::searchGermplasmSearchResultsDbIdGet, + searchRequest); + + for (BrAPIGermplasm germplasm : germplasmSearchedWithExRef) { + Optional exRef = Utilities.getExternalReference(germplasm.getExternalReferences(), referenceSource); + + if (exRef.isPresent()) { + germplasmDbIdByGeneratedExRef.put(exRef.get().getReferenceId(), germplasm.getGermplasmDbId()); + } else { + throw new IllegalStateException("External references wasn't found for germplasm (dbid): " + germplasm.getGermplasmDbId()); + } + } + + return germplasmDbIdByGeneratedExRef; + } + /** * This method requires a BI-API program. If the BrAPIProgram inside this data model is not set, * this method will retrieve it. @@ -336,7 +392,7 @@ private List getBrAPIGermplasmUsingBrAPIProgramId(GermplasmQuery List result = brAPIDAOUtil.get(api::germplasmGet, germplasmQueryParams); // TODO: Once cache is removed for this class, fix processGermplasmForDisplay to return List [BI-2906] - return new ArrayList<>(processGermplasmForDisplay(result, program.getKey()).values()); + return new ArrayList<>(processGermplasmForDisplay(result, program).values()); } // TODO: hack for now, probably should update breedbase @@ -369,11 +425,11 @@ private String processBreedbasePedigree(String pedigree) { public List createBrAPIGermplasm(List postBrAPIGermplasmList, UUID programId, ImportUpload upload) { GermplasmApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(programId), GermplasmApi.class); - var program = programDAO.fetchOneById(programId); + var program = new Program(programDAO.fetchOneById(programId)); try { if (!postBrAPIGermplasmList.isEmpty()) { List postResponse = brAPIDAOUtil.post(postBrAPIGermplasmList, upload, api::germplasmPost, importDAO::update); - return new ArrayList<>(processGermplasmForDisplay(postResponse, program.getKey()).values()); + return new ArrayList<>(processGermplasmForDisplay(postResponse, program).values()); } return new ArrayList<>(); } catch (Exception e) { @@ -383,12 +439,12 @@ public List createBrAPIGermplasm(List postBrAPIG public List updateBrAPIGermplasm(List putBrAPIGermplasmList, UUID programId, ImportUpload upload) { GermplasmApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(programId), GermplasmApi.class); - var program = programDAO.fetchOneById(programId); + var program = new Program(programDAO.fetchOneById(programId)); try { if (!putBrAPIGermplasmList.isEmpty()) { Callable> postFunction = () -> { List putResponse = putGermplasm(putBrAPIGermplasmList, api); - return processGermplasmForDisplay(putResponse, program.getKey()); + return processGermplasmForDisplay(putResponse, program); }; return programGermplasmCache.post(programId, postFunction); } @@ -428,15 +484,25 @@ public BrAPIGermplasmListResponse brapiGermplasmSearchReturnResponse(Program pro // TODO: Once cache is removed for this class, fix processGermplasmForDisplay to return List [BI-2906] List processedGermplasm = - new ArrayList<>(processGermplasmForDisplay(brAPIDAOUtil.getListResult(brAPIResponse), program.getKey()).values()); + new ArrayList<>(processGermplasmForDisplay(brAPIDAOUtil.getListResult(brAPIResponse), program).values()); brAPIResponse.getResult().setData(processedGermplasm); return brAPIResponse; } - private BrAPIGermplasmSearchRequest buildSearchRequest(Program program, List brapiGermplasmIds, GermplasmQuery germplasmQuery) throws ApiException { - BrAPIGermplasmSearchRequest searchRequest = new BrAPIGermplasmSearchRequest(); + private BrAPIGermplasmSearchRequest buildSearchRequest(Program program, List brapiGermplasmIds, GermplasmQuery query) throws ApiException { + return buildSearchRequest(program, brapiGermplasmIds, query, null); + } + + private BrAPIGermplasmSearchRequest buildSearchRequest(Program program, List brapiGermplasmIds, GermplasmQuery germplasmQuery, BrAPIGermplasmSearchRequest searchRequestPassThru) throws ApiException { + BrAPIGermplasmSearchRequest searchRequest; + + if (searchRequestPassThru == null) { + searchRequest = new BrAPIGermplasmSearchRequest(); + } else { + searchRequest = searchRequestPassThru; + } searchRequest.programDbIds(List.of(brAPIDAOUtil.getBrAPIProgramDbId(program.getId()))); diff --git a/src/main/java/org/breedinginsight/brapps/importer/services/processors/germplasm/GermplasmProcessor.java b/src/main/java/org/breedinginsight/brapps/importer/services/processors/germplasm/GermplasmProcessor.java index a942bae3c..e0eaf3c53 100644 --- a/src/main/java/org/breedinginsight/brapps/importer/services/processors/germplasm/GermplasmProcessor.java +++ b/src/main/java/org/breedinginsight/brapps/importer/services/processors/germplasm/GermplasmProcessor.java @@ -842,7 +842,10 @@ else if (germplasmIndexByEntryNo.containsKey(germplasm.getFemaleParentEntryNo()) //entry number no longer needed for figuring out parentage, can remove (since same germplasm can have different entry numbers across multiple lists) brAPIGermplasm.putAdditionalInfoItem(BrAPIAdditionalInfoFields.GERMPLASM_FEMALE_PARENT_ENTRY_NO, null); // Add femaleParentUUID to additionalInfo. - brAPIGermplasm.putAdditionalInfoItem(BrAPIAdditionalInfoFields.GERMPLASM_FEMALE_PARENT_UUID, femaleParent.getGermplasmDbId()); + Optional femaleParentUUID = Utilities.getExternalReference(femaleParent.getExternalReferences(), BRAPI_REFERENCE_SOURCE); + if (femaleParentUUID.isPresent()) { + brAPIGermplasm.putAdditionalInfoItem(BrAPIAdditionalInfoFields.GERMPLASM_FEMALE_PARENT_UUID, femaleParentUUID.get().getReferenceID()); + } } if (maleParent != null) { @@ -850,8 +853,10 @@ else if (germplasmIndexByEntryNo.containsKey(germplasm.getFemaleParentEntryNo()) //entry number no longer needed for figuring out parentage, can remove (since same germplasm can have different entry numbers across multiple lists) brAPIGermplasm.putAdditionalInfoItem(BrAPIAdditionalInfoFields.GERMPLASM_MALE_PARENT_ENTRY_NO, null); // Add maleParentUUID to additionalInfo. - brAPIGermplasm.putAdditionalInfoItem(BrAPIAdditionalInfoFields.GERMPLASM_MALE_PARENT_UUID, maleParent.getGermplasmDbId()); - } + Optional maleParentUUID = Utilities.getExternalReference(maleParent.getExternalReferences(), BRAPI_REFERENCE_SOURCE); + if (maleParentUUID.isPresent()) { + brAPIGermplasm.putAdditionalInfoItem(BrAPIAdditionalInfoFields.GERMPLASM_MALE_PARENT_UUID, maleParentUUID.get().getReferenceID()); + } } } } } From 22622741f48ca8378072b502e4ca23893e4e2ac7 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Fri, 4 Sep 2026 15:32:51 -0400 Subject: [PATCH 060/102] Fix unit test --- .../breedinginsight/services/BrAPIGermplasmServiceUnitTest.java | 1 + 1 file changed, 1 insertion(+) diff --git a/src/test/java/org/breedinginsight/services/BrAPIGermplasmServiceUnitTest.java b/src/test/java/org/breedinginsight/services/BrAPIGermplasmServiceUnitTest.java index a47a3eebb..127feb94c 100644 --- a/src/test/java/org/breedinginsight/services/BrAPIGermplasmServiceUnitTest.java +++ b/src/test/java/org/breedinginsight/services/BrAPIGermplasmServiceUnitTest.java @@ -155,6 +155,7 @@ public void getGermplasmListExport() { when(programDAO.getProgramBrAPI(any())).thenReturn(brapiProgram); when(brAPIDAOUtil.get(any(Function.class), any(GermplasmQueryParams.class))).thenReturn(germplasm); + when(brAPIDAOUtil.getBrAPIProgramDbId(any())).thenReturn(brapiProgramDbId); //Create germplasm cache of stub data Method setupMethod = BrAPIGermplasmDAO.class.getDeclaredMethod("setup"); From b215bcced612c8f5ab472b0027d5d23e23315c0c Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Wed, 9 Sep 2026 18:03:48 -0400 Subject: [PATCH 061/102] Address review comments --- .../brapi/v2/dao/BrAPIGermplasmDAO.java | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java index ad1f6424e..bfd207896 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java @@ -20,6 +20,7 @@ import com.google.gson.JsonObject; import io.micronaut.context.annotation.Context; import io.micronaut.context.annotation.Property; +import io.micronaut.http.HttpStatus; import io.micronaut.http.server.exceptions.InternalServerException; import io.micronaut.scheduling.annotation.Scheduled; import lombok.extern.slf4j.Slf4j; @@ -335,15 +336,35 @@ private Map processGermplasmForDisplay(List getPedigreeGermplasmDbIdByBICreatedExRef(List brAPIGermplasm, Program program) throws ApiException { Map germplasmDbIdByGeneratedExRef = new HashMap<>(); + // First, utilize initialized map to store all related parent bi-generated exref IDs. for (BrAPIGermplasm germplasm : brAPIGermplasm) { + if (germplasm.getAdditionalInfo() == null) { + continue; + } if (germplasm.getAdditionalInfo().has(BrAPIAdditionalInfoFields.GERMPLASM_FEMALE_PARENT_UUID)) { + try { + UUID.fromString(germplasm.getAdditionalInfo().get(BrAPIAdditionalInfoFields.GERMPLASM_FEMALE_PARENT_UUID).getAsString()); + } catch (IllegalArgumentException e) { + throw new ApiException(HttpStatus.INTERNAL_SERVER_ERROR.getCode(), String.format("Germplasm with BrAPI dbId [%s] has an additionalInfo.femaleParentUUID that is not a UUID", germplasm.getGermplasmDbId())); + } germplasmDbIdByGeneratedExRef.put(germplasm.getAdditionalInfo().get(BrAPIAdditionalInfoFields.GERMPLASM_FEMALE_PARENT_UUID).getAsString(), null); } if (germplasm.getAdditionalInfo().has(BrAPIAdditionalInfoFields.GERMPLASM_MALE_PARENT_UUID)) { + try { + UUID.fromString(germplasm.getAdditionalInfo().get(BrAPIAdditionalInfoFields.GERMPLASM_MALE_PARENT_UUID).getAsString()); + } catch (IllegalArgumentException e) { + throw new ApiException(HttpStatus.INTERNAL_SERVER_ERROR.getCode(), String.format("Germplasm with BrAPI dbId [%s] has an additionalInfo.maleParentUUID that is not a UUID", germplasm.getGermplasmDbId())); + } germplasmDbIdByGeneratedExRef.put(germplasm.getAdditionalInfo().get(BrAPIAdditionalInfoFields.GERMPLASM_MALE_PARENT_UUID).getAsString(), null); } } + if (germplasmDbIdByGeneratedExRef.isEmpty()) { + // If there are none, no reason to proceed with a BrAPI search. + return germplasmDbIdByGeneratedExRef; + } + + // Now grab all male/female exrefs and search for them to get their germplasmDbIds List exRefIds = new ArrayList<>(germplasmDbIdByGeneratedExRef.keySet()); BrAPIGermplasmSearchRequest searchRequest = new BrAPIGermplasmSearchRequest(); @@ -356,6 +377,9 @@ private Map getPedigreeGermplasmDbIdByBICreatedExRef(List germplasmSearchedWithExRef = brAPIDAOUtil.searchNoPaging( api::searchGermplasmPost, api::searchGermplasmSearchResultsDbIdGet, From 52b867429dad1685835a9a4951f009a6da5c238e Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Wed, 9 Sep 2026 18:05:57 -0400 Subject: [PATCH 062/102] Improvements to be based hack --- .../brapi/v2/dao/BrAPIGermplasmDAO.java | 42 ++++++++++++++----- 1 file changed, 32 insertions(+), 10 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java index bfd207896..7e7cfeb59 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java @@ -189,14 +189,16 @@ private Map fetchProgramGermplasm(UUID programId) throws api::searchGermplasmPost, api::searchGermplasmSearchResultsDbIdGet, germplasmSearch), - program); + program, + true); } else { log.debug("Fetching germplasm without pagination to BrAPI"); return processGermplasmForDisplay(brAPIDAOUtil.searchNoPaging( api::searchGermplasmPost, api::searchGermplasmSearchResultsDbIdGet, germplasmSearch), - program); + program, + true); } } @@ -204,6 +206,10 @@ public void repopulateGermplasmCacheForProgram(UUID programId) { programGermplasmCache.populate(programId); } + private Map processGermplasmForDisplay(List programGermplasm, + Program program) throws ApiException { + return processGermplasmForDisplay(programGermplasm, program, false); + } /** * Process germplasm into a format for display * @param programGermplasm @@ -211,7 +217,8 @@ public void repopulateGermplasmCacheForProgram(UUID programId) { * @throws ApiException */ private Map processGermplasmForDisplay(List programGermplasm, - Program program) throws ApiException { + Program program, + boolean pedigreeExRefMutation) throws ApiException { // Process the germplasm Map programGermplasmMap = new HashMap<>(); log.trace("processing germ for display: " + programGermplasm); @@ -244,7 +251,12 @@ private Map processGermplasmForDisplay(List pedigreeBrAPIGermplasmDbIdByBICreatedExRef = getPedigreeGermplasmDbIdByBICreatedExRef(programGermplasm, program); + Map pedigreeBrAPIGermplasmDbIdByBICreatedExRef = null; + + if (pedigreeExRefMutation) { + // Only perform this operation for callers that require it + pedigreeBrAPIGermplasmDbIdByBICreatedExRef = getPedigreeGermplasmDbIdByBICreatedExRef(programGermplasm, program); + } // Update pedigree string for (BrAPIGermplasm germplasm: programGermplasm) { @@ -284,8 +296,14 @@ private Map processGermplasmForDisplay(List processGermplasmForDisplay(List getBrAPIGermplasmUsingBrAPIProgramId(GermplasmQuery List result = brAPIDAOUtil.get(api::germplasmGet, germplasmQueryParams); // TODO: Once cache is removed for this class, fix processGermplasmForDisplay to return List [BI-2906] - return new ArrayList<>(processGermplasmForDisplay(result, program).values()); + return new ArrayList<>(processGermplasmForDisplay(result, program, true).values()); } // TODO: hack for now, probably should update breedbase @@ -508,7 +530,7 @@ public BrAPIGermplasmListResponse brapiGermplasmSearchReturnResponse(Program pro // TODO: Once cache is removed for this class, fix processGermplasmForDisplay to return List [BI-2906] List processedGermplasm = - new ArrayList<>(processGermplasmForDisplay(brAPIDAOUtil.getListResult(brAPIResponse), program).values()); + new ArrayList<>(processGermplasmForDisplay(brAPIDAOUtil.getListResult(brAPIResponse), program, true).values()); brAPIResponse.getResult().setData(processedGermplasm); From cc4bae00549ca6277309aad623f7cf409b302304 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Thu, 10 Sep 2026 18:13:52 -0400 Subject: [PATCH 063/102] Restrict pedigree string mutation usage to pulls size 200 and below --- .env.template | 2 ++ .../brapi/v2/dao/BrAPIGermplasmDAO.java | 25 +++++++++---------- src/main/resources/application.yml | 2 ++ 3 files changed, 16 insertions(+), 13 deletions(-) diff --git a/.env.template b/.env.template index 0e768adcd..73ff2d89e 100644 --- a/.env.template +++ b/.env.template @@ -79,3 +79,5 @@ TRIAL_START_DELAY=15s TRAIT_START_DELAY=20s OBSERVATION_START_DELAY=25s OBSERVATION_UNIT_START_DELAY=30s + +DATA_TABLE_MAX_SIZE=200 \ No newline at end of file diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java index 7e7cfeb59..59e4776c9 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java @@ -75,6 +75,9 @@ public class BrAPIGermplasmDAO { @Property(name = "brapi.paginate.germplasm") private boolean paginateGermplasm; + @Property(name = "data-table.max-size") + private int dataTableMaxSize; + private final ProgramCache programGermplasmCache; private final BrAPIEndpointProvider brAPIEndpointProvider; @@ -189,27 +192,20 @@ private Map fetchProgramGermplasm(UUID programId) throws api::searchGermplasmPost, api::searchGermplasmSearchResultsDbIdGet, germplasmSearch), - program, - true); + program); } else { log.debug("Fetching germplasm without pagination to BrAPI"); return processGermplasmForDisplay(brAPIDAOUtil.searchNoPaging( api::searchGermplasmPost, api::searchGermplasmSearchResultsDbIdGet, germplasmSearch), - program, - true); + program); } } public void repopulateGermplasmCacheForProgram(UUID programId) { programGermplasmCache.populate(programId); } - - private Map processGermplasmForDisplay(List programGermplasm, - Program program) throws ApiException { - return processGermplasmForDisplay(programGermplasm, program, false); - } /** * Process germplasm into a format for display * @param programGermplasm @@ -217,8 +213,7 @@ private Map processGermplasmForDisplay(List processGermplasmForDisplay(List programGermplasm, - Program program, - boolean pedigreeExRefMutation) throws ApiException { + Program program) throws ApiException { // Process the germplasm Map programGermplasmMap = new HashMap<>(); log.trace("processing germ for display: " + programGermplasm); @@ -253,6 +248,10 @@ private Map processGermplasmForDisplay(List pedigreeBrAPIGermplasmDbIdByBICreatedExRef = null; + // This should ease concerns for extra time pulling this data. The intended usage is for the Germplasm data table, + // but any usage under 200 germs (current data table max size) should not be too large of a hit to the server or database. + boolean pedigreeExRefMutation = programGermplasm.size() <= dataTableMaxSize; + if (pedigreeExRefMutation) { // Only perform this operation for callers that require it pedigreeBrAPIGermplasmDbIdByBICreatedExRef = getPedigreeGermplasmDbIdByBICreatedExRef(programGermplasm, program); @@ -438,7 +437,7 @@ private List getBrAPIGermplasmUsingBrAPIProgramId(GermplasmQuery List result = brAPIDAOUtil.get(api::germplasmGet, germplasmQueryParams); // TODO: Once cache is removed for this class, fix processGermplasmForDisplay to return List [BI-2906] - return new ArrayList<>(processGermplasmForDisplay(result, program, true).values()); + return new ArrayList<>(processGermplasmForDisplay(result, program).values()); } // TODO: hack for now, probably should update breedbase @@ -530,7 +529,7 @@ public BrAPIGermplasmListResponse brapiGermplasmSearchReturnResponse(Program pro // TODO: Once cache is removed for this class, fix processGermplasmForDisplay to return List [BI-2906] List processedGermplasm = - new ArrayList<>(processGermplasmForDisplay(brAPIDAOUtil.getListResult(brAPIResponse), program, true).values()); + new ArrayList<>(processGermplasmForDisplay(brAPIDAOUtil.getListResult(brAPIResponse), program).values()); brAPIResponse.getResult().setData(processedGermplasm); diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml index d58a8d8d2..7114763f0 100644 --- a/src/main/resources/application.yml +++ b/src/main/resources/application.yml @@ -237,3 +237,5 @@ startup: trait: ${TRAIT_START_DELAY:2s} observation: ${OBSERVATION_START_DELAY:3s} observation_unit: ${OBSERVATION_UNIT_START_DELAY:3s} +data-table: + max-size: ${DATA_TABLE_MAX_SIZE:200} From 6ce44fe7a5aaf1d1b6fa55da83be917185400dc5 Mon Sep 17 00:00:00 2001 From: humsika Date: Fri, 11 Sep 2026 12:06:33 -0400 Subject: [PATCH 064/102] BI-2921: Removed remaining ProgramCache operations from BrAPIStudyDAO. --- .../brapi/v2/dao/BrAPICachedDAO.java | 15 ---- .../brapi/v2/dao/BrAPIStudyDAO.java | 87 ++++--------------- .../brapi/v2/services/BrAPITrialService.java | 2 - .../ExperimentControllerIntegrationTest.java | 3 + .../brapi/v2/dao/BrAPIStudyDAOUnitTest.java | 38 +++++--- 5 files changed, 43 insertions(+), 102 deletions(-) delete mode 100644 src/main/java/org/breedinginsight/brapi/v2/dao/BrAPICachedDAO.java diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPICachedDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPICachedDAO.java deleted file mode 100644 index 2d623b02b..000000000 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPICachedDAO.java +++ /dev/null @@ -1,15 +0,0 @@ -package org.breedinginsight.brapi.v2.dao; - -import org.breedinginsight.daos.cache.ProgramCache; - -import java.util.UUID; - -public abstract class BrAPICachedDAO { - - protected ProgramCache programCache; - - public void repopulateCache(UUID programId) { - this.programCache.invalidate(programId); - this.programCache.populate(programId); - } -} diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java index 2f2b808e0..69339e9a2 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java @@ -19,7 +19,6 @@ import com.google.gson.JsonObject; import io.micronaut.context.annotation.Property; import io.micronaut.http.server.exceptions.InternalServerException; -import io.micronaut.scheduling.annotation.Scheduled; import lombok.extern.slf4j.Slf4j; import org.brapi.client.v2.model.exceptions.ApiException; import org.brapi.client.v2.model.queryParams.core.StudyQueryParams; @@ -32,7 +31,6 @@ import org.breedinginsight.brapps.importer.model.ImportUpload; import org.breedinginsight.brapps.importer.services.ExternalReferenceSource; import org.breedinginsight.daos.ProgramDAO; -import org.breedinginsight.daos.cache.ProgramCacheProvider; import org.breedinginsight.model.Program; import org.breedinginsight.services.brapi.BrAPIEndpointProvider; import org.breedinginsight.utilities.BrAPIDAOUtil; @@ -42,16 +40,14 @@ import javax.inject.Singleton; import javax.validation.constraints.NotNull; import java.util.*; -import java.util.concurrent.Callable; import java.util.stream.Collectors; @Slf4j @Singleton -public class BrAPIStudyDAO extends BrAPICachedDAO { +public class BrAPIStudyDAO { @Property(name = "brapi.server.reference-source") private String referenceSource; - @Property(name = "micronaut.bi.api.run-scheduled-tasks") - private boolean runScheduledTasks; + @Property(name = "brapi.cache.fetch-page-size") private int brapiMaxPageSize; @@ -61,52 +57,15 @@ public class BrAPIStudyDAO extends BrAPICachedDAO { private final BrAPIEndpointProvider brAPIEndpointProvider; @Inject - public BrAPIStudyDAO(ProgramDAO programDAO, ImportDAO importDAO, BrAPIDAOUtil brAPIDAOUtil, BrAPIEndpointProvider brAPIEndpointProvider, ProgramCacheProvider programCacheProvider) { + public BrAPIStudyDAO( + ProgramDAO programDAO, + ImportDAO importDAO, + BrAPIDAOUtil brAPIDAOUtil, + BrAPIEndpointProvider brAPIEndpointProvider) { // NEW this.programDAO = programDAO; this.importDAO = importDAO; this.brAPIDAOUtil = brAPIDAOUtil; this.brAPIEndpointProvider = brAPIEndpointProvider; - this.programCache = programCacheProvider.getProgramCache(this::fetchProgramStudy, BrAPIStudy.class); - } - - @Scheduled(initialDelay = "${startup.delay.study}") - public void setup() { - if(!runScheduledTasks) { - return; - } - // Populate study cache for all programs on startup - log.debug("populating study cache"); - List programs = programDAO.getActive(); - if(programs != null) { - programCache.populate(programs.stream().map(Program::getId).collect(Collectors.toList())); - } - } - - - /** - * Fetch formatted study for this program - * @param programId - * @return Map - Key = string representing study UUID, value = formatted BrAPIStudy - * @throws ApiException - */ - private Map fetchProgramStudy(UUID programId) throws ApiException { - StudiesApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(programId), StudiesApi.class); - // Get the program key - List programs = programDAO.get(programId); - if (programs.size() != 1) { - throw new InternalServerException("Program was not found for given key"); - } - Program program = programs.get(0); - - // Set query params and make call - BrAPIStudySearchRequest studySearch = new BrAPIStudySearchRequest(); - studySearch.externalReferenceIDs(List.of(programId.toString())); - studySearch.externalReferenceSources(List.of(Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.PROGRAMS))); - return processStudyForDisplay(brAPIDAOUtil.search( - api::searchStudiesPost, - api::searchStudiesSearchResultsDbIdGet, - studySearch - ), program.getKey()); } /** @@ -201,39 +160,23 @@ public List getStudiesByExperimentIds(@NotNull Collection expe public List createBrAPIStudies(List brAPIStudyList, UUID programId, ImportUpload upload) throws ApiException { StudiesApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(programId), StudiesApi.class); - List createdStudies = new ArrayList<>(); + try { if (!brAPIStudyList.isEmpty()) { - Callable> postCallback = () -> { - List postedStudies = brAPIDAOUtil - .post(brAPIStudyList, upload, api::studiesPost, importDAO::update); - return environmentById(postedStudies); - }; - createdStudies.addAll(programCache.post(programId, postCallback)); + //Create studies directly through BrAPI. + List postedStudies = brAPIDAOUtil.post(brAPIStudyList, upload, api::studiesPost, importDAO::update); + + // Return the BrAPI response without updating Redis. + return postedStudies; } - return createdStudies; + // Preserve the existing empty-input behavior. + return new ArrayList<>(); } catch (Exception e) { throw new InternalServerException("Unknown error has occurred: " + e.getMessage(), e); } } - /** - * @return Map - Key = BI external reference ID, Value = BrAPIStudy - * */ - private Map environmentById(List studies) { - Map environmentById = new HashMap<>(); - for (BrAPIStudy environment: studies) { - BrAPIExternalReference xref = environment - .getExternalReferences() - .stream() - .filter(reference -> String.format("%s/%s", referenceSource, ExternalReferenceSource.STUDIES.getName()).equals(reference.getReferenceSource())) - .findFirst().orElseThrow(() -> new IllegalStateException("No BI external reference found")); - environmentById.put(xref.getReferenceID(), environment); - } - return environmentById; - } - public List getStudiesByStudyDbId(Collection studyDbIds, Program program) throws ApiException { if(studyDbIds.isEmpty()) { return Collections.emptyList(); diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java index e698df2e6..f6a78c695 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPITrialService.java @@ -814,8 +814,6 @@ public int deleteExperiment(Program program, UUID experimentId, boolean hard) th for (BrAPIListSummary list : lists) { listDAO.deleteBrAPIList(list.getListDbId(), program.getId(), hard); } - // TODO: if performance is poor, implement more precise invalidation, possibly using hierarchical cache keys. - studyDAO.repopulateCache(program.getId()); } // Successful or not, return the number of observations in this experiment. diff --git a/src/test/java/org/breedinginsight/api/v1/controller/ExperimentControllerIntegrationTest.java b/src/test/java/org/breedinginsight/api/v1/controller/ExperimentControllerIntegrationTest.java index 36055121a..f1b5e9ce8 100644 --- a/src/test/java/org/breedinginsight/api/v1/controller/ExperimentControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/api/v1/controller/ExperimentControllerIntegrationTest.java @@ -16,6 +16,7 @@ import org.apache.commons.io.FileUtils; import org.apache.commons.lang3.StringUtils; import org.brapi.v2.model.BrAPIExternalReference; +import org.brapi.v2.model.core.BrAPIStudy; import org.brapi.v2.model.core.BrAPITrial; import org.brapi.v2.model.germ.BrAPIGermplasm; import org.breedinginsight.BrAPITest; @@ -218,6 +219,8 @@ void setup() throws Exception { envIds.clear(); brAPIStudyDAO.getStudies(program.getId()) + .stream() + .sorted(Comparator.comparing(BrAPIStudy::getStudyName)) .forEach(study -> envIds.add(study.getStudyDbId())); } diff --git a/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAOUnitTest.java b/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAOUnitTest.java index 3dda7b8e3..95cf4a73a 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAOUnitTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAOUnitTest.java @@ -16,6 +16,7 @@ */ package org.breedinginsight.brapi.v2.dao; +import io.reactivex.functions.Consumer; import io.reactivex.functions.Function; import io.reactivex.functions.Function3; import lombok.SneakyThrows; @@ -26,11 +27,9 @@ import org.brapi.v2.model.core.BrAPIStudy; import org.brapi.v2.model.core.request.BrAPIStudySearchRequest; import org.breedinginsight.brapps.importer.daos.ImportDAO; +import org.breedinginsight.brapps.importer.model.ImportUpload; import org.breedinginsight.brapps.importer.services.ExternalReferenceSource; import org.breedinginsight.daos.ProgramDAO; -import org.breedinginsight.daos.cache.FetchFunction; -import org.breedinginsight.daos.cache.ProgramCache; -import org.breedinginsight.daos.cache.ProgramCacheProvider; import org.breedinginsight.model.Program; import org.breedinginsight.services.brapi.BrAPIEndpointProvider; import org.breedinginsight.utilities.BrAPIDAOUtil; @@ -56,7 +55,6 @@ public class BrAPIStudyDAOUnitTest { private BrAPIStudyDAO studyDAO; private ProgramDAO programDAO; private BrAPIDAOUtil brAPIDAOUtil; - private ProgramCache programCache; private Program program; private UUID programId; private UUID environmentId; @@ -76,11 +74,7 @@ void setup() { programDAO = mock(ProgramDAO.class); brAPIDAOUtil = mock(BrAPIDAOUtil.class); - ProgramCacheProvider programCacheProvider = mock(ProgramCacheProvider.class); - programCache = mock(ProgramCache.class); - when(programCacheProvider.getProgramCache(any(FetchFunction.class), eq(BrAPIStudy.class))) - .thenReturn(programCache); when(programDAO.get(programId)).thenReturn(List.of(program)); when(programDAO.getCoreClient(programId)).thenReturn(mock(BrAPIClient.class)); when(programDAO.getProgramBrAPI(program)).thenReturn(brapiProgram); @@ -89,8 +83,7 @@ void setup() { programDAO, mock(ImportDAO.class), brAPIDAOUtil, - new BrAPIEndpointProvider(), - programCacheProvider + new BrAPIEndpointProvider() ); Field referenceSource = BrAPIStudyDAO.class.getDeclaredField("referenceSource"); @@ -119,7 +112,6 @@ void getStudiesUsesDirectBrAPIGetInsteadOfProgramCache() { assertEquals("brapi-program-1", queryParamsCaptor.getValue().programDbId()); assertEquals(0, queryParamsCaptor.getValue().page()); assertEquals(1000, queryParamsCaptor.getValue().pageSize()); - verify(programCache, never()).get(any(UUID.class)); } @Test @@ -143,8 +135,6 @@ void getStudiesByStudyDbIdUsesDirectBrAPISearch() { assertEquals(List.of("brapi-program-1"), requestCaptor.getValue().getProgramDbIds()); assertEquals(List.of(studyDbId), requestCaptor.getValue().getStudyDbIds()); - - verify(programCache, never()).get(any(UUID.class)); } @Test @@ -158,6 +148,28 @@ void getStudyByDbIdReturnsEmptyWhenBrAPIDoesNotFindStudy() { assertTrue(result.isEmpty()); } + @Test + @SneakyThrows + void createBrAPIStudiesReturnsDirectBrAPIPostResponse() { + + BrAPIStudy requestedStudy = new BrAPIStudy().studyName("Env1 [TEST-1]"); + List requestedStudies = List.of(requestedStudy); + + BrAPIStudy createdStudy = new BrAPIStudy().studyDbId("study-db-id").studyName("Env1 [TEST-1]"); + ImportUpload upload = mock(ImportUpload.class); + + doReturn(List.of(createdStudy)) + .when(brAPIDAOUtil) + .post(eq(requestedStudies),eq(upload),any(Function.class),any(Consumer.class)); + + List result = studyDAO.createBrAPIStudies(requestedStudies,programId,upload); + + assertEquals(1, result.size()); + assertEquals("study-db-id",result.get(0).getStudyDbId()); + + verify(brAPIDAOUtil).post(eq(requestedStudies),eq(upload),any(Function.class),any(Consumer.class)); + } + private BrAPIStudy study(UUID environmentId, String studyName) { BrAPIExternalReference studyReference = new BrAPIExternalReference() .referenceSource(Utilities.generateReferenceSource(REFERENCE_SOURCE, ExternalReferenceSource.STUDIES)) From 5bef696149260d51886ba733df4035dae30f3708 Mon Sep 17 00:00:00 2001 From: humsika Date: Sun, 13 Sep 2026 23:00:44 -0400 Subject: [PATCH 065/102] BI-2921: Formatted the file. --- .../java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java index 69339e9a2..079bf11a1 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java @@ -61,7 +61,7 @@ public BrAPIStudyDAO( ProgramDAO programDAO, ImportDAO importDAO, BrAPIDAOUtil brAPIDAOUtil, - BrAPIEndpointProvider brAPIEndpointProvider) { // NEW + BrAPIEndpointProvider brAPIEndpointProvider) { this.programDAO = programDAO; this.importDAO = importDAO; this.brAPIDAOUtil = brAPIDAOUtil; From d9d6798d27c40a02cbaedf91426407ee276422c4 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Mon, 14 Sep 2026 18:50:06 -0400 Subject: [PATCH 066/102] Remove rest of CRUD operations from BrAPIGermplasmDAO --- .../brapi/v2/dao/BrAPIGermplasmDAO.java | 31 ++----------------- .../germplasm/GermplasmProcessor.java | 2 -- .../importer/GermplasmFileImportTest.java | 3 -- .../BrAPIGermplasmServiceUnitTest.java | 9 +----- 4 files changed, 3 insertions(+), 42 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java index ad1f6424e..48bcee916 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java @@ -68,14 +68,9 @@ public class BrAPIGermplasmDAO { @Property(name = "brapi.server.reference-source") private String referenceSource; - @Property(name = "micronaut.bi.api.run-scheduled-tasks") - private boolean runScheduledTasks; - @Property(name = "brapi.paginate.germplasm") private boolean paginateGermplasm; - private final ProgramCache programGermplasmCache; - private final BrAPIEndpointProvider brAPIEndpointProvider; private final int brapiMaxPageSize; @@ -84,30 +79,15 @@ public class BrAPIGermplasmDAO { public BrAPIGermplasmDAO(ProgramDAO programDAO, ImportDAO importDAO, BrAPIDAOUtil brAPIDAOUtil, - ProgramCacheProvider programCacheProvider, BrAPIEndpointProvider brAPIEndpointProvider, @Property(name = "brapi.cache.fetch-page-size") int brapiFetchPageSize) { this.programDAO = programDAO; this.importDAO = importDAO; this.brAPIDAOUtil = brAPIDAOUtil; - this.programGermplasmCache = programCacheProvider.getProgramCache(this::fetchProgramGermplasm, BrAPIGermplasm.class); this.brAPIEndpointProvider = brAPIEndpointProvider; this.brapiMaxPageSize = brapiFetchPageSize; } - @Scheduled(initialDelay = "${startup.delay.germplasm}") - public void setup() { - if(!runScheduledTasks) { - return; - } - // Populate germplasm cache for all programs on startup - log.debug("populating germplasm cache"); - List programs = programDAO.getActive(); - if(programs != null) { - programGermplasmCache.populate(programs.stream().map(Program::getId).collect(Collectors.toList())); - } - } - /** * Fetch the germplasm for this program, and process it to remove storage specific values * @param programId @@ -199,10 +179,6 @@ private Map fetchProgramGermplasm(UUID programId) throws } } - public void repopulateGermplasmCacheForProgram(UUID programId) { - programGermplasmCache.populate(programId); - } - /** * Process germplasm into a format for display * @param programGermplasm @@ -442,11 +418,8 @@ public List updateBrAPIGermplasm(List putBrAPIGe var program = new Program(programDAO.fetchOneById(programId)); try { if (!putBrAPIGermplasmList.isEmpty()) { - Callable> postFunction = () -> { - List putResponse = putGermplasm(putBrAPIGermplasmList, api); - return processGermplasmForDisplay(putResponse, program); - }; - return programGermplasmCache.post(programId, postFunction); + List putResponse = putGermplasm(putBrAPIGermplasmList, api); + return new ArrayList<>(processGermplasmForDisplay(putResponse, program).values()); } return new ArrayList<>(); } catch (Exception e) { diff --git a/src/main/java/org/breedinginsight/brapps/importer/services/processors/germplasm/GermplasmProcessor.java b/src/main/java/org/breedinginsight/brapps/importer/services/processors/germplasm/GermplasmProcessor.java index e0eaf3c53..4ea4d7963 100644 --- a/src/main/java/org/breedinginsight/brapps/importer/services/processors/germplasm/GermplasmProcessor.java +++ b/src/main/java/org/breedinginsight/brapps/importer/services/processors/germplasm/GermplasmProcessor.java @@ -724,8 +724,6 @@ public void postBrapiData(Map mappedBrAPIImport, Program try { // Create germplasm list brAPIListDAO.createBrAPILists(List.of(importList), program.getId(), upload); - // Now that we have finished uploading, fetch all the data posted to BrAPI to the cache so it is up-to-date. - brAPIGermplasmDAO.repopulateGermplasmCacheForProgram(program.getId()); } catch (ApiException e) { throw new InternalServerException(e.toString(), e); } diff --git a/src/test/java/org/breedinginsight/brapps/importer/GermplasmFileImportTest.java b/src/test/java/org/breedinginsight/brapps/importer/GermplasmFileImportTest.java index 2673b0353..7916df3e1 100644 --- a/src/test/java/org/breedinginsight/brapps/importer/GermplasmFileImportTest.java +++ b/src/test/java/org/breedinginsight/brapps/importer/GermplasmFileImportTest.java @@ -1257,8 +1257,5 @@ private void seedExistingGermplasm(String accessionNumber, String displayName, S germplasm.setExternalReferences(externalReferences); germplasmDAO.createBrAPIGermplasm(List.of(germplasm), validProgram.getId(), null); - - //Refresh cache so importer lookup sees the seeded germplasm immediately. - germplasmDAO.repopulateGermplasmCacheForProgram(validProgram.getId()); } } diff --git a/src/test/java/org/breedinginsight/services/BrAPIGermplasmServiceUnitTest.java b/src/test/java/org/breedinginsight/services/BrAPIGermplasmServiceUnitTest.java index 127feb94c..7251b02e9 100644 --- a/src/test/java/org/breedinginsight/services/BrAPIGermplasmServiceUnitTest.java +++ b/src/test/java/org/breedinginsight/services/BrAPIGermplasmServiceUnitTest.java @@ -51,7 +51,6 @@ public class BrAPIGermplasmServiceUnitTest extends DatabaseTest { private BrAPIGermplasmService germplasmService; private BrAPIDAOUtil brAPIDAOUtil; private String referenceSource; - private ProgramCacheProvider cacheProvider; @SneakyThrows @BeforeEach @@ -61,8 +60,7 @@ void setup() { listDAO = mock(BrAPIListDAO.class); programDAO = mock(ProgramDAO.class); brAPIDAOUtil = mock(BrAPIDAOUtil.class); - cacheProvider = new ProgramCacheProvider(super.getRedisConnection()); - germplasmDAO = new BrAPIGermplasmDAO(programDAO, mock(ImportDAO.class), brAPIDAOUtil, cacheProvider, new BrAPIEndpointProvider(), 65000); + germplasmDAO = new BrAPIGermplasmDAO(programDAO, mock(ImportDAO.class), brAPIDAOUtil, new BrAPIEndpointProvider(), 65000); programService = mock(ProgramService.class); Field externalReferenceSource = BrAPIGermplasmDAO.class.getDeclaredField("referenceSource"); @@ -157,11 +155,6 @@ public void getGermplasmListExport() { any(GermplasmQueryParams.class))).thenReturn(germplasm); when(brAPIDAOUtil.getBrAPIProgramDbId(any())).thenReturn(brapiProgramDbId); - //Create germplasm cache of stub data - Method setupMethod = BrAPIGermplasmDAO.class.getDeclaredMethod("setup"); - setupMethod.setAccessible(true); - setupMethod.invoke(germplasmDAO); - //Create test instance of service, injecting spy- and mock-dependencies germplasmService = new BrAPIGermplasmService(brAPIListSpy, programSpy, germplasmDAO); From f9fd37def6c32616697bb5afff68321ab5f65515 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Thu, 17 Sep 2026 08:27:00 -0400 Subject: [PATCH 067/102] Remove unused germplasmFetch --- .../brapi/v2/dao/BrAPIGermplasmDAO.java | 38 ------------------- 1 file changed, 38 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java index c806d3eb2..8602b2fc3 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java @@ -145,44 +145,6 @@ public List getRawGermplasm(UUID programId) throws ApiException }).collect(Collectors.toList()); } - - /** - * Fetch formatted germplasm for this program - * @param programId - * @return Map - * @throws ApiException - */ - private Map fetchProgramGermplasm(UUID programId) throws ApiException { - GermplasmApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(programId), GermplasmApi.class); - // Get the program key - List programs = programDAO.get(programId); - if (programs.size() != 1) { - throw new InternalServerException("Program was not found for given key"); - } - Program program = programs.get(0); - - // Set query params and make call - BrAPIGermplasmSearchRequest germplasmSearch = new BrAPIGermplasmSearchRequest(); - germplasmSearch.externalReferenceIDs(List.of(programId.toString())); - germplasmSearch.externalReferenceSources(List.of(Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.PROGRAMS))); - - if (paginateGermplasm) { - log.debug("Fetching germplasm with pagination to BrAPI"); - return processGermplasmForDisplay(brAPIDAOUtil.search( - api::searchGermplasmPost, - api::searchGermplasmSearchResultsDbIdGet, - germplasmSearch), - program); - } else { - log.debug("Fetching germplasm without pagination to BrAPI"); - return processGermplasmForDisplay(brAPIDAOUtil.searchNoPaging( - api::searchGermplasmPost, - api::searchGermplasmSearchResultsDbIdGet, - germplasmSearch), - program); - } - } - /** * Process germplasm into a format for display * @param programGermplasm From 3eda7eb64df1029fb2d55d2bb3b617ce6a65082d Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Thu, 17 Sep 2026 08:47:33 -0400 Subject: [PATCH 068/102] Remove imports --- .../brapi/v2/dao/BrAPIGermplasmDAO.java | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java index 8602b2fc3..a90d46bc8 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java @@ -18,18 +18,14 @@ package org.breedinginsight.brapi.v2.dao; import com.google.gson.JsonObject; -import io.micronaut.context.annotation.Context; import io.micronaut.context.annotation.Property; import io.micronaut.http.HttpStatus; import io.micronaut.http.server.exceptions.InternalServerException; -import io.micronaut.scheduling.annotation.Scheduled; import lombok.extern.slf4j.Slf4j; -import org.apache.commons.lang3.tuple.Pair; import org.brapi.client.v2.ApiResponse; import org.brapi.client.v2.model.exceptions.ApiException; import org.brapi.client.v2.model.queryParams.germplasm.GermplasmQueryParams; import org.brapi.client.v2.modules.germplasm.GermplasmApi; -import org.brapi.v2.model.BrAPIAcceptedSearchResponse; import org.brapi.v2.model.BrAPIExternalReference; import org.brapi.v2.model.core.BrAPIProgram; import org.brapi.v2.model.germ.BrAPIGermplasm; @@ -41,10 +37,7 @@ import org.breedinginsight.brapi.v2.model.request.query.GermplasmQuery; import org.breedinginsight.brapps.importer.daos.ImportDAO; import org.breedinginsight.brapps.importer.model.ImportUpload; -import org.breedinginsight.brapps.importer.services.ExternalReferenceSource; import org.breedinginsight.daos.ProgramDAO; -import org.breedinginsight.daos.cache.ProgramCache; -import org.breedinginsight.daos.cache.ProgramCacheProvider; import org.breedinginsight.model.Program; import org.breedinginsight.services.brapi.BrAPIEndpointProvider; import org.breedinginsight.services.exceptions.DoesNotExistException; @@ -54,12 +47,10 @@ import javax.inject.Inject; import javax.inject.Singleton; import java.util.*; -import java.util.concurrent.Callable; import java.util.stream.Collectors; @Slf4j @Singleton -@Context public class BrAPIGermplasmDAO { private final ProgramDAO programDAO; @@ -69,9 +60,6 @@ public class BrAPIGermplasmDAO { @Property(name = "brapi.server.reference-source") private String referenceSource; - @Property(name = "brapi.paginate.germplasm") - private boolean paginateGermplasm; - @Property(name = "data-table.max-size") private int dataTableMaxSize; From c838dc5eaa30c649acd85e9f83ea08d9473d9c4d Mon Sep 17 00:00:00 2001 From: humsika Date: Tue, 22 Sep 2026 10:54:47 -0500 Subject: [PATCH 069/102] BI-2922: Made the changes required to call the prod server directly with the params. --- .../brapi/v2/BrAPIStudiesController.java | 33 +-- .../brapi/v2/dao/BrAPIStudyDAO.java | 43 +++- .../v2/model/request/query/StudyQuery.java | 68 +++--- .../brapi/v2/services/BrAPIStudyService.java | 11 + ...BrAPIStudiesControllerIntegrationTest.java | 42 ++++ .../v2/BrAPIStudiesControllerUnitTest.java | 200 ++++++++++++++++++ .../brapi/v2/dao/BrAPIStudyDAOUnitTest.java | 87 +++++++- .../request/query/StudyQueryUnitTest.java | 76 +++++++ 8 files changed, 511 insertions(+), 49 deletions(-) create mode 100644 src/test/java/org/breedinginsight/brapi/v2/BrAPIStudiesControllerUnitTest.java create mode 100644 src/test/java/org/breedinginsight/brapi/v2/model/request/query/StudyQueryUnitTest.java diff --git a/src/main/java/org/breedinginsight/brapi/v2/BrAPIStudiesController.java b/src/main/java/org/breedinginsight/brapi/v2/BrAPIStudiesController.java index 66e21c055..88f7095c4 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/BrAPIStudiesController.java +++ b/src/main/java/org/breedinginsight/brapi/v2/BrAPIStudiesController.java @@ -28,12 +28,12 @@ import org.brapi.v2.model.BrAPIMetadata; import org.brapi.v2.model.BrAPIStatus; import org.brapi.v2.model.core.BrAPIStudy; +import org.brapi.v2.model.core.response.BrAPIStudyListResponse; import org.brapi.v2.model.core.response.BrAPIStudySingleResponse; import org.breedinginsight.api.auth.ProgramSecured; import org.breedinginsight.api.auth.ProgramSecuredRole; import org.breedinginsight.api.auth.ProgramSecuredRoleGroup; import org.breedinginsight.api.auth.SecurityService; -import org.breedinginsight.api.model.v1.request.query.SearchRequest; import org.breedinginsight.api.model.v1.response.DataResponse; import org.breedinginsight.api.model.v1.response.Response; import org.breedinginsight.api.model.v1.validators.QueryValid; @@ -87,31 +87,40 @@ public BrAPIStudiesController(BrAPIStudyService studyService, @Produces(MediaType.APPLICATION_JSON) @ProgramSecured( roles = {ProgramSecuredRole.SYSTEM_ADMIN, ProgramSecuredRole.READ_ONLY, ProgramSecuredRole.PROGRAM_ADMIN ,ProgramSecuredRole.EXPERIMENTAL_COLLABORATOR} ) - public HttpResponse>>> getStudies( + public HttpResponse>> getStudies( @PathVariable("programId") UUID programId, @QueryValue @QueryValid(using = StudyQueryMapper.class) @Valid StudyQuery queryParams) { try { Optional program = programService.getById(programId); if (program.isEmpty()) { return HttpResponse.notFound(); } - queryParams.setSortField(studyQueryMapper.getDefaultSortField()); - queryParams.setSortOrder(studyQueryMapper.getDefaultSortOrder()); - SearchRequest searchRequest = queryParams.constructSearchRequest(); + if (queryParams.getSortField() == null) { + queryParams.setSortField(studyQueryMapper.getDefaultSortField()); + } + if (queryParams.getSortOrder() == null) { + queryParams.setSortOrder(studyQueryMapper.getDefaultSortOrder()); + } log.debug("fetching studies for program: " + programId); // If the program user is an experimental collaborator, filter results for only authorized studies. Optional experimentalCollaborator = programUserService.getIfExperimentalCollaborator(programId, securityService.getUser().getId()); if (experimentalCollaborator.isPresent()) { List authorizedExperimentIds = experimentalCollaboratorService.getAuthorizedExperimentIds(experimentalCollaborator.get().getId()); - List authorizedStudies = studyService.getStudiesByExperimentIds( - program.get(), - authorizedExperimentIds); - return ResponseUtils.getBrapiQueryResponse(authorizedStudies, studyQueryMapper, queryParams, searchRequest); + if (authorizedExperimentIds.isEmpty()) { + return ResponseUtils.getEmptyBrapiQueryResponse(); + } + + BrAPIStudyListResponse brapiResponse = studyService.searchStudies( + program.get(), + authorizedExperimentIds, + queryParams); + List foundStudies = brapiResponse.getResult().getData(); + return ResponseUtils.getBrapiQueryResponse(foundStudies, brapiResponse); } - // TODO: Instead of getting all studies for a program and filtering, doing the filtering on brapi side [BI-2922] - List studies = studyService.getStudies(programId); - return ResponseUtils.getBrapiQueryResponse(studies, studyQueryMapper, queryParams, searchRequest); + BrAPIStudyListResponse brapiResponse = studyService.searchStudies(program.get(), queryParams); + List foundStudies = brapiResponse.getResult().getData(); + return ResponseUtils.getBrapiQueryResponse(foundStudies, brapiResponse); } catch (ApiException e) { log.info(e.getMessage(), e); return HttpResponse.status(HttpStatus.INTERNAL_SERVER_ERROR, "Error retrieving study"); diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java index 079bf11a1..02734954f 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java @@ -27,6 +27,8 @@ import org.brapi.v2.model.core.BrAPIProgram; import org.brapi.v2.model.core.BrAPIStudy; import org.brapi.v2.model.core.request.BrAPIStudySearchRequest; +import org.brapi.v2.model.core.response.BrAPIStudyListResponse; +import org.breedinginsight.brapi.v2.model.request.query.StudyQuery; import org.breedinginsight.brapps.importer.daos.ImportDAO; import org.breedinginsight.brapps.importer.model.ImportUpload; import org.breedinginsight.brapps.importer.services.ExternalReferenceSource; @@ -83,6 +85,45 @@ public List getStudies(UUID programId) throws ApiException { return getBrAPIStudiesUsingBrAPIProgramId(program); } + public BrAPIStudyListResponse brapiStudySearch(Program program, StudyQuery studyQuery) throws ApiException { + return brapiStudySearch(program, Collections.emptyList(), studyQuery); + } + + public BrAPIStudyListResponse brapiStudySearch(Program program, List brapiTrialIds, + StudyQuery studyQuery) throws ApiException { + StudiesApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(program.getId()), StudiesApi.class); + + BrAPIStudySearchRequest brAPIStudySearchRequest = buildSearchRequest(program, brapiTrialIds, studyQuery); + + BrAPIStudyListResponse brAPIResponse = brAPIDAOUtil.simpleSearch(api::searchStudiesPost, brAPIStudySearchRequest); + + List processedStudies = new ArrayList<>(processStudyForDisplay(brAPIDAOUtil.getListResult(brAPIResponse), program.getKey()).values()); + + brAPIResponse.getResult().setData(processedStudies); + + return brAPIResponse; + } + + private BrAPIStudySearchRequest buildSearchRequest(Program program, List brapiTrialIds, StudyQuery studyQuery) { + BrAPIProgram brAPIProgram = programDAO.getProgramBrAPI(program); + + if (brAPIProgram == null || brAPIProgram.getProgramDbId() == null) { + throw new InternalServerException(String.format("BI program with id [%s] not found in BrAPI db", program.getId())); + } + + BrAPIStudySearchRequest searchRequest = new BrAPIStudySearchRequest(); + + searchRequest.programDbIds(List.of(brAPIProgram.getProgramDbId())); + + if (brapiTrialIds != null && !brapiTrialIds.isEmpty()) { + searchRequest.setTrialDbIds(brapiTrialIds.stream().map(UUID::toString).collect(Collectors.toList())); + } + + brAPIDAOUtil.setGenericSearchParameters(searchRequest, studyQuery); + + return searchRequest; + } + private List getBrAPIStudiesUsingBrAPIProgramId(Program program) throws ApiException { if (program == null || program.getId() == null) { throw new InternalServerException("BI-API Program or Program ID is null"); @@ -205,7 +246,7 @@ public Optional getStudyByDbId(String studyDbId, Program program) th * @return Map - Key = string representing study UUID, value = formatted BrAPIStudy */ private Map processStudyForDisplay(List programStudy, String programKey) { - Map programStudyMap = new HashMap<>(); + Map programStudyMap = new LinkedHashMap<>(); log.trace("processing study for display: " + programStudy); for (BrAPIStudy study: programStudy) { // Remove program key from studyName, trialName and locationName. diff --git a/src/main/java/org/breedinginsight/brapi/v2/model/request/query/StudyQuery.java b/src/main/java/org/breedinginsight/brapi/v2/model/request/query/StudyQuery.java index 5c3d6bfeb..edd228be1 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/model/request/query/StudyQuery.java +++ b/src/main/java/org/breedinginsight/brapi/v2/model/request/query/StudyQuery.java @@ -8,7 +8,9 @@ import org.jooq.tools.StringUtils; import java.util.ArrayList; +import java.util.HashMap; import java.util.List; +import java.util.Map; @Getter @Introspected @@ -24,38 +26,38 @@ public class StudyQuery extends BrapiQuery { private String externalReferenceSource; private String externalReferenceId; - public SearchRequest constructSearchRequest() { - List filters = new ArrayList<>(); - if (!StringUtils.isBlank(getStudyType())) { - filters.add(constructFilterRequest("studyType", getStudyType())); - } - if (!StringUtils.isBlank(getLocationDbId())) { - filters.add(constructFilterRequest("locationDbId", getLocationDbId())); - } - if (!StringUtils.isBlank(getStudyCode())) { - filters.add(constructFilterRequest("studyCode", getStudyCode())); - } - if (!StringUtils.isBlank(getStudyPUI())) { - filters.add(constructFilterRequest("studyPUI", getStudyPUI())); - } - if (!StringUtils.isBlank(getCommonCropName())) { - filters.add(constructFilterRequest("commonCropName", getCommonCropName())); - } - if (!StringUtils.isBlank(getTrialDbId())) { - filters.add(constructFilterRequest("trialDbId", getTrialDbId())); - } - if (!StringUtils.isBlank(getStudyDbId())) { - filters.add(constructFilterRequest("studyDbId", getStudyDbId())); - } - if (!StringUtils.isBlank(getStudyName())) { - filters.add(constructFilterRequest("studyName", getStudyName())); - } - if (!StringUtils.isBlank(getExternalReferenceSource())) { - filters.add(constructFilterRequest("externalReferenceSource", getExternalReferenceSource())); - } - if (!StringUtils.isBlank(getExternalReferenceId())) { - filters.add(constructFilterRequest("externalReferenceId", getExternalReferenceId())); - } - return new SearchRequest(filters); + @Override + public Map getFilterValuesByBrAPIColumnName() { + Map filterValuesByBrAPIColumnName = new HashMap<>(); + + filterValuesByBrAPIColumnName.put("studyType", getStudyType()); + filterValuesByBrAPIColumnName.put("locationDbId", getLocationDbId()); + filterValuesByBrAPIColumnName.put("studyCode", getStudyCode()); + filterValuesByBrAPIColumnName.put("studyPUI", getStudyPUI()); + filterValuesByBrAPIColumnName.put("commonCropName", getCommonCropName()); + filterValuesByBrAPIColumnName.put("trialDbId", getTrialDbId()); + filterValuesByBrAPIColumnName.put("studyDbId", getStudyDbId()); + filterValuesByBrAPIColumnName.put("studyName", getStudyName()); + filterValuesByBrAPIColumnName.put("externalReferenceSource", getExternalReferenceSource()); + filterValuesByBrAPIColumnName.put("externalReferenceId", getExternalReferenceId()); + + return filterValuesByBrAPIColumnName; } + + @Override + public Map getBrAPIColumnNamesByBiColumnName() { + Map brAPIColumnNamesByBiColumnName = new HashMap<>(); + + brAPIColumnNamesByBiColumnName.put("studyType", "studyType"); + brAPIColumnNamesByBiColumnName.put("locationDbId", "locationDbId"); + brAPIColumnNamesByBiColumnName.put("studyCode", "studyCode"); + brAPIColumnNamesByBiColumnName.put("studyPUI", "studyPUI"); + brAPIColumnNamesByBiColumnName.put("commonCropName", "commonCropName"); + brAPIColumnNamesByBiColumnName.put("trialDbId", "trialDbId"); + brAPIColumnNamesByBiColumnName.put("studyDbId", "studyDbId"); + brAPIColumnNamesByBiColumnName.put("studyName", "studyName"); + + return brAPIColumnNamesByBiColumnName; + } + } diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIStudyService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIStudyService.java index 5c9a2e8f0..fea126380 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIStudyService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIStudyService.java @@ -20,7 +20,9 @@ import lombok.extern.slf4j.Slf4j; import org.brapi.client.v2.model.exceptions.ApiException; import org.brapi.v2.model.core.BrAPIStudy; +import org.brapi.v2.model.core.response.BrAPIStudyListResponse; import org.breedinginsight.brapi.v2.dao.BrAPIStudyDAO; +import org.breedinginsight.brapi.v2.model.request.query.StudyQuery; import org.breedinginsight.model.Program; import javax.inject.Inject; @@ -40,6 +42,15 @@ public BrAPIStudyService(BrAPIStudyDAO studyDAO) { this.studyDAO = studyDAO; } + public BrAPIStudyListResponse searchStudies(Program program, StudyQuery studyQuery) throws ApiException { + return studyDAO.brapiStudySearch(program, studyQuery); + } + + public BrAPIStudyListResponse searchStudies(Program program, List authorizedExperimentIds, + StudyQuery studyQuery) throws ApiException { + return studyDAO.brapiStudySearch(program, authorizedExperimentIds, studyQuery); + } + public List getStudies(UUID programId) throws ApiException { return studyDAO.getStudies(programId); } diff --git a/src/test/java/org/breedinginsight/brapi/v2/BrAPIStudiesControllerIntegrationTest.java b/src/test/java/org/breedinginsight/brapi/v2/BrAPIStudiesControllerIntegrationTest.java index b4d4ea906..94db5dd6c 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/BrAPIStudiesControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/BrAPIStudiesControllerIntegrationTest.java @@ -95,6 +95,48 @@ public void testGetStudiesAsExperimentalCollaborator() { assertTrue(studyNames.contains("Env4")); } + @Test + public void testGetStudiesAsExperimentalCollaboratorWithStudyFilter() { + Flowable> call = client.exchange( + GET(String.format("/programs/%s/brapi/v2/studies?studyName=Env3", program.getId())) + .bearerAuth("other-registered-user"), + String.class + ); + + HttpResponse response = call.blockingFirst(); + assertEquals(HttpStatus.OK, response.getStatus()); + + JsonObject responseObj = gson.fromJson(response.body(), JsonObject.class); + JsonArray studies = responseObj.getAsJsonObject("result").getAsJsonArray("data"); + assertEquals(1, studies.size()); + assertEquals("Env3", studies.get(0).getAsJsonObject().get("studyName").getAsString()); + } + + @Test + public void testGetStudiesUsesProdServerSortingAndPagination() { + Flowable> call = client.exchange( + GET(String.format("/programs/%s/brapi/v2/studies?sortField=studyName&sortOrder=DESC&page=1&pageSize=2", + program.getId())) + .bearerAuth("test-registered-user"), + String.class + ); + + HttpResponse response = call.blockingFirst(); + assertEquals(HttpStatus.OK, response.getStatus()); + + JsonObject responseObj = gson.fromJson(response.body(), JsonObject.class); + JsonArray studies = responseObj.getAsJsonObject("result").getAsJsonArray("data"); + assertEquals(2, studies.size()); + assertEquals("Env2", studies.get(0).getAsJsonObject().get("studyName").getAsString()); + assertEquals("Env1", studies.get(1).getAsJsonObject().get("studyName").getAsString()); + + JsonObject pagination = responseObj.getAsJsonObject("metadata").getAsJsonObject("pagination"); + assertEquals(1, pagination.get("currentPage").getAsInt()); + assertEquals(2, pagination.get("pageSize").getAsInt()); + assertEquals(4, pagination.get("totalCount").getAsInt()); + assertEquals(2, pagination.get("totalPages").getAsInt()); + } + @Test @SneakyThrows public void testPostGetStudiesNotFound() { diff --git a/src/test/java/org/breedinginsight/brapi/v2/BrAPIStudiesControllerUnitTest.java b/src/test/java/org/breedinginsight/brapi/v2/BrAPIStudiesControllerUnitTest.java new file mode 100644 index 000000000..2a9991db7 --- /dev/null +++ b/src/test/java/org/breedinginsight/brapi/v2/BrAPIStudiesControllerUnitTest.java @@ -0,0 +1,200 @@ +/* + * See the NOTICE file distributed with this work for additional information + * regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.breedinginsight.brapi.v2; + +import io.micronaut.http.HttpResponse; +import io.micronaut.http.HttpStatus; +import lombok.SneakyThrows; +import org.brapi.v2.model.BrAPIMetadata; +import org.brapi.v2.model.BrAPIPagination; +import org.brapi.v2.model.core.BrAPIStudy; +import org.brapi.v2.model.core.response.BrAPIStudyListResponse; +import org.brapi.v2.model.core.response.BrAPIStudyListResponseResult; +import org.breedinginsight.api.auth.AuthenticatedUser; +import org.breedinginsight.api.auth.SecurityService; +import org.breedinginsight.api.model.v1.response.DataResponse; +import org.breedinginsight.api.model.v1.response.Response; +import org.breedinginsight.api.v1.controller.metadata.SortOrder; +import org.breedinginsight.brapi.v2.model.request.query.StudyQuery; +import org.breedinginsight.brapi.v2.services.BrAPIStudyService; +import org.breedinginsight.model.Program; +import org.breedinginsight.model.ProgramUser; +import org.breedinginsight.services.ExperimentalCollaboratorService; +import org.breedinginsight.services.ProgramService; +import org.breedinginsight.services.ProgramUserService; +import org.breedinginsight.utilities.response.mappers.StudyQueryMapper; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +import java.util.List; +import java.util.Optional; +import java.util.UUID; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.same; +import static org.mockito.Mockito.*; + +class BrAPIStudiesControllerUnitTest { + + private BrAPIStudyService studyService; + private ProgramService programService; + private SecurityService securityService; + private ProgramUserService programUserService; + private ExperimentalCollaboratorService experimentalCollaboratorService; + private BrAPIStudiesController controller; + private Program program; + private UUID programId; + private UUID userId; + + @BeforeEach + void setup() { + studyService = mock(BrAPIStudyService.class); + programService = mock(ProgramService.class); + securityService = mock(SecurityService.class); + programUserService = mock(ProgramUserService.class); + experimentalCollaboratorService = mock(ExperimentalCollaboratorService.class); + + controller = new BrAPIStudiesController( + studyService, + new StudyQueryMapper(), + programService, + securityService, + programUserService, + experimentalCollaboratorService); + + programId = UUID.randomUUID(); + userId = UUID.randomUUID(); + program = new Program(); + program.setId(programId); + + AuthenticatedUser user = new AuthenticatedUser("test-user", List.of(), userId, List.of()); + when(programService.getById(programId)).thenReturn(Optional.of(program)); + when(securityService.getUser()).thenReturn(user); + when(programUserService.getIfExperimentalCollaborator(programId, userId)).thenReturn(Optional.empty()); + } + + @Test + @SneakyThrows + void getStudiesDelegatesQueryToProdServerAndUsesReturnedPagination() { + StudyQuery query = new StudyQuery(); + query.setSortField("studyCode"); + query.setSortOrder(SortOrder.DESC); + query.setPage(1); + query.setPageSize(2); + + List studies = List.of( + new BrAPIStudy().studyName("Environment 2"), + new BrAPIStudy().studyName("Environment 1")); + BrAPIStudyListResponse brAPIResponse = studyResponse(studies, 1, 2, 5); + when(studyService.searchStudies(same(program), same(query))) + .thenReturn(brAPIResponse); + + HttpResponse>> response = controller.getStudies(programId, query); + + assertEquals(HttpStatus.OK, response.getStatus()); + assertEquals(studies, response.body().getResult().getData()); + assertEquals(1, response.body().getMetadata().getPagination().getCurrentPage()); + assertEquals(2, response.body().getMetadata().getPagination().getPageSize()); + assertEquals(5, response.body().getMetadata().getPagination().getTotalCount()); + assertEquals(3, response.body().getMetadata().getPagination().getTotalPages()); + assertEquals("studyCode", query.getSortField()); + assertEquals(SortOrder.DESC, query.getSortOrder()); + + verify(studyService).searchStudies(same(program), same(query)); + verify(studyService, never()).getStudies(any(UUID.class)); + } + + @Test + @SneakyThrows + void getStudiesAppliesDefaultSortOnlyWhenSortIsMissing() { + StudyQuery query = new StudyQuery(); + query.setSortField(null); + query.setSortOrder(null); + BrAPIStudyListResponse brAPIResponse = studyResponse(List.of(), 0, 50, 0); + when(studyService.searchStudies(same(program), same(query))) + .thenReturn(brAPIResponse); + + controller.getStudies(programId, query); + + assertEquals("studyName", query.getSortField()); + assertEquals(SortOrder.ASC, query.getSortOrder()); + verify(studyService).searchStudies(same(program), same(query)); + } + + @Test + @SneakyThrows + void getStudiesLimitsCollaboratorSearchToAuthorizedExperiments() { + StudyQuery query = new StudyQuery(); + ProgramUser collaborator = new ProgramUser(); + UUID programUserRoleId = UUID.randomUUID(); + collaborator.setId(programUserRoleId); + List authorizedExperimentIds = List.of(UUID.randomUUID(), UUID.randomUUID()); + List studies = List.of(new BrAPIStudy().studyName("Authorized Environment")); + + when(programUserService.getIfExperimentalCollaborator(programId, userId)) + .thenReturn(Optional.of(collaborator)); + when(experimentalCollaboratorService.getAuthorizedExperimentIds(programUserRoleId)) + .thenReturn(authorizedExperimentIds); + BrAPIStudyListResponse brAPIResponse = studyResponse(studies, 0, 50, 1); + when(studyService.searchStudies(same(program), same(authorizedExperimentIds), same(query))) + .thenReturn(brAPIResponse); + + HttpResponse>> response = controller.getStudies(programId, query); + + assertEquals(HttpStatus.OK, response.getStatus()); + assertEquals(studies, response.body().getResult().getData()); + verify(studyService).searchStudies(same(program), same(authorizedExperimentIds), same(query)); + verify(studyService, never()).searchStudies(any(Program.class), any(StudyQuery.class)); + } + + @Test + void getStudiesReturnsEmptyResponseWithoutCallingProdServerWhenCollaboratorHasNoAuthorizedExperiments() { + StudyQuery query = new StudyQuery(); + ProgramUser collaborator = new ProgramUser(); + UUID programUserRoleId = UUID.randomUUID(); + collaborator.setId(programUserRoleId); + + when(programUserService.getIfExperimentalCollaborator(programId, userId)) + .thenReturn(Optional.of(collaborator)); + when(experimentalCollaboratorService.getAuthorizedExperimentIds(programUserRoleId)) + .thenReturn(List.of()); + + HttpResponse>> response = controller.getStudies(programId, query); + + assertEquals(HttpStatus.OK, response.getStatus()); + assertTrue(response.body().getResult().getData().isEmpty()); + assertEquals(0, response.body().getMetadata().getPagination().getTotalCount()); + assertEquals(0, response.body().getMetadata().getPagination().getTotalPages()); + verifyNoInteractions(studyService); + } + + private BrAPIStudyListResponse studyResponse(List studies, + int currentPage, + int pageSize, + int totalCount) { + BrAPIPagination pagination = mock(BrAPIPagination.class); + when(pagination.getCurrentPage()).thenReturn(currentPage); + when(pagination.getPageSize()).thenReturn(pageSize); + when(pagination.getTotalCount()).thenReturn(totalCount); + + return new BrAPIStudyListResponse() + .metadata(new BrAPIMetadata().pagination(pagination)) + .result(new BrAPIStudyListResponseResult().data(studies)); + } +} diff --git a/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAOUnitTest.java b/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAOUnitTest.java index 95cf4a73a..58806202e 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAOUnitTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAOUnitTest.java @@ -23,14 +23,22 @@ import org.brapi.client.v2.BrAPIClient; import org.brapi.client.v2.model.queryParams.core.StudyQueryParams; import org.brapi.v2.model.BrAPIExternalReference; +import org.brapi.v2.model.BrAPIMetadata; +import org.brapi.v2.model.BrAPIPagination; +import org.brapi.v2.model.BrAPISortOrder; import org.brapi.v2.model.core.BrAPIProgram; import org.brapi.v2.model.core.BrAPIStudy; import org.brapi.v2.model.core.request.BrAPIStudySearchRequest; +import org.brapi.v2.model.core.response.BrAPIStudyListResponse; +import org.brapi.v2.model.core.response.BrAPIStudyListResponseResult; +import org.breedinginsight.api.v1.controller.metadata.SortOrder; +import org.breedinginsight.brapi.v2.model.request.query.StudyQuery; import org.breedinginsight.brapps.importer.daos.ImportDAO; import org.breedinginsight.brapps.importer.model.ImportUpload; import org.breedinginsight.brapps.importer.services.ExternalReferenceSource; import org.breedinginsight.daos.ProgramDAO; import org.breedinginsight.model.Program; +import org.breedinginsight.services.ProgramService; import org.breedinginsight.services.brapi.BrAPIEndpointProvider; import org.breedinginsight.utilities.BrAPIDAOUtil; import org.breedinginsight.utilities.Utilities; @@ -39,12 +47,14 @@ import org.mockito.ArgumentCaptor; import java.lang.reflect.Field; +import java.time.Duration; import java.util.List; +import java.util.Map; import java.util.Optional; import java.util.UUID; +import java.util.stream.Collectors; -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.junit.jupiter.api.Assertions.*; import static org.mockito.ArgumentMatchers.*; import static org.mockito.Mockito.*; @@ -148,6 +158,67 @@ void getStudyByDbIdReturnsEmptyWhenBrAPIDoesNotFindStudy() { assertTrue(result.isEmpty()); } + @Test + @SneakyThrows + void brapiStudySearchSendsServerSideQueryAndPreservesPagedResponseOrder() { + UUID authorizedTrialId = UUID.randomUUID(); + StudyQuery studyQuery = new StudyQuery(); + setStudyQueryField(studyQuery, "studyName", "Environment"); + studyQuery.setSortField("studyName"); + studyQuery.setSortOrder(SortOrder.DESC); + studyQuery.setPage(1); + studyQuery.setPageSize(2); + + BrAPIDAOUtil genericSearchParameterUtil = new BrAPIDAOUtil(1, Duration.ofSeconds(1), 50, 50, 1000, mock(ProgramService.class)); + doAnswer(invocation -> { + genericSearchParameterUtil.setGenericSearchParameters( + invocation.getArgument(0), + invocation.getArgument(1)); + return null; + }).when(brAPIDAOUtil).setGenericSearchParameters(any(BrAPIStudySearchRequest.class), same(studyQuery)); + + BrAPIPagination pagination = mock(BrAPIPagination.class); + when(pagination.getCurrentPage()).thenReturn(1); + when(pagination.getPageSize()).thenReturn(2); + when(pagination.getTotalCount()).thenReturn(4); + when(pagination.getTotalPages()).thenReturn(2); + + BrAPIStudyListResponse brAPIResponse = new BrAPIStudyListResponse() + .metadata(new BrAPIMetadata().pagination(pagination)) + .result(new BrAPIStudyListResponseResult()); + List serverOrderedStudies = List.of( + study("2", "Environment 2 [TEST-2]"), + study("1", "Environment 1 [TEST-1]")); + + when(brAPIDAOUtil.simpleSearch(any(Function.class), any(BrAPIStudySearchRequest.class))).thenReturn(brAPIResponse); + doReturn(serverOrderedStudies).when(brAPIDAOUtil).getListResult(brAPIResponse); + + BrAPIStudyListResponse result = studyDAO.brapiStudySearch(program, List.of(authorizedTrialId), studyQuery); + + ArgumentCaptor requestCaptor = + ArgumentCaptor.forClass(BrAPIStudySearchRequest.class); + verify(brAPIDAOUtil).simpleSearch(any(Function.class), requestCaptor.capture()); + + BrAPIStudySearchRequest request = requestCaptor.getValue(); + assertEquals(List.of("brapi-program-1"), request.getProgramDbIds()); + assertEquals(List.of(authorizedTrialId.toString()), request.getTrialDbIds()); + assertEquals(1, request.getPage()); + assertEquals(2, request.getPageSize()); + assertEquals(1, request.getSortBy().size()); + assertEquals("studyName", request.getSortBy().get(0).getSortedOn()); + assertEquals(BrAPISortOrder.DESC, request.getSortBy().get(0).getSortOrder()); + + Map filters = request.getFilterBy().stream() + .collect(Collectors.toMap(filter -> filter.getFilterOn(), filter -> filter.getValue())); + assertEquals(Map.of("studyName", "Environment"), filters); + + assertSame(brAPIResponse, result); + assertSame(pagination, result.getMetadata().getPagination()); + assertEquals(List.of("Environment 2", "Environment 1"), result.getResult().getData().stream() + .map(BrAPIStudy::getStudyName) + .collect(Collectors.toList())); + } + @Test @SneakyThrows void createBrAPIStudiesReturnsDirectBrAPIPostResponse() { @@ -171,12 +242,22 @@ void createBrAPIStudiesReturnsDirectBrAPIPostResponse() { } private BrAPIStudy study(UUID environmentId, String studyName) { + return study(environmentId.toString(), studyName); + } + + private BrAPIStudy study(String environmentId, String studyName) { BrAPIExternalReference studyReference = new BrAPIExternalReference() .referenceSource(Utilities.generateReferenceSource(REFERENCE_SOURCE, ExternalReferenceSource.STUDIES)) - .referenceId(environmentId.toString()); + .referenceId(environmentId); return new BrAPIStudy() .studyName(studyName) .externalReferences(List.of(studyReference)); } + + private void setStudyQueryField(StudyQuery studyQuery, String fieldName, String value) throws Exception { + Field field = StudyQuery.class.getDeclaredField(fieldName); + field.setAccessible(true); + field.set(studyQuery, value); + } } diff --git a/src/test/java/org/breedinginsight/brapi/v2/model/request/query/StudyQueryUnitTest.java b/src/test/java/org/breedinginsight/brapi/v2/model/request/query/StudyQueryUnitTest.java new file mode 100644 index 000000000..71b969db1 --- /dev/null +++ b/src/test/java/org/breedinginsight/brapi/v2/model/request/query/StudyQueryUnitTest.java @@ -0,0 +1,76 @@ +/* + * See the NOTICE file distributed with this work for additional information + * regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.breedinginsight.brapi.v2.model.request.query; + +import org.junit.jupiter.api.Test; + +import java.lang.reflect.Field; +import java.util.Map; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +class StudyQueryUnitTest { + + @Test + void exposesAllSupportedStudyFiltersUsingBrAPIColumnNames() throws Exception { + StudyQuery query = new StudyQuery(); + setField(query, "studyType", "Phenotyping"); + setField(query, "locationDbId", "location-1"); + setField(query, "studyCode", "study-code"); + setField(query, "studyPUI", "study-pui"); + setField(query, "commonCropName", "maize"); + setField(query, "trialDbId", "trial-1"); + setField(query, "studyDbId", "study-1"); + setField(query, "studyName", "Environment 1"); + setField(query, "externalReferenceSource", "breedinginsight.org/studies"); + setField(query, "externalReferenceId", "environment-1"); + + assertEquals(Map.ofEntries( + Map.entry("studyType", "Phenotyping"), + Map.entry("locationDbId", "location-1"), + Map.entry("studyCode", "study-code"), + Map.entry("studyPUI", "study-pui"), + Map.entry("commonCropName", "maize"), + Map.entry("trialDbId", "trial-1"), + Map.entry("studyDbId", "study-1"), + Map.entry("studyName", "Environment 1"), + Map.entry("externalReferenceSource", "breedinginsight.org/studies"), + Map.entry("externalReferenceId", "environment-1")), + query.getFilterValuesByBrAPIColumnName()); + } + + @Test + void mapsAllSupportedBiSortFieldsToBrAPIColumnNames() { + assertEquals(Map.ofEntries( + Map.entry("studyType", "studyType"), + Map.entry("locationDbId", "locationDbId"), + Map.entry("studyCode", "studyCode"), + Map.entry("studyPUI", "studyPUI"), + Map.entry("commonCropName", "commonCropName"), + Map.entry("trialDbId", "trialDbId"), + Map.entry("studyDbId", "studyDbId"), + Map.entry("studyName", "studyName")), + new StudyQuery().getBrAPIColumnNamesByBiColumnName()); + } + + private void setField(StudyQuery query, String fieldName, String value) throws Exception { + Field field = StudyQuery.class.getDeclaredField(fieldName); + field.setAccessible(true); + field.set(query, value); + } +} From 58d65e69bff0fc5ec1adbe1cf2dcae683e0248aa Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Thu, 24 Sep 2026 20:20:24 -0400 Subject: [PATCH 070/102] Implement brapi side filtering, sorting, paging for germplasm --- .../brapi/v2/BrAPIGermplasmController.java | 13 ++- .../brapi/v2/dao/BrAPIGermplasmDAO.java | 72 +++++++-------- .../model/request/query/GermplasmQuery.java | 40 +++++++++ .../v2/services/BrAPIGermplasmService.java | 89 +++++++++++++++---- .../GermplasmControllerIntegrationTest.java | 1 + 5 files changed, 159 insertions(+), 56 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/BrAPIGermplasmController.java b/src/main/java/org/breedinginsight/brapi/v2/BrAPIGermplasmController.java index f234c3030..2d39cf251 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/BrAPIGermplasmController.java +++ b/src/main/java/org/breedinginsight/brapi/v2/BrAPIGermplasmController.java @@ -19,6 +19,7 @@ import org.brapi.v2.model.BrAPIIndexPagination; import org.brapi.v2.model.BrAPIMetadata; import org.brapi.v2.model.BrAPIStatus; +import org.brapi.v2.model.core.BrAPITrial; import org.brapi.v2.model.germ.*; import org.brapi.v2.model.germ.request.BrAPIGermplasmSearchRequest; import org.brapi.v2.model.germ.response.BrAPIGermplasmListResponse; @@ -185,7 +186,7 @@ private void batchProcessGermplasm(List germplasmList, String pr @Get("/programs/{programId}" + BrapiVersion.BRAPI_V2 + "/germplasm{?queryParams*}") @Produces(MediaType.APPLICATION_JSON) @ProgramSecured(roleGroups = {ProgramSecuredRoleGroup.PROGRAM_SCOPED_ROLES}) - public HttpResponse>>> getGermplasm( + public HttpResponse>> getGermplasm( @PathVariable("programId") UUID programId, @QueryValue @QueryValid(using = GermplasmQueryMapper.class) @Valid GermplasmQuery queryParams) { try { @@ -198,15 +199,19 @@ public HttpResponse>>> getGermplasm( } // Fetch all germplasm in the program unless a list id is supplied to return only germplasm in that collection - List germplasm = queryParams.getListDbId() == null ? germplasmService.getGermplasm(programId) : germplasmService.getGermplasmByList(programId, queryParams.getListDbId()); - SearchRequest searchRequest = queryParams.constructSearchRequest(); - return ResponseUtils.getBrapiQueryResponse(germplasm, germplasmQueryMapper, queryParams, searchRequest); + BrAPIGermplasmListResponse brapiResponse = queryParams.getListDbId() == null ? germplasmService.searchGermplasm(programId, queryParams) : germplasmService.getGermplasmByList(programId, queryParams); + + List foundTrials = brapiResponse.getResult().getData(); + return ResponseUtils.getBrapiQueryResponse(foundTrials, brapiResponse, queryParams); } catch (ApiException e) { log.info(e.getMessage(), e); return HttpResponse.status(HttpStatus.INTERNAL_SERVER_ERROR, "Error retrieving germplasm"); } catch (IllegalArgumentException e) { log.info(e.getMessage(), e); return HttpResponse.status(HttpStatus.UNPROCESSABLE_ENTITY, "Error parsing requested date format"); + } catch (DoesNotExistException e) { + log.info(e.getMessage(), e); + return HttpResponse.status(HttpStatus.NOT_FOUND, "Supplied programId does not exist"); } } diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java index a90d46bc8..998662370 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java @@ -135,16 +135,15 @@ public List getRawGermplasm(UUID programId) throws ApiException /** * Process germplasm into a format for display - * @param programGermplasm + * @param germplasmToProcess * @return Map * @throws ApiException */ - private Map processGermplasmForDisplay(List programGermplasm, + private List processGermplasmForDisplay(List germplasmToProcess, Program program) throws ApiException { // Process the germplasm - Map programGermplasmMap = new HashMap<>(); - log.trace("processing germ for display: " + programGermplasm); - for (BrAPIGermplasm germplasm: programGermplasm) { + log.trace("processing germ for display: " + germplasmToProcess); + for (BrAPIGermplasm germplasm: germplasmToProcess) { JsonObject additionalInfo = germplasm.getAdditionalInfo(); if (additionalInfo != null && additionalInfo.has(BrAPIAdditionalInfoFields.GERMPLASM_BREEDING_METHOD_ID)) { @@ -177,15 +176,15 @@ private Map processGermplasmForDisplay(List processGermplasmForDisplay(List referenceSource.equals(reference.getReferenceSource())).findFirst().orElseThrow(() -> new IllegalStateException("No BI external reference found")); - String germplasmId = extRef.getReferenceID(); - programGermplasmMap.put(germplasmId, germplasm); + germplasm.setPedigree(gidPedigreeString); } - return programGermplasmMap; + return germplasmToProcess; } private Map getPedigreeGermplasmDbIdByBICreatedExRef(List brAPIGermplasm, Program program) throws ApiException { @@ -320,7 +315,7 @@ private Map getPedigreeGermplasmDbIdByBICreatedExRef(List getBrAPIGermplasmUsingBrAPIProgramId(GermplasmQuery List result = brAPIDAOUtil.get(api::germplasmGet, germplasmQueryParams); // TODO: Once cache is removed for this class, fix processGermplasmForDisplay to return List [BI-2906] - return new ArrayList<>(processGermplasmForDisplay(result, program).values()); + return processGermplasmForDisplay(result, program); } // TODO: hack for now, probably should update breedbase @@ -401,7 +396,7 @@ public List createBrAPIGermplasm(List postBrAPIG try { if (!postBrAPIGermplasmList.isEmpty()) { List postResponse = brAPIDAOUtil.post(postBrAPIGermplasmList, upload, api::germplasmPost, importDAO::update); - return new ArrayList<>(processGermplasmForDisplay(postResponse, program).values()); + return processGermplasmForDisplay(postResponse, program); } return new ArrayList<>(); } catch (Exception e) { @@ -415,7 +410,7 @@ public List updateBrAPIGermplasm(List putBrAPIGe try { if (!putBrAPIGermplasmList.isEmpty()) { List putResponse = putGermplasm(putBrAPIGermplasmList, api); - return new ArrayList<>(processGermplasmForDisplay(putResponse, program).values()); + return processGermplasmForDisplay(putResponse, program); } return new ArrayList<>(); } catch (Exception e) { @@ -432,18 +427,27 @@ public List getGermplasmByRawName(List germplasmNames, U .collect(Collectors.toList()); } + public BrAPIGermplasmListResponse searchGermplasmByRawName(List germplasmNames, UUID programId, GermplasmQuery germplasmQuery) throws ApiException { + Program program = new Program(programDAO.fetchOneById(programId)); + + BrAPIGermplasmSearchRequest searchRequest = new BrAPIGermplasmSearchRequest(); + searchRequest.setGermplasmNames(germplasmNames); + + return brapiGermplasmSearchReturnResponse(program, searchRequest, germplasmQuery); + } + public List brapiGermplasmSearchReturnList(Program program, - List brapiGermplasmIds) throws ApiException { - return brapiGermplasmSearchReturnResponse(program, brapiGermplasmIds, null).getResult().getData(); + BrAPIGermplasmSearchRequest searchRequest) throws ApiException { + return brapiGermplasmSearchReturnResponse(program, searchRequest, null).getResult().getData(); } public BrAPIGermplasmListResponse brapiGermplasmSearchReturnResponse(Program program, - List brapiGermplasmIds, + BrAPIGermplasmSearchRequest searchRequest, GermplasmQuery germplasmQuery) throws ApiException { GermplasmApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(program.getId()), GermplasmApi.class); - BrAPIGermplasmSearchRequest brAPIGermplasmSearchRequest = buildSearchRequest(program, brapiGermplasmIds, germplasmQuery); + BrAPIGermplasmSearchRequest brAPIGermplasmSearchRequest = buildSearchRequest(program, searchRequest, germplasmQuery); BrAPIGermplasmListResponse brAPIResponse = brAPIDAOUtil.simpleSearch( @@ -451,20 +455,14 @@ public BrAPIGermplasmListResponse brapiGermplasmSearchReturnResponse(Program pro brAPIGermplasmSearchRequest ); - // TODO: Once cache is removed for this class, fix processGermplasmForDisplay to return List [BI-2906] - List processedGermplasm = - new ArrayList<>(processGermplasmForDisplay(brAPIDAOUtil.getListResult(brAPIResponse), program).values()); + List processedGermplasm = processGermplasmForDisplay(brAPIDAOUtil.getListResult(brAPIResponse), program); brAPIResponse.getResult().setData(processedGermplasm); return brAPIResponse; } - private BrAPIGermplasmSearchRequest buildSearchRequest(Program program, List brapiGermplasmIds, GermplasmQuery query) throws ApiException { - return buildSearchRequest(program, brapiGermplasmIds, query, null); - } - - private BrAPIGermplasmSearchRequest buildSearchRequest(Program program, List brapiGermplasmIds, GermplasmQuery germplasmQuery, BrAPIGermplasmSearchRequest searchRequestPassThru) throws ApiException { + private BrAPIGermplasmSearchRequest buildSearchRequest(Program program, BrAPIGermplasmSearchRequest searchRequestPassThru, GermplasmQuery germplasmQuery) throws ApiException { BrAPIGermplasmSearchRequest searchRequest; if (searchRequestPassThru == null) { @@ -475,10 +473,6 @@ private BrAPIGermplasmSearchRequest buildSearchRequest(Program program, List(brapiGermplasmIds)); - } - brAPIDAOUtil.setGenericSearchParameters(searchRequest, germplasmQuery); return searchRequest; @@ -487,7 +481,10 @@ private BrAPIGermplasmSearchRequest buildSearchRequest(Program program, List result = brapiGermplasmSearchReturnList(program, List.of(germplasmId)); + BrAPIGermplasmSearchRequest searchRequest = new BrAPIGermplasmSearchRequest(); + searchRequest.setGermplasmDbIds(List.of(germplasmId)); + + List result = brapiGermplasmSearchReturnList(program, searchRequest); if (result.size() > 1) { throw new ApiException(String.format("Multiple germplasms found for germplasm with ID: [%s]", germplasmId)); @@ -502,7 +499,10 @@ public List getGermplasmsByDBID(Collection germplasmDbId // TODO: This method is mainly used by the download experiment export tool. This method will fail until we address the parameter limit for async Germplasm requests for germplasmDbIds > 4. Return to this use case during [BI-3021] Program program = new Program(programDAO.fetchOneById(programId)); - return brapiGermplasmSearchReturnList(program, new ArrayList<>(germplasmDbIds)); + BrAPIGermplasmSearchRequest searchRequest = new BrAPIGermplasmSearchRequest(); + searchRequest.setGermplasmDbIds(new ArrayList<>(germplasmDbIds)); + + return brapiGermplasmSearchReturnList(program, searchRequest); } public List putGermplasm(List germplasmList, GermplasmApi api) throws ApiException { diff --git a/src/main/java/org/breedinginsight/brapi/v2/model/request/query/GermplasmQuery.java b/src/main/java/org/breedinginsight/brapi/v2/model/request/query/GermplasmQuery.java index 81039b7ef..2c1807490 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/model/request/query/GermplasmQuery.java +++ b/src/main/java/org/breedinginsight/brapi/v2/model/request/query/GermplasmQuery.java @@ -8,7 +8,9 @@ import org.jooq.tools.StringUtils; import java.util.ArrayList; +import java.util.HashMap; import java.util.List; +import java.util.Map; @Getter @Introspected @@ -67,4 +69,42 @@ public SearchRequest constructSearchRequest() { } return new SearchRequest(filters); } + + @Override + public Map getFilterValuesByBrAPIColumnName() { + Map filterValuesByBrAPIColumnName = new HashMap<>(); + + filterValuesByBrAPIColumnName.put("importEntryNumber", getImportEntryNumber()); + filterValuesByBrAPIColumnName.put("accessionNumber", getAccessionNumber()); + filterValuesByBrAPIColumnName.put("defaultDisplayName", getDefaultDisplayName()); + filterValuesByBrAPIColumnName.put("breedingMethod", getBreedingMethod()); + filterValuesByBrAPIColumnName.put("seedSource", getSeedSource()); + filterValuesByBrAPIColumnName.put("pedigree", getPedigree()); + filterValuesByBrAPIColumnName.put("femaleParentGID", getFemaleParentGID()); + filterValuesByBrAPIColumnName.put("maleParentGID", getMaleParentGID()); + filterValuesByBrAPIColumnName.put("createdDate", getCreatedDate()); + filterValuesByBrAPIColumnName.put("createdBy", getCreatedByUserName()); + filterValuesByBrAPIColumnName.put("synonyms", getSynonym()); + + return filterValuesByBrAPIColumnName; + } + + @Override + public Map getBrAPIColumnNamesByBiColumnName() { + Map brAPIColumnNamesByBiColumnName = new HashMap<>(); + + brAPIColumnNamesByBiColumnName.put("importEntryNumber", "importEntryNumber"); + brAPIColumnNamesByBiColumnName.put("accessionNumber", "accessionNumber"); + brAPIColumnNamesByBiColumnName.put("defaultDisplayName", "defaultDisplayName"); + brAPIColumnNamesByBiColumnName.put("breedingMethod", "breedingMethod"); + brAPIColumnNamesByBiColumnName.put("seedSource", "seedSource"); + brAPIColumnNamesByBiColumnName.put("pedigree", "pedigree"); + brAPIColumnNamesByBiColumnName.put("femaleParentGID", "femaleParentGID"); + brAPIColumnNamesByBiColumnName.put("maleParentGID", "maleParentGID"); + brAPIColumnNamesByBiColumnName.put("createdDate", "createdDate"); + brAPIColumnNamesByBiColumnName.put("createdBy", "createdByUserName"); + brAPIColumnNamesByBiColumnName.put("synonyms", "synonyms"); + + return brAPIColumnNamesByBiColumnName; + } } diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIGermplasmService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIGermplasmService.java index c68801a8b..333d9910f 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIGermplasmService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIGermplasmService.java @@ -4,10 +4,7 @@ import io.micronaut.context.annotation.Property; import io.micronaut.http.server.exceptions.InternalServerException; import io.micronaut.http.server.types.files.StreamedFile; -import org.apache.commons.lang3.tuple.Pair; -import org.brapi.client.v2.ApiResponse; import org.brapi.client.v2.model.exceptions.ApiException; -import org.brapi.v2.model.BrAPIAcceptedSearchResponse; import org.brapi.v2.model.BrAPIExternalReference; import lombok.extern.slf4j.Slf4j; import org.brapi.v2.model.core.request.BrAPIListNewRequest; @@ -15,10 +12,10 @@ import org.brapi.v2.model.core.response.BrAPIListsSingleResponse; import org.brapi.v2.model.germ.BrAPIGermplasm; import org.brapi.v2.model.germ.BrAPIGermplasmSynonyms; -import org.brapi.v2.model.germ.request.BrAPIGermplasmSearchRequest; import org.brapi.v2.model.germ.response.BrAPIGermplasmListResponse; import org.breedinginsight.brapi.v2.constants.BrAPIAdditionalInfoFields; import org.breedinginsight.brapi.v2.dao.BrAPIListDAO; +import org.breedinginsight.brapi.v2.model.request.query.GermplasmQuery; import org.breedinginsight.brapps.importer.model.exports.FileType; import org.breedinginsight.model.Column; import org.breedinginsight.model.DownloadFile; @@ -169,19 +166,27 @@ public List> processListData(List germplasm, return processedData; } - public List getGermplasmByList(UUID programId, String listDbId) throws ApiException { + public BrAPIGermplasmListResponse getGermplasmByList(UUID programId, GermplasmQuery germplasmQuery) throws ApiException, DoesNotExistException { // get list germplasm names - BrAPIListsSingleResponse listResponse = brAPIListDAO.getListById(listDbId, programId); + BrAPIListsSingleResponse listResponse = brAPIListDAO.getListById(germplasmQuery.getListDbId(), programId); if(Objects.nonNull(listResponse) && Objects.nonNull(listResponse.getResult())) { // get the list ID stored in the list external references UUID listId = getGermplasmListId(listResponse.getResult()); - // get list BrAPI germplasm variables - List germplasmNames = listResponse.getResult().getData(); - List germplasm = germplasmDAO.getGermplasmByRawName(germplasmNames, programId); + // get list BrAPI germplasm variables. + // The order of these germplasm names are the exact order/entry number in the list that was imported. + List germplasmNamesFromBrapiList = listResponse.getResult().getData(); + + BrAPIGermplasmListResponse germplasmSearchResponse = germplasmDAO.searchGermplasmByRawName(germplasmNamesFromBrapiList, programId, germplasmQuery); + + List germplasm = germplasmSearchResponse.getResult().getData(); Map germplasmByGid = new HashMap<>(); + if (germplasm == null || germplasm.isEmpty()) { + return germplasmSearchResponse; + } + for (BrAPIGermplasm g : germplasm) { // set the list ID in the germplasm additional info g.putAdditionalInfoItem(BrAPIAdditionalInfoFields.GERMPLASM_LIST_ID, listId); @@ -190,23 +195,68 @@ public List getGermplasmByList(UUID programId, String listDbId) } // Extract gids from list names - List gids = germplasmNames.stream().map(Utilities::extractGid).collect(Collectors.toList()); + List gids = germplasmNamesFromBrapiList.stream().map(Utilities::extractGid).collect(Collectors.toList()); // Build list from BrAPI list that preserves ordering and duplicates and assigns sequential entry numbers. - List germplasmList = new ArrayList<>(); - int entryNumber = 0; + List orderByEntryNumber = new ArrayList<>(); + + Program program = programService.getById(programId).orElseThrow(() -> new DoesNotExistException("Could not find program: " + programId)); + for (String gid : gids) { - ++entryNumber; - BrAPIGermplasm listEntry = cloneBrAPIGermplasm(germplasmByGid.get(gid)); + BrAPIGermplasm germ = germplasmByGid.get(gid); + + if (germ == null) { + continue; + } + + // We can't simply use germ.getGermplasmName here because the BrAPIGermplasmDAO code strips the key and gid via BrAPIGermplasmDAO.processGermplasmForDisplay() + // Rebuild the unique name so we can get the entry number via the order on the germplasmNamesFromBrapiList list which was derived from the list response. + String fullGermplasmName = Utilities.appendProgramKey(germ.getDefaultDisplayName(), program.getKey(), germ.getAccessionNumber()); + + BrAPIGermplasm listEntry = cloneBrAPIGermplasm(germ); + + int entryNumber = germplasmNamesFromBrapiList.indexOf(fullGermplasmName) + 1; + // Set entry number. listEntry.putAdditionalInfoItem(BrAPIAdditionalInfoFields.GERMPLASM_IMPORT_ENTRY_NUMBER, entryNumber); - germplasmList.add(listEntry); + germ.putAdditionalInfoItem(BrAPIAdditionalInfoFields.GERMPLASM_IMPORT_ENTRY_NUMBER, entryNumber); + orderByEntryNumber.add(listEntry); + } + + if (germplasmQuery.getSortField() == null || germplasmQuery.getSortField().equals("importEntryNumber")) { + // This should order by entry number when germplasm list details page displays + germplasmSearchResponse.getResult().setData(orderByEntryNumber); + } else { + // In all other cases it will order by the other selected data + germplasmSearchResponse.getResult().setData(germplasm); } - return germplasmList; + return germplasmSearchResponse; } else throw new ApiException(); } +// private BrAPIGermplasmListResponse orderByListImportEntryNumber() { +// for (String gid : gids) { +// BrAPIGermplasm germ = germplasmByGid.get(gid); +// +// if (germ == null) { +// continue; +// } +// +// // We can't simply use germ.getGermplasmName here because the BrAPIGermplasmDAO code strips the key and gid via BrAPIGermplasmDAO.processGermplasmForDisplay() +// // Rebuild the unique name so we can get the entry number via the order on the germplasmNamesFromBrapiList list which was derived from the list response. +// String fullGermplasmName = Utilities.appendProgramKey(germ.getDefaultDisplayName(), program.getKey(), germ.getAccessionNumber()); +// +// BrAPIGermplasm listEntry = cloneBrAPIGermplasm(germ); +// +// int entryNumber = germplasmNamesFromBrapiList.indexOf(fullGermplasmName) + 1; +// +// // Set entry number. +// listEntry.putAdditionalInfoItem(BrAPIAdditionalInfoFields.GERMPLASM_IMPORT_ENTRY_NUMBER, entryNumber); +// orderByEntryNumber.add(listEntry); +// } +// } + private BrAPIGermplasm cloneBrAPIGermplasm(BrAPIGermplasm germplasm) { // Serialize then deserialize to deep copy. return (BrAPIGermplasm) gson.fromJson(gson.toJson(germplasm), BrAPIGermplasm.class); @@ -355,4 +405,11 @@ public List getGermplasmByDisplayName(List germplasmDisp } return matchingGermplasm; } + + public BrAPIGermplasmListResponse searchGermplasm(UUID programId, + GermplasmQuery germplasmQuery) throws ApiException, DoesNotExistException { + Program program = programService.getById(programId).orElseThrow(() -> new DoesNotExistException("Could not find program: " + programId)); + + return germplasmDAO.brapiGermplasmSearchReturnResponse(program, null, germplasmQuery); + } } diff --git a/src/test/java/org/breedinginsight/brapi/v2/GermplasmControllerIntegrationTest.java b/src/test/java/org/breedinginsight/brapi/v2/GermplasmControllerIntegrationTest.java index 2a0ad750f..fd6e41c50 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/GermplasmControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/GermplasmControllerIntegrationTest.java @@ -396,6 +396,7 @@ public void searchGermplasmOneMatchOneNoMatch() { @Test @SneakyThrows public void filterGermplasmCreatedDateSuccess() { + // TODO: This test is going to continue to fail until date data is migrated to the proper format [BI-3057] // Case 1: createdDate="/". // If createdDate is filtered in the default format, "dd/MM/yyyy HH:mm:ss", "/" will match all, test fails. // If createdDate is filtered after formatting with "yyyy-MM-dd", "/" will match none, test succeeds. From 2b7f7e63c35ed178c147a36c128c1f39b8b0c3f7 Mon Sep 17 00:00:00 2001 From: humsika Date: Sun, 27 Sep 2026 20:35:05 -0500 Subject: [PATCH 071/102] BI-2922: Replaced the LinkedHashMap with List. --- .../brapi/v2/dao/BrAPIStudyDAO.java | 46 ++++++++----------- 1 file changed, 20 insertions(+), 26 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java index 02734954f..424a17339 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIStudyDAO.java @@ -97,7 +97,7 @@ public BrAPIStudyListResponse brapiStudySearch(Program program, List brapi BrAPIStudyListResponse brAPIResponse = brAPIDAOUtil.simpleSearch(api::searchStudiesPost, brAPIStudySearchRequest); - List processedStudies = new ArrayList<>(processStudyForDisplay(brAPIDAOUtil.getListResult(brAPIResponse), program.getKey()).values()); + List processedStudies = processStudyForDisplay(brAPIDAOUtil.getListResult(brAPIResponse), program.getKey()); brAPIResponse.getResult().setData(processedStudies); @@ -148,7 +148,7 @@ private List getBrAPIStudiesUsingBrAPIProgramId(Program program) thr List result = brAPIDAOUtil.get(api::studiesGet, studyQueryParams); - return new ArrayList<>(processStudyForDisplay(result, program.getKey()).values()); + return processStudyForDisplay(result, program.getKey()); } public List getStudiesByName(List studyNames, Program program) throws ApiException { @@ -192,11 +192,11 @@ public List getStudiesByExperimentIds(@NotNull Collection expe studySearch.programDbIds(List.of(program.getBrapiProgram().getProgramDbId())); studySearch.trialDbIds(experimentIds.stream().map(UUID::toString).collect(Collectors.toList())); StudiesApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(program.getId()), StudiesApi.class); - return new ArrayList<>(processStudyForDisplay(brAPIDAOUtil.search( + return processStudyForDisplay(brAPIDAOUtil.search( api::searchStudiesPost, api::searchStudiesSearchResultsDbIdGet, studySearch - ), program.getKey()).values()); + ), program.getKey()); } public List createBrAPIStudies(List brAPIStudyList, UUID programId, ImportUpload upload) throws ApiException { @@ -241,18 +241,23 @@ public Optional getStudyByDbId(String studyDbId, Program program) th } /** - * Process study into a format for display - * @param programStudy - * @return Map - Key = string representing study UUID, value = formatted BrAPIStudy + * Process studies into a format for display while preserving their order. + * + * @param programStudy studies returned by BrAPI + * @param programKey the program key to remove from display fields + * @return formatted studies in their original order */ - private Map processStudyForDisplay(List programStudy, String programKey) { - Map programStudyMap = new LinkedHashMap<>(); + private List processStudyForDisplay(List programStudy, String programKey) { + List processedStudies = new ArrayList<>(programStudy.size()); + log.trace("processing study for display: " + programStudy); - for (BrAPIStudy study: programStudy) { + + for (BrAPIStudy study : programStudy) { // Remove program key from studyName, trialName and locationName. if (study.getStudyName() != null) { // Study name is appended with experiment sequence number in addition to program key. - study.setStudyName(Utilities.removeProgramKeyAndUnknownAdditionalData(study.getStudyName(), programKey)); + study.setStudyName( + Utilities.removeProgramKeyAndUnknownAdditionalData(study.getStudyName(), programKey)); } if (study.getTrialName() != null) { study.setTrialName(Utilities.removeProgramKey(study.getTrialName(), programKey)); @@ -260,24 +265,13 @@ private Map processStudyForDisplay(List programSt if (study.getLocationName() != null) { study.setLocationName(Utilities.removeProgramKey(study.getLocationName(), programKey)); } - } - - String refSource = Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.STUDIES); - // Add to map. - for (BrAPIStudy study: programStudy) { - JsonObject additionalInfo = study.getAdditionalInfo(); - if(additionalInfo == null) { - additionalInfo = new JsonObject(); - study.setAdditionalInfo(additionalInfo); + if (study.getAdditionalInfo() == null) { + study.setAdditionalInfo(new JsonObject()); } - BrAPIExternalReference extRef = study.getExternalReferences().stream() - .filter(reference -> reference.getReferenceSource().equals(refSource)) - .findFirst().orElseThrow(() -> new IllegalStateException("No BI external reference found")); - String studyId = extRef.getReferenceId(); - programStudyMap.put(studyId, study); + processedStudies.add(study); } - return programStudyMap; + return processedStudies; } } \ No newline at end of file From eb7717f090a75dba6b394f55668113e3d0db52b1 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Wed, 30 Sep 2026 14:40:10 -0400 Subject: [PATCH 072/102] Swap bi/brapi col names in GermplasmQuery --- .../brapi/v2/model/request/query/GermplasmQuery.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/model/request/query/GermplasmQuery.java b/src/main/java/org/breedinginsight/brapi/v2/model/request/query/GermplasmQuery.java index 2c1807490..d00255f68 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/model/request/query/GermplasmQuery.java +++ b/src/main/java/org/breedinginsight/brapi/v2/model/request/query/GermplasmQuery.java @@ -102,7 +102,7 @@ public Map getBrAPIColumnNamesByBiColumnName() { brAPIColumnNamesByBiColumnName.put("femaleParentGID", "femaleParentGID"); brAPIColumnNamesByBiColumnName.put("maleParentGID", "maleParentGID"); brAPIColumnNamesByBiColumnName.put("createdDate", "createdDate"); - brAPIColumnNamesByBiColumnName.put("createdBy", "createdByUserName"); + brAPIColumnNamesByBiColumnName.put("createdByUserName", "createdBy"); brAPIColumnNamesByBiColumnName.put("synonyms", "synonyms"); return brAPIColumnNamesByBiColumnName; From 012c9dd5c24c5ade5e9f177277a3a89b3818d2e5 Mon Sep 17 00:00:00 2001 From: humsika Date: Fri, 2 Oct 2026 12:26:00 -0500 Subject: [PATCH 073/102] BI-2963: Optimized observation retrieval using BrAPI search. --- .../brapi/v2/dao/BrAPIObservationDAO.java | 54 ++++-- .../ExperimentControllerIntegrationTest.java | 22 +++ .../v2/dao/BrAPIObservationDAOUnitTest.java | 177 ++++++++++++++++++ 3 files changed, 239 insertions(+), 14 deletions(-) create mode 100644 src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAOUnitTest.java diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java index 16a2a73cc..9f8fe8ea6 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java @@ -123,6 +123,21 @@ public List getObservationsByStudyName(List studyNames ); } + private List searchBrapiObservations(BrAPIObservationSearchRequest observationSearchRequest, Program program) throws ApiException { + + ObservationsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(program.getId()), ObservationsApi.class); + + List observations = brAPIDAOUtil.search( + api::searchObservationsPost, + (brAPIWSMIMEDataTypes, searchResultsDbId, page, pageSize) -> searchObservationsSearchResultsDbIdGet(program.getId(), searchResultsDbId, page, pageSize), + observationSearchRequest + ); + + processObservations(program.getKey(), observations); + + return observations; + } + /** * Retrieves a list of observations based on their database IDs and a specific program. * @@ -149,34 +164,45 @@ public List getObservationsByTrialDbId(List trialDbIds return Collections.emptyList(); } // First, get all ObservationUnits for the given trialDbIds. - // TODO: Once OUDAO removes cache, investigate utilizing observationUnit GET param to includeObservations instead of making an extra call for the observations. This should offer performance gains. [BI-2963] List observationUnitDbIds = observationUnitDAO.getObservationUnitsForTrialDbIds(program.getId(), trialDbIds) .stream().map(BrAPIObservationUnit::getObservationUnitDbId).collect(Collectors.toList()); - // Finally, return all Observations for those ObservationUnits (Observations are linked to Trial through ObservationUnits). - // TODO: This gets all observations for the program and filters, which is extremely inefficient. If above TODO suggestion doesn't work, another improvement would be to search on OU ids directly in BrAPI instead. [BI-2963] - return getProgramObservations(program.getId()).stream() - .filter(o -> observationUnitDbIds.contains(o.getObservationUnitDbId())) - .collect(Collectors.toList()); + + if (observationUnitDbIds.isEmpty()) { + return Collections.emptyList(); + } + + BrAPIObservationSearchRequest observationSearchRequest = + new BrAPIObservationSearchRequest() + .programDbIds(List.of( + program.getBrapiProgram().getProgramDbId())) + .observationUnitDbIds(observationUnitDbIds); + + return searchBrapiObservations( + observationSearchRequest, + program); } public List getObservationsByObservationUnitsAndVariables(Collection ouDbIds, Collection variableDbIds, Program program) throws ApiException { if(ouDbIds.isEmpty() || variableDbIds.isEmpty()) { return Collections.emptyList(); } - // TODO: Once OUDAO removes cache, change to BrAPI Observation search request on program, observation var ids, and ouDbId [BI-2963] - return getProgramObservations(program.getId()).stream() - .filter(o -> ouDbIds.contains(o.getObservationUnitDbId()) && variableDbIds.contains(o.getObservationVariableDbId())) - .collect(Collectors.toList()); + + BrAPIObservationSearchRequest observationSearchRequest = new BrAPIObservationSearchRequest().programDbIds(List.of(program.getBrapiProgram().getProgramDbId())) + .observationUnitDbIds(new ArrayList<>(ouDbIds)) + .observationVariableDbIds(new ArrayList<>(variableDbIds)); + + return searchBrapiObservations(observationSearchRequest, program); } public List getObservationsByObservationUnits(Collection ouDbIds, Program program) throws ApiException { - // TODO: Once OUDAO removes cache, change to BrAPI Observation search request on program and ouDbIds [BI-2963] + if(ouDbIds.isEmpty()) { return Collections.emptyList(); } - return getProgramObservations(program.getId()).stream() - .filter(o -> ouDbIds.contains(o.getObservationUnitDbId())) - .collect(Collectors.toList()); + + BrAPIObservationSearchRequest observationSearchRequest = new BrAPIObservationSearchRequest().programDbIds(List.of(program.getBrapiProgram().getProgramDbId())).observationUnitDbIds(new ArrayList<>(ouDbIds)); + + return searchBrapiObservations(observationSearchRequest, program); } public List getObservationsByFilters(Program program, String studyDbId) throws ApiException, DoesNotExistException { diff --git a/src/test/java/org/breedinginsight/api/v1/controller/ExperimentControllerIntegrationTest.java b/src/test/java/org/breedinginsight/api/v1/controller/ExperimentControllerIntegrationTest.java index f1b5e9ce8..3db310e33 100644 --- a/src/test/java/org/breedinginsight/api/v1/controller/ExperimentControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/api/v1/controller/ExperimentControllerIntegrationTest.java @@ -923,6 +923,28 @@ public void deleteExperimentSuccess(boolean hardDelete, boolean withObservations } + @Test + @SneakyThrows + public void hardDeleteExperimentIgnoresObservationsFromOtherExperiment() { + Program deleteProgram = createSeededProgram("Delete Experiment Isolation"); + + String observedExperimentTitle = "Observed Experiment " + UUID.randomUUID(); + String emptyExperimentTitle = "Empty Experiment " + UUID.randomUUID(); + + uploadExperimentWithObs(deleteProgram, observedExperimentTitle, buildObservedRows(observedExperimentTitle)); + + String emptyExperimentId = uploadExperimentWithoutObs(deleteProgram, emptyExperimentTitle,"Plot"); + + Flowable> deleteCall = client.exchange(DELETE(String.format("/programs/%s/experiments/%s?hard=true", deleteProgram.getId(), emptyExperimentId)).cookie(new NettyCookie("phylo-token","test-registered-user")),String.class); + + HttpResponse deleteResponse = deleteCall.blockingFirst(); + + assertEquals(HttpStatus.NO_CONTENT, deleteResponse.getStatus()); + + JsonArray remainingTrials = getProgramTrials(deleteProgram.getId().toString()); + assertEquals(1, remainingTrials.size()); + } + private List> buildObservedRows(String title) { List> observedRows = new ArrayList<>(); String envBase = title.replaceAll("\\s+", ""); diff --git a/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAOUnitTest.java b/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAOUnitTest.java new file mode 100644 index 000000000..8df2fda10 --- /dev/null +++ b/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAOUnitTest.java @@ -0,0 +1,177 @@ +/* + * See the NOTICE file distributed with this work for additional information + * regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.breedinginsight.brapi.v2.dao; + +import io.reactivex.functions.Function; +import io.reactivex.functions.Function4; +import lombok.SneakyThrows; +import org.brapi.client.v2.BrAPIClient; +import org.brapi.v2.model.core.BrAPIProgram; +import org.brapi.v2.model.pheno.BrAPIObservation; +import org.brapi.v2.model.pheno.BrAPIObservationUnit; +import org.brapi.v2.model.pheno.request.BrAPIObservationSearchRequest; +import org.breedinginsight.brapps.importer.daos.ImportDAO; +import org.breedinginsight.daos.ProgramDAO; +import org.breedinginsight.model.Program; +import org.breedinginsight.services.TraitService; +import org.breedinginsight.services.brapi.BrAPIEndpointProvider; +import org.breedinginsight.utilities.BrAPIDAOUtil; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.mockito.ArgumentCaptor; + +import java.util.List; +import java.util.UUID; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.mockito.ArgumentMatchers.*; +import static org.mockito.Mockito.*; + +public class BrAPIObservationDAOUnitTest { + + private static final String BRAPI_PROGRAM_DB_ID = "brapi-program-1"; + + private BrAPIObservationDAO observationDAO; + private BrAPIObservationUnitDAO observationUnitDAO; + private BrAPIDAOUtil brAPIDAOUtil; + private Program program; + + @BeforeEach + void setup() { + UUID programId = UUID.randomUUID(); + + BrAPIProgram brapiProgram = new BrAPIProgram().programDbId(BRAPI_PROGRAM_DB_ID); + + program = new Program(); + program.setId(programId); + program.setKey("TEST"); + program.setBrapiProgram(brapiProgram); + + ProgramDAO programDAO = mock(ProgramDAO.class); + observationUnitDAO = mock(BrAPIObservationUnitDAO.class); + brAPIDAOUtil = mock(BrAPIDAOUtil.class); + + when(programDAO.getCoreClient(programId)).thenReturn(mock(BrAPIClient.class)); + + observationDAO = new BrAPIObservationDAO( + programDAO, + mock(ImportDAO.class), + observationUnitDAO, + brAPIDAOUtil, + new BrAPIEndpointProvider(), + 1000, + mock(TraitService.class) + ); + } + + @Test + @SneakyThrows + void getObservationsByTrialDbIdUsesObservationSearch() { + String trialDbId = "trial-1"; + String observationUnitDbId = "ou-1"; + + BrAPIObservationUnit observationUnit = new BrAPIObservationUnit().observationUnitDbId(observationUnitDbId); + + BrAPIObservation observation = new BrAPIObservation().observationDbId("observation-1").observationUnitDbId(observationUnitDbId); + + when(observationUnitDAO.getObservationUnitsForTrialDbIds(program.getId(), List.of(trialDbId))).thenReturn(List.of(observationUnit)); + + when(brAPIDAOUtil.search(any(Function.class),any(Function4.class),any(BrAPIObservationSearchRequest.class))).thenReturn(List.of(observation)); + + List result = observationDAO.getObservationsByTrialDbId(List.of(trialDbId), program); + + assertEquals(List.of(observation), result); + + ArgumentCaptor requestCaptor = ArgumentCaptor.forClass(BrAPIObservationSearchRequest.class); + + verify(brAPIDAOUtil).search(any(Function.class),any(Function4.class),requestCaptor.capture()); + + BrAPIObservationSearchRequest request = requestCaptor.getValue(); + + assertEquals(List.of(BRAPI_PROGRAM_DB_ID), request.getProgramDbIds()); + + assertEquals(List.of(observationUnitDbId), request.getObservationUnitDbIds()); + } + + @Test + @SneakyThrows + void getObservationsByTrialDbIdReturnsEmptyWhenNoUnitsExist() { + String trialDbId = "trial-without-units"; + + when(observationUnitDAO.getObservationUnitsForTrialDbIds(program.getId(), List.of(trialDbId))).thenReturn(List.of()); + + List result = observationDAO.getObservationsByTrialDbId(List.of(trialDbId), program); + + assertTrue(result.isEmpty()); + + verify(brAPIDAOUtil, never()).search(any(Function.class),any(Function4.class),any(BrAPIObservationSearchRequest.class)); + } + + @Test + @SneakyThrows + void getObservationsByObservationUnitsUsesObservationSearch() { + List observationUnitDbIds = List.of("ou-1", "ou-2"); + + when(brAPIDAOUtil.search(any(Function.class),any(Function4.class),any(BrAPIObservationSearchRequest.class))).thenReturn(List.of()); + + observationDAO.getObservationsByObservationUnits(observationUnitDbIds, program); + + ArgumentCaptor requestCaptor = ArgumentCaptor.forClass(BrAPIObservationSearchRequest.class); + + verify(brAPIDAOUtil).search(any(Function.class),any(Function4.class),requestCaptor.capture()); + + BrAPIObservationSearchRequest request = requestCaptor.getValue(); + + assertEquals(List.of(BRAPI_PROGRAM_DB_ID), request.getProgramDbIds()); + assertEquals(observationUnitDbIds, request.getObservationUnitDbIds()); + } + + @Test + @SneakyThrows + void getObservationsByObservationUnitsAndVariablesUsesBothFilters() { + List observationUnitDbIds = List.of("ou-1", "ou-2"); + List observationVariableDbIds = List.of("variable-1", "variable-2"); + + when(brAPIDAOUtil.search(any(Function.class), any(Function4.class),any(BrAPIObservationSearchRequest.class))).thenReturn(List.of()); + + observationDAO.getObservationsByObservationUnitsAndVariables(observationUnitDbIds, observationVariableDbIds, program); + + ArgumentCaptor requestCaptor = ArgumentCaptor.forClass(BrAPIObservationSearchRequest.class); + + verify(brAPIDAOUtil).search(any(Function.class),any(Function4.class),requestCaptor.capture()); + + BrAPIObservationSearchRequest request = requestCaptor.getValue(); + + assertEquals(List.of(BRAPI_PROGRAM_DB_ID), request.getProgramDbIds()); + assertEquals(observationUnitDbIds, request.getObservationUnitDbIds()); + assertEquals(observationVariableDbIds, request.getObservationVariableDbIds()); + } + + @Test + @SneakyThrows + void observationSearchIsSkippedForEmptyFilters() { + assertTrue(observationDAO.getObservationsByTrialDbId(List.of(), program).isEmpty()); + + assertTrue(observationDAO.getObservationsByObservationUnits(List.of(), program).isEmpty()); + + assertTrue(observationDAO.getObservationsByObservationUnitsAndVariables(List.of("ou-1"), List.of(), program).isEmpty()); + + verifyNoInteractions(observationUnitDAO); + verify(brAPIDAOUtil, never()).search(any(Function.class),any(Function4.class),any(BrAPIObservationSearchRequest.class)); + } +} \ No newline at end of file From e9b6cd39f447e92caf50412e50fbd8e6eb708c8a Mon Sep 17 00:00:00 2001 From: humsika Date: Sun, 4 Oct 2026 19:46:36 -0500 Subject: [PATCH 074/102] BI-2963: Optimized ObservationDAO method and added test case. --- .../brapi/v2/dao/BrAPIObservationDAO.java | 40 +++++++++---------- .../v2/dao/BrAPIObservationDAOUnitTest.java | 26 ++++++++++++ 2 files changed, 45 insertions(+), 21 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java index 9f8fe8ea6..5766cae0b 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java @@ -124,7 +124,6 @@ public List getObservationsByStudyName(List studyNames } private List searchBrapiObservations(BrAPIObservationSearchRequest observationSearchRequest, Program program) throws ApiException { - ObservationsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(program.getId()), ObservationsApi.class); List observations = brAPIDAOUtil.search( @@ -148,19 +147,19 @@ private List searchBrapiObservations(BrAPIObservationSearchReq */ public List getObservationsByDbIds(List dbIds, Program program) throws ApiException { // Check if the dbIds list is empty and return an empty list if so - if(dbIds.isEmpty()) { + if (dbIds.isEmpty()) { return Collections.emptyList(); } - // Filter the observations based on the provided program ID and the provided list of dbIds - // Collect the filtered observations into a List and return the result - return getProgramObservations(program.getId()).stream() - .filter(o -> dbIds.contains(o.getObservationDbId())) - .collect(Collectors.toList()); + BrAPIObservationSearchRequest observationSearchRequest = new BrAPIObservationSearchRequest() + .programDbIds(List.of(program.getBrapiProgram().getProgramDbId())) + .observationDbIds(new ArrayList<>(dbIds)); + + return searchBrapiObservations(observationSearchRequest, program); } public List getObservationsByTrialDbId(List trialDbIds, Program program) throws ApiException { - if(trialDbIds.isEmpty()) { + if (trialDbIds.isEmpty()) { return Collections.emptyList(); } // First, get all ObservationUnits for the given trialDbIds. @@ -171,36 +170,35 @@ public List getObservationsByTrialDbId(List trialDbIds return Collections.emptyList(); } - BrAPIObservationSearchRequest observationSearchRequest = - new BrAPIObservationSearchRequest() - .programDbIds(List.of( - program.getBrapiProgram().getProgramDbId())) + BrAPIObservationSearchRequest observationSearchRequest = new BrAPIObservationSearchRequest() + .programDbIds(List.of(program.getBrapiProgram().getProgramDbId())) .observationUnitDbIds(observationUnitDbIds); - return searchBrapiObservations( - observationSearchRequest, - program); + return searchBrapiObservations(observationSearchRequest, program); } public List getObservationsByObservationUnitsAndVariables(Collection ouDbIds, Collection variableDbIds, Program program) throws ApiException { - if(ouDbIds.isEmpty() || variableDbIds.isEmpty()) { + if (ouDbIds.isEmpty() || variableDbIds.isEmpty()) { return Collections.emptyList(); } - BrAPIObservationSearchRequest observationSearchRequest = new BrAPIObservationSearchRequest().programDbIds(List.of(program.getBrapiProgram().getProgramDbId())) - .observationUnitDbIds(new ArrayList<>(ouDbIds)) - .observationVariableDbIds(new ArrayList<>(variableDbIds)); + BrAPIObservationSearchRequest observationSearchRequest = new BrAPIObservationSearchRequest() + .programDbIds(List.of(program.getBrapiProgram().getProgramDbId())) + .observationUnitDbIds(new ArrayList<>(ouDbIds)) + .observationVariableDbIds(new ArrayList<>(variableDbIds)); return searchBrapiObservations(observationSearchRequest, program); } public List getObservationsByObservationUnits(Collection ouDbIds, Program program) throws ApiException { - if(ouDbIds.isEmpty()) { + if (ouDbIds.isEmpty()) { return Collections.emptyList(); } - BrAPIObservationSearchRequest observationSearchRequest = new BrAPIObservationSearchRequest().programDbIds(List.of(program.getBrapiProgram().getProgramDbId())).observationUnitDbIds(new ArrayList<>(ouDbIds)); + BrAPIObservationSearchRequest observationSearchRequest = new BrAPIObservationSearchRequest() + .programDbIds(List.of(program.getBrapiProgram().getProgramDbId())) + .observationUnitDbIds(new ArrayList<>(ouDbIds)); return searchBrapiObservations(observationSearchRequest, program); } diff --git a/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAOUnitTest.java b/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAOUnitTest.java index 8df2fda10..a82bb9389 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAOUnitTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAOUnitTest.java @@ -79,6 +79,30 @@ void setup() { ); } + @Test + @SneakyThrows + void getObservationsByDbIdsUsesObservationSearch() { + List observationDbIds = List.of("observation-1", "observation-2"); + + BrAPIObservation observation = new BrAPIObservation().observationDbId("observation-1"); + + when(brAPIDAOUtil.search(any(Function.class), any(Function4.class), any(BrAPIObservationSearchRequest.class))).thenReturn(List.of(observation)); + + List result = observationDAO.getObservationsByDbIds(observationDbIds, program); + + assertEquals(List.of(observation), result); + + ArgumentCaptor requestCaptor = ArgumentCaptor.forClass(BrAPIObservationSearchRequest.class); + + verify(brAPIDAOUtil).search(any(Function.class), any(Function4.class), requestCaptor.capture()); + + BrAPIObservationSearchRequest request = requestCaptor.getValue(); + + assertEquals(List.of(BRAPI_PROGRAM_DB_ID), request.getProgramDbIds()); + + assertEquals(observationDbIds, request.getObservationDbIds()); + } + @Test @SneakyThrows void getObservationsByTrialDbIdUsesObservationSearch() { @@ -167,6 +191,8 @@ void getObservationsByObservationUnitsAndVariablesUsesBothFilters() { void observationSearchIsSkippedForEmptyFilters() { assertTrue(observationDAO.getObservationsByTrialDbId(List.of(), program).isEmpty()); + assertTrue(observationDAO.getObservationsByDbIds(List.of(),program).isEmpty()); + assertTrue(observationDAO.getObservationsByObservationUnits(List.of(), program).isEmpty()); assertTrue(observationDAO.getObservationsByObservationUnitsAndVariables(List.of("ou-1"), List.of(), program).isEmpty()); From 9e1f79e29219392dbaafca0e8acb85573aeeea33 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Tue, 6 Oct 2026 18:36:18 -0400 Subject: [PATCH 075/102] Fix compile time issue, and missing injections --- .../breedinginsight/brapi/v2/BrAPIGermplasmController.java | 6 ++---- .../v2/BrAPIObservationLevelsControllerIntegrationTest.java | 1 + .../v2/BrAPIObservationUnitControllerIntegrationTest.java | 1 + .../v2/BrAPIObservationsControllerIntegrationTest.java | 1 + ...BrAPIV2ObservationVariableControllerIntegrationTest.java | 1 + 5 files changed, 6 insertions(+), 4 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/BrAPIGermplasmController.java b/src/main/java/org/breedinginsight/brapi/v2/BrAPIGermplasmController.java index 2d39cf251..bae393fc2 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/BrAPIGermplasmController.java +++ b/src/main/java/org/breedinginsight/brapi/v2/BrAPIGermplasmController.java @@ -19,7 +19,6 @@ import org.brapi.v2.model.BrAPIIndexPagination; import org.brapi.v2.model.BrAPIMetadata; import org.brapi.v2.model.BrAPIStatus; -import org.brapi.v2.model.core.BrAPITrial; import org.brapi.v2.model.germ.*; import org.brapi.v2.model.germ.request.BrAPIGermplasmSearchRequest; import org.brapi.v2.model.germ.response.BrAPIGermplasmListResponse; @@ -27,7 +26,6 @@ import org.brapi.v2.model.germ.response.BrAPIGermplasmProgenyResponse; import org.breedinginsight.api.auth.ProgramSecured; import org.breedinginsight.api.auth.ProgramSecuredRoleGroup; -import org.breedinginsight.api.model.v1.request.query.SearchRequest; import org.breedinginsight.api.model.v1.response.DataResponse; import org.breedinginsight.api.model.v1.response.Response; import org.breedinginsight.api.model.v1.validators.QueryValid; @@ -201,8 +199,8 @@ public HttpResponse>> getGermplasm( // Fetch all germplasm in the program unless a list id is supplied to return only germplasm in that collection BrAPIGermplasmListResponse brapiResponse = queryParams.getListDbId() == null ? germplasmService.searchGermplasm(programId, queryParams) : germplasmService.getGermplasmByList(programId, queryParams); - List foundTrials = brapiResponse.getResult().getData(); - return ResponseUtils.getBrapiQueryResponse(foundTrials, brapiResponse, queryParams); + List foundGermplasm = brapiResponse.getResult().getData(); + return ResponseUtils.getBrapiQueryResponse(foundGermplasm, brapiResponse); } catch (ApiException e) { log.info(e.getMessage(), e); return HttpResponse.status(HttpStatus.INTERNAL_SERVER_ERROR, "Error retrieving germplasm"); diff --git a/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationLevelsControllerIntegrationTest.java b/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationLevelsControllerIntegrationTest.java index c5ed96908..60b08d1b8 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationLevelsControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationLevelsControllerIntegrationTest.java @@ -90,6 +90,7 @@ public class BrAPIObservationLevelsControllerIntegrationTest extends BrAPITest { private BrAPIGermplasmDAO germplasmDAO; @Inject private ProgramDAO programDAO; + @Inject private BrAPIStudyDAO brAPIStudyDAO; @Inject diff --git a/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitControllerIntegrationTest.java b/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitControllerIntegrationTest.java index 5101ca6ac..fb47a3364 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationUnitControllerIntegrationTest.java @@ -99,6 +99,7 @@ public class BrAPIObservationUnitControllerIntegrationTest extends BrAPITest { private BrAPITrialDAO brapiTrialDAO; @Inject private ProgramDAO programDAO; + @Inject private BrAPIStudyDAO brAPIStudyDAO; @Inject diff --git a/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationsControllerIntegrationTest.java b/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationsControllerIntegrationTest.java index 2899cdc49..aae656761 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationsControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationsControllerIntegrationTest.java @@ -96,6 +96,7 @@ public class BrAPIObservationsControllerIntegrationTest extends BrAPITest { private BrAPIGermplasmDAO germplasmDAO; @Inject private ProgramDAO programDAO; + @Inject private BrAPIStudyDAO brAPIStudyDAO; @Inject diff --git a/src/test/java/org/breedinginsight/brapi/v2/BrAPIV2ObservationVariableControllerIntegrationTest.java b/src/test/java/org/breedinginsight/brapi/v2/BrAPIV2ObservationVariableControllerIntegrationTest.java index e5449cad4..36f739c6d 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/BrAPIV2ObservationVariableControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/BrAPIV2ObservationVariableControllerIntegrationTest.java @@ -95,6 +95,7 @@ public class BrAPIV2ObservationVariableControllerIntegrationTest extends BrAPITe private BrAPIGermplasmDAO germplasmDAO; @Inject ProgramDAO programDAO; + @Inject private BrAPITrialService brAPITrialService; @Inject private BrAPIStudyDAO brAPIStudyDAO; From d2c62d6d36a387b44453cbc4605dd08f556f754b Mon Sep 17 00:00:00 2001 From: humsika Date: Wed, 7 Oct 2026 12:18:56 -0500 Subject: [PATCH 076/102] BI-3069: Fix observation unit filtering by studyDbId. --- .../brapi/v2/dao/BrAPIObservationUnitDAO.java | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java index fd03ad0db..2569f352f 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java @@ -292,20 +292,12 @@ public List getObservationUnits(Program program, // TODO: Are level filters being used here at all? Should they be? addLevelFilter(observationUnitLevelName, observationUnitLevelOrder, observationUnitLevelCode, level, levelFilter); addLevelFilter(observationUnitLevelRelationshipName, observationUnitLevelRelationshipOrder, observationUnitLevelRelationshipCode, relationship, relationshipFilter); - // TODO: Use observationUnitSearchRequest.setStudyDbIds() instead of xrefs [BI-2919] + environmentId.ifPresent(envId -> observationUnitSearchRequest.setStudyDbIds(List.of(envId))); - return searchObservationUnitsAndProcess(observationUnitSearchRequest, program, true).stream().filter(ou -> { - //xref search does an OR, so we need to convert the searching for expId/envId to be an AND - boolean matches = environmentId.map(id -> id.equals(Utilities.getExternalReference(ou.getExternalReferences(), Utilities.generateReferenceSource(referenceSource, ExternalReferenceSource.STUDIES)) - .get() - .getReferenceId())) - .orElse(true); - - //adding filter for germplasmDbId because we can't easily search that in the stored data object - // TODO: Add search on germplasmDbId directly in search request [BI-3006] - return matches && germplasmId.map(id -> id.equals(ou.getAdditionalInfo().get(BrAPIAdditionalInfoFields.GERMPLASM_UUID).getAsString())).orElse(true); - }).collect(Collectors.toList()); + return searchObservationUnitsAndProcess(observationUnitSearchRequest, program, true).stream() + // TODO: Add search on germplasmDbId directly in the search request [BI-3006] + .filter(ou -> germplasmId.map(id -> id.equals(ou.getAdditionalInfo().get(BrAPIAdditionalInfoFields.GERMPLASM_UUID).getAsString())).orElse(true)).collect(Collectors.toList()); } private void addLevelFilter(Optional observationUnitLevelName, Optional observationUnitLevelOrder, Optional observationUnitLevelCode, BrAPIObservationUnitLevelRelationship level, AtomicBoolean levelFilter) { From 2f9ca55664929d8e9a54b4f29c63884f8e21956a Mon Sep 17 00:00:00 2001 From: humsika Date: Mon, 12 Oct 2026 16:08:14 -0500 Subject: [PATCH 077/102] BI-2964: Applied observation filtering and pagination on BrAPI side and added Unit tests. --- .../brapi/v2/BrAPIObservationsController.java | 73 +++++++------------ .../brapi/v2/dao/BrAPIObservationDAO.java | 41 +++++++---- ...ObservationsControllerIntegrationTest.java | 55 +++++++++++++- .../v2/dao/BrAPIObservationDAOUnitTest.java | 73 ++++++++++++++++++- 4 files changed, 179 insertions(+), 63 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationsController.java b/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationsController.java index 7c1a18897..094880e4d 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationsController.java +++ b/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationsController.java @@ -17,7 +17,6 @@ package org.breedinginsight.brapi.v2; - import io.micronaut.http.HttpResponse; import io.micronaut.http.HttpStatus; import io.micronaut.http.annotation.*; @@ -28,13 +27,12 @@ import org.brapi.client.v2.ApiResponse; import org.brapi.client.v2.model.exceptions.ApiException; import org.brapi.client.v2.modules.phenotype.ObservationsApi; -import org.brapi.v2.model.BrAPIIndexPagination; import org.brapi.v2.model.BrAPIMetadata; import org.brapi.v2.model.BrAPIStatus; import org.brapi.v2.model.BrAPIWSMIMEDataTypes; -import org.brapi.v2.model.core.BrAPIStudy; import org.brapi.v2.model.pheno.BrAPIObservation; -import org.brapi.v2.model.pheno.response.*; +import org.brapi.v2.model.pheno.response.BrAPIObservationListResponse; +import org.brapi.v2.model.pheno.response.BrAPIObservationTableResponse; import org.breedinginsight.api.auth.ProgramSecured; import org.breedinginsight.api.auth.ProgramSecuredRoleGroup; import org.breedinginsight.brapi.v1.controller.BrapiVersion; @@ -46,7 +44,7 @@ import org.breedinginsight.services.ProgramService; import org.breedinginsight.services.brapi.BrAPIEndpointProvider; import org.breedinginsight.utilities.Utilities; - +import org.breedinginsight.utilities.response.ResponseUtils; import javax.annotation.Nullable; import javax.inject.Inject; @@ -144,54 +142,37 @@ public HttpResponse observationsGet(@PathVariable("programId") UUID programId, ); } - // Get a filtered list of observations. - // TODO: Handle filtering and pagination of this request entirely on BrAPI side once study and ou cache is removed: [BI-2964] - List observations = observationDAO.getObservationsByFilters(program.get(), studyDbId); - - // If page is not provided, set it to the default value 0. - if (page == null) page = 0; - // If pageSize is not provided, set it to the default value 1000. - if (pageSize == null) pageSize = 1000; + boolean pageSizeValid = pageSize == null || pageSize > 0; + boolean pageValid = page == null || page >= 0; - // Total number of records in the unpaged super set. - int totalCount = observations.size(); - // The least of pageSize and totalCount, unless pageSize is zero, in which case use totalCount. - int requestedPageSize = pageSize > 0 ? Math.min(pageSize, totalCount) : totalCount; - // Integer division and round up. - int totalPages = totalCount / requestedPageSize + ((totalCount % requestedPageSize == 0) ? 0 : 1); - log.info("(Pagination) totalCount: " + totalCount + " page (0-indexed): " + page + " requestedPageSize: " + requestedPageSize + " totalPages: " + totalPages); - - // Determine validity of pagination query parameters. - boolean pageSizeValid = pageSize > 0; - boolean pageValid = page >= 0 && page < totalPages; - - // Only paginate if valid pagination values were sent. - if (pageSizeValid && pageValid) { - int start = page * requestedPageSize; - // Account for last page, which may have fewer than requestedPageSize items, or exactly requestedPageSize items. - int end = (page == (totalPages - 1) && totalCount % requestedPageSize != 0) ? (start + (totalCount % requestedPageSize)) : Math.min(((page + 1) * requestedPageSize), totalCount); - log.info("(Pagination) start " + start + " end " + end); - // Sort observations so that paging is consistent and coherent. - observations.sort(Comparator.comparing(BrAPIObservation::getObservationDbId)); - // Paginate response. - observations = observations.subList(start, end); - } else { + if (!pageSizeValid || !pageValid) { String errorMessage = "Invalid query parameters: page, pageSize"; - return HttpResponse.badRequest(new BrAPIObservationListResponse().metadata(new BrAPIMetadata().status(List.of(new BrAPIStatus().messageType(BrAPIStatus.MessageTypeEnum.ERROR) - .message(errorMessage))))); + return HttpResponse.badRequest(new BrAPIObservationListResponse() + .metadata(new BrAPIMetadata() + .status(List.of(new BrAPIStatus() + .messageType(BrAPIStatus.MessageTypeEnum.ERROR) + .message(errorMessage))))); } - return HttpResponse.ok(new BrAPIObservationListResponse().metadata(new BrAPIMetadata().pagination(new BrAPIIndexPagination() - .currentPage(page) - .totalPages(totalPages) - .pageSize(observations.size()) - .totalCount(totalCount))) - .result(new BrAPIObservationListResponseResult().data(observations))); + BrAPIObservationListResponse brAPIResponse = observationDAO.getObservationsByFilters(program.get(), studyDbId, page, pageSize); + + List observations = brAPIResponse.getResult().getData(); + return ResponseUtils.getBrapiQueryResponse(observations, brAPIResponse); } catch (ApiException e) { log.error(Utilities.generateApiExceptionLogMessage(e), e); - return HttpResponse.serverError(new BrAPIObservationListResponse().metadata(new BrAPIMetadata().status(List.of(new BrAPIStatus().messageType(BrAPIStatus.MessageTypeEnum.ERROR) - .message("Error fetching observations"))))); + + BrAPIObservationListResponse errorResponse = new BrAPIObservationListResponse() + .metadata(new BrAPIMetadata() + .status(List.of(new BrAPIStatus() + .messageType(BrAPIStatus.MessageTypeEnum.ERROR) + .message("Error fetching observations")))); + + if (e.getCode() == HttpStatus.BAD_REQUEST.getCode()) { + return HttpResponse.badRequest(errorResponse); + } + + return HttpResponse.serverError(errorResponse); } catch (Exception e) { log.error("Error fetching Observations", e); return HttpResponse.serverError(new BrAPIObservationListResponse().metadata(new BrAPIMetadata().status(List.of(new BrAPIStatus().messageType(BrAPIStatus.MessageTypeEnum.ERROR) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java index 5766cae0b..ccd95948e 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java @@ -203,21 +203,32 @@ public List getObservationsByObservationUnits(Collection getObservationsByFilters(Program program, String studyDbId) throws ApiException, DoesNotExistException { - Collection observations = getProgramObservations(program.getId()); - - HashMap traitIdsByObservationVariableDbId = - traitService.getIdsByObservationVariableDbIds( - program.getId(), - observations.stream() - .map(BrAPIObservation::getObservationVariableDbId) - .collect(Collectors.toList())); - - return observations.stream() - .filter(o -> studyDbId == null || studyDbId.equals(o.getStudyDbId())) - .peek(o -> - o.setObservationVariableDbId(traitIdsByObservationVariableDbId.get(o.getObservationVariableDbId()))) - .collect(Collectors.toList()); + public BrAPIObservationListResponse getObservationsByFilters(Program program, String studyDbId, Integer page, Integer pageSize) throws ApiException, DoesNotExistException { + BrAPIObservationSearchRequest observationSearchRequest = new BrAPIObservationSearchRequest() + .programDbIds(List.of(program.getBrapiProgram().getProgramDbId())); + + if (studyDbId != null) { + observationSearchRequest.setStudyDbIds(List.of(studyDbId)); + } + observationSearchRequest.setPage(page == null ? 0 : page); + observationSearchRequest.setPageSize(pageSize == null ? 1000 : pageSize); + + ObservationsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(program.getId()), ObservationsApi.class); + + BrAPIObservationListResponse brAPIResponse = brAPIDAOUtil.simpleSearch(api::searchObservationsPost, observationSearchRequest); + + List observations = brAPIDAOUtil.getListResult(brAPIResponse); + processObservations(program.getKey(), observations); + + HashMap traitIdsByObservationVariableDbId = traitService.getIdsByObservationVariableDbIds( + program.getId(), observations.stream() + .map(BrAPIObservation::getObservationVariableDbId).collect(Collectors.toList())); + + observations.forEach(observation -> observation + .setObservationVariableDbId(traitIdsByObservationVariableDbId.get(observation.getObservationVariableDbId()))); + brAPIResponse.getResult().setData(observations); + + return brAPIResponse; } @NotNull diff --git a/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationsControllerIntegrationTest.java b/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationsControllerIntegrationTest.java index aae656761..8ba8580b0 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationsControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/BrAPIObservationsControllerIntegrationTest.java @@ -368,6 +368,58 @@ public void testGetObsPagination() { checkPagination(1, 0, HttpStatus.BAD_REQUEST, null, null, null); checkPagination(10, 100, HttpStatus.BAD_REQUEST, null, null, null); + // Invalid negative values. + checkPagination(-1, 2, HttpStatus.BAD_REQUEST, null, null, null); + checkPagination(0, -1, HttpStatus.BAD_REQUEST, null, null, null); + + // Invalid boundary when the final page is partial. + checkPagination(2, 3, HttpStatus.BAD_REQUEST, null, null, null); + } + + @Test + public void testGetObsUnknownStudyReturnsEmptyFirstPage() { + Flowable> call = client.exchange( + GET(String.format("/programs/%s/brapi/v2/observations" + "?studyDbId=%s&page=0&pageSize=2", program.getId(), UUID.randomUUID())) + .bearerAuth("test-registered-user"), String.class); + + HttpResponse response = call.blockingFirst(); + + assertEquals(HttpStatus.OK, response.getStatus()); + + JsonObject responseObj = gson.fromJson(response.body(), JsonObject.class); + JsonArray observations = responseObj.getAsJsonObject("result").getAsJsonArray("data"); + JsonObject pagination = responseObj.getAsJsonObject("metadata").getAsJsonObject("pagination"); + + assertEquals(0, observations.size()); + assertEquals(0, pagination.get("currentPage").getAsInt()); + assertEquals(2, pagination.get("pageSize").getAsInt()); + assertEquals(0, pagination.get("totalCount").getAsInt()); + assertEquals(0, pagination.get("totalPages").getAsInt()); + } + + @Test + public void testGetObsByStudyDbIdWithPagination() { + Flowable> call = client.exchange( + GET(String.format( + "/programs/%s/brapi/v2/observations?studyDbId=%s&page=0&pageSize=1", + program.getId(), + envIds.get(0))) + .bearerAuth("test-registered-user"), String.class); + + HttpResponse response = call.blockingFirst(); + assertEquals(HttpStatus.OK, response.getStatus()); + + JsonObject responseObj = gson.fromJson(response.body(), JsonObject.class); + JsonArray observations = responseObj.getAsJsonObject("result").getAsJsonArray("data"); + JsonObject pagination = responseObj.getAsJsonObject("metadata").getAsJsonObject("pagination"); + + assertEquals(1, observations.size()); + assertEquals(envIds.get(0), observations.get(0).getAsJsonObject().get("studyDbId").getAsString()); + + assertEquals(0, pagination.get("currentPage").getAsInt()); + assertEquals(1, pagination.get("pageSize").getAsInt()); + assertEquals(2, pagination.get("totalCount").getAsInt()); + assertEquals(2, pagination.get("totalPages").getAsInt()); } private void checkPagination(Integer page, Integer pageSize, HttpStatus expectedStatus, Integer expectedSize, Integer expectedTotalCount, Integer expectedTotalPages) { @@ -400,7 +452,8 @@ private void checkPagination(Integer page, Integer pageSize, HttpStatus expected JsonObject responseObj = gson.fromJson(response.body(), JsonObject.class); // Get metadata. JsonObject pagination = responseObj.getAsJsonObject("metadata").getAsJsonObject("pagination"); - assertEquals(expectedSize, pagination.get("pageSize").getAsInt()); + int expectedPageSize = pageSize == null ? 1000 : pageSize; + assertEquals(expectedPageSize, pagination.get("pageSize").getAsInt()); int expectedPage = page == null ? 0 : page; assertEquals(expectedPage, pagination.get("currentPage").getAsInt()); assertEquals(expectedTotalPages, pagination.get("totalPages").getAsInt()); diff --git a/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAOUnitTest.java b/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAOUnitTest.java index a82bb9389..566fce142 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAOUnitTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAOUnitTest.java @@ -41,6 +41,9 @@ import static org.junit.jupiter.api.Assertions.assertTrue; import static org.mockito.ArgumentMatchers.*; import static org.mockito.Mockito.*; +import org.brapi.v2.model.pheno.response.BrAPIObservationListResponse; +import org.brapi.v2.model.pheno.response.BrAPIObservationListResponseResult; +import java.util.HashMap; public class BrAPIObservationDAOUnitTest { @@ -50,6 +53,7 @@ public class BrAPIObservationDAOUnitTest { private BrAPIObservationUnitDAO observationUnitDAO; private BrAPIDAOUtil brAPIDAOUtil; private Program program; + private TraitService traitService; @BeforeEach void setup() { @@ -65,6 +69,7 @@ void setup() { ProgramDAO programDAO = mock(ProgramDAO.class); observationUnitDAO = mock(BrAPIObservationUnitDAO.class); brAPIDAOUtil = mock(BrAPIDAOUtil.class); + traitService = mock(TraitService.class); when(programDAO.getCoreClient(programId)).thenReturn(mock(BrAPIClient.class)); @@ -75,7 +80,7 @@ void setup() { brAPIDAOUtil, new BrAPIEndpointProvider(), 1000, - mock(TraitService.class) + traitService ); } @@ -200,4 +205,70 @@ void observationSearchIsSkippedForEmptyFilters() { verifyNoInteractions(observationUnitDAO); verify(brAPIDAOUtil, never()).search(any(Function.class),any(Function4.class),any(BrAPIObservationSearchRequest.class)); } + + @Test + @SneakyThrows + void getObservationsByFiltersUsesDefaultsWithoutStudyFilter() { + List observations = List.of(); + + BrAPIObservationListResponse brAPIResponse = new BrAPIObservationListResponse().result(new BrAPIObservationListResponseResult().data(observations)); + + when(brAPIDAOUtil.simpleSearch(any(Function.class), any(BrAPIObservationSearchRequest.class))).thenReturn(brAPIResponse); + + doReturn(observations).when(brAPIDAOUtil).getListResult(brAPIResponse); + + when(traitService.getIdsByObservationVariableDbIds(program.getId(), List.of())).thenReturn(new HashMap<>()); + + observationDAO.getObservationsByFilters(program, null, null, null); + + ArgumentCaptor requestCaptor = ArgumentCaptor.forClass(BrAPIObservationSearchRequest.class); + + verify(brAPIDAOUtil).simpleSearch(any(Function.class), requestCaptor.capture()); + + BrAPIObservationSearchRequest request = requestCaptor.getValue(); + + assertEquals(List.of(BRAPI_PROGRAM_DB_ID), request.getProgramDbIds()); + assertEquals(null, request.getStudyDbIds()); + assertEquals(0, request.getPage()); + assertEquals(1000, request.getPageSize()); + } + + @Test + @SneakyThrows + void getObservationsByFiltersUsesBrAPISearchPagination() { + String brapiVariableDbId = "brapi-variable-1"; + String traitId = UUID.randomUUID().toString(); + + BrAPIObservation observation = new BrAPIObservation() + .observationDbId("observation-1") + .studyDbId("study-1") + .observationVariableDbId(brapiVariableDbId); + + List brapiObservations = List.of(observation); + BrAPIObservationListResponse brAPIResponse = new BrAPIObservationListResponse().result(new BrAPIObservationListResponseResult().data(brapiObservations)); + + when(brAPIDAOUtil.simpleSearch(any(Function.class), any(BrAPIObservationSearchRequest.class))).thenReturn(brAPIResponse); + + doReturn(brapiObservations).when(brAPIDAOUtil).getListResult(brAPIResponse); + + HashMap traitIdsByObservationVariableDbId = new HashMap<>(); + traitIdsByObservationVariableDbId.put(brapiVariableDbId, traitId); + + when(traitService.getIdsByObservationVariableDbIds(program.getId(), List.of(brapiVariableDbId))) + .thenReturn(traitIdsByObservationVariableDbId); + + BrAPIObservationListResponse result = observationDAO.getObservationsByFilters(program, "study-1", 2, 25); + + ArgumentCaptor requestCaptor = ArgumentCaptor.forClass(BrAPIObservationSearchRequest.class); + + verify(brAPIDAOUtil).simpleSearch(any(Function.class), requestCaptor.capture()); + + BrAPIObservationSearchRequest request = requestCaptor.getValue(); + + assertEquals(List.of(BRAPI_PROGRAM_DB_ID), request.getProgramDbIds()); + assertEquals(List.of("study-1"), request.getStudyDbIds()); + assertEquals(2, request.getPage()); + assertEquals(25, request.getPageSize()); + assertEquals(traitId, result.getResult().getData().get(0).getObservationVariableDbId()); + } } \ No newline at end of file From dce51f40032eed122f4d7e5140a99f26ceab7684 Mon Sep 17 00:00:00 2001 From: humsika Date: Wed, 14 Oct 2026 15:28:52 -0500 Subject: [PATCH 078/102] BI-2979: Optimized observation unit queries and add unit tests. --- .../brapi/v2/dao/BrAPIObservationUnitDAO.java | 21 ++- .../dao/BrAPIObservationUnitDAOUnitTest.java | 143 ++++++++++++++++++ 2 files changed, 152 insertions(+), 12 deletions(-) create mode 100644 src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAOUnitTest.java diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java index 2569f352f..1d1bab246 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAO.java @@ -200,10 +200,9 @@ public List getObservationUnitsById(Collection obs } public List getObservationUnitsForStudyDbId(@NotNull String studyDbId, Program program) throws ApiException { - // TODO: Optimize and change this to search/get on studyDbId once cache is removed for studies [BI-2979] - return getProgramObservationUnits(program.getId()).stream() - .filter(ou -> ou.getStudyDbId().equals(studyDbId)) - .collect(Collectors.toList()); + BrAPIObservationUnitSearchRequest observationUnitSearchRequest = buildSearchRequest(program, null); + observationUnitSearchRequest.setStudyDbIds(List.of(studyDbId)); + return searchObservationUnitsAndProcess(observationUnitSearchRequest, program, true); } public List getObservationUnitsForTrialDbIds(@NotNull UUID programId, List trialDbIds) throws ApiException { @@ -211,17 +210,15 @@ public List getObservationUnitsForTrialDbIds(@NotNull UUID return Collections.emptyList(); } - // TODO: Optimize and change this to search on trialDbIds [BI-2979] - return getProgramObservationUnits(programId).stream() - .filter(ou -> trialDbIds.contains(ou.getTrialDbId())) - .collect(Collectors.toList()); + Program program = programDAO.get(programId).stream().findFirst().orElseThrow(); + + BrAPIObservationUnitSearchRequest observationUnitSearchRequest = buildSearchRequest(program, null); + observationUnitSearchRequest.setTrialDbIds(trialDbIds); + return searchObservationUnitsAndProcess(observationUnitSearchRequest, program, true); } public List getObservationUnitsForTrialDbId(@NotNull UUID programId, @NotNull String trialDbId) throws ApiException { - return getProgramObservationUnits(programId).stream() - // TODO: Optimize and change this to search/get on trialDbId [BI-2979] - .filter(ou -> ou.getTrialDbId().equals(trialDbId)) - .collect(Collectors.toList()); + return getObservationUnitsForTrialDbIds(programId, List.of(trialDbId)); } public List getObservationUnitsForDataset(@NotNull String datasetId, @NotNull Program program) throws ApiException { diff --git a/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAOUnitTest.java b/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAOUnitTest.java new file mode 100644 index 000000000..b2639118f --- /dev/null +++ b/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAOUnitTest.java @@ -0,0 +1,143 @@ +/* + * See the NOTICE file distributed with this work for additional information + * regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.breedinginsight.brapi.v2.dao; + +import io.reactivex.functions.Function; +import io.reactivex.functions.Function3; +import lombok.SneakyThrows; +import org.brapi.client.v2.BrAPIClient; +import org.brapi.v2.model.core.BrAPIProgram; +import org.brapi.v2.model.pheno.request.BrAPIObservationUnitSearchRequest; +import org.breedinginsight.brapi.v2.services.BrAPIGermplasmService; +import org.breedinginsight.brapps.importer.daos.ImportDAO; +import org.breedinginsight.daos.ProgramDAO; +import org.breedinginsight.model.Program; +import org.breedinginsight.services.ProgramService; +import org.breedinginsight.services.brapi.BrAPIEndpointProvider; +import org.breedinginsight.utilities.BrAPIDAOUtil; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.mockito.ArgumentCaptor; + +import java.util.List; +import java.util.UUID; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.*; + +public class BrAPIObservationUnitDAOUnitTest { + + private static final String BRAPI_PROGRAM_DB_ID = "brapi-program-1"; + + private BrAPIObservationUnitDAO observationUnitDAO; + private ProgramDAO programDAO; + private BrAPIDAOUtil brAPIDAOUtil; + private Program program; + + @BeforeEach + @SneakyThrows + void setup() { + UUID programId = UUID.randomUUID(); + + BrAPIProgram brapiProgram = new BrAPIProgram().programDbId(BRAPI_PROGRAM_DB_ID); + + program = new Program(); + program.setId(programId); + program.setKey("TEST"); + program.setBrapiProgram(brapiProgram); + + programDAO = mock(ProgramDAO.class); + brAPIDAOUtil = mock(BrAPIDAOUtil.class); + BrAPIGermplasmService germplasmService = mock(BrAPIGermplasmService.class); + + when(programDAO.get(programId)).thenReturn(List.of(program)); + when(programDAO.getProgramBrAPI(program)).thenReturn(brapiProgram); + when(programDAO.getCoreClient(programId)).thenReturn(mock(BrAPIClient.class)); + when(germplasmService.getGermplasm(programId)).thenReturn(List.of()); + + when(brAPIDAOUtil.search(any(Function.class), any(Function3.class), any(BrAPIObservationUnitSearchRequest.class))).thenReturn(List.of()); + + observationUnitDAO = new BrAPIObservationUnitDAO(programDAO, mock(ImportDAO.class), + brAPIDAOUtil, + new BrAPIEndpointProvider(), germplasmService, mock(ProgramService.class), + "test-reference-source", + 1000 + ); + } + + @Test + @SneakyThrows + void getObservationUnitsForStudyDbIdUsesBrAPISearch() { + String studyDbId = "study-1"; + + observationUnitDAO.getObservationUnitsForStudyDbId(studyDbId, program); + + ArgumentCaptor requestCaptor = ArgumentCaptor.forClass(BrAPIObservationUnitSearchRequest.class); + + verify(brAPIDAOUtil).search(any(Function.class), any(Function3.class), requestCaptor.capture()); + + BrAPIObservationUnitSearchRequest request = requestCaptor.getValue(); + + assertEquals(List.of(BRAPI_PROGRAM_DB_ID), request.getProgramDbIds()); + assertEquals(List.of(studyDbId), request.getStudyDbIds()); + } + + @Test + @SneakyThrows + void getObservationUnitsForTrialDbIdsUsesBrAPISearch() { + List trialDbIds = List.of("trial-1", "trial-2"); + + observationUnitDAO.getObservationUnitsForTrialDbIds(program.getId(), trialDbIds); + + ArgumentCaptor requestCaptor = ArgumentCaptor.forClass(BrAPIObservationUnitSearchRequest.class); + + verify(brAPIDAOUtil).search(any(Function.class), any(Function3.class), requestCaptor.capture()); + + BrAPIObservationUnitSearchRequest request = requestCaptor.getValue(); + + assertEquals(List.of(BRAPI_PROGRAM_DB_ID), request.getProgramDbIds()); + assertEquals(trialDbIds, request.getTrialDbIds()); + } + + @Test + @SneakyThrows + void getObservationUnitsForTrialDbIdUsesBrAPISearch() { + String trialDbId = "trial-1"; + + observationUnitDAO.getObservationUnitsForTrialDbId(program.getId(), trialDbId); + + ArgumentCaptor requestCaptor = ArgumentCaptor.forClass(BrAPIObservationUnitSearchRequest.class); + + verify(brAPIDAOUtil).search(any(Function.class), any(Function3.class), requestCaptor.capture()); + + BrAPIObservationUnitSearchRequest request = requestCaptor.getValue(); + + assertEquals(List.of(BRAPI_PROGRAM_DB_ID), request.getProgramDbIds()); + assertEquals(List.of(trialDbId), request.getTrialDbIds()); + } + + @Test + @SneakyThrows + void getObservationUnitsForEmptyTrialDbIdsDoesNotSearch() { + + assertTrue(observationUnitDAO.getObservationUnitsForTrialDbIds(program.getId(), List.of()).isEmpty()); + + verify(brAPIDAOUtil, never()).search(any(Function.class), any(Function3.class), any(BrAPIObservationUnitSearchRequest.class)); + } +} \ No newline at end of file From 9108636b362df23495f25e8756d5ca0aa8ff8b6a Mon Sep 17 00:00:00 2001 From: jloux-brapi Date: Thu, 15 Oct 2026 10:30:59 -0400 Subject: [PATCH 079/102] Update src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java --- .../org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java | 1 + 1 file changed, 1 insertion(+) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java index ccd95948e..0ca219012 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java @@ -220,6 +220,7 @@ public BrAPIObservationListResponse getObservationsByFilters(Program program, St List observations = brAPIDAOUtil.getListResult(brAPIResponse); processObservations(program.getKey(), observations); + // TODO: Investigate if this resetting of the observationVariableDbId can be undone when trait exrefs are examined [BI-2925] HashMap traitIdsByObservationVariableDbId = traitService.getIdsByObservationVariableDbIds( program.getId(), observations.stream() .map(BrAPIObservation::getObservationVariableDbId).collect(Collectors.toList())); From 14e10129f3e3a949af066d776171faaa56567b9e Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Thu, 15 Oct 2026 18:43:51 -0400 Subject: [PATCH 080/102] Utilize prod server changes to correctly sort/filter/paginate germs by list --- .../brapi/v2/dao/BrAPIGermplasmDAO.java | 22 ++++- .../brapi/v2/dao/BrAPIListDAO.java | 47 +++++++-- .../v2/services/BrAPIGermplasmService.java | 97 ++++--------------- 3 files changed, 76 insertions(+), 90 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java index 998662370..fc6e50330 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java @@ -17,6 +17,8 @@ package org.breedinginsight.brapi.v2.dao; +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; import com.google.gson.JsonObject; import io.micronaut.context.annotation.Property; import io.micronaut.http.HttpStatus; @@ -27,7 +29,9 @@ import org.brapi.client.v2.model.queryParams.germplasm.GermplasmQueryParams; import org.brapi.client.v2.modules.germplasm.GermplasmApi; import org.brapi.v2.model.BrAPIExternalReference; +import org.brapi.v2.model.core.BrAPIListItemWithFullItem; import org.brapi.v2.model.core.BrAPIProgram; +import org.brapi.v2.model.core.response.BrAPIListItemsListResponse; import org.brapi.v2.model.germ.BrAPIGermplasm; import org.brapi.v2.model.germ.BrAPIGermplasmSynonyms; import org.brapi.v2.model.germ.request.BrAPIGermplasmSearchRequest; @@ -45,6 +49,7 @@ import org.breedinginsight.utilities.Utilities; import javax.inject.Inject; +import javax.inject.Named; import javax.inject.Singleton; import java.util.*; import java.util.stream.Collectors; @@ -56,6 +61,8 @@ public class BrAPIGermplasmDAO { private final ProgramDAO programDAO; private final ImportDAO importDAO; private final BrAPIDAOUtil brAPIDAOUtil; + private final ObjectMapper objectMapper; + private final BrAPIListDAO brAPIListDAO; @Property(name = "brapi.server.reference-source") private String referenceSource; @@ -72,12 +79,16 @@ public BrAPIGermplasmDAO(ProgramDAO programDAO, ImportDAO importDAO, BrAPIDAOUtil brAPIDAOUtil, BrAPIEndpointProvider brAPIEndpointProvider, - @Property(name = "brapi.cache.fetch-page-size") int brapiFetchPageSize) { + @Property(name = "brapi.cache.fetch-page-size") int brapiFetchPageSize, + ObjectMapper objectMapper, + BrAPIListDAO brAPIListDAO) { this.programDAO = programDAO; this.importDAO = importDAO; this.brAPIDAOUtil = brAPIDAOUtil; this.brAPIEndpointProvider = brAPIEndpointProvider; this.brapiMaxPageSize = brapiFetchPageSize; + this.objectMapper = objectMapper; + this.brAPIListDAO = brAPIListDAO; } /** @@ -427,13 +438,14 @@ public List getGermplasmByRawName(List germplasmNames, U .collect(Collectors.toList()); } - public BrAPIGermplasmListResponse searchGermplasmByRawName(List germplasmNames, UUID programId, GermplasmQuery germplasmQuery) throws ApiException { + public BrAPIListItemsListResponse searchGermplasmByList(String listDbId, UUID programId, GermplasmQuery germplasmQuery) throws ApiException { Program program = new Program(programDAO.fetchOneById(programId)); - BrAPIGermplasmSearchRequest searchRequest = new BrAPIGermplasmSearchRequest(); - searchRequest.setGermplasmNames(germplasmNames); + BrAPIGermplasmSearchRequest searchRequest = buildSearchRequest(program, null, germplasmQuery); + + JsonNode listRequestBody = objectMapper.valueToTree(searchRequest); - return brapiGermplasmSearchReturnResponse(program, searchRequest, germplasmQuery); + return brAPIListDAO.searchBrAPIListItemsByList(listDbId, programId, listRequestBody, BrAPIGermplasm.class); } public List brapiGermplasmSearchReturnList(Program program, diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIListDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIListDAO.java index 4f6cfdec7..65c9d6a7e 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIListDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIListDAO.java @@ -17,6 +17,7 @@ package org.breedinginsight.brapi.v2.dao; +import com.fasterxml.jackson.databind.JsonNode; import io.micronaut.http.HttpResponse; import lombok.extern.slf4j.Slf4j; import okhttp3.HttpUrl; @@ -27,14 +28,13 @@ import org.brapi.v2.model.BrAPIExternalReference; import org.brapi.v2.model.BrAPIResponse; import org.brapi.v2.model.BrAPIResponseResult; +import org.brapi.v2.model.core.BrAPIListItemWithFullItem; import org.brapi.v2.model.core.BrAPIListSummary; import org.brapi.v2.model.core.BrAPIListTypes; import org.brapi.v2.model.core.request.BrAPIListNewRequest; import org.brapi.v2.model.core.request.BrAPIListSearchRequest; -import org.brapi.v2.model.core.response.BrAPIListDetails; -import org.brapi.v2.model.core.response.BrAPIListsListResponse; -import org.brapi.v2.model.core.response.BrAPIListsListResponseResult; -import org.brapi.v2.model.core.response.BrAPIListsSingleResponse; +import org.brapi.v2.model.core.response.*; +import org.brapi.v2.model.germ.BrAPIGermplasm; import org.breedinginsight.brapps.importer.daos.ImportDAO; import org.breedinginsight.brapps.importer.model.ImportUpload; import org.breedinginsight.daos.ProgramDAO; @@ -71,7 +71,7 @@ public BrAPIListDAO(ProgramDAO programDAO, } public List getListsByName(List listNames, UUID programId) throws ApiException { - if(listNames.isEmpty()) { + if (listNames.isEmpty()) { return Collections.emptyList(); } @@ -122,11 +122,11 @@ private List processListsForProgram(List pro // check that all lists were created via the BI UI in case the BrAPI service silently ignores the search by // externalReference source and ID List filteredLists = new ArrayList<>(); - for (BrAPIListSummary list: programLists) { + for (BrAPIListSummary list : programLists) { if (list.getExternalReferences() == null || list.getExternalReferences().size() == 0) { continue; } else { - for (BrAPIExternalReference ref: list.getExternalReferences()) { + for (BrAPIExternalReference ref : list.getExternalReferences()) { if (ref.getReferenceID().equals(externalReferenceId.toString()) && ref.getReferenceSource().equals(externalReferenceSource)) { filteredLists.add(list); @@ -136,6 +136,7 @@ private List processListsForProgram(List pro } return filteredLists; } + public List updateBrAPIList(String brAPIListDbId, BrAPIListDetails mutatedList, UUID programId) throws ApiException { ListsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(programId), ListsApi.class); BrAPIListNewRequest request = new BrAPIListNewRequest(); @@ -160,7 +161,7 @@ public List updateBrAPIList(String brAPIListDbId, BrAPIListDetails mutat log.error(Utilities.generateApiExceptionLogMessage(e)); throw e; } - if(response != null) { + if (response != null) { BrAPIListsSingleResponse body = response.getBody(); if (body == null) { throw new ApiException("Response is missing body", 0, response.getHeaders(), null); @@ -188,7 +189,7 @@ public List createBrAPILists(List brapiLi log.warn(Utilities.generateApiExceptionLogMessage(e)); throw e; } - if(response != null) { + if (response != null) { BrAPIResponse body = response.getBody(); if (body == null) { throw new ApiException("Response is missing body", 0, response.getHeaders(), null); @@ -220,4 +221,32 @@ public HttpResponse deleteBrAPIList(String listDbId, UUID programId, boo return brAPIDAOUtil.makeCall(brapiRequest); } + public BrAPIListItemsListResponse searchBrAPIListItemsByList(String listDbId, UUID programId, JsonNode requestBody, Class itemClass) throws ApiException { + ListsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(programId), ListsApi.class); + // Do manually, it doesn't like List to List for some reason + ApiResponse> response; + try { + response = api.searchListItemsByList(listDbId, requestBody, itemClass); + } catch (ApiException e) { + log.warn(Utilities.generateApiExceptionLogMessage(e)); + throw e; + } + + if (response != null) { + BrAPIResponse> body = response.getBody(); + if (body == null) { + throw new ApiException("Response is missing body", 0, response.getHeaders(), null); + } + BrAPIResponseResult> result = body.getResult(); + if (result == null) { + throw new ApiException("Response body is missing result", 0, response.getHeaders(), response.getBody().toString()); + } + if (result.getData() == null) { + throw new ApiException("Response result is missing data", 0, response.getHeaders(), response.getBody().toString()); + } + return response.getBody(); + } + + throw new ApiException("No response for BrAPI list item search"); + } } diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIGermplasmService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIGermplasmService.java index 333d9910f..4028d25b2 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIGermplasmService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIGermplasmService.java @@ -7,12 +7,15 @@ import org.brapi.client.v2.model.exceptions.ApiException; import org.brapi.v2.model.BrAPIExternalReference; import lombok.extern.slf4j.Slf4j; +import org.brapi.v2.model.core.BrAPIListItemWithFullItem; import org.brapi.v2.model.core.request.BrAPIListNewRequest; import org.brapi.v2.model.core.response.BrAPIListDetails; +import org.brapi.v2.model.core.response.BrAPIListItemsListResponse; import org.brapi.v2.model.core.response.BrAPIListsSingleResponse; import org.brapi.v2.model.germ.BrAPIGermplasm; import org.brapi.v2.model.germ.BrAPIGermplasmSynonyms; import org.brapi.v2.model.germ.response.BrAPIGermplasmListResponse; +import org.brapi.v2.model.germ.response.BrAPIGermplasmListResponseResult; import org.breedinginsight.brapi.v2.constants.BrAPIAdditionalInfoFields; import org.breedinginsight.brapi.v2.dao.BrAPIListDAO; import org.breedinginsight.brapi.v2.model.request.query.GermplasmQuery; @@ -172,96 +175,38 @@ public BrAPIGermplasmListResponse getGermplasmByList(UUID programId, GermplasmQu if(Objects.nonNull(listResponse) && Objects.nonNull(listResponse.getResult())) { // get the list ID stored in the list external references - UUID listId = getGermplasmListId(listResponse.getResult()); + // TODO: See if this can be removed/replaced with actual BrAPI list db id + UUID biGermplasmListId = getGermplasmListId(listResponse.getResult()); - // get list BrAPI germplasm variables. - // The order of these germplasm names are the exact order/entry number in the list that was imported. - List germplasmNamesFromBrapiList = listResponse.getResult().getData(); + // Required for the actual data search in BrAPI + String brapiListDbId = listResponse.getResult().getListDbId(); - BrAPIGermplasmListResponse germplasmSearchResponse = germplasmDAO.searchGermplasmByRawName(germplasmNamesFromBrapiList, programId, germplasmQuery); + BrAPIListItemsListResponse listSearchResponse = germplasmDAO.searchGermplasmByList(brapiListDbId, programId, germplasmQuery); - List germplasm = germplasmSearchResponse.getResult().getData(); - Map germplasmByGid = new HashMap<>(); + List> listItemsWithFullItem = listSearchResponse.getResult().getData(); - if (germplasm == null || germplasm.isEmpty()) { - return germplasmSearchResponse; - } - - for (BrAPIGermplasm g : germplasm) { - // set the list ID in the germplasm additional info - g.putAdditionalInfoItem(BrAPIAdditionalInfoFields.GERMPLASM_LIST_ID, listId); - // Add to map. - germplasmByGid.put(g.getAccessionNumber(), g); - } - - // Extract gids from list names - List gids = germplasmNamesFromBrapiList.stream().map(Utilities::extractGid).collect(Collectors.toList()); - - // Build list from BrAPI list that preserves ordering and duplicates and assigns sequential entry numbers. - List orderByEntryNumber = new ArrayList<>(); - - Program program = programService.getById(programId).orElseThrow(() -> new DoesNotExistException("Could not find program: " + programId)); - - for (String gid : gids) { - BrAPIGermplasm germ = germplasmByGid.get(gid); + listItemsWithFullItem.forEach(li -> { + li.getItem().putAdditionalInfoItem(BrAPIAdditionalInfoFields.GERMPLASM_LIST_ID, biGermplasmListId); + li.getItem().putAdditionalInfoItem(BrAPIAdditionalInfoFields.GERMPLASM_IMPORT_ENTRY_NUMBER, li.getListItem().getPosition() + 1); + }); - if (germ == null) { - continue; - } - - // We can't simply use germ.getGermplasmName here because the BrAPIGermplasmDAO code strips the key and gid via BrAPIGermplasmDAO.processGermplasmForDisplay() - // Rebuild the unique name so we can get the entry number via the order on the germplasmNamesFromBrapiList list which was derived from the list response. - String fullGermplasmName = Utilities.appendProgramKey(germ.getDefaultDisplayName(), program.getKey(), germ.getAccessionNumber()); + List germplasm = listItemsWithFullItem.stream().map(BrAPIListItemWithFullItem::getItem).collect(Collectors.toList()); - BrAPIGermplasm listEntry = cloneBrAPIGermplasm(germ); + BrAPIGermplasmListResponse germplasmSearchResponse = new BrAPIGermplasmListResponse(); + BrAPIGermplasmListResponseResult germplasmListResponseResult = new BrAPIGermplasmListResponseResult(); - int entryNumber = germplasmNamesFromBrapiList.indexOf(fullGermplasmName) + 1; - - // Set entry number. - listEntry.putAdditionalInfoItem(BrAPIAdditionalInfoFields.GERMPLASM_IMPORT_ENTRY_NUMBER, entryNumber); - germ.putAdditionalInfoItem(BrAPIAdditionalInfoFields.GERMPLASM_IMPORT_ENTRY_NUMBER, entryNumber); - orderByEntryNumber.add(listEntry); - } + germplasmSearchResponse.setMetadata(listSearchResponse.getMetadata()); + germplasmListResponseResult.setData(germplasm); + germplasmSearchResponse.setResult(germplasmListResponseResult); - if (germplasmQuery.getSortField() == null || germplasmQuery.getSortField().equals("importEntryNumber")) { - // This should order by entry number when germplasm list details page displays - germplasmSearchResponse.getResult().setData(orderByEntryNumber); - } else { - // In all other cases it will order by the other selected data - germplasmSearchResponse.getResult().setData(germplasm); + if (germplasm.isEmpty()) { + return germplasmSearchResponse; } return germplasmSearchResponse; } else throw new ApiException(); } -// private BrAPIGermplasmListResponse orderByListImportEntryNumber() { -// for (String gid : gids) { -// BrAPIGermplasm germ = germplasmByGid.get(gid); -// -// if (germ == null) { -// continue; -// } -// -// // We can't simply use germ.getGermplasmName here because the BrAPIGermplasmDAO code strips the key and gid via BrAPIGermplasmDAO.processGermplasmForDisplay() -// // Rebuild the unique name so we can get the entry number via the order on the germplasmNamesFromBrapiList list which was derived from the list response. -// String fullGermplasmName = Utilities.appendProgramKey(germ.getDefaultDisplayName(), program.getKey(), germ.getAccessionNumber()); -// -// BrAPIGermplasm listEntry = cloneBrAPIGermplasm(germ); -// -// int entryNumber = germplasmNamesFromBrapiList.indexOf(fullGermplasmName) + 1; -// -// // Set entry number. -// listEntry.putAdditionalInfoItem(BrAPIAdditionalInfoFields.GERMPLASM_IMPORT_ENTRY_NUMBER, entryNumber); -// orderByEntryNumber.add(listEntry); -// } -// } - - private BrAPIGermplasm cloneBrAPIGermplasm(BrAPIGermplasm germplasm) { - // Serialize then deserialize to deep copy. - return (BrAPIGermplasm) gson.fromJson(gson.toJson(germplasm), BrAPIGermplasm.class); - } - public DownloadFile exportGermplasm(UUID programId, FileType fileExtension) throws IllegalArgumentException, ApiException, IOException, DoesNotExistException { List columns = GermplasmFileColumns.getOrderedColumns(); From ece4f54c31c27e000222e0ff1b762ebc170dbbb6 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Fri, 16 Oct 2026 14:56:42 -0400 Subject: [PATCH 081/102] Force type parametrization serialization on the client --- .../org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java | 6 +++++- .../java/org/breedinginsight/brapi/v2/dao/BrAPIListDAO.java | 4 ++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java index fc6e50330..d7c25ef7c 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java @@ -445,7 +445,11 @@ public BrAPIListItemsListResponse searchGermplasmByList(String l JsonNode listRequestBody = objectMapper.valueToTree(searchRequest); - return brAPIListDAO.searchBrAPIListItemsByList(listDbId, programId, listRequestBody, BrAPIGermplasm.class); + BrAPIListItemsListResponse response = brAPIListDAO.searchBrAPIListItemsByList(listDbId, programId, listRequestBody); + + processGermplasmForDisplay(response.getResult().getData().stream().map(BrAPIListItemWithFullItem::getItem).collect(Collectors.toList()), program); + + return response; } public List brapiGermplasmSearchReturnList(Program program, diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIListDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIListDAO.java index 65c9d6a7e..be9b3fcd3 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIListDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIListDAO.java @@ -221,12 +221,12 @@ public HttpResponse deleteBrAPIList(String listDbId, UUID programId, boo return brAPIDAOUtil.makeCall(brapiRequest); } - public BrAPIListItemsListResponse searchBrAPIListItemsByList(String listDbId, UUID programId, JsonNode requestBody, Class itemClass) throws ApiException { + public BrAPIListItemsListResponse searchBrAPIListItemsByList(String listDbId, UUID programId, JsonNode requestBody) throws ApiException { ListsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(programId), ListsApi.class); // Do manually, it doesn't like List to List for some reason ApiResponse> response; try { - response = api.searchListItemsByList(listDbId, requestBody, itemClass); + response = api.searchListItemsByList(listDbId, requestBody); } catch (ApiException e) { log.warn(Utilities.generateApiExceptionLogMessage(e)); throw e; From 8dc5c9e6573e2649265d9e3837d9662e125254f8 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Mon, 19 Oct 2026 12:50:29 -0400 Subject: [PATCH 082/102] Add comment --- .../org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java | 2 ++ .../brapi/v2/services/BrAPIGermplasmService.java | 2 ++ 2 files changed, 4 insertions(+) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java index d7c25ef7c..cc203255a 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java @@ -443,6 +443,8 @@ public BrAPIListItemsListResponse searchGermplasmByList(String l BrAPIGermplasmSearchRequest searchRequest = buildSearchRequest(program, null, germplasmQuery); + // Because the list item search endpoint is generalized, a typed BrAPISearchRequest won't work, so convert it to JsonNode. + // The search request type is derived by the client/prod server based off of the type of the submitted list dbId. JsonNode listRequestBody = objectMapper.valueToTree(searchRequest); BrAPIListItemsListResponse response = brAPIListDAO.searchBrAPIListItemsByList(listDbId, programId, listRequestBody); diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIGermplasmService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIGermplasmService.java index 4028d25b2..03d7ddfc5 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIGermplasmService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIGermplasmService.java @@ -187,6 +187,8 @@ public BrAPIGermplasmListResponse getGermplasmByList(UUID programId, GermplasmQu listItemsWithFullItem.forEach(li -> { li.getItem().putAdditionalInfoItem(BrAPIAdditionalInfoFields.GERMPLASM_LIST_ID, biGermplasmListId); + // listItem.position start of index is 0 in BrAPI, but in DeltaBreed, it starts at 1. increment result data to account for this. + // The actual sort/filter performs the search on a formula column created on the prod server, so no need to worry about that in the request above. li.getItem().putAdditionalInfoItem(BrAPIAdditionalInfoFields.GERMPLASM_IMPORT_ENTRY_NUMBER, li.getListItem().getPosition() + 1); }); From 3abd1a950d67088da3f78a60821aaa7f59a6a98b Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Mon, 19 Oct 2026 18:16:54 -0400 Subject: [PATCH 083/102] Fix broken unit test --- .../services/BrAPIGermplasmServiceUnitTest.java | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/test/java/org/breedinginsight/services/BrAPIGermplasmServiceUnitTest.java b/src/test/java/org/breedinginsight/services/BrAPIGermplasmServiceUnitTest.java index 7251b02e9..6795eb0bf 100644 --- a/src/test/java/org/breedinginsight/services/BrAPIGermplasmServiceUnitTest.java +++ b/src/test/java/org/breedinginsight/services/BrAPIGermplasmServiceUnitTest.java @@ -1,5 +1,6 @@ package org.breedinginsight.services; +import com.fasterxml.jackson.databind.ObjectMapper; import com.google.gson.JsonObject; import io.reactivex.functions.Function; import io.reactivex.functions.Function3; @@ -60,7 +61,7 @@ void setup() { listDAO = mock(BrAPIListDAO.class); programDAO = mock(ProgramDAO.class); brAPIDAOUtil = mock(BrAPIDAOUtil.class); - germplasmDAO = new BrAPIGermplasmDAO(programDAO, mock(ImportDAO.class), brAPIDAOUtil, new BrAPIEndpointProvider(), 65000); + germplasmDAO = new BrAPIGermplasmDAO(programDAO, mock(ImportDAO.class), brAPIDAOUtil, new BrAPIEndpointProvider(), 65000, new ObjectMapper(), listDAO); programService = mock(ProgramService.class); Field externalReferenceSource = BrAPIGermplasmDAO.class.getDeclaredField("referenceSource"); From a5433ef8e095a467c8d1b51156ba8a54ee7b3d44 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Mon, 19 Oct 2026 19:06:11 -0400 Subject: [PATCH 084/102] Set entry number sorting/filtering to correct brapi column name --- .../brapi/v2/model/request/query/GermplasmQuery.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/model/request/query/GermplasmQuery.java b/src/main/java/org/breedinginsight/brapi/v2/model/request/query/GermplasmQuery.java index d00255f68..22188a05f 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/model/request/query/GermplasmQuery.java +++ b/src/main/java/org/breedinginsight/brapi/v2/model/request/query/GermplasmQuery.java @@ -74,7 +74,7 @@ public SearchRequest constructSearchRequest() { public Map getFilterValuesByBrAPIColumnName() { Map filterValuesByBrAPIColumnName = new HashMap<>(); - filterValuesByBrAPIColumnName.put("importEntryNumber", getImportEntryNumber()); + filterValuesByBrAPIColumnName.put("listItemPosition", getImportEntryNumber()); filterValuesByBrAPIColumnName.put("accessionNumber", getAccessionNumber()); filterValuesByBrAPIColumnName.put("defaultDisplayName", getDefaultDisplayName()); filterValuesByBrAPIColumnName.put("breedingMethod", getBreedingMethod()); @@ -93,7 +93,7 @@ public Map getFilterValuesByBrAPIColumnName() { public Map getBrAPIColumnNamesByBiColumnName() { Map brAPIColumnNamesByBiColumnName = new HashMap<>(); - brAPIColumnNamesByBiColumnName.put("importEntryNumber", "importEntryNumber"); + brAPIColumnNamesByBiColumnName.put("importEntryNumber", "listItemPosition"); brAPIColumnNamesByBiColumnName.put("accessionNumber", "accessionNumber"); brAPIColumnNamesByBiColumnName.put("defaultDisplayName", "defaultDisplayName"); brAPIColumnNamesByBiColumnName.put("breedingMethod", "breedingMethod"); From 64d3da89946c5de7e5d106a71f3f3b4e14d58b3e Mon Sep 17 00:00:00 2001 From: humsika Date: Mon, 19 Oct 2026 20:55:37 -0500 Subject: [PATCH 085/102] BI-2979: Modified unit tests. --- .../brapi/v2/dao/BrAPIObservationUnitDAOUnitTest.java | 1 - 1 file changed, 1 deletion(-) diff --git a/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAOUnitTest.java b/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAOUnitTest.java index b2639118f..6e70bcfd5 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAOUnitTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationUnitDAOUnitTest.java @@ -135,7 +135,6 @@ void getObservationUnitsForTrialDbIdUsesBrAPISearch() { @Test @SneakyThrows void getObservationUnitsForEmptyTrialDbIdsDoesNotSearch() { - assertTrue(observationUnitDAO.getObservationUnitsForTrialDbIds(program.getId(), List.of()).isEmpty()); verify(brAPIDAOUtil, never()).search(any(Function.class), any(Function3.class), any(BrAPIObservationUnitSearchRequest.class)); From c5a3665dcd66efc7afdac4ee627b03de4215024d Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Tue, 20 Oct 2026 16:30:54 -0400 Subject: [PATCH 086/102] Continue support of original importEntryNumber, add support for listEntryNumber --- .../model/request/query/GermplasmQuery.java | 55 +++++-------------- 1 file changed, 15 insertions(+), 40 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/model/request/query/GermplasmQuery.java b/src/main/java/org/breedinginsight/brapi/v2/model/request/query/GermplasmQuery.java index 22188a05f..28bf28b0a 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/model/request/query/GermplasmQuery.java +++ b/src/main/java/org/breedinginsight/brapi/v2/model/request/query/GermplasmQuery.java @@ -15,6 +15,7 @@ @Getter @Introspected public class GermplasmQuery extends BrapiQuery { + // Actual DB entry number stored in each germplasm.additional_info private String importEntryNumber; private String accessionNumber; private String defaultDisplayName; @@ -26,55 +27,20 @@ public class GermplasmQuery extends BrapiQuery { private String createdDate; private String createdByUserName; private String synonym; + // This entry number depicts the sequential order of any given germplasm list. + // To be used only in the use case where listDbId is present and a search request is occurring on a germplasm list. + private String listEntryNumber; // This is a meta-parameter, it describes the display format of any date fields. private String dateDisplayFormat; // The list id used to get a collection of germplasm private String listDbId; - public SearchRequest constructSearchRequest() { - List filters = new ArrayList<>(); - if (!StringUtils.isBlank(getImportEntryNumber())) { - filters.add(constructFilterRequest("importEntryNumber", getImportEntryNumber())); - } - if (!StringUtils.isBlank(getAccessionNumber())) { - filters.add(constructFilterRequest("accessionNumber", getAccessionNumber())); - } - if (!StringUtils.isBlank(getDefaultDisplayName())) { - filters.add(constructFilterRequest("defaultDisplayName", getDefaultDisplayName())); - } - if (!StringUtils.isBlank(getBreedingMethod())) { - filters.add(constructFilterRequest("breedingMethod", getBreedingMethod())); - } - if (!StringUtils.isBlank(getSeedSource())) { - filters.add(constructFilterRequest("seedSource", getSeedSource())); - } - if (!StringUtils.isBlank(getPedigree())) { - filters.add(constructFilterRequest("pedigree", getPedigree())); - } - if (!StringUtils.isBlank(getFemaleParentGID())) { - filters.add(constructFilterRequest("femaleParentGID", getFemaleParentGID())); - } - if (!StringUtils.isBlank(getMaleParentGID())) { - filters.add(constructFilterRequest("maleParentGID", getMaleParentGID())); - } - if (!StringUtils.isBlank(getCreatedDate())) { - filters.add(constructFilterRequest("createdDate", getCreatedDate())); - } - if (!StringUtils.isBlank(getCreatedByUserName())) { - filters.add(constructFilterRequest("createdByUserName", getCreatedByUserName())); - } - if (!StringUtils.isBlank(getSynonym())) { - filters.add(constructFilterRequest("synonyms", getSynonym())); - } - return new SearchRequest(filters); - } - @Override public Map getFilterValuesByBrAPIColumnName() { Map filterValuesByBrAPIColumnName = new HashMap<>(); - filterValuesByBrAPIColumnName.put("listItemPosition", getImportEntryNumber()); + filterValuesByBrAPIColumnName.put("importEntryNumber", getImportEntryNumber()); filterValuesByBrAPIColumnName.put("accessionNumber", getAccessionNumber()); filterValuesByBrAPIColumnName.put("defaultDisplayName", getDefaultDisplayName()); filterValuesByBrAPIColumnName.put("breedingMethod", getBreedingMethod()); @@ -86,6 +52,10 @@ public Map getFilterValuesByBrAPIColumnName() { filterValuesByBrAPIColumnName.put("createdBy", getCreatedByUserName()); filterValuesByBrAPIColumnName.put("synonyms", getSynonym()); + if (!StringUtils.isBlank(listDbId)) { + filterValuesByBrAPIColumnName.put("listItemPosition", getListEntryNumber()); + } + return filterValuesByBrAPIColumnName; } @@ -93,7 +63,7 @@ public Map getFilterValuesByBrAPIColumnName() { public Map getBrAPIColumnNamesByBiColumnName() { Map brAPIColumnNamesByBiColumnName = new HashMap<>(); - brAPIColumnNamesByBiColumnName.put("importEntryNumber", "listItemPosition"); + brAPIColumnNamesByBiColumnName.put("importEntryNumber", "importEntryNumber"); brAPIColumnNamesByBiColumnName.put("accessionNumber", "accessionNumber"); brAPIColumnNamesByBiColumnName.put("defaultDisplayName", "defaultDisplayName"); brAPIColumnNamesByBiColumnName.put("breedingMethod", "breedingMethod"); @@ -105,6 +75,11 @@ public Map getBrAPIColumnNamesByBiColumnName() { brAPIColumnNamesByBiColumnName.put("createdByUserName", "createdBy"); brAPIColumnNamesByBiColumnName.put("synonyms", "synonyms"); + if (!StringUtils.isBlank(listDbId)) { + brAPIColumnNamesByBiColumnName.put("listEntryNumber", "listItemPosition"); + } + + return brAPIColumnNamesByBiColumnName; } } From e09d8bf83408036f57dc6e6082079c2d9718112f Mon Sep 17 00:00:00 2001 From: humsika Date: Mon, 26 Oct 2026 10:56:03 -0500 Subject: [PATCH 087/102] BI-3028: Updated getGermplasmByRawName to use BrAPI germplasm search and added unit tests. --- .../brapi/v2/dao/BrAPIGermplasmDAO.java | 23 +++++++++++++++---- .../BrAPIGermplasmServiceUnitTest.java | 5 ++-- 2 files changed, 20 insertions(+), 8 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java index cc203255a..fabf2bd70 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAO.java @@ -430,12 +430,25 @@ public List updateBrAPIGermplasm(List putBrAPIGe } public List getGermplasmByRawName(List germplasmNames, UUID programId) throws ApiException { - // TODO: Optimize this method by utilizing a BrAPIGermplasmSearchRequest [BI-3028] Program program = new Program(programDAO.fetchOneById(programId)); - return getGermplasm(programId) - .stream() - .filter(brAPIGermplasm -> germplasmNames.contains(Utilities.appendProgramKey(brAPIGermplasm.getGermplasmName(),program.getKey(),brAPIGermplasm.getAccessionNumber()))) - .collect(Collectors.toList()); + + if (germplasmNames.isEmpty()) { + return new ArrayList<>(); + } + + BrAPIGermplasmSearchRequest searchRequest = new BrAPIGermplasmSearchRequest(); + searchRequest.setGermplasmNames(germplasmNames); + + searchRequest = buildSearchRequest(program, searchRequest, null); + + GermplasmApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(program.getId()), GermplasmApi.class); + + List germplasm = brAPIDAOUtil.search( + api::searchGermplasmPost, + api::searchGermplasmSearchResultsDbIdGet, + searchRequest); + + return processGermplasmForDisplay(germplasm, program); } public BrAPIListItemsListResponse searchGermplasmByList(String listDbId, UUID programId, GermplasmQuery germplasmQuery) throws ApiException { diff --git a/src/test/java/org/breedinginsight/services/BrAPIGermplasmServiceUnitTest.java b/src/test/java/org/breedinginsight/services/BrAPIGermplasmServiceUnitTest.java index 6795eb0bf..4211bb419 100644 --- a/src/test/java/org/breedinginsight/services/BrAPIGermplasmServiceUnitTest.java +++ b/src/test/java/org/breedinginsight/services/BrAPIGermplasmServiceUnitTest.java @@ -5,7 +5,6 @@ import io.reactivex.functions.Function; import io.reactivex.functions.Function3; import lombok.SneakyThrows; -import org.brapi.client.v2.model.queryParams.germplasm.GermplasmQueryParams; import org.brapi.v2.model.BrAPIExternalReference; import org.brapi.v2.model.core.BrAPIProgram; import org.brapi.v2.model.core.response.BrAPIListDetails; @@ -152,8 +151,8 @@ public void getGermplasmListExport() { when(programDAO.fetchOneById(any(UUID.class))).thenReturn(testProgram); when(programDAO.get(any(UUID.class))).thenReturn(Arrays.asList(testProgram)); when(programDAO.getProgramBrAPI(any())).thenReturn(brapiProgram); - when(brAPIDAOUtil.get(any(Function.class), - any(GermplasmQueryParams.class))).thenReturn(germplasm); + when(brAPIDAOUtil.search(any(Function.class), any(Function3.class), + any(BrAPIGermplasmSearchRequest.class))).thenReturn(germplasm); when(brAPIDAOUtil.getBrAPIProgramDbId(any())).thenReturn(brapiProgramDbId); //Create test instance of service, injecting spy- and mock-dependencies From 537afe2dfac83a3c2686b6251570931880b7ceb6 Mon Sep 17 00:00:00 2001 From: humsika Date: Mon, 26 Oct 2026 15:54:45 -0500 Subject: [PATCH 088/102] BI-3028: Added Unit test. --- .../v2/dao/BrAPIGermplasmDAOUnitTest.java | 111 ++++++++++++++++++ 1 file changed, 111 insertions(+) create mode 100644 src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAOUnitTest.java diff --git a/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAOUnitTest.java b/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAOUnitTest.java new file mode 100644 index 000000000..038fdbfaf --- /dev/null +++ b/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIGermplasmDAOUnitTest.java @@ -0,0 +1,111 @@ +/* + * See the NOTICE file distributed with this work for additional information + * regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.breedinginsight.brapi.v2.dao; + +import com.fasterxml.jackson.databind.ObjectMapper; +import io.reactivex.functions.Function; +import io.reactivex.functions.Function3; +import lombok.SneakyThrows; +import org.brapi.client.v2.BrAPIClient; +import org.brapi.client.v2.model.queryParams.germplasm.GermplasmQueryParams; +import org.brapi.v2.model.germ.BrAPIGermplasm; +import org.brapi.v2.model.germ.request.BrAPIGermplasmSearchRequest; +import org.breedinginsight.brapps.importer.daos.ImportDAO; +import org.breedinginsight.daos.ProgramDAO; +import org.breedinginsight.model.Program; +import org.breedinginsight.services.brapi.BrAPIEndpointProvider; +import org.breedinginsight.utilities.BrAPIDAOUtil; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.mockito.ArgumentCaptor; + +import java.util.List; +import java.util.UUID; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.*; + +public class BrAPIGermplasmDAOUnitTest { + + private static final String BRAPI_PROGRAM_DB_ID = "brapi-program-1"; + + private BrAPIGermplasmDAO germplasmDAO; + private BrAPIDAOUtil brAPIDAOUtil; + private Program program; + + @BeforeEach + @SneakyThrows + void setup() { + UUID programId = UUID.randomUUID(); + + program = new Program(); + program.setId(programId); + program.setKey("TEST"); + + ProgramDAO programDAO = mock(ProgramDAO.class); + brAPIDAOUtil = mock(BrAPIDAOUtil.class); + + when(programDAO.fetchOneById(programId)).thenReturn(program); + when(programDAO.getCoreClient(programId)).thenReturn(mock(BrAPIClient.class)); + when(brAPIDAOUtil.getBrAPIProgramDbId(programId)).thenReturn(BRAPI_PROGRAM_DB_ID); + + germplasmDAO = new BrAPIGermplasmDAO(programDAO, mock(ImportDAO.class), + brAPIDAOUtil, + new BrAPIEndpointProvider(), + 65000, + new ObjectMapper(), + mock(BrAPIListDAO.class) + ); + } + + @Test + @SneakyThrows + void getGermplasmByRawNameUsesBrAPISearch() { + List germplasmNames = List.of("Germplasm A [TEST-1]", "Germplasm B [TEST-2]"); + + BrAPIGermplasm germplasm = new BrAPIGermplasm(); + germplasm.setGermplasmName("Germplasm A [TEST-1]"); + germplasm.setDefaultDisplayName("Germplasm A"); + germplasm.setAccessionNumber("1"); + when(brAPIDAOUtil.search(any(Function.class), any(Function3.class), any(BrAPIGermplasmSearchRequest.class))).thenReturn(List.of(germplasm)); + + List result = germplasmDAO.getGermplasmByRawName(germplasmNames, program.getId()); + + ArgumentCaptor requestCaptor = ArgumentCaptor.forClass(BrAPIGermplasmSearchRequest.class); + + verify(brAPIDAOUtil).search(any(Function.class), any(Function3.class), requestCaptor.capture()); + verify(brAPIDAOUtil, never()).get(any(Function.class), any(GermplasmQueryParams.class)); + + BrAPIGermplasmSearchRequest request = requestCaptor.getValue(); + + assertEquals(List.of(BRAPI_PROGRAM_DB_ID), request.getProgramDbIds()); + assertEquals(germplasmNames, request.getGermplasmNames()); + + assertEquals(1, result.size()); + assertEquals("Germplasm A", result.get(0).getGermplasmName()); + } + + @Test + @SneakyThrows + void getGermplasmByRawNameWithEmptyNamesDoesNotSearch() { + assertTrue(germplasmDAO.getGermplasmByRawName(List.of(), program.getId()).isEmpty()); + + verify(brAPIDAOUtil, never()).search(any(Function.class), any(Function3.class), any(BrAPIGermplasmSearchRequest.class)); + } +} From 86b6c19b780c9dd592c08f4083a83b675ea86865 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Mon, 26 Oct 2026 22:08:12 -0400 Subject: [PATCH 089/102] Create obs vars with brapi programDbId, fetch using brapi id --- .../daos/impl/TraitDAOImpl.java | 21 +++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/src/main/java/org/breedinginsight/daos/impl/TraitDAOImpl.java b/src/main/java/org/breedinginsight/daos/impl/TraitDAOImpl.java index 618d1239d..544a70510 100644 --- a/src/main/java/org/breedinginsight/daos/impl/TraitDAOImpl.java +++ b/src/main/java/org/breedinginsight/daos/impl/TraitDAOImpl.java @@ -165,9 +165,17 @@ private List fetchTraitsFullByProgramId(UUID programId) { return new ArrayList<>(); } + String brapiProgramDbId; + + try { + brapiProgramDbId = brAPIDAOUtil.getBrAPIProgramDbId(programId); + } catch (ApiException e) { + throw new InternalServerException(String.format("While fetching traits, unable to retrieve brapi programDbId using bi program ID [%s]", programId), e); + } + // Get brapi variables VariableQueryParams variablesRequest = new VariableQueryParams(); - variablesRequest.externalReferenceSource(referenceSource); + variablesRequest.programDbId(brapiProgramDbId); variablesRequest.pageSize(10000); ApiResponse brApiVariables; @@ -354,6 +362,14 @@ public List createTraitsBrAPI(List traits, User actingUser, Progra //TODO: Pass ontology reference + String brapiProgramDbId; + + try { + brapiProgramDbId = brAPIDAOUtil.getBrAPIProgramDbId(program.getId()); + } catch (ApiException e) { + throw new InternalServerException(String.format("While creating traits, unable to fetch brapi programDbId using bi program with id [%s]", program.getId()), e); + } + // Convert our traits into BrAPI traits List brApiVariables = new ArrayList<>(); for (Trait trait: traits) { @@ -419,7 +435,8 @@ public List createTraitsBrAPI(List traits, User actingUser, Progra .defaultValue(trait.getDefaultValue()) .synonyms(trait.getSynonyms()) .institution(program.getName()) - .commonCropName(program.getSpecies().getCommonName()); + .commonCropName(program.getSpecies().getCommonName()) + .programDbId(brapiProgramDbId); if (trait.getTags() != null) brApiVariable.putAdditionalInfoItem(TAGS_KEY, trait.getTags()); if (trait.getFullName() != null) brApiVariable.putAdditionalInfoItem(FULLNAME_KEY, trait.getFullName()); From ac08461dbf4fbdb47d34d5333a7a4729ffb07a4f Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Wed, 28 Oct 2026 14:55:34 -0400 Subject: [PATCH 090/102] Remove cache.get() in TraitDAOImpl For one use case, I implemented a search for a single trait via exref --- .../daos/impl/TraitDAOImpl.java | 71 ++++++++++++++----- .../TraitUploadControllerIntegrationTest.java | 8 +-- 2 files changed, 55 insertions(+), 24 deletions(-) diff --git a/src/main/java/org/breedinginsight/daos/impl/TraitDAOImpl.java b/src/main/java/org/breedinginsight/daos/impl/TraitDAOImpl.java index 544a70510..5c4a2bafc 100644 --- a/src/main/java/org/breedinginsight/daos/impl/TraitDAOImpl.java +++ b/src/main/java/org/breedinginsight/daos/impl/TraitDAOImpl.java @@ -34,6 +34,7 @@ import org.brapi.v2.model.pheno.*; import org.brapi.v2.model.pheno.request.BrAPIObservationVariableSearchRequest; import org.brapi.v2.model.pheno.response.BrAPIObservationVariableListResponse; +import org.brapi.v2.model.pheno.response.BrAPIObservationVariableListResponseResult; import org.brapi.v2.model.pheno.response.BrAPIObservationVariableSingleResponse; import org.breedinginsight.brapps.importer.services.ExternalReferenceSource; import org.breedinginsight.dao.db.tables.BiUserTable; @@ -61,7 +62,6 @@ import java.util.stream.Stream; import static org.breedinginsight.dao.db.Tables.*; -import static org.jooq.impl.DSL.lower; @Singleton @Slf4j @@ -143,15 +143,7 @@ public List getTraitsFullByProgramId(UUID programId) { public List getTraitsFullByProgramIds(List programIds) { List saturatedTraits = new ArrayList<>(); for(UUID id : programIds) { - Map programTraits = null; - try { - programTraits = cache.get(id); - } catch (ApiException e) { - throw new RuntimeException(e); - } - if(programTraits != null) { - saturatedTraits.addAll(programTraits.values()); - } + saturatedTraits.addAll(fetchTraitsFullByProgramId(id)); } return saturatedTraits; @@ -175,8 +167,8 @@ private List fetchTraitsFullByProgramId(UUID programId) { // Get brapi variables VariableQueryParams variablesRequest = new VariableQueryParams(); - variablesRequest.programDbId(brapiProgramDbId); - variablesRequest.pageSize(10000); + variablesRequest.externalReferenceSource(referenceSource) + .pageSize(10000); ApiResponse brApiVariables; try { @@ -215,6 +207,53 @@ private List fetchTraitsFullByProgramId(UUID programId) { return saturatedTraits; } + private Trait fetchTraitFullByBiTraitAndProgramId(UUID traitId, UUID programId) { + // Get our db trait (equivalent to brapi variables) + Optional biTraitOpt = getTrait(programId, traitId); + if (biTraitOpt.isEmpty()) { + throw new InternalServerException(String.format("Unable to find BI trait with id [%s]", traitId)); + } + + Trait trait = biTraitOpt.get(); + + String brapiProgramDbId; + + try { + brapiProgramDbId = brAPIDAOUtil.getBrAPIProgramDbId(programId); + } catch (ApiException e) { + throw new InternalServerException(String.format("While fetching an individual trait in full, unable to retrieve brapi programDbId using bi program ID [%s]", programId), e); + } + + // Get brapi variables + VariableQueryParams variablesRequest = new VariableQueryParams(); + variablesRequest.programDbId(brapiProgramDbId); + variablesRequest.pageSize(1); + + variablesRequest.setExternalReferenceId(traitId.toString()); + variablesRequest.externalReferenceSource(referenceSource); + + ApiResponse brApiVariables = null; + BrAPIObservationVariable brAPIObservationVariable; + try { + brApiVariables = brAPIEndpointProvider.get(programDAO.getCoreClient(programId), ObservationVariablesApi.class) + .variablesGet(variablesRequest); + } catch (ApiException e) { + log.warn(Utilities.generateApiExceptionLogMessage(e)); + throw new InternalServerException("Error making BrAPI call", e); + } finally { + brAPIObservationVariable = Optional.ofNullable(brApiVariables) + .map(ApiResponse::getBody) + .map(BrAPIObservationVariableListResponse::getResult) + .map(BrAPIObservationVariableListResponseResult::getData) + .orElseThrow() + .get(0); + } + + saturateTrait(trait, brAPIObservationVariable); + + return trait; + } + @Override public List getTraitsByProgramId(UUID programId) { return getTraitsByProgramIds(programId); @@ -260,13 +299,7 @@ public List getTraitsById(UUID... traitIds){ @Override public Optional getTraitFull(UUID programId, UUID traitId){ - - try { - return Optional.ofNullable(cache.get(programId).get(traitId.toString())); - } catch (ApiException e) { - log.warn(Utilities.generateApiExceptionLogMessage(e)); - throw new InternalServerException("Error making BrAPI call", e); - } + return Optional.of(fetchTraitFullByBiTraitAndProgramId(traitId, programId)); } // could be more efficient to do a single get instead of search in saved search case but less code this way diff --git a/src/test/java/org/breedinginsight/api/v1/controller/TraitUploadControllerIntegrationTest.java b/src/test/java/org/breedinginsight/api/v1/controller/TraitUploadControllerIntegrationTest.java index 01a478bdf..1679da0fc 100644 --- a/src/test/java/org/breedinginsight/api/v1/controller/TraitUploadControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/api/v1/controller/TraitUploadControllerIntegrationTest.java @@ -30,18 +30,16 @@ import io.reactivex.Flowable; import junit.framework.AssertionFailedError; import org.breedinginsight.BrAPITest; -import org.breedinginsight.DatabaseTest; import org.breedinginsight.TestUtils; import org.breedinginsight.api.model.v1.request.ProgramRequest; import org.breedinginsight.api.model.v1.request.SpeciesRequest; import org.breedinginsight.api.model.v1.request.query.FilterRequest; import org.breedinginsight.api.model.v1.request.query.SearchRequest; import org.breedinginsight.api.v1.controller.metadata.SortOrder; +import org.breedinginsight.brapi.v2.dao.BrAPIProgramDAO; import org.breedinginsight.dao.db.enums.DataType; import org.breedinginsight.dao.db.enums.TermType; import org.breedinginsight.dao.db.tables.daos.ProgramDao; -import org.breedinginsight.dao.db.tables.pojos.BiUserEntity; -import org.breedinginsight.dao.db.tables.pojos.ProgramEntity; import org.breedinginsight.daos.TraitDAO; import org.breedinginsight.daos.UserDAO; import org.breedinginsight.model.Program; @@ -59,7 +57,6 @@ import java.util.stream.Collectors; import static io.micronaut.http.HttpRequest.*; -import static org.breedinginsight.TestUtils.insertAndFetchTestProgram; import static org.junit.jupiter.api.Assertions.*; @MicronautTest @@ -79,6 +76,8 @@ public class TraitUploadControllerIntegrationTest extends BrAPITest { private TraitDAO traitDAO; @Inject private SpeciesService speciesService; + @Inject + private BrAPIProgramDAO programDAO; private Species validSpecies; @@ -135,7 +134,6 @@ public void setup() { //dsl.execute(fp.get("InsertProgramOntology")); dsl.execute(fp.get("InsertMethod")); dsl.execute(fp.get("InsertScale")); - dsl.execute(fp.get("InsertTrait")); } From 3c7a06c64da4266e6c0ac217efff62ecabc19aa5 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Thu, 29 Oct 2026 09:53:41 -0400 Subject: [PATCH 091/102] Fix revert back to reference_source --- src/main/java/org/breedinginsight/daos/impl/TraitDAOImpl.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/main/java/org/breedinginsight/daos/impl/TraitDAOImpl.java b/src/main/java/org/breedinginsight/daos/impl/TraitDAOImpl.java index 5c4a2bafc..eff783a44 100644 --- a/src/main/java/org/breedinginsight/daos/impl/TraitDAOImpl.java +++ b/src/main/java/org/breedinginsight/daos/impl/TraitDAOImpl.java @@ -167,8 +167,8 @@ private List fetchTraitsFullByProgramId(UUID programId) { // Get brapi variables VariableQueryParams variablesRequest = new VariableQueryParams(); - variablesRequest.externalReferenceSource(referenceSource) - .pageSize(10000); + variablesRequest.programDbId(brapiProgramDbId); + variablesRequest.pageSize(10000); ApiResponse brApiVariables; try { From e00c5aadb2a9a923599f1e1c15bbd70085924ea6 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Thu, 29 Oct 2026 13:53:10 -0400 Subject: [PATCH 092/102] Preliminary exref swapping work on traits and observation variable dbIds --- .../BrAPIObservationVariableController.java | 18 +++-------------- .../brapi/v2/dao/BrAPIObservationDAO.java | 18 ----------------- .../v2/dao/BrAPIObservationVariableDAO.java | 16 +++++++++++++++ .../BrAPIObservationVariableService.java | 20 +++++++++++++++---- 4 files changed, 35 insertions(+), 37 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationVariableController.java b/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationVariableController.java index 9727ad1be..fb183b706 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationVariableController.java +++ b/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationVariableController.java @@ -150,27 +150,15 @@ public HttpResponse variablesGet(@PathVari public HttpResponse variablesObservationVariableDbIdGet(@PathVariable("programId") UUID programId, @PathVariable("observationVariableDbId") String observationVariableDbId) { log.debug("fetching variable: " + observationVariableDbId); - UUID traitId; - try { - traitId = UUID.fromString(observationVariableDbId); - } catch (IllegalArgumentException e) { - return HttpResponse.notFound(); - } try { - Optional trait = traitService.getById(programId, traitId); - - if(trait.isEmpty()) { - return HttpResponse.notFound(); - } - - BrAPIObservationVariableSingleResponse response = new BrAPIObservationVariableSingleResponse() - .metadata(new BrAPIMetadata()) - .result(observationVariableService.convertToBrAPI(trait.get())); + BrAPIObservationVariableSingleResponse response = observationVariableService.getBrAPIObservationVariableByDbId(observationVariableDbId, programId); return HttpResponse.ok(response); } catch (DoesNotExistException e) { return HttpResponse.notFound(); + } catch (ApiException e) { + return HttpResponse.status(HttpStatus.INTERNAL_SERVER_ERROR, "error fetching variables"); } } diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java index 0ca219012..3f176028d 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java @@ -98,15 +98,6 @@ private void processObservations(String programKey, List obser } } - private List getProgramObservations(UUID programId) throws ApiException { - Program program = programDAO.get(programId) - .stream() - .findFirst() - .orElseThrow(); - - return getBrAPIObservationsUsingBrAPIProgramId(program); - } - public List getObservationsByStudyName(List studyNames, Program program) throws ApiException { if(studyNames.isEmpty()) { return Collections.emptyList(); @@ -220,15 +211,6 @@ public BrAPIObservationListResponse getObservationsByFilters(Program program, St List observations = brAPIDAOUtil.getListResult(brAPIResponse); processObservations(program.getKey(), observations); - // TODO: Investigate if this resetting of the observationVariableDbId can be undone when trait exrefs are examined [BI-2925] - HashMap traitIdsByObservationVariableDbId = traitService.getIdsByObservationVariableDbIds( - program.getId(), observations.stream() - .map(BrAPIObservation::getObservationVariableDbId).collect(Collectors.toList())); - - observations.forEach(observation -> observation - .setObservationVariableDbId(traitIdsByObservationVariableDbId.get(observation.getObservationVariableDbId()))); - brAPIResponse.getResult().setData(observations); - return brAPIResponse; } diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationVariableDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationVariableDAO.java index 0de5c19ed..892a73cbf 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationVariableDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationVariableDAO.java @@ -16,10 +16,14 @@ */ package org.breedinginsight.brapi.v2.dao; +import io.micronaut.http.server.exceptions.InternalServerException; +import org.brapi.client.v2.ApiResponse; import org.brapi.client.v2.model.exceptions.ApiException; +import org.brapi.client.v2.model.queryParams.phenotype.VariableQueryParams; import org.brapi.client.v2.modules.phenotype.ObservationVariablesApi; import org.brapi.v2.model.pheno.BrAPIObservationVariable; import org.brapi.v2.model.pheno.request.BrAPIObservationVariableSearchRequest; +import org.brapi.v2.model.pheno.response.BrAPIObservationVariableSingleResponse; import org.breedinginsight.daos.ProgramDAO; import org.breedinginsight.services.brapi.BrAPIEndpointProvider; import org.breedinginsight.utilities.BrAPIDAOUtil; @@ -59,4 +63,16 @@ public List getVariableByName(List variableNam ); } + public BrAPIObservationVariableSingleResponse getVariableByIdWithResponse(String observationVariableDbId, UUID programId) throws ApiException { + ObservationVariablesApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(programId), ObservationVariablesApi.class); + + ApiResponse apiResponse = api.variablesObservationVariableDbIdGet(observationVariableDbId); + + if (apiResponse.getBody() != null && apiResponse.getStatusCode() == 200) { + return apiResponse.getBody(); + } + + throw new InternalServerException(String.format("Unable to retrieve BrAPI Observation Variable using id [%s] for BI Program with id: [%s]", observationVariableDbId, programId)); + } + } diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java index 4b579c0f1..da9f1ba2e 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java @@ -25,7 +25,9 @@ import org.brapi.v2.model.core.BrAPIStudy; import org.brapi.v2.model.core.BrAPITrial; import org.brapi.v2.model.pheno.*; +import org.brapi.v2.model.pheno.response.BrAPIObservationVariableSingleResponse; import org.breedinginsight.brapi.v2.constants.BrAPIAdditionalInfoFields; +import org.breedinginsight.brapi.v2.dao.BrAPIObservationVariableDAO; import org.breedinginsight.model.Program; import org.breedinginsight.model.Trait; import org.breedinginsight.services.ProgramService; @@ -43,12 +45,14 @@ public class BrAPIObservationVariableService { private final ProgramService programService; private final BrAPITrialService trialService; + private final BrAPIObservationVariableDAO observationVariableDAO; @Inject public BrAPIObservationVariableService( - ProgramService programService, BrAPITrialService trialService){ + ProgramService programService, BrAPITrialService trialService, BrAPIObservationVariableDAO observationVariableDAO){ this.programService = programService; this.trialService = trialService; + this.observationVariableDAO = observationVariableDAO; } // TODO: support sub-entity datasets. @@ -115,8 +119,7 @@ public List filterVariables(List programTraits, Map, String>> filterParams = new HashMap<>(); filterParams.put("observationVariableDbId", Pair.of(observationVariableDbId, - trait.getId() - .toString())); + trait.getObservationVariableDbId())); filterParams.put("observationVariableName", Pair.of(observationVariableName, trait.getObservationVariableName())); filterParams.put("traitClass", Pair.of(traitClass, trait.getTraitClass())); filterParams.put("methodDbId", @@ -171,7 +174,7 @@ public BrAPIObservationVariable convertToBrAPI(Trait trait) { .toString()); String status = trait.getActive() ? "active" : "inactive"; List synonyms = prepSynonyms(trait); - return new BrAPIObservationVariable().observationVariableDbId(trait.getId().toString()) + return new BrAPIObservationVariable().observationVariableDbId(trait.getObservationVariableDbId()) .observationVariableName(trait.getObservationVariableName()) .defaultValue(trait.getDefaultValue()) .status(status) @@ -227,4 +230,13 @@ private List prepSynonyms(Trait trait) { } return preppedSynonyms; } + + public BrAPIObservationVariableSingleResponse getBrAPIObservationVariableByDbId(String observationVariableDbId, UUID programId) throws ApiException, DoesNotExistException { + + if (!programService.exists(programId)) { + throw new DoesNotExistException("Program does not exist"); + } + + return observationVariableDAO.getVariableByIdWithResponse(observationVariableDbId, programId); + } } From f38827e0881be938178c5fb8546ed088c62eba0e Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Thu, 29 Oct 2026 16:39:36 -0400 Subject: [PATCH 093/102] Fix unit test failures, add processing for ObservationVariables to strip keys --- .../v2/dao/BrAPIObservationVariableDAO.java | 24 +++++++++++++++---- .../BrAPIObservationVariableService.java | 5 +++- ...tionVariableControllerIntegrationTest.java | 12 +++++++--- .../v2/dao/BrAPIObservationDAOUnitTest.java | 2 +- 4 files changed, 34 insertions(+), 9 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationVariableDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationVariableDAO.java index 892a73cbf..2e904777e 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationVariableDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationVariableDAO.java @@ -25,8 +25,10 @@ import org.brapi.v2.model.pheno.request.BrAPIObservationVariableSearchRequest; import org.brapi.v2.model.pheno.response.BrAPIObservationVariableSingleResponse; import org.breedinginsight.daos.ProgramDAO; +import org.breedinginsight.model.Program; import org.breedinginsight.services.brapi.BrAPIEndpointProvider; import org.breedinginsight.utilities.BrAPIDAOUtil; +import org.breedinginsight.utilities.Utilities; import javax.inject.Inject; import javax.inject.Singleton; @@ -63,16 +65,30 @@ public List getVariableByName(List variableNam ); } - public BrAPIObservationVariableSingleResponse getVariableByIdWithResponse(String observationVariableDbId, UUID programId) throws ApiException { - ObservationVariablesApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(programId), ObservationVariablesApi.class); + public BrAPIObservationVariableSingleResponse getVariableByIdWithResponse(String observationVariableDbId, Program program) throws ApiException { + ObservationVariablesApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(program.getId()), ObservationVariablesApi.class); ApiResponse apiResponse = api.variablesObservationVariableDbIdGet(observationVariableDbId); - if (apiResponse.getBody() != null && apiResponse.getStatusCode() == 200) { + if (apiResponse.getBody() != null && apiResponse.getBody().getResult() != null && apiResponse.getStatusCode() == 200) { + BrAPIObservationVariable returnedObsVar = apiResponse.getBody().getResult(); + + processObservationVariables(List.of(returnedObsVar), program); + return apiResponse.getBody(); } - throw new InternalServerException(String.format("Unable to retrieve BrAPI Observation Variable using id [%s] for BI Program with id: [%s]", observationVariableDbId, programId)); + throw new InternalServerException(String.format("Unable to retrieve BrAPI Observation Variable using id [%s] for BI Program with id: [%s]", observationVariableDbId, program.getId())); + } + + private void processObservationVariables(List observationVariables, Program program) { + observationVariables.forEach(observationVariable -> { + observationVariable.setObservationVariableName(Utilities.removeProgramKey(observationVariable.getObservationVariableName(), program.getKey())); + + if (observationVariable.getScale() != null && observationVariable.getScale().getScaleName() != null) { + observationVariable.getScale().setScaleName(Utilities.removeProgramKey(observationVariable.getScale().getScaleName(), program.getKey())); + } + }); } } diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java index da9f1ba2e..eb0470e12 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java @@ -237,6 +237,9 @@ public BrAPIObservationVariableSingleResponse getBrAPIObservationVariableByDbId( throw new DoesNotExistException("Program does not exist"); } - return observationVariableDAO.getVariableByIdWithResponse(observationVariableDbId, programId); + // We know the program exists as of check above + Program program = programService.getById(programId).get(); + + return observationVariableDAO.getVariableByIdWithResponse(observationVariableDbId, program); } } diff --git a/src/test/java/org/breedinginsight/brapi/v2/BrAPIV2ObservationVariableControllerIntegrationTest.java b/src/test/java/org/breedinginsight/brapi/v2/BrAPIV2ObservationVariableControllerIntegrationTest.java index 36f739c6d..9f4419bee 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/BrAPIV2ObservationVariableControllerIntegrationTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/BrAPIV2ObservationVariableControllerIntegrationTest.java @@ -161,12 +161,17 @@ void setup() throws Exception { traits = createTraits(4); AuthenticatedUser user = new AuthenticatedUser(testUser.getName(), new ArrayList<>(), testUser.getId(), new ArrayList<>()); try { - ontologyService.createTraits(program.getId(), traits, user, false); + // Re-assign to get obtain all brapi related data as well + traits = ontologyService.createTraits(program.getId(), traits, user, false); } catch (ValidatorException e) { System.err.println(e.getErrors()); throw e; } + // Re-assignment returns the data in an indeterminate order. Sort on variable name, which should be determinate. + // Tests below depend on the order being correct. + traits.sort(Comparator.comparing(Trait::getObservationVariableName)); + // Add germplasm to program List germplasm = createGermplasm(1, brapiProgramDbId); BrAPIExternalReference newReference = new BrAPIExternalReference(); @@ -305,7 +310,7 @@ public void testGetVariablesByExpId() { @Test public void testGetVariableById() { Flowable> call = client.exchange( - GET(String.format("/programs/%s/brapi/v2/variables/%s", program.getId(), traits.get(0).getId())) + GET(String.format("/programs/%s/brapi/v2/variables/%s", program.getId(), traits.get(0).getObservationVariableDbId())) .bearerAuth("test-registered-user"), String.class ); @@ -316,7 +321,7 @@ public void testGetVariableById() { JsonObject responseObj = gson.fromJson(response.body(), JsonObject.class); JsonObject variable = responseObj.getAsJsonObject("result"); assertNotNull(variable); - assertEquals(traits.get(0).getId().toString(), variable.get("observationVariableDbId").getAsString()); + assertEquals(traits.get(0).getObservationVariableDbId(), variable.get("observationVariableDbId").getAsString()); assertEquals(traits.get(0).getObservationVariableName(), variable.get("observationVariableName").getAsString()); JsonObject trait = variable.getAsJsonObject("trait"); @@ -404,6 +409,7 @@ private List createTraits(int numToCreate) { String varName = "tt_test_" + (i + 1); traits.add(Trait.builder() .observationVariableName(varName) + .observationVariableDbId(UUID.randomUUID().toString()) .fullName(varName) .entity("Plant " + i) .attribute("height " + i) diff --git a/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAOUnitTest.java b/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAOUnitTest.java index 566fce142..ab4cbd794 100644 --- a/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAOUnitTest.java +++ b/src/test/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAOUnitTest.java @@ -269,6 +269,6 @@ void getObservationsByFiltersUsesBrAPISearchPagination() { assertEquals(List.of("study-1"), request.getStudyDbIds()); assertEquals(2, request.getPage()); assertEquals(25, request.getPageSize()); - assertEquals(traitId, result.getResult().getData().get(0).getObservationVariableDbId()); + assertEquals(brapiVariableDbId, result.getResult().getData().get(0).getObservationVariableDbId()); } } \ No newline at end of file From d453287bd8969f8ffe0158ae7e5f4edf97c74241 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Thu, 29 Oct 2026 17:16:41 -0400 Subject: [PATCH 094/102] Remove programKeys from other observation variable attributes --- .../brapi/v2/dao/BrAPIObservationVariableDAO.java | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationVariableDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationVariableDAO.java index 2e904777e..617ea05a4 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationVariableDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationVariableDAO.java @@ -88,6 +88,14 @@ private void processObservationVariables(List observat if (observationVariable.getScale() != null && observationVariable.getScale().getScaleName() != null) { observationVariable.getScale().setScaleName(Utilities.removeProgramKey(observationVariable.getScale().getScaleName(), program.getKey())); } + + if (observationVariable.getMethod() != null && observationVariable.getMethod().getMethodName() != null) { + observationVariable.getMethod().setMethodName(Utilities.removeProgramKey(observationVariable.getMethod().getMethodName(), program.getKey())); + } + + if (observationVariable.getTrait() != null && observationVariable.getTrait().getTraitName() != null) { + observationVariable.getTrait().setTraitName(Utilities.removeProgramKey(observationVariable.getTrait().getTraitName(), program.getKey())); + } }); } From 240536b13a9823bbc96133e244c570eb543c3e34 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Mon, 2 Nov 2026 12:36:44 -0500 Subject: [PATCH 095/102] Throw DoesNotExist, reuse and update getBrapiVariable method --- .../org/breedinginsight/daos/TraitDAO.java | 3 +- .../daos/impl/TraitDAOImpl.java | 38 ++++++++----------- 2 files changed, 18 insertions(+), 23 deletions(-) diff --git a/src/main/java/org/breedinginsight/daos/TraitDAO.java b/src/main/java/org/breedinginsight/daos/TraitDAO.java index 4a14f94f0..a80e8ad1f 100644 --- a/src/main/java/org/breedinginsight/daos/TraitDAO.java +++ b/src/main/java/org/breedinginsight/daos/TraitDAO.java @@ -7,6 +7,7 @@ import org.breedinginsight.model.Program; import org.breedinginsight.model.Trait; import org.breedinginsight.model.User; +import org.breedinginsight.services.exceptions.DoesNotExistException; import org.jooq.DAO; import java.util.List; @@ -24,7 +25,7 @@ public interface TraitDAO extends DAO { List getTraitsById(UUID... traitIds); - Optional getTraitFull(UUID programId, UUID traitId); + Optional getTraitFull(UUID programId, UUID traitId) throws DoesNotExistException; // could be more efficient to do a single get instead of search in saved search case but less code this way // and search stuff is working in breedbase diff --git a/src/main/java/org/breedinginsight/daos/impl/TraitDAOImpl.java b/src/main/java/org/breedinginsight/daos/impl/TraitDAOImpl.java index eff783a44..b9c317db2 100644 --- a/src/main/java/org/breedinginsight/daos/impl/TraitDAOImpl.java +++ b/src/main/java/org/breedinginsight/daos/impl/TraitDAOImpl.java @@ -49,6 +49,7 @@ import org.breedinginsight.model.User; import org.breedinginsight.services.brapi.BrAPIEndpointProvider; import org.breedinginsight.services.brapi.BrAPIProvider; +import org.breedinginsight.services.exceptions.DoesNotExistException; import org.breedinginsight.utilities.BrAPIDAOUtil; import org.breedinginsight.utilities.Utilities; import org.jooq.*; @@ -207,11 +208,11 @@ private List fetchTraitsFullByProgramId(UUID programId) { return saturatedTraits; } - private Trait fetchTraitFullByBiTraitAndProgramId(UUID traitId, UUID programId) { + private Trait fetchTraitFullByBiTraitAndProgramId(UUID traitId, UUID programId) throws DoesNotExistException { // Get our db trait (equivalent to brapi variables) Optional biTraitOpt = getTrait(programId, traitId); if (biTraitOpt.isEmpty()) { - throw new InternalServerException(String.format("Unable to find BI trait with id [%s]", traitId)); + throw new DoesNotExistException(String.format("Unable to find BI trait with id [%s]", traitId)); } Trait trait = biTraitOpt.get(); @@ -232,22 +233,9 @@ private Trait fetchTraitFullByBiTraitAndProgramId(UUID traitId, UUID programId) variablesRequest.setExternalReferenceId(traitId.toString()); variablesRequest.externalReferenceSource(referenceSource); - ApiResponse brApiVariables = null; - BrAPIObservationVariable brAPIObservationVariable; - try { - brApiVariables = brAPIEndpointProvider.get(programDAO.getCoreClient(programId), ObservationVariablesApi.class) - .variablesGet(variablesRequest); - } catch (ApiException e) { - log.warn(Utilities.generateApiExceptionLogMessage(e)); - throw new InternalServerException("Error making BrAPI call", e); - } finally { - brAPIObservationVariable = Optional.ofNullable(brApiVariables) - .map(ApiResponse::getBody) - .map(BrAPIObservationVariableListResponse::getResult) - .map(BrAPIObservationVariableListResponseResult::getData) - .orElseThrow() - .get(0); - } + ObservationVariablesApi variablesApi = brAPIEndpointProvider.get(programDAO.getCoreClient(programId), ObservationVariablesApi.class); + + BrAPIObservationVariable brAPIObservationVariable = getBrAPIVariable(variablesApi, traitId, programId); saturateTrait(trait, brAPIObservationVariable); @@ -298,7 +286,7 @@ public List getTraitsById(UUID... traitIds){ } @Override - public Optional getTraitFull(UUID programId, UUID traitId){ + public Optional getTraitFull(UUID programId, UUID traitId) throws DoesNotExistException { return Optional.of(fetchTraitFullByBiTraitAndProgramId(traitId, programId)); } @@ -534,7 +522,7 @@ public Trait updateTraitBrAPI(Trait trait, Program program) { List variablesAPIS = brAPIProvider.getAllUniqueVariablesAPI(); for (ObservationVariablesApi variablesAPI: variablesAPIS){ // GET brapi trait - BrAPIObservationVariable existingVariable = getBrAPIVariable(variablesAPI, trait.getId()); + BrAPIObservationVariable existingVariable = getBrAPIVariable(variablesAPI, trait.getId(), program.getId()); // Change method existingVariable.getMethod().setMethodName(constructMethodName(trait, program)); @@ -594,11 +582,17 @@ private String constructMethodName(Trait trait, Program program) { String.format("%s [%s]", trait.getMethod().getMethodClass(), program.getKey()); } - private BrAPIObservationVariable getBrAPIVariable(ObservationVariablesApi variablesAPI, UUID traitId) { + private BrAPIObservationVariable getBrAPIVariable(ObservationVariablesApi variablesAPI, + UUID traitId, + UUID biProgramId) { BrAPIObservationVariable existingVariable; try { - VariableQueryParams queryParams = new VariableQueryParams(); + + String brapiProgramDbId = brAPIDAOUtil.getBrAPIProgramDbId(biProgramId); + + VariableQueryParams queryParams = new VariableQueryParams() + .programDbId(brapiProgramDbId); queryParams.externalReferenceID(traitId.toString()); queryParams.externalReferenceSource(referenceSource); ApiResponse existingVariableResponse = From 6036dc510d9c2f9971c96a4cdccfcb8b82ca9c26 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Mon, 2 Nov 2026 17:42:06 -0500 Subject: [PATCH 096/102] Address 404 use cases, fix program key stripping --- .../v2/dao/BrAPIObservationVariableDAO.java | 32 ++++++++++++++----- .../BrAPIObservationVariableService.java | 11 +++++-- 2 files changed, 32 insertions(+), 11 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationVariableDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationVariableDAO.java index 617ea05a4..47d9ad165 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationVariableDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationVariableDAO.java @@ -19,7 +19,6 @@ import io.micronaut.http.server.exceptions.InternalServerException; import org.brapi.client.v2.ApiResponse; import org.brapi.client.v2.model.exceptions.ApiException; -import org.brapi.client.v2.model.queryParams.phenotype.VariableQueryParams; import org.brapi.client.v2.modules.phenotype.ObservationVariablesApi; import org.brapi.v2.model.pheno.BrAPIObservationVariable; import org.brapi.v2.model.pheno.request.BrAPIObservationVariableSearchRequest; @@ -27,6 +26,7 @@ import org.breedinginsight.daos.ProgramDAO; import org.breedinginsight.model.Program; import org.breedinginsight.services.brapi.BrAPIEndpointProvider; +import org.breedinginsight.services.exceptions.DoesNotExistException; import org.breedinginsight.utilities.BrAPIDAOUtil; import org.breedinginsight.utilities.Utilities; @@ -65,25 +65,41 @@ public List getVariableByName(List variableNam ); } - public BrAPIObservationVariableSingleResponse getVariableByIdWithResponse(String observationVariableDbId, Program program) throws ApiException { + public BrAPIObservationVariableSingleResponse getVariableByIdWithResponse(String observationVariableDbId, Program program) throws DoesNotExistException { ObservationVariablesApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(program.getId()), ObservationVariablesApi.class); - ApiResponse apiResponse = api.variablesObservationVariableDbIdGet(observationVariableDbId); + try { + ApiResponse apiResponse = api.variablesObservationVariableDbIdGet(observationVariableDbId); - if (apiResponse.getBody() != null && apiResponse.getBody().getResult() != null && apiResponse.getStatusCode() == 200) { - BrAPIObservationVariable returnedObsVar = apiResponse.getBody().getResult(); + String brapiProgramDbId = brAPIDAOUtil.getBrAPIProgramDbId(program.getId()); - processObservationVariables(List.of(returnedObsVar), program); + if (apiResponse.getBody() != null && apiResponse.getBody().getResult() != null && apiResponse.getStatusCode() == 200) { + BrAPIObservationVariable returnedObsVar = apiResponse.getBody().getResult(); - return apiResponse.getBody(); + if (returnedObsVar.getProgramDbId() == null || !returnedObsVar.getProgramDbId().equals(brapiProgramDbId)) { + throw new DoesNotExistException(String.format("A observation variable with id [%s] was found but it does not belong to the submitted program with id: [%s]", observationVariableDbId, program.getId())); + } + + processObservationVariables(List.of(returnedObsVar), program); + + return apiResponse.getBody(); + } + } catch (ApiException e) { + if (e.getCode() >= 400 && e.getCode() < 500) { + throw new DoesNotExistException(String.format("Observation variable with brapi db id [%s] was not found for program [%s]", observationVariableDbId, program.getId())); + } } throw new InternalServerException(String.format("Unable to retrieve BrAPI Observation Variable using id [%s] for BI Program with id: [%s]", observationVariableDbId, program.getId())); } private void processObservationVariables(List observationVariables, Program program) { + observationVariables.forEach(observationVariable -> { - observationVariable.setObservationVariableName(Utilities.removeProgramKey(observationVariable.getObservationVariableName(), program.getKey())); + + if (observationVariable.getObservationVariableName() != null) { + observationVariable.setObservationVariableName(Utilities.removeProgramKey(observationVariable.getObservationVariableName(), program.getKey())); + } if (observationVariable.getScale() != null && observationVariable.getScale().getScaleName() != null) { observationVariable.getScale().setScaleName(Utilities.removeProgramKey(observationVariable.getScale().getScaleName(), program.getKey())); diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java index eb0470e12..1120c72de 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java @@ -30,6 +30,7 @@ import org.breedinginsight.brapi.v2.dao.BrAPIObservationVariableDAO; import org.breedinginsight.model.Program; import org.breedinginsight.model.Trait; +import org.breedinginsight.services.OntologyService; import org.breedinginsight.services.ProgramService; import org.breedinginsight.services.exceptions.DoesNotExistException; import org.breedinginsight.utilities.DatasetUtil; @@ -46,13 +47,15 @@ public class BrAPIObservationVariableService { private final ProgramService programService; private final BrAPITrialService trialService; private final BrAPIObservationVariableDAO observationVariableDAO; + private final OntologyService ontologyService; @Inject public BrAPIObservationVariableService( - ProgramService programService, BrAPITrialService trialService, BrAPIObservationVariableDAO observationVariableDAO){ + ProgramService programService, BrAPITrialService trialService, BrAPIObservationVariableDAO observationVariableDAO, OntologyService ontologyService){ this.programService = programService; this.trialService = trialService; this.observationVariableDAO = observationVariableDAO; + this.ontologyService = ontologyService; } // TODO: support sub-entity datasets. @@ -237,8 +240,10 @@ public BrAPIObservationVariableSingleResponse getBrAPIObservationVariableByDbId( throw new DoesNotExistException("Program does not exist"); } - // We know the program exists as of check above - Program program = programService.getById(programId).get(); + // This helper method retrieves the proper program that will be associated with the brapi observation variable that is being looked up. + UUID ontologyProgramLookupId = ontologyService.getSubscribedOntologyProgramId(programId); + + Program program = programService.getById(ontologyProgramLookupId).get(); return observationVariableDAO.getVariableByIdWithResponse(observationVariableDbId, program); } From d5be47a3c12783c92d2cb14e757253cde3407382 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Tue, 3 Nov 2026 12:45:26 -0500 Subject: [PATCH 097/102] Return brapiDbIds for rest of entities in BrAPIObservationVariableController GET endpoints --- .../services/BrAPIObservationVariableService.java | 15 ++++++--------- .../java/org/breedinginsight/model/Method.java | 5 +++++ .../java/org/breedinginsight/model/Scale.java | 5 +++++ .../java/org/breedinginsight/model/Trait.java | 6 ++++-- 4 files changed, 20 insertions(+), 11 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java index 1120c72de..66c4adde9 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java @@ -127,8 +127,7 @@ public List filterVariables(List programTraits, filterParams.put("traitClass", Pair.of(traitClass, trait.getTraitClass())); filterParams.put("methodDbId", Pair.of(methodDbId, - trait.getMethodId() - .toString())); + trait.getMethod().getBrapiMethodDbId())); filterParams.put("methodName", Pair.of(methodName, trait.getMethod() @@ -136,16 +135,14 @@ public List filterVariables(List programTraits, filterParams.put("scaleDbId", Pair.of(scaleDbId, trait.getScale() - .getId() - .toString())); + .getBrapiScaleDbId())); filterParams.put("scaleName", Pair.of(scaleName, trait.getScale() .getScaleName())); filterParams.put("traitDbId", Pair.of(traitDbId, - trait.getId() - .toString())); + trait.getBrapiTraitDbId())); filterParams.put("traitName", Pair.of(traitName, trait.getObservationVariableName())); filterParams.put("ontologyDbId", Pair.of(ontologyDbId, @@ -184,18 +181,18 @@ public BrAPIObservationVariable convertToBrAPI(Trait trait) { .synonyms(synonyms) .trait(new BrAPITrait().ontologyReference(brAPIOntologyReference) .traitName(trait.getObservationVariableName()) - .traitDbId(trait.getId().toString()) + .traitDbId(trait.getBrapiTraitDbId()) .entity(trait.getEntity()) .attribute(trait.getAttribute()) .status(status) .synonyms(synonyms)) .method(new BrAPIMethod().ontologyReference(brAPIOntologyReference) - .methodDbId(trait.getMethod().getId().toString()) + .methodDbId(trait.getMethod().getBrapiMethodDbId()) .methodClass(trait.getMethod().getMethodClass()) .description(trait.getMethod().getDescription()) .formula(trait.getMethod().getFormula())) .scale(new BrAPIScale().ontologyReference(brAPIOntologyReference) - .scaleDbId(trait.getScale().getId().toString()) + .scaleDbId(trait.getScale().getBrapiScaleDbId()) .scaleName(trait.getScale().getScaleName()) .dataType(BrAPITraitDataType.fromValue(trait.getScale().getDataType().getLiteral())) .decimalPlaces(trait.getScale().getDecimalPlaces()) diff --git a/src/main/java/org/breedinginsight/model/Method.java b/src/main/java/org/breedinginsight/model/Method.java index b300e96f5..4ce50dd90 100644 --- a/src/main/java/org/breedinginsight/model/Method.java +++ b/src/main/java/org/breedinginsight/model/Method.java @@ -17,6 +17,7 @@ package org.breedinginsight.model; +import com.fasterxml.jackson.annotation.JsonIgnore; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import io.micronaut.core.annotation.Introspected; import lombok.Getter; @@ -48,6 +49,9 @@ public class Method extends MethodEntity { private ProgramOntology programOntology; // BrAPI Properties + @JsonIgnore + // brapiMethodDbId is only used to convert the bi method id to brapiMethodDbId for the BrAPIObservationVariableController GET endpoints + private String brapiMethodDbId; private String methodClass; private String description; private String formula; @@ -76,5 +80,6 @@ public void setBrAPIProperties(BrAPIMethod brApiMethod){ this.setMethodClass(brApiMethod.getMethodClass()); this.setDescription(brApiMethod.getDescription()); this.setFormula(brApiMethod.getFormula()); + this.setBrapiMethodDbId(brApiMethod.getMethodDbId()); } } diff --git a/src/main/java/org/breedinginsight/model/Scale.java b/src/main/java/org/breedinginsight/model/Scale.java index b2458e80b..e504ce6c0 100644 --- a/src/main/java/org/breedinginsight/model/Scale.java +++ b/src/main/java/org/breedinginsight/model/Scale.java @@ -17,6 +17,7 @@ package org.breedinginsight.model; +import com.fasterxml.jackson.annotation.JsonIgnore; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import io.micronaut.core.annotation.Introspected; import lombok.Getter; @@ -50,6 +51,9 @@ public class Scale extends ScaleEntity { private ProgramOntology programOntology; // BrAPI properties + @JsonIgnore + // brapiScaleDbId is only used to convert the bi scale id to brapiScaleDbId for the BrAPIObservationVariableController GET endpoints + private String brapiScaleDbId; private Integer validValueMax; private Integer validValueMin; private Integer decimalPlaces; @@ -89,6 +93,7 @@ public void setBrAPIProperties(BrAPIScale brApiScale) { this.setValidValueMin(validValues.getMin()); this.setCategories(validValues.getCategories()); } + this.setBrapiScaleDbId(brApiScale.getScaleDbId()); } } diff --git a/src/main/java/org/breedinginsight/model/Trait.java b/src/main/java/org/breedinginsight/model/Trait.java index 0dae446bf..f476aac66 100644 --- a/src/main/java/org/breedinginsight/model/Trait.java +++ b/src/main/java/org/breedinginsight/model/Trait.java @@ -29,12 +29,10 @@ import lombok.experimental.SuperBuilder; import lombok.extern.jackson.Jacksonized; import org.brapi.v2.model.pheno.BrAPIObservationVariable; -import org.breedinginsight.api.deserializer.ArrayOfStringDeserializer; import org.breedinginsight.api.deserializer.ListOfStringDeserializer; import org.breedinginsight.dao.db.tables.pojos.TraitEntity; import org.jooq.Record; -import javax.validation.Valid; import java.util.List; import static org.breedinginsight.dao.db.Tables.TRAIT; @@ -64,6 +62,9 @@ public class Trait extends TraitEntity { // Properties from brapi private String observationVariableDbId; + // brapiTraitDbId is only used to convert the bi trait id to brapiTraitDbId for the BrAPIObservationVariableController GET endpoints + @JsonIgnore + private String brapiTraitDbId; private String traitClass; private String traitDescription; private String attribute; @@ -122,6 +123,7 @@ public void setBrAPIProperties(BrAPIObservationVariable brApiVariable) { this.setEntity(brApiVariable.getTrait().getEntity()); this.setMainAbbreviation(brApiVariable.getTrait().getMainAbbreviation()); this.setSynonyms(brApiVariable.getTrait().getSynonyms()); + this.setBrapiTraitDbId(brApiVariable.getTrait().getTraitDbId()); } this.setObservationVariableDbId(brApiVariable.getObservationVariableDbId()); this.setDefaultValue(brApiVariable.getDefaultValue()); From 9490d56e881b5f7b495bd12b8628453c8463eb8a Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Tue, 3 Nov 2026 14:14:31 -0500 Subject: [PATCH 098/102] Unify response data between single variableDbId get and general get --- .../BrAPIObservationVariableController.java | 20 ++++++-- .../v2/dao/BrAPIObservationVariableDAO.java | 50 ------------------- .../BrAPIObservationVariableService.java | 40 +++++++++------ 3 files changed, 43 insertions(+), 67 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationVariableController.java b/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationVariableController.java index fb183b706..ad1bed214 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationVariableController.java +++ b/src/main/java/org/breedinginsight/brapi/v2/BrAPIObservationVariableController.java @@ -150,15 +150,29 @@ public HttpResponse variablesGet(@PathVari public HttpResponse variablesObservationVariableDbIdGet(@PathVariable("programId") UUID programId, @PathVariable("observationVariableDbId") String observationVariableDbId) { log.debug("fetching variable: " + observationVariableDbId); + try { + // Check if submitted ID is valid UUID + UUID.fromString(observationVariableDbId); + } catch (IllegalArgumentException e) { + return HttpResponse.notFound(); + } try { - BrAPIObservationVariableSingleResponse response = observationVariableService.getBrAPIObservationVariableByDbId(observationVariableDbId, programId); + List programTraits = traitService.getByProgramId(programId, true); + + if(programTraits.isEmpty()) { + return HttpResponse.notFound(); + } + + BrAPIObservationVariable observationVariable = observationVariableService.filterVariableById(programTraits, observationVariableDbId); + + BrAPIObservationVariableSingleResponse response = new BrAPIObservationVariableSingleResponse() + .metadata(new BrAPIMetadata()) + .result(observationVariable); return HttpResponse.ok(response); } catch (DoesNotExistException e) { return HttpResponse.notFound(); - } catch (ApiException e) { - return HttpResponse.status(HttpStatus.INTERNAL_SERVER_ERROR, "error fetching variables"); } } diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationVariableDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationVariableDAO.java index 47d9ad165..87b2158ca 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationVariableDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationVariableDAO.java @@ -65,54 +65,4 @@ public List getVariableByName(List variableNam ); } - public BrAPIObservationVariableSingleResponse getVariableByIdWithResponse(String observationVariableDbId, Program program) throws DoesNotExistException { - ObservationVariablesApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(program.getId()), ObservationVariablesApi.class); - - try { - ApiResponse apiResponse = api.variablesObservationVariableDbIdGet(observationVariableDbId); - - String brapiProgramDbId = brAPIDAOUtil.getBrAPIProgramDbId(program.getId()); - - if (apiResponse.getBody() != null && apiResponse.getBody().getResult() != null && apiResponse.getStatusCode() == 200) { - BrAPIObservationVariable returnedObsVar = apiResponse.getBody().getResult(); - - if (returnedObsVar.getProgramDbId() == null || !returnedObsVar.getProgramDbId().equals(brapiProgramDbId)) { - throw new DoesNotExistException(String.format("A observation variable with id [%s] was found but it does not belong to the submitted program with id: [%s]", observationVariableDbId, program.getId())); - } - - processObservationVariables(List.of(returnedObsVar), program); - - return apiResponse.getBody(); - } - } catch (ApiException e) { - if (e.getCode() >= 400 && e.getCode() < 500) { - throw new DoesNotExistException(String.format("Observation variable with brapi db id [%s] was not found for program [%s]", observationVariableDbId, program.getId())); - } - } - - throw new InternalServerException(String.format("Unable to retrieve BrAPI Observation Variable using id [%s] for BI Program with id: [%s]", observationVariableDbId, program.getId())); - } - - private void processObservationVariables(List observationVariables, Program program) { - - observationVariables.forEach(observationVariable -> { - - if (observationVariable.getObservationVariableName() != null) { - observationVariable.setObservationVariableName(Utilities.removeProgramKey(observationVariable.getObservationVariableName(), program.getKey())); - } - - if (observationVariable.getScale() != null && observationVariable.getScale().getScaleName() != null) { - observationVariable.getScale().setScaleName(Utilities.removeProgramKey(observationVariable.getScale().getScaleName(), program.getKey())); - } - - if (observationVariable.getMethod() != null && observationVariable.getMethod().getMethodName() != null) { - observationVariable.getMethod().setMethodName(Utilities.removeProgramKey(observationVariable.getMethod().getMethodName(), program.getKey())); - } - - if (observationVariable.getTrait() != null && observationVariable.getTrait().getTraitName() != null) { - observationVariable.getTrait().setTraitName(Utilities.removeProgramKey(observationVariable.getTrait().getTraitName(), program.getKey())); - } - }); - } - } diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java index 66c4adde9..e5c7c72dd 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java @@ -17,6 +17,7 @@ package org.breedinginsight.brapi.v2.services; +import io.micronaut.http.server.exceptions.InternalServerException; import lombok.extern.slf4j.Slf4j; import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.tuple.Pair; @@ -91,6 +92,31 @@ public List getBrAPIObservationVariablesForExperiment( return new ArrayList<>(); } + @NotNull + public BrAPIObservationVariable filterVariableById(List programTraits, + String observationVariableDbId) throws DoesNotExistException { + List filterResult = filterVariables(programTraits, + Optional.of(observationVariableDbId), + Optional.empty(), + Optional.empty(), + Optional.empty(), + Optional.empty(), + Optional.empty(), + Optional.empty(), + Optional.empty(), + Optional.empty(), + Optional.empty() + ); + + if (filterResult.isEmpty()) { + throw new DoesNotExistException(String.format("No observation variables found for brapi observation variable dbId [%s]", observationVariableDbId)); + } else if (filterResult.size() > 1) { + throw new InternalServerException(String.format("Multiple observation variables found for brapi observation variable db id [%s]. This should not be possible considering this id is unique.", observationVariableDbId)); + } + + return filterResult.get(0); + } + @NotNull public List filterVariables(List programTraits, Optional observationVariableDbId, @@ -230,18 +256,4 @@ private List prepSynonyms(Trait trait) { } return preppedSynonyms; } - - public BrAPIObservationVariableSingleResponse getBrAPIObservationVariableByDbId(String observationVariableDbId, UUID programId) throws ApiException, DoesNotExistException { - - if (!programService.exists(programId)) { - throw new DoesNotExistException("Program does not exist"); - } - - // This helper method retrieves the proper program that will be associated with the brapi observation variable that is being looked up. - UUID ontologyProgramLookupId = ontologyService.getSubscribedOntologyProgramId(programId); - - Program program = programService.getById(ontologyProgramLookupId).get(); - - return observationVariableDAO.getVariableByIdWithResponse(observationVariableDbId, program); - } } From ad4c030d5a17482e97bfbb5eae86223b7f7273c7 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Tue, 3 Nov 2026 14:23:33 -0500 Subject: [PATCH 099/102] Add clarifying comment --- .../brapi/v2/services/BrAPIObservationVariableService.java | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java index e5c7c72dd..4968695a4 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java +++ b/src/main/java/org/breedinginsight/brapi/v2/services/BrAPIObservationVariableService.java @@ -196,6 +196,8 @@ public List filterVariables(List programTraits, } public BrAPIObservationVariable convertToBrAPI(Trait trait) { + // This data is not stored in BrAPI by DeltaBreed, which is why it is being set with the DeltaBreed dbIds instead. + // They can be filtered upon in BrAPIObservationVariableController.variablesGet() BrAPIOntologyReference brAPIOntologyReference = new BrAPIOntologyReference().ontologyDbId(trait.getProgramOntologyId() .toString()); String status = trait.getActive() ? "active" : "inactive"; From c06b5051d2318e1334ab1d5554e2cd9a7e775f8a Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Thu, 5 Nov 2026 10:57:10 -0500 Subject: [PATCH 100/102] Remove trait cache and rest of CRUD operations --- .../daos/impl/TraitDAOImpl.java | 35 ------------------- 1 file changed, 35 deletions(-) diff --git a/src/main/java/org/breedinginsight/daos/impl/TraitDAOImpl.java b/src/main/java/org/breedinginsight/daos/impl/TraitDAOImpl.java index b9c317db2..3b810cfe0 100644 --- a/src/main/java/org/breedinginsight/daos/impl/TraitDAOImpl.java +++ b/src/main/java/org/breedinginsight/daos/impl/TraitDAOImpl.java @@ -23,7 +23,6 @@ import com.google.gson.JsonDeserializer; import io.micronaut.context.annotation.Property; import io.micronaut.http.server.exceptions.InternalServerException; -import io.micronaut.scheduling.annotation.Scheduled; import lombok.extern.slf4j.Slf4j; import org.brapi.client.v2.ApiResponse; import org.brapi.client.v2.BrAPIClient; @@ -34,7 +33,6 @@ import org.brapi.v2.model.pheno.*; import org.brapi.v2.model.pheno.request.BrAPIObservationVariableSearchRequest; import org.brapi.v2.model.pheno.response.BrAPIObservationVariableListResponse; -import org.brapi.v2.model.pheno.response.BrAPIObservationVariableListResponseResult; import org.brapi.v2.model.pheno.response.BrAPIObservationVariableSingleResponse; import org.breedinginsight.brapps.importer.services.ExternalReferenceSource; import org.breedinginsight.dao.db.tables.BiUserTable; @@ -43,8 +41,6 @@ import org.breedinginsight.daos.ObservationDAO; import org.breedinginsight.daos.ProgramDAO; import org.breedinginsight.daos.TraitDAO; -import org.breedinginsight.daos.cache.ProgramCache; -import org.breedinginsight.daos.cache.ProgramCacheProvider; import org.breedinginsight.model.*; import org.breedinginsight.model.User; import org.breedinginsight.services.brapi.BrAPIEndpointProvider; @@ -74,7 +70,6 @@ public class TraitDAOImpl extends TraitDao implements TraitDAO { private final Boolean runScheduledTasks; private final ObservationDAO observationDao; private final BrAPIDAOUtil brAPIDAOUtil; - private final ProgramCache cache; private final ProgramDAO programDAO; private final BrAPIEndpointProvider brAPIEndpointProvider; private final Gson gson; @@ -89,7 +84,6 @@ public TraitDAOImpl(Configuration config, ObservationDAO observationDao, BrAPIDAOUtil brAPIDAOUtil, ProgramDAO programDAO, - ProgramCacheProvider programCacheProvider, BrAPIEndpointProvider brAPIEndpointProvider, @Property(name = "brapi.server.reference-source") String referenceSource, @Property(name = "micronaut.bi.api.run-scheduled-tasks") Boolean runScheduledTasks) { @@ -98,7 +92,6 @@ public TraitDAOImpl(Configuration config, this.brAPIProvider = brAPIProvider; this.observationDao = observationDao; this.brAPIDAOUtil = brAPIDAOUtil; - this.cache = programCacheProvider.getProgramCache(this::populateCache, Trait.class); this.programDAO = programDAO; this.brAPIEndpointProvider = brAPIEndpointProvider; this.gson = new GsonBuilder().registerTypeAdapter(OffsetDateTime.class, (JsonDeserializer) @@ -110,29 +103,6 @@ public TraitDAOImpl(Configuration config, this.runScheduledTasks = runScheduledTasks; } - @Scheduled(initialDelay = "${startup.delay.trait}") - public void setup() { - if(!runScheduledTasks) { - return; - } - // Populate trait cache for all programs on startup - log.debug("Populate traits cache"); - List programs = programDAO.getActive(); - if(programs != null) { - cache.populate(programs.stream().map(Program::getId).collect(Collectors.toList())); - } - } - - private Map populateCache(UUID programId) { - List programTraits = fetchTraitsFullByProgramId(programId); - Map traits = new HashMap<>(); - if (!programTraits.isEmpty()) { - programTraits.forEach(trait -> traits.put(trait.getId().toString(), trait)); - } - - return traits; - } - @Override public List getTraitsFullByProgramId(UUID programId) { List programIds = new ArrayList<>(); @@ -504,8 +474,6 @@ public List createTraitsBrAPI(List traits, User actingUser, Progra if (brApiExternalReference.getReferenceSource().equals(referenceSource) && brApiExternalReference.getReferenceID().equals(trait.getId().toString())){ saturateTrait(trait, variable); - - cache.set(program.getId(), trait.getId().toString(), trait); } } } @@ -568,9 +536,6 @@ public Trait updateTraitBrAPI(Trait trait, Program program) { // Retrieve our update trait from the db updatedTrait = getTrait(program.getId(), trait.getId()).get(); saturateTrait(updatedTrait, updatedVariable); - - //update cache - cache.set(program.getId(), updatedTrait.getId().toString(), updatedTrait); } return updatedTrait; From f5b9ca4196d14dd8273f711c80cad8894dbae1a6 Mon Sep 17 00:00:00 2001 From: humsika Date: Thu, 12 Nov 2026 16:35:29 -0600 Subject: [PATCH 101/102] BI-2862: Pass observations search-results GET directly to BrAPIDAOUtil. --- .../brapi/v2/dao/BrAPIObservationDAO.java | 16 ++-------------- 1 file changed, 2 insertions(+), 14 deletions(-) diff --git a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java index 3f176028d..2026f2ac5 100644 --- a/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java +++ b/src/main/java/org/breedinginsight/brapi/v2/dao/BrAPIObservationDAO.java @@ -20,12 +20,9 @@ import io.micronaut.http.server.exceptions.InternalServerException; import lombok.extern.slf4j.Slf4j; import org.apache.commons.lang3.StringUtils; -import org.apache.commons.lang3.tuple.Pair; -import org.brapi.client.v2.ApiResponse; import org.brapi.client.v2.model.exceptions.ApiException; import org.brapi.client.v2.model.queryParams.phenotype.ObservationQueryParams; import org.brapi.client.v2.modules.phenotype.ObservationsApi; -import org.brapi.v2.model.BrAPIAcceptedSearchResponse; import org.brapi.v2.model.core.BrAPIProgram; import org.brapi.v2.model.pheno.BrAPIObservation; import org.brapi.v2.model.pheno.BrAPIObservationUnit; @@ -40,15 +37,12 @@ import org.breedinginsight.services.exceptions.DoesNotExistException; import org.breedinginsight.utilities.BrAPIDAOUtil; import org.breedinginsight.utilities.Utilities; -import org.jetbrains.annotations.NotNull; import javax.inject.Inject; import javax.inject.Singleton; import java.util.*; import java.util.stream.Collectors; -import static org.brapi.v2.model.BrAPIWSMIMEDataTypes.APPLICATION_JSON; - @Singleton @Slf4j public class BrAPIObservationDAO { @@ -109,7 +103,7 @@ public List getObservationsByStudyName(List studyNames ObservationsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(program.getId()), ObservationsApi.class); return brAPIDAOUtil.search( api::searchObservationsPost, - (brAPIWSMIMEDataTypes, searchResultsDbId, page, pageSize) -> searchObservationsSearchResultsDbIdGet(program.getId(), searchResultsDbId, page, pageSize), + api::searchObservationsSearchResultsDbIdGet, observationSearchRequest ); } @@ -119,7 +113,7 @@ private List searchBrapiObservations(BrAPIObservationSearchReq List observations = brAPIDAOUtil.search( api::searchObservationsPost, - (brAPIWSMIMEDataTypes, searchResultsDbId, page, pageSize) -> searchObservationsSearchResultsDbIdGet(program.getId(), searchResultsDbId, page, pageSize), + api::searchObservationsSearchResultsDbIdGet, observationSearchRequest ); @@ -214,12 +208,6 @@ public BrAPIObservationListResponse getObservationsByFilters(Program program, St return brAPIResponse; } - @NotNull - private ApiResponse, Optional>> searchObservationsSearchResultsDbIdGet(UUID programId, String searchResultsDbId, Integer page, Integer pageSize) throws ApiException { - ObservationsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(programId), ObservationsApi.class); - return api.searchObservationsSearchResultsDbIdGet(APPLICATION_JSON, searchResultsDbId, page, pageSize); - } - public List createBrAPIObservations(List brAPIObservationList, UUID programId, ImportUpload upload) throws ApiException { ObservationsApi api = brAPIEndpointProvider.get(programDAO.getCoreClient(programId), ObservationsApi.class); var program = programDAO.fetchOneById(programId); From a5f01689a5f121d114df31dbe90c0c78850a9500 Mon Sep 17 00:00:00 2001 From: Jason Loux Date: Mon, 16 Nov 2026 17:44:15 -0500 Subject: [PATCH 102/102] Update brapi snapshot --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 3e6164d51..1a24e322f 100644 --- a/pom.xml +++ b/pom.xml @@ -89,7 +89,7 @@ 31.0.1-jre 4.9.3 4.3.1 - 2.2.1-SNAPSHOT + 2.2.2-SNAPSHOT 2.11.0 2.2.1