From 0d5532c0a29ff234ebd2a7bb21806d54ba75d31a Mon Sep 17 00:00:00 2001
From: David Randolph Phillips <drp227@cornell.edu>
Date: Fri, 20 Oct 2023 09:39:08 -0400
Subject: [PATCH] [BI-1911] when commit==false, add the Env Year to
 additionalInfo

---
 .../constants/BrAPIAdditionalInfoFields.java  |  1 +
 .../processors/ExperimentProcessor.java       | 43 ++++++++++++++++++-
 2 files changed, 43 insertions(+), 1 deletion(-)

diff --git a/src/main/java/org/breedinginsight/brapi/v2/constants/BrAPIAdditionalInfoFields.java b/src/main/java/org/breedinginsight/brapi/v2/constants/BrAPIAdditionalInfoFields.java
index f82a718ed..d9daab6d0 100644
--- a/src/main/java/org/breedinginsight/brapi/v2/constants/BrAPIAdditionalInfoFields.java
+++ b/src/main/java/org/breedinginsight/brapi/v2/constants/BrAPIAdditionalInfoFields.java
@@ -47,4 +47,5 @@ public final class BrAPIAdditionalInfoFields {
     public static final String MALE_PARENT_UNKNOWN = "maleParentUnknown";
 	public static final String TREATMENTS = "treatments";
     public static final String GID = "gid";
+    public static final String ENV_YEAR = "envYear";
 }
diff --git a/src/main/java/org/breedinginsight/brapps/importer/services/processors/ExperimentProcessor.java b/src/main/java/org/breedinginsight/brapps/importer/services/processors/ExperimentProcessor.java
index 2c453b29d..b490a334d 100644
--- a/src/main/java/org/breedinginsight/brapps/importer/services/processors/ExperimentProcessor.java
+++ b/src/main/java/org/breedinginsight/brapps/importer/services/processors/ExperimentProcessor.java
@@ -16,6 +16,8 @@
  */
 package org.breedinginsight.brapps.importer.services.processors;
 
+import com.google.gson.JsonElement;
+import com.google.gson.JsonObject;
 import io.micronaut.context.annotation.Property;
 import io.micronaut.context.annotation.Prototype;
 import io.micronaut.http.HttpStatus;
@@ -899,6 +901,9 @@ private PendingImportObject<BrAPIStudy> fetchOrCreateStudyPIO(Program program, b
         PendingImportObject<BrAPIStudy> pio;
         if (studyByNameNoScope.containsKey(importRow.getEnv())) {
             pio = studyByNameNoScope.get(importRow.getEnv());
+            if (! commit){
+                addYearToStudyAdditionalInfo(program, pio.getBrAPIObject());
+            }
         } else {
             PendingImportObject<BrAPITrial> trialPIO = this.trialByNameNoScope.get(importRow.getExpTitle());
             UUID trialID = trialPIO.getId();
@@ -906,20 +911,56 @@ private PendingImportObject<BrAPIStudy> fetchOrCreateStudyPIO(Program program, b
             BrAPIStudy newStudy = importRow.constructBrAPIStudy(program, commit, BRAPI_REFERENCE_SOURCE, expSequenceValue, trialID, id, envNextVal);
             newStudy.setLocationDbId(this.locationByName.get(importRow.getEnvLocation()).getId().toString()); //set as the BI ID to facilitate looking up locations when saving new studies
 
+            // It is assumed that the study has only one season, And that the Years and not
+            // the dbId's are stored in getSeason() list.
+            String year = newStudy.getSeasons().get(0);
             if (commit) {
-                String year = newStudy.getSeasons().get(0); // It is assumed that the study has only one season
                 if(StringUtils.isNotBlank(year)) {
                     String seasonID = this.yearToSeasonDbId(year, program.getId());
                     newStudy.setSeasons(Collections.singletonList(seasonID));
                 }
+            } else {
+                addYearToStudyAdditionalInfo(program, newStudy, year);
             }
 
+
             pio = new PendingImportObject<>(ImportObjectState.NEW, newStudy, id);
             this.studyByNameNoScope.put(importRow.getEnv(), pio);
         }
         return pio;
     }
 
+
+    /*
+     * this finds the YEAR from the season list on the BrAPIStudy and then
+     * will add the year to the additionalInfo-field of the BrAPIStudy
+     * */
+    private void addYearToStudyAdditionalInfo(Program program, BrAPIStudy study) {
+        JsonObject additionalInfo = study.getAdditionalInfo();
+
+        //if it is already there, don't add it.
+        if(additionalInfo==null || additionalInfo.get(BrAPIAdditionalInfoFields.ENV_YEAR)==null) {
+            String seasonDbId = study.getSeasons().get(0);
+            String year = seasonDbIdToYear(seasonDbId, program.getId());
+            addYearToStudyAdditionalInfo(program, study, year);
+        }
+    }
+
+
+    /*
+    * this will add the given year to the additionalInfo field of the BrAPIStudy (if it does not already exist)
+    * */
+    private void addYearToStudyAdditionalInfo(Program program, BrAPIStudy study, String year) {
+        JsonObject additionalInfo = study.getAdditionalInfo();
+        if (additionalInfo==null){
+            additionalInfo = new JsonObject();
+            study.setAdditionalInfo(additionalInfo);
+        }
+        if( additionalInfo.get(BrAPIAdditionalInfoFields.ENV_YEAR)==null) {
+            additionalInfo.addProperty(BrAPIAdditionalInfoFields.ENV_YEAR, year);
+        }
+    }
+
     private PendingImportObject<ProgramLocation> fetchOrCreateLocationPIO(ExperimentObservation importRow) {
         PendingImportObject<ProgramLocation> pio;
         if (locationByName.containsKey((importRow.getEnvLocation()))) {