🤿 Websocket Microservices With Redis Pubsub

what is websocket microservices?

websocket microservices are microservices that use websockets to communicate server with client or reverse

🚧 what is redis pubsub?

redis pubsub is a pubsub (messaging bor) system that uses Redis as a backend

🚧 why Websocket Microservice not integrated with webserver ?

when websocket microservices integrate with webserver, it will be overloaded with webserver request and response because of websocket connection transport data between client and server and do this many times with many clients, so it will be better to separate websocket microservice from webserver

🚧 how this architecture works?

assume that we have two clients client A and client B , A want send message to B , B wants to send a message to A, so how do this, first A sends message to webserver with metadata like this

let message = {
    uuid_remote: UUID,
    uuid_local: UUID,
    message: message,
}
// uuid_remote: the uuid of the remote client
// uuid_local : the uuid of me 
// message: the message that the client want to send to the remote client

this message get from client to webserver , webserver will take this message and make some checks on it and if it is valid send it to redis pub_sub then websocket microservice will take this message and send it to the remote client throw websocket connection

🚧 practical example

• when you open webpage, page will send request to get a token from the server by any authentication method
• server will send a token client then the client try to open a connection with websocket microservice
• websocket microservice will send the token to server to authenticate this connection
• server will send authentication valid of token
• websocket microservice will accept this connection
• the client will send a message to the server with uuid of the remote client
• server will send this message after making validation to this message
• send this meesage to redis pub sub
• websocket microservice will take this message and send it to the remote client

🚀 How run this architecture

• run redis stack container

  • go to redis_pub_sub directory
  • add configuration file local-redis-stack.conf
  • there are two configuration in this file port and time to take snapshot from database and minumum keys number to do this
  • run docker compose up -d to make redis stack container
  • this will run RedisInsight web interface can access from localhost:8001

• run web sever

  • go to server directory
  • run node main.js
  • this server has three endpoints
    • /token -> endpoint used to get auth token then use it by clinet to connected to websocket
    • /auth/:token -> endpoint using by websocket microservice to authenticate the connection of client
    • /publish -> endpoint used to send message to client by uuid of client

• run websocket microservice

  • go to ws_microservice directory
  • run node main.js
  • this microservice which make websocket connection with client and make subscribe to redis pubsub and get record from redis and send it to target client

• open client page

  • go to client directory
  • open index.html in live server

---

🚧 How client look

the uuid which in above this is client uuid , client can send any message to other clinet but should know uuid of other client , to send message enter uuid of client and message and click publish this sned message to server which send it to redis pubsub which subscribed by websocket microservice and send it to other client