@sap/cds 8.9.4 → 9.0.2

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

@@ -1,331 +0,0 @@
-const cds = require('../../../../cds')
-
-const {
-  Components: { DATA_DELETE_HANDLER, DATA_READ_HANDLER, DATA_CREATE_HANDLER, DATA_UPDATE_HANDLER }
-} = require('../okra/odata-server')
-
-const { findCsnTargetFor } = require('../../../../common/utils/csn')
-const { convertStructured } = require('../../../../common/utils/ucsn')
-const { deepCopy } = require('../../../../common/utils/copy')
-const { getSegmentKeyValue } = require('../odata-to-cqn/utils')
-const { MULTIPLE_ERRORS } = require('../../../../common/error/constants')
-
-const _isFunctionInvocation = odataReq =>
-  odataReq.getUriInfo().getLastSegment().getFunction() || odataReq.getUriInfo().getLastSegment().getFunctionImport()
-
-const _addStructuredProperties = ([structName, property, ...nestedProperties], paramData, value) => {
-  paramData[structName] = paramData[structName] || {}
-  if (nestedProperties.length) {
-    _addStructuredProperties([property, ...nestedProperties], paramData[structName], value)
-    return
-  }
-
-  paramData[structName][property] = value
-}
-
-/**
- * The key predicates or function parameters will contain the keys and values for this request.
- * Combine all key value pairs into one object.
- *
- * @param parameters
- * @returns {object}
- * @private
- */
-const _getParamData = parameters => {
-  const paramData = {}
-
-  for (const segmentParam of parameters) {
-    const { keyName, val } = getSegmentKeyValue(segmentParam)
-
-    if (keyName.includes('/')) {
-      _addStructuredProperties(keyName.split('/'), paramData, val)
-      continue
-    }
-
-    paramData[keyName] = val
-  }
-
-  return paramData
-}
-const _flattenStructureKeys = structureData => {
-  const result = {}
-  for (const prop in structureData) {
-    if (typeof structureData[prop] === 'object') {
-      const nested = _flattenStructureKeys(structureData[prop])
-      for (const key in nested) {
-        result[prop + '_' + key] = nested[key]
-      }
-    } else {
-      result[prop] = structureData[prop]
-    }
-  }
-  return result
-}
-// works only for custom on condition working on keys with '=' operator
-// and combination of multiple conditions connected with 'and'
-const _addKeysToData = (navSourceKeyValues, onCondition, data) => {
-  if (onCondition[0].xpr) {
-    // REVISIT support for nested xpr?
-    return _addKeysToData(navSourceKeyValues, onCondition[0].xpr, data)
-  }
-
-  const flattenKeys = _flattenStructureKeys(navSourceKeyValues)
-  for (const key in flattenKeys) {
-    // find index of source column
-    const sourceIndex = onCondition.findIndex(e => e.ref && e.ref[0] === 'source' && e.ref[1] === key)
-    if (sourceIndex === -1) {
-      if (key === 'IsActiveEntity') {
-        data[key] = false
-      }
-      // if key is not part of on condition, it must not be added
-    } else {
-      // if '=' follows on index, the target columns comes next
-      const {
-        ref: [, target]
-      } = onCondition[sourceIndex + 1] === '=' ? onCondition[sourceIndex + 2] : onCondition[sourceIndex - 2]
-      data[target] = flattenKeys[key]
-    }
-  }
-
-  // get static values from onCond
-  for (let i = 0; i < onCondition.length; i++) {
-    const first = onCondition[i]
-    const compare = onCondition[i + 1]
-    const second = onCondition[i + 2]
-
-    if (compare !== '=') continue
-
-    if (first && first.ref && second && 'val' in second) {
-      // ref = val
-      _staticOnCond(data, first, second)
-      i += 2
-    } else if (second && second.ref && first && 'val' in first) {
-      // val = ref
-      _staticOnCond(data, second, first)
-      i += 2
-    }
-  }
-}
-
-const _staticOnCond = (data, ref, val) => {
-  const {
-    ref: [alias, target]
-  } = ref
-  if (alias != 'target') return
-  data[target] = val.val
-}
-
-function _entityOrTypeName(navSourceSegment) {
-  // if navigation has more than 2 segments, the precessor is a naviation and we must use .getTarget
-  if (navSourceSegment.getKind() === 'COMPLEX.PROPERTY') {
-    return navSourceSegment.getProperty().getType().getFullQualifiedName()
-  }
-
-  // TODO do it similar for both cases below?
-  return (
-    navSourceSegment.getEntitySet()
-      ? navSourceSegment.getEntitySet()
-      : navSourceSegment.getNavigationProperty() || navSourceSegment.getSingleton()
-  )
-    .getEntityType()
-    .getFullQualifiedName()
-}
-
-const _addForeignKeys = (service, odataReq, data) => {
-  const pathSegments = odataReq.getUriInfo().getPathSegments()
-  // retrieve keys/values from the path segment representing the navigation source
-  const navSourceSegment = pathSegments[pathSegments.length - 2]
-  const navSourceKeyValues = _getParamData(navSourceSegment.getKeyPredicates())
-
-  // retrieve relevant foreign key properties of the target entity, including the corresponding source key properties
-  const navProperty = odataReq.getUriInfo().getLastSegment().getNavigationProperty()
-
-  // REVISIT: cannot be removed yet because of navigation of draft to non draft would add IsActiveEntity to .data
-  if (navProperty.getPartner() && navProperty.getPartner().getReferentialConstraints().size) {
-    const refConstraints = navProperty.getPartner().getReferentialConstraints()
-
-    // set value of foreign key properties as specified in the navigation source segment
-    for (const key in navSourceKeyValues) {
-      const refConstraint = [...refConstraints].find(r => r[1].constraint.referencedProperty === key)
-      // exclude source keys if they cannot be matched (e.g. isActiveEntity in draft scenario)
-      if (refConstraint) {
-        data[refConstraint[0]] = navSourceKeyValues[key]
-      }
-    }
-  } else {
-    const { name, namespace } = _entityOrTypeName(navSourceSegment)
-    const def = findCsnTargetFor(name, service.model, namespace)
-    const onCondition = def._relations[navProperty.getName()].join('target', 'source')
-    _addKeysToData(navSourceKeyValues, onCondition, data)
-  }
-}
-
-const _getFunctionParameters = (lastSegment, keyValues, service, target) => {
-  const functionParameters = lastSegment.getFunctionParameters()
-  const paramValues = _getParamData(functionParameters)
-
-  // Working assumption for the case of name collisions: take the entity's key
-  for (const key in keyValues) paramValues[key] = keyValues[key]
-
-  const errors = []
-  if (lastSegment.getKind() === 'BOUND.FUNCTION') {
-    const targetFunction = target && target.actions && target.actions[lastSegment.getFunction().getName()]
-    if (!targetFunction.params) return {}
-    convertStructured(service, targetFunction, paramValues, { errors })
-  } else if (lastSegment.getKind() === 'FUNCTION.IMPORT') {
-    const { namespace, name } = lastSegment.getFunctionImport().getFullQualifiedName()
-    const targetFunction = service.model && service.model.definitions[`${namespace}.${name}`]
-    if (!targetFunction.params) return {}
-    convertStructured(service, targetFunction, paramValues, { errors })
-  }
-
-  if (errors.length > 1) throw Object.assign(new Error(MULTIPLE_ERRORS), { details: errors })
-  if (errors.length === 1) throw errors[0]
-
-  return paramValues
-}
-
-const _getCopiedData = (odataReq, segments, service, target) => {
-  const lastSegment = segments[segments.length - 1]
-
-  let data = odataReq.getBody() || {}
-
-  if (lastSegment.getKind() === 'PRIMITIVE.PROPERTY') {
-    data = { [lastSegment.getProperty().getName()]: data }
-    if (cds.env.effective.odata.structs) {
-      for (let i = segments.length - 2; i >= 0; i--) {
-        const segment = segments[i]
-        if (segment.getKind() === 'COMPLEX.PROPERTY') {
-          const name = segment.getProperty().getName()
-          data = { [name]: data }
-        } else break
-      }
-    }
-  } else {
-    data = deepCopy(data)
-    if (lastSegment.getKind() === 'BOUND.ACTION') {
-      const targetAction = target.actions && target.actions[lastSegment.getAction().getName()]
-      if (!targetAction || !targetAction.params) return { data: {} }
-      convertStructured(service, targetAction, data)
-    } else if (lastSegment.getKind() === 'ACTION.IMPORT') {
-      const { namespace, name } = lastSegment.getActionImport().getFullQualifiedName()
-      const targetAction = service.model && service.model.definitions[`${namespace}.${name}`]
-      if (!targetAction || !targetAction.params) return { data: {} }
-      convertStructured(service, targetAction, data)
-    } else {
-      convertStructured(service, target, data)
-    }
-  }
-
-  return data
-}
-
-/**
- * Gets a deep copy of the request payload, preserving the original payload.
- *
- * READ and DELETE work are retrieved from URL; CREATE and UPDATE from body.
- * For function invocations the URL parameters are set as data.
- * For CREATE and UPDATE annotated columns can be mixed in.
- *
- * @param {string} component - odata-v4 component which processes this request
- * @param {import('../okra/odata-server/core/OdataRequest')} odataReq - OKRA's req
- * @param {import('../../../../common/Service')} service - Service, which will process this request
- * @returns {object | Array}
- * @private
- */
-const getData = (component, odataReq, service, target) => {
-  const segments = odataReq.getUriInfo().getPathSegments()
-  const lastSegment = odataReq.getUriInfo().getLastSegment()
-  const keyPredicates =
-    lastSegment.getKind() === 'PRIMITIVE.PROPERTY'
-      ? segments[segments.length - 2].getKeyPredicates()
-      : lastSegment.getKeyPredicates()
-  const keyValues = _getParamData(keyPredicates)
-
-  if (component === DATA_READ_HANDLER && _isFunctionInvocation(odataReq)) {
-    return _getFunctionParameters(lastSegment, keyValues, service, target)
-  }
-
-  if (component === DATA_DELETE_HANDLER || component === DATA_READ_HANDLER) {
-    if (component === DATA_DELETE_HANDLER && lastSegment.getKind() === 'PRIMITIVE.PROPERTY') {
-      return Object.assign(keyValues, { [lastSegment.getProperty().getName()]: null })
-    }
-    return keyValues
-  }
-
-  // copy so that original payload is preserved
-  const data = _getCopiedData(odataReq, segments, service, target)
-
-  // Only to be done for post via navigation
-  if (
-    component === DATA_CREATE_HANDLER &&
-    (lastSegment.getKind() === 'NAVIGATION.TO.MANY' || lastSegment.getKind() === 'NAVIGATION.TO.ONE')
-  ) {
-    _addForeignKeys(service, odataReq, data)
-  }
-
-  // Only to be done for patch via navigation
-  // TODO: revert with new CQN
-  if (component === DATA_UPDATE_HANDLER && lastSegment.getKind() === 'NAVIGATION.TO.ONE') {
-    _addForeignKeys(service, odataReq, data)
-  }
-
-  // prefer identifier from URL
-  if (keyValues) {
-    Array.isArray(data) ? Object.assign(data[0], keyValues) : Object.assign(data, keyValues)
-  }
-
-  return data
-}
-
-const _getParamsAsIterableObject = req => {
-  const params = {
-    *[Symbol.iterator]() {
-      for (const e in this) {
-        yield this[e].ID && Object.keys(this[e]).length === 1 ? this[e].ID : this[e]
-      }
-    }
-  }
-
-  const segments = [...req.getUriInfo().getPathSegments()]
-  let next = segments.shift()
-  let psi = ''
-  while (next) {
-    psi += next.getPathSegmentIdentifier()
-    const keyPredicates = next.getKeyPredicates()
-    keyPredicates.length > 0 && (params[psi] = _getParamData(keyPredicates))
-    psi += '/'
-    next = segments.shift()
-  }
-
-  return params
-}
-
-const _getParamsAsArray = req => {
-  const params = []
-
-  const segments = [...req.getUriInfo().getPathSegments()]
-  let next = segments.shift()
-  while (next) {
-    const keyPredicates = next.getKeyPredicates()
-    if (keyPredicates.length > 0) {
-      const param = _getParamData(keyPredicates)
-      params.push(param.ID && Object.keys(param).length === 1 ? param.ID : param)
-    }
-    next = segments.shift()
-  }
-
-  return params
-}
-
-const getParams = req => {
-  if (process.env.CDS_FEATURES_PARAMS) {
-    return _getParamsAsIterableObject(req)
-  }
-  return _getParamsAsArray(req)
-}
-
-module.exports = {
-  getData,
-  getParams
-}

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

