Merge pull request #102 from maykinmedia/feature/refactor-settings

🔧 [open-zaak/open-zaak#1629] Refactor settings module
maykinmedia · May 17, 2024 · 07c57b2 · 07c57b2
2 parents 38e11f9 + 9d73d43
commit 07c57b2
Show file tree

Hide file tree

Showing 16 changed files with 139 additions and 514 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -44,7 +44,7 @@ jobs:
             gdal-bin
 
       - name: Install dependencies
-        run: pip install -r requirements/dev.txt codecov
+        run: pip install -r requirements/ci.txt codecov
       - name: Build frontend
         run: |
           npm ci
@@ -55,7 +55,7 @@ jobs:
           python src/manage.py collectstatic --noinput --link
           coverage run src/manage.py test src
         env:
-          DJANGO_SETTINGS_MODULE: objecttypes.conf.dev
+          DJANGO_SETTINGS_MODULE: objecttypes.conf.ci
           SECRET_KEY: dummy
           DB_USER: postgres
           DB_PASSWORD: ''

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -8,12 +8,19 @@ Change history
 **Bugfixes and QOL**
 
 * updated to Django 4.2 (objects-api#385)
+* changed caching backend from LocMem to Redis
 
 .. warning::
 
    Two-factor authentication is enabled by default. The ``DISABLE_2FA`` environment variable
    can be used to disable it if needed.
 
+.. warning::
+
+    Because the caching barefer to env config for envvarsckend was changed to Redis,
+    existing deployments must add a Redis container or Redis instance
+    (see ``Installation > Environment configuration reference`` in the documentation on how to configure) the connection with Redis
+
 2.1.2 (2024-02-06)
 ------------------
 

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -2,22 +2,26 @@ version: '3'
 
 services:
   db:
-    image: postgres:11-alpine
+    image: postgres:12-alpine
     environment:
       - POSTGRES_HOST_AUTH_METHOD=trust
     volumes:
       - ./docker-init-db.sql:/docker-entrypoint-initdb.d/init_db.sql
 #      - db:/var/lib/postgresql/data
     command: postgres -c max_connections=300 -c log_min_messages=LOG
 
+  redis:
+    image: redis
+
   web:
     build: .
     environment: &app-env
       - DJANGO_SETTINGS_MODULE=objecttypes.conf.docker
-      - SECRET_KEY=${SECRET_KEY:-fgv=c0hz&tl*8*3m3893@m+1pstrvidc9e^5@fpspmg%cy$15d}
+      - SECRET_KEY=${SECRET_KEY:-fgv=c0hz&tl*8*3m3893@m+1pstrvidc9e^5@fpspmg%cyf15d}
       - ALLOWED_HOSTS=*
-      - TWO_FACTOR_FORCE_OTP_ADMIN=no
-      - TWO_FACTOR_PATCH_ADMIN=no
+      - CACHE_DEFAULT=redis:6379/0
+      - CACHE_AXES=redis:6379/0
+      - DISABLE_2FA=yes
       # setup_configuration env vars
       - OBJECTTYPES_DOMAIN=web:8000
       - OBJECTTYPES_ORGANIZATION=ObjectTypes

diff --git a/requirements/base.txt b/requirements/base.txt
@@ -73,12 +73,14 @@ django==4.2.11
     # via
     #   commonground-api-common
     #   django-admin-index
+    #   django-appconf
     #   django-axes
     #   django-cors-headers
     #   django-filter
     #   django-formtools
     #   django-jsonform
     #   django-jsonsuit
+    #   django-log-outgoing-requests
     #   django-markup
     #   django-otp
     #   django-phonenumber-field
@@ -105,6 +107,8 @@ django==4.2.11
     #   zgw-consumers
 django-admin-index==3.1.1
     # via open-api-framework
+django-appconf==1.0.6
+    # via django-log-outgoing-requests
 django-axes==6.4.0
     # via open-api-framework
 django-cors-headers==4.3.1
@@ -121,6 +125,8 @@ django-jsonform==2.21.5
     #   open-api-framework
 django-jsonsuit==0.5.0
     # via -r requirements/base.in
+django-log-outgoing-requests==0.6.1
+    # via open-api-framework
 django-markup==1.8.1
     # via open-api-framework
 django-ordered-model==3.7.4
@@ -146,6 +152,7 @@ django-simple-certmanager==2.0.0
 django-solo==2.0.0
     # via
     #   commonground-api-common
+    #   django-log-outgoing-requests
     #   mozilla-django-oidc-db
     #   notifications-api-common
     #   sharing-configs
@@ -226,11 +233,11 @@ maykin-2fa==1.0.0
     # via open-api-framework
 mozilla-django-oidc==4.0.0
     # via mozilla-django-oidc-db
-mozilla-django-oidc-db==0.14.1
+mozilla-django-oidc-db==0.16.0
     # via open-api-framework
 notifications-api-common==0.2.2
     # via commonground-api-common
-open-api-framework==0.2.0
+open-api-framework==0.3.0
     # via -r requirements/base.in
 orderedmultidict==1.0.1
     # via furl
@@ -286,6 +293,7 @@ requests==2.31.0
     #   ape-pie
     #   commonground-api-common
     #   coreapi
+    #   django-log-outgoing-requests
     #   gemma-zds-client
     #   mozilla-django-oidc
     #   open-api-framework

diff --git a/requirements/ci.txt b/requirements/ci.txt
@@ -117,13 +117,15 @@ django==4.2.11
     #   -r requirements/base.txt
     #   commonground-api-common
     #   django-admin-index
+    #   django-appconf
     #   django-axes
     #   django-cors-headers
     #   django-filter
     #   django-formtools
     #   django-jenkins
     #   django-jsonform
     #   django-jsonsuit
+    #   django-log-outgoing-requests
     #   django-markup
     #   django-otp
     #   django-phonenumber-field
@@ -152,6 +154,10 @@ django-admin-index==3.1.1
     # via
     #   -r requirements/base.txt
     #   open-api-framework
+django-appconf==1.0.6
+    # via
+    #   -r requirements/base.txt
+    #   django-log-outgoing-requests
 django-axes==6.4.0
     # via
     #   -r requirements/base.txt
@@ -178,6 +184,10 @@ django-jsonform==2.21.5
     #   open-api-framework
 django-jsonsuit==0.5.0
     # via -r requirements/base.txt
+django-log-outgoing-requests==0.6.1
+    # via
+    #   -r requirements/base.txt
+    #   open-api-framework
 django-markup==1.8.1
     # via
     #   -r requirements/base.txt
@@ -224,6 +234,7 @@ django-solo==2.0.0
     # via
     #   -r requirements/base.txt
     #   commonground-api-common
+    #   django-log-outgoing-requests
     #   mozilla-django-oidc-db
     #   notifications-api-common
     #   sharing-configs
@@ -360,15 +371,15 @@ mozilla-django-oidc==4.0.0
     # via
     #   -r requirements/base.txt
     #   mozilla-django-oidc-db
-mozilla-django-oidc-db==0.14.1
+mozilla-django-oidc-db==0.16.0
     # via
     #   -r requirements/base.txt
     #   open-api-framework
 notifications-api-common==0.2.2
     # via
     #   -r requirements/base.txt
     #   commonground-api-common
-open-api-framework==0.2.0
+open-api-framework==0.3.0
     # via -r requirements/base.txt
 orderedmultidict==1.0.1
     # via
@@ -461,6 +472,7 @@ requests==2.31.0
     #   ape-pie
     #   commonground-api-common
     #   coreapi
+    #   django-log-outgoing-requests
     #   gemma-zds-client
     #   mozilla-django-oidc
     #   open-api-framework

diff --git a/requirements/dev.txt b/requirements/dev.txt
@@ -135,6 +135,7 @@ django==4.2.11
     #   -r requirements/ci.txt
     #   commonground-api-common
     #   django-admin-index
+    #   django-appconf
     #   django-axes
     #   django-cors-headers
     #   django-debug-toolbar
@@ -144,6 +145,7 @@ django==4.2.11
     #   django-jenkins
     #   django-jsonform
     #   django-jsonsuit
+    #   django-log-outgoing-requests
     #   django-markup
     #   django-otp
     #   django-phonenumber-field
@@ -172,6 +174,10 @@ django-admin-index==3.1.1
     # via
     #   -r requirements/ci.txt
     #   open-api-framework
+django-appconf==1.0.6
+    # via
+    #   -r requirements/ci.txt
+    #   django-log-outgoing-requests
 django-axes==6.4.0
     # via
     #   -r requirements/ci.txt
@@ -202,6 +208,10 @@ django-jsonform==2.21.5
     #   open-api-framework
 django-jsonsuit==0.5.0
     # via -r requirements/ci.txt
+django-log-outgoing-requests==0.6.1
+    # via
+    #   -r requirements/ci.txt
+    #   open-api-framework
 django-markup==1.8.1
     # via
     #   -r requirements/ci.txt
@@ -248,6 +258,7 @@ django-solo==2.0.0
     # via
     #   -r requirements/ci.txt
     #   commonground-api-common
+    #   django-log-outgoing-requests
     #   mozilla-django-oidc-db
     #   notifications-api-common
     #   sharing-configs
@@ -401,7 +412,7 @@ mozilla-django-oidc==4.0.0
     # via
     #   -r requirements/ci.txt
     #   mozilla-django-oidc-db
-mozilla-django-oidc-db==0.14.1
+mozilla-django-oidc-db==0.16.0
     # via
     #   -r requirements/ci.txt
     #   open-api-framework
@@ -411,7 +422,7 @@ notifications-api-common==0.2.2
     # via
     #   -r requirements/ci.txt
     #   commonground-api-common
-open-api-framework==0.2.0
+open-api-framework==0.3.0
     # via -r requirements/ci.txt
 orderedmultidict==1.0.1
     # via
@@ -521,6 +532,7 @@ requests==2.31.0
     #   ape-pie
     #   commonground-api-common
     #   coreapi
+    #   django-log-outgoing-requests
     #   gemma-zds-client
     #   mozilla-django-oidc
     #   open-api-framework