@sap/cds-dk 8.4.2 → 8.5.1

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')
         }

package/lib/init/template/html5-repo/files/xs-app.json.hbs

@@ -1,4 +1,5 @@
 {
+  {{#hasIndexHtml}}"welcomeFile": "/index.html",{{/hasIndexHtml}}
   "authenticationMethod": "route",
   "routes": [
     {

package/lib/init/template/html5-repo/index.js

@@ -3,6 +3,7 @@ const { readProject } = require('../../projectReader')
 const { merge } = require('../../merge')
 const { srv4, html5RepoHost, html5Runtime, appDeployer, approuter, mtxSidecar4 } = require('../../registries/mta')
 const { odataApi } = require('../../registries/xs-app')
+const { exists } = require('../../../cds').utils
 
 module.exports = class Html5RepoTemplate extends require('../../plugin') {
 
@@ -53,6 +54,7 @@ module.exports = class Html5RepoTemplate extends require('../../plugin') {
 
         await Promise.all(apps.map(async ({app}) => {
             project.app = app
+            project.hasIndexHtml = exists(join(appPath, app, 'webapp/index.html'))
             const additions = [odataApi]
             await merge(__dirname, 'files/xs-app.json.hbs').into(join(appPath, app, 'xs-app.json'), { with: project, additions })
         }))

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

@@ -2,16 +2,21 @@ const https = require('node:https')
 const axios = require('axios')
 const asJson = require("../data/as-json")
 const cds = require('../../../cds')
-const cf = require("../../../util/cf")
+const cf = require('../../../util/cf')
 const { write, exists } = cds.utils
-const { filterStringAsRegex } = require("../data/index")
+const { filterStringAsRegex } = require('../../add')
+const { _readSpringBootConfig } = require('../../projectReader')
+
+/**
+ * @typedef {{name: string, entities:[], actions:[], urlPaths: string[], isJava:boolean}} ServiceData
+ * @typedef {Map<string, ServiceData>|undefined} ServiceMap
+ */
 
 module.exports = class HttpTemplate extends require('../../plugin') {
 
   #nodeHost = "http://localhost:4004"
   #javaHost = "http://localhost:8080"
   #defaultOutputDir = "test/http"
-  #defaultAuth = `Authorization: Basic alice:`
 
   static help() {
     return 'add .http files for modeled services'
@@ -50,42 +55,16 @@ module.exports = class HttpTemplate extends require('../../plugin') {
     cds.linked(csn)
 
     const serviceInfo = cds.compile.to.serviceinfo(csn)
-    let [hostname, auth] = await this.#getHostnameAndAuth(serviceInfo)
     let services = this.#collectServiceInfo(csn, serviceInfo)
     if (!services)  return
 
     const payload = await this.#generatePayload(csn, services)
-    this.#generateRequests(services, hostname, auth, payload)
-  }
-
-  async #getHostnameAndAuth(serviceInfo) {
-    if (!cds.cli.options['for-app']) {
-      if (serviceInfo[0].runtime === 'Java') {
-        return [this.#javaHost, null]
-      } else {
-        return [this.#nodeHost, this.#defaultAuth]
-      }
-    }
-
-    const app = cds.cli.options['for-app']
-    // Later: differentiate between CF and Kyma
-    const env = await cf.getEnv(app)
-    if (!cds.cli.options.dry)   console.error('Fetching credentials from Cloud Foundry app \'' + app + '\'...')
-    const hostname = `https://${env.application_env_json.VCAP_APPLICATION.application_uris[0]}`
-    const xsuaaCredentials = env.system_env_json.VCAP_SERVICES?.xsuaa[0]?.credentials ?? {}
-    const { url, clientid, clientsecret, certurl, certificate, key } = xsuaaCredentials
-    if (!url) throw new Error('No XSUAA service found in the environment of ' + app)
-
-    const auth = certificate ? { maxRedirects: 0, httpsAgent: new https.Agent({ cert: certificate, key }) }
-                             : { auth: { username: clientid, password: clientsecret } }
-    const authUrl = `${certurl ?? url}/oauth/token`
-    const data = `grant_type=client_credentials&client_id=${encodeURI(clientid)}`
-    const config = { method: 'POST', timeout: 5000, data, ...auth }
-    const { access_token } = (await axios(authUrl, config)).data
-    const approuterAuth = `x-approuter-authorization: bearer ${access_token}`
-    return [hostname, approuterAuth]
+    await this.#generateRequests(services, payload, csn)
   }
 
+  /**
+   * @returns {ServiceMap}
+   */
   #collectServiceInfo(csn, serviceInfo) {
     const services = new Map()
 
@@ -105,7 +84,7 @@ module.exports = class HttpTemplate extends require('../../plugin') {
         }
       }
       if (entities.length === 0 && actions.length === 0) return
-      services.set(s.name, { entities, urlPaths, actions })
+      services.set(s.name, { name: s.name, entities, urlPaths, actions, isJava: sInfo.runtime === 'Java' })
     })
 
     if (services.size === 0) {
@@ -126,6 +105,9 @@ module.exports = class HttpTemplate extends require('../../plugin') {
     }
   }
 
+  /**
+   * @param {ServiceMap} services
+   */
   async #generatePayload(csn, services) {
     const payload = {}
     for (const [, service] of services) {
@@ -145,9 +127,13 @@ module.exports = class HttpTemplate extends require('../../plugin') {
     return payload
   }
 
-  #generateRequests(services, hostname, auth, payload) {
+  /**
+   * @param {ServiceMap} services
+   */
+  async #generateRequests(services, payload, csn) {
     let varsDefined = false  // when writing requests for multiple services to stdout, define vars only once
     for (const [serviceName, service] of services) {
+      let [hostname, auth] = await this.#getHostnameAndAuth(service, csn)
       let requests = []
       if (!cds.cli.options.dry || !varsDefined) {
         requests.push(auth ? `@server = ${hostname}\n@auth = ${auth}\n` : `@server = ${hostname}\n`)
@@ -226,6 +212,87 @@ module.exports = class HttpTemplate extends require('../../plugin') {
     }
   }
 
+  async #getHostnameAndAuth(service, csn) {
+    if (!cds.cli.options['for-app']) {
+      const host = service.isJava ? this.#javaHost : this.#nodeHost
+      const users = Object.values(await this.#mockUsersForService(service, csn))
+      const authStr = users.length ? `Authorization: Basic ${users[0].name}:${users[0].password||''}` : null
+      return [host, authStr]
+    }
+
+    if (!this.approuterAuth) {
+      const app = cds.cli.options['for-app']
+      // Later: differentiate between CF and Kyma
+      const env = await cf.getEnv(app)
+      if (!cds.cli.options.dry)   console.error('Fetching credentials from Cloud Foundry app \'' + app + '\'...')
+      this.hostname = `https://${env.application_env_json.VCAP_APPLICATION.application_uris[0]}`
+      const xsuaaCredentials = env.system_env_json.VCAP_SERVICES?.xsuaa[0]?.credentials ?? {}
+      const { url, clientid, clientsecret, certurl, certificate, key } = xsuaaCredentials
+      if (!url) throw new Error('No XSUAA service found in the environment of ' + app)
+
+      const auth = certificate ? { maxRedirects: 0, httpsAgent: new https.Agent({ cert: certificate, key }) }
+                              : { auth: { username: clientid, password: clientsecret } }
+      const authUrl = `${certurl ?? url}/oauth/token`
+      const data = `grant_type=client_credentials&client_id=${encodeURI(clientid)}`
+      const config = { method: 'POST', timeout: 5000, data, ...auth }
+      const { access_token } = (await axios(authUrl, config)).data
+      this.approuterAuth = `x-approuter-authorization: bearer ${access_token}`
+    }
+    return [this.hostname, this.approuterAuth]
+  }
+
+  /**
+   * Reads mock users from the cds.env or the application.yml,
+   * returning only those that match to the declared roles of the given service.
+   * @param {ServiceData} service
+   * @returns {Promise<Record<string, {password: string, roles: string[]}>>} a map of users
+   */
+  async #mockUsersForService(service, csn) {
+    const declaredRoles = new Set()
+    Object.values(csn.definitions)
+      .filter(d => d.name.startsWith(service.name))
+      .map(d => d['@requires']).filter(Boolean)
+      .forEach(req => {
+        declaredRoles.add(...(Array.isArray(req) ? req : [req]))
+      })
+
+    const matchingUsers = {}
+    const addUserIfMatching = (roles, name, password) => {
+      if (!declaredRoles.size || declaredRoles.has('authenticated-user') || roles?.some(r => declaredRoles.has(r))) {
+        matchingUsers[name] = { name, password, roles }
+      }
+    }
+
+    if (service.isJava) {
+      const javaDefaultUsers = [
+        { name: 'authenticated', roles: ['authenticated-user'] },
+        { name: 'internal', roles: ['internal-user'] },
+        { name: 'system', roles: ['system-user'] },
+      ]
+      const javaUsers = []
+      this.javaConfig ??= await _readSpringBootConfig()
+      javaUsers.push(
+        ...this.javaConfig
+          .map(cfg => cfg.cds?.security?.mock?.users) // {name: { password, roles }}
+          .filter(Boolean)
+          .flatMap(usrList => Object.entries(usrList).map(([name, {password, roles}]) => ({ name, password, roles: roles??[] })))
+      , ...javaDefaultUsers // add default users at end for lower priority
+      )
+      javaUsers.forEach(({name, password='', roles}) => addUserIfMatching(roles, name, password))
+    }
+    // Node
+    else if (cds.env.requires.auth?.users) {
+      const nodeUsers = Object.entries(cds.env.requires.auth.users)
+      nodeUsers.forEach(([name, {password, roles}]) => addUserIfMatching(roles, name, password))
+    }
+    // add a dummy user as a hint if no user matches the scopes
+    if (declaredRoles.size && !matchingUsers.length) {
+      const name = `no_user_found_for_roles_${Array.from(declaredRoles).join('_')}`
+      matchingUsers[name] = { name: name, password: '', roles: [] }
+    }
+    return matchingUsers
+  }
+
   #write(requests, serviceName) {
     const http = requests.join('\n')
     if (cds.cli.options.dry) {

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

@@ -11,7 +11,7 @@
   },
   "devDependencies": {
     "@cap-js/sqlite": "^1",
-    "@cap-js/cds-types": "^0.7.0"
+    "@cap-js/cds-types": "^0.8.0"
   },
   "scripts": {
     "start": "cds-serve"

package/lib/init/template/sample/files/nodejs/{admin-service.js → admin-service.js.hbs}

@@ -1,6 +1,13 @@
+{{#isESM}}
+import cds from '@sap/cds'
+
+export class AdminService extends cds.ApplicationService { init() {
+{{/isESM}}
+{{^isESM}}
 const cds = require('@sap/cds')
 
-module.exports = class AdminService extends cds.ApplicationService { init(){
+module.exports = class AdminService extends cds.ApplicationService { init() {
+{{/isESM}}
 
   const { Books } = this.entities
 

package/lib/init/template/sample/files/nodejs/{cat-service.js → cat-service.js.hbs}

@@ -1,6 +1,13 @@
+{{#isESM}}
+import cds from '@sap/cds'
+
+export class CatalogService extends cds.ApplicationService { init() {
+{{/isESM}}
+{{^isESM}}
 const cds = require('@sap/cds')
 
-class CatalogService extends cds.ApplicationService { init() {
+module.exports = class CatalogService extends cds.ApplicationService { init() {
+{{/isESM}}
 
   const { Books } = cds.entities('sap.capire.bookshop')
   const { ListOfBooks } = this.entities
@@ -34,5 +41,3 @@ class CatalogService extends cds.ApplicationService { init() {
   // Delegate requests to the underlying generic service
   return super.init()
 }}
-
-module.exports = CatalogService

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

@@ -2,6 +2,7 @@ const { join } = require('path')
 const cds = require('../../../cds'), { exists, read, write, copy } = cds.utils
 const { env4, readProject } = require('../../projectReader')
 const { merge } = require('../../merge')
+const { renderAndCopy } = require('../../template')
 const mvn = require('../../mvn')
 
 module.exports = class SampleTemplate extends require('../../plugin') {
@@ -13,19 +14,20 @@ module.exports = class SampleTemplate extends require('../../plugin') {
     async run() {
         const { db, srv, app } = env4('production').folders
         const language = exists('pom.xml') ? 'java' : 'nodejs'
+        const project = readProject()
 
         if (language === 'nodejs') {
             await Promise.all([
                 copy(join(__dirname, 'files/db')).to(db),
                 copy(join(__dirname, 'files/srv')).to(srv)
             ])
-            await copy(join(__dirname, 'files', language)).to(srv)
+            await renderAndCopy(join(__dirname, 'files', language), srv, project)
             await copy(join(__dirname, 'files/app')).to(app)
         } else if (language === 'java') {
             await mvn.add('sample')
         }
 
-        const { appName, appPath, appUIPaths } = readProject()
+        const { appName, appPath, appUIPaths } = project
         await merge(__dirname, 'files/package.json.hbs').into('package.json', { with: { appPath }})
 
         // manifest.json must be unique

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

@@ -0,0 +1,18 @@
+{
+  "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"
+        }
+      }
+    }
+  }
+}

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

@@ -1,5 +1,6 @@
 const cds = require('../../../cds')
 const { readProject } = require('../../projectReader')
+const { merge, sort } = require('../../merge')
 
 module.exports = class extends require('../../plugin') {
 
@@ -8,12 +9,17 @@ module.exports = class extends require('../../plugin') {
   }
 
   async canRun() {
-    const { hasMta, hasHelm, hasHelmUnifiedRuntime } = readProject()
-    if ((hasHelmUnifiedRuntime || hasHelm) && !hasMta) throw `'cds add telemetry' is not available for Kyma yet`
     return true
   }
 
   requires() {
     return ['cloud-logging']
   }
+
+  async run() {
+    const project = readProject();
+    project.profile ??= 'production'
+    await merge(__dirname, 'files/package.json.hbs').into('package.json', { with: project })
+    await sort('package.json', 'dependencies')
+  }
 }

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

@@ -1,10 +1,10 @@
 {
   "devDependencies": {
-    "@cap-js/cds-types": "^0.7.0",
+    "@cap-js/cds-types": "^0.8.0",
     "@types/node": "^22.0.0",
     "typescript": "^5"
   },
   "scripts": {
-    "watch": "cds-ts w"
+    "watch": "cds-tsx w"
   }
 }

package/lib/init/template/workzone-standard/index.js

@@ -16,7 +16,7 @@ module.exports = class extends require('../../plugin') {
     }
 
     static hasInProduction(env) {
-      return !!env.requires?.workzone
+      return !!env.requires?.workzone || cds.cli.options.add.has('workzone-standard')
     }
 
     canRun() {

package/lib/init/types.d.ts

@@ -16,12 +16,6 @@ export interface CDSGenerator {
    */
   stepEnd(): Promise<void>;
 
-  /**
-   * Contains the parameter description
-   * DEPRECATED: use uiConfig
-   */
-  config?: any;
-
   /**
    * Contains the parameter description
    */

package/lib/watch/node-watch.js

@@ -3,6 +3,7 @@ const LOG = cds.log('cli|watch'), DEBUG = cds.debug('cli|watch')
 const { relative } = require('path')
 
 module.exports = ({ cwd, script, ext, ignore=RegExp(), env={}, delay=200, options={} })=>{
+  const debugOpts = _debugOpts(options)
 
   let child
 
@@ -20,18 +21,16 @@ module.exports = ({ cwd, script, ext, ignore=RegExp(), env={}, delay=200, option
 
   // Re-starting child process...
   const { fork } = require('child_process')
-  const restart = _coalesceEvents(delay, (events) => {
-    DEBUG?.('Restart', {events})
+  const restart = _coalesceEvents(delay, (eventsAndOpts) => {
+    DEBUG?.('Restart', {events: eventsAndOpts})
     _kill (child, () => {
-      const execArgv = [...process.execArgv]
-      events.forEach(evt => {
-        if (evt.type && evt.type.startsWith('--')) execArgv.push(evt.type)
-        if (evt.name && evt.name.startsWith('--')) execArgv.push(evt.name)
+      const execArgv = [...process.execArgv, ...debugOpts]
+      eventsAndOpts.forEach(evt => { // ad-hoc options from stdin
+        if (evt.type?.startsWith('--')) execArgv.push(evt.type)
+        if (evt.name?.startsWith('--')) execArgv.push(evt.name)
       })
-      if (options.debug) execArgv.push('--inspect')
-      if (options['debug-brk']) execArgv.push('--inspect-brk')
 
-      const updated = events.filter(evt => evt.type && evt.type === 'update').map(evt => evt.name)
+      const updated = eventsAndOpts.filter(evt => evt.type && evt.type === 'update').map(evt => evt.name)
       emitter.emit ('restart', updated)
       child = fork (script, { cwd, env, stdio:'inherit', execArgv }, (err)=>{
         if (err)  console.error (err)
@@ -147,4 +146,21 @@ function _kill (child, cb=()=>{}) {
   child.kill()
 }
 
+function _debugOpts(options={}) {
+  const o = []
+  if ('debug' in options) {
+    options.inspect = options.debug
+    delete options.debug
+  }
+  if ('inspect' in options) { // could be 0
+    if (typeof options.inspect === 'string') o.push(`--inspect=${options.inspect}`) // could be port and/or host
+    else o.push(`--inspect`)
+  }
+  if ('inspect-brk' in options) {
+    if (typeof options['inspect-brk'] === 'string') o.push(`--inspect-brk=${options['inspect-brk']}`)
+    else o.push(`--inspect-brk`)
+  }
+  return o
+}
+
 const _pending = Symbol.for('sap.cds.watch.pendingKill')