Skip to content

fix paging for rating spec getAll endpoint #1578

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 6 commits into from
Feb 12, 2026
Merged

fix paging for rating spec getAll endpoint #1578

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
492f82c
fix paging for rating spec getAll endpoint
adamkorynta Feb 11, 2026
aec8034
also check ".*" in regex
adamkorynta Feb 11, 2026
fef7fe3
remove incorrect comment
adamkorynta Feb 11, 2026
7a3f613
update query to use multi-set so rows are one-to-one retrieved specs
adamkorynta Feb 11, 2026
21bb55f
add spec pagination integration test
adamkorynta Feb 11, 2026
053bca0
fix test now that more than one page is returned
adamkorynta Feb 12, 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
2 changes: 1 addition & 1 deletion cwms-data-api/src/main/java/cwms/cda/api/rating/RatingSpecController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ public class RatingSpecController implements CrudHandler {

private final MetricRegistry metrics;

private static final int DEFAULT_PAGE_SIZE = 100;
static final int DEFAULT_PAGE_SIZE = 100;

private final Histogram requestResultSize;

Expand Down
3 changes: 3 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 @@ -251,6 +251,9 @@ protected void withDefaultDatum(@Nullable VerticalDatum targetDatum, DSLContext
* an easy to read manner without having to worry about the syntax.
*/
public static Condition caseInsensitiveLikeRegex(Field<String> field, String regex) {
if("*".equals(regex) || ".*".equals(regex)) {
return DSL.noCondition();
}
return new CustomCondition() {
@Override
public void accept(org.jooq.Context<?> ctx) {
Expand Down
8 changes: 6 additions & 2 deletions cwms-data-api/src/main/java/cwms/cda/data/dao/RatingAdapter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,10 +104,14 @@ private static TransitionalRating toTransitional(
withAbstractFields(builder, rating);

String[] evaluationStrings = rating.getEvaluationStrings();
builder.withEvaluations(Arrays.asList(evaluationStrings));
if(evaluationStrings != null) {
builder.withEvaluations(Arrays.asList(evaluationStrings));
}

String[] conditionStrings = rating.getConditionStrings();
builder.withConditions(Arrays.asList(conditionStrings));
if(conditionStrings != null) {
builder.withConditions(Arrays.asList(conditionStrings));
}

List<String> ratingSpecIds = new ArrayList<>();
SourceRating[] sourceRatings = rating.getSourceRatings();
Expand Down
275 changes: 94 additions & 181 deletions cwms-data-api/src/main/java/cwms/cda/data/dao/RatingSpecDao.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
import static com.google.common.flogger.LazyArgs.lazy;

import static cwms.cda.data.dto.rating.RatingSpec.Builder.buildIndependentRoundingSpecs;
import static java.util.Comparator.comparing;
import static java.util.stream.Collectors.toList;

import com.fasterxml.jackson.core.JsonProcessingException;
Expand All @@ -48,15 +49,14 @@
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Calendar;
import java.util.Collection;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.NavigableMap;
import java.util.NavigableSet;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.TimeZone;
import java.util.TreeMap;
import java.util.TreeSet;
Expand Down Expand Up @@ -114,69 +114,8 @@ public RatingSpecDao(DSLContext dsl) {
super(dsl);
}

public Collection<RatingSpec> retrieveRatingSpecs(String office, String specIdMask) {

AV_RATING_SPEC specView = AV_RATING_SPEC.AV_RATING_SPEC;
AV_RATING ratView = AV_RATING.AV_RATING;

// We don't want to also check AV_RATING_SPEC.ALIASED_ITEM b/c we
// don't care whether the specs returned are an alias or not.
// We do want to exclude the aliased ratings b/c we only want one
// copy of each matching rating.

Condition condition = ratView.ALIASED_ITEM.isNull();

if (office != null) {
condition = condition.and(specView.OFFICE_ID.eq(office));
}

if (specIdMask != null) {
Condition likeRegex = JooqDao.caseInsensitiveLikeRegex(specView.RATING_ID, specIdMask);
condition = condition.and(likeRegex);
}

ResultQuery<? extends Record> query = dsl.select(specView.RATING_SPEC_CODE,
specView.OFFICE_ID, specView.RATING_ID, specView.TEMPLATE_ID,
specView.LOCATION_ID, specView.VERSION, specView.SOURCE_AGENCY,
specView.ACTIVE_FLAG, specView.AUTO_UPDATE_FLAG,
specView.AUTO_ACTIVATE_FLAG,
specView.AUTO_MIGRATE_EXT_FLAG, specView.IND_ROUNDING_SPECS,
specView.DEP_ROUNDING_SPEC, specView.DATE_METHODS, specView.DESCRIPTION,
ratView.RATING_SPEC_CODE, ratView.EFFECTIVE_DATE)
.from(specView)
.leftOuterJoin(ratView)
.on(specView.RATING_SPEC_CODE.eq(ratView.RATING_SPEC_CODE))
.where(condition)
.fetchSize(DEFAULT_FETCH_SIZE);

logger.atFine().log("%s", lazy(() -> query.getSQL(ParamType.INLINED)));

Map<RatingSpec, List<ZonedDateTime>> map = new LinkedHashMap<>();
try (Stream<? extends Record> stream = query.fetchStream()) {
stream.forEach(rec -> {
RatingSpec template = buildRatingSpec(rec);

Timestamp effectiveDate = rec.get(ratView.EFFECTIVE_DATE);
ZonedDateTime effective = toZdt(effectiveDate);

List<ZonedDateTime> list = map.computeIfAbsent(template, k -> new ArrayList<>());
if (effective != null) {
list.add(effective);
}
});
}

return map.entrySet().stream()
.map(entry -> new RatingSpec.Builder()
.fromRatingSpec(entry.getKey())
.withEffectiveDates(entry.getValue())
.build())
.collect(Collectors.toCollection(LinkedHashSet::new));
}


public RatingSpecs retrieveRatingSpecs(String cursor, int pageSize, String office,
String specIdMask) {
@NotNull
public RatingSpecs retrieveRatingSpecs(String cursor, int pageSize, String office, String specIdMask) {
Integer total = null;
int offset = 0;

Expand All @@ -196,145 +135,119 @@ public RatingSpecs retrieveRatingSpecs(String cursor, int pageSize, String offic
}
}

Set<RatingSpec> retval = getRatingSpecs(office, specIdMask, offset, pageSize);

RatingSpecs.Builder builder = new RatingSpecs.Builder(offset, pageSize, total);
builder.withSpecs(new ArrayList<>(retval));
return builder.build();
}

@NotNull
public Set<RatingSpec> getRatingSpecs(String office, String specIdMask, int firstRow,
int pageSize) {
Set<RatingSpec> retVal;

AV_RATING_SPEC specView = AV_RATING_SPEC.AV_RATING_SPEC;
AV_RATING ratView = AV_RATING.AV_RATING;

// We don't want to also check AV_RATING_SPEC.ALIASED_ITEM b/c we
// don't care whether the specs returned are an alias or not.
// We do want to exclude the aliased ratings b/c we only want one
// copy of each matching rating.
Condition condition = ratView.ALIASED_ITEM.isNull();
// Conditions that define WHICH SPECS match
Condition specCondition = specView.TEMPLATE_ID.notLike("%Stage-Offset%")
.and(specView.TEMPLATE_ID.notLike("%Stage-Shift%"))
.and(specView.ALIASED_ITEM.isNull());

if (office != null) {
condition = condition.and(specView.OFFICE_ID.eq(office));
specCondition = specCondition.and(specView.OFFICE_ID.eq(office.toUpperCase()));
}

if (specIdMask != null) {
Condition maskRegex = JooqDao.caseInsensitiveLikeRegex(specView.RATING_ID, specIdMask);
condition = condition.and(maskRegex);
specCondition = specCondition.and(maskRegex);
}

ResultQuery<? extends Record> query = dsl.select(specView.RATING_SPEC_CODE,
specView.OFFICE_ID, specView.RATING_ID, specView.DATE_METHODS,
specView.TEMPLATE_ID, specView.LOCATION_ID, specView.VERSION,
specView.SOURCE_AGENCY, specView.ACTIVE_FLAG, specView.AUTO_UPDATE_FLAG,
specView.AUTO_ACTIVATE_FLAG, specView.AUTO_MIGRATE_EXT_FLAG,
specView.IND_ROUNDING_SPECS, specView.DEP_ROUNDING_SPEC,
specView.DESCRIPTION, specView.ALIASED_ITEM,
ratView.RATING_SPEC_CODE, ratView.EFFECTIVE_DATE)
.from(specView)
.leftOuterJoin(ratView)
.on(specView.RATING_SPEC_CODE.eq(ratView.RATING_SPEC_CODE))
.where(condition)
.orderBy(specView.OFFICE_ID, specView.TEMPLATE_ID, ratView.RATING_ID,
ratView.EFFECTIVE_DATE)
.limit(pageSize)
.offset(firstRow);

logger.atFine().log("%s", lazy(() -> query.getSQL(ParamType.INLINED)));

Map<RatingSpec, List<ZonedDateTime>> map = new LinkedHashMap<>();
try (Stream<? extends Record> stream = query.fetchStream()) {
stream.forEach(rec -> {
RatingSpec template = buildRatingSpec(rec);

Timestamp effectiveDate = rec.get(ratView.EFFECTIVE_DATE);
ZonedDateTime effective = toZdt(effectiveDate);

List<ZonedDateTime> list = map.computeIfAbsent(template, k -> new ArrayList<>());
if (effective != null) {
list.add(effective);
}
});
}

retVal = map.entrySet().stream()
.map(entry -> new RatingSpec.Builder()
.fromRatingSpec(entry.getKey())
.withEffectiveDates(entry.getValue())
.build())
.collect(Collectors.toCollection(LinkedHashSet::new));
return retVal;
}


public Optional<RatingSpec> retrieveRatingSpec(String office, String specId) {
Set<RatingSpec> retVal;

AV_RATING_SPEC specView = AV_RATING_SPEC.AV_RATING_SPEC;
AV_RATING ratView = AV_RATING.AV_RATING;

Condition condition = ratView.ALIASED_ITEM.isNull();

if (specId != null) {
condition = condition.and(specView.RATING_ID.eq(specId));
if (total == null) {
total = dsl.fetchCount(specView, specCondition);
}

if (office != null) {
condition = condition.and(specView.OFFICE_ID.eq(office));
}
var specPage = dsl
.select(
specView.RATING_SPEC_CODE,
specView.OFFICE_ID, specView.RATING_ID, specView.DATE_METHODS,
specView.TEMPLATE_ID, specView.LOCATION_ID, specView.VERSION,
specView.SOURCE_AGENCY, specView.ACTIVE_FLAG, specView.AUTO_UPDATE_FLAG,
specView.AUTO_ACTIVATE_FLAG, specView.AUTO_MIGRATE_EXT_FLAG,
specView.IND_ROUNDING_SPECS, specView.DEP_ROUNDING_SPEC,
specView.DESCRIPTION, specView.ALIASED_ITEM
)
.from(specView)
.where(specCondition)
.orderBy(specView.OFFICE_ID, specView.RATING_ID)
.limit(pageSize)
.offset(offset)
.asTable("spec_page");

Field<Long> spSpecCode = specPage.field(specView.RATING_SPEC_CODE);
Field<String> spOfficeId = specPage.field(specView.OFFICE_ID);
Field<String> spRatingId = specPage.field(specView.RATING_ID);

Field<List<ZonedDateTime>> effectiveDates =
DSL.multiset(
dsl.select(ratView.EFFECTIVE_DATE)
.from(ratView)
.where(ratView.RATING_SPEC_CODE.eq(spSpecCode))
.and(ratView.ALIASED_ITEM.isNull())
.orderBy(ratView.EFFECTIVE_DATE)
)
.convertFrom(r ->
r.getValues(ratView.EFFECTIVE_DATE).stream()
.map(RatingSpecDao::toZdt)
.filter(Objects::nonNull)
.collect(Collectors.toList())
)
.as("effective_dates");

ResultQuery<? extends Record> query = dsl.select(
specView.RATING_SPEC_CODE,
specView.OFFICE_ID, specView.RATING_ID, specView.TEMPLATE_ID,
specView.LOCATION_ID, specView.VERSION, specView.SOURCE_AGENCY,
specView.ACTIVE_FLAG, specView.AUTO_UPDATE_FLAG,
specView.AUTO_ACTIVATE_FLAG, specView.AUTO_MIGRATE_EXT_FLAG,
specView.IND_ROUNDING_SPECS, specView.DEP_ROUNDING_SPEC,
specView.DATE_METHODS, specView.DESCRIPTION,
ratView.RATING_SPEC_CODE, ratView.EFFECTIVE_DATE
)
.from(specView)
.leftOuterJoin(ratView)
.on(specView.RATING_SPEC_CODE.eq(ratView.RATING_SPEC_CODE))
.where(condition)
.orderBy(specView.OFFICE_ID, specView.RATING_ID, ratView.EFFECTIVE_DATE)
.fetchSize(DEFAULT_FETCH_SIZE);
spSpecCode,
spOfficeId,
spRatingId,
specPage.field(specView.DATE_METHODS),
specPage.field(specView.TEMPLATE_ID),
specPage.field(specView.LOCATION_ID),
specPage.field(specView.VERSION),
specPage.field(specView.SOURCE_AGENCY),
specPage.field(specView.ACTIVE_FLAG),
specPage.field(specView.AUTO_UPDATE_FLAG),
specPage.field(specView.AUTO_ACTIVATE_FLAG),
specPage.field(specView.AUTO_MIGRATE_EXT_FLAG),
specPage.field(specView.IND_ROUNDING_SPECS),
specPage.field(specView.DEP_ROUNDING_SPEC),
specPage.field(specView.DESCRIPTION),
specPage.field(specView.ALIASED_ITEM),
effectiveDates
)
.from(specPage)
.orderBy(spOfficeId, spRatingId)
.fetchSize(DEFAULT_FETCH_SIZE);

logger.atFine().log("%s", lazy(() -> query.getSQL(ParamType.INLINED)));

Map<RatingSpec, List<ZonedDateTime>> map = new LinkedHashMap<>();
try (Stream<? extends Record> stream = query.fetchStream()) {
stream.forEach(rec -> {
List<RatingSpec> specs = query.fetch()
.stream()
.map(rec -> {
RatingSpec template = buildRatingSpec(rec);
List<ZonedDateTime> dates = rec.get(effectiveDates);
return new RatingSpec.Builder()
.fromRatingSpec(template)
.withEffectiveDates(dates == null ? List.of() : dates)
.build();
})
.collect(toList());

Timestamp effectiveDate = rec.get(ratView.EFFECTIVE_DATE);
ZonedDateTime effective = toZdt(effectiveDate);

List<ZonedDateTime> list = map.computeIfAbsent(template, k -> new ArrayList<>());
if (effective != null) {
list.add(effective);
}
});
}
RatingSpecs.Builder builder = new RatingSpecs.Builder(offset, pageSize, total);
builder.withSpecs(specs);
return builder.build();
}

retVal = map.entrySet().stream()
.map(entry -> new RatingSpec.Builder()
.fromRatingSpec(entry.getKey())
.withEffectiveDates(entry.getValue())
.build())
.collect(Collectors.toCollection(LinkedHashSet::new));

// There should only be one key in the map
if (retVal.size() > 1) {
throw new IllegalStateException("More than one rating spec found for id: " + specId);
public Optional<RatingSpec> retrieveRatingSpec(String office, String specId) {
RatingSpecs ratingSpecs = retrieveRatingSpecs(null, 1, office, specId);
List<RatingSpec> specs = ratingSpecs.getSpecs();
if(specs.size() > 1) {
throw new IllegalStateException("More than one rating spec found for specId: " + specId);
} else if(specs.isEmpty()) {
return Optional.empty();
} else {
return Optional.of(specs.get(0));
}
}

return retVal.stream().findFirst();
}

public static ZonedDateTime toZdt(final Timestamp time) {
if (time != null) {
return ZonedDateTime.ofInstant(time.toInstant(), ZoneId.of("UTC"));
Expand Down
2 changes: 1 addition & 1 deletion cwms-data-api/src/main/java/cwms/cda/data/dto/rating/RatingSpecs.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ public static class Builder {
private int offset;
private int pageSize;
private Integer total;
private List<RatingSpec> specs;
private List<RatingSpec> specs = new ArrayList<>();

public Builder() {
}
Expand Down
Loading
Loading