@sap/cds-dk 7.5.0 → 7.6.0

package/lib/init/template/xsuaa/files/package.json.hbs

@@ -1,8 +1,7 @@
 {
   {{#isNodejs}}
   "dependencies": {
-    "@sap/xssec": "^3",
-    "passport": "^0"
+    "@sap/xssec": "^3"
   },
   "cds": {
   {{/isNodejs}}

package/lib/mtx/activate.js

@@ -5,7 +5,7 @@ const axios = require('axios');
 const cds = require('../cds');
 const AuthManager = require('./auth_manager');
 
-require('../util/pruneAxiosErrors');
+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

@@ -4,7 +4,7 @@ const cds = require('../cds');
 const { SettingsManager } = require('./settings_manager');
 const { ParamCollection } = require('./params');
 
-require('../util/pruneAxiosErrors');
+require('../util/axios').pruneErrors();
 const { getMessage } = require('./util/logging');
 
 const DEBUG = cds.debug('cli');
@@ -127,8 +127,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/pruneAxiosErrors');
+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/pruneAxiosErrors');
+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/pruneAxiosErrors');
+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/pruneAxiosErrors');
+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) {
@@ -126,6 +127,14 @@ 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 +154,8 @@ class SettingsManager {
 
     static init() {
         logConfigPaths();
+        keytar = undefined;
+        keytarDisabled = undefined;
     }
 
     static get config() {
@@ -175,7 +186,7 @@ class SettingsManager {
         if (params.get('clearOtherTokenStorage')) {
             // Delete token from the other storage.
             params.delete('clearOtherTokenStorage');
-            await this.deleteToken(params, true);
+            await this.deleteToken(params, { fromOtherStorage: true });
         }
 
         if (params.get('tokenStorage') === 'plain') {
@@ -259,7 +270,7 @@ class SettingsManager {
     }
 
     static async setKeytar(params, logout = false) {
-        if (params.get('skipToken')) {
+        if (keytar || keytarDisabled || params.get('skipToken')) {
             return;
         }
         if (isBas()) {
@@ -273,7 +284,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 +329,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 +371,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 +406,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 +420,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 +443,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,15 +464,33 @@ 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) {
         const paramValuesByFolder = await this._loadFromFile(undefined);
         if (paramValues !== null) {
@@ -559,7 +590,7 @@ class SettingsManager {
         try {
             allAuth = JSON.parse((await fs.promises.readFile(CONFIG.paths.auth)).toString());
         } catch (err) {
-            DEBUG?.('Empty authentication-data file');
+            DEBUG?.('File contains invalid saved auth');
             return emptyData(all);
         }
 
@@ -613,6 +644,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/pruneAxiosErrors');
+require('../util/axios').pruneErrors();
 const { getMessage } = require('./util/logging');
 const { capitalize } = require('./util/strings');
 const { handleHttpError } = require('./util/errors');

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/pruneAxiosErrors');
 
 const MTX_URL_PATH_PREFIX = 'mtx/v1/model/';
 

package/lib/util/axios.js

@@ -0,0 +1,66 @@
+module.exports = {
+    pruneErrors
+};
+
+function pruneErrors() {
+    function stacklessError(message) {
+        const { stackTraceLimit } = Error;
+        Error.stackTraceLimit = 0;
+        const error = new Error(message);
+        Error.stackTraceLimit = stackTraceLimit;
+        return error;
+    }
+
+    require('axios').interceptors.response.use(
+        response => response,
+        axError => {
+            const { inspect } = require('util');
+            const { url, method } = axError.config ?? {};
+            const { errno, code, response = {}, message: axMessage } = axError;
+            const prefix = (url && method ? `${method.toUpperCase()} ${url}` : 'Request') + ' failed';
+
+            let error;
+            if (errno) {
+                // System error during request.
+                const message = prefix
+                    + `: ${errno} ${code}`
+                    + (/\b(ENOTFOUND|EAI_AGAIN)\b/.test(code) ? `. 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 || reason || details
+                        ? (status || statusText ? ':' : '') +
+                        (status ? ` ${status}` : '') +
+                        (statusText ? ` ${statusText}` : '') +
+                        (reason ? `. ${reason}` : '') +
+                        (details ? `. Details: ${details}` : '')
+                        : (axMessage ? `: ${axMessage}` : '')
+                );
+
+                error = stacklessError(message);
+                if (status) {
+                    error.status = status;
+                }
+            }
+
+            if (require('../').debug('req')) {
+                error.cause = axError;
+            }
+            return Promise.reject(error);
+        }
+    );
+    return module.exports;
+}

package/lib/util/cf.js

@@ -116,7 +116,7 @@ class CfUtil {
             if (config) {
                 return {
                     apiEndpoint: this._extract(config.Target, /\s*(.+)\s*/, `CF API endpoint is missing. Use 'cf login' to login.`),
-                    org: this._extract(config.OrganizationFields.Name, /\s*(.+)\s*/, `CF org is missing. Use 'cf target -o <ORG> to specify.`),
+                    org: this._extract(config.OrganizationFields.Name, /\s*(.+)\s*/, `CF org is missing. Use 'cf target -o <ORG>' to specify.`),
                     space: this._extract(config.SpaceFields.Name, /\s*(.+)\s*/, `CF space is missing. Use 'cf target -s <SPACE>' to specify.`)
                 }
             }
@@ -131,7 +131,7 @@ class CfUtil {
             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.`),
+                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.`),
             };
         }
@@ -189,6 +189,14 @@ Deployment will stop in the near future for Cloud Foundry client versions < ${CF
         return this.spaceInfo;
     }
 
+    async getServices(app) {
+        const { spaceGuid: space_guids, orgGuid: organization_guids } = await this.getCfSpaceInfo();
+        const apps = await this._cfRequest('/v3/apps', { space_guids, organization_guids, names: app });
+        const guid = apps.resources[0].guid;
+        const env = await this._cfRequest('/v3/apps/'+guid+'/env', { space_guids, organization_guids, names: app });
+        return Object.values(env.system_env_json.VCAP_SERVICES).flat();
+    }
+
     async getService(serviceName, showMessage = true) {
         showMessage && console.log(`Getting service ${bold(serviceName)}`);
         const spaceInfo = await this.getCfSpaceInfo();
@@ -323,15 +331,14 @@ Deployment will stop in the near future for Cloud Foundry client versions < ${CF
     }
 
 
-    async getOrCreateServiceKey(serviceInstance, serviceKeyName) {
-
+    async getOrCreateServiceKey(serviceInstance, serviceKeyName, parameters, { silent = false, create = true } = {}) {
         const serviceKey = await this.getServiceKey(serviceInstance, serviceKeyName, false);
-        if (serviceKey) {
-            console.log(`Getting service key ${bold(serviceKeyName)}`);
+        if (serviceKey || !create) {
+            if (serviceKey && !silent) console.log(`Getting service key ${bold(serviceKeyName)}`);
             return serviceKey;
         }
 
-        console.log(`Creating service key ${bold(serviceKeyName)} - please be patient...`);
+        if (!silent) console.log(`Creating service key ${bold(serviceKeyName)} - please be patient...`);
 
         const body = {
             type: 'key',
@@ -343,9 +350,7 @@ Deployment will stop in the near future for Cloud Foundry client versions < ${CF
                     }
                 }
             },
-            parameters: {
-                permissions: 'development'
-            }
+            parameters
         }
 
         const postResult = await this._cfRequest('/v3/service_credential_bindings', undefined, body);