@sap/cds-compiler 2.10.4 → 2.11.0

package/lib/model/csnUtils.js

@@ -2,6 +2,7 @@
 
 const { setProp } = require('../base/model');
 const { csnRefs } = require('../model/csnRefs');
+const { isBuiltinType } = require('../compiler/builtins.js')
 const { sortCsn, cloneCsnDictionary: _cloneCsnDictionary } = require('../json/to-csn');
 const version = require('../../package.json').version;
 
@@ -11,8 +12,8 @@ const version = require('../../package.json').version;
  * Generic Callback
  *
  * @callback genericCallback
- * @param {CSN.Artifact} art
- * @param {CSN.FQN} name Artifact Name
+ * @param {any} art
+ * @param {string} name Artifact Name
  * @param {string} prop Dictionary Property
  * @param {CSN.Path} path Location
  * @param {CSN.Artifact} [dictionary]
@@ -457,8 +458,8 @@ function getUtils(model) {
       return resultNode;
     }
   }
-  
-  
+
+
   /**
    * Resolve to the final type of a type, that means follow type chains, references to other types or
    * elements a.s.o
@@ -497,12 +498,12 @@ function getUtils(model) {
    * Composed types (structures, entities, views, ...) are returned as type objects, if not drilled down into
    * the elements. Path steps that have no corresponding element lead to 'undefined'. Refs to something that has
    * no type (e.g. expr in a view without explicit type) returns 'null'
-   * 
+   *
    * @param {string|object} type Type - either string or ref
-   * @param {CSN.Path} path 
+   * @param {CSN.Path} path
    * @param {WeakMap} [resolved=new WeakMap()] WeakMap containing already resolved refs - if a ref is not cached, it will be resolved JIT
-   * @param {object} [cycleCheck] Dictionary to remember already resolved types - to be cycle-safe 
-   * @returns 
+   * @param {object} [cycleCheck] Dictionary to remember already resolved types - to be cycle-safe
+   * @returns
    */
   function getFinalBaseType(type, path = [], resolved = new WeakMap(), cycleCheck = undefined) {
     if (!type)
@@ -552,16 +553,6 @@ function getUtils(model) {
   }
 }
 
