@sap/cds-compiler 2.12.0 → 2.13.6

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 = options.user
-        ? Object.assign(options.user, { locale: options.locale })
-        : { 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,7 +389,7 @@ 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;
     }
   });
@@ -416,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';
 
@@ -432,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
@@ -30,21 +34,7 @@ module.exports = {
   ],
   // 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.
@@ -195,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
@@ -675,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 ];

package/lib/base/message-registry.js

@@ -42,15 +42,17 @@ const centralMessages = {
   'anno-definition':        { severity: 'Warning' },
   'anno-duplicate':         { severity: 'Error', configurableFor: true }, // does not hurt us
   'anno-duplicate-unrelated-layer': { severity: 'Error', configurableFor: true }, // does not hurt us
-  'anno-invalid-sql-element': { severity: 'Error'},  // @sql.prepend/append
-  'anno-invalid-sql-struct': { severity: 'Error'},  // @sql.prepend/append
-  'anno-invalid-sql-view': { severity: 'Error' },  // @sql.prepend/append
-  'anno-invalid-sql-view-element': { severity: 'Error'},  // @sql.prepend/append
+  'anno-invalid-sql-element': { severity: 'Error', configurableFor: true },  // @sql.prepend/append - configurable for "I know what I'm doing"
+  'anno-invalid-sql-struct': { severity: 'Error', configurableFor: true },  // @sql.prepend/append - configurable for "I know what I'm doing"
+  'anno-invalid-sql-kind': { severity: 'Error', configurableFor: true  },  // @sql.prepend/append - configurable for "I know what I'm doing"
+  'anno-invalid-sql-view': { severity: 'Error', configurableFor: true  },  // @sql.prepend/append - configurable for "I know what I'm doing"
+  'anno-invalid-sql-view-element': { severity: 'Error', configurableFor: true },  // @sql.prepend/append - configurable for "I know what I'm doing"
   'anno-undefined-action':  { severity: 'Info' },
   'anno-undefined-art':     { severity: 'Info' }, // for annotate statement (for CDL path root)
   'anno-undefined-def':     { severity: 'Info' }, // for annotate statement (for CSN or CDL path cont)
   'anno-undefined-element': { severity: 'Info' },
   'anno-undefined-param':   { severity: 'Info' },
+  'anno-unexpected-ellipsis-layers': { severity: 'Error', configurableFor: true }, // TODO(v3): Merge with anno-unexpected-ellipsis and make non-configurable
 
   'args-expected-named':  { severity: 'Error', configurableFor: 'deprecated' }, // future --sloppy
   'args-no-params':       { severity: 'Error', configurableFor: 'deprecated' }, // future --sloppy
@@ -58,6 +60,8 @@ const centralMessages = {
 
   'assoc-in-array': { severity: 'Error', configurableFor: 'deprecated' }, // not supported yet
   'assoc-as-type':  { severity: 'Error', configurableFor: 'deprecated' }, // TODO: allow more, but not all
+  'def-unexpected-paramview-assoc': { severity: 'Error' },
+  'def-unexpected-calcview-assoc': { severity: 'Error' },
 
   'check-proper-type':    { severity: 'Error', configurableFor: [ 'compile' ] },
   'check-proper-type-of': { severity: 'Info',  errorFor: [ 'for.odata', 'to.edmx', 'to.hdbcds', 'to.sql', 'to.rename' ] },
@@ -131,6 +135,8 @@ const centralMessages = {
   'syntax-fragile-alias': { severity: 'Error', configurableFor: true },
   'syntax-fragile-ident': { severity: 'Error', configurableFor: true },
 
+  'syntax-invalid-extend': { severity: 'Error' },
+
   'syntax-invalid-text-block' : { severity: 'Error' },
   'syntax-unknown-escape': { severity: 'Error', configurableFor: true },
   'syntax-invalid-escape': { severity: 'Error' },
@@ -156,8 +162,10 @@ const centralMessages = {
 
 // For messageIds, where no text has been provided via code (central def)
 const centralMessageTexts = {
+  'anno-duplicate': 'Duplicate assignment with $(ANNO)',
   'anno-mismatched-ellipsis': 'An array with $(CODE) can only be used if there is an assignment below with an array value',
   'anno-unexpected-ellipsis': 'No base annotation available to apply $(CODE)',
+  'anno-unexpected-ellipsis-layers': 'No base annotation available to apply $(CODE)',
   'missing-type-parameter': 'Missing value for type parameter $(NAME) in reference to type $(ID)',
   'syntax-csn-expected-object': 'Expected object for property $(PROP)',
   'syntax-csn-expected-column': 'Expected object or string \'*\' for property $(PROP)',
@@ -179,6 +187,7 @@ const centralMessageTexts = {
     one: 'Expected array in $(PROP) to have at least one item',
     suffix: 'With sibling property $(OTHERPROP), expected array in $(PROP) to have at least one item',
   },
+  'syntax-invalid-extend': 'Can\'t extend an element with $(KIND)',
   'syntax-invalid-text-block': 'Missing newline in text block',
   'syntax-unknown-escape': 'Unknown escape sequence $(CODE)',
   'syntax-invalid-escape': {
@@ -209,6 +218,7 @@ const centralMessageTexts = {
   'ref-unknown-var': {
     std: 'Replacement $(ID) not found'
   },
+  'ref-unexpected-draft-enabled': 'Composition in draft-enabled entity can\'t lead to another entity with $(ANNO)',
   'ref-rejected-on': {
     std: 'Do not refer to a artefact like $(ID) in the explicit ON of a redirection', // Not used
     mixin: 'Do not refer to a mixin like $(ID) in the explicit ON of a redirection',
@@ -238,6 +248,17 @@ const centralMessageTexts = {
     param: 'Artifact $(ART) has no parameter $(MEMBER)'
   },
 
+  'def-unexpected-paramview-assoc': {
+    std: 'SAP HANA does no support associations in/to parameterized entities',
+    view: 'SAP HANA does no support associations in parameterized entities',
+    target: 'SAP HANA does no support associations to parameterized entities',
+  },
+  'def-unexpected-calcview-assoc': {
+    std: 'SAP HANA does not allow associations in/to entities annotated with $(ANNO)',
+    'entity-persistence': 'SAP HANA does not allow associations in entities annotated with $(ANNO)',
+    'target-persistence': 'SAP HANA does not allow associations pointing to entities annotated with $(ANNO)',
+  },
+
   'def-missing-element': {
     std: 'Expecting entity to have at least one non-virtual element',
     view: 'Expecting view to have at least one non-virtual element'

package/lib/base/messages.js

@@ -125,6 +125,7 @@ class CompileMessage {
    * @param {CSN.MessageSeverity} [severity='Error'] Severity: Debug, Info, Warning, Error
    * @param {string} [id] The ID of the message - visible as property messageId
    * @param {any} [home]
+   * @param {string} [moduleName] Name of the module that created this message
    *
    * @memberOf CompileMessage
    */
@@ -175,22 +176,6 @@ function dollarLocation( location ) {
   return loc;
 }
 
-/**
- * Handle compiler messages, i.e. throw a compiler exception if there are errors.
- *
- * @param {object} model CSN or XSN
- * @param {CSN.Options} [options]
- * @deprecated Use throwWithError() from makeMessageFunction instead.
- */
-function handleMessages( model, options = {} ) {
-  const messages = options.messages;
-  if (messages && messages.length) {
-    if (hasErrors( messages ))
-      throw new CompilationError( messages, options.attachValidNames && model );
-  }
-  return model;
-}
-
 const severitySpecs = {
   error: { name: 'Error', level: 0 },
   warning: { name: 'Warning', level: 1 },
@@ -282,16 +267,16 @@ function compareSeverities( a, b ) {
 /**
  * @todo This was copied from somewhere just to make CSN paths work.
  * @param {CSN.Model} model
- * @param {CSN.Path} path
+ * @param {CSN.Path} csnPath
  */
-function searchForLocation( model, path ) {
+function searchForLocation( model, csnPath ) {
   if (!model)
     return null;
   // Don't display a location if we cannot find one!
   let lastLocation = null;
   /** @type {object} */
   let currentStep = model;
-  for (const step of path) {
+  for (const step of csnPath) {
     if (!currentStep)
       return lastLocation;
     currentStep = currentStep[step];
@@ -1101,13 +1086,15 @@ function artName( art, omit ) {
     r.push( (art.kind === 'extend' ? 'block:' : 'query:') + name.select ); // TODO: rename to 'select:1' and consider whether there are more selects
   if (name.action && omit !== 'action')
     r.push( memberActionName(art) + ':' + quoted( name.action ) );
-  if (name.alias)
+  if (name.alias && art.kind !== '$self')
     r.push( (art.kind === 'mixin' ? 'mixin:' : 'alias:') + quoted( name.alias ) )
   if (name.param != null && omit !== 'param')
     r.push( name.param ? 'param:' + quoted( name.param ) : 'returns' ); // TODO: join
   if (name.element && omit !== 'element')
     // r.push( `${ art.kind }: ${ quoted( name.element )}` ); or even better element:"assoc"/key:"i" same with enum
     r.push( (art.kind === 'enum' ? 'enum:' : 'element:') + quoted( name.element ) );
+  if (art.kind === '$self')
+    r.push( 'alias:' + quoted( name.alias ) ) // should be late due to $self in anonymous aspect
   return r.join('/');
 }
 
@@ -1120,6 +1107,7 @@ function memberActionName( art ) {
   return 'action';
 }
 
+// TODO: XSN-specific things should probably move out
 function homeName( art, absoluteOnly ) {
   if (!art)
     return art;
@@ -1135,8 +1123,10 @@ function homeName( art, absoluteOnly ) {
     return homeName( art.name._artifact, absoluteOnly ); // use corresponding definition
   else if (absoluteOnly)
     return art.name.absolute;
-  else
-    return (art._main ? art._main.kind : art.kind) + ':' + artName( art );
+  let main = art._main || art;
+  while (main._outer)           // anonymous aspect
+    main = main._outer._main;
+  return main.kind + ':' + artName( art );
 }
 
 // The "home" for extensions is handled differently because `_artifact` is not
@@ -1190,9 +1180,9 @@ function constructSemanticLocationFromCsnPath(csnPath, model) {
 
   // remove definitions
   csnPath.shift();
-  const artName = csnPath.shift();
-  let currentThing = model.definitions[artName];
-  let result = `${ (currentThing && currentThing.kind) ? currentThing.kind : 'artifact' }:${ _quoted(artName) }`;
+  const artifactName = csnPath.shift();
+  let currentThing = model.definitions[artifactName];
+  let result = `${ (currentThing && currentThing.kind) ? currentThing.kind : 'artifact' }:${ _quoted(artifactName) }`;
 
   if (!currentThing)
     return result;
@@ -1444,12 +1434,12 @@ module.exports = {
   createMessageFunctions,
   makeMessageFunction,
   artName,
-  handleMessages,
   sortMessages: (m => m.sort(compareMessage)),
   sortMessagesSeverityAware: (m => m.sort(compareMessageSeverityAware)),
   deduplicateMessages,
   CompileMessage,
   CompilationError,
+  isMessageDowngradable: isDowngradable,
   explainMessage,
   hasMessageExplanation,
   messageIdsWithExplanation,

package/lib/base/model.js

@@ -27,7 +27,6 @@ const availableBetaFlags = {
   ignoreAssocPublishingInUnion: true,
   nestedProjections: true,
   enableUniversalCsn: true,
-  sqlSnippets: true,
   // disabled by --beta-mode
   nestedServices: false,
 };
@@ -64,7 +63,7 @@ function isBetaEnabled( options, feature ) {
  */
 function isDeprecatedEnabled( options, feature = null ) {
   const { deprecated } = options;
-  if(!feature)
+  if (!feature)
     return !!deprecated;
   return deprecated && typeof deprecated === 'object' && deprecated[feature];
 }
@@ -94,63 +93,6 @@ function forEachMember( construct, callback, target ) {
 
 }
 
-// Apply function `callback(member, memberName, prop)` to each member in
-// `construct`, recursively (i.e. also for sub-elements of elements).
-function forEachMemberRecursively( construct, callback ) {
-  forEachMember( construct, ( member, memberName, prop ) => {
-    callback( member, memberName, prop );
-    // Descend into nested members, too
-    forEachMemberRecursively( member, callback );
-  });
-  // If 'construct' has more than one query, descend into the elements of the remaining ones, too
-  if (construct.$queries && construct.$queries.length > 1) {
-    construct.$queries.slice(1).forEach(query => forEachMemberRecursively(query, callback));
-  }
-}
-
-/**
- * Apply function `callback` to all members of object `obj` (main artifact or
- * parent member).  Members are considered those in dictionaries `elements`,
- * `enum`, `actions` and `params` of `obj`, `elements` and `enums` are also
- * searched inside property `items` (array of).  `$queries`, `mixin` and
- * `columns` are also visited in contrast to `forEachMember()`.
- * See function `forEachGeneric()` for details.
- *
- * @param {XSN.Artifact} construct
- * @param {(member: object, memberName: string, prop: string) => any} callback
- * @param {object} [target]
- */
-function forEachMemberWithQuery( construct, callback, target ) {
-  let obj = construct.returns || construct; // why the extra `returns` for actions?
-  obj = obj.items || obj;
-  forEachGeneric( target || obj, 'elements', callback );
-  forEachGeneric( obj, 'enum', callback );
-  forEachGeneric( obj, 'foreignKeys', callback );
-  forEachGeneric( construct, 'actions', callback );
-  forEachGeneric( construct, 'params', callback );
-  // For Queries
-  forEachGeneric( construct, '$queries', callback );
-  forEachGeneric( construct, 'mixin', callback );
-  forEachGeneric( construct, 'columns', callback );
-}
-
-/**
- * Apply function `callback(member, memberName, prop)` to each member in
- * `construct`, recursively (i.e. also for sub-elements of elements).
- * In contrast to `forEachMemberRecursively()` this function also traverses
- * queries and mixins.
- *
- * @param {XSN.Artifact} construct
- * @param {(member: object, memberName: string, prop: string) => any} callback
- */
-function forEachMemberRecursivelyWithQuery( construct, callback ) {
-  forEachMemberWithQuery( construct, ( member, memberName, prop ) => {
-    callback( member, memberName, prop );
-    // Descend into nested members, too
-    forEachMemberRecursivelyWithQuery( member, callback );
-  });
-}
-
 // Apply function `callback` to all objects in dictionary `dict`, including all
 // duplicates (found under the same name).  Function `callback` is called with
 // the following arguments: the object, the name, and -if it is a duplicate-
@@ -158,7 +100,7 @@ function forEachMemberRecursivelyWithQuery( construct, callback ) {
 function forEachGeneric( obj, prop, callback ) {
   let dict = obj[prop];
   for (let name in dict) {
-    let obj = dict[name];
+    obj = dict[name];
     callback( obj, name, prop );
     if (Array.isArray(obj.$duplicates)) // redefinitions
       obj.$duplicates.forEach( o => callback( o, name, prop ) )
@@ -190,9 +132,6 @@ module.exports = {
   queryOps,
   forEachDefinition,
   forEachMember,
-  forEachMemberRecursively,
-  forEachMemberWithQuery,
-  forEachMemberRecursivelyWithQuery,
   forEachGeneric,
   forEachInOrder,
   setProp,