@sap/cds-compiler 5.9.4 → 6.0.12

package/lib/edm/edmPreprocessor.js

@@ -1,11 +1,12 @@
 'use strict';
 
 /* eslint max-statements-per-line:off */
-const { setProp, isDeprecatedEnabled, isBetaEnabled } = require('../base/model');
+const { setProp, isBetaEnabled } = require('../base/model');
 const {
   forEachDefinition, forEachGeneric, forEachMemberRecursively,
   isEdmPropertyRendered, getUtils,
-  applyTransformations, transformAnnotationExpression, findAnnotationExpression,
+  applyTransformations, applyTransformationsOnNonDictionary,
+  transformAnnotationExpression, findAnnotationExpression,
   cardinality2str,
 } = require('../model/csnUtils');
 const { isBuiltinType, isMagicVariable } = require('../base/builtins');
@@ -274,7 +275,10 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
         // if this definition has a root def and the root def is not the service/schema name
         // => service C { type D.E }, replace the prefix dots with underscores
         if (rootDef && defName !== rootDef && rootDef !== edmUtils.getSchemaPrefix(defName)) {
-          const newDefName = `${ rootDef }.${ defName.replace(`${ rootDef }.`, '').replace(/\./g, '_') }`;
+          const underscoredDefName = defName
+            .replace(`${ rootDef }.`, '')
+            .replace(/\./g, '_');
+          const newDefName = `${ rootDef }.${ underscoredDefName }`;
           // store renamed types in correlation maps for later renaming
           if (def.kind === 'entity')
             dotEntityNameMap[defName] = newDefName;
@@ -322,11 +326,32 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
         if (node.$path && dotEntityNameMap[node.$path[1]])
           node.$path[1] = dotEntityNameMap[node.$path[1]];
 
+        if (node.projection || node.query) {
+          applyTransformationsOnNonDictionary(node.projection || node.query, undefined, {
+            ref: (parent, prop, ref) => {
+              if (dotEntityNameMap[ref[0]])
+                parent.ref[0] = dotEntityNameMap[ref[0]];
+            },
+          }, { directDict: true });
+        }
+
         rewriteReferencesInActions(node);
       };
 
-      forEachMemberRecursively(def, applyOnNode);
+      const applyOnAnnoXprs = (node) => {
+        Object.keys(node).filter(pn => pn[0] === '@').forEach((anno) => {
+          transformAnnotationExpression(node, anno, {
+            ref: (elemRef, _prop, ref) => {
+              if (dotEntityNameMap[ref[0]] || dotTypeNameMap[ref[0]])
+                elemRef.ref[0] = dotEntityNameMap[ref[0]] || dotTypeNameMap[ref[0]];
+            },
+          });
+        });
+      };
+
+      forEachMemberRecursively(def, [ applyOnNode, applyOnAnnoXprs ]);
       applyOnNode(def);
+      applyOnAnnoXprs(def);
       // handle unbound action/function and params in views
       rewriteReferencesInActions(def);
     };
@@ -518,7 +543,7 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
     // create the Type Definition
     // modify the original parameter entity with backlink and new name
     if (csn.definitions[typeEntityName])
-      error('odata-definition-exists', [ 'definitions', entityName ], { '#': 'std', name: typeEntityName });
+      error('odata-duplicate-definition', [ 'definitions', entityName ], { '#': 'std', name: typeEntityName });
     else
       entityCsn.name = typeEntityName;
     setProp(entityCsn, '$entitySetName', typeEntitySetName);
@@ -649,7 +674,7 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
     // proxies are registered in model separately
     if (!isProxy) {
       if (csn.definitions[parameterCsn.name]) {
-        error('odata-definition-exists', [ 'definitions', entityName ], { '#': 'std', name: parameterCsn.name });
+        error('odata-duplicate-definition', [ 'definitions', entityName ], { '#': 'std', name: parameterCsn.name });
       }
       else {
         csn.definitions[parameterCsn.name] = parameterCsn;
@@ -694,7 +719,8 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
     if (!edmUtils.isStructuredArtifact(def))
       return;
 
-    let keys = Object.create(null);
+    const keys = Object.create(null);
+    // eslint-disable-next-line
     const validFrom = [];
     const validKey = [];
 
@@ -741,38 +767,11 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
       edmAnnoPreproc.applyAppSpecificLateCsnTransformationOnElement(options, element, def, error);
     }, [], true, { elementsOnly: true });
 
