@sap/cds 6.0.1 → 6.0.2

package/CHANGELOG.md

@@ -4,6 +4,13 @@
 - The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - This project adheres to [Semantic Versioning](http://semver.org/).
 
+## Version 6.0.2 - 2022-07-06
+
+### Fixed
+
+- Jest tests do not fail any longer because of logs during app shutdown
+- `cds build` now uses correct `mtx/sidecar` context. This avoids redundant `cds-mtxs` npm dependency for Java projects.  
+
 ## Version 6.0.1 - 2022-07-05
 
 ### Added

package/bin/build/provider/mtx-sidecar/index.js

@@ -5,6 +5,7 @@ const BuildTaskHandlerInternal = require('../buildTaskHandlerInternal')
 const NodeCfModuleBuilder = require('../nodejs')
 const ResourcesTarProvider = require('../mtx/resourcesTarBuilder')
 const { INFO } = require('../buildTaskHandlerInternal')
+const { relativePaths } = require('@sap/cds/bin/build/util')
 
 const DEFAULT_MAIN_FOLDER = "_main"
 
@@ -20,47 +21,50 @@ class MtxSidecarModuleBuilder extends NodeCfModuleBuilder {
         }
     }
 
+    /**
+     * Builds the mtx sidecar app consisting of:
+     * - nodejs app model defined by the required sidecar services
+     * - main app model defined by the build task's model options including feature models and resources TAR
+     * 
+     * build.target=".": 'dest' -> 'model-provider/gen'
+     * build.target="gen": 'dest' -> 'gen/model-provider'
+     */
     async build() {
-        // Sidecar scenario: model-provider is implemented as separate Nodejs app.
-        // Create resources TAR AND and compiled CSN(s) for the sidecar app.
-        // build.target=".": 'dest' -> 'model-provider/gen'
-        // build.target="gen": 'dest' -> 'gen/model-provider'
+        // nodejs app parts have to be built using sidecar env
         const sidecarEnv = this.env.for("cds", this.task.src)
-
-        // 1. build node application
-        await this._buildNodeApp(sidecarEnv)
-
-        // 2. build main application
+        // build main application
         await this._buildMainApp(sidecarEnv)
+        // build node application
+        await this._buildNodeApp(sidecarEnv)
     }
 
+    /**
+     * Builds the mtx sidecar nodejs app parts.
+     * @param {object} sidecarEnv cds env based on the sidecar dir
+     */
     async _buildNodeApp(sidecarEnv) {
-        const sources = []
-        for (const name in sidecarEnv.requires) {
-            const service = sidecarEnv.requires[name]
-            if (service.model) {
-                sources.push(service.model)
-            }
-        }
-        const model = await this.cds.load(sources, this.options)
         const destSidecar = this.task.dest
         const destSidecarSrc = path.join(destSidecar, this.env.folders.srv)
-
+        const model = this._compileSidecarSync(sidecarEnv)
         await this.compileToJson(model, destSidecarSrc)
         await this.collectLanguageBundles(model, destSidecarSrc)
         await this._copyProjectRootContent(this.task.src, destSidecar)
     }
 
+    /**
+     * Builds the main app parts containing base model CSN with feature CSNs and resources TAR.
+     * @param {object} sidecarEnv cds env based on the sidecar dir
+     */
     async _buildMainApp(sidecarEnv) {
         let main = sidecarEnv.requires['cds.xt.ModelProviderService']?.root
         if (!main) {
-            throw new Error("Invalid sidecar configuration - model-provider.root configuration missing")
+            throw new Error("Invalid sidecar configuration - {\"model-provider\": \"in-sidecar\"} configuration missing")
         }
         const profiles = this.env.get("profiles") || []
         if (!profiles.includes("production") && !profiles.includes("prod")) {
             main = DEFAULT_MAIN_FOLDER
             // root should represent the production use case and not development
-            this.pushMessage(`Sidecar main application build results are created in folder '${main}'. Use the 'production' profile if the folder is configured differently.`, INFO)
+            this.pushMessage(`Sidecar main application build results are created in folder '${main}'. Enable the 'production' or 'prod' profile if the folder is configured differently.`, INFO)
         }
         const destRoot = this.task.dest
         const destMain = path.join(destRoot, main)
@@ -76,5 +80,31 @@ class MtxSidecarModuleBuilder extends NodeCfModuleBuilder {
         // resources are determined based on available database build task, SQLite as fallback
         await new ResourcesTarProvider(this).writeTar(destMain, csn)
     }
+
+    /**
+     * Synchronous compilation using the sidecar context.
+     * @param {object} sidecarEnv cds env based on the sidecar dir
+     * @returns the compiled mtx sidecar CSN
+     */
+    _compileSidecarSync(sidecarEnv) {
+        const env = this.env
+        try {
+            this.cds.root = this.task.src
+            this.cds.env = sidecarEnv
+            let modelPaths = this.cds.resolve('*', false)
+            modelPaths = this.cds.resolve(modelPaths)
+            if (!modelPaths || modelPaths.length === 0) {
+                throw new Error("No model found for MTX sidecar app")
+            }
+            this._logger._debug && this._logger.debug(`sidecar model: ${relativePaths(this.buildOptions.root, modelPaths).join(", ")}`)
+
+            // synchronous compilation
+            return this.cds.load(modelPaths, { sync: true, ...this.options() })
+        } finally {
+            // restore project scope
+            this.cds.root = this.buildOptions.root
+            this.cds.env = env
+        }
+    }
 }
 module.exports = MtxSidecarModuleBuilder

package/bin/serve.js

@@ -203,7 +203,7 @@ async function serve (all=[], o={}) { // NOSONAR
     const shutdown = async sig => {
       if (shutdownCalled)  return
       shutdownCalled = true
-      global.jest || cds.watched || console.log()  // blank line makes the ^C look pretty in terminals
+      global.it || cds.watched || console.log()  // blank line makes the ^C look pretty in terminals
       debug && debug(`${sig}, shutting down, calling ${cds.listeners('shutdown').length} listeners`)
       await Promise.all(cds.listeners('shutdown').map((fn) => fn()))
       if (process.env.NODE_ENV !== 'test' && !global.it)  process.exit()

package/lib/env/requires.js

@@ -193,6 +193,7 @@ const _mtx_services = {
   },
   "cds.xt.SaasProvisioningService": {
     model: "@sap/cds-mtxs/srv/cf/saas-provisioning-service",
+    kind: "saas-registry",
   },
   "cds.xt.DeploymentService": {
     model: "@sap/cds-mtxs/srv/deployment-service",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/cds",
-  "version": "6.0.1",
+  "version": "6.0.2",
   "description": "SAP Cloud Application Programming Model - CDS for Node.js",
   "homepage": "https://cap.cloud.sap/",
   "keywords": [