fix: adapt to template processor API change (#110)

Co-authored-by: D050513 <[email protected]>
cap-js · Sep 12, 2024 · 523b7c0 · 523b7c0
1 parent f4c91b4
commit 523b7c0
Show file tree

Hide file tree

Showing 5 changed files with 64 additions and 183 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -14,14 +14,16 @@ jobs:
       fail-fast: false
       matrix:
         node-version: [22.x, 20.x]
+        cds-version: [8, 7]
     steps:
     - uses: actions/checkout@v2
     - name: Use Node.js ${{ matrix.node-version }}
       uses: actions/setup-node@v2
       with:
         node-version: ${{ matrix.node-version }}
-    - run: npm i -g @sap/cds-dk
+    - run: npm i -g @sap/cds-dk@${{ matrix.cds-version }}
     - run: npm i
+    - run: npm i @sap/cds@${{ matrix.cds-version }}
     - run: cds v
     - run: npm run lint
     - run: npm run test

diff --git a/lib/access.js b/lib/access.js
@@ -2,7 +2,6 @@ const cds = require('@sap/cds')
 
 // REVISIT: don't require internal stuff
 const getTemplate = require('@sap/cds/libx/_runtime/common/utils/template')
-const templateProcessor = require('@sap/cds/libx/_runtime/common/utils/templateProcessor')
 
 const {
   getRootEntity,
@@ -56,8 +55,16 @@ const auditAccess = async function (data, req) {
   if (!template.elements.size) return
 
   const accessLogs = {}
-  const _data = Array.isArray(data) ? data : [data]
-  _data.forEach(row => templateProcessor({ processFn: _processorFnAccess(accessLogs, this.model, req), row, template }))
+  const processFn = _processorFnAccess(accessLogs, this.model, req)
+  // cds internal templating mechanism api changed in 8.2.0 -> polyfill
+  if (!template.process) {
+    module.exports._templateProcessor ??= require('@sap/cds/libx/_runtime/common/utils/templateProcessor')
+    template.process = (data, processFn) => {
+      const _data = Array.isArray(data) ? data : [data]
+      _data.forEach(row => module.exports._templateProcessor({ processFn, row, template }))
+    }
+  }
+  template.process(data, processFn)
 
   for (const each of Object.keys(accessLogs)) if (!accessLogs[each].attributes.length) delete accessLogs[each]
   if (!Object.keys(accessLogs).length) return

diff --git a/lib/modification.js b/lib/modification.js
@@ -2,7 +2,6 @@ const cds = require('@sap/cds')
 
 // REVISIT: don't require internal stuff
 const getTemplate = require('@sap/cds/libx/_runtime/common/utils/template')
-const templateProcessor = require('@sap/cds/libx/_runtime/common/utils/templateProcessor')
 
 const {
   getMapKeyForCurrentRequest,
@@ -166,7 +165,14 @@ const _getDataModificationLogs = (req, tx, diff, beforeWrite) => {
 
   const modificationLogs = {}
   const processFn = _processorFnModification(modificationLogs, tx.model, req, beforeWrite)
-  templateProcessor({ processFn, row: diff, template })
+  // cds internal templating mechanism api changed in 8.2.0 -> polyfill
+  if (!template.process) {
+    module.exports._templateProcessor ??= require('@sap/cds/libx/_runtime/common/utils/templateProcessor')
+    template.process = (data, processFn) => {
+      module.exports._templateProcessor({ processFn, row: data, template })
+    }
+  }
+  template.process(diff, processFn)
 
   return modificationLogs
 }

diff --git a/package.json b/package.json
@@ -19,7 +19,7 @@
     "test-old-db": "npx jest --silent"
   },
   "peerDependencies": {
-    "@sap/cds": ">=7 || ^8.0.0-beta"
+    "@sap/cds": ">=7"
   },
   "devDependencies": {
     "@cap-js/audit-logging": "file:.",

diff --git a/test/personal-data/crud.test.js b/test/personal-data/crud.test.js
@@ -376,7 +376,8 @@ describe('personal data audit logging in CRUD', () => {
         { auth: ALICE }
       )
       expect(response).toMatchObject({ status: 200 })
-      expect(_logs.length).toBe(3)
+      // NOTE: cds^8 only returns root on update requests -> no data access logs for children
+      expect(_logs.length).toBeGreaterThanOrEqual(1)
       expect(_logs).toContainMatchObject({
         user: 'alice',
         object: {
@@ -397,40 +398,6 @@ describe('personal data audit logging in CRUD', () => {
           { name: 'town', new: 'updated town', old: 'shu' }
         ]
       })
-      expect(_logs).toContainMatchObject({
-        user: 'alice',
-        object: {
-          type: 'CRUD_2.CustomerPostalAddress',
-          id: { ID: '1ab71292-ef69-4571-8cfb-10b9d5d1459e' }
-        },
-        data_subject: {
-          type: 'CRUD_2.CustomerPostalAddress',
-          role: 'Address',
-          id: {
-            ID: '1ab71292-ef69-4571-8cfb-10b9d5d1459e',
-            street: 'updated',
-            town: 'updated town'
-          }
-        },
-        attributes: [{ name: 'someOtherField' }]
-      })
-      expect(_logs).toContainMatchObject({
-        user: 'alice',
-        object: {
-          type: 'CRUD_2.CustomerPostalAddress',
-          id: { ID: '285225db-6eeb-4b4f-9439-dbe5fcb4ce82' }
-        },
-        data_subject: {
-          type: 'CRUD_2.CustomerPostalAddress',
-          role: 'Address',
-          id: {
-            ID: '285225db-6eeb-4b4f-9439-dbe5fcb4ce82',
-            street: 'sue',
-            town: 'lou'
-          }
-        },
-        attributes: [{ name: 'someOtherField' }]
-      })
     })
 
     test('create Customer - flat', async () => {
@@ -867,9 +834,19 @@ describe('personal data audit logging in CRUD', () => {
       }
 
       response = await PATCH(`/crud-1/Customers(${CUSTOMER_ID})`, customer, { auth: ALICE })
-
       expect(response).toMatchObject({ status: 200 })
-      expect(_logs.length).toBe(12)
+
+      // NOTE: cds^8 only returns root on update requests -> no data access logs for children
+      expect(_logs.length).toBeGreaterThanOrEqual(9)
+
+      // augment response with data (specifically keys in children) not returned in cds^8
+      if (!response.data.addresses) {
+        const {
+          data: { addresses, status }
+        } = await GET(`/crud-1/Customers(${CUSTOMER_ID})?$select=ID&$expand=addresses,status`, { auth: ALICE })
+        response.data.addresses = addresses
+        response.data.status = status
+      }
 
       const newAddresses = response.data.addresses
       const newStatus = response.data.status
@@ -943,33 +920,6 @@ describe('personal data audit logging in CRUD', () => {
         data_subject: DATA_SUBJECT,
         attributes: [{ name: 'creditCardNo' }]
       })
-      expect(_logs).toContainMatchObject({
-        user: 'alice',
-        object: {
-          type: 'CRUD_1.CustomerPostalAddress',
-          id: { ID: newAddresses[0].ID }
-        },
-        data_subject: DATA_SUBJECT,
-        attributes: [{ name: 'street' }]
-      })
-      expect(_logs).toContainMatchObject({
-        user: 'alice',
-        object: {
-          type: 'CRUD_1.CustomerPostalAddress',
-          id: { ID: newAddresses[1].ID }
-        },
-        data_subject: DATA_SUBJECT,
-        attributes: [{ name: 'street' }]
-      })
-      expect(_logs).toContainMatchObject({
-        user: 'alice',
-        object: {
-          type: 'CRUD_1.CustomerStatus',
-          id: { ID: newStatus.ID }
-        },
-        data_subject: DATA_SUBJECT,
-        attributes: [{ name: 'description' }]
-      })
     })
 
     test('update Customer - deep with reusing notes', async () => {
@@ -1028,15 +978,26 @@ describe('personal data audit logging in CRUD', () => {
       _logs = []
 
       response = await PATCH(`/crud-1/Customers(${CUSTOMER_ID})`, customer, { auth: ALICE })
-
       expect(response).toMatchObject({ status: 200 })
-      expect(_logs.length).toBe(16)
+
+      // NOTE: cds^8 only returns root on update requests -> no data access logs for children
+      expect(_logs.length).toBeGreaterThanOrEqual(10)
+
+      // augment response with data (specifically keys in children) not returned in cds^8
+      if (!response.data.addresses) {
+        const {
+          data: { addresses, status }
+        } = await GET(
+          `/crud-1/Customers(${CUSTOMER_ID})?$select=ID&$expand=addresses($expand=attachments($expand=notes)),status`,
+          { auth: ALICE }
+        )
+        response.data.addresses = addresses
+        response.data.status = status
+      }
 
       const newAddresses = response.data.addresses
       const newStatus = response.data.status
-      const newAttachments = response.data.addresses[0].attachments
       const newAttachmentNote = response.data.addresses[0].attachments[0].notes[0]
-      const newStatusNote = response.data.status.notes[0]
 
       expect(_logs).toContainMatchObject({
         user: 'alice',
@@ -1131,15 +1092,6 @@ describe('personal data audit logging in CRUD', () => {
           { name: 'todo', old: oldStatus.todo, new: newStatus.todo }
         ]
       })
-      expect(_logs).toContainMatchObject({
-        user: 'alice',
-        object: {
-          type: 'CRUD_1.AddressAttachment',
-          id: { ID: newAttachments[0].ID }
-        },
-        data_subject: DATA_SUBJECT,
-        attributes: [{ name: 'description' }]
-      })
       expect(_logs).toContainMatchObject({
         user: 'alice',
         object: {
@@ -1149,51 +1101,6 @@ describe('personal data audit logging in CRUD', () => {
         data_subject: DATA_SUBJECT,
         attributes: [{ name: 'creditCardNo' }]
       })
-      expect(_logs).toContainMatchObject({
-        user: 'alice',
-        object: {
-          type: 'CRUD_1.CustomerPostalAddress',
-          id: { ID: newAddresses[0].ID }
-        },
-        data_subject: DATA_SUBJECT,
-        attributes: [{ name: 'street' }]
-      })
-      expect(_logs).toContainMatchObject({
-        user: 'alice',
-        object: {
-          type: 'CRUD_1.CustomerPostalAddress',
-          id: { ID: newAddresses[1].ID }
-        },
-        data_subject: DATA_SUBJECT,
-        attributes: [{ name: 'street' }]
-      })
-      expect(_logs).toContainMatchObject({
-        user: 'alice',
-        object: {
-          type: 'CRUD_1.CustomerStatus',
-          id: { ID: newStatus.ID }
-        },
-        data_subject: DATA_SUBJECT,
-        attributes: [{ name: 'description' }]
-      })
-      expect(_logs).toContainMatchObject({
-        user: 'alice',
-        object: {
-          type: 'CRUD_1.Notes',
-          id: { ID: newStatusNote.ID }
-        },
-        data_subject: DATA_SUBJECT,
-        attributes: [{ name: 'note' }]
-      })
-      expect(_logs).toContainMatchObject({
-        user: 'alice',
-        object: {
-          type: 'CRUD_1.Notes',
-          id: { ID: newAttachmentNote.ID }
-        },
-        data_subject: DATA_SUBJECT,
-        attributes: [{ name: 'note' }]
-      })
     })
 
     test('delete Customer - flat', async () => {
@@ -1745,8 +1652,7 @@ describe('personal data audit logging in CRUD', () => {
         ],
         misc: 'abc'
       }
-      const r1 = await POST(`/crud-1/Orders`, order, { auth: ALICE })
-      expect(r1)
+      await POST(`/crud-1/Orders`, order, { auth: ALICE })
       const {
         data: {
           header_ID,
@@ -1772,9 +1678,12 @@ describe('personal data audit logging in CRUD', () => {
         },
         items
       }
+
       _logs = []
+
       await PATCH(`/crud-1/Orders(${order.ID})`, updatedOrder, { auth: ALICE })
-      expect(_logs.length).toBe(6)
+      // NOTE: cds^8 only returns root on update requests -> no data access logs for children
+      expect(_logs.length).toBeGreaterThanOrEqual(4)
       expect(_logs).toContainMatchObject({
         user: 'alice',
         object: {
@@ -1811,62 +1720,19 @@ describe('personal data audit logging in CRUD', () => {
         data_subject: DATA_SUBJECT,
         attributes: [{ name: 'misc' }]
       })
-      expect(_logs).toContainMatchObject({
-        user: 'alice',
-        object: {
-          type: 'CRUD_1.OrderHeader',
-          id: { ID: header_ID }
-        },
-        data_subject: DATA_SUBJECT,
-        attributes: [{ name: 'description' }]
-      })
-      expect(_logs).toContainMatchObject({
-        user: 'alice',
-        object: {
-          type: 'CRUD_1.OrderHeader.sensitiveData',
-          id: { ID: sensitiveData.ID }
-        },
-        data_subject: DATA_SUBJECT,
-        attributes: [{ name: 'note' }]
-      })
-      const r2 = await DELETE(`/crud-1/Orders(${order.ID})`, { auth: ALICE })
-      expect(r2).toMatchObject({ status: 204 })
-      expect(_logs.length).toBe(9)
-      expect(_logs).toContainMatchObject({
-        user: 'alice',
-        object: {
-          type: 'CRUD_1.Orders',
-          id: { ID: order.ID }
-        },
-        data_subject: DATA_SUBJECT,
-        attributes: [{ name: 'misc', old: '***', new: '***' }]
-      })
-      expect(_logs).toContainMatchObject({
-        user: 'alice',
-        object: {
-          type: 'CRUD_1.OrderHeader',
-          id: { ID: header_ID }
-        },
-        data_subject: DATA_SUBJECT,
-        attributes: [{ name: 'description', old: '***', new: '***' }]
-      })
-      expect(_logs).toContainMatchObject({
-        user: 'alice',
-        object: {
-          type: 'CRUD_1.OrderHeader.sensitiveData',
-          id: { ID: sensitiveData.ID }
-        },
-        data_subject: DATA_SUBJECT,
-        attributes: [{ name: 'note', old: '***', new: '***' }]
-      })
+
+      _logs = []
+
+      await DELETE(`/crud-1/Orders(${order.ID})`, { auth: ALICE })
+      expect(_logs.length).toBe(3)
       expect(_logs).toContainMatchObject({
         user: 'alice',
         object: {
           type: 'CRUD_1.Orders',
           id: { ID: order.ID }
         },
         data_subject: DATA_SUBJECT,
-        attributes: [{ name: 'misc', old: '***', new: '***' }]
+        attributes: [{ name: 'misc', old: '***' }]
       })
       expect(_logs).toContainMatchObject({
         user: 'alice',
@@ -1875,7 +1741,7 @@ describe('personal data audit logging in CRUD', () => {
           id: { ID: header_ID }
         },
         data_subject: DATA_SUBJECT,
-        attributes: [{ name: 'description', old: '***', new: '***' }]
+        attributes: [{ name: 'description', old: '***' }]
       })
       expect(_logs).toContainMatchObject({
         user: 'alice',
@@ -1884,7 +1750,7 @@ describe('personal data audit logging in CRUD', () => {
           id: { ID: sensitiveData.ID }
         },
         data_subject: DATA_SUBJECT,
-        attributes: [{ name: 'note', old: '***', new: '***' }]
+        attributes: [{ name: 'note', old: '***' }]
       })
     })