@sap/cds-dk 7.8.2 → 7.9.2

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

@@ -78,7 +78,14 @@ module.exports = class MultitenancyTemplate extends require('../../plugin') {
     }
 
     if (hasHelm || hasHelmUnifiedRuntime) {
-      await merge(__dirname, 'files/values.yaml.hbs').into('chart/values.yaml', { with: project })
+      const overwrites = hasXsuaa ? [{
+        item: [{
+          in: 'xsuaa',
+          where: { serviceOfferingName: 'xsuaa' }
+        }, 'parameters.tenant-mode'], withValue: 'shared'
+      }] : []
+      
+      await merge(__dirname, 'files/values.yaml.hbs').into('chart/values.yaml', { with: project, overwrites })
 
       const envFromObject = {
         envFrom: [{
@@ -100,11 +107,12 @@ module.exports = class MultitenancyTemplate extends require('../../plugin') {
               }
             }
           ]
-        }}).into('chart/values.yaml', { with: project })
+        }
+      }).into('chart/values.yaml', { with: project })
 
-        await removeFromYAML(join('chart', 'values.yaml'), ['srv.expose', 'srv.networkSecurity'])
-        await copy(join(__dirname, 'files', `mtxs-configmap-${isJava ? 'java' : 'nodejs'}${hasApprouter ? '-approuter' : ''}.yaml`)).to('chart', 'templates', 'mtxs-configmap.yaml') // REVISIT: Move to build task
-        await copy(join(__dirname, 'files', 'saas-registry-secret.yaml')).to('chart', 'templates', 'saas-registry-secret.yaml') // REVISIT: Move to build task
+      await removeFromYAML(join('chart', 'values.yaml'), ['srv.expose', 'srv.networkSecurity'])
+      await copy(join(__dirname, 'files', `mtxs-configmap-${isJava ? 'java' : 'nodejs'}${hasApprouter ? '-approuter' : ''}.yaml`)).to('chart', 'templates', 'mtxs-configmap.yaml') // REVISIT: Move to build task
+      await copy(join(__dirname, 'files', 'saas-registry-secret.yaml')).to('chart', 'templates', 'saas-registry-secret.yaml') // REVISIT: Move to build task
     }
 
     if (hasXsuaa) {

package/lib/init/template/nodejs/files/.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+  // uncomment entries once all libraries have been installed via 'npm install'
+  "eslint.validate": [
+    // "cds",
+    // "csn",
+    // "csv",
+    // "csv (semicolon)",
+    // "tab",
+    // "tsv"
+  ]
+}

package/lib/init/template/nodejs/files/eslint.config.js

@@ -0,0 +1,13 @@
+const cds = require('@sap/eslint-plugin-cds')
+
+module.exports = [
+  cds.configs.recommended,
+  {
+    plugins: {
+      '@sap/cds': cds
+    },
+    rules: {
+      ...cds.configs.recommended.rules
+    }
+  }
+]

package/lib/init/template/nodejs/files/package.json.hbs

@@ -10,7 +10,9 @@
     "express": "^4"
   },
   "devDependencies": {
-    "@cap-js/sqlite": "^1"
+    "@cap-js/sqlite": "^1",
+    "@sap/eslint-plugin-cds": "^3",
+    "eslint": "^9"
   },
   "scripts": {
     "start": "cds-serve"

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

@@ -1,33 +1,31 @@
 const { join } = require('path')
 const cds = require('../../../cds'), { exists, read, write, copy } = cds.utils
 const { env4, readProject } = require('../../projectReader')
+const mvn = require('../../mvn')
 
 module.exports = class SampleTemplate extends require('../../plugin') {
 
-    async canRun() {
-        const { isJava } = readProject()
-        if (isJava) throw `'cds add sample' is not available for Java yet`
-        return true
-    }
-
     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', 'srv')).to(srv),
-          copy(join(__dirname, 'files', language)).to(srv)
-        ])
-
-        await copy(join(__dirname, 'files', 'app')).to(app)
-        const { appName, appPath, appUIPaths } = readProject()
+        if (language === 'nodejs') {
+            await Promise.all([
+                copy(join(__dirname, 'files/db')).to(db),
+                copy(join(__dirname, 'files/srv')).to(srv)
+            ])
+            await 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 })
-        }))
+            // manifest.json must be unique // REVISIT: Check if relevant for `cds add sample` in Java scenario
+            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 })
+            }))
+        } else if (language === 'java') {
+            await mvn.add('sample')
+        }
     }
 }

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

@@ -11,8 +11,7 @@ module.exports = class TinySampleTemplate extends require('../../plugin') {
         const { isJava } = readProject()
         if (isJava) {
             if (!cds.cli.options.add.has(JAVA)) {
-                await mvn.execMvn(mvn.getAddSamplesCmdArgs())
-                await mvn.execMvn(mvn.getAddTestsCmdArgs())
+                await mvn.add('tiny_sample')
             }
         } else {
             const { db, srv } = env4('production').folders

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;
-  },
+  }
 };