How to subscribe to user events (socket events) without using virtual get (for testing purposes) in sails.js

[hartatovich]

Node version: 12.19.1 Sails version (sails): 1.4.0 ORM hook version (sails-hook-orm): 2.1.1 Sockets hook version (sails-hook-sockets): 2.0.0 Organics hook version (sails-hook-organics): 0.16.1 Grunt hook version (sails-hook-grunt): 4.0.1

---

I'm trying to implement some tests for my socket and I can't find a way to subscribe to User events without using sails.js virtual GET inside SailsSocket class

the application frontend code looks something like that

import socketIOClient from "socket.io-client";
import sailsIOClient from "sails.io.js";

const io = sailsIOClient(socketIOClient);
io.sails.transports = ['websocket'];
io.sails.url = "http://localhost:1337/";//define the url in http protocol (that's works fine)
io.sails.reconnectionAttempts = 10000;
const socket = io.sails.connect();

socket.get(`/api/v1/socket/subscribe/1`); //virtual GET to the server via the socket object (also fine)

and the backend sails.js code looks like this:

//routes.js

module.exports.routes = {
  'GET /api/v1/socket/subscribe/:user_id': {action: 'socket/subscribe'}
}

//socket/subscribe

fn: async function (inputs) {

    const id = this.req.param('user_id');
    const user = await User.findOne({id});
    User.subscribe(this.req, [user.id]);

}

so far so good and everything works pretty well on the application side.

my problem starts when i'm trying to connect with a different client side code on a socket class that don't have virtual GET I'm using k6, its a load testing tool with some API to connect to sockets.

I'm not sure if virtual GET is part of the web socket protocol or how everything really works around that with sails.js

//frontend code
io.sails.url = "http://localhost:1337/";

//k6 code 
var url = 'ws://localhost:1337/socket.io/?__sails_io_sdk_version=1.2.1&__sails_io_sdk_platform=node&__sails_io_sdk_language=javascript&EIO=3&transport=websocket';
var params = { tags: { my_tag: 'hello' } };
var response = ws.connect(url, params, function (socket) {
   socket.on('open', function open() {
      console.log('connected');
      socket.on('message', function (message) {
         console.log(`Received message: ${message}`);
      }); 
    });
  });

I changed the url to use the ws protocol (was originally http) and I managed to connect the socket from k6, however was not able to receive any user event that published on the backend

//publish event from the backend to the client
User.publish([1], data);

I can't figure out how to subscribe to those user events outside the client side code inside my application.. (k6 or any other socket library)

thanks for all those that spend the extra time reading all this! :)

some related links:

https://k6.io/docs/javascript-api/k6-ws/socket/

https://sailsjs.com/documentation/reference/web-sockets/socket-client/io-socket-get

https://sailsjs.com/documentation/reference/web-sockets/socket-client/sails-socket

[sailsbot]

@hartatovich Thanks for posting! We'll take a look as soon as possible.

In the mean time, there are a few ways you can help speed things along:

• look for a workaround. (Even if it's just temporary, sharing your solution can save someone else a lot of time and effort.)
• tell us why this issue is important to you and your team. What are you trying to accomplish? (Submissions with a little bit of human context tend to be easier to understand and faster to resolve.)
• make sure you've provided clear instructions on how to reproduce the bug from a clean install.
• double-check that you've provided all of the requested version and dependency information. (Some of this info might seem irrelevant at first, like which database adapter you're using, but we ask that you include it anyway. Oftentimes an issue is caused by a confluence of unexpected factors, and it can save everybody a ton of time to know all the details up front.)
• read the code of conduct.
• if appropriate, ask your business to sponsor your issue. (Open source is our passion, and our core maintainers volunteer many of their nights and weekends working on Sails. But you only get so many nights and weekends in life, and stuff gets done a lot faster when you can work on it during normal daylight hours.)
• let us know if you are using a 3rd party plugin; whether that's a database adapter, a non-standard view engine, or any other dependency maintained by someone other than our core team. (Besides the name of the 3rd party package, it helps to include the exact version you're using. If you're unsure, check out this list of all the core packages we maintain.)

  ---

Please remember: never post in a public forum if you believe you've found a genuine security vulnerability. Instead, disclose it responsibly.

For help with questions about Sails, click here.

[eashaw]

Hi @hartatovich, We recommend writing an action to subscribe to the socket that recreates a JSON websocket response object. We also recommend taking a look at how sockets emit in the sails.io.js source code .