@sap/cds-dk 4.9.5 → 6.0.1

package/lib/init/template/_merging/existences.js

@@ -27,8 +27,7 @@ const approuter = {
     constraints: [{
         comparisonKeyPath: ["type"],
         value: "approuter.nodejs"
-    }],
-    spaceBefore: true
+    }]
 }
 
 const xsuaa = {
@@ -43,8 +42,7 @@ const xsuaa = {
     }, {
         comparisonKeyPath: ["parameters", "service-plan"],
         value: "application"
-    }],
-    spaceBefore: true
+    }]
 }
 
 const auditlog = {
@@ -56,8 +54,7 @@ const auditlog = {
     }, {
         comparisonKeyPath: ["parameters", "service"],
         value: "auditlog-api",
-    }],
-    spaceBefore: true
+    }]
 }
 
 const kibanaLogging = {
@@ -72,8 +69,7 @@ const kibanaLogging = {
     }, {
         comparisonKeyPath: ["parameters", "service-plan"],
         value: "lite",
-    }],
-    spaceBefore: true
+    }]
 }
 
 const hdbDeployer = {
@@ -82,8 +78,7 @@ const hdbDeployer = {
     constraints: [{
         comparisonKeyPath: ["type"],
         value: "hdb"
-    }],
-    spaceBefore: true
+    }]
 }
 
 const hdiContainer = {
@@ -92,8 +87,7 @@ const hdiContainer = {
     constraints: [{
         comparisonKeyPath: ["type"],
         value: "com.sap.xs.hdi-container",
-    }],
-    spaceBefore: true
+    }]
 }
 
 const serviceManager = {
@@ -108,8 +102,7 @@ const serviceManager = {
     }, {
         comparisonKeyPath: ["parameters", "service-plan"],
         value: "container"
-    }],
-    spaceBefore: true
+    }]
 }
 
 const saasRegistry = {
@@ -124,8 +117,7 @@ const saasRegistry = {
     }, {
         comparisonKeyPath: ["parameters", "service-plan"],
         value: "application"
-    }],
-    spaceBefore: true
+    }]
 }
 
 const srvAPI = {
@@ -146,8 +138,7 @@ const mtxSidecar = {
     constraints: [{
         comparisonKeyPath: ["type"],
         value: `nodejs`
-    }],
-    spaceBefore: true
+    }]
 }
 
 const providedMtxAPI = {
@@ -175,6 +166,35 @@ const requiredMtxAPI = {
     }]
 }
 
+const providedAppAPI = {
+    ref: "provided-app-api",
+    in: approuter,
+    keyPath: ["provides"],
+    constraints: [{
+        comparisonKeyPath: ["name"],
+        value: "app-api"
+    }, {
+        comparisonKeyPath: ["properties", "app-protocol"],
+        value: "${protocol}"
+    }, {
+        comparisonKeyPath: ["properties", "app-uri"],
+        value: "${default-uri}"
+    }],
+}
+
+const requiredAppAPI = {
+    ref: "required-app-api",
+    in: srvNode,
+    keyPath: ["requires"],
+    constraints: [{
+        comparisonKeyPath: ["name"],
+        value: "app-api"
+    }, {
+        comparisonKeyPath: ["properties", "SUBSCRIPTION_URL"],
+        value: "~{app-protocol}://\\${tenant_subdomain}-~{app-uri}"
+    }]
+}
+
 const providedMtxSidecarAPI = {
     ref: "provided-mtx-sidecar-api",
     in: mtxSidecar,
@@ -215,6 +235,42 @@ const providedJavaApprouterAPI = {
     }]
 }
 
