@sap/cds-dk 7.0.3 → 7.1.0

package/lib/client/auth_manager.js

@@ -4,7 +4,7 @@ const cds = require('../cds');
 const DEBUG = cds.debug('cli');
 const { SettingsManager } = require('./settings_manager');
 const { ParamCollection } = require('./params');
-const { CliError } = require('./helper/errors');
+const { getMessage } = require('./helper/logging');
 
 function addTokenInfo(params, authData) {
     params.set('token', authData.access_token);
@@ -79,14 +79,14 @@ async function retrieveTokenOrPasscodeUrl(params) {
                 if (error.response?.status === 404) { // may represent 405 in case of wrong method
                     continue;
                 }
-                throw new CliError('Failed to get authentication token', { error });
+                throw getMessage('Failed to get authentication token', { error });
             }
             if (response) {
                 break;
             }
         }
         if (!response) {
-            throw new CliError('Failed to get authentication token');
+            throw 'Failed to get authentication token';
         }
         authData = response.data;
 
@@ -115,9 +115,9 @@ module.exports = class AuthManager {
                 if (params.get('saveData')) {
                     await SettingsManager.saveSettings(params);
                 }
-                throw new CliError(`Failed to login: no valid token or passcode provided. Get a passcode${
+                throw `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`);
+                } and supply the code when re-running the command`;
             }
             params.set('reqAuth', { headers: { Authorization: 'Bearer ' + params.get('token') } });
         }

package/lib/client/base_command.js

@@ -3,7 +3,7 @@ const fs = require('fs').promises;
 
 require('../util/pruneAxiosErrors');
 
-const { CliError } = require('./helper/errors');
+const { getMessage } = require('./helper/logging');
 
 const MTX_URL_PATH_PREFIX = 'mtx/v1/model/';
 const CUSTOM_FILE_URL_SUFFIX = 'customTenantContent';
