fix: The problem of getting wrong ObjectID in some special scenarios (#65)

Fix issue

[Change tracking will capture the wrong objectID in some special
cases.](#60)

Co-authored-by: I560824 <[email protected]>

Author: Sv7enNowitzki

lib/entity-helper.js

@@ -113,7 +113,7 @@ async function getObjectId (reqData, entityName, fields, curObj) {
         path.shift()
       }
       field = path.join('_')
-      let obj = _db_data[field] || req_data[field]
+      let obj = current.name === entityName && req_data[field] ? req_data[field] : _db_data[field]
       if (obj) all.push(obj)
     } else {
       let e = entity.elements[field]

tests/bookshop/db/schema.cds

@@ -185,6 +185,10 @@ entity Report : cuid {
 }
 
 entity Order : cuid {
+  @title     : '{i18n>title}'
+  @changelog
+  title      : String;
+  type       : Association to one OrderType;
   report     : Association to one Report;
   header     : Composition of one OrderHeader;
   orderItems : Composition of many OrderItem
@@ -193,6 +197,12 @@ entity Order : cuid {
   status     : String;
 }
 
+entity OrderType : cuid {
+  @title: '{i18n>title}'
+  @changelog
+  title : String;
+}
+
 entity Customers : cuid {
   name       : String;
   city       : String;

tests/integration/fiori-draft-disabled.test.js

@@ -426,6 +426,31 @@ describe("change log draft disabled test", () => {
         delete cds.services.AdminService.entities.OrderItem["@changelog"];
         delete cds.services.AdminService.entities.Level2Object["@changelog"];
         delete cds.services.AdminService.entities.Level3Object["@changelog"];
+
+        cds.db.entities.Order["@changelog"] = [
+            { "=": "title" },
+            { "=": "type.title" },
+        ]
+        await POST(
+            `/odata/v4/admin/Order`,
+            {
+                ID: "0a41a187-a2ff-4df6-bd12-fae8996e7c44",
+                title: "test Order title",
+            },
+        );
+
+        const createOrderChanges = await adminService.run(
+            SELECT.from(ChangeView).where({
+                entity: "sap.capire.bookshop.Order",
+                attribute: "title",
+                modification: "create",
+            }),
+        );
+
+        expect(createOrderChanges.length).to.equal(1);
+        const createOrderChange = createOrderChanges[0];
+        expect(createOrderChange.objectID).to.equal("test Order title");
+        delete cds.db.entities.Order["@changelog"];
     });
 
     it("8.2 Annotate fields from chained associated entities as displayed value (ERP4SMEPREPWORKAPPPLAT-1094 ERP4SMEPREPWORKAPPPLAT-4542)", async () => {

tests/integration/fiori-draft-enabled.test.js

@@ -788,7 +788,34 @@ describe("change log integration test", () => {
         cds.services.AdminService.entities.BookStores["@changelog"] = [{ "=": "name" }];
     });
 
-    it("7.1 Annotate fields from chained associated entities as objectID (ERP4SMEPREPWORKAPPPLAT-993 ERP4SMEPREPWORKAPPPLAT-4542)", async () => {
+    it("7.1 Annotate fields from chained associated entities as objectID (ERP4SMEPREPWORKAPPPLAT-993)", async () => {
+        cds.services.AdminService.entities.BookStores["@changelog"].push({ "=": "city.name" })
+        
+        const createBookStoresAction = POST.bind({}, `/odata/v4/admin/BookStores`, {
+            ID: "9d703c23-54a8-4eff-81c1-cdce6b6587c4",
+            name: "new name",
+        });
+        await utils.apiAction(
+            "admin",
+            "BookStores",
+            "9d703c23-54a8-4eff-81c1-cdce6b6587c4",
+            "AdminService",
+            createBookStoresAction,
+            true
+        );
+
+        const BookStoresChanges = await adminService.run(
+            SELECT.from(ChangeView).where({
+                entity: "sap.capire.bookshop.BookStores",
+                attribute: "name",
+            })
+        );
+        expect(BookStoresChanges.length).to.equal(1);
+        const BookStoresChange = BookStoresChanges[0];
+        expect(BookStoresChange.objectID).to.equal("new name");
+
+        delete cds.services.AdminService.entities.BookStores["@changelog"];
+
         cds.services.AdminService.entities.Books["@changelog"] = [
             { "=": "bookStore.lifecycleStatus.name" },
             { "=": "bookStore.location" },

tests/integration/service-api.test.js

@@ -70,6 +70,24 @@ describe("change log integration test", () => {
     });
 
     it("7.3 Annotate fields from chained associated entities as objectID (ERP4SMEPREPWORKAPPPLAT-4542)", async () => {
+        cds.services.AdminService.entities.BookStores["@changelog"].push({ "=": "city.name" })
+
+        const bookStoreData = {
+            ID: "9d703c23-54a8-4eff-81c1-cdce6b6587c4",
+            name: "new name",
+        };
+        await adminService.run(INSERT.into(adminService.entities.BookStores).entries(bookStoreData));
+        let createBookStoresChanges = await SELECT.from(ChangeView).where({
+            entity: "sap.capire.bookshop.BookStores",
+            attribute: "name",
+            modification: "create",
+        });
+        expect(createBookStoresChanges.length).to.equal(1);
+        const createBookStoresChange = createBookStoresChanges[0];
+        expect(createBookStoresChange.objectID).to.equal("new name");
+
+        cds.services.AdminService.entities.BookStores["@changelog"].pop();
+        
         const level3EntityData = [
             {
                 ID: "12ed5dd8-d45b-11ed-afa1-0242ac654321",