@sap/cds-dk 6.6.2 → 6.7.1

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

@@ -2,7 +2,7 @@ const { join } = require('path')
 const { readProject } = require('../../util/projectReader')
 const { mergeJSON, mergeYAML } = require('../../util/merge')
 const { parseMd5File, writeMd5File } = require('../../util/md5Tracking')
-const { srvNode, srvJava, xsuaa, mtxSidecar } = require('../_merging/registry-mta')
+const { srvNode, srvJava, xsuaa, mtxSidecar4 } = require('../_merging/registry-mta')
 const { PROJECT_TYPE } = require('../../constants')
 
 module.exports = class XsuaaTemplate extends require('../templateBase') {
@@ -37,11 +37,11 @@ module.exports = class XsuaaTemplate extends require('../templateBase') {
 
     async runDependentMerging( context = {}) {
         const projectDescriptor = await readProject(this.options)
-        const { isMultitenant, isExtensible, hasMta, hasHelm, isNodejs, isJava } = projectDescriptor.cap
+        const { isMultitenant, isExtensible, hasMta, hasHelm, isJava, srvPath } = projectDescriptor.cap
 
         const cds = require('../../../../lib/compile')
         const xsSecurity = await (async () => { try {
-            const models = await cds.load(join(this.projectPath, cds.env.folders.srv))
+            const models = await cds.load(cds.env.folders.srv)
             return cds.compile.to.xsuaa(models)
         } catch (error) { /* ignore */ }
         })() || { scopes: [], attributes: [], 'role-templates': [], 'authorities-inheritance': false }
@@ -52,33 +52,24 @@ module.exports = class XsuaaTemplate extends require('../templateBase') {
                 isEqualTo: scope.name
             }],
         }))}
