@sap/cds-dk 7.4.1 → 7.5.0

package/lib/{client → mtx}/download_legacy.js

@@ -3,11 +3,13 @@ const { join } = require('path');
 const axios = require('axios');
 
 const { login } = require('./auth_manager');
-const BaseCommand = require('./base_command');
+
+require('../util/pruneAxiosErrors');
+const { handleHttpError } = require('./util/errors');
 
 const DOWNLOAD_FILE_NAME = 'migrated_projects.tgz'; // TODO try to add tenant later, if possible
 
-module.exports = class Download extends BaseCommand {
+module.exports = class Download {
 
     static async run(paramValues) {
         const params = await login(paramValues);
@@ -15,7 +17,7 @@ module.exports = class Download extends BaseCommand {
         const projectFolder = params.get('projectFolder');
         const downloadPath = join(projectFolder, DOWNLOAD_FILE_NAME);
 
-        if (fs.existsSync(downloadPath) && !(await require('./helper/question').askBooleanQuestion(`File ${DOWNLOAD_FILE_NAME} already exists. Continue (yN)? `, false, false))) {
+        if (fs.existsSync(downloadPath) && !(await require('./util/question').askBooleanQuestion(`File ${DOWNLOAD_FILE_NAME} already exists. Continue (yN)? `, false, false))) {
             console.log('Download cancelled');
             return;
         }
@@ -35,6 +37,6 @@ module.exports = class Download extends BaseCommand {
 
         return axios.post(downloadUrl, { tagRule, defaultTag }, options)
             .then(response => Buffer.from(response.data))
-            .catch(error => this.handleHttpError(error, params, { url: downloadUrl }));
+            .catch(error => handleHttpError(error, params, { url: downloadUrl }));
     }
 }

package/lib/{client → mtx}/extend.js

@@ -3,12 +3,16 @@ const path = require('path');
 const axios = require('axios');
 
 const AuthManager = require('./auth_manager');
-const BaseCommand = require('./base_command');
-const { normalizePath, isParent } = require('./helper/fs_helper');
-const Question = require('./helper/question');
-const { getMessage } = require('./helper/logging');
+
+require('../util/pruneAxiosErrors');
+const { normalizePath, isParent } = require('./util/fs');
+const Question = require('./util/question');
+const { getMessage } = require('./util/logging');
+const { handleHttpError } = require('./util/errors');
+const { checkProject, getMtxApiUrl } = require('./util/legacy_ext');
 
 const COMMAND_URL_SUFFIX = 'content';
+const CUSTOM_FILE_URL_SUFFIX = 'customTenantContent';
 const CUSTOM_FILE_FOLDERS = ['wsdl'];
 const DB_FOLDER = 'db';
 const SRV_FOLDER = 'srv';
@@ -19,9 +23,10 @@ function folderExists(folder) {
         '\nWhen using --force, make sure you are using a version control system (like git) to avoid data loss';
 }
 
-module.exports = class Extend extends BaseCommand {
+module.exports = class Extend {
 
     static get COMMAND_URL_SUFFIX() { return COMMAND_URL_SUFFIX; }
+    static get CUSTOM_FILE_URL_SUFFIX() { return CUSTOM_FILE_URL_SUFFIX; }
 
     static async storeFiles(content, targetDirectory, filter) {
         fs.mkdirSync(targetDirectory, { recursive: true });
@@ -85,7 +90,7 @@ module.exports = class Extend extends BaseCommand {
             console.log('\n\nCreating extension project for', params.get('appUrl'), 'subdomain', params.get('subdomain'), 'in folder', params.get('projectFolder'));
         }
 
-        const runOnExistingProject = await Extend.checkProject(params.get('projectFolder'));
+        const runOnExistingProject = await checkProject(params.get('projectFolder'));
         if (runOnExistingProject && !(params.get('force') || params.get('templates'))) {
             throw getMessage(folderExists(params.get('projectFolder')), { command: 'extend' });
         }
@@ -93,12 +98,12 @@ module.exports = class Extend extends BaseCommand {
         try {
             await Extend.runExtend(params);
         } catch (error) {
-            await Extend.handleHttpError(error, params, { command: 'extend' });
+            await handleHttpError(error, params, { command: 'extend' });
         }
     }
 
     static async runExtend(params) {
-        const contentUrl = Extend.getMtxApiUrl(params.get('appUrl'), COMMAND_URL_SUFFIX);
+        const contentUrl = getMtxApiUrl(params.get('appUrl'), COMMAND_URL_SUFFIX);
         const requestOptions = Object.assign({ retry: 0 }, params.get('reqAuth'));
 
         console.log('Retrieving files...');
@@ -134,7 +139,7 @@ module.exports = class Extend extends BaseCommand {
 
         if (params.get('wsdl')) {
             console.log('Writing custom files');
-            const customFileUrl = Extend.getMtxApiUrl(params.get('appUrl'), Extend.CUSTOM_FILE_URL_SUFFIX);
+            const customFileUrl = getMtxApiUrl(params.get('appUrl'), CUSTOM_FILE_URL_SUFFIX);
             const customFiles = (await axios.get(customFileUrl, requestOptions)).data;
             await Extend.storeCustomFiles(params.get('projectFolder'), customFiles);
         }

package/lib/{client → mtx}/index.js

@@ -1,8 +1,8 @@
 const Activate = require('./activate');
 const AuthManager = require('./auth_manager');
 const Extend = require('./extend');
-const Question = require('./helper/question');
 const { SettingsManager } = require('./settings_manager');
+const Question = require('./util/question');
 
 module.exports = {
     extend: Extend.run,

package/lib/{client → mtx}/params.js

@@ -1,6 +1,8 @@
 const cds = require('../cds');
+
+const { escapeRegex } = require('./util/strings');
+
 const DEBUG = cds.debug('cli');
-const { escapeRegex } = require('./helper/string_helper');
 
 
 // PARAM BASE TYPES

package/lib/{client → mtx}/pull.js

@@ -6,10 +6,12 @@ const { join } = require('path');
 const axios = require('axios');
 
 const { login } = require('./auth_manager');
-const BaseCommand = require('./base_command');
-const { getMessage } = require('./helper/logging');
 
-module.exports = class Pull extends BaseCommand {
+require('../util/pruneAxiosErrors');
+const { getMessage } = require('./util/logging');
+const { handleHttpError } = require('./util/errors');
+
+module.exports = class Pull {
 
     static async run(paramValues) {
         if (!tar) {
@@ -46,7 +48,7 @@ module.exports = class Pull extends BaseCommand {
 
         return axios.post(pullUrl, {}, options)
             .then(response => Buffer.from(response.data))
-            .catch(error => this.handleHttpError(error, params, { url: pullUrl }));
+            .catch(error => handleHttpError(error, params, { url: pullUrl }));
     }
 
     static getPackageJsonIndentation(packageContents) {

package/lib/{client → mtx}/push.js

@@ -4,11 +4,13 @@ const { readFileSync, existsSync } = require('fs');
 const axios = require('axios');
 
 const { login } = require('./auth_manager');
-const BaseCommand = require('./base_command');
-const { getMessage } = require('./helper/logging');
-const { schemaRegex } = require('./helper/url_helper');
 const buildSystem = require('../build')
 
+require('../util/pruneAxiosErrors');
+const { getMessage } = require('./util/logging');
+const { schemaRegex } = require('./util/urls');
+const { handleHttpError } = require('./util/errors');
+
 const JOB_STATUS = {
     QUEUED: 'QUEUED',
     RUNNING: 'RUNNING',
@@ -16,7 +18,7 @@ const JOB_STATUS = {
     FAILED: 'FAILED'
 };
 
-module.exports = class Push extends BaseCommand {
+module.exports = class Push {
 
     static async run(paramValues, pushOptions = {}) {
         const params = await login(paramValues);
@@ -35,8 +37,7 @@ module.exports = class Push extends BaseCommand {
 
         console.log(`\nPushing extension '${extensionName}' from`, { src }, 'to', target);
         const push = await this.pushTgz(params, content, extensionName);
-        const async = params.get('async');
-        if (async) {
+        if (params.get('async')) {
             await this.pollUntilFinished(push.headers.location, params)
         }
         console.log ('Activation succeeded.\n')
@@ -55,7 +56,7 @@ module.exports = class Push extends BaseCommand {
             try {
                 content = (await axios.get(src, { responseEncoding: 'base64' })).data;
             } catch (error) {
-                this.handleHttpError(error, params, { url: src });
+                handleHttpError(error, params, { url: src });
             }
         }
         return { src, content };
@@ -81,7 +82,7 @@ module.exports = class Push extends BaseCommand {
             extension: tgz,
             tag: extensionName
         }, options)
-            .catch(error => this.handleHttpError(error, params, { url: pushUrl }));
+            .catch(error => handleHttpError(error, params, { url: pushUrl }));
     }
 
     static async pollUntilFinished(jobUrl, params) {
@@ -94,7 +95,7 @@ module.exports = class Push extends BaseCommand {
           }, 5 * 60 * 1000);
 
           const interval = setInterval(async () => {
-            const { status, error } = (await axios.get(jobUrl, options)).data;
+            const { status, error = 'cds push failed' } = (await axios.get(jobUrl, options)).data;
             if (status === JOB_STATUS.FINISHED || status === JOB_STATUS.FAILED) {
               clearInterval(interval);
               clearTimeout(timeout);

package/lib/{client → mtx}/settings_manager.js

@@ -4,13 +4,15 @@ const path = require('path');
 const axios = require('axios');
 
 const cds = require('../cds');
+
+const { requireGlobal } = require('./util/dependencies');
+const { getAppFromSuggestions, getSubdomain } = require('./util/cf');
+const isBas = require('./util/env');
+const Question = require('./util/question');
+const { httpSchema, httpsSchema, schemaRegex, localhostRegex } = require('./util/urls');
+const { capitalize } = require('./util/strings');
+
 const DEBUG = cds.debug('cli');
-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 { httpSchema, httpsSchema, schemaRegex, localhostRegex } = require('./helper/url_helper');
-const { capitalize } = require('./helper/string_helper');
 
 const { ParamCollection, Persistence } = require('./params');
 

package/lib/{client → mtx}/tenant_action.js

@@ -1,11 +1,13 @@
 const cds = require('../cds');
-const DEBUG = cds.debug('cli');
-
-const BaseCommand = require('./base_command');
-const { getMessage } = require('./helper/logging');
 const { ParamCollection } = require('./params');
 const AuthManager = require('./auth_manager');
-const { capitalize } = require('./helper/string_helper');
+
+require('../util/pruneAxiosErrors');
+const { getMessage } = require('./util/logging');
+const { capitalize } = require('./util/strings');
+const { handleHttpError } = require('./util/errors');
+
+const DEBUG = cds.debug('cli');
 
 const COMMANDS = {
     subscribe: 'to',
@@ -13,7 +15,7 @@ const COMMANDS = {
     unsubscribe: 'from'
 };
 
-module.exports = class TenantAction extends BaseCommand {
+module.exports = class TenantAction {
 
     // TODO JSDoc
     /**
@@ -23,7 +25,6 @@ module.exports = class TenantAction extends BaseCommand {
         if (!(command in COMMANDS)) {
             throw new Error(`invalid command: ${command}`);
         }
-        super();
         this.command = command;
         this.gerund = command.replace(/e$/, 'ing');
         this.preposition = COMMANDS[command];
@@ -50,7 +51,7 @@ module.exports = class TenantAction extends BaseCommand {
         try {
             await require('axios').post(url, { tenant }, params.get('reqAuth'));
         } catch (error) {
-            BaseCommand.handleHttpError(error, params, { url });
+            handleHttpError(error, params, { url });
         }
     }
 

package/lib/{client/helper/cf_helper.js → mtx/util/cf.js}

@@ -2,10 +2,11 @@ const os = require('os');
 const { execFile } = require('child_process');
 
 const cds = require('../../cds');
-const DEBUG = cds.debug('cli');
 const Question = require('./question');
-const { formatObjectsFixedWidth } = require('./string_helper');
-const { schemaRegex } = require('./url_helper');
+const { formatObjectsFixedWidth } = require('./strings');
+const { schemaRegex } = require('./urls');
+
+const DEBUG = cds.debug('cli');
 
 function runCf(args, callback) {
     const env = Object.assign({}, process.env, { LC_ALL: 'en_US.UTF-8' }); // enforce English headings

package/lib/{client/helper/dependency_helper.js → mtx/util/dependencies.js}

@@ -2,6 +2,7 @@ const os = require('os');
 const { execFileSync } = require('child_process');
 
 const cds = require('../../cds');
+
 const DEBUG = cds.debug('cli');
 
 let modulesDir;

package/lib/mtx/util/errors.js

@@ -0,0 +1,27 @@
+const { getMessage } = require('./logging');
+
+function handleHttpError(error, params, { url, command } = {}) {
+    url = url ?? params.get('appUrl');
+    const prefix = `Request to ${url} failed`;
+    switch (error.status) {
+        case 401:
+            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 getMessage(prefix + ': insufficient authorization. Ensure client has all necessary roles.', { error, command });
+        case 404:
+            throw getMessage(prefix + ': resource not found.', { error, command });
+        case 422:
+            // Compilation or native-extension error.
+            throw getMessage(prefix + '.', { error, command });
+        default:
+            // Unexpected error should be transparent to user.
+            delete error.status; // Purge extra property already included in message.
+            throw error;
+    }
+}
+
+module.exports = {
+    handleHttpError
+};

package/lib/mtx/util/legacy_ext.js

@@ -0,0 +1,16 @@
+const path = require('path');
+const fs = require('fs').promises;
+
+const { concatUrls } = require('./urls');
+require('../../util/pruneAxiosErrors');
+
+const MTX_URL_PATH_PREFIX = 'mtx/v1/model/';
+
+module.exports = {
+    async checkProject(folder) {
+        return await fs.access(path.join(folder, 'package.json')).then(() => true).catch(() => false);
+    },
+    getMtxApiUrl(url, action) {
+        return concatUrls(url, MTX_URL_PATH_PREFIX, action);
+    }
+}

package/lib/{client/helper/url_helper.js → mtx/util/urls.js}

@@ -12,10 +12,21 @@ function extractSubdomain(url) {
     return hostname.split('.')[0];
 }
 
+function concatUrls(...parts) {
+    return parts
+        .map((p, i) => i === 0
+            ? p.replace(/\/$/ /*end slash*/, '')
+            : i === parts.length - 1
+                ? p.replace(/^\// /*begin slash*/, '')
+                : p.replace(/^\/|\/$/g /*both*/, ''))
+        .join('/');
+}
+
 module.exports = {
     schemaRegex,
     localhostRegex,
     httpSchema,
     httpsSchema,
-    extractSubdomain
+    extractSubdomain,
+    concatUrls
 };

package/lib/util/fs.js

@@ -44,7 +44,11 @@ module.exports = new class FsUtil {
             const renderedFile = Mustache.render(file, project)
             return JSON.parse(renderedFile)
         }
-        return JSON.parse(file)
+        try {
+            return JSON.parse(file)
+        } catch (error) {
+            throw new Error(error.message + '\n' + file)
+        }
     }
 
     async readJSONC(src) {

package/lib/util/pruneAxiosErrors.js

@@ -11,26 +11,43 @@ require('axios').interceptors.response.use(
     axError => {
         const { inspect } = require('util');
         const { url, method } = axError.config ?? {};
-        const { response = {} } = axError;
-        const { status, statusText } = response;
-        let { data } = response;
-        if (Buffer.isBuffer(data)) {
-            data = data.toString();
-            try {
-                data = JSON.parse(data);
-            } catch (error) { /* unexpected; data will be included in error below */ }
+        const { errno, code, response = {} } = axError;
+        const prefix = (url && method ? `${method.toUpperCase()} ${url} ` : '') + 'failed';
+
+        let error;
+        if (errno) {
+            // System error during request.
+            const message = prefix
+                + `: ${errno} ${code}`
+                + (code === 'ENOTFOUND' ? `. Make sure the URL is correct and the server is running.` : '');
+            error = stacklessError(message);
+        } else {
+            // Error after request has been made.
+            const { status, statusText } = response;
+            let { data } = response;
+            if (Buffer.isBuffer(data)) {
+                data = data.toString();
+                try {
+                    data = JSON.parse(data);
+                } catch (error) { /* unexpected; data will be included in error below */
+                }
+            }
+            const inspectData = data && !data.error_description;
+            const reason = !inspectData && data?.error /* RFC 6749 */ && (typeof data.error === 'string' ? data.error : inspect(data.error));
+            const details = inspectData ? inspect(data) : data?.error_description /* RFC 6749 */;
+            const message = prefix +
+                (status || statusText ? ':' : '') +
+                (status ? ` ${status}` : '') +
+                (statusText ? ` ${statusText}` : '') +
+                (reason ? `. ${reason}` : '') +
+                (details ? `. Details: ${details}` : '');
+
+            error = stacklessError(message);
+            if (status) {
+                error.status = status;
+            }
         }
-        const reason = data?.error /* RFC 6749 */ && (typeof data.error === 'string' ? data.error : inspect(data.error));
-        const message = (url && method ? `${method.toUpperCase()} ${url} ` : '') +
-            'failed' +
-            (status || statusText ? ':' : '') +
-            (status ? ` ${status}` : '') +
-            (statusText ? ` ${statusText}` : '') +
-            (reason ? `. ${reason}` : '') +
-            (data ? `. Details: '${data.error_description /* RFC 6749 */ || inspect(data)}'` : '');
 
-        const error = stacklessError(message);
-        error.status = status;
         if (require('../').debug('req')) {
             error.cause = axError;
         }

package/lib/util/write.js

@@ -1,5 +1,5 @@
 // eslint-disable-next-line no-unused-vars
-const USAGE = ()=>{ //NOSONAR
+const USAGE = ()=>{
 
 	// with a fully specified target file
 	write ({foo:'bar'}) .to ('some/folder/foo.json')