@sap/cds-dk 7.3.0 → 7.3.1

package/lib/init/template/helm/subcharts/web-application/values.yaml

@@ -1,27 +1,56 @@
+# 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: ""
-    # dockerconfigjson: ""
+  ## 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.
   image: {}
-    # registry: gcr.io/my-project
-    # tag: latest
+  ## Setting the imagePullPolicy, see https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy
+  # imagePullPolicy: Always
+
+  sap:
+    _internal:
+      web-application:
+        versions:
+          1.8.0: true
+## Will be used instead of the `.Chart.Name`, e.g. when generating the Deployment name.
+# nameOverride: name
+
+## Will be used as an override for the `.fullname` helper function (i.e. `.Release.Name-.Chart.Name`).
+# fullnameOverride: my-name
+
+## The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified.
+# runAsUser: 1000
 
+# Number of desired pods within the Deployment.
 replicaCount: 1
+# Application's exposed port.
 port: 8080
-#serviceAccountName: my-serviceaccount
-
-  # To use a digest, change those values like that
-  # repository: nginx@sha256
-  # tag: 2834dc507516af02784808c5f48b7cbe38b8ed5d0f4837f16e78d00deb7e7767
+## Name of the Service Account assigned to pods.
+# serviceAccountName: my-serviceaccount
 image: {}
-  # repository: repo/image
-  # registry: gcr.io/my-project
-  # tag: latest
+## To use a digest, change those values as shown
+# repository: nginx@sha256
+# tag: 2834dc507516af02784808c5f48b7cbe38b8ed5d0f4837f16e78d00deb7e7767
+## Should also include the image name (i.e. everything before the `:` sign).
+# repository: repo/image
+# registry: gcr.io/my-project
+# tag: latest
 
+# Image Pull Secret configuration, for more information, see https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
 imagePullSecret: {}
-  # name: ""
-  # dockerconfigjson: ""
+## 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: ""
+
+## Setting the imagePullPolicy, see https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy
+# imagePullPolicy: Always
 
+# List of volumes, which should be mounted into Pods, see https://kubernetes.io/docs/concepts/storage/volumes/ for full list of options
 additionalVolumes: []
 # - name: my-volume
 #   secret:
@@ -30,6 +59,7 @@ additionalVolumes: []
 #     mountPath: /etc/mysecret
 #     readOnly: true
 
+## Pod resources configuration, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ for more information
 # resources:
 #   limits:
 #     cpu: 100m
@@ -40,33 +70,40 @@ additionalVolumes: []
 #     ephemeral-storage: 1G
 #     memory: 1G
 
+## Enable or disable istio sidecars for this workload (other default is taken, e.g. namespace)
+# istio:
+#   enabled: true
+
+# Availability related configuration
 availability:
+  # The max disruption to the pods, see https://kubernetes.io/docs/concepts/workloads/pods/disruptions/ for details
   podDisruptionBudget:
     maxUnavailable: 10%
+  # 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
-    maxSkew: 1
-    whenUnsatisfiable: ScheduleAnyway
-  - topologyKey: kubernetes.io/hostname
-    maxSkew: 1
-    whenUnsatisfiable: ScheduleAnyway
-
+    - topologyKey: topology.kubernetes.io/zone
+      maxSkew: 1
+      whenUnsatisfiable: ScheduleAnyway
+    - topologyKey: kubernetes.io/hostname
+      maxSkew: 1
+      whenUnsatisfiable: ScheduleAnyway
+# Health-check configuration
 health:
+  # Liveness-probe configuration.
   liveness:
+    # HTTP path used by Kubernetes, to perform liveness-probe calls.
     path: /healthz
+  # Readiness-probe configuration.
   readiness:
+    # HTTP path used by Kubernetes, to perform readiness-probe calls.
     path: /healthz
-
-# readOnlyRootFilesystem: false
-terminationGracePeriodSeconds: 30
+# Initial timeout in seconds, during which the app must start giving the response to the liveness-probe.
 startupTimeoutSeconds: 30
