Skip to content

Bug Fix: TimeSeries Profile Instance Time Window #1544

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

Merged
adamkorynta merged 2 commits into from
Jan 22, 2026
Merged

Bug Fix: TimeSeries Profile Instance Time Window #1544

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a878ce7
Fixed bug with time series profile time window. Start and end times w…
zack-rma Jan 21, 2026
be256ee
Updated API documentation to better represent previous/next parameter…
zack-rma Jan 21, 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
10 changes: 6 additions & 4 deletions ...api/src/main/java/cwms/cda/api/timeseriesprofile/TimeSeriesProfileInstanceController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,12 @@ public TimeSeriesProfileInstanceController(MetricRegistry metrics) {
+ " time series profile instance. Default is true"),
@OpenApiParam(name = END_TIME_INCLUSIVE, type = Boolean.class, description = "The end inclusive of the"
+ " time series profile instance. Default is true"),
@OpenApiParam(name = PREVIOUS, type = boolean.class, description = "Whether to include the previous "
+ " time window of the time series profile instance. Default is false"),
@OpenApiParam(name = NEXT, type = boolean.class, description = "Whether to include the next time window "
+ "of the time series profile instance. Default is false"),
@OpenApiParam(name = PREVIOUS, type = boolean.class, description = "Whether to include the data point "
+ "with the closest timestamp prior to the specified start of the time window for the time series "
+ "profile instance. Default is false"),
@OpenApiParam(name = NEXT, type = boolean.class, description = "Whether to include the data point with "
+ "the closest timestamp after the specified end of the time window for the time series profile "
+ "instance. Default is false"),
@OpenApiParam(name = MAX_VERSION, type = boolean.class, description = "Whether to use the max version"
+ " date of the time series profile instance. Default is false. If no version date is provided, and"
+ " maxVersion is false, the min version date will be used."),
Expand Down
21 changes: 10 additions & 11 deletions ...a-api/src/main/java/cwms/cda/data/dao/timeseriesprofile/TimeSeriesProfileInstanceDao.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
import static org.jooq.impl.DSL.using;
import static org.jooq.impl.DSL.val;

