@sap/cds-dk 6.4.0 → 6.5.0

package/lib/init/template/approuter/files/approuter-mtxs-configmap.yaml

@@ -4,6 +4,10 @@
 {{- $ := merge (dict "name" "approuter" "deployment" $deployment) . }}
 {{- $approuterUrl := (include "cap.deploymentHostFull" $ )}}
 
+
+{{- $defaultParameters :=  dict "forwardAuthToken" true }}
+{{- $destinations := dict "root" . "defaultParameters" $defaultParameters }}
+
 apiVersion: v1
 kind: ConfigMap
 metadata:
@@ -11,5 +15,5 @@ metadata:
   namespace: "{{ .Release.Namespace }}"
 data:
   destinations: >
-    {{ include "cap.approuterDestinations" . }}
+    {{ include "cap.backendDestinations" $destinations }}
   TENANT_HOST_PATTERN: {{ printf "^(.*)-%s" $approuterUrl }}

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

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

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

@@ -28,4 +28,4 @@ approuter:
       path: /
     readiness:
       path: /
-approuterDestinations: {}
+backendDestinations: {}

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

@@ -1,13 +1,13 @@
 {
   "authenticationMethod": "route",
   "routes": [
-    {{#cap.isMultitenant}}
+    {{#cap.isExtensible}}
     {
       "source": "^/-/cds/.*",
       "destination": "mtx-api",
       "authenticationType": "none"
     },
-    {{/cap.isMultitenant}}
+    {{/cap.isExtensible}}
     {
       "source": "^/app/(.*)$",
       "target": "$1",

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

@@ -35,7 +35,7 @@ module.exports = class ApprouterTemplate extends require('../templateBase') {
         await mergeJSON(appPackageJSONPath, join(__dirname, 'files', 'package.json'))
         await sortDependencies(appPackageJSONPath)
 
-        await mergeJSON(`${appPath}/default-env.json`, `${__dirname}/files/default-env.json`)
+        await mergeJSON(join(appPath, 'default-env.json'), join(__dirname, 'files', 'default-env.json'))
 
         const projectType = await this.getProjectType()
         switch (projectType) {
@@ -69,7 +69,7 @@ module.exports = class ApprouterTemplate extends require('../templateBase') {
             if (isJava && isMultitenant) apis.push(requiredMtxAPI)
             const additions = [srv, approuter, xsuaa, ...apis]
             const mtaYAMLPath = join(this.projectPath, 'mta.yaml')
-            await mergeYAML(mtaYAMLPath, `${__dirname}/files/mta.yaml.hbs`, projectDescriptor, {
+            await mergeYAML(mtaYAMLPath, join(__dirname, 'files', 'mta.yaml.hbs'), projectDescriptor, {
                 additions,
                 relationships: [{
                     insert: [xsuaa, 'name'],
@@ -115,8 +115,7 @@ module.exports = class ApprouterTemplate extends require('../templateBase') {
                     envFrom: [
                       {
                         configMapRef: {
-                          name: "{{ .Release.Name }}-approuter-configmap",
-                          tpl: true
+                          name: "{{ .Release.Name }}-approuter-configmap"
                         }
                       }
                     ]
@@ -140,6 +139,6 @@ module.exports = class ApprouterTemplate extends require('../templateBase') {
         const appPath = join(this.projectPath, projectDescriptor.ui.appPath || 'app')
         const additions = isExtensible && isJava ? [{ ...approuterExtensibilityJava, at: 0 }] :
                           isExtensible && isNodejs ? [{ ...approuterExtensibility, at: 0 }] : []
-        await mergeJSON(`${appPath}/xs-app.json`, `${__dirname}/files/xs-app.json.hbs`, projectDescriptor, { additions })
+        await mergeJSON(join(appPath, 'xs-app.json'), join(__dirname, 'files', 'xs-app.json.hbs'), projectDescriptor, { additions })
     }
 }

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

@@ -27,7 +27,7 @@ module.exports = class AuditlogTemplate extends require('../templateBase') {
             const srv = isNodejs ? srvNode : srvJava
             await mergeYAML(
                 mtaYAMLPath,
-                `${__dirname}/files/mta.yaml.hbs`,
+                join(__dirname, 'files', 'mta.yaml.hbs'),
                 projectDescriptor,
                 {
                     additions: [srv, auditlog],

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

@@ -3,7 +3,7 @@ const cds = require('../../../cds')
 const { exists, fs } = cds.utils
 const { resolve, join, relative }  = require('path');
 const LOG = console
-const DEBUG = /\bcli\b/.test(process.env.DEBUG) && console.debug
+const DEBUG = /\b(y|all|cli)\b/.test(process.env.DEBUG) && console.debug
 
 module.exports = class DataTemplate extends require('../templateBase') {
   constructor(projectPath, generator) {

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

@@ -34,7 +34,7 @@ module.exports = class DestinationsTemplate extends require('../templateBase') {
         if (hasHelm) {
             //const env = await this.getEnv()
             const binding = hasDestination && { srv: { bindings: { destination: { serviceInstanceName: 'destinations' }}}}
-            const html5Binding = hasHtml5Repo && { html5_apps_deployer: { bindings: { destination: { serviceInstanceName: 'destination' }}}}
+            const html5Binding = hasHtml5Repo && { 'html5-apps-deployer': { bindings: { destination: { serviceInstanceName: 'destination' }}}}
 
             //in case facet is being added to the already exisiting charts folder
             let isIndependentCommand = false

package/lib/init/template/enterprise-messaging/index.js

@@ -34,7 +34,7 @@ module.exports = class EnterpriseMessagingTemplate extends require('../templateB
       const srv = isNodejs ? srvNode : srvJava
       await mergeYAML(
           mtaYAMLPath,
-          `${__dirname}/files/mta.yaml.hbs`,
+          join(__dirname, 'files', 'mta.yaml.hbs'),
           projectDescriptor,
           {
               additions: [srv, enterpriseMessaging],

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

@@ -24,7 +24,7 @@ module.exports = class ExtensibilityTemplate extends require('../templateBase')
 
   async runDependentMerging(context = {}) {
     const projectDescriptor = await this.projectReader.read()
-    const { hasXsuaa, hasHelm } = projectDescriptor.cap
+    const { hasXsuaa, hasHelm, hasApprouter } = projectDescriptor.cap
     if (hasXsuaa) {
       await mergeJSON(
         join(this.projectPath, 'xs-security.json'),
@@ -47,6 +47,11 @@ module.exports = class ExtensibilityTemplate extends require('../templateBase')
         }
       )
     }
+    if (hasApprouter) {
+      const ApprouterTemplate = require(`../approuter`)
+      const approuterTemplate = new ApprouterTemplate(this.projectPath, this.generator)
+      await approuterTemplate.runDependentMerging()
+  }
     if (hasXsuaa && hasHelm) {
       //in case facet is being added to the already exisiting charts folder
       let isIndependentCommand = false

package/lib/init/template/hana/files/chart.yaml

@@ -0,0 +1,4 @@
+dependencies:
+  - name: content-deployment
+    alias: hana-deployer
+    version: 0.1.0

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

@@ -0,0 +1 @@
+{{- include "cap.service-instance" . }}

package/lib/init/template/hana/files/java/db/package.json

@@ -4,7 +4,7 @@
     "@sap/hdi-deploy": "^4"
   },
   "engines": {
-    "node": "^16"
+    "node": "^16 || ^18"
   },
   "scripts": {
     "start": "node node_modules/@sap/hdi-deploy/deploy.js",

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

@@ -2,14 +2,14 @@
 srv:
   bindings:
     db:
-      fromSecret: null
-hana_deployer:
+      serviceInstanceName: hana
+hana-deployer:
   image:
     repository: <your-container-registry>/{{cap.appName}}-hana-deployer
     tag: latest
   bindings:
     hana:
-      fromSecret: null
+      serviceInstanceName: hana
   resources:
     limits:
       cpu: 2000m
@@ -17,3 +17,6 @@ hana_deployer:
     requests:
       cpu: 1000m
       memory: 1G
+hana:
+  serviceOfferingName: hana
+  servicePlanName: hdi-shared

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

@@ -1,10 +1,10 @@
 const { join } = require('path');
 const cds = require('../../../cds')
-const { read, write, exists, rm } = cds.utils
+const { read, write, exists, rm, rmdir } = cds.utils
 const commandUtil = require('../../util/commandUtil');
 const mvnArchetypes = require('../../util/mvnArchetypeUtil');
 const term = require('../../../util/term');
-const { mergeJSON, mergeYAML, removeFromYAML } = require('../../util/merge')
+const { mergeJSON, mergeYAML, removeFromYAML, removeFromYAMLArray } = require('../../util/merge')
 const { copyAndTrack, parseMd5File, writeMd5File } = require('../../util/md5Tracking')
 const { copyFiles } = require('../../util/templateUtil')
 const ProjectReader = require('../../util/projectReader');
@@ -60,10 +60,35 @@ module.exports = class HanaTemplate extends require('../templateBase') {
         await this.runDependentMerging()
     }
 
+    async removeEntriesFromContext(context, key, pattern = false) {
+        if(pattern) {
+            Object.keys(context.oldTrackingData).forEach(fileName => {
+                if (fileName.startsWith(key)) {
+                  delete context.oldTrackingData[fileName];
+                }
+            });
 
+            Object.keys(context.newTrackingData).forEach(fileName => {
+                if (fileName.startsWith(key)) {
+                  delete context.newTrackingData[fileName];
+                }
+            });
+        } else {
+            // remove entry from oldTrackingData
+            if(context.oldTrackingData !== undefined && context.oldTrackingData[key] !== undefined) {
+                delete context.oldTrackingData[key];
+            }
+
+            // remove entry from newTrackingData
+            if(context.newTrackingData !== undefined && context.newTrackingData[key] !== undefined) {
+                delete context.newTrackingData[key];
+            }
+        }
+    }
+    
     async runDependentMerging(context = {}) {
         const projectDescriptor = await this.projectReader.read(this.options)
-        const { hasMta, hasHelm, isNodejs, isJava, isMultitenant } = projectDescriptor.cap
+        const { hasMta, hasHelm, hasHtml5Repo, isNodejs, isJava, isMultitenant } = projectDescriptor.cap
 
         if (isMultitenant) {
             await this._updateCdsConfiguration()
@@ -128,37 +153,64 @@ module.exports = class HanaTemplate extends require('../templateBase') {
 
             if(isMultitenant){
                 shouldUpdateTrackingFile = true;
-                const key = "templates/hana-deployer-job.yaml";
 
-                // remove entry from oldTrackingData
-                if(context.oldTrackingData !== undefined && context.oldTrackingData[key] !== undefined) {
-                    delete context.oldTrackingData[key];
-                }
+                const instanceTemplateKey = "templates/hana.yaml";
+                await this.removeEntriesFromContext(context, instanceTemplateKey);
 
-                // remove entry from newTrackingData
-                if(context.newTrackingData !== undefined && context.newTrackingData[key] !== undefined) {
-                    delete context.newTrackingData[key];
-                }
-                
                 // remove hana entries from values.yaml
-                await removeFromYAML(join(this.projectPath, 'chart', 'values.yaml'), ['hana_deployer', 'srv.bindings.db']);
+                await removeFromYAML(join(this.projectPath, 'chart', 'values.yaml'), ['hana-deployer', 'srv.bindings.db', 'hana']);
+
+                // remove hana entries from Chart.yaml
+                await removeFromYAMLArray(join(this.projectPath, 'chart', 'Chart.yaml'), 'dependencies', 'hana-deployer');
 
-                const hanaDeployerPath = join(this.projectPath, 'chart', 'templates', 'hana-deployer-job.yaml');
-                if(exists(hanaDeployerPath)) {
-                    await rm(hanaDeployerPath, { force: true });
+                // remove content-deployment subchart if html5Repo doesn't exist
+                if(!hasHtml5Repo) {
+                    const contentDeploymentEntriesPattern = "charts/content-deployment/"
+                    await this.removeEntriesFromContext(context, contentDeploymentEntriesPattern, true);
+
+                    const contentDeploymentSubchartPath = join(this.projectPath, 'chart', 'charts', 'content-deployment');
+                    if(exists(contentDeploymentSubchartPath)) {
+                        await rmdir(contentDeploymentSubchartPath);
+                    }
                 }
-            }
-            else{
+
+                const hanaInstanceTemplatePath = join(this.projectPath, 'chart', 'templates', 'hana.yaml');
+                if(exists(hanaInstanceTemplatePath)) {
+                    await rm(hanaInstanceTemplatePath);
+                }
+            } else {
                 await mergeYAML(
                     join(this.projectPath, 'chart', 'values.yaml'),
                     join(__dirname, 'files', 'values.yaml.hbs'),
                     projectDescriptor
                 )
                 await copyAndTrack(
-                    join(__dirname, 'files', 'hana-deployer-job.yaml'),
-                    join(this.projectPath, 'chart', 'templates', 'hana-deployer-job.yaml'),
+                    join(__dirname, 'files', 'hana.yaml'),
+                    join(this.projectPath, 'chart', 'templates', 'hana.yaml'),
                     context
                 )
+
+                // copy content deployment chart if it is not present
+                const contentDeploymentSubchartPath = join(this.projectPath, 'chart', 'charts', 'content-deployment');
+                if(!exists(contentDeploymentSubchartPath)) {
+                    const contentDeploymentResourcePath = join(__dirname, '..', 'helm', 'subcharts', 'content-deployment');
+                    await copyAndTrack(contentDeploymentResourcePath, contentDeploymentSubchartPath, context);
+                }
+
+                // add dependency entry in chart.yaml
+                await mergeYAML(
+                    join(this.projectPath, 'chart', 'Chart.yaml'),
+                    join(__dirname, 'files', 'chart.yaml'),
+                    projectDescriptor,
+                    { additions: [{
+                        ref: `content-deployment-hana-deployer`,
+                        in: `dependencies`,
+                        where: [{
+                            property: 'alias',
+                            isEqualTo: 'hana-deployer'
+                        }]
+                    }]}
+                )
             }
             if(shouldUpdateTrackingFile) await writeMd5File(join(this.projectPath, 'chart', '.cds-add-helm-files.md5'), context.newTrackingData);
         }

package/lib/init/template/helm/chart/templates/_deployment_helpers.tpl

@@ -69,16 +69,24 @@ Get FQDN of a deployment
 {{/*
 Backend Destinations
 */}}
-{{- define "cap.approuterDestinations" -}}
+{{- define "cap.backendDestinations" -}}
 {{- $ := . -}}
-{{- if $.Values.approuterDestinations }}
+{{- $root := $.root -}}
+{{- $nameKey := "name" -}}
+{{- $urlKey := "url" -}}
+{{- if $root.Values.backendDestinations }}
 {{- $destinations := list -}}
-{{- range $destinationName, $destination := $.Values.approuterDestinations -}}
+{{- if $.html5 }}
+{{- $nameKey = "Name" -}}
+{{- $urlKey = "URL" -}}
+{{- end -}}
+{{- range $destinationName, $destination := $root.Values.backendDestinations -}}
     {{- $destination := merge (dict "name" $destinationName) $destination -}}
-    {{- $deployment := (get $.Values $destination.service) -}}
-    {{- $srv := merge (dict "name" $destination.service "destination" $destination "deployment" $deployment) $ -}}
+    {{- $deployment := (get $root.Values $destination.service) -}}
+    {{- $srv := merge (dict "name" $destination.service "destination" $destination "deployment" $deployment) $root -}}
     {{- $destinationHost := include "cap.deploymentHostFull" $srv -}}
-    {{- $currentDestination := dict "name" $destination.name "forwardAuthToken" true "url" (print  "https://" $destinationHost ) -}}
+    {{- $currentDestination := dict $nameKey $destination.name $urlKey (print  "https://" $destinationHost ) -}}
+    {{- $currentDestination := merge $currentDestination $.defaultParameters -}}
     {{- $destinations = (append $destinations $currentDestination) -}}
 {{- end -}}
 {{- $destinations | toJson }}

package/lib/init/template/helm/chart/values.root.schema.json

@@ -11,6 +11,16 @@
             "$id": "#/properties/approuter",
             "description": "Deployment",
             "$ref": "./charts/web-application/values.schema.json"
+        },
+        "hana-deployer": {
+            "$id": "#/properties/hana-deployer",
+            "description": "Content Deployment",
+            "$ref": "./charts/content-deployment/values.schema.json"
+        },
+        "html5-apps-deployer": {
+            "$id": "#/properties/html5-apps-deployer",
+            "description": "Content Deployment",
+            "$ref": "./charts/content-deployment/values.schema.json"
         }
     }
 }

package/lib/init/template/helm/chart/values.schema.json

@@ -42,13 +42,21 @@
             "$id": "#/properties/srv",
             "description": "Deployment"
         },
+        "hana-deployer": {
+            "$id": "#/properties/hana-deployer",
+            "description": "Content Deployment"
+        },
+        "html5-apps-deployer": {
+            "$id": "#/properties/html5-apps-deployer",
+            "description": "Content Deployment"
+        },
         "approuter": {
             "$id": "#/properties/approuter",
             "description": "Deployment"
         },
-        "approuterDestinations": {
-            "$id": "#/properties/approuterDestinations",
-            "title": "Backend Destinations for Approuter",
+        "backendDestinations": {
+            "$id": "#/properties/backendDestinations",
+            "title": "Backend Destinations for Approuter or HTML5 Apps Deployer",
             "type": "object",
             "patternProperties": {
                 "^[-._a-zA-Z][-._a-zA-Z0-9]*$": {
@@ -130,113 +138,6 @@
             "$id": "#/properties/event_mesh",
             "$ref": "#/definitions/ServiceInstance"
         },
-        "hana_deployer": {
-            "$id": "#/properties/hana_deployer",
-            "type": "object",
-            "additionalProperties": false,
-            "required": [
-                "image",
-                "bindings",
-                "resources"
-            ],
-            "properties": {
-                "image": {
-                    "$id": "#/properties/hana_deployer/image",
-                    "$ref": "#/definitions/Image"
-                },
-                "bindings": {
-                    "$id": "#/properties/hana_deployer/bindings",
-                    "$ref": "#/definitions/Bindings"
-                },
-                "resources": {
-                    "$id": "#/properties/hana_deployer/resources",
-                    "$ref": "#/definitions/Resources"
-                },
-                "env": {
-                    "$id": "#/properties/hana_deployer/env",
-                    "description": "Key-value map of environment variables, which should be added to the Pod spec.",
-                    "type": "object",
-                    "patternProperties": {
-                        "^[-._a-zA-Z][-._a-zA-Z0-9]*$": {
-                            "$comment": "regex above copied from https://github.com/kubernetes/kubernetes/blob/ea0764452222146c47ec826977f49d7001b0ea8c/staging/src/k8s.io/apimachinery/pkg/util/validation/validation.go#L402",
-                            "not": {
-                                "type": ["null", "object", "array"]
-                            }
-                        }
-                    },
-                    "additionalProperties": false,
-                    "default": {}
-                }
-            }
-        },
-        "html5_apps_deployer": {
-            "$id": "#/properties/html5_apps_deployer",
-            "type": "object",
-            "additionalProperties": false,
-            "required": [
-                "image",
-                "bindings",
-                "resources",
-                "cloudService"
-            ],
-            "properties": {
-                "image": {
-                    "$id": "#/properties/html5_apps_deployer/image",
-                    "$ref": "#/definitions/Image"
-                },
-                "bindings": {
-                    "$id": "#/properties/html5_apps_deployer/bindings",
-                    "$ref": "#/definitions/Bindings"
-                },
-                "resources": {
-                    "$id": "#/properties/html5_apps_deployer/resources",
-                    "$ref": "#/definitions/Resources"
-                },
-                "env": {
-                    "$id": "#/properties/html5_apps_deployer/env",
-                    "description": "Key-value map of environment variables, which should be added to the Pod spec.",
-                    "type": "object",
-                    "patternProperties": {
-                        "^[-._a-zA-Z][-._a-zA-Z0-9]*$": {
-                            "$comment": "regex above copied from https://github.com/kubernetes/kubernetes/blob/ea0764452222146c47ec826977f49d7001b0ea8c/staging/src/k8s.io/apimachinery/pkg/util/validation/validation.go#L402",
-                            "not": {
-                                "type": ["null", "object", "array"]
-                            }
-                        }
-                    },
-                    "additionalProperties": false,
-                    "default": {}
-                },
-                "backendDestinations": {
-                    "$id": "#/properties/html5_apps_deployer/backendDestinations",
-                    "title": "Backend Destinations for HTML5 Application",
-                    "type": "object",
-                    "patternProperties": {
-                        "^[-._a-zA-Z][-._a-zA-Z0-9]*$": {
-                            "description": "Name of the backend Destination",
-                            "required": [
-                                "service"
-                            ],
-                            "properties": {
-                                "service": {
-                                    "type": "string",
-                                    "description": "Target Kubernetes service"
-                                },
-                                "path": {
-                                    "type": "string",
-                                    "description": "This path will be appended to the URL"
-                                }
-                            }
-                        }
-                    }
-                },
-                "cloudService": {
-                    "$id": "#/properties/html5_apps_deployer/cloudService",
-                    "type": "string",
-                    "description": "Name for your business service (unique per subaccount)"
-                }
-            }
-        },
         "html5_apps_repo_host": {
             "$id": "#/properties/html5_apps_repo_host",
             "$ref": "#/definitions/ServiceInstance"

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

@@ -1,5 +1,5 @@
 const { join } = require('path');
-const { exists, read, rimraf } = require('../../../cds').utils;
+const { exists, rimraf } = require('../../../cds').utils;
 const ProjectReader = require('../../util/projectReader');
 const { mergeYAML } = require('../../util/merge')
 const { parseMd5File, writeMd5File, copyAndTrack } = require('../../util/md5Tracking')
@@ -32,7 +32,7 @@ module.exports = class HelmTemplate extends require('../templateBase') {
         this.oldTrackingData = await parseMd5File(join(this.projectPath, 'chart', '.cds-add-helm-files.md5'));
 
         await copyAndTrack(
-            join(__dirname, 'subchart'),
+            join(__dirname, 'subcharts', 'web-application'),
             join(this.projectPath, 'chart', 'charts', 'web-application'),
             this
         )

package/lib/init/template/helm/subcharts/content-deployment/Chart.yaml

@@ -0,0 +1,5 @@
+apiVersion: v2
+name: content-deployment
+description: A Helm Chart for creating a Content Deployment job
+type: application
+version: 0.1.0