@sap/cds 5.6.1 → 5.6.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.6.2 - 2021-11-08
+
+### Fixed
+
+- Handle arrayed elements using templating mechanism
+- OData requests to `$count` endpoint of ETag enabled entity
+- `cds.test` does no longer crash if executed in `cds repl` on a remote service call
+- Crash on draft activate after draft edit for not existing composition of one
+- Ensure request correlation (with default server)
+- `<entity>.texts` points to real text entity
+- Draft union with expand to to-one and to-many
+- No columns in draft lock statement (i.e., use `SELECT 1`)
+
 ## Version 5.6.1 - 2021-11-02
 
 ### Fixed

package/lib/core/reflect.js

@@ -26,6 +26,7 @@ class LinkedCSN extends any {
         /* else: */         any.prototype
       )
       if (p.key && !d.key && d.kind === 'element') Object.defineProperty (d,'key',{value:undefined})  //> don't propagate .key
+      if (d.elements && d.elements.localized) Object.defineProperty (d,'texts',{value: defs [d.elements.localized.target] })
       try { return Object.setPrototypeOf(d,p) }            //> link d to resolved proto
       catch(e) {                                          //> cyclic proto error
         let msg = d.name; for (; p && p.name; p = p.__proto__) msg += ' > '+p.name

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-server/invocation/SetResponseHeadersCommand.js

@@ -75,6 +75,7 @@ class SetResponseHeadersCommand extends Command {
           ? lastSegment.getTarget() && lastSegment.getTarget().isConcurrent()
           : this._request.getConcurrentResource()) &&
         representationKind !== RepresentationKinds.ENTITY_COLLECTION &&
+        representationKind !== RepresentationKinds.COUNT &&
         representationKind !== RepresentationKinds.REFERENCE &&
         representationKind !== RepresentationKinds.REFERENCE_COLLECTION
       ) {

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

@@ -249,23 +249,26 @@ const postProcess = (req, res, service, result, previousResult) => {
   if (template.elements.size === 0) return
 
   // 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
-  const processFn = _processorFn(req, previousResult, options)
-
-  for (const row of rows) {
-    const args = {
-      processFn,
-      row,
-      template,
-      pathOptions: {
-        includeKeyValues: false
+  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(req, previousResult, options)
+
+    for (const row of rows) {
+      const args = {
+        processFn,
+        row,
+        template,
+        pathOptions: {
+          includeKeyValues: false
+        }
       }
-    }
 
-    templateProcessor(args)
+      templateProcessor(args)
+    }
   }
 
   applyOmitValuesPreference(res, options.omitValuesPreference)

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

@@ -205,11 +205,16 @@ function _addSubDeepUpdateCQNRecursion({ definitions, compositionTree, entity, d
     const selectSubData = []
     for (const entry of data) {
       if (element.name in entry) {
-        _addToData(subData, entity, element, entry)
         const selectEntry = selectDataByKey.get(_serializedKey(entity, entry))
+
         if (selectEntry && element.name in selectEntry) {
+          if (selectEntry[element.name] === null && Object.keys(entry[element.name]).length === 0) {
+            continue
+          }
           _addToData(selectSubData, entity, element, selectEntry)
         }
+
+        _addToData(subData, entity, element, entry)
       }
     }
     _addSubDeepUpdateCQN({

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

@@ -11,15 +11,27 @@ const { isAsteriskColumn } = require('../../common/utils/rewriteAsterisks')
 const GET_KEY_VALUE = Symbol.for('sap.cds.getKeyValue')
 const TO_MANY = Symbol.for('sap.cds.toMany')
 const TO_ACTIVE = Symbol.for('sap.cds.toActive')
-
 const SKIP_MAPPING = Symbol.for('sap.cds.skipMapping')
 const IDENTIFIER = Symbol.for('sap.cds.identifier')
 const IS_ACTIVE = Symbol.for('sap.cds.isActive')
 const IS_UNION_DRAFT = Symbol.for('sap.cds.isUnionDraft')
+
 const { DRAFT_COLUMNS } = require('../../common/constants/draft')
 
 const { getCQNUnionFrom } = require('../../common/utils/union')
 
+function getCqnCopy(readToOneCQN) {
+  const readToOneCQNCopy = JSON.parse(JSON.stringify(readToOneCQN))
+  if (readToOneCQN[GET_KEY_VALUE] !== undefined) readToOneCQNCopy[GET_KEY_VALUE] = readToOneCQN[GET_KEY_VALUE]
+  if (readToOneCQN[TO_MANY] !== undefined) readToOneCQNCopy[TO_MANY] = readToOneCQN[TO_MANY]
+  if (readToOneCQN[TO_ACTIVE] !== undefined) readToOneCQNCopy[TO_ACTIVE] = readToOneCQN[TO_ACTIVE]
+  if (readToOneCQN[SKIP_MAPPING] !== undefined) readToOneCQNCopy[SKIP_MAPPING] = readToOneCQN[SKIP_MAPPING]
+  if (readToOneCQN[IDENTIFIER] !== undefined) readToOneCQNCopy[IDENTIFIER] = readToOneCQN[IDENTIFIER]
+  if (readToOneCQN[IS_ACTIVE] !== undefined) readToOneCQNCopy[IS_ACTIVE] = readToOneCQN[IS_ACTIVE]
+  if (readToOneCQN[IS_UNION_DRAFT] !== undefined) readToOneCQNCopy[IS_UNION_DRAFT] = readToOneCQN[IS_UNION_DRAFT]
+  return readToOneCQNCopy
+}
+
 class JoinCQNFromExpanded {
   constructor(cqn, csn, locale) {
     this._SELECT = Object.assign({}, cqn.SELECT)
@@ -91,16 +103,16 @@ class JoinCQNFromExpanded {
    * @private
    */
   _createJoinCQNFromExpanded(SELECT, toManyTree, defaultLanguage) {
-    const unionArgs = SELECT.from.args
-    const isJoinOfTwoUnions = unionArgs && unionArgs.every(a => a.SELECT)
+    const joinArgs = SELECT.from.args
+    const isJoinOfTwoSelects = joinArgs && joinArgs.every(a => a.SELECT)
 
     const unionTableRef = this._getUnionTable(SELECT)
     const unionTable = unionTableRef && unionTableRef.table
     const tableAlias = this._getTableAlias(SELECT, toManyTree, unionTable)
 
-    const readToOneCQN = this._getReadToOneCQN(SELECT, isJoinOfTwoUnions ? 'filterExpand' : tableAlias)
+    const readToOneCQN = this._getReadToOneCQN(SELECT, isJoinOfTwoSelects ? 'filterExpand' : tableAlias)
 
-    if (isJoinOfTwoUnions) {
+    if (isJoinOfTwoSelects) {
       // mappings
       const mappings = this._getMappingObject(toManyTree)
       const prefix = `${tableAlias}_`
@@ -110,7 +122,7 @@ class JoinCQNFromExpanded {
           mappings[c.as.replace(prefix, '')] = c.as
         })
       // expand to one
-      const entity = this._csn.definitions[unionArgs[0].SELECT.from.SET.args[1].SELECT.from.ref[0]]
+      const entity = this._csn.definitions[joinArgs[0].SELECT.from.SET.args[1].SELECT.from.ref[0]]
       const givenColumns = readToOneCQN.columns
       readToOneCQN.columns = []
       this._expandedToFlat({ entity, givenColumns, readToOneCQN, tableAlias, toManyTree, defaultLanguage })
@@ -128,6 +140,9 @@ class JoinCQNFromExpanded {
       this._expandedToFlat({ entity, givenColumns, readToOneCQN, tableAlias, toManyTree, defaultLanguage })
     }
 
+    // brute force hack
+    readToOneCQN.columns = readToOneCQN.columns.filter(c => c.as !== 'filterExpand_IsActiveEntity')
+
     // Add at start, so that the deepest level is post processed first
     this.queries.push({
       SELECT: readToOneCQN,
@@ -480,6 +495,8 @@ class JoinCQNFromExpanded {
     const toManyColumns = []
     const mappings = this._getMappingObject(toManyTree)
 
+    const readToOneCQNCopy = getCqnCopy(readToOneCQN)
+
     for (const column of givenColumns) {
       let navigation
       if (column.expand) {
@@ -523,7 +540,16 @@ class JoinCQNFromExpanded {
     }
 
     // only as second step handle expand to many, or else keys might still be unknown
-    this._toMany({ entity, readToOneCQN, tableAlias, toManyColumns, toManyTree, mappings, defaultLanguage })
+    this._toMany({
+      entity,
+      readToOneCQN,
+      tableAlias,
+      toManyColumns,
+      toManyTree,
+      mappings,
+      defaultLanguage,
+      readToOneCQNCopy
+    })
   }
 
   adjustOrderBy(orderBy, mappings, column, tableAlias) {
@@ -957,7 +983,16 @@ class JoinCQNFromExpanded {
     return DRAFT_COLUMNS.includes(ref[0])
   }
 
-  _toMany({ entity, readToOneCQN, tableAlias, toManyColumns, toManyTree, mappings, defaultLanguage }) {
+  _toMany({
+    entity,
+    readToOneCQN,
+    tableAlias,
+    toManyColumns,
+    toManyTree,
+    mappings,
+    defaultLanguage,
+    readToOneCQNCopy
+  }) {
     if (toManyColumns.length === 0) {
       return
     }
@@ -968,7 +1003,7 @@ class JoinCQNFromExpanded {
       const select = this._buildExpandedCQN({
         column,
         entity,
-        readToOneCQN,
+        readToOneCQN: readToOneCQNCopy,
         toManyTree,
         mappings,
         parentAlias,

package/libx/_runtime/db/generic/arrayed.js

@@ -1,28 +1,13 @@
-// REVISIT: use templating mechanism (resp. results.metadata, once available) to make more efficient
-
 const { getEntityFromCQN } = require('../../common/utils/entityFromCqn')
+const getTemplate = require('../../common/utils/template')
+const templateProcessor = require('../../common/utils/templateProcessor')
 
-const _toArray = (result, elements) => {
-  // REVISIT: This is a very expensive loop in loop...
-  // and 100% overhead the results don't contain arrayed elements,
-  // and 100% of all currently existing stakeholder projects don't.
-  // but that's not that easy to fix -> see comment about results.metadata below
-  for (const row of result) {
-    for (const column in row) {
-      if (elements[column] === undefined || row[column] === undefined) continue
+const _pick = element => {
+  if (element.kind === 'element' && element.items) return 'arrayed'
+}
 
-      // .items marks arrayed element
-      if (elements[column].items) {
-        row[column] = JSON.parse(row[column])
-      } else if (elements[column].is2many) {
-        _toArray(row[column], elements[column]._target.elements)
-      } else if (elements[column].is2one) {
-        _toArray([row[column]], elements[column]._target.elements)
-      } else if (elements[column].elements) {
-        _toArray([row[column]], elements[column].elements)
-      }
-    }
-  }
+const _processFn = ({ row, key, plain }) => {
+  if (plain === 'arrayed' && row && row[key]) row[key] = JSON.parse(row[key])
 }
 
 /**
@@ -35,12 +20,12 @@ const _toArray = (result, elements) => {
 module.exports = function (result, req) {
   if (!this.model) return
 
-  if (!Array.isArray(result)) result = [result]
-
-  // REVISIT: We need results.metadata to make that more efficient
-  // results.metadata ~= cds.infer(req.query).metadata
-  // REVISIT: No entity for sets/unions outside of common draft scenarios
   const entity = getEntityFromCQN(req, this)
   if (!entity) return
-  if (entity) _toArray(result, entity.elements)
+
+  const template = getTemplate('db-arrayed', this, entity, { pick: _pick })
+  if (template.elements.size === 0) return
+
+  for (const row of Array.isArray(result) ? result : [result])
+    templateProcessor({ processFn: _processFn, row, template })
 }

package/libx/_runtime/fiori/generic/edit.js

@@ -106,7 +106,7 @@ const _handler = async function (req) {
   // Only allows one active entity to be processed at a time, locking out other
   // users who need to edit the same record simultaneously.
   // .forUpdate(): lock the record, a wait of 0 is equivalent to no wait
-  const lockRecordCQN = SELECT.from(lockTargetEntity).where(lockWhere).forUpdate({ wait: 0 })
+  const lockRecordCQN = SELECT.from(lockTargetEntity, [1]).where(lockWhere).forUpdate({ wait: 0 })
 
   const columnNames = getColumns(req.target, { onlyNames: true, filterVirtual: true })
   const rootCQN = SELECT.from(req.target, columnNames).where(rootWhere)

package/libx/_runtime/remote/Service.js

@@ -5,8 +5,12 @@ const LOG = cds.log('remote')
 
 // disable sdk logger if not in debug mode
 if (!LOG._debug) {
-  const sdkUtils = require('@sap-cloud-sdk/util')
-  sdkUtils.setGlobalLogLevel('error')
+  try {
+    const sdkUtils = require('@sap-cloud-sdk/util')
+    sdkUtils.setGlobalLogLevel('error')
+  } catch (err) {
+    /* might fail in cds repl due to winston's exception handler, see cap/issues#10134 */
+  }
 }
 
 const { resolveView, getTransition, restoreLink, findQueryTarget } = require('../common/utils/resolveView')

package/package.json

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

package/server.js

@@ -138,13 +138,17 @@ function cors (req, res, next) {
   next()
 }
 
-function correlate (req,_,next) {
-  if (!cds.context) cds.context = {}
-  const id = cds.context.id
-    || req.headers['x-correlation-id'] || req.headers['x-correlationid']
+function correlate (req, res, next) {
+  // derive correlation id from req
+  const id = req.headers['x-correlation-id'] || req.headers['x-correlationid']
     || req.headers['x-request-id'] || req.headers['x-vcap-request-id']
     || cds.utils.uuid()
-  cds.context.id = req.headers['x-correlation-id'] = id
+  // new intermediate cds.context, if necessary
+  if (!cds.context) cds.context = { id }
+  // guarantee x-correlation-id going forward and set on res
+  req.headers['x-correlation-id'] = id
+  res.set('x-correlation-id', id)
+  // guaranteed access to cds.context._.req -> REVISIT
   if (!cds.context._) cds.context._ = {}
   if (!cds.context._.req) cds.context._.req = req
   next()