@sap/cds 6.8.3 → 7.0.0

package/lib/env/cds-env.js

@@ -35,7 +35,8 @@ class Config {
     if (_home) _add_static_profiles (_home, profiles);
     if (!profiles.includes('production')) profiles.push('development')
     this._profiles = new Set (profiles)
-    this._profiles._defined = new Set()
+    this._profiles._defined = new Set
+    this._profiles._important = []
 
     // 1. set compat requires default values
     if (_context === 'cds' && _defaults)  this.add (DEFAULTS, defaults)
@@ -50,21 +51,22 @@ class Config {
       this._add_to_process_env (_home, '.env')
     }
 
-    const sources = Config.sources(_home, _context)
-
     // 2. read config sources in defined order
-    for (const { path, file, mapper } of sources) {
-      this._load(path, file, mapper, this._profiles, false)
-    }
-
-    // 3. read important (!) profiles from config sources in defined order
-    const important = new Set(this.profiles.map( profile => `${profile}!` ).filter( profile => this._profiles._defined.has( profile ) ));
-    if (important.size > 0) {
-      for (const { path, file, mapper } of sources) {
-        this._load(path, file, mapper, important, true)
+    const sources = Config.sources(_home, _context)
+    for (let { path:dir, file, mapper = x=>x } of sources) {
+      let src = path.join(dir,file)
+      let json = _readJson(src,{paths:[_home]}); if (!json) continue
+      if (json.dependencies?.['@sap/cds-mtx']) {
+        console.error('@sap/cds-mtx is not supported by @sap/cds >= 7. Please upgrade to @sap/cds-mtxs following the migration guide on https://cap.cloud.sap/docs/guides/multitenancy/old-mtx-migration.')
+        process.exit(1)
       }
+      this.add (mapper(json), src)
     }
 
+    // 3. apply important (!) profiles from config sources
+    for (let each of this._profiles._important) each()
+    delete this._profiles._important
+
     // 4. add process env before linking to allow things like CDS_requires_db=sql
     this._add_process_env(_context, _home)
 
@@ -74,28 +76,15 @@ class Config {
     // 6. complete service configurations from cloud service bindings
     this._add_cloud_service_bindings(process.env)
 
-    // 7. Add compatibility and correlations for mtx, better-sqlite, and lean draft
+    // 7. Add compatibility and correlations for mtx
     const db  = this.requires?.db
     if (this.requires?.db) {
       if (this.requires.multitenancy !== undefined)
         Object.defineProperty (db, 'multiTenant', { value: !!this.requires.multitenancy })
       else if (db.multiTenant !== undefined)
         this.requires.multitenancy = db.multiTenant
-      // Automatically use new sqlite service if in package dependencies
-      const new_sqlite_service = '@cap-js/sqlite'
-      if (db.kind === 'sqlite') try {
-        const pkg = require(path.join(_home,'package.json'))
-        if (pkg.dependencies?.[new_sqlite_service] || pkg.devDependencies?.[new_sqlite_service]) {
-          db.impl = new_sqlite_service
-        }
-      } catch (e) {
-        if (e.code !== 'MODULE_NOT_FOUND') throw e
-      }
-      // Add correlation b/w better-sqlite and lean-draft
-      if (this.fiori && this.fiori.lean_draft === undefined && db.impl === new_sqlite_service) {
-        this.fiori.lean_draft = true
-      }
     }
+    if (this.requires?.multitenancy && this.requires.db?.kind === 'hana' && !this.requires.db.vcap) Object.assign(this.requires.db, { vcap: { label: 'service-manager' } })
 
 
     // 8. apply presets
@@ -116,25 +105,28 @@ class Config {
    */
   static sources (home, context = 'cds') {
     if (!home) throw new Error('Missing parameter "home".')
+    if (context !== 'cds') return [
+      { path: home, file: 'package.json', mapper: x => x[context] },
+    ]
     const user_home = process.env.CDS_USER_HOME || require('os').homedir()
-
-    let sources = [
-      { name: 'USER_HOME', path: user_home, file: '.cdsrc.json' },
-      { name: 'PROJECT', path: home, file: '.cdsrc.json' },
-      { name: 'PACKAGE', path: home, file: 'package.json', mapper: p => {
-        const obj = p[context] || {}
-        obj.extends = obj.extends || p.extends // fill cds.extends from .extends
-        return obj
-      }},
-      { name: 'PRIVATE', path: home, file: '.cdsrc-private.json' }
+    return [
+      ...( global._plugins||[] ).map (root => ({
+        path: root, file: 'package.json', mapper: x => x.cds
+      })),
+      { path: user_home, file: '.cdsrc.json' },
+      { path: home, file: '.cdsrc-private.json' },
+      { path: home, file: '.cdsrc.json' },
+      { path: home, file: 'package.json', mapper: _package_json },
     ]
-
-    if (context !== 'cds') sources = sources.filter( source => source.name === 'PACKAGE' )
-    return sources
+    function _package_json (pkg) { // fill cds.extends from .extends
+      let cds = pkg.cds
+      if (pkg.extends) (cds||(cds={})).extends = pkg.extends
+      return cds
+    }
   }
 
 
-  add (conf, /*from:*/ _src, profiles = this._profiles, profiles_only = false) {
+  add (conf, /*from:*/ _src, profiles = this._profiles) {
     if (!conf)  return this
     if (_src)  this._sources.push (_src)
     const reqs = conf.requires
@@ -143,7 +135,7 @@ class Config {
         if (typeof reqs[each] === 'string') reqs[each] = {kind:conf.requires[each]}
       }
     }
-    _merge (this, conf, profiles, undefined, profiles_only)
+    _merge (this, conf, profiles)
     return this
   }
 
@@ -192,7 +184,7 @@ class Config {
    * For BAS only: get all defined profiles (could include some from the defaults)
    */
   get "defined-profiles" () {
-    return Array.from (new Set(Array.from(this._profiles._defined).map( profile => profile.endsWith("!") ? profile.slice(0, -1) : profile)))
+    return [...this._profiles._defined]
   }
 
 
@@ -203,25 +195,10 @@ class Config {
   //
 
 
-  /**
-   * Load from JSON file or directory
-   * No profile support!
-   */
-  _loadFromPath (_path, _basePath) {
-    if (_basePath && !path.isAbsolute(_path)) _path = path.join(_basePath, _path)
-    const json = _readJson (_path) || _readFromDir (_path)
-    if (json) this.add (json, _path, new Set())
-  }
-
-  _load (cwd, file, _conf=o=>o, profiles, profiles_only) {
-    const json = _readJson (file = path.join(cwd, file))  // only support JSON
-    if (json) this.add (_conf (json), file, profiles, profiles_only)
-  }
-
   _add_to_process_env (cwd, filename) {
     const file = path.resolve (cwd,filename)
     try {
-      const all = require('../compile/etc/properties').read(file)
+      const all = require('../compile/etc/properties').read(file); if (!all) return
       for (const key in all) {
         if (key in process.env) continue // do not change existing env vars
         const val = all[key]
@@ -240,13 +217,18 @@ class Config {
     const PREF = prefix.toUpperCase(), my = { CONFIG: PREF+'_CONFIG', ENV: PREF+'_ENV' }
     let config
 
-    const configEnvValue = env[my.CONFIG]
-    if (configEnvValue) try {
+    let val = env[my.CONFIG]
+    if (val) try {
       // CDS_CONFIG={ /* json */}
-      config = JSON.parse (configEnvValue)
+      config = JSON.parse (val)
     } catch (e) {
       // CDS_CONFIG=/path/to/config.json *OR* CDS_CONFIG=/path/to/config/dir
-      if (typeof configEnvValue === "string") this._loadFromPath (configEnvValue, basePath)
+      if (typeof val === "string") {
+        // Load from JSON file or directory; No profile support!
+        if (basePath && !path.isAbsolute(val)) val = path.join(basePath, val)
+        const json = _readJson(val) || _readFromDir(val)
+        if (json) this.add (json, val, false)
+      }
     }
 
     if (!config) config = {}
@@ -265,7 +247,7 @@ class Config {
       o[next] = _value4(env[p])
     }
 
-    this.add(config, '{process.env}')
+    this.add(config, 'process.env')
   }
 
   _link_required_services () {
@@ -290,14 +272,14 @@ class Config {
         const preset1 = kinds[key]
         if (typeof preset1 === 'object' && preset1 !== val) {
           const top = val, base = _merge ({},_linked(key,preset1)), {kind} = base
-          val = _merge (base, top, false, false)  // apply/override with top-level data
-          if (kind) val.kind = kind              // but inherited kind wins
+          val = _merge (base, top)    // apply/override with top-level data
+          if (kind) val.kind = kind  // but inherited kind wins
         }
       }
       if (typeof preset === 'object' && preset !== val) {
         const top = val, base = _merge ({},_linked(p,preset), _profiles), {kind} = base
-        val = _merge (base, top, _profiles, false)  // apply/override with top-level data
-        if (kind) val.kind = kind                  // but inherited kind wins
+        val = _merge (base, top, _profiles)  // apply/override with top-level data
+        if (kind) val.kind = kind           // but inherited kind wins
       }
       if (typeof val === 'object') Object.defineProperty (val, '_is_linked', {value:true})
       return val
@@ -311,7 +293,7 @@ class Config {
     try {
       const vcaps = JSON.parse (VCAP_SERVICES)
       const any = this._add_vcap_services_to (vcaps)
-      if (any)  this._sources.push ('{VCAP_SERVICES}')
+      if (any)  this._sources.push ('process.env.VCAP_SERVICES')
     } catch(e) {
       throw new Error ('[cds.env] - failed to parse VCAP_SERVICES:\n  '+ e.message)
     }
@@ -324,7 +306,7 @@ class Config {
     if (VCAP_SERVICES && !(this.features && this.features.vcaps == false)) {
       try {
         bindings = JSON.parse(VCAP_SERVICES)
-        bindingsSource = '{VCAP_SERVICES}'
+        bindingsSource = 'process.env.VCAP_SERVICES'
       } catch(e) {
         throw new Error ('[cds.env] - failed to parse VCAP_SERVICES:\n  '+ e.message)
       }
@@ -461,7 +443,7 @@ function _add_static_profiles (_home, profiles) {
 /**
  * @returns {Config} dst
  */
-function _merge (dst, src, _profiles, _cloned, _profiles_only = false) {
+function _merge (dst, src, _profiles) {
   const profiled = [], descr = Object.getOwnPropertyDescriptors(src)
   for (let p in descr) {
     const pd = descr[p]
@@ -472,24 +454,27 @@ function _merge (dst, src, _profiles, _cloned, _profiles_only = false) {
     }
 
     if (_profiles && p[0] === '[') {
-      const profile = p.slice(1,-1)
-      if (_profiles._defined)  _profiles._defined.add (profile)
+      const important = p.endsWith('!]')
+      const profile = p.slice (1, important ? -2 : -1)
+      if (_profiles._defined) _profiles._defined.add (profile)
       if (_profiles.has(profile)) {
         let o = src[p]; if (typeof o !== 'object') continue
-        profiled.push ({ profile, merge: () => _merge (dst, o, _profiles, _cloned, false)})
+        let merge = () => _merge (dst, o, _profiles, false)
+        if (important && _profiles._important) _profiles._important.push(merge)
+        else profiled.push ({ profile, merge })
       }
       continue
     }
 
     const v = pd.value
     if (typeof v === 'object' && !Array.isArray(v)) {
-      if (!dst[p]) dst[p] = {}; else if (_cloned)  dst[p] = _cloned(dst[p])
+      if (!dst[p]) dst[p] = {}
       if (typeof dst[p] !== 'object') dst[p] = v
-      else _merge (dst[p], v, _profiles, _cloned, _profiles_only)
+      else _merge (dst[p], v, _profiles)
       continue
     }
 
-    if (!_profiles_only && v !== undefined) dst[p] = v
+    else if (v !== undefined) dst[p] = v
   }
   if (profiled.length > 0 && !_profiles.has('production')) {
     const profiles = Array.from(_profiles)
@@ -508,9 +493,9 @@ function _value4 (val) {
   return val
 }
 
-function _readJson (file) {
+function _readJson (file, _options) {
   try {
-    const src = fs.readFileSync (require.resolve (file))
+    const src = fs.readFileSync (require.resolve(file,_options))
     return JSON.parse (src)
   } catch (e) {
     if (e instanceof SyntaxError)  console.error(`Error parsing '${file}': ${e.message}`)

package/lib/env/cds-requires.js

@@ -2,7 +2,7 @@ const _runtime = '@sap/cds/libx/_runtime'
 
 exports = module.exports = {
 
-  middlewares: undefined,   "[middlewares]": { middlewares: true },
+  middlewares: true,
   db: undefined,            "[schevo]": { db: { schema_evolution: 'auto' }, },
   messaging: undefined,
   multitenancy: undefined,
@@ -121,40 +121,40 @@ const _databases = {
     '[production]': { kind: 'hana' },
   },
 
-  "sqlite": _compat_to_use({
+  "sqlite": {
     '[better-sqlite]': { impl: '@cap-js/sqlite' },
     impl: `${_runtime}/sqlite/Service.js`,
     credentials: { url: 'db.sqlite' },
-  }),
+  },
 
   "better-sqlite": {
     credentials: { url: ":memory:" },
     impl: "@cap-js/sqlite",
     kind: 'sqlite'
   },
-  "legacy-sqlite": _compat_to_use({
+  "legacy-sqlite": {
     impl: `${_runtime}/sqlite/Service.js`,
     credentials: { url: 'db.sqlite' },
     kind: 'sqlite'
-  }),
+  },
 
-  "hana": _compat_to_use ({
+  "hana": {
     impl: `${_runtime}/hana/Service.js`,
-  }),
-  "hana-cloud": _compat_to_use ({
+  },
+  "hana-cloud": {
     kind: 'hana', "deploy-format": "hdbtable",
-  }),
+  },
 
   "sql-mt": { // For compatibility only
     '[development]': { kind: 'sqlite' },
     '[production]': { kind: 'hana-mt' },
   },
-  "hana-mt": _compat_to_use ({ // For compatibility only
+  "hana-mt": { // For compatibility only
     kind: 'hana', "deploy-format": "hdbtable",
     "vcap": {
       "label": "service-manager"
     }
-  }),
+  },
 
 }
 
@@ -226,18 +226,6 @@ const _messaging = {
 
 const _platform_services = {
 
-  "audit-log-service": {
-    impl: `${_runtime}/audit/Service.js`,
-    // model: 'AuditLogService.cds',
-    outbox: {},
-    vcap: { label: "auditlog" },
-  },
-
-  "audit-log-to-console": {
-    kind: "audit-log-service",
-    credentials: { logToConsole: true }
-  },
-
   destinations: {
     vcap: {
       label: 'destination'
@@ -258,9 +246,4 @@ exports.kinds = {
 }
 
 
-function _compat_to_use(o) { return Object.defineProperties (o,{
-  // NOTE: Property .use is for compatibility only -> use .dialect instead!
-  use: { get(){ return this.dialect || this.kind }, configurable:true, enumerable:true },
-})}
-
 Object.defineProperty(exports,'_resolved',{value:exports._resolved,enumerable:false}) // hide it in outputs

package/lib/env/defaults.js

@@ -3,8 +3,17 @@ const path = require('path')
 
 const defaults = module.exports = {
 
+  production,
+
+  cov2ap: false, // REVISIT: workaround for bug in @cap-js-community/odata-v2-adapter/cds-plugin -> cds/tests/_runtime/remote/__tests__/integration/mocked-v2-consumption/v2.test.js
+
   requires: require('./cds-requires'),
 
+  server: {
+    force_exit_timeout: 1111,
+    port: 4004,
+  },
+
   schemas: {
     'cds-rc.json': path.join(__dirname, 'schemas/cds-rc.json'),
     'cds-package.json': path.join(__dirname, 'schemas/cds-package.json'),
@@ -24,14 +33,15 @@ const defaults = module.exports = {
     one_model: true,
     localized: true,
     assert_integrity: false,
-    cds_tx_protection: true,
     cds_tx_inheritance: true,
+    serve_on_root: false,
+    precise_timestamps: false
   },
 
   fiori: {
     preview: !production,
     routes: !production,
-    lean_draft: undefined,
+    lean_draft: true,
     draft_compat: undefined,
     '[better-sqlite]': { lean_draft: true },
     '[lean-draft]': { lean_draft: true },
@@ -132,7 +142,7 @@ const defaults = module.exports = {
   },
 
   hana: {
-    'deploy-format': 'hdbcds', // or 'hdbtable'
+    'deploy-format': 'hdbtable',
     journal:  {
       'change-mode': 'alter'
     }

package/lib/env/plugins.js

@@ -1,7 +1,7 @@
 // REVISIT: we should have a real modular plugin technique for cds.env
 module.exports = function add_mtx_env (env) {
 
-  const mtx_env = old_mtx_env() || require('@sap/cds-mtxs/env') // eslint-disable-line cds/no-missing-dependencies
+  const mtx_env = require('@sap/cds-mtxs/env') // eslint-disable-line cds/no-missing-dependencies
   if (mtx_env) {
     const {requires} = env, {kinds} = requires
     Object.assign (env, mtx_env, {requires})
@@ -14,16 +14,5 @@ module.exports = function add_mtx_env (env) {
     catch(e) { if (e.code !== 'MODULE_NOT_FOUND') throw e }
   }
 
-  function old_mtx_env() {
-    const {_oldMtx} = require('../utils/cds-utils')
-    if (_oldMtx()) return {
-      requires: { kinds: {
-        "multitenancy": { model: "@sap/cds/srv/mtx", kind: "saas-registry" },
-        "extensibility": { model: "@sap/cds/srv/mtx" },
-        // "toggles": { model: "@sap/cds/srv/mtx" },
-      }
-    }
-  }}
-
   return env
 }

package/lib/env/presets.js

@@ -1,26 +1,30 @@
-// REVISIT: Looks ver hard-coded -> move this to consumers?
+const cds = require('../index')
+
+const { join } = cds.utils.path
+
+const PROTOCOLS = {
+  'odata-v4': { path: '/odata/v4', impl: join(__dirname,'../srv/protocols/odata-v4') },
+  rest: { path: '/rest', impl: join(__dirname,'../srv/protocols/rest') }
+}
+
+// REVISIT: Looks very hard-coded -> move this to consumers?
 module.exports = function (conf) {
-  const { features } = conf
-  if (!features) return
+  let { features, requires } = conf
 
-  // integrity checks
-  if (typeof features.assert_integrity === 'string') {
-    switch (features.assert_integrity) {
-      case 'off':
-        features.assert_integrity = false
-        break
-      case 'app':
-        features.assert_integrity = true
-        features.assert_integrity_type = 'RT'
-        break
-      case 'db':
-        features.assert_integrity = true
-        features.assert_integrity_type = 'DB'
-        break
-      default:
-        // > invalid -> set to default
-        features.assert_integrity = false
-    }
+  if (requires?.middlewares) {
+    let p = conf.protocols || {}
+    for (let [k, o] of Object.entries(p)) if (typeof o === 'string') p[k] = { path: o }
+    p['odata-v4'] = Object.assign({}, PROTOCOLS['odata-v4'], p['odata-v4'])
+    p.odata = Object.assign({}, PROTOCOLS['odata-v4'], p.odata)
+    p.rest = Object.assign({}, PROTOCOLS.rest, p.rest)
+    conf.protocols = p
   }
 
+  // integrity checks
+  if (!features) return
+  if (typeof features.assert_integrity === 'string' && features.assert_integrity.match(/db/i)) {
+    features.assert_integrity = true
+    features.assert_integrity_type = 'DB'
+  } else features.assert_integrity = false
 }
+