@sap/xsodata 7.3.5 → 7.4.5

package/CHANGELOG.md

@@ -8,11 +8,34 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
 ## Unreleased
 
+## [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'
+
+## [7.4.2] - 2021-05-05
+
+* Quote reserve for calcview "in" formula
+* node version support: 10, 12, 14
+
+## [7.3.7] - 2021-02-24
+
+### Fixed
+
+For Edm.String typed properties, all single quotes must be preserved.
+
 ## [7.3.5] - 2020-11-23
 
 ### Fixed
 
-Authoization header parsing conform to RFC6750
+Authorization header parsing conform to RFC6750
 
 ## [7.3.4] - 2020-10-14
 
@@ -31,7 +54,7 @@ Commit on drop of temporary tables added.
 
 ## [7.3.1] - 2020-09-29
 
-### Changed 
+### Changed
 
 * Improved error messages.
 
@@ -40,34 +63,34 @@ Commit on drop of temporary tables added.
 * Aggregation for "count":
   * For explicit application the aggregation type "count" was not supported in the xsodata file. When
     "aggregates always (COUNT of "Amount");" was used, a syntax error was thrown.
-  * For implicit aggregation, where the aggregation information is loaded from the calcviews measures (e.g. 
+  * For implicit aggregation, where the aggregation information is loaded from the calcviews measures (e.g.
     using "aggregates always;" without a property list in the *.xsodata file), wrongly "avg" was used as measure
     type instead of "count".
   * With this fix aggregation type "count" is now properly supported
-    * For explicit application: "aggregates always (COUNT of "Amount");" 
-    * For implicit aggregation: calcview measures "count" and "avg" are now supported property 
-      
-* Fix: If a temporary table is not properly dropped by the DB, a second drop step is performed to avoid errors 
+    * For explicit application: "aggregates always (COUNT of "Amount");"
+    * For implicit aggregation: calcview measures "count" and "avg" are now supported property
+
+* Fix: If a temporary table is not properly dropped by the DB, a second drop step is performed to avoid errors
     when recreating the table.
-         
+
 ## [7.2.0] - 2020-08-19
 
 * Improve logging infrastructure
 
 ## [7.1.0] - 2020-08-11
 
-* OData type Edm.Time is mapped to hana types 'TIME' (due to backward compatiblity) which stores only hour, minutes 
-  and seconds, so only the uri format **time'PT0H0M0S'** was supported. With this fix also the full representation 
-  like time'P2010Y12M30DT01H02M03S' can be used (some UIs generated it) if the parts of year, mounth and day are zero. 
-  
-* Fix for missing annotations (e.g. "sap:label") if an calcview without input parameters is exposed as normal view 
+* OData type Edm.Time is mapped to hana types 'TIME' (due to backward compatiblity) which stores only hour, minutes
+  and seconds, so only the uri format **time'PT0H0M0S'** was supported. With this fix also the full representation
+  like time'P2010Y12M30DT01H02M03S' can be used (some UIs generated it) if the parts of year, mounth and day are zero.
+
+* Fix for missing annotations (e.g. "sap:label") if an calcview without input parameters is exposed as normal view
   (this is without the "parameter via" keyword in the xsodata file)
 
 * Fixes for create, update, delete operations via user-exits on calculation views without input parameters.
-  Please note: if the input parameters are omitted and "via keys" is used, then the input parameter must be set in 
-  the exit functions since they are rendered in the output.  
+  Please note: if the input parameters are omitted and "via keys" is used, then the input parameter must be set in
+  the exit functions since they are rendered in the output.
 
-* Explicitly drop prepared statements immediately instead at request end  
+* Explicitly drop prepared statements immediately instead at request end
 
 ## [7.0.3] - 2020-06-30
 
@@ -78,20 +101,20 @@ Commit on drop of temporary tables added.
 
 * Add support for create, update, delete operations via user-exits on calculation views without input parameters.
   Work for both, calculation views without input parameters exposed as normal view and exposed as calcview.
- 
+
 ## [7.0.1] - 2020-05-12
 
-* Add support for calculation views without input parameters. 
-  Before release 7.0.0 calcviews without input parameters have not been supported, but worked accidentally if a calcview 
-  was wrongly exposed as normal view. After the major release 7.0.0 this wrong exposure of a calcview resulted in an error. 
+* Add support for calculation views without input parameters.
+  Before release 7.0.0 calcviews without input parameters have not been supported, but worked accidentally if a calcview
+  was wrongly exposed as normal view. After the major release 7.0.0 this wrong exposure of a calcview resulted in an error.
   Because calcviews without input parameters are used more often, the support for this calcviews is now supported.
   You can either expose a calcview as normal view or as proper calcview, for the latter an input parameter entityset with
-  parenthesis must be used.  
+  parenthesis must be used.
 
 ## [7.0.0] - 2020-04-23
 
 * Add support for NodeJS version 12
-* Removed support for NodeJS version 6  
+* Removed support for NodeJS version 6
 * Fix bug when using a view with explicit key in combination with concurrency token using default properties for ETag.
   Now key properties are not considered for etag generation as written in the "SAP HANA Developer Guide":
   _If you specify concurrency token only, then all properties, except the key properties, are used to calculate
@@ -113,7 +136,7 @@ Requirements:
     * input parameters in the calculation view of type ALPHANUM, BLOB, DECIMAL, NVARCHAR, VARBINARY, VARCHAR must have length restriction
     * input parameters in the calculation view of type DECIMAL must have scale restriction
     * all key semantics also apply to keys coming from input parameters
-* **IMPORTANT** By default, now a maximum body size of "10mb" per request is allowed. More payload leads to an "413 Payload Too Large" error. This value of 10mb can be changed with the odata settings in the *.xsodata file 
+* **IMPORTANT** By default, now a maximum body size of "10mb" per request is allowed. More payload leads to an "413 Payload Too Large" error. This value of 10mb can be changed with the odata settings in the *.xsodata file
 [see **XSOdata Settings**](/documentation/xsodataSettings.md)
 
 ## [5.0.0] - 2019-12-17
@@ -123,21 +146,21 @@ Requirements:
 * Removed lock when opening a db connection
   The new native hana-client driver used by xsjs is thread save, so the lock for retrieving a new db connection is not required anymore.
   **IMPORTANT** If a custom open function is used, then this function must be reentrant or implement an own lock inside.
-  
+
 ### Fixed
 
-* When using $count to determine the number of records of an entity set in junction with the limit feature, the 
-returned number was also capped by the limit, this was wrong. Now the correct full number of records is returned.  
+* When using $count to determine the number of records of an entity set in junction with the limit feature, the
+returned number was also capped by the limit, this was wrong. Now the correct full number of records is returned.
 * Fixed typeError if a stored procedure used as custom exit does not return a proper error structure.
- 
+
 ## [4.7.0] - 2019-10-28
 
-### Fixed 
+### Fixed
 
 Fixed error causing duplicate properties and property references in the metadata document. Prerequisites:
 * The error occurs if an calculation view has been used as source for an entityset
 * This calculation view contains an input parameter which is used in more than one measures
-* Example: Input parameter "Input_Currency" (a calcview variable) is used in the currency conversion for the measures "VALUE" and "TAX" 
+* Example: Input parameter "Input_Currency" (a calcview variable) is used in the currency conversion for the measures "VALUE" and "TAX"
 
 ## [4.6.0] - 2019-10-11
 
@@ -180,8 +203,8 @@ Fixed error "Error while executing a DB query" when using an navigation property
 
 - Update module dependencies
 - The code field inside an OData error response (error.code) is now correctly send as string (not as number)
-- For calcviews the columns type length is determined from the COLUMN_SQL_TYPE if LENGTH is not set.  
-- Fixed error while parsing multipart/mixed batch requests  
+- For calcviews the columns type length is determined from the COLUMN_SQL_TYPE if LENGTH is not set.
+- Fixed error while parsing multipart/mixed batch requests
 
 ## [4.3.0] - 2018-10-19
 
@@ -189,12 +212,12 @@ Fixed error "Error while executing a DB query" when using an navigation property
 
 - Minimal required @sap/hana-client version is 2.3.123
 - Improved test exits
-- **IMPORTANT** Conversion: When converting TIMESTAMP db type to OData V2 json payload, only the first 3 digits 
- of the fractional part are used (OData V2 type DateTime does only supports millisecond precision). With the old 
- hdb db driver the xsodata library got already only millisecond precision, with the new hana-client db-driver the xsodata 
- library itself has to remove any digits and use only the millisecond part. The check if the digits for micro- or nanoseconds 
+- **IMPORTANT** Conversion: When converting TIMESTAMP db type to OData V2 json payload, only the first 3 digits
+ of the fractional part are used (OData V2 type DateTime does only supports millisecond precision). With the old
+ hdb db driver the xsodata library got already only millisecond precision, with the new hana-client db-driver the xsodata
+ library itself has to remove any digits and use only the millisecond part. The check if the digits for micro- or nanoseconds
  are zero and throwing an error if not (added with release 4.0.0) has been removed due to backward  compatibility reasons.
- 
+
 ## [4.2.0] - 2018-09-18
 
 ### Changed
@@ -215,8 +238,8 @@ Fixed error "Error while executing a DB query" when using an navigation property
 
 ### Added
 
-- **IMPORTANT**|**INCOMPATIBLE** Added limit feature to restrict the amount of records loaded from the database. 
-  There are defaults for the limit values [see **XSOdata Settings**](/documentation/xsodataSettings.md) which need to 
+- **IMPORTANT**|**INCOMPATIBLE** Added limit feature to restrict the amount of records loaded from the database.
+  There are defaults for the limit values [see **XSOdata Settings**](/documentation/xsodataSettings.md) which need to
   be validated before using this version.
 - Support for hana-client database connector
 - **IMPORTANT**|**INCOMPATIBLE** Switched default database connector from hdb to hana-client
@@ -224,13 +247,13 @@ Fixed error "Error while executing a DB query" when using an navigation property
 
 ### Fixed
 
-- Use always the original DB property ordering when copying data into temporary tables for use 
+- Use always the original DB property ordering when copying data into temporary tables for use
 in exits in the insert and update steps.
-  
+
 
 ## [3.7.0] - 2018-05-22
 
-### Fixed 
+### Fixed
 
 - Update dependencies
 
@@ -243,17 +266,17 @@ in exits in the insert and update steps.
 
 ## New features with xsodata 3.6.0:
 
-### Fixed 
+### Fixed
 
-- Extended DB-Version check to avoid unnecessary cleanup of temporary tables 
-- Commands for cleanup of temporary tables don't stop the request processing if tables are truncated/dropped already  
-- Fixed error which leads to an unclosed db connection. This error occurred only if   
+- Extended DB-Version check to avoid unnecessary cleanup of temporary tables
+- Commands for cleanup of temporary tables don't stop the request processing if tables are truncated/dropped already
+- Fixed error which leads to an unclosed db connection. This error occurred only if
    - the xsdata library is used without the xsjs layer (which is not recommended) and
    - the db connection information was provided via host, port, user,... to the OdataHandler
-   - as request options for the processRequest method a string containing the uriPrefix is used 
-   (not an RequestOptions object). 
+   - as request options for the processRequest method a string containing the uriPrefix is used
+   (not an RequestOptions object).
    - $batch processing is used
-- Fixed wrong decoding of OData strings of type Edm.String in $filter and $orderby expressions if the string contained 
+- Fixed wrong decoding of OData strings of type Edm.String in $filter and $orderby expressions if the string contained
 exactly one single quote (e.g. '''' have been decoded wrongly to Json "" not to the correct "'")
 - Parsing milliseconds for Edm.DateTime works now as expected for hana column type TIMESTAMP.
   Sample: HANA value "9999-12-31T23:59:59.99" is parsed now to have 990 ms instead of just 99ms
@@ -264,35 +287,35 @@ exactly one single quote (e.g. '''' have been decoded wrongly to Json "" not to
 
 ## New features with xsodata 3.5.0:
 
-### Fixed 
+### Fixed
 
 - Proper pattern escaping for substringof, startswith and endswith operations on $filter or $orderby.
 - Fixed SQL error when retrieving the row count of calculation views with transparent filters.
 
 ### Added:
 
-- Added new SQL error class to pass all errors related to DB query execution 
+- Added new SQL error class to pass all errors related to DB query execution
 
 ## New features with xsodata 3.4.0:
 
-### Added:  
+### Added:
 
 - Support for points "." in HANA table column names and consistently in OData property names.
-  This feature has been added for backward compatibility reasons only. The OData V2 specification does not allow the usage 
+  This feature has been added for backward compatibility reasons only. The OData V2 specification does not allow the usage
   of points for property names as points are used to separate namespace parts and names.
   So please consider not using it.
-  
+
 ### Changed
-  
+
 - Upgraded @sap/xssec and @sap/xsenv module dependencies
- 
+
 ## New features with xsodata 3.3.0:
 
-### Fixed:  
+### Fixed:
 
 - Removed failing sql calls to cleanup temporary tables, which become unnecessary with db patch 2.00.030.00.1515544046.
 - Numbers of type Edm.Int64 must be represented as string (e.g. "123") in json format even if they are within in the range of JS Number.
-   
+
 ## New features with xsodata 3.0.0:
 
 ### Added
@@ -300,7 +323,7 @@ exactly one single quote (e.g. '''' have been decoded wrongly to Json "" not to
 - Support Node.js 4.x.x, 6.x.x and newly 8.x.x
 
 ### Changed
- 
+
 - Updated dependencies
 - Improved content id handling in batch requests
 
@@ -328,13 +351,13 @@ exactly one single quote (e.g. '''' have been decoded wrongly to Json "" not to
 - Rollback performed also for non batch modifications
 
 ### Changed
- 
+
 - Updated dependencies
 
 ### Fixed
- 
+
 - Fixed __metadata Uri in payload: name/value key pairs are now correct
- 
+
 ## Modifications with SAP HANA XSA 2.0 SPS 2:
 
 ### Added

package/README.md

@@ -14,6 +14,9 @@ Note: XSOData was developed to provide XS Classic users using XSOData the possib
       For node.js we also provide an OData V4 solution. The development of the OData V4 node.js Library already started in 2016.
       It is also planned that a generic CDS-Odata provider will be deliverd.
 
+      If you are developing an OData service for SAP Business Technology Platform, it is recommended to move to the SAP Cloud Application Programming Model (CP).
+      The XSODATA solution supports HANA as a service, but does **NOT** support SAP HANA Cloud Services (see also SAP note 3013788).
+
 ## Usage
 
   * This module is used in the XSJS shim for SAP HANA XSC Engine applications to

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

@@ -247,7 +247,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 +336,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);
                     }
 
                 }

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) {
@@ -292,10 +305,13 @@ function _getLength(columnSqlType) {
 exports._getLength = _getLength;
 
 function _getType(type, defaultType = null) {
+
     if (type) {
         const i = type.indexOf('(');
         if (i > -1) {
             return type.substr(0, i);
+        } else {
+            return type;
         }
     }
 

package/lib/parsers/jison_segment_parser.js

@@ -241,7 +241,7 @@ parse: function parse(input) {
             }
             action = table[state] && table[state][symbol];
         }
-                    if (typeof action === 'undefined' || !action.length || !action[0]) {
+        if (typeof action === 'undefined' || !action.length || !action[0]) {
                 var errStr = '';
                 expected = [];
                 for (p in table[state]) {