@sap/cds 8.9.4 → 9.0.3

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

@@ -1,314 +0,0 @@
-'use strict'
-
-const EventEmitter = require('events')
-const validateThat = require('../../odata-commons').validator.ParameterValidator.validateThat
-const PreferenceApplied = require('../http/PreferencesApplied.js')
-
-/**
- * Response object wrapper to carry original response information.
- * If any error occurs in the underlying stream, the OdataResponse object emits this error.
- * If any data was written, a finish event will be emitted.
- *
- * @extends EventEmitter
- * @hideconstructor
- */
-class OdataResponse extends EventEmitter {
-  /**
-   * Creates an instance of OdataResponse.
-   * @param {PlainHttpResponse|http.ServerResponse} inResponse - The original response object.
-   */
-  constructor (inResponse) {
-    super()
-
-    this._response = inResponse
-
-    this._response.on('error', err => this.emit('error', err))
-    this._response.on('finish', () => this.emit('finish'))
-
-    this._isBuffered = false
-    this._buffer = Buffer.from('')
-
-    this._preferencesApplied = null
-
-    this._statusCodeHasBeenSet = false
-
-    this._contract = null
-
-    this._logger = null
-  }
-
-  /**
-   * Returns the current logger instance.
-   * @returns {LoggerFacade} The current logger instance
-   */
-  getLogger () {
-    return this._logger
-  }
-
-  /**
-   * Sets the current logger instance.
-   * @param {LoggerFacade} logger The current logger
-   * @returns {OdataResponse} this OData response instance
-   * @package
-   */
-  setLogger (logger) {
-    this._logger = logger
-    return this
-  }
-
-  /**
-   * Sets the response contract.
-   * @param {ResponseContract} contract The response contract
-   * @returns {OdataResponse} this response object
-   * @package
-   */
-  setContract (contract) {
-    if (this._contract !== null) this._originalContract = this._contract
-    this._contract = contract
-    return this
-  }
-
-  /**
-   * Returns the current response contract.
-   * @returns {ResponseContract} The current response contract
-   */
-  getContract () {
-    return this._contract
-  }
-
-  /**
-   * Returns the original response contract.
-   * @returns {ResponseContract} The original response contract
-   */
-  getOriginalContract () {
-    return this._originalContract
-  }
-
-  /**
-   * Sets this response into buffered mode. If buffered mode is active, all data writing to
-   * to response will be buffered and can be fetched by method .getBuffer().
-   *
-   * @param {boolean} isBuffered if true, response will be in buffered mode, else false
-   * @returns {OdataResponse} this instance of OData response
-   */
-  setBuffered (isBuffered) {
-    this._isBuffered = isBuffered
-    return this
-  }
-
-  /**
-   * Returns the internal buffer.
-   * @returns {Buffer} The internal buffer.
-   */
-  getBuffer () {
-    return this._buffer
-  }
-
-  /**
-   * Concatenates the data to the internal buffer.
-   * @param {*} data The data to concatenate
-   * @private
-   */
-  _concatBuffer (data) {
-    if (data !== null && data !== undefined) {
-      this._buffer = Buffer.concat([this._buffer, Buffer.from(data)])
-    }
-  }
-
-  /**
-   * Ends the response and closes the underlying client connection.
-   * @param {string|Buffer} data any data to send to the client
-   * @param {string} [encoding] encoding of data if it is a string
-   * @param {Function} [callback] function to be called when the response stream is finished
-   * @returns {OdataResponse} this instance of OdataResponse
-   * @package
-   */
-  end (data, encoding, callback) {
-    if (this._isBuffered) {
-      if (data && data.pipe && typeof data.pipe === 'function') {
-        data
-          .on('data', chunk => this._concatBuffer(chunk))
-          .on('end', callback)
-          .on('error', callback)
-      } else {
-        this._concatBuffer(data)
-        callback()
-      }
-    } else if (data && data.pipe && typeof data.pipe === 'function') {
-      data
-        .on('end', callback)
-        .on('error', callback)
-        .pipe(this._response)
-    } else {
-      if (!this._response.writableEnded) this._response.end(data, encoding, callback)
-      this._buffer = Buffer.from('')
-    }
-    return this
-  }
-
-  /**
-   * Writes into the underlying stream.
-   * @param {string|Buffer} chunk chunk of data to write
-   * @param {string} [encoding] the encoding of the data if it is a string, default is utf8
-   * @param {Function} [callback] called when data was written
-   * @package
-   */
-  write (chunk, encoding, callback) {
-    if (this._isBuffered) {
-      this._concatBuffer(chunk)
-      callback()
-    } else {
-      this._response.write(chunk, encoding, callback)
-    }
-  }
-
-  /**
-   * Sets the response status code.
-   * The status code can only be set once unless the overwrite option is used.
-   *
-   * @param {number} statusCode The status code to set.
-   * @param {Object} [options] An options object to control the behavior for setting the status code.
-   * @param {Object} [options.overwrite] If true the status code will be set anyway. Default is 'false'
-   * @throws IllegalArgumentError If the status code is not a number.
-   * @returns {OdataResponse} this instance of OData response
-   */
-  setStatusCode (statusCode, options = { overwrite: false }) {
-    if (!this._statusCodeHasBeenSet || options.overwrite) {
-      validateThat('statusCode', statusCode).typeOf('number')
-      if (options.overwrite) {
-        this._statusCodeOriginal = this._response.statusCode
-      }
-      this._response.statusCode = statusCode
-      this._statusCodeHasBeenSet = true
-    }
-
-    return this
-  }
-
-  /**
-   * Returns the current status code of this response.
-   * @returns {number} the current status code
-   */
-  getStatusCode () {
-    return this._response.statusCode
-  }
-
-  /**
-   * Returns the original status code before overwriting.
-   * @returns {number} the original status code
-   */
-  getOriginalStatusCode () {
-    return this._statusCodeOriginal
-  }
-
-  /**
-   * Sets the status message of the HTTP response.
-   * @param {string} msg The message to set
-   * @returns {OdataResponse} This instance of OData response
-   */
-  setStatusMessage (msg) {
-    this._response.statusMessage = msg
-    return this
-  }
-
-  /**
-   * Returns the status message of the HTTP response.
-   * @returns {string} The status message
-   */
-  getStatusMessage () {
-    return this._response.statusMessage
-  }
-
-  /**
-   * Stores all Preferences, which were actually applied by the application or library.
-   * @returns {PreferenceApplied} an object which stores the actually applied Preferences.
-   */
-  getPreferencesApplied () {
-    if (this._preferencesApplied === null) {
-      this._preferencesApplied = new PreferenceApplied()
-    }
-    return this._preferencesApplied
-  }
-
-  /**
-   * Set a header. The header name will be handled as case-insensitive key.
-   * If a header already exists then the header will be replaced by this new value.
-   *
-   * @param {string} name Case-insensitive header name.
-   * @param {string} value Value for the given header name.
-   * @returns {OdataResponse} this instance
-   * @see <a href="http://ietf.org/rfc/rfc7230.txt">RFC 7230, section 3.2.2</a>
-   */
-  setHeader (name, value) {
-    this._response.setHeader(name, value)
-    return this
-  }
-
-  /**
-   * Returns the corresponding header value found by name.
-   * @param {string} name the name of the header
-   * @returns {string} the value for the header, or undefined if not found
-   */
-  getHeader (name) {
-    return this._response.getHeader(name)
-  }
-
-  /**
-   * Returns all available headers set.
-   * @returns {Object} All headers with header: headerValue pairs.
-   */
-  getHeaders () {
-    return this._response.getHeaders()
-  }
-
-  /**
-   * Returns true if the headers of the response have been sent already.
-   * @returns {boolean} true if headers have been sent already, else false
-   */
-  isHeadersSent () {
-    return this._response.headersSent
-  }
-
-  /**
-   * Returns the response body created by application. This body should be sent to the client.
-   * @returns {*} This body
-   */
-  getBody () {
-    return this._body
-  }
-
-  /**
-   * Sets the response body. The body is set while processing the dispatcher command.
-   * @param {*} body The response body
-   * @returns {OdataResponse} This instance
-   */
-  setBody (body) {
-    this._body = body
-    return this
-  }
-
-  /**
-   * @typedef {Object} Options
-   */
-
-  /**
-   * Returns the OData response options. These options are needed for serialization.
-   * @returns {Options} The OData response options
-   */
-  getOdataOptions () {
-    return this._odataOptions
-  }
-
-  /**
-   * Sets the OData response options.
-   * @param {Options} options the OData response options
-   * @returns {OdataResponse} this instance
-   * @package
-   */
-  setOdataOptions (options) {
-    this._odataOptions = options
-    return this
-  }
-}
-
-module.exports = OdataResponse

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

