@sap/cds-compiler 2.11.2 → 2.13.6

package/lib/base/message-registry.js

@@ -42,11 +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', 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
@@ -54,13 +60,14 @@ 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' ] },
 
   'expr-no-filter': { severity: 'Error', configurableFor: 'deprecated' },
 
-  'empty-entity': { severity: 'Info', errorFor: [ 'to.hdbcds', 'to.sql', 'to.rename' ] },
   'empty-type':   { severity: 'Info' }, // only still an error in old transformers
 
   // Structured types were warned about but made CSN un-recompilable.
@@ -69,7 +76,7 @@ const centralMessages = {
   // TODO: rename to ref-expected-XYZ
   'expected-type': { severity: 'Error' },
   'ref-sloppy-type': { severity: 'Error' },
-  'ref-invalid-typeof': { severity: 'Error', configurableFor: 'deprecated' }, // TODO: make it non-config
+  'type-unexpected-typeof': { severity: 'Error', configurableFor: 'deprecated' }, // TODO: make it non-config
   'expected-actionparam-type': { severity: 'Error' },
   'ref-sloppy-actionparam-type': { severity: 'Error' },
   'expected-event-type': { severity: 'Error' },
@@ -89,6 +96,7 @@ const centralMessages = {
   'query-undefined-element': { severity: 'Error' },
   'query-unexpected-assoc-hdbcds': { severity: 'Error' },
   'query-unexpected-structure-hdbcds': { severity: 'Error' },
+  'query-ignoring-param-nullability': { severity: 'Info' },
 
   'recalculated-localized': { severity: 'Info' }, // KEEP: Downgrade in lib/transform/translateAssocsToJoins.js
   'redirected-implicitly-ambiguous': { severity: 'Error', configurableFor: true }, // does not hurt us - TODO: ref-ambiguous-target
@@ -99,6 +107,7 @@ const centralMessages = {
   'ref-undefined-def':    { severity: 'Error' },
   'ref-undefined-var':    { severity: 'Error' },
   'ref-undefined-element': { severity: 'Error' },
+  'ref-unknown-var': { severity: 'Info' },
   'ref-obsolete-parameters': { severity: 'Error', configurableFor: true }, // does not hurt us
   'ref-undefined-param': { severity: 'Error' },
   'ref-rejected-on': { severity: 'Error' },
@@ -126,8 +135,17 @@ 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' },
+  'syntax-missing-escape': { severity: 'Error' },
+
   'type-managed-composition': { severity: 'Error', configurableFor: 'deprecated' }, // TODO: non-config
 
+  'def-missing-element': { severity: 'Error' },
+
   'unexpected-keys-for-composition': { severity: 'Error' }, // TODO: more than 30 chars
   'unmanaged-as-key': { severity: 'Error', configurableFor: 'deprecated' }, // is confusing
   'composition-as-key': { severity: 'Error', configurableFor: 'deprecated' }, // is confusing and not supported
@@ -144,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': 'Unexpected $(CODE) in annotation assignment',
+  '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)',
@@ -167,6 +187,23 @@ 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': {
+    std: 'Invalid escape sequence $(CODE)',
+    octal: 'Octal escape sequences are not supported. Use unicode escapes instead',
+    whitespace: 'Unknown escape sequence: Can\'t escape whitespace',
+    codepoint: 'Undefined code-point for $(CODE)',
+    'unicode-hex': 'Expected hexadecimal numbers for unicode escape but found $(CODE)',
+    'hex-count': 'Expected $(NUMBER) hexadecimal numbers for escape sequence but found $(CODE)',
+    'unicode-brace': 'Missing closing brace for unicode escape sequence',
+    'language-identifier': 'Escape sequences in text-block\'s language identifier are not allowed',
+  },
+  'syntax-missing-escape':  {
+    std: 'Missing escape. Replace $(CODE) with $(NEWCODE)',
+    placeholder: 'Placeholders are not supported. Replace $(CODE) with $(NEWCODE)',
+  },
   'ref-undefined-def': {
     std: 'Artifact $(ART) has not been found',
     // TODO: proposal 'No definition of $(NAME) found',
@@ -178,17 +215,21 @@ const centralMessageTexts = {
     std: 'Element $(ART) has not been found',
     element: 'Artifact $(ART) has no element $(MEMBER)'
   },
+  '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',
     alias: 'Do not refer to a source element (via table alias $(ID)) in the explicit ON of a redirection',
   },
-  'ref-invalid-typeof': {
-    std: 'Do not use $(KEYWORD) for the type reference here',
-    type: 'Do not use $(KEYWORD) for the type of a type',
-    event: 'Do not use $(KEYWORD) for the type of an event',
-    param: 'Do not use $(KEYWORD) for the type of a parameter',
-    select: 'Do not use $(KEYWORD) for type references in queries',
+  'type-unexpected-typeof': {
+    std: 'Unexpected $(KEYWORD) for the type reference here',
+    type: 'Unexpected $(KEYWORD) in type of a type definition',
+    event: 'Unexpected $(KEYWORD) for the type of an event',
+    param: 'Unexpected $(KEYWORD) for the type of a parameter definition',
+    select: 'Unexpected $(KEYWORD) for type references in queries',
   },
   'anno-builtin': 'Builtin types should not be annotated. Use custom type instead',
   'anno-undefined-def': 'Artifact $(ART) has not been found',
@@ -207,6 +248,22 @@ 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'
+  },
+
   'duplicate-definition': {
     std: 'Duplicate definition of $(NAME)',
     absolute: 'Duplicate definition of artifact $(NAME)',
@@ -235,6 +292,10 @@ const centralMessageTexts = {
 
   'query-unexpected-assoc-hdbcds': 'Publishing a managed association in a view is not possible for “hdbcds” naming mode',
   'query-unexpected-structure-hdbcds': 'Publishing a structured element in a view is not possible for “hdbcds” naming mode',
+  'query-ignoring-param-nullability': {
+    std: 'Ignoring nullability constraint on parameter when generating SAP HANA CDS view',
+    sql: 'Ignoring nullability constraint on parameter when generating SQL view'
+  },
 
   'ref-sloppy-type': 'A type or an element is expected here',
   'ref-sloppy-actionparam-type': 'A type, an element, or a service entity is expected here',
@@ -273,6 +334,11 @@ const centralMessageTexts = {
   'odata-spec-violation-type': 'Expected element to have a type',
   'odata-spec-violation-property-name': 'Expected element name to be different from declaring $(KIND)',
   'odata-spec-violation-namespace': 'Expected service name not to be one of the reserved names $(NAMES)',
+  // Other odata/edm errors
+  'odata-definition-exists': {
+    std: 'Entity can\'t be created due to name collision with existing definition $(NAME)',
+    proxy: 'No proxy entity created due to name collision with existing definition $(NAME) of kind $(KIND)'
+  }
 }
 
 /**

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];
@@ -672,13 +657,16 @@ function ignoreTextTransform() {
 
 function transformManyWith( t, sorted ) {
   return function transformMany( many, r, args, texts ) {
-    const prop = ['none','one'][ many.length ];
-    if (!prop || !texts[prop] || args['#'] ) {
-      const names = many.map(t);
-      return (sorted ? names.sort() : names).join(', ');
-    }
+    const prop = ['none','one','two'][ many.length ];
+    const names = many.map(t);
+    if (sorted)
+      names.sort();
+    if (!prop || !texts[prop] || args['#'] )
+      return names.join(', ');
     r['#'] = prop;              // text variant
-    return many.length && t( many[0] );
+    if (many.length === 2)
+      r.second = names[1];
+    return many.length && names[0];
   };
 }
 
@@ -793,7 +781,7 @@ function replaceInString( text, params ) {
     start = pattern.lastIndex;
   }
   parts.push( text.substring( start ) );
-  let remain = ('#' in params) ? [] : Object.keys( params ).filter( n => params[n] );
+  let remain = (params['#']) ? [] : Object.keys( params ).filter( n => params[n] );
   return (remain.length)
          ? parts.join('') + '; ' +
            remain.map( n => n.toUpperCase() + ' = ' + params[n] ).join(', ')
@@ -845,7 +833,10 @@ function messageHash(msg) {
   if(!msg.home)
     return messageString(msg);
   const copy = {...msg};
-  copy.$location = undefined;
+  // Note: This is a hack. deduplicateMessages() would otherwise remove
+  //       all but one message about duplicated artifacts.
+  if (!msg.messageId || !msg.messageId.includes('duplicate'))
+    copy.$location = undefined;
   return messageString(copy);
 }
 
@@ -1082,7 +1073,7 @@ function deduplicateMessages( messages ) {
 
 function shortArtName( art ) {
   const { name } = art;
-  if ([ 'select', 'action', 'alias', 'param' ].every( n => name[n] == null ) &&
+  if ([ 'select', 'action', 'alias', 'param' ].every( n => name[n] == null || name[n] === 1 ) &&
       !name.absolute.includes(':'))
     return quote.name( name.element ? `${ name.absolute }:${ name.element }` : name.absolute );
   return artName( art );
@@ -1095,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('/');
 }
 
@@ -1114,6 +1107,7 @@ function memberActionName( art ) {
   return 'action';
 }
 
+// TODO: XSN-specific things should probably move out
 function homeName( art, absoluteOnly ) {
   if (!art)
     return art;
@@ -1129,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
@@ -1184,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;
@@ -1438,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

@@ -63,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];
 }
@@ -93,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-
@@ -157,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 ) )
@@ -189,9 +132,6 @@ module.exports = {
   queryOps,
   forEachDefinition,
   forEachMember,
-  forEachMemberRecursively,
-  forEachMemberWithQuery,
-  forEachMemberRecursivelyWithQuery,
   forEachGeneric,
   forEachInOrder,
   setProp,