@sap/cds 8.9.3 → 9.0.2

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

@@ -1,171 +0,0 @@
-'use strict'
-
-const commons = require('../../odata-commons')
-const validateThat = commons.validator.ParameterValidator.validateThat
-const HttpMethods = commons.http.HttpMethod.Methods
-const ContentTypes = commons.format.ContentTypeInfo.ContentTypes
-
-const OdataRequestInBatch = require('../core/OdataRequestInBatch')
-const PlainHttpRequest = require('../core/PlainHttpRequest')
-const DeserializationError = require('../errors/DeserializationError')
-
-class BatchJsonDeserializer {
-  constructor () {
-    this._savedRequestIds = new Map()
-    this._savedAtomicityGroupIds = new Set()
-  }
-
-  /**
-   * Deserializes an OData batch in JSON.
-   * @param {Array.<Object>} payload the batch payload requests
-   * @returns {OdataRequestInBatch[]} the deserialized request
-   */
-  deserialize (payload) {
-    validateThat('payload', payload)
-      .notNullNorUndefined()
-      .typeOf('object')
-    validateThat('requests', payload.requests)
-      .notNullNorUndefined()
-      .array()
-      .containsElementsOfType('object')
-
-    const additionalProperty = Object.keys(payload).find(key => key !== 'requests')
-    if (additionalProperty) throw new DeserializationError("Property '" + additionalProperty + "' is not allowed.")
-
-    return payload.requests.map(requestObject => this._deserializeOdataRequestInBatch(requestObject))
-  }
-
-  /**
-   * Deserializes a single OData request from a batch request in JSON.
-   * @param {Object} requestObject a single request from the batch payload requests list
-   * @returns {OdataRequestInBatch} the deserialized request
-   * @private
-   */
-  _deserializeOdataRequestInBatch (requestObject) {
-    validateThat('request', requestObject).notNullNorUndefined()
-    validateThat('id', requestObject.id)
-      .truthy()
-      .typeOf('string')
-
-    const method = requestObject.method
-    validateThat('method', requestObject.method)
-      .truthy()
-      .typeOf('string')
-    if (
-      ![HttpMethods.DELETE, HttpMethods.GET, HttpMethods.PATCH, HttpMethods.POST, HttpMethods.PUT].includes(
-        method.toUpperCase()
-      )
-    ) {
-      throw new DeserializationError(
-        "Method '" + method + "' is not allowed. Only DELETE, GET, PATCH, POST or PUT are."
-      )
-    }
-
-    const url = requestObject.url
-    validateThat('url', url)
-      .notNullNorUndefined()
-      .typeOf('string')
-
-    const additionalProperty = Object.keys(requestObject).find(
-      key => !['id', 'method', 'url', 'atomicityGroup', 'dependsOn', 'headers', 'body'].includes(key)
-    )
-    if (additionalProperty) throw new DeserializationError("Property '" + additionalProperty + "' is not allowed.")
-
-    const id = requestObject.id
-    if (this._savedRequestIds.has(id) || this._savedAtomicityGroupIds.has(id)) {
-      throw new DeserializationError("Request ID '" + id + "' is not unique.")
-    }
-    this._savedRequestIds.set(id)
-
-    const plainHttpRequest = new PlainHttpRequest()
-      .setOdataRequestId(id)
-      .setMethod(method)
-      .setUri(url)
-
-    const headers = requestObject.headers
-    if (headers) plainHttpRequest.setHeaders(headers)
-
-    const body = requestObject.body
-    if (body !== null && body !== undefined) {
-      const isJson = !headers || !headers['content-type'] || headers['content-type'].startsWith(ContentTypes.JSON)
-      if (typeof body === 'object') {
-        if (isJson) {
-          plainHttpRequest.setBody(Buffer.from(JSON.stringify(body)))
-        } else {
-          throw new DeserializationError(
-            'Content-Type must be application/json or one of its subtypes if the body is an object'
-          )
-        }
-      } else if (typeof body === 'string') {
-        if (headers && headers['content-type']) {
-          if (isJson) throw new DeserializationError('JSON content must be an object')
-
-          const isText = headers['content-type'].startsWith('text/')
-          plainHttpRequest.setBody(Buffer.from(body, isText ? 'utf8' : 'base64'))
-        } else {
-          throw new DeserializationError('A Content-Type header has to be specified for a non JSON body')
-        }
-      } else {
-        throw new DeserializationError('Body must either be a JSON object or a string.')
-      }
-      if (method.toUpperCase() === HttpMethods.GET || method.toUpperCase() === HttpMethods.DELETE) {
-        throw new DeserializationError('A body must not be specified if the method is GET or DELETE.')
-      }
-    }
-
-    let result = new OdataRequestInBatch(plainHttpRequest, id)
-
-    const groupId = requestObject.atomicityGroup
-    if (groupId !== undefined) {
-      validateThat('atomicityGroup', groupId)
-        .truthy()
-        .typeOf('string')
-      if (this._savedRequestIds.has(groupId)) {
-        throw new DeserializationError("Atomicity group ID '" + groupId + "' is not unique.")
-      }
-      this._savedRequestIds.set(id, groupId)
-      this._savedAtomicityGroupIds.add(groupId)
-      result.setAtomicityGroupId(groupId)
-    }
-
-    const dependencies = requestObject.dependsOn
-    if (dependencies) {
-      validateThat('dependsOn', dependencies).array()
-      for (const dependentRequestId of dependencies) {
-        validateThat('dependent request ID', dependentRequestId)
-          .truthy()
-          .typeOf('string')
-        if (!this._savedRequestIds.has(dependentRequestId) && !this._savedAtomicityGroupIds.has(dependentRequestId)) {
-          throw new DeserializationError(
-            "Request ID '" + dependentRequestId + "' used in dependsOn has not been defined before."
-          )
-        }
-        // "If a request depends on another request that is part of a different atomicity group,
-        // the atomicity group MUST be listed in dependsOn."
-        const dependentGroup = this._savedRequestIds.get(dependentRequestId)
-        if (dependentGroup && dependentGroup !== groupId && !dependencies.includes(dependentGroup)) {
-          throw new DeserializationError(
-            "The group '" +
-              dependentGroup +
-              "' of the referenced request '" +
-              dependentRequestId +
-              "' must be listed in dependsOn of request '" +
-              id +
-              "'."
-          )
-        }
-        result.addDependsOn(dependentRequestId)
-      }
-    }
-    // The URL may contain a reference to the result of another request.
-    // "The id of this request MUST be specified in the dependsOn".
-    const referencedId = result.getReferencedId()
-    if (referencedId && !(dependencies && dependencies.includes(referencedId))) {
-      throw new DeserializationError("Request '" + id + "' must depend on request '" + referencedId + "'.")
-    }
-
-    return result
-  }
-}
-
-module.exports = BatchJsonDeserializer

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

