@sap/cds 8.9.4 → 9.0.3

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

@@ -1,234 +0,0 @@
-'use strict'
-
-const cds = require('../../../../../cds')
-
-const crypto = require('crypto')
-
-const commons = require('../odata-commons')
-const EdmProvider = commons.edm.EdmProvider
-const CsdlJsonProvider = commons.csdl.CsdlJsonProvider
-const UriParser = commons.uri.UriParser
-const RepresentationKinds = commons.format.RepresentationKind.Kinds
-const ContentTypes = commons.format.ContentTypeInfo.ContentTypes
-const PrimitiveValueEncoder = commons.utils.PrimitiveValueEncoder
-const Service = require('./core/Service')
-const Components = require('./core/ComponentManager').Components
-const Dispatcher = require('./core/Dispatcher')
-const MetadataHandler = require('./handler/MetadataHandler')
-const ServiceHandler = require('./handler/ServiceHandler')
-const BatchHandler = require('./handler/BatchHandler')
-const ResponseContentNegotiator = require('./format/ResponseContentNegotiator')
-const SerializerFactory = require('./serializer/SerializerFactory')
-const MetadataXmlSerializer = require('./serializer/MetadataXmlSerializer')
-const ServiceJsonSerializer = require('./serializer/ServiceJsonSerializer')
-const BatchMultipartSerializer = require('./serializer/BatchMultipartSerializer')
-const ErrorJsonSerializer = require('./serializer/ErrorJsonSerializer')
-const ErrorXmlSerializer = require('./serializer/ErrorXmlSerializer')
-const DebugJsonSerializer = require('./serializer/DebugJsonSerializer')
-const DebugHtmlSerializer = require('./serializer/DebugHtmlSerializer')
-const RequestValidator = require('./validator/RequestValidator')
-const DeserializerFactory = require('./deserializer/DeserializerFactory')
-
-/**
- * OData service factory to create a full featured OData service.
- */
-class ServiceFactory {
-  /**
-   * Creates a full featured OData service.
-   * @param {Object} metadata The metadata JSON with which the CSDL and then EDM providers can be created
-   * @param {Object} [edmConfiguration={}] A configuration object to configure the behavior of EDM artifacts
-   * The example shows the configuration for an EntitySet and a Singleton that are ETAG enabled.
-   * const configuration = {
-   *   'the.EDM.namespace': {
-   *     TheNameOfTheConcurrentEntitySet: { isConcurrent: true },
-   *     TheNameOfTheConcurrentSingleton: { isConcurrent: true }
-   *   }
-   * };
-   * @returns {Service} A full featured OData service
-   */
-  static createService (metadata, edmConfiguration = {}) {
-    const edmProvider = new EdmProvider(new CsdlJsonProvider(metadata), edmConfiguration)
-
-    // put provider into global map for cross-service
-    cds._edmProviders = cds._edmProviders || new Map()
-    const { namespace } = edmProvider._provider._containerName
-    cds._edmProviders.set(namespace, edmProvider)
-
-    return (
-      new Service(edmProvider)
-        .log(null, entry => entry)
-        .on('request', (request, response, next) => {
-          // This is the default listener called on on each request.
-          next(/* error */)
-        })
-        .on('debug', (request, response, next) => {
-          // We disable the debug mode by default.
-          // Overwrite this listener to enable debug mode.
-          // To get the info if debug mode is requested
-          // call 'request.getContract().isDebug(): true|false'.
-          request.getContract().enableDebugMode(false)
-          next(/* error */)
-        })
-        .on('error', (request, response, next, error) => {
-          // This listener subscribes to all error events.
-          // The error object is the original error thrown.
-          // Another error-like object with properties like .statusCode or .message could be passed on.
-          next(null, error)
-        })
-        .setOdataVersion('4.0')
-        .setMetadataEtag(
-          crypto
-            .createHash('sha256')
-            .update(JSON.stringify(metadata))
-            .digest('base64')
-        )
-        .use(Components.URI_PARSER, new UriParser(edmProvider))
-        .use(Components.CONTENT_NEGOTIATOR, new ResponseContentNegotiator())
-        .use(Components.REQUEST_VALIDATOR, new RequestValidator())
-        .use(Components.DISPATCHER, new Dispatcher())
-        .use(Components.PRIMITIVE_VALUE_ENCODER, new PrimitiveValueEncoder())
-        .use(Components.METADATA_HANDLER, MetadataHandler.read)
-        .use(Components.SERVICE_HANDLER, ServiceHandler.read)
-        .use(Components.BATCH_EXECUTE_HANDLER, BatchHandler.handle)
-        .parse(
-          RepresentationKinds.BATCH,
-          ContentTypes.MULTIPART_MIXED,
-          DeserializerFactory.createMultipartMixedDeserializer()
-        )
-        .parse(RepresentationKinds.BATCH, ContentTypes.JSON, DeserializerFactory.createBatchJsonDeserializer())
-        .parse(
-          RepresentationKinds.ENTITY,
-          ContentTypes.JSON,
-          DeserializerFactory.createJsonDeserializer(edmProvider, RepresentationKinds.ENTITY)
-        )
-        .parse(
-          RepresentationKinds.PRIMITIVE,
-          ContentTypes.JSON,
-          DeserializerFactory.createJsonDeserializer(edmProvider, RepresentationKinds.PRIMITIVE)
-        )
-        .parse(
-          RepresentationKinds.PRIMITIVE_COLLECTION,
-          ContentTypes.JSON,
-          DeserializerFactory.createJsonDeserializer(edmProvider, RepresentationKinds.PRIMITIVE_COLLECTION)
-        )
-        .parse(
-          RepresentationKinds.COMPLEX,
-          ContentTypes.JSON,
-          DeserializerFactory.createJsonDeserializer(edmProvider, RepresentationKinds.COMPLEX)
-        )
-        .parse(
-          RepresentationKinds.COMPLEX_COLLECTION,
-          ContentTypes.JSON,
-          DeserializerFactory.createJsonDeserializer(edmProvider, RepresentationKinds.COMPLEX_COLLECTION)
-        )
-        .parse(
-          RepresentationKinds.REFERENCE,
-          ContentTypes.JSON,
-          DeserializerFactory.createJsonDeserializer(edmProvider, RepresentationKinds.REFERENCE)
-        )
-        .parse(
-          RepresentationKinds.PRIMITIVE_VALUE,
-          ContentTypes.TEXT_PLAIN,
-          DeserializerFactory.createTextValueDeserializer()
-        )
-        .parse(
-          RepresentationKinds.ACTION_PARAMETERS,
-          ContentTypes.JSON,
-          DeserializerFactory.createJsonDeserializer(edmProvider, RepresentationKinds.ACTION_PARAMETERS)
-        )
-        // Register the binary parser for all content types sent for representation kind BINARY.
-        // There is special logic for this in the request content negotiator.
-        .parse(RepresentationKinds.BINARY, '', DeserializerFactory.createBinaryDeserializer())
-        .format(RepresentationKinds.METADATA, ContentTypes.XML, (context, data, options, next) =>
-          next(null, new MetadataXmlSerializer(edmProvider, context.getLogger()).serialize(data))
-        )
-        .format(RepresentationKinds.SERVICE, ContentTypes.JSON, (context, data, options, next) =>
-          next(null, new ServiceJsonSerializer(edmProvider).serialize(data))
-        )
-        .format(RepresentationKinds.BATCH, ContentTypes.MULTIPART_MIXED, (context, batchContext, options, next) => {
-          new BatchMultipartSerializer(batchContext).execute(context.getResponse())
-          next()
-        })
-        .format(
-          RepresentationKinds.BATCH,
-          ContentTypes.JSON,
-          SerializerFactory.batch,
-          SerializerFactory.checkJsonParameters
-        )
-        .format(
-          RepresentationKinds.ENTITY,
-          ContentTypes.JSON,
-          SerializerFactory.resourceEntity,
-          SerializerFactory.checkJsonParameters
-        )
-        .format(
-          RepresentationKinds.ENTITY_COLLECTION,
-          ContentTypes.JSON,
-          SerializerFactory.resourceEntityCollection,
-          SerializerFactory.checkJsonParameters
-        )
-        .format(
-          RepresentationKinds.PRIMITIVE,
-          ContentTypes.JSON,
-          SerializerFactory.resourcePrimitive,
-          SerializerFactory.checkJsonParameters
-        )
-        .format(
-          RepresentationKinds.PRIMITIVE_COLLECTION,
-          ContentTypes.JSON,
-          SerializerFactory.resourcePrimitiveCollection,
-          SerializerFactory.checkJsonParameters
-        )
-        .format(
-          RepresentationKinds.COMPLEX,
-          ContentTypes.JSON,
-          SerializerFactory.resourceComplex,
-          SerializerFactory.checkJsonParameters
-        )
-        .format(
-          RepresentationKinds.COMPLEX_COLLECTION,
-          ContentTypes.JSON,
-          SerializerFactory.resourceComplexCollection,
-          SerializerFactory.checkJsonParameters
-        )
-        .format(
-          RepresentationKinds.REFERENCE,
-          ContentTypes.JSON,
-          SerializerFactory.resourceReference,
-          SerializerFactory.checkJsonParameters
-        )
-        .format(
-          RepresentationKinds.REFERENCE_COLLECTION,
-          ContentTypes.JSON,
-          SerializerFactory.resourceReferenceCollection,
-          SerializerFactory.checkJsonParameters
-        )
-        .format(RepresentationKinds.PRIMITIVE_VALUE, ContentTypes.TEXT_PLAIN, SerializerFactory.value)
-        .format(RepresentationKinds.BINARY, ContentTypes.TEXT_PLAIN, SerializerFactory.value)
-        .format(RepresentationKinds.COUNT, ContentTypes.TEXT_PLAIN, (context, data, options, next) =>
-          next(null, data.value.toString())
-        )
-        .format(RepresentationKinds.NO_CONTENT, null, (context, data, options, next) => {
-          context.getLogger().debug('No payload available')
-          next()
-        })
-        .format(RepresentationKinds.ERROR, ContentTypes.XML, (error, response, next) =>
-          next(null, new ErrorXmlSerializer(error).serialize())
-        )
-        .format(
-          RepresentationKinds.ERROR,
-          ContentTypes.JSON,
-          (error, response, next) => next(null, new ErrorJsonSerializer(error).serialize()),
-          SerializerFactory.checkJsonParameters
-        )
-        .format(RepresentationKinds.DEBUG, ContentTypes.JSON, (context, buffer, error, next) =>
-          next(null, new DebugJsonSerializer(context, buffer.toString(), error).serialize())
-        )
-        .format(RepresentationKinds.DEBUG, ContentTypes.HTML, (context, buffer, error, next) =>
-          next(null, new DebugHtmlSerializer(context, buffer.toString(), error).serialize())
-        )
-    )
-  }
-}
-
-module.exports = ServiceFactory

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-server/batch/BatchContext.js

