@sap/cds-compiler 2.10.2 → 2.11.4

package/lib/model/enrichCsn.js

@@ -14,16 +14,22 @@
 // Other enumerable properties in the JSON for non-enumerable properties in the
 // original CSN:
 
-// * `$env` for the non-enumerable `$env` property in the original CSN.
-// * `$elements` for a non-enumerable `elements` property for sub queries.
+// * `$parens`: the number of parentheses provided by the user around an expression
+//   or query if the number is different to the usual (mostly 0, sometimes 1).
+// * `$elements` (in client-style CSN only) for a non-enumerable `elements` property
+//   for sub queries.
 
 // The following properties in the JSON represent the result of the CSN API
 // functions:
 
-// * `_type`, `_includes` and `_targets` have as values the `$locations` of the
+// * `_type`, `_includes` and `_targets` have as values the `$location`s of the
 //   referred artifacts which are returned by function `artifactRef`.
-// * `_links`, `_art` and `_scope` as sibling properties of `ref` have as values
-//   the `$locations` of the artifacts/members returned by function `inspectRef`.
+// * `_links` and `_art` as sibling properties of `ref` have as values the
+//   `$locations` of the artifacts/members returned by function `inspectRef`.
+// * `_scope` and `_env` as sibling properties of `ref` have (string) values,
+//   returned by function `inspectRef`, giving add/ info about the “ref base”.
+// * `_origin` (in Universal CSN only) has as value the `$location` of the
+//   prototype returned by function getOrigin().
 
 'use strict';
 
