@sap/xsodata 8.3.0 → 8.3.1

package/lib/model/entityType.js

@@ -16,15 +16,15 @@ EntityType.entityKind = {
 module.exports = EntityType;
 
 
-var utils = require('./../utils/utils');
-var generatedKey = require('../utils/keyGenerator');
-var typeConverter = require('./../utils/typeConverter');
-var concurrencyTokenValidator = require('./../model/validator/xsoDataConcurrencyTokenValidator');
-var annotationFactory = require('./annotationFactory');
-var util = require('util');
+const utils = require('./../utils/utils');
+const generatedKey = require('../utils/keyGenerator');
+const typeConverter = require('./../utils/typeConverter');
+const concurrencyTokenValidator = require('./../model/validator/xsoDataConcurrencyTokenValidator');
+const annotationFactory = require('./annotationFactory');
+const util = require('util');
 
 // see https://help.sap.com/viewer/88fe5f56472e40cca6ef3c3dcab4855b/2.0.05/en-US/d336ea064c0948ffa3ef84dd516d69af.html
-var CV_AGGREGATE_FUNCTIONS = {
+const CV_AGGREGATE_FUNCTIONS = {
     1: "sum",
     2: "count", // was avg before that was a bug
     3: "min",
@@ -141,21 +141,7 @@ function prepareAdmindata(settingsAdmindata, entityTypeAdmindata) {
     return ret;
 }
 
-/*
- EntityType.prototype.getName = function () {
- return this.name;
- };*/
-
 EntityType.prototype.getUriName = function () {
-    /*
-     if (this._entityType.parameters) {
-     if (this._entityType.parameters.entity) {
-     return this._entityType.parameters.entity;
-     } else {
-     return this.name + 'Parameters';
-     }
-
-     }*/
     return this.name;
 };
 
@@ -229,7 +215,7 @@ EntityType.prototype.getNavigation = function (propertyName) {
 };
 
 function determineKeys(entityType) {
-    var keys = {
+    const keys = {
         names: entityType.keys || []
     };
 
@@ -267,8 +253,7 @@ EntityType.prototype.calcKeyNamesOrdered = function () {
         return;
     }
 
-    for (var i = 0; i < this.propertyNames.length; i++) {
-        var propertyName = this.propertyNames[i];
+    for (const propertyName of this.propertyNames) {
         if (this.keys.names.indexOf(propertyName) > -1) {
             this.keyNamesOrdered.push(propertyName);
         }
@@ -284,7 +269,7 @@ EntityType.prototype.init = function (metadata, kind, tableStoreType, logger) {
     this.kind = kind;
 
     this.isInitialised = true;
-    var i;
+    let i;
 
     /**
      * List of this entities property names (according to with and without filter)
@@ -324,11 +309,11 @@ EntityType.prototype.init = function (metadata, kind, tableStoreType, logger) {
     this.converterMapToXMLPayload = {};
 
 
-    var dbColumns;
+    let dbColumns;
 
     //fill propertyNames
-    var propertyName;
-    var withh = this._entityType.properties.with;
+    let propertyName;
+    const withh = this._entityType.properties.with;
     if (withh) {
         dbColumns = this.__metadata.getColumnsMap();
         for (i = 0; i < withh.length; i++) {
@@ -339,15 +324,15 @@ EntityType.prototype.init = function (metadata, kind, tableStoreType, logger) {
                 this.propertiesMap[propertyName] = dbColumns[propertyName];
             } else {
                 logger.error('Unknown property: ' + propertyName);
-                throw('Unknown property');
+                throw(new Error('Unknown property'));
             }
         }
     } else {
         dbColumns = this.__metadata.getColumns();
-        var without = this._entityType.properties.without;
+        const without = this._entityType.properties.without;
         //Loop over all existing columns
         for (i = 0; i < dbColumns.length; i++) {
-            var column = dbColumns[i];
+            const column = dbColumns[i];
 
             if (without && without.indexOf(column.COLUMN_NAME) > -1) {
                 continue;
@@ -363,8 +348,8 @@ EntityType.prototype.init = function (metadata, kind, tableStoreType, logger) {
     this.resolveAggregates();
 
     //
-    var navigates = this._entityType.navigates;
-    for (var navName in navigates) {
+    const navigates = this._entityType.navigates;
+    for (const navName in navigates) {
         if (navigates.hasOwnProperty(navName)) {
             this.navPropertyNames.push(navName);
             this.navProperties.push(navigates[navName]);
@@ -394,7 +379,7 @@ EntityType.prototype.addProperty = function (colProperty, isKey) {
     this.propertiesMap[colProperty.COLUMN_NAME] = colProperty;
     this._addConverter(colProperty);
     if (isKey) {
-        var keys = this.keys || {};
+        const keys = this.keys || {};
         keys.names.unshift(colProperty.COLUMN_NAME);
         this.calcKeyNamesOrdered();
     }
@@ -403,7 +388,7 @@ EntityType.prototype.addProperty = function (colProperty, isKey) {
 EntityType.prototype.resolveAggregates = function () {
     this._aggregates = this._entityType.aggregates;
     if (this._aggregates && !Array.isArray(this._aggregates)) {
-        var _aggr_props = this.properties.filter(function (p) {
+        const _aggr_props = this.properties.filter(function (p) {
             return !!p.aggregate;
         });
         this._aggregates = _aggr_props.map(function (p) {
@@ -421,16 +406,15 @@ EntityType.prototype.setCalculationViewDimensionData = function (rows, calcView,
 
     this.calcView = calcView;
 
-    //var cv_properties = [];
-    var cv_propertiesMap = {};
-    var new_propertiesMap = {};
+    const cv_propertiesMap = {};
+    const new_propertiesMap = {};
 
     rows.forEach(function (row) {
         cv_propertiesMap[row.COLUMN_NAME] = row;
     });
 
     this.properties.forEach(function (p) {
-        var cvp = cv_propertiesMap[p.COLUMN_NAME];
+        const cvp = cv_propertiesMap[p.COLUMN_NAME];
 
         p.KIND = EntityType.entityKind.calculationView;
         new_propertiesMap[p.COLUMN_NAME] = p;
@@ -447,19 +431,6 @@ EntityType.prototype.setCalculationViewDimensionData = function (rows, calcView,
         }
     });
 
-    /*
-     rows.forEach(function (row) {
-        var property = self.propertiesMap[row.COLUMN_NAME];
-        if (!property) {
-            return;
-        }
-        property.aggregate = row.MEASURE_AGGREGATOR ? CV_AGGREGATE_FUNCTIONS[row.MEASURE_AGGREGATOR] : null;
-        property.KIND = EntityType.entityKind.calculationView;
-        cv_properties.push(property);
-        cv_propertiesMap[row.COLUMN_NAME] = property;
-     });
-     */
-
     this.propertiesMap = new_propertiesMap;
 };
 
@@ -471,20 +442,15 @@ EntityType.prototype.getParameters = function () {
     return this._entityType.parameters;
 };
 
-/*
- EntityType.prototype.getPropertyNames = function () {
- return this.propertyNames;
- };*/
-
 EntityType.prototype._addGenKeyConverter = function () {
-    var genKey = this.keys.generatedKey;
+    const genKey = this.keys.generatedKey;
     if (genKey) {
         this._addConverter(generatedKey.createGenKeyProperty(genKey));
     }
 };
 
 EntityType.prototype.getKeysOrGenKey = function () {
-    var genKey = this.keys.generatedKey;
+    const genKey = this.keys.generatedKey;
     if (genKey) {
         return [genKey];
     }
@@ -493,8 +459,8 @@ EntityType.prototype.getKeysOrGenKey = function () {
 };
 
 EntityType.prototype.getPropertiesWithGenKey = function getPropertiesWithGenKey() {
-    var genKey = this.keys.generatedKey;
-    var properties = this.properties;
+    const genKey = this.keys.generatedKey;
+    let properties = this.properties;
 
     if (genKey) {
         properties = [generatedKey.createGenKeyProperty(genKey)].concat(properties);
@@ -553,7 +519,7 @@ EntityType.prototype.getEntitySetAnnotations = function getEntitySetAnnotations(
  * }
  */
 EntityType.prototype.getPropertyAnnotations = function getPropertyAnnotations(propertyName) {
-    var property = this.getProperty(propertyName);
+    const property = this.getProperty(propertyName);
 
     if (!property._annotations) {
         property._annotations = annotationFactory.createPropertyAnnotations(this, property);
@@ -574,7 +540,7 @@ EntityType.prototype.getPropertyAnnotations = function getPropertyAnnotations(pr
  * }
  */
 EntityType.prototype.getNavigationPropertyAnnotations = function getNavigationPropertyAnnotations(navPropertyName) {
-    var navProperty = this.getNavigation(navPropertyName);
+    const navProperty = this.getNavigation(navPropertyName);
 
     if (!navProperty._annotations) {
         navProperty._annotations = annotationFactory.createNavigationPropertyAnnotations();
@@ -607,7 +573,7 @@ EntityType.prototype.getNavigationPropertyAnnotations = function getNavigationPr
  * @throws {Error} if propertyName is empty or there is no property with the specified name in the entity type
  */
 EntityType.prototype.getProperty = function getProperty(propertyName) {
-    var property;
+    let property;
 
     if (!propertyName) {
         throw new Error("Property name must be specified");
@@ -635,7 +601,7 @@ EntityType.prototype.getProperty = function getProperty(propertyName) {
  * @returns {boolean} If the property has attr. DIMENSION_TYPE with is set if there is an entry in BIMC_DIMENSION_VIEW
  */
 EntityType.prototype.isInBimcDimensionView = function isInBimcDimensionView(propertyName) {
-    var property = this.getProperty(propertyName);
+    const property = this.getProperty(propertyName);
     if (!property) {
         return false;
     }
@@ -651,7 +617,7 @@ EntityType.prototype.isInBimcDimensionView = function isInBimcDimensionView(prop
  * @returns {boolean} <code>true<code/> if the property is an aggregate property; otherwise - <code>false<code/>.
  */
 EntityType.prototype.isAggregateProperty = function isAggregateProperty(propertyName) {
-    var property = this.getProperty(propertyName),
+    let property = this.getProperty(propertyName),
         aggregates,
         aggregate,
         i;
@@ -692,7 +658,7 @@ function isMeasureProperty(property) {
  * @returns {boolean} <code>true<code/> if the entity type has measure properties; otherwise - <code>false<code/>.
  */
 EntityType.prototype.hasMeasureProperties = function hasMeasureProperties() {
-    var i,
+    let i,
         property;
 
     // only calculation views can have measure properties

package/lib/model/metadataReader.js

@@ -25,7 +25,7 @@ const dataCollector2 = require('./../sql/dataCollector2');
 function loadKeysForTable(context, entityType, cb) {
     context.logger.silly('model', 'loadKeysForTable for entity ' + entityType.name);
 
-    var processRows = function (err, rows) {
+    const processRows = function (err, rows) {
         if (logMetadata) {
             context.logger.silly('model', 'rows\n' + JSON.stringify(rows, null, 4));
         }
@@ -60,7 +60,7 @@ function loadKeysForTable(context, entityType, cb) {
 function loadTableInfo(context, entityType, tableStoreType, cb) {
     context.logger.silly("model", "loadTableInfo");
 
-    var processRows = function (err, rows) {
+    const processRows = function (err, rows) {
         try {
             if (logMetadata) {
                 context.logger.silly('model', 'rows\n' + JSON.stringify(rows, null, 4));
@@ -83,15 +83,15 @@ function loadTableInfo(context, entityType, tableStoreType, cb) {
                     return loadKeysForTable(context, entityType, cb);
                 }
             } else {
-                var genKey = entityType.keys.generatedKey;
+                const genKey = entityType.keys.generatedKey;
                 if (!genKey && entityType.keys.names.length === 0) {
                     return cb(new InternalError("Missing specification of keys for view.", context, null), context);
                 } else {
                     if (genKey) {
-                        var overwrittenColumn = entityType.propertiesMap[entityType.keys.generatedKey];
+                        const overwrittenColumn = entityType.propertiesMap[entityType.keys.generatedKey];
                         if (!!overwrittenColumn) {
                             // Provided generated key overwrites an existing column
-                            var msg = "Invalid generated key property '" + genKey + "'";
+                            let msg = "Invalid generated key property '" + genKey + "'";
                             msg += " in definition '" + overwrittenColumn.TABLE_NAME + "'.";
                             msg += " The generated key would overwrite an existing property";
                             return cb(
@@ -179,7 +179,7 @@ function loadCalcViewInfo(context, entityType, cb) {
         "where SCHEMA_NAME = ? AND QUALIFIED_NAME = ? " +
         'order by "ORDER"';
 
-    function processRows(err, rows) {
+    const processRows = function (err, rows) {
         if (logMetadata) {
             context.logger.silly('metadataReader', 'rows\n' + JSON.stringify(rows, null, 4));
         }
@@ -192,7 +192,7 @@ function loadCalcViewInfo(context, entityType, cb) {
             return cb(null, null);
         }
 
-        var cubeName = rows[0].CUBE_NAME;
+        const cubeName = rows[0].CUBE_NAME;
 
         entityType.setCalculationViewDimensionData(rows, { cube: cubeName }, context.logger); // e.g. sap:label is fill with calculation view dimension data
         entityType.resolveAggregates();
@@ -202,16 +202,16 @@ function loadCalcViewInfo(context, entityType, cb) {
             // 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;
+                    for (const entityProperty of entityType.properties) {
+                        if (entityProperty.COLUMN_NAME === property.DESC_NAME) {
+                            entityProperty.suppressAnnotationDimension = true;
                         }
                     }
                 }
             }
         });
 
-        var parameters = entityType.getParameters();
+        const parameters = entityType.getParameters();
         if (!parameters) {
             // entity not exposed as calcview
             return cb(null, entityType);
@@ -225,8 +225,7 @@ function loadCalcViewInfo(context, entityType, cb) {
             }
             return cb(null, entityType);
         });
-
-    }
+    };
 
     /*
      Example mapping :
@@ -296,10 +295,10 @@ function loadInputParameters(parameters, entityType, context, cb) {
         });
 
         try {
-            var paramEntityType = loadInputParametersEntity(parameters, entityType, context, rows);
+            const paramEntityType = loadInputParametersEntity(parameters, entityType, context, rows);
             if (parameters.viaKey) {
                 /*this is called */
-                loadInputParametersViaKey(entityType, paramEntityType, context);
+                loadInputParametersViaKey(entityType, paramEntityType);
             }
         } catch (err_process) {
             err = err_process;
@@ -312,7 +311,7 @@ function loadInputParameters(parameters, entityType, context, cb) {
 
 
 function _getLength(columnSqlType) {
-    const n = columnSqlType.match(/^\w+\(([0-9]+)\)$/);
+    const n = columnSqlType.match(/^\w+\((\d+)\)$/);
     if (n) {
         return Number.parseInt(n[1]);
     }
@@ -338,37 +337,17 @@ function _getType(type, defaultType = null) {
 
 exports._getType = _getType;
 
-/*
-function _getTypeLengthScale(type, defaultType = null) {
-    if (type) {
-        const n = type.match(/^(\w+)(\(([0-9]+)(,([0-9]+))?\))?$/);
-        if (n) {
-            return {
-                type: n[1],
-                length: Number.parseInt(n[3]) || null,
-                scale :  Number.parseInt(n[5]) || null
-            };
-        }
-    }
-    return {
-        type: defaultType|| 'NVARCHAR',
-        length: null,
-        scale: null
-    };
-}
-*/
-
 function loadInputParametersEntity(parameters, entityType, context, rows) {
-    var paramEntityName = parameters.entity;
+    let paramEntityName = parameters.entity;
     if (!paramEntityName || paramEntityName.trim() === '') {
         //No name, use default naming
         paramEntityName = entityType.name + 'Parameters';
     }
 
-    var resultsProp = parameters.resultProperty || 'Results';
-    var assocName = paramEntityName + '_to_' + entityType.name;
+    const resultsProp = parameters.resultProperty || 'Results';
+    let assocName = paramEntityName + '_to_' + entityType.name;
 
-    var _et = {
+    const _et = {
         name: paramEntityName,
         properties: {},
         navigates: {},
@@ -385,10 +364,9 @@ function loadInputParametersEntity(parameters, entityType, context, rows) {
         }
     };
 
-    var paramEntityType = new EntityType(_et);
+    const paramEntityType = new EntityType(_et);
 
-    var mrows = rows.map(function (row) {
-        //const typeLengthScale = _getTypeLengthScale(row.COLUMN_SQL_TYPE, row.COLUMN_TYPE_D );
+    const mrows = rows.map(function (row) {
         const type = _getType(row.COLUMN_SQL_TYPE, row.COLUMN_TYPE_D);
         const metadata = {
             KIND: model.entityKind.inputParameters,
@@ -410,7 +388,7 @@ function loadInputParametersEntity(parameters, entityType, context, rows) {
     });
 
     assocName = paramEntityName + '_to_' + entityType.name;
-    var association = new Association({
+    const association = new Association({
         name: assocName,
         principal: {
             type: paramEntityName,
@@ -434,7 +412,7 @@ function loadInputParametersEntity(parameters, entityType, context, rows) {
 
 
 function loadInputParametersViaKey(entityType, paramEntityType) {
-    var pvalues = _.values(paramEntityType.propertiesMap);
+    const pvalues = _.values(paramEntityType.propertiesMap);
     pvalues.forEach(function (pv) {
         entityType.addProperty(pv, true);
     });
@@ -611,7 +589,7 @@ function processSynonymTableType(context, entityType, tableName, callback) {
  * @param {Function} callback - callback function, which is called when the operation is completed.
  */
 function processTableType(error, dbRows, context, tableName, callback) {
-    var isColumnStoreType,
+    let isColumnStoreType,
         tableStoreType;
 
     if (error) {
@@ -642,7 +620,7 @@ function createLockeEntityID(context, entityType) {
 
 
 function loadEntityTypeOnce(context, entityType, cbErr) {
-    var lockEntityID = createLockeEntityID(context, entityType);
+    const lockEntityID = createLockeEntityID(context, entityType);
 
     if (entityType.isInitialised) {
         //access to __metadata is writelooked, so __metadata is definitively filled here
@@ -660,7 +638,7 @@ function loadEntityTypeOnce(context, entityType, cbErr) {
             return cbErr();
         }
 
-        var load = function (err, context) {
+        const load = function (err, context) {
             if (err) {
                 release();
                 return cbErr(err);
@@ -673,7 +651,7 @@ function loadEntityTypeOnce(context, entityType, cbErr) {
         };
         try {
             if (Measurement.isActive()) {
-                var callConnect = utils.tryAndMeasure(db.connect, 'dbConnect');
+                const callConnect = utils.tryAndMeasure(db.connect, 'dbConnect');
                 return callConnect(context, load);
             } else {
                 return db.connect(context, load);
@@ -689,16 +667,17 @@ exports.loadModelMetadata = function (context, asyncDone) {
 
     context.logger.silly('model', 'load metadata');
 
-    var entityTypes = context.gModel.getEntityTypes();
+    const entityTypes = context.gModel.getEntityTypes();
+    let parent;
 
     if (Measurement.isActive()) { // perform an explicit measurement
-        var parent = Measurement.getRunningMeasurement();
+        parent = Measurement.getRunningMeasurement();
     }
 
     async.mapSeries(
         entityTypes,
         function (entityType, cbMapLimit) {
-            var child;
+            let child;
             try {
                 if (Measurement.isActive() && !context.batchContext) {
                     child = parent.newChild(entityType.name);

package/lib/model/model.js

@@ -36,7 +36,6 @@ let Model = function Model(xsodata) {
     this._entityTypesMap = {};
     this._entityTypesMapUriId = {};
 
-    //var entityTypeName = '';
     for (property in this._service.entityTypes) {
         if (this._service.entityTypes.hasOwnProperty(property)) {
             let entityType = new EntityType(this._service.entityTypes[property], this._settings);

package/lib/model/validator/xsoDataConcurrencyTokenValidator.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var lodash = require('lodash');
+const lodash = require('lodash');
 
 /**
  * Exports the api
@@ -21,7 +21,7 @@ module.exports = {
  */
 function validate(context, callback) {
 
-    var entityTypes = context.gModel._entityTypesMap;
+    const entityTypes = context.gModel._entityTypesMap;
 
     try {
         validateDefaults(entityTypes);
@@ -88,7 +88,7 @@ function validateHasNotKeyPropertyTokenKey(entityTypes) {
 
     findConcurrencyTokenConflicts(entityTypes, "keys.names", function (entityType, intersection) {
 
-        var isInvalidKey = entityType.hasConcurrentProperties() &&
+        const isInvalidKey = entityType.hasConcurrentProperties() &&
             entityType.isConcurrentProperty(entityType.keys.generatedKey);
 
         if (isInvalidKey) {
@@ -120,9 +120,9 @@ function findConcurrencyTokenConflicts(entityTypes, comparableChildPropertyPath,
 
     return lodash.chain(entityTypes)
         .reduce(function (result, entityType) {
-            var comparableKeys;
-            var intersection;
-            var tokenKeys;
+            let comparableKeys;
+            let intersection;
+            let tokenKeys;
         
             comparableKeys = lodash.chain(entityType).get(comparableChildPropertyPath).value();
             if (comparableKeys && !Array.isArray(comparableKeys)) {