@ably-labs/locust 0.0.3 → 0.0.4

package/lib/Worker.d.ts

@@ -48,6 +48,10 @@ interface User {
  * A function which is registered with a worker to initialise a User.
  */
 declare type UserFn = () => User;
+/**
+ * A function which is called when an event happens.
+ */
+declare type EventFn = (data: any) => void;
 /**
  * A Locust worker which connects to a Locust master ZeroMQ socket and spawns
  * Locust users during an active load test.
@@ -105,6 +109,12 @@ export declare class Worker {
      * discard outdated messages.
      */
     lastReceivedSpawnTimestamp: number;
+    /**
+     * A set of functions which are called when events happen.
+     */
+    callbacks: {
+        [key: string]: EventFn[];
+    };
     constructor(opts: Options);
     /**
      * Register a function to initialise users of the given class name.
@@ -120,6 +130,18 @@ export declare class Worker {
      *
      */
     run(): Promise<void>;
+    /**
+     * Register a callback to be called when an event happens.
+     */
+    on(event: string, callback: (data: any) => void): void;
+    /**
+     * Register a callback to be called when a user starts.
+     */
+    onUserStart(callback: EventFn): void;
+    /**
+     * Register a callback to be called when a user stops.
+     */
+    onUserStop(callback: EventFn): void;
     /**
      * Send a protocol message to the Locust master.
      */
@@ -195,5 +217,9 @@ export declare class Worker {
         };
         user_count: number;
     };
+    /**
+     * Invoke all callbacks for the given event with the given data.
+     */
+    emit(event: string, data: any): void;
 }
 export {};

package/lib/Worker.js

@@ -97,6 +97,7 @@ var Worker = /** @class */ (function () {
             ],
         });
         this.lastReceivedSpawnTimestamp = 0;
+        this.callbacks = {};
     }
     /**
      * Register a function to initialise users of the given class name.
@@ -173,6 +174,27 @@ var Worker = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Register a callback to be called when an event happens.
+     */
+    Worker.prototype.on = function (event, callback) {
+        if (!this.callbacks[event]) {
+            this.callbacks[event] = [];
+        }
+        this.callbacks[event].push(callback);
+    };
+    /**
+     * Register a callback to be called when a user starts.
+     */
+    Worker.prototype.onUserStart = function (callback) {
+        this.on('user.start', callback);
+    };
+    /**
+     * Register a callback to be called when a user stops.
+     */
+    Worker.prototype.onUserStop = function (callback) {
+        this.on('user.stop', callback);
+    };
     /**
      * Send a protocol message to the Locust master.
      */
@@ -300,6 +322,7 @@ var Worker = /** @class */ (function () {
                 var user = userFn();
                 user.start();
                 this.users[userClass].push(user);
+                this.emit('user.start', { userClass: userClass });
             }
             catch (err) {
                 this.logException("Error initialising " + userClass + " user: " + err);
@@ -321,6 +344,7 @@ var Worker = /** @class */ (function () {
             var user = this.users[userClass].pop();
             if (user !== undefined) {
                 user.stop();
+                this.emit('user.stop', { userClass: userClass });
             }
         }
     };
@@ -394,6 +418,19 @@ var Worker = /** @class */ (function () {
             user_count: Object.values(this.users).reduce(function (sum, users) { return sum + users.length; }, 0),
         };
     };
+    /**
+     * Invoke all callbacks for the given event with the given data.
+     */
+    Worker.prototype.emit = function (event, data) {
+        var callbacks = this.callbacks[event];
+        if (!callbacks) {
+            return;
+        }
+        for (var _i = 0, callbacks_1 = callbacks; _i < callbacks_1.length; _i++) {
+            var callback = callbacks_1[_i];
+            callback(data);
+        }
+    };
     return Worker;
 }());
 exports.Worker = Worker;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ably-labs/locust",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "A JavaScript load generator for Locust.io.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",