@@ -32,13 +38,14 @@ const { locationString } = require('../base/location');
 
 function enrichCsn( csn, options = {} ) {
   const transformers = {
-    // $env: reveal,
     elements: dictionary,
     definitions: dictionary,
     actions: dictionary,
     params: dictionary,
     enum: dictionary,
     mixin: dictionary,
+    returns: definition,
+    items: definition,
     ref: pathRef,
     type: simpleRef,
     targetAspect: simpleRef,
@@ -81,10 +88,20 @@ function enrichCsn( csn, options = {} ) {
     csnPath.pop();
   }
 
+  function definition( parent, prop, obj ) {
+    // call getOrigin() before standard() to set implicit protos inside standard():
+    const origin = handleError( err => err ? err.toString() : getOrigin( obj ) );
+    standard( parent, prop, obj );
+    if (obj.$origin === undefined && origin != null)
+      obj._origin = refLocation( origin );
+  }
+
   function dictionary( parent, prop, dict ) {
+    if (!dict)                  // value null for inheritance interruption
+      return;
     csnPath.push( prop );
     for (let name of Object.getOwnPropertyNames( dict )) {
-      standard( dict, name, dict[name] );
+      definition( dict, name, dict[name] );
     }
     if (!Object.prototype.propertyIsEnumerable.call( parent, prop ))
       parent['$'+prop] = dict;
@@ -92,10 +109,10 @@ function enrichCsn( csn, options = {} ) {
   }
 
   function refLocation( art ) {
-    if (art)
+    if (art && typeof art === 'object')
       return art.$location || '<no location>';
     if (!options.testMode)
-      return '<illegal link>';
+      return art || '<illegal link>';
     throw new Error( 'Undefined reference' );
   }
 
@@ -122,33 +139,19 @@ function enrichCsn( csn, options = {} ) {
   }
 
   function $origin( parent, prop, ref ) {
-    if (options.testMode) {
-      if (Array.isArray( ref ))  // $origin: […], not $origin: {…}
-        parent._origin = refLocation( getOrigin( parent ) );
-    }
-    else {
-      try {
-        if (Array.isArray( ref ))  // $origin: […], not $origin: {…}
-          parent._origin = refLocation( getOrigin( parent ) );
-      } catch (e) {
-        parent._origin = e.toString();
-      }
-    }
+    handleError( err => {
+      if (err)
+        parent._origin = err.toString();
+      else if (Array.isArray( ref ) || typeof ref === 'string') // $origin: […], not $origin: {…}
+        parent._origin = refLocation( getOrigin( parent, true ) );
+      else if ( ref )
+        standard( parent, prop, ref );
+    } );
   }
 
   function pathRef( parent, prop, path ) {
-    const { links, art, scope, $env } = (() => {
-      if (options.testMode)
-        return inspectRef( csnPath );
-      else {
-        try {
-          return inspectRef( csnPath );
-        }
-        catch (e) {
-          return { scope: e.toString() };
-        }
-      }
-    } )();
+    const { links, art, scope, $env }
+          = handleError( err => (err) ? { scope: err.toString() } : inspectRef( csnPath ) );
     if (links)
       parent._links = links.map( l => refLocation( l.art ) );
     if (links && links[links.length-1].art !== art)
@@ -171,10 +174,20 @@ function enrichCsn( csn, options = {} ) {
     csnPath.pop();
   }
 
-  function _cache_debug( obj ) {
+  function handleError( callback ) {
+    if (options.testMode)
+      return callback();
+    try {
+      return callback();
+    } catch (err) {
+      return callback( err );
+    }
+  }
+
+  function _cache_debug( obj, subCache ) {
     if (options.enrichCsn !== 'DEBUG')
       return;
-    const cache = __getCache_forEnrichCsnDebugging( obj );
+    const cache = subCache || __getCache_forEnrichCsnDebugging( obj );
     if (!cache)
       return;
     if (cache.$$objectNumber > 0) {
@@ -197,8 +210,20 @@ function enrichCsn( csn, options = {} ) {
         }
         else if (name[0] !== '$' || !Object.getPrototypeOf( val )) {
           // ‹name›: dictionary of CSN nodes,
-          // ‹$name›: dictionary of cache values if no prototype,
-          obj.$$cacheObject[name] = Object.keys( val ); // TODO: or dict?
+          // ‹$name›: dictionary of cache values if no prototype
+          if (name !== '$aliases') {
+            obj.$$cacheObject[name] = Object.keys( val ); // TODO: or dict?
+          }
+          else {
+            const sub = Object.create(null);
+            for (const n in val) {
+              const alias = val[n];
+              const c = {};
+              _cache_debug( c, alias );
+              sub[n] = c.$$cacheObject;
+            }
+            obj.$$cacheObject[name] = sub;
+          }
         }
         else if (Array.isArray( val )) {
           obj.$$cacheObject[name] = val.map( item => {

package/lib/model/revealInternalProperties.js

@@ -13,6 +13,8 @@
 
 const msg = require('../base/messages');
 
+const $inferred = Symbol.for('cds.$inferred');
+
 class NOT_A_DICTIONARY {}       // used for consol.log display
 
 function locationString( loc ) {
@@ -32,15 +34,22 @@ const kindsRepresentedAsLinks = {
   // represent SELECTs in query / SET-args property as link:
   select: (art, parent) => art._main && parent !== art._main.$queries,
   // represent table alias in from / join-args property as link:
-  $tableAlias: (art, parent) => art._parent && parent !== art._parent.$tableAliases,
-  // represent table alias in JOIN node as link:
+  $tableAlias: tableAliasAsLink,
+  // represent "navigation elemens" in _combined as links:
   $navElement: (art, parent) => art._parent && parent !== art._parent.elements,
   // represent mixin in $tableAliases as link:
-  mixin: (art, parent) => art._parent && parent !== art._parent.mixin,
+  mixin: tableAliasAsLink,
   // represent $projection as link, as it is just another search name for $self:
   $self: (_a, _p, name) => name !== '$self',
 }
 
+function tableAliasAsLink( art, parent, name ) {
+  return art._parent && art._parent.$tableAliases && // initXYZ() is run
+    parent !== art._parent.$tableAliases &&          // not in $tableAliases
+    !(art.$duplicates === true && name &&            // and its $duplicates
+      parent === art._parent.$tableAliases[name].$duplicates);
+}
+
 function revealInternalProperties( model, name ) {
   const transformers = {
     messages: m => m,
@@ -65,6 +74,7 @@ function revealInternalProperties( model, name ) {
     mixin: dictionary,
     args: dictionary,
     $tableAliases: dictionary,
+    $duplicates: duplicates,
     $keysNavigation: dictionary,
     $layerNumber: n => n,
     $extra: e => e,
@@ -203,6 +213,8 @@ function revealInternalProperties( model, name ) {
     for (let prop of Object.getOwnPropertyNames( node )) { // also non-enumerable
       r[prop] = reveal( node[prop], node, prop );
     }
+    if (node[$inferred] && !node['[$inferred]'])
+      r['[$inferred]'] = node[$inferred];
     return r;
   }
 
@@ -228,7 +240,7 @@ function revealInternalProperties( model, name ) {
     if (node == null || typeof node !== 'object' )
       return node
     if (Array.isArray(node))
-      return node.map( n => reveal( n, node ) );
+      return node.map( n => reveal( n, node, name ) );
 
     const asLinkTest = kindsRepresentedAsLinks[ node.kind ];
     if (asLinkTest && asLinkTest( node, parent, name ))
@@ -246,6 +258,10 @@ function revealInternalProperties( model, name ) {
     }
     return r;
   }
+
+  function duplicates( node, parent ) {
+    return reveal( node, parent, parent.name && parent.name.id );
+  }
 }
 
 function artifactIdentifier( node, parent ) {
@@ -255,12 +271,13 @@ function artifactIdentifier( node, parent ) {
     Object.defineProperty( node, '__unique_id__', { value: ++unique_id } );
   let outer = unique_id ? '##' + node.__unique_id__ : '';
   if (node._outer) {
-    outer = (node._outer.items === node) ? '/items'
-      : (node._outer.returns === node) ? '/returns' : '/returns/items';
+    if (node.$inferred === 'REDIRECTED')
+      outer = '/redirected';
+    else
+      outer = (node._outer.items === node) ? '/items'
+            : (node._outer.returns === node) ? '/returns' : '/returns/items';
     node = node._outer;
   }
-  else if (node.$inferred === 'REDIRECTED')
-    outer = '/redirected';
   if (node === parent)
     return 'this';
   if (node.kind === 'source')

package/lib/model/sortViews.js

@@ -79,7 +79,7 @@ function sortTopologically(csn, _dependents, _dependencies){
 /**
  * Sort the given sql statements so that they can be deployed sequentially.
  * For ordering, only the FROM clause of views is checked - this requires A2J to
- * be run beforehand to resovle association usages.
+ * be run beforehand to resolve association usages.
  *
  * @param {object} sql Map of <object name>: "CREATE STATEMENT"
  *
@@ -96,5 +96,12 @@ module.exports = function({sql, csn}){
   const result = [];
   // keep the "artifact name" - needed for to.hdi sorting
   layers.forEach(layer => layer.forEach(objName => result.push({name: objName, sql: sql[objName]})));
+  // attach sql artifacts which are not considered during the view sorting algorithm
+  // --> this is the case for "ALTER TABLE ADD CONSTRAINT" statements,
+  //     because their identifiers are not part of the csn.definitions
+  Object.entries(sql).forEach(([ name, sqlString ]) => {
+    if (!result.some( o => o.name === name )) // not in result but in incoming sql
+      result.push({ name, sql: sqlString })
+  });
   return result;
 }

package/lib/modelCompare/compare.js

@@ -12,11 +12,12 @@ const {
  *
  * @param beforeModel the before-model
  * @param afterModel the after-model
- * @param {hdiOptions|false} options
+ * @param {import('../api/main.js').hdiOptions|false} options
  * @returns {object} the sets of deletions, extensions, and migrations of entities necessary to transform the before-model
  * to the after-model, together with all the definitions of the after-model
  */
 function compareModels(beforeModel, afterModel, options) {
+  // @ts-ignore
   if(!(options && options.testMode)) // no $version with testMode
     validateCsnVersions(beforeModel, afterModel, options);
 

package/lib/optionProcessor.js

@@ -27,8 +27,11 @@ optionProcessor
   .option('    --internal-msg')
   .option('    --beta-mode')
   .option('    --beta <list>')
-  .option('    --constraints-not-validated')
-  .option('    --constraints-not-enforced')
+  .option('    --integrity-not-validated')
+  .option('    --integrity-not-enforced')
+  .option('    --assert-integrity <mode>', [ 'true', 'false', 'individual' ])
+  .option('    --assert-integrity-type <type>', [ 'RT', 'DB' ])
+  .option('    --constraints-as-alter <boolean>')
   .option('    --deprecated <list>')
   .option('    --hana-flavor')
   .option('    --direct-backend')
@@ -39,7 +42,8 @@ optionProcessor
   .option('    --doc-comment')
   .option('    --add-texts-language-assoc')
   .option('    --localized-without-coalesce')
-  .option('    --defaultStringLength <length>')
+  .option('    --default-binary-length <length>')
+  .option('    --default-string-length <length>')
   .option('    --no-recompile')
   .positionalArgument('<files...>')
   .help(`
@@ -75,7 +79,8 @@ optionProcessor
        --                   Indicate the end of options (helpful if source names start with "-")
 
   Type options
-       --defaultStringLength <length> Default 'length' for 'cds.String'
+       --default-binary-length <length> Default 'length' for 'cds.Binary'
+       --default-string-length <length> Default 'length' for 'cds.String'
 
   Diagnostic options
        --trace-parser       Trace parser
@@ -90,16 +95,26 @@ optionProcessor
        --beta-mode          Enable all unsupported, incomplete (beta) features
        --beta <list>        Comma separated list of unsupported, incomplete (beta) features to use.
                             Valid values are:
-                              foreignKeyConstraints
                               addTextsLanguageAssoc
                               hanaAssocRealCardinality
                               mapAssocToJoinCardinality
                               ignoreAssocPublishingInUnion
-                              windowFunctions
-       --constraints-not-enforced  If this option is supplied, referential constraints are NOT ENFORCED
-                                   This option is also applied to result of "cdsc manageConstraints"
-       --constraints-not-validated If this option is supplied, referential constraints are NOT VALIDATED
-                                   This option is also applied to result of "cdsc manageConstraints"
+       --integrity-not-enforced          If this option is supplied, referential constraints are NOT ENFORCED.
+                                         This option is also applied to result of "cdsc manageConstraints"
+       --integrity-not-validated         If this option is supplied, referential constraints are NOT VALIDATED.
+                                         This option is also applied to result of "cdsc manageConstraints"
+       --assert-integrity      <mode>    Turn DB constraints on/off:
+                                           true        : Constraints will be generated for all associations if 
+                                                         the assert-integrity-type is set to DB
+                                           false       : No constraints will be generated
+                                           individual  : Constraints will be generated for selected associations
+       --assert-integrity-type <type>  Specifies how the referential integrity checks should be performed:
+                                           RT : (default) No database constraint for an association
+                                               if not explicitly demanded via annotation
+                                           DB : Create database constraints for associations
+       --constraints-as-alter <boolean>  If set to 'true', the foreign key constraints will be rendered as 
+                                         "ALTER TABLE ADD CONSTRAINT" statement rather than being part of the
+                                         "CREATE TABLE" statement
        --deprecated <list>  Comma separated list of deprecated options.
                             Valid values are:
                               noElementsExpansion
@@ -130,7 +145,7 @@ optionProcessor
                                     to "sap.common.Languages" if it exists
        --localized-without-coalesce Omit coalesce in localized convenience views
        --no-recompile       Don't recompile in case of internal errors
-  
+
   Commands
     H, toHana [options] <files...>              Generate HANA CDS source files
     O, toOdata [options] <files...>             Generate ODATA metadata and annotations
@@ -140,7 +155,7 @@ optionProcessor
        parseCdl [options] <file>                Generate a CSN that is close to the CDL source.
        explain <message-id>                     Explain a compiler message.
        toRename [options] <files...>            (internal) Generate SQL DDL rename statements
-       manageConstraints [options] <files...>    (internal) Generate ALTER TABLE statements to
+       manageConstraints [options] <files...>   (internal) Generate ALTER TABLE statements to
                                                            add / modify referential constraints.
 `);
 
@@ -150,7 +165,6 @@ optionProcessor.command('H, toHana')
   .option('-n, --names <style>', ['plain', 'quoted', 'hdbcds'])
   .option('    --render-virtual')
   .option('    --joinfk')
-  .option('    --skip-db-constraints')
   .option('-u, --user <user>')
   .option('-s, --src')
   .option('-c, --csn')
@@ -174,7 +188,6 @@ optionProcessor.command('H, toHana')
                                          using element names with dots).
        --render-virtual       Render virtual elements in views and draft tables
        --joinfk               Create JOINs for foreign key accesses
-       --skip-db-constraints  Do not render referential constraints for associations
    -u, --user <user>          Value for the "$user" variable
    -s, --src                  (default) Generate HANA CDS source files "<artifact>.hdbcds"
    -c, --csn                  Generate "hana_csn.json" with HANA-preprocessed model
@@ -241,7 +254,6 @@ optionProcessor.command('Q, toSql')
   .option('-n, --names <style>', ['plain', 'quoted', 'hdbcds'])
   .option('    --render-virtual')
   .option('    --joinfk')
-  .option('    --skip-db-constraints')
   .option('-d, --dialect <dialect>', ['hana', 'sqlite', 'plain'])
   .option('-u, --user <user>')
   .option('-l, --locale <locale>')
@@ -267,7 +279,6 @@ optionProcessor.command('Q, toSql')
                                          combination with "hana" dialect.
        --render-virtual       Render virtual elements in views and draft tables
        --joinfk               Create JOINs for foreign key accesses
-       --skip-db-constraints  Do not render referential constraints for associations
    -d, --dialect <dialect>    SQL dialect to be generated:
                                 plain  : (default) Common SQL - no assumptions about DB restrictions
                                 hana   : SQL with HANA specific language features
@@ -315,7 +326,7 @@ optionProcessor.command('manageConstraints')
 
   (internal, subject to change): Generate SQL DDL ALTER TABLE statements to add / modify
   referential constraints on an existing model.
-  Combine with options "--constraints-not-enforced" and "--constraint-not-validated"
+  Combine with options "--integrity-not-enforced" and "--integrity-not-validated"
   to switch off foreign key constraint enforcement / validation.
 
   Options
@@ -363,6 +374,7 @@ optionProcessor.command('toCsn')
 
 optionProcessor.command('parseCdl')
   .option('-h, --help')
+  .positionalArgument('<file>')
   .help(`
   Usage: cdsc parseCdl [options] <file>
 
@@ -375,14 +387,17 @@ optionProcessor.command('parseCdl')
 
 optionProcessor.command('explain')
   .option('-h, --help')
+  .positionalArgument('<message-id>')
   .help(`
   Usage: cdsc explain [options] <message-id>
 
   Explain the compiler message that has the given message-id.
   The explanation contains a faulty example and a solution.
 
+  Use \`explain list\` to list all available messages.
+
   Options
-   -h, --help             Show this help text
+   -h, --help        Show this help text
 `);
 
 module.exports = {

package/lib/render/.eslintrc.json

@@ -13,8 +13,7 @@
     // Who cares - just very whiny and in the way
     "complexity": "off",
     "max-len": "off",
-    // We should enable this
-    "no-shadow": "off"
+    "no-shadow": "warn"
   },
   "env": {
     "es6": true

package/lib/render/DuplicateChecker.js

@@ -44,7 +44,7 @@ class DuplicateChecker {
    * Add an artifact to the "seen"-list
    *
    * @param {string} name Persistence name of the artifact
-   * @param {CSN.Location} location CSN location of the artifact
+   * @param {CSN.Location|CSN.Path} location CSN location of the artifact
    * @param {string} modelName CSN artifact name
    */
   addArtifact( name, location, modelName ) {

package/lib/render/toCdl.js

@@ -10,7 +10,7 @@ const {
 const keywords = require('../base/keywords');
 const { renderFunc, beautifyExprArray, findElement } = require('./utils/common');
 const { checkCSNVersion } = require('../json/csnVersion');
-const timetrace = require('../utils/timetrace');
+const { timetrace } = require('../utils/timetrace');
 const { csnRefs } = require('../model/csnRefs');
 const { forEachDefinition } = require('../model/csnUtils');
 const enrichUniversalCsn = require('../transform/universalCsnEnricher');
@@ -579,7 +579,7 @@ function toCdsSourceCsn(csn, options) {
    * @return {string}
    */
   function renderQueryActionsAndFunctions(artifactName, art, env) {
-    let result = renderDocComment(art, env) + renderActionsAndFunctions(art, env);
+    let result = renderActionsAndFunctions(art, env);
     // Even if we have seen actions/functions, they might all have been ignored
     if (result !== '')
       result = `${env.indent}extend entity ${artifactName} with${result};`;
@@ -612,7 +612,7 @@ function toCdsSourceCsn(csn, options) {
     }
     // Now iterate elements - render an annotation if it is different from the column's
     const childEnv = increaseIndent(env);
-    let result = renderDocComment(art, env);
+    let result = '';
     for (const elemName in art.elements) {
       let elemAnnotations = '';
       const elem = art.elements[elemName];
@@ -715,7 +715,7 @@ function toCdsSourceCsn(csn, options) {
 
     // Even the first step might have parameters and/or a filter
     if (path.ref[0].args)
-      result += `(${renderArgs(path.ref[0].args, ':', env)})`;
+      result += `(${renderArgs(path.ref[0], ':', env)})`;
 
     if (path.ref[0].where)
       result += `[${path.ref[0].cardinality ? (`${path.ref[0].cardinality.max}: `) : ''}${renderExpr(path.ref[0].where, env, true, true)}]`;
@@ -1404,6 +1404,12 @@ function toCdsSourceCsn(csn, options) {
         // FIXME: no extra magic with x.param or x.global
         return `${(x.param || x.global) ? ':' : ''}${x.ref.map(renderPathStep).join('.')}`;
       }
+      else if (x.xpr && x.func) {
+        // window function
+        const funcDef = renderFunc( x.func, x, null, a => renderArgs(a, '=>', env) );
+        const windowFunctionOperator = x.xpr.shift(); // OVER ...
+        return `${funcDef} ${windowFunctionOperator} ( ${renderExpr(x.xpr, env, true)} )`;
+      }
       // Function call, possibly with args (use '=>' for named args)
       else if (x.func) {
         // test for non-regular HANA identifier that needs to be quoted
@@ -1474,13 +1480,13 @@ function toCdsSourceCsn(csn, options) {
 
         // Not really a path step but an object-like function call
         if (s.func)
-          return `${s.func}(${renderArgs(s.args, '=>', env)})`;
+          return `${s.func}(${renderArgs(s, '=>', env)})`;
 
         // Path step, possibly with view parameters and/or filters
         let result = `${quoteOrUppercaseId(s.id)}`;
         if (s.args) {
           // View parameters
-          result += `(${renderArgs(s.args, ':', env)})`;
+          result += `(${renderArgs(s, ':', env)})`;
         }
         if (s.where) {
           // Filter, possibly with cardinality
@@ -1498,12 +1504,13 @@ function toCdsSourceCsn(csn, options) {
    * Render function arguments or view parameters (positional if array, named if object/dict),
    * using 'sep' as separator for positional parameters
    *
-   * @param {object[]|object} args (Un)Named arguments
+   * @param {object} node with `args` to render
    * @param {string} sep
    * @param {CdlRenderEnvironment} env
    * @returns {string}
    */
-  function renderArgs(args, sep, env) {
+  function renderArgs(node, sep, env) {
+    const args = node.args ? node.args : {};
     // Positional arguments
     if (Array.isArray(args))
       return args.map(arg => renderExpr(arg, env)).join(', ');