@sap/cds 5.8.1 → 5.8.2

package/CHANGELOG.md

@@ -4,6 +4,19 @@
 - The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - This project adheres to [Semantic Versioning](http://semver.org/).
 
+## Version 5.8.2 - 2022-02-22
+
+### Fixed
+
+- Crash if error does not have a stack in kibana logging
+- Allow short names for bound operations in odata-server
+- Performance issue during deep operations
+- Resolving views with parameters
+- Expanding association-to-many within draft union scenario
+- Erroneous invalidation of deep `INSERT|UPDATE|DELETE` operations if root entity has managed to-one association to non-writable view
+- Handling of falsy results when sending requests to remote services
+- Resolving foreign key propagations for views with union
+
 ## Version 5.8.1 - 2022-02-11
 
 ### Fixed
@@ -36,9 +49,6 @@
 - Restrict access to all services via `cds.env.requires.auth.restrict_all_services = true`
   + That is, all unrestricted services (i.e., w/o own `@requires`) are treated as having `@requires: 'authenticated-user'`
 - Threshold for automatically sending GET requests as `$batch` (beta, cf. @sap/cds@5.6.0) can be configured per remote service via `cds.env.requires.<srv>.max_get_url_length` (if not configured on service, the global config applies)
-- Alpha out-of-the-box support for DwC
-  + Authentication based on headers set by Jupiter router via `cds.env.requires.auth.kind = 'dwc-auth'`
-  + All DwC headers are forwarded to remote service via `cds.env.requires.<srv>.forward_dwc_headers = true`
 - Limited support for binary data in OData
   + In payloads, the binary data must be a base64 encoded string
   + In URLs, the binary data must have the following format: `binary'<url-safe base64 encoded>'`, e.g., `$filter=ID eq binary'Q0FQIE5vZGUuanM='`

package/lib/log/format/kibana.js

@@ -1,4 +1,4 @@
-const cds = require ('../../')
+const cds = require('../../')
 const util = require('util')
 
 const _l2l = { 1: 'error', 2: 'warn', 3: 'info', 4: 'debug', 5: 'trace' }
@@ -8,7 +8,7 @@ const _l2l = { 1: 'error', 2: 'warn', 3: 'info', 4: 'debug', 5: 'trace' }
  */
 module.exports = (module, level, ...args) => {
   // config
-  const { user: log_user , kibana_custom_fields } = cds.env.log
+  const { user: log_user, kibana_custom_fields } = cds.env.log
 
   // build the object to log
   const toLog = {
@@ -36,7 +36,7 @@ module.exports = (module, level, ...args) => {
   if (args.length && typeof args[0] === 'object' && args[0].message) {
     const err = args.shift()
     toLog.msg = err.message
-    if (err instanceof Error) toLog.stacktrace = err.stack.split(/\s*\r?\n\s*/)
+    if (typeof err.stack === 'string') toLog.stacktrace = err.stack.split(/\s*\r?\n\s*/)
     Object.assign(toLog, err, { level: toLog.level })
   }
 

package/libx/_runtime/cds-services/adapter/odata-v4/ODataRequest.js

@@ -45,9 +45,7 @@ function _getTarget(service, segments) {
       : last.getEdmType().csdlStructuredType.name
 
     // autoexposed entities now used . in csn and _ in edm
-    const target =
-      findCsnTargetFor(name, service.model, namespace) ||
-      (name.endsWith('Parameters') && service.model.definitions[namespace + '.' + name.replace(/Parameters$/, '')])
+    const target = findCsnTargetFor(name, service.model, namespace)
 
     if (target && target.kind === 'entity') {
       return target

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-commons/uri/ResourcePathParser.js

@@ -396,7 +396,18 @@ class ResourcePathParser {
       throw new UriSyntaxError(UriSyntaxError.Message.PREVIOUS_TYPE_HAS_NO_MEDIA, currentType.getName())
     }
 
-    const uriResources = this._parsePropertyPath(uriPathSegments, currentResource, tokenizer)
+    let uriResources
+    try {
+      uriResources = this._parsePropertyPath(uriPathSegments, currentResource, tokenizer)
+    } catch (e) {
+      try {
+        uriResources = this._parseBoundOperation(uriPathSegments, currentResource, tokenizer)
+      } catch (e1) {
+        // throw first error
+        throw e
+      }
+    }
+
     return result.concat(uriResources)
   }
 
@@ -409,7 +420,17 @@ class ResourcePathParser {
    * @private
    */
   _parseBoundOperation (uriPathSegments, currentResource, tokenizer) {
-    const fqn = FullQualifiedName.createFromNameSpaceAndName(tokenizer.getText())
+    // allow short names for bound operations
+    let name = tokenizer.getText()
+    if (typeof name === 'string' && !name.match(/\./)) {
+      const namespace = currentResource._entitySet &&
+        currentResource._entitySet._target &&
+        currentResource._entitySet._target.type &&
+        currentResource._entitySet._target.type.namespace
+      if (namespace) name = namespace + '.' + name
+    }
+
+    const fqn = FullQualifiedName.createFromNameSpaceAndName(name)
     const bindingParamTypeFqn = currentResource.getEdmType().getFullQualifiedName()
 
     // parse bound action

package/libx/_runtime/common/composition/tree.js

@@ -38,7 +38,7 @@ const _foreignKeysToLinks = (element, inverse) =>
 const _resolvedElement = (element, service) => {
   if (!element.target) return element
   // skip forbidden view check if association to view with foreign key in target
-  const skipForbiddenViewCheck = element._isAssociationStrict && element.on && !element['@odata.contained']
+  const skipForbiddenViewCheck = element._isAssociationStrict && !element['@odata.contained']
   const { target, mapping } = getTransition(element._target, service, skipForbiddenViewCheck)
   const newElement = { target: target.name, _target: target }
   Object.setPrototypeOf(newElement, element)

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

@@ -79,8 +79,20 @@ const getDataSubject = (entity, model, role) => {
   return entity.set(hash, dataSubject)
 }
 
-const _resolve = (name, model, namespace) =>
-  model.entities(namespace)[name] || model.definitions[`${namespace}.${name}`]
+const _findInModel = (name, model, namespace) => {
+  return model.entities(namespace)[name] || model.definitions[`${namespace}.${name}`]
+}
+
+const _resolve = (name, model, namespace) => {
+  const resolved = _findInModel(name, model, namespace)
+  // the edm name has an additional suffix 'Parameters' in case of views with parameters
+  if (!resolved && name.endsWith('Parameters')) {
+    const viewWithParam = _findInModel(name.replace(/Parameters$/, ''), model, namespace)
+    if (!viewWithParam || !viewWithParam.params) return
+    return viewWithParam
+  }
+  return resolved
+}
 
 const _findRootEntity = (model, edmName, namespace) => {
   const parts = edmName.split('_')

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

@@ -178,6 +178,12 @@ const _resolveTargetForeignKey = targetKey => {
   return { targetName, propagation }
 }
 
+const _resolveColumnsFromQuery = query => {
+  if (query && query.SET) return _resolveColumnsFromQuery(query.SET.args[0])
+  if (query && query.SELECT && query.SELECT.columns) return query.SELECT.columns
+  return []
+}
+
 const _resolvedKeys = (foreignKeys, targetKeys, fillChild) => {
   const foreignKeyPropagations = []
 
@@ -191,12 +197,9 @@ const _resolvedKeys = (foreignKeys, targetKeys, fillChild) => {
      * Once you have the full path, you can find it in the target entity.
      * NOTE: There can be projections upon projections and renamings in every projection. -> not yet covered!!!
      */
-    const tkCol =
-      targetKeys[i].parent.query &&
-      targetKeys[i].parent.query.SELECT.columns &&
-      targetKeys[i].parent.query.SELECT.columns.find(
-        c => c.ref && `${fk['@odata.foreignKey4']}_${c.ref.join('_')}` === fk.name
-      )
+    const tkCol = _resolveColumnsFromQuery(targetKeys[i].parent.query).find(
+      c => c.ref && `${fk['@odata.foreignKey4']}_${c.ref.join('_')}` === fk.name
+    )
     tk = tkCol && targetKeys.find(tk => tk.name === (tkCol.as ? tkCol.as : tkCol.ref.join('_')))
     // with composition of aspects, the lookup fails -> we need this final fallback
     if (!tk) tk = targetKeys[i]

package/libx/_runtime/db/expand/expandCQNToJoin.js

@@ -1151,28 +1151,37 @@ class JoinCQNFromExpanded {
           }
         }
       }
-      const ks = Object.keys(expandedEntity.keys).filter(
-        c => !expandedEntity.keys[c].isAssociation && !DRAFT_COLUMNS.includes(c)
-      )
-      const user = (cds.context && cds.context.user && cds.context.user.id) || 'anonymous'
-      const unionFrom = getCQNUnionFrom(cols, ref.replace(/_drafts$/, ''), ref, ks, user)
-      for (const each of cqn.columns) {
-        if (!each.as) continue
-        // replace val with ref
-        if (each.as === 'IsActiveEntity' || each.as === 'HasActiveEntity') {
-          delete each.val
-          each.ref = [tableAlias, each.as]
-          each.as = tableAlias + '_' + each.as
-        }
-        // ensure the cast
-        if (each.as.match(/IsActiveEntity$/) || each.as.match(/HasActiveEntity$/) || each.as.match(/HasDraftEntity$/)) {
-          each.cast = { type: 'cds.Boolean' }
+
+      if (!cqn[IS_ACTIVE]) {
+        const ks = Object.keys(expandedEntity.keys).filter(
+          c => !expandedEntity.keys[c].isAssociation && !DRAFT_COLUMNS.includes(c)
+        )
+        const user = (cds.context && cds.context.user && cds.context.user.id) || 'anonymous'
+        const unionFrom = getCQNUnionFrom(cols, ref.replace(/_drafts$/, ''), ref, ks, user)
+        for (const each of cqn.columns) {
+          if (!each.as) continue
+          // replace val with ref
+          if (each.as === 'IsActiveEntity' || each.as === 'HasActiveEntity') {
+            delete each.val
+            each.ref = [tableAlias, each.as]
+            each.as = tableAlias + '_' + each.as
+          }
+          // ensure the cast
+          if (
+            each.as.match(/IsActiveEntity$/) ||
+            each.as.match(/HasActiveEntity$/) ||
+            each.as.match(/HasDraftEntity$/)
+          ) {
+            each.cast = { type: 'cds.Boolean' }
+          }
         }
+        const cs = cqn.columns
+          .filter(c => !c.expand && c.ref && c.ref[0] === tableAlias)
+          .map(c => ({ ref: [c.ref[1]] }))
+        const unionArgs = cqn.from.args
+        unionArgs[0].SELECT = { columns: cs, from: unionFrom, distinct: true }
+        delete unionArgs[0].ref
       }
-      const cs = cqn.columns.filter(c => !c.expand && c.ref && c.ref[0] === tableAlias).map(c => ({ ref: [c.ref[1]] }))
-      const unionArgs = cqn.from.args
-      unionArgs[0].SELECT = { columns: cs, from: unionFrom, distinct: true }
-      delete unionArgs[0].ref
     }
 
     return cqn

package/libx/_runtime/db/utils/deep.js

@@ -1,14 +1,18 @@
-function _flattenDeep(arr) {
-  return arr.reduce((acc, val) => acc.concat(Array.isArray(val) ? _flattenDeep(val) : val), [])
+const _flattenDeep = (arr, res) => {
+  if (!Array.isArray(arr)) {
+    res.push(arr)
+    return res
+  }
+  for (const a of arr) {
+    _flattenDeep(a, res)
+  }
+  return res
 }
 
 /*
  * flatten with a dfs approach. this is important!!!
  */
-function getFlatArray(arg) {
-  if (!Array.isArray(arg)) return [arg]
-  return _flattenDeep(arg)
-}
+const getFlatArray = arg => _flattenDeep(arg, [])
 
 async function _processChunk(processFn, model, dbc, cqns, user, locale, ts, indexes, results) {
   const promises = []

package/libx/_runtime/hana/dynatrace.js

@@ -7,11 +7,12 @@ try {
 }
 
 const isDynatraceEnabled = () => {
-  return dynatrace.sdk !== undefined
+  return dynatrace.sdk !== undefined && !process.env.CDS_SKIP_DYNATRACE
 }
 
 const _dynatraceResultCallback = function (tracer, cb) {
-  return function (err, results, fields) {
+  return function (err, ...args) {
+    const results = args.shift()
     if (err) {
       tracer.error(err)
     } else {
@@ -19,7 +20,7 @@ const _dynatraceResultCallback = function (tracer, cb) {
         rowsReturned: (results && results.length) || results
       })
     }
-    tracer.end(cb, err, results, fields)
+    tracer.end(cb, err, results, ...args)
   }
 }
 
@@ -73,9 +74,14 @@ const dynatraceClient = (client, credentials, tenant) => {
   // hana-client does not like decorating.
   // because of that, we need to override the fn and pass the original fn for execution
   const originalExecFn = client.exec
-  const originalPrepareFn = client.prepare
   client.exec = _execUsingDynatrace(client, originalExecFn, dbInfo)
-  client.prepare = _preparedStmtUsingDynatrace(client, originalPrepareFn, dbInfo)
+  const originalPrepareFn = client.prepare
+  if (client.name === '@sap/hana-client') {
+    // client.prepare = ... doesn't work for hana-client
+    Object.defineProperty(client, 'prepare', { value: _preparedStmtUsingDynatrace(client, originalPrepareFn, dbInfo) })
+  } else {
+    client.prepare = _preparedStmtUsingDynatrace(client, originalPrepareFn, dbInfo)
+  }
 
   return client
 }

package/libx/_runtime/hana/execute.js

@@ -66,15 +66,73 @@ function _getBinaries(stmt) {
 
 const BASE64 = /^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}={2})$/
 
+function _isProcedureCall(sql) {
+  return sql.trim().match(/^call \s*"{0,1}\w*/i)
+}
+
+function _getProcedureName(sql) {
+  const match = sql.trim().match(/^call \s*"{0,1}(\w*)/i)
+  return match && match[1]
+}
+
+function _hdbGetResultForProcedure(rows, args, outParameters) {
+  // on hdb, rows already contains results for scalar params
+  const result = rows || {}
+  // merge table output params into scalar params
+  if (args && args.length && outParameters) {
+    const params = outParameters.filter(md => !(md.PARAMETER_NAME in rows))
+    for (let i = 0; i < args.length; i++) {
+      result[params[i].PARAMETER_NAME] = args[i]
+    }
+  }
+  return result
+}
+
+function _hcGetResultForProcedure(stmt, resultSet, outParameters) {
+  const result = {}
+  // build result from scalar params
+  const paramInfo = stmt.getParameterInfo()
+  if (paramInfo.some(p => p.direction > 1)) {
+    for (let i = 0; i < paramInfo.length; i++) {
+      if (paramInfo[i].direction > 1) {
+        result[paramInfo[i].name] = stmt.getParameterValue(i)
+      }
+    }
+  }
+  // merge table output params into scalar params
+  if (outParameters && outParameters.length) {
+    const params = outParameters.filter(md => !(md.PARAMETER_NAME in result))
+    let i = 0
+    while (resultSet.next()) {
+      result[params[i].PARAMETER_NAME] = [resultSet.getValues()]
+      resultSet.nextResult()
+      i++
+    }
+  }
+  return result
+}
+
+function _getProcedureMetadata(procedureName, dbc) {
+  return new Promise((resolve, reject) => {
+    dbc.exec(
+      `SELECT PARAMETER_NAME FROM SYS.PROCEDURE_PARAMETERS WHERE SCHEMA_NAME = CURRENT_SCHEMA AND PROCEDURE_NAME = '${procedureName}' AND PARAMETER_TYPE IN ('OUT', 'INOUT') ORDER BY POSITION`,
+      (err, res) => {
+        if (err) reject(err)
+        else resolve(res)
+      }
+    )
+  })
+}
+
 function _executeAsPreparedStatement(dbc, sql, values, reject, resolve) {
-  dbc.prepare(sql, function (err, stmt) {
+  dbc.prepare(sql, async function (err, stmt) {
     if (err) {
       err.query = sql
       if (values) err.values = SANITIZE_VALUES ? ['***'] : values
       return reject(err)
     }
 
-    // convert binary strings to buffers ()
+    // convert binary strings to buffers
     if (cds.env.hana.base64_to_buffer !== false && _hasValues(values)) {
       const binaries = _getBinaries(stmt)
       if (binaries.length) {
@@ -89,6 +147,46 @@ function _executeAsPreparedStatement(dbc, sql, values, reject, resolve) {
       }
     }
 
+    if (cds.env.features.new_call_prodecure) {
+      // procedure call metadata
+      let outParameters
+      const isProcedureCall = _isProcedureCall(sql)
+      if (isProcedureCall) {
+        try {
+          const procedureName = _getProcedureName(sql)
+          outParameters = await _getProcedureMetadata(procedureName, dbc)
+        } catch (e) {
+          LOG._warn && LOG.warn('Unable to fetch procedure metadata due to error:', e)
+        }
+      }
+
+      // on @sap/hana-client, we need to use execQuery in case of calling procedures
+      stmt[isProcedureCall && dbc.name !== 'hdb' ? 'execQuery' : 'exec'](values, function (err, rows, ...args) {
+        if (err) {
+          stmt.drop(() => {})
+          err.query = sql
+          if (values) err.values = SANITIZE_VALUES ? ['***'] : values
+          return reject(err)
+        }
+
+        let result
+        if (isProcedureCall) {
+          result =
+            dbc.name === 'hdb'
+              ? _hdbGetResultForProcedure(rows, args, outParameters)
+              : _hcGetResultForProcedure(stmt, rows, outParameters)
+        } else {
+          result = rows
+        }
+
+        stmt.drop(() => {})
+
+        resolve(result)
+      })
+
+      return
+    }
+
     stmt.exec(values, function (err, rows, procedureReturn) {
       if (err) {
         stmt.drop(() => {})
@@ -123,15 +221,15 @@ function _executeSimpleSQL(dbc, sql, values) {
       values = Object.values(values)
     }
     // ensure that stored procedure with parameters is always executed as prepared
-    if (_hasValues(values) || sql.match(/^call.*?\?.*$/i)) {
+    if (_hasValues(values) || _isProcedureCall(sql)) {
       _executeAsPreparedStatement(dbc, sql, values, reject, resolve)
     } else {
-      dbc.exec(sql, function (err, result, procedureReturn) {
+      dbc.exec(sql, function (err, result) {
         if (err) {
           err.query = sql
           return reject(err)
         }
-        resolve(procedureReturn || result)
+        resolve(result)
       })
     }
   })

package/libx/_runtime/remote/utils/client.js

@@ -142,8 +142,8 @@ function _defineProperty(obj, property, value) {
 }
 
 function _normalizeMetadata(prefix, data, results) {
-  const target = results || data
-  if (typeof target !== 'object') return target
+  const target = results !== undefined ? results : data
+  if (typeof target !== 'object' || target === null) return target
   const metadataKeys = Object.keys(data).filter(k => prefix.test(k))
   for (const k of metadataKeys) {
     const $ = k.replace(prefix, '$')
@@ -169,7 +169,7 @@ const _purgeODataV2 = (data, target, reqHeaders) => {
   data = data.d
   const ieee754Compatible = reqHeaders.accept && reqHeaders.accept.includes('IEEE754Compatible=true')
   const exponentialDecimals = ieee754Compatible && reqHeaders.accept.includes('ExponentialDecimals=true')
-  const purgedResponse = data.results || data
+  const purgedResponse = 'results' in data ? data.results : data
   const convertedResponse = convertV2ResponseData(purgedResponse, target, ieee754Compatible, exponentialDecimals)
   return _normalizeMetadata(/^__/, data, convertedResponse)
 }
@@ -177,7 +177,7 @@ const _purgeODataV2 = (data, target, reqHeaders) => {
 const _purgeODataV4 = data => {
   if (typeof data !== 'object') return data
 
-  const purgedResponse = data.value || data
+  const purgedResponse = 'value' in data ? data.value : data
   return _normalizeMetadata(/^@odata\./, data, purgedResponse)
 }
 

package/libx/_runtime/remote/utils/data.js

@@ -39,7 +39,8 @@ const _getConvertRecordFn = (target, convertValueFn) => record => {
     if (!element) continue
 
     const recordValue = record[key]
-    const value = (recordValue && recordValue.results) || recordValue
+    const value =
+      (recordValue && typeof recordValue === 'object' && 'results' in recordValue && recordValue.results) || recordValue
 
     if (value && (element.isAssociation || Array.isArray(value))) {
       record[key] = _convertData(value, element._target, convertValueFn)

package/package.json

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