@sap/cds-compiler 5.1.2 → 5.3.0

package/lib/compiler/resolve.js

@@ -99,6 +99,7 @@ function resolve( model ) {
   Object.assign( model.$functions, {
     resolveExpr,
     addForeignKeyNavigations,
+    redirectionChain,
   } );
 
   const ignoreSpecifiedElements
@@ -174,9 +175,10 @@ function resolve( model ) {
         // TODO: or should we push elems with `expand` sibling to extra list for
         //       better messages?  (Whatever that means exactly.)
 
-        if (elem._pathHead) {
-          if (elem._pathHead?.kind !== '$inline')
-            // we're traversing top-level elements of the query; other _pathHead kinds can't happen
+        if (elem._columnParent) {
+          if (elem._columnParent?.kind !== '$inline')
+            // we're traversing top-level elements of the query;
+            // other _columnParent kinds can't happen
             throw new CompilerAssertion('found unexpected "expand", but expected "inline"');
 
           if (!isPathBreakout( elem.value )) {
@@ -205,13 +207,17 @@ function resolve( model ) {
       if (!nav.item._navigation) // first non-table-alias
         setLink( nav.item, '_navigation', navItem );
 
-      if (path[index].where || path[index].args)
-        return;
+      // We consider an element only projected if the path doesn't have
+      // either arguments or filters; but we build up the navigation env
+      // nonetheless, as it makes rewriting paths later on easier.
+      let isComplexPath = !!(path[index].where || path[index].args);
+
       ++index;
       while (navItem && index < path.length) {
         const step = path[index];
-        if (!step?.id || step.where || step.args)
+        if (!step?.id)
           break;
+        isComplexPath ||= !!(step.where || step.args);
         if (!navItem.elements?.[step.id]) {
           const elements = navItem._origin?.elements ||
             navItem._origin?.target?._artifact?.elements;
@@ -228,26 +234,26 @@ function resolve( model ) {
         setLink( step, '_navigation', navItem );
         ++index;
       }
-      // Last path step, if found, is a simple projection
+      // Last path step, if found, is a projected, either complex or simple.
       if (index === path.length && navItem)
-        pushLink( navItem, '_projections', elem );
+        pushLink( navItem, isComplexPath ? '_complexProjections' : '_projections', elem );
     }
   }
 
   function columnParentPath( elem ) {
-    if (!elem._pathHead || !elem.value?.path || isPathBreakout( elem.value ))
+    if (!elem._columnParent || !elem.value?.path || isPathBreakout( elem.value ))
       return elem.value?.path;
 
     const fullPath = [ ...elem.value.path ];
-    let pathHead = elem._pathHead;
-    while (pathHead) {
-      if (pathHead.kind !== '$inline' || !pathHead.value?.path ||
-          isPathBreakout( pathHead.value )) {
+    let columnParent = elem._columnParent;
+    while (columnParent) {
+      if (columnParent.kind !== '$inline' || !columnParent.value?.path ||
+          isPathBreakout( columnParent.value )) {
         // path breakout for e.g. `$self.{ foo }`, `1 as a .{ foo }`
         return null;
       }
-      fullPath.unshift(...pathHead.value.path);
-      pathHead = pathHead._pathHead;
+      fullPath.unshift(...columnParent.value.path);
+      columnParent = columnParent._columnParent;
     }
     return fullPath;
   }
@@ -285,16 +291,16 @@ function resolve( model ) {
     return false;
   }
 
-  function inheritedSourceKeyProp( { value, _pathHead } ) {
+  function inheritedSourceKeyProp( { value, _columnParent } ) {
     if (!value || !value.path)
       return null;
-    const nav = !_pathHead && pathNavigation( value );
+    const nav = !_columnParent && pathNavigation( value );
     const item = value.path[value.path.length - 1];
     if (nav?.navigation && nav.item === item)
       return item._artifact?.key;
-    if (value.path.length !== 1 || _pathHead?.kind !== '$inline')
+    if (value.path.length !== 1 || _columnParent?.kind !== '$inline')
       return null;
-    const hpath = _pathHead.value?.path;
+    const hpath = _columnParent.value?.path;
     const head = hpath?.length === 1 && hpath[0]._navigation;
     return head?.kind === '$tableAlias' && item._artifact?.key;
   }
@@ -316,7 +322,7 @@ function resolve( model ) {
       propagateKeys = false;
       info( 'query-from-many', [ toMany.location, query ], { art: toMany }, {
         std: 'Key properties are not propagated because a to-many association $(ART) is selected',
-        // eslint-disable-next-line max-len
+        // eslint-disable-next-line @stylistic/js/max-len
         element: 'Key properties are not propagated because a to-many association $(MEMBER) of $(ART) is selected',
       } );
     }
@@ -344,7 +350,7 @@ function resolve( model ) {
       const elem = query.elements[name];
 
       if (!elem.$inferred && elem.value?.path) {
-        const path = elem._pathHead ? columnParentPath( elem ) : elem.value.path;
+        const path = elem._columnParent ? columnParentPath( elem ) : elem.value.path;
         if (testExpr({ path }, selectTest, () => false, elem))
           propagateKeys = false;
       }
@@ -357,9 +363,9 @@ function resolve( model ) {
         // ID published! Used in stakeholder project; if renamed, add to oldMessageIds
         info( 'query-navigate-many', [ art.location, user || query ], { art }, {
           std: 'Navigating along to-many association $(ART) - key properties are not propagated',
-          // eslint-disable-next-line max-len
+          // eslint-disable-next-line @stylistic/js/max-len
           element: 'Navigating along to-many association $(MEMBER) of $(ART) - key properties are not propagated',
-          // eslint-disable-next-line max-len
+          // eslint-disable-next-line @stylistic/js/max-len
           alias: 'Navigating along to-many mixin association $(MEMBER) - key properties are not propagated',
         } );
       }
@@ -395,9 +401,6 @@ function resolve( model ) {
   function resolveRefs( art ) {
     if (art.builtin)
       return;
-    // console.log(info( null, [ art.location, art ], {}, 'REFS').toString());
-    // console.log(info( null, [ art.location, art ], { art: art.target || 'none' },
-    //   'RR: $(ART)').toString());
     const parent = art._parent;
     const allowedInMain = [ 'entity', 'aspect', 'event' ].includes( adHocOrMainKind( art ) );
     const isTopLevelElement = parent && (parent.kind !== 'element' || parent.targetAspect);
@@ -513,8 +516,6 @@ function resolve( model ) {
       }
     }
     if (obj.target) {
-      // console.log(error( 'test-target', [ obj.location, obj ],
-      //   { target: obj.target, kind: obj.kind }, 'Target: $(TARGET), Kind $(KIND)'));
       if (!obj.target.$inferred || obj.target.$inferred === 'aspect-composition')
         resolveTarget( art, obj );
       else
@@ -530,7 +531,6 @@ function resolve( model ) {
       resolvePath( art.targetElement, 'targetElement', art );
 
     // Resolve projections/views
-    // if (art.query)console.log( info( null, [art.query.location,art.query], 'VQ:' ).toString() );
 
     if (art.$queries)
       art.$queries.forEach( resolveQuery );
@@ -923,14 +923,12 @@ function resolve( model ) {
     // TODO: or set silent dependencies in init?
     forEachGeneric( query, 'elements', elem => dependsOnSilent( query, elem ) );
     forEachGeneric( query, '$tableAliases', ( alias ) => {
-      // console.log( info( null, [alias.location,alias], 'SQA:' ).toString() );
       if (alias.kind === 'mixin')
         resolveRefs( alias );   // mixin element
       else if (alias.kind !== '$self')
         // pure path has been resolved, resolve args and filter now:
         resolveExpr( alias, 'from', query._parent );
     } );
-    // if (!query.$inlines) console.log('RQ:',query)
     for (const col of query.$inlines)
       resolveExpr( col.value, 'column', col );
     // for (const col of query.$inlines)
@@ -1008,7 +1006,7 @@ function resolve( model ) {
     }
     const target = resolvePath( obj.target, 'target', art );
 
-    if (obj._pathHead && obj.type && !obj.type.$inferred && art._main && art._main.query) {
+    if (obj._columnParent && obj.type && !obj.type.$inferred && art._main && art._main.query) {
       // New association inside expand/inline: The on-condition can't be properly checked,
       // so abort early. See #8797
       error( 'query-unexpected-assoc', [ obj.name.location, art ], {},
@@ -1090,17 +1088,8 @@ function resolve( model ) {
         issue['#'] = 'order';
       }
     }
-    if (issue['#']) {
-      /* eslint-disable max-len */
-      message( 'type-expecting-service-target', [ art.target.location, art ], issue, {
-        std: 'Expecting service entity $(TARGET)',
-        ref: 'Expecting service entity $(TARGET); its element $(ID) referred to at line $(LINE), column $(COL) is not from an element with the same name in the provided model target',
-        key: 'Expecting service entity $(TARGET); its key element $(ID) is not from a key element with the same name in the provided model target',
-        missing: 'Expecting service entity $(TARGET); it does not have the key element $(ID) of the provided model target',
-        order: 'Expecting service entity $(TARGET); its key elements are in a different order than those of the provided model target',
-      } );
-      /* eslint-enable max-len */
-    }
+    if (issue['#'])
+      message( 'type-expecting-service-target', [ art.target.location, art ], issue );
   }
 
   function keyElementNames( elements ) {
@@ -1138,7 +1127,7 @@ function resolve( model ) {
   function addImplicitForeignKeys( art, obj, target ) {
     obj.foreignKeys = Object.create( null );
     forEachInOrder( target, 'elements', ( elem, name ) => {
-      if (elem.key && elem.key.val) {
+      if (elem.key?.val) {
         const location = weakLocation( obj.target.location );
         const key = {
           name: { location, id: elem.name.id, $inferred: 'keys' },
@@ -1223,7 +1212,7 @@ function resolve( model ) {
           const text = (item !== last) ? 'sub' : 'std';
           error( 'duplicate-key-ref', [ item.location, key ], { '#': text, name }, {
             std: 'Foreign key $(NAME) already refers to the same target element',
-            // eslint-disable-next-line max-len
+            // eslint-disable-next-line @stylistic/js/max-len
             sub: 'Foreign key $(NAME) already refers to the target element whose sub element is again referred to here',
             // TODO: please add ideas for a better text, e.g. to (closed) PR #11325
           } );
@@ -1241,9 +1230,8 @@ function resolve( model ) {
     const origType = assoc && effectiveType( assoc );
     if (origType === 0)
       return;
-    if (!origType || !origType.target) {
-      const path = (elem.value && elem.value.path);
-      const loc = (path && path[path.length - 1] || elem.value || elem).location;
+    if (!origType?.target) {
+      const loc = (elem.value?.path?.at(-1) || elem.value || elem).location;
       error( 'redirected-no-assoc', [ loc, elem ], {},
              'Only an association can be redirected' );
       return;
@@ -1253,63 +1241,68 @@ function resolve( model ) {
       error( 'type-invalid-cast', [ elem.type.location, elem ], { '#': 'assoc' } );
       return;
     }
-    // console.log(message( null, elem.location, elem, {target,art:assoc}, 'Info','RE')
-    //             .toString(), elem.value)
-    const nav = elem._main && elem._main.query && elem.value && pathNavigation( elem.value );
-    if (nav && nav.item !== elem.value.path[elem.value.path.length - 1]) {
-      if (!elem.on && origType.on) {
-        error( 'rewrite-not-supported', [ elem.target.location, elem ] );
-        return;
-      }
-    }
+
     const origTarget = origType.target._artifact;
-    // console.log(require('../model/revealInternalProperties').ref(elem),
-    //             !!origTarget,!!origType._effectiveType,!!origType.target)
-    if (!origTarget || !target)
-      return;
 
-    const chain = [];
-    if (target === origTarget) {
-      if (!elem.target.$inferred && !elem.on && !elem.foreignKeys) {
-        // Only a managed redirection gets this info message.  Because otherwise
-        // we'd have to check whether on-condition/foreignKeys are the same.
-        // ID published! Used in stakeholder project; if renamed, add to oldMessageIds
-        info( 'redirected-to-same', [ elem.target.location, elem ], { art: target },
-              'The redirected target is the original $(ART)' );
-      }
-      setLink( elem, '_redirected', chain ); // store the chain
-      return;
+    if (target === origTarget && !elem.target.$inferred && !elem.on && !elem.foreignKeys) {
+      // Only a managed redirection gets this info message.  Because otherwise
+      // we'd have to check whether on-condition/foreignKeys are the same.
+      // ID published! Used in stakeholder project; if renamed, add to oldMessageIds
+      info( 'redirected-to-same', [ elem.target.location, elem ], { art: target },
+            'The redirected target is the original $(ART)' );
     }
+
     if (elem.foreignKeys || elem.on)
       return;          // TODO: or should we still bring an msg if nothing in common?
+
+    const chain = redirectionChain( elem, target, origTarget );
+    setLink( elem, '_redirected', chain );
+  }
+
+  /**
+   * Get the redirection chain between a target and the original target.
+   *
+   * @param {XSN.Artifact} elem
+   * @param {XSN.Artifact} target
+   * @param {XSN.Artifact} origTarget
+   * @param {boolean} [silent] Whether to report error and other messages.
+   * @returns {XSN.Artifact[]|null}
+   */
+  function redirectionChain( elem, target, origTarget, silent = false ) {
+    if (!origTarget || !target)
+      return null;
+    if (target === origTarget)
+      return []; // e.g. explicit ON-condition/foreign keys or original target
+
+    const chain = [];
     // now check whether target and origTarget are "related"
+    // first: check via simple projections
     while (target.query) {
       const from = target.query.args ? {} : target.query.from;
       if (!from)
-        return;                 // parse error - TODO: or UNION?
+        return null;           // parse error - TODO: or UNION?
       if (!from.path) {
+        if (silent)
+          break;
         const isTarget = target === elem.target._artifact;
         const op = from.op?.val || target.query.op?.val;
         const variant = (!isTarget && 'std') || (op && 'targetOp') || 'target';
-        // ID published! Used in stakeholder project; if renamed, add to oldMessageIds
         info( 'redirected-to-complex', [ elem.target.location, elem ],
-              { art: target, '#': variant, keyword: op || '' }, {
-                std: 'Redirection involves the complex view $(ART)',
-                target: 'The redirected target $(ART) is a complex view',
-                targetOp: 'The redirected target $(ART) is a complex view with $(KEYWORD)',
-              } );
+              { art: target, '#': variant, keyword: op || '' } );
         break;
       }
       target = from._artifact;
       if (!target)
-        return;
+        return null;
       chain.push( from );
       if (target === origTarget) {
+        // found in simple projection chain
         chain.reverse();
-        setLink( elem, '_redirected', chain );
-        return;
+        return chain;
       }
     }
+
+    // there is a complex view in-between; search through table aliases
     let redirected = null;
     chain.reverse();
     let news = [ { chain, sources: [ target ] } ];
@@ -1327,25 +1320,25 @@ function resolve( model ) {
           else if (!redirected) {
             redirected = (s.kind === '$tableAlias') ? [ s, ...o.chain ] : o.chain;
           }
-          else {
+          else if (!silent) {
             error( 'redirected-to-ambiguous', [ elem.target.location, elem ], { art: origTarget },
                    'The redirected target originates more than once from $(ART)' );
-            return;
+            return null;
+          }
+          else {
+            return null;
           }
         }
       }
     }
-    if (redirected) {
-      setLink( elem, '_redirected', redirected );
-    }
-    else if (redirected == null) {
+    if (!silent && redirected == null) {
       error( 'redirected-to-unrelated', [ elem.target.location, elem ], { art: origTarget },
              'The redirected target does not originate from $(ART)' );
     }
-    return;
+    return redirected;
 
     // B = proj on A, C = A x B, X = { a: assoc to A on a.Q1 = ...}, Y = X.{ a: redirected to C }
-    // what does a: redirected to C means?
+    // what does 'a: redirected to C' mean?
     // -> collect all elements Qi used in ON (corr: foreign keys)
     // -> only use an tableAlias which has propagation for all elements
     // no - error if the original target can be reached twice
@@ -1377,7 +1370,7 @@ function resolve( model ) {
         if (a.path && a.kind !== '$self' && a.kind !== 'mixin')
           sources.push( a );
       }
-      if (alias.kind === '$tablealias')
+      if (alias.kind === '$tableAlias')
         news.push( { chain: [ alias, ...chain ], sources } );
       else
         news.push( { chain, sources } );
@@ -1436,7 +1429,6 @@ function resolve( model ) {
   }
 
   function resolveExpr( expr, exprCtx, user ) {
-    // console.log(expr?.location.line,exprCtx)
     traverseExpr( expr, exprCtx, user, resolveExprItem );
   }
 
@@ -1513,7 +1505,7 @@ function resolve( model ) {
       message( 'expr-unexpected-filter', [ location, user ], { '#': variant }, {
         std: 'A filter can only be provided when navigating along associations',
         // to help users for `… from E:toF { toF[…].x }`
-        // eslint-disable-next-line max-len
+        // eslint-disable-next-line @stylistic/js/max-len
         tableAlias: 'A filter can only be provided when navigating along associations, but found table alias',
         from: 'A filter can only be provided for the source entity or associations',
       } );
@@ -1593,7 +1585,8 @@ function pathNavigation( ref ) {
   if (root.kind === '$self')
     return { item, tableAlias: root };
   if (root.kind !== '$tableAlias' || ref.path.length < 2)
-    return {};                // should not happen
+    return {}; // should not happen
+  // table alias
   return { navigation: root.elements?.[item.id], item, tableAlias: root };
 }
 

package/lib/compiler/shared.js

@@ -1,5 +1,4 @@
 // Compiler functions and utilities shared across all phases
-// TODO: rename to paths.js and move non resolve-paths functions to somewhere else
 
 'use strict';
 
@@ -546,7 +545,7 @@ function fns( model ) {
       ruser = ruser._outer;
 
     // Handle expand/inline, `type of`, :param, global (internally for CDL):
-    if (user._pathHead && !semantics.isMainRef) { // in expand/inline
+    if (user._columnParent && !semantics.isMainRef) { // in expand/inline
       const { name } = semantics;
       semantics = semantics.nestedColumn();
       semantics.name = name;
@@ -563,7 +562,7 @@ function fns( model ) {
 
     // Search in lexical environments, including $self/$projection:
     const { isMainRef } = semantics;
-    const lexical = semantics.lexical?.( ruser ); // TODO: _pathHead?
+    const lexical = semantics.lexical?.( ruser ); // TODO: _columnParent?
     if (lexical) {
       const [ nextProp, dictProp ] = (isMainRef)
         ? [ '_block', 'artifacts' ]
@@ -608,7 +607,7 @@ function fns( model ) {
   // element item in the path)
   // TODO - think about setting _navigation for all $navElement – the
   // "ref: ['tabAlias']: inline: […]" handling might be easier
-  // (no _pathHead consultation for key prop and renaming support)
+  // (no _columnParent consultation for key prop and renaming support)
   function getPathItem( ref, semantics, user ) {
     // let art = (headArt && headArt.kind === '$tableAlias') ? headArt._origin : headArt;
     const { path } = ref;
@@ -918,7 +917,7 @@ function fns( model ) {
   }
 
   function nestedElements( user ) {
-    const colParent = user._pathHead;
+    const colParent = user._columnParent;
     Functions.effectiveType( colParent ); // set _origin
     const path = colParent?.value?.path;
     if (!path?.length)
@@ -1129,7 +1128,7 @@ function fns( model ) {
   }
 
   function undefinedNestedElement( user, head, valid, _dict, _art, path, semantics ) {
-    const art = user._pathHead._origin;
+    const art = user._columnParent._origin;
     if (!art)
       return null;              // no consequential error
     return undefinedItemElement( user, head, valid, null, art, path, semantics );
@@ -1226,7 +1225,7 @@ function fns( model ) {
         // of invisible table aliases; at least one stakeholder uses this,
         // so it can't be an error (yet).
         message( 'ref-deprecated-self-element', [ ref.path[0].location, user._user ], {},
-                 // eslint-disable-next-line max-len
+                 // eslint-disable-next-line @stylistic/js/max-len
                  'Referring to the query\'s own elements here might lead to invalid SQL references; use source elements only' );
         return false;
       default:
@@ -1551,7 +1550,7 @@ function fns( model ) {
     const location = (user.expand || user.inline)[$location];
     // mention `table alias` in text only with initial single path item ref,
     // but do not mention that $self { … } is allowed, shouldn't be advertised:
-    const txt = (path.length > 1 || user._pathHead) ? 'struct' : 'init';
+    const txt = (path.length > 1 || user._columnParent) ? 'struct' : 'init';
     const code = (user.expand) ? '{ ‹expand› }' : '.{ ‹inline› }';
     message( 'def-unexpected-nested-proj', [ location, user ], { '#': txt, code } );
   }
@@ -1618,7 +1617,7 @@ function fns( model ) {
     else if (target._artifact && target._artifact !== user._main && user._main.kind === 'entity') {
       const last = path[path.length - 1];
       warning( 'ref-invalid-backlink', [ last.location, user ], { art: target, id: '$self' },
-               // eslint-disable-next-line max-len
+               // eslint-disable-next-line @stylistic/js/max-len
                'The target $(ART) of the association is not the current entity represented by $(ID)' );
     }
   }
@@ -1655,7 +1654,7 @@ function fns( model ) {
 
   function checkOnlyForeignKeyNavigation( user, path, startIndex = 0, msgPrefix = '' ) {
     // has to be run after foreign-key rewrite
-    const outer = user._pathHead?._origin;
+    const outer = user._columnParent?._origin;
     let assoc = outer?.foreignKeys &&
                 pathStartsWithSelf( { path } ) == null && // not $self or CDS var like $now
                 outer;
@@ -1708,11 +1707,11 @@ function fns( model ) {
       std: 'Can follow association $(ART) only to its foreign key references, not to $(NAME)',
       keys: 'Can follow managed association $(ART) only to the keys of its target, not to $(NAME)',
       complete: 'The reference must cover a full foreign key reference of association $(ART)',
-      // eslint-disable-next-line max-len
+      // eslint-disable-next-line @stylistic/js/max-len
       'self-std': 'In column ref starting with $(ALIAS), we can follow association $(ART) only to its foreign key references, not to $(NAME)',
-      // eslint-disable-next-line max-len
+      // eslint-disable-next-line @stylistic/js/max-len
       'self-keys': 'In column ref starting with $(ALIAS), we can follow managed association $(ART) only to the keys of its target, not to $(NAME)',
-      // eslint-disable-next-line max-len
+      // eslint-disable-next-line @stylistic/js/max-len
       'self-complete': 'The column reference starting with $(ALIAS) must cover a full foreign key reference of association $(ART)',
     } );
     // TODO later: mention allowed ones