+## Use read only filesystem for the Deployment.
+# readOnlyRootFilesystem: false
 
-envFrom: []
-# - configMapRef:
-#     name: my-configmap1
-# - secretRef:
-#     name: my-secret-ref1
-
+# Time in seconds after which the pod will be forcefully stopped after receiving SIGTERM.
+terminationGracePeriodSeconds: 30
 env: {}
 # env:
 #   key1: value
@@ -78,7 +115,7 @@ env: {}
 #     configMapKeyRef:
 #       name: my-configmap
 #       key: my-key
-# Also can be specified as a list
+## Also can be specified as a list
 # env:
 #   - name: key1
 #     value: value1
@@ -87,22 +124,53 @@ env: {}
 #       name: my-configmap
 #       key: my-key
 
+envFrom: []
+# - configMapRef:
+#     name: my-configmap1
+# - secretRef:
+#     name: my-secret-ref1
+
 expose:
+  ## Specifies the service's dns name for inbound external traffic. If it doesn't contain a dot, the default cluster domain will be appended.
+  # host: ""
+
+  # Expose the application to the internet.
   enabled: true
+  # Use this istio gateway for incoming traffic.
   gateway: kyma-gateway.kyma-system.svc.cluster.local
-  # host: ""
-  rules:
-  - accessStrategies:
-    - handler: allow
-    methods:
-    - GET
-    - POST
-    - PUT
-    - PATCH
-    - DELETE
-    - HEAD
-    path: /.*
+  ## Custom Istio Gateway to use with the VirtualService created using the TENANT_HOST_PATTERN.
+  ## If your TENANT_HOST_PATTERN uses top level domain for the tenants (like tenant-name.<provider>.<cluster-domain>), you need to create custom Certificate and Gateway since the default Kyma Gateway will not work.
+  # tenantGateway: tenants-gateway.my-ns.svc.cluster.local
 
+  # Rules represents collection of Rule to apply.
+  rules:
+    - accessStrategies:
+        - handler: allow
+      methods:
+        - GET
+        - POST
+        - PUT
+        - PATCH
+        - DELETE
+        - HEAD
+      path: /.*
+prometheus:
+  # Add annotations to the Service for Prometheus Service Discovery
+  enabled: false
+  # URI used by Prometheus for scraping
+  path: /metrics
+  ## Custom port for Prometheus scraping, defaults to the application port
+  # port: 8081
+# Open Telemetry support
+otlp:
+  metrics:
+    enabled: true
+    # Metrics endpoint
+    endpoint: http://telemetry-otlp-metrics.kyma-system.svc.cluster.local:4317
+  traces:
+    enabled: true
+    # Trace endpoint
+    endpoint: http://telemetry-otlp-traces.kyma-system.svc.cluster.local:4317
 networkSecurity:
   enabled: true
   # allowNamespaceInternal: true
@@ -111,14 +179,25 @@ networkSecurity:
   #   - namespace: my-namespace
   #     podLabelsSelector:
   #       app: my-app
+# RBAC configuration https://kubernetes.io/docs/reference/access-authn-authz/rbac/. Only one of "role", "clusterRole" or "rules" can be specified.
+rbac: {}
+## Name of the existing Role to use
+# role: existing-role-name
+
+## Name of the existing ClusterRole to use
+# clusterRole: existingClusterRoleName
 
+## List of RBAC rules assigned to the new Role.
+# rules:
+#   - apiGroups: [""]
+#     resources: ["pods"]
+#     verbs: ["get", "watch", "list"]
 bindings:
   defaultProperties:
     credentialsRotationPolicy:
       enabled: false
       rotationFrequency: "720h"
       rotatedBindingTTL: "24h"
-
 #   ui5-repo-servicerepo:
 #     serviceInstanceName: ui5-repo-instance
 #     externalName: ui5-kyma-binding
@@ -135,3 +214,48 @@ bindings:
 #     serviceInstanceName: hana-manual
 #   portal:
 #     fromSecret: manual-secret # user-provided-service
