CDA-75 - Adds flow-unit support to CDA for pump accounting. (#1539)

fixes #1180

Note this allows things to work with CDA converting to SI prior to store
- a more permanent fix would be in the db to include native-units to the
object holding the flow

Author: rma-bryson

cda-gui/package-lock.json

@@ -45,6 +45,8 @@
 import cwms.cda.data.dto.watersupply.WaterSupplyAccounting;
 import cwms.cda.formatters.ContentType;
 import cwms.cda.formatters.Formats;
+import cwms.cda.data.dao.watersupply.WaterSupplyUtils;
+import mil.army.usace.hec.metadata.DataSetIllegalArgumentException;
 import io.javalin.core.util.Header;
 import io.javalin.http.Context;
 import io.javalin.http.Handler;
@@ -132,9 +134,15 @@ public void handle(@NotNull Context ctx) {
                 }
             }
 
-            waterSupplyAccountingDao.storeAccounting(accounting);
-            StatusResponse re = new StatusResponse(office, "The pump accounting entry was created.", contractId);
-            ctx.status(HttpServletResponse.SC_CREATED).json(re);
+            // Ensure flows are stored in SI units
+            try {
+                WaterSupplyAccounting accountingInSi = WaterSupplyUtils.convertAccountingFlowsToSi(accounting);
+                waterSupplyAccountingDao.storeAccounting(accountingInSi);
+                StatusResponse re = new StatusResponse(office, "The pump accounting entry was created.", contractId);
+                ctx.status(HttpServletResponse.SC_CREATED).json(re);
+            } catch (DataSetIllegalArgumentException | IllegalArgumentException ex) {
+                ctx.status(HttpServletResponse.SC_BAD_REQUEST).json("Unable to process units for flow: " + ex.getMessage());
+            }
         }
     }
 
@@ -146,4 +154,6 @@ private boolean searchForTransferType(PumpTransfer accounting, List<LookupType>
         }
         return false;
     }
+
+    
 }

cwms-data-api/src/main/java/cwms/cda/api/watersupply/AccountingCreateController.java

@@ -90,7 +90,7 @@ public List<WaterSupplyAccounting> retrieveAccounting(String contractName, Water
                 contractRefT, units, startTimestamp, endTimestamp, timeZoneId, startInclusiveFlag,
                 endInclusiveFlag, ascendingFlagStr, rowLimitBigInt, transferType);
             if (!watUsrContractAcctObjTs.isEmpty()) {
-                return WaterSupplyUtils.toWaterSupplyAccountingList(c, watUsrContractAcctObjTs);
+                return WaterSupplyUtils.toWaterSupplyAccountingList(c, watUsrContractAcctObjTs, units);
             } else {
                 return new ArrayList<>();
             }

cwms-data-api/src/main/java/cwms/cda/data/dao/watersupply/WaterSupplyAccountingDao.java

@@ -47,6 +47,10 @@
 import java.util.Map;
 import java.util.TreeMap;
 import com.google.common.flogger.FluentLogger;
+import mil.army.usace.hec.metadata.DataSetIllegalArgumentException;
+import mil.army.usace.hec.metadata.Parameter;
+import mil.army.usace.hec.metadata.UnitUtil;
+import mil.army.usace.hec.metadata.UnitsConversionException;
 import org.jetbrains.annotations.NotNull;
 import org.jooq.impl.DSL;
 import usace.cwms.db.jooq.codegen.udt.records.LOCATION_REF_T;
@@ -62,13 +66,56 @@
 import usace.cwms.db.jooq.codegen.udt.records.WAT_USR_CONTRACT_ACCT_TAB_T;
 
 