@@ -1,83 +0,0 @@
-'use strict'
-
-const SerializationError = require('../errors/SerializationError')
-
-/**
- * Response object wrapper to carry original response information.
- */
-class OdataResponseInBatch {
-  /**
-   * Creates an instance of OdataResponseInBatch.
-   * @param {Object} inResponse response object
-   * @param {string} responseId response ID
-   */
-  constructor (inResponse, responseId) {
-    this._inResponse = inResponse
-
-    if (!responseId) throw new SerializationError('Invalid response ID')
-    this._responseId = responseId
-  }
-
-  /**
-   * Returns the original incoming node response message.
-   * @returns {Object} the original incoming response
-   */
-  getIncomingResponse () {
-    return this._inResponse
-  }
-
-  /**
-   * Returns the response ID.
-   * @returns {string} the response ID
-   */
-  getOdataResponseId () {
-    return this._responseId
-  }
-
-  /**
-   * Returns the atomicity group to which this response belongs to.
-   * @returns {string} the atomicity group ID
-   */
-  getAtomicityGroupId () {
-    return this._atomicityGroupId
-  }
-
-  /**
-   * Sets the atomicity group to which this response belongs to.
-   * @param {string} atomicityGroup atomicity group
-   * @returns {OdataResponseInBatch} this instance
-   * @package
-   */
-  setAtomicityGroupId (atomicityGroup) {
-    this._atomicityGroupId = atomicityGroup
-    return this
-  }
-
-  /**
-   * Sets the response object which is given to the service processor to store the response in memory
-   * Later the response objects data is used to build the multipart/json batch response
-   * @param {Object} inResponse response object
-   * @returns {OdataResponseInBatch} this instance
-   */
-  setInResponse (inResponse) {
-    this._inResponse = inResponse
-    return this
-  }
-  /**
-   * Return the current status code of this response.
-   * @returns {number} The current status code.
-   */
-  getStatusCode () {
-    return this._inResponse.statusCode
-  }
-
-  /**
-   * Returns the status message of the HTTP response.
-   * @returns {string} The status message
-   */
-  getStatusMessage () {
-    return this._inResponse.statusMessage
-  }
-}
-
-module.exports = OdataResponseInBatch

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

