@sap/cds-compiler 4.0.2 → 4.2.2

package/lib/model/csnRefs.js

@@ -49,14 +49,14 @@
 //    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
+// throw an exception (which might even be a plain TypeError), but it might
 // 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 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
+// delete `s` and then still expect inspectRef() to be able to resolve a
 // reference `['s', 'x']`.
 
 // There are currently 3 (SQL) backend issues for which we provide a workaround:
@@ -205,15 +205,14 @@ const artifactProperties = [ 'elements', 'columns', 'keys', 'mixin', 'enum',
 // - lexical: false | Function - determines where to look first for “lexical names”
 // - dynamic: String - describes the dynamic environment (if in query)
 // - assoc: String, with dynamic: 'global' - what to do with assoc steps
-//   * 'static': visit elements of anonymous aspect if not last ref item
 //   * 'target': always follow target, including last ref item
-//   * other (& not provided) = follow target if not last ref item
+//   * other (& not provided) = follow target (targetAspect if no target) if not last ref item
 const referenceSemantics = {
   $init: { $initOnly: true },
-  type: { lexical: false, dynamic: 'global', assoc: 'static' },
-  includes: { lexical: false, dynamic: 'global', assoc: 'static' }, // no elem ref anyway
-  target: { lexical: false, dynamic: 'global', assoc: 'static' },   // no elem ref anyway
-  targetAspect: { lexical: false, dynamic: 'global', assoc: 'static' },
+  type: { lexical: false, dynamic: 'global' },
+  includes: { lexical: false, dynamic: 'global' },
+  target: { lexical: false, dynamic: 'global' },
+  targetAspect: { lexical: false, dynamic: 'global' },
   from: { lexical: false, dynamic: 'global', assoc: 'target' },
   keys: { lexical: false, dynamic: 'target' },
   keys_origin: { lexical: false, dynamic: 'target' },
@@ -265,6 +264,9 @@ function csnRefs( csn, universalReady ) {
     queryOrMain,
     getColumn: elem => getCache( elem, '_column' ),
     getElement: col => getCache( col, '_element' ),
+    /** Returns the column's name; either explicit, implicit or internal one. */
+    getColumnName: col => getCache( col, '$as' ),
+    $getQueries: def => getCache( def, '$queries' ), // unstable API
     initDefinition,
     dropDefinitionCache,
     targetAspect,
@@ -314,7 +316,7 @@ function csnRefs( csn, universalReady ) {
       env = effectiveType( env.items );
     if (env.elements)           // shortcut
       return env;
-    const target = (staticAssoc ? targetAspect( env ) : env.target);
+    const target = (staticAssoc ? targetAspect( env ) : env.target || env.targetAspect);
     if (typeof target !== 'string')
       return target || env;
     const def = csn.definitions[target];
@@ -352,7 +354,7 @@ function csnRefs( csn, universalReady ) {
 
   function fromArtifactRef( ref ) {
     // do not cache while there is second param
-    const art = artifactFromRef( ref, true );
+    const art = artifactFromRef( ref );
     if (art)
       return art;
     throw new ModelError( `Unknown artifact reference: ${ typeof ref !== 'string' ? JSON.stringify(ref.ref) : ref }` );
@@ -363,7 +365,7 @@ function csnRefs( csn, universalReady ) {
     let art = csn.definitions[pathId( head )];
     initDefinition( art );
     for (const elem of tail) {
-      const env = navigationEnv( art, true );
+      const env = navigationEnv( art );
       art = env.elements[pathId( elem )];
     }
     return art;
@@ -758,7 +760,7 @@ function csnRefs( csn, universalReady ) {
       qcache.elements = elements;
       const { columns } = qcache._select;
       if (elements && columns)
-        columns.map( c => initColumnElement( c, qcache ) );
+        columns.map( (col, colIndex) => initColumnElement( col, colIndex, qcache ) );
       else if (columns && !elements)
         throw new ModelError( `Query elements not available: ${ Object.keys( (index ? qcache._select : main) ).join('+') }`);
     } );
@@ -784,16 +786,19 @@ function csnRefs( csn, universalReady ) {
       : { $aliases: Object.create(null), $next: pcache.$next };
   }
 
-  function initColumnElement( col, parentElementOrQueryCache ) {
+  function initColumnElement( col, colIndex, parentElementOrQueryCache ) {
     if (col === '*')
       return;
     if (col.inline) {
-      col.inline.map( c => initColumnElement( c, parentElementOrQueryCache ) );
+      col.inline.map( c => initColumnElement( c, null, parentElementOrQueryCache ) );
       return;
     }
     setCache( col, '_parent',   // not set for query (has property _select)
               !parentElementOrQueryCache._select && parentElementOrQueryCache );
-    const as = col.as || col.func || implicitAs( col.ref );
+    let as = columnAlias( col );
+    if (!as && colIndex !== null)
+      as = `$_column_${ colIndex + 1 }`;
+    setCache( col, '$as', as );
     let type = parentElementOrQueryCache;
     while (type.items)
       type = type.items;
@@ -801,7 +806,7 @@ function csnRefs( csn, universalReady ) {
     if (elem)                   // TODO to.sql: something is strange if this is not set
       setCache( elem, '_column', col );
     if (col.expand)
-      col.expand.map( c => initColumnElement( c, elem ) );
+      col.expand.map( c => initColumnElement( c, null, elem ) );
   }
 
   // property name convention in cache:
@@ -843,10 +848,11 @@ function csnRefs( csn, universalReady ) {
   }
 }
 
-// Return value of a query SELECT for the query node, or the main artifact,
-// i.e. a value with an `elements` property.
-// TODO: only used in forRelationalDB - move somewhere else
 /**
+ * Return value of a query SELECT for the query node, or the main artifact,
+ * i.e. a value with an `elements` property.
+ * TODO: only used in forRelationalDB - move somewhere else
+ *
  * @param {object} query node (object with SET or SELECT property)
  * @param {object} main definition
  */
@@ -1122,6 +1128,17 @@ function isSelectQuery( query ) {
   return true;
 }
 
+/**
+ * Alias is either explicit or implicit from reference or function without arguments.
+ * If the column is an expression without explicit alias, `false` is returned.
+ * Use csnRefs.getColumnName() instead.
+ *
+ * @returns {string|false}
+ */
+function columnAlias( col ) {
+  return col.as || (!col.args && col.func) || (col.ref && implicitAs( col.ref ));
+}
+
 module.exports = {
   csnRefs,
   traverseQuery,
@@ -1129,4 +1146,5 @@ module.exports = {
   implicitAs,
   analyseCsnPath,
   pathId,
+  columnAlias,
 };

package/lib/model/csnUtils.js

@@ -69,7 +69,8 @@ function getUtils( model, universalReady ) {
   };
 
   /**
-   * Compute and return $combined for the given query.
+   * Compute and return $combined sources for the given query,
+   * that is, a map of elements that combine e.g. UNION sources.
    *
    * @param {CSN.Query} query
    * @returns {object}
@@ -291,11 +292,8 @@ function getUtils( model, universalReady ) {
     if (!absoluteName.startsWith('@'))
       throw new CompilerAssertion(`Annotation name should start with "@": ${ absoluteName }`);
 
-    // Only overwrite if undefined or null
-    if (node[absoluteName] === undefined || node[absoluteName] === null) {
-      // Assemble the annotation
-      node[absoluteName] = theValue;
-    }
+    // Assemble the annotation
+    node[absoluteName] ??= theValue;
   }
 
   /**
@@ -332,12 +330,18 @@ function getUtils( model, universalReady ) {
    *   - Does _not_ return the underlying type definition!  It is an object with all relevant
    *     type properties collected while traversing the type chain!
    *
-   * @todo Rename to e.g. getFinalTypeInfo()
+   * @param {string|object} type
+   *     Type as string or type ref, i.e. `{ ref: [...] }`
+   *
+   * @param {(string)=>CSN.Artifact} getArtifactRef
+   *     Function used to get an artifact for a reference. Useful in case that the caller
+   *     has a custom cache or a CSN that is in in-between state.
+   *     TODO: Can we make getUtils() more modular, so that this argument is already
+   *           passed to it?
    *
-   * @param {string|object} type Type as string or type ref, i.e. `{ ref: [...] }`
    * @returns {object|null}
    */
-  function getFinalTypeInfo( type ) {
+  function getFinalTypeInfo( type, getArtifactRef = artifactRef ) {
     type = normalizeTypeRef(type);
     if (!type)
       return null;
@@ -362,7 +366,7 @@ function getUtils( model, universalReady ) {
     if (typeof type === 'string' && (isBuiltinType( type ) || type === special$self))
       return _cacheResolved({ type });
 
-    const typeRef = artifactRef(type); // throws if not found
+    const typeRef = getArtifactRef(type); // default artifactRef() throws if not found
     const isNonScalar = _cacheNonScalar({ ...typeRef, type });
     if (isNonScalar)
       return finalBaseTypeCache[resolvedKey];
@@ -380,7 +384,7 @@ function getUtils( model, universalReady ) {
     finalBaseTypeCache[resolvedKey] = true;
 
     // Continue the search
-    const finalBase = getFinalTypeInfo(type);
+    const finalBase = getFinalTypeInfo(type, getArtifactRef);
     if (!finalBase) // Reference has no proper type, e.g. due to `type of View:calculated`.
       return _cacheResolved(null);
 
@@ -515,8 +519,8 @@ function forEachDefinition( csn, callback, iterateOptions = {} ) {
  */
 function forEachMember( construct, callback, path = [], ignoreIgnore = true, iterateOptions = {},
                         constructCallback = (_construct, _prop, _path) => {} ) {
-  // Allow processing _ignored elements if requested
-  if (ignoreIgnore && construct._ignore)
+  // Allow processing $ignored elements if requested
+  if (ignoreIgnore && construct.$ignore)
     return;
 
   // `items` itself is a structure that can contain "elements", and more.
@@ -775,7 +779,7 @@ function getArtifactDatabaseNameOf( artifactName, sqlMapping, csn, sqlDialect =
  * @returns {string} The resulting name
  */
 function getResultingName( csn, namingMode, artifactName ) {
-  if (namingMode === 'plain' || artifactName.indexOf('.') === -1)
+  if (namingMode === 'plain' || !artifactName.includes('.'))
     return artifactName;
 
   const namespace = getNamespace(csn, artifactName);
@@ -964,7 +968,7 @@ function isPersistedOnDatabase( art ) {
  */
 function isPersistedAsView( artifact ) {
   return artifact && artifact.kind === 'entity' &&
-      !artifact._ignore &&
+      !artifact.$ignore &&
       !artifact.abstract &&
       ((artifact.query || artifact.projection) && !hasAnnotationValue(artifact, '@cds.persistence.table')) &&
       !hasAnnotationValue(artifact, '@cds.persistence.skip') &&
@@ -978,7 +982,7 @@ function isPersistedAsView( artifact ) {
  */
 function isPersistedAsTable( artifact ) {
   return artifact.kind === 'entity' &&
-      !artifact._ignore &&
+      !artifact.$ignore &&
       !artifact.abstract &&
       (!artifact.query && !artifact.projection || hasAnnotationValue(artifact, '@cds.persistence.table')) &&
       !hasAnnotationValue(artifact, '@cds.persistence.skip') &&
@@ -1077,6 +1081,9 @@ function getLastPartOfRef( ref ) {
  *
  * Overwrite existing ones only if 'overwrite' is true.
  *
+ * IMPORTANT: Consider using copyAnnotationsAndDoc() instead!
+ *            Don't forget about doc comments!
+ *
  * @param {object} fromNode
  * @param {object} toNode
  * @param {boolean} [overwrite]
@@ -1120,6 +1127,32 @@ function copyAnnotationsAndDoc( fromNode, toNode, overwrite = false ) {
   }
 }
 
+/**
+ * Same as `copyAnnotationsAndDoc()` but deletes the annotations on source
+ * side after copying them.  Useful when applying annotations from `cds.extensions`.
+ *
+ * Overwrite existing ones only if 'overwrite' is true.
+ *
+ * @param {object} sourceNode
+ * @param {object} targetNode
+ * @param {boolean} [overwrite]
+ */
+function moveAnnotationsAndDoc( sourceNode, targetNode, overwrite = false ) {
+  // Ignore if no targetNode (in case of errors)
+  if (!targetNode)
+    return;
+
+  const annotations = Object.keys(sourceNode)
+    .filter(key => key.startsWith('@') || key === 'doc');
+
+  for (const anno of annotations) {
+    if (targetNode[anno] === undefined || overwrite) {
+      targetNode[anno] = sourceNode[anno];
+      delete sourceNode[anno];
+    }
+  }
+}
+
 /**
  * Applies annotations from `csn.extensions` to definitions and their elements.
  *
@@ -1147,7 +1180,7 @@ function applyAnnotationsFromExtensions( csn, config ) {
     if (name && filter(name)) {
       const def = csn.definitions[name];
       if (def) {
-        copyAnnotationsAndDoc(ext, def, config.override);
+        moveAnnotationsAndDoc(ext, def, config.override);
         applyAnnotationsToElements(ext, def);
       }
       else if (config.notFound) {
@@ -1169,7 +1202,7 @@ function applyAnnotationsFromExtensions( csn, config ) {
     forEach(ext.elements, (key, sourceElem) => {
       const targetElem = def.elements[key];
       if (targetElem) {
-        copyAnnotationsAndDoc(sourceElem, targetElem, config.override);
+        moveAnnotationsAndDoc(sourceElem, targetElem, config.override);
         applyAnnotationsToElements(sourceElem, targetElem);
       }
     });

package/lib/model/revealInternalProperties.js

@@ -17,7 +17,7 @@ const { CompilerAssertion } = require('../base/error');
 const $inferred = Symbol.for('cds.$inferred');
 const $location = Symbol.for('cds.$location');
 
-class NOT_A_DICTIONARY {}       // used for consol.log display
+class NOT_A_DICTIONARY {}       // used for console.log display
 
 function locationString( loc ) {
   if (Array.isArray(loc))
@@ -102,8 +102,10 @@ function revealInternalProperties( model, nameOrPath ) {
     _status: primOrString,       // is a string anyway
     $annotations: as => as.map( $annotation ),
     $messageFunctions: () => '‹some functions›',
+    $functions: () => '‹some functions›',
+    $builtins: nameOrPath === '++' ? builtinsDictionary : () => '‹reveal with -R ++›',
   };
-  uniqueId = 1;
+  uniqueId = -1;
   return revealXsnPath(nameOrPath, model);
 
   // Returns the desired artifact/dictionary in the XSN.
@@ -129,7 +131,7 @@ function revealInternalProperties( model, nameOrPath ) {
   //   `name.space/S/E/elements/a/kind/`
   //   `name.space/S/E/elements/a/type/scope/`
   function revealXsnPath( path, xsn ) {
-    if (!path || path === '+')
+    if (!path || path === '+' || path === '++')
       return reveal( xsn );
 
     path = path.split('/');
@@ -173,7 +175,9 @@ function revealInternalProperties( model, nameOrPath ) {
     if (!Array.isArray(deps))
       return primOrString( deps );
     return deps
-      .map( d => `${ d.location ? '' : '-' }${ artifactIdentifier( d.art ) }`);
+      .map( d => (d.location
+        ? `${ artifactIdentifier( d.art ) } @${ locationString( d.location ) }`
+        : artifactIdentifier( d.art )) );
   }
 
   function layerExtends( dict ) {
@@ -213,7 +217,13 @@ function revealInternalProperties( model, nameOrPath ) {
   }
 
   function artifactDictionary( node, parent ) {
-    if (!node || typeof node !== 'object' || !model.definitions || parent === model )
+    if (parent === model )
+      return dictionary( node );    // no dictionary or no definitions section
+    return builtinsDictionary( node );
+  }
+
+  function builtinsDictionary( node, parent ) {
+    if (!node || typeof node !== 'object' || !model.definitions )
       return dictionary( node );    // no dictionary or no definitions section
     const dict = Object.create( Object.getPrototypeOf(node)
       ? NOT_A_DICTIONARY.prototype
@@ -237,7 +247,8 @@ function revealInternalProperties( model, nameOrPath ) {
       ? NOT_A_DICTIONARY.prototype
       : Object.prototype );
     for (const prop of Object.getOwnPropertyNames( node )) { // also non-enumerable
-      r[prop] = reveal( node[prop], node, prop );
+      if (node !== model.definitions || nameOrPath === '++' || !node[prop].builtin)
+        r[prop] = reveal( node[prop], node, prop );
     }
     if (node[$inferred] && !node['[$inferred]'])
       r['[$inferred]'] = node[$inferred];
@@ -275,8 +286,8 @@ function revealInternalProperties( model, nameOrPath ) {
 
     const r = Object.create( Object.getPrototypeOf( node ) );
     // property to recognize === objects
-    if (node.kind && node.__unique_id__ == null)
-      Object.defineProperty( node, '__unique_id__', { value: ++uniqueId } );
+    if (node.kind && node.__unique_id__ == null && node.$effectiveSeqNo == null && !node.builtin)
+      Object.defineProperty( node, '__unique_id__', { value: uniqueId-- } );
 
     for (const prop of Object.getOwnPropertyNames( node )) { // also non-enumerable
       const func = transformers[prop] ||
@@ -287,8 +298,8 @@ function revealInternalProperties( model, nameOrPath ) {
   }
 
   function targetAspect( node, parent ) {
-    if (node.elements && uniqueId && node.__unique_id__ == null)
-      Object.defineProperty( node, '__unique_id__', { value: ++uniqueId } );
+    if (node.elements && node.__unique_id__ == null && node.$effectiveSeqNo == null)
+      Object.defineProperty( node, '__unique_id__', { value: uniqueId-- } );
     return reveal( node, parent );
   }
 
@@ -305,19 +316,16 @@ function array( node, fn ) {
 }
 
 function artifactIdentifier( node, parent ) {
+  if (!node)
+    return `${ node }`;
   if (Array.isArray(node))
     return node.map( a => artifactIdentifier( a, node ) );
-  if (uniqueId && node.__unique_id__ == null)
-    Object.defineProperty( node, '__unique_id__', { value: ++uniqueId } );
-  let outer = uniqueId ? `##${ node.__unique_id__ }` : '';
-  if (node._outer) {
-    // eslint-disable-next-line no-nested-ternary
-    outer = (node._outer.items === node) ? `/items${ outer }`
-      // eslint-disable-next-line no-nested-ternary
-      : (node._outer.returns === node) ? `/returns${ outer }` // TODO returns now normal
-      // eslint-disable-next-line no-nested-ternary
-        : (node._outer.targetAspect === node) ? `/target${ outer }`
-          : `/returns/items${ outer }`;
+  if (uniqueId && node.__unique_id__ == null && node.$effectiveSeqNo == null && !node.builtin)
+    Object.defineProperty( node, '__unique_id__', { value: uniqueId-- } );
+  const outerNum = node.$effectiveSeqNo || node.__unique_id__;
+  let outer = outerNum != null ? `##${ outerNum }` : '';
+  if (node._outer) {            // anon aspect in targetAspect | items
+    outer = (node._outer.targetAspect === node) ? `/target${ outer }` : `/items${ outer }`;
     node = node._outer;
   }
   if (node === parent)
@@ -328,7 +336,7 @@ function artifactIdentifier( node, parent ) {
     return '$magicVariables';
   if (!node.name) {
     try {
-      return `${ locationString( node.location ) || '' }##${ node.__unique_id__ }`;
+      return `${ locationString( node.location ) || '' }##${ outerNum }`;
       // return JSON.stringify(node);
     }
     catch (e) {