@sap/cds-dk 8.5.1 → 8.6.0

package/CHANGELOG.md

@@ -7,15 +7,35 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/).
 
-## Version 8.5.1 - 2024-12-05
+## Version 8.6.0 - 2024-12-17
 
 ### Added
 
+- `cds repl` got new option `--run` to run a server; also available through `.run` command within the REPL.
+- `cds repl` got new option `--use` to make the features of a `cds` available as globals.
+- `cds repl` got new builtin `.inspect` command to inspect object with configurable depth, e.g. `.inspect cds .depth=1`.
 - `cds watch` now detects a TypeScript project and tries to run with `tsx` if this is installed locally or globally. Otherwise a warning message is emitted.  `CDS_TYPESCRIPT=false` can be used to opt out of this behavior.
+- `cds import --group` to allow RFC importer to organize imported modules under a logical name.
+- `cds init/add` for Java projects automatically create a `package-lock.json`.
+- `cds add ias` adds IAS configuration (beta).
+- `cds add ams` adds AMS configuration (beta).
+
+### Changed
+
+- Running `cds init` in the user's home dir w/o a project name now fails. This is to prevent creation of configuration that would act as global (user) configuration leading to follow-up problems with later projects.
 
 ### Fixed
 
 - `cds add html5-repo` adds an `index.html` as `welcomePage` to the `xs-app.json`, if available.
+- `cds bind` fixes the recursive call to `mergeCredentials`.
+- `cds add` won't add a duplicated `SUBSCRIPTION_URL` if it doesn't match the template specification.
+- `cds watch` gives a better error message for TypeScript projects started with if `tsx` isn't installed.
+- `cds build` no longer throws an undefined error when processing build plugin messages.
+
+## Version 8.5.1 - 2024-12-05
+
+### Fixed
+
 - `cds build` now logs existing plugin build messages if a BuildError is thrown.
 
 ## Version 8.5.0 - 2024-11-26
@@ -34,8 +54,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/).
 - The existing `cds watch --debug` is now an alias to `cds watch --inspect`.
 - `cds add cloud-logging` adds cloud-logging as an alternative for application logging in Kyma.
 - `cds add cloud-logging --with-telemetry` or `cds add telemetry` adds cloud-logging as well as support for `cap-js/telemetry` plugin in Kyma.
-- `cds add handler` now also works for Node.js projects. It creates an implementation file for each service with event handlers for all entites and actions.
-- `cds add esm` creates ESM-compatible Node.js projects. Sample code added by `add sample` and `add handler` will respect this setting if added aftwards. Existing code will not be adjusted by `cds add esm`, though.
+- `cds add handler` now also works for Node.js projects. It creates an implementation file for each service with event handlers for all entities and actions.
+- `cds add esm` creates ESM-compatible Node.js projects. Sample code added by `add sample` and `add handler` will respect this setting if added afterwards. Existing code will not be adjusted by `cds add esm`, though.
 
 ### Fixed
 

package/bin/cds.js

@@ -279,9 +279,8 @@ function _prepareTsIfNeeded(cds) {
       }
       catch (e) {
         if (e.code !== 'MODULE_NOT_FOUND') throw e
-        // cds.root may for some subcommands not point to the correct directory (e.g. cds w where users can pass a project directory)
-        // showing the full detected path should give the user an idea whether this info is relevant for them
-        console.error(`Detected ${tsconfig}. If this is a TypeScript project, consider running commands using 'cds-ts' or 'cds-tsx' instead of 'cds'.\n`)
+        console.error(`Error: detected ${tsconfig}, but could not run with 'tsx'. Enable Typescript with\n  npm install -D tsx typescript\n`)
+        DEBUG && console.error(e)
       }
     }
   }

package/bin/deploy/index.js