@@ -1,351 +0,0 @@
-'use strict'
-
-const BatchErrorInfo = require('./BatchErrorInfo')
-
-/**
- * Stores information required for batch processing, similar to the Context class.
- */
-class BatchContext {
-  /**
-   * Constructor
-   * @param {OdataRequest} incomingODataRequest Request received from the client
-   * @param {OdataResponse} incomingODataResponse Response to be send to the client
-   */
-  constructor (incomingODataRequest, incomingODataResponse) {
-    /**
-     * OdataRequest wrapping the network request received by node.js
-     * @type {OdataRequest}
-     * @private
-     */
-    this._incomingODataRequest = incomingODataRequest
-
-    /**
-     * OdataResponse wrapping the network response to be sent by node.js
-     * @type {OdataResponse}
-     * @private
-     */
-    this._incomingODataResponse = incomingODataResponse
-
-    /**
-     * Requests extracted from the batch request's payload
-     * @type {OdataRequestInBatch[]}
-     * @private
-     */
-    this._requests = []
-
-    /**
-     * Responses to be written into the batch response as part of the payload, with the request ID as key
-     * @type {Map.<string, OdataResponseInBatch>}
-     * @private
-     */
-    this._responses = new Map()
-
-    /**
-     * Map containing the location headers of the executed requests identified by the request ID,
-     * used for content-ID referencing
-     * @type {Map.<string, string>}
-     * @private
-     */
-    this._locations = new Map()
-
-    /**
-     * Map containing for each atomicity group (identified by the atomicity-group ID) a list of BatchErrorInfo
-     * instances to store which requests of the atomicity group have not been executed successfully.
-     * Failed requests outside of an atomicity group are stored under the key <code>null</code>.
-     * @type {Map.<?string, BatchErrorInfo[]>}
-     * @private
-     */
-    this._failedRequestsPerAtomicityGroup = new Map()
-
-    /**
-     * Map containing the error object, thrown by a handler function or due to a framework error,
-     * causing an atomicity group to fail
-     * @type {Map.<string, ?Error>}
-     * @private
-     */
-    this._failedAtomicityGroups = new Map()
-
-    /**
-     * Flag indicating if the batch processing should be continued after the first error
-     * @type {boolean}
-     * @private
-     */
-    this._continueOnError = this._incomingODataRequest.getPreferences().getOdataContinueOnError()
-
-    /**
-     * Boundary of the incoming batch request if multipart/mixed format is used. Used to create the response boundary.
-     * @type {string}
-     * @private
-     */
-    this._boundary = ''
-
-    /**
-     * Semantics of batch request
-     * @type {BatchContext.SEMANTICS}
-     * @private
-     */
-    this._semantics = BatchContext.SEMANTICS.MULTIPART
-
-    /**
-     * Store the first framework error, framework errors lead to a complete batch fail.
-     * Some framework errors from exits (e.g. from GROUP_START or GROUP_END exit) are not stored here
-     * because this framework errors just lead to an failure of the specific atomicity group.
-     * @type {Error}
-     * @private
-     */
-    this._frameworkError = null
-  }
-
-  /**
-   * Set framework error
-   * @param {Error} error Framework error
-   */
-  setFrameworkError (error) {
-    this._frameworkError = error
-  }
-
-  /**
-   * Get framework error
-   * @returns {Error} Framework error
-   */
-  getFrameworkError () {
-    return this._frameworkError
-  }
-
-  /**
-   * Returns the batch request received from the client.
-   * @returns {OdataRequest} the batch request
-   */
-  getRequest () {
-    return this._incomingODataRequest
-  }
-
-  /**
-   * Returns the batch response to be sent to the client.
-   * @returns {OdataResponse} the batch response
-   */
-  getResponse () {
-    return this._incomingODataResponse
-  }
-
-  /**
-   * Adds an OData response to the responses list for this batch request.
-   * @param {OdataResponseInBatch} odataResponse Response
-   * @returns {BatchContext} this instance
-   */
-  addResponseInBatch (odataResponse) {
-    this._responses.set(odataResponse.getOdataResponseId(), odataResponse)
-    return this
-  }
-
-  /**
-   * If a batched request has been processed and its resulting status code is between
-   * 400 (inclusive) and 600 (exclusive), this method is called to store the error information.
-   * The request is marked as failed and if the request belongs to an atomicity group
-   * this group is also marked as failed.
-   * @param {string} id ID of the batched request where the error occurred
-   * @param {OdataRequestInBatch} request the batched request whose processing failed
-   * @param {OdataResponseInBatch} response response object of the batched request whose processing failed
-   * @param {Error} [applicationError] Error to be forwarded to markAtomicityGroupAsFailed as root cause for the failed atomicity group
-   * @returns {BatchContext} this instance
-   */
-  markRequestAsFailed (id, request, response, applicationError) {
-    const atomicityGroupId = request.getAtomicityGroupId()
-
-    if (this._failedRequestsPerAtomicityGroup.has(atomicityGroupId)) {
-      const erroneousRequests = this._failedRequestsPerAtomicityGroup.get(atomicityGroupId)
-      // don't add request/response twice to the failed requests per atomicity group array.
-      let found = erroneousRequests.some(entry => entry.getId() === id)
-      if (!found) {
-        const batchErrorInfo = new BatchErrorInfo(id, request, response)
-        erroneousRequests.push(batchErrorInfo)
-      }
-    } else {
-      const batchErrorInfo = new BatchErrorInfo(id, request, response)
-      this._failedRequestsPerAtomicityGroup.set(atomicityGroupId, [batchErrorInfo])
-    }
-
-    // Also mark the whole atomicity group as failed, if the group is not already marked as failed
-    // (e.g., due to an error in the previous batched request).
-    if (!this._failedAtomicityGroups.get(atomicityGroupId)) {
-      this.markAtomicityGroupAsFailed(atomicityGroupId, applicationError)
-    }
-    return this
-  }
-
-  /**
-   * Mark an atomicity group as failed.
-   * @param {string} atomicityGroupId atomicity group ID
-   * @param {Error} [error] error information
-   * @returns {BatchContext} this instance
-   */
-  markAtomicityGroupAsFailed (atomicityGroupId, error) {
-    this._failedAtomicityGroups.set(atomicityGroupId, error)
-    return this
-  }
-
-  /**
-   * Returns the map with failed atomicity groups.
-   * @returns {Map.<string, ?Error>} the failed groups
-   */
-  getFailedAtomicityGroups () {
-    return this._failedAtomicityGroups
-  }
-
-  /**
-   * Returns the failed requests of an atomicity group.
-   * @param {string} atomicityGroupId the ID of the atomicity group
-   * @returns {BatchErrorInfo[]} Erroneous requests
-   */
-  getFailedRequestsOfAtomicityGroup (atomicityGroupId) {
-    return this._failedRequestsPerAtomicityGroup.get(atomicityGroupId) || []
-  }
-
-  /**
-   * Check if a atomicity group has been executed.
-   * @param {string} id atomicity-group ID
-   * @returns {boolean} whether the atomicity group has been executed
-   */
-  isAtomicityGroupExecuted (id) {
-    return this._failedRequestsPerAtomicityGroup.get(id) === undefined
-  }
-
-  /**
-   * Check if a request has been executed and failed.
-   * @param {string} id request ID
-   * @returns {boolean} whether the request has been executed and failed
-   */
-  isRequestFailed (id) {
-    const request = this._requests.find(req => req.getOdataRequestId() === id)
-    if (!request) return false
-    const atomicityGroup = request.getAtomicityGroupId()
-    return (
-      this._failedRequestsPerAtomicityGroup.has(atomicityGroup) &&
-      this._failedRequestsPerAtomicityGroup.get(atomicityGroup).some(info => info.getId() === id)
-    )
-  }
-
-  /**
-   * Sets the list of OData requests which have been read from the batch request.
-   * @param {OdataRequestInBatch[]} requestsInBatch requests collected by the batch-request parsing
-   * @returns {BatchContext} this instance
-   */
-  setRequestList (requestsInBatch) {
-    this._requests = requestsInBatch
-    return this
-  }
-
-  /**
-   * Returns the list of OData requests which have been read from the batch request.
-   * @returns {OdataRequestInBatch[]} the request list
-   */
-  getRequestList () {
-    return this._requests
-  }
-
-  /**
-   * Returns the OData responses for the batch response.
-   * @returns {Map.<string, OdataResponseInBatch>} the responses, with the request ID as key
-   */
-  getResponses () {
-    return this._responses
-  }
-
-  /**
-   * Returns whether the batch-request execution should be continued after an error.
-   * @returns {boolean} whether the batch request execution should be continued after an error
-   */
-  isContinueOnError () {
-    return this._continueOnError
-  }
-
-  /**
-   * Set the boundary of the incoming batch request. Used to create the response boundary.
-   * @param {string} boundary the boundary
-   * @returns {BatchContext} this instance
-   */
-  setBatchBoundary (boundary) {
-    this._boundary = boundary
-    return this
-  }
-
-  /**
-   * Returns the boundary of the incoming batch request. Used to create the response boundary.
-   * @returns {string} boundary
-   */
-  getBoundary () {
-    return this._boundary
-  }
-
-  /**
-   * Set the semantics for batch processing.
-   * @param {BatchContext.SEMANTICS} semantics the semantics
-   * @returns {BatchContext} this instance
-   */
-  setSemantics (semantics) {
-    this._semantics = semantics
-    return this
-  }
-
-  /**
-   * Returns the semantics for batch processing.
-   * @returns {BatchContext.SEMANTICS} semantics
-   */
-  getSemantics () {
-    return this._semantics
-  }
-
-  /**
-   * Sets a location from a CREATED response.
-   * @param {string} id request ID
-   * @param {string} location location of the created entity
-   * @returns {BatchContext} this instance
-   */
-  addLocation (id, location) {
-    this._locations.set(id, location)
-    return this
-  }
-
-  /**
-   * Returns a location from a CREATED response.
-   * @param {string} id the ID
-   * @returns {string} the location
-   */
-  getLocation (id) {
-    return this._locations.get(id)
-  }
-
-  /**
-   * Remove an atomicity group.
-   * @param {string} atomicityGroupId the ID of the atomicity group
-   * @returns {BatchContext} this instance
-   */
-  removeAtomicityGroup (atomicityGroupId) {
-    for (const request of this._requests) {
-      if (request.getAtomicityGroupId() === atomicityGroupId) {
-        const id = request.getOdataRequestId()
-        this._responses.delete(id)
-      }
-    }
-
-    // Remove atomicity group.
-    this._failedRequestsPerAtomicityGroup.delete(atomicityGroupId)
-    this._failedAtomicityGroups.delete(atomicityGroupId)
-
-    return this
-  }
-}
-
-/**
- * Semantics of a batch request
- * MULTIPART means the Odata 4.0 batch semantics for multipart/mixed content type is used
- * JSON means the Odata 4.01 batch semantics for batch in application/json content type is used
- * @enum {string}
- * @type {{MULTIPART: string, JSON: string}}
- */
-BatchContext.SEMANTICS = {
-  MULTIPART: 'MULTIPART',
-  JSON: 'JSON'
-}
-
-module.exports = BatchContext

