@sap/cds-dk 8.7.3 → 8.8.1

package/lib/init/projectReader.js

@@ -125,7 +125,9 @@ module.exports = new class ProjectReader {
         const _uiEmbedded = () => exists(join(env.folders.app, 'xs-app.json'))
         const _uiModule = () => !_uiEmbedded() && isdir(env.folders.app) && fs.readdirSync(resolve(cds.root, env.folders.app)).length > 0
         const _isJava = () => this.isJava
-        const isApp = name => name !== 'appconfig' && !name.startsWith('_') && name !== 'router' && name !== 'portal'
+        const isApp = name => {
+            return name !== 'appconfig' && !name.startsWith('_') && name !== 'router' && name !== 'portal' && name !== 'workzone'
+        }
         const reserved = {
             dependencies: () => pkgJson().dependencies,
             has: x => _inProd(x),
@@ -152,7 +154,9 @@ module.exports = new class ProjectReader {
             },
             configFile: () => _isJava() ? '.cdsrc.json' : 'package.json',
             apps: () => {
-                const apps = fs.readdirSync(path.resolve(cds.root, cds.env.folders.app)).filter(e =>
+                const appPath = path.resolve(cds.root, cds.env.folders.app)
+                if (!exists(appPath)) return []
+                const apps = fs.readdirSync(appPath).filter(e =>
                     isdir(path.join(cds.root, cds.env.folders.app, e)) && isApp(e)
                 )
                 return apps.map((app, i) => {
@@ -164,14 +168,18 @@ module.exports = new class ProjectReader {
                     return { app, strippedApp: app.replace(/-/g, ''), vizId, isNotLast: i < apps.length - 1, manifestAppId: manifest?.['sap.app']?.id ?? app}
                 })
             },
-            appUIPaths: () => (fs.readdirSync(path.resolve(cds.root, cds.env.folders.app))).filter(e =>
-                isdir(join(cds.root, cds.env.folders.app, e)) && isApp(e)
-            ),
+            appUIPaths: () => {
+                const appPath = path.resolve(cds.root, cds.env.folders.app)
+                if (!exists(appPath)) return []
+                return fs.readdirSync(appPath).filter(e =>
+                    isdir(path.join(cds.root, cds.env.folders.app, e)) && isApp(e)
+                )
+            },
             hasIndexHtml: () => {},
             appPath: () => env.folders.app,
             appVersion: () => appVersion,
             jdkVersion: () => jdkVersion,
-            approuterPath: () => _uiEmbedded() ? join(env.folders.app) : join(env.folders.app, 'router'),
+            approuterPath: () => (_uiEmbedded() ? join(env.folders.app) : join(env.folders.app, 'router')).replace(/\\/g, '/'),
             appName: () => appName,
             cleanedAppName: () => appName.replaceAll('_', '-'),
             strippedAppName: () => appName.replace(/-/g, ''),
@@ -210,7 +218,7 @@ module.exports = new class ProjectReader {
 
 /**
  * Finds and reads SpringBoot configuration in `cds.root/srv` dir.
- * This is done in a best-effort way. In no way can we replciate all of SpringBoot's
+ * This is done in a best-effort way. In no way can we replicate all of SpringBoot's
  * config variants.
  * @param {string[]?} roots array of directories to search for application.yaml, like `srv`
  * @returns {Promise<object[]>} array of objects with `cds` property

package/lib/init/registries/mta.js

@@ -12,9 +12,14 @@ const approuter = { in: 'modules', where: { type: 'approuter.nodejs' } }
 
 const xsuaa = {
     in: 'resources',
-    where: { type: 'org.cloudfoundry.managed-service', 'parameters.service': 'xsuaa' }
+    where: { type: 'org.cloudfoundry.managed-service', 'parameters.service': 'xsuaa', 'parameters.service-plan': 'application' }
 }
 
+const xsuaa4 = plan => ({
+    in: 'resources',
+    where: { type: 'org.cloudfoundry.managed-service', 'parameters.service': 'xsuaa', 'parameters.service-plan': plan }
+})
+
 const destination = {
     in: 'resources',
     where: { type: 'org.cloudfoundry.managed-service', 'parameters.service': 'destination' }
@@ -194,6 +199,7 @@ module.exports = {
     srv4,
     approuter,
     xsuaa,
+    xsuaa4,
     destination,
     destinations,
     destinationSideBySideExtensibility,

package/lib/init/template/approuter/files/package.json

@@ -1,7 +1,7 @@
 {
   "name": "approuter",
   "dependencies": {
-    "@sap/approuter": "^18.0.0"
+    "@sap/approuter": "^19.0.0"
   },
   "engines": {
     "node": "^20"

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

@@ -17,17 +17,6 @@
       "authenticationType": "none"
     },
     {{/hasMTXRouteJava}}
-    {
-      "source": "^/app/(.*)$",
-      "target": "$1",
-      "localDir": ".",
-      "cacheControl": "no-cache, no-store, must-revalidate"
-    },
-    {
-      "source": "^/appconfig/",
-      "localDir": ".",
-      "cacheControl": "no-cache, no-store, must-revalidate"
-    },
     {
       "source": "^/(.*)$",
       "target": "$1",

package/lib/init/template/cloud-logging/files/package.json.hbs

@@ -1,7 +1,18 @@
 {
+  "dependencies": {
+    "@cap-js/telemetry": ">=0",
+    "@grpc/grpc-js": "^1",
+    "@opentelemetry/exporter-trace-otlp-grpc": "^0",
+    "@opentelemetry/exporter-metrics-otlp-grpc": "^0",
+    "@opentelemetry/host-metrics": "^0"
+  },
   "cds": {
     "requires": {
-      "cloud-logging": true
+      "[{{profile}}]": {
+        "telemetry": {
+          "kind": "to-cloud-logging"
+        }
+      }
     }
   }
 }

package/lib/init/template/cloud-logging/files/values.yaml.hbs

@@ -12,5 +12,3 @@ cloud-logging:
   parameters:
     ingest_otlp:
         enabled: true
-
-

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

@@ -7,14 +7,14 @@ const { srv4, mtxSidecar4, approuter } = require('../../registries/mta')
 module.exports = class extends require('../../plugin') {
 
   static hasInProduction(env) {
-    return env.requires?.['cloud-logging'];
+    return env.requires?.telemetry?.kind === 'to-cloud-logging'
   }
 
   options() {
     return {
       'plan': {
         type: 'string',
-        help: `Override the service plan used for the MTA generation.`,
+        help: 'Specify the service plan.',
       },
       'with-telemetry': {
         type: 'boolean',
@@ -23,19 +23,13 @@ module.exports = class extends require('../../plugin') {
     }
   }
 
-  async canRun() {
-    return true
-  }
-
-  requires() {
-    const project = readProject(), { hasTelemetry } = project
-    if ((cds.cli.options['with-telemetry'] || hasTelemetry)) return ['telemetry']
-  }
-
   async run() {
-    const project = readProject();
-    await merge(__dirname, 'files/package.json.hbs').into('package.json', { with: project })
-    await sort('package.json', 'dependencies')
+    const project = readProject(), { hasTelemetry, isNodejs } = project
+    if (isNodejs && (cds.cli.options['with-telemetry'] || hasTelemetry)) {
+      project.profile ??= 'production'
+      await merge(__dirname, 'files/package.json.hbs').into('package.json', { with: project })
+      await sort('package.json', 'dependencies')
+    }
   }
 
   async combine() {
@@ -82,4 +76,3 @@ module.exports = class extends require('../../plugin') {
     }
   }
 }
-

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

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

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

@@ -27,7 +27,7 @@ module.exports = class DestinationTemplate extends require('../../plugin') {
         const { hasHelm, hasApprouter, hasMultitenancy, hasHelmUnifiedRuntime, hasMta, srvPath, isJava } = project
 
         if (hasMultitenancy) {
-            await merge(__dirname, 'files/package.sidecar.json').into('mtx/sidecar/package.json')
+            await merge({ cds: { requires: { destinations:true } } }).into('mtx/sidecar/package.json')
         }
 
         if (hasMta) {

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

@@ -8,13 +8,11 @@
     "start": "ui5 serve"
   },
   "devDependencies": {
-    {{#hasWorkzoneStandard}}"@sap/ui5-builder-webide-extension": "^1.1.9",{{/hasWorkzoneStandard}}
     "@ui5/cli": "^4",
     "ui5-task-zipper": "^3"
   },
   "ui5": {
     "dependencies": [
-      {{#hasWorkzoneStandard}}"@sap/ui5-builder-webide-extension",{{/hasWorkzoneStandard}}
       "ui5-task-zipper"
     ]
   }

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

@@ -0,0 +1,25 @@
+---
+before-all:
+{{#hasUI5}}
+  - mkdir -p ui-resources/resources
+{{#apps}}
+  - npm i --prefix app/{{app}}
+  - npm run build --prefix app/{{app}}
+  # zip filename should match the archiveName specified in ui5-deploy.yaml
+  - cp -f app/{{app}}/dist/{{app}}.zip ui-resources/resources/{{app}}.zip
+{{/apps}}
+{{/hasUI5}}
+modules:
+  - name: {{appName}}-html5-deployer
+    build-parameters:
+      buildpack:
+        {{#hasHelmUnifiedRuntime}}
+        builder: proxy-unified-runtime-dmz.int.repositories.cloud.sap/builder/noble
+        {{/hasHelmUnifiedRuntime}}
+        {{^hasHelmUnifiedRuntime}}
+        type: nodejs
+        builder: builder-jammy-base
+        {{/hasHelmUnifiedRuntime}}
+        path: ui-resources
+        env:
+          BP_NODE_RUN_SCRIPTS: ""

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

@@ -16,6 +16,7 @@ modules:
     type: nodejs
     path: {{#isNodejs}}gen/{{/isNodejs}}mtx/sidecar
     requires:
+      - name: {{appName}}-html5-repo-host
       - name: {{appName}}-html5-runtime
 
   - name: {{appName}}-app-deployer
@@ -49,13 +50,11 @@ modules:
   {{/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

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

@@ -6,7 +6,7 @@
       {{#profile}}
       "[{{profile}}]": {
       {{/profile}}
-        "html5-repo": true
+        "html5-runtime": true
       {{#profile}}
       }
       {{/profile}}

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

@@ -0,0 +1,11 @@
+{
+    "name": "{{appName}}",
+    "version": "{{appVersion}}",
+    "description": "{{appDescription}}",
+    "scripts": {
+        "start": "node node_modules/@sap/html5-app-deployer/index.js"
+    },
+    "dependencies": {
+        "@sap/html5-app-deployer": "^7.0.0"
+    }
+}

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

@@ -13,16 +13,13 @@ builder:
       - "/test/**"
       - "/localService/**"
   customTasks:
-    {{#hasWorkzoneStandard}}
-    - name: webide-extension-task-updateManifestJson
-      afterTask: replaceVersion
-      configuration:
-        appFolder: webapp
-        destDir: dist
-    {{/hasWorkzoneStandard}}
     - name: ui5-task-zipper
       afterTask: generateVersionInfo
       configuration:
         archiveName: {{app}}
         additionalFiles:
           - xs-app.json
+    {{#isTypescript}}
+    - name: ui5-tooling-transpile-task
+      afterTask: replaceVersion
+    {{/isTypescript}}

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

@@ -4,9 +4,9 @@ html5-apps-repo-host:
   servicePlanName: app-host
 html5-apps-deployer:
   env:
-    SAP_CLOUD_SERVICE: null
+    SAP_CLOUD_SERVICE: {{strippedAppName}}.service
   image:
-    repository: "{{appName}}-html5-deployer"
+    repository: {{appName}}-html5-deployer
   bindings:
     xsuaa:
       serviceInstanceName: xsuaa
@@ -26,7 +26,9 @@ html5-apps-deployer:
     - configMapRef:
         name: "{{ .Release.Name }}-html5-apps-deployer-configmap"
 <%={{ }}=%>
-backendDestinations: {}
+backendDestinations: 
+  srv-api:
+    service: srv
 destination:
   parameters:
     HTML5Runtime_enabled: true
@@ -37,5 +39,5 @@ html5-apps-repo-runtime:
 approuter:
   bindings:
     html5-apps-repo-runtime:
-      serviceInstanceName: 'html5-apps-repo-runtime'
+      serviceInstanceName: html5-apps-repo-runtime
 {{/hasApprouter}}

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

@@ -4,6 +4,7 @@ const { merge } = require('../../merge')
 const { srv4, html5RepoHost, html5Runtime, appDeployer, approuter, mtxSidecar4 } = require('../../registries/mta')
 const { odataApi } = require('../../registries/xs-app')
 const { exists } = require('../../../cds').utils
+const { renderAndCopy } = require('../../template')
 
 module.exports = class Html5RepoTemplate extends require('../../plugin') {
 
@@ -17,7 +18,7 @@ module.exports = class Html5RepoTemplate extends require('../../plugin') {
     }
 
     static hasInProduction(env) {
-        return !!env.requires['html5-repo']
+        return !!env.requires['html5-repo'] || !!env.requires['html5-runtime'] || !!env.requires['html5-host']
     }
 
     async run() {
@@ -44,15 +45,15 @@ module.exports = class Html5RepoTemplate extends require('../../plugin') {
         // app deployer requires a manifest.json
         await Promise.all(appUIPaths.map(p =>
             merge(__dirname, 'files/manifest.json')
-              .into(join(appPath, p, 'webapp/manifest.json'), { project })
+                .into(join(appPath, p, 'webapp/manifest.json'), { project })
         ))
     }
 
     async combine() {
         const project = readProject()
-        const { isJava, srvPath, appPath, hasMta, hasMultitenancy, hasHelm, hasHelmUnifiedRuntime, hasApprouter, apps } = project
+        const { isJava, srvPath, appPath, hasMta, hasMultitenancy, hasWorkzoneStandard, hasHelm, hasHelmUnifiedRuntime, hasApprouter, hasContainerize, apps } = project
 
-        await Promise.all(apps.map(async ({app}) => {
+        await Promise.all(apps.map(async ({ app }) => {
             project.app = app
             project.hasIndexHtml = exists(join(appPath, app, 'webapp/index.html'))
             const additions = [odataApi]
@@ -60,13 +61,13 @@ module.exports = class Html5RepoTemplate extends require('../../plugin') {
         }))
 
         if (hasMultitenancy) {
-            await merge(__dirname, 'files/package.sidecar.json').into('mtx/sidecar/package.json')
-          }
+            await merge({ cds: { requires: { 'html5-runtime':true } } }).into('mtx/sidecar/package.json')
+        }
 
         if (hasMta) {
             const srv = srv4(srvPath)
             project.apps = apps
-            const appModules = project.apps.map(app => ( {
+            const appModules = project.apps.map(app => ({
                 in: 'modules',
                 where: { type: 'html5', path: `${appPath}${app.app}` }
             }))
@@ -75,8 +76,11 @@ module.exports = class Html5RepoTemplate extends require('../../plugin') {
                 insert: [html5RepoHost, 'name'],
                 into: [appDeployer, 'requires', 'name'],
             }]
+            if (hasApprouter || hasWorkzoneStandard) {
+                additions.push(html5Runtime)
+            }
             if (hasApprouter) {
-                additions.push(approuter, html5Runtime)
+                additions.push(approuter)
                 relationships.push({
                     insert: [html5Runtime, 'name'],
                     into: [approuter, 'requires', 'name'],
@@ -88,13 +92,21 @@ module.exports = class Html5RepoTemplate extends require('../../plugin') {
                     into: [mtxSidecar4(isJava ? 'mtx/sidecar' : 'gen/mtx/sidecar'), 'requires', 'name']
                 })
             }
-            await merge(__dirname, 'files/mta.yaml.hbs').into('mta.yaml', { with: project,
+            await merge(__dirname, 'files/mta.yaml.hbs').into('mta.yaml', {
+                with: project,
                 additions,
                 relationships
             })
         }
-
+        if (hasContainerize) {
+            const additions = [{
+                in: 'modules',
+                where: { name: `${project.appName}-html5-deployer` }
+            }]
+            await merge(__dirname, '/files/containerize.yaml.hbs').into('containerize.yaml', { with: project, additions })
+        }
         if (hasHelm || hasHelmUnifiedRuntime) {
+            await renderAndCopy(join(__dirname, 'files/ui-resources'), 'ui-resources', project)
             await merge(__dirname, 'files/values.yaml.hbs').into('chart/values.yaml', { with: project })
         }
     }

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

@@ -223,7 +223,7 @@ module.exports = class HttpTemplate extends require('../../plugin') {
     if (!this.approuterAuth) {
       const app = cds.cli.options['for-app']
       // Later: differentiate between CF and Kyma
-      const env = await cf.getEnv(app)
+      const env = await cf.env(app)
       if (!cds.cli.options.dry)   console.error('Fetching credentials from Cloud Foundry app \'' + app + '\'...')
       const hostname = `https://${env.application_env_json.VCAP_APPLICATION.application_uris[0]}`
       const { xsuaa, identity } = env.system_env_json.VCAP_SERVICES ?? {}

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

@@ -7,6 +7,7 @@ const io = require("../../../lint/io");
 const readline = require("readline");
 const { renderAndCopy } = require('../../template')
 const { LINT_DEV, LINT_GLOBAL } = require("../../constants").OPTIONS;
+const { COMMAND_INIT } = require("../../constants");
 const cds = require("../../../cds");
 const { mkdirp, exists } = cds.utils;
 const IS_WIN = os.platform() === "win32";
@@ -101,6 +102,11 @@ module.exports = class LintTemplate extends require('../../plugin') {
           "names"
         ].join(" ")}`;
 
+        if (cds.cli.command === COMMAND_INIT) {
+          this._runTask(task + ' --package-lock-only');
+          return;
+        }
+
         if (cds.cli.options.force) {
           console.log(
             `\n\nAlmost done - installing ${this.missingNpmDependencies["names"].length} npm dependencies:\n${task}`
@@ -118,11 +124,11 @@ module.exports = class LintTemplate extends require('../../plugin') {
               console.log("\n");
             }
           });
+
           await this._promptInstallDependencies(task);
         }
       }
     }
-
   }
 
   _checkEslint() {

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

@@ -48,7 +48,6 @@ modules:
       []
 
 resources:
-  {{#hasXsuaa}}
   - name: {{appName}}-registry
     type: org.cloudfoundry.managed-service
     requires:
@@ -80,7 +79,6 @@ resources:
           onUnSubscriptionAsync: true
           onUpdateDependenciesAsync: true
           callbackTimeoutMillis: 300000 # Increase if your deployments are taking longer than that
-  {{/hasXsuaa}}
 
   {{#hasIas}}
   - name: {{appName}}-sms

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

@@ -35,7 +35,7 @@ module.exports = class MultitenancyTemplate extends require('../../plugin') {
       await mvn.add('mtx')
     }
     if (isNodejs) await sort('package.json', 'dependencies')
-    await copyRenderedJSON(join(__dirname, 'files', 'package.sidecar.json.hbs'), join('mtx', 'sidecar', 'package.json'), project)
+    await copyRenderedJSON(join(__dirname, 'files', 'package.sidecar.json.hbs'), join('mtx', 'sidecar/package.json'), project)
   }
 
   async combine() {

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

@@ -17,6 +17,10 @@ modules:
     requires:
       - name: {{appName}}-portal
 
+  - name: {{appName}}-app-deployer
+    type: com.sap.application.content
+    path: {{#isNodejs}}gen{{/isNodejs}}{{#isJava}}.{{/isJava}}
+
   - name: {{appName}}-portal-deployer
     type: com.sap.application.content
     path: app/portal
@@ -46,6 +50,11 @@ resources:
       service: portal
       service-plan: standard
 
+  - name: {{appName}}-auth
+    type: org.cloudfoundry.managed-service
+    parameters:
+      service: xsuaa
+
   - name: {{appName}}-destination
     type: org.cloudfoundry.managed-service
     parameters:

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

@@ -37,7 +37,7 @@ module.exports = class PortalTemplate extends require('../../plugin') {
 
     if (hasMta) {
       const srv = srv4(srvPath)
-      const additions = [srv, portal, portalDeployer]
+      const additions = [srv, portal, appDeployer, portalDeployer]
       const relationships = [{
         insert: [portal, 'name'],
         into: [portalDeployer, 'requires', 'name']
@@ -47,12 +47,14 @@ module.exports = class PortalTemplate extends require('../../plugin') {
       }]
 
       if (hasXsuaa) {
+        additions.push(xsuaa)
         relationships.push({
           insert: [xsuaa, 'name'],
           into: [portalDeployer, 'requires', 'name']
         })
       }
       if (hasHtml5Repo) {
+        additions.push(html5RepoHost)
         relationships.push({
           insert: [html5RepoHost, 'name'],
           into: [portalDeployer, 'requires', 'name']