The Game

(Português do Brasil)
Instruções de execução e implantação

Os passos a seguir presumem que vocÊ está utilizando o sistema operacional Windows.

Para maiores informações sobre como executar a aplicação em outros sistemas operacionais, consulte a url a seguir:
https://docs.microsoft.com/pt-br/aspnet/core/fundamentals/environments?view=aspnetcore-5.0

Pré-requisitos
Instale o gerenciador de banco de dados Sql Server
Instale o kit de desenvolvimento de software .NET Core versão 3.1
Ferramentas como Postman ou Advanced REST Client também poderão ser úteis para realizar solicitações aos pontos de acesso da solução
Vale mencionar que a ferramenta Visual Studio 2017 ou posterior é desejável mas não é necessária

Iniciando
Primeiramente, baixe esta solução para a sua máquina.

Como executar esta solução

1. Abra uma janela de comando ("Command prompt") e navegue até o diretório do projeto Web "The Game".
   
2. Em seguida, digite os seguintes comandos:
   set ASPNETCORE_ENVIRONMENT=Development [PRESSIONE A TECLA ENTER]
   dotnet run [PRESSIONE A TECLA ENTER]
   

(Estes comandos irão criar a base de dados, as tabelas, os relacionamentos, a visão de placar dos jogadores e, por último, executar uma carga essencial de dados)

Aqui você já pode testar a aplicação abrindo um navegador de internet e acessando o(s) seguinte(s) endereços:
http://localhost:5000/swagger
http://localhost:5000/api/v1/leaderboards

3. Para gerar uma versão da aplicação candidata para ambiente de produção: Abra uma janela de comando ("Command prompt") e navegue até o diretório da solução "The Game".
   
4. Em seguida, digite os seguintes comandos:
   dotnet build -c release [PRESSIONE A TECLA ENTER]
   set ASPNETCORE_ENVIRONMENT=Production [PRESSIONE A TECLA ENTER]
   dotnet run --no-launch-profile [PRESSIONE A TECLA ENTER]
   

Com esta configuração. a aplicação não disponibiliza a documentação eletrônica Open Api Swagger. Ela aceita somente solicitações dos pontos de acessos relevantes da aplicação. Também, nem migrações nem cargas de banco de dados são realizadas.

Pontos de acesso da aplicação

1. SALVAR DADOS DA PARTIDA DO JOGO
   (POST) http://localhost:5000/api/v1/match -> Este é ponto de acesso para recepção dos dados das partidas de jogos
   Exemplo de corpo da solicitação:
   { "gameId" : 1, "playerId" : 1, "win" : 68000000, "timestamp" : "2021-04-17T14:28:34Z" }

2. OBTER DADOS DE PARTIDAS DE JOGOS (ponto de acesso EXTRA)
   (GET) http://localhost:5000/api/v1/cache-data/game-matches -> Este ponto de acesso retorna todos os dados de partidas de jogos pendentes de persistência na base de dados.

3. OBTER LISTA DE IDS DE JOGOS (ponto de acesso EXTRA)
   (GET) http://localhost:5000/api/v1/cache-data/games -> Este ponto de acesso retorna todos os ids de jogos registrados no sistema
   Útil para criação de solicitações utilizando o ponto de acesso explicado no item 1

4. OBTER LISTA DE IDS DE JOGADORES (ponto de acesso EXTRA)
   (GET) http://localhost:5000/api/v1/cache-data/players -> Este ponto de acesso retorna todos os ids de jogadores registrados no sistema
   Útil para criação de solicitações utilizando o ponto de acesso explicado no item 1

5. PLACAR DOS JOGADORES
   (GET) http://localhost:5000/api/v1/leaderboards -> Este ponto de acesso retorna o placar dos jogadores após o serviço de segundo plano de persistência de pontuações ter executado ao menos uma vez.

6. DOCUMENTAÇÃO DA API (ponto de acesso EXTRA)
   (GET) http://localhost:5000/swagger -> Este ponto de acesso disponibiliza uma documentação atualizada dos pontos de acesso da API através da especificação Swagger OpenAPI. NOTA IMPORTANTE: Este ponto acesso está disponível somente quando a variável de ambiente ASPNETCORE_ENVIRONMENT contém o valor "Development" (vide início do tópico "Como executar esta solução")

Como brincar com esta solução

1. Faça algumas solicitações ao ponto de acesso 1. Você pode utilizar ferramentas como Postman ou Advanced REST Client para fazê-las.
   
