@cap-js/change-tracking 1.0.4 → 1.0.6

package/CHANGELOG.md

@@ -4,6 +4,28 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## Version 1.0.6 - TBD
+
+### Fixed
+
+ -  Storage of wrong ObjectID in some special scenarios
+ -  Missing localization of managed fields
+ -  Views without keys won't get the association and UI facet pushed anymore
+
+### Added
+
+ - A method to disable automatic generation of the UI Facet
+
+### Changed
+
+ - Improved documentation of the @changelog Annotation
+
+## Version 1.0.5 - 15.01.24
+
+### Fixed
+
+- Error on HANA when logging Boolean or Numeric Data
+
 ## Version 1.0.4 - 08.01.24
 
 ### Added

package/README.md

@@ -10,12 +10,10 @@ The `@cap-js/change-tracking` package is a [CDS plugin](https://cap.cloud.sap/do
 
 <img width="1300" alt="change-history-loading" src="_assets/change-history.gif">
 
-
-
 ### Table of Contents
 
 - [Change Tracking Plugin for SAP Cloud Application Programming Model (CAP)](#change-tracking-plugin-for-sap-cloud-application-programming-model-cap)
-    - [Table of Contents](#table-of-contents)
+  - [Table of Contents](#table-of-contents)
   - [Preliminaries](#preliminaries)
   - [Setup](#setup)
   - [Annotations](#annotations)
@@ -27,12 +25,16 @@ The `@cap-js/change-tracking` package is a [CDS plugin](https://cap.cloud.sap/do
   - [Customizations](#customizations)
     - [Altered table view](#altered-table-view)
     - [Disable lazy loading](#disable-lazy-loading)
+    - [Disable UI Facet generation](#disable-ui-facet-generation)
+    - [Disable Association to Changes Generation](#disable-association-to-changes-generation)
+  - [Modelling Samples](#modelling-samples)
+    - [Specify Object ID](#specify-object-id)
+    - [Tracing Changes](#tracing-changes)
+    - [Don'ts](#donts)
   - [Contributing](#contributing)
   - [Code of Conduct](#code-of-conduct)
   - [Licensing](#licensing)
 
-
-
 ## Preliminaries
 
 In this guide, we use the [Incidents Management reference sample app](https://github.com/cap-js/incidents-app) as the base to add change tracking to. Clone the repository and apply the step-by-step instructions:
@@ -55,8 +57,6 @@ npm i
 cds w samples/change-tracking
 ```
 
-
-
 ## Setup
 
 To enable change tracking, simply add this self-configuring plugin package to your project:
@@ -65,8 +65,6 @@ To enable change tracking, simply add this self-configuring plugin package to yo
 npm add @cap-js/change-tracking
 ```
 
-
-
 ## Annotations
 
 > [!WARNING]
@@ -92,7 +90,6 @@ The minimal annotation we require for change tracking is `@changelog` on element
 
 Additional identifiers or labels can be added to obtain more *human-readable* change records as described below.
 
-
 ### Human-readable Types and Fields
 
 By default the implementation looks up *Object Type* names or *Field* namesfrom respective  `@title` or  `@Common.Label` annotations, and applies i18n lookups. If no such annotations are given, the technical names of the respective CDS definitions are displayed.
@@ -111,7 +108,6 @@ We get a human-readable display for *Object Type*:
 
 <img width="1300" alt="change-history-type-hr" src="_assets/changes-type-hr-wbox.png">
 
-
 ### Human-readable IDs
 
 The changelog annotations for *Object ID* are defined at entity level.
@@ -123,6 +119,7 @@ For example, having a `@changelog` annotation without any additional identifiers
 ```cds
 annotate ProcessorService.Conversations {
 ```
+
 <img width="1300" alt="change-history-id" src="_assets/changes-id-wbox.png">
 
 However, this is not advisable as we cannot easily distinguish between changes. It is more appropriate to annotate as follows:
@@ -130,11 +127,11 @@ However, this is not advisable as we cannot easily distinguish between changes.
 ```cds
 annotate ProcessorService.Conversations with @changelog: [author, timestamp] {
 ```
+
 <img width="1300" alt="change-history-id-hr" src="_assets/changes-id-hr-wbox.png">
 
 Expanding the changelog annotation by additional identifiers `[author, timestamp]`, we can now better identify the `message` change events by their respective author and timestamp.
 
-
 ### Human-readable Values
 
 The changelog annotations for *New Value* and *Old Value* are defined at element level.
@@ -144,7 +141,7 @@ They are already human-readable by default, unless the `@changelog` definition c
 For example, having a `@changelog` annotation without any additional identifiers, changes to incident customer would show up as UUIDs:
 
 ```cds
-  customer @changelog;
+customer @changelog;
 ```
 
 <img width="1300" alt="change-history-value" src="_assets/changes-value-wbox.png">
@@ -152,20 +149,21 @@ For example, having a `@changelog` annotation without any additional identifiers
 Hence, here it is essential to add a unique identifier to obtain human-readable value columns:
 
 ```cds
-  customer @changelog: [customer.name];
+customer @changelog: [customer.name];
 ```
 
 <img width="1300" alt="change-history-value-hr" src="_assets/changes-value-hr-wbox.png">
 
-
 ## Test-drive locally
 
 With the steps above, we have successfully set up change tracking for our reference application. Let's see that in action.
 
 1. **Start the server**:
-  ```sh
-  cds watch
-  ```
+
+```sh
+cds watch
+```
+
 2. **Make a change** on your change-tracked elements. This change will automatically be persisted in the database table (`sap.changelog.ChangeLog`) and made available in a pre-defined view, namely the [Change History view](#change-history-view) for your convenience.
 
 ## Change History View
@@ -218,21 +216,332 @@ annotate sap.changelog.aspect @(UI.Facets: [{
   Target: 'changes/@UI.PresentationVariant',
   ![@UI.PartOfPreview]
 }]);
-
 ```
 
 The system now uses the SAPUI5 default setting `![@UI.PartOfPreview]: true`, such that the table will always shown when navigating to that respective Object page.
 
+### Disable UI Facet generation
+
+If you do not want the UI facet added to a specific UI, you can annotate the service entity with `@changelog.disable_facet`. This will disable the automatic addition of the UI faced to this specific entity, but also all views or further projections up the chain.
+
+### Disable Association to Changes Generation
+
+For some scenarios, e.g. when doing `UNION` and the `@changelog` annotion is still propageted, the automatic addition of the association to `changes` does not make sense. You can use `@changelog.disable_assoc`for this to be disabled on entity level.
+
+> [!IMPORTANT]
+> This will also supress the addition of the UI facet, since the change-view is not available as target entity anymore.
+
+## Modelling Samples
+
+This chapter describes more modelling cases for further reference, from simple to complex, including but not limited to the followings.
+
+### Specify Object ID
+
+Use cases for Object ID annotation
+
+#### Use Case 1: Annotate single field/multiple fields of associated table(s) as the Object ID
+
+Modelling in `db/schema.cds`
+
+```cds
+entity Incidents : cuid, managed {
+  ...
+  customer       : Association to Customers;
+  title          : String @title: 'Title';
+  urgency        : Association to Urgency default 'M';
+  status         : Association to Status default 'N';
+  ...
+}
+```
+
+Add the following `@changelog` annotations in `srv/change-tracking.cds`
+
+```cds
+annotate ProcessorService.Incidents with @changelog: [customer.name, urgency.code, status.criticality] {
+  title    @changelog;
+}
+```
+
+![AssociationID](_assets/AssociationID.png)
+
+#### Use Case 2: Annotate single field/multiple fields of project customized types as the Object ID
+
+Modelling in `db/schema.cds`
+
+```cds
+entity Incidents : cuid, managed {
+  ...
+  customer       : Association to Customers;
+  title          : String @title: 'Title';
+  ...
+}
+
+entity Customers : cuid, managed {
+  ...
+  email          : EMailAddress;  // customized type
+  phone          : PhoneNumber;   // customized type
+  ...
+}
+```
+
+Add the following `@changelog` annotations in `srv/change-tracking.cds`
+
+```cds
+annotate ProcessorService.Incidents with @changelog: [customer.email, customer.phone] {
+  title    @changelog;
+}
+```
+
+![CustomTypeID](_assets/CustomTypeID.png)
+
+#### Use Case 3: Annotate chained associated entities from the current entity as the Object ID
+
+Modelling in `db/schema.cds`
+
+```cds
+entity Incidents : cuid, managed {
+  ...
+  customer       : Association to Customers;
+  ...
+}
+
+entity Customers : cuid, managed {
+  ...
+  addresses : Association to Addresses;
+  ...
+}
+```
+
+Add the following `@changelog` annotations in `srv/change-tracking.cds`
+
+```cds
+annotate ProcessorService.Incidents with @changelog: [customer.addresses.city, customer.addresses.postCode] {
+  title    @changelog;
+}
+```
+
+![ChainedAssociationID](_assets/ChainedAssociationID.png)
+
+> Change-tracking supports annotating chained associated entities from the current entity as object ID of current entity in case the entity in consumer applications is a pure relation table. However, the usage of chained associated entities is not recommended due to performance cost.
+
+### Tracing Changes
+
+Use cases for tracing changes
+
+#### Use Case 1: Trace the changes of child nodes from the current entity and display the meaningful data from child nodes (composition relation)
+
+Modelling in `db/schema.cds`
+
+```cds
+entity Incidents : managed, cuid {
+  ...
+  title          : String @title: 'Title';
+  conversation   : Composition of many Conversation;
+  ...
+}
+
+aspect Conversation: managed, cuid {
+    ...
+    message   : String;
+}
+```
+
+Add the following `@changelog` annotations in `srv/change-tracking.cds`
+
+```cds
+annotate ProcessorService.Incidents with @changelog: [title] {
+  conversation @changelog: [conversation.message];
+}
+```
+
+![CompositionChange](_assets/CompositionChange.png)
+
+#### Use Case 2: Trace the changes of associated entities from the current entity and display the meaningful data from associated entities (association relation)
+
+Modelling in `db/schema.cds`
+
+```cds
+entity Incidents : cuid, managed {
+  ...
+  customer       : Association to Customers;
+  title          : String @title: 'Title';
+  ...
+}
+
+entity Customers : cuid, managed {
+  ...
+  email          : EMailAddress;
+  ...
+}
+```
+
+Add the following `@changelog` annotations in `srv/change-tracking.cds`
+
+```cds
+annotate ProcessorService.Incidents with @changelog: [title] {
+  customer @changelog: [customer.email];
+}
+```
+
+![AssociationChange](_assets/AssociationChange.png)
+
+#### Use Case 3: Trace the changes of fields defined by project customized types and display the meaningful data
+
+Modelling in `db/schema.cds`
+
+```cds
+type StatusType : Association to Status;
+
+entity Incidents : cuid, managed {
+  ...
+  title          : String @title: 'Title';
+  status         : StatusType default 'N';
+  ...
+}
+```
+
+Add the following `@changelog` annotations in `srv/change-tracking.cds`
+
+```cds
+annotate ProcessorService.Incidents with @changelog: [title] {
+  status   @changelog: [status.code];
+}
+```
+
+![CustomTypeChange](_assets/CustomTypeChange.png)
+
+#### Use Case 4: Trace the changes of chained associated entities from the current entity and display the meaningful data from associated entities (association relation)
+
+Modelling in `db/schema.cds`
+
+```cds
+entity Incidents : cuid, managed {
+  ...
+  title          : String @title: 'Title';
+  customer       : Association to Customers;
+  ...
+}
+
+entity Customers : cuid, managed {
+  ...
+  addresses : Association to Addresses;
+  ...
+}
+```
+
+Add the following `@changelog` annotations in `srv/change-tracking.cds`
+
+```cds
+annotate ProcessorService.Incidents with @changelog: [title] {
+  customer @changelog: [customer.addresses.city, customer.addresses.streetAddress];
+}
+```
+
+![ChainedAssociationChange](_assets/ChainedAssociationChange.png)
+
+> Change-tracking supports analyzing chained associated entities from the current entity in case the entity in consumer applications is a pure relation table. However, the usage of chained associated entities is not recommended due to performance cost.
+
+#### Use Case 5: Trace the changes of union entity and display the meaningful data
+
+`Payable.cds`:
+
+```cds
+entity Payables : cuid {
+    displayId    : String;
+    @changelog
+    name         : String;
+    cryptoAmount : Decimal;
+    fiatAmount   : Decimal;
+};
+```
+
+`Payment.cds`:
+
+```cds
+entity Payments : cuid {
+    displayId : String; //readable ID
+    @changelog
+    name      : String;
+};
+```
+
+Union entity in `BusinessTransaction.cds`:
+
+```cds
+entity BusinessTransactions          as(
+    select from payments.Payments{
+        key ID,
+            displayId,
+            name,
+            changes  : Association to many ChangeView
+                on changes.objectID = ID AND changes.entity = 'payments.Payments'
+    }
+)
+union all
+(
+    select from payables.Payables {
+        key ID,
+            displayId,
+            name,
+            changes  : Association to many ChangeView
+               on changes.objectID = ID AND changes.entity = 'payables.Payables'
+    }
+);
+```
+
+![UnionChange.png](_assets/UnionChange.png)
+
+### Don'ts
+
+Don'ts
+
+#### Use Case 1: Don't trace changes for field(s) with `Association to many`
+
+```cds
+entity Customers : cuid, managed {
+  ...
+  incidents : Association to many Incidents on incidents.customer = $self;
+}
+```
+
+The reason is that: the relationship: `Association to many` is only for modelling purpose and there is no concrete field in database table. In the above sample, there is no column for incidents in the table Customers, but there is a navigation property of incidents in Customers OData entity metadata.
+
+#### Use Case 2: Don't trace changes for field(s) with *Unmanaged Association*
+
+```cds
+entity AggregatedBusinessTransactionData @(cds.autoexpose) : cuid {
+    FootprintInventory: Association to one FootprintInventories
+                        on  FootprintInventory.month                      = month
+                        and FootprintInventory.year                       = year
+                        and FootprintInventory.FootprintInventoryScope.ID = FootprintInventoryScope.ID;
+    ...
+}
+```
+
+The reason is that: When deploying to relational databases, Associations are mapped to foreign keys. Yet, when mapped to non-relational databases they're just references. More details could be found in [Prefer Managed Associations](https://cap.cloud.sap/docs/guides/domain-models#managed-associations). In the above sample, there is no column for FootprintInventory in the table AggregatedBusinessTransactionData, but there is a navigation property FootprintInventoryof in OData entity metadata.
+
+#### Use Case 3: Don't trace changes for CUD on DB entity
+
+```cds
+this.on("UpdateActivationStatus", async (req) =>
+    // PaymentAgreementsOutgoingDb is the DB entity
+    await UPDATE.entity(PaymentAgreementsOutgoingDb)
+        .where({ ID: paymentAgreement.ID })
+        .set({ ActivationStatus_code: ActivationCodes.ACTIVE });
+);
+```
+
+The reason is that: Application level services are by design the only place where business logic is enforced. This by extension means, that it also is the only point where e.g. change-tracking would be enabled. The underlying method used to do change tracking is `req.diff` which is responsible to read the necessary before-image from the database, and this method is not available on DB level.
+
 ## Contributing
 
 This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/cap-js/change-tracking/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
 
-
 ## Code of Conduct
 
 We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](CODE_OF_CONDUCT.md) at all times.
 
-
 ## Licensing
 
 Copyright 2023 SAP SE or an SAP affiliate company and contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/cap-js/change-tracking).
+

package/cds-plugin.js

@@ -40,12 +40,19 @@ cds.on('loaded', m => {
       const keys = [], { elements: elms } = entity
       for (let e in elms) if (elms[e].key) keys.push(e)
 
+      // If no key attribute is defined for the entity, the logic to add association to ChangeView should be skipped.
+      if(keys.length === 0) {
+        continue;
+      }
+
       // Add association to ChangeView...
       const on = [...changes.on]; keys.forEach((k, i) => { i && on.push('||'); on.push({
         ref: k === 'up_' ? [k,'ID'] : [k] // REVISIT: up_ handling is a dirty hack for now
       })})
       const assoc = { ...changes, on }
       const query = entity.projection || entity.query?.SELECT
+      if(!entity['@changelog.disable_assoc'])
+      {
       if (query) {
         (query.columns ??= ['*']).push({ as: 'changes', cast: assoc })
       } else {
@@ -53,8 +60,9 @@ cds.on('loaded', m => {
       }
 
       // Add UI.Facet for Change History List
-      entity['@UI.Facets']?.push(facet)
-
+      if(!entity['@changelog.disable_facet'])
+        entity['@UI.Facets']?.push(facet)
+      }
       // The changehistory list should be refreshed after the custom action is triggered
       if (entity.actions) {
 

package/index.cds

@@ -40,8 +40,8 @@ entity ChangeLog : managed, cuid {
   serviceEntity : String @title: '{i18n>ChangeLog.serviceEntity}'; // definition name of target entity (on service level) - e.g. ProcessorsService.Incidents
   entity        : String @title: '{i18n>ChangeLog.entity}'; // definition name of target entity (on db level) - e.g. sap.capire.incidents.Incidents
   entityKey     : UUID   @title: '{i18n>ChangeLog.entityKey}'; // primary key of target entity, e.g. Incidents.ID
-  createdAt     : managed:createdAt @title: 'On';
-  createdBy     : managed:createdBy @title: 'By';
+  createdAt     : managed:createdAt;
+  createdBy     : managed:createdBy;
   changes       : Composition of many Changes on changes.changeLog = $self;
 }
 

package/lib/change-log.js

@@ -97,7 +97,7 @@ const _getEntityIDs = function (txParams) {
  * ...
  * }
  */
-const _formatAssociationContext = async function (changes) {
+const _formatAssociationContext = async function (changes, reqData) {
   for (const change of changes) {
     const a = cds.model.definitions[change.serviceEntity].elements[change.attribute]
     if (a?.type !== "cds.Association") continue
@@ -111,10 +111,10 @@ const _formatAssociationContext = async function (changes) {
       SELECT.one.from(a.target).where({ [ID]: change.valueChangedTo })
     ])
 
-    const fromObjId = await getObjectId(a.target, semkeys, { curObjFromDbQuery: from || undefined }) // Note: ... || undefined is important for subsequent object destructuring with defaults
+    const fromObjId = await getObjectId(reqData, a.target, semkeys, { curObjFromDbQuery: from || undefined }) // Note: ... || undefined is important for subsequent object destructuring with defaults
     if (fromObjId) change.valueChangedFrom = fromObjId
 
-    const toObjId = await getObjectId(a.target, semkeys, { curObjFromDbQuery: to || undefined }) // Note: ... || undefined is important for subsequent object destructuring with defaults
+    const toObjId = await getObjectId(reqData, a.target, semkeys, { curObjFromDbQuery: to || undefined }) // Note: ... || undefined is important for subsequent object destructuring with defaults
     if (toObjId) change.valueChangedTo = toObjId
 
     const isVLvA = a["@Common.ValueList.viaAssociation"]
@@ -219,7 +219,7 @@ const _getObjectIdByPath = async function (
   const entityUUID = getUUIDFromPathVal(nodePathVal)
   const obj = await getCurObjFromDbQuery(entityName, entityUUID)
   const curObj = { curObjFromReqData, curObjFromDbQuery: obj }
-  return getObjectId(entityName, objIdElementNames, curObj)
+  return getObjectId(reqData, entityName, objIdElementNames, curObj)
 }
 
 const _formatObjectID = async function (changes, reqData) {
@@ -267,7 +267,7 @@ const _isCompositionContextPath = function (aPath) {
 
 const _formatChangeLog = async function (changes, req) {
   await _formatObjectID(changes, req.data)
-  await _formatAssociationContext(changes)
+  await _formatAssociationContext(changes, req.data)
   await _formatCompositionContext(changes, req.data)
 }
 
@@ -301,8 +301,8 @@ function _trackedChanges4 (srv, target, diff) {
         entity: getDBEntity(element.parent).name,
         serviceEntity: element.parent.name,
         attribute: element["@odata.foreignKey4"] || key,
-        valueChangedFrom: from || '',
-        valueChangedTo: to || '',
+        valueChangedFrom: from?? '',
+        valueChangedTo: to?? '',
         valueDataType: element.type,
         modification: row._op,
         keys,
@@ -349,7 +349,7 @@ async function track_changes (req) {
   let isComposition = _isCompositionContextPath(req.context.path)
   let entityKey = diff.ID
 
-  if (req.event === "DELETE") {
+  if (cds.transaction(req).context.event === "DELETE") {
     if (isDraftEnabled || !isComposition) {
       return await DELETE.from(`sap.changelog.ChangeLog`).where({ entityKey })
     }
@@ -367,7 +367,11 @@ async function track_changes (req) {
     entity: dbEntity.name,
     entityKey: entityKey,
     serviceEntity: target.name,
-    changes: changes.filter(c => c.valueChangedFrom || c.valueChangedTo),
+    changes: changes.filter(c => c.valueChangedFrom || c.valueChangedTo).map((c) => ({
+      ...c,
+      valueChangedFrom: `${c.valueChangedFrom ?? ''}`,
+      valueChangedTo: `${c.valueChangedTo ?? ''}`,
+    })),
   })
 }
 

package/lib/entity-helper.js

@@ -70,7 +70,7 @@ const getCurObjFromReqData = function (reqData, nodePathVal, pathVal) {
 }
 
 
-async function getObjectId (entityName, fields, curObj) {
+async function getObjectId (reqData, entityName, fields, curObj) {
   let all = [], { curObjFromReqData: req_data={}, curObjFromDbQuery: db_data={} } = curObj
   let entity = cds.model.definitions[entityName]
   if (!fields?.length) fields = entity["@changelog"]?.map?.(k => k['='] || k) || []
@@ -81,13 +81,30 @@ async function getObjectId (entityName, fields, curObj) {
       while (path.length > 1) {
         let assoc = current.elements[path[0]]; if (!assoc?.isAssociation) break
         let foreignKey = assoc.keys?.[0]?.$generatedFieldName
-        let IDval = req_data[foreignKey] || _db_data[foreignKey]
+        let IDval =
+        req_data[foreignKey] && current.name === entityName
+          ? req_data[foreignKey]
+          : _db_data[foreignKey]
         if (IDval) try {
           // REVISIT: This always reads all elements -> should read required ones only!
           let ID = assoc.keys?.[0]?.ref[0] || 'ID'
-          // When parent/child nodes are created simultaneously, data is taken from draft table
-          _db_data = await SELECT.one.from(assoc._target).where({[ID]: IDval}) ||
-            await SELECT.one.from(`${assoc._target}.drafts`).where({[ID]: IDval}) || {}
+          const isComposition = hasComposition(assoc._target, current)
+          // Peer association and composition are distinguished by the value of isComposition.
+          if (isComposition) {
+            // This function can recursively retrieve the desired information from reqData without having to read it from db.
+            _db_data = _getCompositionObjFromReq(reqData, IDval)
+            // When multiple layers of child nodes are deleted at the same time, the deep layer of child nodes will lose the information of the upper nodes, so data needs to be extracted from the db.
+            if (!_db_data || JSON.stringify(_db_data) === '{}') {
+              _db_data =
+                (await SELECT.one
+                  .from(assoc._target)
+                  .where({ [ID]: IDval })) || {}
+            }
+          } else {
+            _db_data =
+              (await SELECT.one.from(assoc._target).where({ [ID]: IDval })) ||
+              {}
+          }
         } catch (e) {
           LOG.error("Failed to generate object Id for an association entity.", e)
           throw new Error("Failed to generate object Id for an association entity.", e)
@@ -96,7 +113,7 @@ async function getObjectId (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]
@@ -134,6 +151,39 @@ const getValueEntityType = function (entityName, fields) {
   return types.join(', ')
 }
 
+const hasComposition = function (parentEntity, subEntity) {
+  if (!parentEntity.compositions) {
+    return false
+  }
+
+  const compositions = Object.values(parentEntity.compositions);
+
+  for (const composition of compositions) {
+    if (composition.target === subEntity.name) {
+      return true;
+    }
+  }
+
+  return false
+}
+
+const _getCompositionObjFromReq = function (obj, targetID) {
+    if (obj.ID === targetID) {
+        return obj;
+    }
+
+    for (const key in obj) {
+        if (typeof obj[key] === "object" && obj[key] !== null) {
+            const result = _getCompositionObjFromReq(obj[key], targetID);
+            if (result) {
+                return result;
+            }
+        }
+    }
+
+    return null;
+};
+
 module.exports = {
   getCurObjFromReqData,
   getCurObjFromDbQuery,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js/change-tracking",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "CDS plugin providing out-of-the box support for automatic capturing, storing, and viewing of the change records of modeled entities.",
   "repository": "cap-js/change-tracking",
   "author": "SAP SE (https://www.sap.com)",