We have a case when the server should make requests to the client. At this point this library do not have such functionality, while specification do not restrict regarding this.

Do you interested in merging such PR if we will implement it?

https://github.com/elpheria/rpc-websockets/blob/2f0f59e181e4b5338b878848a53198bcb199ee6f/src/lib/server.js#L417

In case if client socket closes the connection - 'send' will cause an unhandled rejection, which in some production environments might lead to application crash!

Mentioned problem is relevant to any other socket.send call.

Steps to reproduce:

1. Call some long running rpc task
2. Close client connection
3. After task has finished - unhandledRejection will be triggered

Not of all options are passed into ws instance now. For example, without my suggestion, ws-server does not receive custom headers: const Websocket = require('rpc-websockets').Client; const options = { autoconnect: true, reconnect: false, headers: { 'x-header1': 'x-header1', 'x-header2': 'x-header2' } }; const ws = new Websocket('ws://localhost:8080', options);

Hi, Trying to understand how login middlewere should work.

Came across this code:

// if login middleware returned true, set connection as authenticated
        if (message.method === "rpc.login" && response === true)
            this.authenticated = true

Does it mean that after one client authenticates, all clients are authenticated automatically?

Hi,

Thanks for the great library! I've written a small Node JS server, and I want to use it from my frontend running in the browser. Can I do that? I saw a dist/index.browser-bundle.js file and included it in my index.html. How can I instantiate the client using this bundle? Normally I would do: var WebSocket = require('rpc-websockets').Client var ws = new WebSocket('ws://localhost:8080') What's the equivalent if using the browser-bundle?

Thanks!

Dinko

This is related to #12. When adding support for circular objects, only parameters for RPC methods were implemented. This update adds support for the data passed through events as well.

https://github.com/qaap/rpc-websockets/blob/c335c872f8ea46df06848d21ac57df30457322d7/src/lib/client.js#L218

I can't use notification parameters if it is an Object, only if it is an Array.

Fixes: https://github.com/elpheria/rpc-websockets/issues/83

This is a quick and dirty fix for the race condition. Feel free to go with another approach

Greetings! Thanks for the great library, starting to put it to use in a new project.

While experimenting w/ the authentication feature, I noticed the client 'login' promise will always result the 'resolve' callback being invoked even if setAuth returns false. The client can distinguish between successful and failed logins via the parameter specified to this callback (true for success, false for failure) but I feel it would be more inline w/ asynchronous javascript if the 'reject' callback was invoked on failure.

eg in the current situation the client needs to be implemented like so:

ws.login({username, password}).then(function(result) {
  if(result)
    ; // handle successful login
  else
    ; // handle failed login
})

If implemented via resolve/reject, the client could handle the two cases like so:

ws.login({username, password}).then(function(result) {
  ; // handle success login

}).catch(function(err){
  ; // handle failed login
})

Thoughts?

https://hitbtc.com/api#get-currencies
How to add id to JSON-RPC call

{
  "method": "getCurrency",
  "params": {
    "currency": "ETH"
  },
  "id": 123
}

Hi, I was using the client in the library against a simple server that echoes the JSON message sent by the client, for example:

{
  "jsonrpc":"2.0",
  "method":"runScript",
  "params":["test"],
  "id":4
}

Per JSON-RPC 2.0 spec, the server is required to respond with a Response object which contains a result property in case of success, or an error on in case of error. But, when my server responses with that JSON, both of them are absent. So I expected to receive an RPC exception when making a call() and getting this as response. Instead, the method simply resolves with an undefined result. Is this intended behavior?

issue

I register a method by using the Server. The method returns a data body of Map type, but I get {} from the Client

code template

//Server
server.register('getMap', function (params) {
  console.log(
    "---> {'method':'getMap','params':%0}", params
  );
  return new Map([['str', new Array(6).fill(0.0)]]);
});
//Client
let result = await client.call('getMap', []);

How to run ws on the same port as a http Express?

I tried the example express-session-parse given by ws (link), and replace the const { WebSocketServer } = require('ws'); to const WebSocketServer = require('rpc-websockets').Server;, and add a hello remote function, but it didn't work. The client has no output, the server output is only Parsing session from request...

What need I do?

The source code of server and client are :

server

// server: index.json
'use strict';

const session = require('express-session');
const express = require('express');
const http = require('http');
const uuid = require('uuid');

const  WebSocketServer = require('rpc-websockets').Server;

const app = express();
const map = new Map();

//
// We need the same instance of the session parser in express and
// WebSocket server.
//
const sessionParser = session({
  saveUninitialized: false,
  secret: '$eCuRiTy',
  resave: false
});

