@cap-js/audit-logging 0.2.0 → 0.3.1

package/README.md

@@ -1,4 +1,5 @@
 # Welcome to @cap-js/audit-logging
+[![REUSE status](https://api.reuse.software/badge/github.com/cap-js/audit-logging)](https://api.reuse.software/info/github.com/cap-js/audit-logging)
 
 ## About this project
 
@@ -10,7 +11,7 @@ Documentation can be found at [cap.cloud.sap](https://cap.cloud.sap/docs/guides/
 
 See [Getting Started](https://cap.cloud.sap/docs/get-started) on how to jumpstart your development and grow as you go with SAP Cloud Application Programming Model.
 
-The end-to-end out-of-the-box functionality provided by this plugin requires a paid-for instance of the [SAP Audit Logging Service for SAP BTP]([url](https://help.sap.com/docs/application-logging-service?locale=en-US)). However, it is possible to provide an own implementation that writes the audit logs to a custom store.
+The end-to-end out-of-the-box functionality provided by this plugin requires a paid-for instance of the [SAP Audit Log service for customers](https://help.sap.com/docs/btp/sap-business-technology-platform/audit-log-write-api-for-customers?locale=en-US). However, it is possible to provide an own implementation that writes the audit logs to a custom store.
 
 ## Support, Feedback, Contributing
 

package/lib/utils.js

@@ -1,8 +1,10 @@
 const WRITE = { CREATE: 1, UPDATE: 1, DELETE: 1 }
 
 const hasPersonalData = entity => {
-  if (!entity['@PersonalData.DataSubjectRole']) return
   if (!entity['@PersonalData.EntitySemantics']) return
+  // default role to entity name
+  if (entity['@PersonalData.EntitySemantics'] === 'DataSubject' && !entity['@PersonalData.DataSubjectRole'])
+    entity['@PersonalData.DataSubjectRole'] = entity.name.match(/\w+/g).pop()
   return !!Object.values(entity.elements).some(
     element =>
       element['@PersonalData.IsPotentiallyPersonal'] ||
@@ -148,31 +150,27 @@ const _getUps = (entity, model) => {
   return entity.set('__parents', ups)
 }
 
-const _ifDataSubject = (entity, role) => {
-  return entity['@PersonalData.EntitySemantics'] === 'DataSubject' && entity['@PersonalData.DataSubjectRole'] === role
-}
-
-const _getDataSubjectUp = (role, model, entity, prev, next, result) => {
+const _getDataSubjectUp = (model, entity, prev, next, result) => {
   for (const element of _getUps(entity, model)) {
     const me = { entity, relative: element.parent, element }
     if (prev) prev.next = me
-    if (_ifDataSubject(element.parent, role)) {
+    if (element.parent['@PersonalData.EntitySemantics'] === 'DataSubject') {
       if (!result) result = { dataSubjectEntity: element.parent, subs: [] }
       result.subs.push(next || me)
       return result
     } else {
       // dfs is a must here
-      result = _getDataSubjectUp(role, model, element.parent, me, next || me, result)
+      result = _getDataSubjectUp(model, element.parent, me, next || me, result)
     }
   }
   return result
 }
 
-const _getDataSubjectDown = (role, entity, prev, next) => {
+const _getDataSubjectDown = (entity, prev, next) => {
   const associations = Object.values(entity.associations || {}).filter(e => !e._isBacklink)
   for (const element of associations) {
     const me = { entity, relative: entity, element }
-    if (_ifDataSubject(element._target, role)) {
+    if (element._target['@PersonalData.EntitySemantics'] === 'DataSubject') {
       if (prev) prev.next = me
       return { dataSubjectEntity: element._target, subs: [next || me] }
     }
@@ -181,24 +179,25 @@ const _getDataSubjectDown = (role, entity, prev, next) => {
   for (const element of associations) {
     const me = { entity, relative: entity, element }
     if (prev) prev.next = me
-    const dataSubject = _getDataSubjectDown(role, element._target, me, next || me)
+    const dataSubject = _getDataSubjectDown(element._target, me, next || me)
     if (dataSubject) return dataSubject
   }
 }
 
-const getDataSubject = (entity, model, role) => {
-  const hash = '__dataSubject4' + role
+const getDataSubject = (entity, model) => {
+  const hash = '__dataSubject'
   if (entity.own(hash)) return entity[hash]
   // entities with EntitySemantics 'DataSubjectDetails' or 'Other' must not necessarily
   // be always below or always above 'DataSubject' entity in CSN tree
-  let dataSubject = _getDataSubjectUp(role, model, entity)
-  if (!dataSubject) dataSubject = _getDataSubjectDown(role, entity)
-  return entity.set(hash, dataSubject)
+  let dataSubjectInfo = _getDataSubjectUp(model, entity)
+  if (!dataSubjectInfo) dataSubjectInfo = _getDataSubjectDown(entity)
+  return entity.set(hash, dataSubjectInfo)
 }
 
 const addDataSubjectForDetailsEntity = (row, log, req, entity, model) => {
-  const role = entity['@PersonalData.DataSubjectRole']
-  const dataSubjectInfo = getDataSubject(entity, model, role)
+  const dataSubjectInfo = getDataSubject(entity, model)
+  const role = dataSubjectInfo.dataSubjectEntity['@PersonalData.DataSubjectRole']
+  log.data_subject.role ??= role
   log.data_subject.type = dataSubjectInfo.dataSubjectEntity.name
   /*
    * for each req (cf. $batch with atomicity) and data subject role (e.g., customer vs supplier),

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cap-js/audit-logging",
-  "version": "0.2.0",
-  "description": "CDS plugin providing integration to the SAP BTP Audit Logging Service as well as out-of-the-box personal data-related audit logging based on annotations.",
+  "version": "0.3.1",
+  "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)",
   "homepage": "https://cap.cloud.sap/",
@@ -19,27 +19,28 @@
     "@sap/cds": "^7"
   },
   "devDependencies": {
-    "@cap-js/sqlite": "^1.0.1",
-    "axios": "^1.4.0",
+    "@cap-js/sqlite": "^1",
+    "axios": "^1",
+    "better-sqlite3": "8.5.2",
     "eslint": "^8",
-    "express": "^4.18.2",
-    "jest": "^29.5.0"
+    "express": "^4",
+    "jest": "^29"
   },
   "cds": {
     "requires": {
-      "audit-log": true,
-      "kinds": {
-        "audit-log": {
-          "handle": [
-            "WRITE"
-          ],
-          "[development]": {
-            "kind": "audit-log-to-console"
-          },
-          "[production]": {
-            "kind": "audit-log-to-restv2"
-          }
+      "audit-log": {
+        "handle": [
+          "READ",
+          "WRITE"
+        ],
+        "[development]": {
+          "kind": "audit-log-to-console"
         },
+        "[production]": {
+          "kind": "audit-log-to-restv2"
+        }
+      },
+      "kinds": {
         "audit-log-to-console": {
           "impl": "@cap-js/audit-logging/srv/log2console",
           "outbox": false