@sap/cds 5.5.3 → 5.6.1

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

@@ -1,4 +1,5 @@
 const getColumns = require('../utils/columns')
+//  REVISIT: Remove support for @odata.on... with @sap/cds ^6
 const ANNOTATIONS = ['@cds.on.insert', '@odata.on.insert', '@cds.on.update', '@odata.on.update']
 const { ensureNoDraftsSuffix } = require('../../common/utils/draft')
 

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

@@ -3,17 +3,6 @@ const resolveStructured = require('../../common/utils/resolveStructured')
 
 const { DRAFT_COLUMNS } = require('../../common/constants/draft')
 
-const _filterAssociationAndComposition = (entity, columnName) => {
-  return entity.elements[columnName]
-    ? entity.elements[columnName].is2one !== true && entity.elements[columnName].is2many !== true
-    : true
-}
-const _filterDraft = (entity, columnName) => {
-  return DRAFT_COLUMNS.includes(columnName) !== true && _filterAssociationAndComposition(entity, columnName)
-}
-
-const _mapNameToValue = (entity, array) => array.map(key => entity.elements[key] || { name: key })
-
 /**
  * This method gets all columns for an entity.
  * It includes the generated foreign keys from managed associations, structured elements and complex and custom types.
@@ -22,42 +11,24 @@ const _mapNameToValue = (entity, array) => array.map(key => entity.elements[key]
  * @param entity - the csn entity
  * @returns {Array} - array of columns
  */
