@sap/cds-compiler 2.13.8 → 3.0.0

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,6 +45,7 @@ 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-unstable-array': { severity: 'Warning' },
   '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"
@@ -62,9 +66,9 @@ const centralMessages = {
   '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' ] },
+  'check-proper-type-of': { severity: 'Info',  errorFor: [ 'for.odata', 'to.edmx', 'to.hdbcds', 'to.sql', 'to.hdi', 'to.rename' ] },
 
   'expr-no-filter': { severity: 'Error', configurableFor: 'deprecated' },
 
@@ -77,6 +81,8 @@ const centralMessages = {
   'expected-type': { severity: 'Error' },
   'ref-sloppy-type': { severity: 'Error' },
   'type-unexpected-typeof': { severity: 'Error', configurableFor: 'deprecated' }, // TODO: make it non-config
+  'type-ignoring-argument': { severity: 'Error', configurableFor: true },
+  'type-expected-builtin': { severity: 'Error', configurableFor: true },
   'expected-actionparam-type': { severity: 'Error' },
   'ref-sloppy-actionparam-type': { severity: 'Error' },
   'expected-event-type': { severity: 'Error' },
@@ -97,6 +103,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
@@ -111,6 +118,7 @@ const centralMessages = {
   'ref-obsolete-parameters': { severity: 'Error', configurableFor: true }, // does not hurt us
   'ref-undefined-param': { severity: 'Error' },
   'ref-rejected-on': { severity: 'Error' },
+  'ref-expected-element': { severity: 'Error' },
 
   'rewrite-key-not-covered-explicit': { severity: 'Error', configurableFor: 'deprecated' },
   'rewrite-key-not-covered-implicit': { severity: 'Error', configurableFor: 'deprecated' },
@@ -123,14 +131,11 @@ const centralMessages = {
   'service-nested-context': { severity: 'Error', configurableFor: true }, // does not hurt compile, TODO
   'service-nested-service': { severity: 'Error', configurableFor: 'deprecated' }, // not supported yet
 
-  'syntax-anno-after-enum':   { severity: 'Error', configurableFor: true }, // does not hurt
-  'syntax-anno-after-params': { severity: 'Error', configurableFor: true }, // does not hurt
-  'syntax-anno-after-struct': { severity: 'Error', configurableFor: true }, // does not hurt
-  'syntax-csn-expected-cardinality': { severity: 'Error' }, // TODO: more than 30 chars
-  'syntax-csn-expected-length': { severity: 'Error' },
-  'syntax-csn-expected-translation': { severity: 'Error' }, // TODO: more than 30 chars
-  'syntax-csn-required-subproperty': { severity: 'Error' }, // TODO: more than 30 chars
-  'syntax-csn-unexpected-property': { severity: 'Error', configurableFor: true }, // is the removed
+  'syntax-expected-cardinality': { severity: 'Error' },
+  'syntax-expected-length': { severity: 'Error' },
+  'syntax-expected-translation': { severity: 'Error' },
+  'syntax-required-subproperty': { severity: 'Error' },
+  'syntax-unexpected-property': { severity: 'Error', configurableFor: true }, // is the removed
   'syntax-deprecated-ident': { severity: 'Error', configurableFor: true },
   'syntax-fragile-alias': { severity: 'Error', configurableFor: true },
   'syntax-fragile-ident': { severity: 'Error', configurableFor: true },
@@ -142,6 +147,10 @@ const centralMessages = {
   'syntax-invalid-escape': { severity: 'Error' },
   'syntax-missing-escape': { severity: 'Error' },
 
+  'syntax-expected-integer': { severity: 'Error' },
+  'syntax-invalid-masked': { severity: 'Error', configurableFor: true },
+  'syntax-unexpected-null': { severity: 'Error', configurableFor: true },
+
   'type-managed-composition': { severity: 'Error', configurableFor: 'deprecated' }, // TODO: non-config
 
   'def-missing-element': { severity: 'Error' },
@@ -151,38 +160,82 @@ 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-type': { severity: 'Error', configurableFor: [ 'to.edmx' ] },
+  'odata-spec-violation-id': { severity: 'Error', configurableFor: true },
+  'odata-spec-violation-type': { severity: 'Error', configurableFor: true },
+  '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-array':  { severity: 'Error', configurableFor: true }, // more than 30 chars
+  'odata-spec-violation-key-null': { severity: 'Error', configurableFor: true }, // 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 = {
+  'api-invalid-option': {
+    std: 'Option $(NAME) is deprecated! Use SNAPI options instead',
+    magicVars: 'Option “magicVars” is deprecated! Use “variableReplacements” instead. See <https://cap.cloud.sap/docs/guides/databases#configuring-variables> for details',
+    user: 'Option “variableReplacements” expects “$user” instead of “user”. See <https://cap.cloud.sap/docs/guides/databases#configuring-variables> for details',
+    locale: 'Option “variableReplacements” expects “$user.locale” instead of “locale”. See <https://cap.cloud.sap/docs/guides/databases#configuring-variables> for details',
+    'noDollar': 'Option “variableReplacements” does not know $(NAME). Did you forget a leading “$”?'
+  },
+
   'anno-duplicate': 'Duplicate assignment with $(ANNO)',
+  'anno-duplicate-unrelated-layer': 'Duplicate assignment with $(ANNO)',
+  'anno-unstable-array': 'Unstable order of array items due to repeated assignments for $(ANNO) in unrelated layers',
   '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)',
-  'syntax-csn-expected-natnum': 'Expected non-negative number for property $(PROP)',
-  'syntax-csn-expected-cardinality': 'Expected non-negative number or string \'*\' for property $(PROP)',
-  'syntax-csn-expected-reference': 'Expected non-empty string or object for property $(PROP)',
-  'syntax-csn-expected-term': 'Expected non-empty string or object for property $(PROP)',
-  'syntax-anno-after-struct': 'Avoid annotation assignments after structure definitions',
-  'syntax-anno-after-enum': 'Avoid annotation assignments after enum definitions',
-  'syntax-anno-after-params': 'Avoid annotation assignments after parameters',
+  'chained-array-of': '"Array of"/"many" must not be chained with another "array of"/"many" inside a service',
+
+  'name-duplicate-element': {
+    'std': 'Generated element $(NAME) conflicts with another element',
+    'flatten-element-gen': 'Generated element $(NAME) conflicts with other generated element',
+    'flatten-element-exist': 'Flattened name of structured element conflicts with existing element $(NAME)',
+    'flatten-fkey-gen': 'Duplicate definition of foreign key element $(NAME) for association $(ART)',
+    'flatten-fkey-exists': 'Generated foreign key element $(NAME) for association $(ART) conflicts with existing element',
+  },
+
+  'syntax-unexpected-ellipsis': {
+    std: 'Expected no more than one $(CODE)',
+    'nested-array': 'Unexpected $(CODE) in nested array'
+  },
+  'syntax-expected-object': 'Expected object for property $(PROP)',
+  'syntax-expected-column': 'Expected object or string \'*\' for property $(PROP)',
+  'syntax-expected-natnum': 'Expected non-negative number for property $(PROP)',
+  'syntax-expected-cardinality': 'Expected non-negative number or string \'*\' for property $(PROP)',
+  'syntax-expected-reference': 'Expected non-empty string or object for property $(PROP)',
+  'syntax-expected-term': 'Expected non-empty string or object for property $(PROP)',
   'syntax-dollar-ident': {
     std: 'An artifact starting with $(NAME) might shadow a special variable - replace by another name',
     $tableAlias: 'A table alias name starting with $(NAME) might shadow a special variable - replace by another name',
     $tableImplicit: 'The resulting table alias starts with $(NAME) and might shadow a special variable - specify another name with $(KEYWORD)',
     mixin: 'A mixin name starting with $(NAME) might shadow a special variable - replace by another name' ,
   },
-  'syntax-csn-expected-length': {
+  'syntax-expected-length': {
     std: 'Expected array in $(PROP) to have at least $(N) items',
     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',
@@ -204,6 +257,30 @@ 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)',
+  },
+  'syntax-invalid-literal': {
+    'std': 'Invalid literal',
+    'uneven-hex': 'A binary literal must have an even number of characters',
+    'invalid-hex': 'A binary literal must only contain characters 0-9, a-f and A-F',
+    'time': 'Expected time\'hh:mm:ss\' where hh, mm and the optional ss are numbers',
+    'date': 'Expected date\'YYYY-MM-DD\' where YYYY, MM and DD are numbers',
+    'timestamp': 'Expected timestamp\'YYYY-MM-DD hh:mm:ss.u…u\' where YYYY, MM, DD, hh, mm, ss and u are numbers (optional 1-7×u)',
+  },
+  'syntax-unexpected-null': 'Keyword $(KEYWORD) must appear after the enum definition and not before',
+  'syntax-unexpected-vocabulary': {
+    std: 'Annotations can\'t be defined inside contexts or services',
+    service: 'Annotations can\'t be defined inside services',
+    context: 'Annotations can\'t be defined inside contexts',
+  },
   'ref-undefined-def': {
     std: 'Artifact $(ART) has not been found',
     // TODO: proposal 'No definition of $(NAME) found',
@@ -213,7 +290,8 @@ 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'
@@ -224,6 +302,10 @@ const centralMessageTexts = {
     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-expected-element': {
+    std: 'Expected element reference',
+    magicVar: 'Only elements of magic variable $(ID) can be selected',
+  },
   'type-unexpected-typeof': {
     std: 'Unexpected $(KEYWORD) for the type reference here',
     type: 'Unexpected $(KEYWORD) in type of a type definition',
@@ -231,6 +313,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)',
@@ -296,6 +391,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',
@@ -312,11 +411,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)',
@@ -331,31 +435,42 @@ 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.
  *        Only has an effect if default severity is 'Error'.
- *        'deprecated': severity can only be changed with deprecated.downgradableErrors.
+ *        'deprecated': severity can only be changed with deprecated._downgradableErrors.
  *        TODO: Value `true` is temporary. Use an array instead.
  * @property {string[]} [errorFor] Array of module names where the message shall be reclassified to an error.
  * @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 };