@sap/cds 8.9.4 → 9.0.3

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-server/invocation/DispatcherCommand.js

@@ -1,95 +0,0 @@
-'use strict'
-
-const cds = require('../../../../../../cds')
-
-const commons = require('../../odata-commons')
-const RepresentationKinds = commons.format.RepresentationKind.Kinds
-const MetaProperties = commons.format.JsonFormat.MetaProperties
-const Command = require('./Command')
-
-/**
- * The `next` callback to be called upon finish execution.
- *
- * @callback Next
- * @param {?Error} error An error if there is one or null if not
- */
-
-/**
- * Executes the request dispatching.
- *
- * @extends Command
- */
-class DispatcherCommand extends Command {
-  /**
-   * Creates an instance of DispatcherCommand.
-   *
-   * @param {OdataRequest} request the current OData request
-   * @param {OdataResponse} response the current OData response
-   * @param {?MetadataCache} metadataCache the metadata cache
-   * @param {ComponentManager} componentManager The current component manager instance
-   * @param {Dispatcher} dispatcher The current dispatcher
-   * @param {LoggerFacade} logger the logger
-   */
-  constructor (request, response, metadataCache, componentManager, dispatcher, logger) {
-    super()
-    this._request = request
-    this._response = response
-    this._metadataCache = metadataCache
-    this._componentManager = componentManager
-    this._dispatcher = dispatcher
-    this._logger = logger
-  }
-
-  /**
-   * Executes the registered request dispatcher
-   *
-   * @param {Next} next The next callback to be called on finish
-   */
-  execute (next) {
-    const contract = this._response.getContract()
-    const locale = contract.getLocale()
-    // If $metadata is requested and a locale is set, the locale-specific metadata document should be cached
-    const isLocaleSpecificMetadataRequest = contract.getRepresentationKind() === RepresentationKinds.METADATA && locale
-    const cachedMetadata = isLocaleSpecificMetadataRequest
-      ? this._metadataCache.get(contract.getContentTypeInfo().getMimeType(), locale)
-      : null
-
-    if (cachedMetadata) {
-      this._response.setBody({ value: cachedMetadata.metadata, [MetaProperties.ETAG]: cachedMetadata.etag })
-      this._request.validateEtag(cachedMetadata.etag)
-      next()
-    } else {
-      this._dispatcher
-        .dispatch(this._request, this._response, this._componentManager)
-        .then(result => {
-          if (
-            isLocaleSpecificMetadataRequest &&
-            result.data !== null &&
-            result.data !== undefined &&
-            result.data.value !== null &&
-            result.data.value !== undefined
-          ) {
-            const metadataEtag = this._metadataCache.set(
-              contract.getContentTypeInfo().getMimeType(),
-              locale,
-              result.data.value
-            )
-            if (!this._metadataCache.get(contract.getContentTypeInfo().getMimeType(), locale)) {
-              this._logger.info(
-                'Metadata size exceeds cache boundary. Use cds option odata.metadataCacheLimit to increase the cache size.'
-              )
-            }
-            this._request.validateEtag(metadataEtag)
-            let data = result.data
-            data[MetaProperties.ETAG] = metadataEtag
-          }
-
-          this._response.setBody(result.data).setOdataOptions(result.options)
-          next()
-        })
-        .catch(next)
-    }
-  }
-}
-
-module.exports = DispatcherCommand

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-server/invocation/ErrorContentNegotiatorCommand.js

