backoffice: enhance workflow search

* ref: cern-sis/issues-inspire#527
DonHaul · Aug 20, 2024 · a1331b8 · a1331b8
1 parent 8aae25a
commit a1331b8
Show file tree

Hide file tree

Showing 3 changed files with 82 additions and 29 deletions.
diff --git a/backoffice-repo/backoffice-repo/backoffice/backoffice/workflows/api/views.py b/backoffice-repo/backoffice-repo/backoffice/backoffice/workflows/api/views.py
@@ -257,14 +257,17 @@ def __init__(self, *args, **kwargs):
         OrderingFilterBackend,
     ]
     search_fields = {
-        "workflow_type",
-        "status",
-        "is_update",
+        "data.ids.value",
+        "data.ids.schema",
+        "data.name.value",
+        "data.name.preferred_name",
+        "data.email_addresses.value",
     }
 
     filter_fields = {
         "status": "status",
         "workflow_type": "workflow_type",
+        "is_update": "is_update"
     }
 
     ordering_fields = {"_updated_at": "_updated_at"}

diff --git a/backoffice-repo/backoffice-repo/backoffice/backoffice/workflows/documents.py b/backoffice-repo/backoffice-repo/backoffice/backoffice/workflows/documents.py
@@ -9,7 +9,28 @@
 class WorkflowDocument(Document):
     id = fields.TextField()
     workflow_type = fields.KeywordField()
-    data = fields.ObjectField()
+    data = fields.ObjectField(
+        properties={
+            "ids": fields.ObjectField(
+                properties={
+                    "value": fields.KeywordField(),
+                    "schema": fields.KeywordField(),
+                }
+            ),
+            "name": fields.ObjectField(
+                properties={
+                    "value": fields.TextField(),
+                    "preferred_name": fields.TextField(),
+                }
+            ),
+            "email_address": fields.ObjectField(
+                properties={
+                    "value": fields.KeywordField(),
+                    "current": fields.BooleanField(),
+                }
+            )
+        }
+    )
     status = fields.KeywordField()
     is_update = fields.BooleanField()
 

diff --git a/backoffice-repo/backoffice-repo/backoffice/backoffice/workflows/tests/test_views.py b/backoffice-repo/backoffice-repo/backoffice/backoffice/workflows/tests/test_views.py
@@ -398,15 +398,60 @@ class TestWorkflowSearchFilterViewSet(BaseTransactionTestCase):
     def setUp(self):
         super().setUp()
 
-        Workflow.objects.create(
-            data={},
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        Workflow.objects.update_or_create(
+            data={
+                "ids": [
+                    {
+                        "value": "0000-0003-3302-3333",
+                        "schema": "ORCID"
+                    },
+                    {
+                        "value": "CastleFrank",
+                        "schema": "INSPIRE BAI"
+                    }
+                ],
+                "name": {
+                    "value": "Castle, Frank",
+                    "preferred_name": "Frank Castle"
+                },
+                "email_addresses": [
+                    {
+                        "value": "[email protected]",
+                        "current": True
+                    }
+                ]
+            },
             status=StatusChoices.APPROVAL,
             core=True,
             is_update=False,
             workflow_type=WorkflowType.AUTHOR_CREATE,
         )
-        Workflow.objects.create(
-            data={},
+        Workflow.objects.update_or_create(
+            data={
+                "ids": [
+                    {
+                        "value": "0000-0003-3302-2222",
+                        "schema": "ORCID"
+                    },
+                    {
+                        "value": "SmithJohn",
+                        "schema": "INSPIRE BAI"
+                    }
+                ],
+                "name": {
+                    "value": "Smith, John",
+                    "preferred_name": "John Smith"
+                },
+                "email_addresses": [
+                    {
+                        "value": "[email protected]",
+                        "current": True
+                    }
+                ]
+            },
             status=StatusChoices.RUNNING,
             core=True,
             is_update=False,
@@ -421,32 +466,16 @@ def test_facets(self):
         assert "_filter_status" in response.json()["facets"]
         assert "_filter_workflow_type" in response.json()["facets"]
 
-    def test_search_status(self):
-        self.api_client.force_authenticate(user=self.admin)
-
-        url = (
-            reverse("search:workflow-list") + f"?search=status:{StatusChoices.RUNNING}"
-        )
-
-        response = self.api_client.get(url)
-
-        for item in response.json()["results"]:
-            print(item["status"])
-            assert item["status"] == StatusChoices.RUNNING
-
-    def test_search_workflow_type(self):
+    def test_search_data_name(self):
         self.api_client.force_authenticate(user=self.admin)
 
-        url = (
-            reverse("search:workflow-list")
-            + f"?search=workflow_type:{WorkflowType.HEP_CREATE}"
-        )
+        url = reverse("search:workflow-list") + "?search=John"
 
         response = self.api_client.get(url)
+        results = response.json()["results"]
 
-        for item in response.json()["results"]:
-            print(item["workflow_type"])
-            assert item["workflow_type"] == WorkflowType.HEP_CREATE
+        assert len(results) == 1
+        assert results[0]["data"]["name"]["value"] == "Smith, John"
 
     def test_filter_status(self):
         self.api_client.force_authenticate(user=self.admin)