@sap/cds-dk 7.9.6 → 8.0.3

package/lib/{init/template/helm/files → build/plugins/helm/files/subcharts}/service-instance/values.schema.json

@@ -32,6 +32,10 @@
             "type": "string",
             "pattern": "[0-9a-z][0-9a-z-.]*"
         },
+        "btpAccessCredentialsSecret": {
+            "$id": "#/properties/btpAccessCredentialsSecret",
+            "type": "string"
+        },
         "externalName": {
             "$id": "#/properties/externalName",
             "type": "string",
@@ -93,6 +97,65 @@
                             "type": "string"
                         }
                     }
+                },
+                "serviceBinding": {
+                    "type": "object",
+                    "patternProperties": {
+                        ".*": {
+                            "type": "string"
+                        }
+                    }
+                }
+            }
+        },
+        "bindings": {
+            "$id": "#/properties/bindings",
+            "title": "Service Binding configuration",
+            "type": "object",
+            "additionalProperties": false,
+            "patternProperties": {
+                "^[-._a-zA-Z][-._a-zA-Z0-9]*$": {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "properties": {
+                        "externalName": {
+                            "type": "string"
+                        },
+                        "secretName": {
+                            "type": "string"
+                        },
+                        "parameters": {
+                            "type": "object"
+                        },
+                        "parametersFrom": {
+                            "type": "array",
+                            "items": {
+                                "type": "object",
+                                "additionalProperties": false,
+                                "properties": {
+                                    "secretKeyRef": {
+                                        "type": "object",
+                                        "additionalProperties": false,
+                                        "required": [
+                                            "name",
+                                            "key"
+                                        ],
+                                        "properties": {
+                                            "name": {
+                                                "type": "string"
+                                            },
+                                            "key": {
+                                                "type": "string"
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        },
+                        "credentialsRotationPolicy": {
+                            "type": "object"
+                        }
+                    }
                 }
             }
         }

package/lib/{init/template/helm/files → build/plugins/helm/files/subcharts}/service-instance/values.yaml

@@ -10,6 +10,9 @@
 # The plan to use for the service instance.
 # servicePlanName: plan-name
 
+# The secret containing the relevant subaccount's credentials where the ServiceInstance will be provisioned.
+# btpAccessCredentialsSecret: secret-name
+
 # The name for the service instance in SAP BTP.
 # externalName: feature-flags-test
 
@@ -38,9 +41,28 @@
 
 annotations:
   serviceInstance: {}
+  serviceBinding: {}
+bindings:
+  defaultProperties:
+    credentialsRotationPolicy:
+      enabled: false
+      rotationFrequency: "720h"
+      rotatedBindingTTL: "24h"
+#   my-service-binding:
+#     externalName: my-service-binding-external-name
+#     secretName: my-service-binding-secret
+#     parameters:
+#       foo: bar
+#     parametersFrom:
+#       - secretKeyRef:
+#           key: test
+#           name: test
+#     credentialsRotationPolicy:
+#       enabled: false
+
 global:
   sap:
     _internal:
       service-instance:
         versions:
-          1.3.0: true
+          1.5.1: true

package/lib/{init/template/helm/files → build/plugins/helm/files/subcharts}/web-application/Chart.yaml

@@ -3,4 +3,4 @@ description: A Helm chart for web app
 kubeVersion: '>= 1.21'
 name: web-application
 type: application
-version: 1.13.1
+version: 1.16.0

package/lib/{init/template/helm/files → build/plugins/helm/files/subcharts}/web-application/templates/deployment.yaml

@@ -8,7 +8,9 @@ metadata:
   {{- tpl (toYaml .Values.annotations.deployment) $ | nindent 4 }}
   {{- end }}
 spec:
+  {{- if not .Values.hpa.enabled }}
   replicas: {{ .Values.replicaCount }}
+  {{- end }}
   selector:
     matchLabels: {{- include "web-application.selectorLabels" . | nindent 6 }}
   template:

package/lib/build/plugins/helm/files/subcharts/web-application/templates/hpa.yaml

@@ -0,0 +1,22 @@
+{{- if .Values.hpa.enabled -}}
+apiVersion: autoscaling/v2
+kind: HorizontalPodAutoscaler
+metadata:
+  name: {{ include "web-application.fullname" . }}
+  labels: {{- include "web-application.labels" . | nindent 4 }}
+spec:
+  scaleTargetRef:
+    apiVersion: apps/v1
+    kind: deployment
+    name: {{ include "web-application.fullname" . }}
+  minReplicas: {{ .Values.hpa.minReplicas }}
+  maxReplicas: {{ .Values.hpa.maxReplicas }}
+  {{- if .Values.hpa.behavior }}
+  behavior:
+    {{- toYaml .Values.hpa.behavior | nindent 4 }}
+  {{- end }}
+  {{- if .Values.hpa.metrics }}
+  metrics:
+    {{- toYaml .Values.hpa.metrics | nindent 4 }}
+  {{- end }}
+{{- end }}

package/lib/{init/template/helm/files → build/plugins/helm/files/subcharts}/web-application/templates/pod-disruption-budget.yaml

@@ -5,5 +5,6 @@ metadata:
   labels: {{- include "web-application.labels" . | nindent 4 }}
 spec:
   maxUnavailable: {{ .Values.availability.podDisruptionBudget.maxUnavailable }}
+  unhealthyPodEvictionPolicy: {{ .Values.availability.podDisruptionBudget.unhealthyPodEvictionPolicy }}
   selector:
     matchLabels: {{- include "web-application.selectorLabels" . | nindent 6 }}

package/lib/{init/template/helm/files → build/plugins/helm/files/subcharts}/web-application/values.schema.json

@@ -288,6 +288,11 @@
                         "maxUnavailable": {
                             "type": "string",
                             "default": "10%"
+                        },
+                        "unhealthyPodEvictionPolicy": {
+                            "type": "string",
+                            "default": "AlwaysAllow",
+                            "enum": ["AlwaysAllow", "IfHealthyBudget"]
                         }
                     }
                 },
@@ -567,6 +572,9 @@
                                 ],
                                 "additionalProperties": false,
                                 "type": "object"
+                            },
+                            "prefix": {
+                                "type": "string"
                             }
                         },
                         "required": [
@@ -587,6 +595,9 @@
                                 ],
                                 "additionalProperties": false,
                                 "type": "object"
