@sap/cds-compiler 5.5.0 → 5.6.0

package/lib/parsers/CdlGrammar.g4

@@ -208,7 +208,7 @@ aspectDef[ art, outer ]
 @finally{ this.attachLocation( $art ); }
   :
     ( ASPECT
-    | <hide> ABSTRACT { this.warning( 'syntax-deprecated-abstract', this.lb().location ); }
+    | <hide> ABSTRACT { this.warning( 'syntax-deprecated-abstract', this.combineLocation( this.lb(), this.la() ) ); }
       ENTITY
     )
     name=namePath[ 'Type' ]     // TODO: Type?
@@ -418,7 +418,7 @@ elementDef[ outer, art = undefined ]
     ( KEY { $art.key = this.valueWithLocation( true ); } )?
     ( <hide> MASKED { $art.masked = this.valueWithLocation( true ); }
       { this.message( 'syntax-unsupported-masked', this.lb(), { keyword: 'masked' } ); } )?
-    ( ELEMENT { $art.$syntax = 'element'; } )?
+    ( <hide> ELEMENT { $art.$syntax = 'element'; } )?
     Id['Element'] <prepare=elementRestriction, arg=elem>
     { this.addDef( $art, $outer, 'elements', 'element', this.identAst() ); }
     { this.docComment( $art ); } annoAssignMid[ $art ]*
@@ -507,7 +507,8 @@ mixinElementDef[ outer ] locals[ art = new XsnArtifact() ]
     ( assoc=ASSOCIATION cardinality[ $art ]? TO
     | assoc=COMPOSITION cardinality[ $art ]? OF
     )
-    card=ONE/MANY? target=simplePath
+    ( <cond=noRepeatedCardinality> card=ONE/MANY )?
+    target=simplePath
     { this.setAssocAndComposition( $art, $assoc, $card, $target ); }
     ON expr=condition { $art.on = $expr; }
   ;
@@ -515,7 +516,7 @@ mixinElementDef[ outer ] locals[ art = new XsnArtifact() ]
 // Annotate and Extend: main definitions ----------------------------------------
 
 annotateArtifact[ art, outer ]
-@finally{ this.checkWith( $keyword ); this.attachLocation( $art ); }
+@finally{ this.attachLocation( $art ); }
   :
     name=namePath[ 'Ext' ]
     ( // direct element annotation:
@@ -538,10 +539,11 @@ annotateArtifact[ art, outer ]
         annotateActionsBlock[ $art ]?
       )
     )
+    { this.checkWith( $keyword ); }
   ;
 
 extendArtifact[ art, outer ]
-@finally{ this.checkWith( $keyword ); this.attachLocation( $art ); }
+@finally{ this.attachLocation( $art ); }
   :
     name=namePath[ 'Ext' ]
     ( // direct element annotation:
@@ -586,6 +588,7 @@ extendArtifact[ art, outer ]
         DEFINITIONS artifactsBlock[ $art, this.lb() ]
       )?
     )
+    { this.checkWith( $keyword ); }
   ;
 
 extendService[ art, outer ]
@@ -864,11 +867,13 @@ typeExpression[ art ]
     typeProperties[ $art ]?
   |
     assoc=ASSOCIATION <prepare=elementRestriction, arg=calc>
-    cardinality[ $art ]? TO card=ONE/MANY?
+    cardinality[ $art ]? TO
+    ( <cond=noRepeatedCardinality> card=ONE/MANY )?
     typeAssocProperties[ $art, $assoc, $card ]
   |
     assoc=COMPOSITION <prepare=elementRestriction, arg=calc>