-    if (!isDeprecatedEnabled(options, '_v1KeysForTemporal')) {
-      // if artifact has a cds.valid.key mention it as @Core.AlternateKey
-      if (validKey.length) {
-        const altKeys = [ { Key: [] } ];
-        validKey.forEach(vk => altKeys[0].Key.push( { Name: vk.name, Alias: vk.name } ) );
-        edmUtils.assignAnnotation(def, '@Core.AlternateKeys', altKeys);
-      }
-    }
-    else if (validKey.length) {
-      // if artifact has a cds.valid.key make this the only primary key and
-      // add all @cds.valid.from + original primary keys as alternate keys
-      // @Core.AlternateKeys: [{ Key: [ { Name: 'slID', Alias: 'slID' }, { Name: 'validFrom', Alias: 'validFrom'} ] }]
+    // if artifact has a cds.valid.key mention it as @Core.AlternateKey
+    if (validKey.length) {
       const altKeys = [ { Key: [] } ];
-      Object.entries(([ kn, k ]) => {
-        altKeys[0].Key.push( { Name: kn, Alias: kn } );
-        delete k.key;
-      });
-      validFrom.forEach((e) => {
-        altKeys[0].Key.push( { Name: e.name, Alias: e.name } );
-      });
+      validKey.forEach(vk => altKeys[0].Key.push( { Name: vk.name, Alias: vk.name } ) );
       edmUtils.assignAnnotation(def, '@Core.AlternateKeys', altKeys);
-      keys = Object.create(null);
-      validKey.forEach((e) => {
-        e.key = true;
-        keys[e.name] = e;
-      });
-    }
-    else {
-      validFrom.forEach((e) => {
-        e.key = true;
-        keys[e.name] = e;
-      });
     }
 
     // prepare the structure itself
@@ -892,7 +891,7 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
             // eslint-disable-next-line eqeqeq
             const srcMult = (partnerCsn.cardinality.src == 1) ? '0..1' : '*';
             const newMult
-              = (element.cardinality?.min == 1 && element.cardinality?.max == 1) // eslint-disable-line eqeqeq
+              = (element.cardinality?.min == 1 && element.cardinality?.max == 1) // eslint-disable-line
                 ? 1
                 : (element.cardinality?.max === '*' || element.cardinality?.max > 1)
                   ? '*'
@@ -1040,7 +1039,7 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
             else if (!assocOK) {
               // if there is already a proxy (generated by a 'good' association)
               // and this association is not a good one, don't expose this association.
-              muteNavProp(element, 'oncond');
+              muteNavProp(element);
               return;
             }
             if (proxy) {
@@ -1060,7 +1059,7 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
               }
             }
             else {
-              muteNavProp(element, assocOK ? 'std' : 'oncond');
+              muteNavProp(element);
               return;
             }
           }
@@ -1072,12 +1071,10 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
       });
     }
 
