@sap/cds-dk 6.1.1 → 6.1.4

package/CHANGELOG.md

@@ -7,6 +7,32 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## Version 6.1.4 - 2022-09-09
+
+### Fixed
+
+- `cds build` now works again with `@sap/cds` version 4.  Previously, this silently failed with no output.  However, a warning is now emitted that strongly recommends an upgrade to version 6.
+
+## Version 6.1.3 - 2022-09-06
+
+### Fixed
+
+- `cds extend` and other commands no longer fail with `TypeError: Class constructor CliError cannot be invoked without 'new'`
+
+## Version 6.1.2 - 2022-08-25
+
+### Changed
+- `cds init` uses latest Maven Java archetype version 1.27.1 for creating Java projects.
+
+### Fixed
+- `cds add helm` fixed JSON Schema for `srv` property in values.yaml
+- `cds add helm` fixed env property errors for `hana_deployer` and `html5_apps_deployer`
+- `cds add data` now creates proper data file names for entites in a `context`, i.e. `sap.common-Countries.csv` instead of `sap-common-Countries.csv`
+- `cds import` now captures the parameter/property of collection type differently and the associated annotations are pulled out of the `items` object of the parameter/property entry in the csn.
+- Remove redundant `console.log()` statement in `cds lint`
+- `cds push` now shows complete error messages from extension validation
+- `cds push` and related commands now show properly formatted error messages and also fail with a non-zero exit code in error situations
+
 ## Version 6.1.1 - 2022-08-11
 
 ### Added

package/bin/build/all.js

@@ -65,9 +65,15 @@ function build([project], options = {}) {
         delete options["options-model"]
     }
 
-    try {
-        return require('../../lib/cds').build(options)
-    } catch (error) {
-        return Promise.reject(error.message)
+    const cds = require('../../lib/cds')
+    if (typeof cds.build.build === 'function') {
+        console.warn(`
+> WARNING: This application uses a very old version ${cds.version} of package '@sap/cds',
+> which will no longer be supported with the next major version of '@sap/cds-dk'.
+> We strongly recommend an upgrade to latest version 6 of '@sap/cds'.
+`)
+        return cds.build.build(options)
     }
+    return cds.build(options)
+
 }

package/bin/compile/index.js

@@ -283,7 +283,7 @@ function _log (messages, options) {
   const { sortMessagesSeverityAware, deduplicateMessages } = cds.compiler
   deduplicateMessages(messages)
   messages = sortMessagesSeverityAware (messages)
-  cds.utils._log (messages, options)
+  cds._log (messages, options)
 }
 
 /* eslint no-console:0 */

package/bin/login.js

