@sap/cds-compiler 5.5.2 → 5.6.0

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/package.json

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