DhruvikDonga
commented
1 year ago graph TD
node7((wordsbattle app))
node1[[HTTP server URL for ws connect :-/ws?name=Username]]
node2[[Game server <small>game->cow</small><br><small>Maintains maps list of rooms and clients <small><br><small>Create/Delete rooms , Add/Remove clients</small>]]
node3[[Room server <small>game->cow</small>]]
node13[[Room Server State manager]]
node4[Client]
node5[[Client Readpump <br><small>Recieve the messages concurrently<br> from client</small>]]
node8([Join Room])
node9([Leave Room])
node10([Join Random Room])
node11([Send Message to a room])
node6[[Client Writepump <br><small>write the messages concurrently<br> to clients</small>]]
node12((VueJS game UI))
node7-->|intialized in main thread|node1
node7-->|intialized in main thread|node2
node1-->node4
node4-->node5
node4-->node6
node5-->node8
node5-->node9
node5-->node10
node5-->node11
node2-->node3
node8-->node2
node10-->node2
node9-->node2
node11-->node3
node3-->node6
node6-->node12
node12-->node1
node3-->node13
node13-->|manages the state of room <br>the store values of client<br>Customizable to send the messages from server side|node3
Table of Contents
Context 🚀
Currently, the backend codebase, which is written in Golang, has many internal issues that have a high possibility of causing problems in further development and expansion plans.
There are many places where over-engineering has occurred, resulting in the addition of useless code and a lack of proper code structuring around the WebSocket and lobby implementation. Proper error handling is also lacking.
Purpose 🎯
The main purpose of developing this ticket is to address the following issues and introduce new features:
Severity 🛑
The development of this ticket will indeed require a significant amount of time and should be treated as a priority. Neglecting it can result in a more unstable existing system, which can lead to further complications down the line. Additionally, by addressing these issues and improving the system, there is an opportunity to open-source it, which can bring several benefits.
It's essential to allocate the necessary time and resources to address the issues, improve the stability of the existing system, and seize the opportunity to open-source the project. By doing so, you can not only resolve immediate concerns but also leverage the benefits that come with open-source collaboration. There is also a proposal to introduce multiple wsServers and wsClients every time a new game is created for better package management.
Approach 📐
The approach to this ticket should indeed be different from other tickets, considering the specific requirements and goals involved. Here are some methods that can be employed:
By incorporating these methods into the ticket's approach, you can enhance the clarity, quality, and maintainability of the codebase, ultimately improving the overall development process and the system's production-readiness.
Expected Results 🌟
The expected results are subject to changes as the development progresses:
Please note that these expected results may evolve or be refined based on the ongoing development process and user feedback.
Task list ✅
This ticket will be in development unless all the checklist are done this is used to keep track new tasks might be added simultaneously