@cap-js/change-tracking 1.1.1 → 1.1.3

package/CHANGELOG.md

@@ -4,7 +4,7 @@ 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.1.2 - TBD
+## Version 1.1.4 - TBD
 
 ### Added
 
@@ -12,6 +12,18 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
 ### Changed
 
+## Version 1.1.3 - 27.10.25
+
+### Changed
+- Correctly handle changes on foreign keys when sending them via the document notation on an API level.
+
+
+## Version 1.1.2 - 23.10.25
+
+### Fixed
+
+- Support single keys which are not named `ID`
+
 
 ## Version 1.1.1 - 17.10.25
 

package/index.cds

@@ -13,7 +13,7 @@ namespace sap.changelog;
 }]) {
   // Essentially: Association to many Changes on changes.changeLog.entityKey = ID;
   changes : Association to many ChangeView on changes.entityKey = ID;
-  key ID  : UUID;
+  key ID  : String;
 }
 
 
@@ -39,7 +39,7 @@ view ChangeView as
 entity ChangeLog : managed, cuid {
   serviceEntity : String(5000) @title: '{i18n>ChangeLog.serviceEntity}'; // definition name of target entity (on service level) - e.g. ProcessorsService.Incidents
   entity        : String(5000) @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
+  entityKey     : String       @title: '{i18n>ChangeLog.entityKey}'; // primary key of target entity, e.g. Incidents.ID
   createdAt     : managed:createdAt @title : '{i18n>ChangeLog.createdAt}';
   createdBy     : managed:createdBy @title : '{i18n>ChangeLog.createdBy}';
   changes       : Composition of many Changes on changes.changeLog = $self;
@@ -64,7 +64,7 @@ entity Changes {
 
       // Business meaningful parent object id
       parentEntityID    : String(5000)             @title: '{i18n>Changes.parentEntityID}';
-      parentKey         : UUID                     @title: '{i18n>Changes.parentKey}';
+      parentKey         : String                   @title: '{i18n>Changes.parentKey}';
       serviceEntityPath : String(5000)             @title: '{i18n>Changes.serviceEntityPath}';
 
       @title: '{i18n>Changes.modification}'

package/lib/change-log.js

@@ -1,6 +1,6 @@
 const cds = require("@sap/cds")
 const getTemplate = require("@sap/cds/libx/_runtime/common/utils/template") // REVISIT: bad usage of internal stuff
-const templateProcessor = require("./template-processor")
+const {templateProcessor, retrieveFirstKey} = require("./template-processor")
 const LOG = cds.log("change-log")
 
 const {
@@ -173,7 +173,8 @@ const _getChildChangeObjId = async function (
   change,
   childNodeChange,
   curNodePathVal,
-  reqData
+  reqData,
+  target
 ) {
   const composition = cds.model.definitions[change.serviceEntity].elements[change.attribute]
   const objIdElements = composition ? composition["@changelog"] : null
@@ -183,11 +184,12 @@ const _getChildChangeObjId = async function (
     reqData,
     curNodePathVal,
     childNodeChange._path,
+    target,
     objIdElementNames
   )
 }
 
-const _formatCompositionContext = async function (changes, reqData) {
+const _formatCompositionContext = async function (changes, reqData, target) {
   const childNodeChanges = []
 
   for (const change of changes) {
@@ -204,7 +206,8 @@ const _formatCompositionContext = async function (changes, reqData) {
           change,
           childNodeChange,
           curNodePathVal,
-          reqData
+          reqData,
+          target
         )
         _formatCompositionValue(curChange, objId, childNodeChange, childNodeChanges)
       }
@@ -261,17 +264,18 @@ const _getObjectIdByPath = async function (
   reqData,
   nodePathVal,
   serviceEntityPath,
+  target,
   /**optional*/ objIdElementNames
 ) {
   const curObjFromReqData = getCurObjFromReqData(reqData, nodePathVal, serviceEntityPath)
   const entityName = getNameFromPathVal(nodePathVal)
   const entityUUID = getUUIDFromPathVal(nodePathVal)
-  const obj = await getCurObjFromDbQuery(entityName, entityUUID)
+  const obj = await getCurObjFromDbQuery(entityName, {[retrieveFirstKey(target)]: entityUUID})
   const curObj = { curObjFromReqData, curObjFromDbQuery: obj }
   return getObjectId(reqData, entityName, objIdElementNames, curObj)
 }
 
-const _formatObjectID = async function (changes, reqData) {
+const _formatObjectID = async function (changes, reqData, target) {
   const objectIdCache = new Map()
   for (const change of changes) {
     const path = splitPath(change.serviceEntityPath)
@@ -283,7 +287,8 @@ const _formatObjectID = async function (changes, reqData) {
       curNodeObjId = await _getObjectIdByPath(
         reqData,
         curNodePathVal,
-        change.serviceEntityPath
+        change.serviceEntityPath,
+        target
       )
       objectIdCache.set(curNodePathVal, curNodeObjId)
     }
@@ -293,7 +298,8 @@ const _formatObjectID = async function (changes, reqData) {
       parentNodeObjId = await _getObjectIdByPath(
         reqData,
         parentNodePathVal,
-        change.serviceEntityPath
+        change.serviceEntityPath,
+        target
       )
       objectIdCache.set(parentNodePathVal, parentNodeObjId)
     }
@@ -315,9 +321,9 @@ const _isCompositionContextPath = function (aPath, hasComp) {
 }
 
 const _formatChangeLog = async function (changes, req) {
-  await _formatObjectID(changes, req.data)
+  await _formatObjectID(changes, req.data, req.target)
   await _formatAssociationContext(changes, req.data)
-  await _formatCompositionContext(changes, req.data)
+  await _formatCompositionContext(changes, req.data, req.target)
 }
 
 const _afterReadChangeView = function (data, req) {
@@ -326,13 +332,12 @@ const _afterReadChangeView = function (data, req) {
   localizeLogFields(data, req.locale)
 }
 
-
 function _trackedChanges4 (srv, target, diff) {
   const template = getTemplate("change-logging", srv, target, { pick: e => e['@changelog'] })
   if (!template.elements.size) return
 
   const changes = []
-  diff._path = `${target.name}(${diff.ID})`
+  diff._path = `${target.name}(${diff[retrieveFirstKey(target)]})`
 
   templateProcessor({
     template, row: diff, processFn: ({ row, key, element }) => {
@@ -416,7 +421,7 @@ const _prepareChangeLogForComposition = async function (entity, entityKey, chang
     .join('/')
 
   for (const change of changes) {
-    change.parentEntityID = await _getObjectIdByPath(req.data, parentEntityPathVal, parentServiceEntityPath)
+    change.parentEntityID = await _getObjectIdByPath(req.data, parentEntityPathVal, parentServiceEntityPath, entity)
     change.parentKey = parentKey
     change.serviceEntityPath = serviceEntityPath
   }
@@ -520,7 +525,7 @@ async function track_changes (req) {
 async function trackChangesForDiff(diff, req, that){
   let target = req.target
   let compContext = null;
-  let entityKey = diff.ID
+  let entityKey = diff[retrieveFirstKey(req.target)] 
   const params = convertSubjectToParams(req.subject);
   if (req.subject.ref.length === 1 && params.length === 1 && !target[isRoot]) {
     compContext = await generatePathAndParams(req, entityKey);

package/lib/entity-helper.js

@@ -29,10 +29,10 @@ const getObjIdElementNamesInArray = function (elements) {
   else return []
 }
 
-const getCurObjFromDbQuery = async function (entityName, queryVal, /**optional*/ queryKey='ID') {
-  if (!queryVal) return {}
+const getCurObjFromDbQuery = async function (entityName, whereXpr) {
+  if (!Object.keys(whereXpr)) return {}
   // REVISIT: This always reads all elements -> should read required ones only!
-  const obj = await SELECT.one.from(entityName).where({[queryKey]: queryVal})
+  const obj = await SELECT.one.from(entityName).where(whereXpr)
   return obj || {}
 }
 
@@ -99,10 +99,10 @@ async function getObjectId (reqData, entityName, fields, curObj) {
             // 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.
             const entityKeys = reqData ? Object.keys(reqData).filter(item => !Object.keys(assoc._target.keys).some(ele => item === ele)) : [];
             if (!_db_data || JSON.stringify(_db_data) === '{}' || entityKeys.length === 0) {
-              _db_data = await getCurObjFromDbQuery(assoc._target, IDval, ID);
+              _db_data = IDval ? await getCurObjFromDbQuery(assoc._target, {[ID]: IDval}) : {};
             }
           } else {
-            _db_data = await getCurObjFromDbQuery(assoc._target, IDval, ID);
+            _db_data = IDval ? await getCurObjFromDbQuery(assoc._target, {[ID]: IDval}) : {};
           }
         } catch (e) {
           LOG.error("Failed to generate object Id for an association entity.", e)

package/lib/template-processor.js

@@ -23,6 +23,18 @@ const _processElement = (processFn, row, key, elements, isRoot, pathSegments, pi
     }
 };
 
+function retrieveFirstKey(target) {
+  const keys = [];
+  for (const key of Object.keys(target.keys)) {
+    if (target.keys[key].type !== 'cds.Association' && key !== 'IsActiveEntity') {
+      keys.push(key);
+    }
+  }
+
+  //Revisit: For test 3.5
+  return keys.filter(k => !k.startsWith('up_'))[0]
+}
+
 const _processRow = (processFn, row, template, tKey, tValue, isRoot, pathOptions) => {
     const { template: subTemplate, picked } = tValue;
     const key = tKey.split(DELIMITER).pop();
@@ -47,7 +59,8 @@ const _processRow = (processFn, row, template, tKey, tValue, isRoot, pathOptions
                  *  Construct path from root entity to current entity.
                  */
                 const serviceNodeName = template.target.elements[key].target;
-                subRow._path = `${row._path}/${serviceNodeName}(${subRow.ID})`;
+                const serviceNode = template.target.elements[key]._target;
+                subRow._path = `${row._path}/${serviceNodeName}(${subRow[retrieveFirstKey(serviceNode)]})`;
             }
         });
 
@@ -88,6 +101,10 @@ const templateProcessor = ({ processFn, row, template, isRoot = true, pathOption
     const segments = pathOptions.segments && [...pathOptions.segments];
 
     for (const [tKey, tValue] of template.elements) {
+        // When a managed association is marked with @changelog, both foreign key and assoc are in the template. Skip the association as only the foreign key has a change.
+        if (template.target.elements[tKey]?.type === 'cds.Association') {
+            continue;
+        }
         if (segments) {
             pathOptions.segments = [...segments];
         }
@@ -95,4 +112,4 @@ const templateProcessor = ({ processFn, row, template, isRoot = true, pathOption
     }
 };
 
-module.exports = templateProcessor;
+module.exports = {templateProcessor, retrieveFirstKey};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js/change-tracking",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "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)",