-// Tell if a type is (directly) a builtin type
-// Note that in CSN builtins are not in the definition of the model, so we can only check against their absolute names.
-// Builtin types are "cds.<something>", i.e. they are directly in 'cds', but not for example
-// in 'cds.foundation'. Also note, that a type might be a ref object, that refers to something else,
-// so if you consider type chains don't forget first to resolve to the final type before
-function isBuiltinType(type) {
-  return typeof(type) === 'string' && type.startsWith('cds.') && !type.startsWith('cds.foundation.')
-}
-
-
 /**
  * Deeply clone the given CSN model and return it.
  * In testMode (or with testSortCsn), definitions are sorted.
@@ -817,11 +808,25 @@ function forAllQueries(query, callback, path = []){
   }
 }
 
-function forAllElements(artifact, artifactName, cb){
+function forAllElements(artifact, artifactName, cb, includeActions = false){
   if(artifact.elements) {
     cb(artifact, artifact.elements, ['definitions', artifactName, 'elements']);
   }
 
+  if(includeActions && artifact.actions) {
+    Object.entries(artifact.actions).forEach( ([actionName, action]) => {
+      const path = ['definitions', artifactName, 'actions', actionName];
+      if(action.params) {
+        Object.entries(action.params).forEach( ([paramName, param]) => {
+          if(param.elements)
+            cb(param, param.elements, path.concat(['params', paramName, 'elements']));
+        });
+      }
+      if(action.returns && action.returns.elements)
+        cb(action.returns, action.returns.elements,path.concat(['returns', 'elements']));
+    });
+  }
+
   if(artifact.query) {
     forAllQueries(artifact.query, (q, p) => {
       const s = q.SELECT;
@@ -871,7 +876,7 @@ function hasAnnotationValue(artifact, annotationName, expected = true) {
  * function accepts EDM internal and external options
  *
  * @param {CSN.Element} elementCsn
- * @param {CSN.Options & CSN.ODataOptions} options EDM specific options
+ * @param {ODataOptions} options EDM specific options
  */
 function isEdmPropertyRendered(elementCsn, options) {
   if(options.toOdata)
@@ -921,10 +926,10 @@ function getArtifactDatabaseNameOf(artifactName, namingConvention, csn) {
       throw new Error('Unknown naming convention: ' + namingConvention);
     }
   else {
-    const namespace = csn;
     console.error(`This invocation of "getArtifactCdsPersistenceName" is deprecated, as it doesn't produce correct output with definition names containing dots - please provide a CSN as the third parameter.`);
     if (namingConvention === 'hdbcds') {
-      if (namespace) {
+      if (csn) {
+        const namespace = String(csn);
         return `${namespace}::${artifactName.substring(namespace.length + 1)}`;
       }
       return artifactName;
@@ -1532,7 +1537,7 @@ function sortCsnDefinitionsForTests(csn, options) {
   if (!options.testMode)
     return;
   const sorted = Object.create(null);
-  Object.keys(csn.definitions).sort().forEach((name) => {
+  Object.keys(csn.definitions || {}).sort().forEach((name) => {
     sorted[name] = csn.definitions[name];
   });
   csn.definitions = sorted;
@@ -1542,7 +1547,7 @@ function sortCsnDefinitionsForTests(csn, options) {
  * Return an array of non-abstract service names contained in CSN
  *
  * @param {CSN.Model} csn
- * @returns {CSN.Service[]}
+ * @returns {string[]}
  */
 function getServiceNames(csn) {
   let result = [];
@@ -1556,8 +1561,8 @@ function getServiceNames(csn) {
 
 /**
  * Check wether the artifact is @cds.persistence.skip
- * 
- * @param {CSN.Artifact} artifact 
+ *
+ * @param {CSN.Artifact} artifact
  * @returns {Boolean}
  */
 function isSkipped(artifact) {
@@ -1566,9 +1571,9 @@ function isSkipped(artifact) {
 
 /**
  * Walk path in the CSN and return the result.
- * 
- * @param {CSN.Model} csn 
- * @param {CSN.Path} path 
+ *
+ * @param {CSN.Model} csn
+ * @param {CSN.Path} path
  * @returns {object} Whatever is at the end of path
  */
 function walkCsnPath(csn, path) {
@@ -1581,6 +1586,34 @@ function walkCsnPath(csn, path) {
   return obj;
 }
 
+/**
+ * If provided, get the replacement string for the given magic variable ref.
+ * No validation is done that the ref is actually magic!
+ * 
+ * @param {array} ref 
+ * @param {CSN.Options} options 
+ * @returns {string|null} 
+ */
+function getVariableReplacement(ref, options) {
+  if(options && options.variableReplacements) {
+    let replacement = options.variableReplacements;
+    for(let i = 0; i < ref.length; i++) {
+      replacement = replacement[ref[i]];
+      if(replacement === undefined)
+        return null;
+    }
+
+    if(replacement === undefined)
+      return null; // no valid replacement found
+    else if(typeof replacement === 'string')
+      return replacement; // valid replacement
+    else
+      return null; // $user.foo, but we only have configured $user.foo.bar -> error
+  } else {
+    return null;
+  }
+}
+
 module.exports = {
   getUtils,
   cloneCsn,
@@ -1621,4 +1654,5 @@ module.exports = {
   getServiceNames,
   isSkipped,
   walkCsnPath,
+  getVariableReplacement
 };

package/lib/model/enrichCsn.js

@@ -39,6 +39,8 @@ function enrichCsn( csn, options = {} ) {
     params: dictionary,
     enum: dictionary,
     mixin: dictionary,
+    returns: definition,
+    items: definition,
     ref: pathRef,
     type: simpleRef,
     targetAspect: simpleRef,
@@ -81,10 +83,19 @@ function enrichCsn( csn, options = {} ) {
     csnPath.pop();
   }
 
+  function definition( parent, prop, obj ) {
+    const origin = getOrigin( obj ); // before standard for implicit protos inside
+    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;
@@ -123,13 +134,17 @@ function enrichCsn( csn, options = {} ) {
 
   function $origin( parent, prop, ref ) {
     if (options.testMode) {
-      if (Array.isArray( ref ))  // $origin: […], not $origin: {…}
-        parent._origin = refLocation( getOrigin( parent ) );
+      if (Array.isArray( ref ) || typeof ref === 'string') // $origin: […], not $origin: {…}
+        parent._origin = refLocation( getOrigin( parent, true ) );
+      else if ( ref )
+        standard( parent, prop, ref )
     }
     else {
       try {
-        if (Array.isArray( ref ))  // $origin: […], not $origin: {…}
-          parent._origin = refLocation( getOrigin( parent ) );
+        if (Array.isArray( ref ) || typeof ref === 'string')  // $origin: […], not $origin: {…}
+          parent._origin = refLocation( getOrigin( parent, true ) );
+        else if ( ref )
+          standard( parent, prop, ref )
       } catch (e) {
         parent._origin = e.toString();
       }
@@ -171,10 +186,10 @@ function enrichCsn( csn, options = {} ) {
     csnPath.pop();
   }
 
-  function _cache_debug( obj ) {
+  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 +212,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 ) {

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,10 @@ 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('    --deprecated <list>')
   .option('    --hana-flavor')
   .option('    --direct-backend')
@@ -39,7 +41,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 +78,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 +94,23 @@ 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 
        --deprecated <list>  Comma separated list of deprecated options.
                             Valid values are:
                               noElementsExpansion
@@ -130,7 +141,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 +151,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 +161,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 +184,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 +250,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 +275,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 +322,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 +370,7 @@ optionProcessor.command('toCsn')
 
 optionProcessor.command('parseCdl')
   .option('-h, --help')
+  .positionalArgument('<file>')
   .help(`
   Usage: cdsc parseCdl [options] <file>
 
@@ -375,14 +383,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/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];
@@ -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