feat: tutorial self enrolment task feature #306

b0ink · 2025-04-16T05:19:08Z

Description

This feature will allow staff to enable the "Tutorial self enrolment" feature for a designated task. Staff will select which tutorial stream(s) to fetch the tutorials from, and students will be prompted with the list of tutorials they must choose from to complete the task.

Type of change

New feature (non-breaking change which adds functionality)
This change requires a documentation update

How Has This Been Tested?

Ensure you are also using the API branch:
thoth-tech/doubtfire-api#64

Login as aadmin
Select any unit and any task to edit
Scroll to the "Tutorial enrolment form" and enable it
Select a tutorial stream that has a atleast a few tutorials
If there are no tutorial streams to choose from or the stream has no tutorials, manually add them in the in the tutorials tab.
Save the changes to the task after enabling the self enrolment form.
Now login as student_1, and navigate to the same unit and task you enabled the form for.
Click on "Begin enrolment", and confirm the list of tutorials show up. Do note that some tutorials may not show up for a student based on their campus. Eg. if a student is based on campus X, but the tutorial is only available for campus Y, the student will not see it.
Select a tutorial and click enrol.
If it says you have already been enrolled, you can navigate to the Tutorial List and withdraw yourself from the unit, then go back to the task to begin tutorial enrolment, and select a tutorial

Testing Checklist:

Tested in latest Chrome
Tested in latest Safari
Tested in latest Firefox

Checklist:

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented my code in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have requested a review from @macite and @jakerenzella on the Pull Request

returnMarcco · 2025-04-20T03:26:24Z

Hi @b0ink,

Good work!
In reviewing your PR, I've completed the following:

Checklist

Screenshots

Suggested Changes

The wording in the following screenshot could probably be simplified. I suggest something along the lines of "Please select a tutorial".
Question: When enrolling in a tutorial, should every task then show the green 'You're enrolled...' text as it does now?

Summary

The feature functions as expected, no obvious errors or design decisions. I was able to successfully enrol/withdraw from a tutorial. Each task correctly shows when a tutorial has been enrolled in. Good work. I'll approve this once I've been assigned as a reviewer for this PR.

EkamBhullar · 2025-04-20T14:33:54Z

Hey @b0ink, I have reviewed the PR, and the UI and functionality is working as expected. I have tested in following web browsers

Tested in latest Chrome
Tested in latest Safari

Screenshot

Great work overall! I was able to enroll and then withdraw without much hassle.

…rolment

returnMarcco · 2025-05-16T09:03:13Z

Hi @b0ink,

I've been assigned to re-review your PR as a 'senior reviewer'.

I've completed the following steps:

Checklist

Findings

I've come across some potential issues. The main thing here is to determine whether the issue is in my development environment, or there's actually bugs in the code.

Potential error: When I enable Tutorial Enrolment and select a Tutorial Stream, I can save it with a 200 response. The problem is, when I reload the page, the checkbox seems to have reverted to not being selected anymore as if no changes were saved.
Pontential error: When logging in as student_1 and navigating to the task and assignment I've configured the Tutorial Enrolment for in the previous step, the Begin enrolment button doesn't seem to be visible anywhere. Please see the screenshot below.
Potential syntax issue: Seemingly incorrect event binding here. It seems to me that the square brackets around the selectionchange attribute should be parenthesis, which would bind the onSelectStream() event handler to the mat-select component the attribute belongs to. Please correct me if I'm wrong.
Potential unrelated error: When logging in as a student and navigating a unit, the following type errors are thrown from the component in the screenshot. I am unsure if this has anything to do with your changes, or if this will affect your changes at all.
As a side note, there are multiple console.logs remaining in the task-definition-tutorial-enrolment.component.ts file.

Can you please see if you are able to reproduce the above errors on your end and get back to me, then we can go from there.

Cheers.

returnMarcco · 2025-05-15T12:19:56Z

...on-editor/task-definition-tutorial-enrolment/task-definition-tutorial-enrolment.component.ts

