@sap/cds-dk 4.9.7 → 6.0.1

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

@@ -21,22 +21,22 @@ module.exports = class MtaTemplate extends TemplateBase {
         if (projectDescriptor.cap.hasApprouter) {
             const ApprouterTemplate = require(`../approuter`)
             const template = new ApprouterTemplate(this.projectPath, this.generator)
-            await template.runMTAMerging()
+            await template.runDependentMerging()
         }
         if (projectDescriptor.cap.hasHana) {
             const HanaTemplate = require(`../hana`)
             const template = new HanaTemplate(this.projectPath, this.generator)
-            await template.runMTAMerging()
+            await template.runDependentMerging()
         }
         if (projectDescriptor.cap.hasXsuaa) {
             const XsuaaTemplate = require(`../xsuaa`)
             const template = new XsuaaTemplate(this.projectPath, this.generator)
-            await template.runMTAMerging()
+            await template.runDependentMerging()
         }
         if (projectDescriptor.cap.isMultitenant) {
             const MtxTemplate = require(`../mtx`)
             const template = new MtxTemplate(this.projectPath, this.generator)
-            await template.runMTAMerging()
+            await template.runDependentMerging()
         }
     }
 };

package/lib/init/template/mtx/files/java/package.json

@@ -1,20 +1,20 @@
 {
   "name": "cap-mtx-sidecar",
   "dependencies": {
-    "@sap/cds": "^5.4.3",
-    "@sap/cds-mtx": "^2.2.0",
-    "@sap/hdi-deploy": "^4.3.0",
-    "@sap/instance-manager": "^3.0.0",
-    "@sap/xssec": "^3",
-    "@sap/hana-client": "^2.8.16",
-    "express": "^4.17.1",
-    "passport": "^0.5.0"
+    "@sap/cds": "^6.0.0",
+    "@sap/cds-mtx": "^2.5.6",
+    "@sap/hdi-deploy": "^4.3.3",
+    "@sap/instance-manager": "^3.3.3",
+    "@sap/xssec": "^3.2.13",
+    "@sap/hana-client": "^2.12.25",
+    "express": "^4.18.1",
+    "passport": "^0.6.0"
   },
   "scripts": {
     "start": "node server.js"
   },
   "engines": {
-    "node": ">=12.18"
+    "node": "^16.15.0"
   },
   "cds": {
     "features": {

package/lib/init/template/mtx/files/mta.yaml.hbs

@@ -3,11 +3,6 @@ modules:
   - name: {{cap.appName}}-srv
     type: {{cap.pLanguage}}
     path: {{& cap.srv.path}}
-{{#cap.isNodejs}}
-    properties:
-      SUBSCRIPTION_URL: ${protocol}://\${tenant_subdomain}-${default-uri}
-      SUBSCRIPTION_URL_REPLACEMENT_RULES: [['-srv', '']]
-{{/cap.isNodejs}}
     requires:
       - name: {{cap.appName}}-registry
 {{#cap.isJava}}
@@ -19,11 +14,9 @@ modules:
       - name: srv-api # required by consumers of CAP services (e.g. approuter)
         properties:
           srv-url: ${default-url}
-{{#cap.isNodejs}}
       - name: mtx-api # potentially required by approuter
         properties:
           mtx-url: ${default-url}
-{{/cap.isNodejs}}
 
 {{#cap.isJava}}
   - name: {{cap.appName}}-mtx-sidecar

package/lib/init/template/mtx/files/xs-security.json.hbs

@@ -1,27 +1,27 @@
 {
   "scopes": [
     {
-      "name": "$XSAPPNAME.ExtendCDS",
-      "description": "Extend CDS applications"
+      "name": "$XSAPPNAME.mtcallback",
+      "description": "Subscribe to applications",
+      "grant-as-authority-to-apps": [
+        "$XSAPPNAME(application,sap-provisioning,tenant-onboarding)"
+      ]
     },
     {
-      "name": "$XSAPPNAME.ExtendCDSdelete",
-      "description": "Extend CDS applications with undeployments"
+      "name": "$XSAPPNAME.mtdeployment",
+      "description": "Deploy applications"
     },
     {
       "name": "$XSAPPNAME.MtxDiagnose",
       "description": "Diagnose MTX"
     },
     {
-      "name": "$XSAPPNAME.mtdeployment",
-      "description": "Deploy applications"
+      "name": "$XSAPPNAME.ExtendCDS",
+      "description": "Extend CDS applications"
     },
     {
-      "name": "$XSAPPNAME.mtcallback",
-      "description": "Subscribe to applications",
-      "grant-as-authority-to-apps": [
-        "$XSAPPNAME(application,sap-provisioning,tenant-onboarding)"
-      ]
+      "name": "$XSAPPNAME.ExtendCDSdelete",
+      "description": "Extend CDS applications with undeployments"
     }
   ],
   "authorities": [
@@ -30,15 +30,6 @@
     "$XSAPPNAME.mtcallback"
   ],
   "role-templates": [
-    {
-      "name": "MultitenancyAdministrator",
-      "description": "Administrate multitenant applications",
-      "scope-references": [
-        "$XSAPPNAME.MtxDiagnose",
-        "$XSAPPNAME.mtdeployment",
-        "$XSAPPNAME.mtcallback"
-      ]
-    },
     {
       "name": "ExtensionDeveloper",
       "description": "Extend application",

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

@@ -1,4 +1,4 @@
-const cds = require ('@sap/cds/lib'), { fs, path } = cds.utils
+const cds = require('../../../cds'), { fs, path } = cds.utils
 const TemplateBase = require('../templateBase')
 const ProjectReader = require('../../util/projectReader')
 const { OPTION_HANA, OPTION_XSUAA } = require('../../constants')
@@ -20,57 +20,57 @@ module.exports = class MtxTemplate extends TemplateBase {
         return [OPTION_HANA, OPTION_XSUAA]
     }
 
-    async runMTAMerging() {
+    async runDependentMerging() {
         const projectDescriptor = await this.projectReader.read()
 
-        const mtaYAMLPath = path.join(this.projectPath, 'mta.yaml');
+        const mtaYAMLPath = path.join(this.projectPath, 'mta.yaml')
 
-        if (!fs.existsSync(mtaYAMLPath)) return
+        if (fs.existsSync(mtaYAMLPath)) {
+            const mergingRules = projectDescriptor.cap.isNodejs ?
+                {
+                    existences: [srvNode, saasRegistry, providedMtxAPI, xsuaa],
+                    overwrites: [{
+                        in: xsuaa,
+                        keyPath: ["parameters", "config", "tenant-mode"],
+                        replacement: "shared"
+                    }],
+                    relationships: [{
+                        in: srvNode,
+                        inKeyPath: ["requires"],
+                        into: "name",
+                        existences: [saasRegistry],
+                        existenceKeyPath: ["name"],
+                    }],
+                }
+                :
+                {
+                    existences: [srvJava, srvAPI, mtxSidecar, xsuaa, saasRegistry, providedMtxAPI, providedMtxSidecarAPI, requiredMtxSidecarAPI],
+                    overwrites: [{
+                        in: xsuaa,
+                        keyPath: ["parameters", "config", "tenant-mode"],
+                        replacement: "shared"
+                    }],
+                    relationships: [{
+                        in: srvJava,
+                        inKeyPath: ["requires"],
+                        into: "name",
+                        existences: [saasRegistry],
+                        existenceKeyPath: ["name"],
+                    }],
+                }
 
-        const mergingRules = projectDescriptor.cap.isNodejs ?
-        {
-            existences: [srvNode, saasRegistry, providedMtxAPI, xsuaa],
-            overwrites: [{
-                in: xsuaa,
-                keyPath: ["parameters", "config", "tenant-mode"],
-                replacement: "shared"
-            }],
-            relationships: [{
-                in: srvNode,
-                inKeyPath: ["requires"],
-                into: "name",
-                existences: [saasRegistry],
-                existenceKeyPath: ["name"],
-            }],
-        }
-        :
-        {
-            existences: [srvJava, srvAPI, mtxSidecar, xsuaa, saasRegistry, providedMtxSidecarAPI, requiredMtxSidecarAPI],
-            overwrites: [{
-                in: xsuaa,
-                keyPath: ["parameters", "config", "tenant-mode"],
-                replacement: "shared"
-            }],
-            relationships: [{
-                in: srvJava,
-                inKeyPath: ["requires"],
-                into: "name",
-                existences: [saasRegistry],
-                existenceKeyPath: ["name"],
-            }],
+            await this.templateUtil.mergeYAML(
+                mtaYAMLPath,
+                path.join(__dirname, `files`, `mta.yaml.hbs`),
+                projectDescriptor,
+                mergingRules
+            )
         }
 
-        await this.templateUtil.mergeYAML(
-            mtaYAMLPath,
-            path.join(__dirname, `files`, `mta.yaml.hbs`),
-            projectDescriptor,
-            mergingRules
-        )
-
         if (projectDescriptor.cap.hasApprouter) {
             const ApprouterTemplate = require(`../approuter`)
             const template = new ApprouterTemplate(this.projectPath, this.generator)
-            await template.runMTAMerging()
+            await template.runDependentMerging()
         }
     }
 
@@ -82,25 +82,25 @@ module.exports = class MtxTemplate extends TemplateBase {
             projectDescriptor,
             {
                 existences: [{
-                    ref: "scope-diagnose",
+                    ref: "scope-subscription",
                     keyPath: ["scopes"],
                     constraints: [{
                         comparisonKeyPath: ["name"],
-                        value: "$XSAPPNAME.MtxDiagnose"
+                        value: "$XSAPPNAME.mtcallback"
                     }],
                 }, {
-                    ref: "scope-subscription",
+                    ref: "scope-update",
                     keyPath: ["scopes"],
                     constraints: [{
                         comparisonKeyPath: ["name"],
-                        value: "$XSAPPNAME.mtcallback"
+                        value: "$XSAPPNAME.mtdeployment"
                     }],
                 }, {
-                    ref: "scope-update",
+                    ref: "scope-diagnose",
                     keyPath: ["scopes"],
                     constraints: [{
                         comparisonKeyPath: ["name"],
-                        value: "$XSAPPNAME.mtdeployment"
+                        value: "$XSAPPNAME.MtxDiagnose"
                     }],
                 }, {
                     ref: "scope-extend",
@@ -116,13 +116,6 @@ module.exports = class MtxTemplate extends TemplateBase {
                         comparisonKeyPath: ["name"],
                         value: "$XSAPPNAME.ExtendCDSdelete"
                     }],
-                }, {
-                    ref: "template-mt-administrator",
-                    keyPath: ["role-templates"],
-                    constraints: [{
-                        comparisonKeyPath: ["name"],
-                        value: "MultitenancyAdministrator"
-                    }],
                 }, {
                     ref: "template-extension-developer",
                     keyPath: ["role-templates"],
@@ -156,6 +149,6 @@ module.exports = class MtxTemplate extends TemplateBase {
             await fs.copy(path.join(__dirname, 'files', 'java'), path.join(this.projectPath, 'mtx-sidecar'))
         }
         await this.runXSSecurityMerging()
-        await this.runMTAMerging()
+        await this.runDependentMerging()
     }
 }

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

@@ -6,11 +6,11 @@
   "license": "UNLICENSED",
   "private": true,
   "dependencies": {
-    "@sap/cds": "^5",
+    "@sap/cds": ">=5",
     "express": "^4"
   },
   "devDependencies": {
-    "sqlite3": "^5.0.2"
+    "sqlite3": "^5.0.4"
   },
   "scripts": {
     "start": "cds run"

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

@@ -358,6 +358,8 @@ module.exports = class NotebookTemplate extends TemplateBase {
     }
 
     async checkEnabled() {
+        this.logger.warn('There is a new generation of notebooks. Find out more about the new VS Code based CAP Notebooks on https://cap.cloud.sap/docs/releases/jun22#vs-code-cap-notebooks.');
+        this.logger.log();
         return true;
     }
 

package/lib/init/template/templateBase.js

@@ -10,10 +10,11 @@ module.exports = class TemplateBase {
     /**
      * @constructor
      */
-    constructor(projectPath, generator, dirName) {
+    constructor(projectPath, generator, dirName, dontAnnounce) {
         if (generator.options && generator.options.for && typeof generator.options.for !== 'string') {
             throw new Error('The --for argument must not be empty.')
         }
+        this.projectPath = path.resolve(projectPath);
         this.options = generator.options || {};
         this.projectPath = path.resolve(projectPath);
         this.fsUtil = generator.fsUtil;
@@ -21,7 +22,8 @@ module.exports = class TemplateBase {
         this.generator = generator;
 
         this.cwd = this.options.cwd || process.cwd();
-        this.name = this.constructor.name.replace(/template/i, '').toLowerCase();
+        this.name = (dirName ? path.basename(dirName) : this.constructor.name.replace(/template/i, '').toLowerCase());
+        this.dontAnnounce = dontAnnounce;
 
         this.projectName = path.basename(this.projectPath);
         this.templateUtil = new TemplateUtil(path.join(dirName, 'files'), this.fsUtil);
@@ -70,9 +72,9 @@ module.exports = class TemplateBase {
      * want any other steps from the hana template performed (e.g. creating the .hdiconfig).
      * Separating the two let's us run this _only_ the merging part of the template.
      */
-     async runMTAMerging() {
+    async runDependentMerging() {
 
-     }
+    }
 
     /**
      * @abstract

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

@@ -3,7 +3,7 @@ const path = require('path')
 const TemplateBase = require('../templateBase')
 const ProjectReader = require('../../util/projectReader')
 const { srvNode, srvJava, xsuaa } = require('../_merging/existences')
-const { PROJECT_TYPE } = require('../../constants');
+const { PROJECT_TYPE, OPTION_HELM_UPDATE } = require('../../constants');
 
 module.exports = class XsuaaTemplate extends TemplateBase {
     constructor(projectPath, generator) {
@@ -11,7 +11,7 @@ module.exports = class XsuaaTemplate extends TemplateBase {
         this.projectReader = new ProjectReader(this)
     }
 
-    async runMTAMerging() {
+    async runDependentMerging() {
         const projectDescriptor = await this.projectReader.read(this.options)
         const { projectPath } = this
 
@@ -41,7 +41,7 @@ module.exports = class XsuaaTemplate extends TemplateBase {
         if (projectDescriptor.cap.isMultitenant) {
             const MtxTemplate = require(`../mtx`)
             const mtxTemplate = new MtxTemplate(this.projectPath, this.generator)
-            await mtxTemplate.runMTAMerging()
+            await mtxTemplate.runDependentMerging()
         }
     }
 
@@ -74,7 +74,7 @@ module.exports = class XsuaaTemplate extends TemplateBase {
             const models = await cds.load(path.join(projectPath, cds.env.folders.srv))
             return cds.compile.to.xsuaa(models)
         } catch (error) { /* ignore */ }
-        })() || { scopes: [], attributes: [], 'role-templates': [] }
+        })() || { scopes: [], attributes: [], 'role-templates': [], 'authorities-inheritance': false }
 
         const mergingSemantics = { existences: xsuaa.scopes.map(scope => ({
             ref: scope.name,
@@ -86,6 +86,10 @@ module.exports = class XsuaaTemplate extends TemplateBase {
         }))}
         const xsSecurityPath = path.join(projectPath, 'xs-security.json')
         await this.templateUtil.mergeJSON(xsSecurityPath, xsuaa, projectDescriptor, mergingSemantics)
-        await this.runMTAMerging()
+        await this.runDependentMerging()
+    }
+
+    async getDependencies() {
+        return [OPTION_HELM_UPDATE];
     }
 }

package/lib/init/util/fsUtil.js

@@ -1,7 +1,7 @@
 const fs = require('fs').promises;
 const path = require('path');
 
-const {fse, yaml} = require('@sap/cds-foss')
+const {yaml} = require('@sap/cds-foss')
 const JSONC = require('../../util/jsonc');
 
 const UTF_8 = 'utf-8';
@@ -20,14 +20,13 @@ module.exports = class FsUtil {
         if (!skipFileLog) {
             this._addTouchedFile(filepath);
         }
-        await fse.outputFile(filepath, content, UTF_8);
+        await fs.mkdir(path.dirname(filepath), { recursive: true })
+        await fs.writeFile(filepath, content, UTF_8);
     }
 
     async writeJSON(filepath, object, options = { spaces: 2 }, skipFileLog = false) {
-        if (!skipFileLog) {
-            this._addTouchedFile(filepath);
-        }
-        await fse.outputJSON(filepath, object, options);
+        const content = JSON.stringify(object, null, options.spaces)
+        await this.writeFile(filepath, content, skipFileLog)
     }
 
     async writeYAML(filepath, yaml, skipFileLog = false) {
@@ -45,7 +44,7 @@ module.exports = class FsUtil {
             const renderedFile = Mustache.render(file, projectDescriptor);
             return JSON.parse(renderedFile);
         }
-        return await fse.readJSON(src);
+        return JSON.parse(file)
     }
 
     async readJSONC(src) {
@@ -63,15 +62,20 @@ module.exports = class FsUtil {
         return yaml.parseDocument(file);
     }
 
+    // eslint-disable-next-line no-unused-vars
     async copy(source, destination, options = {}, skipFileLog = false) {
         if (!skipFileLog) {
             this._addTouchedFile(destination);
         }
-        await fse.copy(source, destination, options);
+        if (fs.cp) { // Node.js >= 16.7
+            await fs.cp(source, destination, { recursive: true })
+        } else {
+            await _copy(source, destination);
+        }
     }
 
     async pathExists(filePath) {
-        return await fse.pathExists(filePath);
+        return fs.access(filePath).then(() => true).catch(() => false)
     }
 
     async readdir(filePath) {
@@ -83,7 +87,7 @@ module.exports = class FsUtil {
     }
 
     async mkdirp(folderPath) {
-        await fse.mkdirp(folderPath);
+        await fs.mkdir(folderPath, { recursive: true });
     }
 
     async stat(filePath) {
@@ -104,3 +108,14 @@ module.exports = class FsUtil {
         this.touchedFiles.add(relativeFilepath);
     }
 }
+
+// Polyfill for Node.14: asynchronously copies the entire content from src to dest.
+async function _copy(src, dest) {
+    if ((await fs.stat(src)).isDirectory()) {
+        const entries = await fs.readdir(src)
+        return Promise.all(entries.map(async each => _copy(path.join(src, each), path.join(dest, each))))
+    } else {
+        await fs.mkdir(path.dirname(dest), { recursive: true })
+        return fs.copyFile(src, dest)
+    }
+}

package/lib/init/util/logger.js

@@ -1,7 +1,7 @@
 /* eslint no-console: 0 */
 
 const term = require('../../util/term');
-const cds = require('@sap/cds/lib');
+const cds = require('../../cds');
 const LOG = cds.log ? cds.log('init') : console;
 
 const defaultLogger = {

package/lib/init/util/mvnArchetypeUtil.js

@@ -12,7 +12,7 @@ class MvnArchetypeUtil {
         // need to create new regex every call since a constant
         // would keep the match state
 
-        var quoteRegex = /([\w\-.]+)=([\w\-.]+|\[([\w.\-,]+)\])/g;
+        const quoteRegex = /([\w\-.]+)=([\w\-.]+|\[([\w.\-,]+)\])/g;
         // captures a=1         => a:1
         //          -Da=[x,y,z] => -Da:x,y,z (Maven specific)
         //          a=[x,y,z]   => a:x,y,z
@@ -35,14 +35,7 @@ class MvnArchetypeUtil {
             params.set('-X'); params.set('-e');
         }
 
-        return Array.from(params, (e) => {
-            let result = e[0];
-            // ignore if null/undefined but write "false" and "0"
-            if (e[1] != undefined) {
-                result = result + `=${e[1]}`;
-            }
-            return result;
-        });
+        return Array.from(params, ([arg, val]) => val !== null && val !== undefined ? `${arg}=${val}` : arg)
     }
 
     getAddSamplesCmdArgs(options) {
@@ -129,7 +122,7 @@ class MvnArchetypeUtil {
 
         const packageFromParam = params.get(`-Dpackage`);
         if (packageFromParam) {
-            // explicitely specified, so do not modify
+            // explicitly specified, so do not modify
             if (!options.force && !packageFromParam.match(REGEX_JAVA_PACKAGE)) {
                 throw new Error(`Package '${packageFromParam}' is an invalid Java package name. Use --force to use it anyway.`);
             }
@@ -147,6 +140,7 @@ class MvnArchetypeUtil {
 
         return {
             cmdLine: this._finalize(params),
+            archetypeVersion: params.get('-DarchetypeVersion'),
             artifactId
         };
     }

package/lib/init/util/projectReader.js

@@ -5,11 +5,14 @@ const { fs } = require('@sap/cds/lib/utils')
 const P_LANGUAGE_JAVA = 'java'
 const P_LANGUAGE_NODEJS = 'nodejs'
 const DEFAULT_P_LANGUAGE = P_LANGUAGE_NODEJS
-const BUILD_TASK_JAVA = "java-cf"
-const BUILD_TASK_NODE = "node-cf"
+const BUILD_TASK_JAVA = "java"
+const BUILD_TASK_JAVA_CF = "java-cf"
+const BUILD_TASK_NODEJS = "nodejs"
+const BUILD_TASK_NODE_CF = "node-cf"
 const BUILD_TASK_HANA = "hana"
 const BUILD_TASK_FIORI = "fiori"
 const BUILD_TASK_MTX = "mtx"
+const BUILD_TASK_MTX_SIDECAR = "mtx-sidecar"
 
 module.exports = class ProjectReader {
 
@@ -86,10 +89,10 @@ module.exports = class ProjectReader {
                 return this.db.length > 0
             },
             get hasHana() {
-                return this.requires.some(({resource}) => resource.isHana)
+                return this.requires.some(({ resource }) => resource.isHana)
             },
             get hasXsuaa() {
-                return this.requires.some(({resource}) => resource.isXsuaa)
+                return this.requires.some(({ resource }) => resource.isXsuaa)
             },
             get needsSidecar() {
                 return (options && options.add.has('hana') || this.db.length > 0) && (this.isJava || !this.isMultitenant)
@@ -100,8 +103,9 @@ module.exports = class ProjectReader {
         }
 
         // setting the effective env as it might have changed by already executed 'add' commands, e.g. cds init foo --add hana,mta
-        const cds = require('@sap/cds/lib')
-        cds.env = env;
+        const cds = require('../../cds')
+        cds.env // make sure env is initialized, otherwise we cannot set it (exotic case)
+        cds.env = env
 
         const buildTasks = await new BuildTaskFactory(this.logger.isDebug ? this.logger : nullLogger, cds).getTasks({ root: this.projectPath, resolve: true, mta: false })
 
@@ -117,6 +121,7 @@ module.exports = class ProjectReader {
                     break
 
                 case BUILD_TASK_JAVA:
+                case BUILD_TASK_JAVA_CF:
                     capDescriptor.pLanguage = P_LANGUAGE_JAVA
                     capDescriptor.srv = {
                         path: relDestPath,
@@ -125,7 +130,8 @@ module.exports = class ProjectReader {
                     }
                     break
 
-                case BUILD_TASK_NODE:
+                case BUILD_TASK_NODEJS:
+                case BUILD_TASK_NODE_CF:
                     capDescriptor.srv = {
                         path: relDestPath,
                         name: path.basename(task.src)
@@ -134,6 +140,7 @@ module.exports = class ProjectReader {
 
                 case BUILD_TASK_FIORI:
                 case BUILD_TASK_MTX:
+                case BUILD_TASK_MTX_SIDECAR:
                     break
 
                 default:
@@ -159,7 +166,8 @@ module.exports = class ProjectReader {
         // by default spring-boot:repackage is used creating an executable jar archive
         const pomJson = await this._parseXml(path.join(task.src, 'pom.xml'))
         if (pomJson) {
-            if (this.template.name === "manifest" && this._isOldJavaRuntime(pomJson)) {
+            // cannot use 'instanceof ManifestTemplate' since ManifestTemplate requires projectReader -> cycle created
+            if (this.template.constructor.name === 'ManifestTemplate' && this._isOldJavaRuntime(pomJson)) {
                 throw new Error("Projects using the classic CAP Java SDK are not supported")
             }