@sap/cds-compiler 3.5.2 → 3.6.0

package/lib/edm/edmPreprocessor.js

@@ -33,7 +33,7 @@ const capabilities = Object.keys(require('../gen/Dictionary.json').
 function initializeModel(csn, _options, messageFunctions, requestedServiceNames=undefined)
 {
   const { info, warning, error, message } = messageFunctions;
-
+  const special$self = !csn?.definitions?.$self && '$self';
   const csnUtils = getUtils(csn);
 
   // proxies are merged into the final model after all proxy elements are collected
@@ -68,7 +68,7 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
 
   // Structural CSN inbound QA checks
   inboundQualificationChecks(csn, options, messageFunctions,
-    serviceRootNames, requestedServiceNames, isMyServiceRequested, whatsMyServiceRootName);
+    serviceRootNames, requestedServiceNames, isMyServiceRequested, whatsMyServiceRootName, csnUtils);
   // not needed at the moment
   // resolveForeignKeyRefs();
 
@@ -101,7 +101,7 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
   /*
     Enrich the CSN by de-anonymizing and exposing types that are required to make the service self contained.
     Type exposure will add additional schema contexts and group the exposed types in these contexts.
-    contexts either represent another service (if the type to be exposed resides in that
+    Contexts either represent another service (if the type to be exposed resides in that
     service), the namespace (including (sub-)contexts) or as last resort (if the type name
      has no prefix path) a 'root' namespace.
   */
@@ -430,7 +430,7 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
           [ 'definitions', containee.name ], true, { elementsOnly: true });
       }
       else if(elt.type && !elt.elements) {
-          // try to find elements to drill down further
+        // try to find elements to drill down further
         while(elt && !isBuiltinType(elt.type) && !elt.elements) {
           elt = csn.definitions[elt.type];
         }
@@ -599,7 +599,7 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
     });
     linkAssociationTarget(parameterCsn);
     initContainments(parameterCsn);
-      // add assoc to result set, FIXME: is the cardinality correct?
+    // add assoc to result set, FIXME: is the cardinality correct?
     if(!isProxy) {
       parameterCsn.elements[parameterToTypeAssocName] = {
         '@odata.contained': true,
@@ -654,7 +654,7 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
   // convert $path to path starting at main artifact
   function $path2path(p) {
     const path = [];
-    /** @type {object} */
+    /** @type {any} */
     let env = csn;
     for (let i = 0; p && env && i < p.length; i++) {
       const ps = p[i];
@@ -704,7 +704,7 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
           element[attrName] = attr;
         }
       }
-      // and eventually remove some afterwards:)
+      // and eventually remove some afterwards
       if(options.isV2())
         edmAnnoPreproc.setSAPSpecificV2AnnotationsToAssociation(element);
 
@@ -789,9 +789,9 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
     Do not render (ignore) elements as properties
     In V4:
     1) If this is a foreign key of an association to a container which *is* used
-       to establish the containment via composition and $self comparison, then
-       do not render this foreign key. The $self comparison can only be evaluated
-       after the ON conditions have been parsed in prepareConstraints().
+       to establish the containment via composition and $self comparison.
+       The $self comparison can only be evaluated after the ON conditions have been
+       parsed in prepareConstraints().
     2) For all other foreign keys let isEdmPropertyRendered() decide.
     3) If an element/association is annotated with @odata.containment.ignore and containment is
        active, assign @cds.api.ignore or @odata.navigable: false
@@ -817,8 +817,8 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
           if(assoc)
             isContainerAssoc = !!(assoc._isToContainer && assoc._selfReferences.length || assoc['@odata.contained']);
             /*
-            If this foreign key is NOT a container fk, let isEdmPropertyRendered() decide
-            Else, if fk is container fk, omit it if it wasn't requested in structured mode
+              If this foreign key is NOT a container fk, let isEdmPropertyRendered() decide
+              Else, if fk is container fk, omit it if it wasn't requested in structured mode
             */
           if((!isContainerAssoc && !isEdmPropertyRendered(element, options)) ||
                (isContainerAssoc && !options.renderForeignKeys))
