@sap/cds 8.9.4 → 9.0.2

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

@@ -1,203 +0,0 @@
-'use strict'
-
-const EventListenerCommand = require('./EventListenerCommand')
-const OdataVersionValidationCommand = require('./OdataVersionValidationCommand')
-const UriParserCommand = require('./UriParserCommand')
-const ParsePreferHeaderCommand = require('./ParsePreferHeaderCommand')
-const OperationValidationCommand = require('./OperationValidationCommand')
-const QueryOptionsValidationCommand = require('./QueryOptionsValidationCommand')
-const QueryOptionsParserCommand = require('./QueryOptionsParserCommand')
-const ConditionalRequestPreValidationCommand = require('./ConditionalRequestPreValidationCommand')
-const ContentNegotiatorCommand = require('./ContentNegotiatorCommand')
-const LocaleNegotiatorCommand = require('./LocaleNegotiatorCommand')
-const PresetResponseHeadersCommand = require('./PresetResponseHeadersCommand')
-const DeserializingCommand = require('./DeserializingCommand')
-const RequestContentValidationCommand = require('./RequestContentValidationCommand')
-const DispatcherCommand = require('./DispatcherCommand')
-const ConditionalRequestControlCommand = require('./ConditionalRequestControlCommand')
-const SetResponseHeadersCommand = require('./SetResponseHeadersCommand')
-const SetStatuscodeCommand = require('./SetStatuscodeCommand')
-const SerializingCommand = require('./SerializingCommand')
-const SendResponseCommand = require('./SendResponseCommand')
-const ErrorSerializingCommand = require('./ErrorSerializingCommand')
-const ErrorContentNegotiatorCommand = require('./ErrorContentNegotiatorCommand')
-const DebugDeserializingCommand = require('./DebugDeserializingCommand')
-const DebugContentNegotiatorCommand = require('./DebugContentNegotiatorCommand')
-const DebugSerializingCommand = require('./DebugSerializingCommand')
-
-const RequestContentNegotiator = require('../format/RequestContentNegotiator')
-const HttpStatusCode = require('../http/HttpStatusCode')
-const Components = require('../core/ComponentManager').Components
-
-/**
- * The CommandFactory creates chains of commands which can be used for execution by a corresponding executor.
- */
-class CommandFactory {
-  /**
-   * Creates a chain of commands which can be used to execute a default single request.
-   * If the URL indicates that the request should be in debug mode,
-   * additional debug commands to handle the debug mode will be added to the command chain.
-   *
-   * @param {Object} options An options object with configuration properties
-   * @param {ComponentManager} options.componentManager The current component manager instance
-   * @param {FormatManager} options.formatManager The current format manager instance
-   * @param {Context} options.context The current odata context instance
-   * @param {boolean} options.isDebug If true request will be processed in debug mode
-   * @returns {Array.<Array>} an array of commands with their descriptions
-   */
-  static createForSingleRequest (options) {
-    const context = options.context
-    const request = context.getRequest()
-    const response = context.getResponse()
-    const service = context.getService()
-    const logger = context.getLogger()
-
-    const uriParser = options.componentManager
-      .getComponent(Components.URI_PARSER)
-      .setPerformanceMonitor(context.getPerformanceMonitor())
-    const contentNegotiator = options.componentManager.getComponent(Components.CONTENT_NEGOTIATOR).setLogger(logger)
-    const localeNegotiator = options.componentManager.getComponent(Components.LOCALE_NEGOTIATOR)
-    const requestValidator = options.componentManager.getComponent(Components.REQUEST_VALIDATOR).setLogger(logger)
-    const dispatcher = options.componentManager
-      .getComponent(Components.DISPATCHER)
-      .setLogger(logger)
-      .setPerformanceMonitor(context.getPerformanceMonitor())
-
-    let result = [
-      [
-        new EventListenerCommand(context, options.componentManager.getComponent('request'), 'request'),
-        'Eventlistener request'
-      ],
-      [
-        new OdataVersionValidationCommand(request, requestValidator, null, logger),
-        'Initial request version-header validation'
-      ],
-      [new UriParserCommand(uriParser, request, logger), 'Uri parsing'],
-      [new ParsePreferHeaderCommand(request, requestValidator, logger), 'Prefer parsing'],
-      [new OperationValidationCommand(request, requestValidator, logger), 'Operation validation'],
-      [new QueryOptionsValidationCommand(requestValidator, request, response, logger), 'Query options validation'],
-      [new QueryOptionsParserCommand(uriParser, request, logger), 'Query options parsing'],
-      [new ConditionalRequestPreValidationCommand(request, logger), 'Conditional request validation'],
-      [
-        new ContentNegotiatorCommand(request, response, options.formatManager, contentNegotiator, logger),
-        'Content negotiation'
-      ],
-      [new LocaleNegotiatorCommand(request, response, localeNegotiator, logger), 'Locale negotiation'],
-      [
-        new PresetResponseHeadersCommand(request, response, service.getOdataVersion(), logger),
-        'Preset response headers'
-      ],
-      [
-        new DeserializingCommand(request, options.bodyParserManager, new RequestContentNegotiator(), logger),
-        'Deserialize request body'
-      ],
-      [
-        new RequestContentValidationCommand(request, requestValidator, service.getOdataVersion(), logger),
-        'Request content validation'
-      ],
-      [
-        new DispatcherCommand(
-          request,
-          response,
-          service._getMetadataCache(),
-          options.componentManager,
-          dispatcher,
-          logger
-        ),
-        'Handler dispatching'
-      ],
-      [
-        new ConditionalRequestControlCommand(request, response, service.getFormatManager(), logger),
-        'Conditional request control'
-      ],
-      [new SetResponseHeadersCommand(request, response, service.getFormatManager(), logger), 'Set response headers'],
-      [new SetStatuscodeCommand(request, response, HttpStatusCode.resolveSuccessStatusCode, logger), 'Set status code'],
-      [new SerializingCommand(context), 'Serializing'],
-      [new SendResponseCommand(response, logger), 'Send response']
-    ]
-    if (options.isDebug) CommandFactory._addDebugCommands(result, options)
-    return result
-  }
-
-  /**
-   * Creates a chain of commands which can be used to execute an error event.
-   * If the URL indicates that the request should be in debug mode,
-   * additional debug commands to handle the debug mode will be added to the command chain.
-   *
-   * @param {Object} options An options object with configuration properties
-   * @param {Object} options.componentManager The current component manager instance
-   * @param {Object} options.formatManager The current format manager instance
-   * @param {Object} options.context The current odata context instance
-   * @param {boolean} options.isDebug If true request will be processed in debug mode
-   * @returns {Array.<Array>} an array of commands with their descriptions
-   */
-  static createForSingleRequestError (options) {
-    const context = options.context
-    const request = context.getRequest()
-    const response = context.getResponse()
-    const logger = context.getLogger()
-
-    const contentNegotiator = options.componentManager.getComponent(Components.CONTENT_NEGOTIATOR).setLogger(logger)
-
-    let result = [
-      [
-        new EventListenerCommand(context, options.componentManager.getComponent('error'), 'error'),
-        'Eventlistener error'
-      ],
-      [
-        new ErrorContentNegotiatorCommand(request, response, options.formatManager, contentNegotiator, logger),
-        'Error content negotiation'
-      ],
-      [
-        new PresetResponseHeadersCommand(request, response, context.getService().getOdataVersion(), logger),
-        'Set error response headers'
-      ],
-      [
-        new SetStatuscodeCommand(request, response, HttpStatusCode.resolveErrorStatusCode, logger),
-        'Set error status code'
-      ],
-      [new ErrorSerializingCommand(response, logger), 'Serializing error'],
-      [new SendResponseCommand(response, logger), 'Send error response']
-    ]
-    if (options.isDebug) CommandFactory._addDebugCommands(result, options)
-    return result
-  }
-
-  /**
-   * Adds debug negotiation and debug serializing commands to the provided chain of commands.
-   * @param {Array.<Array>} commands Array of commands with their descriptions to add the debug commands to
-   * @param {Object} options An options object with configuration properties
-   * @param {Object} options.formatManager The current format manager instance
-   * @param {Object} options.context The current odata context instance
-   */
-  static _addDebugCommands (commands, options) {
-    const context = options.context
-    const request = context.getRequest()
-    const response = context.getResponse()
-    const logger = context.getLogger()
-
-    const contentNegotiator = options.componentManager.getComponent(Components.CONTENT_NEGOTIATOR).setLogger(logger)
-
-    // For debug output, we have to stop the runtime measurement prematurely;
-    // otherwise we won't get the total runtime in the output (which is written in a command, too).
-    // We do that in the first command of the debug command chain.
-    commands.push([new DebugDeserializingCommand(request, logger), 'Debug deserialize request body'])
-
-    commands.push([
-      new DebugContentNegotiatorCommand(request, response, options.formatManager, contentNegotiator, logger),
-      'Debug content negotiation'
-    ])
-    commands.push([
-      new SetStatuscodeCommand(request, response, HttpStatusCode.resolveDebugStatusCode, logger),
-      'Debug set status code'
-    ])
-    commands.push([new DebugSerializingCommand(context), ''])
-    commands.push([
-      new PresetResponseHeadersCommand(request, response, context.getService().getOdataVersion(), logger),
-      ''
-    ])
-    commands.push([new SendResponseCommand(response, logger), ''])
-  }
-}
-
-module.exports = CommandFactory

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

