@sap/cds-dk 7.7.2 → 7.8.1

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

@@ -1,57 +1,91 @@
-
 const cds = require('../../../cds')
 const { exists, fs } = cds.utils
-const { resolve, join, relative }  = require('path');
-const DEBUG = cds.debug('cli')
+const { resolve, join, relative }  = require('path')
+const { URLSearchParams } = require('url')
 const { env4 } = require('../../projectReader')
+const asJson = require('./as-json')
+const asCsv = require('./as-csv')
 
 module.exports = class DataTemplate extends require('../../plugin') {
 
+  options() {
+    return {
+      'filter': {
+        type: 'string',
+        short: 'f',
+        help: `Filter for entities matching the given pattern. If it contains meta
+        characters like '^' or '*', it is treated like a regular expression,
+        otherwise as a prefix.`
+      },
+      'data:for': {
+        type: 'string',
+        help: `Deprecated. Use '--filter' instead.`
+      },
+      'records': {
+        type: 'number',
+        short: 'n',
+        help: 'The number of records to be created for each entity.'
+      },
+      'content-type': {
+        type: 'string',
+        short: 'c',
+        help: 'The content type of the data. One of "json" or "csv".'
+      },
+      'out': {
+        type: 'string',
+        short: 'o',
+        help: 'The output target folder.'
+      }
+    }
+  }
+
   async run() {
     if (cds.cli.options.for) {
       throw `\nError: Did you mean \`... --data:for\` ?`
     }
 
-    const env = env4('production')
-
-    let dest = (typeof cds.cli.options.out === 'string') // target folder
-      ? cds.cli.options.out
-      : getDefaultTargetFolder(env);
-    dest = resolve(cds.root, dest);
+    let { force, out,
+      'content-type' : contentType='csv',
+      records=1
+    } = cds.cli.options
+    if (typeof records === 'string')  records = parseInt(records)
+    if (Number.isNaN(records) || records < 1) records = 1
 
-    const nameFilter = asRegex(cds.cli.options['data:for'])
-    const { force } = cds.cli.options
+    const [filterName, filterQueryStr] = (cds.cli.options['filter'] ?? cds.cli.options['data:for'] ?? '').split(':')
+    const nameFilter = asRegex(filterName)
+    const dataForParams = parseQueryStr(filterQueryStr)
 
-    let csn = await cds.compile.to.csn(cds.env.roots) // normal CSN
+    const env = env4('production')
+    let dest = (typeof out === 'string') // target folder
+      ? out
+      : getDefaultTargetFolder(env)
+    dest = resolve(cds.root, dest)
 
+    let csn = await cds.load(cds.env.roots) // normal CSN
     // Skip of unused reuse entities like Language, Country, Currency
     csn = cds.minify(csn)
+    csn = cds.reflect(csn) // reflected model (adds additional helper functions)
 
-    // Also include 'external' entities w/ cds.persistence.skip (similar to 'mocked' option of serve).
-    // Could be too much sometimes, but don't want to bother users w/ a separate option for this.
-    includeExternalEntities(csn)
+    const data = csn.all('entity')
+      .filter (e => e.name.match(nameFilter)) // --for prefix|regex
+      .reduce((all, e) => { all[e.name] = []; return all }, {})
 
-    csn = cds.compile.for.sql(csn, { names:env.sql.names, messages:[] })  // CSN w/ persistence information
-    csn = cds.reflect(csn); // reflected model (adds additional helper functions)
+    await asJson(data, csn, records)
 
-    csn.all('entity')
-      .filter (e => e.name.match(nameFilter)) // --for prefix|regex
-      .filter (e => !e.query) // exclude entities with queries (projection on, select from ...)
-      .filter (e => e.name !== 'DRAFT.DraftAdministrativeData' && !e.name.endsWith('.drafts')) // exclude draft stuff
-      .forEach(e => processEntity(e, dest, csn, force));
-  }
-}
+    if (contentType === 'csv') {
+      const headerOnly = !cds.cli.options['records'] // compat to old behavior which only creates headers
+      const queries = false // old behavior excluded queries
+      await asCsv(data, csn, Object.assign({ headerOnly, queries }, dataForParams))
+    }
 