-const getColumns = entity => {
+const getColumns = (entity, { db, onlyKeys } = { db: true, onlyKeys: false }) => {
   // REVISIT is this correct or just a problem that occurs because of new structure we do not deal with yet?
-  if (!entity.elements) return []
-
-  let columnNames
+  if (!(entity && entity.elements)) return []
+  const columnNames = []
   // REVISIT!!!
-  const proto = Object.getPrototypeOf(entity.elements)
-  if (proto) columnNames = Object.keys(proto)
-  else columnNames = Object.keys(entity.elements)
-
-  if (cds.env.effective.odata.structs) {
-    const toBeDeleted = []
-    for (const column of columnNames) {
-      const element = entity.elements[column]
-      if (element && element.elements) {
-        toBeDeleted.push(column)
-        columnNames.push(
-          ...resolveStructured({ structName: element.name, structProperties: [] }, element.elements, false)
-        )
-      }
+  const elements = Object.getPrototypeOf(entity.elements) || entity.elements
+  for (const elementName in elements) {
+    const element = elements[elementName]
+    if (onlyKeys && !element.key) continue
+    if (element.isAssociation) continue
+    if (db && entity._isDraftEnabled && DRAFT_COLUMNS.includes(elementName)) continue
+    if (cds.env.effective.odata.structs && element.elements) {
+      columnNames.push(...resolveStructured({ structName: elementName, structProperties: [] }, element.elements, false))
+      continue
     }
-
-    columnNames = columnNames.filter(col => !toBeDeleted.includes(col))
+    columnNames.push(elementName)
   }
-
-  if (entity && entity._isDraftEnabled) {
-    return _mapNameToValue(
-      entity,
-      columnNames.filter(key => _filterDraft(entity, key))
-    )
-  }
-
-  return _mapNameToValue(
-    entity,
-    columnNames.filter(key => _filterAssociationAndComposition(entity, key))
-  )
+  return columnNames.map(name => elements[name] || { name })
 }
 
 module.exports = getColumns

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

@@ -12,14 +12,12 @@ function getFlatArray(arg) {
 
 async function _processChunk(processFn, model, dbc, cqns, user, locale, ts, indexes, results) {
   const promises = []
-  for (const i of indexes) {
-    promises.push(processFn(model, dbc, cqns[i], user, locale, ts))
-  }
-  const promisesResults = await Promise.all(promises)
+  for (const i of indexes) promises.push(processFn(model, dbc, cqns[i], user, locale, ts))
+  const promisesResults = await Promise.allSettled(promises)
+  const firstRejected = promisesResults.find(r => r.status === 'rejected')
+  if (firstRejected) throw firstRejected.reason
   // put results of queries into correct place of return results
-  for (let i = 0; i < promisesResults.length; i++) {
-    results[indexes[i]] = promisesResults[i]
-  }
+  for (let i = 0; i < promisesResults.length; i++) results[indexes[i]] = promisesResults[i].value
 }
 
 async function processCQNs(processFn, cqns, model, dbc, user, locale, ts, chunks) {

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

@@ -93,6 +93,7 @@ const _draftCompositionTree = async (service, req) => {
   }
 
   if (results[1].length === 1) {
+    _removeIsActiveEntityRecursively(results[1])
     activeData = results[1][0]
   }
 
@@ -175,8 +176,8 @@ const _handler = async function (req) {
   return result
 }
 
-module.exports = function () {
+module.exports = cds.service.impl(function () {
   for (const entity of Object.values(this.entities).filter(e => e._isDraftEnabled)) {
     this.on('draftActivate', entity, _handler)
   }
-}
+})

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

@@ -186,7 +186,7 @@ const _deleteCancel = async function (req) {
   await _addDraftDataFromExistingDraft(req, this)
 }
 
-module.exports = function () {
+module.exports = cds.service.impl(function () {
   _new._initial = true
   _patchUpdate._initial = true
   _deleteCancel._initial = true
@@ -196,4 +196,4 @@ module.exports = function () {
     this.before(['PATCH', 'UPDATE'], entity, _patchUpdate)
     this.before(['DELETE', 'CANCEL'], entity, _deleteCancel)
   }
-}
+})

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

@@ -1,3 +1,4 @@
+const cds = require('../../cds')
 const { deleteDraft } = require('../utils/delete')
 
 /**
@@ -11,8 +12,8 @@ const _handler = function (req) {
   return deleteDraft(req, this)
 }
 
-module.exports = function () {
+module.exports = cds.service.impl(function () {
   for (const entity of Object.values(this.entities).filter(e => e._isDraftEnabled)) {
     this.on('CANCEL', entity, _handler)
   }
-}
+})

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

@@ -1,3 +1,4 @@
+const cds = require('../../cds')
 const { deleteDraft } = require('../utils/delete')
 
 /**
@@ -13,8 +14,8 @@ const _handler = function (req) {
   return deleteDraft(req, this, true)
 }
 
-module.exports = function () {
+module.exports = cds.service.impl(function () {
   for (const entity of Object.values(this.entities).filter(e => e._isDraftEnabled)) {
     this.on('DELETE', entity, _handler)
   }
-}
+})

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

@@ -172,8 +172,8 @@ const _handler = async function (req) {
   return Object.assign({}, results[0][0], { HasDraftEntity: false, HasActiveEntity: true, IsActiveEntity: false })
 }
 
-module.exports = function () {
+module.exports = cds.service.impl(function () {
   for (const entity of Object.values(this.entities).filter(e => e._isDraftEnabled)) {
     this.on('EDIT', entity, _handler)
   }
-}
+})

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

@@ -96,8 +96,8 @@ const _handler = async function (req, next) {
   return result[0]
 }
 
-module.exports = function () {
+module.exports = cds.service.impl(function () {
   for (const entity of Object.values(this.entities).filter(e => e._isDraftEnabled)) {
     this.on('NEW', entity, _handler)
   }
-}
+})

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

@@ -91,8 +91,8 @@ const _handler = async function (req) {
   return result[0]
 }
 
-module.exports = function () {
+module.exports = cds.service.impl(function () {
   for (const entity of Object.values(this.entities).filter(e => e._isDraftEnabled)) {
     this.on('PATCH', entity, _handler)
   }
-}
+})

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

@@ -50,8 +50,8 @@ const _handler = async function (req) {
   return result[0]
 }
 
-module.exports = function () {
+module.exports = cds.service.impl(function () {
   for (const entity of Object.values(this.entities).filter(e => e._isDraftEnabled)) {
     this.on('draftPrepare', entity, _handler)
   }
-}
+})

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

@@ -1,7 +1,7 @@
 const cds = require('../../cds')
 const { SELECT } = cds.ql
 
-const cqn2cqn4sql = require('../../common/utils/cqn2cqn4sql')
+const { cqn2cqn4sql } = require('../../common/utils/cqn2cqn4sql')
 const { getElementDeep } = require('../../common/utils/csn')
 
 const { DRAFT_COLUMNS, DRAFT_COLUMNS_MAP, SCENARIO } = require('../../common/constants/draft')
@@ -15,7 +15,6 @@ const {
   getEnrichedCQN,
   removeDraftUUIDIfNecessary,
   replaceRefWithDraft,
-  hasKeyInWhere,
   filterKeys
 } = require('../utils/handler')
 const { deleteCondition, readAndDeleteKeywords, removeIsActiveEntityRecursively } = require('../utils/where')
@@ -186,34 +185,6 @@ function _copyArray(array) {
   })
 }
 
-const _whereContainsKeys = (req, whereDraft) => {
-  const keys = _getTargetKeys(req)
-  if (whereDraft.length < keys.length * 4 - 1) {
-    return false
-  }
-
-  let i = 0
-  let keyCount = 0
-  while (i < whereDraft.length) {
-    const element = whereDraft[i]
-    const op = whereDraft[i + 1]
-    if (element.ref && keys.some(x => x === element.ref[element.ref.length - 1]) && op === '=') {
-      // op is EQ by keys
-      i = i + 4
-      keyCount++
-      continue
-    }
-
-    i++
-  }
-
-  return keyCount === keys.length
-}
-
-const _isValidActive = (isActiveEntity, req, whereDraft) => {
-  return isActiveEntity.op === '=' && _isTrue(isActiveEntity.value.val) && _whereContainsKeys(req, whereDraft)
-}
-
 const _isValidDraftOfWhichIAmOwner = isActiveEntity => {
   return isActiveEntity.op === '=' && _isFalse(isActiveEntity.value.val)
 }
@@ -275,7 +246,7 @@ const _filterDraftColumnsBySelected = (draftColumns, columns) => {
   )
 }
 
-const _isOnlyCount = columns => columns.length === 1 && columns[0].as === '_counted_'
+const _isOnlyCount = columns => columns.length === 1 && (columns[0].as === '_counted_' || columns[0].as === '$count')
 
 const _getOuterMostColumns = (columnsFromRequest, additionalDraftColumns) => {
   if (_isOnlyCount(columnsFromRequest)) return columnsFromRequest
@@ -428,18 +399,6 @@ const _allActive = (req, columns, model) => {
   }
 }
 
-const _active = (req, draftWhere, columns) => {
-  const { table } = _getTableName(req)
-
-  const outerMostColumns = _getOuterMostColumns(columns, _getDraftPropertiesDetermineDraft(req, draftWhere))
-
-  const cqn = SELECT.from(table).columns(...outerMostColumns)
-
-  draftWhere = _getWhereWithAppendedDraftRestrictions(draftWhere, req)
-
-  return { cqn: getEnrichedCQN(cqn, req.query.SELECT, draftWhere), scenario: SCENARIO.ACTIVE }
-}
-
 const _activeWithoutDraft = (req, draftWhere, columns) => {
   const { table } = _getTableName(req, true)
   const draftName = table.ref[0]
@@ -805,7 +764,7 @@ const _getUnionCQN = (req, draftName, columns, subSelect, draftWhere) => {
         _alignAliasForUnion(ensureNoDraftsSuffix(req.target.name), req.query.SELECT.from.as, subSelect)
       ])
 
-    return union.columns({ func: 'sum', args: [{ ref: ['_counted_'] }], as: '_counted_' })
+    return union.columns({ func: 'sum', args: [{ ref: ['$count'] }], as: '$count' })
   }
 
   const enrichedColumns = _getOrderByEnrichedColumns(req.query.SELECT.orderBy, columns)
@@ -941,9 +900,6 @@ const _validatedWithSiblingInProcess = (req, draftWhere, draftParameters, column
   }
 }
 
-const _validatedActive = (req, draftWhere, draftParameters, columns) =>
-  _isValidActive(draftParameters.isActiveEntity, req, draftWhere) && _active(req, draftWhere, columns)
-
 const _validatedDraftOfWhichIAmOwner = (req, draftWhere, draftParameters, columns) =>
   _isValidDraftOfWhichIAmOwner(draftParameters.isActiveEntity) && _draftOfWhichIAmOwner(req, draftWhere, columns)
 
@@ -989,20 +945,16 @@ const _generateCQN = (reqOriginal, req, columns, model) => {
     return _allActive(req, columns, model)
   }
 
-  if (req.query.SELECT.where.length === 1 && req.query.SELECT.where[0].xpr) {
-    // REVISIT ugly workaround until we support .xpr instead of '('...')' in draft choreo
-    req.query.SELECT.where = req.query.SELECT.where[0].xpr
-  }
+  // REVISIT this function does not only read, but modifies where!
   const draftParameters = _readDraftParameters(req.query.SELECT.where)
 
   if (
     draftParameters.isActiveEntity &&
     _isTrue(draftParameters.isActiveEntity.value.val) &&
     !draftParameters.siblingIsActive &&
-    !draftParameters.hasDraftEntity &&
-    !hasKeyInWhere(reqOriginal.query.SELECT.from.ref[0].where, model.definitions[req.query.SELECT.from.ref[0]])
+    !draftParameters.hasDraftEntity
   ) {
-    return _allActive(req, columns)
+    return _allActive(req, columns, model)
   }
 
   if (!draftParameters.isActiveEntity) {
@@ -1012,7 +964,7 @@ const _generateCQN = (reqOriginal, req, columns, model) => {
       // this is only the case when navigating into tree
       return _allInactive(req, columns)
     }
-    return _allActive(req, columns)
+    return _allActive(req, columns, model)
   }
 
   if (draftParameters.hasDraftEntity) {
@@ -1023,9 +975,7 @@ const _generateCQN = (reqOriginal, req, columns, model) => {
     return _validatedWithSiblingInProcess(req, req.query.SELECT.where, draftParameters, columns)
   }
 
-  return _isTrue(draftParameters.isActiveEntity.value.val)
-    ? _validatedActive(req, req.query.SELECT.where, draftParameters, columns)
-    : _validatedDraftOfWhichIAmOwner(req, req.query.SELECT.where, draftParameters, columns)
+  return _validatedDraftOfWhichIAmOwner(req, req.query.SELECT.where, draftParameters, columns)
 }
 
 const _getColumns = ({ query: { SELECT } }, model) => {
@@ -1183,7 +1133,7 @@ const _handler = async function (req) {
   delete req.query._validationQuery
 
   // REVISIT DRAFT HANDLING: cqn2cqn4sql must not be called here
-  const sqlQuery = cqn2cqn4sql(req.query, this.model)
+  const sqlQuery = cqn2cqn4sql(req.query, this.model, { draft: true })
 
   // do not clone with Object.assign as that would skip all non-enumerable properties
   const reqClone = { __proto__: req, query: _copyCQNPartial(sqlQuery) }
@@ -1204,7 +1154,11 @@ const _handler = async function (req) {
     return
   }
 
-  const enhacnedWithLastChangeDateTime = enhanceQueryForTimeoutIfNeeded(
+  if (cqnScenario.scenario === SCENARIO.ALL_ACTIVE && cqnScenario.cqn.SELECT.where) {
+    cqnScenario.cqn.SELECT.where = removeIsActiveEntityRecursively(cqnScenario.cqn.SELECT.where)
+  }
+
+  const enhancedWithLastChangeDateTime = enhanceQueryForTimeoutIfNeeded(
     cqnScenario.scenario,
     cqnScenario.cqn.SELECT.columns
   )
@@ -1228,7 +1182,7 @@ const _handler = async function (req) {
     _calculateDraftAdminColumns(resultAsArray[0], req.user.id)
   }
 
-  calculateDraftTimeout(cqnScenario.scenario, resultAsArray, enhacnedWithLastChangeDateTime)
+  calculateDraftTimeout(cqnScenario.scenario, resultAsArray, enhancedWithLastChangeDateTime)
 
   if (cqnScenario.scenario === SCENARIO.SIBLING_ENTITY) {
     if (!result || (Array.isArray(result) && !result.length)) return result
@@ -1247,8 +1201,8 @@ const _handler = async function (req) {
   return result
 }
 
-module.exports = function () {
+module.exports = cds.service.impl(function () {
   for (const entity of Object.values(this.entities).filter(e => e._isDraftEnabled)) {
     this.on('READ', entity, _handler)
   }
-}
+})

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

@@ -2,7 +2,7 @@ const cds = require('../../cds')
 const { SELECT } = cds.ql
 const { getEnrichedCQN, hasDraft, ensureDraftsSuffix } = require('../utils/handler')
 const { readAndDeleteKeywords } = require('../utils/where')
-const cqn2cqn4sql = require('../../common/utils/cqn2cqn4sql')
+const { cqn2cqn4sql } = require('../../common/utils/cqn2cqn4sql')
 
 const _modifyCQN = (cqnDraft, where, context) => {
   const whereDraft = [...where]
@@ -45,7 +45,7 @@ const _handler = async function (req) {
   }
 
   // REVISIT DRAFT HANDLING: cqn2cqn4sql must not be called here
-  const sqlQuery = cqn2cqn4sql(req.query, this.model)
+  const sqlQuery = cqn2cqn4sql(req.query, this.model, { draft: true })
   if (req.query._streaming) {
     sqlQuery._streaming = true
   }
@@ -70,8 +70,8 @@ const _handler = async function (req) {
   return cds.tx(req).run(sqlQuery)
 }
 
-module.exports = function () {
+module.exports = cds.service.impl(function () {
   for (const entity of Object.values(this.entities).filter(e => !e._isDraftEnabled)) {
     this.on('READ', entity, _handler)
   }
-}
+})

package/libx/_runtime/fiori/uiflex/extensibility/index.cds

@@ -0,0 +1,15 @@
+namespace cds_r; //> cds system tables
+
+service ExtensibilityService @(path:'/-/cds/extensibility') {
+  action addExtension(extensions : array of String); // TODO: change to array of CSN extensions
+}
+
+entity Extensions {
+  key ID : UUID;
+  csn    : String;
+}
+
+// @open type Extension {
+//   extend: String;
+//   elements:{ /*  */ }
+// }

package/libx/_runtime/fiori/uiflex/extensibility/index.js

@@ -0,0 +1,148 @@
+const cds = require('../../../cds')
+const { ensureDraftsSuffix } = require('../../../common/utils/draft')
+
+const { EXT_BACK_PACK } = require('../utils')
+
+const _getDraftTable = (view, cds) => {
+  return cds.model.definitions[view]._isDraftEnabled ? ensureDraftsSuffix(view) : undefined
+}
+
+const _addAnnotation = extension => {
+  Object.values(extension.elements).forEach(el => {
+    el['@cds.extension'] = true
+  })
+}
+
+const _isProjection = target => target && target.query && target.query._target
+
+const _resolveViews = (target, views_ = []) => {
+  if (_isProjection(target)) {
+    views_.push(target)
+    return _resolveViews(target.query._target, views_)
+  }
+
+  return target
+}
+
+const _getCsn = req => {
+  const csn = {
+    extensions: req.data.extensions.map(ext => JSON.parse(ext))
+  }
+
+  return csn
+}
+
+const _addViews = csn => {
+  csn.extensions.forEach(extension => {
+    const target = cds.model.definitions[extension.extend]
+    const views_ = []
+    const view = _resolveViews(target, views_)
+    extension.extend = view && view.name
+    _addAnnotation(extension)
+
+    // All projection views leading to the db entity are extended with back pack in case view columns are explicitly listed.
+    // The views using projections with '*' obtain the back pack automatically.
+    views_.forEach(view => {
+      if (!view.projection || (view.projection.columns && !view.projection.columns.some(col => col === '*'))) {
+        csn.extensions.push({
+          extend: view.name,
+          columns: Object.keys(extension.elements).map(key => {
+            return { ref: [key] }
+          })
+        })
+      }
+    })
+  })
+}
+
+const _handleDefaults = async (extension, dbEntity, req, cds, draftEntity) => {
+  const ext = Object.keys(extension.elements)
+    .filter(key => extension.elements[key].default)
+    .map(key => {
+      const element = extension.elements[key]
+      const t = cds.model.definitions[element.type] || cds.builtin.types[element.type]
+      const value = t && t instanceof cds.builtin.classes.string ? `"${element.default.val}"` : element.default.val
+      return `"${key}":${value}`
+    })
+
+  if (ext.length !== 0) {
+    const extStr = ext.join(',')
+    const changed = `'{${extStr},' || substr(${EXT_BACK_PACK}, 2, length(${EXT_BACK_PACK})-1)`
+    const assign = `${EXT_BACK_PACK} = CASE WHEN ${EXT_BACK_PACK} IS NULL THEN '{${extStr}}' ELSE ${changed} END`
+    await UPDATE(dbEntity).with(assign)
+    if (draftEntity) await UPDATE(draftEntity).with(assign)
+  }
+}
+
+const _validateCsn = (csn, req) => {
+  csn.extensions.forEach(extension => {
+    if (!extension.extend || !cds.model.definitions[extension.extend]) {
+      req.reject(400, 'Invalid extension. Parameter "extend" missing or malformed')
+    }
+
+    if (!extension.elements) {
+      req.reject(400, 'Invalid extension. Missing parameter "elements"')
+    }
+  })
+}
+
+const _validateExtensionFields = async (csn, req) => {
+  csn.extensions.forEach(extension => {
+    if (extension.elements) {
+      Object.keys(extension.elements).forEach(name => {
+        if (!/^[A-Za-z]\w*$/.test(name)) {
+          req.reject(400, `Invalid extension. Bad element name "${name}"`)
+        }
+
+        if (Object.keys(cds.model.definitions[extension.extend].elements).includes(name)) {
+          req.reject(400, `Invalid extension. Element "${name}" already exists`)
+        }
+      })
+    }
+  })
+}
+
+const _getCompilerError = messages => {
+  const defaultMsg = 'Error while compiling extension'
+  if (!messages) return defaultMsg
+
+  for (const msg of messages) {
+    if (msg.severity === 'Error') return msg.message
+  }
+
+  return defaultMsg
+}
+
+const _validateExtension = async (csn, req) => {
+  try {
+    const base = await cds.load('*', cds.options)
+    const baseCsn = await cds.compile.to.json(base)
+    const extCsn = await cds.compile.to.json(csn)
+    await cds.compile.to.csn({ 'base.csn': baseCsn, 'ext.csn': extCsn })
+  } catch (err) {
+    req.reject(400, _getCompilerError(err.messages))
+  }
+}
+
+module.exports = function () {
+  this.on('addExtension', async req => {
+    const csn = _getCsn(req, cds)
+    _validateCsn(csn, req)
+    await _validateExtensionFields(csn, req)
+    _addViews(csn, cds)
+    await _validateExtension(csn, req)
+
+    const ID = cds.utils.uuid()
+    await INSERT.into('cds_r.Extensions').entries([{ ID, csn: JSON.stringify(csn) }])
+
+    for (const ext of req.data.extensions) {
+      const extension = JSON.parse(ext)
+      const draft = _getDraftTable(extension.extend, cds)
+      const target = cds.model.definitions[extension.extend]
+      const dbEntity = _resolveViews(target).name
+      await _handleDefaults(extension, dbEntity, req, cds, draft)
+    }
+
+    setTimeout(() => process.send('restart'), 1111)
+  })
+}