@@ -1,175 +0,0 @@
-'use strict'
-
-const Readable = require('stream').Readable
-
-/**
- * Simulates an http.IncomingMessage
- * Used when parsing an multipart/mixed request into sub requests
- *
- * @extends Readable
- * @hideconstructor
- */
-class PlainHttpRequest extends Readable {
-  /**
-   * Constructor
-   */
-  constructor () {
-    super()
-    this.method = 'GET'
-    this.url = '/'
-    this.version = 'HTTP/1.1'
-    this.headers = {}
-    this._body = null
-
-    this._readPosition = 0
-    this._line = null
-
-    this._odataRequestId = null
-    this._atomicityGroupId = null
-
-    /**
-     * @type {BatchContext}
-     * @private
-     */
-    this._batchContext = null
-  }
-
-  /**
-   * Return OData request ID.
-   * @returns {?string} the request ID
-   */
-  getOdataRequestId () {
-    return this._odataRequestId
-  }
-
-  /**
-   * Set OData request ID.
-   * @param {string} id OData request ID
-   * @returns {PlainHttpRequest} this instance
-   */
-  setOdataRequestId (id) {
-    this._odataRequestId = id
-    return this
-  }
-
-  /**
-   * Return atomicity group ID.
-   * @returns {?string} the atomicity group ID
-   */
-  getAtomicityGroupId () {
-    return this._atomicityGroupId
-  }
-
-  /**
-   * Set atomicity group ID.
-   * @param {string} id Atomicity group ID
-   * @returns {PlainHttpRequest} this instance
-   */
-  setAtomicityGroupId (id) {
-    this._atomicityGroupId = id
-    return this
-  }
-
-  /**
-   * Set the HTTP method.
-   * @param {string} method the HTTP method
-   * @returns {PlainHttpRequest} this instance
-   * @package
-   */
-  setMethod (method) {
-    this.method = method
-    return this
-  }
-
-  /**
-   * Set the uri.
-   * @param {string} uri the URI
-   * @returns {PlainHttpRequest} this instance
-   * @package
-   */
-  setUri (uri) {
-    this.url = uri
-    return this
-  }
-
-  /**
-   * Set the HTTP version.
-   * @param {string} version the HTTP version
-   * @returns {PlainHttpRequest} this instance
-   * @package
-   */
-  setVersion (version) {
-    this.version = version
-    return this
-  }
-
-  /**
-   * Set the headers object.
-   * @param {Object} headers the headers
-   * @returns {PlainHttpRequest} this instance
-   * @package
-   */
-  setHeaders (headers) {
-    this.headers = headers
-    return this
-  }
-
-  /**
-   * Set the body.
-   * @param {Buffer} buffer the body
-   * @returns {PlainHttpRequest} this instance
-   * @package
-   */
-  setBody (buffer) {
-    this._body = buffer
-    return this
-  }
-
-  /**
-   * Returns the request body.
-   * @returns {?Buffer} the request body
-   */
-  getBody () {
-    return this._body
-  }
-
-  /**
-   * Readable implementation.
-   * @param {number} size the size to read
-   * @private
-   */
-  _read (size) {
-    if (!this._body || this._readPosition >= this._body.length) {
-      this.push(null)
-    } else {
-      const pushTo = Math.min(this._body.length, this._readPosition + size)
-      this.push(this._body.slice(this._readPosition, pushTo))
-      this._readPosition = pushTo
-    }
-  }
-
-  /**
-   * Returns batch context with meta information (e.g., dependencies).
-   * So this context is used to tranport information from the batch request
-   * to the batched request / sub request.
-   *
-   * @returns {BatchContext} OData batch context
-   * @package
-   */
-  getBatchContext () {
-    return this._batchContext
-  }
-
-  /**
-   * Set batch context with meta information (e.g., dependencies).
-   * @param {BatchContext} batchContext batch context information
-   * @returns {PlainHttpRequest} this instance
-   * @package
-   */
-  setBatchContext (batchContext) {
-    this._batchContext = batchContext
-    return this
-  }
-}
-
-module.exports = PlainHttpRequest

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

