Move AuditEvent.path to being a UrlPath

airlock/business_logic.py

@@ -86,7 +86,7 @@ class AuditEvent:
     user: str
     workspace: str | None = None
     request: str | None = None
-    path: str | None = None
+    path: UrlPath | None = None
     extra: dict[str, str] = field(default_factory=dict)
     # this is used when querying the db for audit log times
     created_at: datetime = field(default_factory=timezone.now, compare=False)
@@ -110,7 +110,7 @@ def from_request(
             extra=kwargs,
         )
         if path:
-            event.path = str(path)
+            event.path = path
 
         return event
 
@@ -902,7 +902,7 @@ def audit_workspace_file_access(
             type=AuditEventType.WORKSPACE_FILE_VIEW,
             user=user.username,
             workspace=workspace.name,
-            path=str(path),
+            path=path,
         )
         bll._dal.audit_event(audit)
 

local_db/data_access.py

@@ -227,7 +227,7 @@ def _create_audit_log(self, audit: AuditEvent) -> AuditLog:
             user=audit.user,
             workspace=audit.workspace,
             request=audit.request,
-            path=audit.path,
+            path=str(audit.path) if audit.path else None,
             extra=audit.extra,
             created_at=audit.created_at,
         )
@@ -263,7 +263,7 @@ def get_audit_log(
                 user=audit.user,
                 workspace=audit.workspace,
                 request=audit.request,
-                path=audit.path,
+                path=UrlPath(audit.path) if audit.path else None,
                 extra=audit.extra,
                 created_at=audit.created_at,
             )

tests/factories.py

@@ -1,6 +1,6 @@
 from django.conf import settings
 
-from airlock.business_logic import AuditEvent, RequestFileType, Workspace, bll
+from airlock.business_logic import AuditEvent, RequestFileType, UrlPath, Workspace, bll
 from airlock.users import User
 
 
@@ -98,15 +98,15 @@ def create_audit_event(
     user="user",
     workspace="workspace",
     request="request",
-    path="foo/bar",
+    path=UrlPath("foo/bar"),
     extra={"foo": "bar"},
 ):
     event = AuditEvent(
         type=type_,
         user=user,
         workspace=workspace,
         request=request,
-        path=path,
+        path=UrlPath(path) if path else None,
         extra=extra,
     )
     bll._dal.audit_event(event)

tests/integration/views/test_request.py

@@ -3,7 +3,13 @@
 import pytest
 import requests
 
-from airlock.business_logic import AuditEventType, RequestFileType, RequestStatus, bll
+from airlock.business_logic import (
+    AuditEventType,
+    RequestFileType,
+    RequestStatus,
+    UrlPath,
+    bll,
+)
 from tests import factories
 from tests.conftest import get_trace
 
@@ -180,7 +186,7 @@ def test_request_contents_file(airlock_client):
         request=release_request.id,
     )
     assert audit_log[0].type == AuditEventType.REQUEST_FILE_VIEW
-    assert audit_log[0].path == "default/file.txt"
+    assert audit_log[0].path == UrlPath("default/file.txt")
     assert audit_log[0].extra["group"] == "default"
 
 
@@ -223,7 +229,7 @@ def test_request_download_file(airlock_client):
         request=release_request.id,
     )
     assert audit_log[0].type == AuditEventType.REQUEST_FILE_DOWNLOAD
-    assert audit_log[0].path == "default/file.txt"
+    assert audit_log[0].path == UrlPath("default/file.txt")
     assert audit_log[0].extra["group"] == "default"
 
 

tests/integration/views/test_workspace.py

@@ -224,7 +224,7 @@ def test_workspace_contents_file(airlock_client):
         workspace="workspace",
     )
     assert audit[0].type == AuditEventType.WORKSPACE_FILE_VIEW
-    assert audit[0].path == "file.txt"
+    assert audit[0].path == UrlPath("file.txt")
 
 
 def test_workspace_contents_dir(airlock_client):