@sap/cds-dk 6.0.4 → 6.1.1

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

@@ -1,14 +1,6 @@
-const cds = require('../../../cds'), { fs, path } = cds.utils
 const TemplateBase = require('../templateBase')
 const ProjectReader = require('../../util/projectReader')
-const { OPTION_HANA, OPTION_XSUAA } = require('../../constants')
-
-const {
-    srvNode, srvJava, // Server
-    mtxSidecar, // Additional Modules
-    saasRegistry, xsuaa, // BTP Services
-    providedMtxAPI, srvAPI, providedMtxSidecarAPI, requiredMtxSidecarAPI // APIs
-} = require('../_merging/existences');
+const { OPTION_MULTITENANCY, OPTION_TOGGLES, OPTION_EXTENSIBILITY } = require('../../constants')
 
 module.exports = class MtxTemplate extends TemplateBase {
     constructor(projectPath, generator) {
@@ -17,138 +9,6 @@ module.exports = class MtxTemplate extends TemplateBase {
     }
 
     async getDependencies() {
-        return [OPTION_HANA, OPTION_XSUAA]
-    }
-
-    async runDependentMerging() {
-        const projectDescriptor = await this.projectReader.read()
-
-        const mtaYAMLPath = path.join(this.projectPath, 'mta.yaml')
-
-        if (fs.existsSync(mtaYAMLPath)) {
-            const mergingRules = projectDescriptor.cap.isNodejs ?
-                {
-                    existences: [srvNode, saasRegistry, providedMtxAPI, xsuaa],
-                    overwrites: [{
-                        in: xsuaa,
-                        keyPath: ["parameters", "config", "tenant-mode"],
-                        replacement: "shared"
-                    }],
-                    relationships: [{
-                        in: srvNode,
-                        inKeyPath: ["requires"],
-                        into: "name",
-                        existences: [saasRegistry],
-                        existenceKeyPath: ["name"],
-                    }],
-                }
-                :
-                {
-                    existences: [srvJava, srvAPI, mtxSidecar, xsuaa, saasRegistry, providedMtxAPI, providedMtxSidecarAPI, requiredMtxSidecarAPI],
-                    overwrites: [{
-                        in: xsuaa,
-                        keyPath: ["parameters", "config", "tenant-mode"],
-                        replacement: "shared"
-                    }],
-                    relationships: [{
-                        in: srvJava,
-                        inKeyPath: ["requires"],
-                        into: "name",
-                        existences: [saasRegistry],
-                        existenceKeyPath: ["name"],
-                    }],
-                }
-
-            await this.templateUtil.mergeYAML(
-                mtaYAMLPath,
-                path.join(__dirname, `files`, `mta.yaml.hbs`),
-                projectDescriptor,
-                mergingRules
-            )
-        }
-
-        if (projectDescriptor.cap.hasApprouter) {
-            const ApprouterTemplate = require(`../approuter`)
-            const template = new ApprouterTemplate(this.projectPath, this.generator)
-            await template.runDependentMerging()
-        }
-    }
-
-    async runXSSecurityMerging() {
-        const projectDescriptor = await this.projectReader.read()
-        await this.templateUtil.mergeJSON(
-            path.join(this.projectPath, 'xs-security.json'),
-            path.join(__dirname, 'files', 'xs-security.json.hbs'),
-            projectDescriptor,
-            {
-                existences: [{
-                    ref: "scope-subscription",
-                    keyPath: ["scopes"],
-                    constraints: [{
-                        comparisonKeyPath: ["name"],
-                        value: "$XSAPPNAME.mtcallback"
-                    }],
-                }, {
-                    ref: "scope-update",
-                    keyPath: ["scopes"],
-                    constraints: [{
-                        comparisonKeyPath: ["name"],
-                        value: "$XSAPPNAME.mtdeployment"
-                    }],
-                }, {
-                    ref: "scope-diagnose",
-                    keyPath: ["scopes"],
-                    constraints: [{
-                        comparisonKeyPath: ["name"],
-                        value: "$XSAPPNAME.MtxDiagnose"
-                    }],
-                }, {
-                    ref: "scope-extend",
-                    keyPath: ["scopes"],
-                    constraints: [{
-                        comparisonKeyPath: ["name"],
-                        value: "$XSAPPNAME.ExtendCDS"
-                    }],
-                }, {
-                    ref: "scope-extend-delete",
-                    keyPath: ["scopes"],
-                    constraints: [{
-                        comparisonKeyPath: ["name"],
-                        value: "$XSAPPNAME.ExtendCDSdelete"
-                    }],
-                }, {
-                    ref: "template-extension-developer",
-                    keyPath: ["role-templates"],
-                    constraints: [{
-                        comparisonKeyPath: ["name"],
-                        value: "ExtensionDeveloper"
-                    }],
-                }, {
-                    ref: "template-extension-developer-undeploy",
-                    keyPath: ["role-templates"],
-                    constraints: [{
-                        comparisonKeyPath: ["name"],
-                        value: "ExtensionDeveloperUndeploy"
-                    }],
-                }],
-            }
-        )
-    }
-
-    async run() {
-        const projectDescriptor = await this.projectReader.read(this.options)
-        if (projectDescriptor.cap.isNodejs) {
-            const packageJSONPath = path.join(this.projectPath, 'package.json')
-            const cdsTemplateFile = projectDescriptor.cap.for ? 'cds.package.json.hbs' : 'cds.package.json'
-            await this.templateUtil.mergeJSON(packageJSONPath, path.join(__dirname, 'files', cdsTemplateFile), projectDescriptor)
-            await this.templateUtil.mergeJSON(packageJSONPath, path.join(__dirname, 'files', 'dependencies.package.json'))
-            await this.templateUtil.sortDependencies(packageJSONPath)
-        } else {
-            const cdsrcJSONPath = path.join(this.projectPath, '.cdsrc.json')
-            await this.templateUtil.mergeJSON(cdsrcJSONPath, path.join(__dirname, 'files', 'java', '.cdsrc.json'))
-            await fs.copy(path.join(__dirname, 'files', 'java'), path.join(this.projectPath, 'mtx-sidecar'))
-        }
-        await this.runXSSecurityMerging()
-        await this.runDependentMerging()
+        return [OPTION_MULTITENANCY, OPTION_TOGGLES, OPTION_EXTENSIBILITY]
     }
 }

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

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

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

@@ -0,0 +1,9 @@
+{
+  "cds": {
+    "requires": {
+      "[{{cap.for}}]": {
+        "multitenancy": true
+      }
+    }
+  }
+}

package/lib/init/template/{mtx → multitenancy}/files/dependencies.package.json

@@ -1,5 +1,5 @@
 {
   "dependencies": {
-    "@sap/cds-mtx": "^2"
+    "@sap/cds-mtxs": "^1"
   }
 }

package/lib/init/template/multitenancy/files/java/.cdsrc.json

@@ -0,0 +1,19 @@
+{
+  "build": {
+    "target": ".",
+    "tasks": [
+      {
+        "for": "java"
+      },
+      {
+        "for": "mtx-sidecar"
+      },
+      {
+        "for": "hana",
+        "options": {
+          "deploy-format": "hdbtable"
+        }
+      }
+    ]
+  }
+}

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

@@ -0,0 +1,31 @@
+{
+  "name": "cap-mtx-sidecar",
+  "dependencies": {
+    "@sap/cds": "^6.0.2",
+    "@sap/cds-mtxs": "^1.0.1",
+    "@sap/hdi-deploy": "^4.4.1",
+    "@sap/xssec": "^3.2.13",
+    "express": "^4.18.1",
+    "hdb": "^0.19.3",
+    "passport": "^0.6.0"
+  },
+  "scripts": {
+    "start": "cds run",
+    "build": "npm ci && npx -p @sap/cds-dk@^6 cds build ../.. --for mtx-sidecar --production && cd gen && npm ci"
+  },
+  "engines": {
+    "node": "^16.15.0"
+  },
+  "cds": {
+    "requires": {
+      "db": {
+        "kind": "sqlite",
+        "[production]": {
+          "kind": "hana-mt"
+        }
+      },
+      "cds.xt.ModelProviderService": "in-sidecar",
+      "cds.xt.SaasProvisioningService": true
+    }
+  }
+}

package/lib/init/template/{mtx → multitenancy}/files/mta.yaml.hbs

@@ -8,6 +8,7 @@ modules:
 {{#cap.isJava}}
       - name: mtx-sidecar
         properties:
+          CDS_MULTITENANCY_MTXS_ENABLED: true
           CDS_MULTITENANCY_SIDECAR_URL: ~{url}
 {{/cap.isJava}}
     provides:
@@ -21,17 +22,23 @@ modules:
 {{#cap.isJava}}
   - name: {{cap.appName}}-mtx-sidecar
     type: nodejs
-    path: mtx-sidecar
+    path: mtx/sidecar
+    build-parameters:
+      builder: custom
+      build-result: gen
+      commands:
+        - npm run build
     parameters:
       memory: 256M
       disk-quota: 512M
-    requires:
-      - name: {{cap.appName}}-db
-      - name: {{cap.appName}}-auth
     provides:
       - name: mtx-sidecar
         properties:
           url: ${default-url}
+{{#cap.hasXsuaa}}
+    requires:
+      - name: {{cap.appName}}-auth
+{{/cap.hasXsuaa}}
 {{/cap.isJava}}
 
 resources:
@@ -55,8 +62,8 @@ resources:
         category: 'Category'
         appUrls:
 {{#cap.isNodejs}}
-          getDependencies: ~{mtx-api/mtx-url}/mtx/v1/provisioning/dependencies
-          onSubscription: ~{mtx-api/mtx-url}/mtx/v1/provisioning/tenant/{tenantId}
+          getDependencies: ~{mtx-api/mtx-url}/-/cds/saas-provisioning/dependencies
+          onSubscription: ~{mtx-api/mtx-url}/-/cds/saas-provisioning/tenant/{tenantId}
 {{/cap.isNodejs}}
 {{#cap.isJava}}
           getDependencies: ~{srv-api/srv-url}/mt/v1.0/subscriptions/dependencies

package/lib/init/template/multitenancy/files/xs-security.json.hbs

@@ -0,0 +1,18 @@
+{
+  "scopes": [
+    {
+      "name": "$XSAPPNAME.mtcallback",
+      "description": "Subscription via SaaS Registry",
+      "grant-as-authority-to-apps": [
+        "$XSAPPNAME(application,sap-provisioning,tenant-onboarding)"
+      ]
+    },
+    {
+      "name": "$XSAPPNAME.cds.Subscriber",
+      "description": "Subscribe to applications"
+    }
+  ],
+  "authorities": [
+    "$XSAPPNAME.cds.Subscriber"
+  ]
+}

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

@@ -0,0 +1,109 @@
+const cds = require('../../../cds'), { fs, path } = cds.utils
+const TemplateBase = require('../templateBase')
+const ProjectReader = require('../../util/projectReader')
+
+const {
+  srvNode, srvJava, // Server
+  mtxSidecar, // Additional Modules
+  saasRegistry, serviceManager, xsuaa, // BTP Services
+  providedMtxAPI, srvAPI, providedMtxSidecarAPI, requiredMtxSidecarAPI // APIs
+} = require('../_merging/registry-mta');
+
+module.exports = class MultitenancyTemplate extends TemplateBase {
+  constructor(projectPath, generator) {
+    super(projectPath, generator, __dirname)
+    this.projectReader = new ProjectReader(this)
+  }
+
+  async runDependentMerging() {
+    const projectDescriptor = await this.projectReader.read()
+    const { isNodejs, isJava, hasMtaDeployment, hasApprouter, hasXsuaa, hasHana } = projectDescriptor.cap
+
+    if (hasMtaDeployment) {
+      const modules = isNodejs ? [srvNode] : [srvJava, mtxSidecar]
+      const srv = isNodejs ? srvNode : srvJava
+      const services = [saasRegistry]
+      if (hasXsuaa) services.push(xsuaa)
+      const apis = isNodejs ? [providedMtxAPI] : [srvAPI, providedMtxAPI, providedMtxSidecarAPI, requiredMtxSidecarAPI]
+      const relationships =  [{
+        insert: [saasRegistry, 'name'],
+        into: [srv, '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'],
+          })
+        }
+      }
+
+      const mergingRules = {
+        additions: [...modules, ...services, ...apis],
+        overwrites: hasXsuaa ? [{ // TODO: the hasXsuaa should not be necessary
+          item: [xsuaa, 'parameters.config.tenant-mode'],
+          withValue: 'shared'
+        }] : undefined,
+        relationships,
+      }
+      const mtaPath = path.join(this.projectPath, 'mta.yaml')
+      const templateMtaPath = path.join(__dirname, `files`, `mta.yaml.hbs`)
+      await this.templateUtil.mergeYAML(mtaPath, templateMtaPath, projectDescriptor, mergingRules)
+    }
+
+    if (hasApprouter) {
+      const ApprouterTemplate = require(`../approuter`)
+      const template = new ApprouterTemplate(this.projectPath, this.generator)
+      await template.runDependentMerging()
+    }
+
+    if (hasHana) {
+      const HanaTemplate = require(`../hana`)
+      const template = new HanaTemplate(this.projectPath, this.generator)
+      await template.runDependentMerging()
+    }
+
+    if (hasXsuaa) {
+      await this.templateUtil.mergeJSON(
+        path.join(this.projectPath, 'xs-security.json'),
+        path.join(__dirname, 'files', 'xs-security.json.hbs'),
+        projectDescriptor,
+        {
+          additions: [{
+            ref: 'scope-mtcallback',
+            in: 'scopes',
+            where: [{ property: 'name', isEqualTo: '$XSAPPNAME.mtcallback' }],
+          }, {
+            ref: 'scope-subscriber',
+            in: 'scopes',
+            where: [{ property: 'name', isEqualTo: '$XSAPPNAME.cds.Subscriber' }],
+          }]
+        }
+      )
+    }
+  }
+
+  async run() {
+    const projectDescriptor = await this.projectReader.read(this.options)
+    const { for: forProfile, isNodejs, isJava } = projectDescriptor.cap
+    if (isNodejs) {
+      const packageJSONPath = path.join(this.projectPath, 'package.json')
+      const cdsTemplateFile = forProfile ? 'cds.package.json.hbs' : 'cds.package.json'
+      await this.templateUtil.mergeJSON(packageJSONPath, path.join(__dirname, 'files', cdsTemplateFile), projectDescriptor)
+      await this.templateUtil.mergeJSON(packageJSONPath, path.join(__dirname, 'files', 'dependencies.package.json'))
+      await this.templateUtil.sortDependencies(packageJSONPath)
+    } else if (isJava) {
+      const cdsrcJSONPath = path.join(this.projectPath, '.cdsrc.json')
+      await this.templateUtil.mergeJSON(cdsrcJSONPath, path.join(__dirname, 'files', 'java', '.cdsrc.json'))
+      await fs.copy(path.join(__dirname, 'files', 'java', 'package.json'), path.join(this.projectPath, 'mtx', 'sidecar', 'package.json'))
+    }
+    await this.runDependentMerging()
+  }
+}

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

@@ -15,6 +15,9 @@
   "scripts": {
     "start": "cds run"
   },
+  "engines": {
+    "node": "^16.15"
+  },
   "eslintConfig": {
     "extends": "eslint:recommended",
     "env": {

package/lib/init/template/templateBase.js

@@ -64,13 +64,14 @@ module.exports = class TemplateBase {
 
     /**
      * @abstract
-     * Executes the given template's merging steps.
+     * Executes the given template's merging steps which are dependent on another template.
      * The separation from `run()` is necessary to preserve templating associativity,
      * i.e. the order in which you apply them does not matter.
      * Ex.: Assume `cds add hana` is called before `cds add mta`. We want `cds add mta`
      * to create the base mta.yaml template and merge the hana mta.yaml in, but _don't_
      * want any other steps from the hana template performed (e.g. creating the .hdiconfig).
      * Separating the two let's us run this _only_ the merging part of the template.
+     * In addition, this partial merging avoids cyclic template dependencies.
      */
     async runDependentMerging() {
 

package/lib/init/template/toggles/files/cds.package.json

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

package/lib/init/template/toggles/files/cds.package.json.hbs

@@ -0,0 +1,9 @@
+{
+  "cds": {
+    "requires": {
+      "[{{cap.for}}]": {
+        "toggles": true
+      }
+    }
+  }
+}

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

@@ -0,0 +1,24 @@
+const cds = require('../../../cds'), { path } = cds.utils
+const TemplateBase = require('../templateBase')
+const ProjectReader = require('../../util/projectReader')
+
+module.exports = class TogglesTemplate extends TemplateBase {
+  constructor(projectPath, generator) {
+    super(projectPath, generator, __dirname)
+    this.projectReader = new ProjectReader(this)
+  }
+
+  async run() {
+    const projectDescriptor = await this.projectReader.read(this.options)
+    const { for: forProfile, isNodejs, isJava } = projectDescriptor.cap
+    if (isNodejs) {
+      const packageJSONPath = path.join(this.projectPath, 'package.json')
+      const cdsTemplateFile = forProfile ? 'cds.package.json.hbs' : 'cds.package.json'
+      await this.templateUtil.mergeJSON(packageJSONPath, path.join(__dirname, 'files', cdsTemplateFile), projectDescriptor)
+      await this.templateUtil.sortDependencies(packageJSONPath)
+    } else if (isJava) {
+      // TODO: implement
+    }
+    await this.runDependentMerging()
+  }
+}

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

@@ -5,6 +5,16 @@ modules:
     requires:
       - name: {{cap.appName}}-auth
 
+{{#cap.isJava}}
+{{#cap.isMultitenant}}
+  - name: {{cap.appName}}-mtx-sidecar
+    type: nodejs
+    path: mtx/sidecar
+    requires:
+      - name: {{cap.appName}}-auth
+{{/cap.isMultitenant}}
+{{/cap.isJava}}
+
 resources:
   - name: {{cap.appName}}-auth
     type: org.cloudfoundry.managed-service

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

@@ -1,9 +1,8 @@
-const fs = require('fs')
 const path = require('path')
 const TemplateBase = require('../templateBase')
 const ProjectReader = require('../../util/projectReader')
-const { srvNode, srvJava, xsuaa } = require('../_merging/existences')
-const { PROJECT_TYPE, OPTION_HELM_UPDATE } = require('../../constants');
+const { srvNode, srvJava, xsuaa, mtxSidecar } = require('../_merging/registry-mta')
+const { PROJECT_TYPE, OPTION_HELM_UPDATE } = require('../../constants')
 
 module.exports = class XsuaaTemplate extends TemplateBase {
     constructor(projectPath, generator) {
@@ -13,35 +12,46 @@ module.exports = class XsuaaTemplate extends TemplateBase {
 
     async runDependentMerging() {
         const projectDescriptor = await this.projectReader.read(this.options)
-        const { projectPath } = this
+        const { isMultitenant, isExtensible, hasMtaDeployment, isNodejs, isJava } = projectDescriptor.cap
 
-        const mtaYAMLPath = path.join(projectPath, 'mta.yaml')
-        if (!fs.existsSync(mtaYAMLPath)) return
+        if (hasMtaDeployment) {
+            const srv = isNodejs ? srvNode : srvJava
+            const additions = [srv, xsuaa]
+            if (isMultitenant && isJava) additions.push(mtxSidecar)
 
-        const srv = projectDescriptor.cap.isNodejs ? srvNode : srvJava
-        await this.templateUtil.mergeYAML(
-            mtaYAMLPath,
-            `${__dirname}/files/mta.yaml.hbs`,
-            projectDescriptor,
-            {
-                existences: [srv, xsuaa],
-                relationships: [{
-                    in: srv,
-                    inKeyPath: ["requires"],
-                    into: "name",
-                    existences: [xsuaa],
-                    existenceKeyPath: ["name"],
-                }],
-            }
-        )
+            const mtaYAMLPath = path.join(this.projectPath, 'mta.yaml')
+            const relationships =  [{
+                insert: [xsuaa, 'name'],
+                into: [srv, 'requires', 'name']
+            }]
+            relationships.push({
+                insert: [xsuaa, 'name'],
+                into: [mtxSidecar, 'requires', 'name']
+            })
+
+            await this.templateUtil.mergeYAML(
+                mtaYAMLPath,
+                `${__dirname}/files/mta.yaml.hbs`,
+                projectDescriptor,
+                {
+                    additions,
+                    relationships
+                }
+            )
+        }
 
         // Re-applying the merging part of `cds add mtx` because cds.compile.to.xsuaa
         // has overwritten the existing `xs-security.json`.
         // TODO: Find a generic solution for situation like these.
-        if (projectDescriptor.cap.isMultitenant) {
-            const MtxTemplate = require(`../mtx`)
-            const mtxTemplate = new MtxTemplate(this.projectPath, this.generator)
-            await mtxTemplate.runDependentMerging()
+        if (isMultitenant) {
+            const MultitenancyTemplate = require(`../multitenancy`)
+            const multitenancyTemplate = new MultitenancyTemplate(this.projectPath, this.generator)
+            await multitenancyTemplate.runDependentMerging()
+        }
+        if (isExtensible) {
+            const ExtensibilityTemplate = require(`../extensibility`)
+            const extensibilityTemplate = new ExtensibilityTemplate(this.projectPath, this.generator)
+            await extensibilityTemplate.runDependentMerging()
         }
     }
 
@@ -49,19 +59,20 @@ module.exports = class XsuaaTemplate extends TemplateBase {
         const { projectPath } = this
         const templatePath = path.join(__dirname, 'files')
         const projectDescriptor = await this.projectReader.read(this.options)
+        const { for: forProfile } = projectDescriptor.cap
 
         const projectType = await this.getProjectType();
         switch (projectType) {
             case PROJECT_TYPE.java: {
                 const cdsrcJSONPath = path.join(projectPath, '.cdsrc.json')
-                const cdsTemplateFile = projectDescriptor.cap.for ? 'cds.cdsrc.json.hbs' : 'cds.cdsrc.json'
+                const cdsTemplateFile = forProfile ? 'cds.cdsrc.json.hbs' : 'cds.cdsrc.json'
                 const cdsTemplatePath = path.join(templatePath, cdsTemplateFile)
                 await this.templateUtil.mergeJSON(cdsrcJSONPath, cdsTemplatePath, projectDescriptor)
                 break
             }
             case PROJECT_TYPE.nodejs: {
                 const packageJSONPath = path.join(projectPath, 'package.json')
-                const cdsTemplateFile = projectDescriptor.cap.for ? 'cds.package.json.hbs' : 'cds.package.json'
+                const cdsTemplateFile = forProfile ? 'cds.package.json.hbs' : 'cds.package.json'
                 const cdsTemplatePath = path.join(templatePath, cdsTemplateFile)
                 await this.templateUtil.mergeJSON(packageJSONPath, cdsTemplatePath, projectDescriptor)
                 const dependenciesTemplatePath = path.join(templatePath, 'dependencies.package.json')
@@ -76,12 +87,12 @@ module.exports = class XsuaaTemplate extends TemplateBase {
         } catch (error) { /* ignore */ }
         })() || { scopes: [], attributes: [], 'role-templates': [], 'authorities-inheritance': false }
 
-        const mergingSemantics = { existences: xsuaa.scopes.map(scope => ({
+        const mergingSemantics = { additions: xsuaa.scopes.map(scope => ({
             ref: scope.name,
-            keyPath: ["scopes"],
-            constraints: [{
-                comparisonKeyPath: ["name"],
-                value: scope.name
+            in: 'scopes',
+            where: [{
+                property: 'name',
+                isEqualTo: scope.name
             }],
         }))}
         const xsSecurityPath = path.join(projectPath, 'xs-security.json')