@sap/cds-compiler 4.8.0 → 4.9.0

package/lib/compiler/xpr-rewrite.js

@@ -0,0 +1,689 @@
+// Rewrite paths in annotation expressions.
+//
+// This module rewrites paths in expressions of propagated annotations.
+// To properly rewrite paths, we need to consider where the annotation originates
+// and where it is propagated to.
+//
+// Paths may need:
+// 1. to have their prefix changed.
+//    This affects e.g. propagation due to type-of, where a prefix `$self.a` needs to
+//    be replaced by `$self.sub.elem` or even simple type references at parameters
+//    where `$self` needs to be replaced by `:P`.
+// 2. to be rewritten due to projections
+//    This affects all paths that contain association steps, as their target may
+//    have been redirected, but also all annotations on projections.
+//
+// References referring to parameters are never rewritten.
+//
+// Via Includes
+// ============
+// Path prefixes don't change. However, we may need to reject the annotation if
+// an included element was overridden and the type has changed.
+//
+// The path then needs to be rewritten due to associations.
+// See section "Associations".
+//
+// Via Type
+// ========
+// If an annotation was written at a type or at an element of a type, we may need to
+// adapt path prefixes at the type usage position.
+//
+// If an annotation is propagated from a type definition and the type is used at:
+//
+// - another (type) definition, no prefixes need to change.
+// - another (type) definition as an include, see "Includes".
+// - an element definition, `$self` needs to be replaced by the element name.
+//   Paths without `$self` on the type itself (not sub-elements), need to have
+//   the element name prepended.
+// - a parameter, `$self` needs to be replaced by the parameter name.
+//   Paths without `$self` on the type itself (not sub-elements), need to have
+//   the parameter name prepended.
+// - a return parameter, `$self` needs to be rejected, because there is no way
+//   to refer to `returns`. Paths without `$self` on the type itself (not sub-elements),
+//   need to be rejected as well.
+//
+// If elements in a structured type use `$self`, they, too, will need to be rewritten.
+// The same rules as above apply.  Because this would always end up in element
+// expansion, this case is rejected and only possible with a beta flag.
+// If no `$self` is used, no prefixes need to change, as the paths are already relative.
+// Parameter references in types do not exist.
+//
+// The path then needs to be rewritten due to associations.
+// See section "Associations".
+//
+// Via Type-Of
+// ===========
+// For type-ofs such as `E:sub.elem`, similar rules as for "type" are required, but
+// before rewriting the paths, we need to check whether the path is valid.
+//
+// For `E:sub.elem`, all paths at element `elem` need to refer to sub-elements of
+// `elem` or `elem` itself only.  If siblings of `elem` or siblings of `sub` are
+// referred to, the path can't be rewritten at the type-of usage location.
+//
+// Because non-relative references such as `$self` inside structures would always
+// end up in element expansion, they are rejected and are only possible with a beta
+// flag.
+//
+// If an annotation is propagated from an element `sub.elem` and the type-of is used at:
+//
+// - another type definition, the path may also not refer to element `sub.elem`
+//   itself, as it can't be rewritten to `$self` at a type definition.
+//   Paths starting with `$self.sub.elem` must be replaced by `$self`, i.e.
+//   the path up to the last path step in the type-of.
+// - an element definition, `$self.sub.elem` needs to be replaced by the element name.
+//   Paths without `$self` on the "type-of element" itself need to have
+//   the first path step be replaced by the target element name.
+// - a parameter, `$self.sub.elem` needs to be replaced by the parameter name.
+//   Paths without `$self` on the "type-of element" itself need to have
+//   the first path step be replaced by the target parameter name.
+// - a return parameter, `$self` needs to be rejected, because there is no way
+//   to refer to `returns`. Paths without `$self` on the "type-of element" itself
+//   (not sub-elements), need to be rejected as well.
+//
+// The path then needs to be rewritten due to associations.
+// See section "Associations".
+//
+// Associations
+// ============
+// All paths containing associations may need to be rewritten.  Due to auto-exposure
+// and auto-redirection, associations may be redirected to projections of their
+// original targets.  And those projections may rename elements or leave them out
+// altogether.  Therefore, all paths with associations need to be rewritten
+// according to the rules in section "In Queries".
+//
+// In Queries
+// ==========
+// Both, propagation from source entity to query, but also from element to select item,
+// need to respect renamed select items.
+//
+// Select Item via Origin
+// ----------------------
+// A bare select item that gets an annotation via propagation from its origin behaves
+// similar to an element that gets it via an include.
+// However, elements may have been renamed or may not be available at all.
+// On top of that, they may be inside nested projections (expand).
+//
+// Instead of changing the path prefix, we need to check if the referenced path
+// was projected or if a prefix was projected (e.g. for structures or associations).
+// The same rules as for ON-condition rewriting apply.
+//
+// TODO:
+//   For now, we do not rewrite sub-structure elements.  The whole structure needs
+//   to be projected or the select item isn't considered.  That is, `expand {*}`
+//   is not considered, yet.
+//
+// Query Source
+// ------------
+// For propagation from query sources to the query, the same rules as for select
+// items apply.
+//
+// Via Calculated Element Origin
+// =============================
+// Calculated elements behave just like `type-of`.
+//
+// Notes on $self
+// ==============
+// Because `$self` handling is complicated and will always result in type-expansion
+// if used on/in a type definition, we reject it at such places.
+// This module still resolves and rewrites them properly, though, if beta flag
+// `rewriteAnnotationExpressionsViaType` is used.
+//
+// Notes on Propagator
+// ===================
+// If the compiler expands all elements (including those in `targetAspect`), then we
+// can move the call to rewriteAnnotationRefs from the propagator into tweak-assocs.
+// There, we need to go through _all_ definitions, not just `model._entities`.
+// But until then, we rely on the propagator to properly propagate annotations.
+
+
+'use strict';
+
+const { weakLocation } = require('../base/location');
+const {
+  setArtifactLink,
+  setLink,
+  setExpandStatusAnnotate,
+} = require('./utils');
+const { CompilerAssertion } = require('../base/error');
+const { isBetaEnabled } = require('../base/model');
+
+// Config object passed around all "rewrite" functions.
+class AnnoRewriteConfig {
+  anno;
+  target;
+  targetRoot;
+  origin;
+  isViaType;
+  isViaCalcElement;
+  viaExpand;
+  viaExpandType;
+  isInFilter;
+}
+
+function xprRewriteFns( model ) {
+  const { error } = model.$messageFunctions;
+  const {
+    traverseExpr,
+    resolvePath,
+    navigationEnv,
+    resolvePathRoot,
+  } = model.$functions;
+
+  return {
+    rewriteAnnotationsRefs,
+  };
+
+  /**
+   * @param expr
+   * @param {AnnoRewriteConfig} config
+   * @param {string} [variant]
+   */
+  function reportAnnoRewriteError( expr, config, variant = 'std' ) {
+    return error('anno-missing-rewrite', [
+      weakLocation( config.target.location ), config.target,
+    ], {
+      '#': variant,
+      anno: config.anno,
+      art: config.origin,
+      elemref: expr,
+    });
+  }
+
+  /**
+   * Rewrite the propagated annotation relative to the target.
+   *
+   * @param {XSN.Artifact} target
+   * @param {XSN.Artifact} origin
+   * @param {string} annoName
+   */
+  function rewriteAnnotationsRefs( target, origin, annoName ) {
+    // Make sure not to waste time if no inherited annotation has references:
+    if (!origin?.$contains?.$annotation?.$path)
+      return;
+
+    const anno = target[annoName];
+    // only annotations with expressions have a kind
+    // also, don't report errors twice
+    if (!anno.kind || anno.$invalidPaths)
+      return;
+
+    const isViaType = target.type?._artifact === origin;
+    const [ viaExpand, viaExpandType ] = !isViaType && getExpandRoot( target ) || [ null, null ];
+    const isViaCalcElement = !isViaType && target.$calcDepElement &&
+      target.value?._artifact === origin;
+
+    const config = {
+      __proto__: AnnoRewriteConfig.prototype,
+      anno: annoName,
+      target,
+      targetRoot: annoRootArt( target ),
+      origin,
+      isViaType,
+      isViaCalcElement,
+      viaExpand,
+      viaExpandType,
+    };
+
+    const hasError = rewriteAnnotationExpr( target[annoName], config );
+    target.$contains ??= {};
+    target.$contains.$annotation ??= {};
+    target.$contains.$annotation.$path ||= origin.$contains.$annotation.$path;
+    target.$contains.$annotation.$self ||= origin.$contains.$annotation.$self;
+    if (hasError)
+      anno.$invalidPaths = true; // avoid subsequent errors
+  }
+
+  /**
+   * @param {XSN.Expression} expr
+   * @param {AnnoRewriteConfig} config
+   * @returns {boolean}
+   */
+  function rewriteAnnotationExpr( expr, config ) {
+    if (expr.literal === 'array') {
+      return !!expr.val.find(val => rewriteAnnotationExpr( val, config ));
+    }
+    else if (expr.literal === 'struct') {
+      const struct = Object.values(expr.struct);
+      return !!struct.find(val => rewriteAnnotationExpr( val, config ));
+    }
+    else if (expr.$tokenTexts) {
+      // used to set `$tokenText` to true in case of rewritten annotation
+      config.tokenExpr = expr;
+      return !!traverseExpr(
+        expr, 'annoRewrite', config.target,
+        (e, refCtx) => rewriteAnnoExpr( e, config, refCtx )
+      );
+    }
+    return false;
+  }
+
+  /**
+   * @param {XSN.Expression} expr
+   * @param {AnnoRewriteConfig} config
+   * @param {string} refCtx
+   * @returns {null} Returns true if the expression couldn't be rewritten.
+   */
+  function rewriteAnnoExpr( expr, config, refCtx ) {
+    const root = expr.path && (expr.path[0]?._navigation || expr.path[0]?._artifact);
+    if (!root || !expr._artifact)
+      return null; // invalid path
+
+    const { target } = config;
+
+    // Report obsolete $parameters; parameters on non-actions not supported, yet.
+    if (root.kind === '$parameters' || (root.kind === 'param' && root._parent.kind !== 'action' &&
+      root._parent.kind !== 'function'))
+      return reportAnnoRewriteError( expr, config, 'unsupported' );
+
+    let hasError = false;
+    if (config.isViaType || config.isViaCalcElement)
+      hasError = adaptPathPrefixViaType( expr, config );
+    else if (config.viaExpand)
+      hasError = adaptPathPrefixViaTypeExpansion( expr, config );
+
+    hasError ||= rewriteGenericAnnoPath( expr, config, refCtx );
+
+    if (hasError)
+      return true;
+
+    // TODO: Remove extra loop once filter traversal is added to traverseExpr (#12068)
+    for (const step of expr.path) {
+      if (step?._artifact && step.where && !Array.isArray( step._artifact ) ) {
+        // We must not prefix `$`-renamed variables with `$self`, as it would
+        // change meaning, see (#11775).  Also, the path's target changes.
+        const assocTarget = step._artifact.target._artifact;
+        if (target) {
+          const filterConfig = { ...config, target: assocTarget, isInFilter: true };
+          if (traverseExpr( step.where, 'filter', step,
+            (e, ctx) => expr.path && rewriteGenericAnnoPath( e, filterConfig, ctx )))
+            return true;
+        }
+        else {
+          // can't happen: rejected earlier by compiler
+          return reportAnnoRewriteError( expr, config, 'unsupported' );
+        }
+      }
+    }
+
+    if (model.options.testMode) {
+      // re-resolve the modified path; all paths steps must match what we rewrote
+      const ref = { ...expr, path: [ ...expr.path.map(item => ({ ...item })) ] };
+      if (!resolvePath( ref, refCtx, target ))
+        throw new CompilerAssertion(`rewritten anno path must be resolvable: ${ JSON.stringify(ref.path) }`);
+
+      for (let i = 0; i < ref.path.length; ++i) {
+        const actual = ref.path[i];
+        const expected = ref.path[i];
+        if (actual._artifact !== expected._artifact) {
+          throw new CompilerAssertion(`rewritten anno path contains incorrect artifact links: ${
+            JSON.stringify(ref.path) }; step ${ i }`);
+        }
+        else if (actual._navigation !== undefined && actual._navigation !== expected._navigation) {
+          throw new CompilerAssertion(`rewritten anno path contains incorrect navigation links: ${
+            JSON.stringify(ref.path) }; step ${ i }`);
+        }
+      }
+    }
+
+    return false;
+  }
+
+  /**
+   * @param {XSN.Expression} expr
+   * @param {AnnoRewriteConfig} config
+   * @returns {*}
+   */
+  function getRootEnv( expr, config ) {
+    const { target } = config;
+    if (isAnnoPathAbsolute( expr ))
+      return navigationEnv( config.targetRoot, null, null, 'nav' );
+    // root item is element reference (others were already rejected)
+    if (isAnnoRootArt( target ))
+      return navigationEnv( target, null, null, 'nav' );
+    return navigationEnv( target._parent, null, null, 'nav' );
+  }
+
+  /**
+   * @param {XSN.Expression} expr
+   * @param {AnnoRewriteConfig} config
+   * @param {string} refCtx
+   * @returns {boolean}
+   */
+  function rewriteGenericAnnoPath( expr, config, refCtx ) {
+    const rootIndex = isAnnoPathAbsolute( expr ) ? 1 : 0;
+    let env = getRootEnv( expr, config );
+
+    // reset artifact link
+    setArtifactLink( expr, null );
+
+    // Adapt root path, as it isn't rewritten in rewriteItem
+    const rootItem = expr.path[0];
+    if (rootIndex === 1) {
+      delete rootItem._artifact;
+      delete rootItem._navigation;
+      // TODO: What about `up_`? Shouldn't we set `_navigation` as well?
+      // TODO: Can we handle `$self` of anonymous-composition-of-aspect?
+      const root = resolvePathRoot( expr, refCtx, config.target );
+      if (!root)
+        return reportAnnoRewriteError( expr, config );
+    }
+
+    let art = rootItem._artifact;
+    for (let i = rootIndex; i < expr.path.length; ++i) {
+      const item = expr.path[i];
+      art = rewriteItem( expr, config, env, item );
+      if (!art)
+        return reportAnnoRewriteError( expr, config );
+      env = navigationEnv( art, null, null, 'nav' );
+    }
+    setArtifactLink( expr, art );
+
+    if (rootIndex === 0 && rootItem.id.startsWith('$')) {
+      if (config.isInFilter) {
+        // In filters, we must not prepend `$self`, as that would change its meaning.
+        // We must reject it. See #11775
+        return reportAnnoRewriteError( expr, config );
+      }
+      // After rewriting, an element starts with `$` -> add root prefix
+      prependRootPath( config.origin, config.targetRoot, expr );
+    }
+
+    return false;
+  }
+
+  /**
+   * Rewrite an expression that came via type propagation.
+   *
+   * @returns {boolean} Returns the expression if it couldn't be rewritten.
+   */
+  function adaptPathPrefixViaType( expr, config ) {
+    const { target, origin } = config;
+    if (!target._main && !origin._main)
+      return false; // no need to rewrite; both are top-level
+
+    if (rejectOuterReference( expr, origin, config ))
+      return true;
+
+    // $self-paths via types from/to non-main artifacts always need to be rewritten.
+    config.tokenExpr.$tokenTexts = true;
+
+    const wasAbsolute = isAnnoPathAbsolute( expr );
+    stripPrefixToNewRoot( expr, target, origin );
+
+    if (wasAbsolute) {
+      prependRootPath( origin, target, expr );
+    }
+    else if (!isAnnoRootArt( target )) { // target is element
+      const item = { id: target.name.id };
+      setArtifactLink( item, target );
+      prependToStrippedPath( origin, expr, [ item ] );
+    }
+    else if (target.kind === 'param') {
+      // annotations on parameters need a `:prefix`
+      prependRootPath( origin, target, expr );
+    }
+    else {
+      prependToStrippedPath( origin, expr, [ ] );
+    }
+
+    return false;
+  }
+
+  function adaptPathPrefixViaTypeExpansion( expr, config ) {
+    const root = expr.path[0]?._navigation;
+    if (root?.kind !== '$self') {
+      // non-self paths are always valid in expanded artifacts
+      // TODO: What about parameter references? Are they already always rejected?
+      return false;
+    }
+
+    // $self-paths via type expansion always need to be rewritten.
+    config.tokenExpr.$tokenTexts = true;
+
+    const { target } = config;
+    // We reject $self-paths because they need to be rewritten.
+    // However, with a special flag, we allow rewriting it for testing purposes.
+    if (!isBetaEnabled( model.options, 'rewriteAnnotationExpressionsViaType' ))
+      return reportAnnoRewriteError( expr, config, 'unsupported' );
+
+    if (rejectOuterReference( expr, config.viaExpandType, config ))
+      return true;
+
+    stripPrefixToNewRoot( expr, target, config.viaExpandType );
+    prependRootPath( config.viaExpandType, config.viaExpand, expr );
+    setExpandStatusAnnotate( target, 'annotate' );
+    config.target[config.anno].$inferred = 'anno-rewrite';
+    return false;
+  }
+
+  /**
+   * Prepend a path to `expr.path` or replace the root item.
+   * The path needs to have been run through exprstripPrefixToNewRoot(…)`.
+   * It is prepended if the root item is not the origin.
+   * Replaced otherwise.
+   *
+   * @param origin
+   * @param {XSN.Expression} expr
+   * @param path
+   */
+  function prependToStrippedPath( origin, expr, path ) {
+    // If origin is a definition, we need to _prepend_ the path.
+    // Otherwise, we need to replace the root's name.
+    const rootArt = expr.path[0]._artifact;
+    if (rootArt === origin)
+      expr.path.shift();
+    expr.path.unshift(...path);
+  }
+
+  /**
+   * Strips a prefix path from `expr.path`.  The prefix is defined
+   * by where `newRootArt` appears in the path.
+   *
+   * @param {XSN.Expression} expr
+   * @param {XSN.Artifact} target
+   * @param {XSN.Artifact} newRootArt
+   */
+  function stripPrefixToNewRoot( expr, target, newRootArt ) {
+    const relativeRoot = findRelativeRoot( expr, newRootArt );
+    if (relativeRoot === -1 && isAnnoRootArt( newRootArt ))
+      return; // no $self; root item is element
+    if (relativeRoot >= 1)
+      expr.path = expr.path.slice(relativeRoot);
+    else if (relativeRoot === -1)
+      throw new CompilerAssertion('Error while rewriting annotation');
+  }
+
+  /**
+   * Returns false if the path can be propagated to the target without referring
+   * to any "outer" elements.  It differentiates between the target being a main
+   * artifact and elements, because an element annotation referring to itself can't
+   * be propagated to a type:
+   *
+   *     type T1 : { @a: (elem) elem: String; };
+   *     type T2 : T1:elem; // invalid
+   *
+   * Also considers other targets such as `returns`, etc.
+   *
+   * @param {XSN.Expression} expr
+   * @param {XSN.Artifact} origin
+   * @param {AnnoRewriteConfig} config
+   * @returns {boolean}
+   */
+  function rejectOuterReference( expr, origin, config ) {
+    if (!isAnnoPathAbsolute( expr ) && !origin._main)
+      return false;
+
+    const root = expr.path[0]?._navigation;
+    const found = findRelativeRoot( expr, origin );
+    const isInvalid = (found === -1) ||
+      // Can't use paths with `$self` in `returns`.
+      (root?.kind === '$self' && isReturnParam( config.targetRoot )) ||
+      // siblings are allowed for non-main artifacts, except for 'returns'
+      (!config.target._main || isReturnParam( config.target )) && (expr.path.length - found) <= 1;
+
+    if (isInvalid)
+      return reportAnnoRewriteError( expr, config );
+    return false;
+  }
+
+  /**
+   * Finds the path segment in expr which starts at `origin`.
+   * For example, for a path `$self.elem.b.c` on an element `b`, it will return 2.
+   * Returns -1 if `origin` isn't found in the path.
+   *
+   * @param {XSN.Expression} expr
+   * @param {XSN.Artifact} newRootArt
+   * @returns {number}
+   */
+  function findRelativeRoot( expr, newRootArt ) {
+    if (!newRootArt._main) // main artifacts can't have outer references
+      return expr.path[0]?._artifact === newRootArt ? 0 : -1;
+
+    const { path } = expr;
+    for (let i = 0; i < path.length; ++i) {
+      const item = path[i];
+      if (item._artifact === newRootArt)
+        return i;
+    }
+    return -1;
+  }
+
+  function prependRootPath( origin, art, expr ) {
+    const path = [];
+    while (!isAnnoRootArt( art )) {
+      const item = { id: art.name.id };
+      setArtifactLink( item, art );
+      do
+        art = art._parent;
+      while (art.kind === 'select');
+      path.push(item);
+    }
+
+    if (art.kind === 'param') {
+      const param = { id: art.name.id };
+      setArtifactLink( param, art );
+      path.push(param);
+      expr.scope = 'param';
+    }
+    else {
+      const self = makeDollarSelfItem( art );
+      path.push(self);
+    }
+    path.reverse();
+
+    prependToStrippedPath( origin, expr, path );
+  }
+
+  function makeDollarSelfItem( art ) {
+    const self = { id: '$self' };
+    setLink( self, '_artifact', art );
+    setLink( self, '_navigation', art.$tableAliases.$self );
+    return self;
+  }
+
+  function rewriteItem( expr, config, env, item ) {
+    const found = setArtifactLink( item, findRewriteTarget( item, env, config.target ));
+    if (found) {
+      if (item.id !== found.name.id) {
+        // Path was rewritten; original token text string is no longer accurate
+        config.tokenExpr.$tokenTexts = true;
+        item.id = found.name.id;
+      }
+      return found;
+    }
+    return null;
+  }
+
+  function findRewriteTarget( item, env, target ) {
+    if (!env.query && env.kind !== 'select')
+      return env.elements?.[item.id] || null;
+    const items = (env._leadingQuery || env)._combined?.[item.id];
+    const navs = !items || Array.isArray(items) ? items : [ items ];
+
+    // Look at all table aliase that could project `item` and only select
+    // those that have actual projections.
+    let projected = navs?.filter(p => p._origin === item._artifact && p._projections);
+    if (!projected || projected.length === 0)
+      return null;
+
+    // If the annotation target itself has a table alias, prefer projections
+    // of that table alias over others when rewriting.
+    const tableAlias = target.value?.path[0]?._navigation;
+    if (tableAlias?.kind === '$tableAlias') {
+      // TODO: Is the _parent always a table alias?
+      const taProjected = projected.filter(p => p._parent === tableAlias);
+      if (taProjected.length)
+        projected = taProjected;
+    }
+
+    // Of the possible entries, choose the first one
+    projected = projected[0];
+
+    // If there are multiple projections, check if the annotation target is
+    // projected as well, otherwise, simply take the first one.
+    return projected._projections.find(proj => proj === target) ||
+      projected._projections[0] || null;
+  }
+}
+
+/**
+ * @param {XSN.Expression} expr
+ * @returns {boolean}
+ */
+function isAnnoPathAbsolute( expr ) {
+  return expr.path[0]?._navigation?.kind === '$self' || expr.scope === 'param';
+}
+
+/**
+ * Returns true if the given artifact is a root artifact in terms of annotation paths.
+ * E.g. an element is never a root, but an entity is, as it can be referred to as `$self`,
+ * but also a param, as it can be referred to as `:P`.
+ *
+ * @param {XSN.Artifact} art
+ * @returns {boolean}
+ */
+function isAnnoRootArt( art ) {
+  return !art._parent || !art._main || art.kind === 'param';
+}
+
+/**
+ * Get the root artifact according to the rules of isAnnoRootArt(art).
+ *
+ * @param {XSN.Artifact} art
+ * @returns {XSN.Artifact}
+ */
+function annoRootArt( art ) {
+  while (art && !isAnnoRootArt( art ))
+    art = art._parent;
+  return art;
+}
+
+/**
+ * @param {XSN.Artifact} art
+ * @returns {boolean}
+ */
+function isReturnParam( art ) {
+  return art?.kind === 'param' && art.name.id === '';
+}
+
+/**
+ * Returns the target's parent which is expanded and the type from which the elements originate.
+ *
+ * @param {XSN.Artifact} target
+ * @returns {[XSN.Artifact, XSN.Artifact]}
+ */
+function getExpandRoot( target ) {
+  let viaExpand = target;
+  while (viaExpand.$inferred === 'expanded')
+    viaExpand = viaExpand._parent;
+  const viaExpandType = viaExpand
+    ? (viaExpand.type?._artifact || viaExpand.items?.type?._artifact)
+    : null;
+  const viaInclude = viaExpand?.$inferred === 'include' || false;
+  viaExpand = !viaInclude && viaExpandType ? viaExpand : false;
+  return [ viaExpand, viaExpandType ];
+}
+
+module.exports = {
+  xprRewriteFns,
+};