herringthecoder / judge-em-api

Hi there 👋

judge-em-api's Issues

Update project to .NET 5.0

• updated all projects and dependencies to .NET 5.0
• updated dockerfile base/build images

Setting up testing

We should set up a project for testing (preferably with xUnit) and integrate it with some simple CI like Github Actions

Making repositories atomic (aka not pointless)

Queries should stay inside repositories and stop returning IQueryable.

Connecting to the game room

• User should be able to connect to the game room using pre-generated unique code and register to the broadcast group associated with the room.
• User should be able to add or remove items before the game has started
• User should be notified of other players joining

Handling 5xx HTTP Errors with custom message

Assigning users to the game

Users should be assigned to game not only by temporary membership, but also by a relationship, i.e. by intermediate "Players" table (id, nickname, user_id, game_id)

Refactoring entity-response mapping

Response models should be independent of database entities, so there need to be some intermediate classes (maybe extensions?) mapping models to responses.
Automapper would be another solution, but I have to test whether it's necessary to bring reflection-heavy mechanism here.

Set up more precise validation rules for incoming requests

We need to specify validation rules for incoming requests for creating and modifying entities.

Authorization module

Client should be able to authorize using JWT tokens provided by API

Logging into system should be possible in two ways:

1. Using Facebook/Google

• On valid authorization if no associated email (provided by fb/google) was found in database, then it should be automatically registered.

2. Using temporary Guest token
   -Maybe guest does not need to be stored in database? (TBD)

On valid authorization, the API should response with token containing encoded user data and assigned custom roles.
Example role names:

• AuthorizedUser
• Guest
• Master

Note: when issuing a token, it might be useful to provide standard Role Claim using built-in ClaimTypes
https://docs.microsoft.com/en-us/dotnet/api/system.security.claims.claimtypes.role?view=netcore-3.1
It will simplify role-based authorization on Controllers and Hubs.
All necessary services should be placed in Authorization project.

Add default WSL2 config

test

Creating database schema

Database should contain following entities (with proposed field implementation):

• User (id, email, nick, name, providerId, providerName)
• Game (id, name, code, masterId, startedAt, finishedAt)
• Summary (gameId, data)
• Rating (id, score, itemid, userId, categoryId)
• Category (id, name, weight)
• Item (id, name, description, imageLink, gameId)

Schema should be implemented by model-first approach in Storage project using Entity Framework Core.

Creating a seeder for local testing

We could use a seeder for local testing.
It needs to populate all database tables and attach relations between entities.

Game summary

• Each game should end with generating a summary of a game.
  The summary should be cached in database and linked to a game room and pushed to the users.
  Sample idea of summary response:

{
   "room_name":"someName",
   "items":[
      {
         "name":"someItemName",
         "meanRating":"meanRatingValueForItem",
         "ratings":[
            {
               "userName1":"ratingValue1"
            },
            {
               "userName2":"ratingValue2"
            }
         ]
      }
   ]
}

Implementing CQRS pattern

Because overengineering is fun

Adding endpoints for crud operations

We need to add endpoints for crud operations on:

• categories
• summaries
• games

Initiating project

Solution should be pushed to 'dev' branch containing at least 4 projects:

• API (gate with hubs and controllers and configured HostBuilder)
• Storage (storing database context, entities)
• Core (containing business logic i.e. Services, Repositiories, Interfaces)
• Authorization (separated library for handling authorization logic)

Note: Registering DI should be preferably self-contained (via ServiceCollectionExtension)

Setting up reviewed categories

• Master should be able to assign reviewed categories and add numerical weights.

Updating Github Actions pipeline to support .NET 5

• updated dotnet-version

Nullable Datetime

By the current service logic, the DateTime fields on Games table should be nullable.

Arranging game room

• Registered user should be able to create a game room resulting in unique code generation and him becoming current game master.
  The connection to game rooms should be WebSocket based, preferably using SignalR Hubs.

Adding Hub Filters

.NET 5.0 Hub filters can simplify Hub methods code by checking gameId and returning early errors to clients if game was not found or is not active.

Add direct relation between game and categories

The categories should be directly assigned to a game by database relation.

Game flow

• Game master should be able to change the current reviewed item for all players
• Players should be able to place a vote on the currently reviewed item
• Players should be able to see how many players have already voted

Saving rating categories as template

• It would be nice to be able to save and load a template containing a set of categories as a registered user.

Swagger

Swagger should be implemented as api auto documentation

Adding more tests

We should:

• Cover existing services with unit tests
• Create SignalR Hubs integration tests