@sap/cds-compiler 2.15.4 → 3.0.0

package/lib/model/revealInternalProperties.js

@@ -14,6 +14,7 @@
 const msg = require('../base/messages');
 
 const $inferred = Symbol.for('cds.$inferred');
+const $location = Symbol.for('cds.$location');
 
 class NOT_A_DICTIONARY {}       // used for consol.log display
 
@@ -96,6 +97,7 @@ function revealInternalProperties( model, nameOrPath ) {
     _annotate: reveal,
     _deps: dependencyInfo,
     _status: primOrString,       // is a string anyway
+    $annotations: as => as.map( $annotation ),
     $messageFunctions: () => '‹some functions›',
   }
   unique_id = 1;
@@ -149,7 +151,7 @@ function revealInternalProperties( model, nameOrPath ) {
 
   function shortenName( node, parent ) {
     const name = reveal( node, parent );
-    if (name && typeof name === 'object' && name.absolute) {
+    if (name && typeof name === 'object' && name.absolute && node.kind) {
       const text = artifactIdentifier( parent );
       delete name.absolute;
       delete name.select;
@@ -178,11 +180,20 @@ function revealInternalProperties( model, nameOrPath ) {
     return r;
   }
 
+  function $annotation( anno ) { // property for cds-lsp
+    const { name, $flatten } = anno.value || anno;
+    const value = ($flatten)
+          ? { name: reveal( name ), $flatten: $flatten.map( $annotation ) }
+          : `@${name?.absolute}`;
+    return { value, location: locationString( anno.location || anno.name.location ) };
+  }
+
   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)
-                                    ? artifactIdentifier( c, query )
-                                    : reveal( c, nodes ) );
+    return nodes && array( nodes,
+                           c => (c._parent && c._parent.elements)
+                           ? artifactIdentifier( c, query )
+                           : reveal( c, nodes ) );
   }
 
   function elements( dict, parent ) {
@@ -215,7 +226,7 @@ function revealInternalProperties( model, nameOrPath ) {
     if (!node || typeof node !== 'object')
       return primOrString( node );
     if (Array.isArray(node))  // with args
-      return node.map( n => reveal( n, node ) );
+      return array( node, reveal );
     // Make unexpected prototype visible with node-10+:
     const r = Object.create( Object.getPrototypeOf(node)
                              ? NOT_A_DICTIONARY.prototype
@@ -225,6 +236,8 @@ function revealInternalProperties( model, nameOrPath ) {
     }
     if (node[$inferred] && !node['[$inferred]'])
       r['[$inferred]'] = node[$inferred];
+    if (node[$location] && !node['[$location]'])
+      r['[$location]'] = locationString( node[$location] );
     return r;
   }
 
@@ -239,7 +252,7 @@ function revealInternalProperties( model, nameOrPath ) {
     if (node == null || typeof node !== 'object' )
       return primOrString( node );
     if (Array.isArray(node))
-      return node.map( n => revealNonEnum( n, node ) );
+      return array( node, revealNonEnum );
 
     if (Object.getPrototypeOf( node ))
       return artifactIdentifier( node, parent );
@@ -250,7 +263,7 @@ function revealInternalProperties( model, nameOrPath ) {
     if (node == null || typeof node !== 'object' )
       return node
     if (Array.isArray(node))
-      return node.map( n => reveal( n, node, name ) );
+      return array( node, n => reveal( n, node, name ) );
 
     const asLinkTest = kindsRepresentedAsLinks[ node.kind ];
     if (asLinkTest && asLinkTest( node, parent, name ))
@@ -280,6 +293,13 @@ function revealInternalProperties( model, nameOrPath ) {
   }
 }
 
+function array( node, fn ) {
+  const r = node.map( n => fn( n, node ) );
+  if (node[$location])
+    r.push( { $location: locationString( node[$location] ) } );
+  return r;
+}
+
 function artifactIdentifier( node, parent ) {
   if (Array.isArray(node))
     return node.map( a => artifactIdentifier( a, node ) );
@@ -335,7 +355,7 @@ function primOrString( node ) {
   if (node == null || typeof node !== 'object')
     return node
   if (Array.isArray(node))
-    return node.map( primOrString );
+    return array( node, primOrString );
   if (Object.getPrototypeOf( node ))
     return '' + node;
   else

package/lib/model/sortViews.js

@@ -21,7 +21,7 @@ const { ModelError } = require("../base/error");
  */
 function sortTopologically(csn, _dependents, _dependencies){
   const layers = [];
-  let { zero, nonZero } = calculateDepth(Object.entries(csn.definitions));
+  let { zero, nonZero } = _calculateDepth(Object.entries(csn.definitions), _dependents, _dependencies);
   while (zero.length !== 0){
     const currentLayer = [];
     zero.forEach(([artifactName, artifact]) => {
@@ -34,46 +34,46 @@ function sortTopologically(csn, _dependents, _dependencies){
       }
     });
     layers.push(currentLayer);
-    ({zero, nonZero} = findWithXPointers(nonZero, 0));
+    ({zero, nonZero} = _findWithXPointers(nonZero, 0, _dependents, _dependencies));
   }
 
   return { layers, leftover: nonZero };
+}
 
-  function calculateDepth(definitionsArray) {
-    const zero = [];
-    const nonZero = [];
+function _calculateDepth(definitionsArray, _dependents, _dependencies) {
+  const zero = [];
+  const nonZero = [];
 
-    definitionsArray.forEach(([artifactName, artifact]) => {
-      if(artifact[_dependencies]) {
-        artifact.$pointers = artifact[_dependencies].size;
-        nonZero.push([artifactName, artifact]);
-      } else {
-        artifact.$pointers = 0;
-        zero.push([artifactName, artifact]);
-      }
-    });
-    return {
-      zero,
-      nonZero
+  definitionsArray.forEach(([artifactName, artifact]) => {
+    if(artifact[_dependencies]) {
+      artifact.$pointers = artifact[_dependencies].size;
+      nonZero.push([artifactName, artifact]);
+    } else {
+      artifact.$pointers = 0;
+      zero.push([artifactName, artifact]);
     }
+  });
+  return {
+    zero,
+    nonZero
   }
+}
 
-  function findWithXPointers(definitionsArray, x=0){
-    const zero = [];
-    const nonZero = [];
-
-    definitionsArray.forEach(([artifactName, artifact]) => {
-      if(artifact.$pointers !== undefined && artifact.$pointers === x) {
-        zero.push([artifactName, artifact]);
-      } else {
-        nonZero.push([artifactName, artifact]);
-      }
-    });
+function _findWithXPointers(definitionsArray, x, _dependents, _dependencies){
+  const zero = [];
+  const nonZero = [];
 
-    return {
-      zero,
-      nonZero
+  definitionsArray.forEach(([artifactName, artifact]) => {
+    if(artifact.$pointers !== undefined && artifact.$pointers === x) {
+      zero.push([artifactName, artifact]);
+    } else {
+      nonZero.push([artifactName, artifact]);
     }
+  });
+
+  return {
+    zero,
+    nonZero
   }
 }
 
@@ -83,6 +83,7 @@ function sortTopologically(csn, _dependents, _dependencies){
  * be run beforehand to resolve association usages.
  *
  * @param {object} sql Map of <object name>: "CREATE STATEMENT"
+ * @param {CSN.Model} csn
  *
  * @returns {{name: string, sql: string}[]} Sorted array of artifact name / "CREATE STATEMENTS" pairs
  *

package/lib/optionProcessor.js

@@ -34,7 +34,6 @@ optionProcessor
   .option('    --beta-mode')
   .option('    --beta <list>')
   .option('    --deprecated <list>')
-  .option('    --hana-flavor')
   .option('    --direct-backend')
   .option('    --parse-only')
   .option('    --fallback-parser <type>', ['cdl', 'csn', 'csn!'])
@@ -107,21 +106,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:
-                              addTextsLanguageAssoc
                               hanaAssocRealCardinality
                               mapAssocToJoinCardinality
                               ignoreAssocPublishingInUnion
        --deprecated <list>  Comma separated list of deprecated options.
                             Valid values are:
-                              noElementsExpansion
-                              v1KeysForTemporal
-                              parensAsStrings
-                              projectionAsQuery
-                              renderVirtualElements
-                              unmanagedUpInComponent
-                              createLocalizedViews
-                              redirectInSubQueries
-       --hana-flavor        Compile with backward compatibility for HANA CDS (incomplete)
+                              eagerPersistenceForGeneratedEntities
        --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:
@@ -207,7 +197,7 @@ optionProcessor.command('H, toHana')
 
 optionProcessor.command('O, toOdata')
   .option('-h, --help')
-  .option('-v, --version <version>', ['v2', 'v4', 'v4x'])
+  .option('-v, --odata-version <version>', ['v2', 'v4', 'v4x'])
   .option('-x, --xml')
   .option('-j, --json')
   .option('    --odata-containment')
@@ -226,10 +216,10 @@ optionProcessor.command('O, toOdata')
 
   Options
    -h, --help               Show this help text
-   -v, --version <version>  ODATA version
-                              v2: ODATA V2
-                              v4: (default) ODATA V4
-                              v4x: { version: 'v4', odataContainment:true, format:'structured' }
+   -v, --odata-version <version>  ODATA version
+                                    v2: ODATA V2
+                                    v4: (default) ODATA V4
+                                    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)
    -c, --csn                Generate "odata_csn.json" with ODATA-preprocessed model
@@ -250,7 +240,7 @@ optionProcessor.command('O, toOdata')
                               hdbcds  : Names as HANA CDS would generate them from the same CDS
                                         source (like "quoted", but using element names with dots)
     -s, --service-names <list>    List of comma-separated service names to be rendered
-                                  (default) empty, all services are rendered 
+                                  (default) empty, all services are rendered
 `);
 
 optionProcessor.command('C, toCdl')
@@ -269,7 +259,7 @@ optionProcessor.command('Q, toSql')
   .option('-n, --names <style>', ['plain', 'quoted', 'hdbcds'])
   .option('    --render-virtual')
   .option('    --joinfk')
-  .option('-d, --dialect <dialect>', ['hana', 'sqlite', 'plain'])
+  .option('-d, --dialect <dialect>', ['hana', 'sqlite', 'plain', 'postgres'])
   .option('-u, --user <user>')
   .option('-l, --locale <locale>')
   .option('-s, --src <style>', ['sql', 'hdi'])
@@ -300,9 +290,10 @@ optionProcessor.command('Q, toSql')
        --render-virtual       Render virtual elements in views and draft tables
        --joinfk               Create JOINs for foreign key accesses
    -d, --dialect <dialect>    SQL dialect to be generated:
-                                plain  : (default) Common SQL - no assumptions about DB restrictions
-                                hana   : SQL with HANA specific language features
-                                sqlite : Common SQL for sqlite
+                                plain    : (default) Common SQL - no assumptions about DB restrictions
+                                hana     : SQL with HANA specific language features
+                                sqlite   : Common SQL for sqlite
+                                postgres : Common SQL for postgres - beta-feature
    -u, --user <user>          Value for the "$user" variable
    -l, --locale <locale>      Value for the "$user.locale" variable in "sqlite"/"plain" dialect
    -s, --src <style>          Generate SQL source files as <artifact>.<suffix>

package/lib/render/.eslintrc.json

@@ -16,6 +16,6 @@
     "no-shadow": "warn"
   },
   "env": {
-    "es6": true
+    "es2020": true
   }
 }

package/lib/render/DuplicateChecker.js

@@ -2,12 +2,14 @@
  * Usage: Create an instance to process artifacts which should be checked for collision.
  * First call addArtifact to specify the current artifact,
  * then call addElement to register the elements of the current artifact.
- * Finally call the "done" function to check for duplicates.
- * In addition the internal structures will be reinitialized to enable reuse of the instance.
+ * Finally, call the "done" function to check for duplicates.
+ * In addition, the internal structures will be reinitialized to enable reuse of the instance.
  */
 
 'use strict';
 
+const { forEach } = require('../utils/objectUtils');
+
 /**
  * database name - uppercase if not quoted
  *
@@ -121,9 +123,4 @@ class DuplicateChecker {
   }
 }
 
-function forEach(obj, callback) {
-  for (const key in obj)
-    callback(key, obj[key]);
-}
-
 module.exports = DuplicateChecker;

package/lib/render/manageConstraints.js

@@ -6,11 +6,78 @@ const {
   getResultingName,
 } = require('../model/csnUtils');
 const { forEach } = require('../utils/objectUtils');
+const { makeMessageFunction } = require('../base/messages');
+const { optionProcessor } = require('../optionProcessor');
+const { transformForHanaWithCsn } = require('../transform/forHanaNew');
 
 const {
   renderReferentialConstraint, getIdentifierUtils,
 } = require('./utils/sql');
 
+/**
+ * Used only by `cdsc manageConstraints`.
+ * Not part of our API, yet.
+ *
+ * @param {CSN.Model} csn
+ * @param {CSN.Options} options
+ */
+function alterConstraintsWithCsn(csn, options) {
+  const { error } = makeMessageFunction(csn, options, 'manageConstraints');
+
+  const {
+    drop, alter, names, src, violations,
+  } = options.manageConstraints || {};
+
+  if (drop && alter)
+    error(null, null, 'Option “--drop” can\'t be combined with “--alter”');
+
+  options.sqlDialect = 'hana';
+  options.sqlMapping = names || 'plain';
+
+  // Of course we want the database constraints
+  options.assertIntegrityType = 'DB';
+
+  const transformedOptions = _transformSqlOptions(csn, options);
+  const forSqlCsn = transformForHanaWithCsn(csn, transformedOptions, 'to.sql');
+
+  if (violations && src && src !== 'sql')
+    error(null, null, `Option “--violations“ can't be combined with source style “${src}“`);
+
+  let intermediateResult;
+  if (violations)
+    intermediateResult = listReferentialIntegrityViolations(forSqlCsn, transformedOptions);
+  else
+    intermediateResult = manageConstraints(forSqlCsn, transformedOptions);
+
+  return intermediateResult;
+}
+
+function _transformSqlOptions(model, options) {
+  // Merge options with defaults.
+  options = Object.assign({ sqlMapping: 'plain', sqlDialect: 'plain' }, options);
+  options.toSql = true;
+
+  if (!options.src && !options.csn)
+    options.src = 'sql';
+
+  const { warning, error } = makeMessageFunction(model, options, 'to.sql');
+
+  optionProcessor.verifyOptions(options, 'toSql', true)
+    .forEach(complaint => warning(null, null, `${complaint}`));
+
+  if (options.sqlDialect !== 'hana') {
+    // CDXCORE-465, 'quoted' and 'hdbcds' are to be used in combination with dialect 'hana' only
+    if (options.sqlMapping === 'quoted' || options.sqlMapping === 'hdbcds')
+      error(null, null, `Option "{ sqlDialect: '${options.sqlDialect}' }" can't be combined with "{ sqlMapping: '${options.sqlMapping}' }"`);
+
+    // No non-HANA SQL for HDI
+    if (options.src === 'hdi')
+      error(null, null, `Option "{ sqlDialect: '${options.sqlDialect}' }" can't be used for HDI"`);
+  }
+
+  return options;
+}
+
 /**
  * This render middleware can be used to generate SQL DDL ALTER TABLE <table> ALTER / ADD / DROP CONSTRAINT <constraint> statements for a given CDL model.
  * Moreover, it can be used to generate .hdbconstraint artifacts.
@@ -38,7 +105,7 @@ function manageConstraints(csn, options) {
           return;
         }
         let alterTableStatement = '';
-        alterTableStatement += `${indent}ALTER TABLE ${quoteSqlId(getResultingName(csn, options.toSql.names, constraint.dependentTable))}`;
+        alterTableStatement += `${indent}ALTER TABLE ${quoteSqlId(getResultingName(csn, options.sqlMapping, constraint.dependentTable))}`;
         if (renderAlterConstraintStatement)
           alterTableStatement += `\n${indent}ALTER ${renderedConstraint};`;
         else if (drop)
@@ -172,7 +239,7 @@ function listReferentialIntegrityViolations(csn, options) {
   }
 
   function quoteAndGetResultingName(id) {
-    return quoteSqlId(getResultingName(csn, options.toSql.names, id));
+    return quoteSqlId(getResultingName(csn, options.sqlMapping, id));
   }
 
   return resultArtifacts;
@@ -192,6 +259,7 @@ function getListOfAllConstraints(csn) {
 }
 
 module.exports = {
+  alterConstraintsWithCsn,
   manageConstraints,
   listReferentialIntegrityViolations,
 };