-    cardinality[ $art ]? OF card=ONE/MANY?
+    cardinality[ $art ]? OF
+    ( <cond=noRepeatedCardinality> card=ONE/MANY )?
     ( typeAssocProperties[ $art, $assoc, $card ]
     | elementsBlock[ this.setAssocAndComposition( $art, $assoc, $card ) ]
       { $art.target.location = $art.target.elements[Symbol.for('cds.$location')]; }
@@ -987,6 +992,7 @@ typeNamedArgsList[ art ]
 
 typeNamedArg[ art ]
   :
+    // TODO: or keywords with guards for better code completion?
     name=Id['typeparamname']
     ':'
     ( Number
@@ -1053,12 +1059,11 @@ projectionSpec returns[ default query = {} ]
 @finally{ this.attachLocation($query); }
   :
     // TODO, currently just with simple ref
-    PROJECTION { $query = { op: this.valueWithLocation( 'SELECT' ) }; }
+    PROJECTION <prepare=afterBrace> // v6: remove <prepare>
+    { $query = { op: this.valueWithLocation( 'SELECT' ) }; }
     ON
-    tab=fromRefWithOptAlias
+    tab=fromRefWithOptAlias <prepare=afterBrace>
     // TODO: this <prepare=afterBrace> is extremely strange... v6 forbid.
-    // Deliberately set this via action (→ interpreter will not accept this)
-    { this.afterBrace(); }<always>
     { $query.from = tab; }
     selectItemsList[ $query ]?
     excludingClause[ $query ]?
@@ -1115,6 +1120,8 @@ selectQuery returns[ default query = {} ]
       excludingClause[ $query ]?
     |
       ( ALL/DISTINCT { $query.quantifier = this.valueWithLocation(); } )?
+      // TODO TOOL: move <prepare> to all branches if "simple", or with special <…,attach>
+      {;} <prepare=inSelectItem, arg=sqlStyle>
       ( '*' { $query.columns = [ this.valueWithLocation() ]; }
       | selectItemDef[ ($query.columns = []) ]
       )
@@ -1221,8 +1228,7 @@ fromRefWithOptAlias returns[ default expr = {} ]
     (
       AS Id['FromAlias'] { $expr.name = this.identAst(); }
     |
-      <cond=tableWithoutAs>
-      // TODO: probably not necessary, TOOL already uses `default: this.giR()`
+      // <cond=tableWithoutAs> not necessary, tool uses `default: this.giR()`
       Id_restricted['FromAlias']
       { $expr.name = this.fragileAlias(); }
     |
@@ -1237,6 +1243,7 @@ fromPath[ table, category ] locals[ pathItem ]
     Id[ $category ] { $table.path.push( $pathItem = this.identAst() ); }
     ( fromArgumentsAndFilter[ $pathItem ] { $pathItem = null; } )?
     (
+      <cond=notAfterEntityArgOrFilter> // TODO TOOL: allow <hide=method>
       '.' { if (!$pathItem && !$table.scope) {
         $table.scope = $table.path.length; $category = 'ref';
         this.warning( 'syntax-invalid-path-separator', this.lb(),
@@ -1352,24 +1359,24 @@ selectItemDef[ columns ] locals[ art = new XsnArtifact(), alias ]
     { $columns.push( $art ); }  // TODO: probably too early
     { this.docComment( $art ); } annoAssignCol[ $art ]*
     ( <cond=modifierRestriction> VIRTUAL
-      { $art.virtual = this.valueWithLocation( true ); } )?
+      { $art.virtual = this.valueWithLocation( true ); }
+    )?
+    {;} <prepare=columnExpr, arg=key>    // TOOL TODO: disappears without {;}
     ( <cond=modifierRestriction> KEY
-      { $art.key = this.valueWithLocation( true ); } )?
+      { $art.key = this.valueWithLocation( true ); }
+    )?
     (
       expr=expression { $art.value = $expr; }
       ( as=AS Id['ItemAlias'] { $art.name = this.identAst(); }
       | Id_restricted['ItemAlias'] { $art.name = this.fragileAlias( true ); }
       | { $alias = this.classifyImplicitName( 'ItemImplicit', $expr ); }
-      )
-      // TODO: <cond> instead `reportExpandInline` for "expand/inline only w/ ref"
-      (
-        { this.reportExpandInline( $art, false ); }
-        nestedSelectItemsList[ $art, 'expand' ]
-        excludingClause[ $art ]?
       |
+        // TODO: guard for ref-only expression can probably replace reportExpandInline
         '.'
         { this.reportUnexpectedSpace( this.lb(), this.la().location, true ); } // TODO: no ERR
         { this.reportExpandInline( $art, $as || true ); }
+        // no extra 'syntax-unexpected-alias' anymore,
+        // 'syntax-unexpected-anno' reported in define.js
         { if ($alias) $alias.token.parsedAs = $alias.parsedAs; }
         (
           nestedSelectItemsList[ $art, 'inline' ]
@@ -1377,13 +1384,21 @@ selectItemDef[ columns ] locals[ art = new XsnArtifact(), alias ]
         |
           '*' { $art.inline = [ this.valueWithLocation() ]; }
         )
+        <exitRule>
+      )
+      // TODO: <cond> instead `reportExpandInline` for "expand/inline only w/ ref"
+      (
+        // TODO: guard for ref-only expression can probably replace:
+        { this.reportExpandInline( $art, false ); }
+        nestedSelectItemsList[ $art, 'expand' ]
+        excludingClause[ $art ]?
       )?
     |
       nestedSelectItemsList[ $art, 'expand' ]
       excludingClause[ $art ]?
       AS Id['ItemAlias'] { $art.name = this.identAst(); }
     )
-    { this.docComment( $art ); } annoAssignMid[ $art ]*
+    { this.docComment( $art ); } <prepare=columnExpr> annoAssignMid[ $art ]*
     (
       ':'
       (
@@ -1392,18 +1407,21 @@ selectItemDef[ columns ] locals[ art = new XsnArtifact(), alias ]
           typeRefOptArgs[ $art ]
         )
       |
+        // TODO: guard for ref-only expression ?
         REDIRECTED TO target=simplePath { $art.target = $target; }
         ( ON cond=condition { $art.on = $cond; }
         | foreignKeysBlock[ $art ]
         )?
       |
-        // TODO: condition for this
-        ( assoc=ASSOCIATION { this.associationInSelectItem( $art ); }
+        ( <cond=columnExpr>     // arg=singleId
+          assoc=ASSOCIATION { this.associationInSelectItem( $art ); }
           cardinality[ $art ]? TO
-        | assoc=COMPOSITION { this.associationInSelectItem( $art ); }
+        | <cond=columnExpr>     // arg=singleId
+          assoc=COMPOSITION { this.associationInSelectItem( $art ); }
           cardinality[ $art ]? OF
         )
-        card=ONE/MANY? target=simplePath
+        ( <cond=noRepeatedCardinality> card=ONE/MANY )?
+        target=simplePath
         { this.setAssocAndComposition( $art, $assoc, $card, $target ); }
         ON expr=condition { $art.on = $expr; }
       )
@@ -1692,7 +1710,7 @@ options{ minTokensMatched = 1 }
           )*
         )
       )
-      ')'
+      ')' { this.finalizeDictOrArray( $pathStep.args ); }
     )?
      // TODO: not with function!
     cardinalityAndFilter[ ...$ ]?
@@ -1972,11 +1990,19 @@ annoValue returns[ default value = {} ]
       ( sub=annoValue { $value.val.push( $sub ) }
       |
         <cond=arrayAnno, arg=ellipsis> ellipsis='...'
-        ( UP TO upTo=annoValue | { $upTo = undefined; } )
-        { $value.val.push( { literal: 'token', val: '...', location: $ellipsis.location, upTo: $upTo } ); }
+        ( UP TO upTo=annoValue
+          { $value.val.push( { literal: 'token', val: '...', location: $ellipsis.location, upTo: $upTo } ); }
+        | { $value.val.push( { literal: 'token', val: '...', location: $ellipsis.location } ); }
+        )
+        // TODO TOOL: if at last good state the command is ['g'],resume after the
+        // gotos, do not execute its actions - ?
+        // ( UP TO upTo=annoValue | { $upTo = undefined; } )
+        // { $value.val.push( { literal: 'token', val: '...', location: $ellipsis.location, upTo: $upTo } ); }
       )
       ( ',' | <exitLoop> )
     )*
+    // TODO TOOL: allow ( <cond=arrayAnno, arg=bracket> ']' )
+    { this.ec( 'arrayAnno', 'bracket' ); }<always>
     ']'
   |
     '(' $value=condition ')' { $value.$tokenTexts = this.ruleTokensText(); }

package/lib/transform/db/expansion.js

@@ -652,6 +652,9 @@ function expandStructureReferences( csn, options, pathDelimiter, messageFunction
       if (typeof root.$env === 'string' && (isComplexOrNestedQuery || options.transformation !== 'odata' || root.$env === pathId(obj.ref[0])))
         obj.ref = [ root.$env, ...obj.ref ];
 
+      if (iterateOptions.keepKeysOrigin)
+        setProp(obj, '$originalKeyRef', { ref: root.ref, as: root.as });
+
       return obj;
     });
   }

