@sap/cds 8.9.4 → 9.0.2

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

@@ -1,64 +0,0 @@
-// don't require okra when using new adapter -> define constants here
-const ENTITY = 'ENTITY'
-const ENTITY_COLLECTION = 'ENTITY.COLLECTION'
-
-const getError = require('../../../../common/error')
-
-const _unboundActionsAndFunctions = { 'ACTION.IMPORT': 1, 'FUNCTION.IMPORT': 1 }
-const _actionsAndFunctions = { ..._unboundActionsAndFunctions, 'BOUND.ACTION': 1, 'BOUND.FUNCTION': 1 }
-
-/**
- * Checks if a custom operation was requested.
- *
- * @param {Array} pathSegments - The uri path segments of the request.
- * @param {boolean} [includingBound] - True if the check should also accept bound operations. Default is true.
- * @returns {boolean} - True if the request targets a custom operation.
- * @private
- */
-const isCustomOperation = (pathSegments, includingBound = true) => {
-  const kind = pathSegments[pathSegments.length - 1].getKind()
-  const kinds = includingBound ? _actionsAndFunctions : _unboundActionsAndFunctions
-  if (kind in kinds) {
-    return kind
-  }
-}
-
-/**
- * Validate resource path length and autoexposed entities.
- * It will throw an error in case the maximum is exceeded or top entity is autoexposed.
- *
- * @param {object} odataReq
- * @param {object} service
- */
-const validateResourcePath = (odataReq, service) => {
-  const segment = odataReq.getUriInfo().getPathSegments()[0]
-  if (segment.getKind() === ENTITY || segment.getKind() === ENTITY_COLLECTION) {
-    const name = segment.getEntitySet().getName()
-    // REVISIT: This validation is violating all principles of locality
-    const entity =
-      service.model.definitions[`${service.definition.name}.${name}`] ||
-      service.model.definitions[`${service.definition.name}.${name.replace(/_texts$/, '.texts')}`]
-    if (!entity) return
-
-    /*
-     * For auto-exposed Compositions all direct CRUD requests are rejected in non-draft case.
-     * For other auto-exposed entities in non-draft case only C_UD are rejected. Direct READ is allowed.
-     * Draft case is an exception. Direct requests are allowed.
-     */
-    if (entity._isDraftEnabled) return
-    if (entity['@cds.autoexposed']) {
-      if (entity['@cds.autoexpose'] && odataReq.getIncomingRequest().method === 'GET') {
-        // combination GET && @cds.autoexposed && @cds.autoexpose is OK
-        return
-      }
-      throw getError(405, entity['@cds.autoexpose'] ? 'ENTITY_IS_AUTOEXPOSE_READONLY' : 'ENTITY_IS_AUTOEXPOSED', [
-        `${service.definition.name}.${name}`
-      ])
-    }
-  }
-}
-
-module.exports = {
-  isCustomOperation,
-  validateResourcePath
-}

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

