Merge pull request #1088 from userlocalhost/feature/trigger/add_named_type

Enable to select named Attributes to Trigger configurations

Author: hinashi

CHANGELOG.md

@@ -3,6 +3,8 @@
 ## In development
 
 ### Added
+* Added Attribute type (`named_object` and `array_named_object`) for TriggerAction
+  Contributed by @userlocalhost, @hinashi
 
 ### Changed
 

apiclient/typescript-fetch/package.json

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

entry/models.py

@@ -2385,9 +2385,12 @@ def _get_value(attrname, attrtype, value):
                 return [_get_value(attrname, attrtype, x) for x in value]
 
             elif attrtype & AttrTypeValue["named"]:
-                [co_value] = list(value.values())
+                [name, ref] = list(value.keys()) + list(value.values())
 
-                return co_value["id"] if co_value else None
+                return {
+                    "id": ref["id"] if ref else None,
+                    "name": name,
+                }
 
             elif attrtype & AttrTypeValue["object"]:
                 return value["id"] if value else None

entry/tests/test_view.py

@@ -7,6 +7,7 @@
 
 import yaml
 from django.conf import settings
+from django.db.models import Q
 from django.http import HttpResponse
 from django.http.response import JsonResponse
 from django.urls import reverse
@@ -1937,31 +1938,55 @@ def test_create_entry_with_trigger_configuration(self):
         user = self.guest_login()
 
         # initialize Entity which has Role related Attributes
+        entity_pref = self.create_entity(user, "Prefecture")
+        self.add_entry(user, "Tokyo", entity_pref)
+        pref_info = {"tokyo": self.add_entry(user, "Tokyo", entity_pref)}
+
         entity = self.create_entity(
             user,
             "Personal Information",
             attrs=[
-                {"name": "address", "type": AttrTypeValue["string"]},
+                {"name": "address", "type": AttrTypeValue["named_object"], "ref": entity_pref},
                 {"name": "age", "type": AttrTypeValue["string"]},
             ],
         )
 
         # register TriggerAction configuration before creating an Entry
         TriggerCondition.register(
             entity,
-            [{"attr_id": entity.attrs.get(name="age").id, "cond": "0"}],
-            [{"attr_id": entity.attrs.get(name="address").id, "value": "Tokyo"}],
+            [
+                {
+                    "attr_id": entity.attrs.get(name="address").id,
+                    "hint": "json",
+                    "cond": json.dumps(
+                        {
+                            "name": "unknown",
+                            "id": None,
+                        }
+                    ),
+                }
+            ],
+            [
+                {"attr_id": entity.attrs.get(name="age").id, "value": "0"},
+                {
+                    "attr_id": entity.attrs.get(name="address").id,
+                    "value": {
+                        "name": "Chiyoda ward",
+                        "id": pref_info["tokyo"],
+                    },
+                },
+            ],
         )
 
         # create an Entry to invoke TriggerAction
         params = {
             "entry_name": "Jhon Doe",
             "attrs": [
                 {
-                    "id": str(entity.attrs.get(name="age").id),
+                    "id": str(entity.attrs.get(name="address").id),
                     "type": str(AttrTypeValue["string"]),
-                    "value": [{"data": "0", "index": 0}],
-                    "referral_key": [],
+                    "value": [{"data": "", "index": 0}],
+                    "referral_key": [{"data": "unknown", "index": 0}],
                 }
             ],
         }
@@ -1974,12 +1999,13 @@ def test_create_entry_with_trigger_configuration(self):
         # check trigger action was worked properly
         job_query = Job.objects.filter(operation=JobOperation.MAY_INVOKE_TRIGGER)
         self.assertEqual(job_query.count(), 1)
-        self.assertEqual(job_query.first().status, JobStatus.DONE)
+        self.assertEqual(job_query.first().status, JobStatus.DONE.value)
 
         # check created Entry's attributes are set properly by TriggerAction
         entry = Entry.objects.get(id=resp.json().get("entry_id"))
         self.assertEqual(entry.get_attrv("age").value, "0")
