@sap/cds 5.8.0 → 5.8.1

package/CHANGELOG.md

@@ -4,6 +4,21 @@
 - The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - This project adheres to [Semantic Versioning](http://semver.org/).
 
+## Version 5.8.1 - 2022-02-11
+
+### Fixed
+
+- Use single transaction for update mutations in GraphQL adapter
+- ODATA to CQN parser returned not selected keys in `@odata.context`
+- Draft: `$expand` with special draft columns in `$orderBy` for active entities
+- Reading distinct values of draft enabled entity
+- Handling of LOB data on HANA
+- Fix streaming draft by navigation
+- Empty to-many arrays are not removed from req.data for inserts
+- `$filter` query option in structured mode (OData flavors `w4` and `x4`)
+  + Using JSON-stringified objects no longer occasionally crashes an application
+  + Filtering on a structured element with `ne null` condition also selects data having some `null` properties within
+
 ## Version 5.8.0 - 2022-01-27
 
 ### Added

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-server/serializer/ContextURLFactory.js

@@ -281,7 +281,7 @@ class ContextURLFactory {
       // If there is one '*' selected, the context URL contains only '*'.
       if (isAll) {
         value = ['*']
-      } else if (type && type.getKind() === EdmTypeKind.ENTITY && isKeyRequired) {
+      } else if (type && type.getKind() === EdmTypeKind.ENTITY && isKeyRequired && !cds.env.features.odata_new_parser) {
         for (const keyName of type.getKeyPropertyRefs().keys()) {
           if (!value.includes(keyName)) value.push(keyName)
         }

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-server/serializer/ErrorJsonSerializer.js

@@ -34,6 +34,8 @@ class ErrorJsonSerializer extends ErrorSerializer {
       })
     }
 
+    if (this._error.innererror) result.innererror = this._error.innererror
+
     addAnnotations(this._error, result)
 
     return JSON.stringify({ error: result })

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,6 +18,34 @@ 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'])
 
@@ -56,14 +87,17 @@ const getStreamProperties = (req, model) => {
 
   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)
@@ -79,5 +113,6 @@ const getStreamProperties = (req, model) => {
 
 module.exports = {
   isStreaming,
-  getStreamProperties
+  getStreamProperties,
+  adaptStreamCQN
 }

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

@@ -1,5 +1,5 @@
 const { getCompositionTree, getCompositionRoot } = require('./tree')
-const { hasDeepInsert, getDeepInsertCQNs, cleanEmptyCompositionsOfMany } = require('./insert')
+const { hasDeepInsert, getDeepInsertCQNs } = require('./insert')
 const { hasDeepUpdate, getDeepUpdateCQNs } = require('./update')
 const { hasDeepDelete, getDeepDeleteCQNs, getSetNullParentForeignKeyCQNs } = require('./delete')
 const { selectDeepUpdateData } = require('./data')
@@ -11,7 +11,6 @@ module.exports = {
   // insert
   hasDeepInsert,
   getDeepInsertCQNs,
-  cleanEmptyCompositionsOfMany,
   // update
   hasDeepUpdate,
   getDeepUpdateCQNs,

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

@@ -10,9 +10,9 @@ const { deepCopyArray } = require('../utils/copy')
  * own utils
  */
 
-function _hasCompOrAssocIgnoreEmptyToMany(entity, k, data) {
+function _hasCompOrAssoc(entity, k) {
   // TODO once REST also uses same logic as odata structured check if we can omit 'entity.elements[k] &&'
-  return entity.elements[k] && (entity.elements[k].is2one || (entity.elements[k].is2many && data[k] && data[k].length))
+  return entity.elements[k] && (entity.elements[k].is2one || entity.elements[k].is2many)
 }
 
 const _addSubDeepInsertCQN = (model, compositionTree, data, cqns, draft) => {
@@ -60,25 +60,13 @@ const _entityFromINSERT = (model, INSERT) => {
   }
 }
 
-const cleanEmptyCompositionsOfMany = (model, cqn) => {
-  const entity = _entityFromINSERT(model, cqn.INSERT)
-  if (!entity) return
-  for (const entry of cqn.INSERT.entries || []) {
-    for (const elName in entry || {}) {
-      const el = entity.elements[elName]
-      if (!el) continue
-      if (el.is2many && !entry[elName].length) delete entry[elName]
-    }
-  }
-}
-
 const hasDeepInsert = (model, cqn) => {
   if (cqn.INSERT.entries) {
     const entity = _entityFromINSERT(model, cqn.INSERT)
     if (entity) {
       return !!cqn.INSERT.entries.find(entry => {
         return !!Object.keys(entry || {}).find(k => {
-          return _hasCompOrAssocIgnoreEmptyToMany(entity, k, entry)
+          return _hasCompOrAssoc(entity, k)
         })
       })
     }
@@ -111,7 +99,6 @@ const getDeepInsertCQNs = (model, cqn) => {
 }
 
 module.exports = {
-  cleanEmptyCompositionsOfMany,
   hasDeepInsert,
   getDeepInsertCQNs
 }

package/libx/_runtime/common/error/frontend.js

@@ -30,9 +30,8 @@ const _getFiltered = err => {
   Object.keys(err)
     .concat(['message'])
     .forEach(k => {
-      if (k === 'innererror' && process.env.NODE_ENV === 'production') {
-        return
-      }
+      // REVISIT: do not remove innererror with cds^6
+      if (k === 'innererror' && process.env.NODE_ENV === 'production' && !err[SKIP_SANITIZATION]) return
       if (ALLOWED_PROPERTIES.includes(k) || k.startsWith('@')) {
         error[k] = err[k]
       } else if (k === 'numericSeverity') {

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

@@ -50,7 +50,7 @@ const _getDataSubjectUp = (role, model, entity, prev, next, result) => {
 }
 
 const _getDataSubjectDown = (role, entity, prev, next) => {
-  const associations = Object.values(entity.associations).filter(e => !e._isBacklink)
+  const associations = Object.values(entity.associations || {}).filter(e => !e._isBacklink)
   for (const element of associations) {
     const me = { entity, relative: entity, element }
     if (_ifDataSubject(element._target, role)) {

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

@@ -99,6 +99,7 @@ const _getVal = (data, name) => {
 
 const _filterForStructProperty = (structElement, structData, op, prefix = '', nav = []) => {
   const filterArray = []
+  const andOr = op === '!=' ? 'or' : 'and'
 
   for (const elementName in structElement.elements) {
     const element = structElement.elements[elementName]
@@ -123,8 +124,8 @@ const _filterForStructProperty = (structElement, structData, op, prefix = '', na
           for (const key in assoc._target.keys) {
             if (element.name === `${assocName}_${key}`) {
               const ref = [`${prefix}_${assocName}_${key}`]
-              const val = _getVal(structData[assocName], key)
-              filterArray.push({ ref }, op, { val }, 'and')
+              const val = _getVal(structData && structData[assocName], key)
+              filterArray.push({ ref }, op, { val }, andOr)
             }
           }
         }
@@ -134,7 +135,7 @@ const _filterForStructProperty = (structElement, structData, op, prefix = '', na
         { ref: [...nav, `${prefix}_${element.name}`] },
         op,
         { val: _getVal(structData, element.name) },
-        'and'
+        andOr
       )
     }
   }
@@ -182,7 +183,12 @@ const _transformStructToFlatWhereHaving = ([first, op, second], resArray, struct
   } else {
     // transform complex structured to multiple single structured
     const { nestedElement, prefix } = _nestedStructElement(structProperties, structElement)
-    resArray.push(..._filterForStructProperty(nestedElement, structData, op, prefix, nav))
+    const filterForStructProperty = _filterForStructProperty(nestedElement, structData, op, prefix, nav)
+    if (filterForStructProperty.length) {
+      filterForStructProperty.pop() // last and/or
+      if (op === '!=') resArray.push('(', ...filterForStructProperty, ')')
+      else resArray.push(...filterForStructProperty)
+    }
   }
 
   if (resArray[resArray.length - 1] === 'and') {

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

@@ -520,6 +520,17 @@ class JoinCQNFromExpanded {
 
         // REVISIT required for other cqn properties as well?
         this.adjustOrderBy(readToOneCQN.orderBy, mappings, column, tableAlias)
+
+        // In case active parent entity has orderBy with draft specific columns we need to add them to parent CQN
+        if (
+          readToOneCQN[IS_ACTIVE] &&
+          readToOneCQN.orderBy &&
+          column.as &&
+          (column.as === 'IsActiveEntity' || column.as === 'HasActiveEntity' || column.as === 'HasDraftEntity')
+        ) {
+          readToOneCQNCopy.orderBy = readToOneCQN.orderBy
+          this._addColumnsInCaseOrderByHasDraft(readToOneCQNCopy, readToOneCQN.columns[readToOneCQN.columns.length - 1])
+        }
       }
     }
 
@@ -551,6 +562,14 @@ class JoinCQNFromExpanded {
     }
   }
 
+  _addColumnsInCaseOrderByHasDraft(readToOneCQNCopy, column) {
+    readToOneCQNCopy.orderBy.forEach(order => {
+      if (order.as === column.as) {
+        readToOneCQNCopy.columns.push(column)
+      }
+    })
+  }
+
   /**
    * Follow the tree to get to the relevant config object.
    *
@@ -1326,6 +1345,17 @@ class JoinCQNFromExpanded {
       }
     }
 
+    if (readToOneCQN[IS_ACTIVE] && readToOneCQN.columns.length > 0) {
+      readToOneCQN.columns.forEach(column => {
+        if (
+          column.as === `${parentAlias}_IsActiveEntity` ||
+          column.as === `${parentAlias}_HasActiveEntity` ||
+          column.as === `${parentAlias}_HasDraftEntity`
+        )
+          columns.push(column)
+      })
+    }
+
     const subSelect = Object.assign({}, readToOneCQN, { columns })
 
     const SELECT = { from: { SELECT: subSelect }, columns: outerColumns, distinct: true }

package/libx/_runtime/db/query/insert.js

@@ -1,4 +1,4 @@
-const { hasDeepInsert, getDeepInsertCQNs, cleanEmptyCompositionsOfMany } = require('../../common/composition')
+const { hasDeepInsert, getDeepInsertCQNs } = require('../../common/composition')
 const { getFlatArray, processCQNs } = require('../utils/deep')
 const { timestampToISO } = require('../data-conversion/timestamp')
 
@@ -15,7 +15,6 @@ const insert = executeInsertCQN => async (model, dbc, query, req) => {
     return getFlatArray(results)
   }
 
-  cleanEmptyCompositionsOfMany(model, query)
   return executeInsertCQN(model, dbc, query, user, locale, isoTs)
 }
 

package/libx/_runtime/db/sql-builder/SelectBuilder.js

@@ -96,7 +96,7 @@ class SelectBuilder extends BaseBuilder {
     }
 
     if (this._obj.SELECT.orderBy && this._obj.SELECT.orderBy.length) {
-      this._orderBy()
+      this._orderBy(noQuoting)
     }
 
     if (this._obj.SELECT.limit || this._obj.SELECT.one) {
@@ -373,7 +373,11 @@ class SelectBuilder extends BaseBuilder {
     this._outputObj.values.push(...values)
   }
 
-  _orderBy() {
+  _getOrderByElement(noQuoting, name, element) {
+    return (noQuoting ? name : this._quote(name)) + ' ' + (element.sort || 'asc').toUpperCase()
+  }
+
+  _orderBy(noQuoting) {
     const sqls = []
     this._outputObj.sql.push('ORDER BY')
     for (const element of this._obj.SELECT.orderBy) {
@@ -385,7 +389,7 @@ class SelectBuilder extends BaseBuilder {
         if (!columns.find(c => JSON.stringify(c.ref) === serialized)) {
           const toMatch = element.as || (element.ref && element.ref.length === 1 && element.ref[0])
           if (toMatch && columns.find(c => c.as === toMatch)) {
-            sqls.push(this._quote(toMatch) + ' ' + (element.sort || 'asc').toUpperCase())
+            sqls.push(this._getOrderByElement(noQuoting, toMatch, element))
             continue
           }
         }

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

@@ -3,10 +3,8 @@ const { SELECT } = cds.ql
 
 const { cqn2cqn4sql, convertWhereExists } = require('../../common/utils/cqn2cqn4sql')
 const { getElementDeep } = require('../../common/utils/csn')
-
 const { DRAFT_COLUMNS, DRAFT_COLUMNS_MAP, SCENARIO } = require('../../common/constants/draft')
 const {
-  adaptStreamCQN,
   addColumnAlias,
   draftIsLocked,
   ensureDraftsSuffix,
@@ -18,8 +16,8 @@ const {
   filterKeys
 } = require('../utils/handler')
 const { deleteCondition, readAndDeleteKeywords, removeIsActiveEntityRecursively } = require('../utils/where')
-
 const { getColumns } = require('../../cds-services/services/utils/columns')
+const { adaptStreamCQN } = require('../../cds-services/adapter/odata-v4/utils/stream')
 
 const _findRootSubSelectFor = query => {
   if (query.SELECT.where) {

package/libx/_runtime/fiori/utils/handler.js

@@ -1,6 +1,5 @@
 const cds = require('../../cds')
 const { UPDATE, SELECT } = cds.ql
-const { removeIsActiveEntityRecursively, isActiveEntityRequested } = require('./where')
 const { getColumns } = require('../../cds-services/services/utils/columns')
 const { ensureNoDraftsSuffix, ensureDraftsSuffix, ensureUnlocalized } = require('../../common/utils/draft')
 const getTemplate = require('../../common/utils/template')
@@ -126,7 +125,7 @@ const getEnrichedCQN = (cqn, select, draftWhere, scenarioAlias, addLimitOrder =
   }
 
   if (select.distinct) {
-    cqn.distinct()
+    cqn.SELECT.distinct = true
   }
 
   const alias = (select.from && select.from.as) || scenarioAlias
@@ -249,14 +248,6 @@ const replaceRefWithDraft = ref => {
   ref[0] = ensureDraftsSuffix(ref[0])
 }
 
-const adaptStreamCQN = cqn => {
-  if (isActiveEntityRequested(cqn.SELECT.where)) {
-    cqn.SELECT.where = removeIsActiveEntityRecursively(cqn.SELECT.where)
-  } else {
-    replaceRefWithDraft(cqn.SELECT.from.ref)
-  }
-}
-
 const draftIsLocked = lastChangedAt => {
   // default timeout timer is 15 minutes
   const DRAFT_CANCEL_TIMEOUT_IN_MS = ((cds.env.drafts && cds.env.drafts.cancellationTimeout) || 15) * 60 * 1000
@@ -289,7 +280,6 @@ module.exports = {
   hasDraft,
   proxifyToNoDraftsName,
   addColumnAlias,
-  adaptStreamCQN,
   replaceRefWithDraft,
   getKeyProperty,
   filterKeys,

package/libx/_runtime/hana/conversion.js

@@ -46,7 +46,8 @@ const HANA_TYPE_CONVERSION_MAP = new Map([
   ['cds.Integer64', convertInt64ToString],
   ['cds.DateTime', convertToISONoMillis],
   ['cds.Timestamp', convertToISO],
-  ['cds.LargeString', convertToString]
+  ['cds.LargeString', convertToString],
+  ['cds.hana.CLOB', convertToString]
 ])
 
 if (cds.env.features.bigjs) {

package/libx/_runtime/hana/execute.js

@@ -51,8 +51,6 @@ function _getOutputParameters(stmt) {
 const BINARY_TYPES = {
   12: 'BINARY',
   13: 'VARBINARY',
-  25: 'CLOB',
-  26: 'NCLOB',
   27: 'BLOB'
 }
 

package/libx/_runtime/hana/search2cqn4sql.js

@@ -72,10 +72,7 @@ const search2cqn4sql = (query, entity, options) => {
   return query
 }
 
-const _getLocalizedAssociation = entity => {
-  const associations = entity.associations
-  return associations && associations.localized
-}
+const _getLocalizedAssociation = entity => entity.associations && entity.associations.localized
 
 // The inner join modifies the original SELECT ... FROM query and adds ambiguity,
 // therefore add the table/entity name (as a preceding element) to the columns ref

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

@@ -246,6 +246,7 @@ const run = async (
 
     LOG._warn && LOG.warn(sanitizedError)
 
+    // REVISIT: switch from innererror to reason in cds^6
     throw Object.assign(new Error(e.message), { statusCode: 502, innererror: sanitizedError })
   }
 
@@ -267,6 +268,7 @@ const run = async (
 
     LOG._warn && LOG.warn(sanitizedError)
 
+    // REVISIT: switch from innererror to reason in cds^6
     throw Object.assign(new Error(`Error during request to remote service: ${e.message}`), {
       statusCode: 502,
       innererror: sanitizedError
@@ -294,6 +296,8 @@ const run = async (
         : 'Request to remote service failed.'
       const sanitizedError = _getSanitizedError(contentJSON, requestConfig)
       LOG._warn && LOG.warn(sanitizedError)
+
+      // REVISIT: switch from innererror to reason in cds^6
       throw Object.assign(new Error(contentJSON.message), { statusCode: 502, innererror: sanitizedError })
     }
   }

package/libx/gql/resolvers/crud/update.js

@@ -5,16 +5,14 @@ const { entriesStructureToEntityStructure } = require('./utils')
 module.exports = async (service, entityFQN, selection) => {
   const filter = getArgumentByName(selection.arguments, ARGUMENT.FILTER)
 
-  let queryBeforeUpdate = service.read(entityFQN)
+  const queryBeforeUpdate = service.read(entityFQN)
   queryBeforeUpdate.columns(astToColumns(selection.selectionSet.selections))
 
   if (filter) {
     queryBeforeUpdate.where(astToWhere(filter))
   }
 
-  const resultBeforeUpdate = await service.tx(tx => tx.run(queryBeforeUpdate))
-
-  let query = service.update(entityFQN)
+  const query = service.update(entityFQN)
 
   if (filter) {
     query.where(astToWhere(filter))
@@ -24,7 +22,12 @@ module.exports = async (service, entityFQN, selection) => {
   const entries = entriesStructureToEntityStructure(service, entityFQN, astToEntries(input))
   query.with(entries)
 
-  const result = await service.tx(tx => tx.run(query))
+  let resultBeforeUpdate
+  const result = await service.tx(async tx => {
+    // read needs to be done before the update, otherwise the where clause might become invalid (case that properties in where clause are updated by the mutation)
+    resultBeforeUpdate = await service.tx(tx => tx.run(queryBeforeUpdate))
+    return tx.run(query)
+  })
 
   // Merge selected fields with updated data
   return resultBeforeUpdate.map(original => ({ ...original, ...result }))

package/package.json

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