@@ -1,52 +0,0 @@
-'use strict'
-
-const commons = require('../../odata-commons')
-const StatusCodes = commons.http.HttpStatusCode.StatusCodes
-const RepresentationKinds = commons.format.RepresentationKind.Kinds
-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 conditional request.
- */
-class ConditionalRequestControlCommand extends Command {
-  /**
-   * Creates an instance of ConditionalRequestControlCommand.
-   * @param {OdataRequest} request the current OData request
-   * @param {OdataResponse} response the current OData response
-   * @param {FormatManager} formatManager The current instance of format manager
-   * @param {LoggerFacade} logger the logger
-   */
-  constructor (request, response, formatManager, logger) {
-    super()
-    this._request = request
-    this._response = response
-    this._formatManager = formatManager
-    this._logger = logger
-  }
-
-  execute (next) {
-    // Validate that the ETag validation has been called by the data handler.
-    if (this._request.isConditional()) {
-      // Do not set statusCode directly because of internal response cache.
-      if (this._request.getETAGValidationStatus() === StatusCodes.NOT_MODIFIED) {
-        this._response.setStatusCode(StatusCodes.NOT_MODIFIED)
-
-        this._response
-          .getContract()
-          .setSerializerFunction(
-            this._formatManager.getFormatDescriptions(RepresentationKinds.NO_CONTENT, null)[0].getSerializerFunction()
-          )
-      }
-    }
-
-    next()
-  }
-}
-
-module.exports = ConditionalRequestControlCommand

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

