@sap/cds-compiler 2.12.0 → 2.15.2

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

@@ -30,6 +30,9 @@
 
 'use strict';
 
+const { CompilerAssertion } = require("./error");
+const { createDict } = require("../utils/objectUtils");
+
 /**
  * Central register of messages and their configuration.
  * Group by id-category.
@@ -42,15 +45,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,7 +63,9 @@ 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' },
+  'chained-array-of': { 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' ] },
 
@@ -73,6 +80,7 @@ const centralMessages = {
   'expected-type': { severity: 'Error' },
   'ref-sloppy-type': { severity: 'Error' },
   'type-unexpected-typeof': { severity: 'Error', configurableFor: 'deprecated' }, // TODO: make it non-config
+  'type-expected-builtin': { severity: 'Error', configurableFor: true },
   'expected-actionparam-type': { severity: 'Error' },
   'ref-sloppy-actionparam-type': { severity: 'Error' },
   'expected-event-type': { severity: 'Error' },
@@ -93,6 +101,7 @@ const centralMessages = {
   'query-unexpected-assoc-hdbcds': { severity: 'Error' },
   'query-unexpected-structure-hdbcds': { severity: 'Error' },
   'query-ignoring-param-nullability': { severity: 'Info' },
+  'query-expected-identifier': { severity: 'Error' },
 
   '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
@@ -131,11 +140,15 @@ 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' },
 
+  'syntax-expected-integer': { severity: 'Error' },
+
   'type-managed-composition': { severity: 'Error', configurableFor: 'deprecated' }, // TODO: non-config
 
   'def-missing-element': { severity: 'Error' },
@@ -145,20 +158,46 @@ const centralMessages = {
   'composition-as-key': { severity: 'Error', configurableFor: 'deprecated' }, // is confusing and not supported
   'odata-spec-violation-array':  { severity: 'Warning' }, // more than 30 chars
   'odata-spec-violation-constraints': { severity: 'Info' }, // more than 30 chars
+  'odata-spec-violation-id': { severity: 'Error' },
   'odata-spec-violation-type': { severity: 'Error', configurableFor: [ 'to.edmx' ] },
+  'odata-spec-violation-type-unknown': { severity: 'Warning' },
   'odata-spec-violation-no-key':  { severity: 'Warning' },
   'odata-spec-violation-key-array':  { severity: 'Error' }, // more than 30 chars
   'odata-spec-violation-key-null': { severity: 'Error' }, // more than 30 chars
   'odata-spec-violation-key-type': { severity: 'Warning' }, // more than 30 chars
   'odata-spec-violation-property-name': { severity: 'Warning' }, // more than 30 chars
-  'odata-spec-violation-namespace-name': { severity: 'Warning' }, // more than 30 chars
 };
 
+// Old/Deprecated message IDs that we only still use for backwards-compatibility.
+// We keep them in a separate array for easier access. No need to go through all
+// existing messages and search for the old one in `oldNames` property.
+// The keys will be added to `oldNames` of the new message, which is used for reclassification.
+const oldMessageIds = createDict({
+  'old-anno-duplicate': 'anno-duplicate', // Example
+});
+
+// Set up the old-to-new message ID mapping in the message registry.
+for (const oldName in oldMessageIds) {
+  const newName = oldMessageIds[oldName];
+  if (centralMessages[oldName])
+    throw new CompilerAssertion(`Mapping from ${oldName} not possible: ID is still used in message registry.`);
+  if (!centralMessages[newName])
+    throw new CompilerAssertion(`Mapping from ${oldName} to new message ID ${newName} does not exist!`);
+
+  if (!centralMessages[newName].oldNames)
+    centralMessages[newName].oldNames = [ oldName ];
+  else
+    centralMessages[newName].oldNames.push(oldName);
+}
+
+
 // 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)',
-  'missing-type-parameter': 'Missing value for type parameter $(NAME) in reference to type $(ID)',
+  'anno-unexpected-ellipsis-layers': 'No base annotation available to apply $(CODE)',
+  'chained-array-of': '"Array of"/"many" must not be chained with another "array of"/"many" inside a service',
   'syntax-csn-expected-object': 'Expected object for property $(PROP)',
   'syntax-csn-expected-column': 'Expected object or string \'*\' for property $(PROP)',
   'syntax-csn-expected-natnum': 'Expected non-negative number for property $(PROP)',
@@ -179,6 +218,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': {
@@ -195,6 +235,16 @@ const centralMessageTexts = {
     std: 'Missing escape. Replace $(CODE) with $(NEWCODE)',
     placeholder: 'Placeholders are not supported. Replace $(CODE) with $(NEWCODE)',
   },
+  'syntax-expected-integer': {
+    std: 'A safe integer is expected here',
+    normal: 'An integer number is expected here',
+    unsafe: 'The provided integer is too large',
+  },
+  'syntax-duplicate-argument': {
+    std: 'Unexpected argument $(CODE)',
+    unknown: 'Unknown argument $(CODE)',
+    duplicate: 'Duplicate argument $(CODE)',
+  },
   'ref-undefined-def': {
     std: 'Artifact $(ART) has not been found',
     // TODO: proposal 'No definition of $(NAME) found',
@@ -204,11 +254,13 @@ const centralMessageTexts = {
   // TODO: proposal 'No definition found for $(NAME)',
   'ref-undefined-element': {
     std: 'Element $(ART) has not been found',
-    element: 'Artifact $(ART) has no element $(MEMBER)'
+    element: 'Artifact $(ART) has no element $(MEMBER)',
+    aspect: 'Element $(ID) has not been found in the anonymous target aspect'
   },
   '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',
@@ -221,6 +273,19 @@ const centralMessageTexts = {
     param: 'Unexpected $(KEYWORD) for the type of a parameter definition',
     select: 'Unexpected $(KEYWORD) for type references in queries',
   },
+
+  'type-missing-argument': 'Missing value for argument $(NAME) in reference to type $(ID)',
+  'type-ignoring-argument': 'Too many arguments for type $(ART)',
+  'type-unexpected-argument': {
+    std: 'Too many arguments for type $(ART)',
+    type: 'Unexpected argument $(PROP) for type $(ART) with base type $(TYPE)',
+    builtin: 'Unexpected argument $(PROP) for type $(ART)',
+    'non-scalar': 'Only scalar types can have arguments',
+    max: 'Expecting argument $(PROP) for type $(TYPE) to not exceed $(NUMBER)',
+    min: 'Expecting argument $(PROP) for type $(TYPE) to be greater than or equal to $(NUMBER)',
+    'incorrect-type': 'Expected $(NAMES) for argument $(PROP), but found $(CODE)',
+  },
+
   'anno-builtin': 'Builtin types should not be annotated. Use custom type instead',
   'anno-undefined-def': 'Artifact $(ART) has not been found',
   'anno-undefined-art': 'No artifact has been found with name $(NAME)',
@@ -238,6 +303,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'
@@ -275,6 +351,10 @@ const centralMessageTexts = {
     std: 'Ignoring nullability constraint on parameter when generating SAP HANA CDS view',
     sql: 'Ignoring nullability constraint on parameter when generating SQL view'
   },
+  'query-expected-identifier': {
+    std: 'Expected identifier for select item',
+    assoc: 'Expected identifier as the association\'s name',
+  },
 
   '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',
@@ -291,11 +371,16 @@ const centralMessageTexts = {
   'i18n-different-value': 'Different translation for key $(PROP) of language $(OTHERPROP) in unrelated layers',
 
   // OData version dependent messages
-  'odata-spec-violation-array': 'Unexpected array type for $(API)',
-  'odata-spec-violation-param' : 'Expected parameter to be typed with either scalar or structured type for $(API)',
-  'odata-spec-violation-returns': 'Expected $(KIND) to return one or many values of scalar, complex, entity or view type for $(API)',
-  'odata-spec-violation-assoc': 'Unexpected association in structured type for $(API)',
-  'odata-spec-violation-constraints': 'Partial referential constraints produced for $(API)',
+  'odata-spec-violation-array': 'Unexpected array type for OData $(VERSION)',
+  'odata-spec-violation-param' : 'Expected parameter to be typed with either scalar or structured type for OData $(VERSION)',
+  'odata-spec-violation-returns': 'Expected $(KIND) to return one or many values of scalar, complex, entity or view type for OData $(VERSION)',
+  'odata-spec-violation-assoc': 'Unexpected association in structured type for OData $(VERSION)',
+  'odata-spec-violation-constraints': 'Partial referential constraints produced for OData $(VERSION)',
+  'odata-spec-violation-id': {
+    std: 'Expected EDM name $(ID) to start with a letter or underscore, followed by at most 127 letters, underscores or digits',
+    'v2firstchar': 'Unexpected first character $(PROP) of EDM Name $(ID) for OData $(VERSION)',
+    'qualifier': 'Expected annotation qualifier $(ID) to start with a letter or underscore, followed by at most 127 letters, underscores or digits'
+  },
   // version independent messages
   'odata-spec-violation-key-array': {
     std: 'Unexpected array type for element $(NAME)',
@@ -310,21 +395,30 @@ const centralMessageTexts = {
     scalar: 'Unexpected $(TYPE) mapped to $(ID) as type for key element' // flat
   },
   'odata-spec-violation-no-key': 'Expected entity to have a primary key',
-  'odata-spec-violation-type': 'Expected element to have a type',
+  'odata-spec-violation-type-unknown': 'Unknown Edm Type $(TYPE)',
+  'odata-spec-violation-type': {
+    std: 'Expected element to have a type',
+    incompatible: 'Unexpected EDM Type $(TYPE) for OData $(VERSION)',
+    facet: 'Unexpected EDM Type facet $(NAME) of type $(TYPE) for OData $(VERSION)',
+  },
   '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)',
+  'odata-spec-violation-namespace': {
+    std: 'Expected service name not to be one of the reserved names $(NAMES)',
+    length: 'Expected service name not to exceed 511 characters',
+  },
   // 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)'
-  }
+  },
+  'odata-navigation': 'No OData navigation property generated, target $(TARGET) is outside of service $(SERVICE)'
 }
 
 /**
  * Configuration for a message in the central message register.
  *
  * @typedef {object} MessageConfig
- * @property {CSN.MessageSeverity} severity Default severity for the message.
+ * @property {MessageSeverity} severity Default severity for the message.
  * @property {string[]|'deprecated'|true} [configurableFor]
  *        Whether the error can be reclassified to a warning or lower.
  *        If not `true` then an array is expected with specified modules in which the error is downgradable.
@@ -335,6 +429,8 @@ const centralMessageTexts = {
  * @property {boolean} [throughMessageCall]
  *        If set, it means that a message-id was added to the registry in test-mode through a `message.<severity>()`
  *        call.  Used for ensuring that all calls with the same message-id have the same severity.
+ * @property {string[]} [oldNames] Aliases for the message id. Used for reclassification as well as "explain" messages.
+ *                                 Don't set this property directly! Append to object oldMessageIds instead!
  */
 
-module.exports = { centralMessages, centralMessageTexts };
+module.exports = { centralMessages, centralMessageTexts, oldMessageIds };