feat: Cleanup of stale sensor references

[joshuaunity]

Description

This PR implements a cleanup feature used to clean up sensor references on delete. Now, if a sensor is deleted, all its references in flex-config and sensors_to_show are deleted as well.

Look & Feel

None

How to test

1. Look for or intentionally add a sensor to any of the options (flex-config or sensors to show)
2. Delete that sensor, and confirm that its references are cleared in any of the above options you placed it in.

Further Improvements

None

Related Items

This PR closes #2099

Sign-off

• 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

[read-the-docs-community]

Documentation build overview

📚 flexmeasures | 🛠️ Build #32270626 | 📁 Comparing b084fb2 against latest (df83ec3)

  🔍 Preview build  

10 files changed · ± 9 modified · - 1 deleted

± Modified

• changelog.html
• configuration.html
• genindex.html
• index.html
• _autosummary/flexmeasures.api.v3_0.sensors.html
• _autosummary/flexmeasures.data.services.sensors.html
• api/introduction.html
• api/v3_0.html
• host/installation.html

- Deleted

• dev/scripting.html

[nhoening]

Two larger comments:

• cleanup_sensor_references_in_assets() could be called from a more central place in data/services/sensors.oy, I believe we have a until function to delete sensors there, or not?
• we can assume that postgres is used, so some code can go.

[joshuaunity]

cleanup_sensor_references_in_assets() could be called from a more central place in data/services/sensors.oy, I believe we have a until function to delete sensors there, or not?

ill check

[joshuaunity]

cleanup_sensor_references_in_assets() could be called from a more central place in data/services/sensors.py, I believe we have a until function to delete sensors there, or not?

from my checks, no place solely handles the deletion of sensors in data/services/sensors.py,

[nhoening]

I see. I was thinking of services/generic_assets.py, where I refactored a bit a few months ago.
Let's also start doing this here. We can create a common delete_sensor() method and a create_sensor() method, which both do the same, also write the same audit log message. And of course add your new logic to the deletion one.

• The CLI for deletion has a confirmation dialogue, that can stay there of course
• I just saw the API endpoint for deleting a sensor is writing the same audit log entry twice - good time to fix that.

[nhoening]

@joshuaunity I just noticed that I had written the same problem into an issue before: #2062

There I also proposed the new service method. And Felix suggested to ceate audit logs when removing the references - that makes some sense, too.

[joshuaunity]

@joshuaunity I just noticed that I had written the same problem into an issue before: #2062

There I also proposed the new service method. And Felix suggested to ceate audit logs when removing the references - that makes some sense, too.

Following up on this, there is now:

1. A central delete_sensor
2. Logging sensor cleanups