@sap/cds-compiler 4.4.2 → 4.4.4

package/CHANGELOG.md

@@ -7,6 +7,12 @@
 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

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

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