@sap/cds-compiler 2.10.4 → 2.12.0

package/lib/model/csnRefs.js

@@ -4,6 +4,8 @@
 // a reference is context-dependent, especially if queries are involved.  This
 // module provides the corresponding resolve/inspect functions.
 //
+// This module should work with both client-style CSN and Universal CSN.
+//
 // See below for preconditions / things to consider – the functions in this
 // module do not issue user-friendly messages for invalid references in a CSN,
 // such messages are (hopefully) issued by the compile() function.
@@ -41,18 +43,18 @@
 //
 // 1. a well-formed CSN with valid references;
 // 2. a compiled model, i.e. a CSN with all inferred information provided by
-//    the compile() function, including the (non-)enumerable `elements`
-//    property of sub `SELECT`s in a FROM;
+//    the compile() function for the CSN flavors `client` or `universal`
+//    (including the (non-)enumerable `elements` property in `client` CSN);
 // 3. no (relevant) CSN changes between the calls of the same instance of
 //    inspectRef() - to enable caching.
 //
 // If any of these conditions are not given, our functions usually simply
 // throws an exception (which might even be a plain TypeError), but it might
-// also jsut return any value.  CSN processors can provide user-friendly error
+// also just return any value.  CSN processors can provide user-friendly error
 // messages by calling the Core Compiler in case of exceptions.  For details,
 // see internalDoc/CoreCompiler.md#use-of-the-core-compiler-for-csn-processors.
 
-// During a transformation, care must be taked to adhere to these conditions.
+// During a transformation, care must be taken to adhere to these conditions.
 // E.g. a structure flattening function cannot create an element `s_x` and
 // delete `s` and then still expects inspectRef() to be able to resolve a
 // reference `['s', 'x']`.
@@ -93,7 +95,7 @@
 //
 // The names in further path items are searched in the “navigation” environment
 // of the path so far - it does not need to depend on the reference context (as
-// we do not check the validility here):
+// we do not check the validity here):
 //
 // 1. We search in the elements of the target entity for associations and
 //    compositions, and in the elements of the current object otherwise.
@@ -157,6 +159,24 @@
 //   hierarchy, query number, table aliases and links from a column to its
 //   respective inferred element.
 
+// Properties in cache:
+//
+// - _effectiveType on def/member/items: cached result of effectiveType()
+// - _origin on def/member/items: the "prototype"
+// - $origin on def/member/items: whether implicit _origin refs have been set for direct members
+// - _parent: not yet used (for debugging)
+//
+// - _env on non-string path item: environment provided by the ref so far,
+//    next path item is element in it
+// - _ref on non-string `type` or `from` ref, or on alias: the referred def/elem
+//
+// - $queries on def: array of all queries of an entity
+// - $queryNumber: the index position +1 of a query inside the $queries array
+// - $aliases on query: dictionary of alias names to cache with _ref/_select and elements
+// - _select: value of the `SELECT` property of a query (or value of `projection`)
+// - elements: the elements of the query (original CSN elements from query or main)
+// - _element on query column: the corresponding element
+
 'use strict';
 
 const BUILTIN_TYPE = {};
