@sap/cds-dk 9.4.3 → 9.6.0

package/bin/util/containerize.js

@@ -2,7 +2,8 @@ const cds = require('../../lib/cds')
 const { path } = cds.utils
 const { join } = path
 const { execSync } = require('node:child_process')
-const { highlight } = require('../../lib/util/term')
+const { highlight, info } = require('../../lib/util/term')
+const { calcDirChecksum } = require('../../lib/util/checksum')
 
 const buildpacks = new Set([
   'java', 'nodejs', 'sap-machine', 'executable-jar', 'spring-boot', 'syft'
@@ -17,15 +18,20 @@ const keyProcessorMap = {
   buildpack: processBuildpack
 }
 
-const run = cmd => {
+const run = (cmd, { continueOnFail = false, silent = false } = {}) => {
   cmd = Array.isArray(cmd) ? cmd.join(' ') : cmd
   console.log(highlight(cmd))
   try {
     return execSync(cmd, {
-      stdio: 'inherit',
+      stdio: silent ? 'pipe' : 'inherit',
       env: { ...process.env, FORCE_COLOR: cds.utils.colors.enabled }
     })
   } catch (error) {
+    if (continueOnFail) {
+      if (!silent)
+        console.error(error.message)
+      return
+    }
     throw error.message
   }
 }
@@ -72,41 +78,46 @@ function processBuildpack(bp, name, tag, clearCache = false) {
  * @param {string} filename - The path to the YAML file to parse.
  * @param {string} [repoOpt=''] - Optional repository override. If not provided, uses the repository defined in the YAML file.
  * @param {boolean} [clearCache=false] - Whether to clear cache for buildpack builds.
- * @returns {{
+ * @returns {Promise<{
  *   commands: Array<{
  *     name: string,
  *     tag: string,
  *     buildCmd: Array<string>,
  *     tagCmd: Array<string>,
- *     pushCmd: Array<string>
+ *     pushCmd: Array<string>,
+ *     image: string,
+ *     checksum: string|null
+ *     path: string
  *   }>,
  *   before_all: Array<Array<string>>,
  *   repository: string
- * }} An object containing the commands for each module, any global pre-commands, and the repository name.
+ * }>} An object containing the commands for each module, any global pre-commands, and the repository name.
  * @throws {Error} If modules are not defined in the YAML file or if build-parameters are invalid.
  */
-function parseYAML(filename, repoOpt = '', options) {
+async function parseYAML(filename, repoOpt = '', options) {
   const file = cds.load.yaml(join(cds.root, filename))
   const { repository: repoFile, modules, tag: globalTag = 'latest' } = file
   const repository = repoOpt || repoFile
   const before_all = file['before-all'] ? file['before-all'].map(c => c.trim().split(' ')) : []
-  if (!modules) throw new Error('Modules not defined')
-  console.log(`Using repository: ${repository}`)
-  const commands = modules.map(m => {
+  if (!modules) throw `no modules defined in ${filename}`
+  const commands = await Promise.all(modules.map(async (m) => {
     const name = m.name, tag = m.tag || globalTag, bp = m['build-parameters']
-    const source = `${name}:${tag}`, repoImg = `${repository}/${source}`
+    const rawImg = `${repository}/${name}`, source = `${name}:${tag}`, repoImg = `${repository}/${source}`
     const key = Object.keys(bp)[0]
     const buildType = keyProcessorMap[key]
-    if (!buildType) throw new Error(`build-parameters ${Object.keys(bp)} is invalid.`)
+
+    if (!buildType) throw `'build-parameters' ${Object.keys(bp)} in ${filename} is invalid`
     return {
-      name, tag,
-      buildCmd: key === 'buildpack'
-        ? buildType(bp, name, tag, options.clearCache)
-        : buildType(bp, name, tag),
-      tagCmd: ['docker', 'tag', source, repoImg],
-      pushCmd: ['docker', 'push', repoImg]
+      name,
+      tag,
+      buildCmd: buildType(bp, name, tag, key === 'buildpack' && options.clearCache),
+      pushCmd: ['docker', 'push', repoImg],
+      tagCmd: [['docker', 'tag', source, repoImg]],
+      image: rawImg,
+      source,
+      path: bp.buildpack?.path
     }
-  })
+  }))
   return { commands, before_all, repository }
 }
 
@@ -117,26 +128,69 @@ function parseYAML(filename, repoOpt = '', options) {
  */
 async function executeModules(modules, options) {
   for (const m of modules) {
-    console.log(`Containerising module ${m.name}`)
+    if (m.checksum && process.env.SKIP_CHECK != 'true') {
+      try {
+        run(`docker inspect --format='{{index .RepoTags 0}}' ${m.image}:${m.checksum}`, { silent: true })
+        console.log(info(`image ${m.image}:${m.checksum} already exists – skipping build and push`))
+        continue
+      } catch (error) {
+        // ignore
+      }
+    }
+
     for (const cmd of m.buildCmd) run(cmd)
     if (options.push) {
-      run(m.tagCmd)
+      for (const cmd of m.tagCmd) run(cmd)
       run(m.pushCmd)
     }
   }
 }
 
+/**
+ * Calculates checksums for the specified modules based on their directory contents.
+ * @param {*} modules - The list of modules to calculate checksums for.
+ * @param {string} filename - The filename to include in the checksum calculation.
+ */
+async function calculateChecksums(modules, filename) {
+  for (const m of modules) {
+    if (m.path) {
+      m.checksum = await calcDirChecksum(
+        join(cds.root, m.path),
+        (dir) => !dir.includes('node_modules'),
+        'sha256',
+        [
+          join(cds.root, filename),
+          join(cds.root, 'package.json')
+        ]
+      )
+      m.tagCmd = m.tagCmd
+        .concat(m.checksum ? [['docker', 'tag', m.source, `${m.image}:${m.checksum}`]] : [])
+    }
+  }
+}
+
 /**
  * Main function to containerize modules based on a YAML configuration file.
  * @param {string} filename - The path to the YAML configuration file.
  * @param {{ push: boolean, clearCache: boolean }} options - Options object, e.g., { push: true } to push images after building.
- * @returns {Promise<void>}
+ * @returns {Promise<Array<{
+ *    name: string,
+ *    tag: string,
+ *    buildCmd: Array<string>,
+ *    tagCmd: Array<string>,
+ *    pushCmd: Array<string>,
+ *    image: string,
+ *    checksum: string|null
+ *    path: string
+ * }>} - The list of modules that were containerized.
  */
-async function containerize(filename, options = { push: false, clearCache: false }) {
-  const { repository, before_all, commands: modules } = parseYAML(filename, '', options)
+async function containerize(filename = 'containerize.yaml', options = { clearCache: !!process.env.CLEAR_CACHE, push: true }) {
+  const { repository, before_all, commands: modules } = await parseYAML(filename, '', options)
   if (!repository || !modules) return
-  for (const cmd of before_all) await run(cmd)
+  for (const cmd of before_all) run(cmd)
+  await calculateChecksums(modules, filename)
   await executeModules(modules, options)
+  return modules
 }
 
 module.exports = { containerize }

package/bin/version.js

@@ -52,7 +52,7 @@ function list_versions (args, options) {
 
   process.stdout.isTTY && console.log()
   if (options.markdown || options.info) {
-    _markdown (versions)
+    _markdown (versions, options)
   } else {
     const mark = !colors ? s => s : require('../lib/util/term').info
     for (let each of Object.keys(versions))  console.log(`${mark(each)}: ${versions[each]}`)
@@ -81,7 +81,7 @@ function info({ root: cwd = process.cwd() }) {
 
   // Sort entries, with @sap/cds packages on top, followed by @cap-js packages
   const keys = Object.keys(versions).sort(), sorted={}
-  for (let k of ['@sap/cds','@sap/cds-dk']) if (!(k in sorted)) sorted[k] = versions[k]
+  for (let k of ['@sap/cds']) if (!(k in sorted)) sorted[k] = versions[k]
   for (let k of keys) if (!(k in sorted) && k.startsWith('@sap/cds')) sorted[k] = versions[k]
   for (let k of keys) if (!(k in sorted) && k.startsWith('@cap-js')) sorted[k] = versions[k]
   for (let k of keys) if (!(k in sorted)) sorted[k] = versions[k]
@@ -115,9 +115,9 @@ function _versions_from(pkg_path, pkg_label) {
   return versions
 }
 
-function _markdown (versions) {
+function _markdown (versions, { root: cwd = process.cwd() }) {
   const pkg = { name:'', repository:'', version:'' }; try {
-    Object.assign (pkg, require (resolve('package.json')))
+    Object.assign (pkg, require (require.resolve('./package.json', { paths:[cwd] })))
   } catch (e) {/* ignored */}
   const repo = pkg.repository.url || pkg.repository || 'https://github.com/<your/repo>'
   const valLength = Math.max(repo.length, versions.home.length)

package/lib/bind/k8s.js

@@ -32,7 +32,7 @@ module.exports = new class K8SBind extends require('./plugin') {
 
   services4(app) {
     const { execSync } = require('node:child_process')
-    const json = cmd => JSON.parse(execSync(cmd, { encoding: 'utf8' }))
+    const json = cmd => JSON.parse(execSync(cmd, { encoding: 'utf8', maxBuffer: 10 * 1024 * 1024 }))
 
     const bindings = json('kubectl get servicebindings -o json').items
       .filter(b => b.metadata.name.startsWith(app))

package/lib/build/plugins/helm/files/templates/_deployment_helpers.tpl

@@ -23,7 +23,7 @@ copied from web-application: web-application.fullname
 */}}
 {{- define "cap.deploymentHost" -}}
 {{- if .deployment.expose.host }}
-{{- .deployment.expose.host }}
+{{- tpl .deployment.expose.host . }}
 {{- else }}
 {{- $name := (include "cap.web-application.fullname" .) }}
 {{- if hasPrefix $name .Release.Namespace }}

package/lib/build/plugins/helm/index.js

@@ -27,7 +27,7 @@ module.exports = class HelmBuildPlugin extends Plugin {
 
   async build() {
     if (!HelmBuildPlugin.hasTask()) {
-      this.pushMessage("Helm Chart not found. Execute `cds add helm` to add the helm chart.", Plugin.WARNING)
+      this.pushMessage("Helm Chart not found. Execute `cds add kyma` to add the helm chart.", Plugin.WARNING)
       return
     }
 

package/lib/build/provider/hana/2migration.js

@@ -48,31 +48,23 @@ function _compileToHana(model, options, beforeImage) {
     let migrations = []
     let afterImage
 
-    if (cds.compile.to.hana) {
-        const result = cds.compile.to.hana(model, options, beforeImage);
-
-        for (const [content, { file }] of result) {
-            switch (file) {
-                case 'deletions.json':
-                    break
-                case 'migrations.json':
-                    migrations = content
-                    break
-                case 'afterImage.json':
-                    afterImage = content
-                    break
-                default: {
-                    const { name, ext: suffix } = path.parse(file)
-                    definitions.push({ name, suffix, sql: content })
-                }
+    const result = cds.compile.to.hana(model, options, beforeImage);
+
+    for (const [content, { file }] of result) {
+        switch (file) {
+            case 'deletions.json':
+                break
+            case 'migrations.json':
+                migrations = content
+                break
+            case 'afterImage.json':
+                afterImage = content
+                break
+            default: {
+                const { name, ext: suffix } = path.parse(file)
+                definitions.push({ name, suffix, sql: content })
             }
         }
-    } else {
-        // compatibility with cds < 8.0.0
-        const result = cdsc.to.hdi.migration(cds.minify(model), options, beforeImage)
-        definitions = result.definitions
-        migrations = result.migrations
-        afterImage = result.afterImage
     }
     let migrationTableNames = new Set()
     if (afterImage) {
@@ -97,7 +89,7 @@ function _compileToHana(model, options, beforeImage) {
  * @param {String} srcPath Fully qualified path of the directory containing .hdbmigrationtable files
  * @param {String} migration the migration descriptor
  * @param {String} tableSql SQL TABLE definition
- * @returns {Object} Providing access to 'content' and 'fileName'.
+ * @returns {Promise<Object>} Providing access to 'content' and 'fileName'.
  */
 async function _2migrationtable(srcPath, migration, tableSql) {
     let migrationTableModel = null

package/lib/build/provider/hana/index.js

@@ -586,7 +586,7 @@ class HanaBuildPlugin extends InternalBuildPlugin {
     /**
      * Returns all hana native artifacts located in db/src/** workspace folders.
      * @param {Array} workspacePaths Array of workspace paths, 'cds.root' is excluded from the list
-     * @returns {Array} Array of workspace files, each entry contains the db src directory,
+     * @returns {Promise<Array>} Array of workspace files, each entry contains the db src directory,
      * the relative file path and the file name.
      */
     async _getWorkspaceFiles(workspacePaths) {

package/lib/build/provider/hana/template/.hdiconfig-all

@@ -167,6 +167,12 @@
         },
         "hdbschedulerjob" : {
             "plugin_name" : "com.sap.hana.di.schedulerjob"
+        },
+        "hdblogicalschema" : { 
+           "plugin_name" : "com.sap.hana.di.logicalschema"
+        }, 
+        "hdblogicalschemaconfig" : { 
+           "plugin_name" : "com.sap.hana.di.logicalschema.config" 
         }
     }
-}
+}

package/lib/build/provider/hana/template/package.json

@@ -1,7 +1,7 @@
 {
   "name": "deploy",
   "dependencies": {
-    "hdb": "^0",
+    "hdb": "^2.0.0",
     "@sap/hdi-deploy": "^5"
   },
   "engines": {

package/lib/build/provider/internalBuildPlugin.js

@@ -4,6 +4,7 @@ const cds = require('../../cds')
 const Plugin = require('../plugin')
 const { hasOptionValue, getFiles } = require('../util')
 const { FOLDER_GEN, DEFAULT_BUILTIN_PRIORITY_MAX } = require('../constants')
+const TRACE = cds.debug('trace')
 
 class InternalBuildPlugin extends Plugin {
     /**
@@ -116,7 +117,7 @@ class InternalBuildPlugin extends Plugin {
             cwd: cds.root,
             src: this.hasBuildOption('flatDeployLayout', true) || this.task.src === this.task.dest ? this.task.src : cds.root
         }
-        const csnStr = cds.compile.to.json(model, jsonOptions)
+        const csnStr = cds_compile_to_json(model, jsonOptions)
         await this.write(csnStr).to(csnFile)
         return csnStr
     }
@@ -156,4 +157,17 @@ class InternalBuildPlugin extends Plugin {
         return null
     }
 }
+
+// Emits the 'compile.for.runtime' event, as the produced CSN is for runtime usage.
+// Plugins use it to modify the CSN before it is stringified.
+function cds_compile_to_json (csn,o) {
+  TRACE?.time('cds.compile 2json'.padEnd(22)); try {
+    let result, next = ()=> result ??= cds.compile.to.json (csn,o)
+    cds.emit ('compile.for.runtime', csn, o, next)
+    return next() //> in case no handler called next
+  }
+  finally { TRACE?.timeEnd('cds.compile 2json'.padEnd(22)) }
+}
+
+
 module.exports = InternalBuildPlugin

package/lib/build/provider/java/index.js

@@ -7,6 +7,7 @@ const { OUTPUT_MODE, OUTPUT_MODE_RESULT, FILE_EXT_CDS, CONTENT_LANGUAGE_BUNDLES,
 const { getI18nDefaultFolder } = require('../../util')
 const DEFAULT_COMPILE_DEST_FOLDER = path.normalize('src/main/resources/edmx')
 const DEBUG = cds.debug('cli|build')
+const LOG = cds.log('cli|build')
 
 class JavaBuildPlugin extends EdmxBuildPlugin {
     init() {
@@ -25,7 +26,17 @@ class JavaBuildPlugin extends EdmxBuildPlugin {
 
         if (!this.hasBuildOption(CONTENT_EDMX, false)) {
             // generate edmx files containing all features - localized edmx for backward compatibility
-            if (this.hasBuildOption(CONTENT_LOCALIZED_EDMX, true)) {
+            let localized = this.hasBuildOption(CONTENT_LOCALIZED_EDMX, true)
+
+            // Force localized to true for OData v2
+            if (cds.env.odata.version === 'v2') {
+                if (!localized) {
+                    LOG.info('Forcing localized EDMX generation for OData v2')
+                    localized = true
+                }
+            }
+
+            if (localized) {
                 await this.compileToEdmx(model, compileDest, { [FLAVOR_LOCALIZED_EDMX]: true })
             }
             // non-localized edmx

package/lib/build/provider/mtx-sidecar/index.js

@@ -86,7 +86,8 @@ class MtxSidecarBuildPlugin extends NodejsBuildPlugin {
             return
         }
         const { dictionary, sources } = await this.compileAll(model, destMainSrv, destMain)
-        await this.collectAllLanguageBundles(dictionary, sources, destMainSrv, destMain)
+        // await this.collectAllLanguageBundles(dictionary, sources, destMainSrv, destMain)
+        await this.collectAllLanguageBundles(dictionary, sources, destMain, destMain)
 
         if (!this.hasBuildOption(CONTENT_EDMX, false)) {
             //inferred model expected by cds.compile.to.edmx()

package/lib/build/provider/nodejs/index.js

@@ -53,7 +53,8 @@ class NodejsBuildPlugin extends EdmxBuildPlugin {
         if (model) {
             const { dictionary, sources } = await this.compileAll(model, destSrv, destRoot)
             // collect and write language bundles into single i18n.json file
-            await this.collectAllLanguageBundles(dictionary, sources, destSrv, destRoot)
+            await this.collectAllLanguageBundles(dictionary, sources, destRoot, destRoot)
+            // await this.collectAllLanguageBundles(dictionary, sources, destSrv, destRoot)
 
             if (!this.hasBuildOption(CONTENT_EDMX, false)) {
                 const compileOptions = { [FLAVOR_LOCALIZED_EDMX]: this.hasBuildOption(FLAVOR_LOCALIZED_EDMX, true) }

package/lib/build/util.js

@@ -1,13 +1,19 @@
 // @ts-check
-const fs = require('fs')
-const path = require('path')
+const cp = require('node:child_process');
+const fs = require('node:fs')
+const path = require('node:path')
+
 const cds = require('../cds')
-const cp = require('child_process');
-const execAsync = require('util').promisify(cp.exec)
-const IS_WIN = require('os').platform() === 'win32'
+const execAsync = require('node:util').promisify(cp.exec)
+const { isRoot } = require('../util/fs')
+
+const IS_WIN = require('node:os').platform() === 'win32'
 const { SEVERITY_ERROR, FILE_EXT_CDS, NODEJS_MODEL_EXCLUDE_LIST } = require('./constants');
 const DEBUG = cds.debug('cli|build')
-const WS_MAX_DEPTH = 2
+
+// failsafe to avoid too deep recursions
+// increased from 2 to 5, adding a config options in the future
+const WS_MAX_DEPTH = 5
 
 /** @typedef {{col?: number, endCol?: number, line?: number, endLine?: number, file: string}} SourceLocation */
 /** @typedef {object[] | object} Credentials */
@@ -165,9 +171,9 @@ function flatten(modelPaths) {
 
 function getI18nDefaultFolder() {
     // keep '_i18n' as preferred folder for compatibility reasons
-    if (cds.env.i18n.folders.includes('_i18n')) return '_i18n'
-    if (cds.env.i18n.folders.includes('i18n')) return 'i18n'
-    return cds.env.i18n.folders[0] ?? 'i18n'
+    // if (cds.env.i18n.folders.includes('_i18n')) return '_i18n'
+    // if (cds.env.i18n.folders.includes('i18n')) return 'i18n'
+    return cds.env.i18n.folders?.[0] ?? '_i18n'
 }
 
 async function pathExists(path) {
@@ -279,22 +285,32 @@ async function getWorkspaces(wsRoot, resolve = false, devDependencies = true, vi
 }
 
 function findWorkspaceRoot(currentPath, depth = 0) {
-    if (depth > WS_MAX_DEPTH) {
-        DEBUG?.(`No workspaces exist, max depth of ${WS_MAX_DEPTH} reached`)
+    if (isRoot(currentPath) || depth > WS_MAX_DEPTH) {
+        DEBUG?.(`No workspaces found, filesystem root or max depth of ${WS_MAX_DEPTH} reached`)
         return
     }
-    const packageJson = path.join(currentPath, 'package.json')
-    if (fs.existsSync(packageJson)) {
-        if (require(path.join(currentPath, 'package.json')).workspaces) {
+
+    const packageJsonPath = path.join(currentPath, 'package.json')
+    try {
+        const packageJsonContent = fs.readFileSync(packageJsonPath, 'utf8')
+        const packageJson = JSON.parse(packageJsonContent)
+        if (packageJson.workspaces?.length > 0) {
             return currentPath
         }
+    } catch (e) {
+        if (e.code !== 'ENOENT') {
+            if (e.name === 'SyntaxError') {
+                throw `Corrupt package.json found at ${packageJsonPath}: ${e.message}`
+            }
+            throw e
+        }
     }
+
     if (fs.existsSync(path.join(currentPath, '.gitmodules'))) {
         return // project root reached
     }
-    if (path.dirname(currentPath) !== currentPath) {
-        return findWorkspaceRoot(path.dirname(currentPath), depth + 1)
-    }
+
+    return findWorkspaceRoot(path.dirname(currentPath), depth + 1)
 }
 
 /**
@@ -415,15 +431,16 @@ function _filterModelPaths(modelPaths, filter = undefined) {
  * @param {string} srcDir - the directory to search for files
  * @param {(file: string) => boolean} [filter] - the filter function to apply to the found files
  * @param {string[]} files - the set of files to add the found files to
+ * @param {boolean} [ignoreSymlinks=false] - whether to ignore symlinks
  * @returns {string[]} files found in the given directory and its subdirectories
  */
-function getFiles(srcDir, filter, files = []) {
+function getFiles(srcDir, filter, files = [], ignoreSymlinks = false) {
     function handleResource(/** @type {string} entry */ entry) {
         if (!filter || filter.call(this, entry)) {
             const stats = fs.lstatSync(entry)
             if (cds.utils.isdir(entry)) {
                 getFiles(entry, filter, files)
-            } else if (stats.isFile() || stats.isSymbolicLink()) {
+            } else if (stats.isFile() || (!ignoreSymlinks && stats.isSymbolicLink())) {
                 files.push(entry)
             }
         }

package/lib/compile/to_openapi.js

@@ -1,8 +1,4 @@
 const cds = require('../cds')
-const { compile } = cds._local('@cap-js/openapi') // load a local cap-js/openapi (fallback to our own)
-
-function cds_compile_to_openapi (csn, options) {
-  return compile(csn, options)
-}
+const { compile: cds_compile_to_openapi } = cds._local('@cap-js/openapi') // load a local cap-js/openapi (fallback to our own)
 
 module.exports = cds_compile_to_openapi

package/lib/import/common.js

@@ -357,7 +357,13 @@ async function _updateNodeConfig(dest, services, kind, cwd, options) {
             config = {};
             options.config.trim().split(',').forEach(kv => {
                 const [key, val] = kv.split('=');
-                config[key] = val;
+                if (val === 'true' || val === 'false') {
+                    config[key] = (val === 'true');
+                } else if (!isNaN(val)) {
+                    config[key] = Number(val);
+                } else {
+                    config[key] = val;
+                }
             })
             normalizeToDeepObject(config);
         }
@@ -510,7 +516,8 @@ async function postProcess(filePath, options, csn, cwd) {
         usingStatements.push(`using from './${path.basename(csnFile.replace(`'`, `''`))}';`);
     }
 
-    _printUsageHint(csnFile, services, cwd);
+    if (!options.dry)
+        _printUsageHint(csnFile, services, cwd);
 
     if (!options.dry && !options.no_copy)
         await _copyToSrvExternal(filePath, destFilePath, cwd);

package/lib/import/odata/ParserContext.js

@@ -38,6 +38,7 @@ module.exports = class ParserContext {
         this.schemaAliasToNamespace = {};
         this.schemaToSchemaDataIndex = {};
         this.schemaToPrimarySchema = {};
+        this.schemaDetails = {};
         this.vocabNamespaceToAlias = {};
         this.entityToBoundActions = {};
         this.entityToBoundFunctions = {};