FlexMeasures / flexmeasures / 30497297146

83%

Build Type

push

github

Committed by web-flow

Commit Message

fix: let annotation searches filter by belief time (#2367)

* fix: let annotation searches filter by belief time

Annotations carry a belief_time, but nothing could filter on it: the
annotation queries had no belief-time criterion, search_annotations took
no belief-time arguments, and the chart_annotations endpoint declared
beliefs_after/beliefs_before query parameters that were parsed and then
dropped. Replaying a chart therefore showed annotations that were only
recorded later, e.g. breach alerts appearing before the planning window
that produced them.

Annotations without a belief time are never filtered out: a missing
belief time means the recording moment is unknown, not that it lies in
the future.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Signed-off-by: F.N. Claessen <felix@seita.nl>

* fix: wire belief-time filtering into the asset chart_annotations endpoint, add tests

GET /api/v3_0/assets/<id>/chart_annotations (added in PR #2312) accepted no
beliefs_after/beliefs_before query parameters at all, even though the sensor
counterpart in flexmeasures/api/dev/sensors.py declared them (and, before this
branch, silently dropped them). GenericAsset.search_annotations already
supports beliefs_after/beliefs_before after the previous commit, so wire the
same query parameters through this endpoint.

Also add test coverage:
- flexmeasures/data/tests/test_annotations.py: search_annotations on account,
  asset and sensor excludes an annotation recorded after beliefs_before, while
  keeping annotations with belief_time=None regardless of the filter.
- flexmeasures/api/v3_0/tests/test_assets_api.py: the chart_annotations
  endpoint applies the same beliefs_before filtering end-to-end.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Signed-off-by: F.N. Claessen <felix@seita.nl>

* docs: reference PR #2367 in the annotation belief-time changelog entry

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Signed-off-by: F.N. Claessen <felix@s... (continued)

Coverage Stats

94 of 99 new or added lines in 8 files covered. (94.95%)

1 existing line in 1 file now uncovered.

16153 of 19445 relevant lines covered (83.07%)

0.83 hits per line