@sap/cds 5.4.6 → 5.5.0

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

@@ -4,6 +4,7 @@ const BaseBuilder = require('./BaseBuilder')
 const SelectBuilder = require('./SelectBuilder')
 const getAnnotatedColumns = require('./annotations')
 const dollar = require('./dollar')
+const { stringifyIfArrayedElement, isArrayedElement } = require('./arrayed')
 
 /**
  * InsertBuilder is used to take a CQN object as an input and to build an object representing an insert operation
@@ -185,13 +186,13 @@ class InsertBuilder extends BaseBuilder {
     const annotatedInsertColumnValues = annotatedColumns ? this._getAnnotatedInsertColumnValues(annotatedColumns) : []
 
     if (this._obj.INSERT.values) {
-      this._outputObj.values = this._obj.INSERT.values
+      this._outputObj.values = this._obj.INSERT.values.map(stringifyIfArrayedElement)
 
       placeholderNum = this._outputObj.values.length
 
       this._valuesAnnotatedValues(annotatedInsertColumnValues, this._outputObj.values)
     } else {
-      this._outputObj.values = this._obj.INSERT.rows
+      this._outputObj.values = this._obj.INSERT.rows.map(r => r.map(stringifyIfArrayedElement))
 
       placeholderNum = this._outputObj.values[0].length
 
@@ -261,7 +262,7 @@ class InsertBuilder extends BaseBuilder {
       for (const column of columns) {
         const flattenColumn = flattenColumnMap.get(column)
         const val = this._getValue(column, { entry, flattenColumn, insertAnnotatedColumns })
-        values.push(val)
+        values.push(isArrayedElement(val) ? JSON.stringify(val) : val)
       }
 
       // insert values for insert annotated columns
@@ -370,7 +371,7 @@ class InsertBuilder extends BaseBuilder {
   _getFlattenEntryColumnsRecursion(res, entry, prefix) {
     Object.keys(entry).forEach(key => {
       const prefixKey = prefix ? `${prefix}_${key}` : key
-      if (this._isSubObject(key, entry)) {
+      if (this._isSubObject(key, entry) && !isArrayedElement(entry[key])) {
         this._getFlattenEntryColumnsRecursion(res, entry[key], prefixKey)
       } else {
         res.push(prefixKey)
@@ -384,7 +385,7 @@ class InsertBuilder extends BaseBuilder {
     entries.forEach(entry => {
       Object.keys(entry).forEach(key => {
         const prefixKey = prefix ? `${prefix}_${key}` : key
-        if (this._isSubObject(key, entry)) {
+        if (this._isSubObject(key, entry) && !isArrayedElement(entry[key])) {
           const resInternal = this._getFlattenColumnMap([entry[key]], { prefix: prefixKey, annotatedColumns })
 
           Array.from(resInternal.keys()).forEach(keyInternal => {

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

@@ -45,6 +45,16 @@ class ReferenceBuilder extends BaseBuilder {
       this._outputObj.values.push(...values)
     } else if (this._obj.ref) {
       // reference
+
+      // REVISIT: compat for legacy ref: "['foo as bar']" -> remove with cds^6
+      if (this._obj.ref.length === 1 && typeof this._obj.ref[0] === 'string') {
+        const matched = this._obj.ref[0].match(/(\S*)\s{1,}as\s{1,}(\S*)/i)
+        if (matched) {
+          this._obj.ref = [matched[1]]
+          this._obj.as = matched[2].replace(/^"/, '').replace(/"$/, '')
+        }
+      }
+
       if (this._obj.param) {
         this._parseParamReference(this._obj.ref)
       } else {

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

@@ -1,3 +1,5 @@
+const cds = require('../../cds')
+
 const BaseBuilder = require('./BaseBuilder')
 const { DRAFT_COLUMNS } = require('../../common/constants/draft')
 
@@ -67,6 +69,8 @@ class SelectBuilder extends BaseBuilder {
    * SQL string for prepared statement and array of values to replace the placeholders.
    */
   build(noQuoting = false) {
+    if (this._obj.SELECT._4odata) this._options._4odata = true
+
     this._outputObj = {
       sql: ['SELECT'],
       values: []
@@ -250,8 +254,7 @@ class SelectBuilder extends BaseBuilder {
       res.sql = `( ${res.sql} )`
     } else {
       // val
-      res.sql = this._val(col)
-      res.values = []
+      res = this._val(col)
     }
 
     if (col.as) {
@@ -288,7 +291,7 @@ class SelectBuilder extends BaseBuilder {
     const aliases = columns.map(col => this._getAlias(col)).filter(element => element !== undefined)
     const findDuplicates = aliases.filter((item, index) => aliases.indexOf(item) !== index)
 
-    if (findDuplicates.length !== 0) {
+    if (findDuplicates.length > 0) {
       throw new Error(
         `Duplicate column names ${JSON.stringify(findDuplicates)} detected in SELECT statement. Please use aliases.`
       )
@@ -296,11 +299,8 @@ class SelectBuilder extends BaseBuilder {
   }
 
   _getAlias(col) {
-    if (col.as) {
-      return col.as
-    } else if (col.ref) {
-      return col.ref[col.ref.length - 1]
-    }
+    if (col.as) return col.as
+    if (col.ref) return col.ref[col.ref.length - 1]
   }
 
   _columns(noQuoting) {
@@ -368,16 +368,29 @@ class SelectBuilder extends BaseBuilder {
   }
 
   _having() {
-    const having = new this.ExpressionBuilder(this._obj.SELECT.having, this._options, this._csn).build()
-    this._outputObj.sql.push('HAVING', having.sql)
-    this._outputObj.values.push(...having.values)
+    const { sql, values } = new this.ExpressionBuilder(this._obj.SELECT.having, this._options, this._csn).build()
+    this._outputObj.sql.push('HAVING', sql)
+    this._outputObj.values.push(...values)
   }
 
   _orderBy() {
     const sqls = []
     this._outputObj.sql.push('ORDER BY')
     for (const element of this._obj.SELECT.orderBy) {
-      this._quoteAliases(element)
+      // REVISIT: should not be necessary
+      // if columns doesn't have matching ref but matching as, then use that as
+      const { columns } = this._obj.SELECT
+      if (columns) {
+        const serialized = JSON.stringify(element.ref)
+        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())
+            continue
+          }
+        }
+      }
+
       const { sql, values } = new this.ReferenceBuilder(element, this._options, this._csn).build()
       sqls.push(sql)
       this._outputObj.values.push(...values)
@@ -394,17 +407,8 @@ class SelectBuilder extends BaseBuilder {
    * offset will still use placeholders, as it'll change during the paging queries.
    */
   _limit() {
-    // limit
-    if (this._obj.SELECT.one) {
-      this._outputObj.sql.push('LIMIT', 1)
-    } else {
-      if (typeof this._obj.SELECT.limit.rows.val === 'number' && !this._parameterizedNumbers) {
-        this._outputObj.sql.push('LIMIT', this._obj.SELECT.limit.rows.val)
-      } else {
-        this._outputObj.sql.push('LIMIT', '?')
-        this._outputObj.values.push(this._obj.SELECT.limit.rows.val)
-      }
-    }
+    // limit (no placeholder for statement caching)
+    this._outputObj.sql.push('LIMIT', this._obj.SELECT.one ? 1 : this._obj.SELECT.limit.rows.val)
     // offset
     if (this._obj.SELECT.limit && this._obj.SELECT.limit.offset) {
       if (typeof this._obj.SELECT.limit.offset.val === 'number' && !this._parameterizedNumbers) {
@@ -425,7 +429,14 @@ class SelectBuilder extends BaseBuilder {
   }
 
   _val(obj) {
-    return obj.val
+    let _val = obj.val
+    if (typeof _val === 'number') return { sql: _val, values: [] }
+    // REVISIT: remove with cds^6
+    if (typeof _val === 'string' && cds.env.features.extract_vals !== false) {
+      const match = _val.match(/^'(.*)'$/)
+      if (match) _val = match[1]
+    }
+    return { sql: '?', values: [_val] }
   }
 
   getDefaultOptions() {

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

@@ -1,6 +1,7 @@
 const BaseBuilder = require('./BaseBuilder')
 const getAnnotatedColumns = require('./annotations')
 const dollar = require('./dollar')
+const { stringifyIfArrayedElement, isArrayedElement } = require('./arrayed')
 
 /**
  * UpdateBuilder is used to take a CQN object as an input and to build an object representing an update operation
@@ -69,7 +70,8 @@ class UpdateBuilder extends BaseBuilder {
     const entityName = this._entity()
     this._options.entityName = entityName
 
-    this._data(getAnnotatedColumns(entityName, this._csn))
+    const entity = this._csn && this._csn.definitions && this._csn.definitions[entityName]
+    this._data(getAnnotatedColumns(entityName, this._csn), entity)
     if (Array.isArray(this._obj.UPDATE.where) && this._obj.UPDATE.where.length > 0) {
       this._where()
     }
@@ -101,7 +103,7 @@ class UpdateBuilder extends BaseBuilder {
     }
   }
 
-  _data(annotatedColumns) {
+  _data(annotatedColumns, entity) {
     const sql = []
     const data = this._obj.UPDATE.data || {}
     const withObj = this._obj.UPDATE.with || {}
@@ -111,13 +113,19 @@ class UpdateBuilder extends BaseBuilder {
 
     this._addAnnotatedUpdateColumns(resMap, annotatedColumns)
 
+    if (entity && entity.keys) {
+      resMap.forEach((value, key, map) => {
+        if (key in entity.keys) map.delete(key)
+      })
+    }
+
     resMap.forEach((value, key, map) => {
       if (value && value.sql) {
         sql.push(`${this._quoteElement(key)} = ${value.sql}`)
         this._outputObj.values.push(...value.values)
       } else {
         sql.push(`${this._quoteElement(key)} = ?`)
-        this._outputObj.values.push(value)
+        this._outputObj.values.push(stringifyIfArrayedElement(value))
       }
     })
 
@@ -142,7 +150,9 @@ class UpdateBuilder extends BaseBuilder {
       const prefixKey = prefix ? `${prefix}_${key}` : key
       const value = data[key]
       if (typeof value === 'object' && !Buffer.isBuffer(value) && value !== null && typeof value.pipe !== 'function') {
-        if ('xpr' in value && Array.isArray(value.xpr)) {
+        if (isArrayedElement(value)) {
+          res.set(key, JSON.stringify(value))
+        } else if ('xpr' in value && Array.isArray(value.xpr)) {
           const xpr = new this.ExpressionBuilder(value.xpr, this._options, this._csn).build()
           res.set(key, xpr)
         } else if ('ref' in value && Array.isArray(value.ref)) {

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

@@ -0,0 +1,4 @@
+const isArrayedElement = v => Array.isArray(v) && !Buffer.isBuffer(v)
+const stringifyIfArrayedElement = v => (isArrayedElement(v) ? JSON.stringify(v) : v)
+
+module.exports = { isArrayedElement, stringifyIfArrayedElement }

package/libx/_runtime/db/utils/deep.js

@@ -30,12 +30,20 @@ async function processCQNs(processFn, cqns, model, dbc, user, locale, ts, chunks
   const results = new Array(cqns.length)
 
   const deletes = []
+  const updatesBeforeDelete = []
   const others = []
   for (let i = 0; i < cqns.length; i++) {
     if (cqns[i].DELETE) deletes.push(i)
+    else if (cqns[i].UPDATE && cqns[i].UPDATE._beforeDelete) updatesBeforeDelete.push(i)
     else others.push(i)
   }
 
+  // UPDATEs to SET null parent's foreign keys of one compositions
+  // which are otherwise violate foreign key constraints
+  if (updatesBeforeDelete.length) {
+    await _processChunk(processFn, model, dbc, cqns, user, locale, ts, updatesBeforeDelete, results)
+  }
+
   if (deletes.length > 0) {
     if (chunks) {
       let offset = 0

package/libx/_runtime/db/utils/generateAliases.js

@@ -52,6 +52,7 @@ const _generateAliases = (partialCqn, aliasMap = new Map()) => {
     _redirectXpr(partialCqn.SELECT.where, selectMap)
     _redirectXpr(partialCqn.SELECT.having, selectMap)
     _redirectXpr(partialCqn.SELECT.columns, selectMap)
+    _redirectXpr(partialCqn.SELECT.groupBy, selectMap)
     return
   }
 
@@ -65,7 +66,7 @@ const _generateAliases = (partialCqn, aliasMap = new Map()) => {
     return
   }
 
-  if (partialCqn.join) {
+  if (Object.prototype.hasOwnProperty.call(partialCqn, 'join')) {
     partialCqn.args.forEach(arg => {
       if (arg.ref) {
         _redirectRef(arg, aliasMap)

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

@@ -1,19 +1,19 @@
 const cds = require('../../cds')
 const { INSERT, SELECT, UPDATE, DELETE } = cds.ql
 
-const { ensureNoDraftsSuffix, ensureDraftsSuffix, filterKeys } = require('../utils/handler')
+const {
+  ensureNoDraftsSuffix,
+  ensureDraftsSuffix,
+  filterKeys,
+  getDeleteDraftAdminCqn,
+  getCompositionTargets
+} = require('../utils/handler')
 const { readAndDeleteKeywords, isActiveEntityRequested, getKeyData } = require('../utils/where')
 const { isDraftRootEntity } = require('../../fiori/utils/csn')
-const { getVirtuals, postProcessVirtuals } = require('../../db/generic/virtual')
 const { getColumns } = require('../../cds-services/services/utils/columns')
 
 const { DRAFT_COLUMNS } = require('../../common/constants/draft')
 
-const _getDeleteDraftAdminCqn = draftUUID =>
-  DELETE.from('DRAFT.DraftAdministrativeData').where([{ ref: ['DraftUUID'] }, '=', { val: draftUUID }])
-
-const _getDeleteRootDraftCqn = (targetName, rootWhere) => DELETE.from(targetName).where(rootWhere)
-
 const _getRootCQN = (context, requestActiveData) => {
   const keys = filterKeys(context.target.keys)
   const keyData = getKeyData(keys, context.query.SELECT.from.ref[0].where)
@@ -147,12 +147,10 @@ const _handler = async function (req) {
   r.getUrlObject = () => req.getUrlObject()
   r._.params = req.params
 
-  const virtuals = getVirtuals(req, this.model)
   // use finally to preserve r.messages in success or error case
   let result
   try {
     result = await this.dispatch(r)
-    postProcessVirtuals(virtuals, result)
   } finally {
     // REVISIT: should not be necessary
     if (r.messages) for (const m of r.messages) req.info(m)
@@ -161,12 +159,18 @@ const _handler = async function (req) {
   /*
    * delete draft data
    */
-  const deleteDraftAdminCqn = _getDeleteDraftAdminCqn(adminData.DraftUUID)
-  const deleteRootDraftCqn = _getDeleteRootDraftCqn(
-    ensureDraftsSuffix(req.target.name),
-    req.query.SELECT.from.ref[0].where
-  )
-  await cds.db.tx(req).run([deleteDraftAdminCqn, deleteRootDraftCqn])
+  const deleteDraftAdminCqn = getDeleteDraftAdminCqn(adminData.DraftUUID)
+  const draftTablesToDeleteFrom = [req.target.name + '_drafts']
+  for (const [entity] of getCompositionTargets(req.target, this).entries())
+    draftTablesToDeleteFrom.push(entity + '_drafts')
+  await cds.db.tx(req).run([
+    deleteDraftAdminCqn,
+    ...draftTablesToDeleteFrom.map(dt => {
+      const d = DELETE.from(dt).where({ DraftAdministrativeData_DraftUUID: adminData.DraftUUID })
+      d._suppressDeepDelete = true // hidden flag to tell db layer that no deep delete is required
+      return d
+    })
+  ])
 
   return result
 }

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

@@ -3,8 +3,8 @@ const cds = require('../../cds')
 const { SELECT } = cds.ql
 
 const { isNavigationToMany } = require('../utils/req')
-const { isDraftActivateAction } = require('../utils/handler')
-const { ensureNoDraftsSuffix, ensureDraftsSuffix, draftIsLocked } = require('../utils/handler')
+const { getKeysCondition } = require('../utils/where')
+const { isDraftActivateAction, ensureNoDraftsSuffix, ensureDraftsSuffix, draftIsLocked } = require('../utils/handler')
 
 const { isCustomOperation } = require('../../cds-services/adapter/odata-v4/utils/request')
 
@@ -128,15 +128,7 @@ const _addDraftDataFromExistingDraft = async (req, service) => {
   }
 
   if (!parent) {
-    const keys = Object.keys(req.target.keys)
-    const rootWhere = keys.reduce((res, key) => {
-      if (key === 'IsActiveEntity') {
-        return res
-      }
-      res[key] = req.data[key]
-      return res
-    }, {})
-
+    const rootWhere = getKeysCondition(req.target, req.data)
     result = await cds.tx(req).run(_getSelectDraftDataCqn(ensureNoDraftsSuffix(req.target.name), rootWhere))
     if (result && result.length > 0) {
       _addDraftDataToContext(req, result)

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

@@ -8,7 +8,7 @@ const { deleteDraft } = require('../utils/delete')
  * @param req
  */
 const _handler = function (req) {
-  return deleteDraft(req, this.model.definitions, false)
+  return deleteDraft(req, this)
 }
 
 module.exports = function () {

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

@@ -8,7 +8,9 @@ const { deleteDraft } = require('../utils/delete')
  * @param req
  */
 const _handler = function (req) {
-  return deleteDraft(req, this.model.definitions, true)
+  // we should call deleteDraft only for draft tables and call next
+  // to pass delete of active tables to our general implementation
+  return deleteDraft(req, this, true)
 }
 
 module.exports = function () {

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

@@ -92,7 +92,9 @@ const _handler = async function (req) {
     res[key] = data[key]
     return res
   }, {})
-  const transition = getTransition(req.target)
+
+  // cds.db and not "this" as we want to resolve as db here
+  const transition = getTransition(req.target, cds.db)
   const lockWhere = _getLockWhere(rootWhere, transition.mapping)
 
   // gets the underlying target entity, as record locking can't be
@@ -110,13 +112,21 @@ const _handler = async function (req) {
   const rootCQN = SELECT.from(req.target, columnNames).where(rootWhere)
   const subCQNs = getSubCQNs({
     definitions,
-    context: req,
     rootCQN,
     compositionTree: getCompositionTree({ definitions, rootEntityName: ensureNoDraftsSuffix(req.target.name) })
   })
   const rootDraftName = ensureDraftsSuffix(req.target.name)
   const draftExistsCQN = SELECT.from(rootDraftName, ['DraftAdministrativeData_DraftUUID as DraftUUID']).where(rootWhere)
   const selectCQNs = [rootCQN, ...subCQNs.map(obj => obj.cqn)]
+
+  // fetch unlocalized data if not a texts entity
+  for (const q of selectCQNs) {
+    const entity = definitions[q.SELECT.from.ref[0]]
+    if (entity && !entity.name.match(/\.texts$/)) {
+      Object.defineProperty(q, '_suppressLocalization', { value: true })
+    }
+  }
+
   const lockAndSelectCQNs = [lockRecordCQN, draftExistsCQN, ...selectCQNs]
 
   const dbtx = cds.tx(req)

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

@@ -6,7 +6,6 @@ const { isNavigationToMany } = require('../utils/req')
 const { getKeysCondition } = require('../utils/where')
 const { removeDraftUUIDIfNecessary, ensureDraftsSuffix } = require('../utils/handler')
 const { DRAFT_COLUMNS } = require('../../common/constants/draft')
-const { getVirtuals, postProcessVirtuals } = require('../../db/generic/virtual')
 
 const _getUpdateDraftAdminCQN = ({ user, timestamp }, draftUUID) => {
   return UPDATE('DRAFT.DraftAdministrativeData')
@@ -76,10 +75,13 @@ const _handler = async function (req, next) {
   const insertDataCQN = _getInsertDataCQN(req, req.data.DraftAdministrativeData_DraftUUID)
 
   // read data as on db and return
-  const readInsertDataCQN = SELECT.from(insertDataCQN.INSERT.into)
+  const columns = Object.keys(req.target.elements)
+    .map(e => req.target.elements[e])
+    .filter(e => !e.isAssociation)
+    .map(e => e.name)
+  const readInsertDataCQN = SELECT.from(insertDataCQN.INSERT.into).columns(columns)
   readInsertDataCQN.where(getKeysCondition(req.target, req.data))
 
-  const virtuals = getVirtuals({ query: readInsertDataCQN, target: req.target }, this.model)
   const dbtx = cds.tx(req)
 
   await Promise.all([dbtx.run(adminDataCQN), dbtx.run(insertDataCQN)])
@@ -89,8 +91,6 @@ const _handler = async function (req, next) {
     req.reject(404)
   }
 
-  postProcessVirtuals(virtuals, result)
-
   removeDraftUUIDIfNecessary(result[0], req)
 
   return result[0]

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

@@ -53,21 +53,6 @@ const _getUpdateDraftCQN = ({ query, target: { name } }, keysCondition) => {
   return UPDATE(ensureDraftsSuffix(name)).data(set).where(keysCondition)
 }
 
-const _deleteDraftAdminProperties = oldData => {
-  for (const toBeDeletedProperty of [
-    'DraftIsCreatedByMe',
-    'DraftIsProcessedByMe',
-    'InProcessByUser',
-    'LastChangeDateTime',
-    'LastChangedByUser',
-    'CreatedByUser',
-    'CreationDateTime',
-    'DraftUUID'
-  ]) {
-    delete oldData[toBeDeletedProperty]
-  }
-}
-
 /**
  * Generic Handler for PATCH requests in the context of draft.
  * In case of success it returns the updated entry.
@@ -91,9 +76,6 @@ const _handler = async function (req) {
     req.reject(403)
   }
 
-  _deleteDraftAdminProperties(result[0])
-  req._oldData = result[0]
-
   const updateDraftCQN = _getUpdateDraftCQN(req, keysCondition)
   const updateDraftAdminCQN = getUpdateDraftAdminCQN(req, result[0].DraftAdministrativeData_DraftUUID)