@sap/cds-dk 8.8.2 → 8.9.0

package/CHANGELOG.md

@@ -7,6 +7,29 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/).
 
+## Version 8.9.0 - 2025-03-31
+
+### Added
+
+- `cds import` now adds Cloud SDK dependencies to package.json if an OData service is imported.
+- `cds deploy --to hana --on k8s` is now supported.
+- `cds up` automates freezing dependencies, building, and deploying your application.
+- `cds pull` includes existing extensions if the server is configured accordingly.
+
+### Changed
+
+- `cds build` logging is simplified.
+- `cds add html5-repo` ignores folders in `app/` starting with `.`
+
+### Fixed
+
+- `cds add telemetry` is order-independent with other `cds add` commands for Java.
+- Build task `mtx-extension` now fails with exit code 1 in case of build errors.
+
+### Removed
+
+- Removed `before:cds-watch` script.
+
 ## Version 8.8.2 - 2025-03-21
 
 ### Fixed
@@ -18,9 +41,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/).
 ### Fixed
 
 - `cds init` uses latest Maven Java archetype version 3.8.0 for creating Java projects.
-- `cds import` json schema now contains correct references.
 - `cds init --add lint` writes complete eslint.config.mjs.
 - `cds import` no longer fails with an `EXDEV` error in `docker` containers.
+- `cds import` json schema now contains correct references.
 
 ## Version 8.8.0 - 2025-03-03
 

package/bin/deploy/index.js

@@ -1,7 +1,7 @@
 module.exports = Object.assign(deploy, {
-  options: ['--to', '--for', '--out', '--tunnel-address', '--vcap-file', '--delta-from' ],
+  options: ['--to', '--for', '--out', '--on', '--tunnel-address', '--vcap-file', '--delta-from' ],
   flags: ['--no-save', '--auto-undeploy', '--dry', '--xdry', '--with-mocks', '--store-credentials', '--no-build', '--model-only', '--script', '--with-auto-schema-evolution' ],
-  shortcuts: ['-2', '-4', '-o'],
+  shortcuts: ['-2', '-4', '-o', '-n'],
   help: `
 # SYNOPSIS
 
@@ -46,6 +46,10 @@ module.exports = Object.assign(deploy, {
       Write the DDL statements to the given file.
       Not available in combination with '--to hana'.
 
+    *--on* | *-n* cf|k8s
+
+      The target platform. Default is 'cf'.
+
     *--with-mocks*
 
       Also create tables for all entities from imported models.
@@ -103,7 +107,7 @@ module.exports = Object.assign(deploy, {
 
 `})
 
