@sap/cds-compiler 2.5.2 → 2.11.0

package/lib/transform/translateAssocsToJoins.js

@@ -1,24 +1,22 @@
 'use strict'
 
 const { setProp, forEachGeneric, forEachDefinition, isBetaEnabled } = require('../base/model');
-var { handleMessages, makeMessageFunction } = require('../base/messages');
-var { linkToOrigin } = require('../compiler/shared');
+var { makeMessageFunction } = require('../base/messages');
+const { recompileX } = require('../compiler/index');
+var { linkToOrigin } = require('../compiler/utils');
 const  {compactModel, compactExpr} = require('../json/to-csn');
 const { deduplicateMessages } = require('../base/messages');
-const timetrace = require('../utils/timetrace');
+const { timetrace } = require('../utils/timetrace');
 // Paths that start with an artifact of protected kind are special
 // either ignore them in QAT building or in path rewriting
 const internalArtifactKinds = ['builtin'/*, '$parameters'*/, 'param'];
 
 function translateAssocsToJoinsCSN(csn, options){
   timetrace.start('Recompiling model');
-  let { augment } = require('../json/from-csn');
-  // Append `.csn` to `.cds` files to indicate recompilation.
-  const file = csn.$location && csn.$location.file.replace(/[.]cds$/, '.cds.csn') || '<recompile>.csn';
-  let xsn = augment(csn, file, options);
-  const { compileSourcesX } = require('../compiler');
   // Do not re-complain about localized
-  const model = compileSourcesX( { [file]: xsn }, { ...options, $recompile: true } );
+  const compileOptions = { ...options, $skipNameCheck: true };
+  delete compileOptions.csnFlavor;
+  const model = recompileX(csn, compileOptions);
   timetrace.stop();
   timetrace.start('Translating associations to joins');
   translateAssocsToJoins(model, options);
@@ -46,9 +44,9 @@ function translateAssocsToJoinsCSN(csn, options){
   }
 
   // If A2J reports error - end! Continuing with a broken CSN makes no sense
-  handleMessages(model, options);
+  makeMessageFunction(model, options).throwWithError();
   // FIXME: Move this somewhere more appropriate
-  const compact = compactModel(model, options);
+  const compact = compactModel(model, compileOptions);
   return compact;
 }
 
