@sap/cds 6.3.0 → 6.3.2

package/CHANGELOG.md

@@ -4,6 +4,26 @@
 - The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - This project adheres to [Semantic Versioning](http://semver.org/).
 
+## Version 6.3.2 - 2022-11-21
+
+### Fixed
+
+- `cds deploy` reports errors correctly
+- Reference resolution in QL API
+- `cds.parse.path` to correctly handle special characters
+- `cds build` issues on Windows: build with large number of files and build on Git Bash.
+- `odata` as default protocol for enabled middlewares feature
+
+## Version 6.3.1 - 2022-11-04
+
+### Fixed
+
+- `cds build` no longer reports false positive validation errors for built-in MTX models like `@sap/cds/srv/mtx` or `@sap/cds-mtxs/srv/bootstrap`
+- `cds deploy` handles empty result from `cf` call correctly
+- `$search` fails on columns composed by a CQL expression that uses the SAP HANA `coalesce` predicate
+- Draft ownership was erroneously checked for bound actions on active instances
+- `cds watch/run/serve --with-mocks` no longer start randomly with missing mocked services.  This could happen if previous runs crashed with errors and left bad state in the local service registry.
+
 ## Version 6.3.0 - 2022-10-28
 
 ### Added

package/bin/build/buildTaskEngine.js

@@ -2,8 +2,8 @@ const fs = require('fs')
 const path = require('path')
 const _cds = require('./cds'), { log } = _cds.exec
 const { sortMessagesSeverityAware, deduplicateMessages, CompilationError } = require('@sap/cds-compiler')
-const { relativePaths, BuildError, BuildMessage, resolveRequiredSapModels } = require('./util')
-const { OUTPUT_MODE_DEFAULT, SEVERITIES, LOG_LEVELS, LOG_MODULE_NAMES } = require('./constants')
+const { relativePaths, BuildError, BuildMessage, resolveRequiredSapModels, hasJavaNature } = require('./util')
+const { OUTPUT_MODE_DEFAULT, SEVERITIES, LOG_LEVELS, LOG_MODULE_NAMES, CDS_MODEL_EXCLUDE_LIST } = require('./constants')
 const BuildTaskProviderFactory = require('./buildTaskProviderFactory')
 const BuildTaskHandlerInternal = require('./provider/buildTaskHandlerInternal')
 
@@ -28,6 +28,7 @@ class BuildTaskEngine {
 
     async processTasks(tasks, buildOptions, clean = true) {
         const startTime = Date.now()
+        const messages = []
 
         if (buildOptions) {
             // clone as data may be stored as part of the buildOptions object
@@ -48,14 +49,16 @@ class BuildTaskEngine {
             buildOptions.target = path.resolve(buildOptions.root, this.env.build.target)
         }
 
-        // validate required @sap namespace models - log only
-        const { unresolved, missing } = this._resolveRequiredSapServices(tasks)
-        const messages = []
-        if (unresolved.length > 0) {
-            messages.push(new BuildMessage(`Required CDS service models [${unresolved.join(', ')}] cannot be resolved. Make sure to install the missing npm modules.`))
-        }
-        if (missing.length > 0) {
-            messages.push(new BuildMessage(`Required CDS service models [${missing.join(', ')}] are missing in custom build tasks. Make sure to add the missing models.`))
+        // Java projects don't have node modules installed on project root level
+        if (!hasJavaNature([buildOptions.root])) {
+            // validate required @sap namespace models - log only
+            const { unresolved, missing } = this._resolveRequiredSapServices(tasks)
+            if (unresolved.length > 0) {
+                messages.push(new BuildMessage(`Required CDS service models [${unresolved.join(', ')}] cannot be resolved. Make sure to install the missing npm modules.`))
+            }
+            if (missing.length > 0) {
+                messages.push(new BuildMessage(`Required CDS service models [${missing.join(', ')}] are missing in custom build tasks. Make sure to add the missing models.`))
+            }
         }
 
         // create build task handlers
@@ -85,7 +88,7 @@ class BuildTaskEngine {
             return buildResult
         } catch (error) {
             this._logBuildOutput(handlers, buildOptions)
-            
+
             // cds CLI layer logs in case of an exception if invoked from CLI
             if (!buildOptions.cli) {
                 this._logMessages(buildOptions, [...BuildTaskEngine._getErrorMessages([error]), ...messages])
@@ -336,7 +339,7 @@ class BuildTaskEngine {
 
         const unresolved = resolveRequiredSapModels(this.cds, [...taskModelPaths])
         // are the required service models contained in the task's options.model
-        const missing = srvModelPaths.filter(m => m.startsWith('@sap/') && !taskModelPaths.has(m) && !unresolved.find(u => u === m))
+        const missing = srvModelPaths.filter(m => m.startsWith('@sap/') && !CDS_MODEL_EXCLUDE_LIST.includes(m) && !taskModelPaths.has(m) && !unresolved.find(u => u === m))
 
         return { unresolved, missing }
     }

package/bin/build/constants.js

@@ -45,6 +45,8 @@ exports.FOLDER_GEN = "gen"
 exports.FILE_EXT_CDS = ".cds"
 exports.MTX_SIDECAR_FOLDER = "mtx/sidecar"                  // default name of the mtx sidecar folder
 exports.DEFAULT_CSN_FILE_NAME = "csn.json"
+// REVISIT: the models are not required if a custom server.js file is used for MTX bootstrap
+exports.CDS_MODEL_EXCLUDE_LIST = ['@sap/cds/srv/mtx', '@sap/cds-mtxs/srv/bootstrap']
 
 exports.CDS_CONFIG_PATH_SEP = "/"
 exports.SKIP_ASSERT_COMPILER_V2 = "skip-assert-compiler-v2"

package/bin/build/util.js

@@ -1,6 +1,6 @@
 const fs = require('fs')
 const path = require('path')
-const { SEVERITY_ERROR } = require('./constants')
+const { SEVERITY_ERROR, CDS_MODEL_EXCLUDE_LIST } = require('./constants')
 
 function getProperty(src, segments) {
     segments = Array.isArray(segments) ? segments : segments.split('.')
@@ -142,7 +142,7 @@ function isStreamlinedMtx(cds) {
  */
 function resolveRequiredSapModels(cds, modelPaths) {
     return modelPaths.filter(p => {
-        if (p.startsWith('@sap/')) {
+        if (p.startsWith('@sap/') && !CDS_MODEL_EXCLUDE_LIST.includes(p)) {
             const files = cds.resolve(p)
             return !files || files.length === 0
         }

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

@@ -2,6 +2,10 @@ const cp = require('child_process');
 const fsp = require('fs').promises;
 const os = require('os');
 const path = require('path');
+const util = require('util');
+
+const IS_WIN = os.platform() === 'win32';
+const execAsync = util.promisify(cp.exec);
 
 const cds = require('../../../lib');
 const LOG = cds.log ? cds.log('deploy') : console;
@@ -33,46 +37,23 @@ class CfUtil {
     }
 
     async _cfRun(...args) {
-        const cmdLine = `${CF_COMMAND} ${args.join(' ')}`;
-        if (DEBUG) {
-            // eslint-disable-next-line no-console
-            console.time(cmdLine);
-            LOG.debug('>>> ' + cmdLine);
-        }
+        args = args.map(arg => arg.replace(/"/g, '\\"'));
+        const cmdLine = `${CF_COMMAND} "${args.join('" "')}"`;
+        DEBUG && console.time(cmdLine);
+        LOG.debug('>>>', cmdLine);
 
         try {
-            return await new Promise((resolve, reject) => {
-                const child = cp.spawn(CF_COMMAND, args);
-
-                let stdout = '';
-                child.stdout.on('data', (data) => {
-                    stdout += data;
-                });
-
-                let stderr = '';
-                child.stderr.on('data', (data) => {
-                    stderr += data;
-                });
-
-                child.on('error', (err) => {
-                    DEBUG && LOG.debug(`${stdout}\n${stderr}`);
-                    if (err.code === 'ENOENT') {
-                        reject(new Error(`Command ${bold(CF_COMMAND)} not found. Make sure to install the Cloud Foundry Command Line Interface.`));
-                    } else {
-                        reject(err);
-                    }
-                });
-
-                child.on('close', (code) => {
-                    DEBUG && LOG.debug(`${stdout}\n${stderr}`);
-                    if (!code) {
-                        resolve(stdout.trim());
-                    } else {
-                        const errorMessage = `${stdout}\n${stderr}`;
-                        reject(new Error(errorMessage.trim()));
-                    }
-                });
+            const result = await execAsync(cmdLine, {
+                shell: IS_WIN,
+                stdio: ['inherit', 'pipe', 'inherit']
             });
+            result.stdout = result.stdout?.trim();
+            result.stderr = result.stderr?.trim();
+            return result;
+        } catch (err) {
+            err.stdout = err.stdout?.trim();
+            err.stderr = err.stderr?.trim();
+            throw err;
         } finally {
             // eslint-disable-next-line no-console
             DEBUG && console.timeEnd(cmdLine);
@@ -98,17 +79,20 @@ class CfUtil {
             args.push(JSON.stringify(bodyObj)); // cfRun uses spawn so no special handling for quotes on cli required
         }
 
-        const response = await this._cfRun(...args);
-        if (!response) {
-            throw new Error(`The response from the server was empty. Maybe your token is expired. Run the command again and re-log on in case the problem persists.`);
+        const result = await this._cfRun(...args);
+        let response = {};
+        if (result.stdout) {
+            response = JSON.parse(result.stdout);
+        } else if (result.stderr) {
+            response = { errors: [{ title: result.stderr }] };
         }
 
-        const result = JSON.parse(response);
-        if (result.errors) {
-            const errorMessage = result.errors.map((entry) => `${entry.title}: ${entry.detail} (${entry.code})`).join('\n');
+        if (response.errors) {
+            const errorMessage = response.errors.map((entry) => `${entry.title || ''}: ${entry.detail || ''} (${entry.code || ''})`).join('\n');
             throw new Error(errorMessage);
         }
-        return result;
+
+        return response;
     }
 
     _extract(string, pattern, errorMsg) {
@@ -138,23 +122,24 @@ class CfUtil {
 
     async getCfTargetFromCli() {
         const result = await this._cfRun('target');
-        return {
-            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.`),
-        };
+        if (result?.stdout) {
+            return {
+                apiEndpoint: this._extract(result.stdout, /api endpoint\s*:\s*([^\s]+)/i, `CF API endpoint is missing. Use 'cf login' to login.`),
+                user: this._extract(result.stdout, /user\s*:\s*(.+)/i, `CF user is missing. Use 'cf login' to login.`),
+                org: this._extract(result.stdout, /org\s*:\s*(.+)/i, `CF org is missing. Use 'cf target -o <ORG> to specify.`),
+                space: this._extract(result.stdout, /space\s*:\s*(.+)/i, `CF space is missing. Use 'cf target -s <SPACE>' to specify.`),
+            };
+        }
     }
 
     async getCfTarget() {
-        // check if token is valid or expired / missing
-        await this._cfRun('oauth-token');
+        await this._cfRun('oauth-token'); // check if token is valid or expired / missing
         return await this.getCfTargetFromConfigFile() || await this.getCfTargetFromCli();
     }
 
     async getCfSpaceInfo() {
         if (!this.spaceInfo) {
-            DEBUG && LOG.debug('getting space info');
+            LOG.debug('getting space info');
 
             const target = await this.getCfTarget();
 
@@ -179,7 +164,7 @@ class CfUtil {
     }
 
     async getService(serviceName, showMessage = true) {
-        showMessage && LOG.log(`Getting service ${bold(serviceName)}`);
+        showMessage && console.log(`Getting service ${bold(serviceName)}`);
         const spaceInfo = await this.getCfSpaceInfo();
 
         let counter = POLL_COUNTER;
@@ -208,7 +193,7 @@ class CfUtil {
                     throw new Error(`The returned service reported state '${OPERATION_STATE_FAILED}'.\n${JSON.stringify(serviceInstance, null, 4)}`);
 
                 default:
-                    LOG.log(`Unsupported server response state '${serviceInstance?.last_operation?.state}'. Waiting for next response.`);
+                    console.error(`Unsupported server response state '${serviceInstance?.last_operation?.state}'. Waiting for next response.`);
                     break;
             }
         }
@@ -221,11 +206,11 @@ class CfUtil {
 
         const probeService = await this.getService(serviceName, false);
         if (probeService) {
-            LOG.log(`Getting service ${bold(serviceName)}`);
+            console.log(`Getting service ${bold(serviceName)}`);
             return probeService;
         }
 
-        LOG.log(`Creating service ${bold(serviceName)} - please be patient...`);
+        console.log(`Creating service ${bold(serviceName)} - please be patient...`);
 
         const spaceInfo = await this.getCfSpaceInfo();
 
@@ -263,7 +248,7 @@ class CfUtil {
         }
 
         const postResult = await this._cfRequest('/v3/service_instances', undefined, body);
-        if (postResult.errors) {
+        if (postResult?.errors) {
             throw new Error(postResult.errors[0].detail);
         }
 
@@ -277,7 +262,7 @@ class CfUtil {
 
 
     async getServiceKey(serviceInstance, serviceKeyName, showMessage = true) {
-        showMessage && LOG.log(`Getting service key ${bold(serviceKeyName)}`);
+        showMessage && console.log(`Getting service key ${bold(serviceKeyName)}`);
 
         let counter = POLL_COUNTER;
         while (counter > 0) {
@@ -303,7 +288,7 @@ class CfUtil {
                     throw new Error(`The returned binding reported state '${OPERATION_STATE_FAILED}'.\n${JSON.stringify(binding, null, 4)}`);
 
                 default:
-                    LOG.log(`Unsupported server response state '${binding?.last_operation?.state}'. Waiting for next response.`);
+                    console.error(`Unsupported server response state '${binding?.last_operation?.state}'. Waiting for next response.`);
                     break;
             }
         }
@@ -316,11 +301,11 @@ class CfUtil {
 
         const serviceKey = await this.getServiceKey(serviceInstance, serviceKeyName, false);
         if (serviceKey) {
-            LOG.log(`Getting service key ${bold(serviceKeyName)}`);
+            console.log(`Getting service key ${bold(serviceKeyName)}`);
             return serviceKey;
         }
 
-        LOG.log(`Creating service key ${bold(serviceKeyName)} - please be patient...`);
+        console.log(`Creating service key ${bold(serviceKeyName)} - please be patient...`);
 
         const body = {
             type: 'key',
@@ -338,7 +323,7 @@ class CfUtil {
         }
 
         const postResult = await this._cfRequest('/v3/service_credential_bindings', undefined, body);
-        if (postResult.errors) {
+        if (postResult?.errors) {
             throw new Error(postResult.errors[0].detail);
         }
 

package/lib/compile/parse.js

@@ -16,7 +16,8 @@ const parse = module.exports = Object.assign (cds_parse, {
   }},
   path: (x,...values) => {
     if (x && x.raw) return tagged (parse.path,x,...values)
-    if (/^[A-Za-z_$][A-Za-z_0-9.$]*$/.test(x)) return {ref:[x]}
+    if (/^[A-Za-z_0-9.$]*$/.test(x)) return {ref:[x]}
+    if ((cds.context?.model || cds.model)?.definitions[x]) return {ref:[x]}
     let {SELECT} = parse.cql('SELECT from '+x)
     return SELECT.from
   },

package/lib/srv/bindings.js

@@ -69,6 +69,7 @@ module.exports = class Bindings {
             }
         }
         cds.on ('shutdown', ()=>this.purge())
+        process.on ('exit', ()=>this.purge()) // last resort e.g. in case of errors
         return this.store()
     }
 

package/lib/srv/protocols/index.js

@@ -10,7 +10,9 @@ class ProtocolAdapter {
     for (let [k,o] of Object.entries(protocols)) if (typeof o === 'string') protocols[k] = {path:o}
     if (!protocols.odata) protocols.odata = { impl: join(__dirname,'odata-v4') }
     if (!protocols.rest) protocols.rest = { impl: join(__dirname,'rest') }
-    return this.protocols = protocols
+    
+    // odata must always be first for fallback
+    return this.protocols = { odata: protocols.odata, ...protocols }
   }
 
   /**

package/lib/utils/tar.js

@@ -5,7 +5,7 @@ const spawn = /\btar\b/.test(process.env.DEBUG) ? (cmd, args, options) => {
   return child_process.spawn(cmd, args, options)
 } : child_process.spawn
 
-const cds = require('../index'), { fs, path, mkdirp } = cds.utils
+const cds = require('../index'), { fs, path, mkdirp, exists, rimraf } = cds.utils
 const _resolve = (...x) => path.resolve (cds.root,...x)
 
 // tar does not work properly on Windows (by npm/jest tests) w/o this change
@@ -15,6 +15,21 @@ const win = path => {
   if (Array.isArray(path)) return path.map(el => win(el))
 }
 
+// Copy files to temp dir on Windows and pack temp dir.
+// cli tar has a size limit on Windows.
+const createTemp = async (root, files) => {
+  const temp = await fs.promises.mkdtemp(`${fs.realpathSync(require('os').tmpdir())}${path.sep}tar-`)    
+  for (const file of files) {
+      const fname = path.relative(root, file)
+      const destination = path.join(temp, fname)
+      const dirname = path.dirname(destination)
+      if (!await exists(dirname)) await fs.promises.mkdir(dirname, { recursive: true })
+      await fs.promises.copyFile(file, destination)          
+  }
+
+  return temp
+}
+
 /**
  * Creates a tar archive, to an in-memory Buffer, or piped to write stream or file.
  * @example ```js
@@ -39,15 +54,31 @@ const win = path => {
  * - `.then()` collects the tar output into an in-memory `Buffer`
  * - `.to()` is a convenient shortcut to pipe the output into a write stream
  */
-exports.create = (dir='.', ...args) => {
+exports.create = async (dir='.', ...args) => {
 
   if (typeof dir === 'string') dir = _resolve(dir)
   if (Array.isArray(dir)) [ dir, ...args ] = [ cds.root, dir, ...args ]
-  if (Array.isArray(args[0])) args.push (...args.shift().map (f => path.isAbsolute(f) ? path.relative(dir,f) : f))
-  else args.push('.')
-  const c = process.platform === 'linux' 
-    ? spawn (`tar c -C ${dir}`, args, { shell:true })
-    : spawn (`tar cf - -C ${win(dir)}`, args, { shell:true })
+  
+  let c, temp
+  if (process.platform === 'win32') {
+    const spawnDir = (dir, args) => {      
+      if (args.some(arg => arg === '-f')) return spawn ('tar', ['c', '-C', win(dir), ...win(args)])
+      else return spawn ('tar', ['cf', '-', '-C', win(dir), ...win(args)])
+    }
+    args.push('.')
+    if (Array.isArray(args[0])) {
+      temp = await createTemp(dir, args[0])
+      args.shift()
+      c = spawnDir(temp, args)
+    } else {
+      c = spawnDir(dir, args)
+    }
+  } else {
+    if (Array.isArray(args[0])) args.push (...args.shift().map (f => path.isAbsolute(f) ? path.relative(dir,f) : f))
+    else args.push('.')
+
+    c = spawn ('tar', ['c', '-C', dir, ...args])
+  }
 
   return {__proto__:c, // returning a thenable + fluent ChildProcess...
 
@@ -60,6 +91,10 @@ exports.create = (dir='.', ...args) => {
       const bb=[]; c.stdout.on('data', b => bb.push(b))
       c.on('close', ()=>r(Buffer.concat(bb)))
       c.on('error', e)
+      if (process.platform === 'win32') {
+        c.on('close', async () => temp && exists(temp) && await rimraf(temp))
+        c.on('error', async () => temp && exists(temp) && await rimraf(temp))
+      }
     },
 
     /**
@@ -107,7 +142,7 @@ exports.extract = (archive, ...args) => ({
   to (...dest) {
     if (typeof dest === 'string') dest = _resolve(...dest)
     const input = typeof archive !== 'string' || archive == '-' ? '-' : _resolve(archive)
-    const x = spawn(`tar xf ${win(input)} -C ${win(dest)}`, args, { shell:true })
+    const x = spawn('tar', ['xf', win(input), '-C', win(dest), ...args])
     if (archive === '-') return x.stdin
     if (Buffer.isBuffer(archive)) archive = require('stream').Readable.from (archive)
     if (typeof archive !== 'string') archive.pipe (x.stdin)

package/libx/_runtime/fiori/generic/before.js

@@ -77,7 +77,7 @@ const _getRoot = req => {
   return root
 }
 
-const _getDraftDataFromExistingDraft = async (req, root) => {
+const _getDraftDataFromExistingDraft = async (req, root, isBoundAction) => {
   if (!root) return []
   if (root?.IsActiveEntity === false) {
     const query = _getSelectDraftDataCqn(root.entityName, root.where)
@@ -85,6 +85,9 @@ const _getDraftDataFromExistingDraft = async (req, root) => {
     return result
   }
 
+  // do not expect validate draft ownership for action call on active instances
+  if (isBoundAction) return []
+
   const rootWhere = getKeysCondition(req)
   const query = _getSelectDraftDataCqn(ensureNoDraftsSuffix(req.target.name), rootWhere)
   const result = await cds.tx(req).run(query)
@@ -147,8 +150,8 @@ const _deleteCancel = async function (req) {
 }
 
 const _validateDraftBoundAction = async function (req) {
-  const result = await _getDraftDataFromExistingDraft(req, _getRoot(req))
   const isBoundAction = true
+  const result = await _getDraftDataFromExistingDraft(req, _getRoot(req), isBoundAction)
   if (result && result.length > 0) _validateDraft(req, result, isBoundAction)
 }
 

package/libx/_runtime/hana/search2Contains.js

@@ -95,7 +95,9 @@ const isContainsPredicateSupported = (query, entity, columns2Search) => {
 const _isColumnFunc = (columns2Search, columnsDefs) =>
   columns2Search.some(column2Search => {
     if (column2Search.func) return true
-    return columnsDefs?.some(columnDef => columnDef.func && columnDef.as === column2Search.ref[0])
+    return columnsDefs?.some(
+      columnDef => (columnDef.func && columnDef.as === column2Search.ref[0]) || columnDef?.xpr?.some(xpr => xpr.func)
+    )
   })
 
 module.exports = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/cds",
-  "version": "6.3.0",
+  "version": "6.3.2",
   "description": "SAP Cloud Application Programming Model - CDS for Node.js",
   "homepage": "https://cap.cloud.sap/",
   "keywords": [