package/lib/transform/forOdata.js

@@ -188,7 +188,7 @@ function transform4odataWithCsn(inputModel, options, messageFunctions) {
   if (!structuredOData) {
     expansion.expandStructureReferences(csn, options, '_',
       { error, info, throwWithAnyError }, csnUtils,
-      { skipArtifact: isExternalServiceMember });
+      { skipArtifact: isExternalServiceMember, keepKeysOrigin: true });
   }
 
   createForeignKeyElements(csn, options, messageFunctions, csnUtils, { skipArtifact: isExternalServiceMember });

package/lib/transform/odata/createForeignKeys.js

@@ -2,7 +2,7 @@
 
 const { isBuiltinType } = require('../../base/builtins');
 const { setProp } = require('../../base/model');
-const { applyTransformations, implicitAs, findAnnotationExpression, copyAnnotations, isDeepEqual } = require('../../model/csnUtils');
+const { transformAnnotationExpression, applyTransformations, implicitAs, findAnnotationExpression, copyAnnotations, isDeepEqual } = require('../../model/csnUtils');
 const { EdmTypeFacetNames } = require('../../edm/EdmPrimitiveTypeDefinitions');
 
 function createForeignKeyElements(csn, options, messageFunctions, csnUtils, iterateOptions = {}) {
@@ -60,6 +60,8 @@ function createForeignKeyElements(csn, options, messageFunctions, csnUtils, iter
           if (options.transformation === 'effective')
             delete element.default;
         }
+
+        adaptAnnotationsRefs(generatedForeignKeys, csnUtils);
         setProp(element, '$generatedForeignKeys', generatedForeignKeys.map(gfk => gfk[0]));
         orderedElements.push(...generatedForeignKeys);
       
@@ -69,9 +71,9 @@ function createForeignKeyElements(csn, options, messageFunctions, csnUtils, iter
       elementsAccumulator[name] = element;
       return elementsAccumulator;
     }, Object.create(null));
