Allow disabling redis #785

elfjes · 2024-04-23T09:52:55Z

Add a boolean environment variable "ARGUS_DISABLE_REDIS" that, when set, will tell channels to use an InMemoryChannel instead of Redis so that we may run the backend without having a redis server running

lunkwill42

This needs to be rebased, I think the upstream branch has seen a force-push since this was created, and now this PR seems to include @hmpf's old commits.
While disabling Redis might be fine in a development environment, this setting needs to come with a big fat warning that it is not suitable for production use. In-memory channels are single-process only, and that's not how you would deploy the Argus in any production setting.

hmpf · 2024-04-25T11:02:24Z

While disabling Redis might be fine in a development environment, this setting needs to come with a big fat warning that it is not suitable for production use. In-memory channels are single-process only, and that's not how you would deploy the Argus in any production setting.

What @lunkwill42 is probably trying to say is that you need to document the setting where the other settings are in the docs, and maybe only turn it on if DEBUG is also on. after rebasing :) I should really write that "how to merge"-doc...

codecov-commenter · 2024-04-25T13:28:26Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.45%. Comparing base (5a6b8c1) to head (a8d6f0c).
Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #785      +/-   ##
==========================================
+ Coverage   81.93%   82.45%   +0.51%     
==========================================
  Files         132      132              
  Lines        4861     4867       +6     
==========================================
+ Hits         3983     4013      +30     
+ Misses        878      854      -24

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

sonarqubecloud · 2024-04-25T13:42:33Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

elfjes · 2024-04-25T13:48:28Z

I've limited the flag only when debug is also set, but this doesn't work if debug is managed statically in a different file. Consider the following:

For security reasons, DEBUG is set statically to False in settings.prod. However, this is done only after settings.base has been imported. This means that in theory DEBUG and ARGUS_DISABLE_REDIS may be set as environment variables, which would trigger disabling redis. Then DEBUG would be reset to False in settings.prod, but redis would still be disabled. Sounds like a (minor) issue, but I'm not quite sure how to deal with that (ie only evaluate ARGUS_DISABLE_REDIS after all other settings have been loaded...

github-actions · 2024-04-25T13:55:10Z

Test results

      7 files   574 suites 21m 33s ⏱️
  462 tests   461 ✔️ 1 💤 0 ❌
3 234 runs 3 227 ✔️ 7 💤 0 ❌

Results for commit 8809dcc.

lunkwill42 · 2024-04-30T06:54:09Z

If I'm reading #630 correctly, the mechanism it introduces will also use Redis for conveying messages about notifications to the new qcluster command. We'd have to remember to also include a warning in #630 that disabling Redis would disable notifications and possibly all other background processing functionality we might add using django-q2 later. This could also be ok in a development environment, but it could also be very bad, depending on what you're developing.

hmpf

I think moving this to the dev settings file maybe makes the most sense.

Hmm...

sonarqubecloud · 2024-12-04T09:11:33Z

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

hmpf · 2024-12-13T11:15:33Z

docs/reference/site-specific-settings.rst

@@ -323,7 +323,7 @@ Ticket system settings
 ``TICKET_PLUGIN``, ``TICKET_ENDPOINT``, ``TICKET_AUTHENTICATION_SECRET``,
 ``TICKET_INFORMATION`` are all described in :ref:`ticket-systems-settings`.

-Debugging settings
+Development settings


The underline is too short, sphinx will croak.

hmpf · 2024-12-13T11:16:01Z

docs/reference/site-specific-settings.rst

+
+* :setting:`ARGUS_DISABLE_REDIS` When given as an environment variable, this switches out the
+  depencendy of django channels on Redis with an InMemoryChannelLayer. This can only be done
+  in development (using the dev.py settings). Overriding this setting in a custom settings file has


hmpf · 2024-12-13T11:17:33Z

src/argus/site/settings/base.py

-# fmt: off
-_REDIS = urlsplit("//" + get_str_env("ARGUS_REDIS_SERVER", "127.0.0.1:6379"))
-CHANNEL_LAYERS = {
-    "default": {
-        "BACKEND": "channels_redis.core.RedisChannelLayer",
-        "CONFIG": {
-            "hosts": [(_REDIS.hostname, _REDIS.port or 6379)],
-        },
-    },
-}
-# fmt: on
-


This turns redis off for all production though.

You could move this to the "backend" settings, or "spa" since the old frontend needs it.

hmpf force-pushed the htmx branch from a5359a9 to d8e30c8 Compare April 24, 2024 09:07

lunkwill42 requested changes Apr 25, 2024

View reviewed changes

hmpf self-requested a review April 25, 2024 10:35

elfjes force-pushed the disable-redis-flag branch from 02d1e6d to ab91dc4 Compare April 25, 2024 13:23

hmpf reviewed Apr 30, 2024

View reviewed changes

hmpf added the after-demo Need not work for demo label Jul 23, 2024

hmpf removed after-demo Need not work for demo labels Sep 13, 2024

hmpf assigned elfjes Dec 2, 2024

elfjes force-pushed the disable-redis-flag branch from 8809dcc to b870827 Compare December 4, 2024 08:29

elfjes changed the base branch from htmx to master December 4, 2024 08:30

elfjes closed this Dec 4, 2024

elfjes force-pushed the disable-redis-flag branch from b870827 to 5a6b8c1 Compare December 4, 2024 08:31

elfjes added 3 commits December 4, 2024 09:36

Allow disabling redis

ce5e841

formatting

67be393

allow disable redis only when debug is true

bb0571b

elfjes reopened this Dec 4, 2024

move setting to dev settings and add docs

a8d6f0c

elfjes requested review from lunkwill42 and hmpf December 4, 2024 09:12

hmpf requested changes Dec 13, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow disabling redis #785

Allow disabling redis #785

elfjes commented Apr 23, 2024

lunkwill42 left a comment

hmpf commented Apr 25, 2024

codecov-commenter commented Apr 25, 2024 •

edited

Loading

sonarqubecloud bot commented Apr 25, 2024

elfjes commented Apr 25, 2024

github-actions bot commented Apr 25, 2024

lunkwill42 commented Apr 30, 2024

hmpf left a comment

sonarqubecloud bot commented Dec 4, 2024

hmpf Dec 13, 2024

hmpf Dec 13, 2024

hmpf Dec 13, 2024

hmpf Dec 13, 2024

Allow disabling redis #785

Are you sure you want to change the base?

Allow disabling redis #785

Conversation

elfjes commented Apr 23, 2024

lunkwill42 left a comment

Choose a reason for hiding this comment

hmpf commented Apr 25, 2024

codecov-commenter commented Apr 25, 2024 • edited Loading

Codecov Report

sonarqubecloud bot commented Apr 25, 2024

Quality Gate passed

elfjes commented Apr 25, 2024

github-actions bot commented Apr 25, 2024

Test results

lunkwill42 commented Apr 30, 2024

hmpf left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Dec 4, 2024

Quality Gate passed

hmpf Dec 13, 2024

Choose a reason for hiding this comment

hmpf Dec 13, 2024

Choose a reason for hiding this comment

hmpf Dec 13, 2024

Choose a reason for hiding this comment

hmpf Dec 13, 2024

Choose a reason for hiding this comment

codecov-commenter commented Apr 25, 2024 •

edited

Loading