feat: search filter on sensor API #1191

joshuaunity · 2024-09-20T16:44:52Z

Description

This PR adds the following to the sensor API

Pagination
Search functionality

Look & Feel

How to test

Steps to test it or name of the tests functions.

Go to the assets page and click any of your assets that has some sensors

Further Improvements

None

Related Items

This PR closes the first task in #1076

I agree to contribute to the project under Apache 2 License.
To the best of my knowledge, the proposed patch is not based on code under GPL or other license that is incompatible with FlexMeasures

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

nhoening

First batch of comments, one idea about asking for asset sensors still not clear to me either.

flexmeasures/data/services/sensors.py

flexmeasures/ui/templates/crud/asset.html

flexmeasures/api/v3_0/sensors.py

- relocated SearchField to dedicated file - worked on event resolution formating Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

…ring Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

nhoening

Some quick observations

flexmeasures/api/v3_0/sensors.py

flexmeasures/api/v3_0/assets.py

flexmeasures/ui/templates/crud/asset.html

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

nhoening

We saw today that there are no tests yet for the sensor index endpoint. Let's add some, both with and without pagination.

flexmeasures/api/v3_0/assets.py

flexmeasures/ui/templates/crud/asset.html

flexmeasures/api/v3_0/tests/test_assets_api.py

flexmeasures/data/queries/sensors.py

nhoening · 2024-09-26T11:49:15Z

One more thing: I found a query for asset sensors which the asset view is making, and which we don't have to do anymore now (I guess, please confirm).

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

joshuaunity · 2024-09-26T12:37:17Z

One more thing: I found a query for asset sensors which the asset view is making, and which we don't have to do anymore now (I guess, please confirm).

I think this is the code that was populating the sensors attribute/property previously being used: for sensor in asset.sensors in the asset page

Since that page is being feed by a API now I don't think its needed anymore

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

nhoening

I asked for tests for the index endpoint. Right now, we are only testing the new simpler endpoint.

flexmeasures/api/v3_0/tests/test_assets_api.py

flexmeasures/ui/templates/base.html

…ntend Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

nhoening

A bit more detail in testing, please.

flexmeasures/api/v3_0/tests/test_sensors_api.py

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

nhoening

This test needs work.

flexmeasures/api/v3_0/tests/test_sensors_api.py

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

nhoening

I still think the test need one iteration.

documentation/changelog.rst

flexmeasures/api/v3_0/tests/test_sensors_api.py

flexmeasures/api/v3_0/assets.py

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

nhoening

Thanks, much better. Almost there!

flexmeasures/api/v3_0/tests/test_sensors_api.py

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

flexmeasures/api/v3_0/tests/test_sensors_api.py

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

nhoening

Thanks!

nhoening

Thanks!

We discussed that I found how this endpoint needs to be enhanced even further, so we can get sensors of an asset and its sub-assets, but I will open a follow-up PR, so that this one can already be on main and serve ongoing development!

* feat: search filter on sensor API Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com> * feat: sensor API pagintion and search Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com> * refactor: reduce code repitition and code size Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com> * refactor: request changes - relocated SearchField to dedicated file - worked on event resolution formating Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com> * feat: api to fetch all sensors under an asset Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com> * feat: added filter feature for sensor table, both name and unit filtering Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com> * feat: unit filter features on get sensors API Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com> * refactor: asset sensor and sensors API changes Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com> * feat: test case for asset_sensors API Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com> * chore: few changes variable namings and import arrangement Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com> * refactor: updated testcase with more checks and removed redundant code Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com> * chore: little changes on test(waiting for comment resolution) Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com> * chore: moved formatResolution func to base.html Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com> * refactor: changes to asset sensors API and ISO formatter logic on forntend Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com> * chore: removed hard coded asset ID in asset sensors test case Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com> * feat: test to get all sensors Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com> * fix: fix wrong imports Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com> * refactor: expandd test cases for get sensors Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com> * refactor: expanded test case Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com> * chore: added to changelog Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com> * chore: updated change log Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com> * refactor: dynamic expected results for test case Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com> * refactor: dynamic sensor name for test case Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com> * chore: simplified testcase Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com> --------- Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com> Co-authored-by: Nicolas Höning <nicolas@seita.nl> (cherry picked from commit e8444d0)

feat: search filter on sensor API

4dc4e04

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

joshuaunity self-assigned this Sep 23, 2024

joshuaunity and others added 2 commits September 24, 2024 13:15

Merge branch 'main' into feat-sensors-filters

4ab4263

feat: sensor API pagintion and search

92c58a0

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

joshuaunity requested review from nhoening and Flix6x September 24, 2024 15:01

refactor: reduce code repitition and code size

658b525

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

nhoening requested changes Sep 24, 2024

View reviewed changes

joshuaunity added 4 commits September 25, 2024 11:48

refactor: request changes

2114eca

- relocated SearchField to dedicated file - worked on event resolution formating Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

feat: api to fetch all sensors under an asset

1930365

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

feat: added filter feature for sensor table, both name and unit filte…

ecd3966

…ring Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

feat: unit filter features on get sensors API

2a37dde

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

joshuaunity requested a review from nhoening September 25, 2024 15:20

nhoening requested changes Sep 25, 2024

View reviewed changes

flexmeasures/api/v3_0/sensors.py Show resolved Hide resolved

