@sap/cds-compiler 2.5.2 → 2.11.0

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,
@@ -76,6 +86,7 @@ function revealInternalProperties( model, name ) {
     _annotate: reveal,
     _deps: dependencyInfo,
     _status: primOrString,       // is a string anyway
+    $messageFunctions: () => '‹some functions›',
   }
   unique_id = 1;
   return revealXsnPath(name, model);
@@ -159,7 +170,7 @@ function revealInternalProperties( model, name ) {
 
   function columns( nodes, query ) {
     // If we will have specified elements, we need another test to see columns in --parse-cdl
-    return nodes && nodes.map( c => (c._parent && c._parent.elements && c.kind !== '$inline')
+    return nodes && nodes.map( c => (c._parent && c._parent.elements)
                                     ? artifactIdentifier( c, query )
                                     : reveal( c, nodes ) );
   }
@@ -202,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;
   }
 
@@ -227,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 ))
@@ -245,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,27 +12,28 @@ 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);
 
   const deletedEntities = Object.create(null);
   const elementAdditions = [];
-  const elementChanges = [];
+  const migrations = []; // element changes/removals or changes of entity properties
 
   // There is currently no use in knowing the added entities only. If this changes, hand in `addedEntities` to `getArtifactComparator` below.
-  forEachDefinition(afterModel, getArtifactComparator(beforeModel, null, null, elementAdditions, elementChanges));       // (, alerts(afterModel))
-  forEachDefinition(beforeModel, getArtifactComparator(afterModel, null, deletedEntities, null, null));       // (, alerts(beforeModel))
+  forEachDefinition(afterModel, getArtifactComparator(beforeModel, null, null, elementAdditions, migrations));
+  forEachDefinition(beforeModel, getArtifactComparator(afterModel, null, deletedEntities, null, null));
 
   const returnObj = Object.create(null);
   returnObj.definitions = afterModel.definitions;
   returnObj.deletions = deletedEntities;
   returnObj.extensions = elementAdditions;
-  returnObj.migrations = elementChanges;
+  returnObj.migrations = migrations;
   return returnObj;
 }
 
@@ -59,35 +60,45 @@ function validateCsnVersions(beforeModel, afterModel, options) {
   }
 }
 