@@ -1,159 +0,0 @@
-const cds = require('../../../../cds')
-const { isCustomOperation } = require('./request')
-// don't require okra when using new adapter -> define constants here
-const COMPLEX_PROPERTY = 'COMPLEX.PROPERTY'
-const PRIMITIVE_PROPERTY = 'PRIMITIVE.PROPERTY'
-const { DRAFT_COLUMNS_MAP } = require('../../../../common/constants/draft')
-const { SELECT } = cds.ql
-
-const _keysOf = (row, target) => {
-  const keyElements = Object.values(target.keys || {}).filter(v => !v.virtual)
-  // > singleton
-  if (!keyElements.length) return
-  const keys = {}
-  for (const key of keyElements) {
-    if (key._isAssociationStrict) continue
-    if (row[key.name] === undefined) continue // key is not in data, so ignore it
-    keys[key.name] = key.elements ? { val: JSON.stringify(row[key.name]) } : row[key.name]
-  }
-  return keys
-}
-
-const getSimpleSelectCQN = (target, data, columns) => {
-  const keys = _keysOf(data, target)
-  // don't use `ql.where()` to get `where` in `from` for location header
-  const cqn = keys ? SELECT.one(target, keys) : /* singleton */ SELECT.one(target)
-
-  if (columns) {
-    cqn.columns(...columns)
-  }
-
-  if (target.query && target.query.SELECT && target.query.SELECT.orderBy) {
-    cqn.SELECT.orderBy = target.query.SELECT.orderBy
-  }
-
-  return cqn
-}
-
-/*
- * merge CQNs
- */
-const _mergeExpandCQNs = cqns => {
-  const cols = cqns[0].SELECT.columns
-  for (const cqn of cqns.slice(1)) {
-    for (const col of cqn.SELECT.columns) {
-      if (!col.expand) continue
-      const idx = cols.findIndex(ele => {
-        if (!col.ref) return
-        if (ele.ref) return ele.ref[0] === col.ref[0]
-        if (ele.as) return ele.as === col.ref[0]
-      })
-      if (idx === -1) {
-        cols.push(col)
-      } else {
-        const colExists = cols[idx]
-        if (colExists.as && colExists.val === null) {
-          cols[idx] = col
-          continue
-        }
-        if (col.as && col.val === null) continue
-        const mergedExpandCQN = _mergeExpandCQNs([
-          { SELECT: { columns: colExists.expand } },
-          { SELECT: { columns: col.expand } }
-        ])
-        colExists.expand = mergedExpandCQN.SELECT.columns
-      }
-    }
-  }
-  return cqns[0]
-}
-
-const _getExpandColumn = (data, element) => {
-  const key = element.name
-  if (!(key in data)) return
-  data = data[key]
-  if ((Array.isArray(data) && data.length === 0) || data == null) {
-    // performance tweak, keep in mind it is only for compositions
-    return { val: null, as: key }
-  }
-  const cqn = Array.isArray(data)
-    ? _mergeExpandCQNs(data.map(data => getDeepSelect({ target: element._target, data })))
-    : getDeepSelect({ target: element._target, data })
-  return { ref: [key], expand: cqn.SELECT.columns }
-}
-
-const _getColumns = (target, data, prefix = []) => {
-  const columns = []
-  for (const each in target.elements) {
-    if (target.elements[each]['@cds.api.ignore']) continue
-    if (each in DRAFT_COLUMNS_MAP) continue
-    if (!cds.env.features.stream_compat && target.elements[each].type === 'cds.LargeBinary') continue
-    const element = target.elements[each]
-    if (element.elements && data[each]) {
-      prefix.push(element.name)
-      columns.push(..._getColumns(element, data[each], prefix))
-      prefix.pop()
-    } else if (element.isComposition && !prefix.length) {
-      const col = _getExpandColumn(data, element, prefix)
-      if (col) columns.push(col)
-    } else if (!element.isAssociation) {
-      columns.push({ ref: [...prefix, each] })
-    }
-  }
-  return columns
-}
-
-/*
- * recursively builds a select cqn for deep read after write
- * (depth determined by req.data)
- */
-const getDeepSelect = req => {
-  let { target, data } = req
-  const columns = _getColumns(target, data)
-  return getSimpleSelectCQN(target, data, columns)
-}
-
-const getActionOrFunctionReturnType = (pathSegments, definitions) => {
-  if (!isCustomOperation(pathSegments, true)) return
-
-  const actionOrFunction =
-    pathSegments[pathSegments.length - 1].getFunction() || pathSegments[pathSegments.length - 1].getAction()
-
-  if (actionOrFunction) {
-    const returnType = actionOrFunction.getReturnType()
-    if (returnType) {
-      return definitions[returnType.getType().getFullQualifiedName().toString()]
-    }
-  }
-}
-
-const resolveStructuredName = (pathSegments, index, nameArr = []) => {
-  if (pathSegments[index].getKind() === COMPLEX_PROPERTY) {
-    const prop = pathSegments[index].getProperty()
-    nameArr.unshift(prop.getName())
-    return resolveStructuredName(pathSegments, --index, nameArr)
-  } else if (
-    pathSegments[index].getKind() === PRIMITIVE_PROPERTY &&
-    pathSegments[index - 1].getKind() === COMPLEX_PROPERTY
-  ) {
-    return resolveStructuredName(pathSegments, --index, nameArr)
-  }
-
-  return nameArr
-}
-
-const isReturnMinimal = req => {
-  if (!req.headers.prefer || !req.headers.prefer.includes('return=')) {
-    return cds.env.odata.prefer && cds.env.odata.prefer.return === 'minimal'
-  }
-
-  return req.headers.prefer.includes('return=minimal')
-}
-
-module.exports = {
-  resolveStructuredName,
-  getActionOrFunctionReturnType,
-  isReturnMinimal,
-  getDeepSelect,
-  getSimpleSelectCQN
-}