@sap/cds-dk 7.8.2 → 7.9.1

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

@@ -1,7 +1,7 @@
 const { join } = require('path')
 const { readProject } = require('../../projectReader')
 const { merge, mergeGitignore } = require('../../merge')
-const { warn, secondary } = require('../../../util/term')
+const { warn, dim } = require('../../../util/term')
 const { TYPER } = require('../../constants').OPTIONS
 const { exists, read } = require('../../../cds').utils
 
@@ -25,7 +25,7 @@ module.exports = class TyperTemplate extends require('../../plugin') {
     }
     await merge(template('package.json')).into('package.json')
     await mergeGitignore('.gitignore', template('gitignore'))
-    console.log(secondary(` > Adding '@cds-models' to .gitignore to ignore generated types`)) // REVISIT: other facets are silent wrt. what they change
+    console.log(dim(`  Adding '@cds-models' to .gitignore to ignore generated types`)) // REVISIT: other facets are silent wrt. what they change
     try {
       await merge(source).into(target)
     } catch (e) {

package/lib/lint/Linter.js

@@ -10,6 +10,8 @@ const { exit } = require("process");
 const LOG = cds.debug("lint");
 const LOG_CONFIG = cds.debug("lint:config");
 
+const GENERAL_ERROR = 1;
+
 class Linter {
   constructor() {
     this.eslintCmd = "";
@@ -61,6 +63,11 @@ class Linter {
    * @param {*} options options/flag passed by user
    */
   async lint(args, options) {
+    // Check for ESLint (legacy)
+    const currentDir = process.cwd();
+    const DefaultESLint = await this._loadEslint(currentDir);
+    this.isESLintLegacy = DefaultESLint.configType === "eslintrc";
+
     this.eslintCmdOpts = this._sanitizeUserOpts(options);
     this.eslintCmdFileExpr = args.length ? args : ["."];
     if (this.eslintCmdOpts.help) {
@@ -82,7 +89,7 @@ class Linter {
 
       // Run ESLint with collected options
       try {
-        await this._runEslint();
+        await this._runEslint(currentDir, DefaultESLint);
       } catch (err) {
         term.error(err);
       }
@@ -91,7 +98,6 @@ class Linter {
 
   _printHelp() {
     console.log(this.help.replace(/ \*([^*]+)\*/g, ` ${term.codes.bold}$1${term.codes.reset}`));
-    return;
   }
 
   _sanitizeUserOpts(options) {
@@ -111,7 +117,7 @@ class Linter {
    * @param {string} currentDir start here and search until root dir
    * @returns {string} dir containing ESLint config file (empty if not exists)
    */
-  async _getConfigPath(currentDir = ".") {
+  async _getConfigPathLegacy(currentDir = ".") {
     const configFiles = [
       ".eslintrc.js",
       ".eslintrc.cjs",
@@ -122,18 +128,48 @@ class Linter {
       "package.json",
     ];
     let configDir = path.resolve(currentDir);
-    while (configDir !== path.resolve(configDir, "..")) {
+    while (configDir && configDir !== path.dirname(configDir)) {
       for (let i = 0; i < configFiles.length; i++) {
         const configPath = path.join(configDir, configFiles[i]);
-        if (configFiles[i] !== "package.json" || (
-          configFiles[i] === "package.json" && require(configPath).eslintConfig
-        )) {
+        const config = this.safeRequire(configPath)
+
+        if (configFiles[i] !== "package.json" || config?.eslintConfig) {
           if (exists(configPath) && await isfile(configPath)) {
             return configPath;
           }
         }
       }
-      configDir = path.join(configDir, "..");
+
+      configDir = path.dirname(configDir);
+    }
+    return "";
+  }
+
+  /**
+ * Searches for ESLint config file types (in order or precedence)
+ * and returns corresponding directory (usually project's root dir)
+ * https://eslint.org/docs/user-guide/configuring#configuration-file-formats
+ * @param {string} currentDir start here and search until root dir
+ * @returns {string} dir containing ESLint config file (empty if not exists)
+ */
+  async _getConfigPath(currentDir = ".") {
+    const configFiles = [
+      "eslint.config.js",
+      "eslint.config.cjs",
+      "eslint.config.mjs"
+    ];
+    let configDir = path.resolve(currentDir);
+    while (configDir && configDir !== path.dirname(configDir)) {
+      for (let i = 0; i < configFiles.length; i++) {
+        const configPath = path.join(configDir, configFiles[i]);
+        const config = this.safeRequire(configPath)
+        if (configFiles[i] !== "package.json" || config?.eslintConfig) {
+          if (exists(configPath) && await isfile(configPath)) { // TODO exists neccessary ?
+            return configPath;
+          }
+        }
+      }
+      configDir = path.dirname(configDir);
     }
     return "";
   }
@@ -146,45 +182,51 @@ class Linter {
     this.fileExtensions.forEach((ext) => {
       this.ignorePatterns.push(`!${ext}`);
     });
-    return;
   }
 
-  async _runEslint() {
+  async _runEslint(currentDir, DefaultESLint) {
     try {
-      const currentDir = process.cwd();
-
-      const { ESLint } = require("eslint");
 
       let eslintOpts = {
         cwd: currentDir,
-        extensions: this.fileExtensions,
         overrideConfig: {
           ...this.configContents,
         },
-        useEslintrc: false,
       };
 
       if (this.lintType === "global") {
         eslintOpts = {
           cwd: process.cwd(),
-          extensions: this.fileExtensions,
-          overrideConfig: {
-            plugins: ["@sap/eslint-plugin-cds"],
-            extends: "plugin:@sap/cds/recommended"
-          },
-          useEslintrc: false,
-          resolvePluginsRelativeTo: this.cdsdkPath
+          overrideConfig: {},
         };
       }
 
+      if (this.isESLintLegacy) {
+        LOG?.("Using legacy ESLint configuration");
+        eslintOpts.extensions = this.fileExtensions;
+        eslintOpts.overrideConfig.extends = "plugin:@sap/cds/recommended-legacy"
+        eslintOpts.overrideConfig.plugins = ["@sap/eslint-plugin-cds"]
+        eslintOpts.useEslintrc = false
+        if (this.lintType === "global") {
+          eslintOpts.resolvePluginsRelativeTo = this.cdsdkPath
+        }
+      } else {
+        LOG?.("Using flat ESLint configuration");
+        const cdsPlugin = require(this.pluginPath)
+        // Exvlude our own apis from plugin to avoid wrapper errors
+        delete cdsPlugin.configs.recommended?.plugins?.['@sap/cds']
+        eslintOpts.overrideConfig = [cdsPlugin.configs.recommended]
+      }
+
       if (this.customRulesOpts && this.customRulesOpts.length > 0) {
         eslintOpts.rulePaths = [this.customRulesOpts]
       }
 
-      LOG_CONFIG && LOG_CONFIG(eslintOpts);
+      LOG_CONFIG?.(eslintOpts);
 
       let lintString = `eslint`;
-      if (this.fileExtensions) { lintString += ` --ext "${this.fileExtensions.join(",")}"`}
+      if (this.fileExtensions) { lintString += ` --ext "${this.fileExtensions.join(",")}"` }
+
       for (const ruleOpt of Object.entries(this.ruleOpts)) {
         lintString += ` --rule ${ruleOpt[0]}:${ruleOpt[1]}`;
       }
@@ -192,10 +234,10 @@ class Linter {
         lintString += ` --rulesdir "${this.customRulesOpts}"`
       }
 
-      LOG && LOG(lintString);
+      LOG?.(lintString);
 
       if (!process.env.isTest) {
-        const eslint = new ESLint(eslintOpts);
+        const eslint = new DefaultESLint(eslintOpts);
         const formatter = await eslint.loadFormatter("stylish");
 
         let results = (await eslint.lintText("")).map((result) => {
@@ -221,13 +263,12 @@ class Linter {
           const eslintBase = `${require.resolve('eslint').split('eslint')[0]}/eslint`;
           const template = require(path.join(eslintBase, `messages/${err.messageTemplate}.js`));
           console.log(template(err.messageData || {}));
-          exit(1)
         } catch {
-            // Ignore template error then fallback to use `error.stack`.
+          // Ignore template error then fallback to use `error.stack`.
+          console.log(err.stack);
         }
-        console.log(err.stack);
-     }
-      exit(1)
+      }
+      exit(GENERAL_ERROR); // TODO use error constant
     }
   }
 
@@ -244,31 +285,50 @@ class Linter {
         input = ".";
       }
     }
-    this.configPath = await this._getConfigPath(process.cwd());
+    this.configPath = this.isESLintLegacy
+      ? await this._getConfigPathLegacy(process.cwd())
+      : await this._getConfigPath(process.cwd());
     if (!this.configPath) {
       this.lintType === "global";
-      this.configContents = await io.sanitizeEslintConfig({}, false, LOG);
+      this.configContents = this.isESLintLegacy
+        ? await io.sanitizeEslintConfigLegacy({}, false, LOG)
+        : await io.sanitizeEslintConfig({}, false, LOG);
     } else {
-      const configContents = await io.readEslintConfig(this.configPath);
-      this.configContents = await io.sanitizeEslintConfig(configContents, false, LOG);
-      if (this.configContents) {
-        if ("extends" in this.configContents) {
-          this.extendsPlugin = checks.hasEslintConfigContent(
-            this.configContents,
-            "extends"
-          );
-          if (this.extendsPlugin) {
-            this.lintType = "local";
-            try {
-              this.pluginPath = require.resolve("@sap/eslint-plugin-cds", {
-                paths: [path.dirname(this.configPath)],
-              });
-              this.pluginApi = require(this.pluginPath.replace("index.js", "api"));
-            } catch (err) {
-              // CLI will report (no locally installed plugin)
+      const configContents = this.isESLintLegacy
+        ? await io.readEslintConfigLegacy(this.configPath)
+        : await io.readEslintConfig(this.configPath);
+      this.configContents = configContents;
+      if (this.isESLintLegacy) {
+        this.configContents = await io.sanitizeEslintConfig(configContents, false, LOG);
+        if (this.configContents) {
+          if ("extends" in this.configContents) {
+            this.extendsPlugin = checks.hasEslintConfigContent(
+              this.configContents,
+              "extends"
+            );
+            if (this.extendsPlugin) {
+              this.lintType = "local";
+              try {
+                this.pluginPath = require.resolve("@sap/eslint-plugin-cds", {
+                  paths: [path.dirname(this.configPath)],
+                });
+                this.pluginApi = require(this.pluginPath.replace("index.js", "api"));
+              } catch (err) {
+                // CLI will report (no locally installed plugin)
+              }
             }
           }
         }
+      } else {
+        const cdsConfig = configContents?.filter(c => c.files?.includes("*.cds"))[0] ?? {}
+        this.configContents = cdsConfig.files
+          ? {
+            ...cdsConfig.plugins.configs?.recommended,
+            languageOptions: cdsConfig.languageOptions,
+            files: cdsConfig.files,
+            rules: cdsConfig.rules,
+          }
+          : {};
       }
     }
     if (!this.pluginPath) {
@@ -281,17 +341,20 @@ class Linter {
         // CLI will report (no globally installed plugin)
       }
     }
-    return;
+    LOG?.(`Lint type: ${this.lintType}`);
+    LOG?.(`ESLint CDS plugin resolved: ${this.pluginPath}`);
   }
 
   async _overwriteRuleSeverities() {
     let configContents = {};
     if (this.configPath) {
-      configContents = await io.readEslintConfig(this.configPath);
+      configContents = await io.readEslintConfigLegacy(this.configPath);
     } else {
-      configContents = await io.readEslintConfig(await this._getConfigPath(this.cdsdkPath));
+      configContents = this.isESLintLegacy
+        ? await io.readEslintConfigLegacy(await this._getConfigPath(this.cdsdkPath))
+        : await io.readEslintConfig(await this._getConfigPath(this.cdsdkPath));
     }
-    let rules = configContents.rules;
+    let rules = configContents?.rules || {};
     // Allow recommended plugin rules in cds-dk to be overwritten
     // by user by adding rule to cmd line (because of precedence)
     const pluginRules = require(this.pluginPath).configs.recommended.rules;
@@ -305,7 +368,22 @@ class Linter {
         }
       }
     }
-    return;
+  }
+
+  async _loadEslint(currentDir) {
+    const { loadESLint, ESLint } = require("eslint");
+    const DefaultESLint = loadESLint
+      ? await loadESLint({ cwd: currentDir }) // ESLint 9
+      : new ESLint({ cwd: currentDir }) // ESLint 8
+    return DefaultESLint;
+  }
+
+  safeRequire(module) {
+    try {
+      return require(module)
+    } catch (e) {
+      return {}
+    }
   }
 }
 

package/lib/lint/checks.js

@@ -7,7 +7,7 @@ const IS_WIN = os.platform() === "win32";
 
 module.exports = {
   /**
-   * Checks whether ESLint v>=7 is installed by trying to resolve
+   * Checks whether ESLint v>=8 is installed by trying to resolve
    * 'eslint' module from (1) <inputPath> or (2) global npm path
    * @param {*} inputPath where to resolve 'eslint' module from
    * @param {*} globalPath resolves 'eslint' module from cds-dk
@@ -23,14 +23,14 @@ module.exports = {
         paths: [inputPath, globalPath],
       });
       const packageJson = require(eslintPath);
-      if (packageJson.version > "7") {
+      if (packageJson.version >= "8") {
         version = packageJson.version;
       } else {
         errMessage =
-          `ESLint v>=6.0.0 required!\n\n` +
+          `ESLint v>=8.0.0 required!\n\n` +
           `   Make sure to update and check for any breaking changes:\n` +
           `   ${term.warn(
-            "https://eslint.org/docs/user-guide/migrating-to-6.0.0"
+            "https://eslint.org/docs/user-guide/migrating-to-8.0.0"
           )}\n`;
       }
       const bin = packageJson.bin.eslint;
@@ -53,7 +53,6 @@ module.exports = {
     if (logger) {
       logger.error(errMessage);
     }
-    return;
   },
 
   /**
@@ -132,5 +131,5 @@ module.exports = {
       // Do nothing
     }
     return false;
-  },
+  }
 };

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);
     }
 }