@sap/cds-compiler 6.6.0 → 6.7.1

package/lib/compiler/define.js

@@ -120,17 +120,13 @@
 
 'use strict';
 
-const {
-  forEachGeneric,
-  forEachInOrder,
-  forEachMember,
-} = require('../base/model');
-const { weakLocation } = require('../base/location');
+const { weakLocation, builtinLocation } = require('../base/location');
+
 const shuffleGen = require('../base/shuffle');
 const {
   dictAdd, dictAddArray, dictForEach, pushToDict,
 } = require('../base/dictionaries');
-const { kindProperties, dictKinds } = require('./base');
+const { kindProperties } = require('./base');
 const {
   setLink,
   initItemsLinks,
@@ -142,14 +138,14 @@ const {
   initBoundSelfParam,
   dependsOnSilent,
   pathName,
-  targetCantBeAspect,
+  forEachGeneric,
+  forEachInOrder,
 } = require('./utils');
 const { compareLayer } = require('./moduleLayers');
 const { initBuiltins } = require('./builtins');
 const { isInReservedNamespace } = require('../base/builtins');
 
 const $location = Symbol.for( 'cds.$location' );
-const $inferred = Symbol.for( 'cds.$inferred' );
 
 /**
  * Export function of this file.  Transform argument `sources` = dictionary of
@@ -178,10 +174,9 @@ function define( model ) {
     shuffleDict,
     shuffleArray,
     initMainArtifact,
-    initMembers,                // for finalize-parser-cdl.js
-    targetIsTargetAspect,
+    initArtifactParentLink,
     checkRedefinition,
-    initSelectItems,
+    createGapArtifact,
   } );
   return doDefine();
 
@@ -200,7 +195,6 @@ function define( model ) {
     }
     model.definitions = Object.create( null );
     setLink( model, '_entities', [] ); // for entities with includes
-    model.$entity = 0;
     model.$compositionTargets = Object.create( null );
     model.$collectedExtensions = Object.create( null );
 
@@ -404,7 +398,7 @@ function define( model ) {
     const absolute = ext.name && resolveUncheckedPath( ext.name, '_uncheckedExtension', ext );
     if (!absolute)                    // broken path
       return;
-    delete ext.name.path[0]._artifact; // might point to wrong JS object in phase 1
+    delete ext.name.path[0]._artifact; // might point to wrong JS object in phase 1 - TODO: still?
     ext.name.id = absolute; // definition might not be there yet, no _artifact link
     const location = { file: '' }; // stupid required location
     const late = model.$collectedExtensions[absolute] ||
@@ -529,12 +523,13 @@ function define( model ) {
       initArtifactParentLink( art, model.definitions );
     checkRedefinition( art );
     initDollarSelf( art );      // $self, TODO: also for 'namespace'?
-    initMembers( art );
     if (art.params)
       initDollarParameters( art ); // $parameters
+    initMembers( art );
+
     if (art.query) {
       initArtifactQuery( art );
-      restrictToSimpleProjection( art );
+      restrictToSimpleProjection( art ); // late syntax check, TODO: do in parsers
     }
   }
 
@@ -551,38 +546,23 @@ function define( model ) {
   }
 
   function initExtension( parent ) {
-    // TODO: re-think
-    forEachMember( parent, function initExtensionMember( sub, name, prop ) {
-      if (sub.kind !== 'extend' && sub.kind !== 'annotate')
-        return;                 // for defs inside, set somewhere else - TODO: rethink
-      if (prop === 'params' && name === '') // RETURNS
-        sub.name = { id: '', location: sub.location };
-      setLink( sub, '_block', parent._block );
-      initExprAnnoBlock( sub, parent._block );
-      setLink( sub, '_parent', parent );
-      setLink( sub, '_main', parent._main || parent );
-      initExtension( sub );
-    } );
-    if (parent.kind !== 'extend')
-      return;
-    // TODO: sub queries? expand/inline?
-    parent.columns?.forEach( c => setLink( c, '_block', parent._block ) );
-    if (parent.scale && !parent.precision) {
-      // TODO: where could we store the location of the name?
-      error( 'syntax-missing-type-property', [ parent.scale.location ],
-             { prop: 'scale', otherprop: 'precision' },
-             'Type extension with property $(PROP) must also have property $(OTHERPROP)' );
-      parent.scale = undefined; // no consequential error
-    }
+    initMembers( parent );
+    if (parent.columns)
+      initSelectItems( parent, parent.columns, parent, true );
+    // there are no sub queries in extensions yet
+    // Remark: sub queries not yet allowed in `extend … with columns`
   }
 
+  //-----------------------------------------------------------------------------
+
   /**
    * Make the `_parent` pointer of artifact `A.B.C` point to `A.B`.  If no `A.B`
    * exists in XSN.definitions, create an artifact with kind `namespace` (better
-   * would be `$gap`).  Add `A.B.C` to the `_subArtifacts` dictionary of `A.B`.
+   * would be `$gap`).  Add `A.B.C` to the `_subArtifacts` dictionary of `A.B`
+   * if `noSubArtifacts` is not truthy (not for gap artifacts).
    * Do recursively if necessary, `_parent` of `A.B` is `A` in this example.
    */
-  function initArtifactParentLink( art, definitions, path, pathIndex ) {
+  function initArtifactParentLink( art, definitions, path, pathIndex, noSubArtifacts ) {
     setLink( art, '_parent', null );
     const { id } = art.name;
     const dot = id.lastIndexOf( '.' );
@@ -592,7 +572,7 @@ function define( model ) {
     let parent = definitions[prefix];
     if (!parent) {
       path ??= art.name.path;
-      pathIndex ??= path?.length - 1;
+      pathIndex ??= path?.length - 1; // just used for location
       const pathItemOrName = (path && pathIndex) ? path[--pathIndex] : art.name;
       const location = weakLocation( pathItemOrName.location );
       parent = { kind: 'namespace', name: { id: prefix, location }, location };
@@ -600,6 +580,8 @@ function define( model ) {
       initArtifactParentLink( parent, definitions, path, pathIndex );
     }
     setLink( art, '_parent', parent );
+    if (noSubArtifacts)
+      return;
     if (!parent._subArtifacts)
       setLink( parent, '_subArtifacts', Object.create( null ) );
     if (art.$duplicates !== true) // no redef or "first def"
@@ -1059,29 +1041,31 @@ function define( model ) {
   /**
    * Set property `_parent` for all elements in `parent` to `parent` and do so
    * recursively for all sub elements.
-   *
-   * Param `initExtensions` is for parse.cdl - TODO delete
    */
   function initMembers( parent ) {
+    // TODO: combine with initMembers() - better structuring
     const block = parent._block;
-    let obj = initItemsLinks( parent, block );
     initExprAnnoBlock( parent, block );
-    if (obj.target && targetIsTargetAspect( obj )) {
+    const obj = initItemsLinks( parent, block );     // down many / array of
+
+    if (obj.scale && !obj.precision &&
+        (parent._main || parent).kind === 'extend') { // TODO v7: why just with extend?
+      // TODO: where could we store the location of the name?
+      error( 'syntax-missing-type-property', [ obj.scale.location ],
+             { prop: 'scale', otherprop: 'precision' },
+             'Type extension with property $(PROP) must also have property $(OTHERPROP)' );
+    }
+
+    if (obj.target?.elements) {
+      // in kick-start.js, we consider a target refererence to an aspect
       obj.targetAspect = obj.target;
       delete obj.target;
     }
-    const { targetAspect } = obj;
-    if (targetAspect) {
-      if (obj.foreignKeys) {
-        error( 'type-unexpected-foreign-keys', [ obj.foreignKeys[$location], parent ] );
-        delete obj.foreignKeys; // continuation semantics: not specified
-      }
-      if (obj.on && !obj.target) {
-        error( 'type-unexpected-on-condition', [ obj.on.location, parent ] );
-        delete obj.on;          // continuation semantics: not specified
-      }
-      if (targetAspect.elements) // eslint-disable-next-line no-multi-assign
-        parent = obj = initAnonymousAspect( parent, obj, targetAspect );
+    if (obj.targetAspect?.elements) {
+      initAnonymousAspect( parent, obj, obj.targetAspect );
+      forEachInOrder( obj.targetAspect, 'elements',
+                      (...args) => initArtifact( obj.targetAspect, ...args ) );
+      return;
     }
     forEachInOrder( obj, 'elements', (...args) => initArtifact( parent, ...args ) );
     forEachGeneric( obj, 'enum', (...args) => initArtifact( parent, ...args ) );
@@ -1107,7 +1091,7 @@ function define( model ) {
 
     targetAspect.kind = 'aspect';   // TODO: probably '$aspect' to detect
     setLink( targetAspect, '_block', parent._block );
-    initDollarSelf( targetAspect );
+    initDollarSelf( targetAspect ); // not with extend
     // allow ref of up_ in anonymous aspect inside entity
     // (TODO: complain if used and the managed composition is included into
     // another entity - might induce auto-redirection):
@@ -1131,9 +1115,8 @@ function define( model ) {
     return targetAspect;
   }
 
-  function initArtifact( parent, elem, name, prop ) {
-    if (!elem.kind)           // wrong CSN input
-      elem.kind = dictKinds[prop];
+  // TODO: combine with initMembers()
+  function initArtifact( parent, elem, name ) {
     if (!elem.name && !elem._outer) {
       const ref = elem.targetElement || elem.kind === 'element' && elem.value;
       if (ref && ref.path) {
@@ -1157,9 +1140,9 @@ function define( model ) {
 
     // for a correct home path, setMemberParent needed to be called
 
-    if (!elem.value || elem.kind !== 'element' ||
-        elem.$syntax === 'enum' && parent.kind === 'extend') // ambiguous in parse-cdl
-      return;
+    if (!elem.value || elem.kind !== 'element' || elem.$syntax === 'or-enum')
+      return;                            // not an element with value
+    // remark: $syntax: 'or-enum' is set in CDL+CSN parser for potential enums
     // -> it's a calculated element
     if (!elem.type && elem.value.type) {  // top-level CAST( expr AS type )
       if (!elem.target)
@@ -1180,25 +1163,24 @@ function define( model ) {
   }
 
   /**
-   * Return whether the `target` is actually a `targetAspect`
+   * Create "gap" artifact (kind: "namespace") for references which might turn out
+   * to refer to a compiler-generated texts or target entity later.
+   *
+   * A _parent link is set as usual, but the parent does not list the gap artifact
+   * in its _subArtifacts (to allow more precise and processing
+   * sequence-independent resolve errors).  When the gap artifact is replaced by
+   * the generated entity, it is added to the _subArtifacts of the parent.
    */
-  function targetIsTargetAspect( elem ) {
-    const { target } = elem;
-    if (target.elements)        // CSN parser ensures: has no targetAspect then
-      return true;
-
-    if (elem.targetAspect) {
-      // Ensure that a compiled CSN is parseable - not inside query, only on element
-      return false;
-    }
-    if (targetCantBeAspect( elem ) || options.parseCdl)
-      return false;
-    // Compare this check with check in acceptEntity() called by resolvePath()
-    // Remark:  do not check `on` and `foreignKeys` here, we want error for those, not the aspect
-    const name = resolveUncheckedPath( target, 'target', elem );
-    const aspect = name && model.definitions[name];
-    return (aspect?.kind === 'aspect' || aspect?.kind === 'type') && // type is sloppy
-      aspect.elements && !aspect.elements[$inferred];
+  function createGapArtifact( name, location = builtinLocation() ) {
+    // TODO: make it work without location (or value undefined/null)
+    const art = {
+      kind: 'namespace', name: { id: name, location }, location,
+    };
+    model.definitions[name] = art;
+    // set _parent link, but do not add in _subArtifacts
+    // (TODO: in the future, test better for "valid" completion, and add anyway.)
+    initArtifactParentLink( art, model.definitions, undefined, undefined, true );
+    return art;
   }
 }