@ably-labs/locust 0.0.4 → 0.0.6

package/README.md

@@ -14,7 +14,7 @@ See [example/users.ts](/example/users.ts) for an example of defining Locust user
 
 The example can be run by copying `example/.env.sample` to `example/.env`, setting `ABLY_API_KEY` to your Ably API key, and running [Docker Compose](https://docs.docker.com/compose/):
 
-```
+```bash
 cd example
 
 cp .env.sample .env
@@ -36,7 +36,7 @@ Locust has the concept of a User which runs a set of requests during a load test
 
 `ably-locust` is an implementation of a Locust worker process in JavaScript. It can be installed by running:
 
-```
+```bash
 npm install @ably-labs/locust
 ```
 
@@ -48,7 +48,7 @@ One of the messages a worker receives is a `spawn` message which declares how ma
 
 For example, assuming there is a Locust master running at `locust.example.com:5557` which is using the following `locustfile.py`:
 
-```
+```python
 from locust import User
 
 class ExampleUser(User):
@@ -57,7 +57,7 @@ class ExampleUser(User):
 
 Then here's an example program where each user reports a successful request every second:
 
-```
+```javascript
 const { Worker } = require('@ably-labs/locust');
 
 const worker = new Worker({
@@ -88,7 +88,7 @@ worker.run();
 
 Start an instance of Locust and run the tests:
 
-```
+```bash
 cd tests
 
 docker compose up --build

package/lib/Worker.js

@@ -144,7 +144,7 @@ var Worker = /** @class */ (function () {
                         data = _c.value[0];
                         try {
                             msg = Message_1.Message.decode(data);
-                            this.log.info("Received '" + msg.type + "' message");
+                            this.log.debug("Received '" + msg.type + "' message");
                             this.handle(msg);
                         }
                         catch (err) {
@@ -237,6 +237,7 @@ var Worker = /** @class */ (function () {
         this.lastReceivedSpawnTimestamp = data.timestamp;
         this.state = "spawning" /* Spawning */;
         this.send("spawning" /* Spawning */, null);
+        this.log.info("Handling spawn message: expected = " + JSON.stringify(data.user_classes_count) + ", actual = " + JSON.stringify(this.spawnState().user_classes_count));
         for (var _i = 0, _a = Object.keys(data.user_classes_count); _i < _a.length; _i++) {
             var userClass = _a[_i];
             // check we have a registered function for the given class
@@ -317,6 +318,7 @@ var Worker = /** @class */ (function () {
      * Start the given number of users.
      */
     Worker.prototype.startUsers = function (userClass, userFn, count) {
+        this.log.debug("Starting " + count + " " + userClass + " users");
         for (var i = 0; i < count; i++) {
             try {
                 var user = userFn();
@@ -340,6 +342,7 @@ var Worker = /** @class */ (function () {
      * Stop the given number of users.
      */
     Worker.prototype.stopUsers = function (userClass, count) {
+        this.log.debug("Stopping " + count + " " + userClass + " users");
         for (var i = 0; i < count; i++) {
             var user = this.users[userClass].pop();
             if (user !== undefined) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ably-labs/locust",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "A JavaScript load generator for Locust.io.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -36,8 +36,8 @@
     "typescript": "^4.4.4"
   },
   "dependencies": {
+    "@ably/zeromq": "^6.0.0-beta.ably.3",
     "msgpack5": "^5.3.2",
-    "winston": "^3.3.3",
-    "zeromq": "^6.0.0-beta.6"
+    "winston": "^3.3.3"
   }
 }