@sap/cds-dk 6.5.1 → 6.6.0

package/lib/lint/Linter.js

@@ -70,13 +70,16 @@ class Linter {
       // Determine if case "local" or "global" and resolve plugin accordingly
       await this._getConfigFileAndSetProjectPath(args);
 
-      const overwriteRules = checks.hasEslintConfigContent(this.configContents, "rules");
-      if (overwriteRules) {
-        await this._overwriteRuleSeverities();
-      }
+      if (this.pluginPath) {
+        const overwriteRules = checks.hasEslintConfigContent(this.configContents, "rules");
+        // Overwrite rules severities
+        if (overwriteRules) {
+          await this._overwriteRuleSeverities();
+        }
 
-      // Limit to CDS file extensions
-      this._addExtensions();
+        // Limit to CDS file extensions
+        this._addExtensions();
+      }
 
       // Run ESLint with collected options
       try {
@@ -213,7 +216,18 @@ class Linter {
         }
       }
     } catch (err) {
-      console.log(err);
+      // Report identically to ESLint CLI
+      if (typeof err.messageTemplate === "string") {
+        try {
+          const eslintBase = `${require.resolve('eslint').split('eslint')[0]}/eslint`;
+          const template = require(path.join(eslintBase, `messages/${err.messageTemplate}.js`));
+          console.log(template(err.messageData || {}));
+          exit(1)
+        } catch {
+            // Ignore template error then fallback to use `error.stack`.
+        }
+        console.log(err.stack);
+     }
       exit(1)
     }
   }
@@ -250,19 +264,23 @@ class Linter {
               this.pluginPath = require.resolve("@sap/eslint-plugin-cds", {
                 paths: [path.dirname(this.configPath)],
               });
+              this.pluginApi = require(this.pluginPath.replace("index.js", "api"));
             } catch (err) {
-              // Do nothing
+              // CLI will report (no locally installed plugin)
             }
-            this.pluginApi = require(this.pluginPath.replace("index.js", "api"));
           }
         }
       }
     }
     if (!this.pluginPath) {
-      this.pluginPath = require.resolve("@sap/eslint-plugin-cds", {
-        paths: [this.cdsdkPath],
-      });
-      this.pluginApi = require(this.pluginPath.replace("index.js", "api"));
+      try {
+        this.pluginPath = require.resolve("@sap/eslint-plugin-cds", {
+          paths: [this.cdsdkPath],
+        });
+        this.pluginApi = require(this.pluginPath.replace("index.js", "api"));
+      } catch (err) {
+        // CLI will report (no globally installed plugin)
+      }
     }
     // Project path is directory of ESLint config file
     this.projectPath = path.dirname(this.configPath);

package/lib/watch/livereload-server.js

@@ -1,4 +1,6 @@
-const DEBUG = /\b(y|all|cli|livereload)\b/.test(process.env.DEBUG) && console.debug
+const cds = require('../cds')
+const DEBUG = cds.debug('cli|livereload')
+
 const axios = require('axios')
 const ws = require('ws')
 const express = require('express')
@@ -19,7 +21,7 @@ module.exports = class LiveReload {
         const {address,port} = server.address()
         startWs(server)
         this.url = await livereloadURL(address, port)
-        DEBUG && DEBUG(`[cds] - live reload available at ${this.url}`)
+        DEBUG?.(`live reload available at ${this.url}`)
         resolve(this.url)
       }
         // start server
@@ -39,13 +41,13 @@ module.exports = class LiveReload {
       const startWs = (server) => {
         this.wsServer = new ws.Server({ server })
         this.wsServer.on('connection', (socket) => {
-          DEBUG && DEBUG('Client connected')
+          DEBUG?.('Client connected')
           socket.on('message', (msg) => {
-            DEBUG && DEBUG('Client message', msg)
+            DEBUG?.('Client message', msg)
             const request = JSON.parse(msg)
 
             if (request.command === 'hello') {
-              DEBUG && DEBUG('Client handshake')
+              DEBUG?.('Client handshake')
               const data = JSON.stringify({
                 command: 'hello',
                 protocols: [
@@ -59,16 +61,21 @@ module.exports = class LiveReload {
               })
               socket.send(data)
             } else if (request.command === 'info') {
-              DEBUG && DEBUG('Server received client data. Not sending response.')
+              DEBUG?.('Server received client data. Not sending response.')
             }
           })
         })
-        this.wsServer.on('close', () => { DEBUG && DEBUG('Socket closed') })
-        this.wsServer.on('error', (e) => DEBUG && DEBUG(e))
+        if (DEBUG) {
+          server.on('close', () => DEBUG('⚡️','cds watch - livereload closed'))
+          this.wsServer.on('close', () => DEBUG('⚡️','cds watch - web socket closed'))
+          this.wsServer.on('error', (e) => DEBUG(e))
+        }
       }
-      const close = () => { this.wsServer.close(); server.close(); DEBUG && DEBUG('Reload server closed') }
-      process.once('SIGTERM', close)
-      process.once('SIGINT', close)
+
+      process.once('shutdown', ()=>{
+        server.close()
+        this.wsServer.close()
+      })
     })
   }
 
