@sap/cds 6.4.1 → 6.6.0

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-commons/validator/ValueValidator.js

@@ -260,7 +260,7 @@ class ValueValidator {
       throw new IllegalArgumentError(
         'Invalid value ' +
           value +
-          ' (JavaScript ' +
+          ' (' +
           typeof value +
           ')' +
           (this.property ? ' for property "' + this.property + '"' : '') +
@@ -350,7 +350,7 @@ class ValueValidator {
       throw new IllegalArgumentError(
         'Invalid value ' +
           value +
-          ' (JavaScript ' +
+          ' (' +
           typeof value +
           ')' +
           (this.property ? ' for property "' + this.property + '"' : '') +
@@ -383,7 +383,7 @@ class ValueValidator {
       throw new IllegalArgumentError(
           'Invalid value ' +
           value +
-          ' (JavaScript ' +
+          ' (' +
           typeof value +
           ')' +
           (this.property ? ' for property "' + this.property + '"' : '') +
@@ -406,7 +406,7 @@ class ValueValidator {
         throw new IllegalArgumentError(
           'Invalid value ' +
             value +
-            ' (JavaScript ' +
+            ' (' +
             typeof value +
             ')' +
             (this.property ? ' for property "' + this.property + '"' : '') +
@@ -424,7 +424,7 @@ class ValueValidator {
       throw new IllegalArgumentError(
         'Invalid value ' +
           value +
-          ' (JavaScript ' +
+          ' (' +
           typeof value +
           ')' +
           (this.property ? ' for property "' + this.property + '"' : '') +
@@ -442,7 +442,7 @@ class ValueValidator {
       throw new IllegalArgumentError(
           'Invalid value ' +
           value +
-          ' (JavaScript ' +
+          ' (' +
           typeof value +
           ')' +
           (this.property ? ' for property "' + this.property + '"' : '') +
@@ -510,7 +510,7 @@ class ValueValidator {
       throw this._valueError(
         value,
         'Edm.GeographyPoint or Edm.GeometryPoint',
-        'JavaScript object with type and coordinates'
+        'Object with type and coordinates'
       )
     }
   }
@@ -528,7 +528,7 @@ class ValueValidator {
       throw this._valueError(
         value,
         'Edm.GeographyLineString or Edm.GeometryLineString',
-        'JavaScript object with type and coordinates'
+        'Object with type and coordinates'
       )
     }
   }
@@ -543,7 +543,7 @@ class ValueValidator {
       throw this._valueError(
         value,
         'Edm.GeographyPolygon or Edm.GeometryPolygon',
-        'JavaScript object with type and coordinates'
+        'Object with type and coordinates'
       )
     }
   }
@@ -561,7 +561,7 @@ class ValueValidator {
       throw this._valueError(
         value,
         'Edm.GeographyMultiPoint or Edm.GeometryMultiPoint',
-        'JavaScript object with type and coordinates'
+        'Object with type and coordinates'
       )
     }
   }
@@ -579,7 +579,7 @@ class ValueValidator {
       throw this._valueError(
         value,
         'Edm.GeographyMultiLineString or Edm.GeometryMultiLineString',
-        'JavaScript object with type and coordinates'
+        'Object with type and coordinates'
       )
     }
   }
@@ -597,7 +597,7 @@ class ValueValidator {
       throw this._valueError(
         value,
         'Edm.GeographyMultiPolygon or Edm.GeometryMultiPolygon',
-        'JavaScript object with type and coordinates'
+        'Object with type and coordinates'
       )
     }
   }
@@ -629,7 +629,7 @@ class ValueValidator {
       throw this._valueError(
         value,
         'Edm.GeographyCollection or Edm.GeometryCollection',
-        'JavaScript object with type and geometries'
+        'Object with type and geometries'
       )
     }
   }
@@ -725,7 +725,7 @@ class ValueValidator {
     const msg =
       'Invalid value ' +
       (typeName.includes('Geo') ? JSON.stringify(value) : value) +
-      ' (JavaScript ' +
+      ' (' +
       typeof value +
       ')' +
       (this.property ? ' for property "' + this.property + '"' : '') +

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-server/deserializer/DeserializerFactory.js

@@ -135,6 +135,7 @@ class DeserializerFactory {
             .getIncomingRequest()
             .on('error', next)
             .pipe(new stream.PassThrough())
+            .on('error', next)
         )
       } else {
         request

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

@@ -950,6 +950,7 @@ class ResourceJsonSerializer {
       const [identifier, star, annotation] = this._getPropertyNameAndAnnotation(entityProp)
 
       if (identifier && !type.getProperty(identifier)) {
+        if (identifier === 'DraftAdministrativeData_DraftUUID') continue
         throw new SerializationError(
           "The entity contains data for '" +
             entityProp +
@@ -1042,6 +1043,8 @@ class ResourceJsonSerializer {
   _serializeNullValue (propertyOrReturnType) {
     const nullable = propertyOrReturnType.isNullable()
     if (nullable === undefined || nullable) return null
+    const name = propertyOrReturnType.getName()
+    if (name === 'IsActiveEntity' || name === 'HasActiveEntity' || name === 'HasDraftEntity') return
     throw new SerializationError(
       'Not nullable value ' +
         (propertyOrReturnType.getName ? "for '" + propertyOrReturnType.getName() + "' " : '') +

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-server/utils/UriHelper.js

@@ -83,10 +83,11 @@ class UriHelper {
       const property = keyPropertyRef.getProperty()
       for (const pathElement of keyPropertyRef.getName().split('/')) {
         value = value[pathElement]
-        if (value === undefined) {
+        if (value === undefined && name !== 'IsActiveEntity') {
           throw new IllegalArgumentError(`The key '${pathElement}' does not exist in the given entity`)
         }
       }
+      if (value === undefined && name === 'IsActiveEntity') continue
       value = primitiveValueEncoder.encodeText(value, property)
       keys.push({ type: property.getType(), name, value })
     }

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

@@ -306,9 +306,10 @@ const _getPathInfo = (query, model) => {
   } else {
     returnType = target
     isCollection = Array.isArray(query) || (query.SELECT && !query.SELECT.one)
-    propertyName = !isCollection && last.kind !== 'entity' && last.name
+    propertyName = query._propertyAccess && query.SELECT.columns[0].ref[query.SELECT.columns[0].ref.length - 1]
+    if (propertyName) returnType = query.SELECT.columns[0].ref.reduce((r, c) => r.elements[c], target)
   }
-  const isStream = last['@Core.MediaType']
+  const isStream = propertyName && target.elements[propertyName]?.['@Core.MediaType']
   return {
     path,
     target,

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

@@ -38,6 +38,12 @@ const _getOperationQueryColumns = urlQueryOptions => {
 const _isDraftAction = req => req.event in { draftActivate: 1, EDIT: 1, draftPrepare: 1 }
 const _isActionOrFunction = req => !(req.event in CDS_EVENTS) || _isDraftAction(req)
 const _isWriteWithResponse = req => req.event in WRITE_EVENTS && !(req.event in { CANCEL: 1, DELETE: 1 })
+const _ensureKeysAreSelected = query => {
+  if (!query.SELECT.columns || query.SELECT.columns.some(c => c === '*')) return
+  for (const key in query._target.keys) {
+    if (!query.SELECT.columns.some(c => c.ref?.[0] === key)) query.SELECT.columns.push({ ref: [key] })
+  }
+}
 
 const readAfterWrite = async (req, srv, { operation, isBefore } = { isBefore: false }) => {
   let query
@@ -55,6 +61,7 @@ const readAfterWrite = async (req, srv, { operation, isBefore } = { isBefore: fa
     query = getDeepSelect(req)
   }
   Object.defineProperty(query.SELECT, '_4odata', { value: true })
+  _ensureKeysAreSelected(query)
   // gracefully set location and no body if no read auth or not readable capability
   let result
   try {

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

@@ -108,9 +108,6 @@ const getStreamProperties = (req, model) => {
     // used cloned path
     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 (req._metaInfo && req._metaInfo.propertyName) select.SELECT.from.ref.pop()
-
     const pathToDraft = isPathToDraft(select.SELECT.from.ref, model)
     if (req.target._isDraftEnabled && pathToDraft) {
       select = cqn2cqn4sql(select, model)

package/libx/_runtime/cds-services/services/Service.js

@@ -22,6 +22,9 @@ class ApplicationService extends cds.Service {
     require('../../common/generic/temporal').call(this, this)
     require('../../common/generic/paging').call(this, this) // > paging must be executed before sorting
     require('../../common/generic/sorting').call(this, this)
+
+    if (cds.env.requires.extensibility?.code) require('../../common/code-ext/handlers').call(this, this)
+
     this.registerFioriHandlers(this)
     this.registerPersonalDataHandlers(this)
     this.registerCrudHandlers(this) // default .on handlers, have to go last
@@ -51,26 +54,14 @@ class ApplicationService extends cds.Service {
 
   registerFioriHandlers() {
     if (cds.env.features.lean_draft) {
-      const {
-        onNewDraft,
-        onDraftPrepare,
-        onDraftActivate,
-        onPatch,
-        onDraftEdit,
-        onDelete
-      } = require('../../fiori/lean-draft')
-      const LOG = cds.log('fiori|drafts')
-
-      for (let each of this.entities)
+      const { onNew, onPrepare, onEdit, onCancel } = require('../../fiori/lean-draft')
+
+      for (const each of this.entities)
         if (each.drafts) {
-          LOG.debug('serving drafts for', { entity: each.name })
-          this.on('NEW', each, onNewDraft)
-          this.on('PATCH', each, onPatch)
-          this.on('EDIT', each, onDraftEdit)
-          this.on('draftPrepare', each, onDraftPrepare)
-          this.on('draftActivate', each, onDraftActivate)
-          this.on('draftActivate', each, onDraftActivate)
-          this.on(['CANCEL', 'DELETE'], each, onDelete)
+          this.on('NEW', each.drafts, onNew)
+          this.on('EDIT', each, onEdit)
+          this.on('CANCEL', each.drafts, onCancel)
+          this.on('draftPrepare', each.drafts, onPrepare)
         }
     } else return require('../../fiori/generic').impl.call(this)
   }
@@ -145,4 +136,5 @@ class ApplicationService extends cds.Service {
   }
 }
 
+ApplicationService.prototype.isAppService = true
 module.exports = ApplicationService

package/libx/_runtime/cds-services/services/utils/columns.js

@@ -4,6 +4,8 @@ const LOG = cds.log()
 
 const { DRAFT_COLUMNS_UNION_MAP } = require('../../../common/constants/draft')
 
+const defaultSearchableType = 'cds.String'
+
 // REVISIT: Can we combine that with db/utils/columns.js?
 /**
  * This method gets all columns for an entity.
@@ -43,7 +45,10 @@ const _getSearchableColumns = entity => {
   const columnsOptions = { removeIgnore: true, filterVirtual: true }
   const columns = getColumns(entity, columnsOptions)
   const cdsSearchTerm = '@cds.search'
-  const cdsSearchKeys = Object.keys(entity).filter(key => key.startsWith(cdsSearchTerm))
+  const cdsSearchKeys = []
+  for (const key in entity) {
+    if (key.startsWith(cdsSearchTerm)) cdsSearchKeys.push(key)
+  }
   const cdsSearchColumnMap = new Map()
   let atLeastOneColumnIsSearchable = false
 
@@ -63,9 +68,6 @@ const _getSearchableColumns = entity => {
     cdsSearchColumnMap.set(columnName, annotationValue)
   }
 
-  // For performance reasons, by default, only elements typed as strings are searchable unless
-  // the @cds.search annotation is specified.
-  const defaultSearchableType = 'cds.String'
   const searchableColumns = columns.filter(column => {
     const annotatedColumnValue = cdsSearchColumnMap.get(column.name)
 
@@ -122,44 +124,44 @@ const _getSearchableColumns = entity => {
  * @returns {import('../../../types/api').ColumnRefs}
  */
 const computeColumnsToBeSearched = (cqn, entity = { __searchableColumns: [] }, alias) => {
-  // if there is a group by clause, only columns in it may be searched
-  let toBeSearched =
-    entity.own('__searchableColumns') || entity.set('__searchableColumns', _getSearchableColumns(entity))
-
-  if (cqn.SELECT.groupBy) toBeSearched = toBeSearched.filter(tbs => cqn.SELECT.groupBy.some(gb => gb.ref[0] === tbs))
-  toBeSearched = toBeSearched.map(c => {
-    const col = { ref: [c] }
-    if (alias) col.ref.unshift(alias)
-    return col
-  })
-
-  // add aggregations
-  cqn.SELECT.columns &&
-    cqn.SELECT.columns.forEach(column => {
-      if (column.func) {
-        // exclude $count by SELECT of number of Items in a Collection
-        if (
-          cqn.SELECT.columns.length === 1 &&
-          column.func === 'count' &&
-          (column.as === '_counted_' || column.as === '$count')
-        )
+  let toBeSearched = []
+
+  // aggregations case
+  // in the new parser groupBy is moved to sub select.
+  if (cqn._aggregated || /* new parser */ cqn.SELECT.groupBy || cqn.SELECT?.from?.SELECT?.groupBy) {
+    cqn.SELECT.columns &&
+      cqn.SELECT.columns.forEach(column => {
+        if (column.func) {
+          // exclude $count by SELECT of number of Items in a Collection
+          if (
+            cqn.SELECT.columns.length === 1 &&
+            column.func === 'count' &&
+            (column.as === '_counted_' || column.as === '$count')
+          )
+            return
+
+          toBeSearched.push(column)
           return
-
-        toBeSearched.push(column)
-        return
-      }
-
-      const columnRef = column.ref
-      if (columnRef) {
-        const columnName = columnRef[columnRef.length - 1]
-        const csnColumn = entity.elements[columnName]
-        if (csnColumn) return
-        const col = { ref: [columnName] }
-        if (alias) col.ref.unshift(alias)
-        toBeSearched.push(col)
-      }
+        }
+
+        const columnRef = column.ref
+        if (columnRef) {
+          if (entity.elements[columnRef[columnRef.length - 1]]?._type !== defaultSearchableType) return
+          column = { ref: [...column.ref] }
+          if (alias) column.ref.unshift(alias)
+          toBeSearched.push(column)
+        }
+      })
+  } else {
+    toBeSearched = entity.own('__searchableColumns') || entity.set('__searchableColumns', _getSearchableColumns(entity))
+
+    if (cqn.SELECT.groupBy) toBeSearched = toBeSearched.filter(tbs => cqn.SELECT.groupBy.some(gb => gb.ref[0] === tbs))
+    toBeSearched = toBeSearched.map(c => {
+      const col = { ref: [c] }
+      if (alias) col.ref.unshift(alias)
+      return col
     })
-
+  }
   return toBeSearched
 }
 

package/libx/_runtime/cds-services/util/assert.js

@@ -25,7 +25,6 @@ const ASSERT_FORMAT = 'ASSERT_FORMAT'
 const ASSERT_DATA_TYPE = 'ASSERT_DATA_TYPE'
 const ASSERT_ENUM = 'ASSERT_ENUM'
 const ASSERT_NOT_NULL = 'ASSERT_NOT_NULL'
-const ASSERT_DEEP_ASSOCIATION = 'ASSERT_DEEP_ASSOCIATION'
 
 const _enumValues = element => {
   return Object.keys(element).map(enumKey => {
@@ -221,11 +220,18 @@ const _isNotFilled = value => {
 }
 
 const _checkMandatoryElement = (element, value, errors, key, pathSegments) => {
+  if (element.parent?.query?.SELECT?.columns?.find(col => _isNavigationColumn(col, element.name))) return
   if (element._isMandatory && !element.default && _isNotFilled(value)) {
     errors.push(assertError(ASSERT_NOT_NULL, element, value, key, pathSegments))
   }
 }
 
+const _isNavigationColumn = (column, searched) => {
+  return (
+    column.ref && column.ref.length > 1 && (column.as === searched || column.ref[column.ref.length - 1] === searched)
+  )
+}
+
 const _getEnumElement = element => {
   return (element['@assert.range'] && element.enum) || element['@assert.enum'] ? element.enum : undefined
 }

package/libx/_runtime/common/code-ext/WorkerReq.js

@@ -0,0 +1,81 @@
+const { parentPort } = require('worker_threads')
+const { Responses, Errors } = require('../../../../lib/req/response')
+
+class WorkerReq {
+  constructor(contextId, reqData) {
+    this.contextId = contextId
+    Object.assign(this, reqData)
+    this.postMessages = []
+    this.messages = this.messages ?? []
+    this.errors = this.errors ?? new Errors()
+  }
+
+  #push(args) {
+    this.postMessages.push({
+      kind: 'run',
+      target: 'req',
+      ...args
+    })
+  }
+
+  notify(...args) {
+    this.#push({
+      prop: 'notify',
+      args
+    })
+
+    const notify = Responses.get(1, ...args)
+    this.messages.push(notify)
+    return notify
+  }
+
+  info(...args) {
+    this.#push({
+      prop: 'info',
+      args
+    })
+
+    const info = Responses.get(2, ...args)
+    this.messages.push(info)
+    return info
+  }
+
+  warn(...args) {
+    this.#push({
+      prop: 'warn',
+      args
+    })
+
+    const warn = Responses.get(3, ...args)
+    this.messages.push(warn)
+    return warn
+  }
+
+  error(...args) {
+    this.#push({
+      prop: 'error',
+      args
+    })
+
+    let error = Responses.get(4, ...args)
+    if (!error.stack) Error.captureStackTrace((error = Object.assign(new Error(), error)), this.error)
+    this.errors.push(error)
+    return error
+  }
+
+  reject(...args) {
+    parentPort.postMessage({
+      contextId: this.contextId,
+      kind: 'run',
+      target: 'req',
+      prop: 'reject',
+      args
+    })
+
+    let error = Responses.get(4, ...args)
+    if (!error.stack) Error.captureStackTrace((error = Object.assign(new Error(), error)), this.reject)
+    throw error
+  }
+}
+
+module.exports = WorkerReq

package/libx/_runtime/common/code-ext/config.js

@@ -0,0 +1,13 @@
+const os = require('os')
+const totalMemory = os.totalmem() // total amount of system memory in bytes
+const maxOldGenerationSizeMb = Math.floor(totalMemory / 1024 ** 2 / 8) // max size of the main heap in MB
+const maxYoungGenerationSizeMb = Math.floor(totalMemory / 1024 ** 2 / 8) // max size of a heap space for recently created objects
+
+module.exports = {
+  timeout: 10000,
+  resourceLimits: {
+    maxOldGenerationSizeMb,
+    maxYoungGenerationSizeMb,
+    stackSizeMb: 4 // default
+  }
+}

package/libx/_runtime/common/code-ext/execute.js

@@ -0,0 +1,113 @@
+const cds = require('../../cds')
+const { Worker } = require('worker_threads')
+const path = require('node:path')
+const { timeout, resourceLimits } = require('./config')
+const workerPath = path.resolve(__dirname, 'worker.js')
+const { Errors } = require('../../../../lib/req/response')
+const LOG = cds.log()
+
+const _getReqData = req => {
+  return {
+    data: req.data,
+    params: req.params,
+    results: req.results,
+    messages: req.messages,
+    errors: req.errors ?? new Errors()
+  }
+}
+
+module.exports = async function executeCode(code, req) {
+  const reqData = _getReqData(req)
+  const srv = this
+  const _getTarget = target => {
+    switch (target) {
+      case 'srv':
+        return srv
+
+      case 'req':
+        return req
+
+      // no default
+    }
+  }
+  const workerId = cds.utils.uuid()
+  const contextId = cds.utils.uuid()
+  const worker = new Worker(workerPath, {
+    workerData: { id: workerId },
+    resourceLimits
+  })
+
+  const executePromise = new Promise(function executeCodePromiseExecutor(resolve, reject) {
+    worker.on('online', onStarted)
+    worker.on('message', onMessageReceived)
+    worker.on('error', onError)
+    worker.on('exit', onExit)
+
+    let onStartTimeoutID
+
+    function onStarted() {
+      onStartTimeoutID = setTimeout(() => {
+        worker.terminate()
+        reject(new Error(`Script execution timed out after ${timeout}ms`))
+      }, timeout)
+    }
+
+    function onMessageReceived(message) {
+      if (LOG._debug)
+        LOG.debug(`Post message received on main thread (code-ext/execute.js) from worker thread`, message)
+      switch (message.kind) {
+        case 'run':
+          run(message)
+          return
+
+        case 'success':
+          onSuccess(message)
+          cleanup()
+          return
+
+        case 'error':
+          onError(message.error)
+          return
+
+        // no default
+      }
+    }
+
+    async function onSuccess(message) {
+      for (const m of message.postMessages) await run(m)
+      req.data && Object.assign(req.data, message.req.data) // REVISIT: Why Object.assign(...) is a required?
+      req.results = message.req.results
+      resolve(req.results ?? message.result)
+    }
+
+    function onError(error) {
+      reject(error)
+    }
+
+    function onExit(exitCode) {
+      if (exitCode !== 0) reject(new Error(`Worker thread stopped with exit code ${exitCode}`))
+    }
+
+    async function run(message) {
+      try {
+        let result = _getTarget(message.target)[message.prop](...message.args)
+        if (typeof result?.then === 'function') result = await result
+        if (message.responseData) worker.postMessage({ id: message.id, kind: 'responseData', result })
+      } catch (error) {
+        if (LOG._debug) LOG.debug(`Calling ${message.target}.${message.prop}(...) throws an error.`, error)
+        worker.postMessage({ id: message.id, kind: 'cleanup' })
+        reject(error)
+      }
+    }
+
+    function cleanup() {
+      clearTimeout(onStartTimeoutID)
+      worker.terminate()
+    }
+  })
+
+  // triggers execution of the code in the worker thread
+  const message = { contextId, workerId, kind: 'start', code, reqData }
+  worker.postMessage(message)
+  return executePromise
+}

package/libx/_runtime/common/code-ext/handlers.js

@@ -0,0 +1,49 @@
+const cds = require('../../cds')
+const executeCode = require('./execute')
+
+const CODE_ANNOTATION = '@extension.code'
+
+module.exports = cds.service.impl(function () {
+  const getCodeFromAnnotation = async (defName, operation, registration) => {
+    // REVISIT: tenant info in not in this.model and cds.context.model is undefined for single tenancy
+    const model = cds.context.model || this.model
+    const el = model.definitions[defName]
+    const boundEl = el.actions?.[operation]
+    const extensionCode = boundEl?.[CODE_ANNOTATION] ?? el[CODE_ANNOTATION]
+    if (extensionCode) {
+      const annotation = extensionCode.filter(element => element[registration] === operation)
+      return annotation.length && annotation[0].code
+    }
+  }
+
+  this.after('READ', async function (result, req) {
+    if (result == null) return // whether result is null or undefined
+    const code = await getCodeFromAnnotation(req.target.name, req.event, 'after')
+    if (!code) return
+    await executeCode.call(this, code, req)
+  })
+
+  this.before(['CREATE', 'UPDATE', 'DELETE'], async function (req) {
+    const code = await getCodeFromAnnotation(req.target.name, req.event, 'before')
+    if (!code) return
+    await executeCode.call(this, code, req)
+  })
+
+  this.on('*', async function (req, next) {
+    if (this.name.startsWith('cds.xt')) return next()
+    // REVISIT: req.target -> wait until implementation task finished
+    let fqn = req.target?.actions?.[`${req.event}`] // check for bound action/function
+    if (!fqn) {
+      if (req.target) return next()
+      fqn = this.model.definitions[`${this.name}.${req.event}`] // check for bound action/function or event
+    }
+
+    // REVISIT: DO NOT OVERWRITE EXISTING Action Implementations!
+    // REVISIT: check whether action/function or event is part of an extension
+    if (fqn.kind === 'action' || fqn.kind === 'function' || req.constructor.name === 'EventMessage') {
+      const code = await getCodeFromAnnotation(req?.target?.name ?? fqn.name, req.event, 'on')
+      if (!code) return next()
+      return await executeCode.call(this, code, req)
+    }
+  })
+})