loadtest 6.3.1 → 6.4.0

package/README.md

@@ -300,30 +300,9 @@ Setting this to 0 disables timeout (default).
 
 #### `-R requestGeneratorModule.js`
 
-Use custom request generator function from an external file.
-
-Example request generator module could look like this:
-
-```javascript
-module.exports = function(params, options, client, callback) {
-  generateMessageAsync(function(message) {
-
-    if (message)
-    {
-      options.headers['Content-Length'] = message.length;
-      options.headers['Content-Type'] = 'application/x-www-form-urlencoded';
-    }
-    request = client(options, callback);
-    if (message){
-      request.write(message);
-    }
-
-    return request;
-  }
-}
-```
-
-See [`sample/request-generator.js`](sample/request-generator.js) for some sample code including a body
+Use a custom request generator function from an external file.
+See an example of a request generator module in [`--requestGenerator`](#requestGenerator) below.
+Also see [`sample/request-generator.js`](sample/request-generator.js) for some sample code including a body
 (or [`sample/request-generator.ts`](sample/request-generator.ts) for ES6/TypeScript).
 
 #### `--agent` (deprecated)
@@ -532,7 +511,6 @@ const options = {
 const result = await loadTest(options)
 result.show()
 console.log('Tests run successfully')
-})
 ```
 
 The call returns a `Result` object that contains all info about the load test, also described below.
@@ -665,24 +643,20 @@ How many requests each client will send per second.
 
 #### `requestGenerator`
 
-Custom request generator function.
+Use a custom request generator function.
+The request needs to be generated synchronously and returned when this function is invoked.
 
 Example request generator function could look like this:
 
 ```javascript
 function(params, options, client, callback) {
-  generateMessageAsync(function(message)) {
-    request = client(options, callback);
-
-    if (message)
-    {
-      options.headers['Content-Length'] = message.length;
-      options.headers['Content-Type'] = 'application/x-www-form-urlencoded';
-      request.write(message);
-    }
-
-    request.end();
-  }
+  const message = generateMessage();
+  const request = client(options, callback);
+  options.headers['Content-Length'] = message.length;
+  options.headers['Content-Type'] = 'application/x-www-form-urlencoded';
+  request.write(message);
+  request.end();
+  return request;
 }
 ```
 
@@ -909,6 +883,11 @@ Return an HTTP error code.
 Return an HTTP error code only for the given % of requests.
 If no error code was specified, default is 500.
 
+#### `logger`
+
+A function to be called as `logger(request, response)` after every request served by the test server.
+Where `request` and `response` are the usual HTTP objects.
+
 ### Configuration file
 
 It is possible to put configuration options in a file named `.loadtestrc` in your working directory or in a file whose name is specified in the `loadtest` entry of your `package.json`. The options in the file will be used only if they are not specified in the command line.

package/lib/httpClient.js

@@ -9,6 +9,8 @@ import * as agentkeepalive from 'agentkeepalive'
 import * as HttpsProxyAgent from 'https-proxy-agent'
 
 
+let uniqueIndex = 1
+
 /**
  * Create a new HTTP client.
  * Seem parameters below.
@@ -90,6 +92,19 @@ class HttpClient {
 		if (this.params.secureProtocol) {
 			this.options.secureProtocol = this.params.secureProtocol;
 		}
+		// adding proxy configuration
+		if (this.params.proxy) {
+			const proxy = this.params.proxy;
+			const agent = new HttpsProxyAgent(proxy);
+			this.options.agent = agent;
+		}
+		if (this.params.indexParam) {
+			this.options.indexParamFinder = new RegExp(this.params.indexParam, 'g');
+		}
+		// Disable certificate checking
+		if (this.params.insecure === true) {
+			process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
+		}
 	}
 
 	/**
@@ -129,43 +144,10 @@ class HttpClient {
 		this.operation.requests += 1;
 
 		const id = this.operation.latency.start();
+		const options = {...this.options, headers: {...this.options.headers}}
 		const requestFinished = this.getRequestFinisher(id);
-		let lib = http;
-		if (this.options.protocol == 'https:') {
-			lib = https;
-		}
-		if (this.options.protocol == 'ws:') {
-			lib = websocket;
-		}
-
-		// adding proxy configuration
-		if (this.params.proxy) {
-			const proxy = this.params.proxy;
-			const agent = new HttpsProxyAgent(proxy);
-			this.options.agent = agent;
-		}
-
-
-		// Disable certificate checking
-		if (this.params.insecure === true) {
-			process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
-		}
-		let request, message;
-		if (this.generateMessage) {
-			message = this.generateMessage(id);
-			if (typeof message === 'object') {
-				message = JSON.stringify(message);
-			}
-			this.options.headers['Content-Length'] = Buffer.byteLength(message);
-		} else {
-			delete this.options.headers['Content-Length'];
-		}
-		if (typeof this.params.requestGenerator == 'function') {
-			const connect = this.getConnect(id, requestFinished, this.params.contentInspector)
-			request = this.params.requestGenerator(this.params, this.options, lib.request, connect);
-		} else {
-			request = lib.request(this.options, this.getConnect(id, requestFinished, this.params.contentInspector));
-		}
+		this.customizeIndex(options)
+		const request = this.getRequest(id, options, requestFinished)
 		if (this.params.timeout) {
 			const timeout = parseInt(this.params.timeout);
 			if (!timeout) {
@@ -175,8 +157,10 @@ class HttpClient {
 				requestFinished('Connection timed out');
 			});
 		}
+		const message = this.getMessage(id, options)
 		if (message) {
 			request.write(message);
+			options.headers['Content-Length'] = Buffer.byteLength(message);
 		}
 		request.on('error', error => {
 			requestFinished('Connection error: ' + error.message);
@@ -184,6 +168,54 @@ class HttpClient {
 		request.end();
 	}
 
+	customizeIndex(options) {
+		if (!this.options.indexParamFinder) {
+			return
+		}
+		options.customIndex = this.getCustomIndex()
+		options.path = this.options.path.replace(this.options.indexParamFinder, options.customIndex);
+	}
+
+	getCustomIndex() {
+		if (this.options.indexParamCallback instanceof Function) {
+			return this.options.indexParamCallback();
+		}
+		const customIndex = uniqueIndex
+		uniqueIndex += 1
+		return customIndex
+	}
+
+	getLib() {
+		if (this.options.protocol == 'https:') {
+			return https;
+		}
+		if (this.options.protocol == 'ws:') {
+			return websocket;
+		}
+		return http;
+	}
+
+	getMessage(id, options) {
+		if (!this.generateMessage) {
+			return
+		}
+		const candidate = this.generateMessage(id);
+		const message = typeof candidate === 'object' ? JSON.stringify(candidate) : candidate
+		if (this.options.indexParamFinder) {
+			return message.replace(this.options.indexParamFinder, options.customIndex);
+		}
+		return message
+	}
+
+	getRequest(id, options, requestFinished) {
+		const lib = this.getLib()
+		if (typeof this.params.requestGenerator == 'function') {
+			const connect = this.getConnect(id, requestFinished, this.params.contentInspector)
+			return this.params.requestGenerator(this.params, options, lib.request, connect);
+		}
+		return lib.request(options, this.getConnect(id, requestFinished, this.params.contentInspector));
+	}
+
 	/**
 	 * Get a function that finishes one request and goes for the next.
 	 */

package/lib/loadtest.js

@@ -23,7 +23,7 @@ https.globalAgent.maxSockets = 1000;
  *	 - cookies [array]: a string or an array of strings, each with name:value.
  *	 - headers [map]: a map with headers: {key1: value1, key2: value2}.
  *	 - method [string]: the method to use: POST, PUT. Default: GET, what else.
- *	 - body [string]: the contents to send along a POST or PUT request.
+ *	 - data [string]: the contents to send along a POST or PUT request.
  *	 - contentType [string]: the MIME type to use for the body, default text/plain.
  *	 - requestsPerSecond [number]: how many requests per second to send.
  *	 - agentKeepAlive: if true, then use connection keep-alive.
@@ -33,6 +33,7 @@ https.globalAgent.maxSockets = 1000;
  *	 - proxy [string]: use a proxy for requests e.g. http://localhost:8080.
  *	 - quiet: do not log any messages.
  *	 - debug: show debug messages (deprecated).
+ *	 - requestGenerator [function]: use a custom function to generate requests.
  * - `callback`: optional `function(result, error)` called if/when the test finishes;
  * if not present a promise is returned.
  */
@@ -117,33 +118,9 @@ class Operation {
 	 * Start a number of measuring clients.
 	 */
 	startClients() {
-		const url = this.options.url;
-		const strBody = JSON.stringify(this.options.body);
 		for (let index = 0; index < this.options.concurrency; index++) {
-			if (this.options.indexParam) {
-				let oldToken = new RegExp(this.options.indexParam, 'g');
-				if(this.options.indexParamCallback instanceof Function) {
-					let customIndex = this.options.indexParamCallback();
-					this.options.url = url.replace(oldToken, customIndex);
-					if(this.options.body) {
-						let body = strBody.replace(oldToken, customIndex);
-						this.options.body = JSON.parse(body);
-					}
-				}
-				else {
-					this.options.url = url.replace(oldToken, index);
-					if(this.options.body) {
-						let body = strBody.replace(oldToken, index);
-						this.options.body = JSON.parse(body);
-					}
-				}
-			}
-			let constructor = httpClient.create;
-			// TODO: || this.options.url.startsWith('wss:'))
-			if (this.options.url.startsWith('ws:')) {
-				constructor = websocket.create;
-			}
-			const client = constructor(this, this.options);
+			const createClient = this.getClientCreator()
+			const client = createClient(this, this.options);
 			this.clients[index] = client;
 			if (!this.options.requestsPerSecond) {
 				client.start();
@@ -155,6 +132,14 @@ class Operation {
 		}
 	}
 
+	getClientCreator() {
+		// TODO: || this.options.url.startsWith('wss:'))
+		if (this.options.url.startsWith('ws:')) {
+			return websocket.create;
+		}
+		return httpClient.create;
+	}
+
 	/**
 	 * Stop clients.
 	 */

package/lib/testserver.js

@@ -16,6 +16,7 @@ const LOG_HEADERS_INTERVAL_MS = 5000;
  *	 - quiet: do not log any messages.
  *	 - percent: give an error (default 500) on some % of requests.
  *	 - error: set an HTTP error code, default is 500.
+ *	 - logger: function to log all incoming requests.
  * - `callback`: optional callback, called after the server has started.
  *   If not present will return a promise.
  */
@@ -118,10 +119,10 @@ class TestServer {
 				this.debug(request, elapsedMs);
 			}
 			if (!this.options.delay) {
-				return this.end(response, id);
+				return this.end(request, response, id);
 			}
 			setTimeout(() => {
-				this.end(response, id);
+				this.end(request, response, id);
 			}, this.options.delay).unref();
 		});
 	}
@@ -167,7 +168,7 @@ class TestServer {
 	/**
 	 * End the response now.
 	 */
-	end(response, id) {
+	end(request, response, id) {
 		if (this.shouldError()) {
 			const code = this.options.error || 500;
 			response.writeHead(code);
@@ -176,6 +177,9 @@ class TestServer {
 			response.end('OK');
 		}
 		this.latency.end(id);
+		if (this.options.logger) {
+			this.options.logger(request, response)
+		}
 	}
 
 	shouldError() {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "loadtest",
-	"version": "6.3.1",
+	"version": "6.4.0",
 	"type": "module",
 	"description": "Run load tests for your web application. Mostly ab-compatible interface, with an option to force requests per second. Includes an API for automated load testing.",
 	"homepage": "https://github.com/alexfernandez/loadtest",

package/test/integration.js

@@ -159,12 +159,41 @@ async function testPromise() {
 	return 'Test result: ' + JSON.stringify(result)
 }
 
+async function testIndexParam() {
+	const urls = new Map()
+	const bodies = new Map()
+	function logger(request) {
+		if (urls.has(request.url)) {
+			throw new Error(`Duplicated url ${request.url}`)
+		}
+		urls.set(request.url, true)
+		if (bodies.has(request.body)) {
+			throw new Error(`Duplicated body ${request.body}`)
+		}
+		bodies.set(request.body, true)
+	}
+	const server = await startServer({logger, ...serverOptions})
+	const options = {
+		url: `http://localhost:${PORT}/?param=index`,
+		maxRequests: 100,
+		concurrency: 10,
+		postBody: {
+			hi: 'my_index',
+		},
+		indexParam: 'index',
+		quiet: true,
+	};
+	await loadTest(options)
+	await server.close()
+}
+
 /**
  * Run all tests.
  */
 export function test(callback) {
 	testing.run([
-		testIntegration, testIntegrationFile, testDelay, testWSIntegration, testPromise,
+		testIntegration, testIntegrationFile, testDelay, testWSIntegration,
+		testPromise, testIndexParam,
 	], 4000, callback);
 }