Optimizing implementation

Author: danjoa

lib/change-log.js

@@ -1,14 +1,7 @@
 const cds = require("@sap/cds")
 const getTemplate = require("@sap/cds/libx/_runtime/common/utils/template") // REVISIT: bad usage of internal stuff
 const templateProcessor = require("./template-processor")
-const { big } = require("@sap/cds-foss") // REVISIT: Do we really need that?
 const LOG = cds.log("change-log")
-const {
-  OBJECT_PATH_DELIMITER,
-  TX_CONTEXT_PATH_DELIMITER,
-  VALUE_DELIMITER,
-} = require("./constants")
-const CHANGE_LOG_ANNOTATION = "@changelog"
 
 const {
   getNameFromPathVal,
@@ -17,11 +10,8 @@ const {
   getCurObjFromDbQuery,
   getObjectId,
   getDBEntity,
-  getEntity,
   getEntityByContextPath,
-  hasComposition,
   getObjIdElementNamesInArray,
-  getAssociationCompositionEntity,
   getValueEntityType,
 } = require("./entity-helper")
 const { localizeLogFields } = require("./localization")
@@ -31,7 +21,7 @@ const _getRootEntityPathVals = function (txContext, entity, entityKey) {
   const serviceEntityPathVals = []
   const entityIDs = _getEntityIDs(txContext.params)
 
-  let path = txContext.path.split(TX_CONTEXT_PATH_DELIMITER)
+  let path = txContext.path.split('/')
 
   if (txContext.event === "CREATE") {
     const curEntityPathVal = `${entity.name}(${entityKey})`
@@ -61,7 +51,7 @@ const _getRootEntityPathVals = function (txContext, entity, entityKey) {
 
 const _getAllPathVals = function (txContext) {
   const pathVals = []
-  const paths = txContext.path.split(TX_CONTEXT_PATH_DELIMITER)
+  const paths = txContext.path.split('/')
   const entityIDs = _getEntityIDs(txContext.params)
 
   for (let idx = 0; idx < paths.length; idx++) {
@@ -91,10 +81,6 @@ const _getEntityIDs = function (txParams) {
   return entityIDs
 }
 
-const _pick = (element) => {
-  return element[CHANGE_LOG_ANNOTATION]
-}
-
 /**
  *
  * @param {*} tx
@@ -113,10 +99,10 @@ const _pick = (element) => {
  */
 const _formatAssociationContext = async function (changes) {
   for (const change of changes) {
-    const a = getEntity(change.serviceEntity).elements[change.attribute]
+    const a = cds.model.definitions[change.serviceEntity].elements[change.attribute]
     if (a?.type !== "cds.Association") continue
 
-    const semkeys = getObjIdElementNamesInArray(a[CHANGE_LOG_ANNOTATION])
+    const semkeys = getObjIdElementNamesInArray(a["@changelog"])
     if (!semkeys.length) continue
 
     const ID = a.keys[0].ref[0] || 'ID'
@@ -142,8 +128,8 @@ const _getChildChangeObjId = async function (
   curNodePathVal,
   reqData
 ) {
-  const composition = getAssociationCompositionEntity(change.serviceEntity, change.attribute )
-  const objIdElements = composition ? composition[CHANGE_LOG_ANNOTATION] : null
+  const composition = cds.model.definitions[change.serviceEntity].elements[change.attribute]
+  const objIdElements = composition ? composition["@changelog"] : null
   const objIdElementNames = getObjIdElementNamesInArray(objIdElements)
 
   return _getObjectIdByPath(
@@ -164,7 +150,7 @@ const _formatCompositionContext = async function (changes, reqData) {
       }
       for (const childNodeChange of change.valueChangedTo) {
         const curChange = Object.assign({}, change)
-        const path = childNodeChange._path.split(OBJECT_PATH_DELIMITER)
+        const path = childNodeChange._path.split('/')
         const curNodePathVal = path.pop()
         curChange.modification = childNodeChange._op
         const objId = await _getChildChangeObjId(
@@ -211,11 +197,8 @@ const _formatCompositionValue = function (
 }
 
 const _formatCompositionEntityType = function (change) {
-  const composition = getAssociationCompositionEntity(
-    change.serviceEntity,
-    change.attribute
-  )
-  const objIdElements = composition ? composition[CHANGE_LOG_ANNOTATION] : null
+  const composition = cds.model.definitions[change.serviceEntity].elements[change.attribute]
+  const objIdElements = composition ? composition['@changelog'] : null
 
   if (Array.isArray(objIdElements)) {
     // In this case, the attribute is a composition
@@ -242,7 +225,7 @@ const _getObjectIdByPath = async function (
 const _formatObjectID = async function (changes, reqData) {
   const objectIdCache = new Map()
   for (const change of changes) {
-    const path = change.serviceEntityPath.split(OBJECT_PATH_DELIMITER)
+    const path = change.serviceEntityPath.split('/')
     const curNodePathVal = path.pop()
     const parentNodePathVal = path.pop()
 
@@ -278,68 +261,35 @@ const _isCompositionContextPath = function (aPath) {
   if (aPath.length < 2) return false
   const target = getEntityByContextPath(aPath)
   const parent = getEntityByContextPath(aPath.slice(0, -1))
-  return hasComposition(parent, target)
+  if (!parent.compositions) return false
+  return Object.values(parent.compositions).some(c => c._target === target)
 }
 
 const _formatChangeLog = async function (changes, req) {
   await _formatObjectID(changes, req.data)
   await _formatAssociationContext(changes)
   await _formatCompositionContext(changes, req.data)
-  // _formatFromTo(req, changes)
 }
 
-// function _formatFromTo (req, changes) {
-//   const contentType = req.context.req?.headers["content-type"] // the service API do not have a req header
-//   const isExponentialDecimals = contentType?.includes("ExponentialDecimals=true")
-//   for (const change of changes) {
-//     if (!isExponentialDecimals)
-//       _formatDecimalValue(change)
-//   }
-// }
-
-// const _formatDecimalValue = function (change) {
-//   const valueDataTypes = change.valueDataType.split(VALUE_DELIMITER)
-//   const valueChangedFroms = change.valueChangedFrom.split(VALUE_DELIMITER)
-//   const valueChangedTos = change.valueChangedTo.split(VALUE_DELIMITER)
-//   for (const idx in valueDataTypes) {
-//     if (valueDataTypes[idx] === "cds.Decimal") {
-//       if (valueChangedFroms[idx]) {
-//         const bigFrom = big(valueChangedFroms[idx])
-//         valueChangedFroms[idx] = bigFrom.toFixed()
-//       }
-
-//       if (valueChangedTos[idx]) {
-//         const bigTo = big(valueChangedTos[idx])
-//         valueChangedTos[idx] = bigTo.toFixed()
-//       }
-//     }
-//   }
-//   change.valueChangedFrom = valueChangedFroms.join(VALUE_DELIMITER)
-//   change.valueChangedTo = valueChangedTos.join(VALUE_DELIMITER)
-// }
-
-const _afterReadChangeView = async function (data, req) {
-  if (!data) {
-    return
-  }
-
-  localizeLogFields(Array.isArray(data) ? data : [data], req.user.locale)
+const _afterReadChangeView = function (data, req) {
+  if (!data) return
+  if (!Array.isArray(data)) data = [data]
+  localizeLogFields(data, req.locale)
 }
 
 
 function _trackedChanges4 (srv, target, diff) {
-  const template = getTemplate("change-logging", srv, target, { pick: _pick })
+  const template = getTemplate("change-logging", srv, target, { pick: e => e['@changelog'] })
   if (!template.elements.size) return
 
   const changes = []
   diff._path = `${target.name}(${diff.ID})`
 
   templateProcessor({
     template, row: diff, processFn: ({ row, key, element }) => {
-      const from = row._old?.[key] ? row._old[key] : undefined
-      const to = row[key] ? row[key] : undefined
-      if (from === to)
-        return
+      const from = row._old?.[key]
+      const to = row[key]
+      if (from === to) return
 
       const keys = Object.keys(element.parent.keys)
         .filter(k => k !== "IsActiveEntity")
@@ -373,10 +323,10 @@ const _prepareChangeLogForComposition = async function (entity, entityKey, chang
 
   const parentEntityPathVal = rootEntityPathVals[rootEntityPathVals.length - 2]
   const parentKey = getUUIDFromPathVal(parentEntityPathVal)
-  const serviceEntityPath = rootEntityPathVals.join(OBJECT_PATH_DELIMITER)
+  const serviceEntityPath = rootEntityPathVals.join('/')
   const parentServiceEntityPath = _getAllPathVals(req.context)
     .slice(0, rootEntityPathVals.length - 2)
-    .join(OBJECT_PATH_DELIMITER)
+    .join('/')
 
   for (const change of changes) {
     change.parentEntityID = await _getObjectIdByPath(req.data, parentEntityPathVal, parentServiceEntityPath)