-final class WaterSupplyUtils {
+public final class WaterSupplyUtils {
     private static final FluentLogger LOGGER = FluentLogger.forEnclosingClass();
 
     private WaterSupplyUtils() {
         throw new IllegalStateException("Utility class");
     }
 
+    /**
+     * Converts all PumpTransfer flow values to SI units and returns a new WaterSupplyAccounting instance.
+     * The SI flow units are determined using metadata for the FLOW parameter. If any conversion fails,
+     * an IllegalArgumentException is thrown wrapping the UnitsConversionException. If the SI units
+     * cannot be determined due to metadata issues, a DataSetIllegalArgumentException may be thrown.
+     *
+     * @param accounting the input WaterSupplyAccounting, possibly containing non-SI flow units
+     * @return a new WaterSupplyAccounting with all flows in SI units
+     * @throws DataSetIllegalArgumentException if SI flow units cannot be determined
+     * @throws IllegalArgumentException if a units conversion fails
+     */
+    public static WaterSupplyAccounting convertAccountingFlowsToSi(WaterSupplyAccounting accounting)
+            throws DataSetIllegalArgumentException, IllegalArgumentException {
+        String siFlowUnits = Parameter.getParameter(Parameter.PARAMID_FLOW)
+                .getUnitsStringForSystem(UnitUtil.SI_ID);
+
+        Map<Instant, List<PumpTransfer>> converted = new java.util.TreeMap<>();
+        for (Map.Entry<Instant, List<PumpTransfer>> entry : accounting.getPumpAccounting().entrySet()) {
+            List<PumpTransfer> transformed = new java.util.ArrayList<>();
+            for (PumpTransfer pt : entry.getValue()) {
+                String fromUnits = pt.getFlowUnit();
+                if (fromUnits != null && !fromUnits.equalsIgnoreCase(siFlowUnits)) {
+                    try {
+                        double siValue = UnitUtil.convertUnits(pt.getFlow(), fromUnits, siFlowUnits);
+                        transformed.add(new PumpTransfer(pt.getPumpType(), pt.getTransferTypeDisplay(), siValue,
+                                siFlowUnits, pt.getComment()));
+                    } catch (UnitsConversionException e) {
+                        throw new IllegalArgumentException(e.getMessage(), e);
+                    }
+                } else {
+                    transformed.add(pt);
+                }
+            }
+            converted.put(entry.getKey(), transformed);
+        }
+        return new WaterSupplyAccounting.Builder()
+                .withWaterUser(accounting.getWaterUser())
+                .withContractName(accounting.getContractName())
+                .withPumpLocations(accounting.getPumpLocations())
+                .withPumpAccounting(converted)
+                .build();
+    }
+
     static WaterUserContract toWaterContract(WATER_USER_CONTRACT_OBJ_T contract) {
         Instant effectiveDate = null;
         if(contract.getWS_CONTRACT_EFFECTIVE_DATE() != null) {
@@ -251,7 +298,7 @@ static LOC_REF_TIME_WINDOW_TAB_T toTimeWindowTabT(WaterSupplyAccounting accounti
     }
 
     static List<WaterSupplyAccounting> toWaterSupplyAccountingList(Connection c, WAT_USR_CONTRACT_ACCT_TAB_T
-            watUsrContractAcctTabT) {
+            watUsrContractAcctTabT, String flowUnits) {
 
         List<WaterSupplyAccounting> waterSupplyAccounting = new ArrayList<>();
         Map<AccountingKey, WaterSupplyAccounting> cacheMap = new TreeMap<>();
@@ -269,9 +316,9 @@ static List<WaterSupplyAccounting> toWaterSupplyAccountingList(Connection c, WAT
                 .build();
             if (cacheMap.containsKey(key)) {
                 WaterSupplyAccounting accounting = cacheMap.get(key);
-                addTransfer(watUsrContractAcctObjT, accounting);
+                addTransfer(watUsrContractAcctObjT, accounting, flowUnits);
             } else {
-                cacheMap.put(key, createAccounting(c, watUsrContractAcctObjT));
+                cacheMap.put(key, createAccounting(c, watUsrContractAcctObjT, flowUnits));
             }
         }
         for (Map.Entry<AccountingKey, WaterSupplyAccounting> entry : cacheMap.entrySet()) {
@@ -280,7 +327,7 @@ static List<WaterSupplyAccounting> toWaterSupplyAccountingList(Connection c, WAT
         return waterSupplyAccounting;
     }
 
-    private static WaterSupplyAccounting createAccounting(Connection c, WAT_USR_CONTRACT_ACCT_OBJ_T acctObjT) {
+    private static WaterSupplyAccounting createAccounting(Connection c, WAT_USR_CONTRACT_ACCT_OBJ_T acctObjT, String flowUnits) {
         WaterContractDao waterContractDao = new WaterContractDao(DSL.using(c));
         WATER_USER_OBJ_T waterUserObjT = acctObjT.getWATER_USER_CONTRACT_REF().getWATER_USER();
         WaterUserContract waterUserContract = waterContractDao.getWaterContract(
@@ -307,13 +354,13 @@ private static WaterSupplyAccounting createAccounting(Connection c, WAT_USR_CONT
         PumpTransfer transfer = null;
         if (pumpIn != null && pumpIn.getName().equalsIgnoreCase(pumpLocation)
                 && pumpIn.getOfficeId().equalsIgnoreCase(pumpOffice)) {
-            transfer = new PumpTransfer(PumpType.IN, transferDisplay, flow, remarks);
+            transfer = new PumpTransfer(PumpType.IN, transferDisplay, flow, flowUnits, remarks);
         } else if (pumpOut != null && pumpOut.getName().equalsIgnoreCase(pumpLocation)
                 && pumpOut.getOfficeId().equalsIgnoreCase(pumpOffice)) {
-            transfer = new PumpTransfer(PumpType.OUT, transferDisplay, flow, remarks);
+            transfer = new PumpTransfer(PumpType.OUT, transferDisplay, flow, flowUnits, remarks);
         } else if (pumpBelow != null && pumpBelow.getName().equalsIgnoreCase(pumpLocation)
                 && pumpBelow.getOfficeId().equalsIgnoreCase(pumpOffice)) {
-            transfer = new PumpTransfer(PumpType.BELOW, transferDisplay, flow, remarks);
+            transfer = new PumpTransfer(PumpType.BELOW, transferDisplay, flow, flowUnits, remarks);
         }
         if (transfer != null) {
             pumpAccounting.put(transferStart, Collections.singletonList(transfer));
@@ -330,7 +377,7 @@ private static WaterSupplyAccounting createAccounting(Connection c, WAT_USR_CONT
             .build();
     }
 
-    private static void addTransfer(WAT_USR_CONTRACT_ACCT_OBJ_T acctObjTs, WaterSupplyAccounting accounting) {
+    private static void addTransfer(WAT_USR_CONTRACT_ACCT_OBJ_T acctObjTs, WaterSupplyAccounting accounting, String flowUnits) {
         PumpTransfer transfer = null;
         String transferDisplay = acctObjTs.getPHYSICAL_TRANSFER_TYPE().getDISPLAY_VALUE();
         String accountingRemarks = acctObjTs.getACCOUNTING_REMARKS();
@@ -343,14 +390,14 @@ private static void addTransfer(WAT_USR_CONTRACT_ACCT_OBJ_T acctObjTs, WaterSupp
 
         if (pumpIn != null && pumpIn.getName().equalsIgnoreCase(locationId)
                 && pumpIn.getOfficeId().equalsIgnoreCase(officeId)) {
-            transfer = new PumpTransfer(PumpType.IN, transferDisplay, acctObjTs.getPUMP_FLOW(), accountingRemarks);
+            transfer = new PumpTransfer(PumpType.IN, transferDisplay, acctObjTs.getPUMP_FLOW(), flowUnits, accountingRemarks);
         } else if (pumpOut != null && pumpOut.getName().equalsIgnoreCase(locationId)
                 && pumpOut.getOfficeId().equalsIgnoreCase(officeId)) {
-            transfer = new PumpTransfer(PumpType.OUT, transferDisplay, acctObjTs.getPUMP_FLOW(), accountingRemarks);
+            transfer = new PumpTransfer(PumpType.OUT, transferDisplay, acctObjTs.getPUMP_FLOW(), flowUnits, accountingRemarks);
         } else if (pumpBelow != null && pumpBelow.getName().equalsIgnoreCase(locationId)
                 && pumpBelow.getOfficeId().equalsIgnoreCase(officeId)) {
             transfer = new PumpTransfer(PumpType.BELOW, transferDisplay,
-                    acctObjTs.getPUMP_FLOW(), accountingRemarks);
+                    acctObjTs.getPUMP_FLOW(), flowUnits, accountingRemarks);
         }
         if (accounting.getPumpAccounting().get(transferStart) != null) {
             List<PumpTransfer> transfers = new ArrayList<>(accounting.getPumpAccounting().get(transferStart));

cwms-data-api/src/main/java/cwms/cda/data/dao/watersupply/WaterSupplyUtils.java

@@ -2,7 +2,7 @@
  *
  * MIT License
  *
- * Copyright (c) 2024 Hydrologic Engineering Center
+ * Copyright (c) 2026 Hydrologic Engineering Center
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -41,14 +41,17 @@ public final class PumpTransfer extends CwmsDTOBase {
     @JsonProperty(required = true)
     private final Double flow;
     @JsonProperty(required = true)
+    private final String flowUnit;
+    @JsonProperty(required = true)
     private final String comment;
 
     @JsonCreator
     public PumpTransfer(@JsonProperty("pump-type") PumpType pumpType,
-            @JsonProperty("transfer-type-display") String transferTypeDisplay,
-            @JsonProperty("flow") Double flow, @JsonProperty("comment") String comment) {
+                        @JsonProperty("transfer-type-display") String transferTypeDisplay,
+                        @JsonProperty("flow") Double flow, @JsonProperty("flow-unit") String flowUnit, @JsonProperty("comment") String comment) {
         this.transferTypeDisplay = transferTypeDisplay;
         this.flow = flow;
+        this.flowUnit = flowUnit;
         this.comment = comment;
         this.pumpType = pumpType;
     }
@@ -61,6 +64,10 @@ public Double getFlow() {
         return this.flow;
     }
 
+    public String getFlowUnit() {
+        return this.flowUnit;
+    }
+
     public PumpType getPumpType() {
         return this.pumpType;
     }

cwms-data-api/src/main/java/cwms/cda/data/dto/watersupply/PumpTransfer.java

@@ -68,6 +68,7 @@
 import static cwms.cda.data.dao.DaoTest.getDslContext;
 import static cwms.cda.security.ApiKeyIdentityProvider.AUTH_HEADER;
 import static io.restassured.RestAssured.given;
+import static org.hamcrest.Matchers.closeTo;
 import static org.hamcrest.Matchers.equalTo;
 import static org.hamcrest.Matchers.is;
 
@@ -449,6 +450,66 @@ void testStoreRetrieveWithUnits(String format) throws Exception {
         ;
     }
 
+    @ParameterizedTest
+    @ValueSource(strings = {Formats.JSONV1, Formats.DEFAULT})
+    void testStoreAsCfsThenRetrieveWithUnits(String format) throws Exception {
+        TestAccounts.KeyUser user = TestAccounts.KeyUser.SPK_NORMAL;
+        String json = JsonV1.buildObjectMapper().writeValueAsString(waterSupplyAccounting);
+
+        json = json.replace("cms", "cfs");
+        // create pump accounting
+        given()
+                .log().ifValidationFails(LogDetail.ALL, true)
+                .contentType(Formats.JSONV1)
+                .body(json)
+                .header(AUTH_HEADER, user.toHeaderValue())
+                .when()
+                .redirects().follow(true)
+                .redirects().max(3)
+                .post("/projects/" + OFFICE_ID + "/" + contract.getWaterUser().getProjectId().getName() + "/water-user/"
+                        + contract.getWaterUser().getEntityName() + "/contracts/"
+                        + contract.getContractId().getName() + "/accounting")
+                .then()
+                .log().ifValidationFails(LogDetail.ALL, true)
+                .assertThat()
+                .statusCode(is(HttpServletResponse.SC_CREATED))
+        ;
+
+        // retrieve pump accounting
+        given()
+                .log().ifValidationFails(LogDetail.ALL, true)
+                .contentType(Formats.JSONV1)
+                .header(AUTH_HEADER, user.toHeaderValue())
+                .accept(format)
+                .queryParam(START_TIME, "2005-04-05T00:00:00Z")
+                .queryParam(END_TIME, "2335-04-06T00:00:00Z")
+                .queryParam(START_INCLUSIVE, "true")
+                .queryParam(END_INCLUSIVE, "true")
+                .queryParam(ASCENDING, "true")
+                .queryParam(ROW_LIMIT, 100)
+                .queryParam(UNIT, "cfs")
+                .when()
+                .redirects().follow(true)
+                .redirects().max(3)
+                .get("/projects/" + OFFICE_ID + "/" + contract.getWaterUser().getProjectId().getName() + "/water-user/"
+                        + contract.getWaterUser().getEntityName() + "/contracts/"
+                        + contract.getContractId().getName() + "/accounting")
+                .then()
+                .log().ifValidationFails(LogDetail.ALL, true)
+                .assertThat()
+                .statusCode(is(HttpServletResponse.SC_OK))
+                .body("[0].contract-name", equalTo(waterSupplyAccounting.getContractName()))
+                .body("[0].water-user.entity-name", equalTo(waterSupplyAccounting.getWaterUser().getEntityName()))
+                .body("[0].water-user.project-id.name", equalTo(waterSupplyAccounting.getWaterUser().getProjectId().getName()))
+                .body("[0].water-user.project-id.office-id", equalTo(waterSupplyAccounting.getWaterUser().getProjectId().getOfficeId()))
+                .body("[0].water-user.water-right", equalTo(waterSupplyAccounting.getWaterUser().getWaterRight()))
+                .body("[0].pump-accounting[\"2022-11-20T21:17:28Z\"].pump-type[2]", equalTo(String.format("%s", PumpType.IN)))
+                .body("[0].pump-accounting[\"2022-11-20T21:17:28Z\"].flow[2].toDouble()", closeTo(1.0, 0.0001))
+                .body("[0].pump-accounting[\"2022-11-20T21:17:28Z\"].transfer-type-display[2]", equalTo(testTransferType.getDisplayValue()))
+                .body("[0].pump-locations.pump-in.name", equalTo(waterSupplyAccounting.getPumpLocations().getPumpIn().getName()))
+        ;
+    }
+
     @Test
     void testStoreNonExistentTransferType() throws Exception {
         TestAccounts.KeyUser user = TestAccounts.KeyUser.SPK_NORMAL;

cwms-data-api/src/test/java/cwms/cda/api/WaterSupplyAccountingControllerIT.java

@@ -450,22 +450,22 @@ private WaterSupplyAccounting buildTestAccountingWithFewerPumps() {
     private Map<Instant, List<PumpTransfer>> buildTestPumpAccountingList() {
         Map<Instant, List<PumpTransfer>> retList = new TreeMap<>();
         List<PumpTransfer> transfers = new ArrayList<>();
-        transfers.add(new PumpTransfer(PumpType.IN, "Conduit", 100.0, "Test Transfer"));
-        transfers.add(new PumpTransfer(PumpType.OUT, "Pipeline", 200.0, "Emergency Transfer"));
+        transfers.add(new PumpTransfer(PumpType.IN, "Conduit", 100.0, "cms", "Test Transfer"));
+        transfers.add(new PumpTransfer(PumpType.OUT, "Pipeline", 200.0, "cms", "Emergency Transfer"));
         retList.put(Instant.parse("2025-10-01T00:00:00Z"), transfers);
         transfers.clear();
-        transfers.add(new PumpTransfer(PumpType.OUT, "Canal", 300.0, "Test Transfer"));
-        transfers.add(new PumpTransfer(PumpType.BELOW, "Stream", 400.0, "Emergency Transfer"));
+        transfers.add(new PumpTransfer(PumpType.OUT, "Canal", 300.0, "cms", "Test Transfer"));
+        transfers.add(new PumpTransfer(PumpType.BELOW, "Stream", 400.0, "cms", "Emergency Transfer"));
         retList.put(Instant.parse("2025-10-02T00:00:00Z"), transfers);
         return retList;
     }
 
     private Map<Instant, List<PumpTransfer>> buildTestPumpAccountingListWithFewerPumps() {
         Map<Instant, List<PumpTransfer>> retList = new TreeMap<>();
         retList.put(Instant.parse("2025-10-01T00:00:00Z"),
-                Collections.singletonList(new PumpTransfer(PumpType.IN, "Conduit", 560.0, "Test Transfer")));
+                Collections.singletonList(new PumpTransfer(PumpType.IN, "Conduit", 560.0, "cms", "Test Transfer")));
         retList.put(Instant.parse("2025-10-02T00:00:00Z"),
-                Collections.singletonList(new PumpTransfer(PumpType.IN, "Canal", 750.0, "Test Transfer")));
+                Collections.singletonList(new PumpTransfer(PumpType.IN, "Canal", 750.0, "cms", "Test Transfer")));
         return retList;
     }