@sap/cds 8.7.2 → 8.8.0

package/libx/rest/RestAdapter.js

@@ -8,8 +8,7 @@ const deleet = require('./middleware/delete')
 const operation = require('./middleware/operation')
 const error = require('./middleware/error')
 
-const { bufferToBase64 } = require('../_runtime/common/utils/binary')
-const getTemplate = require('../_runtime/common/utils/template')
+const { postProcessData } = require('./post-processing')
 
 const HttpAdapter = require('../../lib/srv/protocols/http')
 const bodyParser4 = require('../odata/middleware/body-parser')
@@ -22,17 +21,6 @@ class RestRequest extends NoaRequest {
   }
 }
 
-const _processorFn = elementInfo => {
-  const { row, key, plain } = elementInfo
-  if (plain.categories.includes('@cds.api.ignore')) delete row[key]
-}
-
-const _pick = element => {
-  const categories = []
-  if (element['@cds.api.ignore'] && !element.isAssociation) categories.push('@cds.api.ignore')
-  if (categories.length) return { categories }
-}
-
 class RestAdapter extends HttpAdapter {
   request4(args) {
     return new RestRequest(args)
@@ -127,9 +115,7 @@ class RestAdapter extends HttpAdapter {
           srv.model.definitions[definition] ||
           srv.model.definitions[definition.split(':$:')[0]].actions[definition.split(':$:')[1]]
       if (result && srv && definition) {
-        bufferToBase64(result, srv, definition)
-        const template = getTemplate('process_result', srv, definition, { pick: _pick })
-        template.process(result, _processorFn)
+        postProcessData(result, srv, definition)
       }
 
       if (status && res.statusCode === 200) res.status(status) //> only set status if not yet modified

package/libx/rest/middleware/operation.js

@@ -1,10 +1,12 @@
 const cds = require('../../_runtime/cds')
+const getError = require('../../_runtime/common/error')
 
 const { checkStatic } = require('../../_runtime/cds-services/util/assert')
-const getError = require('../../_runtime/common/error')
+const { Readable } = require('node:stream')
 
 // REVISIT: strict or relaxed type checkers?
 const typeCheckers = require('../../common/assert/type-strict')
+const streaming = require('../../common/utils/streaming')
 
 // REVISIT: use i18n
 const _enrichErrorDetails = (isPrimitive, error) => {
@@ -74,21 +76,40 @@ module.exports = adapter => {
 
   return async function operation(req, res) {
     const { _query: query, _operation: operation, _data: data, _params: params } = req
-
-    let result
-
-    result = await service.dispatch(
-      adapter.request4(
-        Object.assign(
-          query
-            ? { query, event: operation.name }
-            : { event: operation.name.replace(`${service.definition.name}.`, '') },
-          { data, params, req, res }
-        )
+    const request = adapter.request4(
+      Object.assign(
+        query // REVISIT: when is a query given, and when not? -> bound vs unbound? -> obsolete with req.subject? -> deprecated?
+          ? { event: operation.name, query } // REVISIT: why don't we need a similar .replace as below here?
+          : { event: operation.name.replace(`${service.definition.name}.`, '') }, // REVISIT: why is this .replace needed?
+        { data, params, req, res } // REVISIT: req and res are not part of the public API !!!
       )
     )
 
-    if (!operation.returns) return { status: 204 }
+    let result = await service.dispatch(request)
+
+    if (!operation.returns || result == null) return { status: 204 }
+
+    const _isStream = result instanceof Readable || (operation.returns._type === 'cds.LargeBinary' && 'value' in result)
+    if (_isStream) {
+      const stream = streaming.getReadable(result)
+      if (!stream) return res.sendStatus(204)
+
+      const { mimetype, filename, disposition } = streaming.collectStreamMetadata(result, operation, query)
+      streaming.validateMimetypeIsAcceptedOrThrow(req.headers, mimetype)
+
+      if (mimetype && !res.get('Content-Type'))
+        res.set('Content-Type', mimetype)
+
+      if (filename && !res.get('Content-Disposition'))
+        res.set('Content-Disposition', `${disposition}; filename="${filename}"`)
+        // NOTE: We should NOT use encodeURIComponent here, as it is not needed for the filename in the Content-Disposition header
+        //       and it would break the filename in the header if it contains special characters like
+        //       e.g. German umlauts (ä, ö, ü) or spaces
+        //       See also: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition
+
+      return stream.pipe(res) && {} // REVISIT: strange caller expects this
+    }
+
 
     // REVISIT: do not use from old rest adapter
     // REVISIT: new impl should return instead of throwing to avoid try catch
@@ -97,11 +118,10 @@ module.exports = adapter => {
     // set content-type header to text/plain for returned primitive data types, except for boolean
     const returnType = operation.returns._type
     if (
-      !res.get('content-type') &&
-      !operation.returns.items &&
-      returnType &&
       cds.builtin.types[returnType] &&
-      returnType !== 'cds.Boolean'
+      !operation.returns.items &&
+      returnType !== 'cds.Boolean' &&
+      !res.get('content-type')
     ) {
       res.set('Content-Type', 'text/plain')
     }
@@ -112,7 +132,7 @@ module.exports = adapter => {
       res.set('Content-Type', 'application/json')
     }
 
-    // REVISIT: still needed?
+    // REVISIT: still needed? // REVISIT: indeed!
     if (!operation.returns.items && Array.isArray(result)) result = result[0]
 
     if (result === undefined) return { status: 204 }

package/libx/rest/middleware/parse.js

@@ -1,31 +1,11 @@
 const cds = require('../../_runtime/cds')
 const { INSERT, SELECT, UPDATE, DELETE } = cds.ql
 
-const { getKeysAndParamsFromPath } = require('../../common/utils')
+const { getKeysAndParamsFromPath } = require('../../common/utils/path')
 
-const { base64ToBuffer } = require('../../_runtime/common/utils/binary')
+const { preProcessData } = require('../pre-processing')
 const { convertStructured } = require('../../_runtime/common/utils/ucsn')
-const getTemplate = require('../../_runtime/common/utils/template')
 
-const { checkStaticElementByKey } = require('../../_runtime/cds-services/util/assert')
-
-const _processorFn = errors => {
-  return ({ row, key, plain: categories, target }) => {
-    // REVISIT move validation to generic asserter => see PR 717
-    if (categories['static_validation'] && row[key] != null) {
-      const validations = checkStaticElementByKey(target, key, row[key])
-      errors.push(...validations)
-    }
-  }
-}
-
-const _picker = element => {
-  const categories = {}
-  if (Array.isArray(element)) return
-  if (element._isStructured || element.isAssociation || element.items) return
-  categories['static_validation'] = true
-  return categories
-}
 
 const _cache = req => `rest-input;skip-key-validation:${req.method !== 'POST'}`
 
@@ -149,14 +129,14 @@ module.exports = adapter => {
           convertStructured(service, operation || definition, payload, {
             cleanupStruct: cds.env.features.rest_struct_data
           })
-          const template = getTemplate(_cache(req), service, definition, { pick: _picker })
-          template.process(payload, _processorFn(errs))
+          preProcessData(payload, service, definition, _cache, errs)
           if (errs.length) {
             if (errs.length === 1) throw errs[0]
             throw Object.assign(new Error('MULTIPLE_ERRORS'), { statusCode: 400, details: errs })
           }
+        } else {
+          preProcessData(payload, service, definition)
         }
-        base64ToBuffer(payload, service, definition)
         req._data = payload
       }
     }

package/libx/rest/post-processing.js

@@ -0,0 +1,33 @@
+const getTemplate = require('../_runtime/common/utils/template')
+const _picker = element => {
+  const categories = []
+  if (Array.isArray(element)) return
+  if (element.type === 'cds.Binary' || element.type === 'cds.LargeBinary') categories.push('convert_binary')
+  if (element['@cds.api.ignore'] && !element.isAssociation) categories.push('@cds.api.ignore')
+  if (categories.length) return { categories }
+}
+
+const _processorFn = elementInfo => {
+  const { row, key, plain } = elementInfo
+  if (typeof row !== 'object') return
+  for (const category of plain.categories) {
+    switch (category) {
+      case 'convert_binary':
+        if (row[key] != null && Buffer.isBuffer(row[key])) row[key] = row[key].toString('base64')
+        break
+      case '@cds.api.ignore':
+        delete row[key]
+        break
+      // no default
+    }
+  }
+}
+
+const postProcessData = (data, srv, definition) => {
+  const template = getTemplate('rest-post-process', srv, definition, { pick: _picker })
+  template.process(data, _processorFn)
+}
+
+module.exports = {
+  postProcessData
+}

package/libx/rest/pre-processing.js

@@ -0,0 +1,38 @@
+const getTemplate = require('../_runtime/common/utils/template')
+const { checkStaticElementByKey } = require('../_runtime/cds-services/util/assert')
+const _picker = element => {
+  const categories = []
+  if (Array.isArray(element)) return
+  if (element.type === 'cds.Binary' || element.type === 'cds.LargeBinary') categories.push('convert_binary')
+  if (!(element._isStructured || element.isAssociation || element.items)) categories.push('static_validation')
+  if (categories.length) return { categories }
+}
+
+const _processorFn = errors => elementInfo => {
+  const { row, key, plain, target } = elementInfo
+  if (typeof row !== 'object') return
+  if (row[key] == null) return
+  for (const category of plain.categories) {
+    switch (category) {
+      case 'convert_binary':
+        if (typeof row[key] === 'string') row[key] = Buffer.from(row[key], 'base64')
+        break
+      case 'static_validation':
+        if (errors) { //> errors collector is only provided in case of !cds.env.features.cds_validate
+          // REVISIT move validation to generic asserter => see PR 717
+          const validations = checkStaticElementByKey(target, key, row[key])
+          errors.push(...validations)
+        }
+        break
+    }
+  }
+}
+
+const preProcessData = (data, srv, definition, usecase = 'rest-pre-process', errors) => {
+  const template = getTemplate(usecase, srv, definition, { pick: _picker })
+  template.process(data, _processorFn(errors))
+}
+
+module.exports = {
+  preProcessData
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/cds",
-  "version": "8.7.2",
+  "version": "8.8.0",
   "description": "SAP Cloud Application Programming Model - CDS for Node.js",
   "homepage": "https://cap.cloud.sap/",
   "keywords": [

package/libx/common/utils/index.js

@@ -1,5 +0,0 @@
-const { getKeysAndParamsFromPath } = require('./path')
-
-module.exports = {
-  getKeysAndParamsFromPath
-}