@sap/cds-dk 7.6.1 → 7.7.0

package/lib/init/merge.js

@@ -141,7 +141,7 @@ async function _mergeYAML(into, from, project, semantics = {}) {
         throw new Error(`Target YAML doesn't exist`)
     }
 
-    const entryMap = new Map, templateEntryMap = new Map()
+    const entryMap = new Map, templateEntryMap = new Map
 
     const { additions, overwrites, deletions, relationships } = semantics
     additions?.forEach(entry => {
@@ -236,7 +236,7 @@ async function _mergeYAML(into, from, project, semantics = {}) {
 
         if (!templateCollection?.items) return
 
-        templateCollection.items.forEach((templateNode, templateIndex) => {
+        templateCollection.items?.forEach((templateNode, templateIndex) => {
             if (YAML.isScalar(templateNode)) {
                 if (!collection.items.map(item => item.value).includes(templateNode.value)) {
                     collection.add(templateNode)
@@ -413,20 +413,38 @@ async function removeFromYAMLArray(name, keyPath, aliasToRemove) {
     await writeYAML(name, yaml)
 }
 
+
 const path = require('path')
+
+/**
+ * @param {...(string | Object | YAML.Document)} src The source to merge from.
+ * @returns {{
+*   into: (dst: (string | Object | YAML.Document), options?: {project?: Object, semantics?: MergingSemantics}) => Promise<any>
+* }} An object with an 'into' method to merge the sources into the specified destination.
+*/
 const merge = (...src) => {
-    return { into: (dst, { with: withProject, project, ...semantics } = {}) => {
-        if (Object.keys(semantics).length === 0) semantics = undefined
-        project ??= withProject // to allow { with: project } for a more fluent API
-        const isYAML = typeof dst === 'string' && ['.yaml', '.yml', '.yaml.hbs', '.yml.hbs'].some(ext => dst.endsWith(ext))
-        const _merge = isYAML ? _mergeYAML : _mergeJSON
-        const target = typeof dst === 'string' ? path.resolve(cds.root, dst) : dst
-        if (typeof src[src.length-1] === 'string') {
-            return _merge(target, path.join(...src), project, semantics)
-        } else {
-            return _merge(target, ...src, project, semantics)
+    return {
+        /**
+         * Merges sources into the specified destination.
+         * @param {(string | Object | YAML.Document)} dst File path or object to merge into.
+         * @param {Object} [options] Merging options.
+         * @param {Object} [options.project] Project descriptor used for Mustache replacements.
+         * @param {MergingSemantics} [options.semantics] Merging algorithm semantics.
+         * @returns {Promise} A promise resolving to the merged object.
+         */
+        into: (dst, { with: withProject, project, ...semantics } = {}) => {
+            if (Object.keys(semantics).length === 0) semantics = undefined
+            project ??= withProject // to allow { with: project } for a more fluent API
+            const isYAML = typeof dst === 'string' && ['.yaml', '.yml', '.yaml.hbs', '.yml.hbs'].some(ext => dst.endsWith(ext))
+            const _merge = isYAML ? _mergeYAML : _mergeJSON
+            const target = typeof dst === 'string' ? path.resolve(cds.root, dst) : dst
+            if (typeof src[src.length-1] === 'string') {
+                return _merge(target, path.join(...src), project, semantics)
+            } else {
+                return _merge(target, ...src, project, semantics)
+            }
         }
-    }}
+    }
 }
 
 module.exports = {

package/lib/init/projectReader.js

@@ -1,6 +1,6 @@
 const cds = require('../cds')
 const { join, resolve, basename } = require('path')
-const { fs, exists, isdir } = cds.utils
+const { fs, exists, isdir, path } = cds.utils
 const { parseXml } = require('./xml')
 const { REGEX_JAVA_VERSION } = require('./constants')
 const DEBUG = cds.debug('cli')
@@ -59,6 +59,7 @@ module.exports = new class ProjectReader {
      * @property {Object} db Database configuration.
      * @property {string} configFile The name of the configuration file. This is typically the `package.json` for Node.js and `.cdsrc.json` for Java.
      * @property {string} appPath The path to the app folder.
+     * @property {string} approuterPath The path to the approuter folder.
      * @property {boolean} hasUIEmbedded Indicates if the project uses an embedded UI.
      * @property {boolean} hasUIModule Indicates if the project is using a modular UI.
      * @property {boolean} hasUI Indicates if the project has a UI.
@@ -112,8 +113,15 @@ module.exports = new class ProjectReader {
                 return { folder, name, path }
             },
             configFile: () => exists('pom.xml') ? '.cdsrc.json' : 'package.json',
+            apps: () => (fs.readdirSync(path.resolve(cds.root, cds.env.folders.app))).filter(e =>
+                isdir(join(cds.root, cds.env.folders.app, e)) && e !== 'appconfig' && e !== '_i18n' && e !== 'router'
+            ).map(app => ({ app })),
+            appUIPaths: () => (fs.readdirSync(path.resolve(cds.root, cds.env.folders.app))).filter(e =>
+                isdir(join(cds.root, cds.env.folders.app, e)) && e !== 'appconfig' && e !== '_i18n' && e !== 'router'
+            ),
             appPath: () => env.folders.app,
             appVersion: () => appVersion,
+            approuterPath: () => join(env.folders.app, 'router'),
             appName: () => appName,
             cleanedAppName: () => appName.replaceAll('_', '-'),
             appId: () => appId,

package/lib/init/registries/mta.js

@@ -122,6 +122,21 @@ const approuterExtensibility = {
     where: { source: '^/-/cds/.*', destination: 'mtx-api', authenticationType: 'none' }
 }
 
+const html5RepoHost = {
+    in: 'resources',
+    where: { 'parameters.service': 'html5-apps-repo', 'parameters.service-plan': 'app-host' }
+}
+
+const html5Runtime = {
+    in: 'resources',
+    where: { 'parameters.service': 'html5-apps-repo', 'parameters.service-plan': 'app-runtime' }
+}
+
+const appContent = {
+    in: 'modules',
+    where: { type: 'com.sap.application.content' }
+}
+
 module.exports = {
     srv4,
     approuter,
@@ -147,5 +162,8 @@ module.exports = {
     providedJavaApprouterApi4,
     providedJavaApprouterApi,
     applicationLogging,
-    approuterExtensibility
+    approuterExtensibility,
+    html5RepoHost,
+    html5Runtime,
+    appContent
 }

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

@@ -19,7 +19,7 @@ modules:
 
   - name: {{appName}}
     type: approuter.nodejs
-    path: {{& appPath}}
+    path: {{& approuterPath}}
     parameters:
       keep-existing-routes: true
       disk-quota: 256M

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

@@ -22,16 +22,16 @@ module.exports = class ApprouterTemplate extends require('../../plugin') {
     }
 
     async run() {
-        const { appPath } = readProject()
-        const appPackageJSONPath = join(appPath, 'package.json')
+        const { approuterPath } = readProject()
+        const appPackageJSONPath = join(approuterPath, 'package.json')
         await merge(__dirname, 'files/package.json').into(appPackageJSONPath)
         await sort(appPackageJSONPath, 'dependencies')
-        await merge(__dirname, 'files/default-env.json').into(appPath + '/default-env.json')
+        await merge(__dirname, 'files/default-env.json').into(approuterPath + '/default-env.json')
     }
 
     async combine() {
         const project = readProject(this.options)
-        const { isNodejs, isJava, hasExtensibility, hasMultitenancy, hasMta, hasHelm, hasHelmUnifiedRuntime, srvPath, appPath } = project
+        const { isNodejs, isJava, hasExtensibility, hasMultitenancy, hasMta, hasHelm, hasHelmUnifiedRuntime, srvPath, approuterPath } = project
 
         if (hasMta) {
             const srv = srv4(srvPath)
@@ -72,7 +72,7 @@ module.exports = class ApprouterTemplate extends require('../../plugin') {
             }
         }
 
-        const xsAppPath = join(appPath, 'xs-app.json')
+        const xsAppPath = join(approuterPath, 'xs-app.json')
         const additions = hasExtensibility ? [{ ...approuterExtensibility, at: 0 }] : []
         await merge(__dirname, 'files/xs-app.json.hbs').into(xsAppPath, { project, additions })
     }

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

@@ -12,10 +12,9 @@ module.exports = class ConnectivityTemplate extends require('../../plugin') {
     }
 
     async run() {
-        // Disable setting cds.requires.connectivity for now.
-        // const project = readProject()
-        // const { configFile } = project
-        // await merge(__dirname, 'files', 'package.json.hbs').into(configFile, { with: project })
+        const project = readProject()
+        const { configFile } = project
+        await merge(__dirname, 'files', 'package.json.hbs').into(configFile, { with: project })
     }
 
     async combine() {

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

@@ -0,0 +1,16 @@
+{
+  "name": "{{app}}",
+  "version": "1.0.0",
+  "private": true,
+  "description": "<description>",
+  "main": "webapp/index.html",
+  "scripts": {
+    "build": "ui5 build preload --clean-dest --include-task=generateCachebusterInfo",
+    "start": "ui5 serve"
+  },
+  "devDependencies": {
+    "@ui5/cli": "^3.8.0",
+    "ui5-middleware-simpleproxy": "^3.2.10",
+    "ui5-task-zipper": "^3.1.1"
+  }
+}

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

@@ -0,0 +1,83 @@
+---
+modules:
+  - name: {{appName}}-srv
+    type: {{language}}
+    path: {{& srvPath}}
+
+  - name: {{appName}}
+    type: approuter.nodejs
+    path: {{& approuterPath}}
+    requires:
+      - name: {{appName}}-html5-runtime
+
+  - name: {{appName}}-app-content
+    type: com.sap.application.content
+    path: {{& appPath}}
+    requires:
+      - name: {{appName}}-destination
+      - name: {{appName}}-html5-repo-host
+        parameters:
+          content-target: true
+    build-parameters:
+      build-result: resources
+      requires:
+      {{#apps}}
+        - name: {{appName}}-app-{{app}}
+          artifacts:
+            - {{app}}.zip
+          target-path: resources/
+      {{/apps}}
+
+  {{#apps}}
+  - name: {{appName}}-app-{{app}}
+    type: html5
+    path: {{& appPath}}{{app}}
+    build-parameters:
+      build-result: dist
+      builder: custom
+      commands:
+        - npm ci
+        - npm run build
+      supported-platforms: []
+  {{/apps}}
+
+resources:
+  {{#hasApprouter}}
+  - name: {{appName}}-html5-runtime
+    type: org.cloudfoundry.managed-service
+    parameters:
+      service: html5-apps-repo
+      service-plan: app-runtime
+  {{/hasApprouter}}
+
+  - name: {{appName}}-html5-repo-host
+    type: org.cloudfoundry.managed-service
+    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
+                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.json.hbs

@@ -0,0 +1,17 @@
+{
+  {{#isNodejs}}
+  "cds": {
+  {{/isNodejs}}
+    "requires": {
+      {{#profile}}
+      "[{{profile}}]": {
+      {{/profile}}
+        "html5-repo": true
+      {{#profile}}
+      }
+      {{/profile}}
+    }
+  {{#isNodejs}}
+  }
+  {{/isNodejs}}
+}

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

@@ -0,0 +1,33 @@
+---
+# yaml-language-server: $schema=https://sap.github.io/ui5-tooling/schema/ui5.yaml.json
+specVersion: "3.0"
+metadata:
+  name: sap.fe.cap.{{app}}
+type: application
+
+resources:
+  configuration:
+    propertiesFileSourceEncoding: UTF-8
+
+builder:
+  resources:
+    excludes:
+      - "/test/**"
+      - "/localService/**"
+  customTasks:
+    - name: ui5-task-zipper
+      afterTask: generateCachebusterInfo
+      configuration:
+        archiveName: {{app}}
+        additionalFiles:
+          - xs-app.json
+
+server:
+  customMiddleware:
+    - name: ui5-middleware-simpleproxy
+      mountPath: /{{app}}
+      afterMiddleware: compression
+      configuration:
+        baseUri: http://localhost:4004/{{app}}
+        username: admin # dummy credentials for local testing
+        password: admin # dummy credentials for local testing

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

@@ -0,0 +1,19 @@
+{
+  "welcomeFile": "/index.html",
+  "authenticationMethod": "route",
+  "routes": [
+    {
+      "source": "^/{{app}}/(.*)$",
+      "target": "/{{app}}/$1",
+      "destination": "srv-api",
+      "authenticationType": "xsuaa",
+      "csrfProtection": false
+    },
+    {
+      "source": "^(.*)$",
+      "target": "$1",
+      "service": "html5-apps-repo-rt",
+      "authenticationType": "xsuaa"
+    }
+  ]
+}

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

@@ -1,7 +1,9 @@
 const { join } = require('path')
-const { exists, copy } = require('../../../cds').utils
+const cds = require('../../../cds')
+const { copy } = cds.utils
 const { readProject } = require('../../projectReader')
 const { merge } = require('../../merge')
+const { srv4, destination, html5RepoHost, html5Runtime, appContent, approuter } = require('../../registries/mta')
 
 module.exports = class Html5RepoTemplate extends require('../../plugin') {
 
@@ -9,23 +11,65 @@ module.exports = class Html5RepoTemplate extends require('../../plugin') {
         return ['destination']
     }
 
-    async canRun() {
-        const project = readProject()
-        const { hasMta, hasHelm, hasHelmUnifiedRuntime } = project
-        if (!(hasHelm || hasHelmUnifiedRuntime) && hasMta) {
-            throw `'cds add html5-repo' is not available for Cloud Foundry yet`
-        }
-        return true
+    static hasInProduction(env) {
+        return !!env.requires['html5-repo']
     }
 
-    static hasInProduction() {
-        // REVISIT: Should be detectable without helm charts
-        return exists(join('chart', 'templates', 'html5-apps-deployer-configmap.yaml'))
+    async run() {
+        const project = readProject()
+        const { apps, appPath, configFile } = project
+        await merge(__dirname, 'files', 'package.json.hbs').into(configFile, { with: project })
+
+        await Promise.all(apps.map(async ({app}) => {
+            project.app = app
+            await merge(__dirname, 'files/ui5.yaml.hbs').into(join(appPath, app, 'ui5.yaml'), { project })
+        }))
+        await Promise.all(apps.map(async ({app}) => {
+            project.app = app
+            await merge(__dirname, 'files/app-package.json.hbs').into(join(appPath, app, 'package.json'), { project })
+        }))
     }
 
     async combine() {
         const project = readProject()
-        const { hasHelm, hasHelmUnifiedRuntime } = project
+        const { srvPath, appPath, hasMta, hasHelm, hasHelmUnifiedRuntime, hasApprouter, apps } = project
+
+        if (hasApprouter) {
+            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 (hasMta) {
+            const srv = srv4(srvPath)
+            project.apps = apps
+            const appModules = project.apps.map(app => ( {
+                in: 'modules',
+                where: { type: 'html5', path: `${appPath}${app.app}` }
+            }))
+            const additions = [srv, appContent, destination, html5RepoHost, ...appModules]
+            const relationships = [{
+                insert: [destination, 'name'],
+                into: [appContent, 'requires', 'name'],
+            }, {
+                insert: [html5RepoHost, 'name'],
+                into: [appContent, 'requires', 'name'],
+            }]
+            if (hasApprouter) {
+                console.log('aaddd')
+                additions.push(approuter, html5Runtime)
+                relationships.push({
+                    insert: [html5Runtime, 'name'],
+                    into: [approuter, 'requires', 'name'],
+                })
+            }
+            await merge(__dirname, 'files/mta.yaml.hbs').into('mta.yaml', { with: project,
+                additions,
+                relationships
+            })
+        }
+
         if (hasHelm || hasHelmUnifiedRuntime) {
             await merge(__dirname, 'files/values.yaml.hbs').into('chart/values.yaml', { with: project })
             await merge({

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

@@ -10,6 +10,7 @@ build-parameters:
   before-all:
     - builder: custom
       commands:
+        - npm ci
         - npx cds build --production
 {{/isNodejs}}
 modules:

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

@@ -1,6 +1,7 @@
 const { join } = require('path')
 const cds = require('../../../cds')
 const { exists } = cds.utils
+const { bold } = require('../../../util/term')
 const { copyRenderedYAML } = require('../../../util/fs')
 const { readProject } = require('../../projectReader')
 const { merge, sort } = require('../../merge')
@@ -19,4 +20,8 @@ module.exports = class MtaTemplate extends require('../../plugin') {
         await merge(__dirname, 'files/package.json').into('package.json')
         await sort('package.json', 'devDependencies')
     }
+
+    async finalize() {
+        if (!exists('pom.xml')) console.log(`\nRun ${bold('npm update --package-lock-only')} to freeze dependencies.`)
+    }
 }

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

@@ -9,8 +9,7 @@
 		"esbenp.prettier-vscode",
 		"mechatroner.rainbow-csv",
 		"qwtel.sqlite-viewer",
-		"humao.rest-client",
-		"sdras.night-owl"
+		"humao.rest-client"
 	],
 	// List of extensions recommended by VS Code that should not be recommended for users of this workspace.
 	"unwantedRecommendations": [

package/lib/init/template/nodejs/files/README.md

@@ -15,7 +15,7 @@ File or Folder | Purpose
 
 ## Next Steps
 
-- Open a new terminal and run `cds watch` 
+- Open a new terminal and run `cds watch`
 - (in VS Code simply choose _**Terminal** > Run Task > cds watch_)
 - Start adding content, for example, a [db/schema.cds](db/schema.cds).
 

package/lib/init/template/sample/files/app/index.html

@@ -15,12 +15,14 @@
 	</script>
 
 	<script id="sap-ushell-bootstrap" src="https://sapui5.hana.ondemand.com/test-resources/sap/ushell/bootstrap/sandbox.js"></script>
-	<script id="sap-ui-bootstrap" src="https://sapui5.hana.ondemand.com/resources/sap-ui-core.js"
-			data-sap-ui-libs="sap.m, sap.ushell, sap.collaboration, sap.ui.layout"
-			data-sap-ui-compatVersion="edge"
-			data-sap-ui-theme="sap_horizon"
-			data-sap-ui-frameOptions="allow"
-	></script>
+    <script id="sap-ui-bootstrap" src="https://sapui5.hana.ondemand.com/resources/sap-ui-core.js"
+      data-sap-ui-libs="sap.m, sap.ushell, sap.collaboration, sap.ui.layout"
+      data-sap-ui-compatVersion="edge"
+      data-sap-ui-async="true"
+      data-sap-ui-preload="async"
+      data-sap-ui-theme="sap_horizon"
+      data-sap-ui-frameOptions="allow"
+    ></script>
 	<script>
 		sap.ui.getCore().attachInit(()=> sap.ushell.Container.createRenderer().placeAt("content"))
 	</script>

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

@@ -1,5 +1,5 @@
 const { join } = require('path')
-const cds = require('../../../cds'), { exists, copy } = cds.utils
+const cds = require('../../../cds'), { exists, read, write, copy } = cds.utils
 const { env4, readProject } = require('../../projectReader')
 
 module.exports = class SampleTemplate extends require('../../plugin') {
@@ -13,11 +13,21 @@ module.exports = class SampleTemplate extends require('../../plugin') {
     async run() {
         const { db, srv, app } = env4('production').folders
         const language = exists('pom.xml') ? 'java' : 'nodejs'
+
         await Promise.all([
           copy(join(__dirname, 'files', 'db')).to(db),
-          copy(join(__dirname, 'files', 'app')).to(app),
           copy(join(__dirname, 'files', 'srv')).to(srv),
           copy(join(__dirname, 'files', language)).to(srv)
         ])
+
+        await copy(join(__dirname, 'files', 'app')).to(app)
+        const { appName, appPath, appUIPaths } = readProject()
+
+        // manifest.json must be unique
+        await Promise.all(appUIPaths.map(async p => {
+            const manifest = await read(join(appPath, p, 'webapp/manifest.json'))
+            manifest['sap.app'].id = appName + '.' + p
+            await write(join(appPath, p, 'webapp/manifest.json'), manifest, { spaces: 2 })
+        }))
     }
 }

package/lib/util/cf.js

@@ -192,6 +192,7 @@ Deployment will stop in the near future for Cloud Foundry client versions < ${CF
     async getServices(app) {
         const { spaceGuid: space_guids, orgGuid: organization_guids } = await this.getCfSpaceInfo();
         const apps = await this._cfRequest('/v3/apps', { space_guids, organization_guids, names: app });
+        if (apps.resources.length < 1) throw `Cannot find app with name '${app}'`
         const guid = apps.resources[0].guid;
         const env = await this._cfRequest('/v3/apps/'+guid+'/env', { space_guids, organization_guids, names: app });
         return Object.values(env.system_env_json.VCAP_SERVICES).flat();