@sap/cds 7.2.1 → 7.3.1

package/lib/i18n/localize.js

@@ -1,4 +1,4 @@
-const cds = require ('..')
+const cds = require('..')
 const {existsSync, readdirSync} = require ('fs')
 const {join,dirname,resolve,parse,sep} = require ('path')
 
@@ -6,68 +6,75 @@ const DEBUG = cds.debug('i18n')
 const _node_modules = cds.env.cdsc.moduleLookupDirectories.map(d => sep+d.slice(0, -1))
 
 module.exports = Object.assign (localize, {
-  bundles4, folders4, folder4, bundle4
+  localize, lookup, bundles4, folders4, folder4, bundle4
 })
 
+/**
+ * Can be used like that:
+ * @example cds.i18n.lookup('CreatedAt','de')
+ */
+function lookup (key, locale, model = cds.context?.model || cds.model) {
+  let bundle = bundle4 (model, locale)
+  return bundle?.[key]
+}
 
-function localize (model, /*with:*/ locale, aString, extBundle) {
-  const _localize = bundle => localizeString (aString, bundle, extBundle)
+/**
+ * Can be used like that:
+ * @example cds.localize(edmx,'de')
+ */
+function localize (aString, locale, model = cds.context?.model || cds.model, ext={}) {
 
-  const bundle = bundles4 (model, locale)
-  if (Array.isArray(locale)) { // array of multiple locales
-    return (function*(){
-      let any;
-      if(bundle && bundle[Symbol.iterator]) { // try iteration only if bundle is set
-        for (let [lang,each] of bundle)  yield any = [ _localize(each), {lang} ]
-      }
-      if (!any)  yield [ _localize(), {lang:''} ]
-    })()
-  } else { // a single locale string
-    return _localize(bundle)
+  // support for legacy signature
+  if (typeof aString === 'object') [ aString, model ] = [ model, aString ]
+
+  // in case of multiple locales, return a generator
+  if (Array.isArray(locale)) return (function*(){
+    let localized, bundles = bundles4 (model, locale)
+    if (bundles?.[Symbol.iterator]) for (let [lang,each] of bundles) {
+      localized = _localize_with (each)
+      yield [ localized, {lang} ]
+    }
+    if (!localized) yield [ aString, {lang:''} ]
+  })()
+
+  // otherwise return a single localized string
+  let bundle = bundle4 (model, locale)
+  return _localize_with (bundle)
+
+  function _localize_with (bundle) {
+    if (!bundle || !aString) return aString
+    if (typeof aString === 'object') aString = JSON.stringify(aString)
+    const escape = aString.startsWith('<?xml') ? escapeXmlAttr : /^[{[]/.test(aString) ? escapeJson : v=>v
+    return aString.replace (/{i18n>([^}]+)}/g, (_, key) => {
+      const val = ext[key] || bundle[key]
+      return !val ? key : escape(val)
+    })
   }
 }
 
-const TEXT_KEY_MARKER = 'i18n>'
-const TEXT_KEYS = /{b?i18n>([^"}]+)}/g
-function localizeString (aString, bundle, extBundle) {
-  if (!bundle || !aString)  return aString
-  if (typeof aString === 'object')  aString = JSON.stringify(aString, null, 2)
-  // quick check for presence of any text key, to avoid expensive operation below
-  if (!aString.includes(TEXT_KEY_MARKER))  return aString
-  const escape = aString.startsWith('<?xml') ? escapeXmlAttr : /^[{[]/.test(aString) ? escapeJson : v=>v
-  return aString.replace (TEXT_KEYS, (_, key) => {
-    const val = (extBundle && extBundle[key]) || bundle[key]
-    return val ? escape(val) : key
-  })
-}
 
 
 /**
  * Returns all property bundles, i.e. one for each available translation language,
  * for the given model.
  */
-function bundles4 (model, locales) { // NOSONAR
-
-  const folders = folders4 (model)
-  if (folders.length === 0)  return  //> no folders, hence no bundles found at all
-  if (typeof locales === 'string')  return bundle4 (model, locales)  // single locale string --> single bundle
-  if (!locales)  locales = cds.env.i18n.languages  // default
-  if (locales.split)  locales = locales.split(',')
-  // if no languages are specified, use all available
-  if (locales.length === 1 && (locales[0] === '*' || locales[0] === 'all')) {
-    locales = allLocales4 (folders)
-    if (!locales)  return {}
+function bundles4 (model, locales = cds.env.i18n.languages) {
+
+  const folders = folders4 (model); if (folders.length === 0) return
+
+  if (locales.split) locales = locales.split(',')
+  if (locales[0] === '*' || locales[0] === 'all') {
+    locales = allLocales4 (folders); if (!locales) return {}
     if (!locales.includes(cds.env.i18n.fallback_bundle))  locales.push (cds.env.i18n.fallback_bundle)
   }
-  DEBUG && DEBUG ('Languages:', locales)
+
+  DEBUG?.('Languages:', locales)
 
   return (function*(){
     for (let each of locales) {
-      let bundle = bundle4 (model, each)
-      if (bundle) {
-        DEBUG && DEBUG (bundle)
-        yield [ each, bundle ]
-      }
+      let bundle = bundle4 (model, each); if(!bundle) continue
+      DEBUG?.(bundle)
+      yield [ each, bundle ]
     }
   })()
 }
@@ -79,13 +86,13 @@ function bundles4 (model, locales) { // NOSONAR
  */
 function allLocales4 (folders) {
   // find all languages in all folders
-  const files = folders
-    .map (folder => readdirSync(folder)
-      .filter (e => e.startsWith(cds.env.i18n.file))
-      .map(i18nFile => join (folder, i18nFile))
-    ).reduce ((files, file) => files.concat(file)) // flatten
+  const files = folders.map (folder => readdirSync(folder)
+    .filter (e => e.startsWith(cds.env.i18n.file))
+    .map(i18nFile => join (folder, i18nFile))
+  ).reduce ((files, file) => files.concat(file)) // flatten
+
   if (files.length === 0) {
-    DEBUG && DEBUG ('No languages for folders:', folders)
+    DEBUG?.('No languages for folders:', folders)
     return null
   }
 
@@ -117,17 +124,26 @@ function allLocales4 (folders) {
  */
 function bundle4 (model, locale) {
 
-  const folders = folders4 (model); if (!folders.length)  return //> no folders, hence no bundles found at all
+  if (typeof model === 'string') [ model, locale ] = [ cds.context?.model || cds.model, model ]
+
+  const bundles = model.texts || Object.defineProperty (model,'texts',{value:{}}).texts
+  if (locale in bundles) return bundles[locale]
+
   const bundle = {}
+  const folders = folders4(model)
+  try {
+    if (!folders.length) return bundle
+
+    add (cds.env.i18n.fallback_bundle)  // e.g. i18n.properties
+    if (locale === cds.env.i18n.fallback_bundle) return bundle
 
-  add (cds.env.i18n.fallback_bundle)  // e.g. i18n.properties
-  if (locale === cds.env.i18n.fallback_bundle)  return bundle
+    add (cds.env.i18n.default_language)  // e.g. i18n_en.properties
+    if (locale === cds.env.i18n.default_language) return bundle
 
-  add (cds.env.i18n.default_language)  // e.g. i18n_en.properties
-  if (locale === cds.env.i18n.default_language)  return bundle
+    add (locale)  // e.g. i18n_de.properties
+    return bundle
 
-  add (locale)  // e.g. i18n_de.properties
-  return bundle
+  } finally { bundles[locale] = bundle }
 
   function add (lang) {
     for (let each of folders) {
@@ -154,18 +170,16 @@ function folders4 (model) {
   //   foo/bar.cds
   //   foo/node_modules/reuse-level-1/model.cds
   //   foo/node_modules/reuse-level-2/model.cds
-  if (!model.$sources)  return []
-  const srcFolders = new Set (model.$sources.map (dirname))
-  const folders = []
+  const folders = [] // using an array here to not screw up the folder order
+  const srcFolders = new Set ((model.$sources||[]).map(dirname))
   srcFolders.forEach(src => {
-    let folder = folder4 (src)
+    const folder = folder4 (src)
     if (folder && !folders.includes(folder)) {
-      folders.push(folder)  // use an array here to not screw up the folder order
+      folders.push(folder)
     }
   })
-
-  Object.defineProperty (model, '_i18nfolders', {value:folders})
-  return folders.reverse()
+  Object.defineProperty (model, '_i18nfolders', {value:folders.reverse()})
+  return folders
 }
 
 /**
@@ -202,7 +216,7 @@ function loadFromJSON (res, lang=cds.env.i18n.default_language) {
     const bundles = require (resolve (cds.root,res+'.json'))
     return bundles[lang] || bundles [(lang.match(/\w+/)||[])[0]]
   } catch(e) {
-    if (e.code !== 'MODULE_NOT_FOUND')  throw e
+    if (e.code !== 'MODULE_NOT_FOUND') throw e
   }
 }
 
@@ -231,17 +245,9 @@ function escapeXmlAttr (str) {
       .replace(/</g, '&lt;')
       .replace(/"/g, '&quot;')
       .replace(/\r\n|\n/g, '&#xa;');
-    if (!result.startsWith('{i18n>') && !result.startsWith('{bi18n'))
-      result = result.replace(/>/g, '&gt;')
+    if (!result.startsWith('{i18n>')) result = result.replace(/>/g, '&gt;')
   }
   return result;
 }
 
-function escapeJson (str) { return str
-    .replace(/"/g, '\\"')
-    .replace(/\\t/g, '\\t')
-    .replace(/\\n/g, '\\n')
-}
-
-
-/* eslint no-console:off */
+const escapeJson = str => str.replace(/"/g, '\\"')

package/lib/index.js

@@ -7,9 +7,10 @@ const cds = module.exports = new class cds extends EventEmitter {
 
   // Configuration & Information
   get requires() { return super.requires = this.env.requires._resolved() }
-  get plugins()  { return super.plugins = require('./plugins') }
+  get plugins()  { return super.plugins = require('./plugins').activate() }
   get version()  { return super.version = require('../package.json').version }
   get env()      { return super.env = require('./env/cds-env').for('cds',this.root) }
+  get schema()   { return super.schema = require('./env/schema') }   // dynamic schema loading
   get home()     { return super.home = __dirname.slice(0,-4) }
   cli = { command:'', options:{}, argv:[] }
   root = process.cwd()
@@ -25,7 +26,6 @@ const cds = module.exports = new class cds extends EventEmitter {
   get extend()   { return super.extend = require('./compile/extend') }
   get deploy()   { return super.deploy = require('./dbs/cds-deploy') }
   get localize() { return super.localize = require('./i18n/localize') }
-  get build()    { return () => { throw new Error('This application uses @sap/cds version >= 7, which is not compatible with the installed @sap/cds-dk version 6. Either update @sap/cds-dk to version 7 or downgrade @sap/cds to version 6 instead.') } }
   /** @type {{definitions:{},extensions:[]}} */ model = undefined
   /** @type Service */ db = undefined
 
@@ -116,6 +116,10 @@ const cds = module.exports = new class cds extends EventEmitter {
 
   // legacy and to be moved stuff -> hidden for tools in cds.__proto__
   /** @deprecated */ in (cwd) { return !cwd ? this : {__proto__:this, cwd, env: this.env.for('cds',cwd) } }
+  get build() { return () => cds.error('\
+    This application uses @sap/cds version >= 7, which is not compatible with the installed @sap/cds-dk version 6. \
+    Either update @sap/cds-dk to version 7 or downgrade @sap/cds to version 6 instead.\
+  ')}
 }
 
 // add global cds.ql commands

package/lib/linked/classes.js

@@ -1,6 +1,3 @@
-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 {
@@ -79,7 +76,7 @@ class service extends context {
 
     // Return a sluggified variant of the service's name
     const pathFromServiceName4 = (srv) => {
-      return ( 
+      return (
         /[^.]+$/.exec(srv.name)[0]  //> my.very.CatalogService --> CatalogService
         .replace(/Service$/,'')     //> CatalogService --> Catalog
         .replace(/_/g,'-')          //> foo_bar_baz --> foo-bar-baz
@@ -87,7 +84,7 @@ class service extends context {
         .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:
@@ -108,10 +105,10 @@ class service extends context {
             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
       }
 
@@ -125,15 +122,18 @@ class service extends context {
       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 endpoints = [], env_protocols = global.cds?.env.protocols
+    const serve_on_root = global.cds?.env.features.serve_on_root
+
+    for (let each of protocols) {
+      let p = this._protocols[each] || env_protocols[each]
+      if (!p) throw new Error(`Protocol "${each}" is unknown`)
 
-      const kind = pName
+      const middlewares = global.cds?.requires.middlewares
+      const kind = each
       let prefix = middlewares ? p.path || '/' : '/' // > no middlewares, no prefix
       if (!prefix.endsWith('/')) prefix += '/'
-      const unprefixedPaths = unprefixedPaths4(pName, srv, options)
+      const unprefixedPaths = unprefixedPaths4(each, srv, options)
       for (let path of unprefixedPaths) {
         if (path.startsWith('/')) endpoints.push({ kind, path})
         else {

package/lib/plugins.js

@@ -1,49 +1,45 @@
-// IMPORTANT We must not use cds.debug/log/env here to allow plugins to change env.defaults
-const DEBUG = /\by|all|plugins\b/.test(process.env.DEBUG)
-const cds = require('.'), { local } = cds.utils
+const cds = require('.')
 
-module.exports = (async function load_plugins (log = console.log) {
-
-  if (DEBUG) console.time('[cds] - loaded plugins in')
+/**
+ * Fetch cds-plugins from project's package dependencies.
+ * Used in and made available through cds.env.plugins.
+ */
+exports.fetch = function (DEV = process.env.NODE_ENV !== 'production') {
   const plugins = {}
-
-  load_from(cds.home) // load well-known plugins from our dependencies
-  load_from(cds.root)
-
-  global._plugins = Object.keys(plugins) // used in cds.env
-  await Promise.all(Object.values(plugins).map(load => load()))
-  if (DEBUG) console.timeEnd('[cds] - loaded plugins in')
-
+  fetch_plugins_in (cds.home, false)
+  fetch_plugins_in (cds.root, DEV)
+  function fetch_plugins_in (root, dev) {
+    let pkg; try { pkg = require(root + '/package.json') } catch { return }
+    let deps = { ...pkg.dependencies, ...dev && pkg.devDependencies }
+    for (let each in deps) try {
+      let impl = require.resolve(each + '/cds-plugin', { paths: [root] })
+      plugins[each] = { impl }
+    } catch { /* no cds-plugin.js */ }
+  }
   return plugins
-
-  function load_from(pkg_path) {
-    let pkg; try { pkg = require(pkg_path + '/package.json') } catch { return }
-
-    if (pkg.cds?.plugins) {
-      for (let each of pkg.cds.plugins) {
-        let plugin = typeof each === 'string' ? each : each.impl
-        if (plugin.startsWith('.'))
-          plugin = require.resolve(pkg_path + '/' + plugin)
-        _load_plugin(plugin, plugin, each)
-      }
-    } else {
-      const deps = { ...pkg.dependencies, ...(process.env.NODE_ENV !== 'production' && pkg.devDependencies) }
-      const plugins = []
-      for (let each in deps) try {
-        let plugin = require.resolve(each + '/cds-plugin', {paths:[pkg_path]})
-        plugins.push (()=>_load_plugin(each, plugin))
-      } catch { /* no plugin */ }
-      for (let each of plugins) each()
-    }
-
-    function _load_plugin (name, impl, conf) {
-      plugins[name] = async() => {
-        // TODO support ESM plugins.  But see cap/cds/pull/1838#issuecomment-1177200 !
-        const plugin = plugins[name] = require(impl)
-        if (DEBUG) log('[cds] - loaded plugin:', { impl: local(impl) })
-        if (plugin.activate) await plugin.activate(conf)
-      }
+}
+
+/**
+ * Load and activate cds-plugins from project's package dependencies.
+ * Used in and made available through cds.plugins.
+ */
+exports.activate = async function () {
+  const DEBUG = cds.debug ('plugins', {label:'cds'})
+  DEBUG && console.time ('[cds] - loaded plugins in')
+  const { plugins } = cds.env, { local } = cds.utils
+  await Promise.all (Object.entries(plugins) .map (async ([ plugin, conf ]) => {
+    DEBUG?.(`loading plugin ${plugin}:`, { impl: local(conf.impl) })
+    // TODO: support ESM plugins. But see cap/cds/pull/1838#issuecomment-1177200 !
+    const p = require (conf.impl)
+    if(p.activate) {
+      cds.log('plugins').warn(`WARNING: \n
+  Returning an 'activate' function is deprecated and won't be
+  supported in future releases. → Please return a Promise with 'module.exports' instead.
+  `)
+      await p.activate(conf)
     }
-  }
-
-})()
+    return p
+  }))
+  DEBUG && console.timeEnd ('[cds] - loaded plugins in')
+  return plugins
+}

package/lib/req/user.js

@@ -13,9 +13,9 @@ class User {
   get attr() { return super.attr = {} }
   set attr(a) { super.attr = a }
 
-  get roles(){ return super.roles = {} }
+  get roles() { return super.roles = {} }
   set roles(r) {
-    super.roles = !Array.isArray(r) ? r : r.reduce((p,n)=>{ p[n]=1; return p },{})
+    super.roles = Array.isArray(r) ? r.reduce((p, n) => { p[n]=1; return p }, {}) : r
   }
 
   is (role) {

package/lib/srv/protocols/_legacy.js

@@ -17,7 +17,6 @@ class LegacyProtocolAdapter extends ProtocolAdapter {
 
   static serve (srv, /* in: */ app) {
     return super.serve (srv, app, { before: [
-      // async (req, res, next) => { await 1; next() }, // REVISIT: AsyncResource.bind() -> enable to break cds/tests/_runtime/odata/__tests__/integration/crud-with-mtx.test.js with existing, non-middleware mode, *w/o* fix to BufferedWriter
       cds_context,
       libx.perf,
       libx.auth(srv),

package/lib/srv/protocols/odata-v4.js

@@ -17,5 +17,9 @@ module.exports = function ODataAdapter (srv) { return [
 
     next()
   },
+  ...cds.env.features.odata_new_adapter ? [
+    require('../../../libx/odata/service-document')(srv),
+    require('../../../libx/odata/metadata')(srv),
+  ] : [],
   libx.to.odata_v4 (srv)
 ]}

package/lib/utils/axios.js

@@ -2,10 +2,16 @@ class Axios {
 
   get axios() {
     // eslint-disable-next-line cds/no-missing-dependencies
-    return super.axios = require('axios').create ({
+    const axios = require('axios').create ({
       headers: { 'Content-Type': 'application/json' },
       baseURL: this.url,
     })
+    // fill in baseURL on subsequent this.url = url, after server has started
+    Reflect.defineProperty (this, 'url', { configurable: true, set: url => {
+      Reflect.defineProperty (this, 'url', { value: url })
+      axios.defaults.baseURL = url
+    }})
+    return super.axios = axios
   }
   get     (..._) { return this.axios.get     (..._args(_)) .catch(_error) }
   put     (..._) { return this.axios.put     (..._args(_)) .catch(_error) }