-}
+  }
 
-function createForeignKeysForElement(csnUtils, path, element, prefix, csn, options, pathDelimiter, lvl = 0 ) {
+function createForeignKeysForElement(csnUtils, path, element, prefix, csn, options, pathDelimiter, lvl = 0, originalkey = {} ) {
   const special$self = !csn?.definitions?.$self && '$self';
   const isInspectRefResult = !Array.isArray(path);
 
@@ -109,7 +111,16 @@ function createForeignKeysForElement(csnUtils, path, element, prefix, csn, optio
       const continuePath = getContinuePath([ 'keys', keyIndex ]);
       const alias = key.as || implicitAs(key.ref);
       const result = csnUtils.inspectRef(continuePath);
-      fks = fks.concat(createForeignKeysForElement(csnUtils, result, result.art, alias, csn, options, pathDelimiter, lvl + 1));
+      let gfks = createForeignKeysForElement(csnUtils, result, result.art, alias, csn, options, pathDelimiter, lvl + 1,
+        lvl === 0 ? { ref: key.ref, as: key.as, $path: key.$path, $originalKeyRef: key.$originalKeyRef } : originalkey);
+      if (lvl === 0) {
+        gfks.forEach(gfk => copyAnnotations(key, gfk[1]));
+        // once applied -> remove the annotations from the keys array, to keep the OData CSN size as small as possible
+        Object.keys(key).forEach( prop => {
+          if (prop[0] === '@') delete key[prop]
+        });
+      }
+      fks = fks.concat(gfks);
     });
   }
   // the element is a structure