@@ -1,8 +1,8 @@
 const { bold } = require('../lib/util/term');
 
 module.exports = Object.assign(login, {
-    options: ['--subdomain', '--directory', '--passcode', '--clientid'],
-    shortcuts: ['-s', '-d', '-p', '-c'],
+    options: ['--subdomain', '--directory', '--passcode', '--user', '--clientid'],
+    shortcuts: ['-s', '-d', '-p', '-u', '-c'],
     flags: ['--plain'],
     get help() {
         const config = require('../lib/client/settings_manager').SettingsManager.config
@@ -71,10 +71,16 @@ module.exports = Object.assign(login, {
 
         Tenant-specific passcode for authentication.
 
-    *-u* | *--username* <name>
+    *-u* | *--user* <name>[:[<password>]]
 
-        Username for authentication with Basic Auth in test scenarios. For security reasons,
-        username will only be saved for app URLs that look like localhost.
+        Username and optionally password for authentication with Basic Auth in test scenarios.        
+        See https://cap.cloud.sap/docs/guides/multitenancy/#send-subscribe-events for information
+        on suitable mock users.
+
+        When typing the colon but omitting <password>, the password is assumed empty. 
+
+        For security reasons, username will only be saved for app URLs that look like localhost.
+        The same is true for an empty password. Non-empty passwords will never be saved.
 
     *-c* | *--clientid* <clientid>
 
@@ -105,8 +111,12 @@ module.exports = Object.assign(login, {
 
 
 async function login ([url], options = {}) {
+    const [username, password] = options.user?.split(':') ?? [];
+    delete options.user;
     Object.assign(options, {
         url,
+        username,
+        password,
         tokenStorage: options.plain ? 'plain' : 'keyring',
         renewLogin: true,
         saveData: true

package/bin/subscribe.js

@@ -36,7 +36,7 @@ async function subscribe([tenant], { to: url, user } = {}) {
   if (!tenant)  throw new Error('Must provide a tenant')
   if (!url)  throw new Error('Must provide an app URL via `--to`')  // for now, if we don't infer it from the project
   if (typeof user !== 'string')  throw new Error('Must provide a username')
-  const [, username, , password = ''] = /([^:]+)(:(.*))?/.exec(user);
+  const [username, password = ''] = user.split(':');
   Logger.log(`Subscribing to ${url} for tenant '${tenant}' with user '${username}'${password === '' ? ' and empty password' : ''}`);
   const options = { auth: { username, password } };
   return require('axios').post (url+'/-/cds/deployment/subscribe', { tenant }, options);

package/lib/cds.js

@@ -1,9 +1,8 @@
-/** @type { import('@sap/cds/apis/cds') } */
+/** @type { import('@sap/cds/lib') } */
 const cds = module.exports = require(_local ('@sap/cds'))
 
 // for internal use in cds-dk only
-cds.utils._log = require(_local ('@sap/cds/bin/utils/log'))
-
+cds._log = require(_local ('@sap/cds/bin/utils/log'))
 
 function _local (id) {
   return require.resolve (id, {paths:[

package/lib/client/activate.js

@@ -6,6 +6,7 @@ const AuthManager = require('./auth_manager');
 const BaseCommand = require('./base_command');
 const { collectFileContent, collectFiles, toUnixPath } = require('./helper/fs_helper');
 const Logger = require('./helper/logging');
+const { CliError } = require('./helper/errors');
 
 const COMMAND_URL_SUFFIX = 'asyncActivate';
 const COMMAND_URL_SUFFIX_SYNC = 'activate';
@@ -27,7 +28,7 @@ async function checkFinished(jobId, statusUrl, params, finisher) {
         finisher.finished = true;
         clearInterval(finisher.timer);
         if (status === JOB_STATUS.FAILED) {
-            return finisher.reject(new Error(`Job ${jobId} failed: ${error.message || JSON.stringify(error)}`));
+            return finisher.reject(new CliError(`Job ${jobId} failed: ${error.message || JSON.stringify(error)}`));
         }
         Logger.log('Extension active');
         finisher.resolve();
@@ -55,17 +56,17 @@ module.exports = class Activate extends BaseCommand {
                 Logger.log(`Activating extension located at ${params.get('projectFolder')} to URL ${params.get('appUrl')}`);
             }
 
-            if (!await Activate.checkProject(params.get('projectFolder'))) {
-                throw new Error(params.get('projectFolder') + ' is not a valid extension project');
+            if (!await this.checkProject(params.get('projectFolder'))) {
+                throw new CliError(params.get('projectFolder') + ' is not a valid extension project');
             }
 
             try {
-                await Activate.runActivate(injection.cds, params);
+                await this.runActivate(injection.cds, params);
                 if (params.get('wsdl')) {
-                    await Activate.runCustomFileUpload(params);
+                    await this.runCustomFileUpload(params);
                 }
             } catch (error) {
-                Activate.handleHttpError(error, params);
+                await this.handleHttpError(error, params);
             }
         } catch (error) {
             Logger.error(undefined, error);
@@ -153,7 +154,7 @@ module.exports = class Activate extends BaseCommand {
             return wsdlFiles;
         } catch (error) {
             Logger.error(undefined, error);
-            throw new Error('No custom files found');
+            throw new CliError('No custom files found');
         }
     }
 
@@ -161,7 +162,7 @@ module.exports = class Activate extends BaseCommand {
         let activationUrl;
         const isSync = params.get('sync');
 
-        return Activate.collectExtensionFiles(cds, params.get('projectFolder'))
+        return this.collectExtensionFiles(cds, params.get('projectFolder'))
         .then(allFiles => {
             if (allFiles.size === 0) {
                 return null;
@@ -169,8 +170,8 @@ module.exports = class Activate extends BaseCommand {
 
             Logger.log('Activating extension...');
 
-            const urlSuffix = isSync ? Activate.COMMAND_URL_SUFFIX_SYNC : Activate.COMMAND_URL_SUFFIX;
-            activationUrl = Activate.getMtxApiUrl(params.get('appUrl'), urlSuffix);
+            const urlSuffix = isSync ? this.COMMAND_URL_SUFFIX_SYNC : this.COMMAND_URL_SUFFIX;
+            activationUrl = this.getMtxApiUrl(params.get('appUrl'), urlSuffix);
             const requestOptions = Object.assign({
                 headers: {}
             }, params.get('reqAuth'));
@@ -189,17 +190,17 @@ module.exports = class Activate extends BaseCommand {
             const { jobID: jobId, statusPath } = response.data;
 
             if (jobId === undefined) {
-                throw new Error('Activation failed: did not receive job ID');
+                throw new CliError('Activation failed: did not receive job ID');
             }
 
             if (!statusPath) {
-                throw new Error(`Job ${jobId} failed: did not receive job-status path`);
+                throw new CliError(`Job ${jobId} failed: did not receive job-status path`);
             }
 
             Logger.debug(`Job ID: ${jobId}`);
 
             return new Promise((resolve, reject) => {
-                const statusUrl = Activate.concatUrls(params.get('appUrl'), statusPath);
+                const statusUrl = this.concatUrls(params.get('appUrl'), statusPath);
                 const finisher = {
                     resolve,
                     reject,
@@ -214,7 +215,7 @@ module.exports = class Activate extends BaseCommand {
     static async runCustomFileUpload(params) {
         Logger.log(`Uploading custom files to ${params.get('appUrl')}...`);
 
-        const customFiles = Activate.collectCustomFiles(params.get('projectFolder'));
+        const customFiles = this.collectCustomFiles(params.get('projectFolder'));
 
         const customFilesSerialized = [];
         customFiles.forEach((value, key) => {
@@ -225,7 +226,7 @@ module.exports = class Activate extends BaseCommand {
             });
         });
 
-        const customFileUrl = Activate.getMtxApiUrl(params.get('appUrl'), Activate.UPDATE_CUSTOM_FILE_URL_SUFFIX);
+        const customFileUrl = this.getMtxApiUrl(params.get('appUrl'), this.UPDATE_CUSTOM_FILE_URL_SUFFIX);
         const requestOptions = Object.assign({
             headers: {},
         }, params.get('reqAuth'));

package/lib/client/auth_manager.js

@@ -4,6 +4,7 @@ const axios = require('axios');
 const Logger = require('./helper/logging');
 const { SettingsManager } = require('./settings_manager');
 const { ParamCollection } = require('./params');
+const { CliError } = require('./helper/errors');
 
 function addTokenInfo(params, authData) {
     params.set('token', authData.access_token);
@@ -60,7 +61,7 @@ async function retrieveTokenOrPasscodeUrl(params) {
         try {
             response = await axios.get(tokenUrl);
         } catch (error) {
-            throw new Error(`Failed to get authentication token: ${error}.\nResponse body: ${util.inspect(error.response && error.response.data)}`);
+            throw new CliError(`Failed to get authentication token: ${error}.\nResponse body: ${util.inspect(error.response && error.response.data)}`);
         }
         authData = response.data;
 
@@ -89,7 +90,7 @@ module.exports = class AuthManager {
                 if (params.get('saveData')) {
                     await SettingsManager.saveSettings(params);
                 }
-                throw new Error('Failed to login: no valid token or passcode provided. ' +
+                throw new CliError('Failed to login: no valid token or passcode provided. ' +
                     'Get a passcode' + (params.get('passcodeUrl') ? ' from ' + params.get('passcodeUrl') : '') +
                     ' and supply the code when re-running the command');
             }

package/lib/client/base_command.js

@@ -1,7 +1,7 @@
 const path = require('path');
 const fs = require('fs').promises;
 
-const Logger = require('./helper/logging');
+const { CliError } = require('./helper/errors');
 
 const MTX_URL_PATH_PREFIX = 'mtx/v1/model/';
 const CUSTOM_FILE_URL_SUFFIX = 'customTenantContent';
@@ -22,15 +22,13 @@ module.exports = class BaseCommand {
 
         switch (error.response && error.response.status) {
             case 401:
-                Logger.error('Request failed: authorization might have expired. Please retry with valid passcode' +
+                throw new CliError('Request failed: authorization might have expired. Please retry with valid passcode' +
                     (params.has('passcodeUrl') ? ` from ${params.get('passcodeUrl')}` : ''), error);
-                break;
             case 404:
-                Logger.error(`Request failed. Please check application URL ${params.get('appUrl')}`, error);
-                break;
+                throw new CliError(`Request failed. Please check application URL ${params.get('appUrl')}`, error);
             default:
                 // Including 422 (compilation or native-extension error).
-                Logger.error(undefined, error);
+                throw new CliError(undefined, error);
         }
     }
 

package/lib/client/extend.js

@@ -7,6 +7,7 @@ const BaseCommand = require('./base_command');
 const { normalizePath, isParent } = require('./helper/fs_helper');
 const Logger = require('./helper/logging');
 const Question = require('./helper/question');
+const { CliError } = require('./helper/errors');
 
 const COMMAND_URL_SUFFIX = 'content';
 const CUSTOM_FILE_FOLDERS = ['wsdl'];
@@ -88,7 +89,7 @@ module.exports = class Extend extends BaseCommand {
 
             const runOnExistingProject = await Extend.checkProject(params.get('projectFolder'));
             if (runOnExistingProject && !(params.get('force') || params.get('templates'))) {
-                throw new Error(folderExists(params.get('projectFolder')));
+                throw new CliError(folderExists(params.get('projectFolder')));
             }
 
             try {

package/lib/client/helper/errors.js

@@ -0,0 +1,11 @@
+const Logger = require('./logging');
+class CliError extends Error {
+    stack = '';
+    constructor(message, error) {
+        super(Logger.getMessage(message, error));
+    }
+}
+
+module.exports = {
+    CliError
+};

package/lib/client/helper/logging.js

@@ -17,20 +17,13 @@ module.exports = class Logger {
     }
 
     static getMessage(errorText, error) {
-        let message = errorText && errorText + '\n' || '';
+        let message = errorText ? errorText + '\n' : '';
         if (!error) {
             return message;
         }
-        if (process.env.DEBUG) {
-            if ('response' in error && error.response.data) {
-                const body = error.response.data;
-                if (body.error && body.error.message) {
-                    message += body.error.message + '\n';
-                }
-            }
+        message += error.response?.data?.error?.message || error.message;
+        if (process.env.DEBUG && error.stack) {
             message += '\n' + error.stack;
-        } else {
-            message += error.message;
         }
         return message;
     }

package/lib/client/params.js

@@ -1,5 +1,6 @@
 const Logger = require('./helper/logging');
 const { escapeRegex } = require('./helper/string_helper');
+const { CliError } = require('./helper/errors');
 
 
 // PARAM BASE TYPES
@@ -104,10 +105,10 @@ class Param {
             expectedType = typeof this.allowedValues[0];
         }
         if (typeof val !== expectedType) {
-            throw new Error(`Failed to set '${(this.name)}' = ${JSON.stringify(val)}: expected value of type ${expectedType}`);
+            throw new CliError(`Failed to set '${(this.name)}' = ${JSON.stringify(val)}: expected value of type ${expectedType}`);
         }
         if (this.allowedValues && !(this.allowedValues).includes(val)) {
-            throw new Error(`Failed to set '${(this.name)}' = ${JSON.stringify(val)}: expected one of ${JSON.stringify(this.allowedValues)}`);
+            throw new CliError(`Failed to set '${(this.name)}' = ${JSON.stringify(val)}: expected one of ${JSON.stringify(this.allowedValues)}`);
         }
     }
 
@@ -246,7 +247,7 @@ class ParamCollection {
      */
     checkFrozen() {
         if (this.isFrozen) {
-            throw new Error('cannot modify read-only parameter collection');
+            throw new CliError('cannot modify read-only parameter collection');
         }
     }
 
@@ -267,7 +268,7 @@ class ParamCollection {
     static mainName(name) {
         const paramDef = ParamDefs[name];
         if (!paramDef) {
-            throw new Error(`Unknown parameter: '${name}'`);
+            throw new CliError(`Unknown parameter: '${name}'`);
         }
         return paramDef.mainName;
     }

package/lib/client/pull.js

@@ -7,13 +7,13 @@ const { unpackTarArchive } = require('@sap/cds/lib/utils/resources');
 const { login } = require('./auth_manager');
 const BaseCommand = require('./base_command');
 const Logger = require('./helper/logging');
+const { CliError } = require('./helper/errors');
 
 module.exports = class Pull extends BaseCommand {
 
     static async run(paramValues) {
         try {
             const params = await login(paramValues);
-
             Logger.log(`Pulling base model from ${params.get('appUrl')}, for subdomain '${params.get('subdomain')}', to project folder '${params.get('projectFolder')}'`);
 
             const projectFolder = params.get('projectFolder');
@@ -24,8 +24,8 @@ module.exports = class Pull extends BaseCommand {
             const tgzBuffer = Buffer.from(await this.getTgz(params));
             return unpackTarArchive(tgzBuffer, targetDir, false);
 
-        } catch (mainError) {
-            Logger.error(undefined, mainError);
+        } catch (error) {
+            throw new CliError(undefined, error);
         }
     }
 
@@ -41,11 +41,8 @@ module.exports = class Pull extends BaseCommand {
         const pullUrl = `${(params.get('appUrl'))}/-/cds/extensibility/pull`;
         const options = { ...params.get('reqAuth'), responseType: 'arraybuffer' };
 
-        try {
-            const response = await axios.post(pullUrl, {}, options);
-            return response.data;
-        } catch (error) {
-            return this.handleHttpError(error, params);
-        }
+        return axios.post(pullUrl, {}, options)
+            .then(response => response.data)
+            .catch(error => this.handleHttpError(error, params));
     }
 }

package/lib/client/push.js

@@ -5,23 +5,22 @@ const axios = require('axios');
 const { login } = require('./auth_manager');
 const BaseCommand = require('./base_command');
 const Logger = require('./helper/logging');
+const { CliError } = require('./helper/errors');
 
 module.exports = class Push extends BaseCommand {
 
     static async run(paramValues) {
         try {
             const params = await login(paramValues);
-
             const projectFolder = params.get('projectFolder');
             Logger.log(`Pushing extension from project folder '${projectFolder}', for subdomain '${params.get('subdomain')}', to app URL ${params.get('appUrl')}`);
 
-            const tgzPath = join(projectFolder, 'gen', 'extension.tgz');
-            const tgz = fs.readFileSync(tgzPath, { encoding: 'base64' });
+            const tgz = fs.readFileSync(join(projectFolder, 'gen', 'extension.tgz'), { encoding: 'base64' });
             const extensionName = this.getExtensionName(projectFolder);
             return this.pushTgz(params, tgz, extensionName);
 
-        } catch (mainError) {
-            Logger.error(undefined, mainError);
+        } catch (error) {
+            throw new CliError(undefined, error);
         }
     }
 
@@ -29,7 +28,7 @@ module.exports = class Push extends BaseCommand {
         try {
             return require(join(projectFolder, 'package.json')).name;
         } catch (error) {
-            throw new Error(`Extension project at ${projectFolder} is missing package.json`);
+            throw new CliError(`Extension project at ${projectFolder} is missing package.json`);
         }
     }
 
@@ -37,13 +36,10 @@ module.exports = class Push extends BaseCommand {
         const pushUrl = `${params.get('appUrl')}/-/cds/extensibility/push`;
         const options = { ...params.get('reqAuth') };
 
-        try {
-            return axios.post(pushUrl, {
-                extension: tgz,
-                tag: extensionName
-            }, options);
-        } catch (error) {
-            return this.handleHttpError(error, params);
-        }
+        return axios.post(pushUrl, {
+            extension: tgz,
+            tag: extensionName
+        }, options)
+            .catch(error => this.handleHttpError(error, params));
     }
 }

package/lib/client/settings_manager.js

@@ -9,6 +9,7 @@ const { getAppFromSuggestions, getAppName, getSubdomain } = require('./helper/cf
 const isBas = require('./helper/env_helper');
 const Logger = require('./helper/logging');
 const Question = require('./helper/question');
+const { CliError } = require('./helper/errors');
 const { httpSchema, httpsSchema, extractSubdomain, schemaRegex, localhostRegex } = require('./helper/url_helper');
 const { ParamCollection, Persistence } = require('./params');
 const { capitalize } = require('./helper/string_helper');
@@ -95,7 +96,7 @@ async function getTokenBaseUrl(params, renewUrl) {
         return params.get('tokenUrl');
     }
     if (!params.has('appUrl')) {
-        throw new Error('Failed to determine token URL: app URL not given');
+        throw new CliError('Failed to determine token URL: app URL not given');
     }
     const baseUrl = new URL(params.get('appUrl'));
     const cleanPathname = pathname => baseUrl.pathname.replace(/\/?$/, pathname);
@@ -116,7 +117,7 @@ async function getTokenBaseUrl(params, renewUrl) {
             if (e.response?.status === 404) {
                 continue;
             } else {
-                throw Error(`Failed with root cause ${e.message}`);
+                throw new CliError(`Failed with root cause ${e.message}`);
             }
         }
     }
@@ -230,12 +231,12 @@ class SettingsManager {
                 }
             }
             if (!params.has('appUrl')) {
-                throw new Error('App URL not given. Please specify it or log in to Cloud Foundry and repeat this command.');
+                throw new CliError('App URL not given. Please specify it or log in to Cloud Foundry and repeat this command.');
             }
             if (!params.has('subdomain')) {
                 const subdomain = extractSubdomain(params.get('appUrl'));
                 if (!subdomain) {
-                    throw new Error('Subdomain not given');
+                    throw new CliError('Subdomain not given');
                 }
                 params.set('subdomain', subdomain);
                 Logger.log(`Subdomain determined from app URL: ${subdomain}`);
@@ -267,7 +268,7 @@ class SettingsManager {
             return;
         }
         if (params.get('tokenStorage') === 'keyring') {
-            throw new Error(`${capitalize(TOKEN_STORAGE_DESC.keyring)} requested but keytar not installed. Run 'npm install -g keytar' or ` +
+            throw new CliError(`${capitalize(TOKEN_STORAGE_DESC.keyring)} requested but keytar not installed. Run 'npm install -g keytar' or ` +
                 `switch to ${TOKEN_STORAGE_DESC.plain} by adding '--plain' (discouraged).`);
         }
         if (params.get('renewLogin') || logout) {
@@ -288,7 +289,7 @@ class SettingsManager {
             params.set('clientsecret', await Question.askQuestion('clientsecret: ', undefined, true));
             console.log();
             if (params.get('clientsecret') === '') {
-                throw new Error('clientsecret cannot be empty');
+                throw new CliError('clientsecret cannot be empty');
             }
         }
         async function addPasscode() {
@@ -296,7 +297,7 @@ class SettingsManager {
             params.set('passcode', await Question.askQuestion(prompt, undefined, true));
             console.log();
             if (params.get('passcode') === '') {
-                throw new Error('Passcode cannot be empty');
+                throw new CliError('Passcode cannot be empty');
             }
         }
         function setRelevantAuth(auth) {
@@ -338,7 +339,7 @@ class SettingsManager {
             if (params.get('password') === '') {
                 params.set('isEmptyPassword', true);
                 // TODO check password only in production env
-                // throw new Error('Password cannot be empty');
+                // throw new CliError('Password cannot be empty');
             } else {
                 params.delete('isEmptyPassword');
             }