flexmeasures/api/v3_0/assets.py Outdated Show resolved Hide resolved

flexmeasures/ui/templates/crud/asset.html Outdated Show resolved Hide resolved

joshuaunity added 2 commits September 25, 2024 22:02

refactor: asset sensor and sensors API changes

f8ebe9b

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

feat: test case for asset_sensors API

5d9b547

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

joshuaunity requested a review from nhoening September 25, 2024 21:45

nhoening requested changes Sep 26, 2024

View reviewed changes

chore: few changes variable namings and import arrangement

e93b1fb

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

joshuaunity added 3 commits September 26, 2024 14:24

refactor: updated testcase with more checks and removed redundant code

d80f1ba

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

chore: little changes on test(waiting for comment resolution)

461f1d2

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

chore: moved formatResolution func to base.html

dc3e8df

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

joshuaunity requested a review from nhoening September 27, 2024 08:25

nhoening requested changes Sep 27, 2024

View reviewed changes

flexmeasures/api/v3_0/tests/test_assets_api.py Outdated Show resolved Hide resolved

flexmeasures/api/v3_0/tests/test_assets_api.py Outdated Show resolved Hide resolved

flexmeasures/ui/templates/base.html Outdated Show resolved Hide resolved

joshuaunity added 2 commits September 27, 2024 22:42

refactor: changes to asset sensors API and ISO formatter logic on for…

807f0d0

…ntend Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

chore: removed hard coded asset ID in asset sensors test case

e92a8dd

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

joshuaunity requested a review from nhoening September 28, 2024 20:23

fix: fix wrong imports

dbd300b

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

nhoening requested changes Sep 30, 2024

View reviewed changes

flexmeasures/api/v3_0/tests/test_sensors_api.py Show resolved Hide resolved

flexmeasures/api/v3_0/tests/test_sensors_api.py Show resolved Hide resolved

refactor: expandd test cases for get sensors

b08901d

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

joshuaunity requested a review from nhoening October 1, 2024 07:16

joshuaunity added the API label Oct 1, 2024

nhoening requested changes Oct 1, 2024

View reviewed changes

refactor: expanded test case

651006a

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

joshuaunity requested a review from nhoening October 1, 2024 17:49

chore: added to changelog

5c7f797

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

nhoening requested changes Oct 2, 2024

View reviewed changes

chore: updated change log

e420fa1

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

joshuaunity requested review from nhoening and removed request for nhoening October 3, 2024 11:46

refactor: dynamic expected results for test case

646de9c

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

nhoening requested changes Oct 3, 2024

View reviewed changes

flexmeasures/api/v3_0/tests/test_sensors_api.py Outdated Show resolved Hide resolved

flexmeasures/api/v3_0/tests/test_sensors_api.py Outdated Show resolved Hide resolved

refactor: dynamic sensor name for test case

f4f5bf6

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

joshuaunity requested a review from nhoening October 4, 2024 12:16

Merge branch 'main' into feat-sensors-filters

c5fedaf

nhoening requested changes Oct 8, 2024

View reviewed changes

flexmeasures/api/v3_0/tests/test_sensors_api.py Outdated Show resolved Hide resolved

chore: simplified testcase

4f987b2

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

joshuaunity requested a review from nhoening October 8, 2024 17:54

joshuaunity and others added 3 commits October 8, 2024 19:06

Merge branch 'main' into feat-sensors-filters

289e78b

Merge branch 'main' into feat-sensors-filters

e8d4ad8

Merge branch 'main' into feat-sensors-filters

fe5b6fa

nhoening approved these changes Oct 11, 2024

View reviewed changes

nhoening merged commit e8444d0 into main Oct 11, 2024
9 checks passed

nhoening deleted the feat-sensors-filters branch October 11, 2024 15:24

nhoening mentioned this pull request Oct 11, 2024

Let /sensors index endpoint limit search to an asset (and sub-assets) #1209

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: search filter on sensor API #1191

feat: search filter on sensor API #1191

joshuaunity commented Sep 20, 2024 •

edited

Loading

nhoening left a comment

nhoening left a comment

nhoening left a comment

nhoening commented Sep 26, 2024

joshuaunity commented Sep 26, 2024

nhoening left a comment

nhoening left a comment

nhoening left a comment

nhoening left a comment

nhoening left a comment

nhoening left a comment

nhoening left a comment

feat: search filter on sensor API #1191

feat: search filter on sensor API #1191

Conversation

joshuaunity commented Sep 20, 2024 • edited Loading

Description

Look & Feel

How to test

Further Improvements

Related Items

nhoening left a comment

Choose a reason for hiding this comment

nhoening left a comment

Choose a reason for hiding this comment

nhoening left a comment

Choose a reason for hiding this comment

nhoening commented Sep 26, 2024

joshuaunity commented Sep 26, 2024

nhoening left a comment

Choose a reason for hiding this comment

nhoening left a comment

Choose a reason for hiding this comment

nhoening left a comment

Choose a reason for hiding this comment

nhoening left a comment

Choose a reason for hiding this comment

nhoening left a comment

Choose a reason for hiding this comment

nhoening left a comment

Choose a reason for hiding this comment

nhoening left a comment

Choose a reason for hiding this comment

joshuaunity commented Sep 20, 2024 •

edited

Loading