2. Neste momento, faça solicitações ao ponto de acesso 2 para verificar que os dados das partidas estão em persistidos em cache. Estes dados eventualmente serão persistidos na base de dados.
   A partir deste momento, você pode continuar enviandos dados para o ponto de acesso 1 e, após aproximadamente 40 segundos, o serviço de segundo de peristência de dados captura os dados daquele momento, sem perder os novos dados que estão chegando.
   Toda vez que o serviço em segundo plano executa, o placar dos jogadores é atualizado e estes dados são armazenados em cache para fins de ganho de performance. Assim que os dados das partidas são persistidos na base de dados, todos os dados processados são removidos do cache, preservando aqueles que ainda não foram processados, esperando a próxima execução do serviço.
   
3. Faça solicitações ao ponto de acesso 5 para obter o placar atualizado dos jogadores

Executando os testes automatizados da solução (unitários e de integração)

1. Abra uma janela de comando ("Command prompt") e navegue até o diretório da solução "The Game".
   
2. Em seguida, digite o seguinte comando:
   dotnet test [PRESSIONE A TECLA ENTER]

---

(English)
Execution and deployment instructions

The steps described below assume you are in a Windows operating system.

For more information about how to run in other operating systems, pelase refer to the following url:
https://docs.microsoft.com/en-us/aspnet/core/fundamentals/environments?view=aspnetcore-5.0

Prerequisites
Please make sure the Sql Server is up and running on your machine.
Also, .Net Core 3.1 SDK must be installed.
Tools like Postman or Advanced REST Client may also come in handy to make requests to the solution endpoints
It's worth to mention that Visual Studio 2017 or later is desirable but not required

Getting started
First things first, download this solution to your machine.

How to run this solution

1. Open command prompt and go to "TheGame" web project directory.
   
2. Next, type the following commands:
   set ASPNETCORE_ENVIRONMENT=Development [HIT ENTER]
   dotnet run [HIT ENTER]
   

(This will create the database along with all tables, relationships, the leaderboards view and will ultimately perform initial data seeds)

You can test the application at this point by opening a web browser and then reaching out to the following url's:
http://localhost:5000/swagger
http://localhost:5000/api/v1/leaderboards

3. Now, to switch to a production environment:
   Open command prompt and go to "TheGame" solution directory.
   
4. Next, type the following commands:
   dotnet build -c release [HIT ENTER]
   set ASPNETCORE_ENVIRONMENT=Production [HIT ENTER]
   dotnet run --no-launch-profile [HIT ENTER]
   

With this setup, the application no longer includes the Open API Swagger documentation. It only accepts requests from the relevant application endpoints. Also, neither migrations nor database loads are performed.

Application endpoints

1. SAVE GAME DATA ENDPOINT
   (POST) http://localhost:5000/api/v1/match -> This is the entry point for receiving game match data
   Request body example:
   { "gameId" : 1, "playerId" : 1, "win" : 68000000, "timestamp" : "2021-04-17T14:28:34Z" }

2. FETCH GAME DATA ENDPOINT (EXTRA endpoint)
   (GET) http://localhost:5000/api/v1/cache-data/game-matches -> This endpoint displays all pending match data that has been posted for later persistence.

3. FETCH A LIST WITH AVAILABLE GAMES IDS (EXTRA endpoint)
   (GET) http://localhost:5000/api/v1/cache-data/games -> This endpoint displays all games ids registered in the system
   Useful for creating requests when using the endpoint explained in item 1

4. FETCH A LIST WITH AVAILABLE PLAYERS IDS (EXTRA endpoint)
   (GET) http://localhost:5000/api/v1/cache-data/players -> This endpoint displays all players ids registered in the system
   Useful for creating requests when using the endpoint explained in item 1

5. LEADERBOARDS
   (GET) http://localhost:5000/api/v1/leaderboards -> This endpoint displays the leaderboards after the database flushing background service has been executed at least once.

6. API DOCUMENTATION (EXTRA endpoint)
   (GET) http://localhost:5000/swagger -> This endpoint makes available the API endpoints live documentation via Swagger OpenAPI. IMPORTANT NOTE: This endpoint is available only when ASPNETCORE_ENVIRONMENT environment variable is set to "Development" (please refer to the beginning of topic "How to run this solution")

How to play with this solution

1. Invoke a couple of times the endpoint 1. You can use a tool like Postman or Advanced REST Client to send some requests to it.
   
2. In this moment, invoke the endpoint 2 to check that match data is in the cache. These are data waiting to be flushed to the database.
   From this moment on, you can keep inserting data and, after approximately 40 seconds, the database flushing service starts its job to persist all match data it can get from cache in that moment, without losing new posted match data.
   Everytime the background service runs, the leaderboards is automatically refreshed and its data is stored in cache for performance. As soon as the game match data is flushed to the database, all processed data are removed from the cache preserving the ones that weren't processed yet, waiting for the next service execution.
   
3. Invoke the endpoint 5 for leaderboards

Running the solution automated tests (both unit and integration ones)

1. Open command prompt and go to "TheGame" solution directory
   
2. Next, type the following command:
   dotnet test [HIT ENTER]