-function getArtifactComparator(otherModel, addedEntities, deletedEntities, elementAdditions, elementChanges) {                              // (, alerts)
-  return function compareArtifacts(artifact, name) {                                   // (, topKey, path)   topKey == 'definitions'
+function getArtifactComparator(otherModel, addedEntities, deletedEntities, elementAdditions, migrations) {
+  return function compareArtifacts(artifact, name) {
     function addElements() {
       const elements = {};
       forEachMember(artifact, getElementComparator(otherArtifact, elements));
       if (Object.keys(elements).length > 0) {
-        elementAdditions.push({
-          extend: name,
-          elements: elements
-        });
+        elementAdditions.push(addedElements(name, elements));
       }
     }
-    function removeOrChangeElements() {
+    function changePropsOrRemoveOrChangeElements() {
+      const relevantProperties = ['doc'];
+      const changedProperties = {};
+
       const removedElements = {};
       const changedElements = {};
-      const modification = { migrate: name };
+
+      const migration = { migrate: name };
+
+      relevantProperties.forEach(prop => {
+        if (artifact[prop] !== otherArtifact[prop]) {
+          changedProperties[prop] = changedElement(artifact[prop], otherArtifact[prop] || null);
+        }
+      });
+      if (Object.keys(changedProperties).length > 0) {
+        migration.properties = changedProperties;
+      }
 
       forEachMember(otherArtifact, getElementComparator(artifact, removedElements));
       if (Object.keys(removedElements).length > 0) {
-        modification.remove = removedElements;
+        migration.remove = removedElements;
       }
 
       forEachMember(artifact, getElementComparator(otherArtifact, null, changedElements));
       if (Object.keys(changedElements).length > 0) {
-        modification.change = changedElements;
+        migration.change = changedElements;
       }
 
-      if (modification.remove || modification.change) {
-        elementChanges.push(modification);
+      if (migration.properties || migration.remove || migration.change) {
+        migrations.push(migration);
       }
     }
 
@@ -124,8 +135,8 @@ function getArtifactComparator(otherModel, addedEntities, deletedEntities, eleme
     if (elementAdditions) {
       addElements();
     }
-    if (elementChanges) {
-      removeOrChangeElements();
+    if (migrations) {
+      changePropsOrRemoveOrChangeElements();
     }
   };
 }
@@ -139,8 +150,8 @@ function isPersistedAsTable(artifact) {
       && !hasAnnotationValue(artifact, '@cds.persistence.exists');
 }
 
-function getElementComparator(otherArtifact, addedElements = null, changedElements = null) {                    // (, alerts)
-  return function compareElements(element, name) {                                     // (, topKey, path)   topKey == 'elements'
+function getElementComparator(otherArtifact, addedElements = null, changedElements = null) {
+  return function compareElements(element, name) {
     if (element._ignore) {
       return;
     }
@@ -209,6 +220,13 @@ function typeParametersChanged(element, otherElement) {
   return !deepEqual(element, otherElement, (key, depth) => !(depth === 0 && key === 'type'));
 }
 
+function addedElements(entity, elements) {
+  return {
+    extend: entity,
+    elements
+  };
+}
+
 function changedElement(element, otherElement) {
   return {
     old: otherElement,

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')
@@ -37,8 +39,11 @@ optionProcessor
   .option('    --test-mode')
   .option('    --test-sort-csn')
   .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(`
   Usage: cdsc <command> [options] <files...>
@@ -73,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
@@ -88,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:
-                              keylessManagedAssoc
-                              foreignKeyConstraints
                               addTextsLanguageAssoc
                               hanaAssocRealCardinality
                               mapAssocToJoinCardinality
                               ignoreAssocPublishingInUnion
-       --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
@@ -124,7 +137,10 @@ optionProcessor
                             OData CSN, CDL order and more.  When --test-mode is enabled, this
                             option is implicitly enabled as well.
        --doc-comment        Preserve /** */ comments at annotation positions as doc property in CSN
+       --add-texts-language-assoc   In generated texts entities, add association "language"
+                                    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
@@ -135,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.
 `);
 
@@ -145,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')
@@ -169,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
@@ -236,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>')
@@ -262,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
@@ -310,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
@@ -335,7 +347,7 @@ optionProcessor.command('manageConstraints')
 
 optionProcessor.command('toCsn')
   .option('-h, --help')
-  .option('-f, --flavor <flavor>', ['client', 'gensrc'])
+  .option('-f, --flavor <flavor>', ['client', 'gensrc', 'universal'])
   .option('    --with-localized')
   .help(`
   Usage: cdsc toCsn [options] <files...>
@@ -350,6 +362,7 @@ optionProcessor.command('toCsn')
                                       combination with additional "extend" or "annotate"
                                       statements, but not suitable for consumption by clients or
                                       backends
+                            universal: in development (BETA)
 
   Internal options (for testing only, may be changed/removed at any time)
        --with-localized   Add localized convenience views to the CSN output.
@@ -357,6 +370,7 @@ optionProcessor.command('toCsn')
 
 optionProcessor.command('parseCdl')
   .option('-h, --help')
+  .positionalArgument('<file>')
   .help(`
   Usage: cdsc parseCdl [options] <file>
 
@@ -369,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/.eslintrc.json

@@ -7,8 +7,11 @@
     "prefer-template": "error",
     "no-trailing-spaces": "error",
     "sonarjs/cognitive-complexity": "off",
+    "sonarjs/no-duplicate-string": ["off"],
+    "sonarjs/no-nested-template-literals": "off",
     "template-curly-spacing":["error", "never"],
-    "complexity": ["warn", 30],
+    // Who cares - just very whiny and in the way
+    "complexity": "off",
     "max-len": "off",
     // We should enable this
     "no-shadow": "off"

package/lib/render/DuplicateChecker.js

@@ -8,8 +8,6 @@
 
 'use strict';
 
-const walker = require('../json/walker');
-
 /**
  * database name - uppercase if not quoted
  *
@@ -46,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 ) {
@@ -87,13 +85,13 @@ class DuplicateChecker {
    * @param {CSN.Options} options Options used for the compilation
    */
   check(error, options = null) {
-    walker.forEach(this.seenArtifacts, (artifactName, artifacts) => {
+    forEach(this.seenArtifacts, (artifactName, artifacts) => {
       if (artifacts.length > 1) {
         artifacts.slice(1).forEach((artifact) => { // report all colliding artifacts, except the first one
           const collidesWith = this.seenArtifacts[artifactName].find( art => art !== artifact );
           let namingMode;
           if (options)
-            namingMode = options.toHana ? options.toHana.names : options.toSql.names;
+            namingMode = options.sqlMapping;
           else
             namingMode = 'plain';
 
@@ -106,7 +104,7 @@ class DuplicateChecker {
         });
       }
       artifacts.forEach((artifact) => {
-        walker.forEach(artifact.elements, (elementName, elements) => {
+        forEach(artifact.elements, (elementName, elements) => {
           if (elements.length > 1) {
             elements.forEach((element) => { // report all colliding elements
               error(null,
@@ -123,4 +121,9 @@ class DuplicateChecker {
   }
 }
 
+function forEach(obj, callback) {
+  for (const key in obj)
+    callback(key, obj[key]);
+}
+
 module.exports = DuplicateChecker;