Move common functionality to destination base class #936

hmpf · 2024-11-11T14:24:06Z

Best reviewed per file.

src/argus/notificationprofile/media/base.py

codecov-commenter · 2024-12-03T08:58:21Z

Codecov Report

Attention: Patch coverage is 69.82249% with 51 lines in your changes missing coverage. Please review.

Project coverage is 76.70%. Comparing base (eaa3a25) to head (713e5d5).
Report is 2 commits behind head on master.

Files with missing lines	Patch %	Lines
src/argus/notificationprofile/media/base.py	62.10%	36 Missing ⚠️
src/argus/notificationprofile/media/email.py	80.95%	8 Missing ⚠️
src/argus/notificationprofile/media/__init__.py	42.85%	4 Missing ⚠️
src/argus/notificationprofile/serializers.py	89.47%	2 Missing ⚠️
...rc/argus/notificationprofile/media/sms_as_email.py	83.33%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #936      +/-   ##
==========================================
- Coverage   77.36%   76.70%   -0.66%     
==========================================
  Files         141      141              
  Lines        5548     5667     +119     
==========================================
+ Hits         4292     4347      +55     
- Misses       1256     1320      +64

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

src/argus/notificationprofile/media/base.py

src/argus/notificationprofile/media/email.py

src/argus/notificationprofile/media/base.py

src/argus/notificationprofile/serializers.py

src/argus/notificationprofile/media/email.py

sonarqubecloud · 2024-12-04T13:53:16Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

johannaengland

I just checked and we don't have a test for trying to PATCH update with medium being empty, that should be added, I think then it would be clearer if the changes work or not

We do have tests for when trying to change the medium that that will lead to an error

docs/integrations/notifications/writing-notification-plugins.rst

src/argus/notificationprofile/media/base.py

src/argus/notificationprofile/serializers.py

hmpf · 2024-12-06T10:50:29Z

I just checked and we don't have a test for trying to PATCH update with medium being empty, that should be added, I think then it would be clearer if the changes work or not

We do have tests for when trying to change the medium that that will lead to an error

We are now way out of scope for a refactor.

I guess the underlying problem is that we cannot lookup and change destinations of a specific media type directly, as part of the url of the endpoint. If we could, we would never need bother with media in the update-serializer.

johannaengland · 2024-12-06T11:13:03Z

I just checked and we don't have a test for trying to PATCH update with medium being empty, that should be added, I think then it would be clearer if the changes work or not
We do have tests for when trying to change the medium that that will lead to an error

We are now way out of scope for a refactor.

Yes, I agree, I can do this in another PR, but that would have to merged before this then, because it would show if the functionality is staying the same

hmpf · 2024-12-06T11:18:48Z

I don't think it is wise to stress with finishing this PR this week anymore, so start on the patch-PR next week.

src/argus/notificationprofile/media/base.py

hmpf · 2025-01-15T07:54:40Z

We could change the __str__ function of DestinationConfig change to use the get_label function in general. Then we can simplify this

Originally posted by @johannaengland in #1118 (comment)

stveit · 2025-01-15T14:58:15Z

I got stuff mostly working with this but the main problem is extracting errors to show in the related fields

src/argus/notificationprofile/media/base.py

sonarqubecloud · 2025-01-24T11:30:27Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

stveit

Sum comments

src/argus/notificationprofile/media/base.py

stveit · 2025-01-28T05:43:47Z

src/argus/notificationprofile/media/base.py

+        return {}
+
+    @classmethod
+    def raise_if_not_deletable(cls, destination: DestinationConfig) -> NoneType:


Pretty sure None should be used as return type over NoneType, but this seems to be a relic from the past and not really introduced in this PR

src/argus/notificationprofile/media/base.py

johannaengland · 2025-01-29T12:02:45Z

src/argus/notificationprofile/media/base.py


    @classmethod
-    @abstractmethod
    def has_duplicate(cls, queryset: QuerySet, settings: dict) -> bool:


I think what @stveit mentioned in #1161 (review) could be avoided by simply updating the has_duplicate method to also take the instance and check, that the entered data is a duplicate of another destination than the given instance

There need not exist an instance yet.

In that case instance can be empty and we know that if the settings exist somewhere else that it definitely is a duplicate

We have that already, no? Smaller teaspoon, please.

Yes, we have the check that assures that no duplicate destinations are posted, but as @stveit said in his review - this leads to that error showing when updating a destination without changing the settings

