aspnet-microservice-template/Services/InstructionTests/InstructionTestsService.cs

using AutoMapper;
using GamificationService.Database.Repositories;
using GamificationService.Exceptions.Services.Instruction;
using GamificationService.Exceptions.Services.InstructionTest;
using GamificationService.Models.Database;
using GamificationService.Models.DTO;
using GamificationService.Utils.Enums;

namespace GamificationService.Services.InstructionTests;

public class InstructionTestsService : IInstructionTestsService
{
    private readonly ILogger<InstructionTestsService> _logger;
    private readonly UnitOfWork _unitOfWork;
    private readonly IMapper _mapper;

    public InstructionTestsService(ILogger<InstructionTestsService> logger, UnitOfWork unitOfWork, IMapper mapper)
    {
        _logger = logger;
        _unitOfWork = unitOfWork;
        _mapper = mapper;
    }

    public async Task<InstructionTestDTO> CreateInstructionTest(InstructionTestCreateDTO instructionTest)
    {
        return _mapper.Map<InstructionTestDTO>(await CreateInstructionTest(_mapper.Map<InstructionTest>(instructionTest)));
    }

    public async Task<bool> DeleteInstructionTestByIdAsync(long id)
    {
        var instructionTest = _unitOfWork.InstructionTestRepository.GetByID(id);

        if (instructionTest == null)
        {
            _logger.LogError("Instruction test with id {Id} not found", id);
            throw new InstructionTestNotFoundException();
        }

        // Find all questions 
        var questions = _unitOfWork.InstructionTestQuestionRepository.Get(q => q.InstructionTestId == id);

        // Start transaction
        await _unitOfWork.BeginTransactionAsync();

        foreach (var question in questions)
        {
            _unitOfWork.InstructionTestQuestionRepository.Delete(question);
        }

        // Delete instruction test
        _unitOfWork.InstructionTestRepository.Delete(instructionTest);

        if (await _unitOfWork.SaveAsync())
        {
            await _unitOfWork.CommitAsync();
            _logger.LogInformation("Instruction test deleted ({Id})", id);
            return true;
        }
        else
        {
            _logger.LogError("Failed to delete instruction test ({Id})", id);
            throw new InstructionTestDeletionException();
        }

    }

    public List<InstructionTestResultDTO> GetCompletedInstructionTestsByUserId(long userId)
    {
        var userTestAttempts = _unitOfWork.InstructionTestResultRepository.Get(
            q => q.UserId == userId).ToList();

        var userInstructionTests = _unitOfWork.InstructionTestRepository.Get(
            q => userTestAttempts.Any(a => a.InstructionTestId == q.Id)).ToList();

        var conclusiveUserTestResults = new List<InstructionTestResultDTO>();
        foreach (var instructionTest in userInstructionTests)
        {
            var scoreCalcMethod = instructionTest.ScoreCalcMethod;
            int maxScore = 0;

            if (scoreCalcMethod == InstructionTestScoreCalcMethod.AverageGrade)
            {
                maxScore = (int)Math.Round(userTestAttempts.Where(q => q.InstructionTestId == instructionTest.Id).Average(q => q.Score));
            }
            else
            {
                maxScore = userTestAttempts.Where(q => q.InstructionTestId == instructionTest.Id).Max(q => q.Score);
            }

            if (maxScore >= instructionTest.MinScore)
            {
                conclusiveUserTestResults.Add(_mapper.Map<InstructionTestResultDTO>(userTestAttempts.First(q => q.InstructionTestId == instructionTest.Id)));
            }
        }

        return conclusiveUserTestResults;
    }

    public InstructionTestDTO GetInstructionTestById(long id)
    {
        var instructionTest = _unitOfWork.InstructionTestRepository.GetByID(id);
        if (instructionTest == null)
        {
            _logger.LogError("Instruction test with id {Id} not found", id);
            throw new InstructionTestNotFoundException();
        }
        return _mapper.Map<InstructionTestDTO>(instructionTest);
    }

    public List<InstructionTestQuestionDTO> GetInstructionTestQuestionsByInstructionTestId(long instructionTestId)
    {
        var questions = _unitOfWork.InstructionTestQuestionRepository.Get(q => q.InstructionTestId == instructionTestId);
        return _mapper.Map<List<InstructionTestQuestionDTO>>(questions);
    }

    public List<InstructionTestResultDTO> GetUserInstructionTestResultsByInstructionTestId(long userId, long instructionTestId)
    {
        var userTestResults = _unitOfWork.InstructionTestResultRepository.Get(
            q => q.UserId == userId && q.InstructionTestId == instructionTestId).ToList();
        return _mapper.Map<List<InstructionTestResultDTO>>(userTestResults);
    }

    public List<InstructionTestResultDTO> GetInstructionTestResultsByUserId(long userId)
    {
        var userTestResults = _unitOfWork.InstructionTestResultRepository.Get(
            q => q.UserId == userId).ToList();
        return _mapper.Map<List<InstructionTestResultDTO>>(userTestResults);
    }

    public List<InstructionTestDTO> GetInstructionTestsByInstructionId(long instructionId)
    {
        var instructionTest = (_unitOfWork.InstructionRepository.GetByID(instructionId)
            ?? throw new InstructionNotFoundException())
          .InstructionTest ?? throw new InstructionTestNotFoundException();

        return _mapper.Map<List<InstructionTestDTO>>(new List<InstructionTest>() {instructionTest});
    }