@@ -1,59 +0,0 @@
-'use strict'
-
-const commons = require('../../odata-commons')
-const Methods = commons.http.HttpMethod.Methods
-const ResourceKinds = commons.uri.UriResource.ResourceKind
-const Command = require('./Command')
-const ConditionalRequestValidator = require('../validator/ConditionalRequestValidator')
-
-/**
- * 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 conditional request.
- */
-class ConditionalRequestValidationCommand extends Command {
-  /**
-   * Creates an instance of ConditionalRequestValidationCommand.
-   *
-   * @param {OdataRequest} request the current OData request
-   * @param {LoggerFacade} logger the logger
-   */
-  constructor (request, logger) {
-    super()
-    this._request = request
-    this._logger = logger
-  }
-
-  execute (next) {
-    const uriInfo = this._request.getUriInfo()
-    const isConcurrentResource = this._request.getConcurrentResource() !== null
-
-    this._logger.debug('Requested resource is concurrent:', isConcurrentResource)
-
-    const ifNoneMatch = this._request.getHeader('if-none-match')
-    const ifMatch = this._request.getHeader('if-match')
-    const method = this._request.getMethod()
-    const isValidOperation =
-      method === Methods.GET ||
-      method === Methods.PUT ||
-      method === Methods.PATCH ||
-      method === Methods.DELETE ||
-      (method === Methods.POST && uriInfo.getLastSegment().getKind() === ResourceKinds.REF_COLLECTION) ||
-      uriInfo.getLastSegment().getKind() === ResourceKinds.BOUND_ACTION
-
-    if (isValidOperation && (ifMatch || ifNoneMatch || isConcurrentResource)) {
-      this._logger.debug('Header If-Match:', "'" + ifMatch + "'", 'If-None-Match:', "'" + ifNoneMatch + "'")
-
-      new ConditionalRequestValidator().preValidate(ifMatch, ifNoneMatch, method, isConcurrentResource)
-    }
-
-    next()
-  }
-}
-
-module.exports = ConditionalRequestValidationCommand

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

