@sap/cds-dk 8.8.2 → 8.9.0

package/lib/build/plugins/helm/files/subcharts/web-application/values.schema.json

@@ -1283,6 +1283,56 @@
                     }
                 }
             }
+        },
+        "nodeSelector": {
+            "$id": "#/properties/nodeSelector",
+            "title": "Node selector",
+            "type": "object",
+            "patternProperties": {
+                "^[-._a-zA-Z][-._a-zA-Z0-9]*$": {
+                    "type": "string"
+                }
+            }
+        },
+        "nodeAffinity": {
+            "$id": "#/properties/nodeAffinity",
+            "title": "Node affinity",
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "requiredDuringSchedulingIgnoredDuringExecution": {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "properties": {
+                        "nodeSelectorTerms": {
+                            "type": "array",
+                            "description": "A node selector terms, associated with the corresponding weight.",
+                            "items": {
+                                "$ref": "#/definitions/NodeSelectorTerm"
+                            }
+                        }
+                    },
+                    "required": ["nodeSelectorTerms"]
+                },
+                "preferredDuringSchedulingIgnoredDuringExecution": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": false,
+                        "properties": {
+                            "weight": {
+                                "type": "integer",
+                                "description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100."
+                            },
+                            "preference": {
+                                "description": "A node selector term, associated with the corresponding weight.",
+                                "$ref": "#/definitions/NodeSelectorTerm"
+                            }
+                        },
+                        "required": ["weight", "preference"]
+                    }
+                }
+            }
         }
     },
     "definitions": {
@@ -1355,6 +1405,43 @@
             "type": "integer",
             "minimum": 1,
             "maximum": 65535
+        },
+        "NodeSelectorRequirement": {
+            "description": "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "key": {
+                    "description": "The label key that the selector applies to.",
+                    "type": "string"
+                },
+                "operator": {
+                    "description": "Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.",
+                    "type": "string",
+                    "enum": ["In", "NotIn", "Exists", "DoesNotExist", "Gt", "Lt"]
+                },
+                "values": {
+                    "description": "An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.",
+                    "items": {
+                        "type": "string"
+                    },
+                    "type": "array"
+                }
+            },
+            "required": ["key", "operator"]
+        },
+        "NodeSelectorTerm": {
+            "description": "A null or empty node selector term matches no objects. The requirements of them are ANDed.",
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "matchExpressions": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/NodeSelectorRequirement"
+                    }
+                }
+            }
         }
     }
 }

package/lib/build/plugins/helm/files/subcharts/web-application/values.yaml

@@ -14,7 +14,7 @@ global:
     _internal:
       web-application:
         versions:
-          1.23.0: true
+          1.24.0: true
 ## Will be used instead of the `.Chart.Name`, e.g. when generating the Deployment name.
 # nameOverride: name
 
@@ -331,3 +331,31 @@ hpa:
   ## See https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/horizontal-pod-autoscaler-v2/#HorizontalPodAutoscalerSpec
   # behavior: {}
   # metrics: {}
+## Node label selector. See https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector
+# nodeSelector:
+#   kubernetes.io/os: linux
+
+## Node Affinity configuration. See https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity
+# nodeAffinity:
+#   requiredDuringSchedulingIgnoredDuringExecution:
+#     nodeSelectorTerms:
+#     - matchExpressions:
+#       - key: kubernetes.io/os
+#         operator: In
+#         values:
+#         - linux
+#   preferredDuringSchedulingIgnoredDuringExecution:
+#   - weight: 1
+#     preference:
+#       matchExpressions:
+#       - key: label-1
+#         operator: In
+#         values:
+#         - key-1
+#   - weight: 50
+#     preference:
+#       matchExpressions:
+#       - key: label-2
+#         operator: In
+#         values:
+#         - key-2

package/lib/build/provider/internalBuildTaskProvider.js

@@ -171,7 +171,7 @@ class InternalBuildTaskProvider extends BuildTaskProvider {
                     }
                     throw new BuildError(`Invalid MTX sidecar configuration - profile 'mtx-sidecar' not set.`)
                 }
