@sap/cds-dk 7.5.1 → 7.6.1

package/lib/lint/checks.js

@@ -2,10 +2,8 @@ const fs = require("fs");
 const os = require("os");
 const path = require("path");
 const term = require("../util/term");
-const commandUtil = require("../util/command");
 
 const IS_WIN = os.platform() === "win32";
-const { URLS } = require("../init/constants");
 
 module.exports = {
   /**
@@ -73,55 +71,6 @@ module.exports = {
     return true;
   },
 
-  /**
-   * Checks if VS Code is installed. If not, suggests to install it
-   * @param {*} inputPath CDS project root
-   * @returns boolean whether VS Code is installed
-   */
-  async hasVscode(inputPath, logger = console) {
-    try {
-      await commandUtil.spawnCommand("code", ["--version"], {
-        cwd: inputPath,
-        shell: IS_WIN,
-      });
-    } catch (err) {
-      logger.log(`Consider installing VS Code: ${URLS.VSCODE}`);
-      return false;
-    }
-    return true;
-  },
-
-  /**
-   * Checks whether VS Code extension <extension> is installed
-   * @param {*} extension VS Code extension
-   * @param {*} inputPath CDS roject root
-   * @returns boolean whether VS Code extension is installed
-   */
-  async hasVscodeExtension(extension, inputPath, logger = console) {
-    try {
-      this.linterExtensions = await commandUtil.spawnCommand(
-        "code",
-        ["--list-extensions", "--category", "linters"],
-        {
-          cwd: inputPath,
-          shell: IS_WIN,
-        },
-        true
-      );
-    } catch (err) {
-      // Do nothing
-    }
-    if (this.linterExtensions && this.linterExtensions.includes(extension)) {
-      return true;
-    } else {
-      logger.log(
-        "\n\nConsider installing the VS Code extension for ESLint:\n" +
-          term.info(`'dbaeumer.vscode-eslint': ${URLS.VSCODE_ESLINT}\n`)
-      );
-    }
-    return false;
-  },
-
   /**
    * Checks ESLint config file for proper setup
    * in context of a local ESLint plugin installation

package/lib/mtx/activate.js

@@ -5,7 +5,7 @@ const axios = require('axios');
 const cds = require('../cds');
 const AuthManager = require('./auth_manager');
 
-require('../util/axios').pruneErrors().setReqTimeout();
+require('../util/axios').pruneErrors();
 const { collectFileContent, collectFiles, toUnixPath } = require('./util/fs');
 const { getMessage } = require('./util/logging');
 const { handleHttpError } = require('./util/errors');

package/lib/mtx/auth_manager.js

@@ -3,29 +3,32 @@ const axios = require('axios');
 const cds = require('../cds');
 const { SettingsManager } = require('./settings_manager');
 const { ParamCollection } = require('./params');
-
-require('../util/axios').pruneErrors().setReqTimeout();
 const { getMessage } = require('./util/logging');
 
+require('../util/axios').pruneErrors();
+
 const DEBUG = cds.debug('cli');
+const REASONS = { invalid_scope: /\binvalid_scope\b/ };
 
-function addTokenInfo(params, authData) {
-    params.set('token', authData.access_token);
-    if (authData.expires_in) {
-        params.set('tokenExpirationDate', Date.now() + authData.expires_in * 1000);
-    } else {
-        params.delete('tokenExpirationDate');
+function assign(params, authData) {
+    if (authData?.access_token) {
+        params.set('token', authData.access_token);
+        if (authData.expires_in) {
+            params.set('tokenExpirationDate', Date.now() + authData.expires_in * 1000);
+        } else {
+            params.delete('tokenExpirationDate');
+        }
+        if (authData.refresh_token) {
+            params.set('refreshToken', authData.refresh_token);
+        } else {
+            params.delete('refreshToken');
+        }
     }
-    if (authData.refresh_token) {
-        params.set('refreshToken', authData.refresh_token);
-    } else {
-        params.delete('refreshToken');
+    if (authData?.passcode_url) {
+        params.set('passcodeUrl', authData.passcode_url);
     }
 }
-function addUrlInfo(params, authData) {
-    params.set('passcodeUrl', authData.passcode_url);
-}
-function* reqParams(params) {
+function reqParams(method, params) {
     const url = params.get('tokenUrl');
     const d = {};
     if (params.has('subdomain')) {
@@ -44,16 +47,9 @@ function* reqParams(params) {
         d.key = params.get('key');
     }
     const data = new URLSearchParams(d).toString();
-    yield {
-        method: 'post',
-        url,
-        data
-    };
-    yield {
-        method: 'get',
-        url: `${url}?${data}`,
-        data: undefined
-    };
+    return method === 'post'
+        ? { url, data }
+        : { url: `${url}?${data}`, data: undefined };
 }
 
 async function retrieveTokenOrPasscodeUrl(params) {
@@ -61,41 +57,37 @@ async function retrieveTokenOrPasscodeUrl(params) {
         return;
     }
 
-    let retry;
-    let authData;
-    do {
-        let response;
-        for (const { method, url, data } of reqParams(params)) {
+    let response, error;
+    reqParams: for (const method of ['post', 'get']) {
+        do {
+            const { url, data } = reqParams(method, params);
             try {
                 DEBUG?.(`Getting authentication token or passcode URL from ${method.toUpperCase()} ${params.obfuscateQueryParams(url)}`);
                 response = await axios[method](url, data);
-            } catch (error) {
+            } catch (e) {
+                error = e;
                 if (error.status === 404) { // may represent 405 in case of wrong method
-                    continue;
+                    continue reqParams;
+                } else if (params.has('refreshToken')) {
+                    DEBUG?.('Discarding invalid refresh token');
+                    params.delete('refreshToken');
+                } else {
+                    break reqParams;
                 }
-                throw getMessage('Failed to get authentication token', { error });
             }
-            if (response) {
-                break;
-            }
-        }
-        if (!response) {
-            throw 'Failed to get authentication token';
-        }
-        authData = response.data;
-
-        retry = !authData.access_token && params.has('refreshToken') && (params.delete('refreshToken'), true);
-    } while (retry);
-
-    if (authData.access_token) {
-        addTokenInfo(params, authData);
+        } while (!(response || error));
     }
-    if (authData.passcode_url) {
-        addUrlInfo(params, authData);
+    const data = response?.data ?? error?.auth;
+    assign(params, data);
+    if (!response) {
+        throw new Error(REASONS.invalid_scope.test(error.message)
+            ? 'Token has invalid scope. Check if your user has the required roles'
+            : `No valid passcode or token provided. Get a passcode${
+                params.get('passcodeUrl') ? ' from ' + params.get('passcodeUrl') : ''
+            } and re-run the command with '-p <passcode>'`);
     }
 }
 
-
 module.exports = class AuthManager {
 
     static async login(paramValues) {
@@ -105,14 +97,13 @@ module.exports = class AuthManager {
         if (params.has('username')) {
             params.set('reqAuth', { auth: { username: params.get('username'), password: params.get('password') } });
         } else if (!params.get('skipToken')) {
-            await retrieveTokenOrPasscodeUrl(params);
-            if (!params.has('token')) {
+            try {
+                await retrieveTokenOrPasscodeUrl(params);
+            } catch (error) {
                 if (params.get('saveData')) {
                     await SettingsManager.saveSettings(params);
                 }
-                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`;
+                throw getMessage('Failed to login', { error });
             }
             params.set('reqAuth', { headers: { Authorization: 'Bearer ' + params.get('token') } });
         }
@@ -127,8 +118,10 @@ module.exports = class AuthManager {
     static async logout(paramValues) {
         SettingsManager.init();
         const params = new ParamCollection(paramValues);
+        await SettingsManager.setKeytar(params, true);
         if (params.get('clearInvalid')) {
-            await SettingsManager.deleteInvalid();
+            await SettingsManager.deleteInvalidSettings();
+            await SettingsManager.deleteInvalidTokens();
         } else {
             await SettingsManager.deleteToken(params);
             if (params.get('deleteSettings')) {

package/lib/mtx/download_legacy.js

@@ -4,7 +4,7 @@ const axios = require('axios');
 
 const { login } = require('./auth_manager');
 
-require('../util/axios').pruneErrors().setReqTimeout();
+require('../util/axios').pruneErrors();
 const { handleHttpError } = require('./util/errors');
 
 const DOWNLOAD_FILE_NAME = 'migrated_projects.tgz'; // TODO try to add tenant later, if possible

package/lib/mtx/extend.js

@@ -4,7 +4,7 @@ const axios = require('axios');
 
 const AuthManager = require('./auth_manager');
 
-require('../util/axios').pruneErrors().setReqTimeout();
+require('../util/axios').pruneErrors();
 const { normalizePath, isParent } = require('./util/fs');
 const Question = require('./util/question');
 const { getMessage } = require('./util/logging');
@@ -163,7 +163,7 @@ module.exports = class Extend {
     }
 
     static promptTemplateOverwrite() {
-        return Question.askBooleanQuestion(`This  will overwrite extisting templates in folder ${TEMPLATE_FOLDER}. Continue (yN)? `);
+        return Question.askBooleanQuestion(`This  will overwrite existing templates in folder ${TEMPLATE_FOLDER}. Continue (yN)? `);
     }
 
     static _logWrittenFile(file) {

package/lib/mtx/pull.js

@@ -7,7 +7,7 @@ const axios = require('axios');
 
 const { login } = require('./auth_manager');
 
-require('../util/axios').pruneErrors().setReqTimeout();
+require('../util/axios').pruneErrors();
 const { getMessage } = require('./util/logging');
 const { handleHttpError } = require('./util/errors');
 

package/lib/mtx/push.js

@@ -6,7 +6,7 @@ const axios = require('axios');
 const { login } = require('./auth_manager');
 const buildSystem = require('../build')
 
-require('../util/axios').pruneErrors().setReqTimeout();
+require('../util/axios').pruneErrors();
 const { getMessage } = require('./util/logging');
 const { schemaRegex } = require('./util/urls');
 const { handleHttpError } = require('./util/errors');

package/lib/mtx/settings_manager.js

@@ -50,6 +50,7 @@ const CONFIG = {
 };
 
 let keytar;
+let keytarDisabled;
 
 function other(tokenStorage) {
     if (!tokenStorage) {
@@ -104,28 +105,31 @@ async function getTokenBaseUrl(params, renewUrl) {
         return url.toString();
     };
 
-    let existingPath;
-    const oauthPaths = [OAUTH_PATH_STREAMLINED_MTX];
-    for (const path of oauthPaths) {
-        try {
-            await axios.head(appUrlWith(path));
-            existingPath = path;
-            break;
-        } catch (error) {
-            if ([401, 404].includes(error.status)) {
-                continue;
-            }
+    let path = OAUTH_PATH_OLD_MTX;
+    try {
+        await axios.head(appUrlWith(OAUTH_PATH_STREAMLINED_MTX));
+        path = OAUTH_PATH_STREAMLINED_MTX;
+    } catch (error) {
+        if (![401, 404].includes(error.status)) {
             throw error;
         }
+        DEBUG?.(`Falling back to legacy token URL: ${error.message}`);
     }
-    existingPath = existingPath ?? OAUTH_PATH_OLD_MTX; // REVISIT can this just be included in the array?
-    return appUrlWith(existingPath);
+    return appUrlWith(path);
 }
 
 function getKeyringAccountName(params) {
     return `${params.get('appUrl')}|${params.get('subdomain')}`;
 }
 
+function getAccountUrl(account) {
+    return account.includes('|') ? account.split('|')[0] : null;
+}
+
+function getAccountSubdomain(account) {
+    return account.includes('|') ? account.split('|')[1] : null;
+}
+
 function logConfigPaths() {
     DEBUG?.(`Settings are stored in ${CONFIG.paths.settings}`);
     DEBUG?.(`Authentication data is stored in ${CONFIG.paths.auth} (${TOKEN_STORAGE_DESC.plain}) or ${CONFIG.keyringDesignation} (${TOKEN_STORAGE_DESC.keyring})`);
@@ -145,6 +149,8 @@ class SettingsManager {
 
     static init() {
         logConfigPaths();
+        keytar = undefined;
+        keytarDisabled = undefined;
     }
 
     static get config() {
@@ -173,9 +179,9 @@ class SettingsManager {
         }
 
         if (params.get('clearOtherTokenStorage')) {
-            // Delete token from the other storage.
+            // Delete data from the other storage.
             params.delete('clearOtherTokenStorage');
-            await this.deleteToken(params, true);
+            await this.deleteToken(params, { fromOtherStorage: true });
         }
 
         if (params.get('tokenStorage') === 'plain') {
@@ -184,7 +190,7 @@ class SettingsManager {
             await this.setKeytar(params);
             await this._saveAuthToKeyring(params, params.toEntries(Persistence.auth));
         } else {
-            console.log('Note: the authentication token is not saved by default. To save the token for later commands, please run `cds login`.');
+            console.log('Note: authentication data is not persisted by default. To save tokens for later commands, please run `cds login`.');
         }
     }
 
@@ -259,7 +265,7 @@ class SettingsManager {
     }
 
     static async setKeytar(params, logout = false) {
-        if (params.get('skipToken')) {
+        if (keytar || keytarDisabled || params.get('skipToken')) {
             return;
         }
         if (isBas()) {
@@ -273,7 +279,7 @@ class SettingsManager {
         if (keytar) {
             return;
         }
-        // keytar missing
+        keytarDisabled = true;
 
         if (params.get('tokenStorage') === 'keyring' && params.get('saveData')) {
             // Explicit login w/o plain-text storage enabled
@@ -318,7 +324,19 @@ class SettingsManager {
                 throw 'Passcode cannot be empty';
             }
         }
-        function setRelevantAuth(auth) {
+        async function addAuthSettings() {
+            function removeObsoleteToken() {
+                if (params.get('renewLogin') || params.get('tokenExpirationDate') <= Date.now()) {
+                    DEBUG?.((params.get('renewLogin') ? 'Renewing' : 'Refreshing expired') + ' authentication token');
+                    params.delete('token');
+                    params.delete('tokenExpirationDate');
+                }
+            }
+
+            const auth = {
+                plain: await SettingsManager._loadAuthFromFile(params.get('appUrl'), params.get('subdomain')),
+                keyring: await SettingsManager._loadAuthFromKeyring(params.get('appUrl'), params.get('subdomain'))
+            };
             if (!(auth.keyring.has('tokenStorage') || auth.plain.has('tokenStorage'))) {
                 // Saved auth data not present.
                 return;
@@ -348,12 +366,8 @@ class SettingsManager {
 
                 params.merge(auth[storage]);
             }
-        }
-        function removeObsoleteToken() {
-            if (params.get('renewLogin') || params.get('tokenExpirationDate') <= Date.now()) {
-                DEBUG?.((params.get('renewLogin') ? 'Renewing' : 'Refreshing expired') + ' authentication token');
-                params.delete('token');
-                params.delete('tokenExpirationDate');
+            if (params.has('token')) {
+                removeObsoleteToken();
             }
         }
 
@@ -387,21 +401,13 @@ class SettingsManager {
             }
         }
 
-        const auth = {
-            plain: await this._loadAuthFromFile(params.get('appUrl'), params.get('subdomain')),
-            keyring: await this._loadAuthFromKeyring(params.get('appUrl'), params.get('subdomain'))
-        };
-
-        setRelevantAuth(auth);
-        if (params.has('token')) {
-            removeObsoleteToken();
-        }
+        await addAuthSettings();
         if (!logout && !params.has('token') && !params.has('refreshToken') && !params.has('passcode') && !params.has('clientsecret') && !params.has('key')) {
             await addPasscode();
         }
     }
 
-    static async deleteToken(params, fromOtherStorage = false) {
+    static async deleteToken(params, { fromOtherStorage = false, invalid = false } = {}) {
         const allParams = params.clone();
         await this.loadAndMergeSettings(allParams, true);
 
@@ -409,11 +415,13 @@ class SettingsManager {
         let fromStorage = fromOtherStorage && other(params.get('tokenStorage'));
         const deleteBoth = !fromStorage && allParams.get('tokenStorage') && allParams.get('clearOtherTokenStorage');
 
-        DEBUG?.(`Deleting authentication data${fromOtherStorage ? ' from other storage' : ''} for ${target}`);
+        DEBUG?.(`Deleting${invalid ? ' invalid' : ''} authentication data${fromOtherStorage ? ' from other storage' : ''} for ${target}`);
 
         fromStorage = fromStorage || allParams.get('tokenStorage');
         if (!fromStorage) {
-            console.log('Failed to delete authentication data: none found for', target);
+            if (!invalid) {
+                console.log('Failed to delete authentication data: none found for', target);
+            }
             return;
         }
 
@@ -430,7 +438,7 @@ class SettingsManager {
         await this._saveToFile(projectFolder, null);
     }
 
-    static async deleteInvalid() {
+    static async deleteInvalidSettings() {
         const settingsByFolder = await this._loadFromFile(undefined);
         const deletionFolders = [];
         const deletionUrlsAndSubdomains = new Set();
@@ -451,13 +459,31 @@ class SettingsManager {
                 const subdomain = urlAndSubdomain.replace(/.*\|/, '');
                 const urlReference = Object.values(settingsByFolder).find(settings => settings.appUrl === appUrl && settings.subdomain === subdomain);
                 if (!urlReference) {
-                    await this.deleteToken(new ParamCollection({ appUrl, subdomain }));
+                    await this.deleteToken(new ParamCollection({ appUrl, subdomain }), { invalid: true });
                 }
             }
             console.log('Deleted settings for nonexistent project folders:', deletionFolders.map(folder => ' ' + folder));
         } else {
-            console.log('All settings seem valid');
+            console.log('All saved project folders seem valid');
+        }
+    }
+
+    static async deleteInvalidTokens() {
+        async function deleteFrom(allAuth) {
+            for (const [appUrl, authForUrl = {}] of Object.entries(allAuth)) {
+                for (const [subdomain, auth] of Object.entries(authForUrl)) {
+                    if (!auth.token) {
+                        continue;
+                    }
+                    if (auth.tokenExpirationDate <= Date.now()) {
+                        await SettingsManager.deleteToken(new ParamCollection({ appUrl, subdomain }), { invalid: true });
+                    }
+                }
+            }
         }
+
+        await deleteFrom(await this._loadAuthFromFile(undefined, undefined));
+        await deleteFrom(await this._loadAllAuthFromKeyring());
     }
 
     static async _saveToFile(projectFolder, paramValues) {
@@ -555,11 +581,11 @@ class SettingsManager {
             return emptyData(all);
         }
 
-        let allAuth
+        let allAuth;
         try {
             allAuth = JSON.parse((await fs.promises.readFile(CONFIG.paths.auth)).toString());
         } catch (err) {
-            DEBUG?.('Empty authentication-data file');
+            DEBUG?.(`${capitalize(TOKEN_STORAGE_DESC.plain)} contains invalid saved auth`);
             return emptyData(all);
         }
 
@@ -568,14 +594,14 @@ class SettingsManager {
         }
 
         if (!allAuth[appUrl]) {
-            DEBUG?.(`File contains no authentication data for app URL ${appUrl}`);
+            DEBUG?.(`${capitalize(TOKEN_STORAGE_DESC.plain)} contains no authentication data for app URL ${appUrl}`);
             return new ParamCollection();
         }
 
         const authForSubdomain = allAuth[appUrl][subdomain];
 
         if (!authForSubdomain) {
-            DEBUG?.(`File contains no authentication data for subdomain ${subdomain} (app URL: ${appUrl})`);
+            DEBUG?.(`${capitalize(TOKEN_STORAGE_DESC.plain)} contains no authentication data for subdomain ${subdomain} (app URL: ${appUrl})`);
             return new ParamCollection();
         }
 
@@ -613,6 +639,26 @@ class SettingsManager {
         return new ParamCollection(auth);
     }
 
+    static async _loadAllAuthFromKeyring() {
+        if (!keytar) {
+            return {};
+        }
+
+        return (await keytar.findCredentials(MTX_FULLY_QUALIFIED))
+            .reduce((result, { account, password: authString }) => {
+                const appUrl = getAccountUrl(account);
+                const subdomain = getAccountSubdomain(account);
+                if (appUrl && subdomain) {
+                    try {
+                        (result[appUrl] ??= {})[subdomain] = JSON.parse(authString);
+                    } catch (error) {
+                        throw new Error(`${capitalize(TOKEN_STORAGE_DESC.keyring)} contains invalid saved auth for URL ${appUrl} and subdomain ${subdomain}`);
+                    }
+                }
+                return result;
+            }, {});
+    }
+
 }
 
 module.exports = {

package/lib/mtx/tenant_action.js

@@ -2,7 +2,7 @@ const cds = require('../cds');
 const { ParamCollection } = require('./params');
 const AuthManager = require('./auth_manager');
 
-require('../util/axios').pruneErrors().setReqTimeout();
+require('../util/axios').pruneErrors();
 const { getMessage } = require('./util/logging');
 const { capitalize } = require('./util/strings');
 const { handleHttpError } = require('./util/errors');

package/lib/mtx/util/dependencies.js

@@ -24,7 +24,7 @@ function requireGlobal(packageId) {
         return require(packagePath);
     } catch (error) {
         // Ignore error.
-        DEBUG?.(`Failed to find module '${packageId}' in ${globalModulesDir()}`, error);
+        DEBUG?.(`Failed to find module '${packageId}' in ${globalModulesDir()}:`, error);
     }
 }
 

package/lib/mtx/util/legacy_ext.js

@@ -2,7 +2,6 @@ const path = require('path');
 const fs = require('fs').promises;
 
 const { concatUrls } = require('./urls');
-require('../../util/axios').pruneErrors().setReqTimeout();
 
 const MTX_URL_PATH_PREFIX = 'mtx/v1/model/';
 

package/lib/mtx/util/logging.js

@@ -1,15 +1,17 @@
 /* eslint-disable no-console */
 
 function getMessage(errorText, { error, command, help = command && getCommandHelp(command) } = {}) {
-    let message = errorText ? errorText : '';
+    let message = errorText ? errorText.trim() : '';
     if (error) {
-        message += '\n' + (
-            error.response?.data?.message           // response body == error
-            || error.response?.data?.error?.message // response body == { error }
-            || error.message                        // no response attached
-        );
-        if (error.stack && require('../../cds').debug('cli')) {
-            message += '\n' + error.stack;
+        const includeStack = error.stack && require('../../cds').debug('cli');
+        message = message.replace(/(?<!\p{P})$/u, ':'); // Append colon if no punctuation at the end
+        message += includeStack ? '\n' : ' ';
+        const oriMsg = error.response?.data?.message // case: response body == error
+            || error.response?.data?.error?.message  // case: response body == { error }
+            || (includeStack ? '' : error.message);
+        message += oriMsg;
+        if (includeStack) {
+            message += (oriMsg ? '\n' : '') + error.stack;
         }
     }
     if (typeof help === 'string') {

package/lib/util/axios.js

@@ -1,25 +1,7 @@
 module.exports = {
-    pruneErrors,
-    setReqTimeout
+    pruneErrors
 };
 
-// Will only count the time until the server starts responding, not the time until the request is finished.
-const GENERIC_REQUEST_TIMEOUT_MS = 1500;
-
-function setReqTimeout() {
-    require('axios').interceptors.request.use(
-        config => {
-            config.timeout = GENERIC_REQUEST_TIMEOUT_MS;
-            return config;
-        },
-        error => {
-            return Promise.reject(error)
-        }
-    );
-    return module.exports;
-}
-
-
 function pruneErrors() {
     function stacklessError(message) {
         const { stackTraceLimit } = Error;
@@ -72,6 +54,11 @@ function pruneErrors() {
                 if (status) {
                     error.status = status;
                 }
+                if (data?.passcode_url) {
+                    error.auth = {
+                        passcode_url: data.passcode_url
+                    };
+                }
             }
 
             if (require('../').debug('req')) {