@sap/cds 5.9.6 → 6.0.1

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

@@ -1,31 +1,87 @@
 const cds = require('../../../../cds')
-const { SELECT } = cds.ql
+const {
+  Request,
+  ql: { SELECT }
+} = cds
+const LOG = cds.log()
+const { normalizeError } = require('../../../../common/error/frontend')
 
-const { getDeepSelect } = require('../../../services/utils/handlerUtils')
-const { DRAFT_COLUMNS_MAP } = require('../../../../common/constants/draft')
-const { filterKeys } = require('../../../../fiori/utils/handler')
+const { getDeepSelect, getSimpleSelectCQN } = require('./handlerUtils')
+const { hasDeepUpdate } = require('../../../../common/composition/update')
+const { WRITE_EVENTS, CDS_EVENTS, DRAFT_MOD_EVENTS } = require('../../../../common/constants/events')
 
-const _getColumns = target => {
-  const columns = []
-  for (const k in target.elements) {
-    if (!target.elements[k].isAssociation && !(k in DRAFT_COLUMNS_MAP)) columns.push(k)
-  }
+const setLocationHeader = (req, { model }) => {
+  const { odataRes } = req._
+  const cqn = getSimpleSelectCQN(req.target, req.data)
+  const { path: location } = cds.odata.urlify(cqn, { kind: 'odata', model, method: 'GET' })
+  odataRes.setHeader('Location', location.replace(/\?.*$/, ''))
+}
+
+const _isNoAccessError = e => Number(e.code) === 403 || Number(e.code) === 401
+const _isNotFoundError = e => Number(e.code) === 404
+const _isEntityNotReadableError = e => Number(e.code) === 405
+
+const _handleReadError = (err, req) => {
+  if (!(_isNoAccessError(err) || _isEntityNotReadableError(err) || _isNotFoundError(err))) throw err
+  const log = Object.assign(err, { level: 'ERROR', message: normalizeError(err, req).error.message })
+  process.env.NODE_ENV !== 'production' && LOG._warn && LOG.warn(log)
+}
+
+const _getOperationQueryColumns = urlQueryOptions => {
+  if (!urlQueryOptions || !(urlQueryOptions.$select || urlQueryOptions.$expand)) return []
+  const url = []
+  if (urlQueryOptions.$select) url.push(`$select=${urlQueryOptions.$select}`)
+  if (urlQueryOptions.$expand) url.push(`$expand=${urlQueryOptions.$expand}`)
+  const {
+    SELECT: { columns }
+  } = cds.odata.parse(`?${url.join('&')}`)
   return columns
 }
 
-module.exports = async (req, srv) => {
-  let deepSelect
-  if (req.event === 'draftActivate') {
-    const where = filterKeys(req.target.keys).reduce((w, k) => {
-      w[k] = req.data[k]
-      return w
-    }, {})
-    deepSelect = SELECT.from(req.target).columns(_getColumns(req.target)).where(where)
-  } else if (req.event === 'UPDATE') {
-    deepSelect = SELECT.from(req.query.UPDATE.entity, _getColumns(req.target))
+const _isDraftAction = req => req.event in DRAFT_MOD_EVENTS
+const _isActionOrFunction = req => !(req.event in CDS_EVENTS) || _isDraftAction(req)
+const _isWriteWithResponse = req => req.event in WRITE_EVENTS && !(req.event in { CANCEL: 1, DELETE: 1 })
+
+const readAfterWrite = async (req, srv, { operation, isBefore } = { isBefore: false }) => {
+  let query
+
+  if (_isActionOrFunction(req)) {
+    const { result, returnType } = operation
+    query = getSimpleSelectCQN(returnType, result, _getOperationQueryColumns(req._queryOptions))
+    if (_isDraftAction(req)) query.where({ IsActiveEntity: req.event === 'draftActivate' })
+  } else if (req.event === 'UPDATE' && !hasDeepUpdate(srv.model, req.query)) {
+    query = Array.isArray(req.data) ? SELECT.from(req.query.UPDATE.entity) : SELECT.one(req.query.UPDATE.entity)
   } else {
-    deepSelect = getDeepSelect(req)
+    query = getDeepSelect(req)
+  }
+  Object.defineProperty(query.SELECT, '_4odata', { value: true })
+  // gracefully set location and no body if no read auth or not readable capability
+  let result
+  try {
+    const _req = new Request({ query, event: 'READ', _: req._ })
+    result = await srv.dispatch(_req)
+    if (result === null && !isBefore && (_isWriteWithResponse(req) || _isDraftAction(req))) {
+      // > something must be written and no READ error <=> @restrict or static where
+      _req.reject({
+        code: 404,
+        internal: {
+          reason: `No data found for "READ" after "${req.method}" of "${query._target.name}"`,
+          source: `"@restrict" or "where" of "${query._target.name}" or underlying entities`
+        }
+      })
+    }
+  } catch (e) {
+    _handleReadError(e, req)
+    result = null
+  }
+  // draft actions have own logic to set location header
+  if (result === null && _isWriteWithResponse(req) && !_isDraftAction(req)) {
+    setLocationHeader(req, srv)
   }
-  const result = await cds.tx(req).run(deepSelect)
   return result
 }
+
+module.exports = {
+  readAfterWrite,
+  setLocationHeader
+}

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

@@ -8,16 +8,8 @@ const {
 
 const getError = require('../../../../common/error')
 
-const _unboundActionsAndFunctions = ['ACTION.IMPORT', 'FUNCTION.IMPORT']
-const _unboundCustomOperationKinds = _unboundActionsAndFunctions.reduce((acc, cur) => {
-  acc[cur] = 1
-  return acc
-}, {})
-const _actionsAndFunctions = [..._unboundActionsAndFunctions, 'BOUND.ACTION', 'BOUND.FUNCTION']
-const _boundCustomOperationKinds = _actionsAndFunctions.reduce((acc, cur) => {
-  acc[cur] = 1
-  return acc
-}, {})
+const _unboundActionsAndFunctions = { 'ACTION.IMPORT': 1, 'FUNCTION.IMPORT': 1 }
+const _actionsAndFunctions = { ..._unboundActionsAndFunctions, 'BOUND.ACTION': 1, 'BOUND.FUNCTION': 1 }
 
 /**
  * Checks if a custom operation was requested.
@@ -29,7 +21,7 @@ const _boundCustomOperationKinds = _actionsAndFunctions.reduce((acc, cur) => {
  */
 const isCustomOperation = (pathSegments, includingBound = true) => {
   const kind = pathSegments[pathSegments.length - 1].getKind()
-  const kinds = includingBound ? _boundCustomOperationKinds : _unboundCustomOperationKinds
+  const kinds = includingBound ? _actionsAndFunctions : _unboundActionsAndFunctions
   if (kind in kinds) {
     return kind
   }

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

@@ -6,6 +6,7 @@ const { big } = require('@sap/cds-foss')
 const getTemplate = require('../../../../common/utils/template')
 const templateProcessor = require('../../../../common/utils/templateProcessor')
 const { omitValue, applyOmitValuesPreference } = require('./omitValues')
+const { setLocationHeader } = require('./readAfterWrite')
 
 const METADATA = {
   $context: '*@odata.context',
@@ -44,6 +45,35 @@ const _getPropertyName = req => {
   }
 }
 
+const _cleanupMetadata = (odataResult, result, req) => {
+  if (typeof result !== 'object') return odataResult
+  // backwards compatibility for content-type in stream
+  if ('*@odata.mediaContentType' in result) result.$mediaContentType = result['*@odata.mediaContentType']
+  if ('$mediaContentDispositionFilename' in result && req) {
+    const cdt = result.$mediaContentDispositionType || 'attachment'
+    req._.odataRes.setHeader(
+      'Content-Disposition',
+      `${cdt}; filename="${encodeURIComponent(result.$mediaContentDispositionFilename)}"`
+    )
+  }
+
+  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
+  }
+
+  for (const key in METADATA) {
+    if (!(key in result)) continue
+    if (!keysToCleanup[key]) odataResult[METADATA[key]] = result[key]
+    delete result[key]
+  }
+
+  return odataResult
+}
+
 /**
  * Convert any result to the result object structure, which is expected of odata-v4.
  *
@@ -51,63 +81,55 @@ const _getPropertyName = req => {
  * @param {*} [req]
  * @returns {string | object}
  */
-// eslint-disable-next-line complexity
 const toODataResult = (result, req) => {
   if (result == null) return ''
 
-  let propertyName, isStream
+  let propertyName, isStream, isCollection
   if (req) {
-    propertyName = _getPropertyName(req)
-    isStream =
-      req._.odataReq.getUriInfo().getLastSegment().getProperty() &&
-      req._.odataReq.getUriInfo().getLastSegment().getProperty().getType().toString() === 'Edm.Stream'
-
-    const isCollection = !propertyName && req._.odataReq.getUriInfo().getLastSegment().isCollection()
-    if (isCollection && !Array.isArray(result)) result = [result]
-    else if (!isCollection && Array.isArray(result)) result = result[0]
+    if (cds.env.features.odata_new_parser) {
+      propertyName = req._metaInfo.propertyName
+      isStream = req._metaInfo.isStream
+      isCollection = req._metaInfo.isCollection
+    } else {
+      propertyName = _getPropertyName(req)
+      isStream =
+        req._.odataReq.getUriInfo().getLastSegment().getProperty() &&
+        req._.odataReq.getUriInfo().getLastSegment().getProperty().getType().toString() === 'Edm.Stream'
+
+      isCollection =
+        !propertyName &&
+        !(req.event in { NEW: 1, CREATE: 1, UPDATE: 1, UPSERT: 1, EDIT: 1, PATCH: 1 }) &&
+        req._.odataReq.getUriInfo().getLastSegment().isCollection()
+    }
   }
 
+  if (isCollection && !Array.isArray(result)) result = [result]
+  else if (!isCollection && Array.isArray(result)) result = result[0]
+
   let value = result
   if (typeof result === 'object') {
     if ('value' in result && (result.value instanceof Readable || isStream)) value = result.value
     else if (propertyName) value = result[propertyName]
   }
 
-  const odataResult = { value }
+  const odataResult = _cleanupMetadata({ value }, result, req)
 
-  if (typeof result === 'object') {
-    // backwards compatibility for content-type in stream
-    if (result['*@odata.mediaContentType']) result.$mediaContentType = result['*@odata.mediaContentType']
-
-    for (const key in METADATA) {
-      // do not set "@odata.context" as it may be inherited of remote service
-      if (key === '$context') {
-        delete result[key]
-        continue
-      }
-
-      // REVISIT: okra doesn't support content disposition
-      if (key === '$mediaContentDispositionFilename' && result[key] && req) {
-        const cdt = result.$mediaContentDispositionType || 'attachment'
-        req._.odataRes.setHeader('Content-Disposition', `${cdt}; filename="${encodeURIComponent(result[key])}"`)
-        delete result[key]
-        continue
-      }
-      if (key === '$mediaContentDispositionType') {
-        delete result[key]
-        continue
-      }
-
-      if (key in result) {
-        odataResult[METADATA[key]] = result[key]
-        delete result[key]
-      }
-    }
+  const { metadata } = _getOptions(req)
+  if (cds.env.features.odata_new_parser && metadata !== 'none') {
+    return _setContext(odataResult, req, isCollection)
   }
 
   return odataResult
 }
 
+const _setContext = (odataResult, req, isCollection) => {
+  if (req && req._metaInfo) {
+    const result = isCollection ? odataResult : odataResult.value
+    if (result != null) Object.assign(result, { [METADATA.$context]: req._metaInfo.contextUrl })
+  }
+  return odataResult
+}
+
 const addEtags = (row, key) => {
   row['*@odata.etag'] = row[key]
 }
@@ -158,12 +180,12 @@ const localizeAfterDraftActivate = (row, key, locale) => {
   }
 }
 
-const _processCategory = (category, processArgs, req, options, previousResult) => {
-  const { row, key, element } = processArgs
+const _processCategory = (req, category, elementInfo, options, previousResult) => {
+  const { row, key, element } = elementInfo
 
   switch (category) {
     case '@odata.omitValues':
-      omitValue(processArgs, req, options.omitValuesPreference, previousResult)
+      omitValue(elementInfo, req, options.omitValuesPreference, previousResult)
       break
 
     case '@odata.etag':
@@ -190,13 +212,13 @@ const _processCategory = (category, processArgs, req, options, previousResult) =
   }
 }
 
-const _processorFn = (req, previousResult, options) => processArgs => {
-  const { row, key, plain } = processArgs
+const _processorFn = (req, previousResult, options) => 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, processArgs, req, options, previousResult)
+    _processCategory(req, category, elementInfo, options, previousResult)
   }
 }
 
@@ -243,15 +265,18 @@ const _assocs = (element, target) => {
   return []
 }
 
-const _pick = options => (element, target, parent) => {
+const _pick = options => (element, target) => {
   const categories = []
 
   if (element['@odata.etag']) categories.push('@odata.etag')
-
   if (element._type === 'cds.Decimal') categories.push('@cds.Decimal')
 
   categories.push(..._assocs(element, target))
 
+  // REVISIT: It makes no sense to store static values inside the template, it would just
+  // blow up the memory of the template.
+  // For operations concering _all_ elements, the templating mechanism doesn't make sense
+  // and should not be used.
   if (options.omitValuesPreference) categories.push('@odata.omitValues')
   if (options.event === 'draftActivate' && options.locale && options.locale !== 'en' && element.localized === true) {
     categories.push('localizeAfterDraftActivate')
@@ -260,12 +285,15 @@ const _pick = options => (element, target, parent) => {
   if (categories.length) return { categories }
 }
 
-const _getOptions = ({ headers, locale, event }) => {
+const _getOptions = req => {
+  if (!req) return {}
+  const { headers, locale, event } = req
   const options = {
     decimals: null,
     omitValuesPreference: null,
     locale,
-    event
+    event,
+    metadata: 'minimal'
   }
 
   if (!headers) return options
@@ -278,6 +306,9 @@ const _getOptions = ({ headers, locale, event }) => {
     options.decimals = { exponential: acceptHeader.includes('ExponentialDecimals=true') }
   }
 
+  const metadataMatch = acceptHeader && acceptHeader.match(/metadata=(minimal|full|none)/)
+  if (metadataMatch) options.metadata = metadataMatch[1]
+
   const preferHeader = headers.prefer
 
   if (preferHeader && preferHeader.includes('omit-values=')) {
@@ -304,6 +335,7 @@ const postProcess = (req, res, service, result, previousResult) => {
   const options = _getOptions(req)
   const cacheKey = _generateCacheKey(headers, options)
   const parent = _getParent(model, target.name)
+  // REVISIT: Why so many templates? -> Create only one (superset) template to reduce memory consumption
   const template = getTemplate(cacheKey, service, target, { pick: _pick(options) }, parent)
 
   if (template.elements.size === 0) return
@@ -318,40 +350,30 @@ const postProcess = (req, res, service, result, previousResult) => {
     const processFn = _processorFn(req, previousResult, options)
 
     for (const row of rows) {
-      const args = {
+      templateProcessor({
         processFn,
         row,
         template
-      }
-
-      templateProcessor(args)
+      })
     }
   }
 
   applyOmitValuesPreference(res, options.omitValuesPreference)
 }
 
-const postProcessMinimal = (req, result) => {
-  const { target } = req
+const postProcessMinimal = (req, service, result) => {
+  const { target, timestamp } = req
 
   if (!target || !result) return
 
-  const etagElement = Object.values(target.elements).find(el => el['@odata.etag'])
-
-  if (!etagElement) return
+  setLocationHeader(req, service)
 
-  const etag = etagElement.name
-
-  // normalize result to rows
-  result = result.value && Object.keys(result).filter(k => !k.match(/^\W/)).length === 1 ? result.value : result
-  const rows = Array.isArray(result) ? result : [result]
-
-  // process each row
-  for (const row of rows) {
-    if (typeof row !== 'object' || !Object.prototype.hasOwnProperty.call(row, etag)) return
-
-    addEtags(row, etag)
+  const etag = target._etag && target._etag.name
+  if (timestamp && etag && etag in result) {
+    return { '*@odata.etag': result[etag] === '$now' ? new Date(timestamp).toISOString() : result[etag] }
   }
+
+  return null
 }
 
 module.exports = {

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

@@ -3,11 +3,12 @@ const LOG = cds.log('odata')
 
 const { SELECT } = cds.ql
 
-const { targetFromPath, isPathToDraft } = require('../../../../common/utils/cqn')
+const { isPathToDraft } = require('../../../../common/utils/cqn')
 const { deepCopyArray } = require('../../../../common/utils/copy')
 const { cqn2cqn4sql } = require('../../../../common/utils/cqn2cqn4sql')
 const { ensureDraftsSuffix } = require('../../../../fiori/utils/handler')
 const { removeIsActiveEntityRecursively, isActiveEntityRequested } = require('../../../../fiori/utils/where')
+const { getTransition } = require('../../../../common/utils/resolveView')
 
 const isStreaming = segments => {
   const lastSegment = segments[segments.length - 1]
@@ -44,8 +45,19 @@ const adaptStreamCQN = (cqn, isDraft = false) => {
   }
 }
 
+// eslint-disable-next-line complexity
 const getStreamProperties = (req, model) => {
-  const mediaTypeProperty = Object.values(req.target.elements).find(val => val['@Core.MediaType'])
+  // new odata parser sets streaming property in SELECT.from
+  const ref = (req.query.SELECT.columns && req.query.SELECT.columns[0].ref) || req.query.SELECT.from.ref
+  const propertyName = ref[ref.length - 1]
+  let mediaTypeProperty
+  for (let key in req.target.elements) {
+    const val = req.target.elements[key]
+    if (val['@Core.MediaType'] && val.name === propertyName) {
+      mediaTypeProperty = val
+      break
+    }
+  }
 
   let contentType, contentDispositionFilename
   const columns = []
@@ -56,10 +68,12 @@ const getStreamProperties = (req, model) => {
         LOG.warn(
           `@Core.MediaType in entity "${req.target.name}" points to property "${contentTypeProperty}" which was renamed or is not part of the projection. You must update the annotation value.`
         )
-      contentTypeProperty = (Object.values(req.target.elements).find(val => val['@Core.IsMediaType']) || {}).name
+      const mapping = getTransition(req.target, cds.db).mapping
+      const key = [...mapping.entries()].find(({ 1: val }) => val.ref[0] === contentTypeProperty)
+      contentTypeProperty = key && key.length && key[0]
     }
     if (!req.target.elements[contentTypeProperty]) {
-      LOG._warn && LOG.warn(`No @Core.IsMediaType found in entity "${req.target.name}".`)
+      LOG._warn && LOG.warn(`MediaType ${contentTypeProperty} not found in entity "${req.target.name}".`)
     } else {
       columns.push({ ref: [contentTypeProperty], as: 'contentType' })
     }
@@ -68,12 +82,19 @@ const getStreamProperties = (req, model) => {
   }
   if (mediaTypeProperty['@Core.ContentDisposition.Filename']) {
     if (typeof mediaTypeProperty['@Core.ContentDisposition.Filename'] === 'object') {
-      const contentDispositionProperty = mediaTypeProperty['@Core.ContentDisposition.Filename']['=']
+      let contentDispositionProperty = mediaTypeProperty['@Core.ContentDisposition.Filename']['=']
       if (!req.target.elements[contentDispositionProperty]) {
         LOG._warn &&
           LOG.warn(
             `@Core.ContentDisposition.Filename in entity "${req.target.name}" points to property "${contentDispositionProperty}" which was renamed or is not part of the projection. You must update the annotation value.`
           )
+        const mapping = getTransition(req.target, cds.db).mapping
+        const key = [...mapping.entries()].find(({ 1: val }) => val.ref[0] === contentDispositionProperty)
+        contentDispositionProperty = key && key.length && key[0]
+      }
+      if (!req.target.elements[contentDispositionProperty]) {
+        LOG._warn &&
+          LOG.warn(`ContentDisposition ${contentDispositionProperty} not found in entity "${req.target.name}".`)
       } else {
         columns.push({ ref: [contentDispositionProperty], as: 'contentDispositionFilename' })
       }
@@ -88,7 +109,7 @@ const getStreamProperties = (req, model) => {
     let select = SELECT.one.from({ ref: deepCopyArray(req.query.SELECT.from.ref) }).columns(columns)
 
     // new parser has media property as last ref element -> remove
-    if (targetFromPath(select.SELECT.from.ref, model).kind === 'element') select.SELECT.from.ref.pop()
+    if (req._metaInfo && req._metaInfo.propertyName) select.SELECT.from.ref.pop()
 
     const pathToDraft = isPathToDraft(select.SELECT.from.ref, model)
     if (req.target._isDraftEnabled && pathToDraft) {

package/libx/_runtime/cds-services/adapter/rest/utils/validation-checks.js

@@ -57,17 +57,6 @@ const _buildTypeErrorObject = (type, value) => {
   return { type, value }
 }
 
-const _checkArray = (type, check, data) => {
-  return data.filter(value => !check(value)).map(value => _buildTypeErrorObject(type, value))
-}
-
-const _checkSingle = (type, check, data) => {
-  if (!check(data)) {
-    return [_buildTypeErrorObject(type, data)]
-  }
-  return []
-}
-
 /**
  * Validate the return type values of custom operations (actions and functions) for primitive or complex values as
  * single values or arrays.
@@ -85,17 +74,18 @@ const validateReturnType = (operation, data) => {
   const returnType = operation.returns.items ? operation.returns.items : operation.returns
 
   if (typeof data === 'undefined') return true
+  if (returnType['@open']) return true
 
   let checkResult
 
   // .type of action/function behaves different to .type of other csn elements
   // Return type contains primitives
-  if (cds.builtin.types[returnType.type]) {
-    const check = CDS_TYPE_CHECKS[returnType.type]
-
-    checkResult = operation.returns.items
-      ? _checkArray(returnType.type, check, data)
-      : _checkSingle(returnType.type, check, data)
+  // eslint-disable-next-line no-proto
+  const _type = typeof returnType._type === 'object' ? returnType.__proto__._type : returnType._type // REVISIT: super dirty hack for compiler's to.edmx polluting the csn definitions with ._type -> please use Symbols instead
+  const check = CDS_TYPE_CHECKS[_type] // IMPORTANT: use ._type
+  if (check) {
+    const array = Array.isArray(data) ? data : [data]
+    checkResult = array.filter(value => !check(value)).map(value => _buildTypeErrorObject(_type, value))
   } else {
     if (typeof data !== 'object') {
       throw new Error(