+                            },
+                            "prefix": {
+                                "type": "string"
                             }
                         },
                         "required": [
@@ -957,6 +968,9 @@
                                                 ],
                                                 "additionalProperties": false,
                                                 "type": "object"
+                                            },
+                                            "prefix": {
+                                                "type": "string"
                                             }
                                         },
                                         "required": [
@@ -977,6 +991,9 @@
                                                 ],
                                                 "additionalProperties": false,
                                                 "type": "object"
+                                            },
+                                            "prefix": {
+                                                "type": "string"
                                             }
                                         },
                                         "required": [
@@ -1260,6 +1277,38 @@
                     }
                 }
             }
+        },
+        "hpa": {
+            "$id": "#/properties/hpa",
+            "title": "Enable autoscaling",
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "enabled": {
+                    "type": "boolean",
+                    "title": "Add Horizontal App Autoscaler resource.",
+                    "default": false
+                },
+                "minReplicas": {
+                    "type": "number",
+                    "title": "Lower limit for the number of replicas to which the autoscaler can scale up.",
+                    "default": 1
+                },
+                "maxReplicas": {
+                    "type": "number",
+                    "title": "Upper limit for the number of replicas to which the autoscaler can scale up.",
+                    "default": 3
+                },
+                "behavior": {
+                    "type": "object"
+                },
+                "metrics": {
+                    "type": "array",
+                    "items": {
+                        "type": "object"
+                    }
+                }
+            }
         }
     },
     "definitions": {

package/lib/{init/template/helm/files → build/plugins/helm/files/subcharts}/web-application/values.yaml

@@ -15,7 +15,7 @@ global:
     _internal:
       web-application:
         versions:
-          1.13.1: true
+          1.16.0: true
 ## Will be used instead of the `.Chart.Name`, e.g. when generating the Deployment name.
 # nameOverride: name
 
@@ -76,9 +76,11 @@ additionalVolumes: []
 
 # Availability related configuration
 availability:
-  # The max disruption to the pods, see https://kubernetes.io/docs/concepts/workloads/pods/disruptions/ for details
+  # The max disruption to the pods, see https://kubernetes.io/docs/tasks/run-application/configure-pdb/ for details
   podDisruptionBudget:
     maxUnavailable: 10%
+    # See https://kubernetes.io/blog/2023/01/06/unhealthy-pod-eviction-policy-for-pdbs/
+    unhealthyPodEvictionPolicy: AlwaysAllow
   # How pods ought to spread across topology domains., see https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/ for details
   topologySpreadConstraints:
     - topologyKey: topology.kubernetes.io/zone
@@ -291,3 +293,7 @@ annotations:
 #     envFrom:
 #       - configMapRef:
 #           name: my-configmap1
+hpa:
+  enabled: false
+  minReplicas: 1
+  maxReplicas: 3

package/lib/{init/template/helm/files/chart → build/plugins/helm/files}/templates/_deployment_helpers.tpl

@@ -73,6 +73,11 @@ Backend Destinations
 {{- $urlKey = "URL" -}}
 {{- end -}}
 {{- range $destinationName, $destination := $root.Values.backendDestinations -}}
+    {{- if $destination.external }}
+        {{- $_ := unset $destination "external" -}}
+        {{- $destinations = (append $destinations $destination) -}}
+        {{- continue -}}
+    {{- end -}}
     {{- $destination := merge (dict "name" $destinationName) $destination -}}
     {{- $deployment := (get $root.Values $destination.service) -}}
     {{- $srv := merge (dict "name" $destination.service "destination" $destination "deployment" $deployment) $root -}}

package/lib/build/plugins/helm/files/templates/_helpers.tpl

@@ -0,0 +1,13 @@
+{{/*
+Labels for a component
+*/}}
+{{- define "cap.labels" -}}
+helm.sh/revision: {{ .Release.Revision | quote }}
+helm.sh/chart: {{ printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+app.kubernetes.io/name: {{ .name }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion }}
+{{- end }}
+{{- end -}}

package/lib/build/plugins/helm/index.js

@@ -0,0 +1,81 @@
+const cds = require('../../../cds')
+const { exists, path, readFileSync, yaml } = cds.utils
+const { Plugin, BuildError } = require('../../../build')
+const { join } = path
+const { readProject } = require('../../../init/projectReader')
+
+module.exports = class HelmBuildPlugin extends Plugin {
+  static taskDefaults = { src: "." }
+
+  static hasTask() {
+    if (exists('chart/Chart.yaml')) {
+      const chartFile = readFileSync(join(cds.root, 'chart', 'Chart.yaml'), 'utf8')
+      const chartYaml = yaml.parseDocument(chartFile).toJS()
+      return chartYaml.annotations?.["app.kubernetes.io/managed-by"] === 'cds-dk/helm'
+    }
+    return false
+  }
+
+  init() {
+    if (this.task.src !== cds.root) {
+      throw new BuildError("Invalid value for property 'src', it must have value '.'")
+    }
+
+    // different from the default build output structure
+    this.task.dest = join(cds.root, cds.env.build.target !== '.' ? cds.env.build.target : 'gen', 'chart')
+  }
+
+  async build() {
+    if(!HelmBuildPlugin.hasTask()) {
+      this.pushMessage("Helm Chart not found. Execute `cds add helm` to add the helm chart.", Plugin.WARNING)
+      return
+    }
+
+    const { hasApprouter, hasConnectivity, hasHtml5Repo } = readProject()
+
+    const chartFile = readFileSync(join(cds.root, 'chart', 'Chart.yaml'), 'utf8')
+    const chartYaml = yaml.parseDocument(chartFile).toJS()
+    const isInternal = chartYaml.dependencies?.find(dep => dep.name === 'web-application')?.repository !== undefined
+
+    if (!isInternal) {
+      // copy web appplication helm chart
+      await this.copy(join(__dirname, 'files', 'subcharts', 'web-application')).to('charts/web-application')
+
+      // copy service instance helm chart
+      if (this._hasSubchart('service-instance')) {
+        await this.copy(join(__dirname, 'files', 'subcharts', 'service-instance')).to('charts/service-instance')
+      }
+
+      // copy content deployment helm chart
+      if (this._hasSubchart('content-deployment')) {
+        await this.copy(join(__dirname, 'files', 'subcharts', 'content-deployment')).to('charts/content-deployment')
+      }
+    }
+
+    // copy templates
+    await this.copy(join(__dirname, 'files', 'templates')).to('templates')
+
+    const pluginResourcePath = join(__dirname, 'files', 'plugins')
+
+    if (hasApprouter) {
+      await this.copy(join(pluginResourcePath, 'approuter/approuter-configmap.yaml')).to('templates/approuter-configmap.yaml')
+    }
+
+    if (hasConnectivity) {
+      await this.copy(join(pluginResourcePath, 'connectivity/connectivity-proxy-info.yaml')).to('templates/connectivity-proxy-info.yaml')
+    }
+
+
+    if (hasHtml5Repo) {
+      await this.copy(join(pluginResourcePath, 'html5-repo/html5-apps-deployer-configmap.yaml')).to('templates/html5-apps-deployer-configmap.yaml')
+    }
+
+    // copy chart folder to gen/chart
+    await this.copy(join(cds.root, 'chart')).to(".")
+  }
+
+  _hasSubchart(subchart) {
+    const chart = exists('chart/Chart.yaml') ? readFileSync(join(cds.root, 'chart/Chart.yaml'), 'utf8') : ''
+    return chart.includes(subchart)
+  }
+}

package/lib/build/plugins.js

@@ -1,35 +1,32 @@
 const cds = require('../cds')
+const Plugin = require('./plugin')
 const DEBUG = cds.debug('cli|build')
 
 module.exports = new (class Plugins {
     constructor() {
         this._plugins = new Map()
+        this._registerDefaults()
     }
     get plugins() {
         return this._plugins
     }
     register(id, plugin) {
         if (!id || !plugin) {
-            throw Error("Invalid parameter")
-        }
-        if (plugin.impl) {
-            // REVISIT: remove compat mode - latest cds-dk@8
-            const taskDefaults = plugin.taskDefaults
-            plugin = this._loadPlugin(id, plugin.impl)
-            plugin.taskDefaults = taskDefaults
+            throw new Error(`Invalid parameter passed, build plugin id: ${id}`)
         }
         if (this._plugins.has(id)) {
-            throw Error(`Build plugin ${id} already registered`)
+            throw new Error(`CDS build plugin ${id} already registered`)
+        }
+        if(!(plugin.prototype instanceof Plugin)) {
+            // with cds-dk version 7 the following registration format was supported:
+            // cds.build.register("cov2ap", { impl: "@cap-js-community/odata-v2-adapter/src/build.js", taskDefaults: { src: "srv" } })
+            throw `The cds build plugin '${id}' is not compatible with this @sap/cds-dk version. Update the npm package '${plugin.impl || id}' to the latest version.`
         }
         DEBUG?.(`Registering build plugin ${id}`)
         this._plugins.set(id, plugin)
     }
-    _loadPlugin(id, impl) {
-        try {
-            // project-local module is preferred - otherwise from our own dependencies
-            return require(require.resolve(impl, { paths: [cds.root, __dirname] }))
-        } catch (e) {
-            throw new Error(`Custom build plugin implementation '${impl}' for '${id}' cannot be loaded:\n` + e)
-        }
+
+    _registerDefaults() {
+        this.register('helm', require('./plugins/helm'))
     }
 })

package/lib/build/provider/featureToggleBuildPlugin.js

@@ -2,7 +2,7 @@ const path = require('path')
 const cds = require('../../cds')
 const { DEFAULT_CSN_FILE_NAME, OUTPUT_MODE, OUTPUT_MODE_RESULT } = require('../constants')
 const InternalBuildPlugin = require('./internalBuildPlugin')
-const { getI18nDefaultFolder } = require('../util')
+const { getI18nDefaultFolder, filterFeaturePaths } = require('../util')
 
 class FeatureToggleBuildPlugin extends InternalBuildPlugin {
     init() {
@@ -16,12 +16,8 @@ class FeatureToggleBuildPlugin extends InternalBuildPlugin {
         }
     }
 
-    get ftsName() {
-        return path.dirname(cds.env.features.folders || 'fts/*')
-    }
-
     async compileAll(csn, destBase, destFts) {
-        const sources = await this._resolveSourcePaths(csn)
+        const sources = filterFeaturePaths(csn, this.task.options.model || this.task.src)
         const dictionary = { base: null, features: null }
 
         if (sources.features) {
@@ -47,6 +43,7 @@ class FeatureToggleBuildPlugin extends InternalBuildPlugin {
 
     async collectAllLanguageBundles(dictionary, paths, destBase, destFts) {
         const i18nFolder = getI18nDefaultFolder()
+        const ftsName = path.dirname(cds.env.features.folders || 'fts/*')
         // create language bundle for base model
         const i18n = await this.collectLanguageBundles(dictionary.base, path.join(destBase, i18nFolder))
         if (i18n && this.hasBuildOption(OUTPUT_MODE, OUTPUT_MODE_RESULT)) {
@@ -58,52 +55,23 @@ class FeatureToggleBuildPlugin extends InternalBuildPlugin {
             for (const ftName in dictionary.features) {
                 // attach the sources information for i18n location reference
                 dictionary.features[ftName]['$sources'] = paths.features[ftName]
-                await this.collectLanguageBundles(dictionary.features[ftName], path.join(destFts, this.ftsName, ftName, i18nFolder))
+                await this.collectLanguageBundles(dictionary.features[ftName], path.join(destFts, ftsName, ftName, i18nFolder))
             }
         }
     }
 
-    async _resolveSourcePaths(csn) {
-        const regex = new RegExp(this.ftsName + '[/|\\\\](?<ftName>[^/|\\\\]*)')
-        let paths = { base: [] }
-
-        // add ROOT source file paths for the base model
-        paths.base = this._resolveModel().reduce((acc, file) => {
-            const match = file.match(regex)
-            if (!match) {
-                acc.push(file)
-            }
-            return acc
-        }, [])
-
-        // add source file paths for the features
-        paths.features = csn['$sources'].reduce((acc, file) => {
-            const match = file.match(regex)
-            if (match) {
-                const { ftName } = match.groups
-                //feature
-                if (!acc[ftName]) {
-                    acc[ftName] = []
-                }
-                acc[ftName].push(file)
-            }
-            return acc
-        }, {})
-
-        return paths
-    }
-
     async _compileFeatures(ftsPaths, destBase, destFts, baseCsn) {
         if (!ftsPaths) {
             return
         }
         const features = {}
         const options = { ...this.options(), flavor: 'parsed' }
+        const ftsName = path.dirname(cds.env.features.folders || 'fts/*')
 
         // create feature models
         for (const ftName in ftsPaths) {
             const ftCsn = await cds.load(ftsPaths[ftName], options)
-            const ftPath = path.join(destFts, this.ftsName, ftName)
+            const ftPath = path.join(destFts, ftsName, ftName)
 
             // replace require paths by base model path to ensure precedence of feature annotations
             // see https://pages.github.tools.sap/cap/docs/cds/compiler-messages#anno-duplicate-unrelated-layer
@@ -119,7 +87,7 @@ class FeatureToggleBuildPlugin extends InternalBuildPlugin {
     _validateFeature(ftCsn, baseCsn) {
         // features must not have other dependencies than base model dependencies - cross feature dependencies are not supported
         // assuming only core compiler options are relevant for validation scenario
-        cds.compiler.compileSources({ [ftCsn.requires[0]]: baseCsn, 'feature.csn': ftCsn }, { ...super.options(), ...cds.env.cdsc ?? {}})
+        cds.compiler.compileSources({ [ftCsn.requires[0]]: baseCsn, 'feature.csn': ftCsn }, { ...super.options(), ...cds.env.cdsc ?? {} })
     }
 }