-                return { for: BUILD_TASK_MTX_SIDECAR }
+                return { src: MTX_SIDECAR_FOLDER, for: BUILD_TASK_MTX_SIDECAR }
             }
 
             if (sidecarEnv?.requires["cds.xt.ModelProviderService"]?._in_sidecar || sidecarEnv?.profiles?.includes('mtx-sidecar')) {

package/lib/build/provider/mtx-extension/index.js

@@ -54,6 +54,11 @@ class MtxExtensionBuildPlugin extends InternalBuildPlugin {
         // reclassify base model warnings as info messages
         extensionCompilation.reclassifyBaseModelMessages(this.messages, saasPkgPath)
 
+        // Throw error if messages contain errors
+        if (this.messages.some(msg => msg.severity === 'Error')) {
+            throw new BuildError('CDS compilation failed', this.messages);
+        }
+
         if (extensionModel) {
             // IMPORTANT NOTE: perform all model operations before the linter is called as the linter
             // will modify the model causing the creation of 'unresolved' associations

package/lib/deploy/to-hana/hana.js

@@ -47,7 +47,7 @@ Therefore, specifying the CDS model is not required when calling 'cds deploy'.`;
     }
 
     if (dry) {
-      console.log('-- running in dry mode ---');
+      console.log('--- running in dry mode ---');
     }
 
     if (vcapFile) {
@@ -91,60 +91,116 @@ Therefore, specifying the CDS model is not required when calling 'cds deploy'.`;
       // the primary database is always built and deployed
       const dest = path.join(cds.env.build.target, cds.env.folders.db);
 
-      let serviceName = pServiceName;
-      let serviceKeyName;
-      const { instance, key } = cds.requires.db?.binding ?? {};
-      if (!serviceName && instance) {
-        serviceName = instance;
-        serviceKeyName = key;
-      }
-
       if (undeployWhitelist) {
         console.log('Writing undeploy.json');
         await write(undeployWhitelist).to(dest, 'undeploy.json')
       }
 
       const hasVCAPEnv = Object.keys(vcapEnv).length > 0;
-      if (!serviceName && hasVCAPEnv) {
-        await mkdirp(dest);
-      } else {
-        const { cfServiceInstanceName, cfServiceInstanceKeyName, serviceKey } =
-          await this._getOrCreateCFService(dest, serviceName, serviceKeyName, tunnelAddress);
 
-        serviceName ??= cfServiceInstanceName;
-        serviceKeyName ??= cfServiceInstanceKeyName
-        if (!vcapEnv.VCAP_SERVICES || serviceName) {
-          vcapEnv.VCAP_SERVICES = this._getVCAPServicesEntry(cfServiceInstanceName, serviceKey);
-        }
+      let bindOptions
+      if (cds.cli.options.on === 'k8s') {
+        const cp = require('node:child_process')
+        const appName = pServiceName ?? path.basename(cds.root)
+        const instance =
+`apiVersion: services.cloud.sap.com/v1
+kind: ServiceInstance
+metadata:
+  name: ${appName}-db
+spec:
+  serviceOfferingName: hana
+  servicePlanName: hdi-shared\n`
+        const binding =
+`apiVersion: services.cloud.sap.com/v1
+kind: ServiceBinding
+metadata:
+  name: ${appName}-db-binding
+spec:
+  serviceInstanceName: ${appName}-db
+  secretName: ${appName}-db-secret
+\n`
 
-        if (storeCredentials) {
-          await this._addInstanceToDefaultEnvJson([dest, cds.root], cfServiceInstanceName, serviceKey);
+        try {
+          cp.execSync('kubectl apply -f -', { input: instance })
+          cp.execSync('kubectl apply -f -', { input: binding })
+          cp.execSync(`kubectl wait --for=condition=Ready servicebinding/${appName}-db-binding --timeout=120s`)
+          cp.execSync(`kubectl wait --for=condition=Ready serviceinstance/${appName}-db --timeout=120s`)
+        } catch (error) {
+          const descr = cp.execSync(`kubectl describe serviceinstance/${appName}-db`).toString()
+          const message = descr.match(/Message:\s+(.*)/)?.[1] || 'None'
+          throw error.message + `\nInstance Message: ${message}`
         }
-      }
-
-      console.log(`${bold('Starting deployment to SAP HANA ...')}`);
-      DEBUG?.({ dest, vcapEnv, hdiOptions })
-      await hdi.deploy(dest, vcapEnv, hdiOptions);
 
-      if (!hasVCAPEnv) {
-        const bindOptions = {
+        const { data: encoded } = JSON.parse(cp.execSync(`kubectl get secrets/${appName}-db-secret -o json`).toString())
+        const credentials = {}
+        for (const [key, value] of Object.entries(encoded)) {
+          credentials[key] = Buffer.from(value, 'base64').toString('utf-8');
+        }
+        vcapEnv.VCAP_SERVICES ??= {
+          hana: [{
+            tags: ['hana'],
+            credentials
+          }]
+        }
+        bindOptions = {
           ...options,
-          to: `${serviceName}:${serviceKeyName}`,
+          to: `${appName}-db-binding`,
           for: options.for,
           kind: BUILD_TASK_HANA
         }
-        const services = await bind(bindOptions);
-        await storeBindings(services, bindOptions);
+      } else {
+        let serviceName = pServiceName;
+        let serviceKeyName;
+        const { instance, key } = cds.requires.db?.binding ?? {};
+        if (!serviceName && instance) {
+          serviceName = instance;
+          serviceKeyName = key;
+        }
+
+        if (!serviceName && hasVCAPEnv) {
+          await mkdirp(dest);
+        } else {
+          const { cfServiceInstanceName, cfServiceInstanceKeyName, serviceKey } = await this._getOrCreateCFService(dest, serviceName, serviceKeyName, tunnelAddress);
+          serviceName ??= cfServiceInstanceName;
+          serviceKeyName ??= cfServiceInstanceKeyName
+          if (!vcapEnv.VCAP_SERVICES || serviceName) {
+            vcapEnv.VCAP_SERVICES = this._getVCAPServicesEntry(cfServiceInstanceName, serviceKey);
+          }
+
+          if (storeCredentials) {
+            await this._addInstanceToDefaultEnvJson([dest, cds.root], cfServiceInstanceName, serviceKey);
+          }
+          if (!hasVCAPEnv) {
+            bindOptions = {
+              ...options,
+              to: `${serviceName}:${serviceKeyName}`,
+              for: options.for,
+              kind: BUILD_TASK_HANA
+            }
+          }
+        }
       }
 
+      console.log(`${bold('starting deployment to SAP HANA ...')}`);
+      DEBUG?.({ dest, vcapEnv, hdiOptions })
+      await hdi.deploy(dest, vcapEnv, hdiOptions);
+
       if (storeCredentials) {
         await gitUtil.ensureFileIsGitignored('default-env.json', cds.root);
       }
 
-      console.log(`If not already done, use ${info('cds add hana')} to configure the project for SAP HANA.\n`);
+      if (!hasVCAPEnv) {
+        const services = await bind(bindOptions)
+        await storeBindings(services, bindOptions)
+      }
+
+      const { env4 } = require('../../init/projectReader')
+      if (env4('production').requires?.db?.kind !== 'hana') {
+        console.log(`use ${info('cds add hana')} to configure the project for SAP HANA.\n`);
+      }
     }
 
-    console.log(`Done.`);
+    console.log(`successfully finished deployment`);
 
     if (warnings.length > 0) {
       console.warn(warn('\nWARNING:'));
@@ -156,7 +212,6 @@ Therefore, specifying the CDS model is not required when calling 'cds deploy'.`;
 
 
   async _getOrCreateCFService(currentModelFolder, serviceName, serviceKeyName, tunnelAddress) {
-    const modelName = path.basename(currentModelFolder);
 
     // get from param
     let cfServiceInstanceMta;
@@ -164,13 +219,18 @@ Therefore, specifying the CDS model is not required when calling 'cds deploy'.`;
     if (serviceName) {
       cfServiceInstanceName = serviceName;
     } else {
+      const modelName = path.basename(currentModelFolder);
       const cfServiceDescriptor = await mtaUtil.getHanaDbModuleDescriptor(cds.root, modelName);
       cfServiceInstanceName = cfServiceDescriptor.hdiServiceName;
       cfServiceInstanceMta = cfServiceDescriptor.hdiService
     }
 
     console.log();
-    this._validateServiceInstanceName(cfServiceInstanceName);
+
+    // valid service name chars: alpha-numeric, hyphens, and underscores
+    if (/[^\w-_]+/g.exec(cfServiceInstanceName)) {
+      throw `Service name ${cfServiceInstanceName} must only contain alpha-numeric, hyphens, and underscores.`;
+    }
     console.log(`Using container ${bold(cfServiceInstanceName)}`);
 
     const cfConfig = cfServiceInstanceMta?.parameters?.config;
@@ -251,14 +311,6 @@ Therefore, specifying the CDS model is not required when calling 'cds deploy'.`;
   }
 
 
-  _validateServiceInstanceName(serviceInstanceName) {
-    // valid service name chars: alpha-numeric, hyphens, and underscores
-    if (/[^\w-_]+/g.exec(serviceInstanceName)) {
-      throw `Service name ${serviceInstanceName} must only contain alpha-numeric, hyphens, and underscores.`;
-    }
-  }
-
-
   _injectTunnelAddress(credentials, tunnelAddress) {
     if (!/\w+:\d+/.test(tunnelAddress)) {
       throw `Invalid tunnel address '${tunnelAddress}' - must be in form 'host:port'`;

package/lib/deploy/to-hana/mtaUtil.js

@@ -153,6 +153,5 @@ function _findHdiResource(mta, moduleName) {
 }
 
 module.exports = {
-    getHanaDbModuleDescriptor,
-    MTA_YAML
+    getHanaDbModuleDescriptor
 }

package/lib/env/schema.js

@@ -1,69 +1,3 @@
-
-function _local(id) {
-    return require.resolve(id, {
-        paths: [
-            process.cwd(), // project-local module is preferred
-            __dirname      // otherwise from our own dependencies
-        ]
-    })
-}
-
-function _robustRequire(file) {
-    const fs = require('fs')
-    const path = require('path')
-
-    file = path.normalize(file)
-    let content
-    try {
-        content = fs.readFileSync(file, 'utf8')
-    } catch (e) {
-        // file is not readable -> nothing to do
-        return
-    }
-
-    try {
-        return JSON.parse(content)
-    } catch (e) {
-        // invalid json -> ignore and try regex
-    }
-
-    const result = {}
-    try {
-        const deps = JSON.parse(content.match(/"dependencies"\s*:\s*({[^}]*})/)[1])
-        result.dependencies = deps
-    } catch (e) { /* ignore */ }
-
-    try {
-        const devDeps = JSON.parse(content.match(/"devDependencies"\s*:\s*({[^}]*})/)[1])
-        result.devDependencies = devDeps
-    } catch (e) { /* ignore */ }
-
-    return result
-}
-
-_robustRequire.resolve = function (id, options = {}) {
-    const fs = require('fs')
-    const path = require('path')
-
-    try {
-        return require.resolve(id, options)
-    } catch (err) {
-        // ignore
-    }
-
-    const [, mod, file] = /(.+)\/([^/]+)$/.exec(id)
-    let modPath = path.join(process.cwd(), 'node_modules', mod, file)
-    const ext = path.extname(modPath)
-    if (!ext) {
-        modPath = modPath + '.js'
-    }
-    if (fs.existsSync(modPath)) {
-        return modPath
-    }
-
-    throw new Error('not found')
-}
-
 function mergePluginSchema(pluginSchema) {
     // contribution points also appear in schema file ./schemas/cds-rc.js
     return {
@@ -140,36 +74,26 @@ module.exports = async function overlay4(schemaName) {
     }
 
     try {
-        const pluginsLib = require(_local('@sap/cds/lib/plugins.js'))
-        if (pluginsLib) {
-            const oldRequire = pluginsLib.require
-            try {
-                pluginsLib.require = _robustRequire
-                const plugins = pluginsLib.fetch?.()
-                if (plugins) {
-                    for (const [key, { impl, packageJson }] of Object.entries(plugins)) {
-                        const pluginPackageJsonFile = packageJson || path.join(path.dirname(impl), 'package.json')
-                        try {
-                            const pluginPackageJson = require(pluginPackageJsonFile)
-                            if (pluginPackageJson.cds?.schema) {
-                                await mergePluginSchema(pluginPackageJson.cds.schema).into(result);
-                            }
-                        } catch (err) {
-                            if (err.code !== 'ENOENT') {
-                                console.error(`Error loading schema from plugin ${key}: ${err.message}`)
-                            }
-                        }
+        const plugins = await cds.plugins;
+        if (plugins) {
+            for (const [key, { impl }] of Object.entries(plugins)) {
+                const pluginPackageJsonFile = path.join(path.dirname(impl), 'package.json')
+                try {
+                    const pluginPackageJson = require(pluginPackageJsonFile)
+                    if (pluginPackageJson.cds?.schema) {
+                        await mergePluginSchema(pluginPackageJson.cds.schema).into(result);
+                    }
+                } catch (err) {
+                    if (err.code !== 'ENOENT') {
+                        console.error(`Error loading schema from plugin ${key}: ${err.message}`)
                     }
                 }
-            } finally {
-                pluginsLib.require = oldRequire
             }
         }
     } catch (err) {
         console.error(err.message)
     }
 
-
     result.title = oldTitle
     result.description = oldDescription
     return result

package/lib/import/common.js

@@ -282,15 +282,14 @@ async function _generateChecksumValidate(dest, output, force) {
     return "/* checksum : " + currentChecksum + " */\n" + output;
 }
 
-// Modify the output to replace the using statements with the dependency services
-function _replaceUsingStatementsForDependent(output) {
-    let using = usingStatements.join('\n');
+// Modify the output to add using statements with the dependency services
+function _addUsingStatementsForDependent(output) {
+    if (usingStatements.length === 0)
+        return output;
+
+    let usings = usingStatements.join('\n') + '\n';
     usingStatements = [];
-    let startIndex = output.indexOf('using');
-    let endIndex = output.indexOf(';', startIndex);
-    let usingStatement = output.substring(startIndex, endIndex+1);
-    output = output.replace(usingStatement, using);
-    return output;
+    return usings + output;
 }
 
 async function _getResult(output, as, dest, force, kind, isDependent) {
@@ -308,11 +307,11 @@ async function _getResult(output, as, dest, force, kind, isDependent) {
         dest += '.' + extension;
     }
 
-    if (as && as != "csn" && as != "json") {
+    if (as && as !== "csn" && as !== "json") {
         // cdsCompiler[as] will convert the csn output into various output formats
         output = cdsCompiler[as](output);
         if (isDependent && kind === 'V4') {
-            output = _replaceUsingStatementsForDependent(output);
+            output = _addUsingStatementsForDependent(output);
         }
     }
 
@@ -400,6 +399,17 @@ async function _updateNodeConfig(dest, services, kind, cwd, options) {
         }
     }
 
+    if (kind.startsWith('odata')) {
+        pkgConf.dependencies ??= {};
+        const { dependencies } = require('./odata.package.json');
+        for (const dep in dependencies) {
+            if (!pkgConf.dependencies?.[dep]) {
+                pkgConf.dependencies[dep] = dependencies[dep];
+                package_json_updated = true;
+            }
+        }
+    }
+
     if (package_json_updated) {
         await write(package_json, JSON.stringify(pkgConf, null, '  '));
         console.log(`[cds] - updated ./package.json`);
@@ -495,11 +505,9 @@ async function postProcess(filePath, options, csn, cwd) {
         await write(csnFile, serviceCsn, "utf-8");
 
     if (options.isDependency) {
-        if (services.length > 1){
-            usingStatements.push(`using { ${services.join(', ')}} from './${path.basename(csnFile)}';`);
-        } else {
-            usingStatements.push(`using { ${services} } from './${path.basename(csnFile)}';`);
-        }
+        // `cdsc.to.cdl() adds `using { foo.bar }` on-demand.  We only need to include correct path.
+        // TODO: Should be part of `csn.requires`, and let ´to.cdl()` render them.
+        usingStatements.push(`using from './${path.basename(csnFile.replace(`'`, `''`))}';`);
     }
 
     _printUsageHint(csnFile, services, cwd);

package/lib/import/odata.package.json

@@ -0,0 +1,7 @@
+{
+  "dependencies": {
+    "@sap-cloud-sdk/connectivity": "^3",
+    "@sap-cloud-sdk/http-client": "^3",
+    "@sap-cloud-sdk/resilience": "^3"
+  }
+}

package/lib/init/constants.js

@@ -5,7 +5,7 @@ module.exports = {
     COMMAND_ADD: 'add',
 
     JAVA_LTS_VERSIONS: [17, 21],
-    MAVEN_ARCHETYPE_VERSION: '3.8.0',
+    MAVEN_ARCHETYPE_VERSION: '3.8.1',
 
     OPTIONS: Object.freeze({
         COMPLETION: 'completion',
@@ -16,6 +16,7 @@ module.exports = {
         ESM: 'esm',
         TYPER: 'typer',
         TYPESCRIPT: 'typescript',  // must run before SAMPLE, as that influences whether .js or .ts files are created
+        EXTENSION: 'extension',
         SAMPLES: 'samples', // deprecated
         TINY_SAMPLE: 'tiny-sample',
         SAMPLE: 'sample',