@sap/cds 5.7.2 → 5.8.0

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

@@ -18,7 +18,7 @@ const isStreaming = segments => {
 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,12 +46,13 @@ 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
@@ -68,11 +69,12 @@ const getStreamProperties = (req, model) => {
       .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 = {

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(

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

@@ -120,26 +120,26 @@ const _subWhere = (result, element) => {
   if (links && links.length > 0) {
     where = []
     for (const row of result) {
-      if (where.length > 0) {
-        where.push('or')
-      }
       const whereObj = links.reduce((res, currentLink) => {
-        if (Object.prototype.hasOwnProperty.call(row, currentLink.targetKey))
+        if (Object.prototype.hasOwnProperty.call(row, currentLink.targetKey) && row[currentLink.targetKey] !== null)
           res[currentLink.entityKey] = row[currentLink.targetKey]
         return res
       }, {})
       const whereCQN = ctUtils.whereKey(whereObj)
-      if (whereCQN.length) where.push('(', ...whereCQN, ')')
+      if (whereCQN.length) {
+        if (where.length > 0) where.push('or')
+        where.push('(', ...whereCQN, ')')
+      }
     }
   }
   return where
 }
 
-const _mergeResults = (result, selectData, root, definitions, compositionTree, entityName) => {
+const _mergeResults = (result, selectData, root, model, compositionTree, entityName) => {
   if (root) {
     return [...selectData, ...result]
   } else {
-    const parent = definitions[compositionTree.target] || definitions[entityName]
+    const parent = model.definitions[compositionTree.target] || model.definitions[entityName]
     const assoc = (parent && parent.elements[compositionTree.name]) || {}
     return selectData.map(selectEntry => {
       if (assoc.is2one) {
@@ -148,8 +148,9 @@ const _mergeResults = (result, selectData, root, definitions, compositionTree, e
         selectEntry[compositionTree.name] = selectEntry[compositionTree.name] || []
       }
       const newData = _findWhere(result, _parentKey(compositionTree, selectEntry))
-      if (assoc.is2one && newData[0]) {
-        selectEntry[compositionTree.name] = Object.assign(selectEntry[compositionTree.name], newData[0])
+      if (assoc.is2one) {
+        if (newData[0]) selectEntry[compositionTree.name] = Object.assign(selectEntry[compositionTree.name], newData[0])
+        else selectEntry[compositionTree.name] = null
       } else if (assoc.is2many) {
         selectEntry[compositionTree.name].push(...newData)
       }
@@ -158,14 +159,14 @@ const _mergeResults = (result, selectData, root, definitions, compositionTree, e
   }
 }
 
-const _columns = (entity, data, compositionTree, selectAll) => {
+const _columns = (entity, data, compositionTree, selectAllColumns) => {
   const backLinkKeys = _getLinksOfCompTree(compositionTree)
   const columns = []
   for (const elementName in entity.elements) {
     const element = entity.elements[elementName]
     if (element.virtual || element.isAssociation) continue
     if (
-      selectAll ||
+      selectAllColumns ||
       element.key ||
       backLinkKeys.includes(element.name) ||
       (Array.isArray(data) && data.find(entry => element.name in entry))
@@ -177,45 +178,42 @@ const _columns = (entity, data, compositionTree, selectAll) => {
 }
 
 const _select = ({
-  definitions,
+  model,
   entityName,
   draft,
   alias,
   compositionTree,
   data,
-  root,
-  includeAllRootColumns,
-  includeAllColumns,
+  selectAllColumns,
   where,
   parentKeys,
   orderBy,
   singleton
 }) => {
-  const entity = definitions && definitions[entityName]
+  const entity = model.definitions[entityName]
   const from = ctUtils.addDraftSuffix(draft, entity.name)
   const selectCQN = SELECT.from(from)
   if (alias) selectCQN.SELECT.from.as = alias
-  const selectAll = includeAllColumns || (includeAllRootColumns && root)
-  selectCQN.SELECT.columns = _columns(entity, data, compositionTree, selectAll)
+  selectCQN.SELECT.columns = _columns(entity, data, compositionTree, selectAllColumns)
   if (where) selectCQN.SELECT.where = where
   else if (parentKeys) selectCQN.SELECT.where = _whereKeys(parentKeys)
   if (orderBy) selectCQN.SELECT.orderBy = orderBy
   if (singleton) selectCQN.SELECT.limit = { rows: { val: 1 } }
   // REVISIT: remove once SELECT builder does flattening!
-  return cqn2cqn4sql(selectCQN, { definitions })
+  return cqn2cqn4sql(selectCQN, model)
 }
 
 const _selectDeepUpdateData = async args => {
-  const { definitions, compositionTree, entityName, data, includeAllColumns, root, selectData, tx } = args
+  const { model, compositionTree, entityName, data, root, selectData, tx, selectAllColumns } = args
   const selectCQN = _select(args)
   const result = await tx.run(selectCQN)
   if (!result.length) return Promise.resolve(result)
 
-  const keys = _keys(definitions[entityName], result)
+  const keys = _keys(model.definitions[entityName], result)
   await Promise.all(
     compositionTree.compositionElements.map(element => {
       if (element.skipPersistence) return Promise.resolve()
-      if (data !== undefined && !data.find(entry => element.name in entry) && !(includeAllColumns && result.length))
+      if (data !== undefined && !data.find(entry => element.name in entry) && !(selectAllColumns && result.length))
         return Promise.resolve()
       const subs = {
         compositionTree: element,
@@ -235,23 +233,17 @@ const _selectDeepUpdateData = async args => {
     })
   )
 
-  return _mergeResults(result, selectData || [], root, definitions, compositionTree, entityName)
+  return _mergeResults(result, selectData || [], root, model, compositionTree, entityName)
 }
 
 /*
  * exports
  */
 
-const selectDeepUpdateData = (
-  definitions,
-  cqn,
-  req,
-  includeAllRootColumns = false,
-  includeAllColumns = false,
-  service
-) => {
+const selectDeepUpdateData = (service, model, req, selectAllColumns = false) => {
+  const query = req.query
   // REVISIT this should be done somewhere before, so it is not done twice for deep updates
-  const sqlQuery = cqn2cqn4sql(cqn, { definitions })
+  const sqlQuery = cqn2cqn4sql(query, model)
 
   if (req && _isSameEntity(sqlQuery, req)) {
     return Promise.resolve(req._.partialPersistentState)
@@ -263,9 +255,9 @@ const selectDeepUpdateData = (
   const entityName = ensureNoDraftsSuffix(from)
   const draft = entityName !== from
   const orderBy = req && req.target && req.target.query && req.target.query.SELECT && req.target.query.SELECT.orderBy
-  const data = Object.assign({}, sqlQuery.UPDATE.data || {}, cqn.UPDATE.with || {})
+  const data = Object.assign({}, sqlQuery.UPDATE.data || {}, query.UPDATE.with || {})
   const compositionTree = getCompositionTree({
-    definitions,
+    definitions: model.definitions,
     rootEntityName: entityName, // REVISIT: drafts are resolved too eagerly
     checkRoot: false,
     resolveViews: !draft,
@@ -274,17 +266,16 @@ const selectDeepUpdateData = (
 
   return _selectDeepUpdateData({
     tx: cds.tx(req),
-    definitions,
+    model,
     compositionTree,
     entityName,
     data: [data],
     where,
     orderBy,
     draft,
-    includeAllRootColumns,
     singleton: req && req.target && req.target._isSingleton,
     alias,
-    includeAllColumns: cqn._selectAll || includeAllColumns,
+    selectAllColumns,
     root: true,
     service
   })