@sap/cds-dk 7.4.0 → 7.5.0

package/lib/init/template/{kibana → application-logging}/files/mta.yaml.hbs

@@ -6,13 +6,13 @@ modules:
     requires:
       - name: {{appName}}-logging
 
-{{#isMultitenant}}
+{{#hasMultitenancy}}
   - name: {{appName}}-mtx
     type: nodejs
     path: {{#isNodejs}}gen/{{/isNodejs}}mtx/sidecar
     requires:
       - name: {{appName}}-logging
-{{/isMultitenant}}
+{{/hasMultitenancy}}
 
 {{#hasApprouter}}
   - name: {{appName}}
@@ -26,4 +26,4 @@ resources:
     type: org.cloudfoundry.managed-service
     parameters:
       service: application-logs
-      service-plan: lite
+      service-plan: standard

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

@@ -0,0 +1,49 @@
+const { readProject } = require('../../projectReader')
+const { merge } = require('../../merge')
+const { srv4, mtxSidecar4, applicationLogging, approuter } = require('../../registries/mta')
+
+module.exports = class ApplicationLoggingTemplate extends require('../../plugin') {
+
+    static hasInProduction(env) {
+        return !!env.features.kibana_formatter
+    }
+
+    async canRun() {
+        const { hasMta, hasHelm, hasHelmUnifiedRuntime, isJava } = readProject()
+        if ((hasHelmUnifiedRuntime || hasHelm) && !hasMta) throw `'cds add application-logging' is not available for Kyma yet`
+        if (isJava) throw `'cds add application-logging' is not available for Java yet`
+        return true
+    }
+
+    async combine() {
+        const project = readProject()
+        const { hasMta, hasApprouter, isJava, hasMultitenancy, srvPath } = project
+
+        if (hasMta) {
+            const srv = srv4(srvPath)
+            const additions = [srv, applicationLogging]
+            const relationships = [{
+                insert: [applicationLogging, 'name'],
+                into: [srv, 'requires', 'name']
+            }]
+            if (hasMultitenancy) {
+                const mtxSidecar = mtxSidecar4(isJava ? 'mtx/sidecar' : 'gen/mtx/sidecar')
+                additions.push(mtxSidecar)
+                relationships.push({
+                    insert: [applicationLogging, 'name'],
+                    into: [mtxSidecar, 'requires', 'name']
+                })
+            }
+            if (hasApprouter) {
+                additions.push(approuter)
+                relationships.push({
+                    insert: [applicationLogging, 'name'],
+                    into: [approuter, 'requires', 'name']
+                })
+            }
+            await merge(__dirname, 'files/mta.yaml.hbs').into('mta.yaml', {
+                with: project, additions, relationships
+            })
+        }
+    }
+}

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

@@ -4,10 +4,10 @@ modules:
     type: {{language}}
     path: {{& srvPath}}
     {{#isJava}}
-    {{#isMultitenant}}
+    {{#hasMultitenancy}}
     properties:
       CDS_MULTITENANCY_APPUI_TENANTSEPARATOR: "-"
-    {{/isMultitenant}}
+    {{/hasMultitenancy}}
     {{/isJava}}
     requires:
       - name: {{appName}}-auth
@@ -24,10 +24,10 @@ modules:
       keep-existing-routes: true
       disk-quota: 256M
       memory: 256M
-    {{#isMultitenant}}
+    {{#hasMultitenancy}}
     properties:
       TENANT_HOST_PATTERN: "^(.*)-${default-uri}"
-    {{/isMultitenant}}
+    {{/hasMultitenancy}}
     requires:
       - name: srv-api
         group: destinations
@@ -35,14 +35,14 @@ modules:
           name: srv-api # must be used in xs-app.json as well
           url: ~{srv-url}
           forwardAuthToken: true
-      {{#isMultitenant}}
+      {{#hasMultitenancy}}
       - name: mtx-api
         group: destinations
         properties:
           name: mtx-api # must be used in xs-app.json as well
           url: ~{mtx-url}
-      {{/isMultitenant}}
-    {{#isMultitenant}}
+      {{/hasMultitenancy}}
+    {{#hasMultitenancy}}
     {{#isNodejs}}
     provides:
       - name: app-api
@@ -50,7 +50,7 @@ modules:
           app-protocol: ${protocol}
           app-uri: ${default-uri}
     {{/isNodejs}}
-    {{/isMultitenant}}
+    {{/hasMultitenancy}}
     {{#isJava}}
     provides:
       - name: app-api
@@ -58,7 +58,7 @@ modules:
           url: ${default-url}
     {{/isJava}}
 
-  {{#isMultitenant}}
+  {{#hasMultitenancy}}
   - name: {{appName}}-mtx
     type: nodejs
     path: {{#isNodejs}}gen/{{/isNodejs}}mtx/sidecar
@@ -66,7 +66,7 @@ modules:
       - name: app-api
         properties:
           SUBSCRIPTION_URL: ~{app-protocol}://\${tenant_subdomain}-~{app-uri}
-  {{/isMultitenant}}
+  {{/hasMultitenancy}}
 
 resources:
   - name: {{appName}}-auth
@@ -77,4 +77,4 @@ resources:
       path: ./xs-security.json
       config:
         xsappname: {{appName}}-${org}-${space}
-        tenant-mode: {{#isMultitenant}}shared{{/isMultitenant}}{{^isMultitenant}}dedicated{{/isMultitenant}}
+        tenant-mode: {{#hasMultitenancy}}shared{{/hasMultitenancy}}{{^hasMultitenancy}}dedicated{{/hasMultitenancy}}

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

@@ -1,13 +1,13 @@
 {
   "welcomeFile": "app/index.html",
   "routes": [
-    {{#isExtensible}}
+    {{#hasExtensibility}}
     {
       "source": "^/-/cds/.*",
       "destination": "mtx-api",
       "authenticationType": "none"
     },
-    {{/isExtensible}}
+    {{/hasExtensibility}}
     {
       "source": "^/app/(.*)$",
       "target": "$1",

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

@@ -1,54 +1,49 @@
 const cds = require('../../../cds')
-const { exists } = cds.utils
+const { exists, copy } = cds.utils
 const { join } = require('path')
-const { readProject } = require('../../util/projectReader')
-const { mergeJSON, mergeYAML, sort } = require('../../util/merge')
-const { XSUAA, KIBANA, HTML5_REPO } = require('../../constants').OPTIONS
+const { readProject } = require('../../projectReader')
+const { sort, merge } = require('../../merge')
 const {
-    srvNode4, srvJava4, mtxSidecar4, approuter, // Modules
+    srv4, mtxSidecar4, approuter, // Modules
     xsuaa, // BTP Services
     requiredMtxApi, providedJavaApprouterApi4, providedJavaApprouterApi, // APIs
     requiredAppApi4, providedAppApi,
     approuterExtensibility // xs-app.json config
-} = require('../_merging/registry-mta')
-const { copyAndTrack, parseMd5File, writeMd5File } = require('../../util/md5')
+} = require('../../registries/mta')
 
-module.exports = class ApprouterTemplate extends require('../templateBase') {
+module.exports = class ApprouterTemplate extends require('../../plugin') {
 
-    static hasFacet(env) {
-        return exists(join(env.folders.app, 'xs-app.json'))
+    static hasInProduction(env) {
+        return exists(join(env.folders.app, 'xs-app.json')) || exists(join(env.folders.app, 'router', 'xs-app.json'))
     }
 
-    getDependencies() {
-        return [XSUAA]
-    }
-
-    getRelatedFacets() {
-        return [KIBANA, HTML5_REPO]
+    requires() {
+        return ['xsuaa']
     }
 
     async run() {
-        const { appPath = 'app' } = await readProject()
+        const { appPath } = readProject()
         const appPackageJSONPath = join(appPath, 'package.json')
-        await mergeJSON(appPackageJSONPath, join(__dirname, 'files', 'package.json'))
+        await merge(__dirname, 'files/package.json').into(appPackageJSONPath)
         await sort(appPackageJSONPath, 'dependencies')
-        await mergeJSON(join(appPath, 'default-env.json'), join(__dirname, 'files', 'default-env.json'))
+        await merge(__dirname, 'files/default-env.json').into(appPath + '/default-env.json')
     }
 
-    async runDependentMerging(context = {}) {
-        const project = await readProject()
-        const { isNodejs, isJava, isExtensible, isMultitenant, hasMta, hasHelm, srvPath, appPath } = project
+    async combine() {
+        const project = readProject(this.options)
+        const { isNodejs, isJava, hasExtensibility, hasMultitenancy, hasMta, hasHelm, hasHelmUnifiedRuntime, srvPath, appPath } = project
 
         if (hasMta) {
-            const srv = (isNodejs ? srvNode4 : srvJava4)(srvPath)
+            const srv = srv4(srvPath)
             const apis = isJava ? [providedJavaApprouterApi4(srv), providedJavaApprouterApi] : []
             const mtxSidecar = mtxSidecar4(isJava ? 'mtx/sidecar' : 'gen/mtx/sidecar')
-            if (isNodejs && isMultitenant) apis.push(requiredMtxApi, requiredAppApi4(mtxSidecar), providedAppApi)
-            if (isJava && isMultitenant) apis.push(requiredMtxApi)
+            if (isNodejs && hasMultitenancy) apis.push(requiredMtxApi, requiredAppApi4(mtxSidecar), providedAppApi)
+            if (isJava && hasMultitenancy) apis.push(requiredMtxApi)
             const modules = [srv, approuter]
-            if (isMultitenant) modules.push(mtxSidecar)
+            if (hasMultitenancy) modules.push(mtxSidecar)
             const additions = [...modules, xsuaa, ...apis]
-            await mergeYAML('mta.yaml', join(__dirname, 'files', 'mta.yaml.hbs'), project, {
+            await merge(__dirname, 'files', 'mta.yaml.hbs').into('mta.yaml', {
+                with: project,
                 additions,
                 relationships: [{
                     insert: [xsuaa, 'name'],
@@ -60,65 +55,25 @@ module.exports = class ApprouterTemplate extends require('../templateBase') {
             })
         }
 
-        if (hasHelm) {
-            let isIndependentCommand = false;
-            if (Object.keys(context).length == 0) {
-                isIndependentCommand = true;
-                context.oldTrackingData = context.newTrackingData = await parseMd5File(join('chart', '.cds-add-helm-files.md5'));
-            }
-
-            await mergeYAML(
-                join('chart', 'values.yaml'),
-                join(__dirname, 'files', 'values.yaml.hbs'),
-                project
-            )
-
-            // add dependency entry in chart.yaml
-            const HelmTemplate = require(`../helm`);
-            const helmTemplate = new HelmTemplate(context.oldTrackingData, context.newTrackingData);
-            await helmTemplate.addDependency('web-application', 'approuter');
+        if (hasHelm || hasHelmUnifiedRuntime) {
+            await merge(__dirname, 'files', 'values.yaml.hbs').into('chart/values.yaml', { with: project })
+            await merge({ approuter: { envFrom: [{
+                configMapRef: {
+                    name: "{{ .Release.Name }}-approuter-configmap"
+                }
+            }]}}).into('chart/values.yaml', { with: project })
 
-            await mergeYAML(
-                join('chart', 'values.yaml'),
-                {
-                  approuter: {
-                    envFrom: [
-                      {
-                        configMapRef: {
-                          name: "{{ .Release.Name }}-approuter-configmap"
-                        }
-                      }
-                    ]
-                  }
-                },
-                project
-            )
+            const fileName = hasMultitenancy ? 'approuter-mtxs-configmap.yaml' : 'approuter-configmap.yaml'
+            await copy(join(__dirname, 'files', fileName)).to('chart', 'templates', 'approuter-configmap.yaml')
 
-            const fileName = isMultitenant ? 'approuter-mtxs-configmap.yaml' : 'approuter-configmap.yaml';
-
-            await copyAndTrack(
-                join(__dirname, 'files', fileName),
-                join('chart', 'templates', 'approuter-configmap.yaml'),
-                context,
-                { force: true }
-            )
-
-            if(isMultitenant) {
-                const mtxsConfigMapFileName = isNodejs ? 'mtxs-configmap-nodejs.yaml' : 'mtxs-configmap-java.yaml';
-                await copyAndTrack(
-                    join(__dirname, 'files', mtxsConfigMapFileName),
-                    join('chart', 'templates', 'mtxs-configmap.yaml'),
-                    context,
-                    { force: true }
-                )
+            if (hasMultitenancy) {
+                const mtxsConfigMapFileName = isNodejs ? 'mtxs-configmap-nodejs.yaml' : 'mtxs-configmap-java.yaml'
+                await copy(join(__dirname, 'files', mtxsConfigMapFileName)).to('chart', 'templates', 'mtxs-configmap.yaml')
             }
-
-            if (isIndependentCommand) await writeMd5File(join('chart', '.cds-add-helm-files.md5'), context.newTrackingData);
-
         }
 
         const xsAppPath = join(appPath, 'xs-app.json')
-        const additions = isExtensible ? [{ ...approuterExtensibility, at: 0 }] : []
-        await mergeJSON(xsAppPath, join(__dirname, 'files', 'xs-app.json.hbs'), project, { additions })
+        const additions = hasExtensibility ? [{ ...approuterExtensibility, at: 0 }] : []
+        await merge(__dirname, 'files/xs-app.json.hbs').into(xsAppPath, { project, additions })
     }
 }

package/lib/init/template/cf-manifest/files/manifest.yml.hbs

@@ -1,7 +1,7 @@
 # Generated manifest.yml based on template version 0.1.0
 # appName = {{appName}}
 # language={{language}}
-# multitenancy={{isMultitenant}}
+# multitenancy={{hasMultitenancy}}
 ---
 applications:
 # -----------------------------------------------------------------------------------
@@ -31,7 +31,7 @@ applications:
 {{/hasXsuaa}}
 
 {{#hasHana}}
-{{^isMultitenant}}
+{{^hasMultitenancy}}
 # -----------------------------------------------------------------------------------
 # HANA Database Content Deployer App
 # -----------------------------------------------------------------------------------
@@ -44,5 +44,5 @@ applications:
   buildpack: nodejs_buildpack
   services:
   - {{appName}}-db
-{{/isMultitenant}}
+{{/hasMultitenancy}}
 {{/hasHana}}

package/lib/init/template/cf-manifest/files/services-manifest.yml.hbs

@@ -3,16 +3,16 @@
 ---
 create-services:
 {{#hasHana}}
-{{#isMultitenant}}
+{{#hasMultitenancy}}
   - name: {{appName}}-db
     broker: service-manager
     plan: container
-{{/isMultitenant}}
-{{^isMultitenant}}
+{{/hasMultitenancy}}
+{{^hasMultitenancy}}
   - name: {{appName}}-db
     broker: hana
     plan: hdi-shared
-{{/isMultitenant}}
+{{/hasMultitenancy}}
 {{/hasHana}}
 {{#hasXsuaa}}
   - name: {{appName}}-auth

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

@@ -1,12 +1,12 @@
 const { join } = require('path')
 const cds = require('../../../cds')
 const { exists } = require('../../../cds').utils
-const { readProject } = require('../../util/projectReader')
-const { renderAndCopy } = require('../../util/template')
+const { readProject } = require('../../projectReader')
+const { renderAndCopy } = require('../../template')
 const MANIFEST_FILE = 'manifest.yml'
 const SERVICES_MANIFEST_FILE = 'services-manifest.yml'
 
-module.exports = class CfManifestTemplate extends require('../templateBase') {
+module.exports = class CfManifestTemplate extends require('../../plugin') {
 
     async canRun() {
         if (cds.cli.options.force) {
@@ -19,7 +19,7 @@ module.exports = class CfManifestTemplate extends require('../templateBase') {
     }
 
     async run() {
-        const project = await readProject()
+        const project = readProject()
         await renderAndCopy(join(__dirname, 'files'), cds.root, project)
     }
 }

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

@@ -1,59 +1,46 @@
+const cds = require('../../../cds')
+const { copy } = cds.utils
 const { join } = require('path')
-const { readProject } = require('../../util/projectReader')
-const { mergeYAML } = require('../../util/merge')
-const { copyAndTrack, parseMd5File, writeMd5File } = require('../../util/md5')
-const { srvJava4, srvNode4, connectivity } = require('../_merging/registry-mta')
+const { readProject } = require('../../projectReader')
+const { merge } = require('../../merge')
+const { srv4, connectivity } = require('../../registries/mta')
 
-module.exports = class ConnectivityTemplate extends require('../templateBase') {
+module.exports = class ConnectivityTemplate extends require('../../plugin') {
 
-    static hasFacet(env) {
-        return env.requires.connectivity
+    static hasInProduction(env) {
+        return !!env.requires.connectivity
     }
 
     async run() {
         // Disable setting cds.requires.connectivity for now.
-        // const project = await readProject()
+        // const project = readProject()
         // const { configFile } = project
-        // await mergeJSON(configFile, join(__dirname, 'files', 'package.json.hbs'), project)
+        // await merge(__dirname, 'files', 'package.json.hbs').into(configFile, { with: project })
     }
 
-    async runDependentMerging(context = {}) {
-        const project = await readProject()
-        const { isJava, srvPath, hasHelm, hasMta } = project
+    async combine() {
+        const project = readProject()
+        const { srvPath, hasHelm, hasHelmUnifiedRuntime, hasMta } = project
 
         if (hasMta) {
-            const srv = (isJava ? srvJava4 : srvNode4)(srvPath)
+            const srv = srv4(srvPath)
             const additions = [srv, connectivity]
             const relationships = [{
                 insert: [connectivity, 'name'],
                 into: [srv, 'requires', 'name']
             }]
-            await mergeYAML('mta.yaml', join(__dirname, 'files', 'mta.yaml.hbs'), project, { additions, relationships })
+            await merge(__dirname, 'files/mta.yaml.hbs').into('mta.yaml', { project, additions, relationships })
         }
 
-        if (hasHelm) {
-            //in case facet is being added to the already exisiting charts folder
-            let isIndependentCommand = false
-            if(Object.keys(context).length == 0){
-                isIndependentCommand = true
-                context.oldTrackingData = context.newTrackingData = await parseMd5File(join('chart', '.cds-add-helm-files.md5'))
-            }
-            await mergeYAML(
-                join('chart', 'values.yaml'),
-                join(__dirname, 'files', 'values.yaml.hbs'),
+        if (hasHelm || hasHelmUnifiedRuntime) {
+            await merge(__dirname, 'files/values.yaml.hbs').into('chart/values.yaml', {
                 project,
-                { additions: [{
+                additions: [{
                     in: 'srv.additionalVolumes',
-                    where: [{
-                        property: 'name',
-                        isEqualTo: 'connectivity-secret'
-                    }]
-                }]}
-            )
-            const filesPath = join(__dirname, 'files')
-            const templatesPath = join('chart', 'templates')
-            await copyAndTrack(join(filesPath, 'connectivity-proxy-info.yaml'), join(templatesPath, 'connectivity-proxy-info.yaml'), context)
-            if(isIndependentCommand) await writeMd5File(join('chart', '.cds-add-helm-files.md5'), context.newTrackingData)
+                    where: { name: 'connectivity-secret' }
+                }]
+            })
+            await copy(join(__dirname, 'files', 'connectivity-proxy-info.yaml')).to('chart', 'templates', 'connectivity-proxy-info.yaml') // REVISIT: Move to build
         }
     }
 }

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

@@ -3,15 +3,16 @@ const cds = require('../../../cds')
 const { exists, fs } = cds.utils
 const { resolve, join, relative }  = require('path');
 const DEBUG = cds.debug('cli')
+const { env4 } = require('../../projectReader')
 
-module.exports = class DataTemplate extends require('../templateBase') {
+module.exports = class DataTemplate extends require('../../plugin') {
 
   async run() {
     if (cds.cli.options.for) {
       throw `\nError: Did you mean \`... --data:for\` ?`
     }
 
-    const env = await this.getEnv();
+    const env = env4('production')
 
     let dest = (typeof cds.cli.options.out === 'string') // target folder
       ? cds.cli.options.out

package/lib/init/template/destination/files/values.yaml

@@ -0,0 +1,9 @@
+srv:
+  bindings:
+    destination:
+      serviceInstanceName: 'destination'
+destination:
+    serviceOfferingName: 'destination'
+    servicePlanName: 'lite'
+    parameters:
+        version: '1.0.0'

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

@@ -1,71 +1,39 @@
-const { join } = require('path')
-const { readProject } = require('../../util/projectReader')
-const { mergeJSON, mergeYAML } = require('../../util/merge')
-const { srvJava4, srvNode4, destination } = require('../_merging/registry-mta')
-const { parseMd5File, writeMd5File } = require('../../util/md5')
+const { readProject } = require('../../projectReader')
+const { merge } = require('../../merge')
+const { srv4, destination } = require('../../registries/mta')
 
-module.exports = class DestinationTemplate extends require('../templateBase') {
+module.exports = class DestinationTemplate extends require('../../plugin') {
 
-    static hasFacet(env) {
+    static hasInProduction(env) {
         const kinds = { odata: 1, 'odata-v2': 1, 'odata-v4': 1, rest: 1 }
         const mtxServices = { 'cds.xt.SaasProvisioningService': 1, 'cds.xt.DeploymentService': 1, 'cds.xt.ModelProviderService': 1, 'cds.xt.ExtensibilityService': 1 }
         const _fromMtx = service => service in mtxServices
         const hasDestination = Object.entries(env.requires).some(([service, require]) => !_fromMtx(service) && !kinds[service] && kinds[require.kind])
-        return hasDestination || env.requires.destinations
+        return hasDestination || !!env.requires.destinations
     }
 
     async run() {
-        const project = await readProject()
+        const project = readProject()
         const { configFile } = project
-        await mergeJSON(configFile, join(__dirname, 'files', `package.json.hbs`), project)
+        await merge(__dirname, 'files', 'package.json.hbs').into(configFile, { with: project })
     }
 
-    async runDependentMerging(context = {}) {
-        const project = await readProject()
-        const { isJava, hasHelm, hasDestination, hasMta, srvPath } = project
+    async combine() {
+        const project = readProject()
+        const { hasHelm, hasHelmUnifiedRuntime, hasMta, srvPath } = project
 
         if (hasMta) {
-            const srv = (isJava ? srvJava4 : srvNode4)(srvPath)
+            const srv = srv4(srvPath)
             const additions = [srv, destination]
             const relationships = [{
                 insert: [destination, 'name'],
                 into: [srv, 'requires', 'name']
             }]
-            await mergeYAML('mta.yaml', join(__dirname, 'files', 'mta.yaml.hbs'), project, { additions, relationships })
+            await merge(__dirname, 'files/mta.yaml.hbs').into('mta.yaml', { with: project, additions, relationships })
         }
 
-        if (hasHelm) {
-            const binding = hasDestination && { srv: { bindings: { destination: { serviceInstanceName: 'destination' }}}}
-
-            //in case facet is being added to the already exisiting charts folder
-            let isIndependentCommand = false
-            if(Object.keys(context).length == 0){
-                isIndependentCommand = true
-                context.oldTrackingData = context.newTrackingData = await parseMd5File(join('chart', '.cds-add-helm-files.md5'))
-            }
-            await mergeYAML(
-                join('chart', 'values.yaml'),
-                {
-                    ...binding,
-                    destination: {
-                        serviceOfferingName: 'destination',
-                        servicePlanName: 'lite',
-                        parameters: {
-                            version: '1.0.0'
-                        }
-                    }
-                }
-            )
-
-            // copy service instance chart if it is not present
-            const HelmTemplate = require(`../helm`);
-            const helmTemplate = new HelmTemplate(context.oldTrackingData, context.newTrackingData);
-            isIndependentCommand = isIndependentCommand | await helmTemplate.addSubChart('service-instance');
-
-            // add dependency entry in chart.yaml
-            await helmTemplate.addDependency('service-instance', 'destination');
-
-            if(isIndependentCommand) await writeMd5File(join('chart', '.cds-add-helm-files.md5'), context.newTrackingData)
+        if (hasHelm || hasHelmUnifiedRuntime) {
+            await merge(__dirname, 'files/values.yaml').into('chart/values.yaml')
         }
     }
 }