@sap/cds-dk 6.6.2 → 6.7.1

package/lib/init/template/multitenancy/files/package.json.hbs

@@ -0,0 +1,28 @@
+{
+  {{#cap.isNodejs}}
+  "dependencies": {
+    "@sap/cds-mtxs": "^1"
+  },
+  {{/cap.isNodejs}}
+  "cds": {
+    {{#cap.isJava}}
+    "profiles": ["with-mtx-sidecar", "java"],
+    "build": {
+      "target": "."
+    },
+    {{/cap.isJava}}
+    {{#cap.isNodejs}}
+    "profile": "with-mtx-sidecar",
+    {{/cap.isNodejs}}
+    "requires": {
+      {{#cap.for}}
+      "[{{cap.for}}]": {
+        "multitenancy": true
+      }
+      {{/cap.for}}
+      {{^cap.for}}
+      "multitenancy": true
+      {{/cap.for}}
+    }
+  }
+}

package/lib/init/template/multitenancy/files/package.sidecar.json.hbs

@@ -0,0 +1,21 @@
+{
+  "name": "{{cap.appName}}-mtx",
+  "dependencies": {
+    "@sap/cds": "^6",
+    "@sap/cds-mtxs": "^1",
+    "@sap/xssec": "^3",
+    "express": "^4",
+    "hdb": "^0",
+    "passport": "^0.6.0"
+  },
+  "devDependencies": {
+    "sqlite3": "^5"
+  },
+  "scripts": {
+    "start": "cds-serve"{{#cap.isJava}},
+    "build": "npm ci && npx -p @sap/cds-dk@^6 cds build ../.. --for mtx-sidecar --production && cd gen && npm ci"{{/cap.isJava}}
+  },
+  "cds": {
+    "profile": "mtx-sidecar"
+  }
+}

package/lib/init/template/multitenancy/files/values.yaml.hbs

@@ -1,8 +1,10 @@
 ---
 srv:
   bindings:
+    {{#cap.isJava}}
     saas-registry:
       serviceInstanceName: saas-registry
+    {{/cap.isJava}}
     service-manager:
       serviceInstanceName: service-manager
 {{#cap.hasXsuaa}}
@@ -22,26 +24,32 @@ saasRegistryParameters:
   displayName: {{cap.appName}}
   description: {{cap.appDescription}}
   category: "CAP Application"
-  appUrls:
 {{#cap.isNodejs}}
+  bindSidecar: true
+{{/cap.isNodejs}}
+  appUrls:
+    {{#cap.isNodejs}}
     getDependencies: "/-/cds/saas-provisioning/dependencies"
     onSubscription: "/-/cds/saas-provisioning/tenant/{tenantId}"
-{{/cap.isNodejs}}
-{{#cap.isJava}}
+    {{/cap.isNodejs}}
+    {{#cap.isJava}}
     getDependencies: "/mt/v1.0/subscriptions/dependencies"
     onSubscription: "/mt/v1.0/subscriptions/tenants/{tenantId}"
-{{/cap.isJava}}
+    {{/cap.isJava}}
     onSubscriptionAsync: true
     onUnSubscriptionAsync: true
     onUpdateDependenciesAsync: true
     callbackTimeoutMillis: 300000
-{{#cap.isJava}}
 sidecar:
   bindings:
-{{#cap.hasXsuaa}}
+    {{#cap.hasXsuaa}}
     auth:
       serviceInstanceName: xsuaa
-{{/cap.hasXsuaa}}
+    {{/cap.hasXsuaa}}
+    {{#cap.isNodejs}}
+    saas-registry:
+      serviceInstanceName: saas-registry
+    {{/cap.isNodejs}}
     service-manager:
       serviceInstanceName: service-manager
   image:
@@ -55,9 +63,8 @@ sidecar:
       ephemeral-storage: 1G
       cpu: 500m
       memory: 500M
-  health_check:
+  health:
     liveness:
       path: /
     readiness:
       path: /
-{{/cap.isJava}}

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

@@ -1,15 +1,16 @@
 const { join } = require('path')
 const cds = require('../../../cds')
-const { copy, exists } = cds.utils
+const { exists } = cds.utils
 const { readProject } = require('../../util/projectReader')
 const { mergeJSON, mergeYAML, sortDependencies } = require('../../util/merge')
 const { copyAndTrack, parseMd5File, writeMd5File } = require('../../util/md5Tracking')
+const { copyRenderedJSON } = require('../../util/fsUtil')
 const {
   srvNode, srvJava, // Server
-  mtxSidecar, // Additional Modules
+  mtxSidecar4, // Additional Modules
   saasRegistry, serviceManager, xsuaa, // BTP Services
-  providedMtxAPISrv, providedMtxAPISidecar, srvAPI, providedMtxSidecarAPI, requiredMtxSidecarAPI // APIs
-} = require('../_merging/registry-mta');
+  srvAPI, providedMtxAPISidecar4, requiredMtxSidecarAPI // APIs
+} = require('../_merging/registry-mta')
 
 module.exports = class MultitenancyTemplate extends require('../templateBase') {
 
@@ -17,82 +18,73 @@ module.exports = class MultitenancyTemplate extends require('../templateBase') {
     // REVISIT: Check if this can be simplified
     return options?.add?.has('mtx') || options?.add?.has('multitenancy') ||
            !!env.requires?.multitenancy || !!env.requires?.db?.multiTenant ||
-           this.isJava && exists(join('mtx', 'sidecar')) || false
+           exists(join('mtx', 'sidecar')) || false
   }
 
   async run() {
     const projectDescriptor = await readProject(this.options)
-    const { for: forProfile, isNodejs, isJava } = projectDescriptor.cap
-    if (isNodejs) {
-      const packageJSONPath = join(this.projectPath, 'package.json')
-      const cdsTemplateFile = forProfile ? 'cds.package.json.hbs' : 'cds.package.json'
-      await mergeJSON(packageJSONPath, join(__dirname, 'files', cdsTemplateFile), projectDescriptor)
-      await mergeJSON(packageJSONPath, join(__dirname, 'files', 'dependencies.package.json'))
-      await sortDependencies(packageJSONPath)
-    } else if (isJava) {
-      const cdsrcJSONPath = join(this.projectPath, '.cdsrc.json')
-      await mergeJSON(cdsrcJSONPath, join(__dirname, 'files', 'java', '.cdsrc.json'))
-      await copy(join(__dirname, 'files', 'java', 'package.json'), join(this.projectPath, 'mtx', 'sidecar', 'package.json'))
-    }
+    const { isNodejs } = projectDescriptor.cap
+    await mergeJSON('package.json', join(__dirname, 'files', `package.json.hbs`), projectDescriptor)
+    if (isNodejs) await sortDependencies('package.json')
+    await copyRenderedJSON(join(__dirname, 'files', 'package.sidecar.json.hbs'), join('mtx', 'sidecar', 'package.json'), projectDescriptor)
     await this.runDependentMerging()
   }
 
   async runDependentMerging(context = {}) {
     const projectDescriptor = await readProject()
-    const { isNodejs, isJava, hasMta, hasHelm, hasApprouter, hasXsuaa, hasHana } = projectDescriptor.cap
+    const { isNodejs, isJava, hasMta, hasHelm, hasApprouter, hasXsuaa, hasHana, srvPath } = projectDescriptor.cap
 
     if (hasMta) {
-      const modules = isNodejs ? [srvNode] : [srvJava, mtxSidecar]
-      const srv = isNodejs ? srvNode : srvJava
+      const srv = (isNodejs ? srvNode : srvJava)(srvPath)
+      const mtxSidecar = mtxSidecar4(isJava ? 'mtx/sidecar' : 'gen/mtx/sidecar')
+      const modules = [srv, mtxSidecar]
       const services = [saasRegistry]
       if (hasXsuaa) services.push(xsuaa)
-      const apis = isNodejs ? [providedMtxAPISrv] : [srvAPI, providedMtxAPISidecar, providedMtxSidecarAPI, requiredMtxSidecarAPI]
+      const apis = [srvAPI(srv), providedMtxAPISidecar4(mtxSidecar)]
+      if (isJava) apis.push(requiredMtxSidecarAPI(srv))
       const additions = [...modules, ...services, ...apis]
 
-      const overwrites = hasXsuaa ? [{ item: [xsuaa, 'parameters.config.tenant-mode'], withValue: 'shared'}] : []
+      const overwrites = hasXsuaa ? [{ item: [xsuaa, 'parameters.config.tenant-mode'], withValue: 'shared' }] : []
 
       const relationships =  [{
         insert: [saasRegistry, 'name'],
-        into: [srv, 'requires', 'name']
+        into: [isJava ? srv : mtxSidecar, 'requires', 'name']
       }]
-      if (isJava) {
-        if (hasXsuaa) {
-          relationships.push({
-            insert: [xsuaa, 'name'],
-            into: [mtxSidecar, 'requires', 'name']
-          })
-        }
-        if (hasHana) {
-          relationships.push({
-            insert: [serviceManager, 'name'],
-            into: [mtxSidecar, 'requires', 'name'],
-          })
-        }
+      if (hasXsuaa) {
+        relationships.push({
+          insert: [xsuaa, 'name'],
+          into: [mtxSidecar, 'requires', 'name']
+        })
+      }
+      if (hasHana) {
+        relationships.push({
+          insert: [serviceManager, 'name'],
+          into: [mtxSidecar, 'requires', 'name'],
+        })
       }
 
-      const templateMtaPath = join(__dirname, `files`, `mta.yaml.hbs`)
-      const mtaPath = join(this.projectPath, 'mta.yaml')
+      const templateMtaPath = join(__dirname, 'files', 'mta.yaml.hbs')
       const mergingRules = { additions, overwrites, relationships }
-      await mergeYAML(mtaPath, templateMtaPath, projectDescriptor, mergingRules)
+      await mergeYAML('mta.yaml', templateMtaPath, projectDescriptor, mergingRules)
     }
 
+    // REVISIT: Why not just pass a Boolean from run() to indicate the merging isn't run transitively?
     let isIndependentCommand = false
     if (hasHelm) {
-      //in case facet is being added to the already exisiting charts folder
+      // in case facet is being added to the already existing charts folder
       if (Object.keys(context).length == 0) {
         isIndependentCommand = true
-        context.projectPath = this.projectPath
-        context.oldTrackingData = context.newTrackingData = await parseMd5File(join(this.projectPath, 'chart', '.cds-add-helm-files.md5'))
+        context.oldTrackingData = context.newTrackingData = await parseMd5File(join('chart', '.cds-add-helm-files.md5'))
       }
 
       await mergeYAML(
-        join(this.projectPath, 'chart', 'values.yaml'),
+        join('chart', 'values.yaml'),
         join(__dirname, 'files', 'values.yaml.hbs'),
         projectDescriptor
       )
 
       await mergeYAML(
-        join(this.projectPath, 'chart', 'values.yaml'),
+        join('chart', 'values.yaml'),
         {
           srv: {
             envFrom: [
@@ -117,74 +109,34 @@ module.exports = class MultitenancyTemplate extends require('../templateBase') {
         projectDescriptor
       )
 
-      if (isJava) {
-        await mergeYAML(
-          join(this.projectPath, 'chart', 'Chart.yaml'),
-          join(__dirname, 'files', 'sidecar.yaml'),
-          projectDescriptor,
-          {
-            additions: [{
-              in: `dependencies`,
-              where: [{
-                property: 'alias',
-                isEqualTo: 'sidecar'
-              }]
-            }]
-          }
-        )
-      }
-
-      // copy service-instance chart
+      // REVISIT: Don't reference other templates except for the safe `runDependentMerging` -> low coupling, high cohesion
       const HelmTemplate = require(`../helm`);
       const helmTemplate = new HelmTemplate(this.generator, context.oldTrackingData, context.newTrackingData);
-      isIndependentCommand = isIndependentCommand | await helmTemplate.addSubChart('service-instance');
 
-      // add dependency entry in chart.yaml
-      await mergeYAML(
-        join(this.projectPath, 'chart', 'Chart.yaml'),
-        join(__dirname, 'files', 'saas-registry.yaml'),
-        projectDescriptor,
-        { additions: [{
-            in: `dependencies`,
-            where: [{
-                property: 'alias',
-                isEqualTo: 'saas-registry'
-            }]
-        }]}
-      );
+      await helmTemplate.addDependency('web-application', 'sidecar');
 
-      await mergeYAML(
-        join(this.projectPath, 'chart', 'Chart.yaml'),
-        join(__dirname, 'files', 'service-manager.yaml'),
-        projectDescriptor,
-        { additions: [{
-            in: `dependencies`,
-            where: [{
-                property: 'alias',
-                isEqualTo: 'service-manager'
-            }]
-        }]}
-      );
+      // copy service-instance chart
+      isIndependentCommand = isIndependentCommand | await helmTemplate.addSubChart('service-instance');
 
-      const mtxsConfigmapPath = isNodejs
-                                ? join(__dirname, 'files', 'mtxs-configmap.yaml')
-                                : join(__dirname, 'files', 'java', 'mtxs-configmap.yaml');
+      // add dependency entry in chart.yaml
+      await helmTemplate.addDependency('service-instance', 'saas-registry');
+      await helmTemplate.addDependency('service-instance', 'service-manager');
 
       // add mtxs configmap
       await copyAndTrack(
-        mtxsConfigmapPath,
-        join(this.projectPath, 'chart', 'templates', 'mtxs-configmap.yaml'),
-        context
+        join(__dirname, 'files', `mtxs-configmap-${isJava ? 'java' : 'nodejs'}.yaml`),
+        join('chart', 'templates', 'mtxs-configmap.yaml'),
+        context,
       )
 
       // add saas registry secret
       await copyAndTrack(
         join(__dirname, 'files', 'saas-registry-secret.yaml'),
-        join(this.projectPath, 'chart', 'templates', 'saas-registry-secret.yaml'),
+        join('chart', 'templates', 'saas-registry-secret.yaml'),
         context
       );
 
-      if (isIndependentCommand) await writeMd5File(join(this.projectPath, 'chart', '.cds-add-helm-files.md5'), context.newTrackingData)
+      if (isIndependentCommand) await writeMd5File(join('chart', '.cds-add-helm-files.md5'), context.newTrackingData)
     }
 
     if (hasApprouter) {
@@ -201,7 +153,7 @@ module.exports = class MultitenancyTemplate extends require('../templateBase') {
 
     if (hasXsuaa) {
       await mergeJSON(
-        join(this.projectPath, 'xs-security.json'),
+        'xs-security.json',
         join(__dirname, 'files', 'xs-security.json.hbs'),
         projectDescriptor,
         {
@@ -215,7 +167,7 @@ module.exports = class MultitenancyTemplate extends require('../templateBase') {
 
     if (hasXsuaa && hasHelm) {
       await mergeYAML(
-          join(this.projectPath, 'chart', 'values.yaml'),
+          join('chart', 'values.yaml'),
           {
               xsuaa: {
                   parameters: {
@@ -226,7 +178,7 @@ module.exports = class MultitenancyTemplate extends require('../templateBase') {
           null,
           { forceOverwrite: true }
       )
-      if (isIndependentCommand) await writeMd5File(join(this.projectPath, 'chart', '.cds-add-helm-files.md5'), context.newTrackingData)
+      if (isIndependentCommand) await writeMd5File(join('chart', '.cds-add-helm-files.md5'), context.newTrackingData)
     }
   }
 }

package/lib/init/template/nodejs/files/.vscode/extensions.json

@@ -8,9 +8,8 @@
 		"dbaeumer.vscode-eslint",
 		"esbenp.prettier-vscode",
 		"mechatroner.rainbow-csv",
+		"qwtel.sqlite-viewer",
 		"humao.rest-client",
-		"alexcvzz.vscode-sqlite",
-		"hbenl.vscode-mocha-test-adapter",
 		"sdras.night-owl"
 	],
 	// List of extensions recommended by VS Code that should not be recommended for users of this workspace.

package/lib/init/template/nodejs/files/.vscode/launch.json

@@ -5,8 +5,8 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "command": "cds run --with-mocks --in-memory?",
-      "name": "cds run",
+      "command": "cds serve --with-mocks --in-memory?",
+      "name": "cds serve",
       "request": "launch",
       "type": "node-terminal",
       "skipFiles": [ "<node_internals>/**" ]

package/lib/init/template/nodejs/files/.vscode/tasks.json

@@ -16,9 +16,9 @@
     },
     {
       "type": "shell",
-      "label": "cds run",
+      "label": "cds serve",
       "command": "cds",
-      "args": ["run", "--with-mocks", "--in-memory?"],
+      "args": ["serve", "--with-mocks", "--in-memory?"],
       "problemMatcher": []
     }
   ]

package/lib/init/template/nodejs/files/package.json.hbs

@@ -10,9 +10,9 @@
     "express": "^4"
   },
   "devDependencies": {
-    "sqlite3": "^5.0.4"
+    "sqlite3": "^5"
   },
   "scripts": {
-    "start": "cds run"
+    "start": "cds-serve"
   }
 }

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

@@ -1,5 +1,6 @@
 const { join, relative } = require('path');
-const { mkdirp } = require('../../../cds').utils
+const cds = require('../../../cds')
+const { mkdirp } = cds.utils
 const { COMMAND_ADD, OPTION_JAVA, OPTION_NODEJS, URLS } = require('../../constants')
 const { copyFiles } = require('../../util/templateUtil')
 const LOG = console
@@ -8,7 +9,7 @@ module.exports = class NodejsTemplate extends require('../templateBase') {
 
     static hasFacet() {
         // TODO: Implement
-        //return this.pLanguage === P_LANGUAGE_NODEJS
+        //return this.language === P_LANGUAGE_NODEJS
     }
 
     async canRun() {
@@ -34,7 +35,7 @@ module.exports = class NodejsTemplate extends require('../templateBase') {
     }
 
     async finalize() {
-        const relativeProjectPath = relative(this.cwd, this.projectPath);
+        const relativeProjectPath = relative(this.cwd, cds.root);
         if (relativeProjectPath && relativeProjectPath !== '.') {
             LOG.info(`Continue with 'cd ${relativeProjectPath}'`);
         }

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

@@ -1,5 +1,6 @@
 const { join } = require('path');
-const { exists } = require('../../../cds').utils
+const cds = require('../../../cds')
+const { exists } = cds.utils
 const { copyFiles } = require('../../util/templateUtil')
 const { URLS } = require('../../constants')
 const LOG = console
@@ -20,7 +21,7 @@ module.exports = class PipelineTemplate extends require('../templateBase') {
     }
 
     async run() {
-        await copyFiles(join(__dirname, 'files'), this.projectPath, {}, this.options.force);
+        await copyFiles(join(__dirname, 'files'), cds.root, {}, this.options.force);
     }
 
     async finalize() {

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

@@ -1,4 +1,5 @@
 const { join } = require('path');
+const cds = require('../../../cds')
 const { copyFiles } = require('../../util/templateUtil')
 const commandUtil = require('../../util/commandUtil');
 const mvnArchetypes = require('../../util/mvnArchetypeUtil');
@@ -30,12 +31,12 @@ module.exports = class SamplesTemplate extends require('../templateBase') {
             const mvnAddSamplesArgs = mvnArchetypes.getAddSamplesCmdArgs(this.options);
             try {
                 await commandUtil.spawnCommand('mvn', mvnAddSamplesArgs, {
-                    cwd: this.projectPath
+                    cwd: cds.root
                 });
 
                 const mvnAddTestsArgs = mvnArchetypes.getAddTestsCmdArgs(this.options);
                 await commandUtil.spawnCommand('mvn', mvnAddTestsArgs, {
-                    cwd: this.projectPath
+                    cwd: cds.root
                 });
             } catch (err) {
                 if (err.code === 'ENOENT' && err.path === 'mvn') {
@@ -48,10 +49,10 @@ module.exports = class SamplesTemplate extends require('../templateBase') {
 
     async _addNodejsSamples() {
         const { db, srv } = (await this.getEnv()).folders;
-        const dbFolder = join(this.projectPath, db);
+        const dbFolder = join(cds.root, db);
         await copyFiles(join(__dirname, 'files', 'nodejs', 'db'), dbFolder, {}, this.options.force);
 
-        const srvFolder = join(this.projectPath, srv);
+        const srvFolder = join(cds.root, srv);
         await copyFiles(join(__dirname, 'files', 'nodejs', 'srv'), srvFolder, {
             dbFolder: db.replace(/[\\/]+$/, '')
         }, this.options.force);

package/lib/init/template/sqlite/files/package.json.hbs

@@ -0,0 +1,19 @@
+{
+  {{#cap.isNodejs}}
+  "devDependencies": {
+    "sqlite3": "^5"
+  },
+  {{/cap.isNodejs}}
+  "cds": {
+    "requires": {
+      {{#cap.for}}
+      "[{{cap.for}}]": {
+        "db": "sqlite"
+      }
+      {{/cap.for}}
+      {{^cap.for}}
+      "db": "sqlite"
+      {{/cap.for}}
+    }
+  }
+}

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

@@ -0,0 +1,11 @@
+const { join } = require('path')
+const { readProject } = require('../../util/projectReader')
+const { mergeJSON } = require('../../util/merge')
+
+module.exports = class SQLiteTemplate extends require('../templateBase') {
+
+    async run() {
+      const projectDescriptor = await readProject(this.options)
+      await mergeJSON('package.json', join(__dirname, 'files', `package.json.hbs`), projectDescriptor)
+    }
+}

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

@@ -12,14 +12,12 @@ module.exports = class TogglesTemplate extends require('../templateBase') {
     const projectDescriptor = await readProject(this.options)
     const { for: forProfile, isNodejs, isJava } = projectDescriptor.cap
     if (isNodejs) {
-      const packageJSONPath = join(this.projectPath, 'package.json')
       const cdsTemplateFile = forProfile ? 'cds.package.json.hbs' : 'cds.package.json'
-      await mergeJSON(packageJSONPath, join(__dirname, 'files', cdsTemplateFile), projectDescriptor)
-      await sortDependencies(packageJSONPath)
+      await mergeJSON('package.json', join(__dirname, 'files', cdsTemplateFile), projectDescriptor)
+      await sortDependencies('package.json')
     } else if (isJava) {
-      const cdsrcPath = join(this.projectPath, '.cdsrc.json')
       const cdsTemplateFile = join(__dirname, 'files', forProfile ? 'cdsrc.json.hbs' : 'cdsrc.json')
-      await mergeJSON(cdsrcPath, cdsTemplateFile, projectDescriptor)
+      await mergeJSON('.cdsrc.json', cdsTemplateFile, projectDescriptor)
     }
     await this.runDependentMerging()
   }

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

@@ -1,19 +1,18 @@
 ---
 modules:
   - name: {{cap.appName}}-srv
-    type: {{cap.pLanguage}}
+    type: {{cap.language}}
+    path: {{& cap.srvPath}}
     requires:
       - name: {{cap.appName}}-auth
 
-{{#cap.isJava}}
 {{#cap.isMultitenant}}
-  - name: {{cap.appName}}-mtx-sidecar
+  - name: {{cap.appName}}-mtx
     type: nodejs
-    path: mtx/sidecar
+    path: {{#cap.isNodejs}}gen/{{/cap.isNodejs}}mtx/sidecar
     requires:
       - name: {{cap.appName}}-auth
 {{/cap.isMultitenant}}
-{{/cap.isJava}}
 
 resources:
   - name: {{cap.appName}}-auth

package/lib/init/template/xsuaa/files/values.yaml.hbs

@@ -1,12 +1,10 @@
 ---
-{{#cap.isJava}}
 {{#cap.isMultitenant}}
 sidecar:
   bindings:
     auth:
       serviceInstanceName: xsuaa
 {{/cap.isMultitenant}}
-{{/cap.isJava}}
 {{#cap.hasApprouter}}
 approuter:
   bindings: