feat: common log entry fields can be provided manually (#65)

closes #64

Author: sjvans

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.0 - 2023-11-22
+
+### Added
+
+- Common log entry fields `uuid`, `tenant`, `user` and `time` can be provided manually
+
 ## Version 0.4.0 - 2023-10-24
 
 ### Added

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js/audit-logging",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "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)",

srv/service.js

@@ -8,8 +8,11 @@ module.exports = class AuditLogService extends Base {
 
     // add common audit log entry fields
     this.before('*', req => {
-      const { tenant, user, timestamp: time } = cds.context
-      Object.assign(req.data, { uuid: cds.utils.uuid(), tenant, user: user.id, time })
+      const { tenant, user, timestamp } = cds.context
+      req.data.uuid ??= cds.utils.uuid()
+      req.data.tenant ??= tenant
+      req.data.user ??= user.id
+      req.data.time ??= timestamp
     })
 
     // call OutboxService's init

test/api/api.test.js

@@ -94,4 +94,33 @@ describe('AuditLogService API', () => {
     await audit.log('foo', { data_subject: { ID: { bar: 'baz' } } })
     expect(_logs).toContainMatchObject({ data_subject: { ID: { bar: 'baz' } } })
   })
+
+  describe('common log entry fields', () => {
+    test('are automatically filled', async () => {
+      await cds.tx({ tenant: 'bar' }, async () => {
+        const audit = await cds.connect.to('audit-log')
+        await audit.log('foo', {})
+      })
+      expect(_logs).toContainMatchObject({
+        uuid: expect.any(String),
+        tenant: 'bar',
+        user: 'anonymous',
+        time: expect.any(Date)
+      })
+    })
+
+    test('can be provided manually', async () => {
+      const time = new Date('2021-01-01T00:00:00.000Z')
+      await cds.tx({ tenant: 'bar' }, async () => {
+        const audit = await cds.connect.to('audit-log')
+        await audit.log('foo', { uuid: 'baz', tenant: 'baz', user: 'baz', time })
+      })
+      expect(_logs).toContainMatchObject({
+        uuid: 'baz',
+        tenant: 'baz',
+        user: 'baz',
+        time
+      })
+    })
+  })
 })