@@ -1,70 +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
- */
-
-/**
- * Negotiates the response content type for the provided request.
- * @extends Command
- */
-class ContentNegotiatorCommand extends Command {
-  /**
-   * Creates an instance of ContentNegotiatorCommand.
-   * @param {OdataRequest} request the current OData request
-   * @param {OdataResponse} response the current OData response
-   * @param {FormatManager} formatManager The current instance of format manager
-   * @param {ResponseContentNegotiator} contentNegotiator The current instance of ResponseContentNegotiator
-   * @param {LoggerFacade} logger the logger
-   */
-  constructor (request, response, formatManager, contentNegotiator, logger) {
-    super()
-    this._request = request
-    this._response = response
-    this._formatManager = formatManager
-    this._negotiator = contentNegotiator
-    this._logger = logger
-  }
-
-  /**
-   * Executes the content negotiation. The content negotiation creates a `ResponseContract` object
-   * as a result with all necessary content negotiation information. The contract object is
-   * attached to the odata response instance.
-   *
-   * @param {Next} next The next callback to be called on finish
-   */
-  execute (next) {
-    const contract = this._negotiator.negotiate(this._formatManager, this._request, this._request.getUriInfo())
-    if (contract.getContentTypeInfo()) {
-      this._logger.debug('Response contract content type:', contract.getContentTypeInfo().toString())
-    }
-
-    this._response.setContract(contract)
-
-    next()
-  }
-
-  /**
-   * Returns the current content negotiator instance.
-   * @returns {ContentNegotiator} the current instance of the negotiator
-   * @protected
-   */
-  getNegotiator () {
-    return this._negotiator
-  }
-
-  /**
-   * Returns the current instance of the format manager.
-   * @returns {FormatManager} the current instance of the format manager
-   * @protected
-   */
-  getFormatManager () {
-    return this._formatManager
-  }
-}
-
-module.exports = ContentNegotiatorCommand

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

