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

🔧 [open-zaak/open-zaak#1629] Refactor settings module

Author: joeribekker

CHANGELOG.rst

@@ -2,19 +2,38 @@
 Change history
 ==============
 
+2.1.0
+=====
+
+*??? ???, 2024*
+
+New features:
+
+* Add support for mounting Open Klant on a ``SUBPATH``
+* Elastic APM service name can now be configured with ``ELASTIC_APM_SERVICE_NAME`` envvar
+
+.. warning::
+
+    The service name for Elastic APM is now configurable via the ``ELASTIC_APM_SERVICE_NAME`` environment variable.
+    The default value changed from ``Open Klant - <ENVIRONMENT>`` to ``openklant - <ENVIRONMENT>``
+
+Bugfixes/QoL:
+* Settings module was refactored to use generic settings provided by Open API Framework
+
+
 2.0.0
 =====
 
 *March 15, 2024*
 
 *VNG officially retired the Klanten and Contactmomenten API, which never had an
-official release. These API's are replaced by the Klantinteractie API. In 
-cooperation with several municipalities and VNG, Open Klant will implement the 
+official release. These API's are replaced by the Klantinteractie API. In
+cooperation with several municipalities and VNG, Open Klant will implement the
 new API specification and might introduce backwards incompatible changes. Since
-Open Klant never had an official 1.0 release, we will continue versioning on 
+Open Klant never had an official 1.0 release, we will continue versioning on
 the 0.x.x-scheme.*
 
-* Initial release of Open Klant featuring the first iteration of the 
+* Initial release of Open Klant featuring the first iteration of the
   Klantinteracties API.
 
 1.0.0

Dockerfile

@@ -3,6 +3,7 @@ FROM python:3.11-slim-bookworm AS build
 
 RUN apt-get update && apt-get upgrade -y && apt-get install -y --no-install-recommends \
         pkg-config \
+        git \
         build-essential \
         libpq-dev \
     && rm -rf /var/lib/apt/lists/*

bin/docker_start.sh

@@ -13,6 +13,8 @@ uwsgi_port=${UWSGI_PORT:-8000}
 uwsgi_processes=${UWSGI_PROCESSES:-4}
 uwsgi_threads=${UWSGI_THREADS:-1}
 
+mountpoint=${SUBPATH:-/}
+
 until pg_isready; do
   >&2 echo "Waiting for database connection..."
   sleep 1
@@ -26,10 +28,11 @@ python src/manage.py migrate
 
 # Start server
 >&2 echo "Starting server"
-exec uwsgi \
+uwsgi \
     --http :$uwsgi_port \
     --http-keepalive \
-    --module openklant.wsgi \
+    --manage-script-name \
+    --mount $mountpoint=openklant.wsgi:application \
     --static-map /static=/app/static \
     --static-map /media=/app/media  \
     --chdir src \

docker-compose.yml

@@ -26,7 +26,8 @@ services:
       - ALLOWED_HOSTS=*
       - CACHE_DEFAULT=redis:6379/0
       - CACHE_AXES=redis:6379/0
-      - SECRET_KEY=${SECRET_KEY:-django-insecure-$8s@b*ds4t84-q_2#c0j0506@!l2q6r5_pq5e!vm^_9c*#^66b}
+      - SUBPATH=${SUBPATH:-/}
+      - SECRET_KEY=${SECRET_KEY:-django-insecure-f8s@b*ds4t84-q_2#c0j0506@!l2q6r5_pq5e!vm^_9c*#^66b}
       - CELERY_BROKER_URL=redis://redis:6379/0
       - CELERY_RESULT_BACKEND=redis://redis:6379/0
     ports:

requirements/base.in

@@ -1,2 +1 @@
 open-api-framework
-django-log-outgoing-requests

requirements/base.txt

@@ -1,5 +1,5 @@
 #
-# This file is autogenerated by pip-compile with Python 3.10
+# This file is autogenerated by pip-compile with Python 3.11
 # by the following command:
 #
 #    ./bin/compile_dependencies.sh
@@ -14,8 +14,6 @@ asgiref==3.8.1
     #   django-cors-headers
 asn1crypto==1.5.1
     # via webauthn
-async-timeout==4.0.3
-    # via redis
 attrs==23.2.0
     # via
     #   glom
@@ -89,6 +87,7 @@ django==4.2.11
     #   django-relativedelta
     #   django-rest-framework-condition
     #   django-sendfile2
+    #   django-setup-configuration
     #   django-simple-certmanager
     #   django-solo
     #   django-two-factor-auth
@@ -122,7 +121,7 @@ django-jsonform==2.22.0
     #   mozilla-django-oidc-db
     #   open-api-framework
 django-log-outgoing-requests==0.6.1
-    # via -r requirements/base.in
+    # via open-api-framework
 django-markup==1.8.1
     # via open-api-framework
 django-ordered-model==3.7.4
@@ -141,6 +140,8 @@ django-rest-framework-condition==0.1.1
     # via commonground-api-common
 django-sendfile2==0.7.1
     # via django-privates
+django-setup-configuration==0.1.0
+    # via open-api-framework
 django-simple-certmanager==2.0.0
     # via zgw-consumers
 django-solo==2.2.0
@@ -226,7 +227,7 @@ mozilla-django-oidc-db==0.15.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.4.2
     # via -r requirements/base.in
 orderedmultidict==1.0.1
     # via furl
@@ -310,7 +311,6 @@ tornado==6.4
     # via flower
 typing-extensions==4.11.0
     # via
-    #   asgiref
     #   qrcode
     #   zgw-consumers
 tzdata==2024.1

requirements/ci.txt

@@ -1,5 +1,5 @@
 #
-# This file is autogenerated by pip-compile with Python 3.10
+# This file is autogenerated by pip-compile with Python 3.11
 # by the following command:
 #
 #    ./bin/compile_dependencies.sh
@@ -29,11 +29,6 @@ asn1crypto==1.5.1
     #   webauthn
 astroid==3.1.0
     # via pylint
-async-timeout==4.0.3
-    # via
-    #   -c requirements/base.txt
-    #   -r requirements/base.txt
-    #   redis
 attrs==23.2.0
     # via
     #   -c requirements/base.txt
@@ -167,6 +162,7 @@ django==4.2.11
     #   django-relativedelta
     #   django-rest-framework-condition
     #   django-sendfile2
+    #   django-setup-configuration
     #   django-simple-certmanager
     #   django-solo
     #   django-two-factor-auth
@@ -222,6 +218,7 @@ django-log-outgoing-requests==0.6.1
     # via
     #   -c requirements/base.txt
     #   -r requirements/base.txt
+    #   open-api-framework
 django-markup==1.8.1
     # via
     #   -c requirements/base.txt
@@ -267,6 +264,11 @@ django-sendfile2==0.7.1
     #   -c requirements/base.txt
     #   -r requirements/base.txt
     #   django-privates
+django-setup-configuration==0.1.0
+    # via
+    #   -c requirements/base.txt
+    #   -r requirements/base.txt
+    #   open-api-framework
 django-simple-certmanager==2.0.0
     # via
     #   -c requirements/base.txt
@@ -477,7 +479,7 @@ notifications-api-common==0.2.2
     #   -c requirements/base.txt
     #   -r requirements/base.txt
     #   commonground-api-common
-open-api-framework==0.2.0
+open-api-framework==0.4.2
     # via
     #   -c requirements/base.txt
     #   -r requirements/base.txt
@@ -683,11 +685,6 @@ sqlparse==0.5.0
     #   django
 tblib==3.0.0
     # via -r requirements/test-tools.in
-tomli==2.0.1
-    # via
-    #   black
-    #   pylint
-    #   sphinx
 tomlkit==0.12.4
     # via pylint
 tornado==6.4
@@ -699,9 +696,6 @@ typing-extensions==4.11.0
     # via
     #   -c requirements/base.txt
     #   -r requirements/base.txt
-    #   asgiref
-    #   astroid
-    #   black
     #   qrcode
     #   zgw-consumers
 tzdata==2024.1

requirements/dev.txt

@@ -1,5 +1,5 @@
 #
-# This file is autogenerated by pip-compile with Python 3.10
+# This file is autogenerated by pip-compile with Python 3.11
 # by the following command:
 #
 #    ./bin/compile_dependencies.sh
@@ -35,11 +35,6 @@ astroid==3.1.0
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   pylint
-async-timeout==4.0.3
-    # via
-    #   -c requirements/ci.txt
-    #   -r requirements/ci.txt
-    #   redis
 attrs==23.2.0
     # via
     #   -c requirements/ci.txt
@@ -194,6 +189,7 @@ django==4.2.11
     #   django-relativedelta
     #   django-rest-framework-condition
     #   django-sendfile2
+    #   django-setup-configuration
     #   django-simple-certmanager
     #   django-solo
     #   django-two-factor-auth
@@ -253,6 +249,7 @@ django-log-outgoing-requests==0.6.1
     # via
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
+    #   open-api-framework
 django-markup==1.8.1
     # via
     #   -c requirements/ci.txt
@@ -298,6 +295,11 @@ django-sendfile2==0.7.1
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   django-privates
+django-setup-configuration==0.1.0
+    # via
+    #   -c requirements/ci.txt
+    #   -r requirements/ci.txt
+    #   open-api-framework
 django-simple-certmanager==2.0.0
     # via
     #   -c requirements/ci.txt
@@ -537,7 +539,7 @@ notifications-api-common==0.2.2
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   commonground-api-common
-open-api-framework==0.2.0
+open-api-framework==0.4.2
     # via
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
@@ -812,16 +814,6 @@ tblib==3.0.0
     # via
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
-tomli==2.0.1
-    # via
-    #   -c requirements/ci.txt
-    #   -r requirements/ci.txt
-    #   black
-    #   build
-    #   pip-tools
-    #   pylint
-    #   pyproject-hooks
-    #   sphinx
 tomlkit==0.12.4
     # via
     #   -c requirements/ci.txt
@@ -836,9 +828,6 @@ typing-extensions==4.11.0
     # via
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
-    #   asgiref
-    #   astroid
-    #   black
     #   qrcode
     #   zgw-consumers
 tzdata==2024.1