@sap/cds-compiler 2.15.2 → 2.15.4

package/CHANGELOG.md

@@ -7,6 +7,19 @@
 Note: `beta` fixes, changes and features are usually not listed in this ChangeLog but [here](doc/CHANGELOG_BETA.md).
 The compiler behavior concerning `beta` features can change at any time without notice.
 
+## Version 2.15.4 - 2022-06-09
+
+### Fixed
+
+- for.odata:
+  + Fix derived type to scalar type resolution with intermediate `many`.
+- to.edm(x):
+  + (V4 structured) Fix key paths in combination with `--odata-foreign-keys`.
+  + Add `Edm.PrimitiveType` to `@odata.Type`.
+  + (V4 JSON) Render constant expressions for `Edm.Stream` and `Edm.Untyped`.
+  + Fix a bug in target path calculation for `NavigationPropertyBinding`s to external references.
+  + Render inner annotations even if `$value` is missing.
+- Update OData vocabularies 'Common', 'UI'.
 
 ## Version 2.15.2 - 2022-05-12
 

package/lib/base/message-registry.js

@@ -158,12 +158,12 @@ const centralMessages = {
   'composition-as-key': { severity: 'Error', configurableFor: 'deprecated' }, // is confusing and not supported
   'odata-spec-violation-array':  { severity: 'Warning' }, // more than 30 chars
   'odata-spec-violation-constraints': { severity: 'Info' }, // more than 30 chars
-  'odata-spec-violation-id': { severity: 'Error' },
-  'odata-spec-violation-type': { severity: 'Error', configurableFor: [ 'to.edmx' ] },
+  'odata-spec-violation-id': { severity: 'Error', configurableFor: true },
+  'odata-spec-violation-type': { severity: 'Error', configurableFor: true },
   'odata-spec-violation-type-unknown': { severity: 'Warning' },
   'odata-spec-violation-no-key':  { severity: 'Warning' },
-  'odata-spec-violation-key-array':  { severity: 'Error' }, // more than 30 chars
-  'odata-spec-violation-key-null': { severity: 'Error' }, // more than 30 chars
+  'odata-spec-violation-key-array':  { severity: 'Error', configurableFor: true }, // more than 30 chars
+  'odata-spec-violation-key-null': { severity: 'Error', configurableFor: true }, // more than 30 chars
   'odata-spec-violation-key-type': { severity: 'Warning' }, // more than 30 chars
   'odata-spec-violation-property-name': { severity: 'Warning' }, // more than 30 chars
 };

package/lib/edm/annotations/genericTranslation.js

