loadtest 5.1.2 → 5.2.0

package/README.md

@@ -651,7 +651,7 @@ loadtest.loadTest(options, function(error) {
 
 #### `statusCallback`
 
-Execution this function after every request operation completes. Provides immediate access to test results while the
+If present, this function executes after every request operation completes. Provides immediate access to test results while the
 test batch is still running. This can be used for more detailed custom logging or developing your own spreadsheet or
 statistical analysis of results.
 
@@ -692,6 +692,31 @@ loadtest.loadTest(options, function(error) {
 });
 ```
 
+ 
+In some situations request data needs to be available in the statusCallBack.
+This data can be assigned to `request.labels` in the requestGenerator:
+```javascript
+const options = {
+	// ...
+	requestGenerator: (params, options, client, callback) => {
+		// ...
+        const randomInputData = Math.random().toString().substr(2, 8);
+        const message = JSON.stringify({ randomInputData })
+		const request = client(options, callback);
+        request.labels = randomInputData;
+		request.write(message);
+		return request;
+	}
+};
+```
+
+Then in statusCallBack the labels can be accessed through `result.labels`:
+```javascript
+function statusCallback(error, result, latency) {
+    console.log(result.labels);
+}
+```
+
 **Warning**: The format for `statusCallback` has changed in version 2.0.0 onwards.
 It used to be `statusCallback(latency, result, error)`,
 it has been changed to conform to the usual Node.js standard.

package/lib/httpClient.js

@@ -257,6 +257,9 @@ class HttpClient {
 					body: body,
 					headers: connection.headers,
 				};
+				if (connection.req.labels) {
+					result.labels = connection.req.labels
+				}
 				if (contentInspector) {
 					contentInspector(result)
 				}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "loadtest",
-	"version": "5.1.2",
+	"version": "5.2.0",
 	"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",
 	"contributors": [