@sap/cds-dk 4.9.5 → 6.0.1

package/lib/client/settings_manager.js

@@ -1,7 +1,6 @@
 const fs = require('fs');
 const os = require('os');
 const path = require('path');
-const { fse } = require('@sap/cds-foss');
 
 const requireGlobal = require('./helper/dependency_helper');
 const keytar = requireGlobal('keytar');
@@ -12,6 +11,7 @@ const Logger = require('./helper/logging');
 const Question = require('./helper/question');
 const { defaultSchema, extractSubdomain, schemaRegex } = require('./helper/url_helper');
 const { ParamCollection, Persistence } = require('./params');
+const { capitalize } = require('./helper/string_helper');
 
 const CONFIG_SUBDIRS = {
     linux: '.config',
@@ -107,7 +107,7 @@ function getKeyringAccountName(params) {
 
 function logConfigPaths() {
     Logger.debug(`Settings are stored in ${CONFIG.paths.settings}`);
-    Logger.debug(`Authentication data is stored in ${CONFIG.paths.auth} or keyring ('${CONFIG.keyringDesignation}' on this platform)`);
+    Logger.debug(`Authentication data is stored in ${CONFIG.paths.auth} (${TOKEN_STORAGE_DESC.plain}) or ${CONFIG.keyringDesignation} (${TOKEN_STORAGE_DESC.keyring})`);
 }
 
 function notifyLoggedIn(params) {
@@ -133,9 +133,6 @@ class SettingsManager {
     // Call with 'projectFolder' param as a resolved path.
     static async saveSettings(params) {
         Logger.debug(`Saving settings for project ${params.get('projectFolder')}`);
-        if (params.has('token') && ! params.has('tokenStorage')) {
-            Logger.log('Note: the authentication token is not saved by default. To save the token for later commands, please run `cds login`.');
-        }
 
         await this._saveToFile(params.get('projectFolder'), params.toValueMap(Persistence.setting));
 
@@ -153,6 +150,8 @@ class SettingsManager {
             await this._saveAuthToFile(params, params.toValueMap(Persistence.auth));
         } else if (params.get('tokenStorage') === 'keyring') {
             await this._saveAuthToKeyring(params, params.toValueMap(Persistence.auth));
+        } else {
+            Logger.log('Note: the authentication token is not saved by default. To save the token for later commands, please run `cds login`.');
         }
     }
 
@@ -160,19 +159,19 @@ class SettingsManager {
         const projectFolder = getProjectFolder(params);
         params.set('projectFolder', projectFolder);
 
-        Logger.debug(`Loading settings for project ${projectFolder}`);
         const loadedSettings = await this._loadFromFile(projectFolder);
-        Logger.debug(`Loaded project settings: ${loadedSettings.format()}`);
+        Logger.debug(`Loaded project settings for ${params.get('projectFolder')}: ${loadedSettings.format()}`);
+        const loadedAppUrl = loadedSettings.get('appUrl');
 
         params.mergeLower(loadedSettings);
 
-        await this.updateUrls(params, logout);
+        await this.updateUrls(params, logout, loadedAppUrl);
         await this.checkKeytar(params, logout);
         await this.addAuth(params, logout);
         Logger.debug(`Effective project settings: ${params.format()}`);
     }
 
-    static async updateUrls(params, logout) {
+    static async updateUrls(params, logout, loadedAppUrl) {
         async function addAppUrlAndSubdomain() {
             if (params.has('appUrl') && !schemaRegex.test(params.get('appUrl'))) {
                 params.set('appUrl', defaultSchema + params.get('appUrl'));
@@ -202,7 +201,7 @@ class SettingsManager {
             }
         }
         function renewTokenUrl() {
-            const renewUrl = params.get('appUrl') !== params.get('appUrl');
+            const renewUrl = params.get('appUrl') !== loadedAppUrl;
             if (!params.get('tokenUrl') || renewUrl) {
                 params.set('tokenUrl', getTokenBaseUrl(params, renewUrl));
             }
@@ -218,7 +217,7 @@ class SettingsManager {
     static async checkKeytar(params, logout) {
         if (isBas()) {
             if (params.get('tokenStorage') === 'keyring') {
-                Logger.log(`NOTE: Keyring storage not supported on SAP Business Application Studio. Switching to plain-text storage.`);
+                Logger.log(`NOTE: ${capitalize(TOKEN_STORAGE_DESC.keyring)} not supported on SAP Business Application Studio. Switching to ${TOKEN_STORAGE_DESC.plain}.`);
                 params.set('tokenStorage', 'plain');
             }
             return;
@@ -227,11 +226,11 @@ class SettingsManager {
             return;
         }
         if (params.get('tokenStorage') === 'keyring') {
-            throw new Error('Keyring storage requested but keytar not installed. Please run `npm install -g keytar` or ' +
-                'switch to plain-text storage by adding `--plain` (discouraged).');
+            throw new Error(`${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).`);
         }
         if (params.get('renewLogin') || logout) {
-            Logger.log('Disabling keyring functionality: \'keytar\' module not found. Run `npm install -g keytar` to install it.');
+            Logger.log(`Disabling ${TOKEN_STORAGE_DESC.keyring} functionality: 'keytar' module not found. Run 'npm install -g keytar' to install it.`);
         }
     }
 
@@ -288,8 +287,6 @@ class SettingsManager {
             }
         }
 
-        Logger.debug(`Consolidating authentication data for project ${params.get('projectFolder')}`);
-
         if (params.has('username')) {
             if (!params.get('password') && !logout) {
                 await addPassword();
@@ -325,7 +322,7 @@ class SettingsManager {
 
         fromStorage = fromStorage || allParams.get('tokenStorage');
         if (!fromStorage) {
-            Logger.log(`No authentication data found for ${target}`);
+            Logger.log(`Failed to delete authentication data: none found for ${target}`);
             return;
         }
 
@@ -339,13 +336,10 @@ class SettingsManager {
 
     static async deleteSettingsWithoutToken(params) {
         const projectFolder = getProjectFolder(params);
-        Logger.debug(`Deleting settings for project ${projectFolder}`);
         await this._saveToFile(projectFolder, null);
     }
 
     static async deleteInvalid() {
-        Logger.log('Deleting invalid project settings');
-
         const settingsByFolder = await this._loadFromFile(undefined);
         const deletionFolders = [];
         const deletionUrlsAndSubdomains = new Set();
@@ -390,29 +384,31 @@ class SettingsManager {
 
     static async _saveAllSettingsToFile(paramValuesByFolder) {
         Logger.debug(`Saving all settings to ${CONFIG.paths.settings}`);
-        await fse.outputJson(CONFIG.paths.settings, paramValuesByFolder, { spaces: 2 });
+        await fs.promises.mkdir(path.dirname(CONFIG.paths.settings), { recursive: true })
+        await fs.promises.writeFile(CONFIG.paths.settings, JSON.stringify(paramValuesByFolder, null, 2));
         Logger.debug('Saved settings');
     }
 
     static async _saveAuthToFile(params, authValues) {
-        Logger.debug(`Updating authentication data to ${CONFIG.paths.auth}`);
         const appUrl = params.get('appUrl');
-        const location = `plain-text storage for app URL ${appUrl}, subdomain ${params.get('subdomain')}`;
-
+        const location = `${TOKEN_STORAGE_DESC.plain} at ${CONFIG.paths.auth} for app URL ${appUrl}, subdomain ${params.get('subdomain')}`;
         const allAuthValues = await this._loadAuthFromFile(undefined, undefined);
+
         if (authValues !== null) {
             (allAuthValues[appUrl] || (allAuthValues[appUrl] = {}))[params.get('subdomain')] = authValues;
-            await fse.outputJson(CONFIG.paths.auth, allAuthValues, { spaces: 2 });
+            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}`);
         } else if (allAuthValues[appUrl]) {
             delete allAuthValues[appUrl][params.get('subdomain')];
             if (Object.keys(allAuthValues[appUrl]).length === 0) {
                 delete allAuthValues[appUrl];
             }
-            await fse.outputJson(CONFIG.paths.auth, allAuthValues, { spaces: 2 });
+            await fs.promises.mkdir(path.dirname(CONFIG.paths.auth), { recursive: true })
+            await fs.promises.writeFile(CONFIG.paths.auth, JSON.stringify(allAuthValues, null, 2));
             Logger.log(`Deleted authentication data from ${location}`);
         } else {
-            Logger.log(`No authentication data to delete from ${location}`);
+            notifyLoggedIn(params)(`No authentication data to delete from ${location}`);
         }
     }
 
@@ -421,8 +417,7 @@ class SettingsManager {
             return;
         }
 
-        Logger.debug('Updating authentication data to keyring');
-        const location = `keyring for app URL ${params.get('appUrl')}, subdomain ${params.get('subdomain')}`;
+        const location = `${TOKEN_STORAGE_DESC.keyring} for app URL ${params.get('appUrl')}, subdomain ${params.get('subdomain')}`;
 
         if (auth !== null) {
             await keytar.setPassword(MTX_FULLY_QUALIFIED, getKeyringAccountName(params), JSON.stringify(auth));
@@ -437,14 +432,14 @@ class SettingsManager {
         const all = !projectFolder;
 
         if (!fs.existsSync(CONFIG.paths.settings)) {
-            Logger.debug('Settings file absent');
+            Logger.debug('Settings file not found');
             return emptyData(all);
         }
 
-        Logger.debug('Reading settings file');
-        const settingsByFolder = await fse.readJson(CONFIG.paths.settings);
-
-        if (!settingsByFolder) {
+        let settingsByFolder
+        try {
+            settingsByFolder = JSON.parse((await fs.promises.readFile(CONFIG.paths.settings)).toString());
+        } catch (err) {
             Logger.debug('Empty settings file');
             return emptyData(all);
         }
@@ -465,15 +460,15 @@ class SettingsManager {
         const all = !appUrl;
 
         if (!fs.existsSync(CONFIG.paths.auth)) {
-            Logger.debug('Authentication-data file absent');
+            Logger.debug('Authentication-data file not found');
             return emptyData(all);
         }
 
-        Logger.debug(`Reading authentication data from ${CONFIG.paths.auth}`);
-        const allAuth = await fse.readJson(CONFIG.paths.auth);
-
-        if (!allAuth) {
-            Logger.debug('Empty authentication data');
+        let allAuth
+        try {
+            allAuth = JSON.parse((await fs.promises.readFile(CONFIG.paths.auth)).toString());
+        } catch (err) {
+            Logger.debug('Empty authentication-data file');
             return emptyData(all);
         }
 
@@ -482,14 +477,14 @@ class SettingsManager {
         }
 
         if (!allAuth[appUrl]) {
-            Logger.debug(`No authentication data found for app URL ${appUrl}`);
+            Logger.debug(`File contains no authentication data for app URL ${appUrl}`);
             return new ParamCollection();
         }
 
         const authForSubdomain = allAuth[appUrl][subdomain];
 
         if (!authForSubdomain) {
-            Logger.debug(`No authentication data found for subdomain ${subdomain}`);
+            Logger.debug(`File contains no authentication data for subdomain ${subdomain} (app URL: ${appUrl})`);
             return new ParamCollection();
         }
 
@@ -505,12 +500,10 @@ class SettingsManager {
             return new ParamCollection();
         }
 
-        Logger.debug('Reading authentication data from keyring');
-
         const authString = await keytar.getPassword(MTX_FULLY_QUALIFIED, getKeyringAccountName(new ParamCollection({ appUrl, subdomain })));
 
         if (!authString) {
-            Logger.debug(`No authentication data found for URL ${appUrl} and subdomain '${subdomain}'`);
+            Logger.debug(`${capitalize(TOKEN_STORAGE_DESC.keyring)} contains no authentication data for URL ${appUrl} and subdomain '${subdomain}'`);
             return new ParamCollection();
         }
 

package/lib/compile/index.js

@@ -1,14 +1,13 @@
-const cds = require ('@sap/cds')
+const cds = require('../cds')
+const comp_to = cds.compile.to
+const { defineProperty } = Object
 
-// cds.compile.to ...
-'xsuaa' in cds.compile.to || Object.defineProperties (cds.compile.to,{
-  'xsuaa':   {enumerable:true, get:()=> require('./to-xsuaa')},
-  'openapi': {enumerable:true, get:()=> require('./openapi')},
-  'edmx-v2': {enumerable:true, value: (csn,o) => cds.compile.to.edmx(csn,{...o,flavor:'v2'}) },
-  'edmx-v4': {enumerable:true, value: (csn,o) => cds.compile.to.edmx(csn,{...o,flavor:'v4'}) },
-  'edmx-w4': {enumerable:true, value: (csn,o) => cds.compile.to.edmx(csn,{...o,flavor:'w4'}) },
-  'edmx-x4': {enumerable:true, value: (csn,o) => cds.compile.to.edmx(csn,{...o,flavor:'x4'}) },
-})
+'xsuaa'   in comp_to || defineProperty (comp_to, 'xsuaa',   {enumerable:true, get:()=> require('./to-xsuaa')})
+'openapi' in comp_to || defineProperty (comp_to, 'openapi', {enumerable:true, get:()=> require('./openapi')})
 
+'edmx-v2' in comp_to || defineProperty (comp_to, 'edmx-v2', {enumerable:true, value: (csn,o) => comp_to.edmx(csn,{...o,flavor:'v2'})})
+'edmx-v4' in comp_to || defineProperty (comp_to, 'edmx-v4', {enumerable:true, value: (csn,o) => comp_to.edmx(csn,{...o,flavor:'v4'})})
+'edmx-w4' in comp_to || defineProperty (comp_to, 'edmx-w4', {enumerable:true, value: (csn,o) => comp_to.edmx(csn,{...o,flavor:'w4'})})
+'edmx-x4' in comp_to || defineProperty (comp_to, 'edmx-x4', {enumerable:true, value: (csn,o) => comp_to.edmx(csn,{...o,flavor:'x4'})})
 
 module.exports = cds