@@ -118,7 +129,7 @@ function createForeignKeysForElement(csnUtils, path, element, prefix, csn, optio
       // Skip already produced foreign keys
       if (!elem['@odata.foreignKey4']) {
         const continuePath = getContinuePath([ 'elements', elemName ]);
-        fks = fks.concat(createForeignKeysForElement(csnUtils, continuePath, elem, elemName, csn, options, pathDelimiter, lvl + 1));
+        fks = fks.concat(createForeignKeysForElement(csnUtils, continuePath, elem, elemName, csn, options, pathDelimiter, lvl + 1, originalkey));
       }
     });
   }
@@ -130,7 +141,7 @@ function createForeignKeysForElement(csnUtils, path, element, prefix, csn, optio
       if (element[prop] !== undefined)
         newFk[prop] = element[prop];
     });
-    return [ [ prefix, newFk ] ];
+    return [ [ prefix, newFk, originalkey ] ];
   }
 
   fks.forEach((fk) => {
@@ -140,9 +151,13 @@ function createForeignKeysForElement(csnUtils, path, element, prefix, csn, optio
     if (lvl === 0) {
       if (options.transformation !== 'effective')
         fk[1]['@odata.foreignKey4'] = prefix;
-      
-      const validAnnoNames = Object.keys(element).filter(pn => pn[0] === '@' && !findAnnotationExpression(element, pn));
-      copyAnnotations(element, fk[1], true, {}, validAnnoNames);
+
+      const allowedOverwriteAnnotationNames = ['@odata.Type', ...EdmTypeFacetNames.map(f => `@odata.${f}`)];
+      const validAnnoNames = Object.keys(element).filter(pn => pn[0] === '@' && !allowedOverwriteAnnotationNames.includes(pn) && !findAnnotationExpression(element, pn));
+      copyAnnotations(element, fk[1], false, {}, validAnnoNames);
+      const overwriteAnnoNames = Object.keys(element).filter(pn => allowedOverwriteAnnotationNames.includes(pn) && !findAnnotationExpression(element, pn));
+      copyAnnotations(element, fk[1], true, {}, overwriteAnnoNames);
+
       // propagate not null to final foreign key
       for (const prop of [ 'notNull', 'key' ]) {
         if (element[prop] !== undefined)
@@ -175,6 +190,74 @@ function createForeignKeysForElement(csnUtils, path, element, prefix, csn, optio
     return [ ...path, ...additions ];
   }
 }
+
+  function adaptAnnotationsRefs(generatedForeignKeys, csnUtils) {
+    let reportedErrorsForAnnoPath = {};
+    generatedForeignKeys.forEach(gfk => {
+      Object.entries(gfk[1]).forEach(([key, value]) => {
+        if (key[0] !== '@') return;
+
+        transformAnnotationExpression(gfk[1], key, {
+          ref: (_parent, _prop, ref, path, _p, _ppn, ctx) => {
+            if (ref[0] !== '$self') {
+
+              const { art } = csnUtils.inspectRef(getOriginatingKeyPath(gfk, path));
+              if (csnUtils.isManagedAssociation(art)) {
+                if (!reportedErrorsForAnnoPath[path]) {
+                  error('odata-anno-xpr-ref', path, { elemref: { ref }, anno: key, '#': 'fk_substitution' });
+                  reportedErrorsForAnnoPath[path] = true;
+                }
+              } else {
+                const gfkForRef = findGeneratedForeignKeyForKeyRef(generatedForeignKeys, ref);
+                if (gfkForRef.length === 1) {
+                  ref[0] = gfkForRef[0][0];
+
+                  if (ctx?.annoExpr?.['=']) {
+                    ctx.annoExpr['='] = true;
+                  }
+                } else {
+                  // check if the annotation reference points to a structure that has been expanded,
+                  // if so -> report an error
+                  const foundInOriginalRef = findOriginalRef(generatedForeignKeys.filter(gfk => gfk[2].$originalKeyRef), ref);
+                  // references to expanded structures in flat mode will be found in the $originalKeyRef
+                  // and in strucred mode more than one match will be found in the generated foreign keys
+                  if ((foundInOriginalRef.length || gfkForRef.length > 1) && !reportedErrorsForAnnoPath[path]) {
+                    error('odata-anno-xpr-ref', path, { elemref: { ref }, anno: key, '#': 'fk_substitution' });
+                    reportedErrorsForAnnoPath[path] = true;
+                  }
+                }
+              }
+            }
+          }
+        }, value?.$path?.slice(0, value.$path.length - 1));
+      });
+    });
+
+    // During tuple expansion, the key ref object looses the $path, therefore
+    // it needs to be extracted from the anno path
+    function getOriginatingKeyPath(gfk, path) {
+      return gfk[2].$path || path.slice(0, path.findIndex(ps => ps[0] === '@'));
+    }
+
+    // Loops through the generated foreign keys for this entity
+    // and filters the ones, which were created for this specific
+    // key ref. In case there are more than one foreign keys found,
+    // that means the key ref points to a structured element/managed assoc
+    function findGeneratedForeignKeyForKeyRef(generatedForeignKeys, ref) {
+      return generatedForeignKeys.filter(gfk => {
+        return (ref.join() === (gfk[2].as || implicitAs(gfk[2].ref)));
+      });
+    }
+
+    // Tuple expansion is performed before the generation of the foreign keys and the original(unexpanded) key ref
+    // is stored in the property $originalKeyRef. Here we try to evaluate whether the reference in the annotation
+    // points to a structure that has been expanded.
+    function findOriginalRef(generatedForeignKeys, ref) {
+      return generatedForeignKeys.filter(gfk => {
+        return (ref.join() === (gfk[2].$originalKeyRef.as || implicitAs(gfk[2].$originalKeyRef.ref)));
+      });
+    }
+  }
 }
 
 module.exports = createForeignKeyElements;

package/lib/utils/objectUtils.js

@@ -83,6 +83,18 @@ function setHidden( obj, prop, val ) {
   } );
 }
 
+/**
+ * Check if the given object has the property as non-enumerable
+ *
+ * @param {Object} object
+ * @param {string} propertyName
+ * @returns {boolean}
+ */
+function hasNonEnumerable( object, propertyName ) {
+  return Object.prototype.hasOwnProperty.call( object, propertyName ) &&
+    !Object.prototype.propertyIsEnumerable.call( object, propertyName );
+}
+
 module.exports = {
   copyPropIfExist,
   createDict,
@@ -90,4 +102,5 @@ module.exports = {
   forEachValue,
   forEachKey,
   setHidden,
+  hasNonEnumerable,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/cds-compiler",
-  "version": "5.5.0",
+  "version": "5.6.0",
   "description": "CDS (Core Data Services) compiler and backends",
   "homepage": "https://cap.cloud.sap/",
   "author": "SAP SE (https://www.sap.com)",