package/libx/_runtime/cds-services/adapter/odata-v4/okra/odata-server/batch/BatchErrorInfo.js

@@ -1,61 +0,0 @@
-'use strict'
-
-/**
- * Structure containing information about errors which occurred while processing a batch request
- */
-class BatchErrorInfo {
-  /**
-   * Constructor
-   * @param {string} id Id of the batched request where the error occurred
-   * @param {OdataRequestInBatch} request Request object of the batched request whose processing failed
-   * @param {OdataResponseInBatch} response Response object of the batched request whose processing failed
-   */
-  constructor (id, request, response) {
-    /**
-     * Id of the batched request where the error occurred
-     * @type {string}
-     * @private
-     */
-    this._id = id
-
-    /**
-     * Request object of the batched request whose processing failed
-     * @type {OdataRequestInBatch}
-     * @private
-     */
-    this._request = request
-
-    /**
-     * Response object of the batched request whose processing failed
-     * @type {OdataResponseInBatch}
-     * @private
-     */
-    this._response = response
-  }
-
-  /**
-   * Returns the Id of the batched request where the error occurred.
-   * @returns {string|*} the ID
-   */
-  getId () {
-    return this._id
-  }
-
-  /**
-   * Returns the request object whose processing failed.
-   * @returns {OdataRequestInBatch} the request
-   */
-  getRequest () {
-    return this._request
-  }
-
-  /**
-   * Returns the response object whose processing failed.
-   * @returns {OdataResponseInBatch} the response
-   */
-  getResponse () {
-    return this._response
-  }
-}
-
-module.exports = BatchErrorInfo