-async function deploy(_model, options) { // NOSONAR
+async function deploy(_model, options) {
 
   if (process.stdout.isTTY && options['no-save']) {
     console.warn('Option --no-save is deprecated. By default, package.json will no longer be modified.')

package/bin/init.js

@@ -7,7 +7,7 @@ cds.root = join(process.cwd(), process.argv[3]?.startsWith('--') ? '.' : process
 
 module.exports = Object.assign(init, {
     handleCompletion,
-    options: ['--add', '--java:mvn', '--java:package', '--lint:custom', '--lint:custom:example', '--no-db'],
+    options: ['--add', '--java:mvn', '--java:package', '--lint:custom', '--lint:custom:example', '--no-db', '--base'],
     shortcuts: ['-a'],
     flags: ['--java', '--force', '--verbose'],
     help: `
@@ -20,10 +20,6 @@ module.exports = Object.assign(init, {
 
 # OPTIONS
 
-    *--java*
-
-        Create a CAP Java project.
-
     *--add* <feature | comma-separated list of features>
 
         Add one or more features while creating the project.
@@ -31,6 +27,10 @@ module.exports = Object.assign(init, {
 
 ${require('../lib/init').help()}
 
+    *--java*
+
+        Create a CAP Java project.
+
     *--java:mvn* <Comma separated maven archetype specific parameters>
 
         Add the given parameters to the archetype call.

package/bin/repl.js

@@ -46,6 +46,7 @@ async function repl (_, options={}) {
   inspect.defaultOptions.depth = 11
 
   Object.defineProperty (cds,'repl',{value:true})
+  await cds.service.bindings
   let context={}, repl = { context, displayPrompt(){} }
   if (options.run) await _run (options.run)
   if (options.use) _export (...options.use.split(','))
@@ -87,6 +88,9 @@ async function repl (_, options={}) {
   process.on('uncaughtException', console.error)
   process.on('unhandledRejection', console.error)
 
+  // Ugly hack to prevent "[ERR_INVALID_REPL_INPUT]: Listeners for `uncaughtException` cannot be used in the REPL" errors caused by winston when connecting to remote services
+  process.on = (event, listener) => event !== 'uncaughtException' && event !== 'unhandledRejection' && process.addListener(event, listener)
+
   async function _run (project) {
     await cds.test (project) // await cds.exec ('--project', project, '--port', '0')
     _export ('entities', 'services')

package/bin/test.js

@@ -1,5 +1,7 @@
-const {resolve} = require, _local = id => resolve (id, { paths: [ process.cwd(), __dirname ] })
-const require = id => module.require (_local(id)) // overwrite require so that navigation in VS Code works below
+// Overwrite require to support IntelliSense in VS Code...
+const {resolve} = require, paths = [ process.cwd(),  __dirname ]
+require = id => module.require (resolve(id,{paths})) // eslint-disable-line no-global-assign
 
-// eslint-disable-next-line cds-dk/use-api-require, cds-dk/use-relative-require
-module.exports = require('@sap/cds/bin/test')
+// FIXME: that check below doesn't work correctly!
+// eslint-disable-next-line cds-dk/no-missing-dependencies
+module.exports = require ('@cap-js/cds-test/bin/chest.js')

package/bin/up.js

@@ -0,0 +1,77 @@
+module.exports = Object.assign(up, {
+  options: ['--to'],
+  shortcuts: ['-2'],
+  flags: [],
+  help: `
+# SYNOPSIS
+
+  *cds up*
+
+  Builds and deploys the application to Cloud Foundry or Kubernetes.
+
+# OPTIONS
+
+  *-2* | *--to* cf|k8s
+
+    The platform to deploy to. Default is 'cf'.
+
+# EXAMPLES
+
+  *cds up*
+  *cds up --to k8s*
+`})
+
+const { execSync } = require('node:child_process')
+const cds = require('../lib/cds')
+const { highlight } = require('../lib/util/term')
+const { exists, path: { join } } = cds.utils
+const { readProject } = require('../lib/init/projectReader')
+
+const run = cmd => {
+  console.log(highlight(cmd))
+  try {
+    execSync(cmd, { stdio: 'inherit', env: { ...process.env, FORCE_COLOR: cds.utils.colors.enabled }})
+  } catch (error) {
+    throw error.message
+  }
+}
+
+async function up() {
+  const { apps, appName, hasMultitenancy, hasApprouter, hasXsuaa } = readProject()
+
+  for (const { app } of apps) {
+    const appPath = join(cds.root, cds.env.folders.app, app)
+    if (exists(join(appPath, 'package.json')) && !exists(join(appPath, 'package-lock.json'))) {
+      run(`npm i --package-lock-only --prefix ${appPath}`)
+    }
+  }
+
+  if (hasMultitenancy && !exists('mtx/sidecar/package-lock.json')) {
+    run('npm i --package-lock-only --prefix mtx/sidecar')
+  }
+
+  if (cds.cli.options.to === 'k8s') {
+    if (!exists('chart')) run('cds add helm')
+    if (!exists('containerize.yaml')) run('cds add containerize')
+  } else {
+    if (!exists('mta.yaml')) {
+      run('cds add mta')
+      run('npm i --package-lock-only')
+    } else if (!exists('package-lock.json')) {
+      run('npm i --package-lock-only')
+    }
+  }
+
+  if (cds.cli.options.to === 'k8s') {
+    run('ctz containerize.yaml --log --push')
+    let helmUpgrade = `helm upgrade --install ${appName} ./gen/chart --wait --wait-for-jobs`
+    if (hasXsuaa) helmUpgrade += ' --set-file xsuaa.jsonParameters=xs-security.json'
+    run(helmUpgrade)
+    run(`kubectl rollout status deployment ${appName}-srv --timeout=8m`)
+    if (hasApprouter) run(`kubectl rollout status deployment ${appName}-approuter --timeout=8m`)
+    if (hasMultitenancy) run(`kubectl rollout status deployment ${appName}-sidecar --timeout=8m`)
+  } else {
+    run('mbt build -t gen --mtar mta.tar')
+    run('cf deploy gen/mta.tar -f')
+  }
+}

package/bin/watch.js

@@ -1,6 +1,3 @@
-const path = require('node:path')
-const { execSync } = require('node:child_process')
-
 const watchOnlyOptions = ['--ext', '--livereload', '--open', '--debug', '--inspect', '--inspect-brk', '--include', '--exclude']
 
 module.exports = Object.assign ( watch, {
@@ -174,8 +171,6 @@ async function watch ([cwd], {
   const { bindingEnv, updateBindings } = require('../lib/bind/shared')
   Object.assign(env, await bindingEnv({cwd}))
 
-  runBeforeScript('watch', {cwd})
-
   const nodemon = require('../lib/watch/node-watch')
   const watcher = nodemon ({
     script: resolve(__dirname,'../lib/watch/watched'), cwd, env, ext, ignore, watched,
@@ -251,41 +246,3 @@ function installed(id, ...paths) {
   try { return require.resolve (id, { paths }) }
   catch(e) { if (e.code !== 'MODULE_NOT_FOUND')  throw e }
 }
-
-/**
- * Runs a before-script for the given task.
- * For now, this will only be used for cds watch,
- * but could be used for other tasks in the future,
- * therefore the generic name/ implementation.
- * @param {string} task - The task to run the before-script for.
- * @param {object} options - Options object containing the cwd.
- * @param {[string]} options.cwd - The current working directory.
- */
-function runBeforeScript(task, {cwd}) {
-  cwd ??= '.'
-  try {
-    const packageJson = getPackageJson(cwd)
-    const beforeScript = `before:cds-${task}`
-    if (packageJson.scripts?.[beforeScript]) {
-      DEBUG(`running before-script '${beforeScript}' for cds ${task}`)
-      const cmd = `npm run ${beforeScript} --prefix "${cwd}"`
-      execSync(cmd)
-    }
-  } catch (e) {
-    // ignore not finding package.json (happens during cds init)
-    if (!(e.code === 'MODULE_NOT_FOUND' && e.message.includes('package.json'))) throw e
-  }
-}
-
-/**
- * @param {string} project - The project to get the package.json from.
- * @returns {JSON} The package.json of the given project.
- */
-function getPackageJson (project) {
-  try {
-    return require(path.join(project, 'package.json'))
-  } catch (e) {
-    if (e.code !== 'MODULE_NOT_FOUND') throw e
-    return require(path.join(cds.root, project, 'package.json'))
-  }
-}

package/lib/bind/shared.js

@@ -33,7 +33,7 @@ const PreferredKinds = {
     'saas-registry': 1
 }
 
-async function bind(options) {
+async function bind(options = { on: 'cf' }) {
     let on
     switch (options.on) {
         case 'k8s':

package/lib/build/buildTaskEngine.js

@@ -1,5 +1,6 @@
-const fs = require('fs')
-const path = require('path')
+const fs = require('node:fs')
+const path = require('node:path')
+const { inspect } = require('node:util')
 const cds = require('../cds'), { _log: log } = cds
 const { sortMessagesSeverityAware, deduplicateMessages, CompilationError } = cds.compiler
 const { relativePaths, BuildError, BuildMessage, resolveRequiredSapModels, redactCredentials } = require('./util')
@@ -25,17 +26,17 @@ class BuildTaskEngine {
     async processTasks(tasks) {
         const startTime = Date.now()
 
-        console.log(`building project [${cds.root}], clean [${this.options.clean}]`)
+        tasks ??= await this.taskFactory.getTasks()
+        console.log(`building project with`, inspect({
+            versions: { cds: cds.version, compiler: cds.compiler.version(), dk: require('../../package.json').version },
+            target: cds.env.build.target,
+            tasks: tasks.map(({ _uses, ...task }) => task),
+            ...(!this.options.clean && { clean: this.options.clean }),
+        }, { depth: 11, colors: cds.utils.colors.enabled, compact: 3, breakLength: 250 }))
 
         DEBUG?.("cds configuration settings:")
         DEBUG?.(redactCredentials(cds.env))
 
-        console.log(`cds-dk [${require('../../package.json').version}], cds [${cds.version}], compiler [${cds.compiler.version()}], home [${cds.home}]\n`)
-
-        if (!tasks) {
-            tasks = await this.taskFactory.getTasks()
-        }
-
         // validate required @sap namespace models - log only
         const unresolved = BuildTaskEngine._resolveRequiredSapServices(tasks)
         if (unresolved.length > 0) {

package/lib/build/buildTaskFactory.js

@@ -4,7 +4,6 @@ const cds = require('../cds')
 const BuildTaskProviderFactory = require('./buildTaskProviderFactory')
 const { hasJavaNature, getProperty, getDefaultModelOptions, hasOptionValue, BuildError } = require('./util')
 const { FILE_EXT_CDS, OPTION_WS, IGNORE_DEFAULT_MODELS, NODEJS_MODEL_EXCLUDE_LIST, BUILD_TASK_NODEJS, BUILD_TASK_NODE_CF } = require("./constants")
-const term = require('../util/term')
 const DEBUG = cds.debug('cli|build')
 
 class BuildTaskFactory {
@@ -24,15 +23,6 @@ class BuildTaskFactory {
     // 3. create from cds.env.folders config data
     async getTasks() {
         const tasks = await this._createTasks()
-
-        // log build tasks
-        let tasksOutput = "{\n  build: {\n    target: " + term.info("'" + cds.env.build.target + "'") + ",\n    tasks: [\n"
-        for (let i = 0; i < tasks.length; i++) {
-            tasksOutput += "      " + BuildTaskFactory._stringifyTask(tasks[i]) + (i + 1 < tasks.length ? ",\n" : "\n")
-        }
-        tasksOutput += "    ]\n  }\n}\n"
-        console.log(tasksOutput)
-
         // always resolve tasks for input validation
         const resolvedTasks = this.providerFactory.resolveTasks(tasks)
         if (this.options.resolve) {
@@ -207,41 +197,6 @@ class BuildTaskFactory {
         task.options.model = [...new Set(taskModelPaths?.length ? taskModelPaths.concat(modelPaths) : modelPaths)]
     }
 
-    static _stringifyTask(task) {
-        // ensures identical order of properties
-        const order = ["for", "use", "src", "dest", "options"]
-        const keys = Object.keys(task).filter(key => order.includes(key)).sort((a, b) => order.indexOf(a) - order.indexOf(b))
-
-        return keys.reduce((acc, key, i) => {
-            const prefix = acc !== '{' ? ', ' : (i === 0 ? ' ' : '')
-            if (!key.startsWith('_')) {
-                // render either "for" OR "use" value
-                if (key in { src: 1, for: 1 } || (!task.for && key === 'use')) {
-                    return `${acc}${prefix}${key}: ${term.info(`'${task[key]}'`)}`
-                } else if (key === 'options') {
-                    const options = Object.entries(task.options)
-                        .map(([key, value]) => {
-                            if (Array.isArray(value)) {
-                                return `${key}: [${value.map(v => term.info(`'${v}'`)).join(', ')}]`
-                            } else if (typeof value === 'object') {
-                                const nested = Object.entries(value)
-                                    .map(([key, value]) => `${key}: ${term.info(`'${value}'`)}`)
-                                    .join(', ')
-                                return `${key}: { ${nested} }`
-                            } else {
-                                return `${key}: ${term.info(`'${value}'`)}`
-                            }
-                        })
-                        .join(', ')
-                    return `${acc}${prefix}${key}: { ${options} }`
-                } else if (key !== 'use') {
-                    return `${acc}${prefix}${key}: ${term.info(`'${task[key]}'`)}`
-                }
-            }
-            return acc
-        }, '{') + '}'
-    }
-
     /**
      * Determines the module folder from the past list that may represent files or folders w or w/o .cds file extension.
      * @param {Array} filesOrFolders

package/lib/build/plugins/helm/files/subcharts/content-deployment/Chart.yaml

@@ -2,4 +2,4 @@ apiVersion: v2
 description: A Helm Chart for creating a Content Deployment job
 name: content-deployment
 type: application
-version: 1.7.1
+version: 1.8.0

package/lib/build/plugins/helm/files/subcharts/content-deployment/templates/job.yaml

@@ -71,6 +71,14 @@ spec:
           name: tmp
         {{- include "content-deployment.internal.serviceMounts" . | nindent 8 }}
       restartPolicy: OnFailure
+      {{- if .Values.nodeSelector }}
+      nodeSelector:
+        {{- .Values.nodeSelector | toYaml | nindent 8 }}
+      {{- end }}
+      {{- if .Values.nodeAffinity }}
+      affinity:
+        {{- .Values.nodeAffinity | toYaml | nindent 8 }}
+      {{- end }}
       volumes:
       - name: tmp
         emptyDir: {}

package/lib/build/plugins/helm/files/subcharts/content-deployment/values.schema.json

@@ -496,6 +496,56 @@
                     }
                 }
             }
+        },
+        "nodeSelector": {
+            "$id": "#/properties/nodeSelector",
+            "title": "Node selector",
+            "type": "object",
+            "patternProperties": {
+                "^[-._a-zA-Z][-._a-zA-Z0-9]*$": {
+                    "type": "string"
+                }
+            }
+        },
+        "nodeAffinity": {
+            "$id": "#/properties/nodeAffinity",
+            "title": "Node affinity",
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "requiredDuringSchedulingIgnoredDuringExecution": {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "properties": {
+                        "nodeSelectorTerms": {
+                            "type": "array",
+                            "description": "A node selector terms, associated with the corresponding weight.",
+                            "items": {
+                                "$ref": "#/definitions/NodeSelectorTerm"
+                            }
+                        }
+                    },
+                    "required": ["nodeSelectorTerms"]
+                },
+                "preferredDuringSchedulingIgnoredDuringExecution": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": false,
+                        "properties": {
+                            "weight": {
+                                "type": "integer",
+                                "description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100."
+                            },
+                            "preference": {
+                                "description": "A node selector term, associated with the corresponding weight.",
+                                "$ref": "#/definitions/NodeSelectorTerm"
+                            }
+                        },
+                        "required": ["weight", "preference"]
+                    }
+                }
+            }
         }
     },
     "definitions": {
@@ -519,6 +569,43 @@
             "title": "ImagePullPolicy",
             "type": "string",
             "enum": ["Always", "IfNotPresent", "Never"]
+        },
+        "NodeSelectorRequirement": {
+            "description": "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "key": {
+                    "description": "The label key that the selector applies to.",
+                    "type": "string"
+                },
+                "operator": {
+                    "description": "Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.",
+                    "type": "string",
+                    "enum": ["In", "NotIn", "Exists", "DoesNotExist", "Gt", "Lt"]
+                },
+                "values": {
+                    "description": "An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.",
+                    "items": {
+                        "type": "string"
+                    },
+                    "type": "array"
+                }
+            },
+            "required": ["key", "operator"]
+        },
+        "NodeSelectorTerm": {
+            "description": "A null or empty node selector term matches no objects. The requirements of them are ANDed.",
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "matchExpressions": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/NodeSelectorRequirement"
+                    }
+                }
+            }
         }
     }
 }

package/lib/build/plugins/helm/files/subcharts/content-deployment/values.yaml

@@ -14,7 +14,7 @@ global:
     _internal:
       content-deployment:
         versions:
-          1.7.1: true
+          1.8.0: true
 # Will be used instead of the `.Chart.Name`, e.g. when generating the Deployment name.
 # nameOverride: name
 
@@ -97,3 +97,31 @@ ttlDaysAfterFinished: 14
 annotations:
   ## Annotations to add to the Job and underlying Pods
   job: {}
+## Node label selector. See https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector
+# nodeSelector:
+#   kubernetes.io/os: linux
+
+## Node Affinity configuration. See https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity
+# nodeAffinity:
+#   requiredDuringSchedulingIgnoredDuringExecution:
+#     nodeSelectorTerms:
+#     - matchExpressions:
+#       - key: kubernetes.io/os
+#         operator: In
+#         values:
+#         - linux
+#   preferredDuringSchedulingIgnoredDuringExecution:
+#   - weight: 1
+#     preference:
+#       matchExpressions:
+#       - key: label-1
+#         operator: In
+#         values:
+#         - key-1
+#   - weight: 50
+#     preference:
+#       matchExpressions:
+#       - key: label-2
+#         operator: In
+#         values:
+#         - key-2

package/lib/build/plugins/helm/files/subcharts/service-instance/Chart.yaml

@@ -2,4 +2,4 @@ apiVersion: v2
 description: A Helm chart for creating service instances on btp-service-operator
 name: service-instance
 type: application
-version: 1.5.2
+version: 1.6.0

package/lib/build/plugins/helm/files/subcharts/service-instance/templates/serviceinstance.yaml

@@ -27,4 +27,5 @@ spec:
   {{- end }}
   {{- if .Values.parametersFrom }}
   parametersFrom: {{ tpl (.Values.parametersFrom | toYaml) $ | nindent 4}}
+  watchParametersFromChanges: true
   {{- end }}

package/lib/build/plugins/helm/files/subcharts/service-instance/values.yaml

@@ -65,4 +65,4 @@ global:
     _internal:
       service-instance:
         versions:
-          1.5.2: true
+          1.6.0: true

package/lib/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.23.0
+version: 1.24.0

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

@@ -167,6 +167,14 @@ spec:
       {{- end }}
       restartPolicy: Always
       terminationGracePeriodSeconds: {{ .Values.terminationGracePeriodSeconds }}
+      {{- if .Values.nodeSelector }}
+      nodeSelector:
+        {{- .Values.nodeSelector | toYaml | nindent 8 }}
+      {{- end }}
+      {{- if .Values.nodeAffinity }}
+      affinity:
+        {{- .Values.nodeAffinity | toYaml | nindent 8 }}
+      {{- end }}
       topologySpreadConstraints:
       {{- range $constraint := .Values.availability.topologySpreadConstraints }}
       - labelSelector: