Merge pull request #64 from unicef/feature/history

Feature/history

Author: saxix

.github/workflows/test.yml

@@ -149,7 +149,7 @@ jobs:
               -v "./tests:/app/tests" \
               -v "./pytest.ini:/app/pytest.ini" \
               -t ${{env.IMAGE}} \
-              pytest tests/ --create-db --selenium -n auto -v --maxfail=5 --migrations --cov-report xml:./output/coverage.xml --record-mode none
+              pytest tests/ --create-db --selenium -v --maxfail=5 --migrations --cov-report xml:./output/coverage.xml --record-mode none
 
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v4

pyproject.toml

@@ -51,6 +51,7 @@ dependencies = [
     "sentry-sdk>=2.7.1",
     "social-auth-app-django",
     "unicef-security>=1.5.1",
+    "django-pghistory>=3.5.4",
 ]
 [project.scripts]
 celery-monitor = "country_workspace.__monitor__:run"

ruff.toml

@@ -90,3 +90,4 @@ section-order = ["future", "standard-library", "third-party", "first-party",  "l
 [lint.per-file-ignores]
 "tests/**.py" = ["S101", "PLR2004", "S", "SIM117", "D", "UP", "PLR0913", "ANN", "N999"]
 "src/**/versioning/**.py" = ["N999", ]
+"src/**/migrations/**.py" = ["E501", ]

src/country_workspace/admin/beneficiary_group.py

@@ -2,6 +2,7 @@
 from django.http import HttpRequest
 
 from country_workspace.models import BeneficiaryGroup
+
 from .base import BaseModelAdmin
 
 

src/country_workspace/admin/user.py

@@ -3,6 +3,7 @@
 from django.db.models import Q, QuerySet
 from django.http import HttpRequest, JsonResponse
 from unicef_security.admin import UserAdminPlus
+
 from ..models import User
 
 

src/country_workspace/cache/middleware.py

@@ -36,8 +36,11 @@ def process_response(self, request: HttpRequest, response: HttpResponse) -> Http
         timeout = self.page_timeout
         patch_response_headers(response, timeout)
         if response.status_code == 200:
-            cache_key = self.manager.build_key_from_request(request, "view", getattr(request.user, "pk", ""))
-            response.headers["Etag"] = cache_key
+            if "Etag" in response.headers:
+                cache_key = response.headers["Etag"]
+            else:
+                cache_key = self.manager.build_key_from_request(request, "view", getattr(request.user, "pk", ""))
+                response.headers["Etag"] = cache_key
             if hasattr(response, "render") and callable(response.render):
                 response.add_post_render_callback(lambda r: self.manager.store(cache_key, r))
             else:

src/country_workspace/config/settings.py

@@ -29,7 +29,9 @@
     "debug_toolbar",
     "django_sysinfo",
     "flags",
-    "reversion",
+    "pghistory",
+    "pgtrigger",
+    "pghistory.admin",
     "tailwind",
     "django_select2",
     "social_django",
@@ -65,6 +67,7 @@
     "country_workspace.middleware.state.StateSetMiddleware",
     "country_workspace.cache.middleware.UpdateCacheMiddleware",
     "django.middleware.common.CommonMiddleware",
+    "country_workspace.middleware.history.HistoryMiddleware",
     "csp.middleware.CSPMiddleware",
     "debug_toolbar.middleware.DebugToolbarMiddleware",
     "django.middleware.csrf.CsrfViewMiddleware",

src/country_workspace/contrib/aurora/pipeline.py

@@ -5,7 +5,7 @@
 from country_workspace.contrib.aurora.client import AuroraClient
 from country_workspace.models import AsyncJob, Batch, Household, Individual
 from country_workspace.utils.config import BatchNameConfig, FailIfAlienConfig
-from country_workspace.utils.fields import uppercase_field_value, clean_field_names
+from country_workspace.utils.fields import clean_field_names, uppercase_field_value
 
 
 class Config(BatchNameConfig, FailIfAlienConfig):

src/country_workspace/contrib/hope/push.py

@@ -1,21 +1,19 @@
 from collections.abc import Callable, Iterator
-from typing import Any
-from itertools import batched
 from dataclasses import dataclass, field
+from itertools import batched
+from json import JSONDecodeError
+from typing import Any
 
+from django.db import DatabaseError, transaction
 from django.db.models import QuerySet
-from django.db import transaction, DatabaseError
-
+from requests.exceptions import RequestException
 
 from country_workspace.contrib.hope.client import HopeClient
+from country_workspace.contrib.hope.constants import HOUSEHOLD_PUSH_BATCH_SIZE
+from country_workspace.exceptions import RemoteError
 from country_workspace.models import AsyncJob
 from country_workspace.workspaces.models import CountryHousehold
 
-from requests.exceptions import RequestException
-from json import JSONDecodeError
-from country_workspace.exceptions import RemoteError
-from country_workspace.contrib.hope.constants import HOUSEHOLD_PUSH_BATCH_SIZE
-
 
 @dataclass
 class PushProcessor:

src/country_workspace/contrib/kobo/forms.py

@@ -1,8 +1,9 @@
 from typing import Any
 
-from country_workspace.contrib.kobo.sync import make_client
 from django import forms
 
+from country_workspace.contrib.kobo.sync import make_client
+
 
 class ImportKoboForm(forms.Form):
     batch_name = forms.CharField(required=False, help_text="Label for this batch")