@cap-js/audit-logging 0.5.1 → 0.5.2

package/CHANGELOG.md

@@ -4,6 +4,12 @@ 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 0.5.2 - 2023-12-08
+
+### Fixed
+
+- Automatic personal data modification logging for deep data structures with renamings
+
 ## Version 0.5.1 - 2023-11-30
 
 ### Fixed

package/lib/modification.js

@@ -17,27 +17,39 @@ const {
 
 let audit
 
-const _applyTransitionRecursively = (transition, data, d) => {
+const _applyTransitionRecursively = (transition, data, d, old = {}) => {
   for (const [k, v] of transition.mapping) {
     if (v.transition) {
-      if (Array.isArray(data[k])) {
+      const ok = v.ref?.[0] || k
+      if (!data[ok]) continue
+      if (Array.isArray(data[ok])) {
         d[k] = []
-        for (let i = 0; i < data[k].length; i++) {
-          d[k].push({ _op: data[k][i]._op })
-          if (data[k][i]._old) d[k][i]._old = {}
-          _applyTransitionRecursively(v.transition, data[k][i], d[k][i])
+        for (let i = 0; i < data[ok].length; i++) {
+          const _op = data[ok][i]._op || d._op
+          d[k].push(_op ? { _op } : {})
+          const _old = old[ok]?.[i] || data[ok][i]._old
+          if (_old) d[k][i]._old = _old
+          _applyTransitionRecursively(v.transition, data[ok][i], d[k][i], _old)
+        }
+        if (old[ok] && data[ok].length !== old[ok].length) {
+          for (const each of Object.values(old[ok]).filter(ele => !ele.__visited)) {
+            const i = d[k].push({ _op: 'delete' })
+            d[k][i - 1]._old = each
+            _applyTransitionRecursively(v.transition, each, d[k][i - 1], each)
+          }
         }
       } else {
-        d[k] = { _op: data[k]._op }
-        if (data[k]._old) d[k]._old = {}
-        _applyTransitionRecursively(v.transition, data[k], d[k])
+        d[k] = { _op: data[ok]._op || d._op }
+        const _old = old[ok] || data[ok]._old
+        if (_old) d[k]._old = _old
+        _applyTransitionRecursively(v.transition, data[ok], d[k], _old)
       }
-      continue
     } else if (v.ref) {
       if (v.ref[0] in data) d[k] = data[v.ref[0]]
-      if (data._old && v.ref[0] in data._old) d._old[k] = data._old[v.ref[0]]
+      if (v.ref[0] in old) d._old[k] = old[v.ref[0]]
     }
   }
+  if (Object.keys(old).length) old.__visited = true
 }
 
 // REVISIT: remove once old database impl is removed
@@ -47,9 +59,9 @@ const _getDataWithAppliedTransitions = (data, req) => {
   // NOTE: there will only be transitions if old database impl is used
   const transition = query._transitions?.find(t => t.queryTarget.name === req.target.name)
   if (transition) {
-    d = { _op: data._op }
+    d = data._op ? { _op: data._op } : {}
     if (data._old) d._old = {}
-    _applyTransitionRecursively(transition, data, d)
+    _applyTransitionRecursively(transition, data, d, data._old)
   }
   return d || data
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js/audit-logging",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "description": "CDS plugin providing integration to the SAP Audit Log service as well as out-of-the-box personal data-related audit logging based on annotations.",
   "repository": "cap-js/audit-logging",
   "author": "SAP SE (https://www.sap.com)",
@@ -14,7 +14,9 @@
   ],
   "scripts": {
     "lint": "npx eslint .",
-    "test": "npx jest --silent"
+    "test": "npm run test-new-db && npm run test-old-db",
+    "test-new-db": "CDS_ENV='better-sqlite' npx jest --silent",
+    "test-old-db": "npx jest --silent"
   },
   "peerDependencies": {
     "@sap/cds": "^7"
@@ -25,10 +27,14 @@
     "axios": "^1",
     "eslint": "^8",
     "express": "^4",
-    "jest": "^29"
+    "jest": "^29",
+    "sqlite3": "^5.1.6"
   },
   "cds": {
     "requires": {
+      "[test]": {
+        "outbox": "persistent-outbox"
+      },
       "audit-log": {
         "handle": [
           "READ",