Whisper chat for me, myself and I
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
chat
fabfile
requirements
static
templates
users
whisper
.coveragerc
.editorconfig
.gitignore
.travis.yml
CODE_OF_CONDUCT.md
Dockerfile
LICENSE
Procfile
README.rst
app.json
docker-compose.yml
flake8.ini
manage.py
pytest.ini
requirements.txt
runtime.txt

README.rst

Whisper

https://travis-ci.org/SavandBros/whisper.svg?branch=master

Basic example of a multi-room chatroom, with messages from all rooms a user is in multiplexed over a single WebSocket connection.

There is no chat persistence; you only see messages sent to a room while you are in that room.

Uses the Django auth system to provide user accounts; users are only able to use the chat once logged in, and this provides their username details for the chatroom.

Some channels can be limited to only "staff" users; the example includes code that checks user credentials on incoming WebSockets to allow or deny them access to chatroom streams based on their staff status.

Installation

Manual installation

Make a new virtualenv for the project, and run:

pip install -r requirements.txt

Then, you'll need Redis running locally; the settings are configured to point to localhost, port 6379, but you can change this in the CHANNEL_LAYERS setting in settings.py.

Finally, run:

python manage.py migrate
python manage.py runserver

Docker installation

Run the app:

docker-compose up -d

The app will now be running on: {your-docker-ip}:8000

Note: You will need to prefix any python manage.py commands with: docker-compose run --rm web. e.g.: docker-compose run --rm web python manage.py createsuperuser

Finally, run:

docker-compose run --rm web python manage.py migrate

Usage

Make yourself a superuser account:

python manage.py createsuperuser

Then, log into http://localhost:8000/admin/ and make a couple of Room objects. Be sure to make one that is set to "staff-only",

Finally, make a second user account in the admin that doesn't have staff privileges. You'll use this to log into the chat in a second window, and to test the authentication on that staff-only room.

Now, open a second window in another browser or in "incognito" mode - you'll be logging in to the same site with two user accounts. Navigate to http://localhost:8000 in both browsers and open the same chatroom.

Now, you can type messages and see them appear on both screens at once. You can join other rooms and try there, and see how you receive messages from all rooms you've currently joined.

If you try and make the non-staff user join your staff-only chatroom, you should see an error as the server-side authentication code kicks in.

How It Works

There's a normal Django view that just serves a HTML page behind the normal @login_required decorator, and that is basically a single-page app with all the JS loaded into the index.html file (as this is an example).

There's a single consumer, which you can see routed to in whisper/routing.py, which is wrapped in the Channels authentication ASGI middleware so it can check that your user is logged in and retrieve it to check access as you ask to join rooms.

Which rooms you are in is kept track of in self.rooms on the consumer so they can be left cleanly if you disconnect.

Whenever the client asks to join a room, leave a room, or send a message, it sends a WebSocket text frame with a JSON encoded command. We use a generic consumer to handle decoding that JSON for us, and then dispatch to one of three handler functions based on what the command is.

All rooms have an associated group, and for joins, leaves and messages, an event is sent over the channel layer to that group. The consumers who are in the group will receive those messages, and the consumer also has handler functions for those (e.g. chat_join), which it uses to encode the events down into the WebSocket wire format before sending them to the client.

Continuous Integration

Like other products or projects of Savand Bros, Whisper uses multiple CI to preform:

  • Running Tests Suite.
  • Running Code Quality Standards.

In case of failure of any the validations checks above, the build will fail and no deployment will happen.

Our pull request & code review flow is also heavily depends on those factors.

Before pushing your code for review, be sure to run the following commands to perform those validations against your local code changes.

fab test cq

Branching

Features: Any new work should be branched out from "master" branch and must be merged back into the "master" branch.

Hot fixes: Fixes should be branched out from "production" branch and must be merged back into "master" and "production".

Branches

Branch production, should be last and stable working code that is on Production servers. All the pull requests (from Master branch) should pass the code checks, including and not limited to:

  • Test Coverage
  • Unit Tess Status
  • Build Status
  • Reviewers Approval

Branch master, should contains the latest development work and should be on staging. All the pull requests (from developers) should pass the code checks, including and not limited to:

  • Test Coverage
  • Unit Tess Status
  • Build Status
  • Reviewers Approval

Deployment

Deployment happens automatically via the CI.

Latest code on master branch will be deployed to the staging, while branch production will be deployed to production server.

Release

To release a new version or have the latest changes on the production:

  • Make a new Pull Request from branch master to production.
  • The pull request should pass (not limited to):
    • Test Coverage
    • Unit Tess Status
    • Build Status
    • Reviewers Approval

After merging the pull request into production, the CI will build and deploy the latest code from production branch to the Production server.

Licensing

Whisper is licensed and distributed under GPLv3.