Catching LearningTask events.

[lukaDoric]

Change goal

The goal of this PR was to enable the backend to capture the following events:

TaskOpened
StepOpened
SubmissionOpened
GuidanceOpened
ExampleOpened
ExampleVideoPlayed
ExampleVideoPaused
ExampleVideoFinished
StepSubmitted
TaskCompleted

Database changes

Add Events table to learningTasks using the following script.

CREATE TABLE "learningTasks"."Events"
(
    "Id" integer NOT NULL GENERATED BY DEFAULT AS IDENTITY ( INCREMENT 1 START 1 MINVALUE 1 MAXVALUE 2147483647 CACHE 1 ),
    "AggregateType" text COLLATE pg_catalog."default" NOT NULL,
    "AggregateId" integer NOT NULL,
    "TimeStamp" timestamp with time zone NOT NULL,
    "DomainEvent" jsonb NOT NULL,
    CONSTRAINT "PK_Events" PRIMARY KEY ("Id")
)

TABLESPACE pg_default;

CREATE INDEX "IX_Events_TimeStamp"
    ON "learningTasks"."Events" USING btree
    ("TimeStamp" ASC NULLS LAST)
    TABLESPACE pg_default;

[Luburic]

Comments inline.

[Luburic]

Will this generate two events (one for the UpdateEvents and another for Update in line 67)?

[Luburic]

Check if this method specifically removes any old events from existence. I do not think this will be the case, but better safe than sorry.

[lukaDoric]

It does not save any events without _progressRepository.UpdateEvents(taskProgress);.

[Luburic]

I think all of these non-state changing methods can be simplified to reduce code duplication. This might not work, as I am writing from memory instead of in an IDE:

public Result PlayExampleVideo(int unitId, int id, int stepId, int learnerId)
{
    return HandleNonStateChangingEvent(unitId, id, stepId, learnerId, (taskProgress, step) => taskProgress.PlayExampleVideo(step));
}

public Result PauseExampleVideo(int unitId, int id, int stepId, int learnerId)
{
    return HandleNonStateChangingEvent(unitId, id, stepId, learnerId, (taskProgress, step) => taskProgress.PauseExampleVideo(step));
}

public Result FinishExampleVideo(int unitId, int id, int stepId, int learnerId)
{
    return HandleNonStateChangingEvent(unitId, id, stepId, learnerId, (taskProgress, step) => taskProgress.FinishExampleVideo(step));
}

private Result HandleNonStateChangingEvent(int unitId, int id, int stepId, int learnerId, Action<TaskProgress, int> action)
{
    var result = GetTaskProgress(unitId, learnerId, id);
    if (result.IsFailed)
        return result.ToResult();

    var taskProgress = result.Value;
    action(taskProgress, stepId);
    _progressRepository.UpdateEvents(taskProgress);

    return UnitOfWork.Save();
}

[lukaDoric]

Nice

[Luburic]

Apart from the issues in the comments below, the PR text was not updated to reflect the required database changes and the TestData SQL script was not updated to delete events.

I will solve the listed issues and resolve the Sonar issues as well.

[Luburic]

Why are these services parametrized?

[Luburic]

Why is the controller parametrized?

[Luburic]

A Test Suite with 300+ lines of code (or really 200+) should be a signal (code smell) for refactoring.

[Luburic]

No need for in the controller. I guess it was caused by a lack of focus, but we cannot parametrize all the layers of our application when we only need a paramterized infrastructure service.

[sonarcloud]

Quality Gate passed

Issues
0 New issues
5 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
4.0% Duplication on New Code

See analysis details on SonarCloud

[Luburic]

🎉 This issue has been resolved in version 2.20.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