@@ -22,16 +22,16 @@ module.exports = class BaseCommand {
         const prefix = `Request to ${url} failed`;
         switch (error.response?.status) {
             case 401:
-                throw new CliError(`${prefix}: invalid authentication.\nRetry with valid passcode${
+                throw getMessage(`${prefix}: invalid authentication.\nRetry with valid passcode${
                     params.has('passcodeUrl') ? ` from ${params.get('passcodeUrl')}` : ''
                 } or username/password (required if SaaS app is configured with mocked-auth).`, { error, command });
             case 403:
-                throw new CliError(prefix + ': insufficient authorization. Ensure client has all necessary roles.', { error, command });
+                throw getMessage(prefix + ': insufficient authorization. Ensure client has all necessary roles.', { error, command });
             case 404:
-                throw new CliError(prefix + ': resource not found.', { error, command });
+                throw getMessage(prefix + ': resource not found.', { error, command });
             case 422:
                 // Compilation or native-extension error.
-                throw new CliError(prefix + '.', { error, command });
+                throw getMessage(prefix + '.', { error, command });
             default:
                 // Unexpected error should be transparent to user.
                 throw error;

package/lib/client/extend.js

@@ -6,7 +6,7 @@ const AuthManager = require('./auth_manager');
 const BaseCommand = require('./base_command');
 const { normalizePath, isParent } = require('./helper/fs_helper');
 const Question = require('./helper/question');
-const { CliError } = require('./helper/errors');
+const { getMessage } = require('./helper/logging');
 
 const COMMAND_URL_SUFFIX = 'content';
 const CUSTOM_FILE_FOLDERS = ['wsdl'];
@@ -87,7 +87,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 CliError(folderExists(params.get('projectFolder')), { command: 'extend' });
+            throw getMessage(folderExists(params.get('projectFolder')), { command: 'extend' });
         }
 
         try {

package/lib/client/helper/logging.js

@@ -1,6 +1,6 @@
 /* eslint-disable no-console */
 
-function getMessage(errorText, { error, help } = {}) {
+function getMessage(errorText, { error, command, help = command && getCommandHelp(command) } = {}) {
     let message = errorText ? errorText : '';
     if (error) {
         message += '\n' + (
@@ -8,7 +8,7 @@ function getMessage(errorText, { error, help } = {}) {
             || error.response?.data?.error?.message // response body == { error }
             || error.message                        // no response attached
         );
-        if (process.env.DEBUG && error.stack) {
+        if (error.stack && require('../../cds').debug('cli')) {
             message += '\n' + error.stack;
         }
     }
@@ -18,6 +18,11 @@ function getMessage(errorText, { error, help } = {}) {
     return message;
 }
 
+function getCommandHelp(command) {
+    const cli = require('../../../bin/cds');
+    return cli?.load(command, () => ({ help: '' }))?.help ?? '';
+}
+
 module.exports = {
     getMessage
 };

package/lib/client/params.js

@@ -1,7 +1,6 @@
 const cds = require('../cds');
 const DEBUG = cds.debug('cli');
 const { escapeRegex } = require('./helper/string_helper');
-const { CliError } = require('./helper/errors');
 
 
 // PARAM BASE TYPES
@@ -106,10 +105,10 @@ class Param {
             expectedType = typeof this.allowedValues[0];
         }
         if (typeof val !== expectedType) {
-            throw new CliError(`Failed to set '${(this.name)}' = ${JSON.stringify(val)}: expected value of type ${expectedType}`);
+            throw `Failed to set '${(this.name)}' = ${JSON.stringify(val)}: expected value of type ${expectedType}`;
         }
         if (this.allowedValues && !(this.allowedValues).includes(val)) {
-            throw new CliError(`Failed to set '${(this.name)}' = ${JSON.stringify(val)}: expected one of ${JSON.stringify(this.allowedValues)}`);
+            throw `Failed to set '${(this.name)}' = ${JSON.stringify(val)}: expected one of ${JSON.stringify(this.allowedValues)}`;
         }
     }
 

package/lib/client/pull.js

@@ -7,13 +7,13 @@ const axios = require('axios');
 
 const { login } = require('./auth_manager');
 const BaseCommand = require('./base_command');
-const { CliError } = require('./helper/errors');
+const { getMessage } = require('./helper/logging');
 
 module.exports = class Pull extends BaseCommand {
 
     static async run(paramValues) {
         if (!tar) {
-            throw new CliError(`cds pull requires @sap/cds version >= 6.2. Current version is ${cds.version}\n`);
+            throw `cds pull requires @sap/cds version >= 6.2. Current version is ${cds.version}\n`;
         }
 
         const params = await login(paramValues);
@@ -59,7 +59,7 @@ module.exports = class Pull extends BaseCommand {
         try {
             packageContents = JSON.parse(fs.readFileSync(packageJson, { encoding: 'utf-8' }));
         } catch (error) {
-            throw new CliError('package.json missing or unreadable', { error });
+            throw getMessage('package.json missing or unreadable', { error });
         }
         fs.writeFileSync(packageJson, JSON.stringify({
             ...packageContents,

package/lib/client/push.js

@@ -5,7 +5,7 @@ const axios = require('axios');
 
 const { login } = require('./auth_manager');
 const BaseCommand = require('./base_command');
-const { CliError } = require('./helper/errors');
+const { getMessage } = require('./helper/logging');
 const { schemaRegex } = require('./helper/url_helper');
 const buildSystem = require('../build')
 
@@ -39,7 +39,7 @@ module.exports = class Push extends BaseCommand {
             src = local(src);
         } else {
             if (!schemaRegex.test(src)) {
-                throw new CliError(`Nonexistent path: ${src}`, { command: 'push' });
+                throw getMessage(`Nonexistent path: ${src}`, { command: 'push' });
             }
             try {
                 content = (await axios.get(src, { responseEncoding: 'base64' })).data;
@@ -54,7 +54,7 @@ module.exports = class Push extends BaseCommand {
         try {
             return require(join(projectFolder, 'package.json')).name;
         } catch (error) {
-            throw new CliError(`Extension project at ${projectFolder} is missing package.json file`, { error, command: 'push' });
+            throw getMessage(`Extension project at ${projectFolder} is missing package.json file`, { error, command: 'push' });
         }
     }
 

package/lib/client/settings_manager.js

@@ -9,7 +9,6 @@ const { requireGlobal } = require('./helper/dependency_helper');
 const { getAppFromSuggestions, getSubdomain } = require('./helper/cf_helper');
 const isBas = require('./helper/env_helper');
 const Question = require('./helper/question');
-const { CliError } = require('./helper/errors');
 const { httpSchema, httpsSchema, schemaRegex, localhostRegex } = require('./helper/url_helper');
 const { capitalize } = require('./helper/string_helper');
 
@@ -95,7 +94,7 @@ async function getTokenBaseUrl(params, renewUrl) {
         return params.get('tokenUrl');
     }
     if (!params.has('appUrl')) {
-        throw new CliError('Failed to determine token URL: app URL not given');
+        throw 'Failed to determine token URL: app URL not given';
     }
     const baseUrl = new URL(params.get('appUrl'));
     const cleanPathname = pathname => baseUrl.pathname.replace(/\/?$/, pathname);
@@ -237,7 +236,7 @@ class SettingsManager {
 
             // Check required param: appUrl
             if (!params.has('appUrl')) {
-                throw new CliError('App URL not given. Please specify it or log in to Cloud Foundry and repeat this command.');
+                throw 'App URL not given. Please specify it or log in to Cloud Foundry and repeat this command.';
             }
         }
         async function renewTokenUrl() {
@@ -273,8 +272,8 @@ class SettingsManager {
 
         if (params.get('tokenStorage') === 'keyring' && params.get('saveData')) {
             // Explicit login w/o plain-text storage enabled
-            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).');
+            throw 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).';
         }
 
         const doLog = params.get('saveData') || logout
@@ -296,14 +295,14 @@ class SettingsManager {
             params.set('clientsecret', await Question.askQuestion('clientsecret: ', undefined, true));
             console.log();
             if (params.get('clientsecret') === '') {
-                throw new CliError('Clientsecret cannot be empty');
+                throw 'Clientsecret cannot be empty';
             }
         }
         async function addKey() {
             params.set('key', await Question.askQuestion('key: ', undefined, true));
             console.log();
             if (params.get('key') === '') {
-                throw new CliError('Key cannot be empty');
+                throw 'Key cannot be empty';
             }
         }
         async function addPasscode() {
@@ -311,7 +310,7 @@ class SettingsManager {
             params.set('passcode', (await Question.askQuestion(prompt, undefined, true)).trim());
             console.log();
             if (params.get('passcode') === '') {
-                throw new CliError('Passcode cannot be empty');
+                throw 'Passcode cannot be empty';
             }
         }
         function setRelevantAuth(auth) {

package/lib/client/tenant_action.js

@@ -2,7 +2,7 @@ const cds = require('../cds');
 const DEBUG = cds.debug('cli');
 
 const BaseCommand = require('./base_command');
-const { CliError } = require('./helper/errors');
+const { getMessage } = require('./helper/logging');
 const { ParamCollection } = require('./params');
 const AuthManager = require('./auth_manager');
 const { capitalize } = require('./helper/string_helper');
@@ -65,13 +65,13 @@ module.exports = class TenantAction extends BaseCommand {
                 libPath = require.resolve(libId);
                 DEBUG?.(`Using cds-mtxs from ${libPath}`);
             } catch (error) {
-                throw new CliError('@sap/cds-mtxs not found or outdated. Have you changed into the directory of your SaaS app? If so, please upgrade to @sap/cds-mtxs@>=1.7.0', { error, command: this.command });
+                throw getMessage('@sap/cds-mtxs not found or outdated. Have you changed into the directory of your SaaS app? If so, please upgrade to @sap/cds-mtxs@>=1.7.0', { error, command: this.command });
             }
         }
 
         const { cds_mtx } = require(libPath);
         if (!cds_mtx) {
-            throw new CliError('@sap/cds-mtxs outdated. Please upgrade to @sap/cds-mtxs@>=1.7.0 and re-run this command.');
+            throw '@sap/cds-mtxs outdated. Please upgrade to @sap/cds-mtxs@>=1.7.0 and re-run this command.';
         }
         return cds_mtx(this.command, tenant);
     }

package/lib/deploy/to-hana/hana.js

@@ -15,7 +15,6 @@ const gitUtil = require('../../util/gitUtil');
 const mtaUtil = require('./mtaUtil');
 
 const { bold, info } = require('../../util/term');
-const { CliError } = require('../../client/helper/errors');
 
 const { bind } = require('../../bind');
 
@@ -49,7 +48,7 @@ class HanaDeployer {
     let { model, serviceName, tunnelAddress, vcapFile, undeployWhitelist, hdiOptions } = options;
 
     if (model) {
-      throw new CliError('Specifying a model for hana deployment is not supported.');
+      throw 'Specifying a model for hana deployment is not supported.';
     }
 
     console.log(`${bold('Starting deploy to SAP HANA ...')}`);

package/lib/import/common.js

@@ -66,6 +66,9 @@ async function getVersion(fileInputStream){
     } else if (version === '4.0' || version === "4.01") {
         oDataVersion = 'V4';
     }
+    else {
+        throw new Error(messages.INVALID_EDMX_METADATA_VERSION);
+    }
 
     return oDataVersion;
 }

package/lib/import/message.js

@@ -2,6 +2,7 @@
 
 const messages = {
 	INVALID_EDMX_METADATA: 'The OData model is not valid. Specify the correct OData model.',
+	INVALID_EDMX_METADATA_VERSION: 'The OData version is not valid. Specify the correct OData version.',
 	INVALID_OUTPUT_FILE: 'Please provide an output file with one of these [cds, csn, json] file extension.',
 	SPECIFY_INPUT_FILE: 'Specify an input file that exists.',
 	SPECIFY_OUTPUT_FILE: 'Specify an output file or correct the output file path provided.',
@@ -26,7 +27,7 @@ const messages = {
 	BOUNDED_ACTION_COLLISION: 'For Bounded Action, combination of action name and binding parameter type should be unique.',
 	STREAM_NO_COLLECTION: `'Edm.Stream' cannot be of Collection type.`,
 	UNSUPPORTED_PROPERTY_TYPE: 'Property cannot be of EntityType. Check the type: ',
-	UNRESOLVED_SCHEMA_NAMESPACE: `Could not resolve the schema `,
+    UNRESOLVED_SCHEMA_NAMESPACE: `Could not resolve the schema `,
 	INVALID_DATATYPE: `Invalid Data Type `,
 	ELEMENT_NAME_COLLISION: 'Collision between EntityContainer Element Name and Schema Element Name is currenlty not supported. Please check the element name: '
 };