@sap/cds-dk 8.0.2 → 8.1.0

package/lib/deploy/to-hana/hdiDeployUtil.js

@@ -59,7 +59,15 @@ module.exports = new class HdiDeployUtil {
     Add it either to ${bold('devDependencies')} using 'npm install -D ${HDI_DEPLOY_LIB}' or install it globally using 'npm install -g ${HDI_DEPLOY_LIB}'.`);
         }
 
-        console.log(`Using HDI deployer from ${libPath}`)
+        console.log(`HDI deployer path: ${libPath}`)
+
+        const libRoot = path.dirname(libPath);
+        try {
+            const libPackageJson = require(path.join(libRoot, 'package.json'));
+            console.log(`HDI deployer version: ${libPackageJson.version}`);
+        } catch {
+            // ignore
+        }
 
         // let any error go through and abort deploy
         return require(libPath);

package/lib/init/constants.js

@@ -5,9 +5,10 @@ module.exports = {
     COMMAND_ADD: 'add',
 
     JAVA_LTS_VERSIONS: [17, 21],
-    MAVEN_ARCHETYPE_VERSION: '2.10.1',
+    MAVEN_ARCHETYPE_VERSION: '3.0.1',
 
     OPTIONS: Object.freeze({
+        COMPLETION: 'completion',
         JAVA: 'java',
         JAVA_MVN: 'java:mvn',
         JAVA_PACKAGE: 'java:package',
@@ -30,6 +31,9 @@ module.exports = {
         SQLITE: 'sqlite',
         H2: 'h2',
         LIQUIBASE: 'liquibase',
+        REDIS: 'redis',
+        ATTACHMENTS: 'attachments',
+        MALWARE_SCANNER: 'malware-scanner',
         LOCAL_MESSAGING: 'local-messaging',
         FILE_BASED_MESSAGING: 'file-based-messaging',
         ENTERPRISE_MESSAGING: 'enterprise-messaging',
@@ -53,7 +57,10 @@ module.exports = {
         LINT_DEV: 'lint:dev',
         PIPELINE: 'pipeline',
         TYPER: 'typer',
-        TYPESCRIPT: 'typescript'
+        TYPESCRIPT: 'typescript',
+        EVENT_QUEUE: 'event-queue',
+        COV2AP: 'cov2ap',
+        WEBSOCKET: 'websocket'
     }),
 
     REGEX_JAVA_PACKAGE: /^[a-z_][a-z0-9_]*(\.[a-z_][a-z0-9_]*)*$/g,
@@ -65,7 +72,10 @@ module.exports = {
         SAMPLES: 'https://github.com/SAP-samples/cloud-cap-samples',
         CAPIRE: 'https://cap.cloud.sap',
         MAVEN_ARCHETYPE_HELP: `https://cap.cloud.sap/docs/java/developing-applications/building#the-maven-archetype`,
-        MAVEN_INSTALL_HELP: `https://maven.apache.org/install.html`
+        MAVEN_INSTALL_HELP: `https://maven.apache.org/install.html`,
+        CAP_JS_COMMUNITY_ODATA_V2: 'https://github.com/cap-js-community/odata-v2-adapter',
+        CAP_JS_COMMUNITY_EVENT_QUEUE: 'https://github.com/cap-js-community/event-queue',
+        CAP_JS_COMMUNITY_WEBSOCKET: 'https://github.com/cap-js-community/websocket'
     }),
 
     PROJECT_FILES: ['package.json', 'pom.xml', '.cdsrc.json']

package/lib/init/index.js