+
+## Annotations to add to objects
+annotations:
+  ## Annotations to add to the Deployment and underlying Pods
+  deployment: {}
+# sidecars:
+#   sidecar-1:
+#     image:
+#       repository: gcr.io/my-sidecar-1
+#       tag: latest
+#     imagePullPolicy: Always
+#     resources:
+#       limits:
+#         cpu: 100m
+#         ephemeral-storage: 1G
+#         memory: 1G
+#       requests:
+#         cpu: 100m
+#         ephemeral-storage: 1G
+#         memory: 1G
+#     env:
+#       - name: SIDECAR_PROXY_REQUEST_TIMEOUT
+#         value: "60000"
+#     envFrom:
+#       - configMapRef:
+#           name: my-configmap1
+#   sidecar-2:
+#     image:
+#       repository: gcr.io/my-sidecar-2
+#       tag: latest
+#     imagePullPolicy: Always
+#     resources:
+#       limits:
+#         cpu: 100m
+#         ephemeral-storage: 1G
+#         memory: 1G
+#       requests:
+#         cpu: 100m
+#         ephemeral-storage: 1G
+#         memory: 1G
+#     env:
+#       SIDECAR_PROXY_REQUEST_TIMEOUT: 30000
+#     envFrom:
+#       - configMapRef:
+#           name: my-configmap1

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

