@sap/xsodata 7.4.4 → 7.5.5

package/CHANGELOG.md

@@ -8,6 +8,33 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
 ## Unreleased
 
+## [7.5.5] - 2022-04-21
+
+* On calc view: Stable sort order with $skip and $top usage for subsequent requests via "order by" of key fields in SQL statement
+
+## [7.5.4] - 2022-04-21
+
+Build infrastructure fix
+
+## [7.5.1] - [7.5.3] - 2022-04-20
+
+Build infrastructure fixes
+
+## [7.5.0] - 2022-03-22
+
+* Support of node version 16
+* Update module dependencies
+* Update of system query options and xsodata-settings help text
+* Minor changes: Error reporting
+
+## [7.4.5] - 2021-12-15
+
+* Suppress $metadata annotation <code>sap:aggregation-role="dimension"</code> on calculation view property if it is used as description property referenced by annotation <code>sap:text</code> by another property of the calulation view. The annotation is only supressed if the corresponding xsodata-file has <code>settings</code> containing this: <code>noDimensionAnnoOnTextProperty true;</code>
+* Improvements on URI parsing errors:
+  * reporting URI resource path character position on parsing error, if possible
+  * Invalid navigation property on <code>$expand</code> system query option returns 400 (Bad Request) instead of 500 (Internal Server Error)
+* Removed support for NodeJS version 10
+
 ## [7.4.4] - 2021-07-20
 
 * HANA client API usage changed: 'execQuery' used for read requests, change requests remain on 'exec'

package/lib/db/connect.js