@@ -22,14 +22,16 @@ module.exports = class CDSGenerator {
     }
 
     static help({ exclude = [] } = {}) {
+        if (!cds.add) return // use case shell completion: cds.add is undefined and not needed
+
         const plugins = this.readPlugins(exclude)
         const nameFixedLength = Math.max(...plugins.map(plugin => plugin.name.length))
         return plugins
+            .filter(({module}) => module.help())
             .map(({name, module}) => {
-                const help = module.help?.() ?? ''
-                return `      *${name}*${' '.repeat(nameFixedLength - name.length)}  - ${help}`
+                return `      *${name}*${' '.repeat(nameFixedLength - name.length)}  - ${module.help()}`
             })
-            .join('\n\n')
+            .join('\n')
     }
 
     /**
@@ -176,7 +178,7 @@ module.exports = class CDSGenerator {
                 const fuzzySearch = require('../../bin/util/fuzzySearch')
                 const [bestMatch] = fuzzySearch(plugin, entries.map(e => e.name))
                 const max = entries.reduce((max, {name}) => Math.max(max, name.length), 0)
-                const allFacetsText = entries.map(({name, module}) => {
+                const allFacetsText = entries.filter(({module})=> module.help()).map(({name, module}) => {
                     const help = module.help?.() ?? ''
                     return `${term.bold(name) + ' '.repeat(max - name.length)}  ${term.dim(help)}`
                 }).join('\n')

package/lib/init/projectReader.js

@@ -4,6 +4,7 @@ const { fs, exists, isdir, path } = cds.utils
 const { parseXml } = require('./xml')
 const { REGEX_JAVA_VERSION, JAVA_LTS_VERSIONS } = require('./constants')
 const DEBUG = cds.debug('cli')
+const TRACE = cds.debug('trace')
 
 module.exports = new class ProjectReader {
 
@@ -41,7 +42,6 @@ module.exports = new class ProjectReader {
         }
     }
 
-    // REVISIT: There should an API provided by cds.env
     /**
      * Returns cds.env using 'production' profile by default as mta deployment is executed with having production profile set.
      */
@@ -89,7 +89,7 @@ module.exports = new class ProjectReader {
      * @property {boolean} hasAttachments Indicates if the project uses SAP BTP Object Store Service.
      * @property {boolean} hasApprouter Indicates if the project uses the SAP Application Router.
      * @property {boolean} hasHtml5Repo Indicates if the project uses the SAP BTP HTML5 Application Repository.
-     * @property {boolean} hasPortal Indicates if the project uses the SAP Cloud Portal serivce.
+     * @property {boolean} hasPortal Indicates if the project uses the SAP Cloud Portal service.
      * @property {boolean} hasDestination Indicates if the project uses the SAP BTP Destination service.
      * @property {boolean} hasMTXRoute Indicates if the approuter should have a multitenant route.
      * @property {boolean} hasMTXRouteJava Indicates if the approuter should have a multitenant subscription route (java).
@@ -107,7 +107,7 @@ module.exports = new class ProjectReader {
         if (!this.appName) this.#setPackageInfo()
         const env = this.env4('production')
         const { appVersion, appName, appId, appDescription, jdkVersion } = this
-        DEBUG?.({ env })
+        TRACE?.({ env })
 
         const _inProd = plugin => require(`./template/${plugin}`).hasInProduction(env)
         const _ui5 = () => exists('package.json') && !!JSON.parse(fs.readFileSync(path.resolve(cds.root, 'package.json'))).sapux
@@ -188,7 +188,6 @@ module.exports = new class ProjectReader {
             })
         })()
 
-        DEBUG?.({ project })
         return project
     }
 }

package/lib/init/template/audit-logging/files/package.sidecar.json

@@ -0,0 +1,7 @@
+{
+  "cds": {
+    "requires": {
+      "audit-log": true
+    }
+  }
+}

package/lib/init/template/audit-logging/index.js

