@sap/cds-dk 7.3.1 → 7.4.0

package/bin/add.js

@@ -27,6 +27,8 @@ module.exports = Object.assign(add, {
 
     *approuter*             - add support for application routing
 
+    *local-messaging*       - add support for local messaging
+
     *file-based-messaging*  - add support for file-based messaging
 
     *enterprise-messaging*  - add support for SAP Event Mesh

package/bin/build.js

@@ -1,7 +1,7 @@
 module.exports = Object.assign(build, {
     options: ['--project', '--src', '--dest', '--for', '--use', '--opts', '--log-level', '--options-model'],
     shortcuts: ['-in', '-s', '-o', '-4'],
-    flags: ['--ws', '--clean'],
+    flags: ['--clean', '--no-clean', '--ws'], // REVISIT: --clean is deprecated, backward compatibility
     help: `
 # SYNOPSIS
 
@@ -16,7 +16,6 @@ module.exports = Object.assign(build, {
 # OPTIONS
 
      *-4 | --for* hana | java | nodejs | mtx | mtx-sidecar | mtx-extension
-
         Name of the build task that is applied to the source folder, either
         explicitly configured in the build task list or generated out of the
         project setup
@@ -25,7 +24,6 @@ module.exports = Object.assign(build, {
         otherwise.
 
     *-s | --src* <folder>
-
         The module folder to build using the build task defined by option
         '--for'.
         This option is only supported when building an individual module of the
@@ -36,7 +34,6 @@ module.exports = Object.assign(build, {
         *hana* build task, 'srv' for *nodejs* or *java* build task.
 
     *-o | --dest* <folder>
-
         Output folder of the build task. The type of build task is defined by
         option '--for'.
         The folder is resolved based on '<project>/<cds.env.build.target>'.
@@ -49,14 +46,12 @@ module.exports = Object.assign(build, {
         '<project>/*<dest>*/*'.
 
     *--opts* <build task specific options>
-
         Add a comma-separated list of build task specific options in the format
         <opt1>=[value1,value2],<opt2>=value.
         For example, --opts model=[db,srv,schema.cds] loads and compiles the CDS
         model based on the given sources.
 
     *--profile* <profile,...>
-
         Loads the configuration data for the specified profile(s) and executes
         'cds build' based on this profile settings.
         E.g. you may want to create the HANA deployment artefacts only if the
@@ -64,18 +59,28 @@ module.exports = Object.assign(build, {
         The *development* profile is used by default.
 
     *--production*
-
         Shortcut for '--profile production'
 
     *--log-level* <debug | info | warn | error>
-
         Choose which level of cds build messages to log, default is *warn*.
 
     *-in | --project* [<project>]
-
         Runs 'cds build' for the specified project, default is current working
         directory.
-
+        
+    *--no-clean* (beta)
+        Skips cleaning the build output folder before running the actual build
+        operation. Clients need to clean the output folder upfront to ensure
+        consistent build results.
+
+    *--ws* (beta)
+        Enable tarball based packaging of npm workspace dependencies for Node.js apps.
+        This feature can be used to package npm workspace dependencies as part of your 
+        mono or multi-repo deployment.
+        Tarball files are created for all 'dependencies' and 'devDependencies' 
+        of your project for which a npm workspace exists. The '*' dependency is replaced
+        by the correct tarball file URL.
+        See 'npm workspaces' for further details.
 
 # EXAMPLES
 
@@ -88,8 +93,9 @@ module.exports = Object.assign(build, {
 
 async function build([project], options = {}) {
     const path = require('path')
+
     const cds = require('../lib/cds')
-    
+
     // plugins are loaded based on cds.root path
     cds.root = path.resolve(process.cwd(), project || options.project || '.')
 
@@ -104,13 +110,17 @@ async function build([project], options = {}) {
     if (Number(major) < 6) {
         throw "This application uses @sap/cds version < 6, which is not compatible with the installed @sap/cds-dk version >= 7. Update @sap/cds to version >= 6."
     }
-    if (options.clean === "false") {
-        throw "cds build option '--clean' is deprecated - build output folders are always cleaned before build"
-    }
     if (typeof options["options-model"] === "string") {
         options.opts = "model=[" + options["options-model"].split(",").map((entry) => entry.trim()) + "]"
         delete options["options-model"]
     }
+    if (options["no-clean"]) {
+        // mapping to the existing 'clean' option
+        if (options["no-clean"] === "true" || options["no-clean"] === true) {
+            options.clean = false
+        }
+        delete options["no-clean"]
+    }
 
     await build(options)
 }

package/bin/cds.js

@@ -30,7 +30,7 @@ const cli = { //NOSONAR
     if (cmd in this.Shortcuts) cmd = process.argv[2] = this.Shortcuts[cmd]
     if (argv.some(a => this.Shortcuts[a]==='help'))  return this.help (cmd)
 
-    const cds = require('../lib/cds')
+    const cds = require('../lib') // make sure to load cds-dk API for plugins
     DEBUG?.(`[cds] - @sap/cds ${cds.version} loaded: ${cds.home}`)
 
     try {
@@ -93,8 +93,8 @@ const cli = { //NOSONAR
 
     function add (k,v) { options[k.slice(2)] = v || true }
     function add_global (k,v='') {
-      if (k === '--production') return process.env.CDS_ENV = [...process.env.CDS_ENV?.split(',') ?? [], 'production']
-      if (k === '--profile') return process.env.CDS_ENV = [...process.env.CDS_ENV?.split(',') ?? [], ...v.split(',')]
+      if (k === '--production') return process.env.CDS_ENV = Array.from(new Set([...process.env.CDS_ENV?.split(',') ?? [], 'production']))
+      if (k === '--profile')    return process.env.CDS_ENV = Array.from(new Set([...process.env.CDS_ENV?.split(',') ?? [], ...v.split(',')]))
       if (k === '--odata') v = { flavor:v }
       let e=env || (env={}), path = k.slice(2).split('-')
       while (path.length > 1) { let p = path.shift(); e = e[p]||(e[p]={}) }
@@ -103,7 +103,7 @@ const cli = { //NOSONAR
 
     // if (env) require('../lib/cds').env.add (env) //> avoid loading env
     // unless it has already explicitly been set by the user
-    process.env.CDS_CONFIG ??= JSON.stringify(env)
+    if (env) process.env.CDS_CONFIG ??= JSON.stringify(env)
     return [ args, options ]
   },
 

package/bin/compile/index.js

@@ -53,6 +53,17 @@ module.exports = Object.assign ( compile, {
 
     - odata
     - sql
+    
+  *--dialect* <dialect>
+    
+    Needs option *--to*.
+    Specify the dialect in combination with *--to sql*.
+    Currently supported:
+    
+    - sqlite
+    - h2
+    - postgres
+    - hana
 
   *-s* | *--service* <name> | all
 

package/bin/init.js

@@ -40,7 +40,7 @@ module.exports = Object.assign(init, {
 
         *approuter*             - add support for application routing
 
-        *file-based-messaging*  - add support for file-based messaging
+        *local-messaging*       - add support for local messaging
 
         *enterprise-messaging*  - add support for SAP Event Mesh
 

package/bin/migrate.js

@@ -43,11 +43,11 @@ module.exports = Object.assign(migrate, {
         Skip verification step. Does not check for potential deployment
         differences.
 
-    *--cleanup* (beta)
+    *--cleanup*
 
         Removes all metadata containers created by @sap/cds-mtx.
 
-    *--resolve-bindings* (beta)
+    *--resolve-bindings*
 
         Resolve remote service bindings configured via *cds bind*.
 

package/bin/repl.js

@@ -17,8 +17,6 @@ async function repl (_, options={}) {
   const cds = require('../lib/cds')
   console.log('\x1b[32m\x1b[1m'+'Welcome to cds repl v', cds.version, '\x1b[0m')
 
-  await cds.plugins
-
   const { inspect } = require('util')
   inspect.defaultOptions.colors = true
   inspect.defaultOptions.depth = 11

package/bin/subscribe.js

@@ -1,8 +1,8 @@
 module.exports = Object.assign(subscribe, {
     init: cmd => new (require('../lib/client/tenant_action'))(cmd),
     options: ['--to', '--user'],
-    flags: ['--local'],
-    shortcuts: ['-2', '-u', '-l'],
+    flags: ['--local', '--resolve-bindings'],
+    shortcuts: ['-2', '-u', '-l', '-b'],
     help: `
 # SYNOPSIS
 
@@ -24,10 +24,10 @@ module.exports = Object.assign(subscribe, {
 
         Username and optionally password for authentication with Basic Auth in
         test scenarios.
-        
+
         Only relevant if <url> is given. May be omitted in case of dummy
         authentication.
-        
+
         Tokens saved with *cds login* are not used for this command.
 
     *-l* | *--local*
@@ -35,11 +35,15 @@ module.exports = Object.assign(subscribe, {
         Run a locally-installed @sap/cds-mtxs and connect to it instead of a
         URL. Ignore settings saved with *cds login*.
 
+    *-b* | *--resolve-bindings*
+
+        Resolve remote service bindings configured via *cds bind*.
+
 
 # SEE ALSO
 
     *cds login* for more information on authentication options.
-    
+
     *cds login* to save project settings and Basic-Auth data, simplifying multiple runs of this command.
 
 `});
@@ -63,6 +67,7 @@ async function subscribe([tenant], options = {}) {
     }
     const [username, password] = options.user?.split(':') ?? [];
     delete options.user;
+    delete options['resolve-bindings'];
 
     await subscribe.init('subscribe').run({
         ...options,

package/bin/unsubscribe.js

@@ -1,8 +1,8 @@
 module.exports = Object.assign(unsubscribe, {
     init: cmd => new (require('../lib/client/tenant_action'))(cmd),
     options: ['--from', '--user'],
-    flags: ['--local'],
-    shortcuts: ['-f', '-u', '-l'],
+    flags: ['--local', '--resolve-bindings'],
+    shortcuts: ['-f', '-u', '-l', '-b'],
     help: `
 # SYNOPSIS
 
@@ -25,10 +25,10 @@ module.exports = Object.assign(unsubscribe, {
 
         Username and optionally password for authentication with Basic Auth in
         test scenarios.
-        
+
         Only relevant if <url> is given. May be omitted in case of dummy
         authentication.
-        
+
         Tokens saved with *cds login* are not used for this command.
 
     *-l* | *--local*
@@ -36,11 +36,15 @@ module.exports = Object.assign(unsubscribe, {
         Run a locally-installed @sap/cds-mtxs and connect to it instead of a
         URL. Ignore settings saved with *cds login*.
 
+    *-b* | *--resolve-bindings*
+
+        Resolve remote service bindings configured via *cds bind*.
+
 
 # SEE ALSO
 
     *cds login* for more information on authentication options.
-    
+
     *cds login* to save project settings and Basic-Auth data, simplifying multiple runs of this command.
 
 `});
@@ -64,6 +68,7 @@ async function unsubscribe([tenant], options = {}) {
     }
     const [username, password] = options.user?.split(':') ?? [];
     delete options.user;
+    delete options['resolve-bindings'];
 
     await unsubscribe.init('unsubscribe').run({
         ...options,

package/bin/upgrade.js

@@ -1,8 +1,8 @@
 module.exports = Object.assign(upgrade, {
     init: cmd => new (require('../lib/client/tenant_action'))(cmd),
     options: ['--at', '--user'],
-    flags: ['--local'],
-    shortcuts: ['-a', '-u', '-l'],
+    flags: ['--local', '--resolve-bindings'],
+    shortcuts: ['-a', '-u', '-l', '-b'],
     help: `
 # SYNOPSIS
 
@@ -25,10 +25,10 @@ module.exports = Object.assign(upgrade, {
 
         Username and optionally password for authentication with Basic Auth in
         test scenarios.
-        
+
         Only relevant if <url> is given. May be omitted in case of dummy
         authentication.
-        
+
         Tokens saved with *cds login* are not used for this command.
 
     *-l* | *--local*
@@ -36,11 +36,15 @@ module.exports = Object.assign(upgrade, {
         Run a locally-installed @sap/cds-mtxs and connect to it instead of a
         URL. Ignore settings saved with *cds login*.
 
+    *-b* | *--resolve-bindings*
+
+        Resolve remote service bindings configured via *cds bind*.
+
 
 # SEE ALSO
 
     *cds login* for more information on authentication options.
-    
+
     *cds login* to save project settings and Basic-Auth data, simplifying multiple runs of this command.
 
 `});
@@ -64,6 +68,7 @@ async function upgrade([tenant], options = {}) {
     }
     const [username, password] = options.user?.split(':') ?? [];
     delete options.user;
+    delete options['resolve-bindings'];
 
     await upgrade.init('upgrade').run({
         ...options,

package/bin/watch.js

@@ -37,6 +37,11 @@ module.exports = Object.assign ( watch, {
     Open the given URL (suffix) in the browser after starting.
     If none is given, the default application URL will be opened.
 
+  *--profile* <profile,...>
+
+    Specify from which profile(s) the binding information is taken.
+    *Example:* cds w --profile hybrid,production
+
 # SEE ALSO
 
   *cds serve --help* for the different start options.

package/bin/watched.js

@@ -7,8 +7,8 @@
 
   // run through cli in order to use its error handling
   const args = JSON.parse(process.env._args)
+  const cds = require('../lib/cds'); cds.watched = true
   const bootstrap = require('./cds')(...args)
-  const {cds} = global; cds.watched = true
 
   cds.once('listening', ({server}) => {
     process.send ({ code:'listening', port: server.address().port })

package/lib/build/buildTaskFactory.js

@@ -230,7 +230,7 @@ class BuildTaskFactory {
 
     static _scanTaskOptionParams(optsParams) {
         // need to create new regex every call since a constant would keep the match state
-        const quoteRegex = /([\w-]+)=([\w/.]+|\[([\w/,.]+)\])/g
+        const quoteRegex = /([\w-]+)=([\w/.-]+|\[([\w/,.-]+)\])/g
 
         // captures a=1             => a:1
         //          a=[x,y,z]       => a:[x,y,z]

package/lib/build/constants.js

@@ -34,6 +34,7 @@ exports.CONTENT_NODE_MODULES = "contentNodeModules"             // copy node_mod
 exports.CONTENT_ENV = "contentEnv"                              // copy .env file if existing into deployment folder - DISABLED by default
 exports.CONTENT_DEFAULT_ENV_JSON = "contentDefaultEnvJson"      // copy default-env.json file if existing into deployment folder - DISABLED by default
 
+exports.CSV_FILE_TARGET = "csvFileTarget"                       // target folder when copying CSV files to the deployment target folder ./db/src/gen/*, default is 'data'
 exports.CSV_FILE_DETECTION = "csvFileDetection"                 // detect CSV files based on CDS model location - ENABLED by default
 exports.EXTENSION_POINT_VALIDATION = "extensionPointValidation" // validate extension point restrictions defined by the extended SaaS app - ENABLED by default
 exports.MTX_SIDECAR_DB_VALIDATION = "mtxSidecarDbValidation"    // validate consistency of app and sidecar db configuration - ENABLED by default

package/lib/build/provider/edmxBuildPlugin.js

@@ -51,9 +51,13 @@ class EdmxBuildPlugin extends FeatureToggleBuildPlugin {
     }
 
     _isOdataProtocol(srv) {
-        let protocols = cds.service.protocols.protocol4(srv)
-        if (typeof protocols === "string") {
-            protocols = [protocols]
+        let protocols = cds.service.protocols4?.(srv)
+        if (!protocols) {
+            // compatibility with @sap/cds < 7.3.0
+            protocols = cds.service.protocols.protocol4(srv)
+            if (typeof protocols === "string") {
+                protocols = [protocols]
+            }
         }
         return protocols.some(p => p && p.startsWith('odata'))
     }

package/lib/build/provider/featureToggleBuildPlugin.js

@@ -124,9 +124,8 @@ class FeatureToggleBuildPlugin extends InternalBuildPlugin {
 
     _validateFeature(ftCsn, baseCsn) {
         // features must not have other dependencies than base model dependencies - cross feature dependencies are not supported
-        // do not pass options.messages in order to avoid duplicate compiler messages
-        // version 2.13.9 of compileSources does not read the 'requires' definition of parsed CSNs
-        cds.compiler.compileSources({ [ftCsn.requires[0]]: baseCsn, 'feature.csn': ftCsn }, this.options())
+        // assuming only core compiler options are relevant for validation scenario
+        cds.compiler.compileSources({ [ftCsn.requires[0]]: baseCsn, 'feature.csn': ftCsn }, { ...super.options(), ...cds.env.cdsc ?? {}})
     }
 }
 

package/lib/build/provider/hana/2migration.js

@@ -13,8 +13,7 @@ module.exports = async (model, lastDevVersion, srcPath, options = {}) => {
     logger = options.logger
   }
 
-  const journalFileNames = _getJournalFileNames(model)
-  const { definitions, deletions, migrations, afterImage } = _toHdiMigration(model, lastDevVersion, journalFileNames, options)
+  const { definitions, deletions, migrations, afterImage, journalFileNames } = _toHdiMigration(model, lastDevVersion, options)
   const definitionResult = []
 
   for (const { name, suffix, sql } of definitions) {
@@ -33,8 +32,9 @@ module.exports = async (model, lastDevVersion, srcPath, options = {}) => {
   return { definitions: definitionResult, deletions, afterImage: _filterJournalArtifacts(afterImage) }
 }
 
-function _toHdiMigration(model, lastDevVersion, journalFileNames, options) {
+function _toHdiMigration(model, lastDevVersion, options) {
   const result = cdsc.to.hdi.migration(cds.minify(model), options, lastDevVersion);
+  const journalFileNames = _getJournalFileNames(result.afterImage);
   if (logger._debug) {
     logger.debug('cdsc.to.hdi.migration returned')
     for (const { name, suffix, sql } of result.definitions) {
@@ -50,7 +50,7 @@ ${migration ? migration.changeset.map(change => change.sql).join('\n') : 'Empty
       }
     }
   }
-  return result
+  return { ...result, journalFileNames };
 }
 
 /**

package/lib/build/provider/hana/index.js

@@ -6,7 +6,7 @@ const InternalBuildPlugin = require('../internalBuildPlugin')
 const { BuildError, relativePaths, BuildMessage } = require('../../util')
 
 const { OUTPUT_MODE_NONE, OUTPUT_MODE, CONTENT_PACKAGE_JSON, CONTENT_HDBTABLEDATA, CSV_FILE_DETECTION,
-    CONTENT_ENV, CONTENT_DEFAULT_ENV_JSON, CONTENT_NODE_MODULES, OUTPUT_MODE_RESULT, CONTINUE_UNRESOLVED_SCHEMA_CHANGES } = require('../../constants')
+    CONTENT_ENV, CONTENT_DEFAULT_ENV_JSON, CONTENT_NODE_MODULES, OUTPUT_MODE_RESULT, CONTINUE_UNRESOLVED_SCHEMA_CHANGES, CSV_FILE_TARGET } = require('../../constants')
 const { WARNING } = InternalBuildPlugin
 
 const DEFAULT_COMPILE_DEST_FOLDER = path.normalize("src/gen")
@@ -90,18 +90,28 @@ class HanaBuildPlugin extends InternalBuildPlugin {
      */
     async _copyResourcesExt(src, dest, model) {
         const resources = Object.keys(await cds.deploy.resources(model)).reverse() // reverse to get reuse resources first and app resources last
-        const csvPath = path.join(src, "data")
-        // determine subfolder name used by the application for backward compatibility
-        const csvFolder = resources.some(res => res && res.startsWith(csvPath)) ? "data" : "csv"
+        const dbSrc = path.join(src, 'src')
 
         // 1. copy csv files into 'src/gen/data' or 'src/gen/csv' subfolder
-        const dbSrc = path.join(src, 'src')
+        if (resources.length) {
+            // determine the CSV folder from the location of the CSVs defined in this build task db folder, use subfolder data by default
+            const dbCSVs = resources.filter(res => res.startsWith(src) && !res.startsWith(dbSrc))
+            let csvFolder = this.getBuildOption(CSV_FILE_TARGET)
+            if (csvFolder && !["data", "csv"].includes(csvFolder)) {
+                throw new BuildError("Invalid value for option 'csvFileTarget'. Valid values are 'data' or 'csv'.")
+            }
+            if (!csvFolder) {
+                const csvPath = path.join(src, "data")
+                // determine subfolder name used by the application for backward compatibility
+                csvFolder = !dbCSVs.length || dbCSVs.some(res => res && res.startsWith(csvPath)) ? "data" : "csv"
+            }
 
-        // await each copy as order is important - reuse resources first and app resources last
-        for (const res of resources) {
-            // do not duplicate resources that are already contained in db/src/**
-            if (res && /\.csv$/.test(res) && !res.startsWith(dbSrc)) {
-                await this.copy(res).to(path.join(this.task.options.compileDest, csvFolder, path.basename(res)))
+            // await each copy as order is important - reuse resources first and app resources last
+            for (const res of resources) {
+                // do not duplicate resources that are already contained in db/src/**
+                if (res && /\.csv$/.test(res) && !res.startsWith(dbSrc)) {
+                    await this.copy(res).to(path.join(this.task.options.compileDest, csvFolder, path.basename(res)))
+                }
             }
         }
 

package/lib/build/provider/java/index.js

@@ -24,12 +24,12 @@ class JavaBuildPlugin extends EdmxBuildPlugin {
 
         if (!this.hasBuildOption(CONTENT_EDMX, false)) {
             // generate edmx files containing all features
-            // localized edmx for backward compatibility
+            // REVISIT: localized edmx for backward compatibility
             if (!this.hasBuildOption(CONTENT_LOCALIZED_EDMX, false)) {
                 await this.compileToEdmx(odata, compileDest, { [FLAVOR_LOCALIZED_EDMX]: true })
             }
             // non-localized edmx
-            await this.compileToEdmx(odata, path.join(compileDest, 'odata', cds.env.odata.version), { [FLAVOR_LOCALIZED_EDMX]: false })
+            await this.compileToEdmx(odata, path.join(compileDest, 'odata', cds.env.odata.version), { [FLAVOR_LOCALIZED_EDMX]: this.hasBuildOption(FLAVOR_LOCALIZED_EDMX, true) })
         }
 
         if (!this.hasBuildOption(CONTENT_LANGUAGE_BUNDLES, false)) {