jvanderen1 / cli_chat

CLI Chat

Introduction

This project is the culmination of work done by Joy Tan, Grant Savage, Joshua Van Deren, and Yen-Hung Lai for the Spring 2018 classes of SE420 Software Quality Assurance and SE310 Software Analysis and Design at Embry-Riddle Aeronautical University. This project is an interactive command line chat. It uses the web socket protocol to send and receive messages from multiple users. Our client application and server implementation will allow clients to send private messages to each other and join rooms to group chat with other users. Our system will also allow users to block other users. This project is currently in development and bugs will be present.

Quick Start Installation

To install the required dependencies for both client and server run the install.sh shell script by running ./install.sh. You may need to change permissions on the file to run it. To do this run chmod 755 install.sh.

Running the System

In order to run the system and interact with it, a total of 3 terminal sessions (tabs) are needed. 1 to run the server and 1 to 2 run the clients. Instructions on how to run on both the client and server are included in the README files under both the client and server directories under the src directory.

Running Tests

To run the tests, cd into the root directory and run npm test.

cli_chat's Issues

Bug: room list not updating

Code modularization of client code (separated one big file into multiple smaller files) resulted in rooms not being saved. The array storing the list of existing rooms is not updating and always reports an empty list.

Bug: privateMessage doesn't come through when in question

Relating to issue #5

When user receives message, while in a question, the content of the message is not pushed through.

Logical error: group messaging

Group message sends to users who used to be in room but are not currently in room (they left the room but still receive group messages from room)

Bug: 'Successful event' message prints after menu is printed

Example: When a user joins a room, and the event is successful, the "Joined room [room name]" message does not get printed until after the menu prints again instead of before.

Logical error: rooms

Created rooms do not appear to those who connect to the server after rooms have been made

Unexpected: prompt prints out if user is interrupted, even in middle of question

Example

- Client A and B connect
- Client A selects "Send Message to User/Room"
- Client B selects "Send Message to User/Room"
- Client B sends message to Client A
- Client A receives message
- ( Unexpected ) Client A prints prompt

Feature: no server message

If a client attempts to connect to a non-existent room, they should be alerted with a message.

Logical Error: incorrect input continues prompt

Example

- Client A selected "Send Message to User/Room"
- Client A selects incorrect option
- ( Logical Error ) Prompt still continues

Bug: prompt is not printed after invalid entry for creating a room

If user tries to create a new room and names it "NONE", the program prints out an error message but does not re-print the prompt to let the user continue using the application.

Bug: User list is not updating

The array of current users is not updating and when choosing the menu option to list the users, it constantly says "No other users online." no matter how many users are connected to the server.

Logical Error: send message

Not supposed to let user send messages to themselves