@sap/cds 5.6.4 → 5.7.1

package/lib/core/reflect.js

@@ -1,6 +1,5 @@
 const { types, classes:{ service, entity, action, event, any, struct, array, context, annotation } } = require('.')
 const _kinds = { annotation, context, service, action, event, entity, view:entity }
-const _minified = Symbol('minified')
 
 class LinkedCSN extends any {
 
@@ -48,38 +47,6 @@ class LinkedCSN extends any {
     return Object.setPrototypeOf (x, new.target.prototype)
   }
 
-  minified (skip = global.cds.env.features.skip_unused) {
-    if (!skip) return this
-    if (this[_minified]) return this; else _set (this,_minified,true)
-    const csn = this, all = csn.definitions, reached = new Set
-    const roots = skip === 'all' ? this.services : this.each(_root)
-    for (let each of roots) _visit (each)
-    function _visit (d) {
-      if (reached.has(d)) return; else reached.add(d)
-      if (d.kind === 'service') for (let e of csn.childrenOf(d)) _visit(e)
-      if (d.includes)  d.includes.forEach(i => _visit(all[i]))  // Note: with delete d.includes, redirects in AFC broke
-      if (d.query)     d.query._target && _visit (d.query._target)
-      if (d.type)      _builtin(d.type) || _visit (d.__proto__)
-      if (d.target)    _visit (d._target) ; else if (d.targetAspect) _visit (typeof d.targetAspect === 'object' ? d.targetAspect : all[d.targetAspect])
-      if (d.returns)   _visit (d.returns)
-      if (d.items)     _visit (d.items)
-      if (d.parent)    _visit (d.parent)
-      for (let e in d.elements) _visit (d.elements[e])
-      for (let a in d.actions) _visit (d.actions[a])
-      for (let p in d.params) _visit (d.params[p])
-    }
-    for (let n in all) {
-      if (n.endsWith('.texts') && reached.has(all[n.slice(0,-6)])) continue
-      if (reached.has(all[n])) continue
-      else {
-        delete all[n]
-        // also delete the legacy _texts proxy (not enumerable, installed by _localized.unfold_csn)
-        if (n.endsWith('.texts'))  delete all[n.replace('.texts','_texts')]
-      }
-    }
-    return this
-  }
-
   *each (x, defs=this.definitions) {
     const pick=_is(x); for (let d in defs) if (pick(defs[d])) yield defs[d]
   }
@@ -131,7 +98,6 @@ class LinkedCSN extends any {
 const _unresolved = (x,unknown=any) => ({name:x, __proto__:unknown.prototype, _unresolved:true})
 const _builtin = x => types[x] || typeof x === 'string' && x.startsWith('cds.hana.') && any.prototype
 const _infer = require('./infer'), _not_inferred = _unresolved('<query>',entity)
-const _root = d => d instanceof service || d instanceof entity && !d.name.endsWith('.texts') && d['@cds.persistence.skip'] !== 'if-unused'
 const _set = (o,p,v) => Object.defineProperty (o,p,{value:v,enumerable:false,configurable:1,writable:1})
 const _own = (o,p) => { const pd = Reflect.getOwnPropertyDescriptor(o,p); return pd && pd.value }
 const _is = x => {

package/lib/deploy.js

@@ -14,7 +14,16 @@ exports = module.exports = function cds_deploy (model,options) { return {
   async to (db, o=options||{}) { // NOSONAR
     LOG = cds.log('deploy')
 
-    if (model && !model.definitions)  model = await cds.load (model)
+    if (model && !model.definitions) {
+      model = await cds.load (model) .then (cds.minify)
+      if (DEBUG) try {
+        DEBUG (`model loaded from ${model.$sources.length} file(s):\n\x1b[2m`)
+        for (let each of model.$sources)  console.log (' ', local(each))
+      } finally {
+        console.log ('\x1b[0m')
+      }
+    }
+
     if (o.mocked) exports.include_external_entities_in (model)
     else exports.exclude_external_entities_in (model)
 
@@ -120,37 +129,36 @@ function init_from_csv (db, csn, SILENT) {
 
   function _csvs (filename,_,allFiles) {
     if (filename[0] === '-' || !filename.endsWith ('.csv'))  return false
-    if (/[._]texts\.csv$/.test (filename) && check_lang_file(filename, allFiles)) {
-      return false
-    }
+    if (prefer_translated_texts(filename, allFiles)) return false
     return true
   }
 }
 
 function init_from_json (db, csn, SILENT) {
   return init_from_ (['data'], _jsons, db, csn, SILENT, (entity, src) => {
-      let json = JSON.parse (src)
-      return json[0] && INSERT.into (entity) .entries (json)
+    let json = JSON.parse (src)
+    return json[0] && INSERT.into (entity) .entries (json)
   });
 
   function _jsons (filename,_,allFiles) {
     if (filename[0] === '-' || !filename.endsWith ('.json'))  return false
-    if (/[._]texts\.json$/.test (filename) && check_lang_file(filename, allFiles)) {
-      return false
-    }
+    if (prefer_translated_texts(filename, allFiles)) return false
     return true
   }
 }
 
-function check_lang_file(filename, allFiles) {
-  // ignores 'Books_texts.csv/json' if there is any 'Books_texts_LANG.csv/json'
-  const basename = path.parse(filename).name
-  const monoLangFiles = allFiles.filter (file => new RegExp('^'+basename+'_').test (file))
-  if (monoLangFiles.length > 0) {
-    DEBUG && DEBUG (`ignoring '${filename}' in favor of [${monoLangFiles}]`)  // eslint-disable-line
-    return true
+/**
+ * ignores 'Books_texts.csv/json' if there is any 'Books_texts_LANG.csv/json'
+ */
+function prefer_translated_texts (file, all) {
+  if (/[._]texts\.(json|csv)$/.test (file)) {
+    const pattern = new RegExp('^'+ path.basename(file) +'_')
+    const translated = all.filter (f => pattern.test(f))
+    if (translated.length > 0) {
+      DEBUG && DEBUG (`ignoring '${file}' in favor of [${translated}]`)  // eslint-disable-line
+      return true
+    }
   }
-  return false
 }
 
 async function init_from_ (locations, filter, db, csn, SILENT, INSERT_into) { // NOSONAR

package/lib/env/defaults.js

@@ -13,12 +13,14 @@ module.exports = {
     in_memory_db: !production,
     test_data: !production,
     test_mocks: !production,
+    with_mocks: !production,
     mocked_bindings: !production,
     // skip_unused: 'all',
     skip_unused: true,
     one_model: true,
     localized: true,
-    // assert_integrity: true,
+    assert_integrity: true,
+    assert_integrity_type: 'RT',
     cds_tx_protection: true,
     cds_tx_inheritance: true,
   },

package/lib/env/index.js

@@ -2,6 +2,7 @@ const { isfile, fs } = require('../utils')
 const DEFAULTS = require('./defaults'), defaults = require.resolve ('./defaults')
 const os_user_home = require('os').homedir()
 const compat = require('./compat')
+const presets = require('./presets')
 const path = require('path')
 
 /**
@@ -73,6 +74,9 @@ class Config {
       else if (this.requires.db.multiTenant !== undefined) this.requires.multitenancy = this.requires.db.multiTenant
     }
 
+    // 9. apply presets
+    presets (this)
+
     // Only if feature is enabled
     this._emulate_vcap_services()
   }
@@ -214,14 +218,15 @@ _loadFromPath (_path, _basePath) {
   _add_process_env (prefix, basePath) {
     const {env} = process
     const PREF = prefix.toUpperCase(), my = { CONFIG: PREF+'_CONFIG', ENV: PREF+'_ENV' }
-    const configEnvValue = env[my.CONFIG]
     let config
-    try {
+
+    const configEnvValue = env[my.CONFIG]
+    if (configEnvValue) try {
       // CDS_CONFIG={ /* json */}
       config = JSON.parse (configEnvValue)
     } catch (e) {
       // CDS_CONFIG=/path/to/config.json *OR* CDS_CONFIG=/path/to/config/dir
-      if (configEnvValue && typeof configEnvValue === "string") this._loadFromPath (configEnvValue, basePath)
+      if (typeof configEnvValue === "string") this._loadFromPath (configEnvValue, basePath)
     }
 
     if (!config) config = {}

package/lib/env/presets.js

@@ -0,0 +1,38 @@
+module.exports = function (conf) {
+  const { features } = conf
+  if (!features) return
+
+  // integrity checks
+  if (typeof features.assert_integrity === 'string') {
+    switch (features.assert_integrity) {
+      case 'individual':
+        // > keep as is
+        break
+      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
+      // *-opt-in options not officially documented!
+      case 'app-opt-in':
+        features.assert_integrity = 'individual'
+        features.assert_integrity_type = 'RT'
+        break
+      case 'db-opt-in':
+        features.assert_integrity = 'individual'
+        features.assert_integrity_type = 'DB'
+        break
+      default:
+        // > invalid -> set to default
+        features.assert_integrity = true
+        features.assert_integrity_type = 'RT'
+    }
+  }
+
+}

package/lib/env/requires.js

@@ -73,16 +73,16 @@ module.exports = {
     local: true
   },
   "file-based-messaging": {
-    outbox: true,
+    outbox: {},
     impl: `${_runtime}/messaging/file-based.js`,
     credentials: { file:'~/.cds-msg-box' }
   },
   "default-messaging": {
-    "[development]": { "kind": "local-messaging" },
-    "[hybrid]": { "kind": "enterprise-messaging-amqp" },
+    "[development]": { kind: "local-messaging" },
+    "[hybrid]": { kind: "enterprise-messaging-amqp" },
     "[production]": {
-      "kind": "enterprise-messaging-amqp",
-      "[multitenant]": { "kind": "enterprise-messaging-http" }
+      kind: "enterprise-messaging-amqp",
+      "[multitenant]": { kind: "enterprise-messaging-http" }
     }
   },
   "enterprise-messaging": {
@@ -92,17 +92,17 @@ module.exports = {
     kind: "enterprise-messaging-amqp",
   },
   "enterprise-messaging-http": {
-    outbox: true,
+    outbox: {},
     impl: `${_runtime}/messaging/enterprise-messaging.js`,
     vcap: { label: "enterprise-messaging" },
   },
   "enterprise-messaging-amqp": {
-    outbox: true,
+    outbox: {},
     impl: `${_runtime}/messaging/enterprise-messaging-shared.js`,
     vcap: { label: "enterprise-messaging" },
   },
   'message-queuing': {
-    outbox: true,
+    outbox: {},
     impl: `${_runtime}/messaging/message-queuing.js`
   },
   "composite-messaging": {
@@ -110,15 +110,20 @@ module.exports = {
   },
   "audit-log": {
     impl: `${_runtime}/audit/Service.js`,
-    // REVISIT: how to load model?
+    // REVISIT: how to load model? -> see _prototypes below
     // model: 'AuditLogService.cds',
-    outbox: true,
+    outbox: {},
     vcap: { label: "auditlog" },
   },
 
   _prototypes: {
     "uiflex": {
-      "model": "@sap/cds/libx/_runtime/fiori/uiflex/extensibility"
+      model: "@sap/cds/srv/flex"
+    },
+    "persistent-outbox": {
+      model: "@sap/cds/srv/outbox",
+      maxAttempts: 20,
+      chunkSize: 100
     },
   }
 }

package/lib/index.js

@@ -3,19 +3,20 @@ if (global.cds) Object.assign(module,{exports:global.cds}) ; else {
 
   const facade = class cds extends require('events') {
 
-    get version() { return super.version = require('../package.json').version }
-    get env() { return super.env = require('./env') }
+    get env()      { return super.env = require('./env') }
     get requires() { return super.requires = this.env.required_services_or_defs }
-    get builtin() { return super.builtin = require ('./core') }
-    get service() { return super.service = extend (this.builtin.classes.service) .with ({
+    get version()  { return super.version = require('../package.json').version }
+    get builtin()  { return super.builtin = require ('./core') }
+    get service()  { return super.service = extend (this.builtin.classes.service) .with ({
       /** @param x {(this:Service, srv:Service) => any} */ impl: x=>x,
       /** @type Service[] */ providers: [],
       factory: require ('./serve/factory'),
       bindings: require ('./connect/bindings'),
     })}
-    get context() { return require('./req/context').for(this) }
-    set context(_){ require('./req/context').for(this,_) }
-    get spawn() { return super.spawn = require('./req/context').spawn }
+    /** @type {import './req/context'} */
+    get context() { return require('./req/cds-context').for(this) }
+    set context(_){ require('./req/cds-context').for(this,_) }
+    get spawn() { return super.spawn = require('./req/cds-context').spawn }
 
     emit (eve, ...args) {
       if (eve === 'served') return Promise.all (this.listeners(eve).map (l => l.call(this,...args)))
@@ -46,11 +47,13 @@ if (global.cds) Object.assign(module,{exports:global.cds}) ; else {
 
     // Loading and Compiling Models
     model: undefined,
+    compiler: require ('./compile/cdsc'),
+    compile: require ('./compile'),
     resolve: require ('./compile/resolve'),
     load: require ('./compile/load'), get: lazy => cds.load.parsed,
     parse: require ('./compile/parse'),
-    compile: require ('./compile'),
-    compiler: require ('./compile/cdsc'),
+    minify: require ('./compile/minify'),
+    extend: require ('./compile/extend'),
     deploy: require ('./deploy'),
 
     // Providing and Consuming Services
@@ -87,7 +90,7 @@ if (global.cds) Object.assign(module,{exports:global.cds}) ; else {
     log: require ('./log'), debug: lazy => cds.log.debug,
     exec: require ('../bin/cds'),
     clone: m => JSON.parse (JSON.stringify(m)),
-    lazified, lazify, extend,
+    lazified, lazify,
 
     // Configuration & Information
     home: __dirname.slice(0,-4),
@@ -117,7 +120,6 @@ if (global.cds) Object.assign(module,{exports:global.cds}) ; else {
   // legacy and to be moved stuff -> hidden for tools in cds.__proto__
   extend (cds.__proto__) .with (lazified ({
     /** @deprecated */ in: (cwd) => !cwd ? cds : {__proto__:cds, cwd, env: cds.env.for('cds',cwd) },
-    alpha_localized: lazy => require('./compile/etc/_localized'),
     mtx: lazy => require('../bin/mtx/in-cds'),
     build: lazy => require('../bin/build'),
   }))

package/lib/log/format/kibana.js

@@ -26,7 +26,9 @@ module.exports = (module, level, ...args) => {
     if (user && log_user) toLog.remote_user = user.id
     // add headers, if available, with _ instead of -
     const req = cds.context._ && cds.context._.req
-    if (req && req.headers) for (const k in req.headers) toLog[k.replace(/-/g, '_')] = req.headers[k]
+    if (req && req.headers)
+      for (const k in req.headers)
+        toLog[k.replace(/-/g, '_')] = k.match(/authorization/i) ? `${req.headers[k].split(' ')[0]} ***` : req.headers[k]
   }
   toLog.timestamp = new Date()
 

package/lib/log/index.js

@@ -4,8 +4,8 @@ const cds = require ('../index'), { log } = cds.env
 if (log.Logger || log.service) {
   if (log.Logger) exports.Logger = require (log.Logger)
   if (log.service) {
-    const {app} = cds, srv = require('./service')
-    app ? setImmediate(()=>srv.serveIn(app)) : cds.on('bootstrap', app => srv.serveIn(app))
+    const {app} = cds, serveIn = app => require('./service').serveIn(app)
+    app ? setImmediate(() => serveIn(app)) : cds.on('bootstrap', app => serveIn(app))
   }
 }
 

package/lib/req/cds-context.js

@@ -0,0 +1,79 @@
+const cds = require('../index'), { EventContext } = cds
+const { EventEmitter } = require('events')
+
+
+/**
+ * Continuation Local Storage for cds.context
+ */
+ exports.for = (cds,v) => {
+
+  if (cds.env.features.cls) {
+
+    const { executionAsyncResource:current, createHook } = module.require ('async_hooks')
+    const _context = Symbol('cds.context')
+
+    createHook ({ init(id,t,tid, res) {
+      const cr = current(); if (!cr) return
+      const ctx = cr[_context]
+      if (ctx) res[_context] = ctx
+    }}).enable()
+
+    Reflect.defineProperty (cds,'context',{ enumerable:1,
+      set(v) {
+        const cr = current(); if (!cr) return
+        const ctx = typeof v !== 'object' ? v : v.context || (v instanceof EventContext ? v : EventContext.for(v,false))
+        cr[_context] = ctx
+      },
+      get() {
+        const cr = current(); if (!cr) return undefined
+        return cr[_context]
+      },
+    })
+
+  } else {
+
+    Reflect.defineProperty (cds,'context',{ enumerable:1,
+      get:()=> undefined,
+      set:()=> {},
+    })
+
+  }
+
+  return v ? cds.context = v : cds.context
+}
+
+
+
+exports.spawn = function cds_spawn (o,fn) {
+
+  if (typeof o === 'function') [fn,o] = [o,fn] //> for compatibility
+  if (o instanceof cds.EventContext) throw new Error('The passed options must not be an instance of cds.EventContext.')
+  else if (!o) o = {}
+
+  const em = new EventEmitter()
+  const fx = () => {
+    // create a new transaction for each run of the background job
+    // which inherits from the current event context by default
+    const o2 = { ...o }; delete o2.timestamp //> spawned txes set their own timestamps
+    const tx = cds.context = cds.tx(o2)
+    const commit = async (res) => {
+      await tx.commit()
+      for (const handler of em.listeners('succeeded')) await handler(res)
+      for (const handler of em.listeners('done')) await handler()
+    }
+    fn(tx).then(commit, tx.rollback) .catch (async e => {
+      // tx.rollback throws passed error -> we will arrive here for any error
+      cds.log().error(`ERROR occured in background job:`, e)
+      for (const handler of em.listeners('failed')) await handler(e)
+      for (const handler of em.listeners('done')) await handler()
+    })
+  }
+
+  const timer = (
+    (o && o.after) ? setTimeout(fx, o.after) :
+    (o && o.every) ? setInterval(fx, o.every) :
+    setImmediate(fx)
+  )
+
+  return Object.assign (em, { timer })
+}

package/lib/req/context.js

@@ -12,8 +12,9 @@ class EventContext {
 
   toString() { return `${this.event} ${this.path}` }
 
-  static new (data={}, base = cds.context) {
-    if (data && base && features.cds_tx_inheritance) {
+  static for (data={}, base = cds.context) {
+    if (data instanceof EventContext) return data
+    if (base && features.cds_tx_inheritance) {
       let u = _inherit('user', u => typeof u === 'object' ? Object.create(u) : u)
       if (!u || !u.tenant) _inherit('tenant')
       if (!u || !u.locale) _inherit('locale')
@@ -156,78 +157,5 @@ class EventContext {
   }
 }
 
-
-/**
- * Continuation Local Storage for cds.context
- */
- const cls = (cds,v) => {
-
-  if (cds.env.features.cls) {
-
-    const { executionAsyncResource:current, createHook } = module.require ('async_hooks')
-    const _context = Symbol('cds.context')
-
-    createHook ({ init(id,t,tid, res) {
-      const cr = current(); if (!cr) return
-      const ctx = cr[_context]
-      if (ctx) res[_context] = ctx
-    }}).enable()
-
-    Reflect.defineProperty (cds,'context',{ enumerable:1,
-      set(v) {
-        const cr = current(); if (!cr) return
-        const ctx = typeof v !== 'object' ? v : v.context || (v instanceof EventContext ? v : EventContext.new(v,false))
-        cr[_context] = ctx
-      },
-      get() {
-        const cr = current(); if (!cr) return undefined
-        return cr[_context]
-      },
-    })
-
-  } else {
-
-    Reflect.defineProperty (cds,'context',{ enumerable:1,
-      get:()=> undefined,
-      set:()=> {},
-    })
-
-  }
-
-  return v ? cds.context = v : cds.context
-}
-
-
-function cds_spawn (o,fn) {
-  if (typeof o === 'function') [ fn, o ] = [ o, fn ]
-  if (!o) o = {}
-  const em = new EventEmitter()
-  const fx = async ()=> {
-    // create a new transaction for each run of the background job
-    // which inherits from the current event context by default
-    const tx = cds.context = cds.tx({...o})
-    try {
-      const res = await fn(tx)
-      await tx.commit()
-      for (const handler of em.listeners('succeeded')) await handler(res)
-      for (const handler of em.listeners('done')) await handler()
-    } catch(e) {
-      console.trace (`ERROR occured in background job:`, e) // eslint-disable-line no-console
-      await tx.rollback()
-      for (const handler of em.listeners('failed')) await handler(e)
-      for (const handler of em.listeners('done')) await handler()
-    }
-  }
-  const timer = (
-    (o && o.after) ? setTimeout (fx, o.after) :
-    (o && o.every) ? setInterval (fx, o.every) :
-    setImmediate (fx) )
-  return Object.assign(em, { timer })
-}
-
-
-module.exports = Object.assign (EventContext,{
-  /** @type {(cds,v)=>EventContext} */ for: cls,
-  spawn: cds_spawn,
-  propagateHeaders: [ 'x-correlation-id' ]
-})
+EventContext.propagateHeaders = [ 'x-correlation-id' ]
+module.exports = EventContext

package/lib/req/request.js

@@ -112,7 +112,7 @@ const SQL2Crud = {
 }
 
 const Query2Crud = (q) => {
-  if (typeof q === 'string') return SQL2Crud[q] || /^\s*(\w+)/.test(q) && SQL2Crud[RegExp.$1] || q
+  if (typeof q === 'string') return SQL2Crud[q] || /^\s*(\w+)/i.test(q) && SQL2Crud[RegExp.$1.toUpperCase()] || q
   else for (let each in q) if (each in SQL2Crud) return SQL2Crud[each]
 }
 

package/lib/serve/Service-api.js

@@ -1,5 +1,5 @@
 const add_methods_to = require ('./Service-methods')
-const cds = require('..')
+const cds = require('..'), { unfold_csn: cds_localized } = cds.compile._localized
 
 
 class Service extends require('./Service-handlers') {
@@ -13,9 +13,13 @@ class Service extends require('./Service-handlers') {
   /**
    * Subclasses may override this to prepare the given model appropriately
    */
-  set model(m) {
-    super.model = m && cds.linked(m)
-    if (m) add_methods_to (this)
+  set model (csn) {
+    if (csn) {
+      super.model = cds_localized(cds.linked(cds.compile.for.odata(csn)))
+      add_methods_to (this)
+    } else {
+      super.model = undefined
+    }
   }
 
   /**

package/lib/serve/Service-dispatch.js

@@ -37,13 +37,6 @@ exports.dispatch = async function dispatch (req) { //NOSONAR
     if (!req.query._srv) Object.defineProperty (req.query,'_srv',{ value:this, configurable:true, writable:true })
   }
 
-  // REVISIT: Ensure req._.req and req._.res in case of srv.run(query)?!
-  /*
-  if (this instanceof cds.ApplicationService && !req._.req) {
-    // TODO: add req and res to req._ from tx
-  }
-  */
-
   return this.handle(req)
 }
 

package/lib/serve/Service-methods.js

@@ -47,14 +47,12 @@ const add_handler_for = (srv, def) => {
 
       // object variant of params, ensure at least one param is present in args[0]
       // REVISIT: still not bullet proof, but parameters might be optional
-      if ( args[0] !== null && typeof args[0] === 'object' && args.length === 1 && Object.keys(def.params).some(p => p in args[0])) {
-        const params = args.shift()
-        for (const p in def.params)  {
-          data[p] = params[p]
-        }
-      } else { // positional
-        for (let p in def.params)  {
-          data[p] = args.shift()
+      if (def.params) {
+        if (args[0] !== null && typeof args[0] === 'object' && args.length === 1 && Object.keys(def.params).some(p => p in args[0])) {
+          const params = args.shift()
+          for (const p in def.params) data[p] = params[p]
+        } else { // positional
+          for (let p in def.params) data[p] = args.shift()
         }
       }