-        self.assertEqual(entry.get_attrv("address").value, "Tokyo")
+        self.assertEqual(entry.get_attrv("address").value, "Chiyoda ward")
+        self.assertEqual(entry.get_attrv("address").referral.id, pref_info["tokyo"].id)
 
     @patch("entry.tasks.edit_entry_attrs.delay", Mock(side_effect=tasks.edit_entry_attrs))
     def test_edit_entry_with_role_attributes(self):
@@ -2035,22 +2061,46 @@ def test_edit_entry_with_role_attributes(self):
     def test_edit_entry_with_trigger_configuration(self):
         user = self.guest_login()
 
-        # initialize Entity and Entry which will be updated by TriggerAction
+        # initialize Entity which has Role related Attributes
+        entity_pref = self.create_entity(user, "Prefecture")
+        self.add_entry(user, "Tokyo", entity_pref)
+        pref_info = {"tokyo": self.add_entry(user, "Tokyo", entity_pref)}
+
         entity = self.create_entity(
             user,
             "Personal Information",
             attrs=[
+                {"name": "address", "type": AttrTypeValue["named_object"], "ref": entity_pref},
                 {"name": "age", "type": AttrTypeValue["string"]},
-                {"name": "address", "type": AttrTypeValue["string"]},
             ],
         )
         entry = self.add_entry(user, "Jhon Doe", entity)
 
         # register TriggerAction configuration before creating an Entry
         TriggerCondition.register(
             entity,
-            [{"attr_id": entity.attrs.get(name="age").id, "cond": "0"}],
-            [{"attr_id": entity.attrs.get(name="address").id, "value": "Tokyo"}],
+            [
+                {
+                    "attr_id": entity.attrs.get(name="address").id,
+                    "hint": "json",
+                    "cond": json.dumps(
+                        {
+                            "name": "unknown",
+                            "id": None,
+                        }
+                    ),
+                }
+            ],
+            [
+                {"attr_id": entity.attrs.get(name="age").id, "value": "0"},
+                {
+                    "attr_id": entity.attrs.get(name="address").id,
+                    "value": {
+                        "name": "Chiyoda ward",
+                        "id": pref_info["tokyo"],
+                    },
+                },
+            ],
         )
 
         # send request for editing Entry to invoke TriggerAction
@@ -2059,8 +2109,9 @@ def test_edit_entry_with_trigger_configuration(self):
             "attrs": [
                 {
                     "entity_attr_id": "",
-                    "id": str(entry.attrs.get(schema__name="age").id),
-                    "value": [{"data": "0", "index": 0}],
+                    "id": str(entry.attrs.get(schema__name="address").id),
+                    "value": [{"data": "", "index": 0}],
+                    "referral_key": [{"data": "unknown", "index": 0}],
                 }
             ],
         }
@@ -2074,12 +2125,13 @@ def test_edit_entry_with_trigger_configuration(self):
         # check trigger action was worked properly
         job_query = Job.objects.filter(operation=JobOperation.MAY_INVOKE_TRIGGER)
         self.assertEqual(job_query.count(), 1)
-        self.assertEqual(job_query.first().status, JobStatus.DONE)
+        self.assertEqual(job_query.first().status, JobStatus.DONE.value)
 
         # check updated Entry's attributes are set properly by TriggerAction
         self.assertEqual(resp.json().get("entry_id"), entry.id)
         self.assertEqual(entry.get_attrv("age").value, "0")
-        self.assertEqual(entry.get_attrv("address").value, "Tokyo")
+        self.assertEqual(entry.get_attrv("address").value, "Chiyoda ward")
+        self.assertEqual(entry.get_attrv("address").referral.id, pref_info["tokyo"].id)
 
     @patch(
         "entry.tasks.create_entry_attrs.delay",
@@ -4875,45 +4927,61 @@ def test_invoke_trigger_by_revert_attrv(self):
             user,
             "Entity",
             [
-                {"name": "cond", "type": AttrTypeValue["string"]},
+                {"name": "cond_str", "type": AttrTypeValue["string"]},
+                {"name": "cond_name", "type": AttrTypeValue["named_object"]},
                 {"name": "action", "type": AttrTypeValue["string"]},
             ],
         )