@@ -1,106 +0,0 @@
-'use strict'
-
-const Writable = require('stream').Writable
-const HttpStatusCode = require('../../odata-commons').http.HttpStatusCode
-const HttpStatusCodes = HttpStatusCode.StatusCodes
-const HttpStatusCodesText = HttpStatusCode.Texts
-
-const CRLF = '\r\n'
-const HTTP_VERSION = 'HTTP/1.1'
-
-/**
- * Simulates an http.ServerResponse; used for a part of a multipart/mixed response.
- * @extends Writable
- * @hideconstructor
- */
-class PlainHttpResponse extends Writable {
-  /**
-   * Constructor
-   */
-  constructor () {
-    super()
-    this.statusCode = HttpStatusCodes.OK // as in node.js
-    this._buffers = []
-    this._header = {}
-
-    this.headersSent = false // as in node.js
-  }
-
-  /**
-   * Writable implementation.
-   * @param {Buffer|string} chunk the chunk to write
-   * @param {string} encoding its encoding
-   * @param {Function} callback the callback
-   * @private
-   */
-  _write (chunk, encoding, callback) {
-    this._buffers.push(chunk)
-    callback()
-  }
-
-  /**
-   * Returns the value of the requested header.
-   * @param {string} name header name
-   * @returns {string} header value
-   */
-  getHeader (name) {
-    return this._header[name.toLowerCase()]
-  }
-
-  /**
-   * Returns headers object.
-   * @returns {Object} the headers
-   */
-  getHeaders () {
-    return this._header
-  }
-
-  /**
-   * Sets a header.
-   * @param {string} name the name of the header
-   * @param {string} value the value of the header
-   * @returns {PlainHttpResponse} this instance
-   * @package
-   */
-  setHeader (name, value) {
-    this._header[name.toLowerCase()] = value
-    return this
-  }
-
-  /**
-   * Returns the response body.
-   * @returns {Buffer} the response body
-   */
-  getBody () {
-    return Buffer.concat(this._buffers)
-  }
-
-  /**
-   * Writes the response into a stream.
-   * @param {Stream} stream the stream
-   * @package
-   */
-  writeTo (stream) {
-    // Write status line.
-    const statusCode = this.statusCode || HttpStatusCodes.OK
-    const statusCodeText = HttpStatusCodesText[statusCode]
-
-    stream.write(HTTP_VERSION + ' ' + statusCode + ' ' + statusCodeText + CRLF)
-
-    // Write headers.
-    // TODO: Check if content-length is a must.
-    for (let name in this._header) {
-      if (name.toLowerCase() !== 'content-length') {
-        stream.write(name + ': ' + this._header[name] + CRLF)
-      }
-    }
-
-    stream.write(CRLF) // header body separator
-
-    // Write payload.
-    if (statusCode !== 204)
-      for (const buffer of this._buffers) stream.write(buffer)
-  }
-}
-
-module.exports = PlainHttpResponse