@@ -829,7 +829,6 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
             delete struct.$keys[element.name];
           }
         }
-        // deprecated._unmanagedUpInComponent:
         // Only in containment:
         // Ignore this (foreign key) elment if renderForeignKeys is false
         if(options.odataContainment && element['@odata.containment.ignore']) {
@@ -842,8 +841,8 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
       }
         // it's an association
       else if(element['@odata.containment.ignore'] && options.odataContainment && !options.renderForeignKeys) {
-          // if this is an explicitly containment ignore tagged association,
-          // ignore it if option odataContainment is true and no foreign keys should be rendered
+        // if this is an explicitly containment ignore tagged association,
+        // ignore it if option odataContainment is true and no foreign keys should be rendered
         edmUtils.assignAnnotation(element, '@odata.navigable', false);
       }
     }, [], true, { elementsOnly: true });
@@ -865,20 +864,20 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
       edmUtils.finalizeReferentialConstraints(csn, element, options, info);
 
       if(element._constraints._partnerCsn && element.cardinality && element.cardinality.max) {
-          // if this is a partnership and this assoc has a set target cardinality, assign it as source cardinality to the partner
+        // if this is a partnership and this assoc has a set target cardinality, assign it as source cardinality to the partner
         if(element._constraints._partnerCsn.cardinality) {
-            // if the forward association has set a src cardinality and it deviates from the backlink target cardinality raise a warning
-            // in V2 only, in V4 the source cardinality is rendered implicitly at the Type property
+          // if the forward association has set a src cardinality and it deviates from the backlink target cardinality raise a warning
+          // in V2 only, in V4 the source cardinality is rendered implicitly at the Type property
           if(element._constraints._partnerCsn.cardinality.src) {
             let srcMult = (element._constraints._partnerCsn.cardinality.src == 1) ? '0..1' : '*';
             let newMult = (element.cardinality.max > 1) ? '*' : '0..1';
             if(options.isV2() && srcMult !== newMult) {
-                // Association 'E_toF': Multiplicity of Role='E' defined to '*', conflicting with target multiplicity '0..1' from
+              // Association 'E_toF': Multiplicity of Role='E' defined to '*', conflicting with target multiplicity '0..1' from
               warning(null, null, `Source cardinality "${element._constraints._partnerCsn.cardinality.src}" of "${element._constraints._partnerCsn._parent.name}/${element._constraints._partnerCsn.name}" conflicts with target cardinality "${element.cardinality.max}" of association "${element._parent.name}/${element.name}"`);
             }
           }
           else {
-              // .. but only if the original assoc hasn't set src yet
+            // .. but only if the original assoc hasn't set src yet
             element._constraints._partnerCsn.cardinality.src = element.cardinality.max;
           }
         }
@@ -900,7 +899,7 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
           if(fqSchemaName.startsWith(srn + '.')) {
             const targetSchemaName = fqSchemaName.replace(srn + '.', '');
             if(serviceRootNames.includes(targetSchemaName)) {
-            // remove all definitions starting with < fqSchemaName >. and add a schema reference
+              // remove all definitions starting with < fqSchemaName >. and add a schema reference
               Object.keys(csn.definitions).forEach(dn => {
                 if(dn.startsWith(fqSchemaName)) {
                   delete csn.definitions[dn];
@@ -1007,7 +1006,7 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
               // and this association is not a good one, don't expose this association.
               muteNavProp(element, 'oncond');
               return;
-            }            
+            }
             if(proxy) {
             // if a proxy was either already created or could be created and
             // if it's a 'real' proxy, link the _target to it and remove constraints
@@ -1170,45 +1169,45 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
 
         // Always expose types referred to by a proxy, never reuse an eventually existing type
         // as the nested elements must all be not nullable
-          // elements have precedence over type
+        // elements have precedence over type
         const typeDef = !node.elements && node.type ? csn.definitions[node.type] : node;
 
         if (typeDef) {
           let typeClone;
-            // the type clone must be produced for each service as this type may
-            // produce references and/or proxies into multiple services
-            // (but only once per service, therefore cache it).
+          // the type clone must be produced for each service as this type may
+          // produce references and/or proxies into multiple services
+          // (but only once per service, therefore cache it).
           if(typeDef.$proxyTypes && typeDef.$proxyTypes[globalSchemaPrefix]) {
               // if type has been exposed in a schema use this type
             typeClone = typeDef.$proxyTypes[globalSchemaPrefix];
           }
           else {
-                // Set the correct name
+              // Set the correct name
             let typeId = artificialName; // the artificialName has no namespace, it's the element
             if(node.type) {
-                // same as for proxies, use schema or namespace, 'root' is last resort
+              // same as for proxies, use schema or namespace, 'root' is last resort
               typeSchemaName = typeDef.$mySchemaName || edmUtils.getSchemaPrefix(node.type);
               typeId = node.type.replace(typeSchemaName + '.', '').replace(/\./g, '_');
-                // strip the service root of that type (if any)
+              // strip the service root of that type (if any)
               const myServiceRootName = whatsMyServiceRootName(typeSchemaName);
               if(myServiceRootName)
                 typeSchemaName = typeSchemaName.replace(myServiceRootName + '.', '');
             }
 
             if(edmUtils.isStructuredArtifact(typeDef)) {
-                // pull forceNotNull to false for named types and non-key nodes
-                // only toplevel nodes (elements) can be key
+              // pull forceNotNull to false for named types and non-key nodes
+              // only toplevel nodes (elements) can be key
               forceToNotNull = !!(forceToNotNull && isKey && node.elements && !node.type);
 
               typeClone = cloneStructTypeForProxy(typeSchemaName, `${typeSchemaName}.${typeId}`, typeDef);
               if(typeClone) {
-                  // Recurse into elements of 'type' (if any)
+                // Recurse into elements of 'type' (if any)
                 typeClone.elements && Object.entries(typeClone.elements).forEach(([elemName, elem]) => {
-                    // if this is a foreign key elment, we must check whether or not the association
-                    // has been exposed as proxy. If it has not been exposed, no further structured
-                    // types must be exposed as 'Proxy_' types.
+                  // if this is a foreign key elment, we must check whether or not the association
+                  // has been exposed as proxy. If it has not been exposed, no further structured
+                  // types must be exposed as 'Proxy_' types.
 
-                    // TODO: expose types of assoc.keys and don't rely on exposed foreign keys
+                  // TODO: expose types of assoc.keys and don't rely on exposed foreign keys
                   if(!elem['@odata.foreignKey4'] ||
                       (elem['@odata.foreignKey4'] && !typeClone.elements[elem['@odata.foreignKey4']].$exposed))
                     exposeStructTypeForProxyOf(proxy, elem, `${typeId}_${elemName}`,
@@ -1220,26 +1219,26 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
               }
             }
             else {
-                // FUTURE: expose scalar type definition as well
+              // FUTURE: expose scalar type definition as well
             }
           }
           if(typeClone) {
-              // register the type clone at the proxy
-              // Reminder: Each proxy receives a full set of type clones, even if the types are shared
-              // (no scattered type clone caching). registerProxy() checks if a clone needs to be added to
-              // csn.definitions.
+            // register the type clone at the proxy
+            // Reminder: Each proxy receives a full set of type clones, even if the types are shared
+            // (no scattered type clone caching). registerProxy() checks if a clone needs to be added to
+            // csn.definitions.
             proxy.$exposedTypes[typeClone.name] = typeClone;
 
-              // set the node's new type name
+            // set the node's new type name
             node.type = typeClone.name;
-              // the key path generator must use the type clone directly, because it can't resolve
-              // the type clone in the CSN (its name is the final name and not the definition name).
+            // the key path generator must use the type clone directly, because it can't resolve
+            // the type clone in the CSN (its name is the final name and not the definition name).
             setProp(node, '_type', typeClone);
-              // Hack alert:
-              // beta feature 'subElemRedirections' (now the default in v2) adds elements to the node by
-              // default, without we must do it to get the primary key tuple calculation correct.
-              // Remember: node.type is the service local type name (not prepended by the service name),
-              // so it can't be resolved in definitions later on
+            // Hack alert:
+            // beta feature 'subElemRedirections' (now the default in v2) adds elements to the node by
+            // default, without we must do it to get the primary key tuple calculation correct.
+            // Remember: node.type is the service local type name (not prepended by the service name),
+            // so it can't be resolved in definitions later on
             if(typeClone.elements)
               node.elements = typeClone.elements;
           }
@@ -1263,7 +1262,7 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
               Object.keys(elem).forEach(prop => type.elements[elemName][prop] = elem[prop])
             }
             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)
@@ -1436,7 +1435,6 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
             schemaNames.push(schemaName);
           }
         });
-        /** @type {object} */
         const alreadyRegistered = csn.definitions[fqProxyName];
         if(!alreadyRegistered) {
           csn.definitions[fqProxyName] = proxy;
@@ -1476,7 +1474,6 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
         // don't error on duplicate schemas, if it's already present then all is good....
       }
     });
-      // sort the global schemaNames array
     schemaNames.sort((a,b) => b.length-a.length);
 
     function finalizeProxyContainments(proxy) {
@@ -1526,12 +1523,12 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
             if(!options.renderForeignKeys || (options.renderForeignKeys && !k.target))
               def.$edmKeyPaths.push(...produceKeyRefPaths(k, kn, [ 'definitions', defName, 'elements', kn ]));
           }
-        // In v2/v4 flat, associations are never rendered
+          // In v2/v4 flat, associations are never rendered
           else if(!k.target) {
             def.$edmKeyPaths.push([kn]);
           }
           // check toplevel key for spec violations
-          checkKeySpecViolations(k, ['definitions', def.name, 'elements', k.name]);
+          checkKeySpecViolations(k, ['definitions', defName, 'elements', k.name]);
         }
       });
     }