-        const xsSecurityPath = join(this.projectPath, 'xs-security.json')
-        await mergeJSON(xsSecurityPath, xsSecurity, projectDescriptor, mergingSemantics)
+        await mergeJSON('xs-security.json', xsSecurity, projectDescriptor, mergingSemantics)
 
         if (hasMta) {
-            const srv = isNodejs ? srvNode : srvJava
+            const srv = (isJava ? srvJava : srvNode)(srvPath)
             const additions = [srv, xsuaa]
+            const mtxSidecar = mtxSidecar4(isJava ? 'mtx/sidecar' : 'gen/mtx/sidecar')
             if (isMultitenant && isJava) additions.push(mtxSidecar)
 
-            const mtaYAMLPath = join(this.projectPath, 'mta.yaml')
-            const relationships =  [{
+            const relationships = [{
                 insert: [xsuaa, 'name'],
                 into: [srv, 'requires', 'name']
             }]
-            relationships.push({
+            if (isMultitenant) relationships.push({
                 insert: [xsuaa, 'name'],
                 into: [mtxSidecar, 'requires', 'name']
             })
 
-            await mergeYAML(
-                mtaYAMLPath,
-                join(__dirname, 'files', 'mta.yaml.hbs'),
-                projectDescriptor,
-                {
-                    additions,
-                    relationships
-                }
-            )
+            await mergeYAML('mta.yaml', join(__dirname, 'files', 'mta.yaml.hbs'), projectDescriptor, { additions, relationships })
         }
 
         if (hasHelm) {
@@ -86,35 +77,23 @@ module.exports = class XsuaaTemplate extends require('../templateBase') {
             let isIndependentCommand = false;
             if(Object.keys(context).length == 0){
                 isIndependentCommand = true;
-                context.projectPath = this.projectPath;
-                context.oldTrackingData = context.newTrackingData = await parseMd5File(join(this.projectPath, 'chart', '.cds-add-helm-files.md5'));
+                context.oldTrackingData = context.newTrackingData = await parseMd5File(join('chart', '.cds-add-helm-files.md5'));
             }
-            
+
             // copy service-instance chart
             const HelmTemplate = require(`../helm`);
             const helmTemplate = new HelmTemplate(this.generator, context.oldTrackingData, context.newTrackingData);
             isIndependentCommand = isIndependentCommand | await helmTemplate.addSubChart('service-instance');
 
             // add dependency entry in chart.yaml
-            await mergeYAML(
-                join(this.projectPath, 'chart', 'Chart.yaml'),
-                join(__dirname, 'files', 'xsuaa.yaml'),
-                projectDescriptor,
-                { additions: [{
-                    in: `dependencies`,
-                    where: [{
-                        property: 'alias',
-                        isEqualTo: 'xsuaa'
-                    }]
-                }]}
-            );
+            await helmTemplate.addDependency('service-instance', 'xsuaa');
 
             await mergeYAML(
-                join(this.projectPath, 'chart', 'values.yaml'),
+                join('chart', 'values.yaml'),
                 join(__dirname, 'files', 'values.yaml.hbs'),
                 projectDescriptor
             )
-            if(isIndependentCommand) await writeMd5File(join(this.projectPath, 'chart', '.cds-add-helm-files.md5'), context.newTrackingData);
+            if(isIndependentCommand) await writeMd5File(join('chart', '.cds-add-helm-files.md5'), context.newTrackingData);
         }
 
         // Re-applying the merging part of `cds add mtx` because cds.compile.to.xsuaa

package/lib/init/util/commandUtil.js

@@ -1,6 +1,7 @@
 const cp = require('child_process');
 const os = require('os');
-const DEBUG = /\b(y|all|cli)\b/.test(process.env.DEBUG) && console.debug
+const cds = require('../../cds');
+const DEBUG = cds.debug('cli');
 
 
 const { IS_WIN } = require('../constants');
@@ -21,7 +22,7 @@ class CommandUtil {
     async spawnCommand(cmd, args, options = {}, collectResult = false) {
         args = this._sanitizeArgs(args);
         return new Promise((resolve, reject) => {
-            DEBUG && console.debug(`[spawn] ${cmd} ${args.join(' ')}`);
+            DEBUG?.(`[spawn] ${cmd} ${args.join(' ')}`);
 
             options.env = options.env || process.env;
 

package/lib/init/util/fsUtil.js

@@ -2,8 +2,15 @@ const { yaml: YAML } = require('@sap/cds-foss')
 const JSONC = require('../../util/jsonc');
 const { read, write } = require('../../cds').utils;
 
+// REVISIT: Consider merging with template util
+
 module.exports = new class FsUtil {
 
+    constructor() {
+        this.copyRenderedJSON = this.copyRenderedJSON.bind(this)
+        this.copyRenderedYAML = this.copyRenderedYAML.bind(this)
+    }
+
     async readYAML(src, projectDescriptor) {
         let file
         try {
@@ -20,9 +27,14 @@ module.exports = new class FsUtil {
         return YAML.parseDocument(file)
     }
 
-    async writeYAML(filepath, yaml) {
+    async writeYAML(dst, yaml) {
         const content = YAML.stringify(yaml, { collectionStyle: 'block' })
-        await write(filepath, content)
+        await write(content).to(dst)
+    }
+
+    async copyRenderedYAML(src, dst, projectDescriptor) {
+        const yaml = await this.readYAML(src, projectDescriptor)
+        await write(yaml.toString()).to(dst)
     }
 
     async readJSON(src, projectDescriptor) {
@@ -38,4 +50,9 @@ module.exports = new class FsUtil {
     async readJSONC(src) {
         return JSONC.parse(await read(src, 'utf8'))
     }
+
+    async copyRenderedJSON(src, dst, projectDescriptor) {
+        const json = await this.readJSON(src, projectDescriptor)
+        await write(dst, json, { spaces: 2 })
+    }
 }

package/lib/init/util/md5Tracking.js

@@ -1,31 +1,24 @@
-const path = require('path'), { dirname, resolve } = path;
-const { mkdirp, isdir } = require('../../cds').utils;
-const cds = require('../../cds');
+const cds = require('../../cds')
+const { exists, mkdirp, isdir, readdir, read, write, copy, path } = cds.utils;
+const { dirname, join } = path
 
-const fs = require('fs');
 const crypto = require('crypto');
-const LOG = cds.log('k8s');
 const os = require('os');
+const { copyRenderedYAML } = require('./fsUtil');
 
-async function copyAndTrack(source, dest, context = {}, force = false) {
-    const sourcePath = resolve(cds.root, source);
-    const destPath = resolve(cds.root, dest);
-    //if (fs.promises.cp) return fs.promises.cp(src, dst, { recursive: true });
-    await mkdirp(dirname(destPath));
-    if (isdir(sourcePath)) {
-        const entries = await fs.promises.readdir(sourcePath);
-        return Promise.all(entries.map(async each => {
-            const subSourcePath = path.join(sourcePath, each);
-            const subDestPath = path.join(destPath, each);
-            return copyAndTrack(subSourcePath, subDestPath, context);
-        }))
+async function copyAndTrack(source, dest, context = {}, { force = false, projectDescriptor } = {}) {
+    await mkdirp(dirname(dest));
+    if (isdir(source)) {
+        const dirents = await readdir(source);
+        return Promise.all(dirents.map(each => copyAndTrack(join(source, each), join(dest, each), context)))
     } else {
-        let data = await _readFileIfExists(sourcePath, 'utf-8');
-        if (!force && await _isChartFileModified(destPath, context)) {
-            LOG.warn("Chart file " + destPath + " has been modified and will not be updated.");
+        const data = exists(source) ? await read(source, 'utf-8') : undefined
+        if (!force && await _isChartFileModified(dest, context)) {
+            console.log('Chart file ' + dest + ' has been modified and will not be updated.');
         } else {
-            _track(destPath, data, context);
-            return fs.promises.copyFile(sourcePath, destPath);
+            _track(dest, data, context);
+            if (projectDescriptor) return copyRenderedYAML(source, dest, projectDescriptor)
+            return copy(source).to(dest);
         }
     }
 }
@@ -33,56 +26,34 @@ async function copyAndTrack(source, dest, context = {}, force = false) {
 
 /**
 * Takes path of md5 file as an argument and returns a JSON object containing hashes of files stored in MD5 file.
-* @param {String} path
+* @param {String} file
 * @returns {Promise<JSON>}
 */
-async function parseMd5File(path) {
-    let md5Hashes = {};
-    const md5FileContent = await _readFileIfExists(path);
-    if (md5FileContent == undefined) return md5Hashes;
-    let md5Checksums = md5FileContent.toString().split(os.EOL)
-    md5Checksums.forEach((checksum) => {
-        checksum = checksum.split(" ")
-        md5Hashes[checksum[1]] = checksum[0];
-    })
-    return md5Hashes;
+async function parseMd5File(file) {
+    const md5 = exists(file) ? await read(file) : undefined
+    if (!md5) return {}
+    return Object.fromEntries(md5.split(os.EOL).map(line => line.split(' ').reverse()))
 }
 
 /**
 * Takes json object containing key as filename and value as MD5 hash and generates a md5sum format file.
-* @param {String} path
+* @param {String} file
 * @param {Promise<JSON>} data
 */
-async function writeMd5File(path, data) {
-    let md5_output;
-    Object.keys(data).forEach(key => {
-        var currMd5 = `${data[key]} ${key}`;
-        if (md5_output === undefined)
-            md5_output = currMd5;
-        else
-            md5_output += os.EOL + currMd5;
-    })
-    await fs.promises.writeFile(path, md5_output);
+async function writeMd5File(file, data) {
+    await write(Object.entries(data).map(([filename, hash]) =>
+        `${hash} ${filename}` + os.EOL
+    ).join('')).to(file)
 }
 
-async function _readFileIfExists(path, encoding) {
-    try {
-        return await fs.promises.readFile(path, encoding);
-    } catch (error) {
-        if (error.code === 'ENOENT' || error.code === 'EISDIR') return undefined;
-        else throw error;
-    }
-}
-
-async function _isChartFileModified(filePath, context = {}) {
-    const data = await _readFileIfExists(filePath, 'utf-8');
-    if (data == undefined) {
-        return false;
-    }
 
-    const key = _pathKey(path.join(context.projectPath, 'chart'), filePath);
-    const currentHash = _hash(data);
-    return context.oldTrackingData != undefined && context.oldTrackingData[key] != undefined && context.oldTrackingData[key] != currentHash;
+// REVISIT: Why pass entire 'context' if we're only interested in one key in the old tracking data? -> decrease coupling
+async function _isChartFileModified(file, context = {}) {
+    const data = exists(file) ? await read(file, 'utf-8') : undefined
+    if (!data) return false;
+    const key = _pathKey(join(cds.root, 'chart'), file);
+    const hashedContent = _hash(data);
+    return context.newTrackingData[key] ? context.newTrackingData[key] !== hashedContent : context.oldTrackingData?.[key] !== hashedContent;
 }
 
 function _hash(data) {
@@ -97,8 +68,9 @@ function _toPosix(path) {
     return path.replace(/\\/g, '/');
 }
 
+// REVISIT: Replace inout parameter 'context' by return value of new tracking data
 async function _track(filePath, data, context = {}) {
-    const key = _pathKey(path.join(context.projectPath, 'chart'), filePath);
+    const key = _pathKey(path.join(cds.root, 'chart'), filePath);
     const hashedContent = _hash(data);
     if (context.oldTrackingData != undefined && context.oldTrackingData[key] != undefined) {
         context.oldTrackingData[key] = hashedContent;
@@ -106,8 +78,9 @@ async function _track(filePath, data, context = {}) {
     context.newTrackingData[key] = hashedContent;
 }
 
+// REVISIT: Can we make copyAndTrack the only public API?
 module.exports = {
     copyAndTrack,
     parseMd5File,
     writeMd5File
-}
+}

package/lib/init/util/projectReader.js

@@ -44,33 +44,23 @@ module.exports = new class ProjectReader {
         const cap = await this._getCapDescriptor(env, options)
         const ui = this._getUiDescriptor(env)
         const projectDescriptor = { cap, ui }
-        this._validateDbFolders(cap)
 
         DEBUG && DEBUG({ projectDescriptor })
         return projectDescriptor
     }
 
-    _validateDbFolders(cap) {
-        const { db: dbs, isJava } = cap
-        if (isJava) {
-            for (const db of dbs) if (!exists(path.join(db.path, 'package.json'))) {
-                LOG.error(`Missing 'package.json' in folder ${db.path} - 'cds add hana' adds configuration for SAP HANA`)
-            }
-        }
-    }
-
     async _getCapDescriptor(env, options) {
         const _hasFacet = template => require(`../template/${template}`).hasFacet(env, options)
         const cap = {
             for: options?.for,
-            pLanguage: DEFAULT_P_LANGUAGE,
+            language: DEFAULT_P_LANGUAGE,
             srv: {},
             db: [],
             requires: [],
             get hasRequires()    { return this.requires.length > 0 },
             get needsSidecar()   { return (options?.add.has('hana') || this.db.length > 0) && (this.isJava || !this.isMultitenant) },
-            get isNodejs()       { return this.pLanguage === P_LANGUAGE_NODEJS },
-            get isJava()         { return this.pLanguage === P_LANGUAGE_JAVA },
+            get isNodejs()       { return this.language === P_LANGUAGE_NODEJS },
+            get isJava()         { return this.language === P_LANGUAGE_JAVA },
             get hasSidecar()     { return exists('mtx', 'sidecar') },
             get isMultitenant()  { return _hasFacet('multitenancy') },
             get isExtensible()   { return _hasFacet('extensibility') },
@@ -112,20 +102,16 @@ module.exports = new class ProjectReader {
 
                 case BUILD_TASK_JAVA:
                 case BUILD_TASK_JAVA_CF:
-                    cap.pLanguage = P_LANGUAGE_JAVA
-                    cap.srv = {
-                        path: relDestPath,
-                        name: srcFolder,
-                        ext: await this._getJavaExtDescriptor(srcPath)
-                    }
+                    cap.language = P_LANGUAGE_JAVA
+                    cap.srvPath = relDestPath
+                    cap.srvName = srcFolder
+                    cap.srvExt = await this._getJavaExtDescriptor(srcPath)
                     break
 
                 case BUILD_TASK_NODEJS:
                 case BUILD_TASK_NODE_CF:
-                    cap.srv = {
-                        path: relDestPath,
-                        name: srcFolder
-                    }
+                    cap.srvPath = relDestPath
+                    cap.srvName = srcFolder
                     break
 
                 case BUILD_TASK_FIORI:
@@ -177,12 +163,12 @@ module.exports = new class ProjectReader {
     }
 
     async _setAppDetails(cap) {
-        if (cap.pLanguage !== P_LANGUAGE_JAVA && cap.pLanguage !== P_LANGUAGE_NODEJS) {
-            throw Error(`${cap.pLanguage} not supported`)
+        if (cap.language !== P_LANGUAGE_JAVA && cap.language !== P_LANGUAGE_NODEJS) {
+            throw Error(`${cap.language} not supported`)
         }
 
         // 1.1. java - use parent pom.xml
-        if (cap.pLanguage === P_LANGUAGE_JAVA) {
+        if (cap.language === P_LANGUAGE_JAVA) {
             const pomXmlPath = path.join(cds.root, 'pom.xml')
             try {
                 if (exists(pomXmlPath)) {

package/lib/lint/Linter.js

@@ -21,7 +21,6 @@ class Linter {
     this.flags = [];
     this.configPath = "";
     this.configContents = {};
-    this.projectPath = "";
     this.cdsdkPath = path.join(__dirname, "../..");
     this.globalPath = path.join(this.cdsdkPath, "../..");
     this.extendsPlugin = false;
@@ -282,8 +281,6 @@ class Linter {
         // CLI will report (no globally installed plugin)
       }
     }
-    // Project path is directory of ESLint config file
-    this.projectPath = path.dirname(this.configPath);
     return;
   }
 

package/lib/util/exec.js

@@ -2,6 +2,7 @@ const { spawn, spawnSync } = require('child_process');
 
 const cds = require('../cds');
 const log = cds.log('exec');
+const DEBUG = cds.debug('exec');
 
 function* commandIterator(strs, args) {
     for (let i=0; i<strs.length; i++) {
@@ -153,7 +154,7 @@ function executeSync(options = {}, command, ...args) {
     const { acceptStatuses } = options;
     const execOptions = getExecOptions(options);
 
-    log.debug(`exec: ${command} ${args.map( v => v.match(/\s/) ? `"${v}"` : v ).join(' ')}`);
+    DEBUG?.(`exec: ${command} ${args.map( v => v.match(/\s/) ? `"${v}"` : v ).join(' ')}`);
     const result = spawnSync(command, args, execOptions);
 
     if (acceptStatuses !== '*' && acceptStatuses.indexOf(result.status) === -1) throw new Error(`Command '${command} ${args.join(' ')}' returned with status code ${result.status}`);

package/lib/util/term.js

@@ -1,5 +1,5 @@
 // FIXME: Nicht gut, das wir das zweimal redundant haben!
-const DEBUG = /\b(y|all|cli)\b/.test(process.env.DEBUG) && console.debug
+const DEBUG = /\b(y|all|cli)\b/.test(process.env.DEBUG) ? console.debug : undefined
 
 // https://docs.microsoft.com/en-us/windows/console/console-virtual-terminal-sequences
 const t = module.exports.codes = {

package/lib/watch/livereload-connect.js

@@ -1,4 +1,5 @@
-const DEBUG = /\b(y|all|cli|livereload)\b/.test(process.env.DEBUG) && console.debug
+const cds = require('../cds');
+const DEBUG = cds.debug('cli|watch|livereload');
 
 module.exports = function livereload(opt) {
   // options
@@ -86,10 +87,10 @@ module.exports = function livereload(opt) {
   function acceptContentType(res) {
     const ha = res.getHeader('content-type');
     if (ha && ha.indexOf('html') >= 0) {
-      DEBUG && DEBUG('[livereload] accepting content-type', ha)
+      DEBUG?.('[livereload] accepting content-type', ha)
       return true;
     }
-    DEBUG && DEBUG('[livereload] rejecting content-type', ha)
+    DEBUG?.('[livereload] rejecting content-type', ha)
     return false;
   }
 
@@ -112,7 +113,7 @@ module.exports = function livereload(opt) {
     if (!accept(req) || !check(req.url, include) || check(req.url, ignore)) {
       return next();
     }
-    DEBUG && DEBUG('[livereload] accepting URL', req.url)
+    DEBUG?.('[livereload] accepting URL', req.url)
 
     // Disable G-Zip to enable proper inspecting of HTML
     if (disableCompression) {

package/lib/watch/livereload-server.js

@@ -1,5 +1,5 @@
 const cds = require('../cds')
-const DEBUG = cds.debug('cli|livereload')
+const DEBUG = cds.debug('cli|watch|livereload')
 
 const axios = require('axios')
 const ws = require('ws')
@@ -119,10 +119,7 @@ async function livereloadURL(address, port) {
   }
   // Local case.  Add effective server address/host to URL.
   // Make sure IPv6 addresses are properly escaped.
-  if (require('net').isIPv6(address)) {
-    // TODO remove as soon as IPv6 support in https://github.com/livereload/livereload-js/pull/103 is fixed
-    if (address === '::1')  address = 'localhost'
-    // address = `[${address}]`
-  }
+  if (require('net').isIPv6(address))  address = `[${address}]`
+
   return `http://${address}:${port}/livereload.js?snipver=1`
 }

package/lib/watch/node-watch.js

@@ -108,7 +108,7 @@ function _coalesceEvents(delay, fn) {
  * Ensures the given child process gets killed in different environments
  */
 function _kill (child, cb=()=>{}) {
-  if (!child)  return cb()
+  if (!child || !child.connected)  return cb()
   if (child[_pending])  return // safeguard against repeated calls for the same process
   child[_pending] = true
   const _done = () => { delete child[_pending]; return cb(); }