@sap/cds 5.4.6 → 5.5.0

package/libx/_runtime/common/utils/foreignKeyPropagations.js

@@ -23,6 +23,7 @@ const _getNestedVal = (row, prefix) => {
   let val = row
   const splitted = prefix.split('_')
   let k = ''
+
   while (splitted.length > 0) {
     k += splitted.shift()
     if (k in val) {
@@ -32,11 +33,13 @@ const _getNestedVal = (row, prefix) => {
       k += '_'
     }
   }
+
   return val
 }
 
 const _propagateToChid = (foreignKeyPropagation, row, childRow) => {
   const { parentFieldName, childFieldName, prefix, parentFieldValue } = foreignKeyPropagation
+
   if (parentFieldName) {
     if (prefix) {
       const nested = _getNestedVal(row, prefix)
@@ -54,18 +57,26 @@ const _propagateToParent = (foreignKeyPropagations, childRow, row) => {
     const deep = foreignKeyPropagations.deep
     _propagateToParent(deep.propagation, childRow[deep.targetName], childRow)
   }
-  if (childRow && Object.prototype.hasOwnProperty.call(childRow, foreignKeyPropagations.childFieldName))
+
+  if (childRow && Object.prototype.hasOwnProperty.call(childRow, foreignKeyPropagations.childFieldName)) {
     row[foreignKeyPropagations.parentFieldName] = childRow[foreignKeyPropagations.childFieldName]
+  }
 }
 
-const propagateForeignKeys = (tKey, row, foreignKeyPropagations) => {
+const propagateForeignKeys = (tKey, row, foreignKeyPropagations, opts = {}) => {
   const childRows = Array.isArray(row[tKey]) ? row[tKey] : [row[tKey]]
+
   for (const childRow of childRows) {
     if (!childRow) return
+
     for (const foreignKeyPropagation of foreignKeyPropagations) {
       if (foreignKeyPropagation.fillChild) {
         _generateParentField(foreignKeyPropagation, row)
-        _propagateToChid(foreignKeyPropagation, row, childRow)
+        if (opts.onlyWriteCompositionEffective && !foreignKeyPropagations._element._isCompositionEffective) {
+          delete row[tKey]
+        } else {
+          _propagateToChid(foreignKeyPropagation, row, childRow)
+        }
       } else {
         _generateChildField(foreignKeyPropagation, childRow)
         _propagateToParent(foreignKeyPropagation, childRow, row)
@@ -79,6 +90,7 @@ const _getSubOns = on => {
   const newOn = on.filter(e => e !== '(' && e !== ')')
   const subOns = []
   let currArr = []
+
   for (const onEl of newOn) {
     if (currArr.length === 0) subOns.push(currArr)
     if (onEl !== 'and') currArr.push(onEl)
@@ -86,11 +98,13 @@ const _getSubOns = on => {
       currArr = []
     }
   }
+
   for (const subOn of subOns) {
     // We don't support anything else than
     // A = B AND C = D AND ...
     if (subOn.length !== 3) return []
   }
+
   return subOns
 }
 
@@ -99,6 +113,7 @@ const _autoGenerate = el => el && el.type === 'cds.UUID' && el.key
 const _parentFieldsFromSimpleOnCond = (element, subOn) => {
   const idxChildField = subOn.findIndex(o => o.ref && o.ref[0] === element.name)
   if (idxChildField === -1 || subOn[1] !== '=') return
+
   const childFieldName = subOn[idxChildField].ref && subOn[idxChildField].ref.slice(1).join('_')
   const childElement = element._target.elements[childFieldName]
   const idxParentField = idxChildField === 2 ? 0 : 2
@@ -126,9 +141,11 @@ const _parentFieldsFromSimpleOnCond = (element, subOn) => {
   if (!childElement.on && parentRef && parentRef.length === 1) {
     return _foreignKeyPropagationsFromToManyOn(element, parentRef, childFieldName)
   }
+
   if ('val' in subOn[idxParentField]) {
     return _foreignKeyPropagationsFromStaticOn(childFieldName, idxParentField, subOn)
   }
+
   if (childElement._isAssociationStrict && childElement.on) {
     return _foreignKeyPropagationsFromCustomBacklink(element, childElement)
   }
@@ -144,6 +161,7 @@ const _foreignKeyPropagationsFromToManyOn = (element, parentRef, childFieldName)
   const parentFieldName = parentRef[0]
   if (parentFieldName === '$self') {
     const foreignKeys = _foreignKeysForTarget(element, childFieldName)
+
     // REVISIT foreignKeys is empty if we have deep operations where a sub element is annotated with persistence skip
     if (foreignKeys && foreignKeys.length) {
       const parentKeys = _parentKeys(element)
@@ -167,11 +185,13 @@ const _foreignKeyPropagationsFromToManyOn = (element, parentRef, childFieldName)
 const _foreignKeyPropagationsFromCustomBacklink = (element, childElement) => {
   const foreignKeyPropagations = []
   const subOns = _getSubOns(childElement.on)
+
   for (const subOn of subOns) {
     if (subOn[1] === '=') {
       const parentFieldIdx = subOn.findIndex(o => o.ref && o.ref[0] === childElement.name)
       const otherFieldIdx = parentFieldIdx === 0 ? 2 : 0
       const otherField = subOn[otherFieldIdx]
+
       if (otherField.ref && otherField.ref.length === 1) {
         const parentFieldName = subOn[parentFieldIdx].ref[1]
         foreignKeyPropagations.push({
@@ -192,17 +212,19 @@ const _foreignKeyPropagationsFromCustomBacklink = (element, childElement) => {
       }
     }
   }
+
   return foreignKeyPropagations
 }
 
 const _foreignKeyPropagationsFromOn = (element, on) => {
   const subOns = _getSubOns(on)
-
   const foreignKeyPropagations = []
+
   for (const subOn of subOns) {
     const subParentFields = _parentFieldsFromSimpleOnCond(element, subOn)
     if (subParentFields) foreignKeyPropagations.push(...subParentFields)
   }
+
   return foreignKeyPropagations
 }
 
@@ -226,6 +248,7 @@ const _resolve4struct = (others, struct, fkps, fillChild, childIsStruct, i) => {
   for (const k in struct.elements) {
     const other = others[i + j]
     const current = struct.elements[k]
+
     if (current._isStructured) {
       // call recursive and increment skip
       j += _resolve4struct(others, current, fkps, fillChild, childIsStruct, i + j)
@@ -239,6 +262,7 @@ const _resolve4struct = (others, struct, fkps, fillChild, childIsStruct, i) => {
         prefix = cur.name + '_' + prefix
         cur = cur.parent
       }
+
       // push propagation
       fkps.push({
         childFieldName: childIsStruct ? current.name : other.name,
@@ -248,6 +272,7 @@ const _resolve4struct = (others, struct, fkps, fillChild, childIsStruct, i) => {
         prefix,
         deep: !fillChild && _resolveTargetForeignKey(childIsStruct ? current : other)
       })
+
       // increment skip
       j++
     }
@@ -259,8 +284,8 @@ const _resolve4struct = (others, struct, fkps, fillChild, childIsStruct, i) => {
 const _resolveTargetForeignKey = targetKey => {
   const targetName = targetKey['@odata.foreignKey4']
   if (!targetName) return
-  const _foreignKeyPropagations = foreignKeyPropagations(targetKey.parent.elements[targetName])
-  const propagation = _foreignKeyPropagations.find(_fkp => targetKey.name === _fkp.parentFieldName)
+  const _foreignKeyProps = foreignKeyPropagations(targetKey.parent.elements[targetName])
+  const propagation = _foreignKeyProps.find(_fkp => targetKey.name === _fkp.parentFieldName)
   return { targetName, propagation }
 }
 
@@ -289,7 +314,7 @@ const resolvedKeys = (foreignKeys, targetKeys, fillChild) => {
   return foreignKeyPropagations
 }
 
-const foreignKeyPropagations = element => {
+const _foreignKeyPropagations = element => {
   if (element.is2many && element.on) {
     return _foreignKeyPropagationsFromOn(element, element.on)
   }
@@ -297,6 +322,7 @@ const foreignKeyPropagations = element => {
   if (element.is2one) {
     if (!element.on) {
       const foreignKeys = _foreignKeys(element)
+
       if (foreignKeys) {
         const targetKeys = _targetKeys(element)
         return resolvedKeys(foreignKeys, targetKeys)
@@ -310,6 +336,12 @@ const foreignKeyPropagations = element => {
   }
 }
 
+const foreignKeyPropagations = element => {
+  const foreignKeyProps = _foreignKeyPropagations(element)
+  if (foreignKeyProps) foreignKeyProps._element = element
+  return foreignKeyProps
+}
+
 const _foreignKeys = csnElement => {
   return Object.values(csnElement.parent.elements).filter(element => element['@odata.foreignKey4'] === csnElement.name)
 }

package/libx/_runtime/common/utils/generateOnCond.js

@@ -74,20 +74,19 @@ const _foreignToOn = (csnElement, options) => {
   const foreignKeys = foreignKeyPropagations(csnElement)
 
   // for external services, there might be no foreign keys
-  if (foreignKeys) {
-    for (const key of foreignKeys) {
-      if (on.length !== 0) {
-        on.push('and')
-      }
-
-      // TODO static values possible here?
+  if (!foreignKeys) return on
 
-      on.push(
-        _toRef(aliases.select, key.prefix ? key.prefix + '_' + key.childFieldName : key.childFieldName),
-        '=',
-        _toRef(aliases.join, _structPrefix(csnElement) + key.parentFieldName)
-      )
+  for (const key of foreignKeys) {
+    if (on.length !== 0) {
+      on.push('and')
     }
+
+    // TODO static values possible here?
+
+    const ref1 = _toRef(aliases.select, key.prefix ? `${key.prefix}_${key.childFieldName}` : key.childFieldName)
+    const structPrefix = _structPrefix(csnElement)
+    const ref2 = _toRef(aliases.join, `${structPrefix}${key.parentFieldName}`)
+    on.push(ref1, '=', ref2)
   }
 
   return on

package/libx/_runtime/common/utils/onlyKeysRemain.js

@@ -0,0 +1,10 @@
+module.exports = req => {
+  // if custom handlers uses only expression like {col: {'+=': 1}},
+  // req.data will only contain the keys
+  if (req.query.UPDATE.with && Object.keys(req.query.UPDATE.with).length > 0) {
+    return false
+  }
+
+  const keys = Object.keys(req.target.keys || {})
+  return !Object.keys(req.data).some(k => !keys.includes(k))
+}

package/libx/_runtime/common/utils/path.js

@@ -0,0 +1,35 @@
+const cds = require('../../cds')
+
+/*
+ * returns path like <service>.<entity>:<prop1>.<prop2> for ref = [{ id: '<service>.<entity>' }, '<prop1>', '<prop2>']
+ */
+const getPathFromRef = ref => {
+  const x = ref.reduce((acc, cur) => {
+    acc += (acc ? ':' : '') + (cur.id ? cur.id : cur)
+    return acc
+  }, '')
+  const y = x.split(':')
+  let z = y.shift()
+  if (y.length) z += ':' + y.join('.')
+  return z
+}
+
+/*
+ * returns the target entity for the given path
+ */
+const getEntityFromPath = (path, model) => {
+  let current = { elements: model.definitions }
+  path = typeof path === 'string' ? cds.parse.path(path) : path
+  const segments = [...path.ref]
+  while (segments.length) {
+    const segment = segments.shift()
+    current = current.elements[segment.id || segment]
+    if (current.target) current = model.definitions[current.target]
+  }
+  return current
+}
+
+module.exports = {
+  getPathFromRef,
+  getEntityFromPath
+}

package/libx/_runtime/common/utils/postProcessing.js

@@ -0,0 +1,86 @@
+const { revertData } = require('./resolveView')
+
+// creates a map with key "remote origin name" and value { as: "projection name"}
+// if it is an expand, it contains an additional property .expand with classic ref/as syntax
+// ref/as syntax is kept in order to reuse handleAliasInResult
+const _createAliasMap = columns => {
+  if (columns) {
+    let aliasMap
+    for (const col of columns) {
+      const processor = {}
+      if (col.as) {
+        processor.as = col.as
+        aliasMap || (aliasMap = new Map())
+        if (col.ref) {
+          aliasMap.set(col.ref[col.ref.length - 1], processor)
+        }
+      }
+      if (col.expand) {
+        processor.expand = col.expand
+      }
+    }
+
+    return aliasMap
+  }
+}
+
+// Transforms the result of the remote service according to the provided aliases
+const handleAliasInResult = (columns, result) => {
+  const postProcessor = _createAliasMap(columns)
+  const resultArray = Array.isArray(result) ? result : [result]
+  if (postProcessor) {
+    for (const row of resultArray) {
+      // we need to use a cache because of cross renamings
+      // e. g. column a is renamed to b and column b is renamed to a
+      const tempCache = new Map()
+
+      for (const col in row) {
+        const processor = postProcessor.get(col)
+        if (processor && processor.as !== col) {
+          // if a value for the alias is already present, add it to the cache
+          if (row[processor.as]) {
+            tempCache.set(processor.as, row[processor.as])
+          }
+
+          // get the value from cache if present
+          row[processor.as] = tempCache.get(col) || row[col]
+
+          // if it was not overridden because of a renaming,
+          // delete it from the row
+          if (!tempCache.has(processor.as)) {
+            delete row[col]
+          }
+        }
+
+        if (processor && processor.expand) {
+          handleAliasInResult(processor.expand, row[processor.as || col])
+        }
+      }
+    }
+  }
+}
+
+// REVISIT: todo renaming for expanded entities
+// REVISIT: todo renaming for deep operations
+const postProcess = (query, result, onlySelectAliases = false) => {
+  if (query.SELECT) {
+    handleAliasInResult(query.SELECT.columns, result)
+
+    if (!onlySelectAliases) {
+      const transition =
+        query.SELECT && query.SELECT._transitions && query.SELECT._transitions[query.SELECT._transitions.length - 1]
+      if (transition) return revertData(result, transition)
+    }
+
+    return result
+  }
+  if (query.DELETE) return result
+  let transition
+  if (query.INSERT) transition = query.INSERT._transitions[query.INSERT._transitions.length - 1]
+  if (query.UPDATE) transition = query.UPDATE._transitions[query.UPDATE._transitions.length - 1]
+  return revertData(result, transition)
+}
+
+module.exports = {
+  postProcess
+}

package/libx/_runtime/common/utils/quotingStyles.js

@@ -1,39 +1,50 @@
 const cds = require('../../cds')
 
-// REVISIT: compiler to provide API for smart quoting (not just list)
-// require list from compiler
-const _COMPILER_RESERVED = {}
-try {
-  const keywords = require('@sap/cds-compiler/lib/base/keywords')
-  _COMPILER_RESERVED.hana = new Set(keywords.hana)
-  _COMPILER_RESERVED.sqlite = new Set(keywords.sqlite)
-} catch (e) {
-  // ignore
-}
+const keywords = require('@sap/cds-compiler/lib/base/keywords')
+const { smartId } = require('@sap/cds-compiler/lib/sql-identifier')
+
+let _dialect
 
-// fallback
 const _DEFAULT_RESERVED = new Set(['WHERE', 'GROUP', 'ORDER', 'BY', 'AT', 'NO', 'LIMIT'])
-let RESERVED = _DEFAULT_RESERVED
+const _COMPILER_RESERVED = {
+  hana: new Set(keywords.hana),
+  sqlite: new Set(keywords.sqlite)
+}
+let _reserved = _DEFAULT_RESERVED
 
-// exclude list
-const EXCLUDE_LIST = new Set(['CURRENT_TIMESTAMP'])
+const _isTruthy = s => s
+const _isQuoted = s => s.match(/^".*"$/)
 
-const _slugify = name => name.replace(/\./g, '_')
+const _slugify = s => s.replace(/\./g, '_')
+const _smartId = s => smartId(_slugify(s), _dialect || 'plain')
+const _smartElement = s => {
+  if (s === '*' || _isQuoted(s)) return s
+  const upper = s.toUpperCase()
+  if (_reserved.has(upper)) return upper
+  return _smartId(s)
+}
 
 module.exports = {
-  quoted: name => `"${name}"`,
-  plain: name => {
-    const upper = name.toUpperCase()
-    if (EXCLUDE_LIST.has(upper)) return name
+  plain: s => {
+    // set _dialect and _reserved once cds.db.kind is set
+    if (!_dialect && cds.db && cds.db.kind) {
+      _dialect = cds.db.options.dialect || cds.db.kind
+      _reserved = _COMPILER_RESERVED[_dialect] || _DEFAULT_RESERVED
+    }
+
+    // * or already quoted?
+    if (s === '*' || _isQuoted(s)) return s
 
-    if (cds.db) {
-      RESERVED = (cds.env.features.compiler_keywords !== false && _COMPILER_RESERVED[cds.db.kind]) || _DEFAULT_RESERVED
+    // expr or space in name?
+    // REVISIT: default behavior in cds^6?
+    if (s.match(/\s/) && !cds.env.sql.spaced_columns) {
+      return s.split(' ').filter(_isTruthy).map(_smartElement).join(' ')
     }
 
-    // REVISIT: _slugify(name) correct? cap-samples' tests needs it this way
-    return RESERVED.has(upper) ? `"${upper}"` : _slugify(name)
+    return _smartId(s)
   },
-  'all-upper': name => `"${_slugify(name.toUpperCase())}"`,
-  'all-lower': name => `"${_slugify(name.toLowerCase())}"`,
-  bracketed: name => `[${name}]`
+  quoted: s => `"${s}"`,
+  bracketed: s => `[${s}]`,
+  'all-upper': s => `"${_slugify(s.toUpperCase())}"`,
+  'all-lower': s => `"${_slugify(s.toLowerCase())}"`
 }