@sap/cds-dk 9.6.1 → 9.7.1

package/lib/build/plugin.js

@@ -5,7 +5,10 @@ const cds = require('../cds')
 const IS_WIN = os.platform() === 'win32';
 
 const { OUTPUT_MODE, OUTPUT_MODE_FILESYSTEM, SEVERITY_INFO, SEVERITY_WARNING, SEVERITY_ERROR } = require('./constants')
-const { hasOptionValue, getProperty, relativePaths, BuildMessage, pathExists, filterFeaturePaths, getFiles } = require('./util')
+
+const { find } = require('../util/fs')
+const { hasOptionValue, relativePaths, BuildMessage, filterFeaturePaths } = require('./util')
+
 const DEBUG = cds.debug('cli|build')
 
 /**
@@ -144,7 +147,7 @@ class Plugin {
         if (cds.env.build.target === '.'
             && this.task.src !== this.task.dest
             && !isSubDirectory(this.task.dest, this.task.src)
-            && await pathExists(this.task.dest)) {
+            && fs.existsSync(this.task.dest)) {
             return fs.promises.rm(this.task.dest, { force: true, recursive: true })
         }
     }
@@ -197,7 +200,7 @@ class Plugin {
                     // list all copied files recursively
                     if (cds.utils.isdir(src)) {
                         await fs.promises.cp(src, dest, { recursive: true })
-                        const files = getFiles(dest)
+                        const files = await find(dest)
                         files.forEach(file => this.pushFile(file))
                     } else {
                         this.pushFile(dest)
@@ -283,9 +286,9 @@ class Plugin {
     // Returns the value of the given build option defined for this build task.
     _getBuildOption(qualifiedName) {
         // build task options overwriting other settings
-        let value = getProperty(this.context.options, qualifiedName) // command line
+        let value = this.context.options[qualifiedName] // command line
         if (value === undefined) {
-            value = getProperty(this.task.options, qualifiedName) // task options
+            value = this.task.options[qualifiedName] // task options
         }
         return value
     }

package/lib/build/plugins/helm/files/subcharts/content-deployment/Chart.yaml

@@ -1,5 +1,7 @@
 apiVersion: v2
 description: A Helm Chart for creating a Content Deployment job
 name: content-deployment
+sources:
+- https://github.tools.sap/unified-runtime/content-deployment
 type: application
-version: 1.8.0
+version: 1.9.0

package/lib/build/plugins/helm/files/subcharts/content-deployment/templates/_helpers.tpl

@@ -33,7 +33,7 @@ If release name contains chart name it will be used as a full name.
 Define a name for the Job object
 */}}
 {{- define "content-deployment.internal.jobName" -}}
