@sap/cds 5.7.3 → 5.8.1

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

@@ -1,7 +1,10 @@
 const cds = require('../../../../cds')
+
+const { Readable } = require('stream')
+const { big } = require('@sap/cds-foss')
+
 const getTemplate = require('../../../../common/utils/template')
 const templateProcessor = require('../../../../common/utils/templateProcessor')
-const { big } = require('@sap/cds-foss')
 const { omitValue, applyOmitValuesPreference } = require('./omitValues')
 
 const METADATA = {
@@ -23,36 +26,59 @@ const METADATA = {
   $mediaEditLink: '*@odata.mediaEditLink',
   $mediaReadLink: '*@odata.mediaReadLink',
   $mediaContentType: '*@odata.mediaContentType',
+  $mediaContentDispositionFilename: '*@odata.mediaContentDispositionFilename', // > not supported by okra
+  $mediaContentDispositionType: '*@odata.mediaContentDispositionType', // > not supported by okra
   $mediaEtag: '*@odata.mediaEtag'
 }
 
+const _getPropertyName = req => {
+  const segments = req._.odataReq.getUriInfo().getPathSegments()
+  if (segments[segments.length - 1].getKind().match(/\w*\.PROPERTY$/)) {
+    return segments[segments.length - 1].getProperty().getName()
+  }
+  if (
+    segments[segments.length - 1].getKind() === 'VALUE' &&
+    segments[segments.length - 2].getKind() === 'PRIMITIVE.PROPERTY'
+  ) {
+    return segments[segments.length - 2].getProperty().getName()
+  }
+}
+
 /**
  * Convert any result to the result object structure, which is expected of odata-v4.
  *
  * @param {*} result
- * @param {*} [arg]
+ * @param {*} [req]
  * @returns {string | object}
  */
-const toODataResult = (result, arg) => {
-  if (result === undefined || result === null) return ''
-
-  if (arg) {
-    if (typeof arg === 'object') {
-      arg = arg._.odataReq.getUriInfo().getLastSegment().isCollection() ? 'Array' : ''
-    }
-
-    if (!Array.isArray(result) && arg === 'Array') {
-      result = [result]
-    } else if (Array.isArray(result) && arg !== 'Array') {
-      result = result[0]
-    }
+// eslint-disable-next-line complexity
+const toODataResult = (result, req) => {
+  if (result == null) return ''
+
+  let propertyName, isStream
+  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]
   }
 
-  const odataResult = {
-    value: result
+  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 }
+
   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') {
@@ -60,6 +86,18 @@ const toODataResult = (result, arg) => {
         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]
@@ -112,6 +150,13 @@ const addAssociationToRow = (row, foreignKey, foreignKeyElement) => {
   delete row[foreignKey]
 }
 
+const localizeAfterDraftActivate = (row, key, locale) => {
+  if (row.texts && Object.prototype.hasOwnProperty.call(row, key)) {
+    const texts = row.texts.filter(t => t.locale === locale)[0]
+    if (texts && texts[key]) row[key] = texts[key]
+  }
+}
+
 const _processCategory = (category, processArgs, req, options, previousResult) => {
   const { row, key, element } = processArgs
 
@@ -136,6 +181,10 @@ const _processCategory = (category, processArgs, req, options, previousResult) =
       if (key !== 'DraftAdministrativeData_DraftUUID') delete row[key]
       break
 
+    case 'localizeAfterDraftActivate':
+      localizeAfterDraftActivate(row, key, req.locale)
+      break
+
     // no default
   }
 }
@@ -197,16 +246,25 @@ const _pick = options => (element, target, parent) => {
   const categories = []
 
   if (element['@odata.etag']) categories.push('@odata.etag')
+
   if (element.type === 'cds.Decimal') categories.push('@cds.Decimal')
+
   categories.push(..._assocs(element, target))
+
   if (options.omitValuesPreference) categories.push('@odata.omitValues')
+  if (options.event === 'draftActivate' && options.locale && options.locale !== 'en' && element.localized === true) {
+    categories.push('localizeAfterDraftActivate')
+  }
+
   if (categories.length) return { categories }
 }
 
-const _getOptions = headers => {
+const _getOptions = ({ headers, locale, event }) => {
   const options = {
     decimals: null,
-    omitValuesPreference: null
+    omitValuesPreference: null,
+    locale,
+    event
   }
 
   if (!headers) return options
@@ -231,7 +289,8 @@ const _getOptions = headers => {
 const _generateCacheKey = (headers, options) => {
   let key = 'postProcess' // default template cache key for post processing
   if (headers.prefer) key += `:${headers.prefer}`
-  if (options.decimals) key += `:exponentialDecimals=true`
+  if (options.decimals) key += `:ExponentialDecimals=true`
+  if (options.event === 'draftActivate' && options.locale) key += `:locale=${options.locale}`
   return key
 }
 
@@ -241,7 +300,7 @@ const postProcess = (req, res, service, result, previousResult) => {
 
   if (!target || !result || !model || !model.definitions[target.name]) return
 
-  const options = _getOptions(headers)
+  const options = _getOptions(req)
   const cacheKey = _generateCacheKey(headers, options)
   const parent = _getParent(model, target.name)
   const template = getTemplate(cacheKey, service, target, { pick: _pick(options) }, parent)

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

@@ -5,6 +5,9 @@ const { SELECT } = cds.ql
 
 const { targetFromPath, 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 isStreaming = segments => {
   const lastSegment = segments[segments.length - 1]
@@ -15,10 +18,38 @@ const isStreaming = segments => {
   )
 }
 
+const _adaptSubSelectsDraft = select => {
+  if (select.SELECT.from.ref) {
+    const index = select.SELECT.from.ref.length - 1
+    select.SELECT.from.ref[index] = ensureDraftsSuffix(select.SELECT.from.ref[index])
+  }
+
+  if (select.SELECT.where) {
+    for (let i = 0; i < select.SELECT.where.length; i++) {
+      const element = select.SELECT.where[i]
+      if (element.SELECT) {
+        _adaptSubSelectsDraft(element)
+      } else if (element.xpr) {
+        for (const ele of element.xpr.filter(e => e.SELECT)) {
+          _adaptSubSelectsDraft(ele)
+        }
+      }
+    }
+  }
+}
+
+const adaptStreamCQN = (cqn, isDraft = false) => {
+  if (isDraft || !isActiveEntityRequested(cqn.SELECT.where)) {
+    _adaptSubSelectsDraft(cqn)
+  } else {
+    cqn.SELECT.where = removeIsActiveEntityRecursively(cqn.SELECT.where)
+  }
+}
+
 const getStreamProperties = (req, model) => {
   const mediaTypeProperty = Object.values(req.target.elements).find(val => val['@Core.MediaType'])
 
-  let contentType, contentDisposition
+  let contentType, contentDispositionFilename
   const columns = []
   if (typeof mediaTypeProperty['@Core.MediaType'] === 'object') {
     let contentTypeProperty = mediaTypeProperty['@Core.MediaType']['=']
@@ -46,36 +77,42 @@ const getStreamProperties = (req, model) => {
             `@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.`
           )
       } else {
-        columns.push({ ref: [contentDispositionProperty], as: 'contentDisposition' })
+        columns.push({ ref: [contentDispositionProperty], as: 'contentDispositionFilename' })
       }
     } else {
-      contentDisposition = mediaTypeProperty['@Core.ContentDisposition.Filename']
+      contentDispositionFilename = mediaTypeProperty['@Core.ContentDisposition.Filename']
     }
   }
+  const contentDispositionType = mediaTypeProperty['@Core.ContentDisposition.Type']
 
   if (columns.length && cds.db && !req.target._hasPersistenceSkip) {
     // used cloned path
-    const select = SELECT.one.from({ ref: deepCopyArray(req.query.SELECT.from.ref) }).columns(columns)
-
-    if (req.target._isDraftEnabled && isPathToDraft(select.SELECT.from.ref, model))
-      select.SELECT.from.ref[0].id = select.SELECT.from.ref[0].id + '_drafts'
+    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()
 
+    const pathToDraft = isPathToDraft(select.SELECT.from.ref, model)
+    if (req.target._isDraftEnabled && pathToDraft) {
+      select = cqn2cqn4sql(select, model)
+      adaptStreamCQN(select, pathToDraft)
+    }
+
     return cds
       .tx(req)
       .run(select)
       .then(res => ({
         contentType: (res && res.contentType) || contentType,
-        contentDisposition: (res && res.contentDisposition) || contentDisposition
+        contentDispositionFilename: (res && res.contentDispositionFilename) || contentDispositionFilename,
+        contentDispositionType
       }))
   }
 
-  return Promise.resolve({ contentType, contentDisposition })
+  return Promise.resolve({ contentType, contentDispositionFilename, contentDispositionType })
 }
 
 module.exports = {
   isStreaming,
-  getStreamProperties
+  getStreamProperties,
+  adaptStreamCQN
 }

package/libx/_runtime/cds-services/adapter/rest/Rest.js

@@ -12,9 +12,10 @@ const { contentTypeCheck } = require('./utils/header-checks')
 const parse = require('./utils/parse-url')
 const { base64toBuffer } = require('./utils/binary')
 
-const { UNAUTHORIZED, FORBIDDEN, getRequiresAsArray } = require('../../../common/utils/auth')
+const { UNAUTHORIZED, FORBIDDEN, getRequiresAsArray } = require('../../../auth/utils')
 
 const PPP = { POST: 1, PUT: 1, PATCH: 1 }
+const GH = { GET: 1, HEAD: 1 }
 
 let _i18n
 const i18n = (...args) => {
@@ -93,6 +94,21 @@ class Rest {
         throw FORBIDDEN
       }
 
+      // service root
+      if (req.path === '/' && GH[req.method]) {
+        if (req.method === 'HEAD') return res.json({})
+        else
+          return res.json(
+            Object.keys(srv.entities).reduce(
+              (acc, cur) => {
+                acc.entities.push({ name: cur, url: cur })
+                return acc
+              },
+              { entities: [] }
+            )
+          )
+      }
+
       // content-type check, parse url, and base64 to buffer
       try {
         if (PPP[req.method]) contentTypeCheck(req)
@@ -115,6 +131,11 @@ class Rest {
       }
     })
 
+    // HEAD
+    this.router.head('/*', (req, res, next) => {
+      read(req, res, next)
+    })
+
     // GET
     this.router.get('/*', (req, res, next) => {
       // READ or custom operation?

package/libx/_runtime/cds-services/adapter/rest/handlers/read.js

@@ -28,9 +28,7 @@ module.exports = service => {
 
       result = await tx.dispatch(req)
 
-      if (result == null) {
-        throw getError(404, 'NO_MATCHING_RESOURCE')
-      }
+      if (result == null) throw getError(404, 'NO_MATCHING_RESOURCE')
 
       bufferToBase64(result, segments[0])
 
@@ -41,6 +39,13 @@ module.exports = service => {
       await tx.rollback(e).catch(() => {})
     } finally {
       if (err) next(err)
+      else if (restReq.method === 'HEAD')
+        restRes
+          .set({
+            'content-type': 'application/json; charset=utf-8',
+            'content-length': JSON.stringify(result).length
+          })
+          .end()
       else restRes.send(toRestResult(result))
     }
   }

package/libx/_runtime/cds-services/adapter/rest/utils/parse-url.js

@@ -230,6 +230,9 @@ module.exports = {
   POST: (service, req) => {
     return parseCreateOrReadUrl('CREATE', service, req)
   },
+  HEAD: (service, req) => {
+    return parseCreateOrReadUrl('READ', service, req)
+  },
   GET: (service, req) => {
     return parseCreateOrReadUrl('READ', service, req)
   },

package/libx/_runtime/cds-services/services/Service.js

@@ -128,7 +128,7 @@ class ApplicationService extends cds.Service {
       // compat
       restoreLink(req)
       if (req.query.SELECT && req.query.SELECT._4odata) {
-        q.SELECT._4odata = req.query.SELECT._4odata
+        Object.defineProperty(q.SELECT, '_4odata', { value: req.query.SELECT._4odata })
       }
 
       // REVISIT: We need to provide target explicitly because it's cached already within ensure_target

package/libx/_runtime/cds-services/services/utils/columns.js

@@ -17,7 +17,10 @@ const { DRAFT_COLUMNS_UNION } = require('../../../common/constants/draft')
  * @param [options.filterVirtual=false]
  * @returns {Array<object>} - array of columns
  */
-const getColumns = (entity, { onlyNames = false, removeIgnore = false, filterDraft = true, filterVirtual = false }) => {
+const getColumns = (
+  entity,
+  { onlyNames = false, removeIgnore = false, filterDraft = true, filterVirtual = false, keysOnly = false }
+) => {
   const skipDraft = filterDraft && entity._isDraftEnabled
   const columns = []
   const elements = entity.elements
@@ -28,6 +31,7 @@ const getColumns = (entity, { onlyNames = false, removeIgnore = false, filterDra
     if (filterVirtual && element.virtual) continue
     if (removeIgnore && element['@cds.api.ignore']) continue
     if (skipDraft && DRAFT_COLUMNS_UNION.includes(each)) continue
+    if (keysOnly && !element.key) continue
     columns.push(onlyNames ? each : element)
   }
 

package/libx/_runtime/cds-services/services/utils/compareJson.js

@@ -285,30 +285,29 @@ const _mergeArrays = (entity, oldValue, newValue) => {
   return merged
 }
 
-const mergeJsonDeep = (entity, oldValue, newValue) => {
+const mergeJsonDeep = (entity, oldValue, value) => {
+  // REVISIT readAfterWrite -> commit -> postProcessing
+  // Detach result from req.data
+  const newValue = value ? Object.assign({}, value) : oldValue // if newValue === undefined
   if (_isObject(oldValue) && _isObject(newValue)) {
-    Object.keys(newValue).forEach(key => {
-      if (_isObject(newValue[key])) {
-        if (!(key in oldValue)) Object.assign(oldValue, { [key]: newValue[key] })
-        else {
-          const target = entity && entity.elements[key] && entity.elements[key]._target
-          oldValue[key] = mergeJsonDeep(target, oldValue[key], newValue[key])
-        }
-      } else if (Array.isArray(newValue[key])) {
-        if (!(key in oldValue)) Object.assign(oldValue, { [key]: newValue[key] })
-        else {
-          const target = entity && entity.elements[key] && entity.elements[key]._target
+    // append to newValue to keep an order of attributes as might be defined in custom handler
+    Object.keys(oldValue).forEach(key => {
+      if (!(key in newValue)) {
+        Object.assign(newValue, { [key]: oldValue[key] })
+      } else {
+        const target = entity && entity.elements[key] && entity.elements[key]._target
+        if (_isObject(newValue[key])) {
+          newValue[key] = mergeJsonDeep(target, oldValue[key], newValue[key])
+        } else if (Array.isArray(newValue[key])) {
           if (target) {
-            oldValue[key] = _mergeArrays(target, oldValue[key], newValue[key])
+            newValue[key] = _mergeArrays(target, oldValue[key], newValue[key])
           }
           // Can't merge items without target
         }
-      } else {
-        Object.assign(oldValue, { [key]: newValue[key] })
       }
     })
   }
-  return oldValue
+  return newValue
 }
 
 // Signature similar to Object.assign(oldValue, newValue)

package/libx/_runtime/cds-services/services/utils/differ.js

@@ -45,14 +45,8 @@ module.exports = class {
   }
 
   async _addPartialPersistentState(req) {
-    const deepUpdateData = await selectDeepUpdateData(
-      this._srv.model.definitions,
-      req.query,
-      req,
-      true,
-      true,
-      this._srv
-    )
+    // REVISIT: cds.context.model?
+    const deepUpdateData = await selectDeepUpdateData(this._srv, this._srv.model, req, true)
     req._.partialPersistentState = deepUpdateData
   }
 

package/libx/_runtime/common/aspects/Association.js

@@ -1,11 +1,24 @@
 // global.cds is used on purpose here!
 const cds = global.cds
 
+// requesting logger without module on purpose!
+const LOG = cds.log()
+
 const ODATA_CONTAINED = '@odata.contained'
 
 const { isSelfManaged, isBacklink, getAnchor, getBacklink } = require('./utils')
 const { foreignKeyPropagations } = require('../utils/foreignKeyPropagations')
 
+const _logDeprecationForODataContained = () => {
+  if (!cds._deprecationWarningForODataContained) {
+    LOG._warn &&
+      LOG.warn(
+        'Annotation "@odata.contained" is deprecated and will be removed in an upcoming release. Use compositions instead of associations.'
+      )
+    cds._deprecationWarningForODataContained = true
+  }
+}
+
 module.exports = class {
   get _isAssociationStrict() {
     return (
@@ -15,6 +28,7 @@ module.exports = class {
   }
 
   get _isAssociationEffective() {
+    this[ODATA_CONTAINED] && _logDeprecationForODataContained()
     return (
       this.own('__isAssociationEffective') ||
       this.set(
@@ -25,6 +39,7 @@ module.exports = class {
   }
 
   get _isCompositionEffective() {
+    this[ODATA_CONTAINED] && _logDeprecationForODataContained()
     return (
       this.own('__isCompositionEffective') ||
       this.set(
@@ -36,6 +51,7 @@ module.exports = class {
   }
 
   get _isContained() {
+    this[ODATA_CONTAINED] && _logDeprecationForODataContained()
     return (
       this.own('__isContained') ||
       this.set(