Merge pull request #1140 from hinashi/feature/search_chain/api_v2

Added advanced search chain apiv2

Author: userlocalhost

apiclient/typescript-fetch/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dmm-com/airone-apiclient-typescript-fetch",
-  "version": "0.0.14",
+  "version": "0.0.15",
   "description": "AirOne APIv2 client in TypeScript",
   "main": "src/autogenerated/index.ts",
   "scripts": {

entry/api_v2/urls.py

@@ -74,6 +74,7 @@
         views.EntryAttributeValueRestoreAPI.as_view(),
     ),
     path("advanced_search/", views.AdvancedSearchAPI.as_view()),
+    path("advanced_search_chain/", views.AdvancedSearchChainAPI.as_view()),
     path("import/", views.EntryImportAPI.as_view()),
     path("bulk_delete/", views.EntryBulkDeleteAPI.as_view()),
 ]

entry/api_v2/views.py

@@ -14,6 +14,7 @@
 from rest_framework.response import Response
 
 import custom_view
+from airone.exceptions import ElasticsearchException
 from airone.lib.acl import ACLType
 from airone.lib.drf import (
     DuplicatedObjectExistsError,
@@ -24,6 +25,7 @@
     YAMLParser,
 )
 from airone.lib.types import AttrType, AttrTypeValue
+from api_v1.entry.serializer import EntrySearchChainSerializer
 from entity.models import Entity, EntityAttr
 from entry.api_v2.pagination import EntryReferralPagination
 from entry.api_v2.serializers import (
@@ -510,6 +512,38 @@ def _get_typed_value(type: int) -> str:
         return Response(serializer.initial_data)
 
 
+class AdvancedSearchChainAPI(generics.GenericAPIView):
+    serializer_class = EntrySearchChainSerializer
+    """
+    NOTE For now, it's just copied from /api/v1/entry/search_chain.
+    And the AttributeValue is missing from the response.
+    """
+
+    @extend_schema(
+        request=EntrySearchChainSerializer,
+        responses=EntryBaseSerializer(many=True),
+    )
+    def post(self, request: Request) -> Response:
+        serializer = EntrySearchChainSerializer(data=request.data)
+        serializer.is_valid(raise_exception=True)
+
+        try:
+            (_, ret_data) = serializer.search_entries(request.user)
+        except ElasticsearchException:
+            return Response(
+                {
+                    "reason": (
+                        "Data overflow was happened. " "Please narrow down intermediate conditions"
+                    )
+                },
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
+        entries = Entry.objects.filter(id__in=[x["id"] for x in ret_data])
+
+        return Response(EntryBaseSerializer(entries, many=True).data)
+
+
 class AdvancedSearchResultAPI(generics.GenericAPIView):
     serializer_class = AdvancedSearchResultExportSerializer
 

entry/tests/test_api_v2.py

@@ -4277,6 +4277,76 @@ def test_export_with_all_entities(self):
             ],
         )
 
+    def test_advanced_search_chain(self):
+        ref_entry = self.add_entry(self.user, "RefEntry", self.ref_entity, values={"val": "hoge"})
+        entry = self.add_entry(
+            self.user,
+            "Entry",
+            self.entity,
+            values={
+                "ref": ref_entry.id,
+            },
+        )
+
+        params = {
+            "entities": [self.entity.id],
+            "attrs": [{"name": "ref", "attrs": [{"name": "val", "value": "hoge"}]}],
+        }
+        resp = self.client.post(
+            "/entry/api/v2/advanced_search_chain/", json.dumps(params), "application/json"
+        )
+        self.assertEqual(resp.status_code, 200)
+        self.assertEqual(
+            resp.json(),
+            [
+                {
+                    "id": entry.id,
+                    "name": "Entry",
+                    "schema": {
+                        "id": entry.schema.id,
+                        "name": "test-entity",
+                        "is_public": True,
+                    },
+                    "is_active": True,
+                    "deleted_user": None,
+                    "deleted_time": None,
+                    "updated_time": entry.updated_time.astimezone(self.TZ_INFO).isoformat(),
+                },
+            ],
+        )
+
+        # empty result case
+        params = {
+            "entities": [self.entity.id],
+            "attrs": [{"name": "ref", "attrs": [{"name": "val", "value": "fuga"}]}],
+        }
+        resp = self.client.post(
+            "/entry/api/v2/advanced_search_chain/", json.dumps(params), "application/json"
+        )
+        self.assertEqual(resp.status_code, 200)
+        self.assertEqual(resp.json(), [])
+
+        # bad request case
+        params = {
+            "entities": [self.entity.id],
+            "attrs": [{"name": "ref", "attrs": [{"value": "fuga"}]}],
+        }
+        resp = self.client.post(
+            "/entry/api/v2/advanced_search_chain/", json.dumps(params), "application/json"
+        )
+        self.assertEqual(resp.status_code, 400)
+        self.assertEqual(
+            resp.json(),
+            {
+                "non_field_errors": [
+                    {
+                        "code": "AE-121000",
+                        "message": "Invalid condition({'value': 'fuga'}) was specified",
+                    }
+                ]
+            },
+        )
+
     def test_entry_history(self):
         values = {
             "val": {"value": "hoge", "result": {"as_string": "hoge"}},

frontend/src/repository/AironeApiClient.ts

@@ -18,6 +18,7 @@ import {
   EntryBase,
   EntryCopy,
   EntryRetrieve,
+  EntrySearchChain,
   GetEntryAttrReferral,
   Group,
   GroupApi,
@@ -709,6 +710,22 @@ class AironeApiClient {
     );
   }
 
+  async advancedSearchChain(
+    entrySearchChain: EntrySearchChain
+  ): Promise<EntryBase[]> {
+    return await this.entry.entryApiV2AdvancedSearchChainCreate(
+      {
+        entrySearchChain: entrySearchChain,
+      },
+      {
+        headers: {
+          "X-CSRFToken": getCsrfToken(),
+          "Content-Type": "application/json;charset=utf-8",
+        },
+      }
+    );
+  }
+
   async exportAdvancedSearchResults(
     entityIds: number[],
     attrinfo: Array<AdvancedSearchResultAttrInfo>,

package-lock.json

@@ -78,7 +78,7 @@
     "zod": "^3.22.4"
   },
   "dependencies": {
-    "@dmm-com/airone-apiclient-typescript-fetch": "^0.0.14",
+    "@dmm-com/airone-apiclient-typescript-fetch": "^0.0.15",
     "@emotion/react": "^11.10.5",
     "@emotion/styled": "^11.10.5",
     "@jest/globals": "^27.0.6",