@cap-js/change-tracking 1.0.8 → 1.1.0

package/CHANGELOG.md

@@ -4,6 +4,23 @@ 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.0 - TBD
+
+### Added
+
+- License entry
+- Added translations for the UI labels for more languages
+
+### Fixed
+
+- Handling of multiple records in one request
+- Handle cases where the key contains '/'
+- Instantiate the changes association correctly so it does not impact other `@cap-js` plugins
+
+### Changed
+
+- Prepare for CDS9 in tests
+
 ## Version 1.0.8 - 28.03.25
 
 ### Added

package/README.md

@@ -5,7 +5,7 @@ a [CDS plugin](https://cap.cloud.sap/docs/node.js/cds-plugins#cds-plugin-package
 [![REUSE status](https://api.reuse.software/badge/github.com/cap-js/change-tracking)](https://api.reuse.software/info/github.com/cap-js/change-tracking)
 
 > [!IMPORTANT]
-> Following the CAP best practices, the new release now requires CDS8 as minimum version in the peer dependencies. If you want to use the plugin with an older version of CAP (CDS7), you will need to manually update the peer dependency in `package.json`. Please be aware that there will be no support for this version of the plugin with a CDS version below 8!
+> Following the CAP best practices, the new release now requires CDS8 or CDS9 as minimum versions. If you want to use the plugin with an older version of CAP (CDS7), you will need to manually update the peer dependency in `package.json`. Please be aware that there will be no support for this version of the plugin with a CDS version below 8!
 
 > [!IMPORTANT]
 > This release establishes support for multi-tenant deployments using MTX and extensibility.

package/_i18n/i18n.properties

@@ -45,6 +45,10 @@ ChangeLog.modification.create=Create
 ChangeLog.modification.update=Update
 #XFLD: Field label
 ChangeLog.modification.delete=Delete
+#XFLD: Field label
+ChangeLog.createdAt=Changed at
+#XFLD: Field label
+ChangeLog.createdBy=Changed by
 
 ## Change History Table##
 ########################################

package/_i18n/i18n_de.properties

@@ -45,7 +45,11 @@ ChangeLog.modification.create=Anlegen
 ChangeLog.modification.update=Aktualisieren
 #XFLD: Field label
 ChangeLog.modification.delete=L\u00F6schen
+#XFLD: Field label
+ChangeLog.createdAt=\u00C4nderung am
+#XFLD: Field label
+ChangeLog.createdBy=\u00C4nderung von
 
 ## Change History Table##
 ########################################
-ChangeHistory=Änderungshistorie
+ChangeHistory=\u00C4nderungshistorie

package/_i18n/i18n_en.properties

@@ -45,6 +45,10 @@ ChangeLog.modification.create=Create
 ChangeLog.modification.update=Update
 #XFLD: Field label
 ChangeLog.modification.delete=Delete
+#XFLD: Field label
+ChangeLog.createdAt=Changed at
+#XFLD: Field label
+ChangeLog.createdBy=Changed by
 
 ## Change History Table##
 ########################################

package/cds-plugin.js

@@ -180,7 +180,7 @@ function enhanceModel (m) {
 
         // Add association to ChangeView...
         const keys = entityKey4(entity); if (!keys.length) continue // If no key attribute is defined for the entity, the logic to add association to ChangeView should be skipped.
-        const assoc = { ...changes, on: [ ...changes.on, ...keys ] }
+        const assoc = new cds.builtin.classes.Association({ ...changes, on: [ ...changes.on, ...keys ] })
 
         // --------------------------------------------------------------------
         // PARKED: Add auto-exposed projection on ChangeView to service if applicable

package/index.cds

@@ -40,8 +40,8 @@ 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
-  createdAt     : managed:createdAt;
-  createdBy     : managed:createdBy;
+  createdAt     : managed:createdAt @title : '{i18n>ChangeLog.createdAt}';
+  createdBy     : managed:createdBy @title : '{i18n>ChangeLog.createdBy}';
   changes       : Composition of many Changes on changes.changeLog = $self;
 }
 

package/lib/change-log.js

@@ -13,6 +13,7 @@ const {
   getEntityByContextPath,
   getObjIdElementNamesInArray,
   getValueEntityType,
+  splitPath,
 } = require("./entity-helper")
 const { localizeLogFields } = require("./localization")
 const isRoot = "change-tracking-isRootEntity"
@@ -193,7 +194,7 @@ const _formatCompositionContext = async function (changes, reqData) {
       }
       for (const childNodeChange of change.valueChangedTo) {
         const curChange = Object.assign({}, change)
-        const path = childNodeChange._path.split('/')
+        const path = splitPath(childNodeChange._path)
         const curNodePathVal = path.pop()
         curChange.modification = childNodeChange._op
         const objId = await _getChildChangeObjId(
@@ -270,7 +271,7 @@ const _getObjectIdByPath = async function (
 const _formatObjectID = async function (changes, reqData) {
   const objectIdCache = new Map()
   for (const change of changes) {
-    const path = change.serviceEntityPath.split('/')
+    const path = splitPath(change.serviceEntityPath)
     const curNodePathVal = path.pop()
     const parentNodePathVal = path.pop()
 
@@ -502,6 +503,18 @@ async function track_changes (req) {
   let diff = await req.diff()
   if (!diff) return
 
+  const diffs = Array.isArray(diff) ? diff : [diff];
+  const changes = (
+    await Promise.all(diffs.map(item => trackChangesForDiff(item, req, this)))
+  ).filter(Boolean);
+
+  if (changes.length > 0) {
+    await INSERT.into("sap.changelog.ChangeLog").entries(changes);
+  }
+
+}
+
+async function trackChangesForDiff(diff, req, that){
   let target = req.target
   let compContext = null;
   let entityKey = diff.ID
@@ -518,10 +531,11 @@ async function track_changes (req) {
     target[isRoot] &&
     !cds.env.requires["change-tracking"]?.preserveDeletes
   ) {
-    return await DELETE.from(`sap.changelog.ChangeLog`).where({ entityKey });
+    await DELETE.from(`sap.changelog.ChangeLog`).where({ entityKey });
+    return;
   }
 
-  let changes = _trackedChanges4(this, target, diff)
+  let changes = _trackedChanges4(that, target, diff)
   if (!changes) return
 
   await _formatChangeLog(changes, req)
@@ -538,7 +552,7 @@ async function track_changes (req) {
     [ target, entityKey ] = await _prepareChangeLogForComposition(target, entityKey, changes, reqInfo)
   }
   const dbEntity = getDBEntity(target)
-  await INSERT.into("sap.changelog.ChangeLog").entries({
+  return {
     entity: dbEntity.name,
     entityKey: entityKey,
     serviceEntity: target.name || target,
@@ -547,7 +561,7 @@ async function track_changes (req) {
       valueChangedFrom: `${c.valueChangedFrom ?? ''}`,
       valueChangedTo: `${c.valueChangedTo ?? ''}`,
     })),
-  })
+  };
 }
 
 module.exports = { track_changes, _afterReadChangeView }

package/lib/entity-helper.js

@@ -37,7 +37,7 @@ const getCurObjFromDbQuery = async function (entityName, queryVal, /**optional*/
 }
 
 const getCurObjFromReqData = function (reqData, nodePathVal, pathVal) {
-  const pathVals = pathVal.split('/')
+  const pathVals = splitPath(pathVal);
   const rootNodePathVal = pathVals[0]
   let curReqObj = reqData || {}
 
@@ -183,6 +183,25 @@ const _getCompositionObjFromReq = function (obj, targetID) {
     return null;
 };
 
+function splitPath (path) {
+  let result = [];
+  let buf = "";
+  let paren = 0;
+  for (let i = 0; i < path.length; i++) {
+    const c = path[i];
+    if (c === "(") paren++;
+    if (c === ")") paren--;
+    if (c === "/" && paren === 0) {
+      result.push(buf);
+      buf = "";
+    } else {
+      buf += c;
+    }
+  }
+  if (buf) result.push(buf);
+  return result;
+}
+
 module.exports = {
   getCurObjFromReqData,
   getCurObjFromDbQuery,
@@ -193,4 +212,5 @@ module.exports = {
   getEntityByContextPath,
   getObjIdElementNamesInArray,
   getValueEntityType,
+  splitPath,
 }

package/lib/localization.js

@@ -1,6 +1,6 @@
 const cds = require("@sap/cds/lib");
 const LOG = cds.log("change-log");
-const { getNameFromPathVal, getDBEntity } = require("./entity-helper");
+const { getNameFromPathVal, getDBEntity, splitPath } = require("./entity-helper");
 
 const MODIF_I18N_MAP = {
     create: "{i18n>ChangeLog.modification.create}",
@@ -36,7 +36,7 @@ const _localizeDefaultObjectID = function (change, locale) {
         change.objectID = change.entity ? change.entity : "";
     }
     if (change.objectID && change.serviceEntityPath && !change.parentObjectID && change.parentKey) {
-        const path = change.serviceEntityPath.split('/');
+        const path = splitPath(change.serviceEntityPath);
         const parentNodePathVal = path[path.length - 2];
         const parentEntityName = getNameFromPathVal(parentNodePathVal);
         const dbEntity = getDBEntity(parentEntityName);

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@cap-js/change-tracking",
-  "version": "1.0.8",
+  "version": "1.1.0",
   "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)",
-  "license": "SEE LICENSE IN LICENSE",
+  "license": "Apache-2.0",
   "main": "cds-plugin.js",
   "files": [
     "lib",
@@ -20,16 +20,15 @@
   "peerDependencies": {
     "@sap/cds": ">=8"
   },
+  "engines": {
+    "node": ">=20.0.0"
+  },
   "devDependencies": {
     "@cap-js/change-tracking": "file:.",
-    "@cap-js/sqlite": "^1",
-    "axios": "^1",
-    "chai": "^4.3.10",
-    "chai-as-promised": "^7.1.1",
-    "chai-subset": "^1.6.0",
-    "eslint": "^8",
-    "express": "^4",
-    "jest": "^29"
+    "@cap-js/attachments": "^2",
+    "@cap-js/sqlite": "^1 || ^2",
+    "@cap-js/cds-test": "*",
+    "express": "^4"
   },
   "cds": {
     "requires": {