@@ -181,7 +179,7 @@ function translateAssocsToJoins(model, inputOptions = {})
       let joinTree = query.from;
       for(let tan in query.$tableAliases)
       {
-        if(!['$projection', '$self'].includes(tan)) // don't drive into $projection/$self tableAlias (yet)
+        if(query.$tableAliases[tan].kind !== '$self') // don't drive into $projection/$self tableAlias (yet)
         {
           let ta = query.$tableAliases[tan];
           joinTree = createJoinTree(env, joinTree, ta.$qat, 'left', '$qat', ta.$QA);
@@ -202,7 +200,7 @@ function translateAssocsToJoins(model, inputOptions = {})
   function createQAForFromClauseSubQuery(query, env)
   {
     for (let taName in query.$tableAliases) {
-      if (!['$self', '$projection'].includes(taName)) {
+      if (query.$tableAliases[taName].kind !== '$self') {
         let ta = query.$tableAliases[taName];
         if(!ta.$QA) {
           ta.$QA = createQA(env, ta._origin, taName, undefined);
@@ -243,14 +241,6 @@ function translateAssocsToJoins(model, inputOptions = {})
         {
           art.$QA = createQA(env, art.target._artifact, art.name.id );
           art.$QA.mixin = true;
-          /* Mark mixin definition to be _ignored:
-            - If the mixin is used, it is now resolved into a join => definition vaporizes
-            - If the mixin is published, forHana backend must create a __copy with rewritten
-              $projection ON conditon and publish it with alias.
-            - If the mixin is neither be used nor published it shall not be visible to the database
-              (internal mixin).
-          */
-          art.$a2j = { _ignore: true };
         }
       });
     }
@@ -618,7 +608,7 @@ function translateAssocsToJoins(model, inputOptions = {})
             const id = this.id();
             if(elt) {
               let found = true;
-              const epath = elt.split('.');
+              const epath = [elt];
               const epl = epath.length+offset;
               if(epl < path.length) {
                 for(let i = 0; i < epl && found; i++) {
@@ -630,7 +620,7 @@ function translateAssocsToJoins(model, inputOptions = {})
             }
             if(id) {
               let found = true;
-              const epath = id.split('.');
+              const epath = [id];
               const epl = epath.length+offset;
               if(epl < path.length) {
                 for(let i = 0; i < epl && found; i++) {
@@ -745,9 +735,14 @@ function translateAssocsToJoins(model, inputOptions = {})
       function swapTableAliasesForFwdAssoc(fwdAssoc, srcAlias, tgtAlias) {
         let newSrcAlias = tgtAlias;
         let newTgtAlias = {};
-        // first try to identify table alias for complex views or
-        // redirected associations
-        if(fwdAssoc._redirected && fwdAssoc._redirected.length) {
+        // first try to identify table alias for complex views or redirected associations
+        if(fwdAssoc._redirected && fwdAssoc._redirected.length && 
+           // redirected target must have a $QA
+           fwdAssoc._redirected[fwdAssoc._redirected.length-1].$QA &&
+           // $QA's artifact must either be same srcAlias artifact
+           (fwdAssoc._redirected[fwdAssoc._redirected.length-1].$QA._artifact === srcAlias._artifact ||
+           // OR original assoc is a mixin (then just use the $QA)
+           assoc.kind === 'mixin')) {
           newTgtAlias.id = fwdAssoc._redirected[fwdAssoc._redirected.length-1].$QA.name.id;
           newTgtAlias._artifact = fwdAssoc._redirected[fwdAssoc._redirected.length-1]._effectiveType;
           newTgtAlias._navigation = fwdAssoc._redirected[fwdAssoc._redirected.length-1].$QA.path[0]._navigation;
@@ -1400,7 +1395,7 @@ function translateAssocsToJoins(model, inputOptions = {})
 
     let [head, ...tail] = path;
 
-    if(['$projection', '$self'].includes(head.id) && tail.length) {
+    if(['$projection', '$self'].includes(head.id) && tail.length && head._navigation.kind === '$self') {
       // make sure not to truncate tail
       if(tail.length > 1)
         [head, ...tail] = tail;

package/lib/transform/universalCsnEnricher.js

@@ -0,0 +1,67 @@
+'use strict';
+
+const { forEachDefinition } = require('../base/model');
+const {
+  applyTransformations,
+  cloneCsn,
+  getUtils,
+  isBuiltinType,
+} = require('../model/csnUtils');
+
+/**
+ * Loop through a universal CSN and enrich it with the properties
+ * from the source definition - modifies the input model in-place
+ * 
+ * @param {CSN.Model} csn
+ * @param {CSN.Options} options
+ */
+module.exports = function(csn, options) {
+  let { getOrigin, getFinalType, getFinalTypeDef } = getUtils(csn);
+  // User-defined structured types do not have the elements propagated any longer
+  // if there is no association among the elements. For that reason,
+  // as a first step propagate the elements of these
+  forEachDefinition(csn, (def) => {
+    if (def.kind === 'type' && def.type && !def.elements) {
+      const finalType = getFinalType(def.type);
+      if (isBuiltinType(finalType)) return;
+      const finalTypeDef = getFinalTypeDef(def.type);
+      if (finalTypeDef.elements)
+        def.elements = cloneCsn(finalTypeDef.elements, options);
+    }
+  });
+
+  // as a second step, loop through all the $origin properties in the model
+  // and propagate the properties from the origin definition
+  applyTransformations(csn, {
+    '$origin': (node, _$orign, $originValue, _path, parent, propName) => {
+      if (!node.kind) { // we do not want to replace whole definitions
+        if (Array.isArray($originValue))
+          propagatePropsFromOrigin(node, propName, parent);
+        else if ($originValue.$origin && Array.isArray($originValue.$origin)) {
+          // cover the case of query entity elements where we have own and ihnerited attributes/annotations
+          propagatePropsFromOrigin($originValue, propName, parent);
+        }
+
+      }
+    }
+  }, undefined, undefined, options);
+
+  function propagatePropsFromOrigin(member, memberName, construct) {
+    // TODO: shall the $origin be kept as part of the element?
+    const origin = getOrigin(member);
+    if (origin.kind) return;
+    if (member.elements && origin.type) {
+      delete member.$origin;
+      member.type = origin.type;
+      return;
+    }
+    let newMember = cloneCsn(origin, options);
+    // keep targets and keys of assoc, if it was redirected
+    if (origin.type === 'cds.Association') {
+      newMember.target = member.target || newMember.target;
+      newMember.keys = member.keys || newMember.keys;
+    }
+    // TODO: check if this works fine for items/returns/actions
+    construct[memberName] = newMember;
+  }
+}

package/lib/utils/file.js

@@ -15,16 +15,6 @@ function splitLines(src) {
   return src.split(/\r\n?|\n/);
 }
 
-/**
- * Change Windows style line endings to Unix style
- *
- * @param {string} src
- * @returns {string}
- */
-function normalizeLineEndings(src) {
-  return (src && process.platform === 'win32') ? src.replace(/\r\n/g, '\n') : src;
-}
-
 /**
  * Returns filesystem utils readFile(), isFile(), realpath() for _CDS_ usage.
  * This includes a trace as well as usage of a file cache.
@@ -40,7 +30,7 @@ function cdsFs(fileCache, enableTrace) {
   const readFile = _wrapReadFileCached(fs.readFile);
   const readFileSync = _wrapReadFileCached((filename, enc, cb) => {
     try {
-      cb(null, fs.readFileSync( filename, enc ));
+      cb(null, fs.readFileSync( filename, { encoding: enc } ));
     }
     catch (err) {
       cb(err, null);
@@ -82,7 +72,7 @@ function cdsFs(fileCache, enableTrace) {
    * Wraps the given reader into a cached environment including a trace.
    * The given @p reader must have the same signature as fs.readFile.
    *
-   * @param {(filename: string, enc: string, cb: (err, data) => void) => void} reader
+   * @param {(filename: string, enc, cb: (err, data) => void) => void} reader
    */
   function _wrapReadFileCached( reader ) {
     return (filename, enc, cb) => {
@@ -103,7 +93,9 @@ function cdsFs(fileCache, enableTrace) {
           body.syscall = 'open';
           body.path = filename;
         }
-        if (body instanceof Error) {
+        if (body && body.stack && body.message) {
+          // NOTE: checks for instanceof Error are not reliable if error
+          //       created in different execution env
           traceFS( 'READFILE:cache-error:', filename, body.message );
           cb( body );   // no need for process.nextTick( cb, body ) with moduleResolve
         }
@@ -181,6 +173,5 @@ function cdsFs(fileCache, enableTrace) {
 
 module.exports = {
   splitLines,
-  normalizeLineEndings,
   cdsFs,
 };

package/lib/utils/moduleResolve.js

@@ -7,7 +7,6 @@
 
 const path = require('path');
 
-const { makeMessageFunction } = require('../base/messages');
 const { cdsFs } = require('./file');
 
 const DEFAULT_ENCODING = 'utf-8';
@@ -44,7 +43,7 @@ function adaptCdsModule(modulePath) {
  * @param {object} fileCache
  * @param {CSN.Options} options
  */
-function resolveModule( dep, fileCache, options ) {
+function resolveModule( dep, fileCache, options, messageFunctions ) {
   const _fs = cdsFs(fileCache, options.traceFs);
   // let opts = { extensions, basedir: dep.basedir, preserveSymlinks: false };
   // `preserveSymlinks` option does not really work -> provide workaround anyway...
@@ -96,7 +95,7 @@ function resolveModule( dep, fileCache, options ) {
       }
     }
   }).catch( () => {
-    _errorFileNotFound(dep, options);
+    _errorFileNotFound(dep, options, messageFunctions);
     return false;
   });
 }
@@ -107,7 +106,7 @@ function resolveModule( dep, fileCache, options ) {
  * @param {object} fileCache
  * @param {CSN.Options} options
  */
-function resolveModuleSync( dep, fileCache, options ) {
+function resolveModuleSync( dep, fileCache, options, messageFunctions ) {
   const _fs = cdsFs(fileCache, options.traceFs);
   const opts = {
     extensions,
@@ -129,7 +128,7 @@ function resolveModuleSync( dep, fileCache, options ) {
   });
 
   if (error) {
-    _errorFileNotFound(dep, options);
+    _errorFileNotFound(dep, options, messageFunctions);
     return false;
   }
 
@@ -148,7 +147,7 @@ function resolveModuleSync( dep, fileCache, options ) {
   }
 
   if (error) {
-    _errorFileNotFound(dep, options);
+    _errorFileNotFound(dep, options, messageFunctions);
     return false;
   }
 
@@ -161,8 +160,7 @@ function resolveModuleSync( dep, fileCache, options ) {
   return result;
 }
 
-function _errorFileNotFound(dep, options) {
-  const { error } = makeMessageFunction( null, options, 'compile' );
+function _errorFileNotFound(dep, options, { error }) {
   if (dep.resolved) {
     let resolved = path.relative( dep.basedir, dep.resolved );
     if (options.testMode)

package/lib/utils/term.js

@@ -2,8 +2,8 @@
 // This file is used for color output to stderr and stdout.
 // Use `term.error`, `term.warn` and `term.info` as they use color output
 // per default if the process runs in a TTY, i.e. stdout as well as
-// stderr are TTYs. stderr/stdout are no TTYs if they (for example)
-// are piped to another process or written to file:
+// stderr are TTYs.  stderr/stdout are no TTYs if they are
+// (for example) piped into another process or written to file:
 //
 //    node myApp.js              # stdout.isTTY: true,      stderr.isTTY: true
 //    node myApp.js | cat        # stdout.isTTY: undefined, stderr.isTTY: true
@@ -17,23 +17,9 @@
 const stderrHasColor = process.stderr.isTTY;
 const stdoutHasColor = process.stdout.isTTY;
 
-let hasColor = stdoutHasColor && stderrHasColor;
-
-module.exports.useColor = (mode) => {
-  switch (mode) {
-    case false:
-    case 'never':
-      hasColor = false;
-      break;
-    case true:
-    case 'always':
-      hasColor = true;
-      break;
-    default:
-      hasColor = stdoutHasColor && stderrHasColor;
-      break;
-  }
-};
+// Note: We require both stderr and stdout to be TTYs, as we don't
+//       know (in our exported functions) where the text will end up.
+const hasColorShell = stdoutHasColor && stderrHasColor;
 
 // https://docs.microsoft.com/en-us/windows/console/console-virtual-terminal-sequences
 const t = {
@@ -47,29 +33,66 @@ const t = {
   cyan: '\x1b[36m', // Foreground Cyan
 };
 
-const as = (codes, o) => (hasColor ? (codes + o + t.reset) : (`${ o }`));
+function term(useColor = 'auto') {
+  let hasColor = hasColorShell;
+  changeColorMode(useColor);
 
-const asError = o => as(t.red + t.bold, o);
-const asWarning = o => as(t.yellow, o);
-const asInfo = o => as(t.green, o);
-const asHelp = o => as(t.cyan, o);
-module.exports.underline = o => as(t.underline, o);
-module.exports.bold = o => as(t.bold, o);
-
-module.exports.asSeverity = (severity, msg) => {
-  switch ((`${ severity }`).toLowerCase()) {
-    case 'error': return asError(msg);
-    case 'warning': return asWarning(msg);
-    case 'info': return asInfo(msg);
-    case 'help': return asHelp(msg);
-    // or e.g. 'none'
-    default: return msg;
+  function changeColorMode(mode) {
+    switch (mode) {
+      case false:
+      case 'never':
+        hasColor = false;
+        break;
+      case true:
+      case 'always':
+        hasColor = true;
+        break;
+      default:
+        // Note: See also: https://no-color.org/
+        //       > Command-line software which adds ANSI color to its output by default
+        //       > should check for the presence of a `NO_COLOR` environment variable
+        //       > that, when present (regardless of its value), prevents the addition
+        //       > of ANSI color.
+        // Note: To be able to disable colors in tests, we check the environment
+        //       variable here again.
+        hasColor = hasColorShell && (process.env.NO_COLOR === undefined);
+        break;
+    }
   }
-};
 
-module.exports.codes = t;
-module.exports.as = as;
-module.exports.error = asError;
-module.exports.warn = asWarning;
-module.exports.info = asInfo;
-module.exports.help = asHelp;
+  const as = (codes, o) => (hasColor ? (codes + o + t.reset) : (`${ o }`));
+
+  const asError = o => as(t.red + t.bold, o);
+  const asWarning = o => as(t.yellow, o);
+  const asInfo = o => as(t.green, o);
+  const asHelp = o => as(t.cyan, o);
+
+  const underline = o => as(t.underline, o);
+  const bold = o => as(t.bold, o);
+
+  const asSeverity = (severity, msg) => {
+    switch ((`${ severity }`).toLowerCase()) {
+      case 'error': return asError(msg);
+      case 'warning': return asWarning(msg);
+      case 'info': return asInfo(msg);
+      case 'help': return asHelp(msg);
+      // or e.g. 'none'
+      default: return msg;
+    }
+  };
+
+  return {
+    changeColorMode,
+    as,
+    underline,
+    bold,
+
+    severity: asSeverity,
+    error: asError,
+    warn: asWarning,
+    info: asInfo,
+    help: asHelp,
+  };
+}
+
+module.exports = { term };

package/lib/utils/timetrace.js

@@ -5,7 +5,7 @@
  *
  * @class TimeTrace
  */
-class TimeTrace {
+class StopWatch {
   /**
    * Creates an instance of TimeTrace.
    * @param {string} id
@@ -13,29 +13,46 @@ class TimeTrace {
    * @memberOf TimeTrace
    */
   constructor(id) {
-    let startTime;
-    /**
-     * Start measuring.
-     *
-     * @param {number} indent
-     */
-    this.start = function start(indent) {
-      // eslint-disable-next-line no-console
-      console.error(`${ ' '.repeat((indent) * 2) }${ id } started`);
-      startTime = process.hrtime();
-    };
+    this.id = id;
+    // eslint-disable-next-line no-multi-assign
+    this.startTime = this.lapTime = process.hrtime();
+  }
 
-    /**
-     * Stop measuring and log the result
-     *
-     * @param {number} indent
+  /**
+     * Start watch.
      */
-    this.stop = function stop(indent) {
-      const endTime = process.hrtime(startTime);
-      const base = `${ ' '.repeat(indent * 2) }${ id } took:`;
-      // eslint-disable-next-line no-console
-      console.error( `${ base }${ ' '.repeat(60 - base.length) } %ds %dms`, endTime[0], endTime[1] / 1000000);
-    };
+  start() {
+    // eslint-disable-next-line no-multi-assign
+    this.startTime = this.lapTime = process.hrtime();
+  }
+
+  /**
+   * Stop and return delta T
+   * but do not set start time
+   */
+  stop() {
+    return process.hrtime(this.startTime);
+  }
+
+  /**
+   * return lap time
+   */
+  lap() {
+    const dt = process.hrtime(this.lapTime);
+    this.lapTime = process.hrtime();
+    return dt;
+  }
+
+  // stop as sec.ns float
+  stopInFloatSecs() {
+    const dt = this.stop();
+    return dt[0] + dt[1] / 1000000000;
+  }
+
+  // lap as sec.ns float
+  lapInFloatSecs() {
+    const dt = this.lap();
+    return dt[0] + dt[1] / 1000000000;
   }
 }
 
@@ -67,9 +84,11 @@ class TimeTracer {
    */
   start(id) {
     try {
-      const b = new TimeTrace(id);
+      const b = new StopWatch(id);
       this.traceStack.push(b);
-      b.start(this.traceStack.length - 1);
+      b.start();
+      // eslint-disable-next-line no-console
+      console.error(`${ ' '.repeat((this.traceStack.length - 1) * 2) }${ id } started`);
     }
     catch (e) {
       // eslint-disable-next-line no-console
@@ -86,7 +105,10 @@ class TimeTracer {
   stop() {
     try {
       const current = this.traceStack.pop();
-      current.stop(this.traceStack.length);
+      const dT = current.stop();
+      const base = `${ ' '.repeat(this.traceStack.length * 2) }${ current.id } took:`;
+      // eslint-disable-next-line no-console
+      console.error( `${ base }${ ' '.repeat(60 - base.length) } %ds %dms`, dT[0], dT[1] / 1000000);
     }
     catch (e) {
       // eslint-disable-next-line no-console
@@ -101,4 +123,4 @@ const ignoreTimeTrace = {
 };
 
 const doTimeTrace = process && process.env && process.env.CDSC_TIMETRACING !== undefined;
-module.exports = doTimeTrace ? new TimeTracer() : ignoreTimeTrace;
+module.exports = { timetrace: (doTimeTrace ? new TimeTracer() : ignoreTimeTrace), StopWatch };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/cds-compiler",
-  "version": "2.5.2",
+  "version": "2.11.0",
   "description": "CDS (Core Data Services) compiler and backends",
   "homepage": "https://cap.cloud.sap/",
   "author": "SAP SE (https://www.sap.com)",

package/lib/json/walker.js

@@ -1,26 +0,0 @@
-/**
- * Walker module provides non-recursive tree walkers with different flavours
- * @module json/walker
- */
-
-/**
- * Callback of the forEach function called for each node it walks
- * @callback forEachCallback
- * @param {string} name of the node
- * @param {object} node
- */
-
-/**
- * Loops over all elements in an object and calls the specified callback(key,obj)
- * @param {object} obj
- * @param {forEachCallback} callback
- */
-function forEach(obj, callback) {
-  for(var key in obj) {
-    callback(key, obj[key]);
-  }
-}
-
-module.exports = {
-  forEach,
-}

package/lib/utils/string.js

@@ -1,17 +0,0 @@
-'use strict';
-
-// String utils
-
-/**
- * Removes duplicate entries from the given string array.
- *
- * @param {string[]} strings Array of strings with duplicates
- * @returns {string[]} strings New array with unique strings
- */
-function uniqueStrings(strings) {
-  return [ ...new Set(strings) ];
-}
-
-module.exports = {
-  uniqueStrings,
-};