@sap/cds-dk 8.4.1 → 8.5.0

package/lib/init/projectReader.js

@@ -1,6 +1,6 @@
 const cds = require('../cds')
 const { join, resolve, basename } = require('path')
-const { fs, exists, isdir, path } = cds.utils
+const { fs, exists, isfile, isdir, path } = cds.utils
 const { parseXml } = require('./xml')
 const { REGEX_JAVA_VERSION, JAVA_LTS_VERSIONS } = require('./constants')
 const TRACE = cds.debug('trace')
@@ -12,13 +12,15 @@ module.exports = new class ProjectReader {
     }
 
     #setPackageInfo() {
+        this.isJava = (exists('pom.xml') || cds.cli.options?.add?.has('java'))
+                        && !cds.env.for('cds').profiles.includes('node') // opt-out for hybrid projects like sflight
+
         // 1. Use project name and static default values
-        this.appVersion = cds.cli.options?.add?.has('java') ? '1.0.0-SNAPSHOT' : '1.0.0'
+        this.appVersion = this.isJava ? '1.0.0-SNAPSHOT' : '1.0.0'
         this.appName = this.appId = basename(cds.root)
         this.appDescription = 'A simple CAP project.'
 
-        const isJava = exists('pom.xml') || cds.cli.options?.add?.has('java')
-        if (isJava) {
+        if (this.isJava) {
             let artifactId, description, version, properties
             try {
                 ({ artifactId, description, version, properties } = parseXml(resolve(cds.root, 'pom.xml')) ?? {})
@@ -74,6 +76,10 @@ module.exports = new class ProjectReader {
      * @property {boolean} isUI5 Indicates if the project is a UI5 project.
      * @property {boolean} isJava Indicates if the project is using Java.
      * @property {boolean} isNodejs Indicates if the project is using Node.js.
+     * @property {boolean} isESM Indicates if the project is an ESM project (type 'module')
+     * @property {boolean} hasEsmStyle Indicates if code supports ESM-style imports and exports. This is true for ESM and Typescript projects.
+     * @property {boolean} isTypescript Indicates if the project is a Typescript project.
+     * @property {boolean} hasTyper Indicates if code supports CDS typer.
      * @property {boolean} hasHelmUnifiedRuntime Indicates if the project uses Unified Runtime Helm deployment.
      * @property {boolean} hasHelm Indicates if the project uses CAP Helm deployment.
      * @property {boolean} hasMta Indicates if the project uses MTA deployment.
@@ -95,7 +101,7 @@ module.exports = new class ProjectReader {
      * @property {boolean} hasMTXRouteJava Indicates if the approuter should have a multitenant subscription route (java).
      * @property {boolean} hasMalwareScanner Indicates if the project uses the SAP Malware Scanning service.
      * @property {boolean} hasDynatrace Indicates if the project uses Dynatrace.
-     *
+     * @property {boolean} hasCloudLogging Indicates if the project uses Cloud Logging.
      */
 
     /**
@@ -110,18 +116,27 @@ module.exports = new class ProjectReader {
         const { appVersion, appName, appId, appDescription, jdkVersion } = this
         TRACE?.({ env })
 
+        const pkgJson = () => exists('package.json') ? JSON.parse(fs.readFileSync(join(cds.root, 'package.json'))) : {}
+        const _isESM        = () => pkgJson().type === 'module'
+        const _isTypescript = () => !!pkgJson().dependencies?.typescript || !!pkgJson().devDependencies?.typescript
+        const _hasTyper     = () => !!pkgJson().dependencies?.['@cap-js/cds-typer'] || !!pkgJson().devDependencies?.['@cap-js/cds-typer']
+
         const _inProd = plugin => require(`./template/${plugin}`).hasInProduction(env)
-        const _ui5 = () => exists('package.json') && !!JSON.parse(fs.readFileSync(path.resolve(cds.root, 'package.json'))).sapux
+        const _ui5 = () => pkgJson().sapux
         const _uiEmbedded = () => exists(join(env.folders.app, 'xs-app.json'))
         const _uiModule = () => !_uiEmbedded() && isdir(env.folders.app) && fs.readdirSync(resolve(cds.root, env.folders.app)).length > 0
-        const _isJava = () => exists('pom.xml') || cds.cli.options?.add?.has('java')
+        const _isJava = () => this.isJava
         const isApp = name => name !== 'appconfig' && !name.startsWith('_') && name !== 'router' && name !== 'portal'
         const reserved = {
             has: x => _inProd(x),
             profile: () => cds.cli.options?.for,
-            language: () => exists('pom.xml') ? 'java' : 'nodejs',
+            language: () => _isJava() ? 'java' : 'nodejs',
             isJava: () => _isJava(),
             isNodejs: () => !_isJava(),
+            isTypescript: () => _isTypescript(),
+            isESM: () => _isESM,
+            hasEsmStyle: () => _isTypescript() || _isESM(),
+            hasTyper: () => _hasTyper(),
             srvPath: () => join(env.build.target, env.folders.srv.replace(/\/$/, '')).replace(/\\/g, '/'),
             archiveName: () => {
                 const pomXmlPath = resolve(cds.root, env.folders.srv, 'pom.xml')
@@ -135,7 +150,7 @@ module.exports = new class ProjectReader {
                 const path = join(env.build.target, name).replace(/\\/g, '/')
                 return { folder, name, path }
             },
-            configFile: () => exists('pom.xml') ? '.cdsrc.json' : 'package.json',
+            configFile: () => _isJava() ? '.cdsrc.json' : 'package.json',
             apps: () => {
                 const apps = fs.readdirSync(path.resolve(cds.root, cds.env.folders.app)).filter(e =>
                     isdir(path.join(cds.root, cds.env.folders.app, e)) && isApp(e)
@@ -191,3 +206,54 @@ module.exports = new class ProjectReader {
         return project
     }
 }
+
+/**
+ * Finds and reads SpringBoot configuration in `cds.root/srv` dir.
+ * This is done in a best-effort way. In no way can we replciate all of SpringBoot's
+ * config variants.
+ * @param {string[]?} roots array of directories to search for application.yaml, like `srv`
+ * @returns {Promise<object[]>} array of objects with `cds` property
+ */
+module.exports._readSpringBootConfig = async function (roots=[cds.env.folders.srv]) {
+    const configNodes = []
+    const rootDirs = roots.map(d => join(cds.root, d))
+    for (let r of rootDirs) {
+      const file = isfile (join (r,'./src/main/resources/application.yaml'))
+      if (file) {
+        const yaml = cds.load.yaml(file)
+        for (let yamlDoc of Array.isArray(yaml) ? yaml : [yaml]) {
+          let cds = yamlDoc?.cds;
+          if (!cds)   continue
+          cds = _normalizeSpringBootCfg(cds)
+          configNodes.push({cds})
+        }
+      }
+    }
+    return configNodes
+  }
+
+/**
+ * Normalize SpringBoot's dots in keys to express nested objects
+ *
+ * @example: `cds.foo.bar = 1` --> `cds: { foo: { bar: 1 } }`
+ * @param {object} obj
+ * @returns {object}
+ */
+function _normalizeSpringBootCfg(obj) {
+    if (typeof obj !== 'object')  return obj
+    Object.keys(obj).forEach(k => {
+        const prop = k.split('.')
+        const last = prop.pop()
+        // and define the object if not already defined
+        const res = prop.reduce((o, key) => {
+            // define the object if not defined and return
+            return o[key] = o[key] ?? {}
+        }, obj)
+        res[last] = obj[k]
+        // recursively normalize
+        _normalizeSpringBootCfg(obj[k])
+        // delete the original property from object if it was rewritten
+        if (prop.length)  delete obj[k]
+    })
+    return obj
+}

package/lib/init/registries/mta.js

@@ -1,4 +1,3 @@
-// Registry of sequence matchers in mta.yaml files
 const cds = require('../../cds')
 
 const srvNode4 = path => ({ in: 'modules', where: { type: 'nodejs', path } })

package/lib/init/template/approuter/files/package.json

@@ -4,7 +4,7 @@
     "@sap/approuter": "^17.0.0"
   },
   "engines": {
-    "node": "^22.0.0"
+    "node": "^20"
   },
   "scripts": {
     "start": "node node_modules/@sap/approuter/approuter.js"

package/lib/init/template/cloud-logging/files/package.json.hbs

@@ -1,18 +1,7 @@
 {
-  "dependencies": {
-    "@cap-js/telemetry": ">=0",
-    "@grpc/grpc-js": "^1",
-    "@opentelemetry/exporter-trace-otlp-grpc": "^0",
-    "@opentelemetry/exporter-metrics-otlp-grpc": "^0",
-    "@opentelemetry/host-metrics": "^0"
-  },
   "cds": {
     "requires": {
-      "[{{profile}}]": {
-        "telemetry": {
-          "kind": "to-cloud-logging"
-        }
-      }
+      "cloud-logging": true
     }
   }
 }

package/lib/init/template/cloud-logging/files/values.yaml.hbs

@@ -0,0 +1,16 @@
+---
+srv:
+  bindings:
+    cloud-logging:
+      serviceInstanceName: cloud-logging
+      credentialsRotationPolicy:
+        enabled: true
+        rotationFrequency: 168h
+cloud-logging:
+  serviceOfferingName: cloud-logging
+  servicePlanName: standard
+  parameters:
+    ingest_otlp:
+        enabled: true
+
+

package/lib/init/template/cloud-logging/index.js

@@ -7,7 +7,7 @@ const { srv4, mtxSidecar4, approuter } = require('../../registries/mta')
 module.exports = class extends require('../../plugin') {
 
   static hasInProduction(env) {
-    return env.requires?.telemetry?.kind === 'to-cloud-logging'
+    return env.requires?.['cloud-logging'];
   }
 
   options() {
@@ -24,23 +24,23 @@ module.exports = class extends require('../../plugin') {
   }
 
   async canRun() {
-    const { hasMta, hasHelm, hasHelmUnifiedRuntime } = readProject()
-    if ((hasHelmUnifiedRuntime || hasHelm) && !hasMta) throw `'cds add cloud-logging' is not available for Kyma yet`
     return true
   }
 
+  requires() {
+    const project = readProject(), { hasTelemetry } = project
+    if ((cds.cli.options['with-telemetry'] || hasTelemetry)) return ['telemetry']
+  }
+
   async run() {
-    const project = readProject(), { hasTelemetry, isNodejs } = project
-    if (isNodejs && (cds.cli.options['with-telemetry'] || hasTelemetry)) {
-      project.profile ??= 'production'
-      await merge(__dirname, 'files/package.json.hbs').into('package.json', { with: project })
-      await sort('package.json', 'dependencies')
-    }
+    const project = readProject();
+    await merge(__dirname, 'files/package.json.hbs').into('package.json', { with: project })
+    await sort('package.json', 'dependencies')
   }
 
   async combine() {
     const project = readProject()
-    const { hasMta, hasApprouter, isJava, hasMultitenancy, srvPath } = project
+    const { hasMta, hasHelm, hasHelmUnifiedRuntime, hasApprouter, isJava, hasMultitenancy, srvPath } = project
 
     if (hasMta) {
       const cloudLogging = {
@@ -77,5 +77,9 @@ module.exports = class extends require('../../plugin') {
         with: project, additions, relationships
       })
     }
+    if (hasHelm || hasHelmUnifiedRuntime) {
+      await merge(__dirname, 'files/values.yaml.hbs').into('chart/values.yaml')
+    }
   }
 }
+

package/lib/init/template/data/as-csv.js

@@ -39,7 +39,7 @@ module.exports = async (data={}, csn, { headerOnly=false, separator=',' }={}) =>
             }
             record.push(...Object.values(value))
           }
-          else if (element.is_struct) {
+          else if (element.is_struct && element.type !== 'cds.Map') {
             if (i === 0) {
               header.push(...Object.keys(value).map(structField => name + '_' + structField))
             }

package/lib/init/template/data/as-json.js

@@ -80,7 +80,7 @@ function fillRecord(record, recordID, artifact, csn, data, parent, depth, refere
   Object.defineProperty(record, '$id', {value: recordID, enumerable: false})
   if (data[artifact.name]) data[artifact.name].push(record) // add id to data, to be referenced by associations to prevent circular dependencies
 
-  const elems = Object.values(artifact.elements ?? artifact.params).sort(asJson.elementsSorter(csn))
+  const elems = Object.values(artifact.elements ?? artifact.params ?? {}).sort(asJson.elementsSorter(csn))
   elems.forEach(el => {
     record[el.name] = dataForField(el, artifact, csn, record, data, parent, depth, referenceData)
   })
@@ -229,9 +229,11 @@ function dataForField(element, artifact, csn, record, data, parent, depth, refer
     }
     case 'cds.hana.REAL':
     case 'cds.Decimal': {
-      const range = {from: 0, to: 100}
+      const prec  = element.precision ? Math.min(Math.pow(10, element.precision), Number.MAX_SAFE_INTEGER) : 100
+      const range = { from: 0, to: prec }
+      const scale = element.scale ?? (element.precision ? 0 : 2) // scale is 0 if only precision is given
       annotatedIntRange(element, range)
-      return +(randomDecimalInRange(range).toFixed(element.scale ?? 2))
+      return +(randomDecimalInRange(range).toFixed(scale))
     }
     case 'cds.Double': {
       const range = {from: 0, to: 100}
@@ -309,8 +311,6 @@ function dataForField(element, artifact, csn, record, data, parent, depth, refer
       return
     case 'cds.Vector': // TODO add Vector
       return
-    case 'cds.Map':
-      return {}
     default: {
       console.error(`Unknown type ${element._type} (${element.type}) in '${artifact.name}:${element.name}'`)
       return

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

@@ -6,6 +6,7 @@ const { URLSearchParams } = require('url')
 const { env4 } = require('../../projectReader')
 const asJson = require('./as-json')
 const asCsv = require('./as-csv')
+const { filterStringAsRegex } = require('../../add')
 
 module.exports = class DataTemplate extends require('../../plugin') {
 
@@ -92,32 +93,6 @@ module.exports = class DataTemplate extends require('../../plugin') {
 }
 module.exports.asJson = asJson
 module.exports.asCsv = asCsv
-module.exports.filterStringAsRegex = filterStringAsRegex
-
-/**
- * Turns a filter string with optional meta characters into a regular expression.
- * If no meta characters are found, the string is treated as an include pattern.
- *
- * @param {string} spec the filter string
- * @returns {RegExp} the regular expression
- */
-function filterStringAsRegex(spec) {
-  if (typeof spec === 'string') {
-    try {
-      if (spec.match(/[\^$|*]/)) {
-        spec = spec.replace(/^\*/, '.*')  // * at start would be invalid, so make it a .*
-        return new RegExp(spec, 'i')
-      }
-      else { // no meta chars -> include semantics
-        spec = spec.replace(/\./g, '\\.') // escape literal dot
-        return new RegExp(spec, 'i')
-      }
-    } catch (err) {
-      throw err.message // user error, so cut off stack trace
-    }
-  }
-  return /.*/
-}
 
 function parseQueryStr(queryStr) {
   const params = new URLSearchParams(queryStr) // e.g. key1&key2=false

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

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

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

@@ -0,0 +1,16 @@
+const { readProject } = require('../../projectReader')
+const { merge } = require('../../merge')
+
+module.exports = class EsmTemplate extends require('../../plugin') {
+
+  static help() {
+    return 'ESM-compatible Node.js project'
+  }
+
+  async run() {
+    const project = readProject()
+    const { configFile } = project
+    await merge(__dirname, 'files/package.json.hbs').into(configFile, { with: project, forceOverwrite: true })
+  }
+
+}

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

@@ -3,10 +3,7 @@
   "dependencies": {
     "@cap-js/hana": "^1"
   },
-  {{/isNodejs}}
-  {{#isNodejs}}
   "cds": {
-  {{/isNodejs}}
     "sql": {
       "native_hana_associations": false
     }{{#profile}},
@@ -22,7 +19,24 @@
       {{/shortcut}}
       }
     }{{/profile}}
-  {{#isNodejs}}
   }
   {{/isNodejs}}
+  {{#isJava}}
+  "requires": {
+    {{#profile}}
+    "[{{profile}}]": {
+    {{/profile}}
+    {{#shortcut}}
+      "db": "hana"
+    {{/shortcut}}
+    {{^shortcut}}
+      "db": {
+        "kind": "hana"
+      }
+    {{/shortcut}}
+    {{#profile}}
+    }
+    {{/profile}}
+  }
+  {{/isJava}}
 }

package/lib/init/template/handler/files/handler.xs.hbs

@@ -0,0 +1,56 @@
+{{! ESM }}
+{{#hasEsmStyle}}
+import cds from '@sap/cds'
+{{#hasTyper}}
+{{#allNames}}
+import { {{allNames}} } from '#cds-models/{{{servicePath}}}'
+{{/allNames}}
+{{/hasTyper}}
+
+{{! class declaration }}
+export class {{serviceClass}} extends cds.ApplicationService { init() {
+{{/hasEsmStyle}}
+{{! CJS }}
+{{^hasEsmStyle}}
+const cds = require('@sap/cds')
+{{#hasTyper}}
+{{#allNames}}
+const { {{allNames}} } = require('#cds-models/{{{servicePath}}}')
+{{/allNames}}
+{{/hasTyper}}
+
+{{! class declaration }}
+module.exports = class {{serviceClass}} extends cds.ApplicationService { init() {
+{{/hasEsmStyle}}
+{{! dynamic model imports }}
+{{^hasTyper}}
+
+{{#entityNames}}
+  const { {{entityNames}} } = cds.entities('{{serviceName}}')
+{{/entityNames}}
+{{/hasTyper}}
+
+{{! entity handlers }}
+{{#entities}}
+  this.before (['CREATE', 'UPDATE'], {{name}}, async (req) => {
+    console.log('Before CREATE/UPDATE {{name}}', req.data)
+  })
+  this.after ('READ', {{name}}, async ({{dataVar}}, req) => {
+    console.log('After READ {{name}}', {{dataVar}})
+  })
+{{/entities}}
+
+{{! action handlers }}
+{{#operations}}
+{{#hasTyper}}
+  this.on ({{name}}, async (req) => {
+{{/hasTyper}}
+{{^hasTyper}}
+  this.on ('{{name}}', async (req) => {
+{{/hasTyper}}
+    console.log('On {{name}}', req.data)
+  })
+{{/operations}}
+
+  return super.init()
+}}

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

@@ -1,11 +1,15 @@
+const cds = require('../../../cds')
+const { fs: { promises: { rename } }, path: { basename, dirname, join }, exists } = cds.utils
 const { readProject } = require('../../projectReader')
+const { renderAndCopy } = require('../../template')
 const mvn = require('../../mvn')
-
+const { dim } = require('../../../util/term')
+const { filterStringAsRegex } = require('../../add')
 
 module.exports = class Handler extends require('../../plugin') {
 
   static help() {
-    return 'add handler stubs for actions and functions (Java)'
+    return 'handler stubs for service entities, actions and functions'
   }
 
   options() {
@@ -13,25 +17,96 @@ module.exports = class Handler extends require('../../plugin') {
       'filter': {
         type: 'string',
         short: 'f',
-        help: `Filter actions or functions by name prefix. Regular expressions are not supported.`
+        help: `Filter for entities, actions or functions matching the given pattern.
+        For Node.js, if it contains meta characters like '^' or '*', it is treated as a regular expression,
+        otherwise as an include pattern, i.e /.*bookshop.*/i
+        For Java, only '*' and '**' as suffix wildcards are allowed, as in 'my.bookshop.*' or 'my.**'`
       },
       'out': {
         type: 'string',
         short: 'o',
-        help: 'Specify a custom output directory inside the `handlers` directory. The default is `handlers`.'
+        help: `Custom output directory.
+        For Java, the default is 'handlers'. For Node.js, the default is 'srv'.`
       }
     }
   }
 
   canRun() {
-    const { isJava } = readProject()
-    if (!isJava) {
-      throw `No Java project detected. 'cds add handler' is currently only supported for Java projects.\n`
-    }
     return true
   }
 
   async run() {
-    await mvn.generate('handler')
+    const { isJava } = readProject()
+    if (isJava) {
+      await mvn.generate('handler')
+    } else {
+      await createNodeHandler()
+    }
+  }
+}
+
+async function createNodeHandler() {
+  const { filter, force, out=cds.env.folders.srv } = cds.cli.options
+  const proj = readProject()
+  const csn = await loadModel()
+  if (!csn)  return console.log(dim(`> Skipping, no model found`))
+
+  const nameFilter = filterStringAsRegex(filter)
+
+  for (const service of csn.services) {
+    if (!service.$location.file)  continue
+
+    const destFileType = proj.isTypescript ? '.ts' : '.js'
+    const outPath = join(out, basename(service.$location.file.replace('.cds', destFileType)))
+    const destFile = join(cds.root, outPath)
+    if (!force && exists(destFile)) {
+      console.log(dim(`> Skipping ${outPath}`))
+      continue
+    }
+
+    proj.serviceName = service.name
+    proj.serviceClass = service.name.split('.').pop()
+    proj.servicePath = proj.serviceName ? (proj.serviceName.replace(/\./g, '/')) : ''
+
+    proj.entities = Object.entries(service.entities)
+      .filter(([name]) =>  name.match(nameFilter))
+      .filter(([name]) => !name.match(/[._]texts$/))
+      .filter(([, e])  => !e['@cds.autoexposed']) // only consider non-autoexposed entities to reduce clutter
+      .map(([name]) => ({
+        name,
+        dataVar: name.charAt(0).toLowerCase() + name.slice(1) // lower case first letter
+      }))
+    if (proj.entities.length)
+      proj.entityNames = proj.entities.map(e => e.name).join(', ')
+
+    proj.operations = Object.keys(service.actions)
+      .filter(name => name.match(nameFilter))
+      .map(name => ({
+        name,
+        dataVar: name.charAt(0).toLowerCase() + name.slice(1) // lower case first letter
+      }))
+
+    const all = [...proj.entities, ...proj.operations]
+    if (all.length > 4)
+      proj.allNames = `\n  ${all.map(e => e.name).join(',\n  ')}\n`
+    else if (all.length)
+      proj.allNames = all.map(e => e.name).join(', ')
+
+    console.log(dim(`> Writing ${outPath}`))
+    const destPath = dirname(destFile)
+    await renderAndCopy(join(__dirname, 'files'), destPath, proj)
+    await rename(join(destPath, 'handler.xs'), destFile)
+  }
+}
+
+/**
+ * @returns { Promise<import('@cap-js/cds-types').linked.LinkedCSN | null> }
+ */
+async function loadModel() {
+  try {
+    return cds.linked(cds.minify(await cds.load([cds.env.roots])))
+  } catch (err) {
+    if (err.code === 'MODEL_NOT_FOUND')  return null
+    throw err
   }
 }

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

@@ -95,7 +95,7 @@ module.exports = class HelmTemplate extends require('../../plugin') {
     }
 
     async combine() {
-        const { hasDestination, hasEnterpriseMessaging, hasEnterpriseMessagingShared, hasHana, hasMultitenancy, hasXsuaa, hasHtml5Repo, hasApprouter, hasKafka, hasAttachments, hasPortal, hasMalwareScanner, hasDynatrace } = readProject()
+        const { hasDestination, hasEnterpriseMessaging, hasEnterpriseMessagingShared, hasHana, hasMultitenancy, hasXsuaa, hasHtml5Repo, hasApprouter, hasKafka, hasAttachments, hasPortal, hasMalwareScanner, hasDynatrace, hasCloudLogging } = readProject()
 
         if (hasApprouter) {
             await this._mergeDependency('web-application', 'approuter')
@@ -142,6 +142,9 @@ module.exports = class HelmTemplate extends require('../../plugin') {
         if (hasMalwareScanner) {
             await this._mergeDependency('service-instance', 'malware-scanner')
         }
+        if (hasCloudLogging) {
+            await this._mergeDependency('service-instance', 'cloud-logging')
+        }
         if (hasDynatrace) {
             await this._mergeDependency('service-instance', 'dynatrace')
         }