@sap/cds-dk 7.1.1 → 7.3.0

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

@@ -2,12 +2,12 @@ const fs = require('fs')
 const path = require('path')
 const cds = require('../../../cds')
 const to_hdbmigration = require('./2migration')
-const BuildTaskHandlerInternal = require('../buildTaskHandlerInternal')
-const { BuildError, relativePaths } = require('../../util')
+const InternalBuildPlugin = require('../internalBuildPlugin')
+const { BuildError, relativePaths, BuildMessage } = 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 } = require('../../constants')
-const { ERROR, WARNING } = BuildTaskHandlerInternal
+    CONTENT_ENV, CONTENT_DEFAULT_ENV_JSON, CONTENT_NODE_MODULES, OUTPUT_MODE_RESULT, CONTINUE_UNRESOLVED_SCHEMA_CHANGES } = require('../../constants')
+const { WARNING } = InternalBuildPlugin
 
 const DEFAULT_COMPILE_DEST_FOLDER = path.normalize("src/gen")
 
@@ -15,16 +15,14 @@ const FILE_EXT_CSV = ".csv"
 const FILE_EXT_HDBTABLEDATA = ".hdbtabledata"
 const FILE_EXT_HDBTABLE = ".hdbtable"
 const FILE_EXT_HDBMIGRATIONTABLE = ".hdbmigrationtable"
-
 const FILE_NAME_HDICONFIG = ".hdiconfig"
 const FILE_NAME_HDINAMESPACE = ".hdinamespace"
 const FILE_NAME_PACKAGE_JSON = "package.json"
 const PATH_LAST_DEV_CSN = "last-dev/csn.json"
 const FILE_NAME_UNDEPLOY_JSON = "undeploy.json"
-
 const DEPLOY_FORMAT = "deploy-format"
 
