@sap/cds-dk 7.9.4 → 8.0.2

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

@@ -1,52 +1,78 @@
 const path = require('path')
 const parser = require('./migrationtable')
-const { BuildError, hasOptionValue, BuildMessage } = require('../../util')
+const { BuildError, BuildMessage } = require('../../util')
 const { SEVERITY_WARNING } = require('../../constants')
 const cds = require('../../../cds'), { compiler: cdsc } = cds
 const cdscVersion = `-- generated by cds-compiler version ${cdsc.version()}`
 const { getArtifactCdsPersistenceName } = cdsc
-const ANNO_PERSISTENCE_JOURNAL = '@cds.persistence.journal'
 const DEBUG = cds.debug('cli|build')
 
-module.exports = async (model, lastDevVersion, srcPath, options = {}) => {
-  const { definitions, deletions, migrations, afterImage, journalFileNames } = _toHdiMigration(model, lastDevVersion, options)
-  const definitionResult = []
+module.exports = async (model, beforeImage, srcPath, options = {}) => {
+    const { definitions, migrations, afterImage, journalFileNames } = _compileToHana(model, options, beforeImage)
+    const definitionResult = []
 
-  for (const { name, suffix, sql } of definitions) {
-    let definitionEntry = { name, suffix, content: sql }
+    for (const { name, suffix, sql } of definitions) {
+        let definitionEntry = { name, suffix, content: sql }
 
-    if (suffix === '.hdbtable') {
-      if (journalFileNames.has(name)) {
-        const migration = migrations.find(migration => migration.name === name)
-        definitionEntry = await _2migrationtable(srcPath, migration || _emptyMigration(name), sql)
-      }
-    }
-    if (definitionEntry) {
-      definitionResult.push(definitionEntry)
+        if (suffix === '.hdbtable') {
+            if (journalFileNames.has(name)) {
+                const migration = migrations.find(migration => migration.name === name)
+                definitionEntry = await _2migrationtable(srcPath, migration || _emptyMigration(name), sql)
+            }
+        }
+        if (definitionEntry) {
+            definitionResult.push(definitionEntry)
+        }
     }
-  }
-  return { definitions: definitionResult, deletions, afterImage: _filterJournalArtifacts(afterImage) }
+    return { definitions: definitionResult, afterImage }
 }
 
-function _toHdiMigration(model, lastDevVersion, options) {
-  const result = cdsc.to.hdi.migration(cds.minify(model), options, lastDevVersion);
-  const journalFileNames = _getJournalFileNames(result.afterImage, options);
-  if (DEBUG) {  
-    DEBUG('cdsc.to.hdi.migration returned')
-    for (const { name, suffix, sql } of result.definitions) {
-      if (suffix === '.hdbtable' || suffix === '.hdbmigrationtable') {
-        if (journalFileNames.has(name)) {
-          const migration = result.migrations.find(migration => migration.name === name)
-          DEBUG(`
-File ${name + '.hdbmigrationtable'} - ${migration ? migration.changeset.length : 0} new changes
-${sql}
-${migration ? migration.changeset.map(change => change.sql).join('\n') : 'Empty changeset'}
-`)
+function _compileToHana(model, options, beforeImage) {
+    let definitions = []
+    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 })
+                }
+            }
         }
-      }
+    } 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 journalFileNames = new Set()
+    if (afterImage) {
+        // 1. determine journal file names before _filterJournalArtifacts is called as getArtifactCdsPersistenceName
+        // might no longer return the proper file name for the reduced CSN, e.g. for draft entities
+        journalFileNames = _getJournalFileNames(afterImage, options)
+
+        // 2. leave only persisted journal-related entities in afterImage
+        afterImage = _filterJournalArtifacts(afterImage)
+    }
+
+    _debug(definitions, migrations, journalFileNames)
+
+    return {
+        definitions, migrations, afterImage, journalFileNames
     }
-  }
-  return { ...result, journalFileNames }
 }
 
 /**
@@ -58,118 +84,136 @@ ${migration ? migration.changeset.map(change => change.sql).join('\n') : 'Empty
  * @returns {Object} Providing access to 'content' and 'fileName'.
  */
 async function _2migrationtable(srcPath, migration, tableSql) {
-  let migrationTableModel = null
-  const file = path.join(srcPath, migration.name + migration.suffix)
-  try {
-    migrationTableModel = await parser.read(file)
-  } catch (e) {
-    // abort build in order to ensure consistent afterImage model state / hdbmigrationtable file state
-    throw new BuildError(`${path.relative(process.cwd(), file)}: ${e.message}`)
-  }
-
-  if (migrationTableModel) {
-    // adding new changeset if change exist, ignore otherwise
-    const migrationEntry = _getNewMigrationEntry(migration.changeset, migrationTableModel.versionNumber)
-    if (migrationEntry) {
-      const versionNumber = migrationTableModel.versionNumber + 1
-      const migrationCount = migrationTableModel.migrations.entries.length
-      const migrations = `${migrationEntry.content}${migrationCount > 0 ? '\n' : ''}${migrationTableModel.migrations.toString()}${migrationCount > 0 ? '\n' : ''}`
-      return {
-        name: migration.name,
-        suffix: migration.suffix,
-        content: `== version=${versionNumber}\n${tableSql}\n\n${migrations}`,
-        changed: true,
-        dropColumns: migrationEntry.dropColumns
-      }
-    } else {
-      // existing migration file version
-      return { name: migration.name, suffix: migration.suffix, content: migrationTableModel.toString(), changed: false }
+    let migrationTableModel = null
+    const file = path.join(srcPath, migration.name + migration.suffix)
+    try {
+        migrationTableModel = await parser.read(file)
+    } catch (e) {
+        // abort build in order to ensure consistent afterImage model state / hdbmigrationtable file state
+        throw new BuildError(`${path.relative(process.cwd(), file)}: ${e.message}`)
     }
-  }
-  // initial migration file version
-  return { name: migration.name, suffix: migration.suffix, content: `== version=1\n${tableSql}\n`, changed: true }
+
+    if (migrationTableModel) {
+        // adding new changeset if change exist, ignore otherwise
+        const migrationEntry = _getNewMigrationEntry(migration.changeset, migrationTableModel.versionNumber)
+        if (migrationEntry) {
+            const versionNumber = migrationTableModel.versionNumber + 1
+            const migrationCount = migrationTableModel.migrations.entries.length
+            const migrations = `${migrationEntry.content}${migrationCount > 0 ? '\n' : ''}${migrationTableModel.migrations.toString()}${migrationCount > 0 ? '\n' : ''}`
+            return {
+                name: migration.name,
+                suffix: migration.suffix,
+                content: `== version=${versionNumber}\n${tableSql}\n\n${migrations}`,
+                changed: true,
+                dropColumns: migrationEntry.dropColumns
+            }
+        } else {
+            // existing migration file version
+            return { name: migration.name, suffix: migration.suffix, content: migrationTableModel.toString(), changed: false }
+        }
+    }
+    // initial migration file version
+    return { name: migration.name, suffix: migration.suffix, content: `== version=1\n${tableSql}\n`, changed: true }
 }
 
 function _getNewMigrationEntry(changeset, currentVersion) {
-  if (changeset && changeset.length > 0) {
-    const dropColumns = changeset.some(e => e.drop)
-    const manualChange = changeset.some(e => !e.sql)
-    const enableDrop = cds.env.hana?.journal?.['enable-drop']
-    const content = changeset.reduce((acc, e) => {
-      if (!acc) {
-        acc = `== migration=${currentVersion + 1}\n`
-        acc += `${cdscVersion}\n`
-
-        if (dropColumns && enableDrop !== true) {
-          acc += `>>>>> Manual resolution required - DROP statements causing data loss are disabled by default.
+    if (changeset && changeset.length > 0) {
+        const dropColumns = changeset.some(e => e.drop)
+        const manualChange = changeset.some(e => !e.sql)
+        const enableDrop = cds.env.hana?.journal?.['enable-drop']
+        const content = changeset.reduce((acc, e) => {
+            if (!acc) {
+                acc = `== migration=${currentVersion + 1}\n`
+                acc += `${cdscVersion}\n`
+
+                if (dropColumns && enableDrop !== true) {
+                    acc += `>>>>> Manual resolution required - DROP statements causing data loss are disabled by default.
 >>>>> You may either:
 >>>>>   uncomment statements to allow incompatible changes, or
 >>>>>   refactor statements, e.g. replace DROP/ADD by single RENAME statement
 >>>>> After manual resolution delete all lines starting with >>>>>\n`
-        } else if (manualChange) {
-          acc += `>>>>> Manual resolution required - insert ALTER statement(s) as described below.
+                } else if (manualChange) {
+                    acc += `>>>>> Manual resolution required - insert ALTER statement(s) as described below.
 >>>>> After manual resolution delete all lines starting with >>>>>\n`
-        }
-      }
-      if (e.sql) {
-        if (e.drop && enableDrop !== true) {
-          acc += `${e.sql.replace(/^/gm, '-- ')}\n`;
-        } else {
-          acc += `${e.sql}\n`
-        }
-      } else {
-        acc +=
-          `>>>>> Insert ALTER statement for: ${e.description}\n`
-      }
-      return acc
-    }, null)
-    return { dropColumns, content }
-  }
-  return null
+                }
+            }
+            if (e.sql) {
+                if (e.drop && enableDrop !== true) {
+                    acc += `${e.sql.replace(/^/gm, '-- ')}\n`;
+                } else {
+                    acc += `${e.sql}\n`
+                }
+            } else {
+                acc +=
+                    `>>>>> Insert ALTER statement for: ${e.description}\n`
+            }
+            return acc
+        }, null)
+        return { dropColumns, content }
+    }
+    return null
 }
 
 function _emptyMigration(name) {
-  return { name, suffix: ".hdbmigrationtable", changeset: [] }
+    return { name, suffix: ".hdbmigrationtable", changeset: [] }
 }
 
 function _getJournalFileNames(model, options) {
-  const journalNames = new Set(cds.reflect(model).all(item => {
-    if (item.kind === 'entity' && item[ANNO_PERSISTENCE_JOURNAL] === true) {
-      if (item['@cds.persistence.skip'] === true || item['@cds.persistence.exists'] === true) {
-        options.messages?.push(new BuildMessage(`[hdbmigrationtable] annotation @cds.persistence.journal skipped for entity '${item.name}' as persistence exists`, SEVERITY_WARNING))
-      }
-      return true
-    }
-    return false
-  }).map(entity => getArtifactCdsPersistenceName(entity.name, 'quoted', model, 'hana')))
+    const journalNames = new Set(cds.reflect(model).all(item => {
+        if (item.kind === 'entity' && item['@cds.persistence.journal'] === true) {
+            if (item['@cds.persistence.skip'] === true || item['@cds.persistence.exists'] === true) {
+                options.messages?.push(new BuildMessage(`[hdbmigrationtable] annotation @cds.persistence.journal skipped for entity '${item.name}' as persistence exists`, SEVERITY_WARNING))
+            }
+            return true
+        }
+        return false
+    }).map(entity => getArtifactCdsPersistenceName(entity.name, 'quoted', model, 'hana')))
 
-  DEBUG?.(`\n[hdbmigrationtable] found ${journalNames.size} model entities annotated with '@cds.persistence.journal`)
-  DEBUG?.(`[hdbmigrationtable] ${[...journalNames].join(', ')}\n`)
+    DEBUG?.(`\n[hdbmigrationtable] found ${journalNames.size} model entities annotated with '@cds.persistence.journal`)
+    DEBUG?.(`[hdbmigrationtable] ${[...journalNames].join(', ')}\n`)
 
-  return journalNames
+    return journalNames
 }
 