@@ -1558,10 +1555,12 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
       }
       // OData requires all elements along the path to be nullable: false (that is either key or notNull)
 
-      const finalType = csnUtils.getFinalTypeDef(eltCsn.items?.type || eltCsn.type);
-      const elements = eltCsn.elements || eltCsn.items?.elements ||
-                     finalType?.elements || finalType?.items?.elements;
-      if(elements) {
+      let elements = eltCsn.elements || eltCsn.items?.elements;
+      if (!elements) {
+        const finalType = csnUtils.getFinalBaseTypeWithProps(eltCsn.items?.type || eltCsn.type);
+        elements = finalType?.elements || finalType?.items?.elements;
+      }
+      if (elements) {
         Object.entries(elements).forEach(([eltName, elt]) => {
           if(!elt.$visited) {
             setProp(elt, '$visited', true);
@@ -1616,9 +1615,15 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
         message('odata-spec-violation-key-null', location,
           {name: pathSegment, '#': pathSegment ? 'std' : 'scalar'});
       }
-      // many
-      let type = elt.items || elt.type && !isBuiltinType(elt.type) && csnUtils.getFinalTypeDef(elt.type).items;
+      // many is either directly on elements or on the type
+      // due to added proxy types it might be that the type can't be found in definitions
+      let type = elt.items ||
+        (elt.type &&
+        !isBuiltinType(elt.type) &&
+        csn.definitions[elt.type] &&
+        csnUtils.getFinalBaseTypeWithProps(elt.type).items);
       if(type) {
+        // many primary key can be induced by a many parameter of a view
         message('odata-spec-violation-key-array', location,
           {name: pathSegment, '#': pathSegment ? 'std' : 'scalar'});
       }
@@ -1904,13 +1909,13 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
     if(rootContainer.kind !== 'entity' || rootContainer.$proxy)
       return;
 
-    const isRecursiveContainment = 
-      !!(rootContainer.$containerNames && rootContainer.$containeeAssociations && 
+    const isRecursiveContainment =
+      !!(rootContainer.$containerNames && rootContainer.$containeeAssociations &&
       rootContainer.$containerNames.length === 1 &&
       rootContainer.$containeeAssociations.some(entry => rootContainer.$containerNames.includes(entry.assoc.target)));
 
     // Root nodes are not contained
-    const isRootNode = 
+    const isRootNode =
       !!(!rootContainer.$containerNames ||
           rootContainer.$containerNames && rootContainer.$containerNames.length === 0);
 
@@ -1921,7 +1926,7 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
     addContainmentAnnotationsRecursively([], rootContainer);
     if(rootRestrictions.length)
       rootContainer[NavResAnno] = rootRestrictions;
-    
+
     function addContainmentAnnotationsRecursively(prefix, container) {
       if(container.$containeeAssociations) {
         // copy or create container restrictions, don't modify original
@@ -1951,9 +1956,9 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
 
           if(isMyServiceRequested(containee.name) || containee.$proxy) {
             const localAssocPath = path.join('.');
-            let navPropEntry;
-            const hasEntry = !!(navPropEntry = localRestrictions.find(p =>
-                p.NavigationProperty && p.NavigationProperty['='] === prefix.concat(localAssocPath).join('.')));
+            let navPropEntry= localRestrictions.find(p =>
+                p.NavigationProperty && p.NavigationProperty['='] === prefix.concat(localAssocPath).join('.'));
+            const hasEntry = !!navPropEntry;
 
             if(!hasEntry) {
               navPropEntry =  { NavigationProperty: { '=': prefix.concat(localAssocPath).join('.') } };
@@ -2008,13 +2013,11 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
     }
 
     function iterateParams(def, loc) {
-      let lastOptPos = 0;
-      let i = 0;
-      for(const pn in def.params) {
-        const p = def.params[pn];
+      let optPns = [];
+      def.params && Object.values(def.params).forEach(p => {
         // user assigned annotation, don't touch it
         if(Object.keys(p).some(a => a.startsWith('@Core.OptionalParameter') && p[a] !== null)) {
-          lastOptPos = i;
+          optPns.push(p);
         }
         // default value automatically makes param optional
         else if(p.default) {
@@ -2022,19 +2025,24 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
             edmUtils.assignAnnotation(p, '@Core.OptionalParameter.DefaultValue', p.default.val);
           else
             edmUtils.assignAnnotation(p, '@Core.OptionalParameter.$Type', '');
-          lastOptPos = i;
+          optPns.push(p);
         }
         // if no default is available, nullable makes param optional
         else if(!p.notNull) {
           edmUtils.assignAnnotation(p, '@Core.OptionalParameter.$Type', '');
-          lastOptPos = i;
+          optPns.push(p);
+
         }
-        // check if mandatory param follows optional param
-        else if(lastOptPos < i) {
-          warning('odata-parameter-order', loc.concat(pn));
+        else {
+          // this is a mandatory parameter, warn about all previously collected optional parameters
+          optPns.forEach(p => {
+            const type = p.items?.type || p.type;
+            if(type !== special$self)
+              warning('odata-parameter-order', loc.concat(p.name));
+          });
+          optPns = [];
         }
-        i++;
-      }
+      });
     }
   }
 
@@ -2043,7 +2051,7 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
   // Helper section starts here
   //
 
-  
+
   function mapCdsToEdmProp(obj) {
     if (obj.type && isBuiltinType(obj.type) && !obj.target && !obj.targetAspect) {
       let edmType = edmUtils.mapCdsToEdmType(obj, messageFunctions, _options.odataVersion === 'v2', obj['@Core.MediaType']);

package/lib/edm/edmUtils.js

@@ -2,6 +2,7 @@
 const { setProp } = require('../base/model');
 const { isBuiltinType, isEdmPropertyRendered, applyTransformations, cloneAnnotationValue } = require('../model/csnUtils');
 const { escapeString, hasControlCharacters, hasUnpairedUnicodeSurrogate } = require('../render/utils/stringEscapes');
+const {CompilerAssertion} = require('../base/error');
 
 /* eslint max-statements-per-line:off */
 function validateOptions(_options)
@@ -24,9 +25,6 @@ function validateOptions(_options)
     options.isStructFormat = options.odataFormat && options.odataFormat === 'structured';
     options.isFlatFormat = !options.isStructFormat;
 
-    if(options.v.filter(v=>v).length !== 1)
-      throw Error(`Please debug me: EDM V2:${v2}, V4:${v4}`);
-
     options.isV2 = () => v2;
     options.isV4 = () => v4;
 
@@ -107,9 +105,6 @@ function isDerivedType(artifact) {
 }
 
 function resolveOnConditionAndPrepareConstraints(csn, assocCsn, messageFunctions) {
-  if(!assocCsn._constraints)
-    throw Error('Please debug me: need _constraints');
-
   const { info, warning } = messageFunctions;
 
   if(assocCsn.on)
@@ -170,7 +165,7 @@ function resolveOnConditionAndPrepareConstraints(csn, assocCsn, messageFunctions
               key id : Integer;
               toMe: association to E on toMe.id = $self; };
             */
-          throw Error('Backlink association element is not an association or composition: "' + originAssocCsn.name);
+          throw new CompilerAssertion('Backlink association element is not an association or composition: "' + originAssocCsn.name);
         }
       }
       else
@@ -255,11 +250,7 @@ function resolveOnConditionAndPrepareConstraints(csn, assocCsn, messageFunctions
 
 function finalizeReferentialConstraints(csn, assocCsn, options, info)
 {
-  if(!assocCsn._constraints)
-    throw Error('Please debug me: need _constraints');
-
-  if(assocCsn.on)
-  {
+  if (assocCsn.on) {
     /* example for originalTarget:
     entity E (with parameters) {
       ... keys and all the stuff ...
@@ -439,7 +430,7 @@ function determineMultiplicity(csn)
     1     => 0..1 // Association
     1     => 1    // Composition
     n     => '*'
-    *     => *
+    *     => '*'
 
     => TGT Cardinality
     CDS   => EDM
@@ -621,7 +612,7 @@ function addTypeFacets(node, csn)
    */
 function isODataSimpleIdentifier(identifier){
   // this regular expression reflects the specifiation from above
-  const regex = /^[\p{Letter}\p{Nl}_]{1}[_\p{Letter}\p{Nl}\p{Nd}\p{Mn}\p{Mc}\p{Pc}\p{Cf}]{0,127}$/gu
+  const regex = /^[\p{Letter}\p{Nl}_][_\p{Letter}\p{Nl}\p{Nd}\p{Mn}\p{Mc}\p{Pc}\p{Cf}]{0,127}$/gu
   return identifier && identifier.match(regex);
 }
 
@@ -776,7 +767,7 @@ function mergeIntoNavPropEntry(annoPrefix, navPropEntry, prefix, props) {
   // don't overwrite existing restrictions
   const prop = annoPrefix.split('.')[1];
   if(!navPropEntry[prop]) {
-    // if dictionary has entries, add them to navPropEnty
+    // if dictionary has entries, add them to navPropEntry
     if(Object.keys(o).length) {
       // ReadRestrictions may have sub type ReadByKeyRestrictions { Description, LongDescription }
       // chop annotations into dictionaries