feat: allow streams as request data

Author: aacerox

.gitignore

@@ -17,3 +17,5 @@ mocha-eclipse.js
 *.sublime-project
 *.sublime-workspace
 *.code-workspace
+.vscode/*
+

lib/NrcConnectManager.js

@@ -2,6 +2,7 @@
 import followRedirect from 'follow-redirects';
 import zlib from 'zlib';
 import debug from './NrcDebugger.js';
+import stream from 'stream';
 
 
 const {http, https} = followRedirect;
@@ -121,16 +122,7 @@ export class NrcConnectManager {
       self.#configureRequest(request, requestConfig, clientRequest);
       clientRequest.setHttpRequest(request);
 
-      // write POST/PUT data to request body;
-      // find valid serializer to be used to serialize request data,
-      // first one found
-      // is the one to be used.if none found for match condition,
-      // default serializer is used
-      if (options.data) {
-        request.write(options.data);
-      }
-
-      request.end();
+      self.#writeRequest(options.data, request);
 
       // handle request errors and handle them by request or general
       // error handler
@@ -204,15 +196,9 @@ export class NrcConnectManager {
     clientRequest.setHttpRequest(request);
 
     debug('options data', options.data);
-    // write POST/PUT data to request body;
-    // find valid serializer to be used to serialize request data,
-    // first one found
-    // is the one to be used.if none found for match condition,
-    // default serializer is used
-    if (options.data) {
-      request.write(options.data);
-    }
-    request.end(); // end request when data is written
+
+
+    this.#writeRequest(options.data, request);
 
     // handle request errors and handle them by request or general
     // error handler
@@ -230,6 +216,38 @@ export class NrcConnectManager {
     });
   }
 
+
+  /**
+     * Description placeholder
+     * @date 10/19/2023 - 7:06:36 PM
+     *
+     * @param {*} data
+     * @param {*} request
+     */
+  #writeRequest(data, request) {
+    if (data) {
+      if (data instanceof stream) {
+        // close request when stream ends
+        data.pipe(request);
+        data.on('end', ()=>{
+          request.end();
+          data.close();
+        });
+      } else {
+        // write POST/PUT data to request body;
+        // find valid serializer to be used to serialize request data,
+        // first one found
+        // is the one to be used.if none found for match condition,
+        // default serializer is used
+        request.write(data);
+        request.end();
+      }
+    } else {
+      // no data, end request
+      request.end();
+    }
+  }
+
   /**
    * prepare request using global or method config
    * @author aacerox

lib/NrcIoManager.js

@@ -4,6 +4,7 @@ import urlParser from 'url';
 import NrcClientRequest from './NrcClientRequest.js';
 import events from 'events';
 import debug from './NrcDebugger.js';
+import stream from 'stream';
 
 // declare ioManager constants
 const CONSTANTS = {
@@ -523,7 +524,11 @@ export default class NrcIoManager extends events.EventEmitter {
 
       // always set Content-length header if not set previously
       // set Content length for some servers to work (nginx, apache)
-      if (
+
+      if (args.data instanceof stream) {
+        // if data is stream redirect to options to be used
+        options.data = args.data;
+      } else if (
         args.data !== undefined &&
         !options.headers.hasOwnProperty(CONSTANTS.HEADER_CONTENT_LENGTH)
       ) {

package-lock.json

@@ -36,7 +36,7 @@
   },
   "scripts": {
     "build": "rm -fr dist/* && tsc -p tsconfig.json && tsc -p tsconfig-cjs.json && bash ./fixup",
-    "test": "mocha --exit",
+    "test": "npm run build && mocha --exit",
     "changeset": "changeset",
     "publish:packages": "changeset publish",
     "version:packages": "changeset version"

package.json

@@ -0,0 +1,23 @@
+Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris.
+Nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor.
+In reprehenderit in voluptate velit esse cillum dolore eu fugiat.
+Nulla pariatur. Excepteur sint occaecat cupidatat non proident.
+Sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris.
+Nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor.
+In reprehenderit in voluptate velit esse cillum dolore eu fugiat.
+Nulla pariatur. Excepteur sint occaecat cupidatat non proident.
+Sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris.
+Nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor.
+In reprehenderit in voluptate velit esse cillum dolore eu fugiat.
+Nulla pariatur. Excepteur sint occaecat cupidatat non proident.
+Sunt in culpa qui officia deserunt mollit anim id est laborum.

test/resources/stream-file.txt

@@ -161,6 +161,19 @@ const RouteManager = {
       res.write(JSON.stringify(message));
       res.end();
     },
+    '/stream': function(req, res) {
+      let requestBody = '';
+
+      req.on('data', (chunk) => requestBody +=chunk);
+
+      req.on('end', function(data) {
+        res.writeHead(200, {
+          'Content-Type': 'text/plain',
+        });
+        res.write(requestBody);
+        res.end();
+      });
+    },
 
   },
   'sleep': function(ms) {

test/server/mock-server.mjs

@@ -1,6 +1,8 @@
 /* eslint-disable max-len */
 import server from '../server/mock-server.mjs';
 import Client from '../../dist/mjs/NodeRestClient.js';
+import {createReadStream, readFileSync} from 'fs';
+
 
 describe('POST Method', function() {
   // eslint-disable-next-line no-invalid-this
@@ -228,6 +230,28 @@ describe('POST Method', function() {
     });
   });
 
+  describe('#STREAM', function() {
+    it('POST request with file read stream', function(done) {
+      const client = new Client();
+
+      // create read stream from file
+      const testFilePath = './test/resources/stream-file.txt';
+      const sourceData = readFileSync(testFilePath);
+      const sourceStream = createReadStream(testFilePath);
+
+
+      client.post(
+          server.baseURL + '/stream',
+          {data: sourceStream},
+          function(data, response) {
+            response.statusCode.should.be.equal(200);
+            data.toString().should.equal(sourceData.toString());
+            done();
+          },
+      );
+    });
+  });
+
   after(function() {
     server.close();
     console.log('server stopped');

test/specs/TestPOSTMethod.mjs

@@ -191,15 +191,6 @@ describe('IO Facade', function() {
         serializedCallback(JSON.stringify(data));
       },
     };
-    const defaultTestSerializer = {'name': 'default-test-serializer',
-      'isDefault': true,
-      'serialize': function(data, nrcEventEmitter, serializedCallback) {
-        if (typeof data === 'object') {
-          data.defaultParsed = true;
-        }
-        serializedCallback(data);
-      },
-    };
 
 
     it('add invalid serializer to client', function(done) {
@@ -260,6 +251,7 @@ describe('IO Facade', function() {
         data.postData.includes('serialized').should.be.true();
       });
 
+      request.should.not.be.null();
       done();
     });
 
@@ -300,6 +292,9 @@ describe('IO Facade', function() {
 
   after(function() {
     server.close();
-    console.log('server stopped');
+    // server will respond with ECONNRESET if we do not wait her
+    setTimeout(() => {
+      console.log('server stopped');
+    }, 500 );
   });
 });