@sap/cds-compiler 2.4.4 → 2.10.2

package/lib/model/enrichCsn.js

@@ -32,7 +32,7 @@ const { locationString } = require('../base/location');
 
 function enrichCsn( csn, options = {} ) {
   const transformers = {
-    $env: reveal,
+    // $env: reveal,
     elements: dictionary,
     definitions: dictionary,
     actions: dictionary,
@@ -44,15 +44,21 @@ function enrichCsn( csn, options = {} ) {
     targetAspect: simpleRef,
     target: simpleRef,
     includes: simpleRef,
-    '@': () => {},
+    $origin,
+    // TODO: excluding
+    '@': () => { /* ignore annotations */ },
   }
   setLocations( csn, false, null );
-  const { inspectRef, artifactRef } = csnRefs( csn );
+  const { inspectRef, artifactRef, getOrigin, __getCache_forEnrichCsnDebugging } =
+      csnRefs( csn );
+  let $$cacheObjectNumber = 0;   // for debugging
   const csnPath = [];
   if (csn.definitions)
     dictionary( csn, 'definitions', csn.definitions );
   if (csn.$location)
     reveal( csn, '$location', locationString( csn.$location ) );
+  if (csn.$sources)
+    reveal( csn, '$sources', csn.$sources );
   return csn;
 
   function standard( parent, prop, obj ) {
@@ -68,6 +74,9 @@ function enrichCsn( csn, options = {} ) {
         const trans = transformers[name] || transformers[name.charAt(0)] || standard;
         trans( obj, name, obj[name] );
       }
+      if (obj.$parens)
+        reveal( obj, '$parens', obj.$parens );
+      _cache_debug( obj );
     }
     csnPath.pop();
   }
@@ -112,8 +121,23 @@ function enrichCsn( csn, options = {} ) {
     //   parent['_' + prop] = e.toString(); }
   }
 
+  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();
+      }
+    }
+  }
+
   function pathRef( parent, prop, path ) {
-    const { links, art, scope } = (() => {
+    const { links, art, scope, $env } = (() => {
       if (options.testMode)
         return inspectRef( csnPath );
       else {
@@ -130,6 +154,8 @@ function enrichCsn( csn, options = {} ) {
     if (links && links[links.length-1].art !== art)
       parent._art = refLocation( art );
     parent._scope = scope;
+    if ($env)
+      parent._env = $env;
 
     csnPath.push( prop );
     path.forEach( function step( s, i ) {
@@ -144,6 +170,51 @@ function enrichCsn( csn, options = {} ) {
     } );
     csnPath.pop();
   }
+
+  function _cache_debug( obj ) {
+    if (options.enrichCsn !== 'DEBUG')
+      return;
+    const cache = __getCache_forEnrichCsnDebugging( obj );
+    if (!cache)
+      return;
+    if (cache.$$objectNumber > 0) {
+      obj.$$cacheObjectNumber = cache.$$objectNumber;
+    }
+    else {
+      cache.$$objectNumber = (cache.$$objectNumber)
+        ? -cache.$$objectNumber
+        : ++$$cacheObjectNumber;
+      obj.$$cacheObject = {};
+      for (const name of Object.keys( cache )) {
+        const val = cache[name];
+        if (val === null || typeof val !== 'object') {
+          obj.$$cacheObject[name] = val;
+        }
+        else if (name[0] === '_') {
+          // _‹name›: link to CSN node, usually with kind & location
+          obj.$$cacheObject[name]
+            = (val.$location) ? locationString( val.$location ) : 'CSN node';
+        }
+        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?
+        }
+        else if (Array.isArray( val )) {
+          obj.$$cacheObject[name] = val.map( item => {
+            if (!item.$$objectNumber)
+              item.$$objectNumber = -(++$$cacheObjectNumber);
+            return item.$$objectNumber;
+          } );
+        }
+        else {
+          if (!val.$$objectNumber)
+            val.$$objectNumber = -(++$$cacheObjectNumber);
+          obj.$$cacheObject[name] = val.$$objectNumber || -(++$$cacheObjectNumber);
+        }
+      }
+    }
+  }
 }
 
 function reveal( node, prop, value ) {

package/lib/model/revealInternalProperties.js

@@ -76,6 +76,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 +160,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 ) );
   }

package/lib/modelCompare/compare.js

@@ -1,9 +1,10 @@
 'use strict';
 
+const { makeMessageFunction } = require('../base/messages');
 const {
   forEachDefinition,
   forEachMember,
-  hasBoolAnnotation
+  hasAnnotationValue
 } = require('../model/csnUtils');
 
 /**
@@ -11,55 +12,92 @@ const {
  *
  * @param beforeModel the before-model
  * @param afterModel the after-model
+ * @param {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) {
+function compareModels(beforeModel, afterModel, options) {
+  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;
 }
 
-function getArtifactComparator(otherModel, addedEntities, deletedEntities, elementAdditions, elementChanges) {                              // (, alerts)
-  return function compareArtifacts(artifact, name) {                                   // (, topKey, path)   topKey == 'definitions'
+function validateCsnVersions(beforeModel, afterModel, options) {
+  const beforeVersion = beforeModel.$version;
+  const afterVersion = afterModel.$version;
+  let beforeVersionParts = beforeVersion && beforeVersion.split('.');
+  let afterVersionParts = afterVersion && afterVersion.split('.');
+
+  if (!beforeVersionParts || beforeVersionParts.length < 2) {
+    const { error, throwWithError } = makeMessageFunction(beforeModel, options, 'modelCompare');
+    error(null, null, `Invalid CSN version: ${beforeVersion}`);
+    throwWithError();
+  }
+  if (!afterVersionParts || afterVersionParts.length < 2) {
+    const { error, throwWithError } = makeMessageFunction(afterModel, options, 'modelCompare');
+    error(null, null, `Invalid CSN version: ${afterVersion}`);
+    throwWithError();
+  }
+  if (beforeVersionParts[0] > afterVersionParts[0] && !(options && options.allowCsnDowngrade)) {
+    const { error, throwWithError } = makeMessageFunction(afterModel, options, 'modelCompare');
+    error(null, null, `Incompatible CSN versions: ${afterVersion} is a major downgrade from ${beforeVersion}. Is @sap/cds-compiler version ${require('../../package.json').version} outdated?`);
+    throwWithError();
+  }
+}
+
+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);
       }
     }
 
@@ -96,8 +134,8 @@ function getArtifactComparator(otherModel, addedEntities, deletedEntities, eleme
     if (elementAdditions) {
       addElements();
     }
-    if (elementChanges) {
-      removeOrChangeElements();
+    if (migrations) {
+      changePropsOrRemoveOrChangeElements();
     }
   };
 }
@@ -106,13 +144,13 @@ function isPersistedAsTable(artifact) {
   return artifact.kind === 'entity'
       && !artifact._ignore
       && !artifact.abstract
-      && (!artifact.query && !artifact.projection || hasBoolAnnotation(artifact, '@cds.persistence.table'))
-      && !hasBoolAnnotation(artifact, '@cds.persistence.skip')
-      && !hasBoolAnnotation(artifact, '@cds.persistence.exists');
+      && (!artifact.query && !artifact.projection || hasAnnotationValue(artifact, '@cds.persistence.table'))
+      && !hasAnnotationValue(artifact, '@cds.persistence.skip')
+      && !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;
     }
@@ -181,6 +219,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

@@ -33,12 +33,14 @@ optionProcessor
   .option('    --hana-flavor')
   .option('    --direct-backend')
   .option('    --parse-only')
-  .option('    --fallback-parser <type>', ['cdl', 'csn'])
+  .option('    --fallback-parser <type>', ['cdl', 'csn', 'csn!'])
   .option('    --test-mode')
   .option('    --test-sort-csn')
   .option('    --doc-comment')
+  .option('    --add-texts-language-assoc')
   .option('    --localized-without-coalesce')
   .option('    --defaultStringLength <length>')
+  .option('    --no-recompile')
   .positionalArgument('<files...>')
   .help(`
   Usage: cdsc <command> [options] <files...>
@@ -88,12 +90,12 @@ 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
+                              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
@@ -111,8 +113,9 @@ optionProcessor
        --parse-only         Stop compilation after parsing and write result to <stdout>
        --fallback-parser <type>  If the language cannot be deduced by the file's extensions, use this
                                  parser as a fallback. Valid values are:
-                                   cdl : Use CDL parser
-                                   csn : Use CSN parser
+                                   cdl  : Use CDL parser
+                                   csn  : Use CSN parser
+                                   csn! : Use CSN parser even with extension cds, cdl, hdbcds and hdbdd
        --direct-backend     Do not compile the given CSN but directly pass it to the backend.
                             Can only be used with certain new CSN based backends. Combination with
                             other flags is limited, e.g. --test-mode will not run a consistency check.
@@ -123,8 +126,11 @@ 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
     O, toOdata [options] <files...>             Generate ODATA metadata and annotations
@@ -179,8 +185,6 @@ optionProcessor.command('O, toOdata')
   .option('-v, --version <version>', ['v2', 'v4', 'v4x'])
   .option('-x, --xml')
   .option('-j, --json')
-  .option('    --separate')
-  .option('    --combined')
   .option('    --odata-containment')
   .option('    --odata-proxies')
   .option('    --odata-x-service-refs')
@@ -202,8 +206,6 @@ optionProcessor.command('O, toOdata')
                               v4x: { version: 'v4', odataContainment:true, format:'structured' }
    -x, --xml                (default) Generate XML output (separate or combined)
    -j, --json               Generate JSON output as "<svc>.json" (not available for v2)
-       --separate           Generate "<svc>_metadata.xml" and "<svc>_annotations.xml"
-       --combined           (default) Generate "<svc>.xml"
    -c, --csn                Generate "odata_csn.json" with ODATA-preprocessed model
    -f, --odata-format <format>  Set the format of the identifier rendering
                                   flat       : (default) Flat type and property names
@@ -338,7 +340,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...>
@@ -353,6 +355,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.

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
  *
@@ -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;