@@ -238,10 +238,10 @@ function _connectInternal(context, asyncDone) {
 exports.connect = function (context, asyncDone) {
     context.db = context.db || {};
     if (context.db.client && (context.db.connectionInitialized === true)) {
-        context.logger.debug('connect - db', 'connect already done');
+        context.logger.info('connect - db', 'connect already done');
         return asyncDone(null, context);
     }
-    context.logger.debug('connect - db', 'connect');
+    context.logger.info('connect - db', 'connect');
 
     return _connectInternal(context, function (err) {
         if (err) {
@@ -268,7 +268,12 @@ exports.disconnect = function (context, cb) {
     if (context.db.openedConnection) {
         context.logger.info('connect - db', 'disconnect done');
         if (context.db.client) {
-            context.db.client.end();
+            context.db.client.end((err) => {
+                if (err) {
+                    context.logger.error('connect - db', `disconnect failed (callback): ${err}`);
+                }
+                context.logger.info('connect - db', 'disconnect done (callback)');
+            });
         }
         context.db.openedConnection = false;
         return cb();

package/lib/db/dbSegment.js

@@ -92,6 +92,13 @@ function DbSegment(kind, entityType, nr) {
      * @type {Array<String>}
      */
     this._SelectedPropertiesOrdered = null;
+
+    /**
+     * For CV: (real) key names with alias
+     * @type {Array<String,string>}
+     */
+    this._aliasedKeyPropertiesOnCalcView = [];
+
     /**
      * Store names existing of navigation properties
      * @type {Array<String>}
@@ -247,7 +254,7 @@ DbSegment.prototype.setRecordFromPostPayload = function (context, record) {
                     (modifyBy && key === 'MODIFIED_BY') ||
                     (modifyAt && key === 'MODIFIED_AT'))
                 ) {
-                    throw new BadRequest('The serialized resource has an missing value for member ' + key);
+                    throw new BadRequest('The serialized resource has a missing value for member ' + key);
                 }
             }
             dbValue = null;
@@ -336,7 +343,7 @@ DbSegment.prototype.setRecordFromPutPayload = function (context, record) {
                         // skip optional calc view parameters
                         (this.entityType.propertiesMap[property] && this.entityType.propertiesMap[property].MANDATORY === 0)
                     )) {
-                        throw new BadRequest('The serialized resource has an missing value for member ' + property);
+                        throw new BadRequest('The serialized resource has a missing value for member ' + property);
                     }
 
                 }
@@ -593,6 +600,50 @@ DbSegment.prototype.getKeyProperties0123ForSelectAs0123 = function (noTable) {
     return ret;
 };
 
+DbSegment.prototype.getKeyProperties0123ForSelectOnCalcViewAs0123 = function (noTable) {
+    let ret = [];
+    let keyNames;
+    let keyName;
+    let property;
+    let selectProperty;
+    let propertyType;
+    let i;
+    let j = -1;
+
+    keyNames = this.entityType.keyNamesOrdered;
+
+    for (i = 0; i < keyNames.length; i++) {
+        keyName = keyNames[i];
+        property = this.entityType.propertiesMap[keyName];
+        selectProperty = null;
+
+        if (property.KIND !== EntityType.entityKind.inputParameters) {
+            j = j + 1;      // for real key properties use numbering: 0,1,2, ... (skip CV input params)
+            propertyType = property.aggregate ? null : property.DATA_TYPE_NAME;
+            selectProperty = new sqlStatement.SelectProperty(noTable ? null : this._Alias, keyName, propertyType, j.toString());
+            ret.push(selectProperty);
+        }
+    }
+    return ret;
+};
+
+DbSegment.prototype.setAliasedKeyPropertiesOnCalcView = function(selectProperties) {
+    this._aliasedKeyPropertiesOnCalcView = selectProperties;
+};
+
+DbSegment.prototype.hasAliasedKeyPropertiesOnCalcView = function() {
+    return this._aliasedKeyPropertiesOnCalcView.length !== 0;
+};
+
+DbSegment.prototype.getAliasedKeyPropertyOnCalcView = function(propertyName) {
+    for (let i = 0; i < this._aliasedKeyPropertiesOnCalcView.length; i++) {
+        if (this._aliasedKeyPropertiesOnCalcView[i].property === propertyName) {
+            return this._aliasedKeyPropertiesOnCalcView[i];
+        }
+    }
+    return null;
+};
+
 /**
  * Returns a selectProperty for usage in the select part of sql statements
  * The property are named "0","1","2",... and have as type the type of the corresponding key ( ordered by position
@@ -649,7 +700,30 @@ DbSegment.prototype.getKeyProperties0123ForOrderBy = function (noTable) {
     return ret;
 };
 
-DbSegment.prototype.getKeyPropertiesNotSelectedForSelect = function (noTable) {
+DbSegment.prototype.getKeyProperties0123ForOrderByCalcView = function (noTable) {
+    let ret = [];
+    let keyName;
+    let property;
+	let j = -1;
+
+    let keyNames = this.entityType.keyNamesOrdered;
+
+    for (let i = 0; i < keyNames.length; i++) {
+
+        keyName = keyNames[i];
+        property = this.entityType.propertiesMap[keyName];
+
+		if (property.KIND !== EntityType.entityKind.inputParameters) {
+			j = j + 1;
+            let newSortOrder = new typedObjects.SortOrder(new typedObjects.Property(j.toString(), noTable ? null : this._Alias), 'ASC');
+            newSortOrder.setPropertyName(property.COLUMN_NAME);
+            ret.push(newSortOrder);
+		}
+    }
+    return ret;
+};
+
+DbSegment.prototype.getKeyPropertiesNotSelectedForSelect = function (noTable = undefined, inputParameters = null) {
     let ret = [];
     let keyNames;
     let i;
@@ -659,6 +733,18 @@ DbSegment.prototype.getKeyPropertiesNotSelectedForSelect = function (noTable) {
 
     keyNames = this.entityType.keyNamesOrdered;
 
+    // remove input params from key list
+    if (inputParameters !== null) {
+        for (let inputParameterName in inputParameters) {
+            if (inputParameters.hasOwnProperty(inputParameterName)) {
+                let indexKeyName = keyNames.indexOf(inputParameterName);
+                if (indexKeyName > -1) {
+                    keyNames.splice(indexKeyName, 1);
+                }
+            }
+        }
+    }
+
     for (i = 0; i < keyNames.length; i++) {
         keyName = keyNames[i];
         key = this.entityType.propertiesMap[keyName];

package/lib/grammars/xsodata.peg

@@ -613,7 +613,7 @@ settingscontent          =  sl:( OWS settingsconfig OWS ";")*
                                 return ret;
                             }
 settingsconfig           = s:(settings_meta_cache / settings_content / settings_enable / settings_support /
-                            settings_hints / settings_admindata / settings_limits )
+                            settings_hints / settings_admindata / settings_limits / settings_noDimensionAnnoOnTextProperty )
                             { return s; }
 settings_meta_cache      = "metadata" MWS ( "cache.control" / "cache-control") MWS qs:quotedstring
                             { return {
@@ -635,6 +635,15 @@ settings_enable          = "enable" MWS string
                             { return { name : "enable", value : s }; }
 settings_support         = "support" MWS s:string
                             { return { name : "support", value : s }; }
+
+settings_noDimensionAnnoOnTextProperty = "noDimensionAnnoOnTextProperty" MWS s:string
+                                {
+                                    return {
+                                        name : "noDimensionAnnoOnTextProperty",
+                                        value : s
+                                    };
+                                }
+
 settings_hints           = "hints" MWS hl:("null" / hintlist)
                             {
                                 var value = hl === 'null' ? [] : hl

package/lib/model/annotationFactory.js

@@ -120,6 +120,9 @@ function setPropertyAggregationRole(entityType, property, propertyAnnotations) {
             (entityType.kind !== EntityType.entityKind.inputParameters &&
                 (entityType.hasAggregates() || entityType.hasMeasureProperties())
             ) && entityType.isInBimcDimensionView(property.COLUMN_NAME)) {
+            if (property.suppressAnnotationDimension && property.suppressAnnotationDimension === true) {
+                return;     // property is used as description text for other property: do not add annotation
+            }
             propertyAnnotations["sap:aggregation-role"] = "dimension";
         }
     }

package/lib/model/metadataReader.js

@@ -189,6 +189,19 @@ function loadCalcViewInfo(context, entityType, cb) {
         entityType.setCalculationViewDimensionData(rows, { cube: cubeName }, context.logger); // e.g. sap:label is fill with calculation view dimension data
         entityType.resolveAggregates();
 
+        entityType.properties.forEach((property) => {
+
+            // suppressing annotation "sap:aggregation-role" depends on xsodata-file "setting"
+            if (entityType._settings.noDimensionAnnoOnTextProperty && entityType._settings.noDimensionAnnoOnTextProperty === 'true') {
+                if (property.DESC_NAME &&  property.DESC_NAME !== property.COLUMN_NAME) {
+                    for (let i = 0; i < entityType.properties.length; i++) {
+                        if (entityType.properties[i].COLUMN_NAME === property.DESC_NAME) {
+                            entityType.properties[i].suppressAnnotationDimension = true;
+                        }
+                    }
+                }
+            }
+        });
 
         var parameters = entityType.getParameters();
         if (!parameters) {