+const approuterExtensibility = {
+    ref: "approuter-extensibility",
+    keyPath: ["routes"],
+    constraints: [{
+        comparisonKeyPath: ["source"],
+        value: "^/extend/(.*)"
+    }, {
+        comparisonKeyPath: ["destination"],
+        value: "mtx-api",
+    }, {
+        comparisonKeyPath: ["target"],
+        value: "$1",
+    }, {
+        comparisonKeyPath: ["authenticationType"],
+        value: "none",
+    }]
+}
+
+const approuterExtensibilityJava = {
+    ref: "approuter-extensibility-java",
+    keyPath: ["routes"],
+    constraints: [{
+        comparisonKeyPath: ["source"],
+        value: "^/extend/(.*)"
+    }, {
+        comparisonKeyPath: ["destination"],
+        value: "mtx-api",
+    }, {
+        comparisonKeyPath: ["target"],
+        value: "$1",
+    }, {
+        comparisonKeyPath: ["authenticationType"],
+        value: "none",
+    }]
+}
+
 module.exports = {
     srvNode,
     srvJava,
@@ -231,7 +287,11 @@ module.exports = {
     requiredMtxAPI,
     providedMtxSidecarAPI,
     requiredMtxSidecarAPI,
+    providedAppAPI,
+    requiredAppAPI,
     requiredJavaApprouterAPI,
     providedJavaApprouterAPI,
-    kibanaLogging
+    kibanaLogging,
+    approuterExtensibility,
+    approuterExtensibilityJava
 }

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

@@ -10,6 +10,13 @@ modules:
     {{/cap.isJava}}
     requires:
       - name: {{cap.appName}}-auth
+    {{#cap.isNodejs}}
+    {{#cap.isMultitenant}}
+      - name: app-api
+        properties:
+          SUBSCRIPTION_URL: ~{app-protocol}://\${tenant_subdomain}-~{app-uri}
+    {{/cap.isMultitenant}}
+    {{/cap.isNodejs}}
     {{#cap.isJava}}
       - name: app-api
         properties:
@@ -35,14 +42,21 @@ modules:
           url: ~{srv-url}
           forwardAuthToken: true
       {{#cap.isMultitenant}}
-      {{#cap.isNodejs}}
       - name: mtx-api
         group: destinations
         properties:
           name: mtx-api # must be used in xs-app.json as well
           url: ~{mtx-url}
-      {{/cap.isNodejs}}
       {{/cap.isMultitenant}}
+    {{#cap.isMultitenant}}
+    {{#cap.isNodejs}}
+    provides:
+      - name: app-api
+        properties:
+          app-protocol: ${protocol}
+          app-uri: ${default-uri}
+    {{/cap.isNodejs}}
+    {{/cap.isMultitenant}}
     {{#cap.isJava}}
     provides:
       - name: app-api
@@ -51,12 +65,12 @@ modules:
     {{/cap.isJava}}
 
 resources:
- - name: {{cap.appName}}-auth
-   type: org.cloudfoundry.managed-service
-   parameters:
-     service: xsuaa
-     service-plan: application
-     path: ./xs-security.json
-     config:
-       xsappname: {{cap.appName}}-${org}-${space}
-       tenant-mode: {{#cap.isMultitenant}}shared{{/cap.isMultitenant}}{{^cap.isMultitenant}}dedicated{{/cap.isMultitenant}}
+  - name: {{cap.appName}}-auth
+    type: org.cloudfoundry.managed-service
+    parameters:
+      service: xsuaa
+      service-plan: application
+      path: ./xs-security.json
+      config:
+        xsappname: {{cap.appName}}-${org}-${space}
+        tenant-mode: {{#cap.isMultitenant}}shared{{/cap.isMultitenant}}{{^cap.isMultitenant}}dedicated{{/cap.isMultitenant}}

package/lib/init/template/approuter/files/package.json

@@ -1,7 +1,7 @@
 {
   "name": "approuter",
   "dependencies": {
-    "@sap/approuter": "^10"
+    "@sap/approuter": "^11.0.0"
   },
   "engines": {
     "node": "^16"

package/lib/init/template/approuter/files/xs-app.json.hbs

@@ -14,6 +14,13 @@
       "destination": "srv-api",
       "authenticationType": "xsuaa",
       "csrfProtection": true
+    }{{#cap.isMultitenant}},
+    {
+      "source": "^/extend/(.*)",
+      "destination": "mtx-api",
+      "target": "$1",
+      "authenticationType": "none"
     }
+    {{/cap.isMultitenant}}
   ]
 }

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

@@ -1,78 +1,85 @@
-const fs = require('fs');
-const { join } = require('path');
-const TemplateBase = require('../templateBase');
-const ProjectReader = require('../../util/projectReader');
-const { OPTION_XSUAA, PROJECT_TYPE } = require('../../constants');
+const fs = require('fs')
+const { join } = require('path')
+const TemplateBase = require('../templateBase')
+const ProjectReader = require('../../util/projectReader')
+const { OPTION_XSUAA, PROJECT_TYPE } = require('../../constants')
 const {
     srvNode, srvJava, approuter, // Modules
     xsuaa, // BTP Services
-    requiredMtxAPI, requiredJavaApprouterAPI, providedJavaApprouterAPI // APIs
-} = require('../_merging/existences');
+    requiredMtxAPI, requiredJavaApprouterAPI, providedJavaApprouterAPI, // APIs
+    requiredAppAPI, providedAppAPI,
+    approuterExtensibility, approuterExtensibilityJava // xs-app.json config
+} = require('../_merging/existences')
 
 module.exports = class ApprouterTemplate extends TemplateBase {
+
     constructor(projectPath, generator) {
-        super(projectPath, generator, __dirname);
-        this.projectReader = new ProjectReader(this);
+        super(projectPath, generator, __dirname)
+        this.projectReader = new ProjectReader(this)
     }
 
     async getDependencies() {
-        return [OPTION_XSUAA];
+        return [OPTION_XSUAA]
     }
 
-    async runMTAMerging() {
-        const projectDescriptor = await this.projectReader.read(this.options);
-        const mtaYAMLPath = join(this.projectPath, 'mta.yaml');
-        if (!fs.existsSync(mtaYAMLPath)) return;
+    async runDependentMerging() {
+        const projectDescriptor = await this.projectReader.read(this.options)
+        const mtaYAMLPath = join(this.projectPath, 'mta.yaml')
         const { isNodejs, isJava, isMultitenant } = projectDescriptor.cap
-        const srv = isNodejs ? srvNode : srvJava
-        const apis = isJava ? [requiredJavaApprouterAPI, providedJavaApprouterAPI] : []
-        if (isNodejs && isMultitenant) apis.push(requiredMtxAPI)
-        const existences = [srv, approuter, xsuaa, ...apis]
-        await this.templateUtil.mergeYAML(
-            mtaYAMLPath,
-            `${__dirname}/files/mta.yaml.hbs`,
+        if (fs.existsSync(mtaYAMLPath)) {
+            const srv = isNodejs ? srvNode : srvJava
+            const apis = isJava ? [requiredJavaApprouterAPI, providedJavaApprouterAPI] : []
+            if (isNodejs && isMultitenant) apis.push(requiredMtxAPI, requiredAppAPI, providedAppAPI)
+            if (isJava && isMultitenant) apis.push(requiredMtxAPI)
+            const existences = [srv, approuter, xsuaa, ...apis]
+            await this.templateUtil.mergeYAML(
+                mtaYAMLPath,
+                `${__dirname}/files/mta.yaml.hbs`,
+                projectDescriptor,
+                {
+                    existences,
+                    relationships: [{
+                        in: srv,
+                        inKeyPath: ["requires"],
+                        into: "name",
+                        existences: [xsuaa],
+                        existenceKeyPath: ["name"],
+                    }, {
+                        in: approuter,
+                        inKeyPath: ["requires"],
+                        into: "name",
+                        existences: [xsuaa],
+                        existenceKeyPath: ["name"],
+                    }],
+                }
+            )
+        }
+
+        const appPath = join(this.projectPath, projectDescriptor.ui.appPath || 'app')
+        const existences = isMultitenant && isJava ? [approuterExtensibilityJava] :
+                           isMultitenant && isNodejs ? [approuterExtensibility] : []
+        await this.templateUtil.mergeJSON(
+            `${appPath}/xs-app.json`,
+            `${__dirname}/files/xs-app.json.hbs`,
             projectDescriptor,
-            {
-                existences,
-                relationships: [{
-                    in: srv,
-                    inKeyPath: ["requires"],
-                    into: "name",
-                    existences: [xsuaa],
-                    existenceKeyPath: ["name"],
-                }, {
-                    in: approuter,
-                    inKeyPath: ["requires"],
-                    into: "name",
-                    existences: [xsuaa],
-                    existenceKeyPath: ["name"],
-                }],
-            }
-        );
+            { existences }
+        )
     }
 
     async run() {
-        const projectDescriptor = await this.projectReader.read(this.options);
-        const appPath = join(this.projectPath, projectDescriptor.ui.appPath || 'app');
-        const appPackageJSONPath = join(appPath, 'package.json');
-
-        await this.templateUtil.mergeJSON(appPackageJSONPath, join(__dirname, 'files', 'package.json'));
-        await this.templateUtil.sortDependencies(appPackageJSONPath);
+        const projectDescriptor = await this.projectReader.read(this.options)
+        const appPath = join(this.projectPath, projectDescriptor.ui.appPath || 'app')
+        const appPackageJSONPath = join(appPath, 'package.json')
 
-        await this.templateUtil.mergeJSON(
-            `${appPath}/xs-app.json`,
-            `${__dirname}/files/xs-app.json.hbs`,
-            projectDescriptor
-        );
+        await this.templateUtil.mergeJSON(appPackageJSONPath, join(__dirname, 'files', 'package.json'))
+        await this.templateUtil.sortDependencies(appPackageJSONPath)
 
         await this.templateUtil.mergeJSON(
             `${appPath}/default-env.json`,
             `${__dirname}/files/default-env.json`
-        );
-
-        // await this.fsUtil.copy(join(__dirname, 'files', 'index.html'), join(appPath, 'index.html'));
+        )
 
-        const projectType = await this.getProjectType();
+        const projectType = await this.getProjectType()
         switch (projectType) {
             case PROJECT_TYPE.java: {
                 const cdsrcJSONPath = join(this.projectPath, '.cdsrc.json')
@@ -90,6 +97,6 @@ module.exports = class ApprouterTemplate extends TemplateBase {
             }
         }
 
-        await this.runMTAMerging()
+        await this.runDependentMerging()
     }
 }

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

@@ -10,7 +10,7 @@ module.exports = class AuditlogTemplate extends TemplateBase {
         this.projectReader = new ProjectReader(this);
     }
 
-    async runMTAMerging() {
+    async runDependentMerging() {
         const projectDescriptor = await this.projectReader.read(this.options);
         const mtaYAMLPath = path.join(this.projectPath, 'mta.yaml');
         if (!fs.existsSync(mtaYAMLPath)) return;
@@ -33,6 +33,6 @@ module.exports = class AuditlogTemplate extends TemplateBase {
     }
 
     async run() {
-        await this.runMTAMerging()
+        await this.runDependentMerging()
     }
 }

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

@@ -1,5 +1,5 @@
 const TemplateBase = require('../templateBase');
-const cds = require('@sap/cds');
+const cds = require('../../../cds');
 const {resolve, join, relative}  = require('path');
 const fs = require('fs');
 
@@ -16,7 +16,7 @@ module.exports = class DataTemplate extends TemplateBase {
       : getDefaultTargetFolder(env, this.projectPath);
     dest = resolve(this.projectPath, dest);
 
-    const nameFilter = asRegex(this.options.for)
+    const nameFilter = asRegex(this.options['data:for'] || this.options.for)
     const force = this.options.force;
     const logger = this.logger;
 

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

@@ -16,20 +16,20 @@ modules:
 {{/cap.isMultitenant}}
 
 resources:
- - name: {{cap.appName}}-db
-{{^cap.isMultitenant}}
-   type: com.sap.xs.hdi-container
-   parameters:
-     service: hana # or 'hanatrial' on trial landscapes
-     service-plan: hdi-shared
-{{/cap.isMultitenant}}
-{{#cap.isMultitenant}} {{! enable automatic switching to 'hanatrial' on trial accounts}}
-   type: org.cloudfoundry.managed-service
-   parameters:
-     service: service-manager
-     service-plan: container
-{{/cap.isMultitenant}}
-{{#cap.isJava}}
-   properties:
-     hdi-service-name: ${service-name}
-{{/cap.isJava}}
+  - name: {{cap.appName}}-db
+    {{^cap.isMultitenant}}
+    type: com.sap.xs.hdi-container
+    parameters:
+      service: hana
+      service-plan: hdi-shared
+    {{/cap.isMultitenant}}
+    {{#cap.isMultitenant}}
+    type: org.cloudfoundry.managed-service
+    parameters:
+      service: service-manager
+      service-plan: container
+    {{/cap.isMultitenant}}
+    {{#cap.isJava}}
+    properties:
+      hdi-service-name: ${service-name}
+    {{/cap.isJava}}

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

@@ -8,7 +8,7 @@ const ProjectReader = require('../../util/projectReader');
 
 const TemplateBase = require('../templateBase');
 
-const { PROJECT_TYPE, OPTION_JAVA, URLS, KIND_HANA } = require('../../constants');
+const { PROJECT_TYPE, OPTION_JAVA, URLS, OPTION_HELM_UPDATE } = require('../../constants');
 const { nullLogger } = require('../../util/logger');
 const { srvNode, srvJava, hdbDeployer, serviceManager, hdiContainer } = require('../_merging/existences');
 
@@ -18,6 +18,10 @@ module.exports = class HanaTemplate extends TemplateBase {
         this.projectReader = new ProjectReader(this);
     }
 
+    async getDependencies() {
+        return [OPTION_HELM_UPDATE];
+    }
+
     // read env from project
     async getEnv() {
         const cdsEnvVar = process.env.CDS_ENV;
@@ -31,14 +35,14 @@ module.exports = class HanaTemplate extends TemplateBase {
 
     async checkEnabled() {
         const { lt } = require('semver')
-        const cds = require('@sap/cds/lib')
+        const cds = require('../../../cds')
         if (lt(cds.version, '5.9.0')) {
             cds.error('The added configuration requires @sap/cds 5.9.0 or higher. Please update @sap/cds to the latest version and run \x1b[1mcds add hana\x1b[0m again.')
         }
         return true
     }
 
-    async runMTAMerging() {
+    async runDependentMerging() {
         const projectDescriptor = await this.projectReader.read(this.options);
 
         const mtaYAMLPath = path.join(this.projectPath, 'mta.yaml');
@@ -118,7 +122,7 @@ module.exports = class HanaTemplate extends TemplateBase {
 
             default: break;
         }
-        await this.runMTAMerging()
+        await this.runDependentMerging()
     }
 
     async _updatePomXml() {

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

@@ -0,0 +1,39 @@
+/* eslint-disable no-unused-vars */
+/* eslint-disable no-unreachable */
+const path = require('path');
+const TemplateBase = require('../templateBase');
+const ProjectReader = require('../../util/projectReader');
+const { exec } = require('../../../k8s/util');
+const {context, addChart, hasChart } = require('../../../k8s');
+const { rimraf } = require('@sap/cds/lib').utils;
+module.exports = class HelmTemplate extends TemplateBase {
+    constructor(projectPath, generator) {
+        super(projectPath, generator, __dirname);
+        this.projectReader = new ProjectReader(this);
+    }
+
+    async checkEnabled() {
+
+        if (this.options.force) {
+            await rimraf(this.chartPath());
+            return true;
+        }
+
+        return true;
+    }
+
+    chartPath() {
+        return path.join(this.projectPath, 'chart');
+    }
+
+    async run() {
+        const PREFIX = 'helm:';
+        const features = new Set();
+        for (const option of this.options.helm && this.options.helm.values() || []) {
+            if (option.startsWith(PREFIX)) features.add(option.substr(PREFIX.length));
+        }
+
+        const project = await context(this.projectPath, features);
+        await addChart(project, path.join(this.projectPath, '/chart'));
+    }
+};

package/lib/init/template/helm/update/index.js

@@ -0,0 +1,28 @@
+/* eslint-disable no-unused-vars */
+/* eslint-disable no-unreachable */
+const path = require('path');
+const TemplateBase = require('../../templateBase');
+const ProjectReader = require('../../../util/projectReader');
+const { OPTION_HELM } = require('../../../constants');
+
+module.exports = class HelmUpdateTemplate extends TemplateBase {
+    constructor(projectPath, generator) {
+        super(projectPath, generator, __dirname, true);
+        this.projectReader = new ProjectReader(this);
+    }
+
+    async getDependencies() {
+        return [ OPTION_HELM ];
+    }
+
+    async checkEnabled() {
+        return await this.fsUtil.pathExists(this.chartPath());
+    }
+
+    chartPath() {
+        return path.join(this.projectPath, 'chart');
+    }
+
+    async run() {
+    }
+};

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

@@ -2,15 +2,12 @@ const fs = require('fs').promises;
 const os = require('os');
 const path = require('path');
 
-const { fse } = require('@sap/cds-foss');
-
-
 const commandUtil = require('../../util/commandUtil');
 const mvnArchetypeUtil = require('../../util/mvnArchetypeUtil');
 const term = require('../../../util/term');
 
 const TemplateBase = require('../templateBase');
-const { COMMAND_ADD, URLS, OPTION_JAVA, OPTION_NODEJS, MAVEN_ARCHETYPE_VERSION } = require('../../constants');
+const { COMMAND_ADD, URLS, OPTION_JAVA, OPTION_NODEJS } = require('../../constants');
 const { nullLogger } = require('../../util/logger');
 
 
@@ -32,24 +29,25 @@ module.exports = class JavaTemplate extends TemplateBase {
     }
 
     async run() {
-        this.logger.log(`Using Maven archetype version ${MAVEN_ARCHETYPE_VERSION}`);
-
         const mvnCmdArgs = mvnArchetypeUtil.getGenerateCmdArgs(this.projectName, this.options, this.logger);
+        const { cmdLine, artifactId, archetypeVersion } = mvnCmdArgs
+
+        this.logger.log(`Using Maven archetype version ${archetypeVersion}`);
 
         const tempFolder = await fs.mkdtemp(path.join(os.tmpdir(), `${this.projectName}_`));
         try {
-            await commandUtil.spawnCommand('mvn', mvnCmdArgs.cmdLine, {
+            await commandUtil.spawnCommand('mvn', cmdLine, {
                 cwd: tempFolder
             }, (this.logger.isDebug ? this.logger : nullLogger));
 
-            await this.fsUtil.copy(path.join(tempFolder, mvnCmdArgs.artifactId), this.projectPath);
+            await this.fsUtil.copy(path.join(tempFolder, artifactId), this.projectPath);
         } catch (err) {
             if (err.code === 'ENOENT' && err.path === 'mvn') {
                 throw new Error(`Maven executable 'mvn' not found, follow ${term.info(URLS.MAVEN_INSTALL_HELP)} and install Maven on your machine.`);
             }
             throw err;
         } finally {
-            await fse.remove(tempFolder);
+            await fs.rm(tempFolder, { force: true, recursive: true });
         }
     }
 

package/lib/init/template/kibana-logging/index.js

@@ -1,4 +1,4 @@
-const cds = require('@sap/cds')
+const cds = require('../../../cds')
 const fs = require('fs');
 const path = require('path');
 
@@ -15,11 +15,10 @@ module.exports = class KibanaTemplate extends TemplateBase {
         this.projectReader = new ProjectReader(this);
     }
 
-    async runMTAMerging() {
+    async runDependentMerging() {
         const mtaYAMLPath = path.join(this.projectPath, 'mta.yaml');
 
         if (!fs.existsSync(mtaYAMLPath)) {
-            console.warn(`Cannot add Kibana Logging as there is no 'mta.yaml' deploy descriptor in your project. Run 'cds add mta' to add it.`)
             return;
         }
 
@@ -45,7 +44,7 @@ module.exports = class KibanaTemplate extends TemplateBase {
 
     async run() {
         const projectType = await this.getProjectType();
-        
+
         switch (projectType) {
             case PROJECT_TYPE.java:
             default:
@@ -58,7 +57,7 @@ module.exports = class KibanaTemplate extends TemplateBase {
                 const cdsTemplatePath = path.join(__dirname, 'files', cdsTemplateFile)
                 await this.templateUtil.mergeJSON(path.join(this.projectPath, 'package.json'), cdsTemplatePath, projectDescriptor)
             }
-        }        
-        await this.runMTAMerging()
+        }
+        await this.runDependentMerging()
     }
 }