@@ -1,44 +0,0 @@
-'use strict'
-
-const commons = require('../../odata-commons')
-const ContentTypes = commons.format.ContentTypeInfo.ContentTypes
-const RepresentationKinds = commons.format.RepresentationKind.Kinds
-const ContentNegotiatorCommand = require('./ContentNegotiatorCommand')
-
-/**
- * The `next` callback to be called upon finish execution.
- * @callback Next
- * @param {?Error} error An error if there is one or null if not
- */
-
-/**
- * Executes the content negotiation in case of an error.
- * @extends ContentNegotiatorCommand
- */
-class ErrorContentNegotiatorCommand extends ContentNegotiatorCommand {
-  /**
-   * Executes the content negotiation in error mode. The content negotiation creates a `ResponseContract` object
-   * as a result with all necessary content negotiation information. The contract object is
-   * attached to the odata context instance.
-   *
-   * @param {Next} next The next callback to be called on finish
-   */
-  execute (next) {
-    const formatManager = super.getFormatManager()
-    const negotiator = super.getNegotiator()
-    let contract = null
-    try {
-      this._logger.debug('Try to execute default content type negotiation...')
-      contract = negotiator.negotiate(formatManager, this._request)
-    } catch (error) {
-      this._logger.debug('... Error content type negotiation failed')
-      this._logger.debug('Execute content type negotation for', "'" + ContentTypes.JSON + "'")
-      contract = negotiator.negotiateContentType(formatManager, RepresentationKinds.ERROR, ContentTypes.JSON)
-    }
-    this._logger.debug('Response contract contentTypeInfo:', contract.getContentTypeInfo())
-    this._response.setContract(contract)
-    next()
-  }
-}
-
-module.exports = ErrorContentNegotiatorCommand

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-server/invocation/ErrorSerializingCommand.js

@@ -1,51 +0,0 @@
-'use strict'
-
-const Command = require('./Command')
-
-/**
- * The `next` callback to be called upon finish execution.
- *
- * @callback Next
- * @param {?Error} error An error if there is one or null if not
- */
-
-/**
- * Executes the error serialization.
- *
- * @extends Command
- */
-class ErrorSerializingCommand extends Command {
-  /**
-   * Creates an instance of the ErrorSerializingCommand.
-   *
-   * @param {OdataResponse} response the current OData response
-   * @param {LoggerFacade} logger the logger
-   */
-  constructor (response, logger) {
-    super()
-    this._response = response
-    this._logger = logger
-  }
-
-  /**
-   * Executes the registered error serializing function bound with the contract created from the
-   * error content negotiation.
-   *
-   * @param {Next} next The next callback to be called on finish
-   * @param {Error} error The error thrown
-   */
-  execute (next, error) {
-    if (this._response.isHeadersSent()) {
-      this._logger.warning('Headers already sent')
-      next()
-    } else {
-      const serialize = this._response.getContract().getSerializerFunction()
-      serialize(error, this._response, (innerError, data) => {
-        this._response.setBody(data)
-        next(innerError)
-      })
-    }
-  }
-}
-
-module.exports = ErrorSerializingCommand

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-server/invocation/EventListenerCommand.js

@@ -1,59 +0,0 @@
-'use strict'
-
-const Command = require('./Command')
-
-/**
- * The `next` callback to be called inside the listener.
- * @callback Next
- * @param {?Error} error An error if there is one or null if not
- */
-
-/**
- * The `listener` function which will be called by this command.
- * @callback Listener
- * @param {Context} context The current odata context instance
- * @param {Next} next The callback to be called
- */
-
-/**
- * The EventListenerCommand executes the provided listener function.
- * @extends Command
- */
-class EventListenerCommand extends Command {
-  /**
-   * Creates an instance of EventListenerCommand
-   * @param {Context} context The current odata context instance
-   * @param {Listener} listener The listener to execute
-   * @param {string} name the name
-   */
-  constructor (context, listener, name) {
-    super(context)
-    this._listener = listener
-    this._name = name
-  }
-
-  /**
-   * Executes the listener. The listener must execute the provided next function.
-   * @param {Next} next the callback to execute inside the listener
-   * @param {?Error} error an error if one occurred; can be undefined
-   */
-  execute (next, error) {
-    const context = this.getContext()
-    if (this._listener) {
-      this._listener(context.getRequest(), context.getResponse(), next, error)
-      // The debug mode could have been changed by the debug listener.
-      if (this._name === 'debug') {
-        context.getResponse().setBuffered(
-          context
-            .getRequest()
-            .getContract()
-            .isDebug()
-        )
-      }
-    } else {
-      next()
-    }
-  }
-}
-
-module.exports = EventListenerCommand

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-server/invocation/LocaleNegotiatorCommand.js

