@sap/cds 7.6.3 → 7.7.0

package/CHANGELOG.md

@@ -4,6 +4,43 @@
 - The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - This project adheres to [Semantic Versioning](http://semver.org/).
 
+## Version 7.7.0 - 2024-02-26
+
+### Added
+
+- Improved trace output for bootstrap phase. For example try that:
+   ```js
+   DEBUG=trace cds w bookshop | grep trace
+   ```
+- Support for `@odata.draft.bypass` to allow direct modifications of active instances.
+- `req.user.tokenInfo` for `@sap/xssec`-based authentication (`ias`, `jwt`, `xsuaa`)
+- `cds.fiori.draft_lock_timeout` as successor of `cds.drafts.cancellationTimeout`.
+  + Possible values are /^([0-9]+)(h|hrs|min)$/ or a number in milliseconds.
+- There is a new `sap.common.Timezones` entity with a basic time zone definition. There will be accompanying data in package `@sap/cds-common-content`.
+- Deprecation warnings for configuration options `cds.drafts.cancellationTimeout`, `cds.features.serve_on_root`, `cds.features.stream_compat`, `cds.fiori.lean_draft` and `cds.requires.middlewares`, as well as for the properties `req.user.locale` and `req.user.tenant`. The deprecation warnings can be turned off by setting `cds.features.deprecated` to `off`. 
+
+### Changed
+
+- The index page now lists all service endpoints, which is important for services that are exposed through multiple protocols.
+- `cds.deploy` improves error diagnostics with deeper `Query` object inspection.
+- Slightly changed the default export for ESM compatibility. This fixed failing ESM imports in Vitest tests.
+
+### Fixed
+
+- Persistent outbox must not be used for `t0` tenant.
+- Second `await cds.connect.to('X')`, where initialization of `X` results in an error, did not return.
+- Support additional draft requests.
+- `cds.log` with `null` as argument.
+
+## Version 7.6.4 - 2024-02-21
+
+### Fixed
+
+- Emitting multiple message with an in-memory outbox
+- Occasional crash for invalid draft requests
+- On the index page, aditional links now show up again for non-OData services.
+- Handling of thenables for queries
+
 ## Version 7.6.3 - 2024-02-13
 
 ### Fixed
@@ -47,7 +84,7 @@
 - Use new CDS schema for validation and code completion in `package.json` and `.cdsrc.json` files
 - Media Data Streaming
   + OData: Large binaries without `@Core.MediaType` annotation were previously returned as base64-encoded buffer. Starting from this `@sap/cds` version also not-annotated large binaries are ignored by OData. It is strongly recommended to annotate all large binary properties with `@Core.MediaType` and use it according to streaming scenarios.
-  + Custom Handlers: `SELECT` with explicitely listed `SELECT.columns` of type `cds.LargeBinary` returns them as Readable streams. Large binary columns requested implicitely by `SELECT` (for example, with `.columns('*')`) are ignored.
+  + Custom Handlers: `SELECT` with explicitly listed `SELECT.columns` of type `cds.LargeBinary` returns them as Readable streams. Large binary columns requested implicitly by `SELECT` (for example, with `.columns('*')`) are ignored.
   + Streaming API: `cds.stream()` and `srv.stream()` are deprecated and will be removed with the next major release. Use `SELECT` with a single `cds.LargeBinary` column instead. The resulting object will contain the name of the column and a stream value. For example, `SELECT.one.from(E).columns(['image']).where(...)` returns `{ image: <media stream> }`.
   + Backward Compatibility: To restore previous behavior use `stream_compat`.
 

package/_i18n/i18n.properties

@@ -70,6 +70,9 @@ LanguageCode=Language Code
 #XTIT: Language Code Description
 LanguageCode.Description=A language code as specified in ISO 639-1
 
+#XTIT Time zone code
+TimeZoneCode=Time Zone Code
+
 #XTIT: User Identifier
 UserID=User ID
 

package/app/index.js

@@ -1,8 +1,9 @@
 const cds = require('../lib')
 const { find, path, fs } = cds.utils
 
-const odata = srv => srv.endpoints?.[0]?.kind.startsWith('odata')
-const metadata = srv => odata(srv) ? ` / <a href="${srv.path}/$metadata">$metadata</a>` : ``
+const odata = endpoint => endpoint.kind.startsWith('odata')
+const metadata = endpoint => odata(endpoint) ? ` / <a href="${endpoint.path}/$metadata">$metadata</a>` : ``
+const asHtmlId = s => s.replace(/[.:/$&?@]/g, '_').toLowerCase()
 
 module.exports = { get html(){
 
@@ -14,16 +15,21 @@ module.exports = { get html(){
       html => `\n<li><a href="${html}">/${html.replace(/^\//,'').replace('/index.html','')}</a></li>`
     ).join('\n') || '— none —'
   )
-  .replace ('{{services}}', cds.service.providers.map (srv => srv._is_dark ? '' : `
+  .replace ('{{services}}', cds.service.providers
+  .filter(srv => !srv._is_dark)
+  .flatMap(srv => srv.endpoints.map(endpoint => ({srv, endpoint})))
+  .map (({srv, endpoint}) => `
+      <div id="${asHtmlId(srv.name)}-${endpoint.kind}">
         <h3>
-          <a href="${srv.path}">${srv.path}</a>${metadata(srv)} ${_moreLinks(srv)}
+          <a href="${endpoint.path}">${endpoint.path}</a>${metadata(endpoint)} ${_moreLinks(srv, endpoint)}
         </h3>
         <ul>${_entities_in(srv).map (e => {
           return `
-          <li>
-            <a href="${srv.path}/${e.replace(/\./g, '_')}">${e}</a> ${_moreLinks(srv, e)}
+          <li id="${asHtmlId(srv.name)}-${endpoint.kind}-${asHtmlId(e)}">
+            <a href="${endpoint.path}/${e.replace(/\./g, '_')}">${e}</a> ${_moreLinks(srv, endpoint, e)}
           </li>`}).join('')}
         </ul>
+      </div>
   `).join(''))
 
   Object.defineProperty (this,'html',{value:html})
@@ -52,13 +58,13 @@ function _entities_in (service) {
   return exposed
 }
 
-function _moreLinks (srv, entity) {
-  return odata(srv) ? (srv.$linkProviders || [])
-    .map (linkProv => linkProv(entity))
-    .filter (l => l && l.href && l.name)
-    .sort ((l1, l2) => l1.name.localeCompare(l2))
+function _moreLinks (srv, endpoint, entity) {
+  return (srv.$linkProviders || [])
+    .map (linkProv => linkProv(entity, endpoint))
+    .filter (l => l?.href && l?.name)
+    .sort ((l1, l2) => l1.name.localeCompare(l2.name))
     .map (l => ` <a class="preview" href="${l.href}" title="${l.title||l.name}"> &rarr; ${l.name}</a>`)
-    .join (' ') : ''
+    .join (' ')
 }
 
 function _project(){

package/bin/serve.js

@@ -159,11 +159,12 @@ async function serve (all=[], o={}) {
   await cds.plugins
 
   const TRACE = cds.debug('trace')
-  // if (TRACE) {
-  //   TRACE?.time('load express   '); require('express') // eslint-disable-line cds/no-missing-dependencies
-  //   TRACE?.timeEnd('load express   ')
-  // }
-  TRACE?.time('cds bootstrap  ')
+  TRACE?.time('total startup time'.padEnd(22))
+  if (TRACE) {
+    TRACE?.time('require express'.padEnd(22))
+    require('express') // eslint-disable-line cds/no-missing-dependencies
+    TRACE?.timeEnd('require express'.padEnd(22))
+  }
 
   // Load local server.js early in order to allow setting custom cds.log.Loggers
   const cds_server = await _local_server_js() || cds.server
@@ -186,8 +187,6 @@ async function serve (all=[], o={}) {
 
   }
 
-  TRACE?.timeEnd('cds bootstrap  ')
-
   // bootstrap server from project-local server.js or from @sap/cds/server.js
   const server = await cds_server(o)
 
@@ -210,8 +209,10 @@ async function serve (all=[], o={}) {
 
     const LOG = cds.log('cli|server')
     cds.shutdown = _shutdown //> for programmatic invocation
-    process.on('unhandledRejection', e => _shutdown (e, cds.log().error('❗️Uncaught',e))) //> using std logger to have it labelled with [cds] - instead of [cli] -
-    process.on('uncaughtException', e => _shutdown (e, cds.log().error('❗️Uncaught',e)))  //> using std logger to have it labelled with [cds] - instead of [cli] -
+    if (!cds.repl) {
+      process.on('unhandledRejection', e => _shutdown (e, cds.log().error('❗️Uncaught',e))) //> using std logger to have it labelled with [cds] - instead of [cli] -
+      process.on('uncaughtException', e => _shutdown (e, cds.log().error('❗️Uncaught',e)))  //> using std logger to have it labelled with [cds] - instead of [cli] -
+    }
     process.on('SIGINT', cds.watched ? _shutdown : (s,n)=>_shutdown(s,n,console.log())) //> newline after ^C
     process.on('SIGHUP', _shutdown)
     process.on('SIGHUP2', _shutdown)
@@ -236,6 +237,7 @@ async function serve (all=[], o={}) {
       process.on('message', msg => msg.close && _shutdown())  // by `cds watch` on Windows
     }
 
+    TRACE?.timeEnd('total startup time'.padEnd(22))
     return server
   })
 }
@@ -259,13 +261,13 @@ function _prepare_logging () { // NOSONAR
   console.time (_timer)
 
   // print information when model is loaded
-  cds.on ('loaded', (model)=>{
-    LOG.info (`loaded model from ${model.$sources.length} file(s):\n${COLORS ? '\x1b[2m' : ''}`)
-    const limit = 30, shown = model.$sources.length === limit + 1 ? limit + 1 : limit // REVISIT: configurable limit?
-    for (let each of model.$sources.slice(0, shown))  console.log (' ', local(each))
-    if (model.$sources.length > shown) {
-      if (LOG._debug) for (let each of model.$sources.slice(shown))  console.log (' ', local(each))
-      else console.log (`  ...${model.$sources.length-shown} more. Run with DEBUG=serve to show all files.`)
+  cds.on ('loaded', ({$sources:srcs})=>{
+    LOG.info (`loaded model from ${srcs.length} file(s):\n${COLORS ? '\x1b[2m' : ''}`)
+    const limit = 30, shown = srcs.length === limit + 1 ? limit + 1 : limit // REVISIT: configurable limit?
+    for (let each of srcs.slice(0, shown))  console.log (' ', local(each))
+    if (srcs.length > shown) {
+      if (LOG._debug) for (let each of srcs.slice(shown))  console.log (' ', local(each))
+      else console.log (`  ...${srcs.length-shown} more. Run with DEBUG=serve to show all files.`)
     }
     COLORS && console.log ('\x1b[0m')
   })
@@ -278,10 +280,13 @@ function _prepare_logging () { // NOSONAR
   // print information about each provided service
   cds.on ('serving', (srv) => {
     const details = {}
-    if (srv.path) details.path = srv.path
     if (srv._source && !srv._source.startsWith('@sap'))
       details.impl = local(srv._source)
-      LOG.info (`${srv.mocked ? 'mocking' : 'serving'} ${srv.name}`, details)
+    if (srv.endpoints.length === 1)
+      details.path = srv.endpoints[0].path // for brevity, omit 'kind' if there is only one protocol
+    else if (srv.endpoints.length > 1)
+      details.endpoints = srv.endpoints    // full endpoint details if more than one
+    LOG.info (`${srv.mocked ? 'mocking' : 'serving'} ${srv.name}`, details)
   })
 
   // print info when we are finally on air
@@ -291,8 +296,35 @@ function _prepare_logging () { // NOSONAR
     _timer && console.timeEnd (_timer)
     if (process.stdin.isTTY) LOG.info (`[ terminate with ^C ]\n`)
   })
-}
 
+  // print config deprecation warnings
+  if (cds.env.features.deprecated !== 'off') {
+    cds.once ('listening', () => {
+      // Remove with cds 8
+      if (cds.env.drafts?.cancellationTimeout)
+        cds.utils.deprecated({
+          old: 'cds.drafts.cancellationTimeout',
+          use: 'cds.fiori.draft_lock_timeout with adapted value'
+        })
+    
+      // Remove with cds 8
+      if (!cds.env.fiori.lean_draft)
+        cds.utils.deprecated({ old: 'cds.fiori.lean_draft' })
+      
+      // Remove with cds 8
+      if (!cds.requires.middlewares)
+        cds.utils.deprecated({ old: 'cds.requires.middlewares' })
+
+      // Remove with cds 8
+      if (cds.env.features.serve_on_root)
+        cds.utils.deprecated({ old: 'cds.features.serve_on_root', use: '@path annotation or adapt your consumers' })
+
+      // Remove with cds 8
+      if (cds.env.features.stream_compat)
+        cds.utils.deprecated({ old: 'cds.features.stream_compat' })
+    })
+  }
+}
 
 /** handles --watch option */
 function _watch (project,o) {

package/common.cds

@@ -19,6 +19,13 @@ type Currency : Association to sap.common.Currencies;
  */
 type Country : Association to sap.common.Countries;
 
+/**
+ * Type for an association to Timezones
+ *
+ * See https://cap.cloud.sap/docs/cds/common#type-timezone
+ */
+type Timezone : Association to sap.common.Timezones;
+
 /**
  * Entities to serve the reuse types with extensible code lists
  * including built-in support for value lists in Fiori.
@@ -61,6 +68,15 @@ context sap.common {
         minorUnit : Int16     @(title : '{i18n>CurrencyMinorUnit}');
   }
 
+  /**
+   * Code list for time zones
+   *
+   * See https://cap.cloud.sap/docs/cds/common#entity-timezones
+   */
+  entity Timezones : CodeList {
+    key code : String(100) @(title: '{i18n>TimeZoneCode}');
+  }
+
   /**
    * Aspect for a code list with name and description
    *

package/lib/auth/ias-auth.js

@@ -25,7 +25,7 @@ module.exports = function ias_auth(config) {
       //> grant_type === client_credentials or x509
       const roles = ['system-user']
       if (clientid === credentials.clientid) roles.push('internal-user')
-      return new cds.User({ id: 'system', roles })
+      return new cds.User({ id: 'system', roles, tokenInfo })
     }
 
     // add all unknown attributes to req.user.attr in order to keep public API small
@@ -38,7 +38,7 @@ module.exports = function ias_auth(config) {
     if (attr.given_name) attr.givenName = attr.given_name
     if (attr.family_name) attr.familyName = attr.family_name
 
-    return new cds.User({ id: payload.sub, attr })
+    return new cds.User({ id: payload.sub, attr, tokenInfo })
   }
 
   return (req, _, next) => {

package/lib/auth/index.js

@@ -55,7 +55,7 @@ module.exports = function auth_factory (o) {
 function ctx_auth (req, res, next) {
   const ctx = cds.context
   ctx.user = req.user
-  ctx.tenant = req.tenant || ctx.user?.tenant
+  ctx.tenant = req.tenant || req.user?.tenant
   next()
 }
 

package/lib/auth/jwt-auth.js

@@ -40,7 +40,7 @@ module.exports = function jwt_auth(config) {
       attr.email = payload.email
     }
 
-    return new cds.User({ id, roles, attr })
+    return new cds.User({ id, roles, attr, tokenInfo })
   }
 
   return (req, _, next) => {

package/lib/compile/cdsc.js

@@ -76,8 +76,8 @@ const _options = {for: Object.assign (_options4, {
 
   hana(o) {
     let cdsc = this.sql (o, cds.env.hana) // returns clone
-    cdsc.sqlChangeMode = cdsc.journal && cdsc.journal['change-mode']
-    cdsc.disableHanaComments = !cdsc.comments
+    cdsc.sqlChangeMode ??= cdsc.journal && cdsc.journal['change-mode']
+    cdsc.disableHanaComments ??= !cdsc.comments
     delete cdsc.journal // cleanup avoiding side effects
     delete cdsc.comments
     return cdsc
@@ -125,15 +125,27 @@ module.exports = exports = {__proto__:compile, _options,
     edm: Object.assign ((csn,o) => compile.to.edm (csn, _options.for.edm(o)), {
       all: (csn,o) => compile.to.edm.all (csn, _options.for.edm(o))
     }),
-    hdi: Object.assign ((csn,o) => compile.to.hdi (csn, _options.for.hana(o)), {
-      migration: (csn,o,...etc) => {
-        o = Object.assign ({...o},_options.for.hana(o)) //> REVISIT: need to flatten as compiler seems to clone options in that impl
-        return compile.to.hdi.migration (csn, o, ...etc)
-      }
-    }),
-    hdbcds: (csn,o) => compile.to.hdbcds (csn, _options.for.hana(o) ),
-    sql: (csn,o) => compile.to.sql (csn, _options.for.sql(o) ),
+    hdi: Object.assign ((csn,o) => compile.to.hdi (csn, _options.for.hana(o)),
+      compile.to.hdi, // keywords
+      {
+        migration: (csn,o,...etc) => {
+          o = Object.assign ({...o},_options.for.hana(o)) //> REVISIT: need to flatten as compiler seems to clone options in that impl
+          return compile.to.hdi.migration (csn, o, ...etc)
+        }
+      },
+    ),
+    hdbcds: Object.assign(
+      (csn,o) => compile.to.hdbcds (csn, _options.for.hana(o)),
+      compile.to.hdbcds // keywords
+    ),
+    sql: Object.assign(
+      (csn,o) => compile.to.sql (csn, _options.for.sql(o)),
+      compile.to.sql // smart* functions
+    ),
     deltaSql: (csn, o, beforeCsn) => compile.to.sql.migration(csn, o, beforeCsn), // or like hdi.migration
-    cdl: (csn,o) => compile.to.cdl (csn, _options4(o||{}) ),
+    cdl: Object.assign(
+      (csn,o) => compile.to.cdl (csn, _options4(o||{})),
+      compile.to.cdl // smart* functions
+    ),
   },
 }

package/lib/compile/for/nodejs.js

@@ -4,7 +4,7 @@ const TRACE = cds.debug('trace')
 
 module.exports = function cds_compile_for_nodejs (csn,o) {
   if ('_4nodejs' in csn) return csn._4nodejs
-  TRACE?.time('cds.compile 4n ')
+  TRACE?.time('cds.compile 4nodejs'.padEnd(22))
   let dsn = csn // cds.minify (csn)
   dsn = cds.compile.for.drafts (csn,o) //> creates a partial copy -> avoid any cds.linked() before
   dsn = unfold_csn (dsn)
@@ -12,6 +12,6 @@ module.exports = function cds_compile_for_nodejs (csn,o) {
   if (cds.env.fiori.lean_draft) cds.compile.for.lean_drafts(dsn, o)
   Object.defineProperty (csn, '_4nodejs', {value:dsn})
   Object.defineProperty (dsn, '_4nodejs', {value:dsn})
-  TRACE?.timeEnd('cds.compile 4n ')
+  TRACE?.timeEnd('cds.compile 4nodejs'.padEnd(22))
   return dsn
 }

package/lib/compile/for/odata.js

@@ -1,11 +1,15 @@
 const compile = require ('../cdsc')
+const cds = require('../../index')
+const TRACE = cds.debug('trace')
 
 module.exports = function cds_compile_for_odata (csn,_o) {
   if ('_4odata' in csn) return csn._4odata
+  TRACE?.time('cdsc.compile 4odata'.padEnd(22))
   let o = compile._options.for.odata(_o) //> required to inspect .sql_mapping below
   let dsn = compile.for.odata (csn,o)
   if (o.sql_mapping) dsn['@sql_mapping'] = o.sql_mapping //> compat4 old Java stack
   Object.defineProperty (csn, '_4odata', {value:dsn})
   Object.defineProperty (dsn, '_4odata', {value:dsn})
+  TRACE?.timeEnd('cdsc.compile 4odata'.padEnd(22))
   return dsn
 }

package/lib/compile/load.js

@@ -1,5 +1,10 @@
 const cds = require('..')
 const TRACE = cds.debug('trace')
+if (TRACE) {
+  TRACE?.time('require cds.compiler'.padEnd(22))
+  require('@sap/cds-compiler/lib/compiler')
+  TRACE?.timeEnd('require cds.compiler'.padEnd(22))
+}
 
 module.exports = exports = function load (files, options) {
   const any = cds.resolve(files,options)
@@ -16,7 +21,7 @@ exports.parsed = function cds_get (files, options, _flavor) {
   if (!files) files = ['*']; else if (!Array.isArray(files)) files = [files]
   if (o.files || o.flavor === 'files') return cds.resolve(files,o)
   if (o.sources || o.flavor === 'sources') return _sources4 (cds.resolve(files,o))
-  if (!o.silent) TRACE?.time('cds.load model')
+  if (!o.silent) TRACE?.time('cdsc.compile *.cds'.padEnd(22))
 
   const csn = cds.compile (files,o,
     o.parse  ? 'parsed' :
@@ -27,7 +32,7 @@ exports.parsed = function cds_get (files, options, _flavor) {
   return csn.then?.(_finalize) || _finalize(csn)
   function _finalize (csn) {
     if (!o.silent) cds.emit ('loaded', csn)
-    if (!o.silent) TRACE?.timeEnd('cds.load model ')
+    if (!o.silent) TRACE?.timeEnd('cdsc.compile *.cds'.padEnd(22))
     return csn
   }
 }

package/lib/compile/to/sql.js

@@ -2,13 +2,16 @@ const cds = require ('../..')
 const cdsc = require ('../cdsc')
 const keywords = require("@sap/cds-compiler").to.sql.sqlite.keywords
 const { unfold_ddl } = require ('../etc/_localized')
+const TRACE = cds.debug('trace')
 
 function cds_compile_to_sql (csn,_o) {
+  TRACE?.time('cdsc.compile 2sql'.padEnd(22))
   csn = cds.minify(csn)
   csn = _extended(csn)
   const o = cdsc._options.for.sql(_o) //> used twice below...
   const all = cdsc.to.sql(csn,o) .map (each => each.replace(/^-- .+\n/,''))  //> strip comments
   const sql = unfold_ddl(all, csn, o)
+  TRACE?.timeEnd('cdsc.compile 2sql'.padEnd(22))
   if (o.as === 'str') return `\n${sql.join('\n\n')}\n`
   return sql
 }