@sap/cds 5.9.8 → 6.0.3

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

@@ -55,7 +55,7 @@ const _getParent = (req, service) => {
     keyPredicateText = keyPredicate.getText()
 
     if (keyPredicateName === 'IsActiveEntity') {
-      parent.IsActiveEntity = keyPredicateText
+      parent.IsActiveEntity = keyPredicateText === 'true'
     } else {
       parent.keyName = keyPredicateName
       parent.keyValue = keyPredicateText
@@ -104,7 +104,7 @@ const _getSelectDraftDataCqn = (entityName, where) => {
 
 const _getDraftDataFromExistingDraft = async (req, service, parent = _getParent(req, service)) => {
   if (parent) {
-    if (parent.IsActiveEntity === 'false') {
+    if (parent.IsActiveEntity === false) {
       const parentWhere = [{ ref: [parent.keyName] }, '=', { val: parent.keyValue }]
       const query = _getSelectDraftDataCqn(parent.entityName, parentWhere)
       const result = await cds.tx(req).run(query)
@@ -125,7 +125,7 @@ const _addDraftDataFromExistingDraft = async (req, service) => {
   const result = await _getDraftDataFromExistingDraft(req, service, parent)
 
   if (parent) {
-    if (parent.IsActiveEntity === 'false') {
+    if (parent.IsActiveEntity === false) {
       _validateDraft(req, result)
       _addDraftDataToContext(req, result)
       return result
@@ -139,21 +139,14 @@ const _addDraftDataFromExistingDraft = async (req, service) => {
   return result
 }
 
-const _addGeneratedDraftUUID = async req => {
-  req._draftMetadata = req._draftMetadata || {}
-  req.data.DraftAdministrativeData_DraftUUID = cds.utils.uuid()
-  req._draftMetadata.DraftUUID = req.data.DraftAdministrativeData_DraftUUID
-}
-
 /**
  * Generic Handler for before NEW requests.
- *
- * @param req
  */
 const _new = async function (req) {
-  if (isDraftActivateAction(req)) return
+  if (isDraftActivateAction(req)) return // REVISIT: How can NEW be draftActivate???
 
   if (isNavigationToMany(req)) {
+    // REVISIT: How can NEW be a navigation to many?
     const result = await _addDraftDataFromExistingDraft(req, this)
 
     // in order to fix corner case where active subitems are created in draft case
@@ -161,13 +154,13 @@ const _new = async function (req) {
     return
   }
 
-  _addGeneratedDraftUUID(req)
+  req._draftMetadata = req._draftMetadata || {}
+  req.data.DraftAdministrativeData_DraftUUID = cds.utils.uuid()
+  req._draftMetadata.DraftUUID = req.data.DraftAdministrativeData_DraftUUID
 }
 
 /**
  * Generic Handler for before PATCH and UPDATE requests.
- *
- * @param req
  */
 const _patchUpdate = async function (req) {
   if (isDraftActivateAction(req)) return
@@ -180,8 +173,6 @@ const _patchUpdate = async function (req) {
 
 /**
  * Generic Handler for before DELETE and CANCEL requests.
- *
- * @param req
  */
 const _deleteCancel = async function (req) {
   await _addDraftDataFromExistingDraft(req, this)
@@ -209,16 +200,13 @@ const _registerBoundActionHandlers = function (entityName, actions) {
   }
 }
 
-module.exports = cds.service.impl(function () {
-  _new._initial = true
-  _patchUpdate._initial = true
-  _deleteCancel._initial = true
-  const entities = Object.values(this.entities).filter(e => e._isDraftEnabled)
-
-  for (const entity of entities) {
-    this.before('NEW', entity, _new)
-    this.before(['PATCH', 'UPDATE'], entity, _patchUpdate)
-    this.before(['DELETE', 'CANCEL'], entity, _deleteCancel)
-    _registerBoundActionHandlers.call(this, entity.name, entity.actions)
-  }
+_new._initial = true
+_patchUpdate._initial = true
+_deleteCancel._initial = true
+
+module.exports = cds.service.impl((srv, entity) => {
+  srv.before('NEW', entity, _new)
+  srv.before(['PATCH', 'UPDATE'], entity, _patchUpdate)
+  srv.before(['DELETE', 'CANCEL'], entity, _deleteCancel)
+  _registerBoundActionHandlers.call(srv, entity.name, entity.actions)
 })

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

@@ -12,8 +12,6 @@ const _handler = function (req) {
   return deleteDraft(req, this)
 }
 
-module.exports = cds.service.impl(function () {
-  for (const entity of Object.values(this.entities).filter(e => e._isDraftEnabled)) {
-    this.on('CANCEL', entity, _handler)
-  }
+module.exports = cds.service.impl(function (srv, entity) {
+  srv.on('CANCEL', entity, _handler)
 })

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

@@ -14,8 +14,6 @@ const _handler = function (req) {
   return deleteDraft(req, this, true)
 }
 
-module.exports = cds.service.impl(function () {
-  for (const entity of Object.values(this.entities).filter(e => e._isDraftEnabled)) {
-    this.on('DELETE', entity, _handler)
-  }
+module.exports = cds.service.impl(function (srv, entity) {
+  srv.on('DELETE', entity, _handler)
 })

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

@@ -4,14 +4,7 @@ const { INSERT, SELECT, DELETE } = cds.ql
 const { getCompositionTree } = require('../../common/composition')
 const { getColumns } = require('../../cds-services/services/utils/columns')
 const { getTransition } = require('../../common/utils/resolveView')
-const {
-  draftIsLocked,
-  ensureDraftsSuffix,
-  ensureNoDraftsSuffix,
-  getSubCQNs,
-  setStatusCodeAndHeader,
-  filterKeys
-} = require('../utils/handler')
+const { draftIsLocked, ensureDraftsSuffix, ensureNoDraftsSuffix, getSubCQNs, filterKeys } = require('../utils/handler')
 const { isActiveEntityRequested, getKeyData } = require('../utils/where')
 
 const _getDraftColumns = draftUUID => ({
@@ -163,14 +156,9 @@ const _handler = async function (req) {
   }
 
   await Promise.all(insertCQNs.map(CQN => dbtx.run(CQN)))
-  setStatusCodeAndHeader(req._.odataRes, rootWhere, req.target.name.replace(`${this.name}.`, ''), false)
-  return Object.assign({}, results[0][0], { HasDraftEntity: false, HasActiveEntity: true, IsActiveEntity: false })
+  return results[0][0]
 }
 
-module.exports = cds.service.impl(function () {
-  const entities = Object.values(this.entities).filter(e => e._isDraftEnabled)
-
-  for (const entity of entities) {
-    this.on('EDIT', entity, _handler)
-  }
+module.exports = cds.service.impl(function (srv, entity) {
+  srv.on('EDIT', entity, _handler)
 })

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

@@ -0,0 +1,31 @@
+const cds = require('../../cds')
+
+exports.impl = cds.service.impl(function () {
+  const entities = Object.values(this.entities).filter(entity => entity._isDraftEnabled)
+  if (entities.length === 0) return
+
+  for (const each of entities) {
+    _before(this, each)
+    _new(this, each)
+    _patch(this, each)
+    _cancel(this, each)
+    _edit(this, each)
+    _prepare(this, each)
+    _activate(this, each)
+    _delete(this, each)
+  }
+
+  _readOverDraft(this) // registers an on READ * handler
+  for (const each of entities) _read(this, each) // have to go last
+})
+
+const _before = require('../../fiori/generic/before')
+const _new = require('../../fiori/generic/new')
+const _patch = require('../../fiori/generic/patch')
+const _cancel = require('../../fiori/generic/cancel')
+const _edit = require('../../fiori/generic/edit')
+const _prepare = require('../../fiori/generic/prepare')
+const _activate = require('../../fiori/generic/activate')
+const _readOverDraft = require('../../fiori/generic/readOverDraft')
+const _read = require('../../fiori/generic/read')
+const _delete = require('../../fiori/generic/delete')

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

@@ -4,7 +4,7 @@ const { INSERT, SELECT, UPDATE } = cds.ql
 const onDraftActivate = require('./activate')._handler
 const { isNavigationToMany } = require('../utils/req')
 const { getKeysCondition } = require('../utils/where')
-const { removeDraftUUIDIfNecessary, ensureDraftsSuffix } = require('../utils/handler')
+const { ensureDraftsSuffix } = require('../utils/handler')
 const { DRAFT_COLUMNS_MAP } = require('../../common/constants/draft')
 
 const _getUpdateDraftAdminCQN = ({ user, timestamp }, draftUUID) => {
@@ -74,30 +74,14 @@ const _handler = async function (req, next) {
     : _getInsertDraftAdminCQN(req, req.data.DraftAdministrativeData_DraftUUID)
   const insertDataCQN = _getInsertDataCQN(req, req.data.DraftAdministrativeData_DraftUUID)
 
-  // read data as on db and return
-  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 dbtx = cds.tx(req)
 
   await Promise.all([dbtx.run(adminDataCQN), dbtx.run(insertDataCQN)])
 
-  const result = await dbtx.run(readInsertDataCQN)
-  if (result.length === 0) {
-    req.reject(404)
-  }
-
-  removeDraftUUIDIfNecessary(req)(result[0])
-
-  return result[0]
+  req._.readAfterWrite = true
+  return { ...req.data, IsActiveEntity: false }
 }
 
-module.exports = cds.service.impl(function () {
-  for (const entity of Object.values(this.entities).filter(e => e._isDraftEnabled)) {
-    this.on('NEW', entity, _handler)
-  }
+module.exports = cds.service.impl(function (srv, entity) {
+  srv.on('NEW', entity, _handler)
 })

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

@@ -12,7 +12,7 @@ const { getKeysCondition } = require('../utils/where')
 const { getColumns } = require('../../cds-services/services/utils/columns')
 const { DRAFT_COLUMNS_CQN } = require('../../common/constants/draft')
 
-const _getSelectCQN = (model, { data, target: { name } }, keysCondition, checkUser = true) => {
+const _getSelectCQN = (model, { target: { name } }, keysCondition, checkUser = true) => {
   const activeName = ensureNoDraftsSuffix(name)
   const draftName = ensureDraftsSuffix(name)
 
@@ -29,7 +29,7 @@ const _getSelectCQN = (model, { data, target: { name } }, keysCondition, checkUs
   }
 
   // REVISIT: support navigation to one
-  return SELECT.from(draftName)
+  return SELECT.one(draftName)
     .columns(columns)
     .join('DRAFT.DraftAdministrativeData')
     .on([
@@ -64,32 +64,27 @@ const _getUpdateDraftCQN = ({ query, target: { name } }, keysCondition) => {
  * @param req
  */
 const _handler = async function (req) {
-  if (req.data.IsActiveEntity === 'true') req.reject(400, 'Patch can only be applied to a draft entity')
+  if (req.data.IsActiveEntity === true) req.reject(400, 'Patch can only be applied to a draft entity')
 
   const keysCondition = getKeysCondition(req.target, req.data)
   const dbtx = cds.tx(req)
   let result = await dbtx.run(_getSelectCQN(this.model, req, keysCondition))
 
   // Potential timeout scenario supported
-  if (result[0].draftAdmin_inProcessByUser && result[0].draftAdmin_inProcessByUser !== req.user.id) {
+  if (result.draftAdmin_inProcessByUser && result.draftAdmin_inProcessByUser !== req.user.id) {
     // REVISIT: security log?
     req.reject(403)
   }
 
   const updateDraftCQN = _getUpdateDraftCQN(req, keysCondition)
-  const updateDraftAdminCQN = getUpdateDraftAdminCQN(req, result[0].DraftAdministrativeData_DraftUUID)
+  const updateDraftAdminCQN = getUpdateDraftAdminCQN(req, result.DraftAdministrativeData_DraftUUID)
 
   await Promise.all([dbtx.run(updateDraftCQN), dbtx.run(updateDraftAdminCQN)])
-  result = await dbtx.run(_getSelectCQN(this.model, req, keysCondition, false))
-  if (result.length === 0) req.reject(404)
-  removeDraftUUIDIfNecessary(req)(result[0])
-  return result[0]
-}
+  req._.readAfterWrite = true
 
-module.exports = cds.service.impl(function () {
-  const entities = Object.values(this.entities).filter(e => e._isDraftEnabled)
+  return { ...req.data, IsActiveEntity: false }
+}
 
-  for (const entity of entities) {
-    this.on('PATCH', entity, _handler)
-  }
+module.exports = cds.service.impl(function (srv, entity) {
+  srv.on('PATCH', entity, _handler)
 })

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

@@ -5,8 +5,6 @@ const { isActiveEntityRequested } = require('../utils/where')
 const { ensureDraftsSuffix, ensureNoDraftsSuffix } = require('../utils/handler')
 const { getColumns } = require('../../cds-services/services/utils/columns')
 
-const { DRAFT_COLUMNS_CQN } = require('../../common/constants/draft')
-
 /**
  * Generic Handler for PreparationAction requests.
  * In case of success it returns the prepared draft entry.
@@ -19,15 +17,14 @@ const _handler = async function (req) {
   }
 
   const target = ensureDraftsSuffix(req.target.name)
-  const columns = [
-    ...getColumns(this.model.definitions[ensureNoDraftsSuffix(req.target.name)], {
-      removeIgnore: true,
-      filterVirtual: true
-    }).map(obj => obj.name),
-    ...DRAFT_COLUMNS_CQN.filter(column => column.ref[0] !== 'DraftAdministrativeData_DraftUUID')
-  ]
+  const columns = getColumns(this.model.definitions[ensureNoDraftsSuffix(req.target.name)], {
+    keysOnly: true,
+    removeIgnore: true,
+    filterVirtual: true,
+    onlyNames: true
+  })
   columns.push({ ref: ['DRAFT.DraftAdministrativeData', 'inProcessByUser'], as: 'draftAdmin_inProcessByUser' })
-  const select = SELECT.from(target)
+  const select = SELECT.one(target)
     .columns(columns)
     .join('DRAFT.DraftAdministrativeData')
     .on([
@@ -36,22 +33,16 @@ const _handler = async function (req) {
       { ref: ['DRAFT.DraftAdministrativeData', 'DraftUUID'] }
     ])
     .where(req.query.SELECT.from.ref[0].where)
-
   const result = await cds.tx(req).run(select)
-
-  if (result.length === 0) req.reject(404)
-
-  if (result[0].draftAdmin_inProcessByUser !== req.user.id) {
+  if (!result) req.reject(404)
+  if (result.draftAdmin_inProcessByUser !== req.user.id) {
     // REVISIT: security log?
     req.reject(403, 'DRAFT_LOCKED_BY_ANOTHER_USER')
   }
-  delete result[0].draftAdmin_inProcessByUser
-
-  return result[0]
+  delete result.draftAdmin_inProcessByUser
+  return result
 }
 
-module.exports = cds.service.impl(function () {
-  for (const entity of Object.values(this.entities).filter(e => e._isDraftEnabled)) {
-    this.on('draftPrepare', entity, _handler)
-  }
+module.exports = cds.service.impl(function (srv, entity) {
+  srv.on('draftPrepare', entity, _handler)
 })