-// delete all entities that are not relevant
-function _filterJournalArtifacts(csn) {
-  if (!csn) {
-    return
-  }
-  const dict = csn.definitions
-  for (const name in dict) {
-    if (!_isPersistedAsJournalTable(dict[name])) {
-      delete dict[name]
+// only keep journal related entities
+function _filterJournalArtifacts(afterImage) {
+    if (!afterImage) {
+        return
     }
-  }
-  // mark CSN as modified by cds build
-  csn.meta.build = `CDS Build v${cds.version}`
-  return csn;
+    const dict = afterImage.definitions
+    for (const name in dict) {
+        if (!_isPersistedAsJournalTable(dict[name])) {
+            delete dict[name]
+        }
+    }
+    // mark CSN as modified by cds
+    afterImage.meta.build = `CDS Build v${cds.version}`
+    return afterImage
 }
 
 // see cds-compiler/lib/model/csnUtils.js#isPersistedAsTable
 function _isPersistedAsJournalTable(artifact) {
-  return artifact.kind === 'entity' && hasOptionValue(artifact['@cds.persistence.journal'], true) &&
-    !artifact.abstract &&
-    !hasOptionValue(artifact['@cds.persistence.skip'], true) &&
-    !hasOptionValue(artifact['@cds.persistence.exists'], true) &&
-    (!artifact.query && !artifact.projection || hasOptionValue(artifact['@cds.persistence.table'], true))
+    return (
+        artifact.kind === 'entity' &&
+        artifact['@cds.persistence.journal'] &&
+        !artifact.abstract &&
+        !artifact['@cds.persistence.skip'] &&
+        !artifact['@cds.persistence.exists'] &&
+        ((!artifact.query && !artifact.projection) || artifact['@cds.persistence.table'])
+    )
+}
+
+function _debug(definitions, migrations, journalFileNames) {
+    if (DEBUG) {
+        DEBUG('compile.to.hana returned')
+        for (const { name, suffix, sql } of definitions) {
+            if (suffix === '.hdbtable' && journalFileNames.has(name)) {
+                const migration = migrations.find(migration => migration.name === name)
+                DEBUG(`File ${name + '.hdbmigrationtable'} - ${migration ? migration.changeset.length : 0} new changes
+${sql}
+${migration ? migration.changeset.map(change => change.sql).join('\n') : 'Empty changeset'}
+`)
+            }
+        }
+    }
 }

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

@@ -3,10 +3,10 @@ const path = require('path')
 const cds = require('../../../cds')
 const to_hdbmigration = require('./2migration')
 const InternalBuildPlugin = require('../internalBuildPlugin')
-const { BuildError, relativePaths, BuildMessage, getWorkspaces, hasOptionValue } = require('../../util')
+const { BuildError, relativePaths, BuildMessage, getWorkspaces, hasOptionValue, getFiles } = 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, CONTENT_WS } = require('../../constants')
+    CSV_FILE_TARGET, OPTION_WS} = require('../../constants')
 const { WARNING } = InternalBuildPlugin
 const DEFAULT_COMPILE_DEST_FOLDER = path.normalize("src/gen")
 const FILE_EXT_CSV = ".csv"
