@sap/cds-dk 6.6.2 → 6.7.0

package/lib/client/helper/cf_helper.js

@@ -1,7 +1,8 @@
 const os = require('os');
 const { execFile } = require('child_process');
 
-const log = require('./logging');
+const cds = require('../../cds');
+const DEBUG = cds.debug('cli');
 const Question = require('./question');
 const { formatObjectsFixedWidth } = require('./string_helper');
 const { schemaRegex } = require('./url_helper');
@@ -20,7 +21,7 @@ function getErrorMessage(error, stdout) {
 async function getAppFromSuggestions() {
     const apps = await getApps();
     if (apps.length === 0) {
-        log.debug('Failed to obtain list of apps from CF');
+        DEBUG?.('Failed to obtain list of apps from CF');
         return undefined;
     }
 
@@ -36,7 +37,7 @@ Your choice: `);
         console.log();
 
         if (!choice) {
-            log.debug('No app URL selected');
+            DEBUG?.('No app URL selected');
             return undefined;
         }
         choiceNr = Number(choice);
@@ -46,7 +47,7 @@ Your choice: `);
 }
 
 async function getApps(nameRegex = /(?<!-db)$/) {
-    log.debug('Getting running apps from CF');
+    DEBUG?.('Getting running apps from CF');
 
     return new Promise(resolve => {
         runCf(['apps'], function(error, stdout) {
@@ -120,13 +121,13 @@ async function getApps(nameRegex = /(?<!-db)$/) {
     }
 
     function errorResult(message) {
-        log.debug(`Failed to get apps: ${message}`);
+        DEBUG?.(`Failed to get apps: ${message}`);
         return [];
     }
 }
 
 async function getSubdomain(appName) {
-    log.debug('Getting subdomain from CF env');
+    DEBUG?.('Getting subdomain from CF env');
 
     return new Promise(resolve => {
         runCf(['env', appName], function(error, stdout) {
@@ -155,13 +156,13 @@ async function getSubdomain(appName) {
                 }
             }
 
-            log.debug(`Subdomain determined from CF app environment: ${value}`);
+            DEBUG?.(`Subdomain determined from CF app environment: ${value}`);
             return resolve(value);
         });
     });
 
     function errorResult(message) {
-        log.debug(`Failed to get subdomain: ${message}`);
+        DEBUG?.(`Failed to get subdomain: ${message}`);
         return undefined;
     }
 }
@@ -171,14 +172,14 @@ async function getAppName(appUrl) {
         return url1.replace(schemaRegex, '') === url2.replace(schemaRegex, '');
     }
 
-    log.debug('Getting app name from CF apps');
+    DEBUG?.('Getting app name from CF apps');
     const apps = await getApps();
     const app = apps.find(app => equalIgnoringTls(app.url, appUrl));
     if (!app) {
-        log.debug(`Failed to find app with URL ${appUrl}.  Running apps: ${apps.map(app => app.name)}`);
+        DEBUG?.(`Failed to find app with URL ${appUrl}.  Running apps: ${apps.map(app => app.name)}`);
         return;
     }
-    log.debug(`App name determined from CF: ${app.name}`);
+    DEBUG?.(`App name determined from CF: ${app.name}`);
     return app.name;
 }
 

package/lib/client/helper/dependency_helper.js

@@ -1,7 +1,8 @@
 const os = require('os');
 const { execFileSync } = require('child_process');
 
-const log = require('./logging');
+const cds = require('../../cds');
+const DEBUG = cds.debug('cli');
 
 let cachedDir;
 
@@ -21,7 +22,7 @@ function requireGlobal(packageId) {
         return require(packagePath);
     } catch (error) {
         // Ignore error.
-        log.debug(`Failed to find module '${packageId}' in ${globalModulesDir()}`, error);
+        DEBUG?.(`Failed to find module '${packageId}' in ${globalModulesDir()}`, error);
     }
 }
 

package/lib/client/helper/logging.js

@@ -1,11 +1,5 @@
 /* eslint-disable no-console */
 
-function debug(debugText, error) {
-    if (process.env.DEBUG) {
-        console.log(getMessage(debugText, { error }));
-    }
-}
-
 function getMessage(errorText, { error, help } = {}) {
     let message = errorText ? errorText : '';
     if (error) {
@@ -25,6 +19,5 @@ function getMessage(errorText, { error, help } = {}) {
 }
 
 module.exports = {
-    debug,
     getMessage
 };

package/lib/client/params.js

@@ -1,4 +1,5 @@
-const log = require('./helper/logging');
+const cds = require('../cds');
+const DEBUG = cds.debug('cli');
 const { escapeRegex } = require('./helper/string_helper');
 const { CliError } = require('./helper/errors');
 
@@ -179,6 +180,7 @@ class BasicParams {
         this.url                    = this.appUrl.newAlias('url');
         this.from                   = this.appUrl.newAlias('from');
         this.to                     = this.appUrl.newAlias('to');
+        this.at                     = this.appUrl.newAlias('at');
         this.subdomain              = new Param('subdomain',              '', { persist: Persistence.setting }); // only needed to fetch token
         this.passcodeUrl            = new Param('passcodeUrl',            '', { persist: Persistence.setting, abbreviate: true });
         this.passcode_url           = this.passcodeUrl.newAlias('passcode_url');
@@ -316,7 +318,7 @@ class ParamCollection {
             this.params[mainName] = ParamDefs[mainName].clone(val);
         }
         if (mainName !== name) {
-            log.debug(`Migrated setting '${name}' to new key '${mainName}'`);
+            DEBUG?.(`Migrated setting '${name}' to new key '${mainName}'`);
         }
     }
 

package/lib/client/settings_manager.js

@@ -3,10 +3,9 @@ const os = require('os');
 const path = require('path');
 const axios = require('axios');
 
+const cds = require('../cds');
+const DEBUG = cds.debug('cli');
 const { requireGlobal } = require('./helper/dependency_helper');
-let keytar;
-
-const log = require('./helper/logging');
 const { getAppFromSuggestions, getAppName, getSubdomain } = require('./helper/cf_helper');
 const isBas = require('./helper/env_helper');
 const Question = require('./helper/question');
@@ -49,6 +48,8 @@ const CONFIG = {
     keyringDesignation: KEYRING_DESC[os.platform()] || 'not supported'
 };
 
+let keytar;
+
 function other(tokenStorage) {
     if (!tokenStorage) {
         return tokenStorage;
@@ -130,14 +131,14 @@ function getKeyringAccountName(params) {
 }
 
 function logConfigPaths() {
-    log.debug(`Settings are stored in ${CONFIG.paths.settings}`);
-    log.debug(`Authentication data is stored in ${CONFIG.paths.auth} (${TOKEN_STORAGE_DESC.plain}) or ${CONFIG.keyringDesignation} (${TOKEN_STORAGE_DESC.keyring})`);
+    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})`);
 }
 
 function notifyLoggedIn(params) {
     return params.get('renewLogin')
            ? console.log.bind(console)
-           : log.debug;
+           : DEBUG;
 }
 
 function emptyData(all) {
@@ -156,7 +157,7 @@ class SettingsManager {
 
     // Call with 'projectFolder' param as a resolved path.
     static async saveSettings(params) {
-        log.debug(`Saving settings for project ${params.get('projectFolder')}`);
+        DEBUG?.(`Saving settings for project ${params.get('projectFolder')}`);
 
         const paramsMap = params.toEntries(Persistence.setting);
         if (params.has('username')) {
@@ -164,7 +165,7 @@ class SettingsManager {
             if (localhostRegex.test(params.get('appUrl'))) {
                 console.log(`Saving username${(params.get('isEmptyPassword') ? ' and empty-password hint' : '')} with project settings.`);
             } else {
-                log.debug('Not saving username because app is not recognized to run on localhost.');
+                DEBUG?.('Not saving username because app is not recognized to run on localhost.');
                 delete paramsMap.username;
                 delete paramsMap.isEmptyPassword;
             }
@@ -196,7 +197,7 @@ class SettingsManager {
         params.set('projectFolder', projectFolder);
 
         const loadedSettings = await this._loadFromFile(projectFolder);
-        log.debug(`Loaded project settings for ${params.get('projectFolder')}: ${loadedSettings.format()}`);
+        DEBUG?.(`Loaded project settings for ${params.get('projectFolder')}: ${loadedSettings.format()}`);
         const loadedAppUrl = loadedSettings.get('appUrl');
 
         if (params.has('passcode') && loadedSettings.has('username')) {
@@ -213,7 +214,7 @@ class SettingsManager {
         await this.updateUrls(params, logout, loadedAppUrl);
         await this.setKeytar(params, logout);
         await this.addAuth(params, logout);
-        log.debug(`Effective project settings: ${params.format()}`);
+        DEBUG?.(`Effective project settings: ${params.format()}`);
     }
 
     static async updateUrls(params, logout, loadedAppUrl) {
@@ -232,20 +233,20 @@ class SettingsManager {
                     } else {
                         params.set('appUrl', httpsSchema + appUrl);
                     }
-                    log.debug(`Added schema to app URL: ${params.get('appUrl')}`);
+                    DEBUG?.(`Added schema to app URL: ${params.get('appUrl')}`);
                 }
             }
 
             if (!logout) {
                 // Get appUrl from CF
                 if (!params.has('appUrl')) {
-                    log.debug('App URL not given');
+                    DEBUG?.('App URL not given');
                     await getAppUrlAndSubdomainFromSuggestions(params);
                 }
 
                 // Get subdomain from CF
                 if (!params.has('subdomain') && needsSubdomain()) {
-                    log.debug('Subdomain not given');
+                    DEBUG?.('Subdomain not given');
                     const appName = await getAppName(params.get('appUrl'));
                     if (appName) {
                         params.set('subdomain', await getSubdomainFromCfAndNotify(appName));
@@ -307,8 +308,8 @@ class SettingsManager {
 
         const doLog = params.get('saveData') || logout
             ? console.log.bind(console) // Explicit login/logout call
-            : log.debug;
-        doLog(`Disabling ${TOKEN_STORAGE_DESC.keyring} functionality: keytar not found. Run \`npm install -g keytar\` to install it.`);
+            : DEBUG;
+        doLog?.(`Disabling ${TOKEN_STORAGE_DESC.keyring} functionality: keytar not found. Run \`npm install -g keytar\` to install it.`);
     }
 
     static async addAuth(params, logout) {
@@ -344,7 +345,7 @@ class SettingsManager {
             if (auth.keyring.has('tokenStorage') && auth.plain.has('tokenStorage')) {
                 // Both storage places contain data: retrieve from selected or keyring.
                 storage = storage || 'keyring';
-                log.debug('WARNING: authentication data found in both kinds of storage. ' +
+                DEBUG?.('WARNING: authentication data found in both kinds of storage. ' +
                     `Using data from ${TOKEN_STORAGE_DESC[storage]}; other storage will be cleared when next saving.`);
 
                 params.merge(auth[storage]);
@@ -352,7 +353,7 @@ class SettingsManager {
 
             } else if (storage && auth[other(storage)].has('tokenStorage')) {
                 // Selected storage contains no data, but other one does: retrieve from other storage, but earmark migration to selected one.
-                log.debug(`Using authentication data from ${TOKEN_STORAGE_DESC[other(storage)]}; will be migrated to other storage on save.`);
+                DEBUG?.(`Using authentication data from ${TOKEN_STORAGE_DESC[other(storage)]}; will be migrated to other storage on save.`);
 
                 params.merge(auth[other(storage)]);
                 params.set('tokenStorage', storage);
@@ -361,7 +362,7 @@ class SettingsManager {
             } else {
                 // One storage contains data, and there's no conflict with selection.
                 const storage = auth.keyring.get('tokenStorage') || auth.plain.get('tokenStorage');
-                log.debug(`Using authentication data from ${TOKEN_STORAGE_DESC[storage]}.`);
+                DEBUG?.(`Using authentication data from ${TOKEN_STORAGE_DESC[storage]}.`);
 
                 params.merge(auth[storage]);
             }
@@ -376,7 +377,7 @@ class SettingsManager {
             } else {
                 params.delete('isEmptyPassword');
             }
-            log.debug('Ignoring any saved authentication data because username is given');
+            DEBUG?.('Ignoring any saved authentication data because username is given');
             return;
         } else {
             params.delete('isEmptyPassword');
@@ -410,7 +411,7 @@ class SettingsManager {
         let fromStorage = fromOtherStorage && other(params.get('tokenStorage'));
         const deleteBoth = !fromStorage && allParams.get('tokenStorage') && allParams.get('clearOtherTokenStorage');
 
-        log.debug(`Deleting authentication data${fromOtherStorage ? ' from other storage' : ''} for ${target}`);
+        DEBUG?.(`Deleting authentication data${fromOtherStorage ? ' from other storage' : ''} for ${target}`);
 
         fromStorage = fromStorage || allParams.get('tokenStorage');
         if (!fromStorage) {
@@ -466,7 +467,7 @@ class SettingsManager {
         if (paramValues !== null) {
             paramValuesByFolder[projectFolder] = paramValues;
             await this._saveAllSettingsToFile(paramValuesByFolder);
-            log.debug(`Saved project settings: ${JSON.stringify(paramValues)}`);
+            DEBUG?.(`Saved project settings: ${JSON.stringify(paramValues)}`);
         } else {
             delete paramValuesByFolder[projectFolder];
             await this._saveAllSettingsToFile(paramValuesByFolder);
@@ -475,10 +476,10 @@ class SettingsManager {
     }
 
     static async _saveAllSettingsToFile(paramValuesByFolder) {
-        log.debug(`Saving all settings to ${CONFIG.paths.settings}`);
+        DEBUG?.(`Saving all settings to ${CONFIG.paths.settings}`);
         await fs.promises.mkdir(path.dirname(CONFIG.paths.settings), { recursive: true })
         await fs.promises.writeFile(CONFIG.paths.settings, JSON.stringify(paramValuesByFolder, null, 2));
-        log.debug('Saved settings');
+        DEBUG?.('Saved settings');
     }
 
     static async _saveAuthToFile(params, authValues) {
@@ -490,7 +491,7 @@ class SettingsManager {
             (allAuthValues[appUrl] || (allAuthValues[appUrl] = {}))[params.get('subdomain')] = authValues;
             await fs.promises.mkdir(path.dirname(CONFIG.paths.auth), { recursive: true })
             await fs.promises.writeFile(CONFIG.paths.auth, JSON.stringify(allAuthValues, null, 2));
-            notifyLoggedIn(params)(`Saved authentication data to ${location}`);
+            notifyLoggedIn(params)?.(`Saved authentication data to ${location}`);
         } else if (allAuthValues[appUrl]) {
             delete allAuthValues[appUrl][params.get('subdomain')];
             if (Object.keys(allAuthValues[appUrl]).length === 0) {
@@ -500,7 +501,7 @@ class SettingsManager {
             await fs.promises.writeFile(CONFIG.paths.auth, JSON.stringify(allAuthValues, null, 2));
             console.log('Deleted authentication data from', location);
         } else {
-            notifyLoggedIn(params)(`No authentication data to delete from ${location}`);
+            notifyLoggedIn(params)?.(`No authentication data to delete from ${location}`);
         }
     }
 
@@ -513,7 +514,7 @@ class SettingsManager {
 
         if (auth !== null) {
             await keytar.setPassword(MTX_FULLY_QUALIFIED, getKeyringAccountName(params), JSON.stringify(auth));
-            notifyLoggedIn(params)(`Saved authentication data to ${location}`);
+            notifyLoggedIn(params)?.(`Saved authentication data to ${location}`);
         } else {
             await keytar.deletePassword(MTX_FULLY_QUALIFIED, getKeyringAccountName(params));
             console.log('Deleted authentication data from', location);
@@ -524,7 +525,7 @@ class SettingsManager {
         const all = !projectFolder;
 
         if (!fs.existsSync(CONFIG.paths.settings)) {
-            log.debug('Settings file not found');
+            DEBUG?.('Settings file not found');
             return emptyData(all);
         }
 
@@ -532,7 +533,7 @@ class SettingsManager {
         try {
             settingsByFolder = JSON.parse((await fs.promises.readFile(CONFIG.paths.settings)).toString());
         } catch (err) {
-            log.debug('Empty settings file');
+            DEBUG?.('Empty settings file');
             return emptyData(all);
         }
 
@@ -541,7 +542,7 @@ class SettingsManager {
         }
 
         if (!settingsByFolder[projectFolder]) {
-            log.debug(`No settings found for project ${projectFolder}`);
+            DEBUG?.(`No settings found for project ${projectFolder}`);
             return new ParamCollection();
         }
 
@@ -552,7 +553,7 @@ class SettingsManager {
         const all = !appUrl;
 
         if (!fs.existsSync(CONFIG.paths.auth)) {
-            log.debug('Authentication-data file not found');
+            DEBUG?.('Authentication-data file not found');
             return emptyData(all);
         }
 
@@ -560,7 +561,7 @@ class SettingsManager {
         try {
             allAuth = JSON.parse((await fs.promises.readFile(CONFIG.paths.auth)).toString());
         } catch (err) {
-            log.debug('Empty authentication-data file');
+            DEBUG?.('Empty authentication-data file');
             return emptyData(all);
         }
 
@@ -569,14 +570,14 @@ class SettingsManager {
         }
 
         if (!allAuth[appUrl]) {
-            log.debug(`File contains no authentication data for app URL ${appUrl}`);
+            DEBUG?.(`File contains no authentication data for app URL ${appUrl}`);
             return new ParamCollection();
         }
 
         const authForSubdomain = allAuth[appUrl][subdomain];
 
         if (!authForSubdomain) {
-            log.debug(`File contains no authentication data for subdomain ${subdomain} (app URL: ${appUrl})`);
+            DEBUG?.(`File contains no authentication data for subdomain ${subdomain} (app URL: ${appUrl})`);
             return new ParamCollection();
         }
 
@@ -595,7 +596,7 @@ class SettingsManager {
         const authString = await keytar.getPassword(MTX_FULLY_QUALIFIED, getKeyringAccountName(new ParamCollection({ appUrl, subdomain })));
 
         if (!authString) {
-            log.debug(`${capitalize(TOKEN_STORAGE_DESC.keyring)} contains no authentication data for URL ${appUrl} and subdomain '${subdomain}'`);
+            DEBUG?.(`${capitalize(TOKEN_STORAGE_DESC.keyring)} contains no authentication data for URL ${appUrl} and subdomain '${subdomain}'`);
             return new ParamCollection();
         }
 

package/lib/client/tenant_action.js

@@ -0,0 +1,78 @@
+const cds = require('../cds');
+const DEBUG = cds.debug('cli');
+
+const BaseCommand = require('./base_command');
+const { CliError } = require('./helper/errors');
+const { ParamCollection } = require('./params');
+const AuthManager = require('./auth_manager');
+const { capitalize } = require('./helper/string_helper');
+
+const COMMANDS = {
+    subscribe: 'to',
+    upgrade: 'at',
+    unsubscribe: 'from'
+};
+
+module.exports = class TenantAction extends BaseCommand {
+
+    // TODO JSDoc
+    /**
+     * @param command {string} the command to execute: 'subscribe', 'upgrade' or 'unsubscribe'
+     */
+    constructor(command) {
+        if (!(command in COMMANDS)) {
+            throw new Error(`invalid command: ${command}`);
+        }
+        super();
+        this.command = command;
+        this.gerund = command.replace(/e$/, 'ing');
+        this.preposition = COMMANDS[command];
+    }
+
+    async run(paramValues, { tenant, local } = {}) {
+        let params = new ParamCollection(paramValues);
+        params.set('skipToken', true); // Token would have insufficient scopes for this command.
+        if (local) {
+            // Connect to locally-served MTXS
+            await this.runWithServer(params, tenant);
+        } else {
+            // Connect to running MTXS server
+            params = await AuthManager.login(params.toEntries());
+            await this.runClientOnly(params, tenant);
+        }
+        console.log(`${capitalize(this.command)} successful.`);
+    }
+
+    async runClientOnly(params, tenant) {
+        console.log(capitalize(this.gerund), { tenant }, this.preposition, { url: params.get('appUrl') });
+        const url = `${params.get('appUrl')}/-/cds/deployment/${this.command}`;
+        DEBUG?.(`Sending request to ${url}`);
+        try {
+            await require('axios').post(url, { tenant }, params.get('reqAuth'));
+        } catch (error) {
+            BaseCommand.handleHttpError(error, params, { url });
+        }
+    }
+
+    async runWithServer(params, tenant) {
+        const libId = '@sap/cds-mtxs/bin/cds-mtx';
+        let libPath;
+        try {
+            libPath = require.resolve(libId, { paths: [process.cwd()] });
+            DEBUG?.(`Using local @sap/cds-mtxs from ${libPath}`);
+        } catch (error) {
+            try {
+                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 });
+            }
+        }
+
+        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.');
+        }
+        return cds_mtx(this.command, tenant);
+    }
+}

package/lib/init/constants.js

@@ -1,6 +1,6 @@
 const os = require('os');
 
-const MAVEN_ARCHETYPE_VERSION = '1.32.0';
+const MAVEN_ARCHETYPE_VERSION = '1.32.1';
 
 const constants = {
     IS_WIN: (os.platform() === 'win32'),

package/lib/init/index.js

@@ -10,7 +10,7 @@ const { OPTIONS_PRIORITY, COMMAND_ADD, COMMAND_INIT,
 
 const cds = require('../cds'), { exists, readdir } = cds.utils
 const LOG = console
-const DEBUG = /\b(y|all|cli)\b/.test(process.env.DEBUG) && console.debug
+const DEBUG = /\b(y|all|cli)\b/.test(process.env.DEBUG) ? console.debug : undefined
 
 module.exports = class CDSGenerator {
     constructor() {
@@ -196,7 +196,7 @@ module.exports = class CDSGenerator {
     }
 
     async _process() {
-        DEBUG && DEBUG(`Project path: ${cds.root}`);
+        DEBUG?.(`Project path: ${cds.root}`);
 
         await this._validateOptions();
         await this._fillTemplateList();
@@ -240,7 +240,7 @@ module.exports = class CDSGenerator {
                 const template = await this._createTemplate(option);
 
                 if (await template.canRun()) {
-                    DEBUG && DEBUG(`Adding feature '${template.name}'`);
+                    DEBUG?.(`Adding feature '${template.name}'`);
 
                     templates.set(option, template);
                     const deps = await template.getDependencies();
@@ -256,7 +256,7 @@ module.exports = class CDSGenerator {
         }).map((entry) => entry[1]);
 
         // check debug to avoid lengthy computation when not in debug mode
-        DEBUG && DEBUG(`Features: ${this.templateList.map(({name}) => name).join(', ')}`);
+        DEBUG?.(`Features: ${this.templateList.map(({name}) => name).join(', ')}`);
     }
 
     async stepEnd() {