@sap/cds-compiler 4.9.2 → 5.0.6

package/lib/base/messages.js

@@ -73,8 +73,8 @@ function isDowngradable( messageId, moduleName, options ) {
     return false;
   if (msg.severity !== 'Error')
     return true;
-  // v5 messages are downgradable (except if errorFor also contains the current module).
-  if (msg.errorFor && msg.errorFor.includes('v5'))
+  // v6 messages are downgradable (except if errorFor also contains the current module).
+  if (msg.errorFor && msg.errorFor.includes('v6'))
     return true;
   const { configurableFor } = msg;
   return (Array.isArray( configurableFor ))
@@ -91,9 +91,11 @@ function isDowngradable( messageId, moduleName, options ) {
 function severityChangeMarker(msg, config) {
   const severity = msg.severity || 'Error';
   if (config.moduleForMarker) {
-    if (severity === 'Error' && isDowngradable(msg.messageId, config.moduleForMarker, {}))
+    if (severity === 'Error' &&
+        isDowngradable( msg.messageId, config.moduleForMarker,
+                        { deprecated: { downgradableErrors: true } }))
       return '‹↓›';
-    if (msg.messageId && centralMessages[msg.messageId]?.errorFor?.includes('v5'))
+    if (msg.messageId && centralMessages[msg.messageId]?.errorFor?.includes('v6'))
       return '‹↑›';
   }
   return '';
@@ -107,12 +109,16 @@ function severityChangeMarker(msg, config) {
 class CompilationError extends Error {
   /**
    * @param {CompileMessage[]} messages
-   * @param {boolean} [dontSerializeMessages] If true, compiler messages are NOT part of the errors message text.
    * @param {XSN.Model} [model] the XSN model, only to be set with options.attachValidNames
    */
-  constructor(messages, model, dontSerializeMessages) {
-    const msg = !dontSerializeMessages && messages?.map( m => m.toString() ).join('\n') || '';
-    super( `CDS compilation failed\n${msg}` );
+  constructor(messages, model) {
+    // Because test frameworks such as mocha and jest to not call `toString()` on
+    // an unhandled CompilationError and instead use `e.stack` directly, there is
+    // no proper message about _what_ the root cause of the exception was.
+    // To mitigate that, we serialize the first error in the message as well.
+    const firstError = messages.find( m => m.severity === 'Error' )?.toString() || '';
+    super( `CDS compilation failed\n${firstError}` );
+
     /** @since v4.0.0 */
     this.code = 'ERR_CDS_COMPILATION_FAILURE';
     this.messages = [ ...messages ].sort(compareMessageSeverityAware);
@@ -240,7 +246,7 @@ function reclassifiedSeverity( msg, options, moduleName ) {
       if (errorFor.includes(moduleName))
         return 'Error';
 
-      if (errorFor.includes('v5') && isBetaEnabled(options, 'v5preview')) {
+      if (errorFor.includes('v6') && isBetaEnabled(options, 'v6preview')) {
         severity = 'Error';
         if (!isDowngradable(msg.messageId, moduleName, options))
           return severity;
@@ -555,8 +561,7 @@ function makeMessageFunction( model, options, moduleName = null ) {
 
   function throwWithError() {
     if (hasNewError) {
-      const dontSerializeMessages = isBetaEnabled(options, 'v5preview');
-      throw new CompilationError(messages, options.attachValidNames && model, dontSerializeMessages);
+      throw new CompilationError(messages, options.attachValidNames && model);
     }
   }
 
@@ -573,8 +578,7 @@ function makeMessageFunction( model, options, moduleName = null ) {
       return;
     const hasError = options.testMode ? hasNonDowngradableErrors : hasErrors;
     if (hasError( messages, moduleName, options )) {
-      const dontSerializeMessages = isBetaEnabled(options, 'v5preview');
-      throw new CompilationError(messages, options.attachValidNames && model, dontSerializeMessages);
+      throw new CompilationError(messages, options.attachValidNames && model);
     }
   }
 
@@ -1018,10 +1022,6 @@ function replaceInString( text, params ) {
  * @param {boolean} [config.noMessageId]
  *     If true, will _not_ show the message ID (+ explanation hint) in the output.
  *
- * @param {boolean} [config.idInBrackets]
- *     If true, the message ID (if there is one and noMessageId is falsey) will be put in brackets.
- *     This will be the default in cds-compiler v5.
- *
  * @param {boolean} [config.noHome]
  *     If true, will _not_ show message's semantic location.
  *
@@ -1049,11 +1049,7 @@ function messageString( err,  config ) {
   const downgradable = severityChangeMarker(err, config);
   // even with noHome, print err.home if the location is weak
   const home = !err.home || config.noHome && err.$location?.endLine ? '' : ` (in ${ err.home })`;
-
-  let msgId = ''; // TODO(v5): Use brackets only
-  if (err.messageId && !config.noMessageId)
-    msgId = (config.idInBrackets) ? `[${err.messageId}]` : ` ${err.messageId}`;
-
+  const msgId = (err.messageId && !config.noMessageId) ? `[${err.messageId}]` : '';
   return `${ location }${ severity }${ downgradable }${ msgId }: ${ err.message }${ home }`;
 }
 
@@ -1065,7 +1061,7 @@ function messageString( err,  config ) {
  * @returns {string} can be used to uniquely identify a message
  */
 function messageHash( msg ) {
-  // parser messages do not provide semantic location, therefore we need to use the file location
+  // parser messages do not provide semantic location, therefore$ we need to use the file location
   if (!msg.home)
     return messageString(msg);
   const copy = { ...msg };
@@ -1118,7 +1114,7 @@ function messageHash( msg ) {
  *     If true/'always', ANSI escape codes will be used for coloring the severity.  If false/'never',
  *     no coloring will be used.  If 'auto', we will decide based on certain factors such
  *     as whether the shell is a TTY and whether the environment variable `NO_COLOR` is
- *     unset.
+ *     unset or whether `FORCE_COLOR` is set.
  *
  * @returns {string}
  */
@@ -1285,7 +1281,7 @@ function _messageContext( err, config ) {
  * @param {boolean | 'auto'} [config.color] If true, ANSI escape codes will be used for coloring the `^`.  If false, no
  *                                          coloring will be used.  If 'auto', we will decide based on certain factors such
  *                                          as whether the shell is a TTY and whether the environment variable 'NO_COLOR' is
- *                                          unset.
+ *                                          unset or `FORCE_COLOR` is set.
  * @returns {string}
  *
  * @deprecated Use `messageStringMultiline()` with `config.sourceMap` and `config.sourceLineMap` instead!
@@ -1353,7 +1349,7 @@ function compareMessageSeverityAware( a, b ) {
 /**
  * Return sort-relevant part of semantic location (after the ':').
  * Messages without semantic locations are considered smaller (for syntax errors)
- * and (currently - should not happen in v5) larger for other messages.
+ * and (currently - should not happen in v6) larger for other messages.
  *
  * @param {CompileMessage} msg
  */

package/lib/base/model.js

@@ -31,11 +31,9 @@ const availableBetaFlags = {
   enableUniversalCsn: true,
   odataTerms: true,
   optionalActionFunctionParameters: true, // not supported by runtime, yet.
-  annotateForeignKeys: true,
   effectiveCsn: true,
   tenantVariable: true,
   calcAssoc: true,
-  v5preview: true,
   temporalRawProjection: true,
   // disabled by --beta-mode
   nestedServices: false,

package/lib/base/node-helpers.js

@@ -28,7 +28,6 @@ class PromiseAllError extends Error {
   }
 }
 
-
 module.exports = {
   promiseAllDoNotRejectImmediately,
 };

package/lib/checks/enricher.js

@@ -49,7 +49,6 @@ function enrichCsn( csn, options ) {
     dictionary( csn, 'definitions', csn.definitions );
   return { csn, cleanup };
 
-  // eslint-disable-next-line jsdoc/require-jsdoc
   function standard( parent, prop, node ) {
     if (!node || typeof node !== 'object' || !{}.propertyIsEnumerable.call( parent, prop ))
       return;
@@ -69,7 +68,7 @@ function enrichCsn( csn, options ) {
     }
     csnPath.pop();
   }
-  // eslint-disable-next-line jsdoc/require-jsdoc
+
   function dictionary( node, prop, dict ) {
     setProp(node, '$path', [ ...csnPath ]);
     cleanupCallbacks.push(() => delete node.$path);
@@ -115,7 +114,6 @@ function enrichCsn( csn, options ) {
     }
   }
 
-  // eslint-disable-next-line jsdoc/require-jsdoc
   function columns( parent, prop, node ) {
     // Establish the link relationships
     parent[prop].forEach((column) => {
@@ -130,7 +128,6 @@ function enrichCsn( csn, options ) {
     standard(parent, prop, node);
   }
 
-  // eslint-disable-next-line jsdoc/require-jsdoc
   function simpleRef( node, prop, ref ) {
     setProp(node, '$path', [ ...csnPath ]);
     cleanupCallbacks.push(() => delete node.$path);
@@ -158,7 +155,6 @@ function enrichCsn( csn, options ) {
     }
   }
 
-  // eslint-disable-next-line jsdoc/require-jsdoc
   function pathRef( node, prop, path ) {
     const {
       links, art, scope, $env,

package/lib/checks/structuredAnnoExpressions.js

@@ -0,0 +1,30 @@
+'use strict';
+
+const { isBuiltinType } = require('../base/builtins');
+const { transformExpression, applyTransformationsOnNonDictionary } = require('../model/csnUtils');
+/**
+ *
+ * @param {object} member
+ */
+function checkAnnotationExpression( member, _memberName, _prop, path ) {
+  Object.keys(member).filter(pn => pn[0] === '@').forEach((anno) => {
+    applyTransformationsOnNonDictionary(member, anno, {
+      xpr: (parent, prop, _xpr, xprPath) => {
+        transformExpression(parent, prop, {
+          ref: (elemref, __prop, ref, refPath) => {
+            const { art, scope } = this.csnUtils.inspectRef(refPath);
+            if (scope !== '$magic' && art) {
+              const ft = this.csnUtils.getFinalTypeInfo(art.type);
+              if (!isBuiltinType(ft?.type))
+                this.error('odata-anno-xpr-ref', refPath, { anno, elemref, '#': 'flatten_builtin_type' });
+            }
+          },
+        }, xprPath);
+      },
+    }, {}, path);
+  });
+}
+
+module.exports = {
+  checkAnnotationExpression,
+};

package/lib/checks/validator.js

@@ -15,6 +15,7 @@ const navigationIntoMany = require('./manyNavigations');
 const checkUsedTypesForAnonymousAspectComposition = require('./managedInType');
 const validateHasPersistedElements = require('./hasPersistedElements');
 const checkForHanaTypes = require('./checkForTypes');
+const { checkAnnotationExpression } = require('./structuredAnnoExpressions');
 const checkForParams = require('./parameters');
 // forOdata
 const { validateDefaultValues } = require('./defaultValues');
@@ -210,6 +211,13 @@ function forRelationalDB( csn, that ) {
                         duplicate messages due to the forEachMemberRecursively.
                         TODO: check if this recursion can be factored out of the validator */
                        forEachMember(artifact, checkUsedTypesForAnonymousAspectComposition.bind(that));
+                     },
+                     (artifact, artifactName) => {
+                       if (that.options.transformation === 'effective') {
+                         forEachMemberRecursively(artifact, checkAnnotationExpression.bind(that), [ 'definitions', artifactName ], false, {
+                           skipArtifact: a => a.returns || (a.params && !a.query),
+                         });
+                       }
                      }
                    ),
                    forRelationalDBQueryValidators.concat(commonQueryValidators),

package/lib/compiler/assert-consistency.js

@@ -208,6 +208,7 @@ function assertConsistency( model, stage ) {
             'elements', '$autoElement', '$uncheckedElements', '_origin', '_extensions',
             '$requireElementAccess', '_effectiveType', '$effectiveSeqNo', '_deps',
             '$calcDepElement', '$filtered', '$enclosed', '_parent',
+            'deprecated', '$onlyInExprCtx',
           ],
           schema: {
             kind: { test: isString, enum: [ 'builtin' ] },
@@ -215,6 +216,8 @@ function assertConsistency( model, stage ) {
             $autoElement: { test: isString },
             $uncheckedElements: { test: isBoolean },
             $requireElementAccess: { test: isBoolean },
+            deprecated: { test: isBoolean },
+            $onlyInExprCtx: { test: TODO },
             // missing location for normal "elements"
             elements: { test: TODO },
           },
@@ -703,7 +706,7 @@ function assertConsistency( model, stage ) {
         'localized', // e.g. compiler-generated elements for localized: `text` assoc, etc.
         'localized-entity', // `.texts` entity
         'localized-origin', // `.texts` entity
-        'nav', // only used for MASKED, TODO(v5): Remove
+        'nav', // only used for MASKED, TODO(v6): Remove
         'none', // only used in ensureColumnName(): Used in object representing empty alias
         'query', // inferred query properties, e.g. `key`
         'rewrite', // on-conditions or FKeys are rewritten

package/lib/compiler/base.js

@@ -48,7 +48,7 @@ const kindProperties = {
     normalized: 'action',
     dict: 'actions',
   }, // no extend params, only annotate
-  key: { normalized: 'element' },
+  key: { normalized: 'element', dict: 'elements' }, // dict for annotate
   param: { elements: () => false, enum: () => false, dict: 'params' },
   source: { artifacts: true },  // TODO -> $source
   using: {},

package/lib/compiler/builtins.js

@@ -178,14 +178,15 @@ const magicVariables = {
     // Allow shortcut in CDL: `$user` becomes `$user.id` in CSN.
     $autoElement: 'id',
   },
-  $at: {
+  $at: { // $at is considered deprecated since cds-compiler v5
     elements: {
       from: {}, to: {},
     },
     // Require that elements are accessed, i.e. no $at, only $at.<element>.
     $requireElementAccess: true,
+    deprecated: true, // $at is deprecated; use $valid
   },
-  $valid: { // dito
+  $valid: {
     elements: {
       from: {}, to: {},
     },
@@ -200,6 +201,15 @@ const magicVariables = {
     $uncheckedElements: true,
     $requireElementAccess: true,
   },
+  $draft: {
+    elements: {
+      IsActiveEntity: {},
+    },
+    // Require that elements are accessed, i.e. no $draft, only $draft.<element>.
+    $requireElementAccess: true,
+    // See reference semantics in shared.js
+    $onlyInExprCtx: [ 'annotation', 'annoRewrite' ],
+  },
 };
 
 // see lib/render/renderUtil.js for DB-specific magic vars, specified in CAP CDS  via function
@@ -437,6 +447,10 @@ function initBuiltins( model ) {
         art.$uncheckedElements = magic.$uncheckedElements;
       if (magic.$requireElementAccess)
         art.$requireElementAccess = magic.$requireElementAccess;
+      if (magic.deprecated)
+        art.deprecated = magic.deprecated;
+      if (magic.$onlyInExprCtx)
+        art.$onlyInExprCtx = magic.$onlyInExprCtx;
 
       createMagicElements( art, magic.elements );
       if (options.variableReplacements?.[id])
@@ -461,6 +475,8 @@ function initBuiltins( model ) {
       // Propagate this property so that it is available for sub-elements.
       if (art.$uncheckedElements)
         magic.$uncheckedElements = art.$uncheckedElements;
+      if (art.$onlyInExprCtx)
+        magic.$onlyInExprCtx = art.$onlyInExprCtx;
       setProp( magic, '_parent', art );
       // setProp( magic, '_effectiveType', magic );
       if (elements[id] && typeof elements[id] === 'object')

package/lib/compiler/checks.js

@@ -54,9 +54,6 @@ function check( model ) {
   function checkEvent( def ) {
     // Ensure that events are structured. Up to compiler v4, we allowed non-structured events,
     // because when we introduced them, it was not fully specified what they are.
-    // TODO(v5):
-    //  - Make this a (configurable) error; move to acceptTypeOrElement
-    //  - require type/elements to be set in parser
     if (def.kind === 'event' && !def._effectiveType?.elements && !def._effectiveType?.projection)
       message( 'def-expected-structured', [ (def.type || def.name).location, def ] );
   }
@@ -862,8 +859,8 @@ function check( model ) {
       // Tree-ish expression from the compiler (not augmented)
       // eslint-disable-next-line max-len
       return (isAssociationOperand( xpr.args[0] ) && isDollarSelfOrProjectionOperand( xpr.args[2] ) ||
-      // eslint-disable-next-line max-len
-             isAssociationOperand( xpr.args[2] ) && isDollarSelfOrProjectionOperand( xpr.args[0] ));
+              // eslint-disable-next-line max-len
+              isAssociationOperand( xpr.args[2] ) && isDollarSelfOrProjectionOperand( xpr.args[0] ));
     }
 
     // Nothing else qualifies

package/lib/compiler/define.js

@@ -364,7 +364,7 @@ function define( model ) {
   // must be called after addUsing().
   function addNamespace( namespace, src ) {
     // create using for own namespace:
-    // TODO: should we really do that in v5? See also initNamespaceAndUsing().
+    // TODO: should we really do that (in v6)?  See also initNamespaceAndUsing().
     const last = namespace.path[namespace.path.length - 1];
     const { id } = last;
     if (src.artifacts[id] || last.id.includes( '.' ))
@@ -507,9 +507,10 @@ function define( model ) {
   // TODO: message ids
   function checkRedefinition( art ) {
     if (!art.$duplicates || !art.name.id ||
-        art.$errorReported === 'syntax-duplicate-extend' ||
-        art.$errorReported === 'syntax-duplicate-annotate')
+        art.$errorReported === 'syntax-duplicate-extend')
       return;
+    if (art.kind === 'annotate' || art.kind === 'extend')
+      return; // extensions are merged into a super-annotate; $duplicates are only kept for LSP
     if (art._main) {
       error( 'duplicate-definition', [ art.name.location, art ], {
         name: art.name.id,
@@ -637,7 +638,6 @@ function define( model ) {
   }
 
   function initDollarParameters( art ) {
-    // TODO: remove $parameters in v5?
     // TODO: use setMemberParent() ?
     const parameters = {
       name: { id: '$parameters' },
@@ -939,14 +939,14 @@ function define( model ) {
           setLink( col, '_block', parent._block );
         if (col.inline) { // `@anno elem.{ * }` does not work
           if (col.doc) {
-            message( 'syntax-ignoring-anno', [ col.doc.location, col ],
+            message( 'syntax-unexpected-anno', [ col.doc.location, col ],
                      { '#': 'doc', code: '.{ ‹inline› }' } );
           }
           // col.$annotations no available for CSN input, have to search.
           // Message about first annotation should be enough to avoid spam.
           const firstAnno = Object.keys( col ).find( key => key.startsWith( '@' ) );
           if (firstAnno) {
-            message( 'syntax-ignoring-anno', [ col[firstAnno].name.location, col ],
+            message( 'syntax-unexpected-anno', [ col[firstAnno].name.location, col ],
                      { code: '.{ ‹inline› }' } );
           }
         }
@@ -1083,7 +1083,7 @@ function define( model ) {
           hasElement = true;    // warning with CDL input or `name: {}` in CSN input
       }
       if (hasElement) {
-        // This message is similar to the one above.  In v5/6, we could probably
+        // This message is similar to the one above.  In v6, we could probably
         // turn this warning into an error, remove `$syntax: 'element' (also in
         // language.g4), and use the above `ext-unexpected-element` only for CSN input.
         warning( 'ext-expecting-enum', [ obj.elements[$location], construct ],