@@ -50,7 +50,7 @@ class HanaBuildPlugin extends InternalBuildPlugin {
                 await this._copyResourcesExt(src, dest, model)
             }
             // copy native hana artifacts from workspace dependencies
-            if (cds.cli.options?.ws || hasOptionValue(this.task.options?.[CONTENT_WS], true)) {
+            if (cds.cli.options?.[OPTION_WS] || hasOptionValue(this.task.options?.[OPTION_WS], true)) {
                 await this._addWorkspaceContent()
             }
 
@@ -163,9 +163,10 @@ class HanaBuildPlugin extends InternalBuildPlugin {
             })
         }
 
-        // handle *.csv and *.hdbtabledata located in '<dbSrc>/data' and '<dbSrc>/csv' folder
+        // 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(InternalBuildPlugin._find(csvDir, (entry) => {
+            return acc.concat(getFiles(csvDir, (entry) => {
                 if (fs.statSync(entry).isDirectory()) {
                     return false
                 }
@@ -193,7 +194,7 @@ class HanaBuildPlugin extends InternalBuildPlugin {
         const tableDataDirs = new Set()
         const destSrcDir = path.join(this.task.dest, "src")
 
-        const allCsvFiles = InternalBuildPlugin._find(destSrcDir, (entry) => {
+        const allCsvFiles = getFiles(destSrcDir, (entry) => {
             if (fs.statSync(entry).isDirectory()) {
                 return true
             }
@@ -260,8 +261,10 @@ class HanaBuildPlugin extends InternalBuildPlugin {
             return Promise.reject(new Error(`Invalid deploy-format defined: ${format}`))
         }
 
-        let no_migration = cds.env.features.journal === false || format === 'hdbcds' || Object.values(model.definitions).every(def => !def['@cds.persistence.journal'])
-        if (no_migration) {
+        if (cds.env.features.journal === false
+            || format === 'hdbcds'
+            || (!cds.compile.to.hana && Object.values(model.definitions).every(def => !def['@cds.persistence.journal']))) {
+            // compatibility with existing cds.compile.to.hdbtable plugins cds < 8.0.0
             return await this._compileToHdb(model, format)
         } else {
             return await this._compileToHdbmigration(model, format)
@@ -318,9 +321,7 @@ class HanaBuildPlugin extends InternalBuildPlugin {
         // enforces sqlNames option for compiler in tests, pass options from cds env, ensures that the correct format is taken
         const options = { ...this.options(), messages: this.messages, sql_mapping: cds.env.sql.names, "deploy-format": format }
 
-        const compilationResult = await to_hdbmigration(model, lastDev, dbSrcDir, options)
-        const definitions = compilationResult.definitions
-        const afterImage = compilationResult.afterImage
+        const { definitions, afterImage } = await to_hdbmigration(model, lastDev, dbSrcDir, options)
         let validationError
 
         for (const { name, suffix, content, changed } of definitions) {
@@ -354,7 +355,6 @@ class HanaBuildPlugin extends InternalBuildPlugin {
         // cds build command is again executed
         await Promise.all(promises)
 
-        // ensure 
         try {
             if (validationError) {
                 throw validationError
@@ -363,21 +363,16 @@ class HanaBuildPlugin extends InternalBuildPlugin {
         } 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))
-                    }
+                if (!HanaBuildPlugin._toEqualIgnoreMeta(lastDev, afterImage)) {
+                    await this.write(afterImage).to(lastDevCsnDir)
+                }
+                // add src/.hdiconfig if not existing
+                if (migrationTableFiles.length > 0 && !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))
                 }
             }
         }
-        if (!afterImage) {
-            throw new BuildError(`Inconsistent CDS compilation results - file ${lastDevCsnFolder} missing`)
-        }
         return hdiPlugins
     }
 
@@ -507,7 +502,7 @@ class HanaBuildPlugin extends InternalBuildPlugin {
 
     async _validateMigrationTableFiles() {
         const dbSrcDir = path.join(this.task.src, "src")
-        const migrationTableFiles = InternalBuildPlugin._find(dbSrcDir, (res) => {
+        const migrationTableFiles = getFiles(dbSrcDir, (res) => {
             return fs.statSync(res).isFile() && path.extname(res) === FILE_EXT_HDBMIGRATIONTABLE
         })
         if (migrationTableFiles.length > 0) {

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

@@ -158,6 +158,9 @@
         },
         "txt": {
             "plugin_name": "com.sap.hana.di.copyonly"
+        },
+        "hdbeshconfig": {
+           "plugin_name": "com.sap.hana.di.eshconfig"
         }
     }
 }

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

@@ -132,6 +132,9 @@
         },
         "txt": {
             "plugin_name": "com.sap.hana.di.copyonly"
+        },
+        "hdbeshconfig": {
+           "plugin_name": "com.sap.hana.di.eshconfig"
         }
     }
 }

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

@@ -1,12 +1,13 @@
 {
   "name": "deploy",
   "dependencies": {
-    "@sap/hdi-deploy": "^4"
+    "hdb": "^0",
+    "@sap/hdi-deploy": "^5"
   },
   "engines": {
-    "node": "^16 || ^18 || ^20"
+    "node": "^18 || ^20"
   },
   "scripts": {
-    "start": "node node_modules/@sap/hdi-deploy/deploy.js"
+    "start": "node node_modules/@sap/hdi-deploy/deploy.js --use-hdb"
   }
 }