@sap/cds-dk 7.8.1 → 7.9.1

package/lib/lint/io.js

@@ -11,7 +11,7 @@ module.exports = {
    * @param {*} configPath config file path to read from
    * @returns config file contents
    */
-  async readEslintConfig(configPath) {
+  async readEslintConfigLegacy(configPath) {
     let config;
     const configFile = path.basename(configPath);
     const configString = await read(configPath, "utf8");
@@ -33,7 +33,7 @@ module.exports = {
         config = await readJSONC(configPath);
         break;
       case "package.json":
-        config = JSON.parse(await read(configPath, "utf8"));
+        config = await read(configPath, "json");
         if ("eslintConfig" in config) {
           config = config["eslintConfig"];
         } else {
@@ -46,16 +46,68 @@ module.exports = {
     return config;
   },
 
+  /**
+ * Reads ESLint config contents from file
+ * @param {*} configPath config file path to read from
+ * @returns config file contents
+ */
+  async readEslintConfig(configPath) {
+    let config;
+    const configFile = path.basename(configPath);
+    switch (configFile) {
+      case "eslint.config.js":
+      case "eslint.config.cjs":
+      case "eslint.config.mjs":
+        config = this.safeRequire(configPath)
+        break;
+      default:
+        break;
+    }
+    return config;
+  },
+
   /**
    * Checks ESLint config file contents for locally installed
    * plugin with:
    * (1) All CDS recommended rules "on"
-   * (2) Option "root": false to stop further config merging
-   * (3) Add's custom rule example 'no-entity-moo' if requested
+   * (2) Add's custom rule example 'no-entity-moo' if requested
    * @param {*} configPath ESLint config file
    * @returns {void}
    */
   async sanitizeEslintConfig(configIn, customRuleExample = false, logger = console) {
+    let configContents;
+    const isFilePath = typeof configIn === "string";
+    if (isFilePath) {
+      configContents = this.safeRequire(configIn); // TODO error handling invalid json
+    }
+
+    configContents ??= { ...configIn };
+
+    if (customRuleExample) {
+      const ruleName = "no-entity-moo";
+      const ruleValue = 2;
+      if ("rules" in configContents) {
+        configContents["rules"][ruleName] = ruleValue;
+      } else {
+        configContents["rules"] = { [ruleName]: ruleValue };
+      }
+    }
+    if (isFilePath) {
+      await this.writeEslintConfig(configIn, logger);
+    }
+    return configContents;
+  },
+
+  /**
+ * Checks ESLint config file contents for locally installed
+ * plugin with:
+ * (1) All CDS recommended rules "on"
+ * (2) Option "root": false to stop further config merging
+ * (3) Add's custom rule example 'no-entity-moo' if requested
+ * @param {*} configPath ESLint config file
+ * @returns {void}
+ */
+  async sanitizeEslintConfigLegacy(configIn, customRuleExample = false, logger = console) {
     let configContents = {};
     const isFilePath = typeof configIn === "string";
     if (isFilePath) {
@@ -93,19 +145,20 @@ module.exports = {
       }
     }
     if (isFilePath) {
-      await this.writeEslintConfig(configIn, configContents, logger);
+      await this.writeEslintConfigLegacy(configIn, configContents, logger);
     }
     return configContents;
   },
 
+
   /**
    * Writes ESLint config contents to file
    * @param {*} configContents config file contents
    * @param {*} configPath config file path to write to
    * @returns {Promise<void>}
    */
-  async writeEslintConfig(configPath, configContents, logger=console) {
-    const configType = "recommended";
+  async writeEslintConfigLegacy(configPath, configContents, logger = console) {
+    const configType = "recommended-legacy";
     const extendsValue = `plugin:@sap/cds/${configType}`;
     let contents = {};
     let configFile = path.basename(configPath);
@@ -114,7 +167,7 @@ module.exports = {
       case ".eslintrc.js":
       case ".eslintrc.cjs":
         try {
-          configContents = await this.readEslintConfig(configPath);
+          configContents = await this.readEslintConfigLegacy(configPath);
         } catch (err) {
           configContents = {};
         }
@@ -146,7 +199,7 @@ module.exports = {
         break;
       case "package.json":
         if (exists(configPath)) {
-          contents = JSON.parse(await read(configPath, "utf8"));
+          contents = await read(configPath, "json");
         } else {
           contents = {};
         }
@@ -162,6 +215,54 @@ module.exports = {
     }
   },
 
+  /**
+   * Suggest ESLint config contents to file
+   * @param {*} configContents config file contents
+   * @param {*} configPath config file path to write to
+   * @returns {Promise<void>}
+   */
+  async writeEslintConfig(configPath, logger = console) {
+    let configFile = path.basename(configPath);
+    switch (configFile) {
+      case "eslint.config.js":
+      case "eslint.config.cjs":
+      case "eslint.config.mjs":
+        if (exists(configPath)) {
+          logger.log(
+            `${term.warn(
+              `\n\nPlease add the following to your "${configFile}":` +
+              '\n\n  1. At the top of your file, import the following:')}` +
+            `\n\n     ${term.bold('const cds = require(\'@sap/eslint-plugin-cds\')')}` +
+            `${term.warn(
+              '\n\n  2. In your export, add the following to the top of the array:')}` +
+            `\n\n     ${term.bold('cds.configs.recommended')}`
+          );
+        } else {
+          await write(configPath, `
+const cds = require('@sap/eslint-plugin-cds')
+
+module.exports = [
+  cds.configs.recommended,
+  {
+    plugins: {
+      "@sap/cds": cds
+    },
+    "files": [
+      ...cds.configs.recommended.files
+    ],
+    "rules": {
+      ...cds.configs.recommended.rules
+    }
+  }
+]
+`)
+        }
+        break;
+      default:
+        break;
+    }
+  },
+
   /**
    * Read VS Code settings from file
    * @param {*} settingsPath settings file path to read from
@@ -204,7 +305,7 @@ module.exports = {
    * (3) "Global" case adds configFile and removes rulePaths
    * @param {*} settingsPath VS Code settings file
    */
-  async sanitizeVscodeSettings(projectPath, settingsPath, lintType, lintFileTypes, customRuleExample = false) {
+  async sanitizeVscodeSettings(settingsPath, lintType, lintFileTypes, customRuleExample = false) {
     let settings = (await this.readVscodeSettings(settingsPath)) || {};
     const rulePaths = [path.join(".eslint/rules")];
 
@@ -253,4 +354,12 @@ module.exports = {
     }
     return userOpts;
   },
+
+  safeRequire(module) {
+    try {
+      return require(module)
+    } catch (e) {
+      return null
+    }
+  }
 };

package/lib/mtx/auth_manager.js

@@ -65,26 +65,26 @@ async function retrieveTokenOrPasscodeUrl(params) {
                 DEBUG?.(`Getting authentication token or passcode URL from ${method.toUpperCase()} ${params.obfuscateQueryParams(url)}`);
                 response = await axios[method](url, data);
             } catch (e) {
-                error = e;
-                if (error.status === 404) { // may represent 405 in case of wrong method
+                if (e.status === 404) { // may represent 405 in case of wrong method
                     continue reqParams;
                 } else if (params.has('refreshToken')) {
                     DEBUG?.('Discarding invalid refresh token');
                     params.delete('refreshToken');
                 } else {
+                    error = e;
                     break reqParams;
                 }
             }
-        } while (!(response || error));
+        } while (!response);
     }
     const data = response?.data ?? error?.auth;
     assign(params, data);
-    if (!response) {
+    if (error) {
         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>'`);
+            } and re-run the command with '-p <passcode>'`, { cause: error });
     }
 }
 

package/lib/mtx/params.js

@@ -213,6 +213,7 @@ class AllParams extends BasicParams {
         // `extend` PARAMS
         this.force                  = new Param('force',                  false);
         this.templates              = new Param('templates',              false);
+        this["download-migrated-projects"]   = new Param('download-migrated-projects', false)
 
         // `activate` PARAMS
         this.undeploy               = new Param('undeploy',               false);
@@ -220,6 +221,9 @@ class AllParams extends BasicParams {
         this.sync                   = new Param('sync',                   false);
         this.async                   = new Param('async',                 false);
 
+        // `subscribe` PARAMS
+        this.body                   = new Param('body',                   '', { persist: Persistence.none });
+
         // `login` PARAMS
         this.skipToken              = new Param('skipToken',              false, { internal: true });
 
@@ -229,8 +233,6 @@ class AllParams extends BasicParams {
         this.clearInvalid           = new Param('clearInvalid',           false);
         this["clear-invalid"]       = this.clearInvalid.newAlias('clear-invalid');
 
-        // download for mxts
-        this["download-migrated-projects"]   = new Param('download-migrated-projects', false)
     }
 }
 

package/lib/mtx/settings_manager.js

@@ -252,7 +252,7 @@ class SettingsManager {
         async function updateTokenUrl() {
             const tokenUrl = params.get('tokenUrl');
             const renewUrl = !logout && !params.get('skipToken')
-                && (!tokenUrl || tokenUrl.includes('//-/cds') || params.get('appUrl') !== loadedSettings.get('appUrl'));
+                && (!tokenUrl || tokenUrl.includes('//-/cds') || tokenUrl.includes(OAUTH_PATH_OLD_MTX) || params.get('appUrl') !== loadedSettings.get('appUrl'));
             if (renewUrl) {
                 const tokenUrl = await getTokenBaseUrl(params, renewUrl);
                 params.set('tokenUrl', tokenUrl);

package/lib/mtx/tenant_action.js

@@ -48,8 +48,17 @@ module.exports = class TenantAction {
         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}`);
+        const body = params.get('body');
+        let parsedBody;
+        if (body) {
+            try {
+                parsedBody = JSON.parse(body)
+            } catch (error) {
+                throw getMessage('Invalid subscription body', { error, command: this.command });
+            }
+        }
         try {
-            await require('axios').post(url, { tenant }, params.get('reqAuth'));
+            await require('axios').post(url, { tenant, metadata: parsedBody, options: parsedBody }, params.get('reqAuth'));
         } catch (error) {
             handleHttpError(error, params, { url });
         }
@@ -74,6 +83,7 @@ module.exports = class TenantAction {
         if (!cds_mtx) {
             throw '@sap/cds-mtxs outdated. Please upgrade to @sap/cds-mtxs@>=1.7.0 and re-run this command.';
         }
-        return cds_mtx(this.command, tenant);
+        const body = params.get('body')
+        return cds_mtx(this.command, tenant, body);
     }
 }

package/lib/mtx/util/logging.js

@@ -3,9 +3,12 @@
 function getMessage(errorText, { error, command, help = command && getCommandHelp(command) } = {}) {
     let message = errorText ? errorText.trim() : '';
     if (error) {
-        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 debug = require('../../cds').debug('cli');
+        const includeStack = debug && error.stack?.includes('\n');
+        if (message.length) {
+            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);
@@ -13,9 +16,12 @@ function getMessage(errorText, { error, command, help = command && getCommandHel
         if (includeStack) {
             message += (oriMsg ? '\n' : '') + error.stack;
         }
+        if (debug && error.cause) {
+            message += '\nCaused by: ' + getMessage('', { error: error.cause }).replace(/^(?= *at)/gm, '  ');
+        }
     }
     if (typeof help === 'string') {
-        message += require('../../../bin/help').formatHelp(help);
+        message += '\n' + require('../../../bin/help').formatHelp(help);
     }
     return message;
 }

package/lib/util/axios.js

@@ -15,7 +15,8 @@ function pruneErrors() {
         response => response,
         axError => {
             const { inspect } = require('util');
-            const { url, method } = axError.config ?? {};
+            let { url, method } = axError.config ?? {};
+            url = url?.replace(/(passcode|refreshToken|clientsecret|key)=[^&]+/g, '$1=...');
             const { errno, code, response = {}, message: axMessage } = axError;
             const prefix = (url && method ? `${method.toUpperCase()} ${url}` : 'Request') + ' failed';
 

package/lib/util/cf.js

@@ -28,12 +28,8 @@ const OPERATION_STATE_SUCCEEDED = 'succeeded';
 
 const CF_CLIENT_MINIMUM_VERSION = 8;
 
-
-class CfUtil {
-
-    _clear() {
-        this.spaceInfo = null;
-    }
+module.exports = new class CfUtil {
+    spaceInfo;
 
     async _sleep(ms) {
         return new Promise((resolve) => {
@@ -41,7 +37,7 @@ class CfUtil {
         });
     }
 
-    async _cfRun(...args) {
+    async cfRun(...args) {
         args = args.map(arg => arg.replace(/"/g, '\\"'));
         const cmdLine = `${CF_COMMAND} "${args.join('" "')}"`;
         DEBUG && console.time(cmdLine);
@@ -65,12 +61,15 @@ class CfUtil {
         }
     }
 
-    async _cfRequest(urlPath, queryObj, bodyObj) {
+    async cfRequest(urlPath, queryObj, bodyObj) {
         if (queryObj) {
             const entries = Object.entries(queryObj);
             const queryStr = entries.map(([key, value]) => {
+                if (Array.isArray(value)) {
+                    value = value.join(',');
+                }
                 // commas cause problems in cf curl when not double encoded
-                value = value.replace(/,/g, encodeURIComponent(','));
+                // value = value.replace(/,/g, encodeURIComponent(','));
                 return `${key}=${encodeURIComponent(value)}`;
             }).join('&');
 
@@ -84,7 +83,7 @@ class CfUtil {
             args.push(JSON.stringify(bodyObj)); // cfRun uses spawn so no special handling for quotes on cli required
         }
 
-        const result = await this._cfRun(...args);
+        const result = await this.cfRun(...args);
         let response = {};
         if (result.stdout) {
             response = JSON.parse(result.stdout);
@@ -108,7 +107,7 @@ class CfUtil {
         throw new Error(errorMsg);
     }
 
-    async getCfTargetFromConfigFile() {
+    async _getCfTargetFromConfigFile() {
         const cfHome = process.env.CF_HOME || process.env.cf_home || path.join(os.homedir(), '.cf');
         try {
             const fileContent = await fsp.readFile(path.join(cfHome, 'config.json'));
@@ -125,8 +124,8 @@ class CfUtil {
         }
     }
 
-    async getCfTargetFromCli() {
-        const result = await this._cfRun('target');
+    async _getCfTargetFromCli() {
+        const result = await this.cfRun('target');
         if (result?.stdout) {
             return {
                 apiEndpoint: this._extract(result.stdout, /api endpoint\s*:\s*([^\s]+)/i, `CF API endpoint is missing. Use 'cf login' to login.`),
@@ -137,23 +136,23 @@ class CfUtil {
         }
     }
 
-    async getCfAuthorization() {
+    async _getCfAuthorization() {
         DEBUG?.('getting authorization');
         try {
-            return (await this._cfRun('oauth-token')).stdout;
+            return (await this.cfRun('oauth-token')).stdout;
         } catch (err) {
             throw err.message;
         }
     }
 
     async getCfTarget() {
-        await this.checkCliVersion();
-        await this.getCfAuthorization();
-        return await this.getCfTargetFromConfigFile() || await this.getCfTargetFromCli();
+        await this._checkCliVersion();
+        await this._getCfAuthorization();
+        return await this._getCfTargetFromConfigFile() || await this._getCfTargetFromCli();
     }
 
-    async checkCliVersion() {
-        const result = await this._cfRun('-v');
+    async _checkCliVersion() {
+        const result = await this.cfRun('-v');
         const version = result?.stdout?.match(/version.*(\d+\.\d+\.\d+)/i)
         if (parseInt(version?.[1]) < CF_CLIENT_MINIMUM_VERSION) {
             console.log(warn(`
@@ -170,13 +169,13 @@ Deployment will stop in the near future for Cloud Foundry client versions < ${CF
             const target = await this.getCfTarget();
 
             const { org, space } = target;
-            const orgs = await this._cfRequest(`/v3/organizations`, { names: org });
+            const orgs = await this.cfRequest(`/v3/organizations`, { names: org });
             if (!orgs?.resources?.length) {
                 throw new Error(`CF org ${bold(org)} not found!`);
             }
 
             const orgGuid = orgs.resources[0].guid;
-            const spaces = await this._cfRequest(`/v3/spaces`, { names: space, organization_guids: orgGuid });
+            const spaces = await this.cfRequest(`/v3/spaces`, { names: space, organization_guids: orgGuid });
             if (!spaces?.resources?.length) {
                 throw new Error(`CF space ${bold(space)} not found in org ${bold(org)}!`);
             }
@@ -196,10 +195,10 @@ Deployment will stop in the near future for Cloud Foundry client versions < ${CF
 
     async getEnv(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 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;
-        return await this._cfRequest('/v3/apps/' + guid + '/env', { space_guids, organization_guids, names: app });
+        return await this.cfRequest('/v3/apps/' + guid + '/env', { space_guids, organization_guids, names: app });
     }
 
     async getService(serviceName, showMessage = true) {
@@ -209,7 +208,7 @@ Deployment will stop in the near future for Cloud Foundry client versions < ${CF
         let counter = POLL_COUNTER;
         while (counter > 0) {
             counter--;
-            const serviceInstances = await this._cfRequest('/v3/service_instances', {
+            const serviceInstances = await this.cfRequest('/v3/service_instances', {
                 names: serviceName,
                 space_guids: spaceInfo.spaceGuid,
                 organization_guids: spaceInfo.orgGuid
@@ -253,7 +252,7 @@ Deployment will stop in the near future for Cloud Foundry client versions < ${CF
 
         const spaceInfo = await this.getCfSpaceInfo();
 
-        const servicePlan = await this._cfRequest(`/v3/service_plans`, {
+        const servicePlan = await this.cfRequest(`/v3/service_plans`, {
             names: planName,
             space_guids: spaceInfo.spaceGuid,
             organization_guids: spaceInfo.orgGuid,
@@ -286,7 +285,7 @@ Deployment will stop in the near future for Cloud Foundry client versions < ${CF
             body.parameters = { ...options };
         }
 
-        const postResult = await this._cfRequest('/v3/service_instances', undefined, body);
+        const postResult = await this.cfRequest('/v3/service_instances', undefined, body);
         if (postResult?.errors) {
             throw new Error(postResult.errors[0].detail);
         }
@@ -299,14 +298,13 @@ Deployment will stop in the near future for Cloud Foundry client versions < ${CF
         throw new Error(`Could not create service ${bold(serviceName)}`);
     }
 
-
-    async getServiceKey(serviceInstance, serviceKeyName, showMessage = true) {
+    async _getServiceKey(serviceInstance, serviceKeyName, showMessage = true) {
         showMessage && console.log(`Getting service key ${bold(serviceKeyName)}`);
 
         let counter = POLL_COUNTER;
         while (counter > 0) {
             counter--;
-            const bindings = await this._cfRequest(`/v3/service_credential_bindings`, { names: serviceKeyName, service_instance_guids: serviceInstance.guid });
+            const bindings = await this.cfRequest(`/v3/service_credential_bindings`, { names: serviceKeyName, service_instance_guids: serviceInstance.guid });
             if (!bindings?.resources?.length) {
                 return null;
             }
@@ -319,7 +317,7 @@ Deployment will stop in the near future for Cloud Foundry client versions < ${CF
                     break;
 
                 case OPERATION_STATE_SUCCEEDED: {
-                    const keyDetails = await this._cfRequest(`/v3/service_credential_bindings/${encodeURIComponent(binding.guid)}/details`);
+                    const keyDetails = await this.cfRequest(`/v3/service_credential_bindings/${encodeURIComponent(binding.guid)}/details`);
                     return keyDetails.credentials;
                 }
 
@@ -335,9 +333,8 @@ Deployment will stop in the near future for Cloud Foundry client versions < ${CF
         throw new Error(`Timeout occurred while getting service key ${bold(serviceKeyName)}`);
     }
 
-
     async getOrCreateServiceKey(serviceInstance, serviceKeyName, parameters, { silent = false, create = true } = {}) {
-        const serviceKey = await this.getServiceKey(serviceInstance, serviceKeyName, false);
+        const serviceKey = await this._getServiceKey(serviceInstance, serviceKeyName, false);
         if (serviceKey || !create) {
             if (serviceKey && !silent) console.log(`Getting service key ${bold(serviceKeyName)}`);
             return serviceKey;
@@ -358,12 +355,12 @@ Deployment will stop in the near future for Cloud Foundry client versions < ${CF
             parameters
         }
 
-        const postResult = await this._cfRequest('/v3/service_credential_bindings', undefined, body);
+        const postResult = await this.cfRequest('/v3/service_credential_bindings', undefined, body);
         if (postResult?.errors) {
             throw new Error(postResult.errors[0].detail);
         }
 
-        const newServiceKey = await this.getServiceKey(serviceInstance, serviceKeyName, false);
+        const newServiceKey = await this._getServiceKey(serviceInstance, serviceKeyName, false);
         if (newServiceKey) {
             return newServiceKey;
         }
@@ -371,5 +368,3 @@ Deployment will stop in the near future for Cloud Foundry client versions < ${CF
         throw new Error(`Could not create service key ${bold(serviceKeyName)}`);
     }
 }
-
-module.exports = new CfUtil();

package/lib/util/fs.js

@@ -28,7 +28,7 @@ module.exports = new class FsUtil {
     }
 
     async writeYAML(dst, yaml) {
-        const content = YAML.stringify(yaml, { collectionStyle: 'block' })
+        const content = YAML.stringify(yaml, { collectionStyle: 'block', lineWidth: 120 })
         await write(content).to(dst)
     }
 

package/lib/util/git.js

@@ -35,7 +35,7 @@ class GitUtil {
             }
         }
 
-        console.log(`adding entry '${file}' to ${GIT_IGNORE_FILE}.`);
+        console.log(`Adding entry '${file}' to ${GIT_IGNORE_FILE}.`);
         let gitignore = await this.readFileSafely(gitIgnorePath);
         gitignore = gitignore + `${os.EOL}# added by cds${os.EOL}${file}${os.EOL}`;
 

package/lib/util/term.js

@@ -26,7 +26,7 @@ module.exports.info  = o => as(t.green, o)
 module.exports.link  = o => as(t.link, o)
 module.exports.bold  = o => as(t.bold, o)
 module.exports.highlight  = o => as(t.blue,as(t.bold, o))
-module.exports.secondary  = o => as(t.grey, o)
+module.exports.dim  = o => as(t.grey, o)
 
 const format = module.exports.format = (o, severity='Error', asInternalError=false, withStack=false) => {
   switch (severity) {

package/{bin → lib/watch}/watched.js

@@ -7,8 +7,8 @@
 
   // run through cli in order to use its error handling
   const args = JSON.parse(process.env._args)
-  const cds = require('../lib/cds'); cds.watched = true
-  const bootstrap = require('./cds')(...args)
+  const cds = require('../cds'); cds.watched = true
+  const bootstrap = require('../../bin/cds')(...args)
 
   cds.once('listening', ({server}) => {
     process.send ({ code:'listening', port: server.address().port })