@hmpf spin up #1161, create a destination and see how it behaves when you try to click update without changing things, or only changing one of the fields

I think this issue if the only problem I have with this PR. I have admittedly only tested on #1161 which isnt completely up to date with the changes in this branch

src/argus/notificationprofile/media/base.py

src/argus/notificationprofile/media/email.py

.. also make it easioer to validate the settings-field with a django form.

sonarqubecloud · 2025-03-13T14:50:06Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

stveit · 2025-03-14T10:58:56Z

Updating existing destination is still buggy. It allows me to update either the email on its own or the label and email together. it does not allow me to only update the label, or just click update without making any changes. In the cases where it doesnt work this is the server log error:

2025-03-14 11:57:19,231 django.request ERROR    Internal Server Error: /destinations/9/htmx-update/
Traceback (most recent call last):
  File "/home/simon/repos/Argus/venv/lib/python3.10/site-packages/django/core/handlers/exception.py", line 55, in inner
    response = get_response(request)
  File "/home/simon/repos/Argus/venv/lib/python3.10/site-packages/django/core/handlers/base.py", line 197, in _get_response
    response = wrapped_callback(request, *callback_args, **callback_kwargs)
  File "/home/simon/repos/Argus/venv/lib/python3.10/site-packages/django/views/decorators/http.py", line 64, in inner
    return func(request, *args, **kwargs)
  File "/home/simon/repos/Argus/src/argus/htmx/destination/views.py", line 58, in update_htmx
    form.save()
  File "/home/simon/repos/Argus/src/argus/htmx/destination/forms.py", line 37, in save
    self.serializer.save(user=self.request.user)
  File "/home/simon/repos/Argus/venv/lib/python3.10/site-packages/rest_framework/serializers.py", line 180, in save
    assert not self.errors, (
AssertionError: You cannot call `.save()` on a serializer with invalid data.
2025-03-14 11:57:19,233 django.server INFO     "POST /destinations/9/htmx-update/ HTTP/1.1" 200 814

hmpf requested review from johannaengland, stveit and a team November 11, 2024 14:24

hmpf changed the title ~~move common functionality to base class~~ Move common functionality to destination base class Nov 11, 2024

hmpf self-assigned this Nov 12, 2024

hmpf added the refactor label Nov 12, 2024

hmpf force-pushed the cleanup-destination-plugins branch from c39d564 to 55a2ff0 Compare November 13, 2024 09:23

stveit mentioned this pull request Nov 29, 2024

Add Htmx destinations page #970

Merged

stveit reviewed Nov 29, 2024

View reviewed changes

src/argus/notificationprofile/media/base.py Outdated Show resolved Hide resolved

hmpf force-pushed the cleanup-destination-plugins branch from 55a2ff0 to 5989b0a Compare December 2, 2024 12:39

hmpf marked this pull request as ready for review December 3, 2024 08:53

hmpf requested a review from lunkwill42 December 3, 2024 08:53

hmpf requested a review from stveit December 3, 2024 12:25

johannaengland requested changes Dec 3, 2024

View reviewed changes

johannaengland reviewed Dec 3, 2024

View reviewed changes

src/argus/notificationprofile/media/email.py Show resolved Hide resolved

johannaengland reviewed Dec 3, 2024

View reviewed changes

src/argus/notificationprofile/media/email.py Outdated Show resolved Hide resolved

hmpf force-pushed the cleanup-destination-plugins branch from 3b78212 to 7b8826c Compare December 4, 2024 06:51

hmpf requested a review from johannaengland December 4, 2024 10:44

hmpf force-pushed the cleanup-destination-plugins branch from 0e23752 to 3131826 Compare December 4, 2024 13:52

johannaengland requested changes Dec 6, 2024

View reviewed changes

docs/integrations/notifications/writing-notification-plugins.rst Outdated Show resolved Hide resolved

src/argus/notificationprofile/media/base.py Show resolved Hide resolved

src/argus/notificationprofile/serializers.py Outdated Show resolved Hide resolved

stveit requested changes Dec 9, 2024

View reviewed changes

src/argus/notificationprofile/media/base.py Outdated Show resolved Hide resolved

src/argus/notificationprofile/media/base.py Outdated Show resolved Hide resolved

hmpf requested a review from stveit January 7, 2025 09:36

hmpf mentioned this pull request Jan 7, 2025

When PATCH-ing a destination, the error message returned for is_duplicate is useless #1111

Open

hmpf force-pushed the cleanup-destination-plugins branch 2 times, most recently from d1eb78c to 97cc505 Compare January 7, 2025 12:55

hmpf mentioned this pull request Jan 15, 2025

Add dropdowns to profiles page #1118

Merged

hmpf force-pushed the cleanup-destination-plugins branch from d329536 to ee9eb86 Compare January 16, 2025 07:27

stveit reviewed Jan 16, 2025

View reviewed changes

src/argus/notificationprofile/media/base.py Show resolved Hide resolved

hmpf force-pushed the cleanup-destination-plugins branch 3 times, most recently from 38130e1 to 282b4d2 Compare January 24, 2025 11:01

hmpf mentioned this pull request Jan 24, 2025

Use forms in destination page #1161

Open

hmpf force-pushed the cleanup-destination-plugins branch from 282b4d2 to 304367b Compare January 24, 2025 11:29

hmpf requested review from stveit and podliashanyk January 24, 2025 11:38

stveit reviewed Jan 28, 2025

View reviewed changes

johannaengland self-requested a review January 29, 2025 08:20

johannaengland requested changes Feb 6, 2025

View reviewed changes

hmpf requested review from stveit and johannaengland March 10, 2025 11:51

hmpf added 7 commits March 13, 2025 11:32

Move common destination functionality to parent class

c7c0d76

.. also make it easioer to validate the settings-field with a django form.

fixes comment from stveit

f3f072e

move line for readability

7db1c7a

update dosctring

6149122

update docstring

ebfd0c1

update docstring

fcc5676

removed full stop

0acb935

hmpf force-pushed the cleanup-destination-plugins branch from 532c71e to 0acb935 Compare March 13, 2025 10:33

only validate changed data

713e5d5

hmpf mentioned this pull request Mar 19, 2025

Trying to create a destination with a name that is already in use causes 500 error #930

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move common functionality to destination base class #936

Move common functionality to destination base class #936

hmpf commented Nov 11, 2024 •

edited

Loading

codecov-commenter commented Dec 3, 2024 •

edited

Loading

sonarqubecloud bot commented Dec 4, 2024

johannaengland left a comment

hmpf commented Dec 6, 2024

johannaengland commented Dec 6, 2024

hmpf commented Dec 6, 2024

hmpf commented Jan 15, 2025

stveit commented Jan 15, 2025

sonarqubecloud bot commented Jan 24, 2025

stveit left a comment

stveit Jan 28, 2025

johannaengland Jan 29, 2025

hmpf Mar 10, 2025

johannaengland Mar 10, 2025

hmpf Mar 11, 2025 •

edited

Loading

johannaengland Mar 11, 2025

stveit Mar 12, 2025

stveit Mar 12, 2025 •

edited

Loading

sonarqubecloud bot commented Mar 13, 2025

stveit commented Mar 14, 2025

Move common functionality to destination base class #936

Are you sure you want to change the base?

Move common functionality to destination base class #936

Conversation

hmpf commented Nov 11, 2024 • edited Loading

codecov-commenter commented Dec 3, 2024 • edited Loading

Codecov Report

sonarqubecloud bot commented Dec 4, 2024

Quality Gate passed

johannaengland left a comment

Choose a reason for hiding this comment

hmpf commented Dec 6, 2024

johannaengland commented Dec 6, 2024

hmpf commented Dec 6, 2024

hmpf commented Jan 15, 2025

stveit commented Jan 15, 2025

sonarqubecloud bot commented Jan 24, 2025

Quality Gate passed

stveit left a comment

Choose a reason for hiding this comment

stveit Jan 28, 2025

Choose a reason for hiding this comment

johannaengland Jan 29, 2025

Choose a reason for hiding this comment

hmpf Mar 10, 2025

Choose a reason for hiding this comment

johannaengland Mar 10, 2025

Choose a reason for hiding this comment

hmpf Mar 11, 2025 • edited Loading

Choose a reason for hiding this comment

johannaengland Mar 11, 2025

Choose a reason for hiding this comment

stveit Mar 12, 2025

Choose a reason for hiding this comment

stveit Mar 12, 2025 • edited Loading

Choose a reason for hiding this comment

sonarqubecloud bot commented Mar 13, 2025

Quality Gate passed

stveit commented Mar 14, 2025

hmpf commented Nov 11, 2024 •

edited

Loading

codecov-commenter commented Dec 3, 2024 •

edited

Loading

hmpf Mar 11, 2025 •

edited

Loading

stveit Mar 12, 2025 •

edited

Loading