feature: add an option to send bytes with ws

examples/websockets/my-functions.js

@@ -1,4 +1,4 @@
-module.exports = { createRandomScore };
+module.exports = { createRandomScore, sendStream };
 
 function createRandomScore(userContext, events, done) {
   const data = {
@@ -11,3 +11,14 @@ function createRandomScore(userContext, events, done) {
 
   return done();
 }
+
+function sendStream(userContext, events, done) {
+  const fs = require('fs');
+  const path = '/path/to/your/wavfile.wav';
+
+  userContext.vars.byteData = fs.readFile(path, (err, data) => {
+    // put it on byteData variable to not overide the "data" variable
+    userContext.vars.byteData = data;
+    return done();
+  });
+}

examples/websockets/websockets.yml

@@ -16,3 +16,6 @@ scenarios:
     flow:
       - function: "createRandomScore"
       - send: "{{ data }}"
+      - function: "sendStream"
+      - sendBytes: "{{ byteData }}"
+      - sendBytes: "ABC" # It will turn the string into bytes automatically

packages/core/lib/engine_ws.js

@@ -165,8 +165,25 @@ WSEngine.prototype.step = function (requestSpec, ee) {
     };
   }
 
+  const get_string_payload = (payload) => {
+    if (typeof payload === 'object') {
+      return JSON.stringify(payload);
+    }
+
+    return _.toString(payload);
+  }
+
+  const get_bytes_payload = (payload) => {
+    if (typeof payload === 'string') {
+      let utf8Encode = new TextEncoder()
+      return utf8Encode.encode(payload).buffer
+    }
+
+    return payload
+  } 
+
   const f = function (context, callback) {
-    const params = requestSpec.wait || requestSpec.send;
+    const params = requestSpec.wait || requestSpec.send || requestSpec.sendBytes;
 
     // match exists on a string, so check match is not a prototype
     let captureOrMatch = _.has(params, 'capture') || _.has(params, 'match');
@@ -192,12 +209,11 @@ WSEngine.prototype.step = function (requestSpec, ee) {
 
     if (payload !== undefined) {
       payload = template(payload, context);
-      if (typeof payload === 'object') {
-        payload = JSON.stringify(payload);
+      if (requestSpec.sendBytes) {
+        payload = get_bytes_payload(payload)
       } else {
-        payload = _.toString(payload);
+        payload = get_string_payload(payload)
       }
-
       ee.emit('counter', 'websocket.messages_sent', 1);
       ee.emit('rate', 'websocket.send_rate');
       debug('WS send: %s', payload);