@@ -1,56 +0,0 @@
-'use strict'
-
-const Command = require('./Command')
-const RepresentationKind = require('../../odata-commons').format.RepresentationKind.Kinds
-
-/**
- * The `next` callback to be called upon finish execution.
- * @callback Next
- * @param {?Error} error An error if there is one or null if not
- */
-
-/**
- * Calls the application in order to negotiate the Locale of the response.
- * @extends Command
- */
-class LocaleNegotiatorCommand extends Command {
-  /**
-   * Creates an instance of LocaleNegotiatorCommand.
-   * @param {OdataRequest} request the current OData request
-   * @param {OdataResponse} response the current OData response
-   * @param {Function} localeNegotiator locale negotiator
-   * @param {LoggerFacade} logger the logger
-   */
-  constructor (request, response, localeNegotiator, logger) {
-    super()
-    this._request = request
-    this._response = response
-    this._localeNegotiator = localeNegotiator
-    this._logger = logger
-  }
-
-  /**
-   * Executes the locale negotiation.
-   * @param {Next} next The next callback to be called on finish
-   */
-  execute (next) {
-    const contract = this._response.getContract()
-    if (contract.getRepresentationKind() === RepresentationKind.METADATA && this._localeNegotiator) {
-      this._localeNegotiator(this._request, this._response, (error, localeInfo) => {
-        if (error) {
-          next(error)
-        } else {
-          if (localeInfo) {
-            contract.setLocale(localeInfo.value)
-            this._logger.debug('Response Contract Locale:', localeInfo.value)
-          }
-          next()
-        }
-      })
-    } else {
-      next()
-    }
-  }
-}
-
-module.exports = LocaleNegotiatorCommand

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-server/invocation/OdataVersionValidationCommand.js

@@ -1,41 +0,0 @@
-'use strict'
-
-const Command = require('./Command')
-
-/**
- * The `next` callback to be called upon finish execution.
- * @callback Next
- * @param {?Error} error An error if there is one or null if not
- */
-
-/**
- * Executes the validation of the request headers.
- * @extends Command
- */
-class OdataVersionValidationCommand extends Command {
-  /**
-   * Creates an instance of the OdataVersionValidationCommand.
-   * @param {OdataRequest} request the current OData request
-   * @param {RequestValidator} requestValidator The current request validator
-   * @param {?string} version the supported OData version
-   * @param {LoggerFacade} logger the logger
-   */
-  constructor (request, requestValidator, version, logger) {
-    super()
-    this._request = request
-    this._requestValidator = requestValidator
-    this._version = version
-    this._logger = logger
-  }
-
-  /**
-   * Executes the registered version validator.
-   * @param {Next} next The next callback to be called on finish
-   */
-  execute (next) {
-    this._requestValidator.validateVersion(this._version, this._request.getHeaders())
-    next()
-  }
-}
-
-module.exports = OdataVersionValidationCommand

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-server/invocation/OperationValidationCommand.js

@@ -1,34 +0,0 @@
-'use strict'
-
-const Command = require('./Command')
-
-/**
- * Executes the operation validation.
- * @extends Command
- */
-class OperationValidationCommand extends Command {
-  /**
-   * Creates an instance of OperationValidationCommand.
-   * @param {OdataRequest} request the current OData request
-   * @param {RequestValidator} requestValidator The current request validator
-   * @param {LoggerFacade} logger the logger
-   */
-  constructor (request, requestValidator, logger) {
-    super()
-    this._request = request
-    this._requestValidator = requestValidator
-    this._logger = logger
-  }
-
-  /**
-   * Executes the operation validation.
-   * @param {Next} next The next callback to be called on finish
-   */
-  execute (next) {
-    this._requestValidator.validateOperationOnResource(this._request)
-
-    next()
-  }
-}
-
-module.exports = OperationValidationCommand

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-server/invocation/ParsePreferHeaderCommand.js