@@ -81,7 +88,7 @@ module.exports = class LiveReload {
       command: 'reload',
       path: this.files.length ? this.files[0] : '',
     })
-    DEBUG && DEBUG(`[cds] - live reload for ${this.files}. ${this.wsServer.clients.size} ws clients`)
+    DEBUG?.(`live reload for ${this.files}. ${this.wsServer.clients.size} ws clients`)
     broadcast(data, this.wsServer.clients)
     this.files = []
   }
@@ -93,8 +100,8 @@ module.exports = class LiveReload {
 
 function broadcast(data, sockets) {
   sockets.forEach(socket => {
-    DEBUG && DEBUG(`Sending ${data}`)
-    socket.send(data, err=> DEBUG && DEBUG(err))
+    DEBUG?.(`Sending ${data}`)
+    socket.send(data, err=> DEBUG?.(err))
   })
 }
 

package/lib/watch/node-watch.js

@@ -1,4 +1,5 @@
-const DEBUG = /\b(y|all|cli|watch)\b/.test(process.env.DEBUG) && console.debug
+const cds = require ('../cds')
+const DEBUG = cds.debug('cli|watch')
 
 module.exports = ({ cwd, script, ext, includes=RegExp(), ignore=RegExp(), env={}, delay=200, options={} })=>{
 
@@ -8,19 +9,19 @@ module.exports = ({ cwd, script, ext, includes=RegExp(), ignore=RegExp(), env={}
   const EventEmitter = require('events')
   const emitter = new EventEmitter
 
-  const killAndExit = (sig) => {
-    DEBUG && DEBUG('\nreceived signal:', sig)
-    _kill (child, process.exit)
+  process.on('SIGINT', ()=>console.log()) //> newline after ^C
+  process.on('SIGINT', _shutdown)
+  process.on('SIGTERM', _shutdown)
+  function _shutdown (signal,n) {
+    DEBUG?.('⚡️', signal, n, 'received by cds watch')
+    process.emit('shutdown')
   }
-  process.on('SIGTERM', killAndExit)
-  process.on('SIGINT', killAndExit)
 
   // Re-starting child process...
   const { fork } = require('child_process')
   const restart = _coalesceEvents(delay, (events) => {
-    DEBUG && DEBUG('>> Events:', events)
+    DEBUG?.('Restart', {events})
     _kill (child, () => {
-      DEBUG && console.trace('Restart')
       const execArgv = [...process.execArgv]
       events.forEach(evt => {
         if (evt.type && evt.type.startsWith('--')) execArgv.push(evt.type)
@@ -38,38 +39,46 @@ module.exports = ({ cwd, script, ext, includes=RegExp(), ignore=RegExp(), env={}
         if (msg === 'restart') return restart()
         emitter.emit('message', msg)
       })
+      // child.channel.unref()
+      // child.unref()
+      // child.on('exit', process.exit)
     })
 
   })
 
   restart()
+  process.on('shutdown', ()=> _kill(child))
 
   // Watching for touched files...
   const watch = require('node-watch')
   const include = RegExp(`\\.(${ext.replace(/,/g,'|')})$|${includes.source}`)
   const filter = f => !ignore.test(f) && include.test(f)
-  watch (cwd||process.cwd(),{ recursive:true, filter, delay:0 }, restart)
+  const watcher = watch (cwd||process.cwd(),{ recursive:true, filter, delay:0 })
+  if (DEBUG) watcher.on('close', ()=> DEBUG('⚡️', 'cds watch - file watcher closed'))
+  watcher.on('change', restart)
+  process.on('shutdown', ()=> watcher.close())
 
   // Live commands...
-  const readline = require('readline')
-  readline.createInterface(process.stdin).on('line', (input) => {
+  const readline = require('readline').createInterface(process.stdin).on('line', (input) => {
     if (input === '') restart()
     else if (input === 'restart' || input === 'rs' || input.match(/^y$/i)) restart()
     else if (input === 'debug' || input === 'dbg')  restart('--inspect')
     else if (input === 'break' || input === 'brk')  restart('--inspect-brk')
     else if (input === 'debug-brk')  restart('--inspect-brk')
     else if (input === 'ps') ps(child,env)
-    else if (input === 'bye' || input.match(/^n$/i)) { _kill (child, () => process.exit())  }
+    else if (input === 'bye' || input.match(/^n$/i)) { _kill (child)  }
     else console.log ('?\n')
   })
+  if (DEBUG) readline.on('close', ()=> DEBUG('⚡️', 'cds watch - readline closed'))
+  process.on('shutdown', ()=> readline.close())
 
   emitter.restart = restart
-  emitter.stop    = () => _kill(child, () => false)
+  emitter.stop    = () => _kill(child)
   emitter.setEnv  = (name, value) => {
     if (typeof value === "undefined") {
       delete env[name]
     } else {
-      env[name]
+      env[name] // REVISIT: no value assigned ???
     }
   }
   return emitter
@@ -85,58 +94,51 @@ const ps = (child,env) => console.log (`\x1b[32m
 // reduces mutiple node-watch events in a time frame into a bulk
 function _coalesceEvents(delay, fn) {
   let timer, cache = []
-  function handle() {
-    fn(cache)
-    timer = null
-    cache = []
-  }
   return function(type, name) { // node-watch callback signature
-    cache.push({type, name})
-    if (!timer) {
-      timer = setTimeout(handle, delay);
-    }
+    if (type) cache.push({type, name})
+    if (!timer) timer = setTimeout(() => {
+      fn(cache)
+      timer = null
+      cache = []
+    }, delay).unref();
   }
 }
 
 /*
  * Ensures the given child process gets killed in different environments
  */
-function _kill (proc, cb=()=>{}) {
-  if (!proc)  return cb()
-  if (proc[_pending])  return // safeguard against repeated calls for the same process
-  proc[_pending] = true
-  const fn = () => { delete proc[_pending]; return cb(); }
+function _kill (child, cb=()=>{}) {
+  if (!child)  return cb()
+  if (child[_pending])  return // safeguard against repeated calls for the same process
+  child[_pending] = true
+  const _done = () => { delete child[_pending]; return cb(); }
 
-  const waitTime = parseInt(process.env.CDS_WATCH_KILL_DELAY) || 500
+  const waitTime = parseInt(process.env.CDS_WATCH_KILL_DELAY) || 2222
   // On Windows, child_process.kill() abruptly kills the process (https://nodejs.org/api/child_process.html#subprocesskillsignal)
   // Server has cleanup code to run, so send a custom message and give it a bit time.
   if (process.platform === 'win32') {
-    proc.send({ close: true }, () => {})  // see @sap/cds/bin/serve.js
+    child.send({ close: true }, () => {})  // see @sap/cds/bin/serve.js
     setTimeout(()=> {
-      proc.kill()
-      DEBUG && DEBUG('Killed process', proc.pid)
-      fn()
-    }, waitTime)
+      child.kill()
+      DEBUG?.('Killed process', child.pid)
+      _done()
+    }, waitTime).unref()
     return
   }
 
+  // fallback for misbehaving processes: SIGKILL it after some time
+  const forced = setTimeout(()=> {
+    DEBUG?.('⚡️', 'cds watch - killing child forcefully!')
+    child.kill('SIGKILL')
+  }, waitTime).unref()
+
   // first kill normally (using SIGTERM)
-  let killed = false
-  proc.on('exit',() => {
-    if (!killed) { killed = true
-      DEBUG && DEBUG('Killed process', proc.pid)
-      fn()
-    }
-  }).kill()
+  child.on('exit',() => { clearTimeout(forced)
+    DEBUG?.('⚡️', 'cds watch - child exited', child.pid)
+    _done()
+  })
 
-  // fallback for misbehaving processes: SIGKILL it after some time
-  setTimeout(()=> {
-    if (!killed) { killed = true
-      proc.kill('SIGKILL')
-      DEBUG && DEBUG('Killed process (forcefully)', proc.pid)
-      fn()
-    }
-  }, waitTime)
+  child.kill()
 }
 
 const _pending = Symbol.for('sap.cds.watch.pendingKill')