@@ -78,22 +78,20 @@ module.exports = Object.assign(deploy, {
 
     *--model-only*
 
-      This is a schema evolution option, to only update the information about
-      the prior cds model. In combination with *--dry* it writes the CSN to
-      stdout, so you can store it to a file. Use that to migrate existing
-      databases to auto schema evolution.
+      Schema evolution: only update the information about the prior cds model.
+      In combination with *--dry* it writes the CSN to stdout, so you can store it to a file.
+      Use that to migrate existing databases to auto schema evolution.
 
     *--delta-from* <filename>
 
-      This is a schema evolution option, to read the information about the
-      prior cds model from the given file, which has been created by
-      *cds deploy --model-only --dry*. When used with *--dry* it writes the
-      generated SQL to stdout.
+      Schema evolution: read the information about the prior cds model from the given file,
+      which has been created by *cds deploy --model-only --dry*. When used with *--dry* it writes
+      the generated SQL to stdout.
 
-    *--script
+    *--script*
 
-      This is a schema evolution option to be used with --delta-from to generate
-      a script of SQL statements to then check and execute manually or for usage with tools such as LiquiBase.
+      Schema evolution: together with *--delta-from* generate a script of SQL
+      statements to then check and execute manually or for usage with tools such as LiquiBase.
       This script might contain potentially lossy statements!
 
 

package/bin/import.js

@@ -1,8 +1,8 @@
 module.exports = Object.assign(_import, {
     _name: 'import',
-    options: ['--out', '--as', '--name', '--include-namespaces', '--from', '--config', '--destination'],
+    options: ['--out', '--as', '--name', '--include-namespaces', '--from',  '--config', '--destination', '--group'],
+    shortcuts: ['-o', '-as',   '-n',     '-ns',                  undefined, '-c',       undefined,       undefined, '-', '-f'],
     flags: ['--dry', '--force', '--no-copy', '--no-save', '--keep-namespace', '--beta'],
-    shortcuts: ['-o', '-as', '-n', '-ns', undefined, '-c', undefined, '-', '-f'],
     help: `
 # SYNOPSIS
 
@@ -72,6 +72,10 @@ module.exports = Object.assign(_import, {
         The name of the module to be imported
         Requires valid system credentials as the import connects to the system to fetch the metadata.
 
+    *--group*
+        Logical group under which the remote service is imported and registered. This could be a
+        function group or an application component name. Defaults to the destination name.
+
 # EXAMPLES
 
     cds import ~/Downloads/API_BUSINESS_PARTNER.edmx

package/bin/repl.js

@@ -1,13 +1,35 @@
-
-module.exports = Object.assign (repl, { options: [], help: `
+module.exports = Object.assign (repl, {
+  options: [ '--run', '--use' ],
+  shortcuts: [ '-r', '-u' ],
+  help: `
 # SYNOPSIS
 
-    *cds r | repl*
+    *cds repl* [ <options> ]
 
     Launches into a read-eval-print-loop, an interactive playground to
     experiment with cds' JavaScript APIs. See documentation of Node.js'
     REPL for details at _http://nodejs.org/api/repl.html_
 
+# OPTIONS
+
+    *-r | --run* <project>
+
+      Runs a cds server from a given CAP project folder, or module name.
+      You can then access the entities and services of the running server.
+      It's the same as using the repl's builtin _.run_ command.
+
+    *-u | --use* <cds feature>
+
+      Loads the given cds feature into the repl's global context. For example,
+      if you specify _xl_ it makes the _cds.xl_ module's methods available.
+      It's the same as doing _{ref,val,xpr,...} = cds.xl_ within the repl.
+
+# EXAMPLES
+
+    *cds repl* --run bookshop
+    *cds repl* --run .
+    *cds repl* --use cds.ql
+
 # SEE ALSO
 
     *cds eval*  to evaluate and execute JavaScript.
@@ -15,6 +37,7 @@ module.exports = Object.assign (repl, { options: [], help: `
 
 async function repl (_, options={}) {
 
+  const GREEN = '\x1b[32m', RESET = '\x1b[0m'
   const cds = require('../lib/cds')
   console.log('\x1b[32m\x1b[1m'+'Welcome to cds repl v', cds.version, '\x1b[0m')
 
@@ -22,8 +45,12 @@ async function repl (_, options={}) {
   inspect.defaultOptions.colors = true
   inspect.defaultOptions.depth = 11
 
+  Object.defineProperty (cds,'repl',{value:true})
+  let context={}, repl = { context, displayPrompt(){} }
+  if (options.run) await _run (options.run)
+  if (options.use) _export (...options.use.split(','))
 
-  const repl = require('repl').start ({
+  repl = require('repl').start ({
     ...options,
     ignoreUndefined: true,
     useGlobal: true,
@@ -33,7 +60,8 @@ async function repl (_, options={}) {
     }
   })
 
-  Object.defineProperty (cds,'repl',{value:repl})
+  if (Object.keys(context).length) Object.assign (repl.context, context)
+
   cds.extend (repl.context) .with ( class {
     get Foo() { return ctx.Foo ??= new cds.entity({ name: 'Foo' }) }; set Foo(v) { ctx.Foo = v }
     get Bar() { return ctx.Bar ??= new cds.entity({ name: 'Bar' }) }; set Bar(v) { ctx.Bar = v }
@@ -41,61 +69,12 @@ async function repl (_, options={}) {
   } .prototype )
   const ctx={}
 
-  repl.defineCommand ('run', {
+  repl.defineCommand ('run', { action: _run,
     help: 'Runs a cds server from a given CAP project folder, or module name like @capire/bookshop.',
-    async action (project) {
-      // await cds.exec ('--project', project, '--port', '0')
-      await cds.test (project)
-
-      const GREEN = '\x1b[32m', RESET = '\x1b[0m'
-      console.log ('------------------------------------------------------------')
-      console.log ('Following are made available as repl globals:')
-      console.log()
-      let ntt = _export ('entities')
-      let srv = _export ('services')
-      console.log()
-      console.log('Simply type e.g.', GREEN+ntt+RESET, 'or', GREEN+srv+RESET, 'in the prompt to use the respective objects.')
-      console.log()
-      this.displayPrompt()
-
-      function _export (cds_property) {
-        let exports = cds[cds_property], first
-        console.log (`from cds.${cds_property}: {`)
-        for (let each in exports) {
-          if (each.includes('.')) continue
-          repl.context[each] = exports [each]
-          console.log (`  ${GREEN}${each}${RESET},`)
-          first ??= each
-        }
-        console.log (`}`)
-        return first
-      }
-    },
   })
 
-  repl.defineCommand ('inspect', {
+  repl.defineCommand ('inspect', { action: _inspect,
     help: 'Sets options for util.inspect, e.g. `.inspect .depth=1`.',
-    async action (_args) {
-      const args = _args.split(' '), subjects={}, options = {}, defaults = inspect.defaultOptions
-      for (let each of args) {
-        // args of shape .<option>=<value> set inspect options
-        if (each[0] === '.') each = eval(`options${each}`)
-        // others are subjects to inpsect with given options
-        else subjects[each ||= 'defaults'] = each === 'defaults' ? defaults : function _recurse (o,slug) {
-          const [ head,...tail ] = slug, x = o[head]
-          if (tail.length && x && typeof x === 'object') return _recurse (x,tail)
-          else return x
-        } (repl.context, each.split('.'))
-      }
-      // if no subjects were given, just set the options globally
-      if (!Object.keys(subjects).length) {
-        Object.assign (defaults, options)
-        console.log('\n', 'updated node:util.inspect.defaultOptions with:', options)
-      } else for (let [each,subject] of Object.entries(subjects))
-        console.log ('\n'+each+':', inspect (subject, options))
-      console.log()
-      this.displayPrompt()
-    }
   })
 
   repl.history = new Array(222)
@@ -108,6 +87,53 @@ async function repl (_, options={}) {
   process.on('uncaughtException', console.error)
   process.on('unhandledRejection', console.error)
 
+  async function _run (project) {
+    await cds.test (project) // await cds.exec ('--project', project, '--port', '0')
+    _export ('entities', 'services')
+  }
+
+  function _export (...cds_features) {
+    console.log()
+    console.log ('------------------------------------------------------------------------')
+    console.log ('Following variables are made available in your repl\'s global context:')
+    console.log()
+    for (let each of cds_features) {
+      let module = cds[each]
+      console.log (`from cds.${each}: {`)
+      for (let p in module) {
+        if (p in global || p.startsWith('_') || p.includes('.')) continue
+        console.log (`  ${GREEN}${p}${RESET},`)
+        repl.context[p] = module [p]
+      }
+      console.log (`}`)
+      console.log()
+    }
+    console.log('Simply type e.g.', GREEN+ Object.keys(context).at(-1) +RESET, 'in the prompt to use the respective objects.')
+    console.log()
+    repl.displayPrompt()
+  }
+
+  async function _inspect (_args) {
+    const args = _args.split(' '), subjects={}, options = {}, defaults = inspect.defaultOptions
+    for (let each of args) {
+      // args of shape .<option>=<value> set inspect options
+      if (each[0] === '.') each = eval(`options${each}`)
+      // others are subjects to inpsect with given options
+      else subjects[each ||= 'defaults'] = each === 'defaults' ? defaults : function _recurse (o,slug) {
+        const [ head,...tail ] = slug, x = o[head]
+        if (tail.length && x && typeof x === 'object') return _recurse (x,tail)
+        else return x
+      } (repl.context, each.split('.'))
+    }
+    // if no subjects were given, just set the options globally
+    if (!Object.keys(subjects).length) {
+      Object.assign (defaults, options)
+      console.log('\n', 'updated node:util.inspect.defaultOptions with:', options)
+    } else for (let [each,subject] of Object.entries(subjects))
+      console.log ('\n'+each+':', inspect (subject, options))
+    console.log()
+    repl.displayPrompt()
+  }
 }
 
 if (!module.parent) repl()

package/lib/bind/cfKeyProvider.js

@@ -88,16 +88,17 @@ module.exports = new class CFKeyProvider {
     async _resolveManagedService(instanceObj, instance, key, org, space, customCredentials) {
         const create = (cds.cli.command === 'bind' || cds.cli.command === 'deploy') && !cds.cli.options['no-create-service-key']
         const silent = (cds.cli.options.json || cds.cli.command === 'env') && !DEBUG
-        const credentials = await cfUtil.getOrCreateServiceKey(instanceObj, key, {}, { create, silent });
+        const planObj = await this.getPlan(instanceObj.relationships.service_plan.data.guid);
+        const offeringObj = await this.getOffering(planObj.relationships.service_offering.data.guid);
+        const parameters = offeringObj.name === "identity" ? { "credential-type": "X509_GENERATED", "app-identifier" : "cds_bind" } : {};
 
+        const credentials = await cfUtil.getOrCreateServiceKey(instanceObj, key, parameters, { create, silent });
         if (!credentials) {
             let message = `No service key ${bold(key)} found for service instance ${bold(instance)}.\n\n`;
             message += `Use ${bold(`cf create-service-key ${instanceObj.name} ${key} [-c ...]`)} to create the required service key.`;
             throw message;
         }
 
-        const planObj = await this.getPlan(instanceObj.relationships.service_plan.data.guid);
-        const offeringObj = await this.getOffering(planObj.relationships.service_offering.data.guid);
         const resolvedBinding = {
             binding: {
                 type: "cf",

package/lib/bind/index.js

@@ -118,7 +118,7 @@ function mergeCredentials(credentials, customCredentials) {
             if (!credentials[key]) {
                 credentials[key] = {};
             }
-            credentials[key] = this.mergeCredentials(credentials[key], customCredentials[key]);
+            credentials[key] = mergeCredentials(credentials[key], customCredentials[key]);
         } else {
             credentials[key] = customCredentials[key];
         }

package/lib/build/buildTaskEngine.js

@@ -333,7 +333,7 @@ The higher the value the earlier the plugin is run.`
         // flatten
         messages = messages.reduce((acc, m) => acc.concat(m), [])
         // filter according to log-level
-        const filteredMessages = messages.filter(message => !message.severity || logLevelIdx >= SEVERITIES.indexOf(message.severity))
+        const filteredMessages = messages.filter(message => message && (!message.severity || logLevelIdx >= SEVERITIES.indexOf(message.severity)))
         // remove duplicates
         deduplicateMessages(filteredMessages)
         // sort

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

@@ -1,5 +1,7 @@
 apiVersion: v2
 description: A Helm Chart for creating a Content Deployment job
 name: content-deployment
+sources:
+- https://github.tools.sap/unified-runtime/content-deployment
 type: application
-version: 1.6.3
+version: 1.7.0

package/lib/build/plugins/helm/files/subcharts/content-deployment/templates/_helpers.tpl

@@ -115,12 +115,10 @@ Name of the imagePullSecret
 {{ $ips := (dict "local" .Values.imagePullSecret "global" .Values.global.imagePullSecret) }}
 {{- if $ips.local.name }}
 {{- $ips.local.name }}
-{{- else if $ips.global.name }}
-{{- $ips.global.name }}
-{{- else if or $ips.local.dockerconfigjson $ips.global.dockerconfigjson }}
+{{- else if or (and $ips.local $ips.local.dockerconfigjson) (and $ips.global $ips.global.dockerconfigjson) }}
 {{- include "content-deployment.internal.fullname" . }}
-{{- else }}
-{{- "image-pull-secret" }}
+{{- else if and $ips.global $ips.global.name }}
+{{- $ips.global.name }}
 {{- end }}
 {{- end }}
 

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

@@ -1,5 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema",
+    "$id": "https://github.tools.sap/unified-runtime/content-deployment/blob/main/values.schema.json",
     "type": "object",
     "required": [
         "image", "bindings"
@@ -23,22 +24,6 @@
                         "dockerconfigjson": {
                             "type": "string"
                         }
-                    },
-                    "dependencies": {
-                        "name": {
-                            "not": {
-                                "required": [
-                                    "dockerconfigjson"
-                                ]
-                            }
-                        },
-                        "dockerconfigjson": {
-                            "not": {
-                                "required": [
-                                    "name"
-                                ]
-                            }
-                        }
                     }
                 },
                 "image": {

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

@@ -1,12 +1,11 @@
 # Helm global values, for more information, see https://helm.sh/docs/chart_template_guide/subcharts_and_globals/#global-chart-values
 global:
   # Image Pull Secret configuration, for more information, see https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
-  imagePullSecret: {}
-  # Name of the Kubernetes Secret, used as an image pull secret (must be of type kubernetes.io/dockerconfigjson). Can't be used with the `dockerconfigjson` option.
-  # name: ""
-  # The content for the dynamically generated Kubernetes Secret, which will be used as an image pull secret. Can't be used with the `name` option.
-  # dockerconfigjson: ""
-  # Either name or repository is required.
+  imagePullSecret:
+    # Name of the Kubernetes Secret, used as an image pull secret (must be of type kubernetes.io/dockerconfigjson).
+    name: image-pull-secret
+    # The content for the dynamically generated Kubernetes Secret, which will be used as an image pull secret.
+    # dockerconfigjson: ""
   image: {}
   # registry: gcr.io/my-project
   # tag: latest
@@ -15,7 +14,7 @@ global:
     _internal:
       content-deployment:
         versions:
-          1.6.3: true
+          1.7.0: true
 # Will be used instead of the `.Chart.Name`, e.g. when generating the Deployment name.
 # nameOverride: name
 

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

@@ -2,5 +2,7 @@ apiVersion: v2
 description: A Helm chart for web app
 kubeVersion: '>= 1.21'
 name: web-application
+sources:
+- https://github.tools.sap/unified-runtime/web-application
 type: application
-version: 1.17.2
+version: 1.20.0

package/lib/build/plugins/helm/files/subcharts/web-application/templates/_helpers.tpl

@@ -29,6 +29,22 @@ Define Host for the APIRule
 {{- end }}
 {{- end }}
 
+{{/*
+Define Hosts for the APIRule (since v2alpha1)
+*/}}
+{{- define "web-application.internal.exposeHosts" -}}
+{{- if .Values.expose.hosts }}
+{{ .Values.expose.hosts | toYaml }}
+{{- else }}
+{{- $name := (include "web-application.fullname" .) }}
+{{- if hasPrefix $name .Release.Namespace }}
+- {{ .Release.Namespace }}
+{{- else }}
+- {{ printf "%s-%s" $name .Release.Namespace | trunc 63 | trimSuffix "-" }}
+{{- end }}
+{{- end }}
+{{- end }}
+
 {{/*
 Returns the TENANT_HOST_PATTERN if defined
 */}}
@@ -92,12 +108,10 @@ Name of the imagePullSecret
 {{ $ips := (dict "local" .Values.imagePullSecret "global" .Values.global.imagePullSecret) }}
 {{- if $ips.local.name }}
 {{- $ips.local.name }}
-{{- else if $ips.global.name }}
-{{- $ips.global.name }}
-{{- else if or $ips.local.dockerconfigjson $ips.global.dockerconfigjson }}
+{{- else if or (and $ips.local $ips.local.dockerconfigjson) (and $ips.global $ips.global.dockerconfigjson) }}
 {{- include "web-application.fullname" . }}
-{{- else }}
-{{- "image-pull-secret" }}
+{{- else if and $ips.global $ips.global.name }}
+{{- $ips.global.name }}
 {{- end }}
 {{- end }}
 
@@ -210,5 +224,11 @@ If release name contains chart name it will be used as service instance name.
 {{- if .checkValues.failureThreshold }}
   failureThreshold: {{ .checkValues.failureThreshold }}
 {{- end }}
+{{- if .checkValues.successThreshold }}
+  successThreshold: {{ .checkValues.successThreshold }}
+{{- end }}
+{{- if .checkValues.timeoutSeconds }}
+  timeoutSeconds: {{ .checkValues.timeoutSeconds }}
+{{- end }}
 {{- end }}
 {{- end }}

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

@@ -1,19 +1,28 @@
 {{- if .Values.expose.enabled -}}
+{{- if .Values.expose.APIRule.experimental -}}
+apiVersion: gateway.kyma-project.io/v2alpha1
+{{ else }}
 apiVersion: gateway.kyma-project.io/v1beta1
+{{- end }}
 kind: APIRule
 metadata:
   name: {{ include "web-application.fullname" . }}
   labels: {{- include "web-application.labels" . | nindent 4 }}
 spec:
-  gateway: {{tpl .Values.expose.gateway $ }}
+  gateway: {{ tpl .Values.expose.gateway $ }}
+  {{- if .Values.expose.APIRule.experimental }}
+  hosts:
+    {{- include "web-application.internal.exposeHosts" . | indent 4 }}
+  {{- else }}
   host: {{ include "web-application.internal.exposeHost" . }}
+  {{- end }}
   service:
     name: {{ include "web-application.fullname" . }}
     port: {{ .Values.port }}
   rules:
-    {{- toYaml .Values.expose.rules | nindent 6 }}
-  {{ if .Values.expose.corsPolicy }}
+    {{- toYaml .Values.expose.rules | nindent 4 }}
+  {{- if .Values.expose.corsPolicy }}
   corsPolicy:
-    {{- toYaml .Values.expose.corsPolicy | nindent 6 }}
+    {{- toYaml .Values.expose.corsPolicy | nindent 4 }}
   {{- end }}
 {{- end }}

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

@@ -11,7 +11,12 @@ metadata:
   labels: {{- include "web-application.labels" $ | nindent 4 }}
 spec:
   serviceInstanceName: {{include "web-application.internal.serviceInstanceName" (dict "binding" $mergedParams "root" $) }}
-  secretKey: credentials
+  {{- if $mergedParams.secretKey }}
+  secretKey: {{ $mergedParams.secretKey }}
+  {{- end }}
+  {{- if $mergedParams.serviceInstanceNamespace }}
+  serviceInstanceNamespace: {{ $mergedParams.serviceInstanceNamespace }}
+  {{- end }}
   {{- if $mergedParams.externalName }}
   externalName: {{ $mergedParams.externalName }}
   {{- end }}