@@ -333,7 +333,7 @@ function csn2annotationEdm(csn, serviceName, Edm = undefined, options=undefined,
   function handleNestedElements(objname, baseElemName, elementsObj) {
     if(!elementsObj) return;
     Object.entries(elementsObj).forEach(([elemName, element]) => {
-      if (Object.keys(element).filter( x => x.substr(0,1) === '@' ).filter(filterKnownVocabularies).length > 0) {
+      if (Object.keys(element).filter( x => x[0] === '@' ).filter(filterKnownVocabularies).length > 0) {
         message(warning, null, `annotations at nested elements are not yet supported, object ${objname}, element ${baseElemName}.${elemName}`);
       }
 
@@ -437,11 +437,17 @@ function csn2annotationEdm(csn, serviceName, Edm = undefined, options=undefined,
 
     // Filter unknown toplevel annotations
     // Final filtering of all annotations is done in handleTerm
-    const annoNames = Object.keys(carrier).filter( x => x.substr(0,1) === '@' );
+    
+    let annoNames = Object.keys(carrier).filter( x => x[0] === '@' );
     const nullWhitelist = [ '@Core.OperationAvailable' ];
-    const knownAnnos = annoNames.filter(filterKnownVocabularies).filter(x => carrier[x] !== null || nullWhitelist.includes(x));
+    let knownAnnos = annoNames.filter(filterKnownVocabularies).filter(x => carrier[x] !== null || nullWhitelist.includes(x));
     if (knownAnnos.length === 0) return;
 
+    if(rewriteInnerAnnotations()) {
+      annoNames = Object.keys(carrier).filter( x => x[0] === '@' );
+      knownAnnos = annoNames.filter(filterKnownVocabularies).filter(x => carrier[x] !== null || nullWhitelist.includes(x));
+      if (knownAnnos.length === 0) return;
+    }
     const prefixTree = createPrefixTree();
 
     // usually, for a given carrier there is one target
@@ -610,6 +616,51 @@ function csn2annotationEdm(csn, serviceName, Edm = undefined, options=undefined,
       */
     }
 
+    function rewriteInnerAnnotations() {
+      let rc = false;
+      for (let a of knownAnnos) {
+        const [ prefix, innerAnnotation ] = a.split('.@');
+        /*
+          New inner annotation (de-)structuring of the core compiler to make
+          $value arrays extendable via ellipsis
+          @anno: { $value: [ ... ], @innerAnno: ... } is now cracked up by
+          the core compiler into:
+          @anno: [ ...]
+          @anno.@innerAnno: ...
+
+          Conflict handling if $value is present:
+          @anno
+          @anno.$value
+          @anno.@innerAnno
+
+          @anno has precedence (as it was before this change) but now
+          @anno.$value is overwritten with @anno and the inner annotations
+          are applied.
+
+          Trigger is always the inner annotation, if no inner annotation
+          is available, @anno has precedence.
+
+          Insert $value into $edmJson with inner annotation as well.
+        */
+        if(innerAnnotation) {
+          if(carrier[prefix]) {
+            const valPrefix = prefix + '.$value';
+            carrier[valPrefix] = carrier[prefix];
+            delete carrier[prefix];
+            rc = true;
+          }
+          const edmJsonPrefix = prefix + '.$edmJson';
+          if(carrier[edmJsonPrefix]) {
+            const valPrefix = prefix + '.$value.$edmJson';
+            carrier[valPrefix] = carrier[edmJsonPrefix];
+            delete carrier[edmJsonPrefix];
+            rc = true;
+          }
+        }
+      }
+      return rc;
+    }
+
     function createPrefixTree() {
       // in csn, all annotations are flattened
       // => values can be - primitive values (string, number)
@@ -619,6 +670,7 @@ function csn2annotationEdm(csn, serviceName, Edm = undefined, options=undefined,
       //   by building a "prefix tree" for the annotations attached to the carrier
       //   see example at definition of function mergePathStepsIntoPrefixTree
       const prefixTree = {};
+
       for (let a of knownAnnos) {
       // remove leading @ and split at "."
       //   stop splitting at ".@" (used for nested annotations)
@@ -845,7 +897,7 @@ function csn2annotationEdm(csn, serviceName, Edm = undefined, options=undefined,
         // "pseudo-structure" used for embedding a piece of JSON that represents "OData CSDL, JSON Representation"
         oTarget.append(handleEdmJson(cAnnoValue['$edmJson'], context));
       }
-      else if ( Object.keys(cAnnoValue).filter( x => x.substr(0,1) !== '@' ).length === 0) {
+      else if ( Object.keys(cAnnoValue).filter( x => x[0] !== '@' ).length === 0) {
         // object consists only of properties starting with "@"
         message(warning, context, 'nested annotations without corresponding base annotation');
       }
@@ -952,6 +1004,8 @@ function csn2annotationEdm(csn, serviceName, Edm = undefined, options=undefined,
   //      Edm.Decimal -> Decimal
   //      integer tpye -> Int
   function handleSimpleValue(val, dTypeName, context) {
+    // these types must be represented as "String" values in XML:
+    const castToXmlString = [ 'Edm.PrimitiveType', 'Edm.Stream', 'Edm.Untyped' ];
     // caller already made sure that val is neither object nor array
     dTypeName = resolveType(dTypeName);
 
@@ -989,12 +1043,12 @@ function csn2annotationEdm(csn, serviceName, Edm = undefined, options=undefined,
         message(warning, context, `found String, but expected enum type ${ dTypeName }`);
         typeName = 'EnumMember';
       }
-      else if (dTypeName && dTypeName.startsWith('Edm.') && dTypeName !== 'Edm.PrimitiveType') {
+      else if (dTypeName && dTypeName.startsWith('Edm.') && !castToXmlString.includes(dTypeName)) {
         // this covers also all paths
         typeName = dTypeName.substring(4);
       }
       else {
-        if(dTypeName == undefined || dTypeName === 'Edm.PrimitiveType')
+        if(dTypeName == undefined || castToXmlString.some(t => t === dTypeName))
           dTypeName = 'Edm.String';
         // TODO
         //message(warning, context, "type is not yet handled: found String, expected type: " + dTypeName);

package/lib/edm/csn2edm.js

@@ -14,7 +14,7 @@ const { cloneCsnNonDict, isEdmPropertyRendered, isBuiltinType } = require('../mo
 const { checkCSNVersion } = require('../json/csnVersion');
 const { makeMessageFunction } = require('../base/messages');
 const { EdmTypeFacetMap, EdmTypeFacetNames, EdmPrimitiveTypeMap, getEdm } = require('./edm.js');
-  
+
 /*
 OData V2 spec 06/01/2017 PDF version is available from here:
 https://msdn.microsoft.com/en-us/library/dd541474.aspx
@@ -421,7 +421,7 @@ function csn2edmAll(_csn, _options, serviceNames=undefined) {
             message('odata-spec-violation-id', pLoc, { id: p._edmAttributes.Name });
           else if (options.isV2() && /^(_|[0-9])/.test(p._edmAttributes.Name)) {
             // FIXME: Rewrite signalIllegalIdentifier function to be more flexible
-            error('odata-spec-violation-id', pLoc, 
+            message('odata-spec-violation-id', pLoc,
             { prop: p._edmAttributes.Name[0], id: p._edmAttributes.Name, version: '2.0', '#': 'v2firstchar' });
           }
         });
@@ -621,9 +621,9 @@ function csn2edmAll(_csn, _options, serviceNames=undefined) {
             message('odata-spec-violation-id', pLoc, { id: parameterName });
 
           // only scalar or structured type in V2 (not entity)
-          if(param._type && 
-            !param._type.startsWith('Edm.') && 
-            csn.definitions[param._type] && 
+          if(param._type &&
+            !param._type.startsWith('Edm.') &&
+            csn.definitions[param._type] &&
             !edmUtils.isStructuredType(csn.definitions[param._type]))
             warning('odata-spec-violation-param', pLoc, { version: '2.0' });
 
@@ -933,7 +933,7 @@ function csn2edmAll(_csn, _options, serviceNames=undefined) {
 
     // generate the Edm.Annotations tree and append it to the corresponding schema
     function addAnnotations() {
-      let { annos, usedVocabularies } = translate.csn2annotationEdm(csn, serviceCsn.name, Edm, options, messageFunctions);
+      let { annos, usedVocabularies } = translate.csn2annotationEdm(reqDefs, serviceCsn.name, Edm, options, messageFunctions);
       // distribute edm:Annotations into the schemas
       // Distribute each anno into Schema
       annos.forEach(anno => {
@@ -990,7 +990,7 @@ function csn2edmAll(_csn, _options, serviceNames=undefined) {
           });
         }
         else {
-          message('odata-spec-violation-type-unknown', pLoc, 
+          message('odata-spec-violation-type-unknown', pLoc,
           { type:edmType });
         }
       }

package/lib/edm/edm.js

@@ -54,7 +54,7 @@ const EdmPrimitiveTypeMap = {
   'Edm.GeometryMultiLineString': { v4: true, SRID: true, desc: 'Collection of line strings in a flat-earth coordinate system' },
   'Edm.GeometryMultiPolygon': { v4: true, SRID: true, desc: 'Collection of polygons in a flat-earth coordinate system' },
   'Edm.GeometryCollection': { v4: true, SRID: true, desc: 'Collection of arbitrary Geometry values' },
-  //'Edm.PrimitiveType': { v4: true, desc: 'Abstract meta type' },
+  'Edm.PrimitiveType': { v4: true, desc: 'Abstract meta type' },
   //'Edm.Untyped': { v4: true, desc: 'Abstract void type' },
 };
 
@@ -1223,9 +1223,15 @@ function getEdm(options, messageFunctions) {
       // short form: key: value
       const inlineConstExpr =
         [ 'Edm.Binary', 'Edm.Boolean', 'Edm.Byte', 'Edm.Date', 'Edm.DateTimeOffset', 'Edm.Decimal', 'Edm.Double', 'Edm.Duration', 'Edm.Guid',
-          'Edm.Int16', 'Edm.Int32', 'Edm.Int64', 'Edm.SByte','Edm.Single', /*'Edm.Stream',*/ 'Edm.String', 'Edm.TimeOfDay',
+          'Edm.Int16', 'Edm.Int32', 'Edm.Int64', 'Edm.SByte','Edm.Single', 'Edm.Stream', 'Edm.String', 'Edm.TimeOfDay',
+          // Edm.Geo* according to https://issues.oasis-open.org/browse/ODATA-1323
+/*          'Edm.Geography', 'Edm.GeographyPoint', 'Edm.GeographyLineString', 'Edm.GeographyPolygon', 'Edm.GeographyMultiPoint',
+          'Edm.GeographyMultiLineString', 'Edm.GeographyMultiPolygon', 'Edm.GeographyCollection', 'Edm.Geometry', 'Edm.GeometryPoint',
+          'Edm.GeometryLineString', 'Edm.GeometryPolygon', 'Edm.GeometryMultiPoint', 'Edm.GeometryMultiLineString', 'Edm.GeometryMultiPolygon',
+          'Edm.GeometryCollection',
+*/
           /* UI.xml: defines Annotations with generic type 'Edm.PrimitiveType' */
-          'Edm.PrimitiveType', 'Bool',
+          'Edm.PrimitiveType', 'Edm.Untyped', 'Bool',
           // Official JSON V4.01 Spec defines these paths as constant inline expression:
           'AnnotationPath', 'ModelElementPath', 'NavigationPropertyPath', 'PropertyPath',
         ];

package/lib/edm/edmPreprocessor.js

@@ -1455,12 +1455,9 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
         if(isEdmPropertyRendered(k, options) &&
          !(options.isV2() && k['@Core.MediaType'])) {
           if(options.isV4() && options.isStructFormat) {
-          // This is structured OData ONLY
-          // if the foreign keys are explicitly requested, ignore associations and use the flat foreign keys instead
-            if(options.renderForeignKeys && !k.target)
-              def.$edmKeyPaths.push([kn]);
-          // else produce paths (isEdmPropertyRendered() has filtered @odata.foreignKey4 already)
-            else if(!options.renderForeignKeys)
+            // This is structured OData ONLY
+            // if the foreign keys are explicitly requested, ignore associations and use the flat foreign keys instead
+            if(!options.renderForeignKeys || (options.renderForeignKeys && !k.target))
               def.$edmKeyPaths.push(...produceKeyRefPaths(k, kn));
           }
         // In v2/v4 flat, associations are never rendered
@@ -1543,13 +1540,13 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
       // Nullability
       if((!elt.key && (elt.notNull === undefined || elt.notNull === false)) ||
            elt.key && (elt.notNull !== undefined && elt.notNull === false)) {
-        error('odata-spec-violation-key-null', location,
+        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;
       if(type) {
-        error('odata-spec-violation-key-array', location,
+        message('odata-spec-violation-key-array', location,
           {name: pathSegment, '#': pathSegment ? 'std' : 'scalar'});
       }
       // type
@@ -1615,7 +1612,14 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
         if(isAssociationOrComposition(elt) && !elt.$touched) {
           if(!elt._target.$edmTgtPaths)
             setProp(elt._target, '$edmTgtPaths', []);
-          if(!elt._target.$hasEntitySet && !elt._isToContainer && curDef !== elt._target) {
+          // drill into target only if
+          // 1) target has no entity set and this assoc is not going to the container
+          // 2) current definition and target are the same (cycle)
+          // 3) it's no external reference
+          if(!elt.$externalRef &&
+             !elt._target.$hasEntitySet &&
+             !elt._isToContainer &&
+             curDef !== elt._target) {
             // follow elements in the target but avoid cycles
             setProp(elt, '$touched', true);
             elt._target.$edmTgtPaths.push(newPrefix);
@@ -1654,6 +1658,7 @@ function initializeModel(csn, _options, messageFunctions, requestedServiceNames=
           // drill into target only if
           // 1) target has no entity set and this assoc is not going to the container
           // 2) current definition and target are the same (cycle)
+          // 3) it's no external reference
           if(!elt.$externalRef &&
              !elt._target.$hasEntitySet &&
              !elt._isToContainer &&

package/lib/gen/Dictionary.json

@@ -658,6 +658,7 @@
       "Type": "Common.FieldControlType",
       "AppliesTo": [
         "Property",
+        "Parameter",
         "Record",
         "EntityType"
       ]
@@ -3246,6 +3247,7 @@
         "TypeNamePlural": "Edm.String",
         "Title": "UI.DataFieldAbstract",
         "Description": "UI.DataFieldAbstract",
+        "Image": "Edm.Stream",
         "ImageUrl": "Edm.String",
         "TypeImageUrl": "Edm.String",
         "Initials": "Edm.String"
@@ -3693,7 +3695,7 @@
       "$kind": "ComplexType",
       "BaseType": "UI.DataFieldAbstract",
       "Properties": {
-        "Value": "Edm.PrimitiveType",
+        "Value": "Edm.Untyped",
         "Label": "Edm.String",
         "Criticality": "UI.CriticalityType",
         "CriticalityRepresentation": "UI.CriticalityRepresentationType",
@@ -3704,8 +3706,8 @@
       "$kind": "ComplexType",
       "BaseType": "UI.DataField",
       "Properties": {
-        "Action": "Common.QualifiedName",
         "Value": "Edm.PrimitiveType",
+        "Action": "Common.QualifiedName",
         "Label": "Edm.String",
         "Criticality": "UI.CriticalityType",
         "CriticalityRepresentation": "UI.CriticalityRepresentationType",
@@ -3716,10 +3718,10 @@
       "$kind": "ComplexType",
       "BaseType": "UI.DataField",
       "Properties": {
+        "Value": "Edm.PrimitiveType",
         "SemanticObject": "Edm.String",
         "Action": "Edm.String",
         "Mapping": "Collection(Common.SemanticObjectMappingType)",
-        "Value": "Edm.PrimitiveType",
         "Label": "Edm.String",
         "Criticality": "UI.CriticalityType",
         "CriticalityRepresentation": "UI.CriticalityRepresentationType",
@@ -3730,8 +3732,8 @@
       "$kind": "ComplexType",
       "BaseType": "UI.DataField",
       "Properties": {
-        "Target": "Edm.NavigationPropertyPath",
         "Value": "Edm.PrimitiveType",
+        "Target": "Edm.NavigationPropertyPath",
         "Label": "Edm.String",
         "Criticality": "UI.CriticalityType",
         "CriticalityRepresentation": "UI.CriticalityRepresentationType",
@@ -3742,9 +3744,9 @@
       "$kind": "ComplexType",
       "BaseType": "UI.DataField",
       "Properties": {
+        "Value": "Edm.PrimitiveType",
         "Url": "Edm.String",
         "UrlContentType": "Edm.String",
-        "Value": "Edm.PrimitiveType",
         "Label": "Edm.String",
         "Criticality": "UI.CriticalityType",
         "CriticalityRepresentation": "UI.CriticalityRepresentationType",
@@ -3755,8 +3757,8 @@
       "$kind": "ComplexType",
       "BaseType": "UI.DataField",
       "Properties": {
-        "Actions": "Collection(UI.DataField)",
         "Value": "Edm.PrimitiveType",
+        "Actions": "Collection(UI.DataField)",
         "Label": "Edm.String",
         "Criticality": "UI.CriticalityType",
         "CriticalityRepresentation": "UI.CriticalityRepresentationType",

package/lib/transform/odata/toFinalBaseType.js

@@ -148,7 +148,9 @@ function expandToFinalBaseType(csn, transformers, csnUtils, services, options, i
         // example in actions: 'action act() return Primitive; type Primitive: array of String;'
       const currService = csnUtils.getServiceName(defName);
       const finalType = csnUtils.getFinalTypeDef(node.type);
-      if (finalType.items && isBuiltinType(finalType.items.type)) {
+      if (finalType.items && 
+        (isBuiltinType(finalType.items.type) || isBuiltinType(csnUtils.getFinalBaseType(finalType.items.type))))
+      {
         if (!isArtifactInService(node.type, currService) || !isV4) {
           node.items = finalType.items;
           delete node.type;

package/lib/transform/translateAssocsToJoins.js

@@ -1818,6 +1818,10 @@ function walkPath(node, env)
   // or that are parameters ($parameters or escaped paths (':')
   //path.length && path[ path.length-1 ]._artifact
   const art = path && path.length && path[path.length-1]._artifact;
+
+  // regardless of the position in the query, ignore paths that have virtual path steps
+  if(art && path.some(ps => ps._artifact && ps._artifact.virtual && ps._artifact.virtual.val))
+    return path;
   if(art && !internalArtifactKinds.includes(art.kind))
   {
     if(env.callback)

package/package.json

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