-    function muteNavProp( elt, msg = 'std' ) {
+    function muteNavProp( elt ) {
       edmUtils.assignAnnotation(elt, '@odata.navigable', false);
-      if (elt._target['@cds.autoexpose'] !== false) {
-        warning('odata-navigation', elt.$path,
-                { target: elt._target.name, service: globalSchemaPrefix, '#': msg });
-      }
+      if (elt._target['@cds.autoexpose'] !== false)
+        info('odata-navigation', elt.$path, { target: elt._target.name, service: globalSchemaPrefix });
     }
 
     function createSchemaRefFor( targetSchemaName ) {
@@ -1100,8 +1097,9 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
 
       // 1) construct the proxy definition
       // proxyDefinitionName: strip the serviceName and replace '.' with '_'
-      const defName
-        = `${ assoc._target.name.replace(`${ proxySchemaName }.`, '').replace(/\./g, '_') }`;
+      const defName = assoc._target.name
+        .replace(`${ proxySchemaName }.`, '')
+        .replace(/\./g, '_');
 
       // fullName: Prepend serviceName and if in same service add '_proxy'
       const proxy = isParamProxy
@@ -1152,10 +1150,7 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
           if (!newElt) {
             if (csnUtils.isAssocOrComposition(e)) {
               if (!e.on && e.keys) {
-                if (options.odataNoTransitiveProxies)
-                  newElt = convertManagedAssocIntoStruct(e);
-                else
-                  newElt = createProxyOrSchemaRefForManagedAssoc(e);
+                newElt = createProxyOrSchemaRefForManagedAssoc(e);
               }
               else {
                 info(null, [ 'definitions', struct.name, 'elements', assoc.name ],
@@ -1306,7 +1301,7 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
                 });
               }
               else if (elem.keys && !elem.on) {
-              // a primary key can never be an unmanaged association
+                // a primary key can never be an unmanaged association
                 type.elements[elemName] = createProxyOrSchemaRefForManagedAssoc(elem);
               }
               if (forceToNotNull) {
@@ -1316,7 +1311,7 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
                     newElt.cardinality = {};
                   newElt.cardinality.min = 1;
                 }
-                // if odata-spec-violation-key-null is checking on min>1, this can be an else
+                // if odata-unexpected-nullable-key is checking on min>1, this can be an else
                 newElt.notNull = true;
               }
               setProp(type.elements[elemName], 'name', elem.name);
@@ -1326,35 +1321,6 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
         }
       }
 
-      // Convert a managed association into a structured type and
-      // eliminate nested foreign key associations
-      function convertManagedAssocIntoStruct( e ) {
-        const newElt = cloneCsnNonDict(e, options);
-        newElt.elements = Object.create(null);
-        // remove all unwanted garbage
-        delete newElt.keys;
-        delete newElt.target;
-        delete newElt.type;
-        // if this association has no keys or if it is a redirected parameterized entity,
-        // use the primary keys of the target
-        const keys = (!e._target.$isParamEntity && e.keys) ||
-          Object.keys(e._target.$keys).map(k => ({ ref: [ k ] }));
-        keys.forEach((k) => {
-          let art = e._target || csnUtils.getCsnDef(e.target);
-          for (const ps of k.ref)
-            art = art.elements[ps];
-
-          // art is in the target side, clone it and remove key property
-          const cloneArt = cloneCsnNonDict(art, options);
-          setProp(cloneArt, 'name', art.name);
-          if (e.key)
-            cloneArt.notNull = true;
-          delete cloneArt.key;
-          newElt.elements[art.name] = cloneArt;
-        });
-        return newElt;
-      }
-
       // create a new element and wire the proxy as new target.
       // Create a new proxy if:
       // 1) source and target schema names are different (otherwise)
