@sap/xsodata 8.2.1 → 8.3.1

package/lib/http/conditionalHttpHandler.js

@@ -1,13 +1,13 @@
 "use strict";
 
-var StateMaschine = require('./../utils/stateMaschine');
-var PreconditionFailedError = require('./../utils/errors/http/preconditionFailed');
-var PreconditionRequiredError = require('./../utils/errors/http/preconditionRequired');
-var NotModifiedError = require('./../utils/errors/http/notModified');
-var BadRequestError = require('./../utils/errors/http/badRequest');
-var NotFoundError = require('./../utils/errors/http/notFound');
-var InternalError = require('./../utils/errors/internalError');
-var uriTypes = require('./../uri/uriType');
+const StateMaschine = require('./../utils/stateMaschine');
+const PreconditionFailedError = require('./../utils/errors/http/preconditionFailed');
+const PreconditionRequiredError = require('./../utils/errors/http/preconditionRequired');
+const NotModifiedError = require('./../utils/errors/http/notModified');
+const BadRequestError = require('./../utils/errors/http/badRequest');
+const NotFoundError = require('./../utils/errors/http/notFound');
+const InternalError = require('./../utils/errors/internalError');
+const uriTypes = require('./../uri/uriType');
 
 function debug(context, text, arg1) {
 	if (context && context.logger && context.logger.debug) {
@@ -24,7 +24,7 @@ module.exports = ConditionalHttpHandler;
  *@param {object} context Current xsodata context object
  */
 function ConditionalHttpHandler(context) {
-	var states = createStates();
+	const states = createStates();
 	this._stateMaschine = new StateMaschine(states, context);
 	this.on = this._stateMaschine.on.bind(this._stateMaschine);
 }
@@ -39,7 +39,7 @@ function ConditionalHttpHandler(context) {
 ConditionalHttpHandler.processConditionalRequest =
 	function processConditionalRequest(context, asyncDone) {
 
-    var handler = new ConditionalHttpHandler(context);
+    const handler = new ConditionalHttpHandler(context);
 
     handler.on("error", function (error) {
         asyncDone(error, context);
@@ -101,7 +101,7 @@ function createStates() {
 			"Is conditional request supported 1": {
 				// We need more than one kind of this state because there will be different outcomes
 				action: function () {
-					var isSupported = isConditionalRequestSupported(this.getExternalContext());
+					const isSupported = isConditionalRequestSupported(this.getExternalContext());
 					debug(this.getExternalContext(),"Is conditional request supported 1: ", isSupported);
 					if (isSupported === true) {
 						this.next("Is concurrent entity 1");
@@ -113,7 +113,7 @@ function createStates() {
 			"Is conditional request supported 2": {
 				action: function () {
 					// We need more than one kind of this state because there will be different outcomes
-					var isSupported = isConditionalRequestSupported(this.getExternalContext());
+					const isSupported = isConditionalRequestSupported(this.getExternalContext());
 					debug(this.getExternalContext(),"Is conditional request supported 2: ", isSupported);
 					if (isSupported) {
 						this.next("428 Precondition required");
@@ -125,7 +125,7 @@ function createStates() {
 			"Is conditional request supported 3": {
 				action: function () {
 					// We need more than one kind of this state because there will be different outcomes
-					var isSupported = isConditionalRequestSupported(this.getExternalContext());
+					const isSupported = isConditionalRequestSupported(this.getExternalContext());
 					debug(this.getExternalContext(),"Is conditional request supported 3: ", isSupported);
 					if (isSupported) {
 						this.next("Is concurrent entity 3");
@@ -137,7 +137,7 @@ function createStates() {
 			"Is concurrent entity 1": {
 				action: function () {
 					// We need more than one kind of this state because there will be different outcomes
-					var hasToken = hasConcurrencyToken(this.getExternalContext());
+					const hasToken = hasConcurrencyToken(this.getExternalContext());
 					debug(this.getExternalContext(),"Is concurrent entity 1: ", hasToken);
 					if (hasToken === true) {
 						this.next("Evaluate If-Match");
@@ -150,7 +150,7 @@ function createStates() {
 			"Is concurrent entity 2": {
 				action: function () {
 					// We need more than one kind of this state because there will be different outcomes
-					var hasToken = hasConcurrencyToken(this.getExternalContext());
+					const hasToken = hasConcurrencyToken(this.getExternalContext());
 					debug(this.getExternalContext(),"Is concurrent entity 2: ", hasToken);
 					if (hasToken === true) {
 						this.next("Is conditional request supported 2");
@@ -163,7 +163,7 @@ function createStates() {
 			"Is concurrent entity 3": {
 				action: function () {
 					// We need more than one kind of this state because there will be different outcomes
-					var hasToken = hasConcurrencyToken(this.getExternalContext());
+					const hasToken = hasConcurrencyToken(this.getExternalContext());
 					debug(this.getExternalContext(),"Is concurrent entity 3: ", hasToken);
 					if (hasToken === true) {
 						this.next("Evaluate If-None-Match");
@@ -175,8 +175,8 @@ function createStates() {
 			},
 			"Evaluate If-Match": {
 				action: function () {
-					var etagTemp,
-					ifMatchHeader = getHeader(this.getExternalContext(), "If-Match");
+					let etagTemp;
+					const ifMatchHeader = getHeader(this.getExternalContext(), "If-Match");
 
 					debug(this.getExternalContext(),"Evaluate If-Match");
 					debug(this.getExternalContext(),"    If-Match header: ", ifMatchHeader);
@@ -209,8 +209,8 @@ function createStates() {
 			},
 			"Evaluate If-None-Match": {
 				action: function () {
-					var etagTemp,
-					ifNoneMatchHeader = getHeader(this.getExternalContext(), "If-None-Match");
+					let etagTemp;
+					const ifNoneMatchHeader = getHeader(this.getExternalContext(), "If-None-Match");
 
 					debug(this.getExternalContext(),"Evaluate If-None-Match");
 					debug(this.getExternalContext(),"    If-None-Match header: ", ifNoneMatchHeader);
@@ -262,7 +262,7 @@ function createStates() {
 			},
 			"Is modification request": {
 				action: function () {
-					var isModification = isModificationRequest(this.getExternalContext());
+					const isModification = isModificationRequest(this.getExternalContext());
 					debug(this.getExternalContext(),"Is modification request: ", isModification);
 					if (isModification){
 						this.next("Is concurrent entity 2");
@@ -317,7 +317,7 @@ function createStates() {
 			"UnexpectedError": {
 				action: function (source, error) {
 					debug(this.getExternalContext(),"UnexpectedError occured", error);
-					var context = this.getExternalContext();
+					const context = this.getExternalContext();
 					throw new InternalError("Unexpected error", context, error);
 				}
 			}
@@ -358,7 +358,7 @@ function getHeader(context, name) {
  *@return {boolean} true if the request is kind of modification else false
  */
 function isModificationRequest(context) {
-	var method = context.request.method;
+	const method = context.request.method;
 	return method === "PUT" || method === "DELETE";
 }
 
@@ -370,11 +370,6 @@ function isModificationRequest(context) {
  *@return {boolean} true if the entity is a concurrent entity else false
  */
 function hasConcurrencyToken(context) {
-
-	// if (!context.oData.dbSegment || !context.oData.dbSegment.entityType) {
-	// 	return false;
-	// }
-
 	return context.oData.dbSegment.entityType.hasConcurrencyToken();
 }
 
@@ -388,7 +383,7 @@ function hasConcurrencyToken(context) {
  */
 function getEtag(context, callback) {
 	/*jshint validthis:true */
-	var self = this;
+	const self = this;
 	if (self._cachedEtag) {
 		callback(null, self._cachedEtag);
 	} else {
@@ -407,11 +402,9 @@ function getEtag(context, callback) {
  *@return {boolean} true if the request is supported else false
  */
 function isConditionalRequestSupported(context) {
-	var uriType = context.uriTree.uriType;
-	var isSupported = uriType === uriTypes.URI2 || uriType === uriTypes.URI5A ||
-		uriType === uriTypes.URI5B || uriType === uriTypes.URI6A;
-
-	isSupported = context.request.method !== "POST" && isSupported;
+	const uriType = context.uriTree.uriType;
+	const isSupported = context.request.method !== "POST" && (uriType === uriTypes.URI2 || uriType === uriTypes.URI5A ||
+		uriType === uriTypes.URI5B || uriType === uriTypes.URI6A);
 
 	return isSupported;
 }

package/lib/http/simpleHttpRequest.js

@@ -1,8 +1,8 @@
 "use strict";
 
-var _ = require('lodash');
-var utils = require('./../utils/utils');
-var bodyParser = require('body-parser');
+const _ = require('lodash');
+const utils = require('./../utils/utils');
+const bodyParser = require('body-parser');
 
 /**
  * Load the limit information from the xsodata file
@@ -21,7 +21,7 @@ function getLimit(context, name) {
 }
 
 module.exports.createRequest = function (originalRequest, context) {
-    var request = {
+    let request = {
         headers: {}
     };
 
@@ -57,13 +57,10 @@ module.exports.createRequest = function (originalRequest, context) {
             }
 
 
-            var parser = bodyParser.raw({ type: '*/*', limit: maxBodySize });
+            const parser = bodyParser.raw({ type: '*/*', limit: maxBodySize });
 
             parser(originalRequest, null, function next(err) {
-                //if (err) {
-                //    throw new BadRequest('Error while parsing http content', null, err);
-                //}
-                var body = originalRequest.body;
+                const body = originalRequest.body;
                 return cb(err, body.toString('utf8'));
             });
 
@@ -74,24 +71,23 @@ module.exports.createRequest = function (originalRequest, context) {
 };
 
 module.exports.createRequestFromAppHttp = function (appHttp, options) {
-    var request;
-    var appData = appHttp.rawData;
+    const appData = appHttp.rawData;
 
-    var s = appData.url.split(' ');
+    const s = appData.url.split(' ');
     if (s.length !== 3) {
         throw new Error('Invalid URI format inside batch request.');
     }
-    var method = s[0];
-    var uri = s[1];
-    var version = s[2];
+    const method = s[0];
+    let uri = s[1];
+    const version = s[2];
 
-    var body = appData.payload.join('\r\n');
+    const body = appData.payload.join('\r\n');
 
     if (uri.substr(0, 1) !== '/') {
         uri = '/' + uri;
     }
 
-    request = {
+    const request = {
         httpVersion: version,
         headers: utils.clone(appData.headers),
         method: method,
@@ -113,7 +109,7 @@ module.exports.createRequestFromAppHttp = function (appHttp, options) {
 };
 
 function createUrlData(request) {
-    var protocol = request.connection && request.connection.encrypted ? 'https' : 'http';
+    const protocol = request.connection && request.connection.encrypted ? 'https' : 'http';
 
     return {
         host: request.headers['x-forwarded-host'] || request.headers.host,

package/lib/http/simpleHttpResponse.js

@@ -1,7 +1,7 @@
 "use strict";
 
-var _ = require('lodash');
-var http = require('http');
+const _ = require('lodash');
+const http = require('http');
 
 module.exports.createResponse = function () {
     return new SimpleResponse();
@@ -13,6 +13,10 @@ function SimpleResponse() {
     this.data = '';
 }
 
+SimpleResponse.prototype._isBatchCRLFEnabled = function () {
+    return (typeof process !== 'undefined' && process.env && process.env.XSODATA_ENABLE_BATCH_CRLF === 'true');
+};
+
 SimpleResponse.prototype.writeHead = function (code, headers) {
     this.statusCode = code;
     _.assign(this.headers, headers);
@@ -37,8 +41,8 @@ SimpleResponse.prototype.end = function () {
 };
 
 SimpleResponse.prototype.writeToBatchResponse = function (response,contentId) {
-    var value;
-    var headers = this.headers;
+    let value;
+    const headers = this.headers;
     response.write('HTTP/1.1 ' + this.statusCode + ' ' + http.STATUS_CODES['' + this.statusCode] + '\r\n');
 
     Object.keys(headers).forEach(function (key) {
@@ -50,10 +54,9 @@ SimpleResponse.prototype.writeToBatchResponse = function (response,contentId) {
     }
     response.write('\r\n'); // end of header
     response.write(this.data);
-    if (this.data.length > 0 ) {
+    if (this._isBatchCRLFEnabled() && this.data.length > 0 ) {
         response.write('\r\n'); //as used in OData_Specification_V2.0 batch samples
     }
-
 };
 
 

package/lib/http/uriParser.js

@@ -16,13 +16,13 @@
  */
 
 //Includes
-var url = require('url');
-var Http404_NotFound = require('./../utils/errors/http/notFound');
-var _ = require('lodash');
-var Measurement = require('./../utils/measurement');
+const url = require('url');
+const Http404_NotFound = require('./../utils/errors/http/notFound');
+const _ = require('lodash');
+const Measurement = require('./../utils/measurement');
 
 function extractSegments(pathname) {
-    var i,
+    let i,
 	    s = pathname.split('/'),
 	    segments = {};
 
@@ -59,7 +59,7 @@ exports.prepareUri = function (context, asyncDone) {
     ///E.g. ///url
     context.logger.silly('http', 'prepareUri');
 
-    var uriTree = context.uriTree = {};
+    const uriTree = context.uriTree = {};
 
     uriTree.rawUrl = context.request.url;  //may contain a xsodata file in first segment or not
     uriTree.rawUrlParts = Measurement.measureSync(url.parse, uriTree.rawUrl, true, 'url.parse');
@@ -86,7 +86,7 @@ exports.prepareUri = function (context, asyncDone) {
         uriTree.segments.raw.shift();
 
         //build baseUrl
-        var urlData = {
+        const urlData = {
             protocol: context.request.urlData.proto,
             host: context.request.urlData.host,
             pathname: determineBasePath(context.request.baseUrl +  '/' + uriTree.xsoFile, uriTree.segments.decoded, context.request.urlData)
@@ -98,7 +98,7 @@ exports.prepareUri = function (context, asyncDone) {
 
     //USE Case this instance of the xsodata handler only processes a single xsodata file
     //so the name of this odata file MUST NOT inside the url
-    var tmp2 = {
+    const tmp2 = {
         protocol: context.request.urlData.proto,
         host: context.request.urlData.host,
         pathname: determineBasePath(context.request.baseUrl, uriTree.segments.decoded, context.request.urlData)
@@ -114,7 +114,7 @@ exports._getSegments = extractSegments;
 
 function determineBasePath(uriPrefix, urlSegmentsNoXso, urlData){
     if (urlData.forwarded){
-        var fSegs = extractSegments(urlData.path).decoded;
+        const fSegs = extractSegments(urlData.path).decoded;
         return _.dropRight(fSegs, urlSegmentsNoXso.length).join('/') + '/';
     }
 

package/lib/http/validator/httpRequestValidator.js

@@ -1,10 +1,10 @@
 'use strict';
 
-var async = require("async");
-var NotSupportedError = require("./../../utils/errors/http/notSupported");
-var contentTypeTools = require("./../../utils/checkContentType");
+const async = require("async");
+const NotSupportedError = require("./../../utils/errors/http/notSupported");
+const contentTypeTools = require("./../../utils/checkContentType");
 
-var api = module.exports = {
+const api = module.exports = {
     validate: validate,
     _validateHttpHeader: _validateHttpHeader,
     _validateAcceptHeader: _validateAcceptHeader
@@ -18,7 +18,7 @@ var api = module.exports = {
  *                       function(error, context){}
  */
 function validate(context, done) {
-    var validationStrategy = getValidationStrategy(context);
+    const validationStrategy = getValidationStrategy(context);
 
     context.logger.silly("httpRequestValidator", "validate");
 
@@ -53,14 +53,14 @@ function _validateHttpHeader(context, done) {
  *                       function(error, context){}
  */
 function _validateAcceptHeader(context, done) {
-    var acceptHeader = context.request.headers["accept"] || context.request.headers["Accept"];
+    const acceptHeader = context.request.headers["accept"] || context.request.headers["Accept"];
 
     context.logger.silly("httpRequestValidator", "validateAcceptHeader");
 
     if (!acceptHeader) {
         return done(new NotSupportedError("A valid http Accept header must be provided"));
     }
-    var contentType;
+    let contentType;
     try {
         contentType = contentTypeTools.checkEntry(context.request, getCustomFormat(context));
     } catch (ex) {
@@ -98,7 +98,7 @@ function isBatchRequest(context) {
  *@param {Object} context The xsodata context
  */
 function getValidationStrategy(context) {
-    var initialStrategy;
+    let initialStrategy;
 
     context.logger.silly("httpRequestValidator", "getValidationStrategy");
 
@@ -123,7 +123,7 @@ function getValidationStrategy(context) {
  * Returns value of the custom 'format' URL parameter.
  */
 function getCustomFormat(context) {
-    var queryParameters = context.uriTree.queryParameters;
+    const queryParameters = context.uriTree.queryParameters;
     if (queryParameters) {
         return queryParameters['format'];
     }

package/lib/model/annotationFactory.js

@@ -2,28 +2,28 @@
 
 // This module is used only internally from the entityType.js and is not intended to be used publicly.
 
-var EntityType = require('./entityType');
+const EntityType = require('./entityType');
 
 /**
  * Mapping of the values of SEMANTIC_TYPE column of the BIMC_DIMENSION_VIEW_HDI / BIMC_VARIABLE_VIEW_HDI DB views to
  * the values of sap:semantics OData annotation, which is added to the EDM properties. Only the values in the map are
  * supported.
  */
-var SEMANTIC_MAPPINGS = {
+const SEMANTIC_MAPPINGS = {
     "currencyCode": "currency-code",
     "unitOfMeasure": "unit-of-measure",
     "date.businessDateFrom": "dtstart",
     "date.businessDateTo": "dtend"
 };
 
-var NAVIGATION_PROPERTY_ANNOTATIONS = {
+const NAVIGATION_PROPERTY_ANNOTATIONS = {
     "sap:creatable": "false", // deep inserts are not supported
     "sap:filterable": "false" // for now, $filter is not supported for navigation properties
 };
 
 // Annotations for the association set, which connects CalcView input parameters (IP) entity set with the entity set
 // representing the CalcView results. Such associations cannot be modified, i.e. $links requests are not supported.
-var IP_ASSOCIATION_SET_ANNOTATIONS = {
+const IP_ASSOCIATION_SET_ANNOTATIONS = {
     "sap:creatable": "false",
     "sap:updatable": "false",
     "sap:deletable": "false"
@@ -55,7 +55,7 @@ exports.createPropertyAnnotations = createPropertyAnnotations;
  * }
  */
 function createPropertyAnnotations(entityType, property) {
-    var propertyAnnotations = {};
+    const propertyAnnotations = {};
 
     setPropertyParameter(property, propertyAnnotations);
     setPropertyDisplayFormat(property, propertyAnnotations);
@@ -88,9 +88,9 @@ function setPropertyDisplayFormat(property, propertyAnnotations) {
 
 function setPropertyLabel(property, propertyAnnotations) {
     // depending on the property's kind, the different DB column (of the different DB table) contains the description
-    var labelColumn = property.KIND === EntityType.entityKind.inputParameters ? "DESCRIPTION" : "COLUMN_CAPTION";
+    const labelColumn = property.KIND === EntityType.entityKind.inputParameters ? "DESCRIPTION" : "COLUMN_CAPTION";
 
-    var propertyLabel = property[labelColumn];
+    const propertyLabel = property[labelColumn];
 
     if (propertyLabel) {
         propertyAnnotations["sap:label"] = propertyLabel;
@@ -100,7 +100,7 @@ function setPropertyLabel(property, propertyAnnotations) {
 exports._setPropertySemantics = setPropertySemantics;
 
 function setPropertySemantics(property, propertyAnnotations) {
-    var odataSemantic;
+    let odataSemantic;
 
     if (!property.SEMANTIC_TYPE) {
         return;
@@ -143,7 +143,7 @@ function setPropertyText(property, propertyAnnotations) {
 exports._setPropertyFilterRestriction = setPropertyFilterRestriction;
 
 function setPropertyFilterRestriction(property, propertyAnnotations) {
-    var selectionType = property.SELECTION_TYPE,
+    const selectionType = property.SELECTION_TYPE,
         multiline = property.MULTILINE;
 
     if (selectionType === "SingleValue") {
@@ -173,7 +173,7 @@ exports.createEntityTypeAnnotations = createEntityTypeAnnotations;
  * }
  */
 function createEntityTypeAnnotations(entityType) {
-    var entityTypeAnnotations = {};
+    const entityTypeAnnotations = {};
 
     setEntityTypeSemantics(entityType, entityTypeAnnotations);
     return entityTypeAnnotations;
@@ -204,7 +204,7 @@ exports.createEntitySetAnnotations = createEntitySetAnnotations;
  * }
  */
 function createEntitySetAnnotations(entityType) {
-    var entitySetAnnotations = {};
+    const entitySetAnnotations = {};
 
     setEntitySetAddressable(entityType, entitySetAnnotations);
     setEntitySetCreatable(entityType, entitySetAnnotations);

package/lib/model/association.js

@@ -1,9 +1,9 @@
 'use strict';
 
 module.exports = Association;
-var utils = require('../utils/utils');
-var _ = require('lodash');
-var annotationFactory = require('./annotationFactory');
+const utils = require('../utils/utils');
+const _ = require('lodash');
+const annotationFactory = require('./annotationFactory');
 
 function Association(association) {
     _.assign(this, utils.clone(association));