-class HanaModuleBuilder extends BuildTaskHandlerInternal {
+class HanaBuildPlugin extends InternalBuildPlugin {
     init() {
         if (this.hasBuildOption(OUTPUT_MODE, OUTPUT_MODE_RESULT)) {
             this._result = {
@@ -155,7 +153,7 @@ class HanaModuleBuilder extends BuildTaskHandlerInternal {
 
         // handle *.csv and *.hdbtabledata located in '<dbSrc>/data' and '<dbSrc>/csv' folder
         const allFiles = csvDirs.reduce((acc, csvDir) => {
-            return acc.concat(BuildTaskHandlerInternal._find(csvDir, (entry) => {
+            return acc.concat(InternalBuildPlugin._find(csvDir, (entry) => {
                 if (fs.statSync(entry).isDirectory()) {
                     return false
                 }
@@ -183,7 +181,7 @@ class HanaModuleBuilder extends BuildTaskHandlerInternal {
         const tableDataDirs = new Set()
         const destSrcDir = path.join(this.task.dest, "src")
 
-        const allCsvFiles = BuildTaskHandlerInternal._find(destSrcDir, (entry) => {
+        const allCsvFiles = InternalBuildPlugin._find(destSrcDir, (entry) => {
             if (fs.statSync(entry).isDirectory()) {
                 return true
             }
@@ -250,7 +248,8 @@ class HanaModuleBuilder extends BuildTaskHandlerInternal {
             return Promise.reject(new Error(`Invalid deploy-format defined: ${format}`))
         }
 
-        if (this.hasCdsEnvOption('features.journal', false) || format === 'hdbcds') {
+        let no_migration = cds.env.features.journal === false || format === 'hdbcds' || Object.values(model.definitions).every(def => !def['@cds.persistence.journal'])
+        if (no_migration) {
             return await this._compileToHdb(model, format)
         } else {
             return await this._compileToHdbmigration(model, format)
@@ -266,12 +265,24 @@ class HanaModuleBuilder extends BuildTaskHandlerInternal {
         const promises = []
 
         for (const [content, key] of result) {
-            hdiPlugins.add(key.suffix || path.extname(key.file))
+            const suffix = key.suffix || path.extname(key.file)
             const file = key.file ? key.file : key.name + key.suffix
+
+            hdiPlugins.add(suffix)
             if (this.hasBuildOption(OUTPUT_MODE, OUTPUT_MODE_RESULT)) {
                 this._result.hana.push(path.join(relDest, file))
             }
             promises.push(this.write(content).to(path.join(this.task.options.compileDest, file)))
+            if (suffix === FILE_EXT_HDBTABLE) {
+                const name = key.name || path.parse(key.file).name
+                const dbSrcDir = path.join(this.task.src, "src")
+                // issue an error in case a .hdbmigrationtable file already exists
+                if (fs.existsSync(path.join(dbSrcDir, name + FILE_EXT_HDBMIGRATIONTABLE))) {
+                    const relDbSrcDir = path.relative(cds.root, dbSrcDir)
+                    const relDbDestDir = path.relative(cds.root, this.task.options.compileDest)
+                    throw new BuildError(`Multiple files exist defining the same HANA artifact - [${path.join(relDbSrcDir, name + FILE_EXT_HDBMIGRATIONTABLE)}, ${path.join(relDbDestDir, file)}].\nEither annotate the model entity using @cds.persistence.journal or undeploy the file [${path.join('src', name + FILE_EXT_HDBMIGRATIONTABLE)}] using an undeploy.json file.`)
+                }
+            }
         }
         await Promise.all(promises)
         return hdiPlugins
@@ -298,6 +309,7 @@ class HanaModuleBuilder extends BuildTaskHandlerInternal {
         const compilationResult = await to_hdbmigration(model, lastDev, dbSrcDir, options)
         const definitions = compilationResult.definitions
         const afterImage = compilationResult.afterImage
+        let validationError
 
         for (const { name, suffix, content, changed } of definitions) {
             hdiPlugins.add(suffix)
@@ -320,28 +332,38 @@ class HanaModuleBuilder extends BuildTaskHandlerInternal {
                 if (suffix === FILE_EXT_HDBTABLE) {
                     // issue an error in case a .hdbmigrationtable file already exists
                     if (fs.existsSync(path.join(dbSrcDir, name + FILE_EXT_HDBMIGRATIONTABLE))) {
-                        throw new BuildError(`Multiple files exist defining the same HANA artifact - [${path.join(relDbSrcDir, name + FILE_EXT_HDBMIGRATIONTABLE)}, ${path.join(relDbDestDir, file)}].\nEither annotate the model entity using @cds.persistence.journal or undeploy the file [${path.join('src', name + FILE_EXT_HDBMIGRATIONTABLE)}] using an undeploy.json file.`)
+                        validationError = new BuildError(`Multiple files exist defining the same HANA artifact - [${path.join(relDbSrcDir, name + FILE_EXT_HDBMIGRATIONTABLE)}, ${path.join(relDbDestDir, file)}].\nEither annotate the model entity using @cds.persistence.journal or undeploy the file [${path.join('src', name + FILE_EXT_HDBMIGRATIONTABLE)}] using an undeploy.json file.`)
                     }
                 }
             }
         }
+        // the last-dev CSN shall only be updated, if all .hdbmigrationtable files could be successfully updated
+        // of course, .hdbmigrationtable files already written would need to be manually reverted before the 
+        // cds build command is again executed
         await Promise.all(promises)
-        await this._validateMigrationTableFiles()
-
-        // update last development version
-        if (afterImage) {
-            if (migrationTableFiles.length > 0) {
-                if (!HanaModuleBuilder._toEqualIgnoreMeta(lastDev, afterImage)) {
-                    await this.write(afterImage).to(lastDevCsnDir)
-                }
 
-                // add src/.hdiconfig if not existing
-                if (!fs.existsSync(path.join(dbSrcDir, FILE_NAME_HDICONFIG))) {
-                    const template = await HanaModuleBuilder._readTemplateAsJson('.hdiconfig-cloud')
-                    await this.write(template).to(path.join(dbSrcDir, FILE_NAME_HDICONFIG))
+        // ensure 
+        try {
+            if (validationError) {
+                throw validationError
+            }
+            await this._validateMigrationTableFiles()
+        } finally {
+            // update last-dev CSN version
+            if (afterImage) {
+                if (migrationTableFiles.length > 0) {
+                    if (!HanaBuildPlugin._toEqualIgnoreMeta(lastDev, afterImage)) {
+                        await this.write(afterImage).to(lastDevCsnDir)
+                    }
+                    // add src/.hdiconfig if not existing
+                    if (!fs.existsSync(path.join(dbSrcDir, FILE_NAME_HDICONFIG))) {
+                        const template = await HanaBuildPlugin._readTemplateAsJson('.hdiconfig-cloud')
+                        await this.write(template).to(path.join(dbSrcDir, FILE_NAME_HDICONFIG))
+                    }
                 }
             }
-        } else {
+        }
+        if (!afterImage) {
             throw new BuildError(`Inconsistent CDS compilation results - file ${lastDevCsnFolder} missing`)
         }
         return hdiPlugins
@@ -355,7 +377,7 @@ class HanaModuleBuilder extends BuildTaskHandlerInternal {
             this.logger._debug && this.logger.debug(`skip create [${relativePaths(cds.root, packageJson)}], already existing`)
         }
         if (this.isStagingBuild() && !exists) {
-            const content = await HanaModuleBuilder._readTemplateAsJson(FILE_NAME_PACKAGE_JSON)
+            const content = await HanaBuildPlugin._readTemplateAsJson(FILE_NAME_PACKAGE_JSON)
             await this.write(content).to(path.join(this.task.dest, FILE_NAME_PACKAGE_JSON))
         }
     }
@@ -374,11 +396,11 @@ class HanaModuleBuilder extends BuildTaskHandlerInternal {
         //     && !fs.existsSync(path.join(this.task.dest, FILE_NAME_HDICONFIG))
         //     && !fs.existsSync(path.join(this.task.dest, 'cfg', FILE_NAME_HDICONFIG))) {
         //     // in 'gen/db' if none exists
-        //     // ensures correct deployment of all artifacts including HANA native artifacts 
+        //     // ensures correct deployment of all artifacts including HANA native artifacts
         //     // without the need of creating a static .hdiconfig file in the 'db' folder
 
         //     // add all known plugins
-        //     const defaultHdiConfig = await HanaModuleBuilder._readTemplateAsJson('.hdiconfig-cloud')
+        //     const defaultHdiConfig = await HanaBuildPlugin._readTemplateAsJson('.hdiconfig-cloud')
         //     for (const plugin in defaultHdiConfig['file_suffixes']) {
         //         hdiPlugins.add('.' + plugin)
         //     }
@@ -390,7 +412,7 @@ class HanaModuleBuilder extends BuildTaskHandlerInternal {
         hdiConfigPath = path.join(this.task.options.compileDest, FILE_NAME_HDICONFIG)
         // }
 
-        const template = await HanaModuleBuilder._readTemplateAsJson('.hdiconfig-all')
+        const template = await HanaBuildPlugin._readTemplateAsJson('.hdiconfig-all')
         let content = {
             'file_suffixes': {}
         }
@@ -412,7 +434,7 @@ class HanaModuleBuilder extends BuildTaskHandlerInternal {
     async _writeHdiNamespace() {
         // see issue #64 - add .hdinamespace file to prevent HDI from adding gen/ folder to the namespace.
         const hdiNamespace = path.join(this.task.options.compileDest, FILE_NAME_HDINAMESPACE)
-        const content = await HanaModuleBuilder._readTemplateAsJson(FILE_NAME_HDINAMESPACE)
+        const content = await HanaBuildPlugin._readTemplateAsJson(FILE_NAME_HDINAMESPACE)
         return await this.write(content).to(hdiNamespace)
     }
 
@@ -424,7 +446,7 @@ class HanaModuleBuilder extends BuildTaskHandlerInternal {
             // see issue #64 - add .hdinamespace file to prevent HDI from adding gen/ folder to the namespace.
             const undeployJsonDest = path.join(this.task.dest, FILE_NAME_UNDEPLOY_JSON)
             const undeployJsonSrc = path.join(this.task.src, FILE_NAME_UNDEPLOY_JSON)
-            const templateEntries = await HanaModuleBuilder._readTemplateAsJson(FILE_NAME_UNDEPLOY_JSON)
+            const templateEntries = await HanaBuildPlugin._readTemplateAsJson(FILE_NAME_UNDEPLOY_JSON)
             let newEntries = []
             if (fs.existsSync(undeployJsonSrc)) {
                 newEntries = await JSON.parse((await fs.promises.readFile(undeployJsonSrc, 'utf-8')).toString())
@@ -454,7 +476,7 @@ class HanaModuleBuilder extends BuildTaskHandlerInternal {
         if (fs.existsSync(file)) {
             const undeployList = JSON.parse((await fs.promises.readFile(file)).toString(), 'utf-8')
             if (Array.isArray(undeployList)) {
-                const hdiconfig = await HanaModuleBuilder._readTemplateAsJson('.hdiconfig-all')
+                const hdiconfig = await HanaBuildPlugin._readTemplateAsJson('.hdiconfig-all')
                 const keys = new Set(Object.keys(hdiconfig['file_suffixes']).map(key => '.' + key))
                 undeployList.forEach(entry => {
                     const extName = path.extname(entry)
@@ -473,23 +495,32 @@ class HanaModuleBuilder extends BuildTaskHandlerInternal {
 
     async _validateMigrationTableFiles() {
         const dbSrcDir = path.join(this.task.src, "src")
-        const migrationTableFiles = BuildTaskHandlerInternal._find(dbSrcDir, (res) => {
+        const migrationTableFiles = InternalBuildPlugin._find(dbSrcDir, (res) => {
             return fs.statSync(res).isFile() && path.extname(res) === FILE_EXT_HDBMIGRATIONTABLE
         })
         if (migrationTableFiles.length > 0) {
             const parser = require('./migrationtable')
+            const resolutionMessages = []
 
             await Promise.all(migrationTableFiles.map(async file => {
                 try {
                     const tableModel = await parser.read(file)
                     if (/^>>>>>/m.test(tableModel.migrations.toString())) {
                         // as this is not a build error, we do not abort cds build, instead only log as error
-                        this.pushMessage(`Current model changes require manual resolution. See migration file ${path.relative(cds.root, file)} for further details.`, ERROR)
+                        resolutionMessages.push(new BuildMessage(`Manual resolution required for file ${path.relative(cds.root, file)}. Check migration version content for further details.`))
                     }
                 } catch (e) {
-                    throw new Error(`${path.relative(cds.root, file)}: ${e.toString()}`, ERROR)
+                    throw new Error(`${path.relative(cds.root, file)}: ${e.toString()}`)
                 }
             }))
+            if (resolutionMessages.length) {
+                // REVISIT: undocumented, we may want to delete in future versions
+                if (!this.hasBuildOption(CONTINUE_UNRESOLVED_SCHEMA_CHANGES, true)) {
+                    throw new BuildError('Current model changes require manual resolution', resolutionMessages)
+                }
+                // adding to the task's message list
+                resolutionMessages.forEach(m => this._messages.push(m))
+            }
         }
     }
 
@@ -519,4 +550,4 @@ class HanaModuleBuilder extends BuildTaskHandlerInternal {
         return toString(csn1) === toString(csn2)
     }
 }
-module.exports = HanaModuleBuilder
+module.exports = HanaBuildPlugin

package/lib/build/provider/{buildTaskHandlerInternal.js → internalBuildPlugin.js}

@@ -1,11 +1,11 @@
 const fs = require('fs')
 const path = require('path')
 const cds = require('../../cds')
-const BuildTaskHandler = require('../buildTaskHandler')
+const BuildPlugin = require('../buildPlugin')
 const { hasOptionValue } = require('../util')
 const { FOLDER_GEN } = require('../constants')
 
-class BuildTaskHandlerInternal extends BuildTaskHandler {
+class InternalBuildPlugin extends BuildPlugin {
     /**
      * Returns the logger that has been passed the build task engine.
      * @returns {object}
@@ -15,11 +15,11 @@ class BuildTaskHandlerInternal extends BuildTaskHandler {
         return this._logger;
     }
     /**
-     * Custom build handlers are executed before internal handlers in order
+     * Custom build plugins are executed before internal build plugins in order
      * ensure and content cannot be overwritten by mistake.
      */
     get priority() {
-        return BuildTaskHandlerInternal.PRIORITY_MAX_VALUE
+        return InternalBuildPlugin.PRIORITY_MAX_VALUE
     }
 
     async clean() {
@@ -43,16 +43,16 @@ class BuildTaskHandlerInternal extends BuildTaskHandler {
     }
 
     /**
-     * Called by the framework after {@link #init()}. Handlers may want to perform more elaborate preparation.
+     * Called by the framework after {@link #init()}, used to perform more elaborate preparation.
      * E.g. caching some pre-calculated data that can be used across multiple build tasks. This kind of data
-     * has to be stored in the handler type specific buildOptions section.
+     * has to be stored in the plugin type specific options section.
      * @returns {Promise<boolean>} A value 'false' indicates that {@link #prepare()} will not be called for other instances
-     * of this handler type.
-     * True indicates that {@link #prepare()} will be called for other instances of this of this handler type.
+     * of this plugin type.
+     * True indicates that {@link #prepare()} will be called for other instances of this of this plugin type.
      * @deprecated
      */
     async prepare() {
-        // cancel subsequent prepare calls for other handlers of the same type by default
+        // cancel subsequent prepare calls for other plugins of the same type by default
         return false
     }
 
@@ -101,7 +101,7 @@ class BuildTaskHandlerInternal extends BuildTaskHandler {
     }
 
     async copyNativeContent(srcDir, destDir, customFilter) {
-        const files = BuildTaskHandlerInternal._find(srcDir, (src) => {
+        const files = InternalBuildPlugin._find(srcDir, (src) => {
             // do not copy files that:
             // - from 'cds.env.build.target'
             // - from 'dest'
@@ -225,4 +225,4 @@ class BuildTaskHandlerInternal extends BuildTaskHandler {
         return fs.lstatSync(entry)
     }
 }
-module.exports = BuildTaskHandlerInternal
+module.exports = InternalBuildPlugin

package/lib/build/provider/{buildTaskProviderInternal.js → internalBuildTaskProvider.js}

@@ -1,14 +1,14 @@
 const fs = require('fs')
 const path = require('path')
 const cds = require('../../cds')
-const { hasJavaNature, getDefaultModelOptions, BuildError, hasOptionValue, isClassicMtx } = require('../util')
+const { hasJavaNature, getDefaultModelOptions, BuildError, hasOptionValue, isClassicMtx, 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_TASK_PREFIX, BUILD_TASKS, BUILD_TASK_MTX_SIDECAR, MTX_SIDECAR_FOLDER, BUILD_TASK_MTX_EXTENSION, NODEJS_MODEL_EXCLUDE_LIST,
-    DEFAULT_BUILT_IN_MODELS } = require("../constants")
+    IGNORE_DEFAULT_MODELS } = require("../constants")
 
-class BuildTaskProviderInternal extends BuildTaskProvider {
+class InternalBuildTaskProvider extends BuildTaskProvider {
     constructor(logger) {
         super()
         this._logger = logger
@@ -22,35 +22,34 @@ Upgrade to @sap/cds-mtxs following the migration guide https://cap.cloud.sap/doc
         return this._logger
     }
 
-    canHandleTask(task) {
-        return BUILD_TASKS.includes(task.for)
-            || task.use && task.use.startsWith(BUILD_TASK_PREFIX)
-        // support different build task implementations of the same build task ID defined by 'for'
-        //return (BUILD_TASKS.includes(task.for) && !task.use) || (task.use && task.use.startsWith(BUILD_TASK_PREFIX))
+    providesTask(key) {
+        return BUILD_TASKS.includes(key.for) || key.use && key.use.startsWith(BUILD_TASK_PREFIX)
+        // REVISIT: do not support different build task implementations of the same build task ID defined by 'for'
+        // return (BUILD_TASKS.includes(key.for) && !key.use) || (key.use && key.use.startsWith(BUILD_TASK_PREFIX))
     }
 
-    loadHandler(task) {
-        return require(`./${BuildTaskProviderInternal._getForValueFromTask(task)}`)
-    }
-
-    async lookupTasks(tasks) {
-        return this._createTasks(tasks, tasks.length > 0)
+    async lookupTasks(tasks, dependencies) {
+        return this._createTasks(tasks, dependencies)
     }
 
     async applyTaskDefaults(task) {
-        const taskFor = BuildTaskProviderInternal._getForValueFromTask(task)
+        const taskFor = InternalBuildTaskProvider._getForValueFromTask(task)
         task.for = task.for || taskFor
         task.use = task.use || `${BUILD_TASK_PREFIX}/${taskFor}`
 
         // src folder needs to be initialized first
-        BuildTaskProviderInternal._setDefaultSrcFolder(task)
+        InternalBuildTaskProvider._setDefaultSrcFolder(task)
 
-        BuildTaskProviderInternal._setDefaultModel(task)
+        InternalBuildTaskProvider._setDefaultModel(task)
     }
 
-    async _createTasks(tasks, addRequiredTasks) {
-        let db = typeof cds.env.folders.db === "string" ? [BuildTaskProviderInternal._normalizePath(cds.env.folders.db)] : cds.env.folders.db
-        let srv = typeof cds.env.folders.srv === "string" ? [BuildTaskProviderInternal._normalizePath(cds.env.folders.srv)] : cds.env.folders.srv
+    loadPlugin(task) {
+        return require(`./${InternalBuildTaskProvider._getForValueFromTask(task)}`)
+    }
+
+    async _createTasks(tasks, dependencies) {
+        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: []
@@ -59,20 +58,20 @@ Upgrade to @sap/cds-mtxs following the migration guide https://cap.cloud.sap/doc
             model: []
         }
         if (Array.isArray(db) && db.length > 0) {
-            db = BuildTaskProviderInternal._getModuleFolder(db) || null
-            if (!db && !addRequiredTasks) { // log once
+            db = InternalBuildTaskProvider._getModuleFolder(db) || null
+            if (!db && !dependencies) { // log once
                 this.logger.debug("No database module found")
             }
         }
         if (Array.isArray(srv) && srv.length > 0) {
-            srv = BuildTaskProviderInternal._getModuleFolder(srv) || null
-            if (!srv && !addRequiredTasks) { // log once
+            srv = InternalBuildTaskProvider._getModuleFolder(srv) || null
+            if (!srv && !dependencies) { // log once
                 this.logger.debug("No service module found")
             }
         }
 
         // order of creation is relevant
-        if (addRequiredTasks) {
+        if (dependencies) {
             const mtxTask = tasks.find(task => task.for === BUILD_TASK_MTX || task.for === BUILD_TASK_MTX_SIDECAR)
             if (mtxTask) {
                 //restore used tasks as they might have been filtered by 'cds build --for mtx'
@@ -124,7 +123,7 @@ Upgrade to @sap/cds-mtxs following the migration guide https://cap.cloud.sap/doc
 
     _createDbTask(src, taskOptions) {
         this.logger.debug("determining database kind")
-        if (!src || BuildTaskProviderInternal._isMtxExtension()) {
+        if (!src || InternalBuildTaskProvider._isMtxExtension()) {
             return null
         }
         let task = null
@@ -166,12 +165,12 @@ Upgrade to @sap/cds-mtxs following the migration guide https://cap.cloud.sap/doc
         this.logger.debug("determining MTX architecture")
 
         // preserve order of creation
-        if (BuildTaskProviderInternal._isMtxExtension()) {
+        if (InternalBuildTaskProvider._isMtxExtension()) {
             this.logger.debug("MTX extension app")
             return { for: BUILD_TASK_MTX_EXTENSION }
         }
 
-        if (BuildTaskProviderInternal._isMtxs()) {
+        if (InternalBuildTaskProvider._isMtxs()) {
             const sidecarPath = path.join(cds.root, MTX_SIDECAR_FOLDER)
             let sidecarEnv
             if (fs.existsSync(sidecarPath)) {
@@ -204,7 +203,7 @@ Upgrade to @sap/cds-mtxs following the migration guide https://cap.cloud.sap/doc
             }
 
             // mtxs nodejs app without sidecar
-            if (!BuildTaskProviderInternal._hasJavaNature(src)) {
+            if (!InternalBuildTaskProvider._hasJavaNature(src)) {
                 this.logger.debug("MTX Nodejs app without sidecar")
                 return {
                     for: BUILD_TASK_MTX,
@@ -216,11 +215,11 @@ Upgrade to @sap/cds-mtxs following the migration guide https://cap.cloud.sap/doc
 
     _createSrvTask(src, taskOptions) {
         this.logger.debug("determining implementation technology")
-        if (!src || BuildTaskProviderInternal._isMtxExtension()) {
+        if (!src || InternalBuildTaskProvider._isMtxExtension()) {
             return null
         }
         let task = null
-        if (BuildTaskProviderInternal._hasJavaNature(src)) {
+        if (InternalBuildTaskProvider._hasJavaNature(src)) {
             task = this._createJavaTask(src, taskOptions)
         } else {
             task = this._createNodeTask(src, taskOptions)
@@ -269,16 +268,16 @@ Upgrade to @sap/cds-mtxs following the migration guide https://cap.cloud.sap/doc
     static _setDefaultSrcFolder(task) {
         switch (task.for) {
             case BUILD_TASK_HANA:
-                task.src = task.src || this._normalizePath(cds.env.folders.db)
+                task.src = task.src || normalizePath(cds.env.folders.db)
                 break
             case BUILD_TASK_JAVA:
             case BUILD_TASK_JAVA_CF:
             case BUILD_TASK_NODEJS:
             case BUILD_TASK_NODE_CF:
-                task.src = task.src || this._normalizePath(cds.env.folders.srv)
+                task.src = task.src || normalizePath(cds.env.folders.srv)
                 break
             case BUILD_TASK_FIORI:
-                task.src = task.src || this._normalizePath(cds.env.folders.app)
+                task.src = task.src || normalizePath(cds.env.folders.app)
                 break
             case BUILD_TASK_MTX_SIDECAR:
                 task.src = task.src || MTX_SIDECAR_FOLDER
@@ -288,7 +287,7 @@ Upgrade to @sap/cds-mtxs following the migration guide https://cap.cloud.sap/doc
                 break
             case BUILD_TASK_MTX:
                 // mtxs with nodejs, but without sidecar
-                task.src = task.src || this._normalizePath(cds.env.folders.srv)
+                task.src = task.src || normalizePath(cds.env.folders.srv)
                 break
             default:
                 throw new Error(`Unknown build task '${task.use || task.for}'`)
@@ -300,29 +299,27 @@ Upgrade to @sap/cds-mtxs following the migration guide https://cap.cloud.sap/doc
         if (taskModelPaths && !Array.isArray(taskModelPaths)) {
             taskModelPaths = [taskModelPaths]
         }
+        const toggles = cds.env.features.folders
+        const allowList = new RegExp(`^@sap/cds${toggles ? '|^' + toggles.replace('*', '') : ''}`)
         task.options = task.options || {}
         let defaultModelPaths = []
-        // add default models to custom build tasks if this hasn't been disabled
         if (taskModelPaths?.length) {
-            if (!hasOptionValue(task.options?.[DEFAULT_BUILT_IN_MODELS], false)) {
-                // get the built-in models
-                defaultModelPaths = getDefaultModelOptions().filter(p => p.match('@sap/cds'))
+            if (!hasOptionValue(task.options?.[IGNORE_DEFAULT_MODELS], true)) {
+                defaultModelPaths = getDefaultModelOptions().filter(p => p.match(allowList))
             }
         } else {
             defaultModelPaths = getDefaultModelOptions()
             defaultModelPaths.push(task.src)
-            if (hasOptionValue(task.options?.[DEFAULT_BUILT_IN_MODELS], false)) {
+            if (hasOptionValue(task.options?.[IGNORE_DEFAULT_MODELS], true)) {
                 // all default models except the built-in models
-                defaultModelPaths = defaultModelPaths.filter(p => !p.match('@sap/cds'))
+                defaultModelPaths = defaultModelPaths.filter(p => !p.match(allowList))
             }
         }
-
         // REVISIT: filter nodejs bootstrap service models for Java - issues/12770#issuecomment-1805719
         if (this._hasJavaNature()) {
             defaultModelPaths = defaultModelPaths.filter(p => !NODEJS_MODEL_EXCLUDE_LIST.includes(p))
         }
-        // also add built-in models to custom build tasks already containing model options
-        if (!taskModelPaths || defaultModelPaths.length) {
+        if (defaultModelPaths.length) {
             task.options.model = [...new Set(taskModelPaths?.length ? taskModelPaths.concat(defaultModelPaths) : defaultModelPaths)]
         }
     }
@@ -340,14 +337,6 @@ Upgrade to @sap/cds-mtxs following the migration guide https://cap.cloud.sap/doc
         return task.for ? task.for : task.use && task.use.substring(BUILD_TASK_PREFIX.length + 1)
     }
 
-    /**
-     * For valid paths remove trailing '/'. Otherwise return as is - important!!
-     * @param {*} dir
-     */
-    static _normalizePath(dir) {
-        return typeof dir === "string" ? dir.replace(/\/$/, '') : dir
-    }
-
     /**
      * Determines the module folder from the past list that may represent files or folders w or w/o .cds file extension.
      * @param {Array} filesOrFolders
@@ -375,4 +364,4 @@ Upgrade to @sap/cds-mtxs following the migration guide https://cap.cloud.sap/doc
         }, null)
     }
 }
-module.exports = BuildTaskProviderInternal
+module.exports = InternalBuildTaskProvider

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

@@ -1,35 +1,34 @@
 const fs = require('fs')
 const path = require('path')
 const cds = require('../../../cds')
-const BuildTaskHandlerEdmx = require('../buildTaskHandlerEdmx')
-const { OUTPUT_MODE, OUTPUT_MODE_RESULT, FILE_EXT_CDS, CONTENT_LANGUAGE_BUNDLES, CONTENT_DEFAULT_CSN, DEFAULT_CSN_FILE_NAME, OUTPUT_MODE_FILESYSTEM } = require('../../constants')
+const EdmxBuildPlugin = require('../edmxBuildPlugin')
+const { OUTPUT_MODE, OUTPUT_MODE_RESULT, FILE_EXT_CDS, CONTENT_LANGUAGE_BUNDLES, CONTENT_DEFAULT_CSN, DEFAULT_CSN_FILE_NAME, 
+    OUTPUT_MODE_FILESYSTEM, FLAVOR_LOCALIZED_EDMX } = require('../../constants')
 const { getI18nDefaultFolder } = require('../../util')
 const DEFAULT_COMPILE_DEST_FOLDER = path.normalize('src/main/resources/edmx')
 
-class JavaModuleBuilder extends BuildTaskHandlerEdmx {
+class JavaBuildPlugin extends EdmxBuildPlugin {
     init() {
         super.init()
         this.task.options.compileDest = path.resolve(this.task.dest, this.task.options.compileDest || DEFAULT_COMPILE_DEST_FOLDER)
     }
 
     async build() {
+        const compileDest = this.task.options.compileDest
         const { src, dest } = this.task
-
-        const odataOptions = {
-            version: cds.env.odata?.version
-        }
-
         const model = await this.model()
         if (!model) {
             return
         }
 
-        const odata = await this._compileForOdata(model, this.task.options.compileDest, odataOptions)
-        await this.compileToEdmx(odata, this.task.options.compileDest, odataOptions)
+        // generate edmx files containing all features
+        const odata = await this._compileForOdata(model, compileDest)
+        await this.compileToEdmx(odata, compileDest) // localized edmx for backward compatibility
+        await this.compileToEdmx(odata, path.join(compileDest, 'odata', cds.env.odata.version), { [FLAVOR_LOCALIZED_EDMX]: false }) // non-localized edmx
 
-        if (this.hasBuildOption(CONTENT_LANGUAGE_BUNDLES, true)) {
-            // collect and write language bundles into single i18n.json file
-            const i18n = await this.collectLanguageBundles(model, path.join(this.task.dest, getI18nDefaultFolder()))
+        if (!this.hasBuildOption(CONTENT_LANGUAGE_BUNDLES, false)) {
+            // collect and write language bundles containing all features
+            const i18n = await this.collectLanguageBundles(model, path.join(compileDest, getI18nDefaultFolder()))
             if (i18n && this.hasBuildOption(OUTPUT_MODE, OUTPUT_MODE_RESULT)) {
                 this._result.languageBundles = i18n.bundles
             }
@@ -59,28 +58,29 @@ class JavaModuleBuilder extends BuildTaskHandlerEdmx {
         })
     }
 
-    async _compileForOdata(model, csnDest, compileOptions) {
+    async _compileForOdata(model, csnDest, compileOptions = {}) {
         // csn for service providers
         const m = cds.compile.for.java(model, {
             ...this._options4odata(),
             ...compileOptions
         })
         const csnFile = path.join(csnDest, DEFAULT_CSN_FILE_NAME)
-        let csnModel
         // adding csn to build result containing @source and _where persisted properties
         if (this.hasBuildOption(CONTENT_DEFAULT_CSN, true)) { //default true or undefined
             const csnStr = await this.compileToJson(model, csnFile)
-            csnModel = JSON.parse(csnStr)
-            csnModel.meta = model.meta
+            if (this.hasBuildOption(OUTPUT_MODE, OUTPUT_MODE_RESULT)) {
+                const csnModel = JSON.parse(csnStr)
+                csnModel.meta = model.meta
+                this._result.csn = csnModel
+            }
         } else {
             const csnStr = await this.compileToJson(m, csnFile)
-            csnModel = JSON.parse(csnStr)
-            csnModel.meta = m.meta
-        }
-        if (this.hasBuildOption(OUTPUT_MODE, OUTPUT_MODE_RESULT)) {
-            this._result.csn = csnModel
+            if (this.hasBuildOption(OUTPUT_MODE, OUTPUT_MODE_RESULT)) {
+                const csnModel = JSON.parse(csnStr)
+                csnModel.meta = m.meta
+                this._result.csn = csnModel
+            }
         }
-
         return m
     }
 
@@ -90,4 +90,4 @@ class JavaModuleBuilder extends BuildTaskHandlerEdmx {
         return match && match[1] === 1
     }
 }
-module.exports = JavaModuleBuilder
+module.exports = JavaBuildPlugin