@@ -9,7 +9,7 @@ const {
     MTA, HELM,
     HANA, POSTGRES,
     ENTERPRISE_MESSAGING, ENTERPRISE_MESSAGING_SHARED, REDIS_MESSAGING,
-    CONNECTIVITY, DESTINATION
+    CONNECTIVITY, DESTINATION, NOTIFICATIONS
 } = require('../../constants').OPTIONS
 module.exports = class MtaTemplate extends require('../templateBase') {
 
@@ -20,7 +20,7 @@ module.exports = class MtaTemplate extends require('../templateBase') {
     }
 
     getRelatedFacets() {
-        return [APPROUTER, XSUAA, MULTITENANCY, HANA, POSTGRES, EXTENSIBILITY, ENTERPRISE_MESSAGING, ENTERPRISE_MESSAGING_SHARED, REDIS_MESSAGING, CONNECTIVITY, DESTINATION]
+        return [APPROUTER, XSUAA, MULTITENANCY, HANA, POSTGRES, EXTENSIBILITY, ENTERPRISE_MESSAGING, ENTERPRISE_MESSAGING_SHARED, REDIS_MESSAGING, CONNECTIVITY, DESTINATION, NOTIFICATIONS]
     }
 
     async run() {

package/lib/init/template/nodejs/files/.vscode/launch.json

@@ -1,7 +1,4 @@
 {
-  // Use IntelliSense to learn about possible attributes.
-  // Hover to view descriptions of existing attributes.
-  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
   "version": "0.2.0",
   "configurations": [
     {

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

@@ -0,0 +1,17 @@
+---
+modules:
+  - name: notification-content-deployment
+    type: nodejs
+    path: gen/srv
+    parameters:
+      no-route: true
+      no-start: true
+      memory: 256MB
+      disk-quota: 256MB
+      tasks:
+        - name: notification-content-deployment
+          command: "node node_modules/@cap-js/notifications/lib/content-deployment.js"
+          memory: 256MB
+          disk-quota: 256MB
+    requires:
+      - name: {{appName}}-destination

package/lib/init/template/notifications/files/notificationtypes.json.hbs

@@ -0,0 +1,16 @@
+[
+  {
+    "NotificationTypeKey": "{{ appName }}-notification",
+    "NotificationTypeVersion": "1",
+    "Templates": [
+      {
+        "Language": "en",
+        "TemplatePublic": "Hello world!",
+        "TemplateSensitive": "Hello SAP!",
+        "TemplateGrouped": "Hello universe!",
+        "TemplateLanguage": "mustache",
+        "Subtitle": "Hello {{ appName }}!"
+      }
+    ]
+  }
+]

package/lib/init/template/notifications/files/package.json.hbs

@@ -0,0 +1,14 @@
+{
+  "dependencies": {
+    "@cap-js/notifications": "*"
+  },
+  "cds":{
+    "requires":{
+       "notifications":{
+           "types" : "notificationtypes.json",
+           "destination" : "SAP_Notifications",
+           "prefix": "{{ appName }}"
+         }
+     }
+  }
+}

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

@@ -0,0 +1,52 @@
+const { join } = require('path')
+const cds = require('../../../cds')
+const { exists } = cds.utils
+const { readProject } = require('../../util/projectReader')
+const { mergeJSON, mergeYAML } = require('../../util/merge')
+const { DESTINATION } = require('../../constants').OPTIONS
+
+const { notificationTypesDeployer } = require('../_merging/registry-mta')
+
+module.exports = class NotificationsTemplate extends require('../templateBase') {
+
+  static hasFacet(env) {
+    return !!env.requires?.notifications;
+  }
+
+  async canRun() {
+    const project = await readProject()
+    const { isJava } = project
+    if (isJava) {
+      throw `'cds add notifications' is not available for JAVA yet`
+    }
+    return true
+  }
+
+  getDependencies() {
+    return [DESTINATION]
+  }
+
+  async run() {
+    const project = await readProject();
+    const { configFile } = project;
+
+    // create notificationtypes if it doesn't exist
+    if (!exists('notificationtypes.json')) {
+      await mergeJSON('notificationtypes.json', join(__dirname, 'files', 'notificationtypes.json.hbs'), project);
+    }
+
+    //update package.json
+    await mergeJSON(configFile, join(__dirname, 'files', 'package.json.hbs'), project);
+  }
+
+  async runDependentMerging() {
+    const project = await readProject();
+    const { hasMta } = project;
+
+    if (hasMta) {
+      await mergeYAML('mta.yaml', join(__dirname, 'files', 'mta.yaml.hbs'), project, {
+        additions: [notificationTypesDeployer]
+      });
+    }
+  }
+}

package/lib/util/pruneAxiosErrors.js

@@ -15,7 +15,10 @@ require('axios').interceptors.response.use(
         const { status, statusText } = response;
         let { data } = response;
         if (Buffer.isBuffer(data)) {
-            data = JSON.parse(data.toString());
+            data = data.toString();
+            try {
+                data = JSON.parse(data);
+            } catch (error) { /* unexpected; data will be included in error below */ }
         }
         const reason = data?.error /* RFC 6749 */ && (typeof data.error === 'string' ? data.error : inspect(data.error));
         const message = (url && method ? `${method.toUpperCase()} ${url} ` : '') +

package/lib/util/term.js

@@ -1,4 +1,3 @@
-// FIXME: Nicht gut, das wir das zweimal redundant haben!
 const DEBUG = /\b(y|all|cli)\b/.test(process.env.DEBUG) ? console.debug : undefined
 
 // https://docs.microsoft.com/en-us/windows/console/console-virtual-terminal-sequences
@@ -16,7 +15,7 @@ const t = module.exports.codes = {
 Object.defineProperty(module.exports, 'isTTY',  { get: () => process.stdin.isTTY && process.stderr.isTTY })
 
 const as = module.exports.as = (codes, o) => {
-  return module.exports.isTTY ? (codes + o + t.reset) : ('' + o)
+  return module.exports.isTTY && !process.env.NO_COLOR ? (codes + o + t.reset) : ('' + o)
 }
 
 const asErr = module.exports.error = o => DEBUG ? o : as(t.red + t.bold, o)

package/lib/watch/livereload-server.js

@@ -5,9 +5,14 @@ const axios = require('axios')
 const ws = require('ws')
 const express = require('express')
 const { URL } = require('url')
+const { relative, sep } = require ('path')
+
+const ext = 'css,gif,html,jpg,png,svg,ts,mjs,cjs,js,json,properties,change,variant,ctrl_variant,ctrl_variant_change,ctrl_variant_management_change'
+const watchIncludes = RegExp(`\\.(${ext.replace(/,/g,'|')})$|\\${sep}(webapp|appconfig)`)
+const watchExcludes = RegExp(`@cds-models\\${sep}|@types\\${sep}`)
 
 module.exports = class LiveReload {
-  async start(port) {
+  async start(port, cwd, delay=0) {
     if (!parseInt(port))  port = 35729
     this.files = []
 
@@ -43,7 +48,7 @@ module.exports = class LiveReload {
         this.wsServer.on('connection', (socket) => {
           DEBUG?.('Client connected')
           socket.on('message', (msg) => {
-            DEBUG?.('Client message', msg)
+            DEBUG?.('Client message', msg.toString())
             const request = JSON.parse(msg)
 
             if (request.command === 'hello') {
@@ -77,6 +82,24 @@ module.exports = class LiveReload {
         this.wsServer.close()
         server.close()
       })
+
+      // Watching for touched files...
+      const watch = require('node-watch')
+      const filter = f => {
+        const isIn = !watchExcludes.test(f) && watchIncludes.test(f)
+        if (!isIn)  DEBUG?. (`livereload ignored: ${relative(cwd||process.cwd(), f)}`)
+        // else        DEBUG?. (`livereload NOT ignored: ${relative(cwd||process.cwd(), f)}`, watchIncludes)
+        return isIn
+      }
+      const watcher = watch (cwd||process.cwd(),{ recursive:true, filter, delay:0 })
+      if (DEBUG) watcher.on('close', ()=> DEBUG('⚡️', 'cds watch - livereload file watcher closed'))
+      watcher.on('change', _coalesceEvents(delay, (files) => {
+        DEBUG?. (`livereload for: ${files.map(f => f.name)}`)
+        this.markPending(files.map(f => f.name))
+        this.reload()
+      }))
+      process.once('shutdown', ()=> watcher.close())
+
     })
   }
 
@@ -99,6 +122,19 @@ module.exports = class LiveReload {
   }
 }
 
+// reduces mutiple node-watch events in a time frame into a bulk
+function _coalesceEvents(delay, fn) {
+  let timer, cache = []
+  return function(type, name) { // node-watch callback signature
+    if (type) cache.push({type, name})
+    if (!timer) timer = setTimeout(() => {
+      fn(cache)
+      timer = null
+      cache = []
+    }, delay).unref();
+  }
+}
+
 function broadcast(data, sockets) {
   sockets.forEach(socket => {
     DEBUG?.(`Sending ${data}`)

package/lib/watch/node-watch.js

@@ -2,7 +2,7 @@ const cds = require ('../cds')
 const DEBUG = cds.debug('cli|watch')
 const { relative } = require('path')
 
-module.exports = ({ cwd, script, ext, includes=RegExp(), ignore=RegExp(), env={}, delay=200, options={} })=>{
+module.exports = ({ cwd, script, ext, ignore=RegExp(), env={}, delay=200, options={} })=>{
 
   let child
 
@@ -52,10 +52,11 @@ module.exports = ({ cwd, script, ext, includes=RegExp(), ignore=RegExp(), env={}
 
   // Watching for touched files...
   const watch = require('node-watch')
-  const include = RegExp(`\\.(${ext.replace(/,/g,'|')})$|${includes.source}`)
+  const include = RegExp(`\\.(${ext.replace(/,/g,'|')})$`)
   const filter = f => {
     const isIn = !ignore.test(f) && include.test(f)
     if (!isIn)  DEBUG?. (`ignored: ${relative(cwd||process.cwd(), f)}`)
+    // else  DEBUG?. (`NOT ignored: ${relative(cwd||process.cwd(), f)}`, include.test(f), include)
     return isIn
   }
   const watcher = watch (cwd||process.cwd(),{ recursive:true, filter, delay:0 })