@@ -1,385 +0,0 @@
-const cds = require('../../../../cds')
-
-const { Readable } = require('stream')
-const { big } = require('@sap/cds-foss')
-
-const getTemplate = require('../../../../common/utils/template')
-const { omitValue, applyOmitValuesPreference } = require('./omitValues')
-const { setLocationHeader } = require('./readAfterWrite')
-const normalizeTimestamp = require('../../../../common/utils/normalizeTimestamp')
-
-const METADATA = {
-  $context: '*@odata.context',
-  $count: '*@odata.count',
-  $etag: '*@odata.etag',
-  $metadataEtag: '*@odata.metadataEtag',
-  $bind: '*@odata.bind',
-  $id: '*@odata.id',
-  $delta: '*@odata.delta',
-  $removed: '*@odata.removed',
-  $type: '*@odata.type',
-  $nextLink: '*@odata.nextLink',
-  $deltaLink: '*@odata.deltaLink',
-  $editLink: '*@odata.editLink',
-  $readLink: '*@odata.readLink',
-  $navigationLink: '*@odata.navigationLink',
-  $associationLink: '*@odata.associationLink',
-  $mediaEditLink: '*@odata.mediaEditLink',
-  $mediaReadLink: '*@odata.mediaReadLink',
-  $mediaContentType: '*@odata.mediaContentType',
-  $mediaContentDispositionFilename: '*@odata.mediaContentDispositionFilename', // > not supported by okra
-  $mediaContentDispositionType: '*@odata.mediaContentDispositionType', // > not supported by okra
-  $mediaEtag: '*@odata.mediaEtag'
-}
-
-const _getPropertyName = req => {
-  const segments = req._.odataReq.getUriInfo().getPathSegments()
-  if (segments[segments.length - 1].getKind().match(/\w*\.PROPERTY$/)) {
-    return segments[segments.length - 1].getProperty().getName()
-  }
-  if (
-    segments[segments.length - 1].getKind() === 'VALUE' &&
-    segments[segments.length - 2].getKind() === 'PRIMITIVE.PROPERTY'
-  ) {
-    return segments[segments.length - 2].getProperty().getName()
-  }
-}
-
-const setStreamingHeaders = (result, req) => {
-  // backwards compatibility for content-type in stream
-  if ('$mediaContentType' in result) result['*@odata.mediaContentType'] = result.$mediaContentType
-  if ('*@odata.mediaContentType' in result) result.$mediaContentType = result['*@odata.mediaContentType']
-  if ('$mediaContentDispositionFilename' in result && req) {
-    const cdt = result.$mediaContentDispositionType || 'attachment'
-    req._.odataRes.setHeader(
-      'content-disposition',
-      `${cdt}; filename="${encodeURIComponent(result.$mediaContentDispositionFilename)}"`
-    )
-  }
-}
-
-const _cleanupMetadata = (odataResult, result, req) => {
-  if (typeof result !== 'object') return odataResult
-
-  setStreamingHeaders(result, req)
-
-  const keysToCleanup = {
-    // do not set "@odata.context" as it may be inherited of remote service
-    $context: true,
-    // REVISIT: okra doesn't support content disposition
-    $mediaContentDispositionFilename: true,
-    $mediaContentDispositionType: true
-  }
-
-  for (const key in METADATA) {
-    if (!(key in result)) continue
-    if (!keysToCleanup[key]) odataResult[METADATA[key]] = result[key]
-    delete result[key]
-  }
-
-  return odataResult
-}
-
-/**
- * Convert any result to the result object structure, which is expected of odata-v4.
- *
- * @param {*} result
- * @param {*} [req]
- * @returns {string | object}
- */
-const toODataResult = (result, req) => {
-  if (result == null) return ''
-
-  let propertyName, isStream, isCollection
-  if (req) {
-    if (cds.env.features.odata_new_parser) {
-      propertyName = req._metaInfo.propertyName
-      isStream = req._metaInfo.isStream
-      isCollection = req._metaInfo.isCollection
-    } else {
-      propertyName = _getPropertyName(req)
-      isStream =
-        req._.odataReq.getUriInfo().getLastSegment().getProperty() &&
-        req._.odataReq.getUriInfo().getLastSegment().getProperty().getType().toString() === 'Edm.Stream'
-
-      isCollection =
-        !propertyName &&
-        !(req.event in { NEW: 1, CREATE: 1, UPDATE: 1, UPSERT: 1, EDIT: 1, PATCH: 1 }) &&
-        req._.odataReq.getUriInfo().getLastSegment().isCollection()
-    }
-  }
-
-  if (isCollection && !Array.isArray(result)) result = [result]
-  else if (!isCollection && Array.isArray(result)) result = result[0]
-
-  let value = result
-  if (typeof result === 'object') {
-    if (cds.env.features.stream_compat) {
-      // REVISIT: test implicit streaming with null value
-      if ('value' in result && (result.value instanceof Readable || isStream)) value = result.value
-      else if (propertyName) value = result[propertyName]
-    } else {
-      if (propertyName && result[propertyName] !== undefined) {
-        value = result[propertyName]
-      }
-      // implicit streaming
-      else if (req._.odataReq.getUriInfo().getLastSegment().getKind() === 'VALUE') {
-        const property = Object.values(req.target.elements).find(
-          el => el.type === 'cds.LargeBinary' && result[el.name] !== undefined
-        )
-        value = property && result[property.name]
-      }
-      // result.value can be obtained from custom handlers
-      else if (isStream && result.value !== undefined) {
-        value = result.value
-      }
-    }
-  }
-
-  const odataResult = _cleanupMetadata({ value }, result, req)
-
-  const { metadata } = _getOptions(req)
-  if (cds.env.features.odata_new_parser && metadata !== 'none') {
-    return _setContext(odataResult, req, isCollection)
-  }
-
-  return odataResult
-}
-
-const _setContext = (odataResult, req, isCollection) => {
-  if (req && req._metaInfo) {
-    const result = isCollection ? odataResult : odataResult.value
-    if (result != null) Object.assign(result, { [METADATA.$context]: req._metaInfo.contextUrl })
-  }
-  return odataResult
-}
-
-const addEtags = (row, key) => {
-  row['*@odata.etag'] = row[key]
-}
-
-const convertDecimal = (row, key, options) => {
-  const bigValue = big(row[key])
-  row[key] = options.decimals.exponential ? bigValue.toExponential() : bigValue.toFixed()
-}
-
-const addAssociationToRow = (row, foreignKey, foreignKeyElement) => {
-  const assocName = foreignKeyElement._foreignKey4
-  const assoc = foreignKeyElement.parent.elements[assocName]
-
-  if (!row[assocName]) {
-    row[assocName] = {}
-  }
-
-  const keyOfAssociatedEntity = foreignKey.replace(`${assocName}_`, '')
-
-  // REVISIT: structured keys, see xtests in structured-x4
-  const assocTargetKey = assoc._target.keys[keyOfAssociatedEntity]
-  if (assocTargetKey && assocTargetKey._foreignKey4) {
-    // assoc as key
-    row[assocName][keyOfAssociatedEntity] = row[foreignKey]
-    delete row[foreignKey]
-    addAssociationToRow(row[assocName], keyOfAssociatedEntity, assoc._target.keys[keyOfAssociatedEntity])
-    return
-  }
-
-  // foreign key null or undefined, set assoc to null
-  if (row[foreignKey] == null) {
-    row[assocName] = null
-    delete row[foreignKey]
-    return
-  }
-
-  if (row[assocName][keyOfAssociatedEntity] === undefined) {
-    row[assocName][keyOfAssociatedEntity] = row[foreignKey]
-  }
-
-  delete row[foreignKey]
-}
-
-const localizeAfterDraftActivate = (row, key, locale) => {
-  if (row.texts && Object.prototype.hasOwnProperty.call(row, key)) {
-    const texts = row.texts.filter(t => t.locale === locale)[0]
-    if (texts && texts[key]) row[key] = texts[key]
-  }
-}
-
-const _processCategory = (req, category, elementInfo, options, previousResult) => {
-  const { row, key, element } = elementInfo
-
-  switch (category) {
-    case '@odata.omitValues':
-      omitValue(elementInfo, req, options.omitValuesPreference, previousResult)
-      break
-
-    case '@odata.etag':
-      addEtags(row, key)
-      break
-
-    case '@cds.Decimal':
-      if (options.decimals && row[key]) convertDecimal(row, key, options)
-      break
-
-    case 'foreignKey':
-      addAssociationToRow(row, key, element)
-      break
-
-    case '@cleanup':
-      if (key !== 'DraftAdministrativeData_DraftUUID') delete row[key]
-      break
-
-    case 'localizeAfterDraftActivate':
-      localizeAfterDraftActivate(row, key, req.locale)
-      break
-
-    case '@cds.Boolean':
-      if (row[key] != null) row[key] = !!row[key]
-      break
-
-    // no default
-  }
-}
-
-const _processorFn = (req, previousResult, options) => elementInfo => {
-  const { row, key, plain } = elementInfo
-  if (typeof row !== 'object' || !Object.prototype.hasOwnProperty.call(row, key)) return
-  const categories = plain.categories
-
-  for (const category of categories) {
-    _processCategory(req, category, elementInfo, options, previousResult)
-  }
-}
-
-const _isUpAssoc = element => element && /^up_(_up_)*$/.test(element.name) && _isContainedOrBackLink(element)
-
-const _isContainedOrBackLink = element =>
-  element &&
-  element.isAssociation &&
-  element.keys &&
-  (element._isContained || (element._anchor && element._anchor._isContained))
-
-const _assocs = (element, target) => {
-  const assocName = element._foreignKey4
-  const assoc = assocName && target.elements[assocName]
-
-  if (cds.env.effective.odata.refs) {
-    // expand assoc keys except of up_ backlinks
-    if (assoc && !_isUpAssoc(assoc)) {
-      return ['foreignKey']
-    }
-
-    if (element['@odata.containment.ignore']) {
-      return ['@cleanup']
-    }
-  }
-
-  if (_isContainedOrBackLink(assoc)) {
-    return ['@cleanup']
-  }
-
-  return []
-}
-
-const _pick = options => (element, target) => {
-  const categories = []
-
-  if (element['@odata.etag']) categories.push('@odata.etag')
-  if (element._type === 'cds.Decimal') categories.push('@cds.Decimal')
-  if (element._type === 'cds.Timestamp') categories.push('@cds.Timestamp')
-  if (cds.db?.cqn2sql && element._type === 'cds.Boolean') categories.push('@cds.Boolean') // REVISIT: violates modularization -> do we still need that?
-
-  categories.push(..._assocs(element, target))
-
-  // REVISIT: It makes no sense to store static values inside the template, it would just
-  // blow up the memory of the template.
-  // For operations concering _all_ elements, the templating mechanism doesn't make sense
-  // and should not be used.
-  if (options.omitValuesPreference) categories.push('@odata.omitValues')
-  if (options.event === 'draftActivate' && options.locale && options.locale !== 'en' && element.localized === true) {
-    categories.push('localizeAfterDraftActivate')
-  }
-
-  if (categories.length) return { categories }
-}
-
-const _getOptions = req => {
-  if (!req) return {}
-  const { headers, locale, event } = req
-  const options = {
-    decimals: null,
-    omitValuesPreference: null,
-    locale,
-    event,
-    metadata: 'minimal'
-  }
-
-  if (!headers) return options
-
-  // REVISIT: options ie headers are not used in _pick since its cached
-  // consequently, all decimals are always picked even w/o these headers
-  const acceptHeader = headers.accept
-
-  if (acceptHeader && acceptHeader.includes('IEEE754Compatible=true')) {
-    options.decimals = { exponential: acceptHeader.includes('ExponentialDecimals=true') }
-  }
-
-  const metadataMatch = acceptHeader && acceptHeader.match(/metadata=(minimal|full|none)/)
-  if (metadataMatch) options.metadata = metadataMatch[1]
-
-  const preferHeader = headers.prefer
-
-  if (preferHeader && preferHeader.includes('omit-values=')) {
-    options.omitValuesPreference = new Map()
-  }
-
-  return options
-}
-
-const _generateCacheKey = (headers, options) => {
-  let key = 'postProcess' // default template cache key for post processing
-  if (headers.prefer) key += `:${headers.prefer}`
-  if (options.decimals) key += `:ExponentialDecimals=true`
-  if (options.event === 'draftActivate' && options.locale) key += `:locale=${options.locale}`
-  return key
-}
-
-const postProcess = (req, res, service, result, previousResult) => {
-  const { model } = service
-  const { headers, target } = req
-
-  if (!target || !result || !model || !model.definitions[target.name]) return
-
-  const options = _getOptions(req)
-  const cacheKey = _generateCacheKey(headers, options)
-  // REVISIT: Why so many templates? -> Create only one (superset) template to reduce memory consumption
-  const template = getTemplate(cacheKey, service, target, { pick: _pick(options) })
-
-  if (template.elements.size === 0) return
-
-  // normalize result to rows
-  result = result.value != null && Object.keys(result).filter(k => !k.match(/^\W/)).length === 1 ? result.value : result
-  template.process(result, _processorFn(req, previousResult, options))
-
-  applyOmitValuesPreference(res, options.omitValuesPreference)
-}
-
-const postProcessMinimal = (req, service, result) => {
-  const { target, timestamp } = req
-  if (!target || !result) return
-
-  setLocationHeader(req, service)
-
-  const etag = target._etag && target._etag.name
-  if (etag && etag in result) {
-    return { '*@odata.etag': result[etag] === '$now' ? normalizeTimestamp(timestamp) : result[etag] }
-  }
-
-  return null
-}
-
-module.exports = {
-  toODataResult,
-  postProcess,
-  postProcessMinimal,
-  setStreamingHeaders
-}

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

