@sap/cds 7.7.3 → 7.8.0

package/libx/odata/utils/index.js

@@ -1,9 +1,10 @@
 // TODO: split into multiple files
 
 const cds = require('../../../')
+const _path = require('./path')
 
 const { toBase64url } = require('../../_runtime/common/utils/binary')
-const { where2obj } = require('../../_runtime/common/utils/cqn')
+const { getSapMessages } = require('../../_runtime/common/error/frontend')
 
 // copied from cds-compiler/lib/edm/edmUtils.js
 const cds2edm = {
@@ -39,8 +40,6 @@ const cds2edm = {
   // 'cds.hana.ST_GEOMETRY': 'Edm.Geometry',
 }
 
-const odataError = (code, message) => ({ error: { code, message } })
-
 const getSafeNumber = inputString => {
   if (typeof inputString !== 'string') return inputString
   // Try to parse the input string as a floating-point number using parseFloat
@@ -211,6 +210,8 @@ const formatVal = (val, elementName, csnTarget, kind, func, literal) => {
   }
   const element = _getElement(csnTarget, elementName)
   if (!element?.type) return typeof val === 'string' ? `'${val}'` : val
+  if ((element.type === 'cds.LargeString' || element.type === 'cds.String') && val.indexOf("'") >= 0)
+    val = val.replace(/'/g, "''")
   return kind === 'odata-v2' ? _v2(val, element) : _v4(val, element)
 }
 
@@ -269,49 +270,29 @@ const skipToken = (token, cqn) => {
   }
 }
 
-// REVISIT: do we already have something like this _without using okra api_?
-const getKeysFromPath = (from, srv) => {
-  const keys = {}
-  // own
-  if (from.ref[from.ref.length - 1].where) {
-    Object.assign(keys, where2obj(from.ref[from.ref.length - 1].where))
-  }
-  // previous path segments
-  if (from.ref.length > 1) {
-    const entities = []
-    let cur = srv.model.definitions
-    for (let i = 0; i < from.ref.length; i++) {
-      const id = from.ref[i].id || from.ref[i]
-      const t = cur[id]._target || cur[id]
-      entities.push(t)
-      cur = t.elements
-    }
-    for (let i = from.ref.length - 2; i >= 0; i--) {
-      const ref = from.ref[i]
-      if (ref.where) {
-        const relation = entities[i]._relations[from.ref[i + 1].id || from.ref[i + 1]].join('target', 'source')
-        const seg_keys = where2obj(ref.where)
-        if (relation?.[0].xpr) {
-          const join = [...relation[0].xpr]
-          while (join.length >= 3) {
-            const [left, _, right] = join.splice(0, 4)
-            if (left.ref?.[0] === 'target') {
-              if (left.ref[1] in keys) break // we already added the foreign key for the last segment
-              keys[left.ref[1]] = 'val' in right ? right.val : seg_keys[right.ref[1]]
-            } else if (right.ref?.[0] === 'target') {
-              if (right.ref[1] in keys) break // we already added the foreign key for the last segment
-              keys[right.ref[1]] = 'val' in left ? left.val : seg_keys[left.ref[1]]
-            } else {
-              // REVISIT: what to do here?
-            }
-          }
-        } else {
-          // REVISIT: what to do here?
-        }
-      }
-    }
+const calculateLocationHeader = (target, srv, result) => {
+  const targetName = target.name.replace(`${srv.name}.`, '')
+
+  const keyValuePairs = Object.keys(target.keys).reduce((acc, key) => {
+    acc[key] = result[key]
+    return acc
+  }, {})
+
+  let keys
+  const entries = Object.entries(keyValuePairs)
+  if (entries.length === 1) {
+    keys = entries[0][1]
+  } else {
+    keys = entries.map(([key, value]) => `${key}=${value}`).join(',')
   }
-  return keys
+
+  return `${targetName}(${keys})`
+}
+
+const handleSapMessages = (cdsReq, req, res) => {
+  if (!cdsReq.messages || !cdsReq.messages.length) return
+  const msgs = getSapMessages(cdsReq.messages, req)
+  if (msgs) res.setHeader('sap-messages', msgs)
 }
 
 module.exports = {
@@ -319,6 +300,7 @@ module.exports = {
   getSafeNumber,
   formatVal,
   skipToken,
-  odataError,
-  getKeysFromPath
+  calculateLocationHeader,
+  handleSapMessages,
+  getKeysAndParamsFromPath: _path.getKeysAndParamsFromPath
 }

package/libx/odata/utils/path.js

@@ -0,0 +1,72 @@
+const { where2obj } = require('../../_runtime/common/utils/cqn')
+
+const _handleXpr = (relation, keys, seg_keys) => {
+  const join = [...relation]
+  while (join.length >= 3) {
+    const [left, _, right] = join
+
+    if (left.xpr) {
+      // can be [ref = ref] or [xpr and ref = ref] and [xpr and xpr] so we will always catch xprs as left element, as it follows and/or or is first element
+      _handleXpr(left.xpr, keys, seg_keys)
+      join.splice(0, 2)
+      continue
+    }
+
+    if (left.ref?.[0] === 'target') {
+      if (left.ref[1] in keys) break // we already added the foreign key for the last segment
+      keys[left.ref[1]] = 'val' in right ? right.val : seg_keys[right.ref[1]]
+      join.splice(0, 4)
+    } else if (right.ref?.[0] === 'target') {
+      if (right.ref[1] in keys) break // we already added the foreign key for the last segment
+      keys[right.ref[1]] = 'val' in left ? left.val : seg_keys[left.ref[1]]
+      join.splice(0, 4)
+    }
+  }
+}
+
+// REVISIT: do we already have something like this _without using okra api_?
+// REVISIT: should we still support process.env.CDS_FEATURES_PARAMS? probably nobody uses it...
+const getKeysAndParamsFromPath = (from, srv) => {
+  if (!from.ref) return {}
+
+  const keys = {}
+  const params = []
+
+  // last path segment
+  if (from.ref[from.ref.length - 1].where) {
+    const seg_keys = where2obj(from.ref[from.ref.length - 1].where)
+    Object.assign(keys, seg_keys)
+    params.unshift(seg_keys.ID && Object.keys(seg_keys).length === 1 ? seg_keys.ID : seg_keys)
+  }
+
+  // previous path segments
+  if (from.ref.length > 1) {
+    const entities = []
+    let cur = srv.model.definitions
+    for (let i = 0; i < from.ref.length; i++) {
+      const id = from.ref[i].id || from.ref[i]
+      const t = cur[id]._target || cur[id]
+      entities.push(t)
+      cur = t.elements
+    }
+    for (let i = from.ref.length - 2; i >= 0; i--) {
+      const ref = from.ref[i]
+      if (ref.where) {
+        const relation = entities[i]._relations[from.ref[i + 1].id || from.ref[i + 1]].join('target', 'source')
+        const seg_keys = where2obj(ref.where)
+        if (relation?.[0].xpr) {
+          _handleXpr(relation[0].xpr, keys, seg_keys)
+        } else {
+          // REVISIT: what to do here?
+        }
+        params.unshift(seg_keys.ID && Object.keys(seg_keys).length === 1 ? seg_keys.ID : seg_keys)
+      }
+    }
+  }
+
+  return { keys, params }
+}
+
+module.exports = {
+  getKeysAndParamsFromPath
+}

package/libx/odata/utils/result.js

@@ -1,3 +1,6 @@
+const getTemplate = require('../../_runtime/common/utils/template')
+const templateProcessor = require('../../_runtime/common/utils/templateProcessor')
+
 const METADATA = {
   $context: '@odata.context',
   $count: '@odata.count',
@@ -22,25 +25,46 @@ const METADATA = {
   $mediaEtag: '@odata.mediaEtag'
 }
 
-const _cleanupMetadata = (odataResult, result) => {
-  if (typeof result !== 'object') return odataResult
-
-  const keysToCleanup = {
-    // do not set "@odata.context" as it may be inherited of remote service
-    $context: true,
-    // REVISIT: okra doesn't support content disposition
-    $mediaContentDispositionFilename: true,
-    $mediaContentDispositionType: true
-  }
+const KEYSTOCLEANUP = {
+  // do not set "@odata.context" as it may be inherited of remote service
+  $context: true,
+  // REVISIT: okra doesn't support content disposition
+  $mediaContentDispositionFilename: true,
+  $mediaContentDispositionType: true
+}
 
+const _metadataRoot = (result, odataResult) => {
   for (const key in METADATA) {
     if (!(key in result)) continue
-    if (!keysToCleanup[key]) {
-      odataResult[METADATA[key]] = result[key]
+    if (!KEYSTOCLEANUP[key]) odataResult[METADATA[key]] = result[key]
+  }
+}
+
+const _metadata = (result, propertyName, odataResult) => {
+  for (const key in result) {
+    if (typeof result[key] === 'object') _metadata(result[key])
+    if (!(key in METADATA)) continue
+    if (!KEYSTOCLEANUP[key]) {
+      if (propertyName) odataResult[METADATA[key]] = result[key]
+      else result[METADATA[key]] = result[key]
     }
-    delete result[key]
+    if (!propertyName) delete result[key]
+  }
+}
+
+const _cleanupMetadata = (propertyName, result) => {
+  if (typeof result !== 'object') return odataResult
+
+  const odataResult = {}
+  if (propertyName) {
+    odataResult.value = result[propertyName]
+  } else {
+    odataResult.value = result
   }
 
+  if (Array.isArray(result)) _metadataRoot(result, odataResult)
+  _metadata(result, propertyName, odataResult)
+
   return odataResult
 }
 
@@ -53,6 +77,90 @@ const _setContext = (odataResult, info, isCollection) => {
   return odataResult
 }
 
+const _getParent = (model, name) => {
+  const target = model.definitions[name]
+
+  if (target && target.elements) {
+    for (const elementName in target.elements) {
+      const element = target.elements[elementName]
+      if (element._anchor && element._anchor._isContained) return element._anchor
+    }
+  }
+
+  return null
+}
+
+const addEtags = (row, key) => {
+  row['$etag'] = row[key].startsWith('W/') ? row[key] : `W/"${row[key]}"`
+}
+
+const _processCategory = (category, elementInfo) => {
+  const { row, key } = elementInfo
+
+  switch (category) {
+    case '@odata.etag':
+      addEtags(row, key)
+      break
+    case 'stringify':
+      // REVISIT: remove once DB always returns strings
+      if (row[key] == null) return
+      row[key] = `${row[key]}`
+      break
+    // no default
+  }
+}
+
+const _processorFn = () => elementInfo => {
+  const { row, key, plain } = elementInfo
+  if (typeof row !== 'object' || !Object.prototype.hasOwnProperty.call(row, key)) return
+  const categories = plain.categories
+
+  for (const category of categories) {
+    _processCategory(category, elementInfo)
+  }
+}
+
+const _pick = element => {
+  const categories = []
+  if (element['@odata.etag']) categories.push('@odata.etag')
+  if (element.type === 'cds.Decimal' || element.type === 'cds.Integer64') categories.push('stringify') // REVISIT: remove once DB always returns strings
+  if (categories.length) return { categories }
+}
+
+const postProcess = (target, service, result, isMinimal) => {
+  const { model } = service
+  if (!target || !result || !model || !model.definitions[target.name]) return
+
+  const cacheKey = isMinimal ? 'postProcessMinimal' : 'postProcess'
+  const parent = _getParent(model, target.name)
+  const template = getTemplate(
+    cacheKey,
+    service,
+    target,
+    { pick: _pick, ignore: isMinimal ? el => el.isAssociation : undefined },
+    parent
+  )
+
+  if (template.elements.size === 0) return
+
+  // normalize result to rows
+  result = result.value != null && Object.keys(result).filter(k => !k.match(/^\W/)).length === 1 ? result.value : result
+
+  if (typeof result === 'object' && result != null) {
+    const rows = Array.isArray(result) ? result : [result]
+
+    // process each row
+    const processFn = _processorFn()
+    for (const row of rows) {
+      templateProcessor({
+        processFn,
+        row,
+        template
+      })
+    }
+  }
+}
+
 /**
  * Convert any result to the result object structure, which is expected of odata-v4.
  *
@@ -72,12 +180,7 @@ const toODataResult = (result, info) => {
   if (isCollection && !Array.isArray(result)) result = [result]
   else if (!isCollection && Array.isArray(result)) result = result[0]
 
-  let value = result
-  if (typeof result === 'object') {
-    if (propertyName) value = result[propertyName]
-  }
-
-  const odataResult = _cleanupMetadata({ value }, result)
+  const odataResult = _cleanupMetadata(propertyName, result)
 
   // REVISIT: Support exponential decimals header
   // REVISIT: we always assume minimal metadata right now
@@ -88,4 +191,4 @@ const toODataResult = (result, info) => {
   return odataResult
 }
 
-module.exports = { toODataResult }
+module.exports = { toODataResult, postProcess }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/cds",
-  "version": "7.7.3",
+  "version": "7.8.0",
   "description": "SAP Cloud Application Programming Model - CDS for Node.js",
   "homepage": "https://cap.cloud.sap/",
   "keywords": [

package/server.js

@@ -22,6 +22,7 @@ module.exports = async function cds_server (options) {
 
   // mount static resources and cors middleware
   if (o.cors)      app.use (o.cors)                     //> if not in prod
+  if (o.health)    app.get ('/health', o.health)
   if (o.static)    app.use (express.static (o.static))  //> defaults to ./app
   if (o.favicon)   app.use ('/favicon.ico', o.favicon)  //> if none in ./app
   if (o.index)     app.get ('/',o.index)                //> if none in ./app
@@ -76,6 +77,9 @@ const defaults = {
       }
       next()
     }
+  },
+  get health() {
+    return (_, res) => res.json({ status: 'UP' })
   }
 }