+  public onSelectStream(): void {
+    const selectedStream = this.tutoralStreamControl.value;
+    if (selectedStream) {
+      console.log(selectedStream);


This log should probably be removed

returnMarcco · 2025-05-15T12:20:14Z

...on-editor/task-definition-tutorial-enrolment/task-definition-tutorial-enrolment.component.ts

      this._tutorialStreams.push(stream);
    }
+
+    console.log(this.taskDefinition.tutorialSelfEnrolmentStream);


This log should probably be removed.

returnMarcco · 2025-05-15T12:20:27Z

...on-editor/task-definition-tutorial-enrolment/task-definition-tutorial-enrolment.component.ts

    const tutorialStreams = this.taskDefinition.unit.tutorialStreamsCache.currentValues;
    console.log(tutorialStreams);
    for (const stream of tutorialStreams) {
      console.log(stream);


This log should probably be removed.

returnMarcco · 2025-05-15T12:23:18Z

...on-editor/task-definition-tutorial-enrolment/task-definition-tutorial-enrolment.component.ts

+
+  public ngOnInit(): void {
+    const tutorialStreams = this.taskDefinition.unit.tutorialStreamsCache.currentValues;
+    console.log(tutorialStreams);


This log should probably be removed.

returnMarcco · 2025-05-19T07:16:16Z

I've accidentally approved these changes and cannot revert this due to not having write access. I'll reach out to Nebula to revert this.

b0ink added 9 commits April 9, 2025 17:32

feat: task definition toggle for tutorial enrolment feature

9053c80

feat: add task card to prompt tutorial enrolment

2b99b06

fix: typo

2cbb3d9

chore: improve wording

c02d8a1

feat: add tutorial enrolment modal

7f77750

feat: check for existing tutorial enrolment

c9a8ae9

fix: typo

90693f1

feat: enrol student into tutorial

344fac2

feat: disable enrolment button if no tutorial selected

9a0feef

feat: add new schema properties

15ba574

b0ink force-pushed the feat/tutorial-self-enrolment branch from de37b87 to 15ba574 Compare May 7, 2025 06:18

b0ink added 3 commits May 7, 2025 16:22

Merge remote-tracking branch 'thoth/8.0.x' into feat/tutorial-self-en…

6f12dcf

…rolment

refactor: map stream abbreviation to tutorial stream object

83d5c07

chore: replace debug stream with live data

95815d0

b0ink marked this pull request as ready for review May 14, 2025 06:40

b0ink mentioned this pull request May 14, 2025

feat: tutorial self enrolment task feature thoth-tech/doubtfire-api#64

Open

1 task

b0ink added 2 commits May 14, 2025 16:50

fix: remove debug

4a92dc0

fix: remove unused var

dcef998

returnMarcco approved these changes May 19, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: tutorial self enrolment task feature #306

feat: tutorial self enrolment task feature #306

Uh oh!

b0ink commented Apr 16, 2025 •

edited

Loading

Uh oh!

returnMarcco commented Apr 20, 2025 •

edited

Loading

Uh oh!

EkamBhullar commented Apr 20, 2025

Uh oh!

returnMarcco commented May 16, 2025 •

edited

Loading

Uh oh!

returnMarcco May 15, 2025

Uh oh!

returnMarcco May 15, 2025

Uh oh!

returnMarcco May 15, 2025

Uh oh!

returnMarcco May 15, 2025

Uh oh!

returnMarcco commented May 19, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feat: tutorial self enrolment task feature #306

Are you sure you want to change the base?

feat: tutorial self enrolment task feature #306

Uh oh!

Conversation

b0ink commented Apr 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of change

How Has This Been Tested?

Testing Checklist:

Checklist:

Uh oh!

returnMarcco commented Apr 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Screenshots

Suggested Changes

Summary

Uh oh!

EkamBhullar commented Apr 20, 2025

Screenshot

Uh oh!

returnMarcco commented May 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Findings

Uh oh!

returnMarcco May 15, 2025

Choose a reason for hiding this comment

Uh oh!

returnMarcco May 15, 2025

Choose a reason for hiding this comment

Uh oh!

returnMarcco May 15, 2025

Choose a reason for hiding this comment

Uh oh!

returnMarcco May 15, 2025

Choose a reason for hiding this comment

Uh oh!

returnMarcco commented May 19, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

b0ink commented Apr 16, 2025 •

edited

Loading

returnMarcco commented Apr 20, 2025 •

edited

Loading

returnMarcco commented May 16, 2025 •

edited

Loading