@sap/cds-compiler 4.4.0 → 4.4.4

package/CHANGELOG.md

@@ -7,6 +7,22 @@
 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 4.4.4 - 2023-11-24
+
+### Fixed
+
+- to.hdi.migration: Changes in only `doc`-comments should not result in a drop-create of the primary key.
+
+## Version 4.4.2 - 2023-11-17
+
+### Fixed
+
+- for.odata: Fix crash when using a projection with associations as action parameter type.
+- to.edm(x): `Edm.AnyPropertyPath` is hard to `Edm.PropertyPath`. As there is no dynamic path evaluation,
+  `Edm.NavigationPropertyPath` must be enforced via `$edmJson`.
+  `Edm.AnyPropertyPath` has been used in `@Aggregation.ApplySupported.GroupableProperties` for the first
+  time after vocabulary update with [4.4.0](#version-440---2023-11-09).
+
 ## Version 4.4.0 - 2023-11-09
 
 ### Added

package/lib/compiler/extend.js

@@ -31,7 +31,22 @@ const $location = Symbol.for( 'cds.$location' );
 // attach stupid location - TODO: remove in v5
 const genLocation = new CsnLocation( '' );
 
-// Array.prototype.spread = 42;   // prototype-polluted JS classes
+const draftElements = [
+  'IsActiveEntity',
+  'HasActiveEntity',
+  'HasDraftEntity',
+  'DraftAdministrativeData',
+  'SiblingEntity',
+];
+const draftBoundActions = [
+  'draftPrepare',
+  'draftActivate',
+  'draftEdit',
+];
+
+function canBeDraftMember( name, parent, draftMembers ) {
+  return parent?.kind === 'entity' && parent._service && draftMembers.includes( name );
+}
 
 function extend( model ) {
   // Get simplified "resolve" functionality and the message function:
@@ -718,7 +733,9 @@ function extend( model ) {
                    'Parameters only exist for actions or functions' );
           break;
         case 'actions':
-          // TODO: use extra text variant and location of dictionary
+          if (canBeDraftMember( name, parent, draftBoundActions ))
+            return true;
+          // TODO: use extra text variant and location of dictionary - no
           notFound( 'ext-undefined-action', ext.name.location, ext,
                     { '#': 'action', art: parent, name } );
           break;
@@ -734,6 +751,8 @@ function extend( model ) {
       const art = inReturns || parent;
       switch (prop) {
         case 'elements':
+          if (canBeDraftMember( name, parent, draftElements ))
+            break;
           notFound( 'ext-undefined-element', ext.name.location, ext,
                     { '#': (inReturns ? 'returns' : 'element'), art, name },
                     parent.elements );
@@ -749,6 +768,8 @@ function extend( model ) {
                     parent.params );
           break;
         case 'actions':
+          if (canBeDraftMember( name, parent, draftBoundActions ))
+            break;
           notFound( 'ext-undefined-action', ext.name.location, ext,
                     { '#': 'action', art: parent, name },
                     parent.actions );

package/lib/compiler/shared.js

@@ -934,14 +934,24 @@ function fns( model ) {
     // TODO: improve text, use text variant for: "or builtin" or "definitions" or none
   }
 
-  function undefinedForAnnotate( user, item, valid, _dict, prev ) {
+  function undefinedForAnnotate( user, item, valid, _dict, prev, path ) {
     // in a CSN source, only one env was tested (valid.length 1):
     const art = (!prev) ? item.id : searchName( prev, item.id, 'absolute' );
+    if (!user.elements && !user.actions && !user.enum && !user.params &&
+        couldBeDraftsEntity( item.id, valid, prev, path ))
+      return;
     signalNotFound( (valid.length > 1 ? 'ext-undefined-art' : 'ext-undefined-def'),
                     // TODO: ext-undefined-xyz
                     [ item.location, user ], valid, { art } );
   }
 
+  function couldBeDraftsEntity( id, valid, prev, path ) {
+    const entity = prev
+      ? prev === path[path.length - 2]._artifact && prev
+      : path.length === 1 && id.endsWith( '.drafts' ) && model.definitions[id.slice( 0, -7 )];
+    return entity?.kind === 'entity' && !!entity._service;
+  }
+
   function undefinedParam( user, head, valid, _dict, _art, _path, semantics ) {
     // TODO: text variant if there are no parameters, or in artifactParameters()
     // TODO: use prepared message variants

package/lib/edm/EdmPrimitiveTypeDefinitions.js

@@ -246,7 +246,15 @@ const EdmPrimitiveTypeMap = {
   },
   // 'Edm.Untyped': { v4: true, desc: 'Abstract void type' },
 };
+const EdmPathTypeMap = {
+  'Edm.AnnotationPath': 1,
+  'Edm.PropertyPath': 1,
+  'Edm.NavigationPropertyPath': 1,
+  'Edm.AnyPropertyPath': 1,
+  'Edm.ModelElementPath': 1,
+  'Edm.Path': 1,
+};
 
 module.exports = {
-  EdmTypeFacetMap, EdmTypeFacetNames, EdmPrimitiveTypeMap,
+  EdmTypeFacetMap, EdmTypeFacetNames, EdmPrimitiveTypeMap, EdmPathTypeMap,
 };

package/lib/edm/annotations/genericTranslation.js

@@ -8,6 +8,7 @@ const { forEachDefinition } = require('../../model/csnUtils');
 const { isBetaEnabled, setProp } = require('../../base/model.js');
 const { xpr2edmJson, getEdmJsonHandler } = require('./edmJson.js');
 const { vocabularyDefinitions } = require('./vocabularyDefinitions.js');
+const { EdmPathTypeMap } = require('../EdmPrimitiveTypeDefinitions.js');
 
 /** ************************************************************************************************
  * csn2annotationEdm
@@ -940,8 +941,12 @@ function csn2annotationEdm( reqDefs, csnVocabularies, serviceName,
   // note: expr can also be provided if an enum/complex type/collection is expected
   function handleExpression( value, dTypeName ) {
     let typeName = 'Path';
-    if ( [ 'Edm.AnnotationPath', 'Edm.ModelElementPath', 'Edm.NavigationPropertyPath', 'Edm.PropertyPath', 'Edm.Path' ].includes(dTypeName) )
-      typeName = dTypeName.split('.')[1];
+    if ( EdmPathTypeMap[dTypeName] ) {
+      if (dTypeName === 'Edm.AnyPropertyPath')
+        typeName = 'PropertyPath';
+      else
+        typeName = dTypeName.split('.')[1];
+    }
 
     if (value) {
       // replace all occurrences of '.' by '/' up to first '@'

package/lib/modelCompare/compare.js

@@ -190,7 +190,7 @@ function getExtensionAndMigrations(beforeModel, options, { extensions, migration
         migration.change = changedElements;
         if(!hasPrimaryKeyChange)
           forEach(changedElements, (_name, change) => {
-            if((change.old.key || change.new.key) && !change.new.target && !change.old.target) {
+            if(!change.onlyDoc && (change.old.key || change.new.key) && !change.new.target && !change.old.target) {
               // For to.hdi.migration: Just drop-create (commented out), for to.sql.migration: Handle case where we add/remove "key" keyword, no drop-create otherwise
               if(options.sqlDialect === 'hana' && options.src === 'hdi' || (!change.old.key || !change.new.key)) {
                 hasPrimaryKeyChange = true;
@@ -276,6 +276,8 @@ function getElementComparator(otherArtifact, addedElementsDict = null, changedEl
           element.$notNull = false; // Explicitly set notNull to the implicit default so we render the correct ALTER
         }
         changedElementsDict[name] = changedElement(element, otherElement);
+      } else if(docCommentChanged(element, otherElement)) {
+        changedElementsDict[name] = { ...changedElement(element, otherElement), onlyDoc: true };
       }
 
       return;
@@ -356,6 +358,9 @@ function deepEqual(a, b, include = () => true, depth = 0) {
       : a === b;
 }
 
+function docCommentChanged(element, otherElement) {
+  return element.doc && !otherElement.doc || otherElement.doc && !element.doc || element.doc && element.doc !== otherElement.doc;
+}
 
 const relevantProperties = {
   'doc': true,
@@ -364,7 +369,8 @@ const relevantProperties = {
 };
 
 /**
- * Returns whether any type parameters differ between two given elements. Ignores whether types themselves differ (`type` property).
+ * Returns whether any type parameters differ between two given elements. Ignores whether types themselves differ (`type` property) and ignores
+ * diff in doc comments.
  * @param element {object} an element
  * @param otherElement {object} another element
  * @returns {boolean}
@@ -373,7 +379,7 @@ function typeParametersChanged(element, otherElement) {
   const checked = new Set();
   for (const key in element) {
     if (Object.prototype.hasOwnProperty.call(element, key))
-      if((!key.startsWith('@') || relevantProperties[key]) && key !== 'type') {
+      if((!key.startsWith('@') || relevantProperties[key]) && key !== 'type' && key !== 'doc') {
         checked.add(key);
         if(!deepEqual(element[key], otherElement[key]))
           return true;
@@ -382,7 +388,7 @@ function typeParametersChanged(element, otherElement) {
 
   for (const key in otherElement) {
     if (Object.prototype.hasOwnProperty.call(otherElement, key))
-      if((!key.startsWith('@') || relevantProperties[key]) && key !== 'type' && !checked.has(key))
+      if((!key.startsWith('@') || relevantProperties[key]) && key !== 'type' &&  key !== 'doc' && !checked.has(key))
         return true;
   }
 

package/lib/transform/forOdata.js

@@ -98,7 +98,9 @@ function transform4odataWithCsn(inputModel, options) {
     inspectRef,
     artifactRef,
     effectiveType,
-    getFinalTypeInfo
+    getFinalTypeInfo,
+    dropDefinitionCache,
+    initDefinition,
   } = csnUtils;
 
   // are we working with structured OData or not
@@ -147,6 +149,8 @@ function transform4odataWithCsn(inputModel, options) {
       // TODO: handle artifact.projection instead of artifact.query correctly in future V2
       if (def.kind === 'entity' && def.projection) {
         def.query = { SELECT: def.projection };
+        dropDefinitionCache(def);
+        initDefinition(def);
       }
     }],
     { skipArtifact: isExternalServiceMember }

package/package.json

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