Skip to content

CHANGELOG.md

Latest commit

 

History

History
208 lines (122 loc) · 5.44 KB

CHANGELOG.md

File metadata and controls

208 lines (122 loc) · 5.44 KB
Raw

Change Log

All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning. The format is based on Keep a Changelog.

Version 1.2.2 - 2026-06-18

Fixed

  • Properly encode request body parameters using in audit-log-to-restv2
  • Resolved server crash when @PersonalData annotations are applied to composition targets whose DataSubject is only reachable via the parent entity's sibling association

Version 1.2.1 - 2026-05-13

Fixed

  • Updated the audit log service plan detection logic to support the new URL format
  • The absence of req.target does not lead to an error

Version 1.2.0 - 2026-02-23

Changed

  • Adjusted auto-detection of kind audit-log-to-als to now check for a VCAP service name matching "auditlog-ng"
  • Adjusted how the handlers for emitting audit logs are registered to support feature toggle and extensibility scenarios.
  • Improved debug logging in cases where emitting audit log fails

Version 1.1.1 - 2025-10-27

Fixed

  • Data subject lookup when data subject is not exposed in the same service

Version 1.1.0 - 2025-09-08

Added

  • audit-log-to-alsng: Support for sending generic audit log events

Fixed

  • audit-log-to-alsng: Correctly retrieve appId from the VCAP_APPLICATION environment variable

Version 1.0.1 - 2025-08-05

Fixed

  • audit-log-to-alsng: EventDataPayload to Support Multi-Key Object and DataSubject IDs

Version 1.0.0 - 2025-07-11

Added

  • Beta support for next generation SAP Audit Log Service
    • Use explicit kind audit-log-to-alsng or alpha auto-detect kind audit-log-to-als

Version 0.9.0 - 2025-06-05

Added

  • Support for @sap/cds^9

Version 0.8.3 - 2025-04-09

Fixed

  • Preperation for @sap/cds^9

Version 0.8.2 - 2024-11-27

Fixed

  • Erroneous modification log for non-updated key properties
  • Error during non-modifying queries on database level
  • Specify charset UTF-8 for requests to SAP Audit Log Service

Version 0.8.1 - 2024-09-13

Fixed

  • Support for @sap/cds^8.2
  • Reduce clutter in error raised for outbound requests

Version 0.8.0 - 2024-05-24

Added

  • Allow to specify undefined tenant in order to log to provider account in multi-tenant scenarios

Changed

  • Use kind audit-log-to-restv2 in profile hybrid

Version 0.7.0 - 2024-05-15

Added

  • Automatically promote entities that are associated with data subjects

Version 0.6.0 - 2024-02-05

Added

  • Support for @sap/cds^7.5

Fixed

  • Automatic personal data modification logging for data subject details with renamed keys
  • Data subject resolution in circular models

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

  • Falsy early exit during bootstrapping in case a service does not contain personal data

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

  • Support for Premium plan of SAP Audit Log Service
  • Support for XSUAA credential type x509
  • Support for generic outbox

Changed

  • Always use outbox (as configured in project)

Fixed

  • Avoid dangling SELECTs to resolve data subject IDs, which resulted in "Transaction already closed" errors

Version 0.3.2 - 2023-10-11

Fixed

  • If the request has no tenant (e.g., Unauthorized), the audit log shall be sent to the provider account

Version 0.3.1 - 2023-09-25

Fixed

  • Defaulting of @PersonalData.DataSubjectRole to entity name
  • Overriding service configuration

Version 0.3.0 - 2023-09-05

Changed

  • Default value for cds.requires['audit-log'].handle changed to ['READ', 'WRITE'], i.e., accessing sensitive data is now logged by default.

Version 0.2.0 - 2023-09-01

Added

  • Export class AuditLogService for extending in custom implementations as follows: 
    const { AuditLogService } = require('@cap-js/audit-logging')
class MyAuditLogService extends AuditLogService {
  async init() {
    [...]
    // call AuditLogService's init
    await super.init()
  }
}
module.exports = MyAuditLogService

Version 0.1.0 - 2023-08-18

Added

  • New API:
    • await audit.log('<event>', <data>) for asynchronous logs (cf. emit)
    • await audit.logSync('<event>', <data>) for synchronous logs (cf. send)
  • New REST API-based schema with auto-filled LogEntry aspect
  • New events SensitiveDataRead, PersonalDataModified, ConfigurationModified, and SecurityEvent
  • Full support for OAuth2 plan of SAP Audit Log Service

Changed

  • Whether reading sensitive data and modifying personal data is logged is determined by cds.requires['audit-log'].handle: [...]. Possible values in the array are READ and/ or WRITE, with WRITE as the sole default entry. Hence, accessing sensitive data is not logged by default.
  • Integration with SAP Audit Log Service via REST API instead of client library (@sap/audit-logging)

Fixed

  • Various glitches in log calculation

Removed

  • Old events dataAccessLog, dataModificationLog, configChangeLog, and securityLog
  • @AuditLog.Operation annotations are ignored. Having the plugin as dependency signals the intent to audit log.
  • cds.features.audit_personal_data: true is no longer necessary. Instead, simply add the plugin as a dependency.