@sap/cds 6.0.2 → 6.1.0

package/bin/build/provider/nodejs/index.js

@@ -3,10 +3,10 @@ const path = require('path')
 const BuildTaskHandlerEdmx = require('../buildTaskHandlerEdmx')
 const { BuildError } = require('../../util')
 const { BUILD_OPTION_OUTPUT_MODE, OUTPUT_MODE_RESULT_ONLY, ODATA_VERSION, ODATA_VERSION_V2, FOLDER_GEN, BUILD_NODEJS_EDMX_GENERAION, EDMX_GENERATION,
-    SKIP_PACKAGE_JSON_GENERATION, CONTENT_EDMX, CONTENT_PACKAGE_JSON, CONTENT_PACKAGELOCK_JSON, CONTENT_NPMRC, CONTENT_CDSRC_JSON, CONTENT_ENV, CONTENT_DEFAULT_ENV_JSON } = require('../../constants')
-const { WARNING } = require('../../buildTaskHandler')
+    SKIP_PACKAGE_JSON_GENERATION, CONTENT_EDMX, CONTENT_PACKAGE_JSON, CONTENT_PACKAGELOCK_JSON, CONTENT_NPMRC, CONTENT_CDSRC_JSON, CONTENT_ENV, CONTENT_DEFAULT_ENV_JSON, SEMVER_REGEX } = require('../../constants')
+const { WARNING, ERROR } = BuildTaskHandlerEdmx
 
