@sap/cds 7.0.3 → 7.1.0

package/lib/env/schemas/cds-package.json

@@ -9,7 +9,9 @@
       "type": "string"
     },
     "cds": {
-      "$ref": "cdsJsonSchema://schemas/cds-rc.json"
+      "$ref": "cdsJsonSchema://schemas/cds-rc.json",
+      "description": "CDS configuration",
+      "default": {}
     }
   }
 }

package/lib/env/schemas/cds-rc.json

@@ -608,10 +608,6 @@
           "const": "hana",
           "description": "SAP HANA"
         },
-        {
-          "const": "hana-cloud",
-          "description": "SAP HANA Cloud"
-        },
         {
           "const": "sql",
           "description": "In-memory SQLite (development), SAP HANA (production)"

package/lib/linked/classes.js

@@ -1,3 +1,6 @@
+const { serve_on_root } = global.cds?.env.features || {}
+const { middlewares } = global.cds?.env.requires || {}
+const { protocols: envProtocols } = global.cds?.env || {}
 const { extend } = require('../lazy')
 
 class any {
@@ -31,22 +34,119 @@ class context extends any {}
 
 class service extends context {
 
+  static _protocols = []
+  get endpoints() { return super.endpoints = service.endpoints4(this) }
   get path() { return super.path = service.path4(this) }
 
   /**
-   * Resolve a service endpoint path to mount it to as follows...
-   * Use _path or def[@path] if given with leading '/' prepended if necessary.
-   * Otherwise, use the service definition name with stripped 'Service'
+   * Return the first service endpoint path to mount it to
    */
-  static path4 (srv, _path = (srv.definition || srv)['@path']) {
-    if (_path) return _path.startsWith('/') ? _path : '/'+_path
-    else return '/' + ( // return a sluggified variant of the service's name
-      /[^.]+$/.exec(srv.name)[0]  //> my.very.CatalogService --> CatalogService
-      .replace(/Service$/,'')     //> CatalogService --> Catalog
-      .replace(/_/g,'-')          //> foo_bar_baz --> foo-bar-baz
-      .replace(/([a-z0-9])([A-Z])/g, (_,c,C) => c+'-'+C)  //> ODataFooBarX9 --> OData-Foo-Bar-X9
-      .toLowerCase()      //> FOO --> foo
-    )
+  static path4 (srv, options = {}) {
+    return this.endpoints4(srv, options)[0]?.path
+  }
+
+  /**
+   * Return an array of protocol names to be served by the given service.
+   * Ensure that 'odata' shortcuts are expanded to 'odata-v4'.
+   */
+  static protocols4 (def, options = {}) {
+    const ov4 = p => p === 'odata' ? 'odata-v4' : p
+
+    if (options.to) return [ov4(options.to)]
+
+    const protocols = this._protocols
+    if (def) {
+      // Check @protocol annotation
+      let atProtocol = def['@protocol']
+      if (atProtocol === 'none') return []
+      if (atProtocol) {
+        const result = (Array.isArray(atProtocol) ? atProtocol : [atProtocol]).map(p => ov4(typeof p === 'string' ? p : p.kind))
+        return [...new Set(result)]
+      }
+
+      // Check @odata, @rest, ... shortcuts
+      const shortcut = Object.keys(protocols).find(p => def['@'+p])
+      if (shortcut) return [ov4(shortcut)]
+    }
+
+    // No protocol annotation found -> serve odata
+    return ['odata-v4']
+  }
+
+  static endpoints4 (srv, options = {}) {
+    const def = srv?.definition || srv
+    if (!def) return []
+
+    // Return a sluggified variant of the service's name
+    const pathFromServiceName4 = (srv) => {
+      return ( 
+        /[^.]+$/.exec(srv.name)[0]  //> my.very.CatalogService --> CatalogService
+        .replace(/Service$/,'')     //> CatalogService --> Catalog
+        .replace(/_/g,'-')          //> foo_bar_baz --> foo-bar-baz
+        .replace(/([a-z0-9])([A-Z])/g, (_,c,C) => c+'-'+C)  //> ODataFooBarX9 --> OData-Foo-Bar-X9
+        .toLowerCase()              //> FOO --> foo
+      )
+    }
+    
+    // Return an array of service paths for a given service and protocol.
+    // The results are not prefixed with the protocol's path.
+    // Can return multiple results to support serving the same protocol on multiple paths:
+    // `@protocol: [{kind: 'odata', path: '/a'}, {kind: 'odata', path: '/b'}]`
+    const unprefixedPaths4 = (protocol, srv, options) => {
+      const def = srv?.definition || srv
+      if (options.at) return [options.at]
+      if (options.path) return [options.path]
+
+      const atProtocol = def['@protocol']
+      if (atProtocol) {
+        let paths = []
+        let protocols = Array.isArray(atProtocol) ? atProtocol : [atProtocol]
+        for (let p of protocols) {
+          let pName = (p.kind || p) === 'odata' ? 'odata-v4' : p.kind || p
+          if (pName === protocol) {
+            if (p.path) paths.push(p.path)
+            else paths.push(def['@path'] || pathFromServiceName4(srv))
+          }
+        }
+        
+        // in case protocol is set via options.at but not contained in @protocol
+        if (paths.length === 0) paths.push(def['@path'] || pathFromServiceName4(srv))
+        
+        return paths
+      }
+
+      if (def['@path']) return [def['@path']]
+      return [pathFromServiceName4(srv)]
+    }
+
+    const protocols = this.protocols4(def, options)
+
+    if (protocols.length > 1 && def['@path']?.[0] === '/') {
+      throw new Error(`Absolute @path (starting with '/') cannot be set for more than one protocol`)
+    }
+
+    const endpoints = []
+    for (let pName of protocols) {
+      let p = this._protocols[pName] || envProtocols[pName]
+      if (!p) throw new Error(`Protocol "${pName}" is unknown`)
+
+      const kind = pName
+      let prefix = middlewares ? p.path || '/' : '/' // > no middlewares, no prefix
+      if (!prefix.endsWith('/')) prefix += '/'
+      const unprefixedPaths = unprefixedPaths4(pName, srv, options)
+      for (let path of unprefixedPaths) {
+        if (path.startsWith('/')) endpoints.push({ kind, path})
+        else {
+          // Extra serve in root if serve_on_root=true, but not(!) in case of ...
+          //   - multiple protocols
+          //   - empty prefix, which is the case for legacy protocol adapter
+          //   - middlewares=false (check only needed for handling of custom protocols)
+          if (middlewares && serve_on_root && protocols.length === 1 && prefix !== '/') endpoints.push({ kind, path: '/' + path })
+          endpoints.push({ kind, path: prefix + path })
+        }
+      }
+    }
+    return endpoints
   }
 }
 

package/lib/linked/entities.js

@@ -1,3 +1,4 @@
+const cds = require('../')
 const { struct } = require ('./classes')
 
 class entity extends struct   {
@@ -12,6 +13,8 @@ class entity extends struct   {
     return this.own('_compositions') || this.set('_compositions', this._elements (e => e instanceof Composition))
   }
   get drafts() {
+    // Remove this getter when old draft is removed
+    if (cds.env.fiori.lean_draft) return null
     return this.own('_drafts') || this.set('_drafts', this.elements?.HasDraftEntity && {
       name: this.name + '_drafts', keys: this.keys,
       toString(){ return this.name.replace(/\./g,'_') }

package/lib/ql/Whereable.js

@@ -8,6 +8,7 @@ class Query extends require('./Query') {
   and(...x) {  return this._where (x,'and') }
   or(...x) { return this._where (x,'or') }
   _where (args, and_or, _where) {
+    if (!args[0]) return this
     let pred = predicate4(args, _where)
     if (pred && pred.length > 0) {
       let _ = this[this.cmd]

package/lib/srv/cds-serve.js

@@ -143,7 +143,8 @@ async function _new (Service, d,m,o) {
     if (required.name) srv.name = required.name
     if (required.external && o.mocked) srv.mocked = true
   }
-  if (!srv.path) srv.path = cds.service.path4(srv,o.at)
+  if (!srv.path) srv.path = cds.service.path4(srv,o)
+  if (!srv.endpoints) srv.endpoints = cds.service.endpoints4(srv,o)
   _pending[srv.name] = new Promise (r => srv[_ready]=r).finally(()=>{
     delete _pending[srv.name]
     delete srv[_ready]

package/lib/srv/protocols/_legacy.js

@@ -6,12 +6,13 @@ const { ProtocolAdapter } = require('.')
 
 class LegacyProtocolAdapter extends ProtocolAdapter {
 
-  static init() {
-    return this.protocols = {
-      "odata-v4": { get impl() { return libx.to.odata_v4 } },
-      "odata": { get impl() { return libx.to.odata_v4 } },
-      "rest":  { get impl() { return libx.to.rest } },
-    }
+  static init(protocols = { ...cds.env.protocols }) {
+    // Legacy protocol behavior for odata and rest,
+    // but ensure that additional protocols like graphql can be configured
+    protocols['odata-v4'] = { get impl() { return libx.to.odata_v4 } }
+    protocols['odata'] = { get impl() { return libx.to.odata_v4 } }
+    protocols['rest'] = { get impl() { return libx.to.rest } }
+    return this.protocols = cds.service._protocols = protocols
   }
 
   static serve (srv, /* in: */ app) {

package/lib/srv/protocols/index.js

@@ -7,7 +7,8 @@ class ProtocolAdapter {
    * Provides canonicalized protocols configurations
    */
   static init (protocols = { ...cds.env.protocols }) {
-    return this.protocols = protocols
+    for (let each in protocols) protocols[each].kind = each
+    return this.protocols = cds.service._protocols = protocols
   }
 
   /**
@@ -25,90 +26,47 @@ class ProtocolAdapter {
   /**
    * Constructs a new adapter for the given service, or returns a formerly constructed one
    */
-  static for (srv, p = srv.options?.to || protocol4(srv.definition)) { // TODO default for param p? 
+  static for (srv, p = srv.options?.to || protocol4(srv.definition)) { // TODO default for param p?
     const cache = srv._adapters || (srv._adapters={}); if (p in cache) return cache[p]
     const impl = this.middlewareFor(p), conf = this.protocols[p]
     return cache[p] = impl (srv, conf)
   }
 
-  /**
-   * Returns the defined protocols for the given service
-   */
-  static protocols4 (def) {
-    // String, provided via srv.options.to
-    if(typeof def === 'string') {
-      return [{ kind: def }]
-    }
-  
-    // @protocol
-    let atProtocol = def?.['@protocol']
-    if (atProtocol) {
-      if (!Array.isArray(atProtocol)) atProtocol = [atProtocol]
-      return atProtocol.map(p => typeof p === 'string' ? { kind: p } : p)
-    }
-  
-    // @odata, @rest, ...
-    const atProtocolDirect = Object.keys(this.protocols).find(p => def?.['@'+p])
-    if (atProtocolDirect) return [{ kind: atProtocolDirect }]
-  
-    // No protocol annotation found -> serve odata
-    return [{ kind: Object.keys(this.protocols)[0] || 'odata-v4' }]
-  }
-
   /**
    * Constructs a new adapter for the given service, and mounts it to an express app.
    */
   static serve (srv, /* in: */ app, { before, after } = cds.middlewares) {
-    const DEBUG = cds.debug('adapters')
-    const protocols = this.protocols4(srv.options?.to || srv.definition)
+    const logger = cds.log('adapters')
 
-    if (protocols.length > 1 && !cds.requires.middlewares) {
-      cds.error `Cannot serve multiple protocols if cds.requires.middlewares is set to false`
+    const endpoints = cds.service.endpoints4(srv, srv.options)
+    
+    if (endpoints.length > 1 && !cds.requires.middlewares) {
+      cds.error `Cannot serve multiple endpoints if cds.requires.middlewares is set to false`
     }
 
-    const srvDefPath = srv.definition?.['@path']
-    if (protocols.length > 1 && srvDefPath?.[0] === '/') {
-      cds.error `Cannot serve entity with absolute @path (starting with '/') for more than one protocol`
-    }
-
-    let adapter, path, prefix
-    for (let p of protocols) {
-      adapter = this.for(srv, p.kind); if (!adapter) continue
-      path = srv.options?.at || srv.options?.path || p.path || srvDefPath || cds.service.path4(srv).slice(1)
-
-      if (path[0] !== '/') {
-        if (protocols.length === 1 && cds.env.features.serve_on_root) {
-          app.use (`/${path}/webapp/`, (_,res) => res.sendStatus(404))
-          DEBUG?.('app.use(', path, ', ... )')
-          app.use (`/${path}`, before, adapter, after)
-        }
+    for (let endpoint of endpoints) {
+      let adapter = this.for(srv, endpoint.kind); if (!adapter) continue
+      // REVISIT: still needed with new handling in @sap/cds-fiori?
+      app.use (`${endpoint.path}/webapp/`, (_,res) => res.sendStatus(404))
+      app.use (adapter.path = endpoint.path, before, adapter, after)
+      logger._debug && logger.debug('app.use(', endpoint.path, ', ... )')
 
-        if (!cds.env.features.serve_on_root) {
-          // log warning for changed path if $metadata is accessed
-          let logged = false
-          app.use(`*/${path}/\\$metadata`, (req,res,next) => {
-            if (!logged) {
-              const logger = cds.log('adapters')
-              logger._warn && logger.warn(`With @sap/cds version 7, the service path has changed to '${srv.path}'.
-             If you use SAP Fiori Elements, make sure to adapt the 'dataSources.uri' paths
-             in 'manifest.json' files accordingly. For more information, see the release notes at
-             https://cap.cloud.sap/docs/releases/jun23.`)
-              logged = true
-            }
-            next()
-          })
-        }
-
-        prefix = this.protocols[p.kind].path
-        prefix = prefix ? (prefix.endsWith('/') ? prefix : prefix + '/') : '/'
-        path = prefix + path
+      // REVISIT: move to @sap/cds-fiori
+      // log warning for changed path if $metadata is accessed
+      if (!cds.env.features.serve_on_root && endpoint.path.startsWith(this.protocols[endpoint.kind].path)) {
+        const oldPath = endpoint.path.replace(this.protocols[endpoint.kind].path, '')
+        let logged = false
+        app.use(`*${oldPath}/\\$metadata`, (req,res,next) => {
+          if (!logged) {
+            logger._warn && logger.warn(`With @sap/cds version 7, the service path has changed to '${endpoint.path}'.
+            If you use SAP Fiori Elements, make sure to adapt the 'dataSources.uri' paths
+            in 'manifest.json' files accordingly. For more information, see the release notes at
+            https://cap.cloud.sap/docs/releases/jun23.`)
+            logged = true
+          }
+          next()
+        })
       }
-
-      app.use (`${path}/webapp/`, (_,res) => res.sendStatus(404))
-      DEBUG?.('app.use(', path, ', ... )')
-      app.use (path, before, adapter, after)
-      // REVISIT this doesn't handle multiple protocols correctly
-      srv.path = path
     }
   }
 }
@@ -118,6 +76,6 @@ const protocols = Object.keys(ProtocolAdapter.init())
 const protocol4 = (def, _default = protocols[0] || 'odata-v4') => def?.['@protocol'] || protocols.find(p => def['@'+p]) || _default
 
 module.exports = { ProtocolAdapter, protocol4 }
-if (!cds.env.protocols && !cds.requires.middlewares) {
+if (!cds.requires.middlewares) {
   module.exports.ProtocolAdapter = require('./_legacy')
 }

package/libx/_runtime/cds-services/adapter/odata-v4/handlers/read.js

@@ -16,7 +16,7 @@ const FUNCTION = { [BOUND_FUNCTION]: 1, [FUNCTION_IMPORT]: 1 }
 const { isCustomOperation } = require('../utils/request')
 const { getActionOrFunctionReturnType } = require('../utils/handlerUtils')
 const { validateResourcePath } = require('../utils/request')
-const { toODataResult, postProcess } = require('../utils/result')
+const { toODataResult, postProcess, setStreamingHeaders } = require('../utils/result')
 const { isStreaming } = require('../utils/stream')
 const { resolveStructuredName } = require('../utils/handlerUtils')
 const getError = require('../../../../common/error')
@@ -245,7 +245,15 @@ const _reliablePagingPossible = req => {
 const _readCollection = async (tx, req, odataReq) => {
   commonGenericPaging(req)
   commonGenericSorting(req)
+
   const result = (await tx.dispatch(req)) || []
+
+  if (req.http?.req?.headers?.accept?.match(/application\/pdf/)) {
+    if (!result.$mediaContentType) result.$mediaContentType = 'application/pdf'
+    setStreamingHeaders(result, req)
+    return result
+  }
+
   if (Array.isArray(req.query)) {
     const adjustedResult = []
     if (req.query[0].SELECT.count) adjustedResult.$count = 0
@@ -287,9 +295,7 @@ const _readCollection = async (tx, req, odataReq) => {
     }
   }
 
-  const odataResult = toODataResult(result, req)
-
-  return odataResult
+  return toODataResult(result, req)
 }
 
 /**
@@ -483,6 +489,9 @@ const read = service => {
       if (changeset) {
         // for passing into commit
         odataReq.getBatchApplicationData().results[changeset].push({ result, req })
+      } else if (result.value && isStreaming(odataReq.getUriInfo().getPathSegments())) {
+        result.value.on('end', () => tx.commit(result).catch(() => {}))
+        result.value.once('error', err => tx.rollback(err).catch(() => {}))
       } else {
         await tx.commit(result)
       }

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

@@ -17,6 +17,8 @@ const HttpHeader = require('../http/HttpHeader')
 const ResponseContract = require('../core/ResponseContract')
 const NotAcceptableError = require('../errors/NotAcceptableError')
 
+const SerializerFactory = require('../serializer/SerializerFactory')
+
 class ResponseContentNegotiator {
   /**
    * Sets the logger.
@@ -194,6 +196,16 @@ class ResponseContentNegotiator {
     }
 
     if (!formatDescription) {
+      if (acceptHeader?.match(/application\/pdf/) && representationKind === 'ENTITY_COLLECTION') {
+        return new ResponseContract()
+          .setRepresentationKind(representationKind)
+          .setSerializerFunction((context, data, options = {}, next) => {
+            options.stream = true
+            SerializerFactory.value(context, data, options, next)
+          })
+          .setContentTypeInfo(new ContentTypeInfo().setMimeType('application/pdf'))
+      }
+
       this._logger.warning(
         `No matching content type found for representation kind '${representationKind}'` +
           ` and accept '${acceptHeader}'`

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

@@ -427,7 +427,9 @@ class SerializerFactory {
     if (type.getKind() === EdmTypeKind.DEFINITION) type = type.getUnderlyingType()
 
     let propertyOrReturnType
-    if (uriInfo.getLastSegment()._isStreamByDollarValue) {
+    if (options?.stream) {
+      type = EdmPrimitiveTypeKind.Stream
+    } else if (uriInfo.getLastSegment()._isStreamByDollarValue) {
       for (const [propertyName, property] of uriInfo.getLastSegment(-1).getEdmType().getOwnProperties()) {
         if (property.getType() === EdmPrimitiveTypeKind.Stream) {
           propertyOrReturnType = property

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

@@ -3,7 +3,7 @@
 const crypto = require('crypto')
 
 const cds = require('../../../../../../cds')
-const DEBUG = cds.debug('odata', '[odata] -')
+const DEBUG = cds.debug('odata')
 
 const CACHE_LIMIT_KB = (cds.env.odata && cds.env.odata.metadataCacheLimit) || 10240 // 10 Megabyte cache limit per mimeType
 

package/libx/_runtime/cds-services/adapter/odata-v4/utils/metaInfo.js

@@ -7,11 +7,8 @@ const { getNavigationIfStruct } = require('../../../../common/utils/structured')
 const getTemplate = require('../../../../common/utils/template')
 const templateProcessor = require('../../../../common/utils/templateProcessor')
 
-const _ignoreColumns = (columns, options) => {
+const _ignoreColumns = columns => {
   if (!(Array.isArray(columns) && columns.some(c => c === '*' || c.as || c.ref))) return true
-  // REVISIT expand=* => list all expanded properties (as by okra's implementation)
-  // OData spec is clarified (https://github.tools.sap/cap/cds/pull/1183#pullrequestreview-1775872)
-  if (options && !options.$select && options.$expand === '*') return true
 }
 
 const _getNestedQueryOptions = (ref, expand, expandString) => {

package/libx/_runtime/cds-services/adapter/odata-v4/utils/result.js

@@ -46,9 +46,9 @@ const _getPropertyName = req => {
   }
 }
 
-const _cleanupMetadata = (odataResult, result, req) => {
-  if (typeof result !== 'object') return odataResult
+const setStreamingHeaders = (result, req) => {
   // backwards compatibility for content-type in stream
+  if ('$mediaContentType' in result) result['*@odata.mediaContentType'] = result.$mediaContentType
   if ('*@odata.mediaContentType' in result) result.$mediaContentType = result['*@odata.mediaContentType']
   if ('$mediaContentDispositionFilename' in result && req) {
     const cdt = result.$mediaContentDispositionType || 'attachment'
@@ -57,6 +57,12 @@ const _cleanupMetadata = (odataResult, result, req) => {
       `${cdt}; filename="${encodeURIComponent(result.$mediaContentDispositionFilename)}"`
     )
   }
+}
+
+const _cleanupMetadata = (odataResult, result, req) => {
+  if (typeof result !== 'object') return odataResult
+
+  setStreamingHeaders(result, req)
 
   const keysToCleanup = {
     // do not set "@odata.context" as it may be inherited of remote service
@@ -370,7 +376,6 @@ const postProcess = (req, res, service, result, previousResult) => {
 
 const postProcessMinimal = (req, service, result) => {
   const { target, timestamp } = req
-
   if (!target || !result) return
 
   setLocationHeader(req, service)
@@ -386,5 +391,6 @@ const postProcessMinimal = (req, service, result) => {
 module.exports = {
   toODataResult,
   postProcess,
-  postProcessMinimal
+  postProcessMinimal,
+  setStreamingHeaders
 }

package/libx/_runtime/cds-services/services/utils/columns.js

@@ -40,6 +40,12 @@ const getColumns = (
   return columns
 }
 
+const _isColumnCalculated = (query, columnName) => {
+  if (!query) return false
+  if (query.SELECT?.columns?.find(col => col.xpr && col.as === columnName)) return true
+  return _isColumnCalculated(query._target?.query, columnName)
+}
+
 const _getSearchableColumns = entity => {
   const columnsOptions = { removeIgnore: true, filterVirtual: true }
   const columns = getColumns(entity, columnsOptions)
@@ -82,11 +88,11 @@ const _getSearchableColumns = entity => {
     if (atLeastOneColumnIsSearchable) return false
 
     // the element is considered searchable if it is explicitly annotated as such or
-    // if it is not annotated and the column is typed as a string (excluding elements/elements expressions)
+    // if it is not annotated and the column is typed as a string (excluding calculated fields)
     return (
       annotatedColumnValue === undefined &&
       column._type === DEFAULT_SEARCHABLE_TYPE &&
-      !entity?.query?.SELECT?.columns?.find(col => col.xpr && col.as === column.name)
+      !_isColumnCalculated(entity?.query, column.name)
     )
   })
 

package/libx/_runtime/cds-services/services/utils/differ.js

@@ -22,7 +22,7 @@ module.exports = class Differ {
       // Don't take into account virtual or computed properties to make the diff result
       // consistent with the ones for UPDATE/CREATE (where we don't have access to that
       // information).
-      if (!element.key && (element.virtual || element['@Core.Computed'])) continue
+      if (!element.key && (element.virtual || element._isReadOnly)) continue
       if (element.isComposition) {
         if (element._target._hasPersistenceSkip) continue
         columns.push({