@sap/cds-dk 6.8.3 → 7.0.0

package/lib/init/util/mvn.js

@@ -1,6 +1,5 @@
 
-const { MAVEN_ARCHETYPE_VERSION, OPTION_JAVA_MVN,
-    OPTION_JAVA_PACKAGE, OPTION_SAMPLES, REGEX_JAVA_PACKAGE, OPTION_HANA } = require('../constants');
+const { MAVEN_ARCHETYPE_VERSION, OPTIONS: { JAVA_MVN, JAVA_PACKAGE, SAMPLES, HANA }, REGEX_JAVA_PACKAGE } = require('../constants');
 
 const { CliError } = require('../../client/helper/errors');
 
@@ -16,6 +15,7 @@ const LOG = console
 const cds = require('../../cds')
 const DEBUG = cds.debug('cli')
 
+
 class MvnArchetypeUtil {
 
     _scanMvnParams(mvnParams, params) {
@@ -56,8 +56,8 @@ class MvnArchetypeUtil {
 
         params.set(`com.sap.cds:cds-maven-plugin:${MAVEN_ARCHETYPE_VERSION}:addSample`);
 
-        if (options[OPTION_JAVA_MVN]) {
-            this._scanMvnParams(options[OPTION_JAVA_MVN], params);
+        if (options[JAVA_MVN]) {
+            this._scanMvnParams(options[JAVA_MVN], params);
         }
 
         if (options.force) {
@@ -72,8 +72,8 @@ class MvnArchetypeUtil {
 
         params.set(`com.sap.cds:cds-maven-plugin:${MAVEN_ARCHETYPE_VERSION}:addIntegrationTest`);
 
-        if (options[OPTION_JAVA_MVN]) {
-            this._scanMvnParams(options[OPTION_JAVA_MVN], params);
+        if (options[JAVA_MVN]) {
+            this._scanMvnParams(options[JAVA_MVN], params);
         }
 
         if (options.force) {
@@ -89,8 +89,8 @@ class MvnArchetypeUtil {
         params.set(`com.sap.cds:cds-maven-plugin:${MAVEN_ARCHETYPE_VERSION}:addTargetPlatform`);
         params.set(`-DtargetPlatform`, `cloudfoundry`);
 
-        if (options[OPTION_JAVA_MVN]) {
-            this._scanMvnParams(options[OPTION_JAVA_MVN], params);
+        if (options[JAVA_MVN]) {
+            this._scanMvnParams(options[JAVA_MVN], params);
         }
 
         return this._finalize(params);
@@ -114,17 +114,17 @@ class MvnArchetypeUtil {
         params.set(`-DartifactId`, projectName);
         params.set(`-DgroupId`, DEFAULT_GROUP_ID);
 
-        const hasHana = !!(options.add && options.add.has(OPTION_HANA));
+        const hasHana = !!(options.add && options.add.has(HANA));
         if (hasHana) {
             params.set(`-DtargetPlatform`, `cloudfoundry`);
         }
 
-        const hasSamples = !!(options.add && options.add.has(OPTION_SAMPLES));
+        const hasSamples = !!(options.add && options.add.has(SAMPLES));
         params.set(`-DincludeModel`, hasSamples);
         params.set(`-DincludeIntegrationTest`, hasSamples);
 
-        if (options[OPTION_JAVA_MVN]) {
-            this._scanMvnParams(options[OPTION_JAVA_MVN], params);
+        if (options[JAVA_MVN]) {
+            this._scanMvnParams(options[JAVA_MVN], params);
         }
 
         // -DjdkVersion=[11|17]
@@ -136,9 +136,13 @@ class MvnArchetypeUtil {
                     const segments = match[1]?.split('.');
                     const version = new Number(segments?.[0]);
                     switch (true) {
-                        case (version < 11): throw new CliError(`Java version ${match[1]} is not supported. Use Java 11 or higher.`);
-                        case (version <= 16): params.set(`-DjdkVersion`, 11); break;
-                        case (version > 16): params.set(`-DjdkVersion`, 17); break;
+                        case (version < 17):
+                            if (process.env.WS_BASE_URL) {
+                                throw new CliError(`Java version ${match[1]} is not supported. Use Java 17 or higher. You can use command 'Java: Set Default JDK' to switch to Java 17.`)
+                            }
+                            throw new CliError(`Java version ${match[1]} is not supported. Use Java 17 or higher.`)
+                        case (version < 20): params.set(`-DjdkVersion`, 17); break;
+                        case (version >= 20): params.set(`-DjdkVersion`, 20); break;
                         default:
                     }
                 }
@@ -150,8 +154,8 @@ class MvnArchetypeUtil {
             }
         }
 
-        if (options[OPTION_JAVA_PACKAGE]) {
-            params.set(`-Dpackage`, options[OPTION_JAVA_PACKAGE]);
+        if (options[JAVA_PACKAGE]) {
+            params.set(`-Dpackage`, options[JAVA_PACKAGE]);
         }
 
         const artifactId = params.get('-DartifactId');

package/lib/init/util/projectReader.js

@@ -5,7 +5,6 @@ const P_LANGUAGE_JAVA = 'java'
 const P_LANGUAGE_NODEJS = 'nodejs'
 const DEFAULT_P_LANGUAGE = P_LANGUAGE_NODEJS
 const DEBUG = /\b(y|all|cli)\b/.test(process.env.DEBUG) && console.debug
-const LOG = console
 
 module.exports = new class ProjectReader {
 
@@ -34,18 +33,9 @@ module.exports = new class ProjectReader {
         const env = this.getEnv()
         DEBUG && DEBUG({ env })
 
-        const cap = await this._getCapDescriptor(env, options)
-        const ui = this._getUiDescriptor(env)
-        const projectDescriptor = { cap, ui }
-
-        DEBUG && DEBUG({ projectDescriptor })
-        return projectDescriptor
-    }
-
-    async _getCapDescriptor(env, options) {
         const _hasFacet = template => require(`../template/${template}`).hasFacet(env, options)
-        const cap = {
-            for: options?.for,
+        const project = {
+            profile: options?.for,
             language: DEFAULT_P_LANGUAGE,
             srv: {},
             db: [],
@@ -62,10 +52,11 @@ module.exports = new class ProjectReader {
             get hasXsuaa()       { return _hasFacet('xsuaa') },
             get hasAuditlog()    { return _hasFacet('auditlog') },
             get hasApprouter()   { return _hasFacet('approuter') },
-            get hasDestination() { return _hasFacet('destinations') },
+            get hasDestination() { return _hasFacet('destination') },
             get hasHtml5Repo()   { return _hasFacet('html5-repo') },
             get hasMta()         { return _hasFacet('mta') },
             get hasHelm()        { return _hasFacet('helm') },
+            get appPath()        { return env.folders.app },
         }
 
         // setting the effective env as it might have changed by already executed 'add' commands, e.g. cds init foo --add hana,mta
@@ -74,29 +65,30 @@ module.exports = new class ProjectReader {
         cds.env = env
 
         // check whether we have a hana service binding defined as a hana build task is returned by default for compatibility reasons if neither hana, nor sqlite has been defined
-        if (this._hasHanaServiceBinding(env)) {
+        if (env?.requires?.db?.kind === 'hana') {
             const dbFolder = env.folders.db.replace(/\/$/, '')
             const relDbDestPath = path.join(env.build.target, dbFolder).replace(/\\/g, '/')
-            cap.db.push({ path: relDbDestPath, name: dbFolder })
+            project.db.push({ path: relDbDestPath, name: dbFolder })
         }
 
         const srvFolder = env.folders.srv.replace(/\/$/, '')
         const relSrvDestPath = path.join(env.build.target, srvFolder).replace(/\\/g, '/')
-        cap.srvPath = relSrvDestPath
-        cap.srvName = srvFolder
+        project.srvPath = relSrvDestPath
+        project.srvName = srvFolder
 
         if (env['project-nature'] === 'java') {
-            cap.language = P_LANGUAGE_JAVA
-            cap.srvExt = await this._getJavaExtDescriptor(path.resolve(cds.root, srvFolder))
+            project.language = P_LANGUAGE_JAVA
+            project.srvExt = await this._getJavaExtDescriptor(path.resolve(cds.root, srvFolder))
         }
 
         // setting app name, app description...
-        await this._setAppDetails(cap)
+        await this._setAppDetails(project)
 
         // setting required resource information
-        this._setResourceDependencies(env, cap)
+        this._setResourceDependencies(env, project)
 
-        return cap
+        DEBUG && DEBUG({ project })
+        return project
     }
 
     /**
@@ -105,85 +97,60 @@ module.exports = new class ProjectReader {
      */
     async _getJavaExtDescriptor(srcPath) {
         // by default spring-boot:repackage is used creating an executable jar archive
-        const pomJson = await parseXml(path.join(srcPath, 'pom.xml'))
-        if (pomJson) {
-            const dependencies = pomJson?.project?.dependencies?.[0]?.dependency
+        const pom = await parseXml(path.join(srcPath, 'pom.xml'))
+        if (pom) {
+            const dependencies = pom?.dependencies?.[0]?.dependency
             const isOldJavaRuntime = [...dependencies].some(d => /com\.sap\.cloud\.servicesdk/.test(d?.groupId?.[0]))
             if (isOldJavaRuntime) {
                 throw new Error("Projects using the classic CAP Java SDK are not supported")
             }
 
             const descriptor = { archiveName: path.basename(cds.root) + "-exec.jar" }
-            const archiveName = pomJson?.project?.artifactId?.[0]
-            const suffix = pomJson?.project?.packaging?.[0]
+            const archiveName = pom?.artifactId?.[0]
+            const suffix = pom?.packaging?.[0]
             if (archiveName) descriptor.archiveName = archiveName + '-exec.' + suffix
             return descriptor
         }
     }
 
-    _getUiDescriptor(env) {
-        const absoluteAppPath = path.join(cds.root, env.folders.app)
-        return {
-            appPath: exists(absoluteAppPath) ? env.folders.app : null
-        }
-    }
-
     async _setAppDetails(cap) {
         if (cap.language !== P_LANGUAGE_JAVA && cap.language !== P_LANGUAGE_NODEJS) {
             throw Error(`${cap.language} not supported`)
         }
 
-        // 1.1. java - use parent pom.xml
-        if (cap.language === P_LANGUAGE_JAVA) {
-            const pomXmlPath = path.join(cds.root, 'pom.xml')
-            try {
-                if (exists(pomXmlPath)) {
-                    const pomJson = await parseXml(pomXmlPath)
-                    const [artifactId] = pomJson?.project?.artifactId ?? []
-                    const [description] = pomJson?.project?.description ?? []
-                    let [version] = pomJson?.project?.version ?? []
-                    // might need to resolve <version>${revision}</version> property
-                    if (version.match(/\${1}\{{1}([\w-\\.]+)\}{1}/)?.length === 2) {
-                        version = pomJson?.project?.properties?.[0].revision[0]
-                    }
-                    if (version) {
-                        // check compliance with mta version format - copied from mbt build error message
-                        // if not compliant we use a static default value, see below...
-                        if (/^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(-(0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(\.(0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*)?(\+[0-9a-zA-Z-]+(\.[0-9a-zA-Z-]+)*)?$/.test(version)) {
-                            cap.appVersion = version
-                        }
-                    }
-                    if (artifactId) {
-                        cap.appName = artifactId.split(/-parent/)[0]
-                    }
-                    if (description) {
-                        cap.appDescription = description
-                    }
+        // Use either pom.xml or package.json
+        if (exists('pom.xml')) {
+            const pom = await parseXml('pom.xml')
+            const [artifactId] = pom?.artifactId ?? []
+            const [description] = pom?.description ?? []
+            let [version] = pom?.version ?? []
+            // might need to resolve <version>${revision}</version> property
+            if (version === '${revision}') {
+                version = pom?.properties?.[0].revision[0]
+            }
+            if (version) {
+                // check compliance with mta version format - copied from mbt build error message
+                // if not compliant we use a static default value, see below...
+                if (/^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(-(0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(\.(0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*)?(\+[0-9a-zA-Z-]+(\.[0-9a-zA-Z-]+)*)?$/.test(version)) {
+                    cap.appVersion = version
                 }
-            } catch (e) {
-                LOG.error(`Failed to read file ${pomXmlPath} - skip pom.xml data`)
-                LOG.error(e)
+            }
+            if (artifactId) {
+                cap.appName = artifactId.split(/-parent/)[0]
+            }
+            if (description) {
+                cap.appDescription = description
             }
         }
-
-        // 1.2. use package.json
-        if (!cap.appName) {
-            const packageJsonPath = path.join(cds.root, 'package.json')
-            if (exists(packageJsonPath)) {
-                try {
-                    const { name, version, description } = await read(packageJsonPath)
-                    cap.appDescription = cap.appDescription ?? description
-                    cap.appVersion = cap.appVersion ?? version
-                    if (name) {
-                        const segments = name.trim().replace(/@/g, '').split('/').map(encodeURIComponent)
-                        cap.appName = cap.appName ?? segments[segments.length - 1]
-                        cap.appId = cap.appId ?? segments.join('.')
-                        cap.appDescription = cap.appDescription ?? cap.appName
-                    }
-                } catch (e) {
-                    LOG.error(`Failed to read file ${packageJsonPath} - skip application data`)
-                    LOG.error(e)
-                }
+        else if (exists('package.json')) {
+            const { name, version, description } = await read('package.json')
+            cap.appDescription = cap.appDescription ?? description
+            cap.appVersion = cap.appVersion ?? version
+            if (name) {
+                const segments = name.trim().replace(/@/g, '').split('/').map(encodeURIComponent)
+                cap.appName = cap.appName ?? segments[segments.length - 1]
+                cap.appId = cap.appId ?? segments.join('.')
+                cap.appDescription = cap.appDescription ?? cap.appName
             }
         }
 
@@ -194,11 +161,6 @@ module.exports = new class ProjectReader {
         cap.appVersion = cap.appVersion ?? '1.0.0'
     }
 
-    _hasHanaServiceBinding(env) {
-        const db = env?.requires?.db
-        return db?.kind === 'hana' || db?.kind === 'sql' && (db?.dialect === 'hana' || db?.use === 'hana')
-    }
-
     // REVISIT: Only used for orphaned cds add cf-manifest. Still needed?
     _setResourceDependencies(env, cap) {
         for (const [key, require] of Object.entries(env.requires)) {

package/lib/init/util/xml.js

@@ -1,6 +1,5 @@
 const cds = require('../../cds')
 const { read } = cds.utils
-const LOG = console
 
 /*
   Remove the _text attributes and convert value it into array
@@ -29,28 +28,20 @@ function _removeTextAttributes(value, parentElement) {
 
 async function parseXml(pomXmlPath) {
   const xmljs = require('xml-js')
-  const xmljsParse = {}
-  try {
-      const xml = await read(pomXmlPath, 'utf-8')
-      xmljsParse.project = JSON.parse(xmljs.xml2json(xml, {
-          ignoreComment: true,
-          compact: true,
-          alwaysArray: true,
-          ignoreDeclaration: true,
-          attributesKey: "$",
-          trim: true,
-          nativeType: true,
-          ignoreInstruction: true,
-          ignoreCdata: true,
-          ignoreDoctype: true,
-          textFn: _removeTextAttributes
-      })).project[0]
-      return xmljsParse
-  } catch (e) {
-    // REVISIT: We shouldn't continue with errors
-    LOG.error(`Failed to read file ${pomXmlPath} - skip pom.xml data`)
-    LOG.error(e)
-  }
+  const xml = await read(pomXmlPath, 'utf-8')
+  return JSON.parse(xmljs.xml2json(xml, {
+      ignoreComment: true,
+      compact: true,
+      alwaysArray: true,
+      ignoreDeclaration: true,
+      attributesKey: "$",
+      trim: true,
+      nativeType: true,
+      ignoreInstruction: true,
+      ignoreCdata: true,
+      ignoreDoctype: true,
+      textFn: _removeTextAttributes
+  }))?.project?.[0]
 }
 
 module.exports = { parseXml }