-        entry = self.add_entry(
-            user,
-            "TestEntry",
-            entity,
-            values={
-                "cond": "hoge",
-            },
-        )
-
-        # changed value to retrieve
-        changing_attr = entry.attrs.get(name="cond")
-        changing_attr.add_value(user, "changed")
 
         # register TriggerAction configuration before creating an Entry
         TriggerCondition.register(
             entity,
-            [{"attr_id": entity.attrs.get(name="cond").id, "cond": "hoge"}],
+            [{"attr_id": entity.attrs.get(name="cond_str").id, "cond": "hoge"}],
             [{"attr_id": entity.attrs.get(name="action").id, "value": "fuga"}],
         )
-
-        # send request to revert attribute value of "cond"
-        revert_attrv = changing_attr.values.filter(value="hoge").last()
-        params = {"attr_id": str(changing_attr.id), "attrv_id": str(revert_attrv.id)}
-        resp = self.client.post(
-            reverse("entry:revert_attrv"), json.dumps(params), "application/json"
+        TriggerCondition.register(
+            entity,
+            [{"attr_id": entity.attrs.get(name="cond_name").id, "cond": "foo"}],
+            [{"attr_id": entity.attrs.get(name="action").id, "value": "fuga"}],
         )
-        self.assertEqual(resp.status_code, 200)
 
-        # This check that Attribute value of "action" would be updated by TriggerAction
-        self.assertEqual(entry.get_attrv("action").value, "fuga")
+        # changed value to retrieve
+        testing_params = [
+            ("cond_str", "hoge", "changed", Q(value="hoge")),
+            (
+                "cond_name",
+                {"name": "foo", "id": None},
+                {"name": "changed", "id": None},
+                Q(value="foo"),
+            ),
+        ]
+        for index, (attrname, initial_value, changed_value, query) in enumerate(testing_params):
+            entry = self.add_entry(
+                user,
+                "TestEntry",
+                entity,
+                values={
+                    attrname: initial_value,
+                },
+            )
+            changing_attr = entry.attrs.get(name=attrname)
+            changing_attr.add_value(user, changed_value)
 
-        # check trigger action was worked properly
-        job_query = Job.objects.filter(operation=JobOperation.MAY_INVOKE_TRIGGER)
-        self.assertEqual(job_query.count(), 1)
-        self.assertEqual(job_query.first().status, JobStatus.DONE)
+            # send request to revert attribute value of "cond"
+            revert_attrv = changing_attr.values.filter(query).last()
+            params = {"attr_id": str(changing_attr.id), "attrv_id": str(revert_attrv.id)}
+            resp = self.client.post(
+                reverse("entry:revert_attrv"), json.dumps(params), "application/json"
+            )
+            self.assertEqual(resp.status_code, 200)
+
+            # This check that Attribute value of "action" would be updated by TriggerAction
+            self.assertEqual(entry.get_attrv("action").value, "fuga")
+
+            # check trigger action was worked properly
+            job_query = Job.objects.filter(operation=JobOperation.MAY_INVOKE_TRIGGER)
+            self.assertEqual(job_query.count(), 1 + index)
+            self.assertEqual(job_query.last().status, JobStatus.DONE)
 
     def test_revert_attrv_with_invalid_value(self):
         user = self.guest_login()

frontend/src/components/entry/entryForm/AttributeValueField.test.tsx

@@ -34,7 +34,7 @@ const server = setupServer(
   }),
   // getGroups
   http.get("http://localhost/group/api/v2/groups", () => {
-    return HttpResponse.json([]);
+    return HttpResponse.json({ count: 0, results: [] });
   }),
   // getRoles
   http.get("http://localhost/role/api/v2/", () => {

frontend/src/components/entry/entryForm/GroupAttributeValueField.test.tsx

@@ -65,6 +65,7 @@ describe("GroupAttributeValueField", () => {
   };
 
   const groups: PaginatedGroupList = {
+    count: 0,
     results: [
       {
         id: 1,