@sap/cds-compiler 2.11.2 → 2.13.6

package/lib/api/main.js

@@ -35,6 +35,7 @@ const propertyToCheck = {
 
 const { cloneCsn } = require('../model/csnUtils');
 const { toHdbcdsSource } = require('../render/toHdbcds');
+const { ModelError } = require('../base/error');
 
 const relevantGeneralOptions = [ /* for future generic options */ ];
 const relevantOdataOptions = [ 'sqlMapping', 'odataFormat' ];
@@ -115,7 +116,7 @@ function checkPreTransformedCsn(csn, options, relevantOptionNames, warnAboutMism
  * @returns {boolean} Return true if it is pre-transformed
  */
 function isPreTransformed(csn, transformation) {
-  return csn.meta && csn.meta.transformation === transformation;
+  return csn && csn.meta && csn.meta.transformation === transformation;
 }
 
 /**
@@ -159,12 +160,13 @@ function cdl(csn, externalOptions = {}) {
  * Transform a CSN like to.sql
  *
  * @param {CSN.Model} csn Plain input CSN
- * @param {sqlOptions} [options={}] Options
+ * @param {SqlOptions} [options={}] Options
  * @returns {CSN.Model} CSN transformed like to.sql
  * @private
  */
 function forSql(csn, options = {}) {
   const internalOptions = prepareOptions.to.sql(options);
+  internalOptions.transformation = 'sql';
   internalOptions.toSql.csn = true;
   return backends.toSqlWithCsn(csn, internalOptions).csn;
 }
@@ -172,7 +174,7 @@ function forSql(csn, options = {}) {
  * Transform a CSN like to.hdi
  *
  * @param {CSN.Model} csn Plain input CSN
- * @param {hdiOptions} [options={}] Options
+ * @param {HdiOptions} [options={}] Options
  * @returns {CSN.Model} CSN transformed like to.hdi
  * @private
  */
@@ -185,7 +187,7 @@ function forHdi(csn, options = {}) {
  * Transform a CSN like to.hdbcds
  *
  * @param {CSN.Model} csn Plain input CSN
- * @param {hdbcdsOptions} [options={}] Options
+ * @param {HdbcdsOptions} [options={}] Options
  * @returns {CSN.Model} CSN transformed like to.hdbcds
  * @private
  */
@@ -202,11 +204,12 @@ function forHdbcds(csn, options = {}) {
  * Process the given CSN into SQL.
  *
  * @param {CSN.Model} csn A clean input CSN
- * @param {sqlOptions} [options={}] Options
+ * @param {SqlOptions} [options={}] Options
  * @returns {SQL[]} Array of SQL statements, tables first, views second
  */
 function sql(csn, options = {}) {
   const internalOptions = prepareOptions.to.sql(options);
+  internalOptions.transformation = 'sql';
 
   // we need the CSN for view sorting
   internalOptions.toSql.csn = true;
@@ -222,7 +225,7 @@ function sql(csn, options = {}) {
  * Process the given CSN into HDI artifacts.
  *
  * @param {CSN.Model} csn A clean input CSN
- * @param {hdiOptions} [options={}] Options
+ * @param {HdiOptions} [options={}] Options
  * @returns {HDIArtifacts} { <filename>:<content>, ...}
  */
 function hdi(csn, options = {}) {
@@ -245,19 +248,19 @@ function hdi(csn, options = {}) {
     const flat = flattenResultStructure(intermediateResult);
 
     const nameMapping = Object.create(null);
-    const sqlsWithCSNNamesToSort = Object.create(null);
-    const sqlsNotToSort = Object.create(null);
+    const sqlArtifactsWithCSNNamesToSort = Object.create(null);
+    const sqlArtifactsNotToSort = Object.create(null);
 
     Object.keys(flat).forEach((key) => {
       const artifactNameLikeInCsn = key.replace(/\.[^/.]+$/, '');
       nameMapping[artifactNameLikeInCsn] = key;
       if (key.endsWith('.hdbtable') || key.endsWith('.hdbview'))
-        sqlsWithCSNNamesToSort[artifactNameLikeInCsn] = flat[key];
+        sqlArtifactsWithCSNNamesToSort[artifactNameLikeInCsn] = flat[key];
       else
-        sqlsNotToSort[key] = flat[key];
+        sqlArtifactsNotToSort[key] = flat[key];
     });
 
-    const sorted = sortViews({ sql: sqlsWithCSNNamesToSort, csn: sqlCSN })
+    const sorted = sortViews({ sql: sqlArtifactsWithCSNNamesToSort, csn: sqlCSN })
       .filter(obj => obj.sql)
       .reduce((previous, current) => {
         const hdiArtifactName = remapName(nameMapping[current.name], sqlCSN, k => !k.endsWith('.hdbindex'));
@@ -265,9 +268,9 @@ function hdi(csn, options = {}) {
         return previous;
       }, Object.create(null));
 
-    // now add the not-sorted stuff, like indizes
-    Object.keys(sqlsNotToSort).forEach((key) => {
-      sorted[remapName(key, sqlCSN, k => !k.endsWith('.hdbindex'))] = sqlsNotToSort[key];
+    // now add the not-sorted stuff, like indices
+    Object.keys(sqlArtifactsNotToSort).forEach((key) => {
+      sorted[remapName(key, sqlCSN, k => !k.endsWith('.hdbindex'))] = sqlArtifactsNotToSort[key];
     });
 
     return sorted;
@@ -323,7 +326,7 @@ function remapName(key, csn, filter = () => true) {
  * Note: Only supports changes in entities (not views etc.) compiled/rendered as HANA-CSN/SQL.
  *
  * @param {CSN.Model}  csn          A clean input CSN representing the desired "after-image"
- * @param {hdiOptions} options      Options
+ * @param {HdiOptions} options      Options
  * @param {CSN.Model}  beforeImage  A HANA-transformed CSN representing the "before-image", or null in case no such image
  *                                  is known, i.e. for the very first migration step
  * @returns {object} - afterImage:  The desired after-image in HANA-CSN format
@@ -344,8 +347,8 @@ function hdiMigration(csn, options, beforeImage) {
    * This is for backward compatibility with @sap/cds@4.5.(2…3).
    *
    * @todo Remove in cds-compiler@2.x
-   * @param {hdiOptions|CSN.Model} inputOptions Options or CSN image
-   * @param {CSN.Model|hdiOptions} inputBeforeImage CSN image or options
+   * @param {HdiOptions|CSN.Model} inputOptions Options or CSN image
+   * @param {HdiOptions|CSN.Model} inputBeforeImage CSN image or options
    * @returns {Array} Array where the real options come first
    */
   function backwardCompatible(inputOptions, inputBeforeImage) {
@@ -436,7 +439,7 @@ hdi.migration = hdiMigration;
  * Process the given CSN into HDBCDS artifacts.
  *
  * @param {any} csn A clean input CSN
- * @param {hdbcdsOptions} [options={}] Options
+ * @param {HdbcdsOptions} [options={}] Options
  * @returns {HDBCDS} { <filename>:<content>, ...}
  */
 function hdbcds(csn, options = {}) {
@@ -641,12 +644,18 @@ function publishCsnProcessor( processor, _name ) {
       return processor( csn, options, ...args );
     }
     catch (err) {
-      if (err instanceof CompilationError || options.noRecompile)
-      // options.testMode && err instanceof RangeError) // stack overflow
+      if (err instanceof CompilationError || options.noRecompile || isPreTransformed(csn, 'odata')) // we cannot recompile a pre-transformed CSN
+        throw err;
+
+      if (options.testMode && !(err instanceof TypeError) &&
+        !(err instanceof ModelError))
         throw err;
 
       const { info } = makeMessageFunction( csn, options, 'compile' );
-      info( 'api-recompiled-csn', emptyLocation('csn.json'), {}, 'CSN input had to be recompiled' );
+      const msg = info( 'api-recompiled-csn', emptyLocation('csn.json'), {}, 'CSN input had to be recompiled' );
+      if (options.internalMsg)
+        msg.error = err; // Attach original error
+
       // next line to be replaced by CSN parser call which reads the CSN object
       const xsn = recompileX(csn, options);
       const recompiledCsn = compactModel(xsn);
@@ -680,12 +689,6 @@ function publishCsnProcessor( processor, _name ) {
  * @typedef {'plain' | 'quoted' | 'hdbcds' } NamingMode
  */
 
-/**
- * Available SQL change modes
- *
- * @typedef {'alter' | 'drop' } SqlChangeMode
- */
-
 /**
  * Available oData versions
  *
@@ -698,56 +701,6 @@ function publishCsnProcessor( processor, _name ) {
  * @typedef { 'structured' | 'flat' } oDataFormat
  */
 
-/**
- * Generally available options
- *
- * @typedef {object} Options
- * @property {object} [beta] Enable experimental features - not for productive use!
- * @property {boolean} [dependentAutoexposed=false] For dependent autoexposed entities (managed compositions, texts entity), follow name of base entity
- * @property {boolean} [longAutoexposed=false] Deprecated: Produce long names (with underscores) for autoexposed entities
- * @property {Map<string, number>} [severities={}] Map of message-id and severity that allows setting the severity for the given message
- * @property {Array} [messages] Allows collecting all messages in the options instead of printing them to stderr.
- */
-
-/**
- * Options available for to.hdi
- *
- * @typedef {object} hdiOptions
- * @property {NamingMode} [sqlMapping='plain'] Naming mode to use
- * @property {SqlChangeMode} [sqlChangeMode='alter'] SQL change mode to use (for changed columns)
- * @property {boolean} [allowCsnDowngrade=false] Allow downgrades of CSN major version (for modelCompare)
- * @property {object} [beta] Enable experimental features - not for productive use!
- * @property {boolean} [longAutoexposed=false] Deprecated: Produce long names (with underscores) for autoexposed entities
- * @property {Map<string, number>} [severities={}] Map of message-id and severity that allows setting the severity for the given message
- * @property {Array} [messages] Allows collecting all messages in the options instead of printing them to stderr.
- */
-
-/**
- * Options available for to.hdbcds
- *
- * @typedef {object} hdbcdsOptions
- * @property {NamingMode} [sqlMapping='plain'] Naming mode to use
- * @property {object} [beta] Enable experimental features - not for productive use!
- * @property {boolean} [longAutoexposed=false] Deprecated: Produce long names (with underscores) for autoexposed entities
- * @property {Map<string, number>} [severities={}] Map of message-id and severity that allows setting the severity for the given message
- * @property {Array} [messages] Allows collecting all messages in the options instead of printing them to stderr.
- */
-
-/**
- * Options available for to.sql
- *
- * @typedef {object} sqlOptions
- * @property {NamingMode} [sqlMapping='plain'] Naming mode to use
- * @property {SQLDialect} [sqlDialect='sqlite'] SQL dialect to use
- * @property {object} [variableReplacements] Object containing values for magic variables like "$user"
- * @property {string} [variableReplacements.$user.locale] Value for the "$user.locale" variable
- * @property {string} [variableReplacements.$user.id] Value for the "$userid" variable
- * @property {object} [beta] Enable experimental features - not for productive use!
- * @property {boolean} [longAutoexposed=false] Deprecated: Produce long names (with underscores) for autoexposed entities
- * @property {Map<string, number>} [severities={}] Map of message-id and severity that allows setting the severity for the given message
- * @property {Array} [messages] Allows collecting all messages in the options instead of printing them to stderr.
- */
-
 /**
  * A fresh (just compiled, not transformed) CSN
  *
@@ -767,13 +720,13 @@ function publishCsnProcessor( processor, _name ) {
  */
 
 /**
- * A map of { <file.hdbcds>:<content> }.
+ * A map of { <file.hdbcds|hdbconstraint>:<content> }.
  *
  * @typedef {object} HDBCDS
  */
 
 /**
- * A map of { <file.hdbtable/view...>:<content> }.
+ * A map of { <file.hdbtable|hdbview|hdbconstraint...>:<content> }.
  *
  * @typedef {object} HDIArtifacts
  */

package/lib/api/options.js

@@ -49,6 +49,7 @@ const privateOptions = [
   'traceParserAmb',
   'testMode',
   'testSortCsn',
+  'constraintsInCreateTable',
   'integrityNotEnforced',
   'integrityNotValidated',
   'assertIntegrity',
@@ -83,9 +84,9 @@ function translateOptions(input = {}, defaults = {}, hardRequire = {},
   for (const name of overallOptions) {
     // Ensure that arrays are not passed as a reference!
     // This caused issues with the way messages are handled in processMessages
-    if (Array.isArray(input[name]) && inputOptionNames.indexOf(name) !== -1)
+    if (Array.isArray(input[name]) && inputOptionNames.includes(name))
       options[name] = [ ...input[name] ];
-    else if (inputOptionNames.indexOf(name) !== -1)
+    else if (inputOptionNames.includes(name))
       options[name] = input[name];
   }
 

package/lib/api/validate.js

@@ -25,13 +25,14 @@ const booleanValidator = {
 /**
  * Generate a Validator that validates that the
  * input is a string and one of the available options.
+ * The validation of the option values is case-insensitive.
  *
  * @param {any} availableValues Available values
  * @returns {Validator} Return a validator for a string in an expected range
  */
 function generateStringValidator(availableValues) {
   return {
-    validate: val => typeof val === 'string' && availableValues.indexOf(val) !== -1,
+    validate: val => typeof val === 'string' && availableValues.some( av => av.toLowerCase() === val.toLowerCase() ),
     expected: (val) => {
       return typeof val !== 'string' ? 'type string' : availableValues.join(', ');
     },

package/lib/backends.js

@@ -279,7 +279,7 @@ function transformSQLOptions(model, options) {
 
   if(options.toSql.dialect !== 'hana') {
     // CDXCORE-465, 'quoted' and 'hdbcds' are to be used in combination with dialect 'hana' only
-    if(['quoted', 'hdbcds'].includes(options.toSql.names)) {
+    if (options.toSql.names === 'quoted' || options.toSql.names === 'hdbcds') {
       error(null, null, `Option "{ toSql.dialect: '${options.toSql.dialect}' }" can't be combined with "{ toSql.names: '${options.toSql.names}' }"`);
     }
     // No non-HANA SQL for HDI
@@ -296,17 +296,17 @@ function transformSQLOptions(model, options) {
   // If among the options user, user.id or user.locale are specified via the CLI or
   // via the API, then ensure that at the end there is a user option, which is an object and has(have)
   // "id" and/or "locale" prop(s)
-  function transformUserOption(options) {
+  function transformUserOption(userOptions) {
     // move the user option value under user.id if specified as a string
-    if (options.user && typeof options.user === 'string' || options.user instanceof String) {
-      options.user = { id: options.user };
+    if (userOptions.user && typeof userOptions.user === 'string' || userOptions.user instanceof String) {
+      userOptions.user = { id: userOptions.user };
     }
     // move the locale option(if provided) under user.locale
-    if (options.locale) {
-      options.user
-        ? Object.assign(options.user, { locale: options.locale })
-        : options.user = { locale: options.locale };
-      delete options.locale;
+    if (userOptions.locale) {
+      userOptions.user = userOptions.user
+        ? Object.assign(userOptions.user, { locale: userOptions.locale })
+        : { locale: userOptions.locale };
+      delete userOptions.locale;
     }
   }
 }
@@ -389,18 +389,16 @@ function toRenameWithCsn(csn, options) {
   let forHanaCsn = transformForHanaWithCsn(csn, mergeOptions(options, { forHana : options.toRename } ), 'to.rename');
   // forHanaCsn looses empty contexts and services, add them again so that toRename can calculate the namespaces
   forEachDefinition(csn, (artifact, artifactName) => {
-    if(['context', 'service'].includes(artifact.kind) && forHanaCsn.definitions[artifactName] === undefined) {
+    if((artifact.kind === 'context' || artifact.kind === 'service') && forHanaCsn.definitions[artifactName] === undefined) {
       forHanaCsn.definitions[artifactName] = artifact;
     }
   });
 
   // Assemble result
-  let result = {
+  return {
     rename : toRenameDdl(forHanaCsn, options),
     options
   };
-
-  return result;
 }
 
 function alterConstraintsWithCsn(csn, options) {
@@ -418,6 +416,10 @@ function alterConstraintsWithCsn(csn, options) {
     names: names || 'plain'
   }
 
+  // Also set new-style options
+  options.sqlDialect = 'hana';
+  options.sqlMapping = names || 'plain';
+
   // Of course we want the database constraints
   options.assertIntegrityType = 'DB';
 
@@ -434,19 +436,7 @@ function alterConstraintsWithCsn(csn, options) {
   else
     intermediateResult = manageConstraints(forSqlCsn, mergedOptions);
 
-  if(options.testMode !== true)
-    return intermediateResult;
-
-  // if in testmode, return a string containing all the artifacts
-  let resultString = '';
-  const extension = src && src === 'hdi' ? 'hdbconstraint' : 'sql';
-  for(const id in intermediateResult){
-    const initialComment = `--$ --- ${id}.${extension} ---\n\n`;
-    resultString += initialComment;
-    resultString += intermediateResult[id];
-    resultString += '\n\n'
-  }
-  return resultString;
+  return intermediateResult;
 }
 
 // ----------- toCsn -----------

package/lib/base/dictionaries.js

@@ -89,17 +89,9 @@ function pushToDict( dict, name, entry ) {
     dict[name] = [entry];
 }
 
-function forEachInDict( dict, callback ) {
-  let r = Object.create(null);
-  for (let name of Object.keys(dict))
-    r[name] = callback( dict[name], name, dict );
-  return r;
-}
-
 module.exports = {
   dictAdd, dictForEach,
   dictAddArray,
   pushToDict,
-  forEachInDict,
 }
 

package/lib/base/error.js

@@ -0,0 +1,26 @@
+'use strict';
+
+/**
+ * Use this class to indicate that an internal error was noticed.
+ * In testMode, these errors do _not_ trigger a recompilation.
+ */
+class CompilerAssertion extends Error {
+  constructor(message) {
+    super(message);
+  }
+}
+
+/**
+ * Use this class to indicate that something with the input CSN is wrong,
+ * which will be caught by the core compiler through recompiling the sources.
+ */
+class ModelError extends Error {
+  constructor(message) {
+    super(message);
+  }
+}
+
+module.exports = {
+  CompilerAssertion,
+  ModelError,
+};

package/lib/base/keywords.js

@@ -1,3 +1,7 @@
+'use strict';
+
+const { functionsWithoutParens } = require("../compiler/builtins");
+
 module.exports = {
   // CDL reserved keywords, used for automatic quoting in 'toCdl' renderer
   // Keep in sync with reserved keywords in language.g4
@@ -11,7 +15,7 @@ module.exports = {
     'DISTINCT',
     'EXISTS',
     'EXTRACT',
-    'FALSE',
+    'FALSE', // boolean
     'FROM',
     'IN',
     'KEY',
@@ -22,28 +26,15 @@ module.exports = {
     'ON',
     'SELECT',
     'SOME',
+    'WHEN',
     'TRIM',
-    'TRUE',
+    'TRUE', // boolean
     'WHERE',
     'WITH',
   ],
   // CDL functions, used for automatic quoting in 'toCdl' renderer,
   // only relevant for element references of path length 1.
-  cdl_functions: [
-    'CURRENT_CONNECTION',
-    'CURRENT_DATE',
-    'CURRENT_SCHEMA',
-    'CURRENT_TIME',
-    'CURRENT_TIMESTAMP',
-    'CURRENT_TRANSACTION_ISOLATION_LEVEL',
-    'CURRENT_USER',
-    'CURRENT_UTCDATE',
-    'CURRENT_UTCTIME',
-    'CURRENT_UTCTIMESTAMP',
-    'SESSION_USER',
-    'SYSTEM_USER',
-    'SYSUUID',
-  ],
+  cdl_functions: functionsWithoutParens,
   // SQLite keywords, used to warn in 'toSql' renderer with dialect 'sqlite'
   // Taken from http://www.sqlite.org/draft/lang_keywords.html
   // Better use keywords in tool/mkkeywordhash.c of a sqlite distribution.
@@ -194,7 +185,7 @@ module.exports = {
     'OTHERS',
     'TIES',
   ],
-  // HANA keywords, used for smart quoting in to-hdi.plain
+  // SAP HANA keywords, used for smart quoting in to-hdi.plain
   // Taken from https://help.sap.com/viewer/7c78579ce9b14a669c1f3295b0d8ca16/Cloud/en-US/28bcd6af3eb6437892719f7c27a8a285.html
   // Better use keywords in ptime/query/parser/syntax/qp_keyword.cc minus those
   // in rule unreserved_keyword_column (=…_common - "CONSTRAINT") in
@@ -674,7 +665,7 @@ module.exports = {
     'XMLTABLE',
     'YEAR'
   ],
-  // HANA CDS keywords, used for smart quoting in to-hdbcds.plain
+  // SAP HANA CDS keywords, used for smart quoting in to-hdbcds.plain
   hdbcds: [
     'ALL',                'ALTER',             'AS',
     'BEFORE',             'BEGIN',             'BOTH',

package/lib/base/location.js

@@ -12,6 +12,9 @@ const { copyPropIfExist } = require('../utils/objectUtils');
  * @param {XSN.WithLocation} start
  * @param {XSN.WithLocation} end
  * @returns {CSN.Location}
+ *
+ * TODO: make this function a CDL parser-only function (i.e. there should be
+ *       no need to use it outside), it is XSN-only anyway already now
  */
 function combinedLocation( start, end ) {
   if (!start || !start.location)
@@ -33,6 +36,8 @@ function combinedLocation( start, end ) {
  *
  * @param {string} filename
  * @returns {CSN.Location}
+ *
+ * TODO: make this function redundant (XSN sparse locations project)
  */
 function emptyLocation(filename) {
   return {
@@ -50,6 +55,8 @@ function emptyLocation(filename) {
  *
  * @param {string} filename
  * @returns {CSN.Location}
+ *
+ * TODO: make this function redundant (XSN sparse locations project)
  */
 function emptyWeakLocation(filename) {
   return {
@@ -63,6 +70,8 @@ function emptyWeakLocation(filename) {
  * Returns a dummy location for built-in definitions.
  *
  * @returns {CSN.Location}
+ *
+ * TODO: make this function redundant (XSN sparse locations project)
  */
 function builtinLocation() {
   return emptyLocation('<built-in>');
@@ -140,10 +149,6 @@ function dictLocation( dict, extraLocation ) {
     endCol: max.endCol,
   };
 }
-dictLocation.end = (dict) => {
-  const loc = dictLocation( dict );
-  return loc && { file: loc.file, line: loc.endLine, col: loc.endCol };
-};
 
 function _objLocations( obj ) {
   return Array.isArray(obj) ? obj.map( o => o.location ) : [ obj.location ];