import com.google.common.flogger.FluentLogger;
import cwms.cda.api.errors.NotFoundException;
import cwms.cda.data.dao.JooqDao;
import cwms.cda.data.dto.CwmsDTOPaginated;
Expand All @@ -28,7 +29,6 @@
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import com.google.common.flogger.FluentLogger;
import org.jetbrains.annotations.NotNull;
import org.jooq.Condition;
import org.jooq.DSLContext;
Expand Down Expand Up @@ -240,8 +240,7 @@ public TimeSeriesProfileInstance retrieveTimeSeriesProfileInstance(CwmsId locati
final String[] parts = CwmsDTOPaginated.decodeCursor(page);

logger.atFine().log("Decoded cursor");
logger.atFinest().log("%s", lazy(()->
{
logger.atFinest().log("%s", lazy(() -> {
StringBuilder sb = new StringBuilder();
for (String part : parts) {
sb.append(part).append("\n");
Expand Down Expand Up @@ -325,20 +324,20 @@ public TimeSeriesProfileInstance retrieveTimeSeriesProfileInstance(CwmsId locati
// Add the time windows conditions depending on the inclusive flags
if (startInclusive && endInclusive) {
whereCondition = whereCondition
.and(VIEW_TSV2.FIRST_DATE_TIME.ge(Timestamp.from(startTime)))
.and(VIEW_TSV2.LAST_DATE_TIME.le(Timestamp.from(endTime)));
.and(VIEW_TSV2.DATE_TIME.ge(Timestamp.from(startTime)))
.and(VIEW_TSV2.DATE_TIME.le(Timestamp.from(endTime)));
} else if (!startInclusive && endInclusive) {
whereCondition = whereCondition
.and(VIEW_TSV2.FIRST_DATE_TIME.greaterThan(Timestamp.from(startTime)))
.and(VIEW_TSV2.LAST_DATE_TIME.le(Timestamp.from(endTime)));
.and(VIEW_TSV2.DATE_TIME.greaterThan(Timestamp.from(startTime)))
.and(VIEW_TSV2.DATE_TIME.le(Timestamp.from(endTime)));
} else if (startInclusive) {
whereCondition = whereCondition
.and(VIEW_TSV2.FIRST_DATE_TIME.ge(Timestamp.from(startTime)))
.and(VIEW_TSV2.LAST_DATE_TIME.lessThan(Timestamp.from(endTime)));
.and(VIEW_TSV2.DATE_TIME.ge(Timestamp.from(startTime)))
.and(VIEW_TSV2.DATE_TIME.lessThan(Timestamp.from(endTime)));
} else {
whereCondition = whereCondition
.and(VIEW_TSV2.FIRST_DATE_TIME.greaterThan(Timestamp.from(startTime)))
.and(VIEW_TSV2.LAST_DATE_TIME.lessThan(Timestamp.from(endTime)));
.and(VIEW_TSV2.DATE_TIME.greaterThan(Timestamp.from(startTime)))
.and(VIEW_TSV2.DATE_TIME.lessThan(Timestamp.from(endTime)));
}
Condition finalWhereCondition = whereCondition;

Expand Down
18 changes: 9 additions & 9 deletions cwms-data-api/src/test/java/cwms/cda/api/TimeSeriesProfileInstanceControllerIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1406,11 +1406,10 @@ void test_previous_next_TimeSeriesProfileInstance_Indexed(String format) throws
.queryParam(OFFICE, OFFICE_ID)
.queryParam(VERSION_DATE, "2024-07-09T12:00:00.00Z")
.queryParam(TIMEZONE, "UTC")
.queryParam(START, "2019-09-09T12:45:00.00Z")
.queryParam(START, "2019-09-09T12:49:00.00Z")
.queryParam(END, "2019-09-09T14:45:00.00Z")
.queryParam(START_TIME_INCLUSIVE, true)
.queryParam(PREVIOUS, true)
.queryParam(NEXT, true)
.queryParam(END_TIME_INCLUSIVE, true)
.queryParam(UNIT, units)
.when()
Expand Down Expand Up @@ -1444,7 +1443,7 @@ void test_previous_next_TimeSeriesProfileInstance_Indexed(String format) throws
.queryParam(VERSION_DATE, "2024-07-09T12:00:00.00Z")
.queryParam(TIMEZONE, "UTC")
.queryParam(START, "2019-09-09T12:45:00.00Z")
.queryParam(END, "2019-09-09T14:45:00.00Z")
.queryParam(END, "2019-09-09T13:15:00.00Z")
.queryParam(START_TIME_INCLUSIVE, true)
.queryParam(END_TIME_INCLUSIVE, true)
.queryParam(NEXT, true)
Expand All @@ -1465,13 +1464,13 @@ void test_previous_next_TimeSeriesProfileInstance_Indexed(String format) throws
.body("time-series-profile.key-parameter",
equalTo(tspInstance.getTimeSeriesProfile().getKeyParameter()))
.body("time-series-profile.parameter-list.size()", equalTo(2))
.body("time-series-list.size()", equalTo(26))
.body("time-series-list.size()", equalTo(25))
.body("time-series-list[\"1568033937000\"].size()", equalTo(2))
.body("time-series-list[\"1568033750000\"].size()", equalTo(2))
.body("time-series-list[\"1568033787000\"].size()", equalTo(2))
;

// Retrieve instance with both next and previous set to false (should return the first page)
// Retrieve instance with both next and previous set to false and a small time window (should cause data not found error)
given()
.log().ifValidationFails(LogDetail.ALL, true)
.accept(format)
Expand All @@ -1480,11 +1479,12 @@ void test_previous_next_TimeSeriesProfileInstance_Indexed(String format) throws
.queryParam(OFFICE, OFFICE_ID)
.queryParam(VERSION_DATE, "2024-07-09T12:00:00.00Z")
.queryParam(TIMEZONE, "UTC")
.queryParam(START, "2019-09-09T12:45:00.00Z")
.queryParam(END, "2019-09-09T14:45:00.00Z")
.queryParam(START, "2019-09-09T12:50:00.00Z")
.queryParam(END, "2019-09-09T13:10:00.00Z")
.queryParam(START_TIME_INCLUSIVE, true)
.queryParam(END_TIME_INCLUSIVE, true)
.queryParam(PREVIOUS, true)
.queryParam(PREVIOUS, false)
.queryParam(NEXT, false)
.queryParam(UNIT, units)
.when()
.redirects().follow(true)
Expand All @@ -1502,7 +1502,7 @@ void test_previous_next_TimeSeriesProfileInstance_Indexed(String format) throws
.body("time-series-profile.key-parameter",
equalTo(tspInstance.getTimeSeriesProfile().getKeyParameter()))
.body("time-series-profile.parameter-list.size()", equalTo(2))
.body("time-series-list.size()", equalTo(26))
.body("time-series-list.size()", equalTo(18))
.body("time-series-list[\"1568033937000\"].size()", equalTo(2))
.body("time-series-list[\"1568033750000\"].size()", equalTo(2))
.body("time-series-list[\"1568033787000\"].size()", equalTo(2))
Expand Down
Loading