@@ -1509,8 +1475,8 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
         }
         else if (alreadyRegistered && !alreadyRegistered.$proxy &&
           alreadyRegistered.kind !== 'entity') {
-          warning('odata-definition-exists', [ 'definitions', proxy.$origin._parent.name, 'elements', proxy.$origin.name ],
-                  { '#': 'proxy', name: fqProxyName, kind: alreadyRegistered.kind });
+          warning('odata-duplicate-proxy', [ 'definitions', proxy.$origin._parent.name, 'elements', proxy.$origin.name ],
+                  { name: fqProxyName, kind: alreadyRegistered.kind });
         }
       }
       else if (!schemas[fqSchemaName]) {
@@ -1639,7 +1605,7 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
       else if (eltCsn.target && !eltCsn.on) {
         // if this association has no keys or if it is a redirected parameterized entity,
         // use the primary keys of the target
-        const keys = (!eltCsn._target.$isParamEntity && eltCsn.keys) ||
+        const keys = (!eltCsn._target.$isParamEntity && !eltCsn.on && (eltCsn.keys ?? [])) ||
           Object.keys(eltCsn._target.$keys).map(k => ({ ref: [ k ] }));
         let pathSegment = prefix;
         keys.forEach((k) => {
@@ -1668,7 +1634,7 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
       const eltDef = elt.items || elt;
       if ((!elt.key && (eltDef.notNull === undefined || eltDef.notNull === false)) ||
            elt.key && (eltDef.notNull !== undefined && eltDef.notNull === false)) {
-        message('odata-spec-violation-key-null', location,
+        message('odata-unexpected-nullable-key', location,
                 { name: pathSegment || elt.name, '#': !pathSegment ? 'std' : 'scalar' });
       }
       // many is either directly on elements or on the type
@@ -1682,7 +1648,7 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
         (options.odataFormat !== 'flat' && !options.odataForeignKeys) &&
          elt.cardinality?.max && elt.cardinality.max !== 1) {
         // many primary key can be induced by a many parameter of a view
-        message('odata-spec-violation-key-array', location,
+        message('odata-unexpected-arrayed-key', location,
                 {
                   name: pathSegment || elt.name,
                   value: cardinality2str(elt),
@@ -1714,7 +1680,7 @@ function initializeModel( csn, _options, messageFunctions, requestedServiceNames
             'Edm.TimeOfDay': 1,
           };
           if (!(edmType in legalEdmTypes)) {
-            message('odata-spec-violation-key-type', location,
+            message('odata-invalid-key-type', location,
                     {
                       name: pathSegment, type: type.type, id: edmType, '#': pathSegment ? 'std' : 'scalar',
                     });

package/lib/edm/edmUtils.js

@@ -344,7 +344,7 @@ function finalizeReferentialConstraints( csn, assocCsn, options, info ) {
         const renderedKeys = Object.values(principalEntity.$keys).filter(isConstraintCandidate).map(v => v.name);
         if (options.isV2() && intersect(renderedKeys, remainingPrincipalRefs).length !== renderedKeys.length) {
           if (options.odataV2PartialConstr) {
-            info('odata-spec-violation-constraints',
+            info('odata-incomplete-constraints',
                  [ 'definitions', assocCsn._parent.name, 'elements', assocCsn.name ], { version: '2.0' });
           }
           else {
@@ -379,7 +379,7 @@ function finalizeReferentialConstraints( csn, assocCsn, options, info ) {
     const renderedKeys = Object.values(assocCsn._target.$keys).filter(isConstraintCandidate).map(v => v.name);
     if (options.isV2() && intersect(renderedKeys, remainingPrincipalRefs).length !== renderedKeys.length) {
       if (options.odataV2PartialConstr) {
-        info('odata-spec-violation-constraints',
+        info('odata-incomplete-constraints',
              [ 'definitions', assocCsn._parent.name, 'elements', assocCsn.name ], { version: '2.0' } );
       }
       else {
@@ -446,23 +446,20 @@ function determineMultiplicity( csn ) {
   if (!csn.cardinality)
     csn.cardinality = Object.create(null);
 
-  if (!csn.cardinality.src)
-    csn.cardinality.src = isAssoc ? '*' : '1';
-  if (!csn.cardinality.min)
-    csn.cardinality.min = 0;
-  if (!csn.cardinality.max)
-    csn.cardinality.max = 1;
+  csn.cardinality.src ??= isAssoc ? '*' : '1';
+  csn.cardinality.min ??= 0;
+  csn.cardinality.max ??= 1;
 
   const srcCardinality
-    = (csn.cardinality.src == 1) // eslint-disable-line eqeqeq
-      ? (!isAssoc || csn.cardinality.srcmin == 1) // eslint-disable-line eqeqeq
+    = (csn.cardinality.src == 1) // eslint-disable-line
+      ? (!isAssoc || csn.cardinality.srcmin == 1) // eslint-disable-line
         ? '1'
         : '0..1'
       : '*';
-  const tgtCardinality
+  const tgtCardinality // eslint-disable-next-line no-nested-ternary
     = (csn.cardinality.max > 1 || csn.cardinality.max === '*')
       ? '*'
-      : (csn.cardinality.min == 1) // eslint-disable-line eqeqeq
+      : (csn.cardinality.min == 1) // eslint-disable-line
         ? '1'
         : '0..1';