@@ -1,196 +0,0 @@
-'use strict'
-
-const EventEmitter = require('events')
-const HttpMethods = require('../../odata-commons').http.HttpMethod.Methods
-const ContentReader = require('./ContentDeserializer')
-const MultipartReader = require('./MultipartReader')
-const OdataRequestInBatch = require('../core/OdataRequestInBatch')
-const PlainHttpRequest = require('../core/PlainHttpRequest')
-const DeserializationError = require('../errors/DeserializationError')
-
-const { AsyncResource } = require('node:async_hooks')
-
-/**
- * Create a list of OdataRequestInBatch from an incoming batch request.
- */
-class BatchRequestListBuilder {
-  constructor () {
-    /**
-     * @type {OdataRequestInBatch[]}
-     * @private
-     */
-    this._requestInBatchList = []
-
-    // create emitter which is injected into readers
-    this._emitter = new EventEmitter()
-    this._setupEvents()
-
-    // temporary helper
-    this._currentPlainHttpRequest = null
-    this._currentRequestId = null
-    this._previousRequestId = null
-    this._previousChangeId = null
-    this._curAtomicityGroup = null
-    this._atomicityGroupPredecessors = []
-    this._currentBuffer = null
-    this._multipartLevel = 0
-    this._batchBoundary = ''
-
-    /**
-     * Used to produces IDs like '~0', '~1', '~2', ...
-     * @type {number}
-     * @private
-     */
-    this._autoRequestID = -1
-  }
-
-  /**
-   * Returns the boundary used in the multipart document.
-   * @returns {string} the boundary
-   */
-  getBatchBoundary () {
-    return this._batchBoundary
-  }
-
-  /**
-   * Prepares the internal state for reading the next part.
-   * @private
-   */
-  _clearForNextRequest () {
-    this._currentPlainHttpRequest = null
-    this._currentRequestId = null
-  }
-
-  /**
-   * Generates a request ID.
-   * @param {string} tag the tag the ID starts with
-   * @returns {string} the request ID
-   * @private
-   */
-  _generateNewRequestID (tag) {
-    const infix = tag | ''
-    this._autoRequestID++
-    return '~' + infix + this._autoRequestID.toString()
-  }
-
-  /**
-   * Starts reading the incoming batch request.
-   * @param {OdataRequest} request the OData request
-   * @param {Function} callback the callback
-   */
-  build (request, callback) {
-    const source = request.getIncomingRequest()
-
-    // create a body reader
-    const parser = new MultipartReader(source.headers)
-    parser.setEmitter(this._emitter)
-
-    // create reader and start with ContentReader
-    const reader = new ContentReader(parser, this._emitter)
-
-    // restore lost context via AsyncResource.bind()
-    source
-      .pipe(reader)
-      .on('finish', AsyncResource.bind(() => {
-        //Revisit: if statement needed in node v12 and v14, not in v16.
-        //Without it, finish callback reached in 12/14 after error handler was thrown
-        if (!source.res || !source.res.headersSent) callback(null, this._requestInBatchList)
-      }))
-      .on('error', callback)
-  }
-
-  /**
-   * Registers the events emitted by the multipart parser.
-   */
-  _setupEvents () {
-    this._emitter.on(ContentReader.EVENTS.MULTIPART_START, boundary => {
-      this._multipartLevel++
-
-      if (this._multipartLevel === 1) {
-        this._batchBoundary = boundary
-      } else if (this._multipartLevel === 2) {
-        this._curAtomicityGroup = boundary
-      } else if (this._multipartLevel === 3) {
-        throw new DeserializationError('Nested changesets are not allowed.')
-      }
-    })
-
-    this._emitter.on(ContentReader.EVENTS.PART_START, () => this._clearForNextRequest())
-
-    this._emitter.on(ContentReader.EVENTS.REQUEST_START, () => {
-      this._currentPlainHttpRequest = new PlainHttpRequest()
-    })
-
-    this._emitter.on(ContentReader.EVENTS.REQUEST_REQUESTLINE, requestLine => {
-      const parts = requestLine.toString('latin1').split(' ')
-      this._currentPlainHttpRequest.setMethod(parts[0])
-      this._currentPlainHttpRequest.setUri(parts[1])
-      this._currentPlainHttpRequest.setVersion(parts[2])
-    })
-
-    this._emitter.on(ContentReader.EVENTS.REQUEST_HEADERS, headers => {
-      this._currentPlainHttpRequest.setHeaders(headers)
-    })
-
-    this._emitter.on(ContentReader.EVENTS.REQUEST_BODY_START, () => {
-      this._currentBuffer = Buffer.from([])
-    })
-
-    this._emitter.on(ContentReader.EVENTS.REQUEST_BODY_DATA, data => {
-      this._currentBuffer = Buffer.concat([this._currentBuffer, data])
-    })
-
-    this._emitter.on(ContentReader.EVENTS.REQUEST_BODY_END, () => {
-      this._currentPlainHttpRequest.setBody(this._currentBuffer)
-    })
-
-    this._emitter.on(ContentReader.EVENTS.UNCONSUMED, () => {
-      throw new DeserializationError('Invalid OData batch request, invalid data at request end')
-    })
-
-    this._emitter.on(ContentReader.EVENTS.REQUEST_END, () => {
-      let requestID = this._currentRequestId || this._generateNewRequestID()
-      const odataRequestInBatch = new OdataRequestInBatch(this._currentPlainHttpRequest, requestID)
-
-      // Add dependency for ordered execution (as defined in specification).
-      if (this._multipartLevel === 1) {
-        if (this._previousChangeId) odataRequestInBatch.addDependsOn(this._previousChangeId)
-      } else if (this._atomicityGroupPredecessors.length) {
-        for (const id of this._atomicityGroupPredecessors) odataRequestInBatch.addDependsOn(id)
-      }
-
-      // The URL may contain a reference to the result of another request.
-      const referencedId = odataRequestInBatch.getReferencedId()
-      if (referencedId) odataRequestInBatch.addDependsOn(referencedId)
-
-      if (this._curAtomicityGroup) odataRequestInBatch.setAtomicityGroupId(this._curAtomicityGroup)
-      this._requestInBatchList.push(odataRequestInBatch)
-
-      this._previousRequestId = requestID
-      if (
-        [HttpMethods.DELETE, HttpMethods.PATCH, HttpMethods.POST, HttpMethods.PUT].includes(
-          this._currentPlainHttpRequest.method.toUpperCase()
-        )
-      ) {
-        this._previousChangeId = requestID
-        if (!this._curAtomicityGroup) this._atomicityGroupPredecessors = [requestID]
-      } else {
-        this._atomicityGroupPredecessors.push(requestID)
-      }
-    })
-
-    this._emitter.on(ContentReader.EVENTS.PART_HEADERS, headers => {
-      const contentId = headers['content-id']
-      this._currentRequestId = contentId ? contentId.getValue() : undefined
-    })
-
-    this._emitter.on(ContentReader.EVENTS.MULTIPART_END, () => {
-      this._multipartLevel--
-      this._previousChangeId = this._curAtomicityGroup
-      this._atomicityGroupPredecessors = [this._curAtomicityGroup]
-      this._curAtomicityGroup = null
-    })
-  }
-}
-
-module.exports = BatchRequestListBuilder

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

