@sap/async-xsjs 1.0.3 → 1.0.5

package/CHANGELOG.md

@@ -5,6 +5,20 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+<a name="1.0.5"></a>
+## 1.0.5 - 2023-06-08
+
+### Fixed
+- Replace deprecated _request_ with _axios_ v1.3.5
+
+
+<a name="1.0.4"></a>
+## 1.0.4 - 2023-03-28
+
+### Updated
+- Updated hana-client to v2.16.21
+- Updated hdbext to v7.7.3
+
 <a name="1.0.3"></a>
 ## 1.0.3 - 2023-02-07
 

package/README.md

@@ -49,10 +49,15 @@ var options = xsenv.getServices({
     secureStore: 'secureStore',
     auditLog: 'audit-log'
 });
-var xsjs_server = await async_xsjs(options);
-await xsjs_server.listen(port);
-
-console.log('Node XS server listening on port %d', port);
+async_xsjs(options).then((async_xsjs_server)=>{
+  async_xsjs_server.listen(port, (err)=>{
+    if(!err) {
+      console.log('Node XS server listening on port %d', port);
+    }else{
+      console.log('Node XS server failed to start on port %d', port);
+    }
+  });
+});
 ```
 
 The starting function takes an object that contains service credentials and application options.

package/lib/xsjs/net/http/Client.js

@@ -2,12 +2,15 @@
 
 var util = require('util');
 var qs = require('querystring');
-var requestLib = require('request');
+var axios = require('axios');
 var _ = require('lodash');
 var SAPPassport = require('@sap/e2e-trace').Passport;
 var WebResponse = require('../../web/WebResponse');
+var CRLF = require('../../constants').WEB.MESSAGES.LINE_BREAK;
 var MultipartResponseBuilder = require('../../web/utils/MultipartResponseBuilder');
 var contentTypeParser = require('content-type');
+var stream = require('stream');
+var URL = require('url').URL;
 
 var methodMapping = {
   // -1: 'INVALID',
@@ -65,15 +68,19 @@ Client.prototype.request = function (arg0, arg1, proxyOpt) {
   if (this._timeoutInMilliseconds) {
     options.timeout = this._timeoutInMilliseconds;
   }
-  this._response = new Promise ((resolve, reject) => {
-    requestLib(options, function(err, response) {
-      if (err) {
-        reject(err);
-        return;
-      }
-      resolve(response);
-    });
-  });
+
+  options.validateStatus = function (status) {
+    // succesfully resolve the promise for all status codes,
+    // otherwise an error is thrown which is incompatible with the current WebResponse logic
+    return status > 0;
+  };
+  this._response = axios.request(options)
+      .then(response => {
+        return response;
+      })
+      .catch(error => {
+        throw error;
+      });
   return this;
 };
 
@@ -134,19 +141,46 @@ function handleEntities(options, webRequest) {
     }
 
     if (multiPartHeader.indexOf('related') > -1) {
-      options.multipart = [];
-      webRequest.entities.forEach(entity => {
-        options.multipart.push({
-          'content-type': entity.contentType,
-          body: entity.body._content
-        });
-      });
+
+      options.data = buildMultipartRelatedData(webRequest, boundary);
     } else {
       throw new Error('Multipart/form-data and Multi-part/mixed are not supported!');
     }
   }
 }
 
+function buildMultipartRelatedData(webRequest, boundary) {
+  const finale = `--${boundary}--`;
+  const dataStream = new stream.PassThrough();
+  let isStream = false;
+  webRequest.entities.forEach(entity => {
+    const preamble = `--${boundary}${CRLF}`;
+    dataStream.push(preamble);
+    if (entity.contentType) {
+      dataStream.push(`content-type: ${entity.contentType}${CRLF}`);
+    }
+    dataStream.push(CRLF);
+    let body = entity.body._content;
+    if (body instanceof stream.Stream) {
+      isStream = true;
+      body.pipe(dataStream, {end: false});
+      body.on('end', () => {
+        dataStream.push(CRLF);
+        dataStream.push(finale);
+        dataStream.push(null);
+      });
+    } else {
+      dataStream.push(body);
+      dataStream.push(CRLF);
+    }
+  });
+  if (!isStream) {
+    dataStream.push(finale);
+    dataStream.push(null);
+  }
+  return dataStream;
+}
+
 function addPath(options, webRequest) {
   if (webRequest.path) {
     if (options.url.charAt(options.url.length - 1) !== '/' && webRequest.path.charAt(0) !== '/') {
@@ -181,14 +215,15 @@ function addCookies(options, webRequest) {
 
 function addBody(options, webRequest) {
   if (options.method === 'POST' || options.method === 'PUT' || options.method === 'PATCH') {
-    options.body = webRequest.body._content;
-    options.json = false;
+    options.data = options.data || webRequest.body._content;
+    options.responseType = 'text';
   }
 }
 
+
 function setProxy(options, proxyOpt) {
   if (proxyOpt) {
-    options.proxy = proxyOpt;
+    options.proxy = new URL(proxyOpt);
   }
 }
 
@@ -203,7 +238,7 @@ function addPathPrefix(options, destination) {
 
 function setProxyFromDestination(options, destination) {
   if (destination.useProxy === true) {
-    return options.proxy = 'http://' + destination.proxyHost + ':' + destination.proxyPort;
+    return options.proxy = new URL('http://' + destination.proxyHost + ':' + destination.proxyPort);
   }
   // explicitly disable proxy
   if (destination.useProxy === false) {
@@ -213,7 +248,7 @@ function setProxyFromDestination(options, destination) {
 
 function setBasicAuthFromDestination(options, destination) {
   if (destination.authType === 'basic') {
-    options.auth = { user: destination.username, pass: destination.password };
+    options.auth = { username: destination.username, password: destination.password };
   }
 }
 

package/lib/xsjs/web/WebResponse.js

@@ -19,7 +19,6 @@ module.exports = WebResponse;
 
 function WebResponse(res, followUpContext) {
   WebEntityResponse.call(this, res);
-
   if (!res) {
     this.cookies = new CookiesTupelList();
     this.status = 200;
@@ -28,9 +27,12 @@ function WebResponse(res, followUpContext) {
     setBodyOrEntities(this, res);
     this.cookies = new CookiesTupelList();
     this.cookies._addData(extractCookies(res));
-    this.status = res.statusCode;
-    this.statusMessage = status[res.statusCode];
-    this._httpVersion = 'HTTP/' + res.httpVersion;
+    var statusCode = res.statusCode || res.status;
+    this.status = statusCode;
+    this.statusMessage = status[statusCode];
+    var httpVersion = (res.req && res.req.httpVersion) || (res.request &&
+        ((res.request.res && res.request.res.httpVersion) || (res.request.response && res.request.response.httpVersion)));
+    this._httpVersion = 'HTTP/' + httpVersion;
   }
 
   if (followUpContext) {
@@ -75,10 +77,10 @@ function normalizeResponseHeaders(webResponse) {
 function setBodyOrEntities(webResponse, internalResponse) {
   var boundary = extractBoundaryOfMultipartResponse(webResponse);
   if (boundary) {
-    MultipartParser.parseFromBuffer(internalResponse.body, boundary, webResponse, MESSAGE_TYPE.RESPONSE);
+    MultipartParser.parseFromBuffer(internalResponse.data, boundary, webResponse, MESSAGE_TYPE.RESPONSE);
     webResponse.body = undefined;
   } else {
-    internalResponse.body && webResponse.setBody(internalResponse.body);
+    internalResponse.data && webResponse.setBody(internalResponse.data);
   }
 }