-function includeExternalEntities(model) {
-  for (let each in model.definitions) {
-    const def = model.definitions[each]
-    if (def['@cds.persistence.skip'] === true) {
-      DEBUG?.('Including skipped entity '+each)
-      delete def['@cds.persistence.skip']
+    // write files
+    for (const name of Object.keys(data)) {
+      writeFileFor(csn.definitions[name], data[name], csn, dest, force)
     }
   }
-  return model
 }
+module.exports.asJson = asJson
+module.exports.asCsv = asCsv
 
 function asRegex(spec) {
   if (typeof spec === 'string') {
@@ -69,96 +103,92 @@ function asRegex(spec) {
   return /.*/
 }
 
-function processEntity (entity, dest, csn, force) {
-  let dataFileName;
-  const namespace = getNamespace(csn, entity.name);
+function parseQueryStr(queryStr) {
+  const params = new URLSearchParams(queryStr) // e.g. key1&key2=false
+  const res = Object.fromEntries(params)
+  for (let [k, v] of Object.entries(res)) {
+    if (v.length === 0 || v === 'true') res[k] = true
+    else if (v === 'false') res[k] = false
+  }
+  return res
+}
+
+function writeFileFor (entity, data, csn, dest, force) {
+  let dataFileName
+  const namespace = getNamespace(csn, entity.name)
   if (!namespace || namespace == entity.name) {
-    dataFileName = `${entity.name}.csv`;
+    dataFileName = `${entity.name}`
   }
   else {
-    const entityName = entity.name.replace(namespace + '.', '');
-    dataFileName = `${namespace}-${entityName}.csv`;
+    const entityName = entity.name.replace(namespace + '.', '')
+    dataFileName = `${namespace}-${entityName}`
   }
+  dataFileName += Array.isArray(data) ? '.json' : '.csv'
 
+  let dataFilePath = join(dest, dataFileName)
+  let fileExists = exists(join(dest, dataFileName))
   if (entity.name.endsWith('.texts')) {
     // handle '.texts' entities (for localized elements) differently:
     // if there is already file exist with '_texts' (old cds versions) - overwrite this one (when --force is used)
     // otherwise use the new '.texts' format
-    const dataFileNameOldFormat = dataFileName.replace('.texts.csv','_texts.csv');
-    const dataFilePathOldFormat = join(dest, dataFileNameOldFormat);
+    const dataFileNameOldFormat = dataFileName.replace('.texts.csv','_texts.csv')
+    const dataFilePathOldFormat = join(dest, dataFileNameOldFormat)
     if (exists(dataFilePathOldFormat)) {
-      createDataFile(true, dataFilePathOldFormat, dest, force, entity);
-      return;
+      dataFileName = dataFileNameOldFormat
+      dataFilePath = join(dest, dataFileName)
+      fileExists = true
     }
   }
 
-  const dataFilePath = join(dest, dataFileName);
-  createDataFile(exists(dataFilePath), dataFilePath, dest, force, entity);
-}
-
-function getDefaultTargetFolder (env) {
-  const { db } = env.folders
-  // csv files should be located in the 'db/data' folder unless a 'db/csv' folder already exists
-  return join(db, exists(join(db, 'csv')) ? 'csv' : 'data')
-}
-
-
-function createDataFile (isFileExists, dataFilePath, dest, force, entity) {
-  let relFilePath = dataFilePath;
+  let relFilePath = dataFilePath
   if (dataFilePath.indexOf(cds.root) === 0) {
     // use relative path in log (for readability), only when data files are added within the project
     // (potentially can be located anywhere using the --out parameter)
-    relFilePath = relative(cds.root, dataFilePath);
+    relFilePath = relative(cds.root, dataFilePath)
   }
-  if (isFileExists && !force) {
-    console.log(`Skipping ${relFilePath}`);
+
+  // continue only if file not already exists, or '--force' option provided
+  if (fileExists && !force) {
+    console.log(`Skipping ${relFilePath}`)
+    return
   }
-  else {
-    // continue only if file not already exists, or '--force' option provided
-    const dataFileContent = prepareDataFileContent(entity);
-    if (dataFileContent && dataFileContent.length) {
-      if (!exists(dest))  fs.mkdirSync(dest, {recursive: true})
-      fs.writeFileSync(dataFilePath, dataFileContent);
-      isFileExists ? console.log(`Overwriting `+relFilePath) : console.log(`Creating `+relFilePath)
-    }
+
+  if (typeof data === 'object')
+    data = JSON.stringify(data, null, 2)
+  if (data.length) {
+    if (!exists(dest))  fs.mkdirSync(dest, {recursive: true})
+    fs.writeFileSync(dataFilePath, data)
+    fileExists ? console.log(`Overwriting `+relFilePath) : console.log(`Creating `+relFilePath)
   }
 }
 
-function prepareDataFileContent (entity) {
-  const persistenceKeyNames = Object.keys(entity.keys||[])
-  return Object.entries(entity.elements)
-    .filter(([,element]) => !(element instanceof cds.Association)) // exclude associations+compositions
-    .filter(([,element]) => !!element['@cds.persistence.name']) // exclude no-persistence elements, e.g. virtual ones
-    .map (([key]) => key)
-    .sort((k1, k2) => { // sort with keys first
-      if (persistenceKeyNames.includes(k1)  && !persistenceKeyNames.includes(k2)) return -1
-      if (!persistenceKeyNames.includes(k1) && persistenceKeyNames.includes(k2))  return 1
-      return 0 // preserve original order otherwise
-    })
-    .join(',') // using comma as csv separator by default
+function getDefaultTargetFolder (env) {
+  const { db } = env.folders
+  // csv files should be located in the 'db/data' folder unless a 'db/csv' folder already exists
+  return join(db, exists(join(db, 'csv')) ? 'csv' : 'data')
 }
 
 // Logic is taken from cds-compile
 function getNamespace(csn, artifactName) {
-  const parts = artifactName.split('.');
-  let seen = parts[0];
-  const art = csn.definitions[seen];
+  const parts = artifactName.split('.')
+  let seen = parts[0]
+  const art = csn.definitions[seen]
 
   // First step is not a namespace (we faked those in the CSN)
   // No subsequent step can be a namespace then
   if (art && art.kind !== 'namespace' && art.kind !== 'context')
-    return null;
+    return null
 
 
   for (let i = 1; i < parts.length; i++) {
     // This was definitely a namespace so far
-    const previousArtifactName = seen;
-    seen = `${seen}.${parts[i]}`;
+    const previousArtifactName = seen
+    seen = `${seen}.${parts[i]}`
     // This might not be - if it isn't, return the result.
-    const currentArtifact = csn.definitions[seen];
+    const currentArtifact = csn.definitions[seen]
     if (currentArtifact && currentArtifact.kind !== 'namespace' && currentArtifact.kind !== 'context')
-      return previousArtifactName;
+      return previousArtifactName
   }
   // We came till here - so the full artifactName is a namespace
-  return artifactName;
+  return artifactName
 }

package/lib/init/template/enterprise-messaging/files/package.json.hbs

@@ -7,7 +7,8 @@
       "[{{profile}}]": {
       {{/profile}}
         "messaging": {
-          "kind": "enterprise-messaging"
+          "kind": "enterprise-messaging"{{#cloudevents}},
+          "format": "cloudevents"{{/cloudevents}}
         }
       {{#profile}}
       }

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

@@ -7,6 +7,16 @@ const { srv4, enterpriseMessaging } = require('../../registries/mta')
 
 module.exports = class EnterpriseMessagingTemplate extends require('../../plugin') {
 
+  options() {
+    return {
+      'cloudevents': {
+        type: 'boolean',
+        short: 'c',
+        help: 'Use CloudEvents formatting',
+      }
+    }
+  }
+
   async canRun() {
     const { isJava } = readProject()
     if (isJava) throw `'cds add enterprise-messaging' is not available for Java yet`
@@ -19,9 +29,12 @@ module.exports = class EnterpriseMessagingTemplate extends require('../../plugin
 
   async run() {
     const project = readProject()
-    const { configFile } = project
-    await merge(__dirname, 'files/package.json.hbs').into(configFile, { with: project })
-    await merge(__dirname, 'files/event-mesh.json.hbs').into('event-mesh.json', { with: project })
+    const { configFile, isNodejs } = project
+    if (isNodejs) {
+      project.cloudevents = cds.cli.options.cloudevents
+      await merge(__dirname, 'files/package.json.hbs').into(configFile, { with: project })
+    }
+    await merge(__dirname, 'files/event-mesh.json.hbs').into('event-mesh.json', { project })
   }
 
   async combine() {

package/lib/init/template/enterprise-messaging-shared/files/package.json.hbs

@@ -10,7 +10,8 @@
       "[{{profile}}]": {
       {{/profile}}
         "messaging": {
-          "kind": "enterprise-messaging-shared"
+          "kind": "enterprise-messaging-shared"{{#cloudevents}},
+          "format": "cloudevents"{{/cloudevents}}
         }
       {{#profile}}
       }

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

@@ -6,6 +6,16 @@ const { srv4, enterpriseMessaging } = require('../../registries/mta')
 
 module.exports = class EnterpriseMessagingSharedTemplate extends require('../../plugin') {
 
+  options() {
+    return {
+      'cloudevents': {
+        type: 'boolean',
+        short: 'c',
+        help: 'Use CloudEvents formatting',
+      }
+    }
+  }
+
   async canRun() {
     const { isJava } = readProject()
     if (isJava) throw `'cds add enterprise-messaging-shared' is not available for Java yet`
@@ -18,9 +28,12 @@ module.exports = class EnterpriseMessagingSharedTemplate extends require('../../
 
   async run() {
     const project = readProject()
-    const { configFile } = project
-    project.shortcut = !(await read(configFile)).cds?.requires?.messaging?.kind
-    await merge(__dirname, 'files/package.json.hbs').into(configFile, { project })
+    const { configFile, isNodejs } = project
+    if (isNodejs) {
+      project.shortcut = !(await read(configFile)).cds?.requires?.messaging?.kind
+      project.cloudevents = cds.cli.options.cloudevents
+      await merge(__dirname, 'files/package.json.hbs').into(configFile, { with: project })
+    }
     await merge(__dirname, 'files/event-mesh.json.hbs').into('event-mesh.json', { project })
   }
 

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

@@ -4,4 +4,4 @@ name: content-deployment
 sources:
 - https://github.tools.sap/unified-runtime/content-deployment
 type: application
-version: 1.5.0
+version: 1.6.0

package/lib/init/template/helm/files/content-deployment/templates/job.yaml

@@ -3,6 +3,10 @@ apiVersion: batch/v1
 kind: Job
 metadata:
   labels: {{- include "content-deployment.internal.labels" . | nindent 4 }}
+  {{- if or .Values.annotations.job }}
+  annotations:
+  {{- tpl (toYaml .Values.annotations.job) $ | nindent 4 }}
+  {{- end }}
   name: {{ include "content-deployment.internal.jobName" . }}
 spec:
   completions: 1
@@ -14,6 +18,9 @@ spec:
       labels: {{- include "content-deployment.internal.labels" . | nindent 8 }}
       annotations:
         container.apparmor.security.beta.kubernetes.io/{{ include "content-deployment.internal.name" . }}: runtime/default
+        {{- if or .Values.annotations.job }}
+        {{- tpl (toYaml .Values.annotations.job) $ | nindent 8 }}
+        {{- end }}
     spec:
       {{- if (include "content-deployment.internal.imagePullSecretName" .) }}
       imagePullSecrets:

package/lib/init/template/helm/files/content-deployment/values.schema.json

@@ -495,6 +495,23 @@
                     ]
                 }
             }
+        },
+        "annotations": {
+            "$id": "#/properties/annotations",
+            "title": "Additional annotations",
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "job": {
+                    "type": "object",
+                    "title": "Annotations to add to the Job",
+                    "patternProperties": {
+                        ".*": {
+                            "type": "string"
+                        }
+                    }
+                }
+            }
         }
     },
     "definitions": {

package/lib/init/template/helm/files/content-deployment/values.yaml

@@ -15,7 +15,7 @@ global:
     _internal:
       content-deployment:
         versions:
-          1.5.0: true
+          1.6.0: true
 # Will be used instead of the `.Chart.Name`, e.g. when generating the Deployment name.
 # nameOverride: name
 
@@ -93,3 +93,8 @@ ttlDaysAfterFinished: 14
 #     serviceInstanceName: hana-manual
 #   portal:
 #     fromSecret: manual-secret # user-provided-service
+
+## Annotations to add to objects
+annotations:
+  ## Annotations to add to the Job and underlying Pods
+  job: {}

package/lib/init/template/helm/files/service-instance/Chart.yaml

@@ -4,4 +4,4 @@ name: service-instance
 sources:
 - https://github.tools.sap/unified-runtime/service-instance
 type: application
-version: 1.2.0
+version: 1.3.0

package/lib/init/template/helm/files/service-instance/templates/serviceinstance.yaml

@@ -3,6 +3,10 @@ apiVersion: services.cloud.sap.com/v1
 kind: ServiceInstance
 metadata:
   labels: {{- include "service-instance.internal.labels" . | nindent 4 }}
+  {{- if or .Values.annotations.serviceInstance }}
+  annotations:
+  {{- tpl (toYaml .Values.annotations.serviceInstance) $ | nindent 4 }}
+  {{- end }}
   name: {{ include "service-instance.internal.fullname" . }}
 spec:
   serviceOfferingName: {{ .Values.serviceOfferingName }}

package/lib/init/template/helm/files/service-instance/values.schema.json

@@ -80,6 +80,22 @@
                     }
                 }
             }
+        },
+        "annotations": {
+            "$id": "#/properties/annotations",
+            "title": "Additional annotations",
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "serviceInstance": {
+                    "type": "object",
+                    "patternProperties": {
+                        ".*": {
+                            "type": "string"
+                        }
+                    }
+                }
+            }
         }
     }
-}
+}

package/lib/init/template/helm/files/service-instance/values.yaml

@@ -35,9 +35,12 @@
 #   - configMapKeyRef:
 #       name: my-cm
 #       key: cm-parameter
+
+annotations:
+  serviceInstance: {}
 global:
   sap:
     _internal:
       service-instance:
         versions:
-          1.2.0: true
+          1.3.0: true

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

@@ -21,6 +21,6 @@ srv:
       memory: {{#isJava}}1G{{/isJava}}{{^isJava}}500M{{/isJava}}
   health:
     liveness:
-      path: /
+      path: {{#isJava}}/{{/isJava}}{{^isJava}}/health{{/isJava}}
     readiness:
-      path: /
+      path: {{#isJava}}/{{/isJava}}{{^isJava}}/health{{/isJava}}

package/lib/init/template/helm/files/web-application/Chart.yaml

@@ -5,4 +5,4 @@ name: web-application
 sources:
 - https://github.tools.sap/unified-runtime/web-application
 type: application
-version: 1.11.0
+version: 1.12.0

package/lib/init/template/helm/files/web-application/templates/api-rule.yaml

@@ -12,4 +12,8 @@ spec:
     port: {{ .Values.port }}
   rules:
     {{- toYaml .Values.expose.rules | nindent 6 }}
+  {{ if .Values.expose.corsPolicy }}
+  corsPolicy:
+    {{- toYaml .Values.expose.corsPolicy | nindent 6 }}
+  {{- end }}
 {{- end }}

package/lib/init/template/helm/files/web-application/templates/network-policy.yaml

@@ -21,6 +21,21 @@ spec:
       - protocol: TCP
         port: {{ $port }}
       {{- end }}
+  - from:
+    - podSelector:
+        matchLabels:
+          app.kubernetes.io/instance: ory
+          app.kubernetes.io/name: oathkeeper
+      namespaceSelector:
+        matchLabels:
+          kubernetes.io/metadata.name: kyma-system
+    ports:
+      - protocol: TCP
+        port: {{ .Values.port }}
+      {{- range $port := .Values.networkSecurity.additionalPorts }}
+      - protocol: TCP
+        port: {{ $port }}
+      {{- end }}
 {{- end }}
 {{- if .Values.prometheus.enabled }}
   - from:

package/lib/init/template/helm/files/web-application/values.schema.json

@@ -605,6 +605,47 @@
                     "$id": "#/properties/expose/properties/gateway",
                     "type": "string"
                 },
+                "corsPolicy": {
+                    "$id": "#/properties/expose/properties/corsPolicy",
+                    "type": "object",
+                    "additionalProperties": false,
+                    "properties": {
+                        "allowHeaders": {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        },
+                        "allowMethods": {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        },
+                        "allowOrigins": {
+                            "type": "array",
+                            "items": {
+                                "type": "object",
+                                "propertyNames": {"enum": ["regex", "exact", "prefix"]},
+                                "patternProperties": {
+                                    "": { "type": "string" }
+                                  }
+                            }
+                        },
+                        "allowCredentials": {
+                            "type": "boolean"
+                        },
+                        "exposeHeaders": {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        },
+                        "maxAge": {
+                            "type": "string"
+                        }
+                    }
+                },
                 "rules": {
                     "$id": "#/properties/expose/properties/rules",
                     "type": "array",

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

@@ -15,7 +15,7 @@ global:
     _internal:
       web-application:
         versions:
-          1.11.0: true
+          1.12.0: true
 ## Will be used instead of the `.Chart.Name`, e.g. when generating the Deployment name.
 # nameOverride: name
 
@@ -158,6 +158,24 @@ expose:
         - DELETE
         - HEAD
       path: /.*
+      ## APIRule CORS policy configuration
+      ## https://kyma-project.io/#/api-gateway/user/custom-resources/apirule/04-10-apirule-custom-resource
+      # corsPolicy:
+      #   allowHeaders:
+      #     - foo
+      #     - bar
+      #   allowMethods:
+      #     - GET
+      #     - POST
+      #   allowCredentials: true
+      #   exposeHeaders:
+      #     - foo
+      #     - bar
+      #   maxAge: 3s
+      #   allowOrigins:
+      #     - regex: foo
+      #     - exact: bar
+      #     - prefix: baz
 prometheus:
   # Add annotations to the Service for Prometheus Service Discovery
   enabled: false

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

@@ -31,10 +31,10 @@ module.exports = class HelmTemplate extends require('../../plugin') {
     }
 
     async combine() {
-        const { hasDestination, hasEnterpriseMessaging, hasHana, hasMultitenancy, hasXsuaa, hasHtml5Repo, hasApprouter } = readProject()
+        const { hasDestination, hasEnterpriseMessaging, hasHana, hasMultitenancy, hasXsuaa, hasHtml5Repo, hasApprouter, hasKafka } = readProject()
         let hasContentDeployment = false
 
-        if (!exists('chart/charts/service-instance') && (hasHtml5Repo || hasMultitenancy || hasDestination || hasEnterpriseMessaging || hasXsuaa || hasHana)) {
+        if (!exists('chart/charts/service-instance') && (hasHtml5Repo || hasMultitenancy || hasDestination || hasEnterpriseMessaging || hasXsuaa || hasHana || hasKafka)) {
             await copy(join(__dirname, 'files', 'service-instance')).to('chart/charts/service-instance')
         }
         if (hasApprouter) {
@@ -71,6 +71,9 @@ module.exports = class HelmTemplate extends require('../../plugin') {
                 await this._mergeDependency('content-deployment', 'hana-deployer')
             }
         }
+        if (hasKafka) {
+            await this._mergeDependency('service-instance', 'kafka')
+        }
         if(!exists('chart/charts/content-deployment') && hasContentDeployment) {
             await copy(join(__dirname, 'files', 'content-deployment')).to('chart/charts/content-deployment')
         }

package/lib/init/template/helm-unified-runtime/files/values.yaml.hbs

@@ -21,6 +21,6 @@ srv:
       memory: {{#isJava}}1G{{/isJava}}{{^isJava}}500M{{/isJava}}
   health:
     liveness:
-      path: /
+      path: {{#isJava}}/{{/isJava}}{{^isJava}}/health{{/isJava}}
     readiness:
-      path: /
+      path: {{#isJava}}/{{/isJava}}{{^isJava}}/health{{/isJava}}