@cap-js/change-tracking 1.0.3 → 1.0.5

package/CHANGELOG.md

@@ -4,6 +4,27 @@ 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.5 - 15.01.24
+
+### Fixed
+
+- Error on HANA when logging Boolean or Numeric Data
+
+## Version 1.0.4 - 08.01.24
+
+### Added
+
+- Side effect annotation now allows automatic refresh after a custom action caused changes
+
+### Changed
+
+- Added a check to disable change tracking for views with a UNION
+
+### Fixed
+
+- Handling of associations within change tracked entities
+- Handling of change log when custom actions on child entities are called
+
 ## Version 1.0.3 - 10.11.23
 
 ### Added
@@ -37,3 +58,4 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 ### Added
 
 - Initial release
+

package/cds-plugin.js

@@ -1,10 +1,28 @@
 const cds = require('@sap/cds')
 
 const isChangeTracked = (entity) => (
-  entity['@changelog']
-  || entity.elements && Object.values(entity.elements).some(e => e['@changelog'])
+  (entity['@changelog']
+  || entity.elements && Object.values(entity.elements).some(e => e['@changelog'])) && entity.query?.SET?.op !== 'union'
 )
 
+// Add the appropriate Side Effects attribute to the custom action
+const addSideEffects = (actions, flag, element) => {
+  for (const se of Object.values(actions)) {
+    const target = flag ? 'TargetProperties' : 'TargetEntities'
+    const sideEffectAttr = se[`@Common.SideEffects.${target}`]
+    const property = flag ? 'changes' : { '=': `${element}.changes` }
+    if (sideEffectAttr?.length >= 0) {
+      sideEffectAttr.findIndex(
+        (item) =>
+          (item['='] ? item['='] : item) ===
+          (property['='] ? property['='] : property)
+      ) === -1 && sideEffectAttr.push(property)
+    } else {
+      se[`@Common.SideEffects.${target}`] = [property]
+    }
+  }
+}
+
 
 // Unfold @changelog annotations in loaded model
 cds.on('loaded', m => {
@@ -23,7 +41,9 @@ cds.on('loaded', m => {
       for (let e in elms) if (elms[e].key) keys.push(e)
 
       // Add association to ChangeView...
-      const on = [...changes.on]; keys.forEach((k, i) => { i && on.push('||'); on.push({ ref: [k] }) })
+      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 (query) {
@@ -34,6 +54,31 @@ cds.on('loaded', m => {
 
       // Add UI.Facet for Change History List
       entity['@UI.Facets']?.push(facet)
+
+      // The changehistory list should be refreshed after the custom action is triggered
+      if (entity.actions) {
+
+        // Update the changehistory list on the current entity when the custom action of the entity is triggered
+        if (entity['@UI.Facets']) {
+          addSideEffects(entity.actions, true)
+        }
+
+        // When the custom action of the child entity is performed, the change history list of the parent entity is updated
+        if (entity.elements) {
+          //ToDo: Revisit Breaklook with node.js Expert
+          breakLoop: for (const [ele, eleValue] of Object.entries(entity.elements)) {
+            const parentEntity = m.definitions[eleValue.target]
+            if (parentEntity && parentEntity['@UI.Facets'] && eleValue.type === 'cds.Association') {
+              for (const value of Object.values(parentEntity.elements)) {
+                if (value.target === name) {
+                  addSideEffects(entity.actions, false, ele)
+                  break breakLoop
+                }
+              }
+            }
+          }
+        }
+      }
     }
   }
 })

package/lib/change-log.js

@@ -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,
@@ -359,7 +359,7 @@ async function track_changes (req) {
   if (!changes) return
 
   await _formatChangeLog(changes, req)
-  if (isComposition && !isDraftEnabled) {
+  if (isComposition) {
     [ target, entityKey ] = await _prepareChangeLogForComposition(target, entityKey, changes, this)
   }
   const dbEntity = getDBEntity(target)
@@ -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/package.json

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