@@ -1,47 +0,0 @@
-'use strict'
-
-const Command = require('./Command')
-const HttpHeaderNames = require('../../odata-commons').http.HttpHeader.HeaderNames
-const HttpHeader = require('../http/HttpHeader')
-
-/**
- * Executes the parsing and validation of the prefer header.
- * @extends Command
- */
-class ParsePreferHeaderCommand extends Command {
-  /**
-   * Creates an instance of ParsePreferHeaderCommand.
-   * @param {OdataRequest} request the current OData request
-   * @param {RequestValidator} requestValidator The current request validator
-   * @param {LoggerFacade} logger the logger
-   */
-  constructor (request, requestValidator, logger) {
-    super()
-    this._request = request
-    this._requestValidator = requestValidator
-    this._logger = logger
-  }
-
-  /**
-   * Executes the parsing and validation of the prefer header.
-   * @param {Next} next The next callback to be called on finish
-   */
-  execute (next) {
-    const preferHeader = this._request.getHeader(HttpHeaderNames.PREFER)
-    if (preferHeader) {
-      const preferences = HttpHeader.parsePreferHeader(preferHeader)
-      this._request.setPreferences(preferences)
-      this._logger.debug('Prefer header parsing result:', preferences)
-
-      this._requestValidator.validatePreferences(
-        preferences,
-        this._request.getMethod(),
-        this._request.getUriInfo().getPathSegments()
-      )
-    }
-
-    next()
-  }
-}
-
-module.exports = ParsePreferHeaderCommand

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-server/invocation/PresetResponseHeadersCommand.js

@@ -1,47 +0,0 @@
-'use strict'
-
-const Command = require('./Command')
-const ResponseHeaderSetter = require('../core/ResponseHeaderSetter')
-
-/**
- * The `next` callback to be called upon finish execution.
- * @callback Next
- * @param {?Error} error An error if there is one or null if not
- */
-
-/**
- * Executes the setting of response headers.
- * @extends Command
- */
-class PresetResponseHeadersCommand extends Command {
-  /**
-   * Creates an instance of PresetResponseHeadersCommand.
-   * @param {OdataRequest} request the current OData request
-   * @param {OdataResponse} response the current OData response
-   * @param {string} version the supported OData version
-   * @param {LoggerFacade} logger the logger
-   */
-  constructor (request, response, version, logger) {
-    super()
-    this._request = request
-    this._response = response
-    this._version = version
-    this._logger = logger
-  }
-
-  /**
-   * Executes the setting of response headers.
-   * @param {Next} next The next callback to be called on finish
-   */
-  execute (next) {
-    if (this._response.isHeadersSent()) {
-      this._logger.debug('Headers already sent')
-    } else {
-      new ResponseHeaderSetter(this._request, this._response, this._version, this._logger).setHeaders(true)
-    }
-
-    next()
-  }
-}
-
-module.exports = PresetResponseHeadersCommand

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-server/invocation/QueryOptionsParserCommand.js

@@ -1,43 +0,0 @@
-'use strict'
-
-const Command = require('./Command')
-
-/**
- * The `next` callback to be called upon finish execution.
- * @callback Next
- * @param {?Error} error An error if there is one or null if not
- */
-
-/**
- * Executes the query-option parsing.
- * @extends Command
- */
-class QueryOptionsParserCommand extends Command {
-  /**
-   * Creates an instance of the QueryOptionsParserCommand.
-   * @param {UriParser} uriParser the URI parser
-   * @param {OdataRequest} request the OData request
-   * @param {LoggerFacade} logger the logger
-   */
-  constructor (uriParser, request, logger) {
-    super()
-    this._uriParser = uriParser
-    this._request = request
-    this._logger = logger
-  }
-
-  /**
-   * Execute the query-options parsing and change the UriInfo object accordingly.
-   * @param {Next} next The callback to be called on finish
-   */
-  execute (next) {
-    if (this._request.getQueryOptions()) {
-      this._uriParser.parseQueryOptions(this._request.getQueryOptions(), this._request.getUriInfo())
-      this._logger.debug('Query options result:', this._request.getUriInfo().getQueryOptions())
-    }
-
-    next()
-  }
-}
-
-module.exports = QueryOptionsParserCommand

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-server/invocation/QueryOptionsValidationCommand.js

