cos301-optimizeprime / cos301_dnd_backend

Backend API for DND State manager

COS301-DND-Backend

Branch	Status
Master
Develop

Backed API Server

Deployment Diagram

Features

• HTTP/2 using gRPC (https://grpc.io/)
• HTTPS in production mode
• Real time sockets
• Firebase authentication
• Strongly typed service and message definition (Protobuf3)
• Easy configuration with TOML
• pep8 Compliance
• Regression testing
• Developer mode (SQLite)
• Production mode (PostgreSQL and PyPy3)
• SystemD service file

Coverage

Name	Stmts	Miss	Cover
main.py	50	5	90%
server/character.py	281	73	74%
server/db.py	167	3	98%
server/firebase.py	4	0	100%
server/helpers.py	181	1	99%
server/log.py	18	0	100%
server/server_pb2.py	186	0	100%
server/session.py	643	200	69%
TOTAL	1530	282	82%

Requirements

sudo apt-get update
sudo apt-get install python3
sudo apt-get install pip3
sudo apt-get install nodejs
sudo apt-get install dart

Installing packages

make install

Running server

make run

Running the tests

make test

Generating code from protobuffers

python -m grpc.tools.protoc -I./protos --python_out=./server --grpc_python_out=./server ./protos/server.proto

Fedora Installation

sudo dnf update
sudo dnf install postgresql-server postgresql-contrib
sudo systemctl enable postgresql
sudo postgresql-setup --initdb --unit postgresql
sudo systemctl start postgresql
pypy -m ensurepip

Arch Linux Installation

pacman -S sudo
sudo pacaman -Syyu
sudo pacman -S postgresql

sudo -u postgres -i
initdb --locale en_US.UTF-8 -E UTF8 -D '/var/lib/postgres/data'
exit

sudo systemctl enable postgresql
sudo systemctl start postgresql
sudo -u postgres -i

createuser --interactive

cos301_dnd_backend's Issues

Check character creation performance.

Experiment/Switch to PyPy

PyPy is a JIT runtime for python programs should in theory help performance as this is a long running app which JIT works best for.

With this some proper profiling should be done to see if any benefits are experienced.

grpcio is not officially supported by PyPy however my tests are so far passing.

Add characters table

Complete kick user from session

Move to SQLAlchemy

Firebase will only be used for authentication.

• migrate existing sessions
• complete all session functionality

Autmatically switch to PostgreSQL for production

Write more tests for character creation.

Leave session removes incorrect user.

Finish session SetName RPC

Leaving a session as the last player should delete the session (Clean orphans)

Add users table

Race condtions causing tests to fail in production mode.

Ready up logic incorrect.

The check if everyone is ready appears to use the count rather than the absolute value. If a player readies up multiple times the server decides that it is ready to start.

Switch versioning scheme

https://calver.org/

Make a docker container to easily distribute

Rate limit API calls

Add rpc calls to get ranges of sessions or characters.

For the lists in the client app we can not request all sessions or all characters as it will overload the device and the server. Currently there is support to limit the amount that gets sent however I should add ability to get the range. The client should then request a further range as it scrolls.

Leaving a session as the dungeon master should promote a other user to become the DM

Verify that only the dungeon master can make changes to the session.

Add a configuration file.

In production I keep editing the code to use the login details of the production database. This should be set in a configuration file.

Change logging so that errors are actual failures and blocked security attempts are rather warnings

Dungeon masters should not be able to join their own session

Optimize for presentiations.

Currently I think there are places where I can improve my database query's. There are also places where I terminate a database connection which should probably be pooled and reuse as connections are usually expensive.

Add password protection to session

Character Creation

Track statistics of RPC calls for analytics.

Finish session SetPrivate RPC

Limit the amount of sessions users can make

Missing attributes in characters

• Gender
• Levels
• Remove subscript

Declare a stable sessions api and deploy to server for app testing.