//
// Serve static files from the 'public' folder.
//
app.use(express.static('public'));
app.use(sessionParser);

app.post('/login', function (req, res) {
  //
  // "Log in" user and set userId to session.
  //
  const id = uuid.v4();

  console.log(`Updating session for user ${id}`);
  req.session.userId = id;
  res.send({ result: 'OK', message: 'Session updated' });
});

app.delete('/logout', function (request, response) {
  const ws = map.get(request.session.userId);

  console.log('Destroying session');
  request.session.destroy(function () {
    if (ws) ws.close();

    response.send({ result: 'OK', message: 'Session destroyed' });
  });
});

//
// Create an HTTP server.
//
const server = http.createServer(app);

//
// Create a WebSocket server completely detached from the HTTP server.
//
const wss = new WebSocketServer({ clientTracking: false, noServer: true });

server.on('upgrade', function (request, socket, head) {
  console.log('Parsing session from request...');

  sessionParser(request, {}, () => {
    if (!request.session.userId) {
      socket.write('HTTP/1.1 401 Unauthorized\r\n\r\n');
      socket.destroy();
      return;
    }

    console.log('Session is parsed!');

    wss.handleUpgrade(request, socket, head, function (ws) {
      wss.emit('connection', ws, request);
    });
  });
});
wss.on('listening',()=>{
wss.register('hello',({index})=>{
  console.log(index);
  return `index:${index}`;
})

})
wss.on('connection', function (ws, request) {
  const userId = request.session.userId;

  map.set(userId, ws);

  ws.on('message', function (message) {
    //
    // Here we can now use session parameters.
    //
    console.log(`Received message ${message} from user ${userId}`);
  });

  ws.on('close', function () {
    map.delete(userId);
  });
});
//
// Start the server.
//
server.listen(8082, function () {
  console.log('Listening on http://localhost:8082');
});

client

// client: rpc_client.js
const WebSocket = require('rpc-websockets').Client;
// instantiate Client and connect to an RPC server
const ws = new WebSocket('ws://localhost:8082/');
ws.on('open', function () {
    console.log("connected");
    ws.call("hello",{index},).then((ret)=>{
        console.log(ret);
    }).catch(err=>{
        console.trace(err);
    })

});

Hi! 👋

Firstly, thanks for your work on this project! 🙂

Today I used patch-package to patch [email protected] for the project I'm working on.

whitebit.com sends "error: null" and I constantly get Server response malformed. Response must include either \"result\"" + " or \"error\", but not both.

Here is the diff that solved my problem:

diff --git a/node_modules/rpc-websockets/dist/lib/client.js b/node_modules/rpc-websockets/dist/lib/client.js
index f07ce1d..2207e56 100644
--- a/node_modules/rpc-websockets/dist/lib/client.js
+++ b/node_modules/rpc-websockets/dist/lib/client.js
@@ -451,6 +451,12 @@ var CommonClient = /*#__PURE__*/function (_EventEmitter) {
         } // reject early since server's response is invalid
 
 
+        if (message.error === null) {
+          delete message.error
+        }if (message.result === null) {
+          delete message.result
+        }
+
         if ("error" in message === "result" in message) _this4.queue[message.id].promise[1](new Error("Server response malformed. Response must include either \"result\"" + " or \"error\", but not both."));
         if (_this4.queue[message.id].timeout) clearTimeout(_this4.queue[message.id].timeout);
         if (message.error) _this4.queue[message.id].promise[1](message.error);else _this4.queue[message.id].promise[0](message.result);

This issue body was partially generated by patch-package.

After i deployed my app on heroku i had an issue, if you can help me please

const app = express()
const port = process.env.PORT || 8080 // Heroku will need the PORT environment variable

app.use(express.static(path.join(__dirname, 'build')));
app.get('/*', function (req, res) {
  res.sendFile(path.join(__dirname, 'build', 'index.html'));
});

app.listen(port, () => console.log(`App is live on port ${port}!`))

// instantiate Server and start listening for requests

var server = new WebSocketServer({
  port: port,
  host: anaddress
})

how can i please pass the express server (as a param) to the websocket server?

Thank you

Hi, I've created an event inside a namespace:

   [...]
   server.event(name, ns);
   [...]

Then I use this command to emit a new event:

   [...]
   server.emit(name, state);
   [...]

On the client I try to subscribe to the event in this way:

      ws.subscribe(name);
      ws.on(name, (param) => {
         console.log('new notify: ', param);
      });

But I don't get any update. I can get it just when I don't use namespace.

Thanks, Mirko