@@ -1,62 +0,0 @@
-'use strict'
-
-const HttpMethods = require('../../odata-commons').http.HttpMethod.Methods
-const Command = require('./Command')
-
-/**
- * The `next` callback to be called upon finish execution.
- * @callback Next
- * @param {?Error} error An error if there is one or null if not
- */
-
-/**
- * Executes the system query options validation.
- * @extends Command
- */
-class QueryOptionsValidationCommand extends Command {
-  /**
-   * Creates an instance of QueryOptionsValidationCommand.
-   * @param {RequestValidator} validator the request validator
-   * @param {OdataRequest} request the OData request
-   * @param {OdataResponse} response the OData response
-   * @param {LoggerFacade} logger the logger
-   */
-  constructor (validator, request, response, logger) {
-    super()
-    this._validator = validator
-    this._request = request
-    this._response = response
-    this._logger = logger
-  }
-
-  /**
-   * Validates the query options.
-   * @param {Next} next The next callback to be called on finish
-   */
-  execute (next) {
-    const uriInfo = this._request.getUriInfo()
-    const queryOptions = this._request.getQueryOptions()
-
-    const method = this._request.getMethod()
-    if (method === HttpMethods.GET) {
-      this._validator.validateQueryOptions(queryOptions, uriInfo)
-    } else {
-      this._validator.validateQueryOptionsForNonGetHttpMethod(queryOptions, method, uriInfo)
-    }
-
-    this._validator.checkForForbiddenQueryOptions(queryOptions)
-
-    try {
-      this._validator.validateDebugOption(queryOptions)
-      next()
-    } catch (error) {
-      // We disable debug mode because there is an error with debug option itself.
-      // This must be done to avoid further buffering of the response.
-      this._request.getContract().enableDebugMode(false)
-      this._response.setBuffered(false)
-      next(error)
-    }
-  }
-}
-
-module.exports = QueryOptionsValidationCommand

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-server/invocation/RequestContentValidationCommand.js

@@ -1,51 +0,0 @@
-'use strict'
-
-const HttpMethods = require('../../odata-commons').http.HttpMethod.Methods
-const Command = require('./Command')
-const MethodNotAllowedError = require('../errors/MethodNotAllowedError')
-
-/**
- * The `next` callback to be called upon finish execution.
- * @callback Next
- * @param {?Error} error An error if there is one or null if not
- */
-
-/**
- * Executes the validation of the request content.
- * @extends Command
- */
-class RequestContentValidationCommand extends Command {
-  /**
-   * Creates an instance of the RequestContentValidationCommand.
-   * @param {OdataRequest} request the current OData request
-   * @param {RequestValidator} requestValidator The current request validator
-   * @param {?string} version the supported OData version
-   * @param {LoggerFacade} logger the logger
-   */
-  constructor (request, requestValidator, version, logger) {
-    super()
-    this._request = request
-    this._requestValidator = requestValidator
-    this._version = version
-    this._logger = logger
-  }
-
-  /**
-   * Executes the validation.
-   * @param {Next} next The next callback to be called on finish
-   */
-  execute (next) {
-    const method = this._request.getMethod()
-    const isDeepUpdate = this._request.getDeepInsertExpand().length && method !== HttpMethods.POST
-    const allowedVersion = this._request.hasDelta() || isDeepUpdate ? '4.01' : this._version
-    this._requestValidator.validateVersion(allowedVersion, this._request.getHeaders())
-
-    if (this._request.hasDelta() && method !== HttpMethods.PATCH) {
-      throw new MethodNotAllowedError('Requests with delta annotations must use HTTP PATCH')
-    }
-
-    next()
-  }
-}
-
-module.exports = RequestContentValidationCommand

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-server/invocation/SendResponseCommand.js

@@ -1,37 +0,0 @@
-'use strict'
-
-const Command = require('./Command')
-const InternalServerError = require('../errors/InternalServerError')
-
-/**
- * Executes the sending of the response to the client with the provided data.
- * @extends Command
- */
-class SendResponseCommand extends Command {
-  /**
-   * Creates an instance of the SendResponseCommand.
-   * @param {OdataResponse} response the current OData response
-   * @param {LoggerFacade} logger the logger
-   */
-  constructor (response, logger) {
-    super()
-    this._response = response
-    this._logger = logger
-  }
-
-  /**
-   * Sends the response.
-   * @param {Next} next The next callback to be called on finish
-   */
-  execute (next) {
-    if (this._response.isHeadersSent() && this._response.getBody()) {
-      throw new InternalServerError(
-        'Response data was already sent while there is still data available in response buffer'
-      )
-    }
-
-    this._response.end(this._response.getBody(), undefined, next)
-  }
-}
-
-module.exports = SendResponseCommand