webflux-react-websocket-chat

Scalable WebSocket chat service with React, Spring Web MVC/WebFlux, Redis and MySQL.

Stack

Backend:

• Spring WebFlux
• Redis: For chat room implementation. Messages are sent and received via respective Pub/Sub channel associated with each room. Respective collection of users per room is stored as a sorted set.
• MySQL: For user database.

Frontend:

• React

Architecture & diagram

Service architecture:

Gateway receives requests at `127.0.0.1:8080` and load-balances authorized requests to respective chat servers.

Chat diagram:

Demo

Sign up & Sign In

Sign In & Chat

How to run

Assuming docker, node and jdk11 is installed,

1. Clone repository.
2. Execute build.sh which builds all sub projects. (requires jdk11)
   • If shell scripts or gradlew files aren't executing, run command chmod u+x ${file_name} to grant execute permissions on them
3. Run command docker compose up -d at the project root directory.
4. Go to http://127.0.0.1:3000 to sign up and start chatting.

Troubleshooting

Windows Port Binding Issue

Occasionally on windows, docker may complain that it failed to bind to specified ports. This is due to windows blocking a range of ports on startup. Such ports can be checked with command:

netsh interface ipv4 show excludedportrange protocol=tcp

In such case you may want to rewrite docker-compose.yml so contaiers can bind to available ports.

M1 Mac Docker Mysql Issue

M1 Mac users are likely to encounter the following error message while pulling the mysql image from docker hub:

no matching manifest for linux/arm64/v8 in the manifest list entries

Mysql does not provide linux/arm64/v8 architecture version of mysql image for M1 Mac, but M1 Mac is capable of handling Intel-friendly version image, which is linux/amd64. Therefore the issue can be fixed simply by using linux/amd64 version of Mysql image. To do so, follow the steps below.

1. Open webflux-react-websocket-chat/chat-user/docker/db/Dockerfile
2. Change the first line FROM mysql:8.0.28 to FROM --platform=linux/amd64 mysql:8.0.28