    public async Task<InstructionTestResultDTO> SubmitInstructionTestAsync(long userId, InstructionTestSubmissionDTO submission)
    {
        // Retrieve the test and questions 
        var instructionTest = _unitOfWork.InstructionTestRepository.GetByID(submission.InstructionTestId);
        
        if (instructionTest == null)
        {
            _logger.LogError("Instruction test with id {Id} not found", submission.InstructionTestId);
            throw new InstructionTestNotFoundException();
        }
        
        // Check remaining attempts
        var userTestAttempts = _unitOfWork.InstructionTestResultRepository.Get(
            q => q.UserId == userId && q.InstructionTestId == submission.InstructionTestId).ToList();

        if (userTestAttempts.Count >= instructionTest.MaxAttempts)
        {
            _logger.LogWarning("User {UserId}: denied submission for test {InstructionTestId}: max attempts reached", userId, submission.InstructionTestId);
            throw new InstructionTestSubmissionException();
        }

        var questions = _unitOfWork.InstructionTestQuestionRepository.Get(q => q.InstructionTestId == submission.InstructionTestId).ToList();

        // Verify answers amount
        if (questions.Count != submission.Answers.Count)
        {
            _logger.LogWarning("User {UserId}: denied submission for test {InstructionTestId}: wrong number of answers", userId, submission.InstructionTestId);
            throw new InstructionTestSubmissionException();
        }

        // Evaluate answers
        double score = 0;
        int maxErrorPerQuestion = 1;
        for (int i = 0; i < questions.Count; i++)
        {
            var question = questions[i];

            // User answers for the question without duplicate options
            var answer = submission.Answers[i].Distinct();

            if (question.IsMultipleAnswer)
            {
                int correctUserAnswersCount = 0;
                int incorrectUserAnswersCount = 0;
                int correctAnswersCount = question.CorrectAnswers.Count;

                foreach (var option in answer)
                {
                    if (question.CorrectAnswers.Contains(option))
                    {
                        correctUserAnswersCount++;
                    }
                    else
                    {
                        incorrectUserAnswersCount++;
                    }
                }

                if (incorrectUserAnswersCount > maxErrorPerQuestion || correctUserAnswersCount == 0)
                {
                    // Nothing scored for the question
                    continue;
                }

                // One question is worth 1 point max
                double questionScore = correctUserAnswersCount / (double)correctAnswersCount;

                // Add the question score, or half of it if an error is present
                score += incorrectUserAnswersCount > 0 ? questionScore /= 2 : questionScore;
            }
            else
            {
                score += question.CorrectAnswers.Contains(answer.First()) ? 1 : 0;
            }
        }

        score = Math.Round(score / questions.Count)*100;

        // Add test result
        await _unitOfWork.BeginTransactionAsync();

        InstructionTestResult newTestResult = new InstructionTestResult()
        {
            UserId = userId,
            InstructionTestId = submission.InstructionTestId,
            Score = (int)score
        };

        _unitOfWork.InstructionTestResultRepository.Insert(newTestResult);
        
        if (!await _unitOfWork.SaveAsync())
        {
            _logger.LogError("Failed to save test result for user {UserId} and test {InstructionTestId}", userId, submission.InstructionTestId);
            throw new InstructionTestSubmissionException(); 
        }

        await _unitOfWork.CommitAsync();
        return _mapper.Map<InstructionTestResultDTO>(newTestResult);
    }

    public async Task<bool> UpdateInstructionTest(InstructionTestCreateDTO instructionTest)
    {
        return await UpdateInstructionTest(_mapper.Map<InstructionTest>(instructionTest));
    }

    public async Task<InstructionTest> CreateInstructionTest(InstructionTest instructionTest)
    {
        instructionTest.Id = 0;

        await _unitOfWork.BeginTransactionAsync();

        await _unitOfWork.InstructionTestRepository.InsertAsync(instructionTest);

        if (await _unitOfWork.SaveAsync() == false)
        {
            _logger.LogError("Failure to create instruction test");
            throw new InstructionTestCreationException();
        }

        await _unitOfWork.CommitAsync();

        _logger.LogInformation($"Created instruction test {instructionTest.Id}");
        return instructionTest;
    }

    public async Task<bool> UpdateInstructionTest(InstructionTest instructionTest)
    {
        var existingInstructionTest = _unitOfWork.InstructionTestRepository.GetByID(instructionTest.Id);
        if (existingInstructionTest == null)
        {
            throw new InstructionTestNotFoundException();
        }

        await _unitOfWork.BeginTransactionAsync();

        _unitOfWork.InstructionTestQuestionRepository.DeleteRange(existingInstructionTest.Questions);

        if (await _unitOfWork.SaveAsync() == false)
        {
            _logger.LogError($"Failure to create existing questions for instruction test {instructionTest.Id} during update");
            throw new InstructionTestCreationException();
        }

        _unitOfWork.InstructionTestRepository.Update(instructionTest);

        if (await _unitOfWork.SaveAsync() == false)
        {
            _logger.LogError($"Failure to update instruction test {instructionTest.Id}");
        }

        await _unitOfWork.CommitAsync();

        return true;
    }
}