-{{- printf "%s-%04d" ((include "content-deployment.internal.fullname" . ) | trunc 59) (mod .Release.Revision 1000) }}
+{{- printf "%s-%04d" ((include "content-deployment.internal.fullname" . ) | trunc 58) (mod .Release.Revision 1000) }}
 {{- end }}
 
 {{/*

package/lib/build/plugins/helm/files/subcharts/content-deployment/templates/job.yaml

@@ -33,6 +33,14 @@ spec:
         imagePullPolicy: {{ .Values.imagePullPolicy |  default .Values.global.imagePullPolicy }}
       {{- end }}
         name: {{ include "content-deployment.internal.name" . }}
+        {{- if .Values.command }}
+        command:
+        {{- toYaml .Values.command | nindent 8 }}
+        {{- end }}
+        {{- if .Values.args }}
+        args:
+        {{- toYaml .Values.args | nindent 8 }}
+        {{- end }}
         env:
         - name: EXIT
           value: "1"

package/lib/build/plugins/helm/files/subcharts/content-deployment/values.schema.json

@@ -546,6 +546,24 @@
                     }
                 }
             }
+        },
+        "command": {
+            "$id": "#/properties/command",
+            "title": "Container command",
+            "description": "The command to run in the container. Overrides the default image entrypoint.",
+            "type": "array",
+            "items": {
+                "type": "string"
+            }
+        },
+        "args": {
+            "$id": "#/properties/args",
+            "title": "Container args",
+            "description": "Arguments to pass to the command. Overrides the default image cmd.",
+            "type": "array",
+            "items": {
+                "type": "string"
+            }
         }
     },
     "definitions": {

package/lib/build/plugins/helm/files/subcharts/content-deployment/values.yaml

@@ -14,7 +14,7 @@ global:
     _internal:
       content-deployment:
         versions:
-          1.8.0: true
+          1.9.0: true
 # Will be used instead of the `.Chart.Name`, e.g. when generating the Deployment name.
 # nameOverride: name
 
@@ -125,3 +125,13 @@ annotations:
 #         operator: In
 #         values:
 #         - key-2
+
+## Container command override. See https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/
+# command:
+#   - /bin/sh
+#   - -c
+
+## Container args override. See https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/
+# args:
+#   - echo
+#   - "Hello World"

package/lib/build/plugins.js

@@ -1,11 +1,14 @@
 // @ts-check
 const cds = require('../cds')
-const Plugin = require('./plugin')
 const DEBUG = cds.debug('cli|build')
 
+/** @typedef {typeof import('./plugin')} BuildPlugin */
+
 module.exports = new (class Plugins {
-    /** @type {Map<string, typeof Plugin>} */
+
+    /** @type {Map<string, BuildPlugin>} */
     #plugins = new Map()
+
     get plugins() {
         return this.#plugins
     }
@@ -15,27 +18,16 @@ module.exports = new (class Plugins {
     }
 
     /**
-     * @param {string} id - unique name of the plugin
-     * @param {typeof Plugin | { prototype?: unknown, impl: string, taskDefaults: { src: string } }} plugin - class extending Plugin
+     * @param {string} id - unique ID of the plugin
+     * @param {BuildPlugin} plugin - build plugin implementation
      */
     register(id, plugin) {
-        /**
-         * @param {{prototype?: unknown}} plugin
-         * @returns {plugin is typeof Plugin}
-         */
-        const isNewStylePlugin = plugin => plugin.prototype instanceof Plugin
-
         if (!id || !plugin) {
             throw new Error(`Invalid parameter passed, build plugin id: ${id}`)
         }
         if (this.#plugins.has(id)) {
             throw new Error(`CDS build plugin ${id} already registered`)
         }
-        if(!isNewStylePlugin(plugin)) {
-            // with cds-dk version 7 the following registration format was supported:
-            // cds.build.register("cov2ap", { impl: "@cap-js-community/odata-v2-adapter/src/build.js", taskDefaults: { src: "srv" } })
-            throw `The cds build plugin '${id}' is not compatible with this @sap/cds-dk version. Update the npm package '${plugin.impl || id}' to the latest version.`
-        }
         DEBUG?.(`registering build plugin ${id}`)
         this.#plugins.set(id, plugin)
     }
@@ -43,4 +35,4 @@ module.exports = new (class Plugins {
     #registerDefaults() {
         this.register('helm', require('./plugins/helm'))
     }
-})
+})

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

@@ -1,7 +1,7 @@
 const path = require('path')
 const cds = require('../../../cds')
 const EdmxBuildPlugin = require('../edmxBuildPlugin')
-const { getProperty, relativePaths } = require('../../util')
+const { relativePaths } = require('../../util')
 const { OUTPUT_MODE, OUTPUT_MODE_RESULT, BUILD_TASK_FIORI, CDS_CONFIG_PATH_SEP, OUTPUT_MODE_FILESYSTEM } = require('../../constants')
 const DEBUG = cds.debug('cli|build')
 
@@ -105,14 +105,14 @@ class FioriBuildPlugin extends EdmxBuildPlugin {
             return
         }
 
-        const mainService = getProperty(manifest, ['sap.app', 'dataSources', 'mainService'])
+        const mainService = manifest?.['sap.app']?.dataSources?.mainService
         if (!mainService) {
             // no mainService defined - not supported
             DEBUG?.(`UI module does not have a datasource [mainService], [${relativePaths(cds.root, manifestPath)}], skipping build`)
             return
         }
 
-        const localUri = getProperty(mainService, ['settings', 'localUri'])
+        const localUri = mainService?.settings?.localUri
         const uri = mainService.uri
 
         if (!localUri || !uri) {

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

@@ -3,7 +3,8 @@ const path = require('path')
 const cds = require('../../../cds')
 const { compileToHdbMigration, getJournalEntities, getMigrationTableName } = require('./2migration')
 const InternalBuildPlugin = require('../internalBuildPlugin')
-const { BuildError, relativePaths, BuildMessage, hasOptionValue, getFiles, getWorkspacePaths } = require('../../util')
+const { find } = require('../../../util/fs')
+const { BuildError, relativePaths, BuildMessage, hasOptionValue, getWorkspacePaths } = require('../../util')
 const { OUTPUT_MODE_NONE, OUTPUT_MODE, CONTENT_PACKAGE_JSON, CONTENT_HDBTABLEDATA, CSV_FILE_DETECTION,
     CONTENT_ENV, CONTENT_DEFAULT_ENV_JSON, CONTENT_NODE_MODULES, OUTPUT_MODE_RESULT, CONTINUE_UNRESOLVED_SCHEMA_CHANGES,
     CSV_FILE_TARGET, OPTION_WS } = require('../../constants')
@@ -197,14 +198,10 @@ class HanaBuildPlugin extends InternalBuildPlugin {
 
         // handle *.csv and *.hdbtabledata located in '<dbSrc>/data' and '<dbSrc>/csv' folder,
         // subfolders are not supported
-        const allFiles = csvDirs.reduce((acc, csvDir) => {
-            return acc.concat(getFiles(csvDir, (entry) => {
-                if (cds.utils.isdir(entry)) {
-                    return false
-                }
-                return regexData.test(entry)
-            }))
-        }, [])
+        const allFiles = []
+        for (const csvDir of csvDirs) {
+            allFiles.push(...await find(csvDir, { filter: entry => regexData.test(entry) && !cds.utils.isdir(entry) }))
+        }
 
         return Promise.all(allFiles.map((file) => {
             return this.copy(file).to(path.join(this.task.options.compileDest, path.relative(src, file)))
@@ -226,7 +223,7 @@ class HanaBuildPlugin extends InternalBuildPlugin {
         const tableDataDirs = new Set()
         const destSrcDir = path.join(this.task.dest, "src")
 
-        const allCsvFiles = getFiles(destSrcDir, (entry) => {
+        const allCsvFiles = await find(destSrcDir, { filter: (entry) => {
             if (cds.utils.isdir(entry)) {
                 return true
             }
@@ -234,7 +231,7 @@ class HanaBuildPlugin extends InternalBuildPlugin {
                 tableDataDirs.add(path.dirname(entry))
             }
             return /\.csv$/.test(entry)
-        })
+        }})
         if (allCsvFiles.length > 0) {
             const csvDirs = allCsvFiles.map(path.dirname).reduce((dirs, dir) => {
                 if (!tableDataDirs.has(dir) && !dirs.includes(dir)) { // exclude any dir where a tabledata is present
@@ -554,9 +551,9 @@ class HanaBuildPlugin extends InternalBuildPlugin {
 
     async _validateMigrationTableFiles() {
         const dbSrcDir = path.join(this.task.src, "src")
-        const migrationTableFiles = getFiles(dbSrcDir, (res) => {
+        const migrationTableFiles = await find(dbSrcDir, { filter: (res) => {
             return fs.statSync(res).isFile() && path.extname(res) === FILE_EXT_HDBMIGRATIONTABLE
-        })
+        }})
         if (migrationTableFiles.length > 0) {
             const parser = require('./migrationtable')
             const resolutionMessages = []
@@ -607,17 +604,17 @@ class HanaBuildPlugin extends InternalBuildPlugin {
                 }
             }
         })
-        const workspaceFiles = [...dbPaths].reduce((acc, src) => {
-            const files = getFiles(src, (entry) => {
+        const workspaceFiles = []
+        for (const src of dbPaths) {
+            const files = await find(src, { filter: (entry) => {
                 if (entry.match(/(\/|\\)gen(\/|\\)?$/)) {
                     // skip gen folder content
                     return false
                 }
                 return true
-            })
-            files.forEach(file => acc.push({ dir: src, filePath: path.relative(src, file), fileName: path.basename(file) }))
-            return acc
-        }, [])
+            }})
+            files.forEach(file => workspaceFiles.push({ dir: src, filePath: path.relative(src, file), fileName: path.basename(file) }))
+        }
 
         return workspaceFiles
     }

package/lib/build/provider/internalBuildPlugin.js

@@ -2,7 +2,8 @@ const fs = require('fs')
 const path = require('path')
 const cds = require('../../cds')
 const Plugin = require('../plugin')
-const { hasOptionValue, getFiles } = require('../util')
+const { find } = require('../../util/fs')
+const { hasOptionValue } = require('../util')
 const { FOLDER_GEN, DEFAULT_BUILTIN_PRIORITY_MAX } = require('../constants')
 const TRACE = cds.debug('trace')
 
@@ -88,14 +89,14 @@ class InternalBuildPlugin extends Plugin {
             return !regex.exec(path.basename(src))
         }
 
-        const files = getFiles(srcDir, (src) => {
+        const files = await find(srcDir, { filter: src => {
             // do not copy files that:
             // - from 'cds.env.build.target'
             // - from 'dest'
             // - from some generation folder
             // - do not match filter function ,
             return commonStagingBuildFilter(src, destDir) && (!customFilter || customFilter.call(this, src))
-        })
+        }})
         return Promise.all(
             files.map((srcFile) => {
                 let relFile = path.relative(srcDir, srcFile)
@@ -115,7 +116,7 @@ class InternalBuildPlugin extends Plugin {
         // This ensures that the paths are relative to the cwd when executing cds run.
         const jsonOptions = {
             cwd: cds.root,
-            src: this.hasBuildOption('flatDeployLayout', true) || this.task.src === this.task.dest ? this.task.src : cds.root
+            src: this.task.src === this.task.dest ? this.task.src : cds.root
         }
         const csnStr = cds_compile_to_json(model, jsonOptions)
         await this.write(csnStr).to(csnFile)

package/lib/build/provider/internalBuildTaskProvider.js

@@ -1,14 +1,14 @@
-const fs = require('fs')
-const path = require('path')
 const cds = require('../../cds')
+const { exists, isdir, path } = cds.utils
 const { hasJavaNature, BuildError, normalizePath } = require('../util')
 const BuildTaskProvider = require('../buildTaskProvider')
 const { FILE_EXT_CDS, BUILD_TASK_HANA, BUILD_TASK_FIORI, BUILD_TASK_JAVA, BUILD_TASK_JAVA_CF, BUILD_TASK_NODEJS, BUILD_TASK_NODE_CF, BUILD_TASK_MTX,
     BUILD_TASKS, BUILD_TASK_MTX_SIDECAR, MTX_SIDECAR_FOLDER, BUILD_TASK_MTX_EXTENSION } = require("../constants")
 const ResourcesTarBuilder = require('./mtx/resourcesTarBuilder')
 const DEBUG = cds.debug('cli|build')
+const ModelProviderService = 'cds.xt.ModelProviderService'
 
-class InternalBuildTaskProvider extends BuildTaskProvider {
+module.exports = class InternalBuildTaskProvider extends BuildTaskProvider {
     providesTask(key) {
         return BUILD_TASKS.includes(key.for)
     }
@@ -29,20 +29,22 @@ class InternalBuildTaskProvider extends BuildTaskProvider {
         let db = typeof cds.env.folders.db === "string" ? [normalizePath(cds.env.folders.db)] : cds.env.folders.db
         let srv = typeof cds.env.folders.srv === "string" ? [normalizePath(cds.env.folders.srv)] : cds.env.folders.srv
 
-        const dbOptions = {
-            model: []
-        }
-        const srvOptions = {
-            model: []
+        const folder4 = filesOrFolders => {
+            const entry = filesOrFolders
+                .flatMap(r => path.extname(r) === FILE_EXT_CDS ? [r] : [r, r + FILE_EXT_CDS])
+                .find(r => exists(r))
+            return entry && (isdir(entry) ? entry : path.dirname(entry))
         }
+        const dbOptions = { model: [] }
+        const srvOptions = { model: [] }
         if (Array.isArray(db) && db.length > 0) {
-            db = InternalBuildTaskProvider._getModuleFolder(db) || null
+            db = folder4(db)
             if (!db && !dependencies) { // log once
                 DEBUG?.("No database module found")
             }
         }
         if (Array.isArray(srv) && srv.length > 0) {
-            srv = InternalBuildTaskProvider._getModuleFolder(srv) || null
+            srv = folder4(srv)
             if (!srv && !dependencies) { // log once
                 DEBUG?.("No service module found")
             }
@@ -130,51 +132,25 @@ class InternalBuildTaskProvider extends BuildTaskProvider {
     }
 
     _createMtxTask(src) {
-        // preserve order of creation
-        if (InternalBuildTaskProvider._isMtxExtension()) {
-            DEBUG?.("MTX extension app")
+        const main = cds.env
+        if (main.extends) {
             return { for: BUILD_TASK_MTX_EXTENSION }
         }
-
-        if (InternalBuildTaskProvider._isMtxs()) {
-            const sidecarPath = path.join(cds.root, MTX_SIDECAR_FOLDER)
-            let sidecarEnv
-            if (fs.existsSync(sidecarPath)) {
-                sidecarEnv = cds.env.for("cds", sidecarPath)
+        const isMtxs = main.requires.toggles || main.requires.multitenancy || main.requires[ModelProviderService]
+        if (isMtxs) {
+            if (main.requires?.[ModelProviderService]?._in_sidecar) {
+                throw new BuildError(`Seems that you are executing 'cds build' in the 'mtx/sidecar' folder. Execute 'cds build' in the project root folder instead.`)
             }
-            if (
-                cds.env.profiles?.includes('with-mtx-sidecar') || // new presets // FIXME: BAD hard-coded dependency to profile
-                cds.env.requires["cds.xt.ModelProviderService"]?.external // for compatibility with former mtxs presets
-            ) {
-                DEBUG?.("MTX app with sidecar")
-                if (!sidecarEnv) {
-                    throw new BuildError(`MTX sidecar directory '${sidecarPath}' not existing. Custom build task configuration required if the folder is named differently.`)
-                }
-                if (!sidecarEnv.requires["cds.xt.ModelProviderService"]?._in_sidecar) {
-                    if (sidecarEnv.profiles?.includes('mtx-sidecar')) {
-                        // profile has been set, but cannot be resolved
-                        throw new BuildError("MTX configuration cannot be resolved. Run the 'npm install' command to install up-to-date versions of @sap/cds-mtxs and @sap/cds.")
-                    }
-                    throw new BuildError(`Invalid MTX sidecar configuration - profile 'mtx-sidecar' not set.`)
+            const sidecarPath = path.join(cds.root, MTX_SIDECAR_FOLDER)
+            const sidecar = cds.env.for("cds", sidecarPath)
+            if (sidecar?.requires[ModelProviderService]?._in_sidecar) {
+                if (!exists(sidecarPath)) {
+                    throw new BuildError(`MTX sidecar directory '${MTX_SIDECAR_FOLDER}' does not exist. Custom build task configuration required if the folder is named differently.`)
                 }
                 return { src: MTX_SIDECAR_FOLDER, for: BUILD_TASK_MTX_SIDECAR }
             }
-
-            if (sidecarEnv?.requires["cds.xt.ModelProviderService"]?._in_sidecar || sidecarEnv?.profiles?.includes('mtx-sidecar')) {
-                throw new BuildError(`MTX sidecar requires profile 'with-mtx-sidecar' in project root configuration.`) // FIXME: BAD hard-coded dependency to profile
-            }
-            if (cds.env.requires["cds.xt.ModelProviderService"]?._in_sidecar || cds.env.profiles?.includes('mtx-sidecar')) {
-                // cds build is executed in sidecar folder
-                throw new BuildError(`Seems that you are executing 'cds build' in the 'mtx/sidecar' folder. Execute 'cds build' in the project root folder instead.`)
-            }
-
-            // mtxs nodejs app without sidecar
-            if (!hasJavaNature()) {
-                DEBUG?.("MTX Nodejs app without sidecar")
-                return {
-                    for: BUILD_TASK_MTX,
-                    src
-                }
+            if (!hasJavaNature()) { // only Node.js: embedded multitenancy
+                return { src, for: BUILD_TASK_MTX }
             }
         }
     }
@@ -203,7 +179,7 @@ class InternalBuildTaskProvider extends BuildTaskProvider {
 
     _createNodeTask(src, taskOptions) {
         DEBUG?.("found Nodejs runtime")
-        if (!fs.existsSync(path.join(cds.root, 'package.json'))) {
+        if (!exists('package.json')) {
             throw new BuildError(`No 'package.json' found in project root folder '${cds.root}'`)
         }
         return {
@@ -217,16 +193,6 @@ class InternalBuildTaskProvider extends BuildTaskProvider {
         return !!cds.env.extends
     }
 
-    /**
-     * Distinguishes whether the Nodejs project is a Streamlined MTX (cds >=6) or an old MTX project.
-     */
-    static _isMtxs() {
-        return cds.env.requires.toggles
-            || cds.env.profiles.includes('with-mtx-sidecar') // FIXME: BAD hard-coded dependency to profile
-            || cds.env.requires['cds.xt.ModelProviderService']
-            || (typeof cds.env.requires.multitenancy === "object")
-    }
-
     static _setDefaultSrcFolder(task) {
         switch (task.for) {
             case BUILD_TASK_HANA:
@@ -258,32 +224,4 @@ class InternalBuildTaskProvider extends BuildTaskProvider {
                 throw new Error(`Unknown build task '${task.for}'`)
         }
     }
-
-    /**
-     * Determines the module folder from the given list that may represent files or folders w or w/o .cds file extension.
-     * @param {Array} filesOrFolders
-     */
-    static _getModuleFolder(filesOrFolders) {
-        const resources = [...filesOrFolders]
-        filesOrFolders.forEach(fileOrFolder => {
-            if (path.extname(fileOrFolder) !== FILE_EXT_CDS) {
-                resources.push(fileOrFolder + FILE_EXT_CDS)
-            }
-        })
-        return resources.reduce((acc, resource) => {
-            if (!acc) {
-                let resourcePath = path.resolve(cds.root, resource)
-                if (fs.existsSync(resourcePath)) {
-                    if (cds.utils.isdir(resourcePath)) {
-                        acc = resource
-                    } else {
-                        // represents file
-                        acc = path.dirname(resource)
-                    }
-                }
-            }
-            return acc
-        }, null)
-    }
 }
-module.exports = InternalBuildTaskProvider

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

@@ -1,11 +1,9 @@
- 
 const fs = require('fs')
 const path = require('path')
 const cds = require('../../../cds')
 const EdmxBuildPlugin = require('../edmxBuildPlugin')
 const ResourcesTarBuilder = require('./resourcesTarBuilder')
 const { FOLDER_GEN } = require('../../constants')
-const { BuildError } = require('../../util')
 
 class MtxBuildPlugin extends EdmxBuildPlugin {
     get priority() {
@@ -15,12 +13,6 @@ class MtxBuildPlugin extends EdmxBuildPlugin {
 
     init() {
         super.init()
-
-        // this build task only supports nodejs mtxs apps without sidecar
-        if (cds.env['project-nature'] === 'java') {
-            throw new BuildError(`@sap/cds-mtx is deprecated and not supported by @sap/cds-dk >= 7. This also applies to the 'mtx' build task in Java projects.
-Upgrade to @sap/cds-mtxs following the migration guide https://cap.cloud.sap/docs/guides/multitenancy/old-mtx-migration.`)
-        }
     }
 
     async build() {