Skip to content

Commit

Permalink
Update DESIGN.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@priyankamanjunath
priyankamanjunath committed Apr 15, 2021
1 parent 783b64e commit 2193753
Showing 1 changed file with 83 additions and 71 deletions.
154 changes: 83 additions & 71 deletions DESIGN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,120 +2,132 @@

## Backend

1) CoveyTypes.ts
>• Added new types for payload such as [ChatData](https://github.com/yrrah/covey.town/blob/93ef479a0205c2c13bacedecc50bfdf4105cd172/services/roomService/src/CoveyTypes.ts#L19-L27), [ReceivingPlayerID](https://github.com/yrrah/covey.town/blob/93ef479a0205c2c13bacedecc50bfdf4105cd172/services/roomService/src/CoveyTypes.ts#L9-L11), [SecretKeySet](https://github.com/yrrah/covey.town/blob/93ef479a0205c2c13bacedecc50bfdf4105cd172/services/roomService/src/CoveyTypes.ts#L13-L15), and [ChatType](https://github.com/yrrah/covey.town/blob/93ef479a0205c2c13bacedecc50bfdf4105cd172/services/roomService/src/CoveyTypes.ts#L2)
1. CoveyTypes.ts

> • Added new types for payload such as [ChatData](https://github.com/yrrah/covey.town/blob/93ef479a0205c2c13bacedecc50bfdf4105cd172/services/roomService/src/CoveyTypes.ts#L19-L27), [ReceivingPlayerID](https://github.com/yrrah/covey.town/blob/93ef479a0205c2c13bacedecc50bfdf4105cd172/services/roomService/src/CoveyTypes.ts#L9-L11), [SecretKeySet](https://github.com/yrrah/covey.town/blob/93ef479a0205c2c13bacedecc50bfdf4105cd172/services/roomService/src/CoveyTypes.ts#L13-L15), and [ChatType](https://github.com/yrrah/covey.town/blob/93ef479a0205c2c13bacedecc50bfdf4105cd172/services/roomService/src/CoveyTypes.ts#L2)
2) CoveyTownListener.ts
>• Added a new function [‘onMessageSent’](https://github.com/yrrah/covey.town/blob/93ef479a0205c2c13bacedecc50bfdf4105cd172/services/roomService/src/types/CoveyTownListener.ts#L31-L34) to send messages to all listeners.
2. CoveyTownListener.ts
> • Added a new function [‘onMessageSent’](https://github.com/yrrah/covey.town/blob/93ef479a0205c2c13bacedecc50bfdf4105cd172/services/roomService/src/types/CoveyTownListener.ts#L31-L34) to send messages to all listeners.
>• The method takes in a ChatData type.
> • The method takes in a ChatData type.
3. CoveyTownController.ts
> • Added a new function ['sendChatMessage'](https://github.com/yrrah/covey.town/blob/93ef479a0205c2c13bacedecc50bfdf4105cd172/services/roomService/src/lib/CoveyTownController.ts#L125-L131) to send the message to all the listeners connected to the room.
3) CoveyTownController.ts
>• Added a new function ['sendChatMessage'](https://github.com/yrrah/covey.town/blob/93ef479a0205c2c13bacedecc50bfdf4105cd172/services/roomService/src/lib/CoveyTownController.ts#L125-L131) to send the message to all the listeners connected to the room.
> • The method takes in a ChatData type that is passed to all the listeners connected to the room.
>• The method takes in a ChatData type that is passed to all the listeners connected to the room.
4. CoveyTownRequestHandler.ts

> • The [townSocketAdapter](https://github.com/yrrah/covey.town/blob/09865aef29a82139b19351ea53e1dd641278a7ba/services/roomService/src/requestHandlers/CoveyTownRequestHandlers.ts#L193-L195) is extended to allow the soket to emit the chat message to all other users.
> • On receiving the 'newChatMessage' by the socket, the controller [calls the sendChatMessage function](https://github.com/yrrah/covey.town/blob/09865aef29a82139b19351ea53e1dd641278a7ba/services/roomService/src/requestHandlers/CoveyTownRequestHandlers.ts#L239-L243) to send the chat data to all the listeners connected to that controller.
4) CoveyTownRequestHandler.ts
5. files.ts

>• The [townSocketAdapter](https://github.com/yrrah/covey.town/blob/09865aef29a82139b19351ea53e1dd641278a7ba/services/roomService/src/requestHandlers/CoveyTownRequestHandlers.ts#L193-L195) is extended to allow the soket to emit the chat message to all other users.
> • Added this file containing REST endpoints for file upload & download
>• On receiving the 'newChatMessage' by the socket, the controller [calls the sendChatMessage function](https://github.com/yrrah/covey.town/blob/09865aef29a82139b19351ea53e1dd641278a7ba/services/roomService/src/requestHandlers/CoveyTownRequestHandlers.ts#L239-L243) to send the chat data to all the listeners connected to that controller.
6. db.ts

5) files.ts
>• Added this file containing REST endpoints for file upload & download
> • Added this file containing functions to create a shared, persistent connection to the Mongo Database and to cleanup and close the connection upon shutdown.
6) db.ts
>• Added this file containing functions to create a shared, persistent connection to the Mongo Database and to cleanup and close the connection upon shutdown.
7. server.ts

7) server.ts
>• Added call to connect to MongoDB
>• Added call to add file upload/download REST routes
>• Added a cleanup function that is called when the server shuts down to close all open connections
>• Also [changed the signal](https://github.com/yrrah/covey.town/blob/fb75849fbd649ecfd75e9b019c54ce9dfba968b2/services/roomService/package.json#L22) sent by nodemon when it restarts due to code changes to 'SIGINT' to avoid EADDRINUSE errors. With the default signal it would not wait for the server to close connections before starting a new instance.
> • Added call to connect to MongoDB
> • Added call to add file upload/download REST routes
> • Added a cleanup function that is called when the server shuts down to close all open connections
> • Also [changed the signal](https://github.com/yrrah/covey.town/blob/fb75849fbd649ecfd75e9b019c54ce9dfba968b2/services/roomService/package.json#L22) sent by nodemon when it restarts due to code changes to 'SIGINT' to avoid EADDRINUSE errors. With the default signal it would not wait for the server to close connections before starting a new instance.
8) Dependencies Added
>• busboy
>• mongodb
>• supertest
8. Dependencies Added
> • busboy
> • mongodb
> • supertest
### Backend Tests

1) CoveyTownController.test.ts
>• [Notifies](https://github.com/yrrah/covey.town/blob/43d7756555c8b0f29858880664d4760e16afcbb6/services/roomService/src/lib/CoveyTownController.test.ts#L71-L78) added listeners that a new message is sent.
>• [Does not notify](https://github.com/yrrah/covey.town/blob/43d7756555c8b0f29858880664d4760e16afcbb6/services/roomService/src/lib/CoveyTownController.test.ts#L115-L124) removed listener when a new message is sent
>• [Emits 'newChatMessage'](https://github.com/yrrah/covey.town/blob/43d7756555c8b0f29858880664d4760e16afcbb6/services/roomService/src/lib/CoveyTownController.test.ts#L195-L202) to the socekt when a player sends a message.
>• [Forwards player messages](https://github.com/yrrah/covey.town/blob/43d7756555c8b0f29858880664d4760e16afcbb6/services/roomService/src/lib/CoveyTownController.test.ts#L266-L280) to subscribed listeners.
>• [Dispatches message updates](https://github.com/yrrah/covey.town/blob/43d7756555c8b0f29858880664d4760e16afcbb6/services/roomService/src/client/CoveyTownsSocket.test.ts#L81-L96) to all the clients in the same town.
1. CoveyTownController.test.ts

2) CoveyTownsSocket.test.ts
>• [Dispatches message updates](https://github.com/yrrah/covey.town/blob/43d7756555c8b0f29858880664d4760e16afcbb6/services/roomService/src/client/CoveyTownsSocket.test.ts#L81-L96) to all the clients in the same town.
> • [Notifies](https://github.com/yrrah/covey.town/blob/43d7756555c8b0f29858880664d4760e16afcbb6/services/roomService/src/lib/CoveyTownController.test.ts#L71-L78) added listeners that a new message is sent.
> • [Does not notify](https://github.com/yrrah/covey.town/blob/43d7756555c8b0f29858880664d4760e16afcbb6/services/roomService/src/lib/CoveyTownController.test.ts#L115-L124) removed listener when a new message is sent
> • [Emits 'newChatMessage'](https://github.com/yrrah/covey.town/blob/43d7756555c8b0f29858880664d4760e16afcbb6/services/roomService/src/lib/CoveyTownController.test.ts#L195-L202) to the socekt when a player sends a message.
> • [Forwards player messages](https://github.com/yrrah/covey.town/blob/43d7756555c8b0f29858880664d4760e16afcbb6/services/roomService/src/lib/CoveyTownController.test.ts#L266-L280) to subscribed listeners.
> • [Dispatches message updates](https://github.com/yrrah/covey.town/blob/43d7756555c8b0f29858880664d4760e16afcbb6/services/roomService/src/client/CoveyTownsSocket.test.ts#L81-L96) to all the clients in the same town.
3) CoveyTownsREST.test.ts
>• [File related testing](https://github.com/yrrah/covey.town/blob/43d7756555c8b0f29858880664d4760e16afcbb6/services/roomService/src/client/CoveyTownsREST.test.ts#L269-L380)
2. CoveyTownsSocket.test.ts

> • [Dispatches message updates](https://github.com/yrrah/covey.town/blob/43d7756555c8b0f29858880664d4760e16afcbb6/services/roomService/src/client/CoveyTownsSocket.test.ts#L81-L96) to all the clients in the same town.
3. CoveyTownsREST.test.ts
> • [File related testing](https://github.com/yrrah/covey.town/blob/43d7756555c8b0f29858880664d4760e16afcbb6/services/roomService/src/client/CoveyTownsREST.test.ts#L269-L380)
## Frontend

1) App.tsx
>• Moved CoveyAppState logic (unmodified) to components/Town/TownLogic.ts
>• Moved the town page to components/Town/TownPage.tsx
>• In the GameController function, added setup of a chatStateReducer similar to appStateReducer (ChatLogic.ts)
1. App.tsx

> • Moved CoveyAppState logic (unmodified) to components/Town/TownLogic.ts
> • Moved the town page to components/Town/TownPage.tsx
> • In the GameController function, added setup of a chatStateReducer similar to appStateReducer (ChatLogic.ts)
2. TownPage.tsx

> • Pulled MenuBar component up out of VideoOverlay and moved it to the top of the page
> • Added collapisble chat window (ChatPanel.tsx)
> • Added a menu button for chat that gets passed to MenuBar as a prop
3. WorldMap.ts

> • moved from components/world folder
> • [changed scaling](https://github.com/yrrah/covey.town/blob/e3ff46acd87158677948ebb37f87dcd428880a35/frontend/src/components/Town/WorldMap.tsx#L444) of the game map so that it would be responsive to the chat opening or window resizing
4. MenuBar.tsx

2) TownPage.tsx
>• Pulled MenuBar component up out of VideoOverlay and moved it to the top of the page
>• Added collapisble chat window (ChatPanel.tsx)
>• Added a menu button for chat that gets passed to MenuBar as a prop
> • moved instantiation of this menu from VideoOverlay.tsx to TownPage.tsx
> • added a chat button
> • made the menu collapsible and responsive to chat opening and window resizing
3) WorldMap.ts
>• moved from components/world folder
>• [changed scaling](https://github.com/yrrah/covey.town/blob/e3ff46acd87158677948ebb37f87dcd428880a35/frontend/src/components/Town/WorldMap.tsx#L444) of the game map so that it would be responsive to the chat opening or window resizing
5. Snackbar.tsx

4) MenuBar.tsx
>• moved instantiation of this menu from VideoOverlay.tsx to TownPage.tsx
>• added a chat button
>• made the menu collapsible and responsive to chat opening and window resizing
> • changed display location to top left so it doesn't cover up chat
5) Snackbar.tsx
>• changed display location to top left so it doesn't cover up chat
6. ChatLogic.ts

6) ChatLogic.ts
>• Added this file that handles communication with the socket for chat messages
> • Added this file that handles communication with the socket for chat messages
7) ChatPanel.tsx
>• Added this component that is the main chat window
>• Added a saveChat function that allows the user to save all messages and the people who sent them in the existing chat window into a textfile downloaded to their computer
>• Added logic to pause and unpause game whenever the Chat Input command is toggled in order to avoid player movement while typing out messages
7. ChatPanel.tsx

8) ChatCrypto.ts
>• Added this file that handles the encryption and decryption of private and proximity messages
> • Added this component that is the main chat window
> • Added a saveChat function that allows the user to save all messages and the people who sent them in the existing chat window into a textfile downloaded to their computer.
> • Added logic to pause and unpause game whenever the Chat Input command is toggled in order to avoid player movement while typing out messages.
> • Added logic to auto scroll to the bottom when a new message is received
>• Makes use of AES encryption as the encryption algorithm
8. ChatCrypto.ts
> • Added this file that handles the encryption and decryption of private and proximity messages
>• For encryption, a random key is generated which is used to encrypt the message. The key is then concatenated with a key identifier, and the entity as a whole is encrypted using the receiving players player IDs. The encrypted entity is stored in the secretkey set of the payload.
> • Makes use of AES encryption as the encryption algorithm
>• For decryption, the client uses their ID to decrypt the entities in the secretkey set from the payload. When the secretkey identifier is found, the secretkey from the decrypted entity is extracted and used to decrypt the message.
> • For encryption, a random key is generated which is used to encrypt the message. The key is then concatenated with a key identifier, and the entity as a whole is encrypted using the receiving players player IDs. The encrypted entity is stored in the secretkey set of the payload.
>• This strategy of encryption, allows encryption of messages using multiple keys and decryption using any one of those keys.
> • For decryption, the client uses their ID to decrypt the entities in the secretkey set from the payload. When the secretkey identifier is found, the secretkey from the decrypted entity is extracted and used to decrypt the message.
9) Dependencies Added
>• buffer
>• crypto-js
>• http-status-codes
> • This strategy of encryption, allows encryption of messages using multiple keys and decryption using any one of those keys.
9. Dependencies Added
> • buffer
> • crypto-js
> • http-status-codes
### Frontend Tests
1) ChatCryptoTest.test.ts
>• Verifies whether encryption and decryption works through test messages.

1. ChatCryptoTest.test.ts
> • Verifies whether encryption and decryption works through test messages.
## Sequence Diagram for Text Messages
![textchat_sequencediagram](https://github.com/yrrah/covey.town/blob/master/docs/textchat_sequencediagram.png)

![textchat_sequencediagram](https://github.com/yrrah/covey.town/blob/master/docs/textchat_sequencediagram.png)

## Sequence Diagram for File Uploads

![fileupload_sequencediagram](https://github.com/yrrah/covey.town/blob/master/docs/fileupload_sequencediagram.png)

## State Diagram for Chat Feature
![chatfeature_statediagram](https://github.com/yrrah/covey.town/blob/master/docs/chatfeature_statediagram.png)

![chatfeature_statediagram](https://github.com/yrrah/covey.town/blob/master/docs/chatfeature_statediagram.png)

0 comments on commit 2193753

Please sign in to comment.