@sap/cds-dk 7.6.0 → 7.7.0

package/lib/init/template/sample/files/app/index.html

@@ -15,12 +15,14 @@
 	</script>
 
 	<script id="sap-ushell-bootstrap" src="https://sapui5.hana.ondemand.com/test-resources/sap/ushell/bootstrap/sandbox.js"></script>
-	<script id="sap-ui-bootstrap" src="https://sapui5.hana.ondemand.com/resources/sap-ui-core.js"
-			data-sap-ui-libs="sap.m, sap.ushell, sap.collaboration, sap.ui.layout"
-			data-sap-ui-compatVersion="edge"
-			data-sap-ui-theme="sap_horizon"
-			data-sap-ui-frameOptions="allow"
-	></script>
+    <script id="sap-ui-bootstrap" src="https://sapui5.hana.ondemand.com/resources/sap-ui-core.js"
+      data-sap-ui-libs="sap.m, sap.ushell, sap.collaboration, sap.ui.layout"
+      data-sap-ui-compatVersion="edge"
+      data-sap-ui-async="true"
+      data-sap-ui-preload="async"
+      data-sap-ui-theme="sap_horizon"
+      data-sap-ui-frameOptions="allow"
+    ></script>
 	<script>
 		sap.ui.getCore().attachInit(()=> sap.ushell.Container.createRenderer().placeAt("content"))
 	</script>

package/lib/init/template/sample/index.js

@@ -1,5 +1,5 @@
 const { join } = require('path')
-const cds = require('../../../cds'), { exists, copy } = cds.utils
+const cds = require('../../../cds'), { exists, read, write, copy } = cds.utils
 const { env4, readProject } = require('../../projectReader')
 
 module.exports = class SampleTemplate extends require('../../plugin') {
@@ -13,11 +13,21 @@ module.exports = class SampleTemplate extends require('../../plugin') {
     async run() {
         const { db, srv, app } = env4('production').folders
         const language = exists('pom.xml') ? 'java' : 'nodejs'
+
         await Promise.all([
           copy(join(__dirname, 'files', 'db')).to(db),
-          copy(join(__dirname, 'files', 'app')).to(app),
           copy(join(__dirname, 'files', 'srv')).to(srv),
           copy(join(__dirname, 'files', language)).to(srv)
         ])
+
+        await copy(join(__dirname, 'files', 'app')).to(app)
+        const { appName, appPath, appUIPaths } = readProject()
+
+        // manifest.json must be unique
+        await Promise.all(appUIPaths.map(async p => {
+            const manifest = await read(join(appPath, p, 'webapp/manifest.json'))
+            manifest['sap.app'].id = appName + '.' + p
+            await write(join(appPath, p, 'webapp/manifest.json'), manifest, { spaces: 2 })
+        }))
     }
 }

package/lib/lint/Linter.js

@@ -38,7 +38,7 @@ class Linter {
   /**
    * Initializes `cds lint` call and generates the required content
    * object for `cds` executable
-   * @returns object continaing help, options, flags and shortcuts
+   * @returns object containing help, options, flags and shortcuts
    */
   init(help = "", options = [], flags = [], shortcuts = []) {
     this.eslintCmd = checks.resolveEslint(this.cdsdkPath, this.globalPath);
@@ -56,7 +56,7 @@ class Linter {
 
   /**
    * Runner for 'cds lint' which is a wrapper for eslint cmd calls
-   * that detecs and adds the required cmd line arguments
+   * that detects and adds the required cmd line arguments
    * @param {*} args files/globs for eslint to lint
    * @param {*} options options/flag passed by user
    */

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/auth_manager.js

@@ -3,29 +3,32 @@ const axios = require('axios');
 const cds = require('../cds');
 const { SettingsManager } = require('./settings_manager');
 const { ParamCollection } = require('./params');
+const { getMessage } = require('./util/logging');
 
 require('../util/axios').pruneErrors();
-const { getMessage } = require('./util/logging');
 
 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') } });
         }

package/lib/mtx/settings_manager.js

@@ -105,22 +105,17 @@ 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) {
@@ -184,7 +179,7 @@ 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, { fromOtherStorage: true });
         }
@@ -195,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`.');
         }
     }
 
@@ -586,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?.('File contains invalid saved auth');
+            DEBUG?.(`${capitalize(TOKEN_STORAGE_DESC.plain)} contains invalid saved auth`);
             return emptyData(all);
         }
 
@@ -599,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();
         }
 

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/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

@@ -54,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')) {

package/lib/util/cf.js

@@ -192,6 +192,7 @@ Deployment will stop in the near future for Cloud Foundry client versions < ${CF
     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 });
+        if (apps.resources.length < 1) throw `Cannot find app with name '${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();