@@ -36,7 +36,7 @@ module.exports = class AuditLoggingTemplate extends require('../../plugin') {
     const { hasMta, hasHelm, hasMultitenancy, srvPath } = project
     const { plan = 'premium' } = cds.cli.options
     project.servicePlan = plan
-    
+
     if (hasMultitenancy) {
       await merge(__dirname, 'files/package.sidecar.json').into('mtx/sidecar/package.json')
     }

package/lib/init/template/cf-manifest/index.js

@@ -12,6 +12,10 @@ module.exports = class CfManifestTemplate extends require('../../plugin') {
         return 'Cloud Foundry deployment using manifest files'
     }
 
+    static hasInProduction() {
+        return exists(MANIFEST_FILE)
+    }
+
     async canRun() {
         if (cds.cli.options.force) {
             return true

package/lib/init/template/cov2ap/files/dependencies.package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "@cap-js-community/odata-v2-adapter": "^1"
+  }
+}

package/lib/init/template/cov2ap/index.js

@@ -0,0 +1,31 @@
+const { readProject } = require('../../projectReader')
+const { merge, sort } = require('../../merge')
+const { link } = require('../../../util/term')
+const { CAP_JS_COMMUNITY_ODATA_V2 } = require('../../constants').URLS
+
+module.exports = class Cov2apTemplate extends require('../../plugin') {
+
+  static help() {
+    return 'cap-js-community: expose CDS services via the OData V2 protocol'
+  }
+
+  static hasInProduction() {
+    const { dependencies } = readProject()
+    return !!dependencies?.['@cap-js-community/odata-v2-adapter']
+  }
+
+  async canRun() {
+    const { isJava } = readProject()
+    if (isJava) throw `'cds add cov2ap' is not available for Java`
+    return true
+  }
+
+  async run() {
+    await merge(__dirname, 'files/dependencies.package.json').into('package.json')
+    await sort('package.json', 'dependencies')
+  }
+
+  async finalize() {
+    console.log(`Find plugin documentation on ${link(CAP_JS_COMMUNITY_ODATA_V2)}`)
+  }
+}

package/lib/init/template/data/as-json.js

@@ -3,7 +3,7 @@ const { dirname } = require('node:path')
 const cds = require('../../../cds')
 
 let counter = Math.round(Math.random() * 10000) // Default random seed // Non-deterministic behaviour
-const MAX_ASSOC_DEPTH = 1
+const MAX_ASSOC_DEPTH = 5
 
 /**
  * Creates JSON test data for the given entities
@@ -40,25 +40,35 @@ const asJson = module.exports = async (data, csn, numRecords=1, options={}) => {
 
   for (const name of entityNames) {
     if (!data[name] // removed on purpose because records are created inline through compositions
-      || data[name].length >= numRecords) { // already created by following associations
+      || data[name].length >= numRecords) { // numRecords already created by following associations
       continue
     }
 
-    const records = data[name] = Array(numRecords).fill({}).map(() => ({}))
+    let numRecordsToGenerate // numRecords might be reduced if some records were created by following associations
+    let records = []
+    if (data[name].length > 0) {
+      numRecordsToGenerate = numRecords - data[name].length 
+      records = Array(numRecordsToGenerate).fill({}).map(() => ({}))
+    } else {
+      numRecordsToGenerate = numRecords
+      records = data[name] = Array(numRecordsToGenerate).fill({}).map(() => ({}))
+    }
     const entity = defs[name]
 
     const idNum = randomNumber()
-    for (let i = 0; i < numRecords; i++) {
+    for (let i = 0; i < numRecordsToGenerate; i++) {
       fillRecord(records[i], idNum+i, entity, csn, data, null, 0, referenceData)
     }
-    // Remove records w/ duplicate keys. This can happen if the key is an enum (and we have less enum values than requested records).
-    data[name] = uniqRecords(records, entity)
+    data[name] = data[name].concat(records) // append the new records to the possibly existingand referenced records
+    // remove records w/ duplicate keys. This can happen if the key is an enum (and we have less enum values than requested records).
+    data[name] = uniqRecords(data[name], entity)
   }
   return data
 }
 
 function fillRecord(record, recordID, entity, csn, data, parentEntity, depth, referenceData) {
   Object.defineProperty(record, '$id', {value: recordID, enumerable: false})
+  if (data[entity.name]) data[entity.name].push(record) // add id to data, to be referenced by associations to prevent circular dependencies
 
   const { elements } = entity
   Object.values(elements).sort(asJson.elementsSorter(csn)).forEach(el => {
@@ -242,7 +252,7 @@ function dataForField(element, entity, csn, record, data, parentEntity, depth, r
       if (element.is2many)
         return
       const target = csn.definitions[element.target]
-      if (!target || target === parentEntity || depth > MAX_ASSOC_DEPTH)
+      if (!target || depth > MAX_ASSOC_DEPTH)
         return
 
       let targetRecord = randomFromReferenceData(target, csn, referenceData)
@@ -256,10 +266,14 @@ function dataForField(element, entity, csn, record, data, parentEntity, depth, r
           targetRecords = data[target.name] = []
         else if (!targetRecords) // target entity is not in the list of entities to be created
           return
-
-        targetRecord = fillRecord({}, randomNumber(), target, csn, data, entity, depth, referenceData)
-        targetRecords.push(targetRecord)
-        uniqRecords(targetRecords, target)
+        
+        if (targetRecords.length > 0) { // use record generated by following asociation
+          targetRecord = targetRecords[0]
+        } else {
+          targetRecord = fillRecord({}, randomNumber(), target, csn, data, entity, depth+1, referenceData)
+          targetRecords.push(targetRecord)
+          uniqRecords(targetRecords, target)
+        }
       }
 
       // TODO: handle foreign keys correctly

package/lib/init/template/destination/files/mta.yaml.hbs

@@ -11,6 +11,12 @@ modules:
     requires:
       - name: {{appName}}-destination
 
+  - name: {{appName}}-mtx
+    type: nodejs
+    path: {{#isNodejs}}gen/{{/isNodejs}}mtx/sidecar
+    requires:
+      - name: {{appName}}-destination
+
 resources:
   - name: {{appName}}-destination
     type: org.cloudfoundry.managed-service

package/lib/init/template/destination/files/package.sidecar.json

@@ -0,0 +1,7 @@
+{
+  "cds": {
+    "requires": {
+      "destinations": true
+    }
+  }
+}

package/lib/init/template/destination/index.js

@@ -1,6 +1,6 @@
 const { readProject } = require('../../projectReader')
 const { merge } = require('../../merge')
-const { srv4, approuter, destination } = require('../../registries/mta')
+const { srv4, approuter, destination, mtxSidecar4 } = require('../../registries/mta')
 
 module.exports = class DestinationTemplate extends require('../../plugin') {
 
@@ -24,7 +24,11 @@ module.exports = class DestinationTemplate extends require('../../plugin') {
 
     async combine() {
         const project = readProject()
-        const { hasHelm, hasApprouter, hasHelmUnifiedRuntime, hasMta, srvPath } = project
+        const { hasHelm, hasApprouter, hasMultitenancy, hasHelmUnifiedRuntime, hasMta, srvPath, isJava } = project
+
+        if (hasMultitenancy) {
+            await merge(__dirname, 'files/package.sidecar.json').into('mtx/sidecar/package.json')
+        }
 
         if (hasMta) {
             const srv = srv4(srvPath)
@@ -39,6 +43,12 @@ module.exports = class DestinationTemplate extends require('../../plugin') {
                     into: [approuter, 'requires', 'name']
                 })
             }
+            if (hasMultitenancy) {
+                relationships.push({
+                    insert: [destination, 'name'],
+                    into: [mtxSidecar4(isJava ? 'mtx/sidecar' : 'gen/mtx/sidecar'), 'requires', 'name']
+                })
+            }
             await merge(__dirname, 'files/mta.yaml.hbs').into('mta.yaml', { with: project, additions, relationships })
         }
 

package/lib/init/template/event-queue/files/dependencies.package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "@cap-js-community/event-queue": "^1"
+  }
+}

package/lib/init/template/event-queue/index.js

@@ -0,0 +1,35 @@
+const { readProject } = require('../../projectReader')
+const { merge, sort } = require('../../merge')
+const { link } = require('../../../util/term')
+const { CAP_JS_COMMUNITY_EVENT_QUEUE } = require('../../constants').URLS
+
+module.exports = class EventQueueTemplate extends require('../../plugin') {
+
+  static help() {
+    return 'cap-js-community: transactional event processing with automatic load distribution'
+  }
+
+  async canRun() {
+    const { isJava } = readProject()
+    if (isJava) throw `'cds add event-queue' is not available for Java`
+    return true
+  }
+
+  static hasInProduction() {
+    const { dependencies } = readProject()
+    return !!dependencies?.['@cap-js-community/event-queue']
+  }
+
+  requires() {
+    return ['redis']
+  }
+
+  async run() {
+    await merge(__dirname, 'files/dependencies.package.json').into('package.json')
+    await sort('package.json', 'dependencies')
+  }
+
+  async finalize() {
+    console.log(`Find plugin documentation on ${link(CAP_JS_COMMUNITY_EVENT_QUEUE)}`)
+  }
+}

package/lib/init/template/html5-repo/files/mta.yaml.hbs

@@ -12,6 +12,12 @@ modules:
     requires:
       - name: {{appName}}-html5-runtime
 
+  - name: {{appName}}-mtx
+    type: nodejs
+    path: {{#isNodejs}}gen/{{/isNodejs}}mtx/sidecar
+    requires:
+      - name: {{appName}}-html5-runtime
+
   - name: {{appName}}-app-deployer
     type: com.sap.application.content
     path: {{#isNodejs}}gen{{/isNodejs}}{{#isJava}}.{{/isJava}}
@@ -42,38 +48,6 @@ modules:
       supported-platforms: []
   {{/apps}}
 
-  - name: {{appName}}-destinations
-    type: com.sap.application.content
-    requires:
-      - name: {{appName}}-auth
-        parameters:
-          service-key:
-            name: {{appName}}-auth-key
-      - name: {{appName}}-html5-repo-host
-        parameters:
-          service-key:
-            name: {{appName}}-html5-repo-host-key
-      - name: srv-api
-      - name: {{appName}}-destination
-        parameters:
-          content-target: true
-    build-parameters:
-      no-source: true
-    parameters:
-      content:
-        instance:
-          existing_destinations_policy: update
-          destinations:
-            - Name: {{appName}}-html5-repository
-              ServiceInstanceName: {{appName}}-html5-repo-host
-              ServiceKeyName: {{appName}}-html5-repo-host-key
-              sap.cloud.service: {{appName}}.service
-            - Name: {{appName}}-auth
-              Authentication: OAuth2UserTokenExchange
-              ServiceInstanceName: {{appName}}-auth
-              ServiceKeyName: {{appName}}-auth-key
-              sap.cloud.service: {{appName}}.service
-
 resources:
   {{#hasApprouter}}
   - name: {{appName}}-html5-runtime
@@ -88,29 +62,3 @@ resources:
     parameters:
       service: html5-apps-repo
       service-plan: app-host
-
-  - name: {{appName}}-destination
-    type: org.cloudfoundry.managed-service
-    parameters:
-      service: destination
-      service-plan: lite
-      config:
-        HTML5Runtime_enabled: true
-        init_data:
-          instance:
-            existing_destinations_policy: update
-            destinations:
-              - Name: {{appName}}-srv-api
-                URL: ~{srv-api/srv-url}
-                Authentication: NoAuthentication
-                Type: HTTP
-                ProxyType: Internet
-                HTML5.ForwardAuthToken: true
-                HTML5.DynamicDestination: true
-    requires:
-      - name: srv-api
-        group: destinations
-        properties:
-          name: srv-api # must be used in xs-app.json as well
-          url: ~{srv-url}
-          forwardAuthToken: true

package/lib/init/template/html5-repo/files/package.sidecar.json

@@ -0,0 +1,7 @@
+{
+  "cds": {
+    "requires": {
+      "html5-repo": true
+    }
+  }
+}

package/lib/init/template/html5-repo/files/xs-app.json.hbs

@@ -4,24 +4,10 @@
     {
       "source": "^/?odata/(.*)$",
       "target": "/odata/$1",
-      "destination": "{{appName}}-srv-api",
+      "destination": "srv-api",
       {{#hasXsuaa}}"authenticationType": "xsuaa",{{/hasXsuaa}}
       "csrfProtection": true
     },
-    {{#hasUI5}}
-    {
-      "source": "^/resources/(.*)$",
-      "target": "/resources/$1",
-      "authenticationType": "none",
-      "destination": "ui5"
-    },
-    {
-      "source": "^/test-resources/(.*)$",
-      "target": "/test-resources/$1",
-      "authenticationType": "none",
-      "destination": "ui5"
-    },
-    {{/hasUI5}}
     {
       "source": "^(.*)$",
       "target": "$1",

package/lib/init/template/html5-repo/index.js

@@ -1,7 +1,7 @@
 const { join } = require('path')
 const { readProject } = require('../../projectReader')
 const { merge } = require('../../merge')
-const { srv4, destination, destinations, html5RepoHost, html5Runtime, appDeployer, approuter } = require('../../registries/mta')
+const { srv4, html5RepoHost, html5Runtime, appDeployer, approuter, mtxSidecar4 } = require('../../registries/mta')
 
 module.exports = class Html5RepoTemplate extends require('../../plugin') {
 
@@ -9,10 +9,6 @@ module.exports = class Html5RepoTemplate extends require('../../plugin') {
         return 'SAP BTP HTML5 Application Repository'
     }
 
-    requires() {
-        return ['destination']
-    }
-
     static hasInProduction(env) {
         return !!env.requires['html5-repo']
     }
@@ -47,13 +43,17 @@ module.exports = class Html5RepoTemplate extends require('../../plugin') {
 
     async combine() {
         const project = readProject()
-        const { srvPath, appPath, hasMta, hasHelm, hasHelmUnifiedRuntime, hasApprouter, apps } = project
+        const { isJava, srvPath, appPath, hasMta, hasMultitenancy, hasHelm, hasHelmUnifiedRuntime, hasApprouter, apps } = project
 
         await Promise.all(apps.map(async ({app}) => {
             project.app = app
             await merge(__dirname, 'files/xs-app.json.hbs').into(join(appPath, app, 'xs-app.json'), { project })
         }))
 
+        if (hasMultitenancy) {
+            await merge(__dirname, 'files/package.sidecar.json').into('mtx/sidecar/package.json')
+          }
+
         if (hasMta) {
             const srv = srv4(srvPath)
             project.apps = apps
@@ -61,11 +61,8 @@ module.exports = class Html5RepoTemplate extends require('../../plugin') {
                 in: 'modules',
                 where: { type: 'html5', path: `${appPath}${app.app}` }
             }))
-            const additions = [srv, appDeployer, destinations, destination, html5RepoHost, ...appModules]
+            const additions = [srv, appDeployer, html5RepoHost, ...appModules]
             const relationships = [{
-                insert: [destination, 'name'],
-                into: [appDeployer, 'requires', 'name'],
-            }, {
                 insert: [html5RepoHost, 'name'],
                 into: [appDeployer, 'requires', 'name'],
             }]
@@ -76,6 +73,12 @@ module.exports = class Html5RepoTemplate extends require('../../plugin') {
                     into: [approuter, 'requires', 'name'],
                 })
             }
+            if (hasMultitenancy) {
+                relationships.push({
+                    insert: [html5Runtime, 'name'],
+                    into: [mtxSidecar4(isJava ? 'mtx/sidecar' : 'gen/mtx/sidecar'), 'requires', 'name']
+                })
+            }
             await merge(__dirname, 'files/mta.yaml.hbs').into('mta.yaml', { with: project,
                 additions,
                 relationships