@@ -178,12 +198,13 @@ const referenceSemantics = {
   targetAspect: { lexical: false, dynamic: 'global' },
   from: { lexical: false, dynamic: 'global' },
   keys: { lexical: false, dynamic: 'target' },
+  keys_origin: { lexical: false, dynamic: 'target' },
   excluding: { lexical: false, dynamic: 'source' },
   expand: { lexical: justDollar, dynamic: 'expand' },   // ...using baseEnv
   inline: { lexical: justDollar, dynamic: 'inline' },   // ...using baseEnv
   ref_where: { lexical: justDollar , dynamic: 'ref-target'}, // ...using baseEnv
   on: { lexical: justDollar, dynamic: 'query' }, // assoc defs, redirected to
-  // there are also 'join_on' and 'mixin_on' with default semantics
+  // there are also 'on_join' and 'on_mixin' with default semantics
   orderBy: { lexical: query => query, dynamic: 'query' },
   orderBy_set: { lexical: query => query.$next, dynamic: 'query' }, // to outer SELECT (from UNION)
   // default: { lexical: query => query, dynamic: 'source' }
@@ -225,17 +246,19 @@ function csnRefs( csn ) {
     const cachedType = getCache( art, '_effectiveType' );
     if (cachedType !== undefined)
       return cachedType;
-    else if (!art.type && !art.$origin ||
-             art.elements || art.target || art.targetAspect || art.enum)
-      return setCache( art, '_effectiveType', art );
 
     const chain = [];
-    while (getCache( art, '_effectiveType' ) === undefined && (art.type || art.$origin) &&
+    let origin;
+    while (getCache( art, '_effectiveType' ) === undefined &&
+           (origin = cached( art, '_origin', getOriginRaw )) &&
            !art.elements && !art.target && !art.targetAspect && !art.enum && !art.items) {
       chain.push( art );
       setCache( art, '_effectiveType', 0 ); // initial setting in case of cycles
-      art = (art.$origin) ? getOrigin( art ) : artifactRef( art.type, BUILTIN_TYPE );
+      art = origin;
     }
+    if (!chain.length)
+      return setCache( art, '_effectiveType', art );
+
     if (getCache( art, '_effectiveType' ) === 0)
       throw new Error( 'Circular type reference');
     const type = getCache( art, '_effectiveType' ) || art;
@@ -247,14 +270,18 @@ function csnRefs( csn ) {
    * @param {CSN.Artifact} art
    */
   function navigationEnv( art ) {
-    let type = effectiveType( art );
+    let env = effectiveType( art );
+    getOrigin( env );          // also set implicit origins
     // here, we do not care whether it is semantically ok to navigate into sub
     // elements of array items (that is the task of the core compiler /
     // semantic check)
-    while (type.items)
-      type = effectiveType( type.items );
-    // cannot navigate along targetAspect!
-    return (type.target) ? csn.definitions[type.target] : type;
+    while (env.items)
+      env = effectiveType( env.items );
+    if (!env.target)
+      return env;
+    const target = csn.definitions[env.target];
+    getOrigin( target );
+    return target;
   }
 
   /**
@@ -279,38 +306,129 @@ function csnRefs( csn ) {
   function artifactPathRef( ref ) {
     const [ head, ...tail ] = ref.ref;
     let art = csn.definitions[pathId( head )];
-    for (const elem of tail)
-      art = navigationEnv( art ).elements[pathId( elem )];
+    for (const elem of tail) {
+      const env = navigationEnv( art );
+      art = env.elements[pathId( elem )];
+    }
     return art;
   }
 
-  function getOrigin( def ) {
-    const art = cached( def, '_origin', originPathRef );
-    if (art)
-      return art;
-    throw new Error( 'Undefined origin reference' );
+  // Return target when resolving references in 'keys'
+  function assocTarget( art, refCtx ) {
+    // Call contexts:
+    // 1. normal definition of association with explicit foreign keys
+    // 2. auto-redirected association with renaming of foreign keys
+    //    (currently: `keys` always available on inherited associations)
+    // 3. user-induced redirection (in 'cast') with explicit foreign keys
+    // 4. original provided association def inside $origin with explicit foreign keys
+    //    (outside $origin like 2)
+    const targetName = refCtx !== 'keys_origin' && art.target
+                    || art.$origin && art.$origin.target
+                    || art.cast.target;
+    const target = csn.definitions[targetName];
+    getOrigin( target );        // induce implicit $origin on target
+    return target;
   }
 
-  function originPathRef( def ) {
-    const [ head, ...tail ] = def.$origin;
-    let art = csn.definitions[head];
-    for (const elem of tail)
-      art = originNavigation( art, elem );
-    return art;
+  function getOrigin( art ) {
+    const origin = cached( art, '_origin', getOriginRaw );
+    if (origin && origin !== BUILTIN_TYPE)
+      cached( art, '$origin', _a => setImplicitOrigin( art, origin ) );
+    return origin;
+  }
+
+  function getOriginRaw( art ) {
+    if (art.type)               // TODO: make robust against "linked" = only direct
+      return artifactRef( art.type, BUILTIN_TYPE );
+    if (!art.$origin)           // implicit $origin should have been set
+      return null;
+    // art.$origin must not be a string here - shortened refs should already
+    // have been used to set the _origin cache
+    // If $origin object, return $origin of that:
+    if (!Array.isArray( art.$origin )) // anonymous prototype in $origin
+      return cached( art.$origin, '_origin', getOriginRaw );
+    const [ head, ...tail ] = art.$origin;
+    let origin = csn.definitions[head];
+    // allow shorter $origin ref for actions/functions, just using a string:
+    let isAction = art.kind === 'action' || art.kind === 'function';
+    for (const elem of tail) {
+      origin = originNavigation( origin, elem, isAction );
+      isAction = false;
+    }
+    return origin;
   }
 
-  function originNavigation( art, elem ) {
+  function originNavigation( art, elem, isAction ) {
     if (typeof elem !== 'string') {
       if (elem.action)
-        return art.actions[elem.action]
+        return art.actions[elem.action];
       if (elem.param)
-        return (elem.param ? art.params[elem.param] : art.returns);
+        return art.params[elem.param];
+      if (elem.returns)
+        return art.returns;
     }
-    if (art.returns)
+    if (isAction)
+      return art.actions[elem];
+    // TODO: if we use effectiveType(), we might have more implicit prototypes
+    // we might then need a function like effectiveArtifact,
+    // which cares about actions/params
+    // let origin = cached( art, '_origin', getOriginRaw );
+    // while (art.items) {
+    //   cached( art, '$origin', _a => setImplicitOrigin( art, origin ) );
+    //   art = art.items;
+    //   origin = cached( art, '_origin', getOriginRaw );
+    // }
+    // if (origin)
+    //   cached( art, '$origin', _a => setImplicitOrigin( art, origin ) );
+    // console.log(art)
+    if (art.returns)            // for ["main", {action: "act"}, "elem"]
       art = art.returns;
-    while (art.items)
+    return (art.elements || art.enum || targetAspect( art ).elements)[elem];
+  }
+
+  function targetAspect( art ) {
+    const { $origin } = art;
+    return art.targetAspect ||
+      $origin && typeof $origin === 'object' && !Array.isArray( $origin ) && $origin.target ||
+      art.target;
+  }
+
+  // From the current CSN object, set implicit origin for the next navigation step
+  function setImplicitOrigin( art, origin ) {
+    setMembersImplicit( art.actions, origin.actions );
+    setMembersImplicit( art.params, origin.params );
+    if (art.returns) {
+      art = art.returns;
+      if (art.type || typeof art.$origin === 'object') // null, […], {…}
+        return true;            // not implicit or shortened
+      origin = effectiveType( origin.returns );
+      setCache( art, '_origin', origin );
+      return true;
+    }
+    while (art.items) {
       art = art.items;
-    return (art.elements || art.enum || (art.targetAspect || art.target).elements)[elem];
+      if (art.type || typeof art.$origin === 'object') // null, […], {…}
+        return true;            // not implicit or shortened
+      origin = effectiveType( origin.items );
+      setCache( art, '_origin', origin );
+    }
+    setMembersImplicit( art.elements, origin.elements );
+    // The enum base type is _not_ where we find the origins of the enum symbols.
+    // A derived type of an enum type with individual annotations on a symbol
+    // has both 'type' and '$origin'.
+    if (!art.type || art.$origin)
+      setMembersImplicit( art.enum, origin.enum );
+    return true;
+  }
+
+  function setMembersImplicit( members, originMembers ) {
+    if (!members)
+      return;
+    for (const name in members) {
+      const elem = members[name];
+      if (!elem.type && typeof elem.$origin !== 'object') // undefined or string
+        setCache( elem, '_origin', originMembers[elem.$origin || name] || false );
+    }
   }
 
   /**
@@ -365,13 +483,16 @@ function csnRefs( csn ) {
 
     const head = pathId( path[0] );
     if (ref.param)
-      return resolvePath( path, main.params[head], 'param' );
+      return resolvePath( path, main.params[head], main, 'param' );
 
     const semantics = referenceSemantics[refCtx] || {};
     if (semantics.dynamic === 'global' || ref.global)
-      return resolvePath( path, csn.definitions[head], 'global', refCtx === 'from' );
+      return resolvePath( path, csn.definitions[head], null, 'global', refCtx === 'from' );
 
-    cached( main, '$queries', allQueries );
+    if (main) {
+      getOrigin( main );
+      cached( main, '$queries', allQueries );
+    }
     let qcache = query && cache.get( query.projection || query );
     // BACKEND ISSUE: you cannot call csnRefs(), inspect some refs, change the
     // CSN and again inspect some refs without calling csnRefs() before!
@@ -387,39 +508,38 @@ function csnRefs( csn ) {
       while (cache) {
         const alias = tryAlias && cache.$aliases[head];
         if (alias)
-          return resolvePath( path, alias._select || alias, 'alias', cache.$queryNumber );
+          return resolvePath( path, alias._select || alias._ref, null,
+                              'alias', cache.$queryNumber );
         const mixin = cache._select.mixin && cache._select.mixin[head];
         if (mixin && {}.hasOwnProperty.call( cache._select.mixin, head ))
-          return resolvePath( path, mixin, 'mixin', cache.$queryNumber );
+          return resolvePath( path, mixin, null, 'mixin', cache.$queryNumber );
         cache = cache.$next;
       }
       if (head.charAt(0) === '$') {
         if (head !== '$self' && head !== '$projection')
           return { scope: '$magic' };
         const self = qcache && qcache.$queryNumber > 1 ? qcache._select : main;
-        return resolvePath( path, self, '$self' );
+        return resolvePath( path, self, null, '$self' );
       }
     }
     // now the dynamic environment: ------------------------------------------
     if (semantics.dynamic === 'target') { // ref in keys
-      // not selecting the corresponding element for a select column works,
-      // because explicit keys can only be provided with explicit redirection
-      // target
-      const target = csn.definitions[parent.target || parent.cast.target];
-      return resolvePath( path, target.elements[head], 'target' );
+      const target = assocTarget( parent, refCtx );
+      return resolvePath( path, target.elements[head], target, 'target' );
     }
     if (baseEnv)                // ref-target (filter condition), expand, inline
-      return resolvePath( path, baseEnv.elements[head], semantics.dynamic );
+      return resolvePath( path, baseEnv.elements[head], baseEnv, semantics.dynamic );
     if (!query)                 // outside queries - TODO: items?
-      return resolvePath( path, parent.elements[head], 'parent' );
+      return resolvePath( path, parent.elements[head], parent, 'parent' );
 
     if (semantics.dynamic === 'query')
       // TODO: for ON condition in expand, would need to use cached _element
-      return resolvePath( path, qcache.elements[head], 'query' );
+      return resolvePath( path, qcache.elements[head], null, 'query' );
     for (const name in qcache.$aliases) {
-      const found = qcache.$aliases[name].elements[head];
+      const alias = qcache.$aliases[name];
+      const found = alias.elements[head];
       if (found)
-        return resolvePath( path, found, 'source', name )
+        return resolvePath( path, found, alias._ref, 'source', name )
     }
     // console.log(query.SELECT,qcache,qcache.$next,main)
     throw new Error ( `Path item ${ 0 }=${ head } refers to nothing, refCtx: ${ refCtx }` );
@@ -429,8 +549,9 @@ function csnRefs( csn ) {
    * @param {CSN.Path} path
    * @param {CSN.Artifact} art
    * @param {string} [scope]
+   * @param [extraInfo]
    */
-  function resolvePath( path, art, scope, extraInfo ) {
+  function resolvePath( path, art, parent, scope, extraInfo ) {
     /** @type {{idx, art?, env?}[]} */
     const links = path.map( (_v, idx) => ({ idx }) );
     // TODO: backends should be changed to enable uncommenting:
@@ -438,11 +559,11 @@ function csnRefs( csn ) {
     //   throw new Error ( `Path item ${ 0 }=${ pathId( path[0] ) } refers to nothing, scope: ${ scope }`);
     links[0].art = art;
     for (let i = 1; i < links.length; ++i) { // yes, starting at 1, links[0] is set above
-      art = navigationEnv( art );
-      links[i - 1].env = art;
+      parent = navigationEnv( art );
+      links[i - 1].env = parent;
       if (typeof path[i - 1] !== 'string')
-        setCache( path[i - 1], '_env', art );
-      art = art.elements[pathId( path[i] )];
+        setCache( path[i - 1], '_env', parent );
+      art = parent.elements[pathId( path[i] )];
       if (!art) {
         const env = links[i - 1].env;
         const loc = env.name && env.name.$location || env.$location;
@@ -455,14 +576,16 @@ function csnRefs( csn ) {
     if (fromRef || typeof last !== 'string') {
       const env = navigationEnv( art );
       links[links.length - 1].env = env;
-      if (fromRef)
+      if (fromRef) {
         art = env;
+        parent = null;
+      }
       if (typeof last !== 'string')
         setCache( last, '_env', env )
     }
     return (extraInfo && !fromRef)
-      ? { links, art, scope, $env: extraInfo }
-      : { links, art, scope };
+      ? { links, art, parent, scope, $env: extraInfo }
+      : { links, art, parent, scope };
   }
 
   /**
@@ -481,7 +604,8 @@ function csnRefs( csn ) {
       if (query.ref) {          // ref in from
         // console.log('SQ:',query,cache.get(query))
         const as = query.as || implicitAs( query.ref );
-        getCache( fromSelect, '$aliases' )[as] = fromRef( query );
+        const _ref = fromRef( query );
+        getCache( fromSelect, '$aliases' )[as] = { _ref, elements: _ref.elements };
       }
       else {
         const qcache = getQueryCache( parentQuery );
@@ -517,7 +641,7 @@ function csnRefs( csn ) {
   function getQueryCache( parentQuery ) {
     if (!parentQuery)
       return { $aliases: Object.create(null) };
-    const pcache = cache.get( parentQuery );
+    const pcache = cache.get( parentQuery.projection || parentQuery );
     if (!parentQuery.SET)       // SELECT / projection: real sub query
       return { $aliases: Object.create(null), $next: pcache };
     // the parent query is a SET: that is not a sub query
@@ -583,8 +707,8 @@ function csnRefs( csn ) {
 // i.e. a value with an `elements` property.
 // TODO: only used in forHanaNew - move somewhere else
 /**
- * @param {CSN.Query} query node (object with SET or SELECT property)
- * @param {CSN.Definition} main
+ * @param {object} query node (object with SET or SELECT property)
+ * @param {object} main definition
  */
 function queryOrMain( query, main ) {
   while (query.SET)
@@ -607,8 +731,8 @@ function queryOrMain( query, main ) {
  *
  * @param {CSN.Query} query
  * @param {CSN.QuerySelect} fromSelect
- * @param {CSN.Query} parentQuery 
- * @param {(query: CSN.Query&CSN.QueryFrom, select: CSN.QuerySelectEnriched) => void} callback
+ * @param {CSN.Query} parentQuery
+ * @param {(query: CSN.Query&CSN.QueryFrom, select: CSN.QuerySelectEnriched, parentQuery: CSN.Query) => void} callback
  */
 function traverseQuery( query, fromSelect, parentQuery, callback ) {
   const select = query.SELECT || query.projection;
@@ -632,8 +756,9 @@ function traverseQuery( query, fromSelect, parentQuery, callback ) {
 
 /**
  * @param {CSN.QueryFrom} from
- * @param {CSN.QuerySelect} select
- * @param {(from: CSN.QueryFrom, select: CSN.QuerySelect) => void} callback
+ * @param {CSN.QuerySelect} fromSelect
+ * @param {CSN.Query} parentQuery
+ * @param {(from: CSN.QueryFrom, select: CSN.QuerySelect, parentQuery: CSN.Query) => void} callback
  */
 function traverseFrom( from, fromSelect, parentQuery, callback ) {
   if (from.ref) {
@@ -671,30 +796,42 @@ function implicitAs( ref ) {
   return id.substring( id.lastIndexOf('.') + 1 );
 }
 
+function startCsnPath( csnPath, csn ) {
+  const head = csnPath[0];
+  if (typeof head !== 'string') {
+    const { main, parent, art } = head;
+    return { index: 1, main, parent, art };
+  }
+  if (csnPath.length < 2 || csnPath[0] !== 'definitions')
+    throw new Error( 'References outside definitions not supported yet');
+  const art = csn.definitions[csnPath[1]];
+  return { index: 2, main: art, parent: null, art };
+}
+
 /**
  * @param {CSN.Path} csnPath
  * @param {CSN.Model} csn
  */
 function analyseCsnPath( csnPath, csn, resolve ) {
-  if (csnPath[0] !== 'definitions')
-    throw new Error( 'References outside definitions not supported yet');
-
   /** @type {object} */
-  let obj = csn;
-  let parent = null;
   let query = null;
   let refCtx = null;
-  let art = null;
   /** @type {boolean|string|number} */
   let isName = false;
   let baseRef = null;
   let baseEnv = null;
-  let main = csn.definitions[csnPath[1]];
+  let { index, main, parent, art } = startCsnPath( csnPath, csn );
+  let obj = art;
+
+  for (; index < csnPath.length; index++) {
+    if (!obj && !resolve)
+      // For the semantic location, use current object as best guess
+      break;
 
-  for (let index = 0; index < csnPath.length; index++) {
     const prop = csnPath[index];
     // array item, name/index of artifact/member, (named) argument
     if (isName || Array.isArray( obj )) {
+      // TODO: call some kind of resolve.setOrigin()
       if (typeof isName === 'string') {
         parent = art;
         art = obj[prop];
@@ -707,7 +844,8 @@ function analyseCsnPath( csnPath, csn, resolve ) {
         parent = null;
       }
       isName = prop;
-      refCtx = prop;
+      // if we want to allow auto-redirect of user-provided target with renamed keys:
+      refCtx = (refCtx === '$origin' && prop === 'keys') ? 'keys_origin' : prop;
     }
     else if (prop === 'items' || prop === 'returns') {
       art = obj[prop];
@@ -723,15 +861,13 @@ function analyseCsnPath( csnPath, csn, resolve ) {
     }
     else if (prop === 'where' && refCtx === 'ref') {
       if (resolve)
-        baseEnv = resolve.ref_where( obj, baseRef, refCtx, csn.definitions[csnPath[1]],
-                                    query, parent, baseEnv );
+        baseEnv = resolve.ref_where( obj, baseRef, refCtx, main, query, parent, baseEnv );
       refCtx = 'ref_where';
     }
     else if (prop === 'expand' || prop === 'inline') {
       if (obj.ref) {
         if (resolve)
-          baseEnv = resolve.expandInline( obj, refCtx, csn.definitions[csnPath[1]],
-                                          query, parent, baseEnv );
+          baseEnv = resolve.expandInline( obj, refCtx, main, query, parent, baseEnv );
         refCtx = prop;
       }
       if (prop === 'expand')
@@ -739,9 +875,9 @@ function analyseCsnPath( csnPath, csn, resolve ) {
     }
     else if (prop === 'on') {
       if (refCtx === 'from')
-        refCtx = 'join_on';
+        refCtx = 'on_join';
       else if (refCtx === 'mixin')
-        refCtx = 'mixin_on';
+        refCtx = 'on_mixin';
       else
         refCtx = 'on';          // will use query elements with REDIRECTED TO
     }
@@ -755,11 +891,7 @@ function analyseCsnPath( csnPath, csn, resolve ) {
     else if (prop !== 'xpr') {
       refCtx = prop;
     }
-
     obj = obj[prop];
-    if (!obj && !resolve)
-      // For the semantic location, use current object as best guess
-      break;
   }
   // console.log( 'CPATH:', csnPath, refCtx, obj, parent.$location );
   if (!resolve)