@@ -1,59 +0,0 @@
-'use strict'
-
-const commons = require('../../odata-commons')
-const QueryOptions = commons.uri.UriInfo.QueryOptions
-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 debug mode.
- * @extends ContentNegotiatorCommand
- */
-class ContentNegotiatorDebugCommand extends ContentNegotiatorCommand {
-  /**
-   * Executes the content negotiation in debug 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) {
-    if (this._response.isHeadersSent()) {
-      this._logger.debug('Headers already sent')
-    } else {
-      const queryOptions = this._request.getQueryOptions()
-      let resultingContentType = null
-
-      if (queryOptions[QueryOptions.ODATA_DEBUG] === 'json') {
-        resultingContentType = ContentTypes.JSON
-      }
-
-      if (queryOptions[QueryOptions.ODATA_DEBUG] === 'html') {
-        resultingContentType = ContentTypes.HTML
-      }
-
-      const formatManager = super.getFormatManager()
-      const contract = super
-        .getNegotiator()
-        .negotiateContentType(formatManager, RepresentationKinds.DEBUG, resultingContentType)
-
-      this._response.setContract(contract)
-
-      if (contract.getContentTypeInfo()) {
-        this._logger.debug('Debug response contract content type:', contract.getContentTypeInfo().toString())
-      }
-    }
-    next()
-  }
-}
-
-module.exports = ContentNegotiatorDebugCommand

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

@@ -1,44 +0,0 @@
-'use strict'
-
-const RepresentationKind = require('../../odata-commons').format.RepresentationKind.Kinds
-const Command = require('./Command')
-const DeserializerFactory = require('../deserializer/DeserializerFactory')
-
-/**
- * Parses the provided request body for debug output.
- * @extends Command
- */
-class DebugDeserializingCommand extends Command {
-  /**
-   * Creates an instance of DebugDeserializingCommand.
-   * @param {OdataRequest} request the current OData request
-   * @param {LoggerFacade} logger the logger
-   */
-  constructor (request, logger) {
-    super()
-    this._request = request
-    this._logger = logger
-  }
-
-  /**
-   * Executes the request-body parsing.
-   * @param {Function} next The next callback to be called on finish
-   */
-  execute (next) {
-    if (
-      this._request.getContract().getRepresentationKind() !== RepresentationKind.NO_CONTENT &&
-      !this._request.getBody()
-    ) {
-      this._logger.debug('Deserializing request body...')
-      const binaryParserFunction = DeserializerFactory.createBinaryDeserializer()
-      binaryParserFunction(this._request, (error, body) => {
-        this._request.setBody(Buffer.from(body).toString())
-        next(error)
-      })
-    } else {
-      next()
-    }
-  }
-}
-
-module.exports = DebugDeserializingCommand

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-server/invocation/DebugSerializingCommand.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 serialization of internal response buffer in debug mode.
- *
- * @extends Command
- */
-class DebugSerializingCommand extends Command {
-  /**
-   * Executes the registered error serializing function bound with the contract created from the
-   * debug content negotiation.
-   *
-   * @param {Next} next The next callback to be called on finish
-   * @param {Error|undefined} [error] An error if there is one. Can be undefined
-   */
-  execute (next, error) {
-    const context = this.getContext()
-    const logger = context.getLogger()
-
-    const response = this.getContext().getResponse()
-
-    if (response.isHeadersSent()) {
-      logger.debug('Headers already sent')
-      next()
-    } else {
-      // The runtime measurement must be stopped before serializing its output,
-      // otherwise we won't get the total runtime in there.
-      context.getPerformanceMonitor().stop()
-
-      const buffer = response.getBuffer()
-      response.setBuffered(false)
-      let serialize = response.getContract().getSerializerFunction()
-
-      serialize(context, buffer, error, (innerError, data) => {
-        response.setBody(data)
-        next(innerError)
-      })
-    }
-  }
-}
-
-module.exports = DebugSerializingCommand

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

@@ -1,69 +0,0 @@
-'use strict'
-
-const RepresentationKinds = require('../../odata-commons').format.RepresentationKind.Kinds
-const Command = require('./Command')
-const DeserializationError = require('../errors/DeserializationError')
-
-/**
- * The `next` callback to be called upon finish execution.
- * @callback Next
- * @param {?Error} error An error if there is one or null if not
- */
-
-/**
- * Parses the provided request body.
- * @extends Command
- */
-class DeserializingCommand extends Command {
-  /**
-   * Creates an instance of DeserializingCommand.
-   * @param {OdataRequest} request the current OData request
-   * @param {FormatManager} formatManager The current used format manager
-   * @param {RequestContentNegotiator} negotiator The current used request payload negotiator
-   * @param {LoggerFacade} logger the logger
-   */
-  constructor (request, formatManager, negotiator, logger) {
-    super()
-    this._request = request
-    this._formatManager = formatManager
-    this._negotiator = negotiator
-    this._logger = logger
-  }
-
-  /**
-   * Executes the request-body parsing. The content negotiation creates a `RequestContract` object
-   * as a result with a payload deserializer facade inside. The contract object is
-   * attached to the odata request instance. The deserializer facade is executed and the result body
-   * is attached to the request. This command is executed only if the incoming request has a body
-   * to parse as determined by the negotiation.
-   *
-   * @param {Next} next The next callback to be called on finish
-   */
-  execute (next) {
-    const contract = this._negotiator.negotiate(this._formatManager, this._request)
-    const representationKind = contract.getRepresentationKind()
-    if (representationKind === RepresentationKinds.NO_CONTENT) {
-      next()
-    } else {
-      const deserializerFacade = contract.getDeserializerFunction()
-      if (deserializerFacade) {
-        deserializerFacade(this._request, (err, body) => {
-          this._request.setBody(body)
-          next(err)
-        })
-      } else {
-        next(
-          new DeserializationError(
-            "No payload deserializer available for resource kind '" +
-              representationKind +
-              "' and mime type '" +
-              contract.getContentTypeInfo().getMimeType() +
-              "'"
-          )
-        )
-      }
-    }
-  }
-}
-
-module.exports = DeserializingCommand