Merge branch 'master' into issue/change-default-filter-backend

Author: TimdeBeer1

.git-blame-ignore-revs

@@ -1,2 +1,3 @@
-# Black update
+# style: apply ruff isort and format
 de05ba4ccf2c9a3c929705cee6f517bf74361a2c
+c2675d07be248a07b111faead0623af9aa3ea6d3

.github/workflows/ci.yml

@@ -89,10 +89,15 @@ jobs:
           docker compose exec --user root web pip install factory-boy
           cat performance_test/create_data.py | docker compose exec -T web src/manage.py shell
 
+      - name: Run Locust tests
+        run: |
+          pip install locust
+          locust --config performance_test/locust.conf
+
       - name: Run tests
         run: |
           pip install -r requirements/ci.txt
-          pytest performance_test/ --benchmark-json output.json
+          pytest -v performance_test/test_objects_list.py --benchmark-json output.json
 
   docs:
     runs-on: ubuntu-latest

.gitignore

@@ -30,6 +30,7 @@ local.py
 /static/
 /mail/
 /log/*.log*
+/log/*.jsonl*
 /log/nginx/*.log*
 .env
 

.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.11.10
+  hooks:
+    # Run the linter.
+    - id: ruff
+    # Run the formatter.
+    - id: ruff-format

CHANGELOG.rst

@@ -28,13 +28,13 @@ Change history
 
 * Upgrade dev dependencies
 
-  * django-webtest to 1.9.13  
+  * django-webtest to 1.9.13
 
 * Upgrade npm packages to fix vulnerabilities
 * Fixed admin logout button
 * [:objects-api:`550`] Implement cache for objecttypes
-* [:objects-api:`550`] add OBJECTTYPE_VERSION_CACHE_TIMEOUT environment variable `documentation <https://objects-and-objecttypes-api.readthedocs.io/en/latest/installation/config.html#cache>`_
-* [:objects-api:`572`] Add db connection pooling environment variables `documentation <https://objects-and-objecttypes-api.readthedocs.io/en/latest/installation/config.html#database>`_
+* [:objects-api:`550`] add OBJECTTYPE_VERSION_CACHE_TIMEOUT environment variable (see `documentation for environment variables for caching <https://objects-and-objecttypes-api.readthedocs.io/en/latest/installation/config.html#cache>`_)
+* [:objects-api:`572`] Add db connection pooling environment variables (see `documentation for environment variables for database <https://objects-and-objecttypes-api.readthedocs.io/en/latest/installation/config.html#database>`_)
 
   * DB_POOL_ENABLED
   * DB_POOL_MIN_SIZE
@@ -46,7 +46,7 @@ Change history
   * DB_POOL_RECONNECT_TIMEOUT
   * DB_POOL_NUM_WORKERS
 
-* [:objects-api:`566`] Add DB_CONN_MAX_AGE environment variable `documentation <https://objects-and-objecttypes-api.readthedocs.io/en/latest/installation/config.html#database>`_
+* [:objects-api:`566`] Add DB_CONN_MAX_AGE environment variable (see `documentation for environment variables for database <https://objects-and-objecttypes-api.readthedocs.io/en/latest/installation/config.html#database>`_)
 
 3.0.3 (2025-04-03)
 ------------------
@@ -132,8 +132,7 @@ Change history
 .. warning::
 
     Previous configuration files used for ``setup_configuration`` do not work.
-    See the `documentation <https://objects-and-objecttypes-api.readthedocs.io/en/latest/installation/config_cli.html>`_
-    for the available settings that can now be configured through ``setup_configuration``.
+    See :ref:`installation_config_cli` for the available settings that can now be configured through ``setup_configuration``.
 
 * added support for configuring permissions through ``django-setup-configuration``
   version ``0.4.0`` [#497]
@@ -246,7 +245,7 @@ Change history
 * bumped python dependencies due to security issues: django, celery, certifi, maykin-2fa, mozilla-django-oidc-db,
   sentry-sdk, webob and others (#428)
 * bumped ``zgw-consumers`` to 0.29.0 and updated a code for clients, because of zgw-consumers breaking change.
-* paginated ``/api/v2/objects/{uuid}/history``endpoint (#329)
+* paginated ``/api/v2/objects/{uuid}/history`` endpoint (#329)
 * fixed ``"register_kanalen`` command (#426)
 * fixed notification page link (open-zaak/open-notificaties#171)
 
@@ -307,7 +306,7 @@ Change history
 * changed caching backend from LocMem to Redis
 * Elastic APM service name can now be configured with ``ELASTIC_APM_SERVICE_NAME`` envvar
 
-** Documentation**
+**Documentation**
 
 * added security policy (#390)
 * updated Quick start documentation (#348)

CONTRIBUTING.md

@@ -21,15 +21,22 @@ other developers to give tips even before you start coding.
 
 To keep the code clean and readable, this project uses:
 
-- [`isort`](https://github.com/timothycrosley/isort) to order the imports
-- [`black`](https://github.com/psf/black) to format the code and keep diffs for 
-  pull requests small
-- [`flake8`](https://github.com/PyCQA/flake8) to clean up code (removing unused
-  imports, etc.)
-
-Whenever a branch is pushed or a pull request is made, the code will be checked 
-in CI by the tools mentioned above, so make sure to install these tools and run 
-them locally before pushing branches/making pull requests.
+- [`ruff`](https://docs.astral.sh/ruff/) to format and clean up code (removing unused imports, etc.)
+
+Whenever a branch is pushed or a pull request is made, the code will be checked in CI by Ruff, so
+make sure to install and run it locally before pushing branches/making pull requests.
+
+The project includes a [pre-commit](https://pre-commit.com) configuration to automatically
+create a pre-commit hook to apply the expected style formatting. After installing
+the dev dependencies, simply do:
+
+```
+$ pre-commit install
+```
+
+Now the various formatting hooks will be run automatically as a pre-commit hook. You
+can pass `--no-verify` to `git commit` to disable these checks for a specific commit
+during development (but keep in mind CI won't pass until your code conforms).
 
 This project aims to meet the criteria of the 
 [Standard for Public Code][Standard_for_Public_Code]. Please make sure that 

Dockerfile

@@ -1,11 +1,14 @@
 # Stage 1 - Compile needed python dependencies
 FROM python:3.11-slim-bookworm AS backend-build
 
-RUN apt-get update && apt-get install -y --no-install-recommends \
+RUN apt-get update && apt-get upgrade -y && apt-get install -y --no-install-recommends \
         pkg-config \
         build-essential \
         git \
         libpq-dev \
+        # required for (log) routing support in uwsgi
+        libpcre3 \
+        libpcre3-dev \
     && rm -rf /var/lib/apt/lists/*
 
 
@@ -37,13 +40,14 @@ FROM python:3.11-slim-bookworm AS production
 
 # Stage 3.1 - Set up the needed production dependencies
 # install all the dependencies for GeoDjango
-RUN apt-get update && apt-get install -y --no-install-recommends \
+RUN apt-get update && apt-get upgrade -y && apt-get install -y --no-install-recommends \
         postgresql-client \
         binutils \
         libproj-dev \
         gdal-bin \
         libgdal-dev \
         gettext \
+        libpcre3 \
     && rm -rf /var/lib/apt/lists/*
 
 RUN pip install pip "setuptools>=70.0.0"
@@ -60,6 +64,7 @@ COPY ./bin/celery_worker.sh /celery_worker.sh
 COPY ./bin/celery_flower.sh /celery_flower.sh
 COPY ./bin/check_celery_worker_liveness.py ./bin/
 COPY ./bin/setup_configuration.sh /setup_configuration.sh
+COPY ./bin/uwsgi.ini /
 RUN mkdir /app/log /app/config /app/tmp
 
 # copy frontend build statics

INSTALL.rst

@@ -54,6 +54,7 @@ development machine.
        $ virtualenv env
        $ source env/bin/activate
        $ pip install -r requirements/dev.txt
+       $ pre-commit install
 
 4. Install all required (frontend) libraries and build static files.
 

README.NL.rst

@@ -76,7 +76,7 @@ Zie: `Alle versies en wijzigingen <https://github.com/maykinmedia/objects-api/bl
 Referentie implementatie
 ========================
 
-|build-status| |coverage| |black| |docker| |python-versions|
+|build-status| |coverage| |ruff| |docker| |python-versions|
 
 De referentie implementatie toont de API in actie en kan gebruikt worden voor
 test en demonstratie doeleinden. De referentie implementatie is open source,
@@ -136,9 +136,9 @@ Licensed under the EUPL_
     :alt: Coverage
     :target: https://codecov.io/gh/maykinmedia/objects-api
 
-.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
-    :alt: Code style
-    :target: https://github.com/psf/black
+.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+    :target: https://github.com/astral-sh/ruff
+    :alt: Ruff
 
 .. |docker| image:: https://images.microbadger.com/badges/image/maykinmedia/objects-api.svg
     :alt: Docker image

README.rst

@@ -74,7 +74,7 @@ See: `All versions and changes <https://github.com/maykinmedia/objects-api/blob/
 Reference implementation
 ========================
 
-|build-status| |coverage| |black| |docker| |python-versions|
+|build-status| |coverage| |ruff| |docker| |python-versions|
 
 The reference implementation is used to demonstrate the API in action and can
 be used for test and demo purposes. The reference implementation is open source,
@@ -134,9 +134,9 @@ Licensed under the EUPL_
     :alt: Coverage
     :target: https://codecov.io/gh/maykinmedia/objects-api
 
-.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
-    :alt: Code style
-    :target: https://github.com/psf/black
+.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+    :target: https://github.com/astral-sh/ruff
+    :alt: Ruff
 
 .. |docker| image:: https://images.microbadger.com/badges/image/maykinmedia/objects-api.svg
     :alt: Docker image