@@ -1,12 +0,0 @@
-const isStreaming = segments => {
-  const lastSegment = segments[segments.length - 1]
-  return (
-    segments.length > 1 &&
-    lastSegment.getKind() === 'PRIMITIVE.PROPERTY' &&
-    lastSegment.getProperty().getType().getName() === 'Stream'
-  )
-}
-
-module.exports = {
-  isStreaming
-}

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

@@ -1,15 +0,0 @@
-const getError = require('../../common/error')
-
-const getModelNotDefinedError = modelName => {
-  return new Error(`No valid model provided. Invalid model: ${JSON.stringify(modelName)}`)
-}
-
-// REVISIT: use i18n
-const getFeatureNotSupportedError = message => {
-  return getError(501, `Feature is not supported: ${message}`)
-}
-
-module.exports = {
-  getModelNotDefinedError,
-  getFeatureNotSupportedError
-}

package/libx/_runtime/common/aspects/relation.js

@@ -1,40 +0,0 @@
-const { getOnCond } = require('../utils/generateOnCond')
-
-let initializing = false
-
-module.exports = class Relation {
-  constructor(csn, path = []) {
-    if (!initializing) throw new Error(`Do not new a relation, use 'Relation.to()' instead`)
-    Object.defineProperty(this, 'csn', { get: () => csn })
-    Object.defineProperty(this, 'path', {
-      get: () => path,
-      set: _ => {
-        path = _
-      }
-    })
-    if (csn.target) Object.defineProperty(this, 'target', { get: () => csn.target })
-    initializing = false
-  }
-
-  static to(from, name) {
-    initializing = true
-    if (!name) return new Relation(from)
-    return from._elements[name] && new Relation(from._elements[name], [...from.path, name])
-  }
-
-  _has(prop) {
-    return Reflect.has(this, prop)
-  }
-
-  get _elements() {
-    if (this.csn.elements) return this.csn.elements
-    if (this.csn._target && this.csn._target.elements) return this.csn._target.elements
-    // if (csn.targetAspect) relation.elements = model.definitions[csn.targetAspect].elements
-    // if (csn.kind = 'type') relation.elements = model.definitions[csn.type].element
-    return {}
-  }
-
-  join(fromAlias = '', toAlias = '') {
-    return getOnCond(this.csn, this.path, { select: fromAlias, join: toAlias })
-  }
-}