loadtest 8.1.1 → 8.2.0

package/README.md

@@ -560,7 +560,8 @@ see [doc/api.md](doc/api.md) for the full explanations with examples.
 * `requestGenerator`: custom request generator function.
 * `agentKeepAlive`: if true, will use 'Connection: Keep-alive'.
 * `quiet`: if true, do not show any messages.
-* `indexParam`: parameter to replace in URL and body with a unique index.
+* `indexParam`: regexp to replace in URL and body with a unique index. The string specified in this parameter will be passed to `new Regexp(here, 'g')`. Do not use together with `indexParamLiteral`.
+* `indexParamLiteral`: literal string to replace in URL and body with a unique index. Do not use together with `indexParam`.
 * `indexParamCallback`: function to generate unique indexes.
 * `insecure`: allow invalid and self-signed certificates over https.
 * `secureProtocol`: TLS/SSL method to use.
@@ -623,7 +624,9 @@ The expected structure of the file is the following:
 	"agentKeepAlive": "Use a keep-alive http agent",
 	"proxy": "Use a proxy for requests",
 	"requestsPerSecond": "Specify the requests per second for each client",
-	"indexParam": "Replace the value of given arg with an index in the URL"
+	"indexParam": "pattern to replace with a generated index in the URL",
+	"indexParamLiteral": "string to replace with a generated index in the URL",
+	"indexParamCallback": "function() {that generates ids to insert into the URL}"
 }
 ```
 

package/doc/api.md

@@ -170,14 +170,27 @@ Do not show any messages.
 
 #### `indexParam`
 
+The given pattern will be replaced in the final URL with a unique index.
+E.g.: if URL is `http://test.com/value` and `indexParam = '\bvalue\b'`, then the URL
+will be:
+
+* http://test.com/1
+* http://test.com/2
+* ...
+* body will also be replaced `body:{ userid: value, othervalue: 123 }` will be `body:{ userid: 1, othervalue: 123 }`
+
+#### `indexParamLiteral`
+
 The given string will be replaced in the final URL with a unique index.
-E.g.: if URL is `http://test.com/value` and `indexParam=value`, then the URL
+E.g.: if URL is `http://test.com/value` and `indexParam: 'value'`, then the URL
 will be:
 
 * http://test.com/1
 * http://test.com/2
 * ...
-* body will also be replaced `body:{ userid: id_value }` will be `body:{ userid: id_1 }`
+* body will also be replaced `body:{ userid: value, othervalue: 123 }` will be `body:{ userid: 1, other1: 123 }`
+
+Use only indexParamLiteral or only indexParam. Not both at the same time!
 
 #### `indexParamCallback`
 

package/lib/httpClient.js

@@ -85,8 +85,12 @@ export class HttpClient {
 			const agent = new HttpsProxyAgent(proxy);
 			this.params.agent = agent;
 		}
-		if (this.options.indexParam) {
-			this.params.indexParamFinder = new RegExp(this.options.indexParam, 'g');
+		if (this.options.indexParamLiteral) {
+			this.params.indexParamFinder = this.options.indexParamLiteral;
+			this.params.indexParamCallback = this.options.indexParamCallback;
+		} else if (this.options.indexParam) {
+			this.params.indexParamFinder = (this.options.indexParam instanceof RegExp) ? this.options.indexParam : new RegExp(this.options.indexParam, 'g');
+			this.params.indexParamCallback = this.options.indexParamCallback;
 		}
 		// Disable certificate checking
 		if (this.options.insecure === true) {

package/lib/options.js

@@ -22,6 +22,8 @@ class Options {
 		this.requestsPerSecond = options.requestsPerSecond || rps || configuration.requestsPerSecond
 		this.agentKeepAlive = options.keepalive || options.agent || options.agentKeepAlive || configuration.agentKeepAlive;
 		this.indexParam = options.index || options.indexParam || configuration.indexParam;
+		this.indexParamLiteral = options.indexParamLiteral || configuration.indexParamLiteral;
+		this.indexParamCallback = options.indexParamCallback || configuration.indexParamCallback;
 		this.method = options.method || configuration.method || 'GET'
 		this.readBodyAndMethod(options, configuration)
 		this.key = null

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "loadtest",
-	"version": "8.1.1",
+	"version": "8.2.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",