Skip to content

Bugfix/cda 101 native and other vert datum support #1710

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
rma-bryson wants to merge 3 commits into
base: develop
Choose a base branch
from
Draft

Bugfix/cda 101 native and other vert datum support #1710

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a183945
CDA-101 - initial removal of exceptions
rma-bryson Apr 9, 2026
66a9079
CDA-101 - Verifying we can't just let OTHER pass through to db curren…
rma-bryson Apr 24, 2026
f367288
CDA-101 - Updates to convert OTHER to LOCAL on ts store. Added passin…
rma-bryson Apr 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions cwms-data-api/src/main/java/cwms/cda/data/dao/JooqDao.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,12 @@ protected static Double toDouble(BigDecimal bigDecimal) {
protected void withDefaultDatum(@Nullable VerticalDatum targetDatum, DSLContext dslContext, ConnectionRunnable cr) {
String defaultVertDatum = CWMS_LOC_PACKAGE.call_GET_DEFAULT_VERTICAL_DATUM(dslContext.configuration());
String targetName = (targetDatum != null) ? targetDatum.toString() : null;
if(targetDatum == VerticalDatum.OTHER) {
targetName = "LOCAL";
}
if(targetDatum == VerticalDatum.NATIVE) {
targetName = null;
}
boolean changeDefaultDatum = !Objects.equals(targetName, defaultVertDatum);
try {
if (changeDefaultDatum) {
Expand Down
7 changes: 1 addition & 6 deletions cwms-data-api/src/main/java/cwms/cda/data/dao/LocationVerticalDatumConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,6 @@ public static Optional<VerticalDatum> getVerticalDatum(Location location) {
return Optional.ofNullable(location)
.map(Location::getVerticalDatum) // unwrap Optional<VerticalDatumInfo>
.filter(s -> !s.isBlank())
.map(s -> {
if (s.equalsIgnoreCase(VerticalDatum.OTHER.toString())) {
throw new IllegalArgumentException("Vertical Datum of OTHER is not currently supported.");
}
return VerticalDatum.getVerticalDatum(s);
});
.map(VerticalDatum::getVerticalDatum);
}
}
7 changes: 1 addition & 6 deletions cwms-data-api/src/main/java/cwms/cda/data/dao/RatingsVerticalDatumExtractor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,7 @@ public static Optional<VerticalDatum> getVerticalDatum(String ratingSet) {
.flatMap(RatingsVerticalDatumExtractor::getVerticalDatumInfo)
.map(VerticalDatumInfo::getNativeDatum)
.filter(s -> !s.isEmpty())
.map(s -> {
if (s.equalsIgnoreCase(VerticalDatum.OTHER.toString())) {
throw new IllegalArgumentException("Vertical Datum of OTHER is not currently supported.");
}
return VerticalDatum.getVerticalDatum(s);
});
.map(VerticalDatum::getVerticalDatum);
}

public static Optional<VerticalDatumInfo> getVerticalDatumInfo(String ratingSet) {
Expand Down
7 changes: 1 addition & 6 deletions cwms-data-api/src/main/java/cwms/cda/data/dao/TimeSeriesVerticalDatumConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,7 @@ public static Optional<VerticalDatum> getVerticalDatum(TimeSeries timeSeries) {
.map(TimeSeries::getVerticalDatumInfo)
.map(VerticalDatumInfo::getNativeDatum)
.filter(s -> !s.isEmpty())
.map(s -> {
if (s.equalsIgnoreCase(VerticalDatum.OTHER.toString())) {
throw new IllegalArgumentException("Vertical Datum of OTHER is not currently supported.");
}
return VerticalDatum.getVerticalDatum(s);
});
.map(VerticalDatum::getVerticalDatum);
}

}
178 changes: 177 additions & 1 deletion cwms-data-api/src/test/java/cwms/cda/api/TimeseriesControllerTestIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1973,7 +1973,183 @@ void test_get_for_elev_has_datum() throws Exception {

}

@Test
void test_create_with_vertical_datum_info_other() throws Exception {
// This test exercises creating a timeseries while providing vertical-datum-info
// where the native-datum is OTHER and a local-datum-name is supplied (MSL1912),
// mirroring the cURL example provided in the issue description. See
// test_get_for_elev_has_datum() for patterns used here.

final String location = "McGregor";
final String officeId = TestAccounts.KeyUser.SPK_NORMAL.getOperatingOffice();
final String tsName = location + ".Elev.Inst.~15Minutes.0.best-MSL1912";

// Load request body from resource file
InputStream resource = this.getClass().getResourceAsStream("/cwms/cda/api/timeseries/ts_create_other_datum.json");
assertNotNull(resource);
String body = IOUtils.toString(resource, StandardCharsets.UTF_8);

// Update the body with the dynamic values
body = body.replace("SPK", officeId);

// Ensure the location exists and has coordinates so offsets logic in DAO has context if needed
createLocation(location, true, officeId);
updateLocation(location, true, officeId, "MSL1912");

TestAccounts.KeyUser user = TestAccounts.KeyUser.SPK_NORMAL;

// POST the timeseries with datum=OTHER
given()
.log().ifValidationFails(LogDetail.ALL, true)
.accept(Formats.JSONV2)
.contentType(Formats.JSONV2)
.body(body)
.header("Authorization", user.toHeaderValue())
.queryParam(OFFICE, officeId)
.queryParam(DATUM, VerticalDatum.OTHER.toString())
.when()
.redirects().follow(true)
.redirects().max(3)
.post("/timeseries/")
.then()
.log().ifValidationFails(LogDetail.ALL,true)
.assertThat()
.statusCode(is(HttpServletResponse.SC_OK));

// Retrieve it back and verify vertical-datum-info echoes expected values
String beginIso = java.time.Instant.ofEpochMilli(1772196300000L).toString();
given()
.log().ifValidationFails(LogDetail.ALL, true)
.accept(Formats.JSONV2)
.queryParam(OFFICE, officeId)
.queryParam(UNIT, "ft")
.queryParam(NAME, tsName)
.queryParam(BEGIN, beginIso)
.when()
.redirects().follow(true)
.redirects().max(3)
.get("/timeseries/")
.then()
.log().ifValidationFails(LogDetail.ALL, true)
.assertThat()
.statusCode(is(HttpServletResponse.SC_OK))
.body("vertical-datum-info", notNullValue())
.body("vertical-datum-info.location", equalTo(location))
.body("vertical-datum-info.office", equalTo(officeId))
.body("vertical-datum-info.unit", equalTo("ft"))
.body("vertical-datum-info.native-datum", equalTo("OTHER"))
.body("vertical-datum-info.local-datum-name", equalTo("MSL1912"))
.body("vertical-datum-info.offsets.size()", equalTo(2));

//delete timeseries
given()
.log().ifValidationFails(LogDetail.ALL, true)
.accept(Formats.JSONV2)
.queryParam(OFFICE, officeId)
.queryParam(BEGIN, "2026-02-27T12:30:34.182026Z")
.queryParam(END, "2026-02-27T13:37:53.366357Z")
.queryParam(START_TIME_INCLUSIVE, "true")
.queryParam(END_TIME_INCLUSIVE, "true")
.queryParam(OVERRIDE_PROTECTION, "true")
.when()
.redirects().follow(true)
.redirects().max(3)
.delete("/timeseries/" + tsName)
.then()
.log().ifValidationFails(LogDetail.ALL, true)
.assertThat()
.statusCode(is(HttpServletResponse.SC_OK));
deleteLocation(location, officeId);
}

@Test
void test_create_with_vertical_datum_info_native() throws Exception {
final String location = "McGregor";
final String officeId = TestAccounts.KeyUser.SPK_NORMAL.getOperatingOffice();
final String tsName = location + ".Elev.Inst.~15Minutes.0.best-NATIVE";

// Load request body from resource file
InputStream resource = this.getClass().getResourceAsStream("/cwms/cda/api/timeseries/ts_create_native_datum.json");
assertNotNull(resource);
String body = IOUtils.toString(resource, StandardCharsets.UTF_8);

// Update the body with the dynamic values
body = body.replace("SPK", officeId);

// Ensure the location exists and has coordinates so offsets logic in DAO has context if needed
createLocation(location, true, officeId);
updateLocation(location, true, officeId);

TestAccounts.KeyUser user = TestAccounts.KeyUser.SPK_NORMAL;

// POST the timeseries with datum=NATIVE
given()
.log().ifValidationFails(LogDetail.ALL, true)
.accept(Formats.JSONV2)
.contentType(Formats.JSONV2)
.body(body)
.header("Authorization", user.toHeaderValue())
.queryParam(OFFICE, officeId)
.queryParam(DATUM, VerticalDatum.NATIVE.toString())
.when()
.redirects().follow(true)
.redirects().max(3)
.post("/timeseries/")
.then()
.log().ifValidationFails(LogDetail.ALL,true)
.assertThat()
.statusCode(is(HttpServletResponse.SC_OK));

// Retrieve it back and verify vertical-datum-info echoes expected values
String beginIso = java.time.Instant.ofEpochMilli(1772196300000L).toString();
given()
.log().ifValidationFails(LogDetail.ALL, true)
.accept(Formats.JSONV2)
.queryParam(OFFICE, officeId)
.queryParam(UNIT, "ft")
.queryParam(NAME, tsName)
.queryParam(BEGIN, beginIso)
.when()
.redirects().follow(true)
.redirects().max(3)
.get("/timeseries/")
.then()
.log().ifValidationFails(LogDetail.ALL, true)
.assertThat()
.statusCode(is(HttpServletResponse.SC_OK))
.body("vertical-datum-info", notNullValue())
.body("vertical-datum-info.location", equalTo(location))
.body("vertical-datum-info.office", equalTo(officeId))
.body("vertical-datum-info.unit", equalTo("ft"))
.body("vertical-datum-info.native-datum", equalTo("NAVD-88")); // NAVD88 is the native datum we set in updateLocation

//delete timeseries
given()
.log().ifValidationFails(LogDetail.ALL, true)
.accept(Formats.JSONV2)
.header("Authorization", user.toHeaderValue())
.queryParam(OFFICE, officeId)
.queryParam(BEGIN, "2026-02-27T12:30:34.182026Z")
.queryParam(END, "2026-02-27T13:37:53.366357Z")
.queryParam(START_TIME_INCLUSIVE, "true")
.queryParam(END_TIME_INCLUSIVE, "true")
.queryParam(OVERRIDE_PROTECTION, "true")
.when()
.redirects().follow(true)
.redirects().max(3)
.delete("/timeseries/" + tsName)
.then()
.log().ifValidationFails(LogDetail.ALL, true)
.assertThat()
.statusCode(is(HttpServletResponse.SC_OK));
deleteLocation(location, officeId);
}

private void updateLocation(String location, boolean active, String officeId) throws SQLException {
updateLocation(location, active, officeId, VerticalDatum.NAVD88.toString());
}

private void updateLocation(String location, boolean active, String officeId, String verticalDatum) throws SQLException {

String P_LOCATION_ID = location;
String P_LOCATION_TYPE = "SITE";
Expand All @@ -1987,7 +2163,7 @@ private void updateLocation(String location, boolean active, String officeId) th
// group by VERTICAL_DATUM
// order by COUNT desc
// has no entries with a dash in the name (unless we've run this test with a dash).
String P_VERTICAL_DATUM = VerticalDatum.NAVD88.toString();
String P_VERTICAL_DATUM = verticalDatum;
Number P_LATITUDE = 38.5757; // pretty sure that if these are 0,0 then its not inside the navd88 bounds and the offsets come back []
Number P_LONGITUDE = -121.4789;
String P_HORIZONTAL_DATUM = "WGS84";
Expand Down
28 changes: 28 additions & 0 deletions cwms-data-api/src/test/resources/cwms/cda/api/timeseries/ts_create_native_datum.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"begin": "2026-02-27T12:30:34.182026Z",
"end": "2026-02-27T13:37:53.366357Z",
"name": "McGregor.Elev.Inst.~15Minutes.0.best-NATIVE",
"office-id": "SPK",
"units": "ft",
"values": [
[
1772196300000,
613.7199999999999,
0
]
],
"vertical-datum-info": {
"office": "SPK",
"unit": "ft",
"location": "McGregor",
"native-datum": "NATIVE",
"elevation": 600,
"offsets": [
{
"estimate": true,
"to-datum": "NGVD-29",
"value": -0.6185
}
]
}
}
34 changes: 34 additions & 0 deletions cwms-data-api/src/test/resources/cwms/cda/api/timeseries/ts_create_other_datum.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"begin": "2026-02-27T12:30:34.182026Z",
"end": "2026-02-27T13:37:53.366357Z",
"name": "McGregor.Elev.Inst.~15Minutes.0.best-MSL1912",
"office-id": "SPK",
"units": "ft",
"values": [
[
1772196300000,
613.7199999999999,
0
]
],
"vertical-datum-info": {
"office": "SPK",
"unit": "ft",
"location": "McGregor",
"native-datum": "OTHER",
"elevation": 600,
"local-datum-name": "MSL1912",
"offsets": [
{
"estimate": false,
"to-datum": "NAVD-88",
"value": -0.771
},
{
"estimate": true,
"to-datum": "NGVD-29",
"value": -0.6185
}
]
}
}
Loading