-class NodeCfModuleBuilder extends BuildTaskHandlerEdmx {
+class NodejsModuleBuilder extends BuildTaskHandlerEdmx {
     init() {
         super.init()
         // set unified option values in order to ease access later on
@@ -28,6 +28,12 @@ class NodeCfModuleBuilder extends BuildTaskHandlerEdmx {
         this.destSrv = this.isStagingBuild() ? path.resolve(this.task.dest, this.env.folders.srv) : path.join(this.task.dest, FOLDER_GEN)
     }
 
+    options() {
+        const options = super.options(), {cds} = this
+        if (cds.requires.extensibility || cds.requires.toggles) options.flavor = 'xtended'
+        return options
+    }
+
     async build() {
         const destSrv = this.isStagingBuild() ? this.destSrv : path.resolve(this.destSrv, this.env.folders.srv)
         const destRoot = this.isStagingBuild() ? this.task.dest : this.destSrv
@@ -48,7 +54,8 @@ class NodeCfModuleBuilder extends BuildTaskHandlerEdmx {
         await this.collectAllLanguageBundles(dictionary, sources, destSrv, destRoot)
 
         if (this.hasBuildOption(CONTENT_EDMX, true)) {
-            await this.compileToEdmx(dictionary.base, this.destSrv)
+            const m = await this.cds.load(sources.base, super.options()) // REVISIT: Quick hack to get inferred model as expected by cds.compile.to.edmx()
+            await this.compileToEdmx(m, this.destSrv)
         }
 
         if (!this.hasBuildOption(BUILD_OPTION_OUTPUT_MODE, OUTPUT_MODE_RESULT_ONLY)) {
@@ -77,11 +84,11 @@ class NodeCfModuleBuilder extends BuildTaskHandlerEdmx {
     }
 
     /**
-     * Copy files from the given <em>src</em>' folder (e.g. 'project/srv') to either <em>destRoot</em> (e.g. 'project/gen/srv') 
+     * Copy files from the given <em>src</em>' folder (e.g. 'project/srv') to either <em>destRoot</em> (e.g. 'project/gen/srv')
      * or <em>destSrv</em> (e.g. 'project/gen/srv/srv') folders according to the file semantics.
-     * Files with project semantics like 'package.json' or '.npmrc' file are copied to <em>destRoot</em> while others like '.js' service handlers 
+     * Files with project semantics like 'package.json' or '.npmrc' file are copied to <em>destRoot</em> while others like '.js' service handlers
      * are copied to <em>destSrv</em>.
-     * @param {*} src 
+     * @param {*} src
      * @param {*} destRoot - folder name representing the app root folder (e.g. gen/srv)
      * @param {*} destSrv - folder name representing the app sub-folder (e.g. gen/srv/srv)
      * @returns the list of files that have been copied
@@ -98,7 +105,8 @@ class NodeCfModuleBuilder extends BuildTaskHandlerEdmx {
                 // TODO shall not copy language bundles - return !/(\/|\\)(node_modules|_i18n)(\/|\\)?$/.test(entry)
                 return !/(\/|\\)node_modules(\/|\\)?$/.test(entry)
             }
-            if (srvRootBlockList.test(entry)) {
+            // make sure the file exists on srv root level - see https://github.tools.sap/cap/issues/issues/12077
+            if (srvRootBlockList.test(entry) && path.dirname(entry) === src) {
                 srvRootFileNames.push(path.basename(entry))
                 return false
             }
@@ -125,8 +133,8 @@ class NodeCfModuleBuilder extends BuildTaskHandlerEdmx {
     /**
      * Copy dedicated files (files with project semantics like package.json, .npmrc, .cdsrc, etc.)
      * from the given <em>src</em> folder (e.g. 'project') into the given <em>dest</em> folder (e.g. 'project/gen/srv')
-     * @param {*} src 
-     * @param {*} dest 
+     * @param {*} src
+     * @param {*} dest
      * @param {*} filter - copy file if filter function returns true
      */
     async _copyProjectRootContent(src, dest, filter) {
@@ -163,12 +171,18 @@ class NodeCfModuleBuilder extends BuildTaskHandlerEdmx {
     async _modifyPackageJson(file) {
         function _addEnginesField(content) {
             if (!content.engines || !content.engines.node) {
+                // use minimum node version of @sap/cds
                 const { engines } = require('../../../../package.json')
                 if (engines && engines.node) {
                     this.logger.log(`${this.task.for}: adding node engines version to package.json ${engines.node}`)
                     content.engines = content.engines || {}
-                    content.engines.node = engines.node
-                    return true
+                    const nodeVersion = NodejsModuleBuilder._convertToClosedVersionRange(engines.node)
+                    if (nodeVersion) {
+                        content.engines.node = nodeVersion
+                        return true
+                    } else {
+                        this.pushMessage(`Invalid node version defined in engines definition for @sap/cds ${engines.node} - skip node engines definition`, ERROR)
+                    }
                 }
             }
             return false
@@ -184,6 +198,13 @@ class NodeCfModuleBuilder extends BuildTaskHandlerEdmx {
             await this.write(content).to(file)
         }
     }
+
+    static _convertToClosedVersionRange(rtVersion) {
+        rtVersion = rtVersion.trim()
+        if (rtVersion.match(SEMVER_REGEX)) {
+            return rtVersion.replace(SEMVER_REGEX, '^$2$3$4')
+        }
+    }
 }
 
-module.exports = NodeCfModuleBuilder
+module.exports = NodejsModuleBuilder

package/bin/build/util.js

@@ -124,11 +124,13 @@ function _redacted(cred) {
  * @returns
  */
 function isStreamlinedMtx(cds) {
-    if (process.env.OLD_MTX) return false
-    return !cds.mtx && (cds.env.get("requires.toggles") !== undefined
+    if (hasOptionValue(process.env.OLD_MTX, true)) {
+        return false
+    }
+    return (cds.env.get("requires.toggles")
         || cds.env.requires['cds.xt.ModelProviderService']
-        || cds.env.get("requires.multitenancy.streamlined") === true
-        || (typeof cds.env.get("requires.multitenancy") === "object" && cds.env.get("requires.multitenancy.streamlined") === undefined))
+        || (typeof cds.env.get("requires.multitenancy") === "object")
+    ) && !(() => { try { return cds.mtx } catch (e) { /**/ } })()
 }
 
 class BuildMessage extends Error {

package/bin/deploy/to-hana/cfUtil.js

@@ -77,7 +77,12 @@ class CfUtil {
     async _cfRequest(urlPath, queryObj, bodyObj) {
         if (queryObj) {
             const entries = Object.entries(queryObj);
-            const queryStr = entries.map((entry) => `${entry[0]}=${encodeURIComponent(entry[1])}`).join('&');
+            const queryStr = entries.map(([key, value]) => {
+                // commas cause problems in cf curl when not double encoded
+                value = value.replace(/,/g, encodeURIComponent(','));
+                return `${key}=${encodeURIComponent(value)}`;
+            }).join('&');
+
             urlPath = urlPath + `?${queryStr}`;
         }
 
@@ -125,7 +130,7 @@ class CfUtil {
     async getCfTargetFromCli() {
         const result = await this._cfRun('target');
         return {
-            apiEndpoint: this._extract(result, /api endpoint\s*:\s*(.+)/i, `CF API endpoint is missing. Use 'cf login' to login.`),
+            apiEndpoint: this._extract(result, /api endpoint\s*:\s*([^\s]+)/i, `CF API endpoint is missing. Use 'cf login' to login.`),
             user: this._extract(result, /user\s*:\s*(.+)/i, `CF user is missing. Use 'cf login' to login.`),
             org: this._extract(result, /org\s*:\s*(.+)/i, `CF org is missing. Use 'cf target -o <ORG> to specify.`),
             space: this._extract(result, /space\s*:\s*(.+)/i, `CF space is missing. Use 'cf target -s <SPACE>' to specify.`),

package/bin/deploy/to-hana/hana.js

@@ -35,7 +35,12 @@ class HanaDeployer {
     this.logger = logger;
 
     this.logger.log(`${bold('Starting deploy to SAP HANA ...')}`);
-    if (bindCallback) {
+    if (vcapFile)  {
+      this.logger.log();
+      this.logger.log(`Using VCAP_SERVICES from file ${vcapFile} (beta feature).`);
+      bindCallback = null // credentials are given - no cds bind then
+    }
+    else if (bindCallback) {
       this.logger.log('Using cds bind');
     }
     this.logger.log();
@@ -46,8 +51,6 @@ class HanaDeployer {
 
     let vcapServices;
     if (vcapFile) {
-      this.logger.log();
-      this.logger.log(`Using vcap file ${vcapFile} (beta feature).`);
       vcapServices = await this._loadVCAPServices(vcapFile);
     }
 

package/bin/serve.js

@@ -181,7 +181,7 @@ async function serve (all=[], o={}) { // NOSONAR
     log ('loading plugin:', {impl})
     // TODO support ESM plugins.  But see cap/cds/pull/1838#issuecomment-1177200 !
     const plugin = require(impl)
-    if (plugin.activate) plugin.activate(each)
+    if (plugin.activate) await plugin.activate(each)
   }
 
   // bootstrap server from project-local server.js or from @sap/cds/server.js
@@ -225,7 +225,7 @@ async function _local_server_js() {
   let server_js = process.env.CDS_TYPESCRIPT && _local('server.ts') || _local('server.js')
   if (server_js) {
     log ('Loading server from', { file: local(server_js) })
-    let fn = await _import(server_js)
+    let fn = await cds.utils._import(server_js)
     if (fn && fn.default)  fn = fn.default  // default ESM export
     return typeof fn === 'function' ? fn : cds.server
   }
@@ -258,16 +258,19 @@ function _prepare_logging () { // NOSONAR
   cds.on ('serving', (srv) => {
     const details = {}
     if (srv.path) details.path = srv.path
-    if (srv._source) details.impl = local( srv._source.startsWith('@sap') ? require.resolve(srv._source) : srv._source )
+    if (srv._source && !srv._source.startsWith('@sap'))
+      details.impl = local(srv._source)
     log (`${srv.mocked ? 'mocking' : 'serving'} ${srv.name}`, details)
   })
 
+  cds.on ('served', ()=> console.log())
+
   // print info when we are finally on air
   cds.once ('listening', ({url})=>{
-    console.log ()
+    console.log()
     log ('server listening on',{url})
     _timer && console.timeEnd (_timer)
-    if (process.stdin.isTTY) log (`[ terminate with ^C ]`)
+    if (process.stdin.isTTY) log (`[ terminate with ^C ]\n`)
   })
 }
 
@@ -320,14 +323,6 @@ function _with_mocks (o) {
   }
 }
 
-const { pathToFileURL } = require('url')  // on Windows, must use a file: URL for ESM import
-function _import(filePath) {
-  return typeof jest !== 'undefined'
-    ? require(filePath)
-    : import (pathToFileURL(filePath).href)
-}
-
-
 const SECRETS = /(password)|(certificate)|(ca)|(secret)|(key)/i // 'certificate' and 'ca' on HANA
 /** mascades password-like strings, also reducing clutter in output */
 function _redacted(cred) {

package/lib/compile/extend.js

@@ -1,8 +1,18 @@
+const compile = require ('./cds-compile')
 const { extend } = require ('../lazy')
-const compile = require ('./index')
 
-module.exports = o => o.definitions ? { with(...exts) {
-  const all = { 'base.csn': JSON.stringify(o) }
-  exts.forEach ((x,i)=> all[i+'.csn'] = JSON.stringify(x))
-  return compile (all)
+module.exports = o => o.definitions ? { with(...csns) {
+
+  const csn=o, merged = { definitions: {}, extensions: [] }
+  for (const { definitions, extensions } of csns) {
+    if (definitions) Object.assign(merged.definitions, definitions)
+    if (extensions) merged.extensions.push(...extensions)
+  }
+  const extended = compile({
+    'base.csn': compile.to.json(csn),
+    'ext.csn': compile.to.json(merged)
+  })
+  extended.$sources = csn.$sources // required to load resources like i18n later on
+  return extended
+
 }} : extend(o)

package/lib/compile/minify.js

@@ -35,7 +35,7 @@ module.exports = function cds_minify (csn, _roots) { // IMPORTANT: don't add cds
   }
   function _visit (d) {
     if (typeof d === 'string') {
-      if (isInReservedNamespace(d)) return
+      if (cds.compiler.model.isInReservedNamespace(d)) return
       else d = all[d]
     } else if (d.ref) return d.ref.reduce((p,n) => {
       let d = (p.elements || csn.definitions[p.target].elements)[n.id || n] // > n.id -> view with parameters
@@ -61,18 +61,4 @@ module.exports = function cds_minify (csn, _roots) { // IMPORTANT: don't add cds
   return minified
 }
 
-/**
- * TODO - keep in sync with @sap/cds-compiler. Use their public API once it is available!
- * Checks whether the given absolute path is inside a reserved namespace.
- *
- * @param {string} absolute
- * @returns {boolean}
- */
-function isInReservedNamespace(absolute) {
-  return absolute.startsWith( 'cds.') &&
-    !absolute.match(/^cds\.foundation(\.|$)/) &&
-    !absolute.match(/^cds\.outbox(\.|$)/) && // Requested by Node runtime
-    !absolute.match(/^cds\.xt(\.|$)/); // Requested by Mtx
-}
-
 const _minified = Symbol('minified')

package/lib/compile/parse.js

@@ -56,7 +56,7 @@ const tagged = (parse, strings, ...values) => {
     all[2*i] = s
     all[2*i+1] = v instanceof cds.entity ? v.name : ':'+i
     if (typeof v === 'string' && s.endsWith(' like ') && !v.includes('%')) values[i] = `%${v}%`
-    if (Array.isArray(v) && s.endsWith(' in ')) values[i] = {list: v.map(cxn4)}
+    if (Array.isArray(v) && s.toLowerCase().endsWith(' in ')) values[i] = {list: v.map(cxn4)}
   }
   all[2*i] = strings[i]
   return merge (parse(all.join('')), values)

package/lib/compile/resolve.js

@@ -20,7 +20,7 @@ module.exports = exports = function cds_resolve (model, o={}) { // NOSONAR
   if (model === '*') return _resolve_all(o,this)
   if (Array.isArray(model)) {
     const resolved = [... new Set(model)] .reduce ((prev,next) => prev.concat (this.resolve(next,o)||[]), [])
-    return o.dry || o === false ? resolved : _resolved (resolved)
+    return o.dry || o === false ? [...new Set(resolved.flat())] : _resolved (resolved)
   }
   if (model.endsWith('/*')) return _resolve_subdirs_in(model,o,this)
 
@@ -69,7 +69,7 @@ const _required = (cds,env=cds.env) => Object.values(env.requires) .map (r => r.
 const _resolve = require('module')._resolveFilename
 
 function _resolve_all (o,cds) {
-  const {roots} = o.env || cds.env; if (o.dry || o === false)  return [ ...roots, ..._required(cds) ]
+  const {roots} = o.env || cds.env; if (o.dry || o === false)  return [ ...roots, ...new Set(_required(cds).flat()) ]
   const cache = o.cache || exports.cache
   const cached = cache['*']; if (cached) return cached
   cache['*'] = [] // important to avoid endless recursion on '*'

package/lib/compile/to/srvinfo.js

@@ -69,21 +69,23 @@ module.exports = (model, options={}) => {
 
   function _javaPrefix() {
     let is_java
+    const javaPrefixDefault = 'odata/v4/'
     for (let s of model.$sources) {
       const file = isfile (join (s,'../src/main/resources/application.yaml'))
       if (file) {
         const yaml = cds.load.yaml(file)
-        for (let {cds} of Array.isArray(yaml) ? yaml : [yaml]) {
+        for (let yamlDoc of Array.isArray(yaml) ? yaml : [yaml]) {
+          const cds = yamlDoc?.cds;
           if (!cds)   continue
           return cds['odataV4.endpoint.path']  || cds['odataV2.endpoint.path'] // https://cap.cloud.sap/docs/java/application-services#configure-base-path
               || cds['odata-v4.endpoint.path'] || cds['odata-v2.endpoint.path'] // older/intermediate config, keep for backward compatibility
-
+              || javaPrefixDefault
         }
-        return 'odata/v4/'
+        return javaPrefixDefault
       }
       else if (isfile (join(s,'../pom.xml'))) is_java = true
     }
-    return is_java && 'odata/v4/'
+    return is_java && javaPrefixDefault
   }
 
 }

package/lib/{deploy.js → dbs/cds-deploy.js}

@@ -1,4 +1,4 @@
-const cds = require('./index'), { local, inspect } = cds.utils
+const cds = require('../index'), { local, inspect } = cds.utils
 const DEBUG = cds.debug('deploy')
 /* eslint-disable no-console */
 
@@ -121,11 +121,11 @@ exports.create = async function (db, csn=db.model, o) {
 
 
 exports.init = (db, csn=db.model, log=()=>{}) => db.tx (async tx => {
-  const resources = await exports.resources(csn), inits=[]
+  const resources = await exports.resources(csn, {testdata: cds.env.features.test_data})
+  const inits=[]
   for (let [file,e] of Object.entries(resources)) {
     if (e === '*') { // init.js/ts
-      const { pathToFileURL } = require('url')  // on Windows, must use a file: URL for ESM import
-      let x = typeof jest !== 'undefined' ? require(file) : await import(pathToFileURL(file).href); if (!x) continue
+      let x = await cds.utils._import(file);  if (!x) continue
       if (x.default)  x = x.default  // default ESM export
       inits.push (!x.then && typeof x === 'function' ? x(db,csn) : x)
       log (file)
@@ -144,9 +144,9 @@ exports.init = (db, csn=db.model, log=()=>{}) => db.tx (async tx => {
 })
 
 
-exports.resources = async function (csn) {
+exports.resources = async function (csn, opts) {
   if (!csn || !csn.definitions) csn = await cds.load (csn||'*') .then (cds.minify)
-  const folders = await exports.resources.folders(csn)
+  const folders = await exports.resources.folders(csn, opts)
   const found={}, ts = process.env.CDS_TYPESCRIPT
   for (let folder of folders) {
     // fetching init.js files
@@ -174,11 +174,11 @@ exports.resources = async function (csn) {
 }
 
 
-exports.resources.folders = async function (csn) {
+exports.resources.folders = async function (csn, o={}) {
   if (!csn || !csn.definitions) csn = await cds.load (csn||'*') .then (cds.minify)
   const folders = new Set (csn.$sources.map (path.dirname) .filter (f => f !== cds.home))
   if (cds.env.folders.db) folders.add (path.resolve(cds.root, cds.env.folders.db))
-  if (cds.env.features.test_data) folders.add (path.resolve(cds.root,'test/'))
+  if (o.testdata) folders.add (path.resolve(cds.root,'test/'))
   return folders
 }
 

package/lib/env/{index.js → cds-env.js}

@@ -1,4 +1,4 @@
-const { isfile, fs, path } = require('../utils')
+const { isfile, fs, path } = require('../utils/cds-utils')
 const DEFAULTS = require('./defaults'), defaults = require.resolve ('./defaults')
 const compat = require('./compat')
 const presets = require('./presets')
@@ -130,22 +130,6 @@ class Config {
     return option.split('.').reduce ((p,n)=> p && p[n], this)
   }
 
-  /**
-   * This is `this.requires` plus additional entries for all cds.required.<name>.service
-   * @returns {import('./requires')}
-   */
-  get required_services_or_defs() {
-    const dict = Object.create (this.requires)
-    for (let [name,e] of Object.entries (this.requires)) if (e.service) {
-      if (e.service in dict && !e.override && e.service !== name) {
-        console.error (`Datasource name '${e.service}' conflicts with 'service' definition referred to in 'cds.requires.${name}':`, e)
-        throw new Error (`Datasource name '${e.service}' conflicts with service definition`)
-      }
-      else dict[e.service] = { ...e, name }
-    }
-    return super.required_services_or_defs = dict
-  }
-
   get profiles() {
     return super.profiles = Array.from (this._profiles)
   }

package/lib/env/{requires.js → cds-requires.js}

@@ -11,6 +11,23 @@ exports = module.exports = {
     '[production]': { kind: 'jwt-auth' }
   },
 
+
+  /**
+   * This is the implementation for `cds.requires` which is `cds.env.requires`
+   * plus additional entries for all cds.required.<name>.service
+   * @returns {import('./cds-requires')}
+   */
+   _resolved() {
+    const dict = Object.create (this)
+    for (let [name,e] of Object.entries (this)) if (e.service) {
+      if (e.service in dict && !e.override && e.service !== name) {
+        console.error (`Datasource name '${e.service}' conflicts with 'service' definition referred to in 'cds.requires.${name}':`, e) // eslint-disable-line no-console
+        throw new Error (`Datasource name '${e.service}' conflicts with service definition`)
+      }
+      else dict[e.service] = { ...e, name }
+    }
+    return dict
+  }
 }
 
 
@@ -85,6 +102,10 @@ const _databases = {
     '[development]': { kind: 'sqlite', credentials: { url: ':memory:' } },
     '[production]': { kind: 'hana' },
   },
+  "sql-mt": {
+    '[development]': { kind: 'sqlite' },
+    '[production]': { kind: 'hana-mt' },
+  },
   "sqlite": _compat_to_use({
     credentials: { url: 'sqlite.db' },
     impl: `${_runtime}/sqlite/Service.js`,
@@ -208,11 +229,11 @@ const _mtx_services = {
     model: "@sap/cds/srv/extensions",
   },
   "extensibility": {
-    model: [ "@sap/cds/srv/mtx", "@sap/cds/srv/extensions" ]
+    model: [ "@sap/cds/srv/mtx", "@sap/cds/srv/extensions" ],
+    tenantCheckInterval: 10000
   },
   "cds.xt.ExtensibilityService": {
-    model: "@sap/cds/srv/extensibility-service",
-    tenantCheckInterval: 10000
+    model: "@sap/cds/srv/extensibility-service"    
   },
   "uiflex": "extensibility", // REVISIT: temporary for compatibility with cds-mtxs tests -> eliminate "uiflex" later
 

package/lib/env/defaults.js

@@ -1,9 +1,15 @@
+const path = require('path')
 const [,major,minor] = /v(\d+)\.(\d+)/.exec(process.version)
 const production = process.env.NODE_ENV === 'production'
 
 module.exports = {
 
-  requires: require('./requires'),
+  requires: require('./cds-requires'),
+
+  schemas: {
+    'cds-rc.json': path.join(__dirname, 'schemas/cds-rc.json'),
+    'cds-package.json': path.join(__dirname, 'schemas/cds-package.json'),
+  },
 
   features: {
     folders: 'fts/*', // where to find feature toggles -> switch on by default when released

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

@@ -0,0 +1,11 @@
+{
+  "title": "JSON schema for CDS configuration in package.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "This is a JSON schema representation of the CDS project configuration inside a project root level package.json",
+  "type": "object",
+  "properties": {
+    "cds": {
+      "$ref": "cdsJsonSchema://schemas/cds-rc.json"
+    }
+  }
+}