@sap/cds-compiler 4.9.8 → 4.9.10

package/CHANGELOG.md

@@ -7,6 +7,14 @@
 Note: `beta` fixes, changes and features are usually not listed in this ChangeLog but [here](doc/CHANGELOG_BETA.md).
 The compiler behavior concerning `beta` features can change at any time without notice.
 
+## Version 4.9.10 - 2025-04-29
+
+### Fixed
+
+- Added option `allowMixinInProjectionExtension` which allows referring to mixins in `extend projection`.
+  This was forbidden in cds-compiler v4, but re-introduced in v5.5.  Users wanting to migrate from cds-compiler
+  v3 to v4 can use this option for easier migration.
+
 ## Version 4.9.8 - 2024-07-29
 
 ### Fixed

package/lib/base/message-registry.js

@@ -975,6 +975,12 @@ const centralMessageTexts = {
     none: 'Ambiguous $(ID) requires an explicit table alias, but there are none: add table aliases to all sub-queries to disambiguate $(ID)',
   },
 
+  'ref-special-in-extend': {
+    std: 'In an added column, $(ID) refers to the element of the projection source $(ART), not the table alias or mixin',
+    alias: 'In an added column, $(ID) refers to the element of the projection source $(ART), not the table alias',
+    mixin: 'In an added column, $(ID) refers to the element of the projection source $(ART), not the mixin',
+  },
+
   'type-managed-composition': {
     std: 'Managed compositions can\'t be used in types', // yet
     sub: 'Managed compositions can\'t be used in sub elements',

package/lib/compiler/shared.js

@@ -175,7 +175,9 @@ function fns( model ) {
     having: 'where',
     groupBy: 'where',
     column: {
-      lexical: tableAliasesIfNotExtendAndSelf,
+      lexical: (!options.allowMixinInProjectionExtension
+        ? tableAliasesIfNotExtendAndSelf // default for v4
+        : tableAliasesAndSelf), // default for v5 or via option
       dollar: true,
       dynamic: combinedSourcesOrParentElements,
       notFound: undefinedSourceElement,
@@ -629,7 +631,6 @@ function fns( model ) {
         // simple 'ref-undefined-art'/'ref-undefined-def' - TODO: which we
         // could "change" to this message at the end of compile():
         error( 'ref-unexpected-autoexposed', [ item.location, user ], { art },
-               // eslint-disable-next-line max-len
                'An auto-exposed entity can\'t be referred to - expose entity $(ART) explicitly' );
         return null;            // continuation semantics: like “not found”
       }
@@ -693,16 +694,49 @@ function fns( model ) {
         return setArtifactLink( head, def ); // we do not want to see the using
       }
       case 'mixin': {
+        if (options.allowMixinInProjectionExtension) { // for v5 compatibility
+          // use a source element having that name if in `extend … with columns`:
+          const elem = (user._user || user).$extended &&
+          art._parent._combined[head.id];
+          if (elem) {
+            path.$prefix = elem._parent.name.id; // prepend alias name
+            info( 'ref-special-in-extend', [ head.location, user ],
+                  { '#': 'mixin', id: head.id, art: elem._origin._main } );
+            setLink( head, '_navigation', elem );
+            return setArtifactLink( head, elem._origin );
+          }
+        }
         return setLink( head, '_navigation', art );
       }
       case '$navElement': {
-        if (head.id === (user._user || user).$extended)
-          path.$prefix = head.id;
+        if (!options.allowMixinInProjectionExtension) { // for v5 compatibility
+          if (head.id === (user._user || user).$extended)
+            path.$prefix = head.id;
+        }
         setLink( head, '_navigation', art );
         return setArtifactLink( head, art._origin );
       }
-      case '$self':             // TODO: remove $projection from CC
       case '$tableAlias': {
+        if (options.allowMixinInProjectionExtension) { // for v5 compatibility
+          // use a source element having that name if in `extend … with columns`:
+          const { $extended } = user._user || user;
+          const elem = $extended && art.elements[head.id];
+          if (elem) {
+            path.$prefix = art.name.id; // prepend alias name
+            info('ref-special-in-extend', [ head.location, user ],
+                 { '#': 'alias', id: head.id, art: elem._origin._main });
+            setLink( head, '_navigation', elem );
+            return setArtifactLink( head, elem._origin );
+          }
+          else if ($extended) {
+            warning( 'ref-deprecated-in-extend', [ head.location, user ], { id: head.id },
+              // eslint-disable-next-line max-len
+                     'In an added column, do not use the table alias $(ID) to refer to source elements' );
+          }
+        }
+      }
+      /* FALLTHROUGH */
+      case '$self': {           // TODO: remove $projection from CC
         setLink( head, '_navigation', art );
         setArtifactLink( head, art._origin ); // query source or leading query in FROM
         if (!art._origin)
@@ -1113,7 +1147,7 @@ function fns( model ) {
       // TODO: if it becomes non-configurable, we can omit this warning
       let id = pathName( path );
       let head = path[0]._artifact || { _parent: art };
-      // eslint-disable-next-line no-cond-assign
+
       while ((head = head?._parent) && head.kind === 'builtin')
         id = `${ head.name.id }.${ id }`;
       const msgId = (art.$uncheckedElements) ? 'ref-unknown-var' : 'ref-undefined-var';
@@ -1635,7 +1669,7 @@ function fns( model ) {
     const txt = index >= path.length
       ? 'complete'
       : (isAssocToPrimaryKeys( assoc ) ? 'keys' : 'std');
-    // eslint-disable-next-line max-len
+
     error( 'ref-invalid-navigation', [ last.location, user ], {
       '#': msgPrefix + txt, art: assoc, name: last.id, alias: '$self',
     }, {

package/lib/json/to-csn.js

@@ -1192,7 +1192,9 @@ function exprInternal( node, xprParens ) {
   }
   if (node.path) {
     const ref = node.path.map( pathItem );
-    if (node.path.$prefix)      // auto-corrected ORDER BY refs without table alias
+    // auto-corrected ORDER BY refs without table alias, or EXTEND … WITH COLUMN
+    // refs to source element shadowed by alias name:
+    if (node.path.$prefix)
       ref.unshift( node.path.$prefix );
     // we would need to consider node.global here if we introduce that
     return extra( { ref }, node );

package/lib/main.d.ts

@@ -131,6 +131,15 @@ declare namespace compiler {
      * @since v2.8.0
      */
     addTextsLanguageAssoc?: boolean
+    /**
+     * Allow referring to mixins in `extend projection` clauses.
+     * This was allowed in cds-compiler v3, forbidden in v4, and allowed in v5.5 by default again.
+     *
+     * @default false
+     * @since v4.9.10
+     * @until v4.9.10
+     */
+    allowMixinInProjectionExtension?: boolean
     /**
      * An array of directory names that are used for CDS module lookups.
      * Lookup directory `node_modules/` is appended if not set explicitly.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/cds-compiler",
-  "version": "4.9.8",
+  "version": "4.9.10",
   "description": "CDS (Core Data Services) compiler and backends",
   "homepage": "https://cap.cloud.sap/",
   "author": "SAP SE (https://www.sap.com)",