@@ -1,154 +0,0 @@
-'use strict'
-
-/**
- * Creates a FIFO cache using a buffer as input. This cache offers functions for consuming bytes from the cache.
- * Used while deserialization of streamed multipart requests.
- * The buffer object used to store the cached bytes is not constant and will change (e.g. while appending bytes
- * to the cache)
- */
-
-// TODO add getter for getReadPos, SerachPos and length
-class Cache {
-  /**
-   * Creates a cache from a given buffer
-   * @param {Buffer} buffer - Buffer containing the initial content
-   */
-  constructor (buffer) {
-    this._cache = buffer
-
-    /**
-     * The read position
-     * @type {number}
-     * @private
-     */
-    this._readPos = 0
-
-    /**
-     * The search position. The search position may be used to improve performance with not searching
-     * already searched data again after more data has been received.
-     * @type {number}
-     * @private
-     */
-    this._searchPosition = 0
-
-    /**
-     * Amount of byte inside the cache. Used to avoid a get length getter.
-     * The length must be updated if the cache content changes.
-     * @type {number}
-     */
-    this._length = this._cache.length
-
-    /**
-     * Consumed bytes
-     * @type {number}
-     */
-    this._consumedBytes = 0
-  }
-
-  /**
-   * The read position
-   * @returns {number} - Read position
-   */
-  getReadPos () {
-    return this._readPos
-  }
-
-  /**
-   * Amount of byte inside the cache. Used to avoid a get length getter.
-   * The length must be updated if the cache content changes.
-   * @returns {number} the length in bytes
-   */
-  getLength () {
-    return this._length
-  }
-
-  /**
-   * The search position. The search position may be used to improve performance with not searching
-   * already searched data again after more data has been received.
-   * @returns {number} - Search position
-   */
-  getSearchPosition () {
-    return this._searchPosition
-  }
-
-  /**
-   * Appends data to the cache
-   * @param {Buffer} buffer - Data to be appended
-   */
-  append (buffer) {
-    this._cache = Buffer.concat([this._cache, buffer], this._cache.length + buffer.length)
-    this._length = this._cache.length
-  }
-
-  /**
-   * Removes the consumed bytes from the cache.
-   */
-  shrink () {
-    if (this._consumedBytes) {
-      this._cache = this._cache.slice(this._consumedBytes)
-      this._readPos -= this._consumedBytes
-      this._searchPosition -= this._consumedBytes
-      this._consumedBytes = 0
-      this._length = this._cache.length
-    }
-  }
-
-  /**
-   * Consumes bytes from the cache.
-   * @param {number} consumed - Bytes to consume
-   */
-  advance (consumed) {
-    this._consumedBytes += consumed
-    this._readPos = this._readPos + consumed
-    this._searchPosition = this._readPos
-  }
-
-  /**
-   * Updates the search position. The search position may be used to improve performance with not searching
-   * already searched data again after more data has been received.
-   *
-   * @param {number} consumed the number of consumed bytes
-   */
-  advanceSearchPosition (consumed) {
-    this._searchPosition += consumed
-  }
-
-  /**
-   * Returns a byte at the read position + offset
-   * @param {number} [offset=0] - Offset
-   * @returns {Buffer} the byte
-   */
-  getByte (offset = 0) {
-    return this._cache[this._readPos + offset]
-  }
-
-  /**
-   * Returns count bytes from the current read position onwards
-   * @param  {number} count - Bytes to return
-   * @returns {Buffer} Bytes
-   */
-  getBytes (count) {
-    return this._cache.slice(this._readPos, this._readPos + count)
-  }
-
-  /**
-   * Returns the bytes between the read position an the upTo position
-   * @param {number} upTo - End position
-   * @returns {Buffer} Bytes, excluding the byte at the upTo position
-   */
-  getBytesTo (upTo) {
-    return this._cache.slice(this._readPos, upTo)
-  }
-
-  /**
-   * Returns the index of the first occurrence of search. See buffer.index of for more details.
-   * @param {Buffer} search - Bytes to be searched
-   * @param {number} from - Start position for searching
-   * @returns {number} the index of the first occurrence of search
-   */
-  indexOf (search, from) {
-    return this._cache.indexOf(search, from)
-  }
-}
-
-module.exports = Cache