Personalized points goal #1387

mikaelGusse · 2024-08-07T13:26:11Z

Description

What?

Add a feature to the progress bar for modules which allows you to set a points goal for that particular module. When this goal is reached, the points progress bar changes color to blue.

Why?

Was asked for and improves the student experience of using APlus.

How?

Changed templates, added a new class to store points goals, added a modal to the interface to modify and create goals.
Also changed how the points required vertical bar is shown to be clearer.

Fixes #1332

Testing

Remember to add or update unit tests for new features and changes.

How to test your changes in A-plus
How to test accessibility

What type of test did you run?

Added playwright tests to test this feature. Manually tested different combinations of required points, points goals etc.

Did you test the changes in

Chrome
Firefox
This pull request cannot be tested in the browser.

Think of what is affected by these changes and could become broken

Translation

Did you modify or add new strings in the user interface? (Read about how to create translation)

Programming style

Did you follow our style guides?
Did you use Python type hinting in all functions that you added or edited? (type hints for function parameters and return values)

Have you updated the README or other relevant documentation?

documents inside the doc directory.
README.md.
Aplus Manual.
Other documentation (mention below which documentation).

Is it Done?

Reviewer has finished the code review
After the review, the developer has made changes accordingly
Customer/Teacher has accepted the implementation of the feature

Clean up your git commit history before submitting the pull request!

exercise/static/exercise/personalized_points_goal.js

ihalaij1

Nice!

A couple of comments from me, and a question:
Is it currently possible to remove points goals at all?
If not, it should be added as an option for the user.
Maybe setting the goal to zero should remove it completely?

e2e_tests/test_points_goal_set.py

exercise/static/exercise/personalized_points_goal.js

locale/fi/LC_MESSAGES/django.po

locale/en/LC_MESSAGES/django.po

locale/fi/LC_MESSAGES/django.po

exercise/templates/exercise/personalized_points_goal_modal.html

exercise/static/exercise/personalized_points_goal.js

…om review

exercise/views.py

ihalaij1

Good job on the fixes!

Is it possible to check if there exists a points goal when clicking the button, and if it exists, show the Remove-button in the modal? If there is no points goal the button wouldn't be shown.

Also, if a previous goal exists, it would be nice if it was auto-filled into the points goal input field.

locale/fi/LC_MESSAGES/django.po

exercise/static/exercise/personalized_points_goal.js

…oal modal

ihalaij1

Can the Remove button be hidden after it has been clicked? Currently, it's possible to click it more than once, which results in a failure message.

exercise/templatetags/exercise.py

ihalaij1

Nice! Let's wait for @murhum1 to review this too.

murhum1

Added some comments and change requests; might still be missing some, but will check the rest tomorrow!

exercise/views.py

course/models.py

exercise/templates/exercise/_points_progress.html

exercise/static/exercise/module_goal.js

+            if ($progressDiv.length) {
+                const tooltipTitle = $progressDiv.attr('data-original-title');
+                const parser = new DOMParser();
+                const doc = parser.parseFromString(tooltipTitle, 'text/html');


exercise/static/exercise/module_goal.js

+                // Update tooltip
+                const tooltipTitle = $progressDiv.attr('data-original-title');
+                const parser = new DOMParser();
+                const doc = parser.parseFromString(tooltipTitle, 'text/html');


murhum1 · 2024-10-08T09:43:41Z

I added some more fixes:

Renamed the instances of personalized_points_goal_* to module_goal_* to make things more understandable (e.g. personalized_points_module_goal_points is really difficult to mentally parse). I still kept references to "personalized points goal" in UI text as they were since it works better in that context.
Fixed some progress-bar CSS classes to use aplus-progress-bar instead
- Related to that, fixed e2e test CSS selector
Squashed migrations into a single one by deleting the migration files and re-running makemigrations

Is the renaming operation ok for you @mikaelGusse? If so, I'll proceed with the merge.

mikaelGusse · 2024-10-08T10:09:18Z

Yes. All of these changes seem sensible to me. Go ahead and merge 👍

mikaelGusse and others added 4 commits June 13, 2024 14:21

Add option for users to set personalized points goals for modules

82a5f4d

Merge branch 'apluslms:master' into personalized_points_goal

5ffda9a

Personalized points goal improvements

9b61e00

Improve points goal

0ecb44c

github-advanced-security bot found potential problems Aug 7, 2024

View reviewed changes

exercise/static/exercise/personalized_points_goal.js Fixed Show fixed Hide fixed

mikaelGusse force-pushed the personalized_points_goal branch 4 times, most recently from 1d124db to a5103c2 Compare August 8, 2024 10:33

github-advanced-security bot found potential problems Aug 8, 2024

View reviewed changes

exercise/static/exercise/personalized_points_goal.js Fixed Show fixed Hide fixed

mikaelGusse force-pushed the personalized_points_goal branch from a5103c2 to c694072 Compare August 8, 2024 13:08

github-advanced-security bot found potential problems Aug 8, 2024

View reviewed changes

exercise/static/exercise/personalized_points_goal.js Fixed Show fixed Hide fixed

mikaelGusse force-pushed the personalized_points_goal branch 3 times, most recently from c6e7c85 to 2dc4c8e Compare August 9, 2024 07:44

Change points goal saving and modal

c07dbdb

mikaelGusse force-pushed the personalized_points_goal branch from 2dc4c8e to c07dbdb Compare August 9, 2024 07:53

mikaelGusse requested a review from ihalaij1 August 9, 2024 08:49

Fix issue with javascripts in personalized points goal

a2b46c3

mikaelGusse force-pushed the personalized_points_goal branch 3 times, most recently from e8a83ba to bd05872 Compare August 12, 2024 13:31

Add e2e tests for personalized points goal

145ac2f

mikaelGusse force-pushed the personalized_points_goal branch from bd05872 to 145ac2f Compare August 12, 2024 13:40

mikaelGusse self-assigned this Aug 13, 2024

mikaelGusse requested a review from murhum1 August 13, 2024 07:53

Change goal points indicator to black

f0263b6

ihalaij1 requested changes Aug 15, 2024

View reviewed changes

ihalaij1 reviewed Aug 15, 2024

View reviewed changes

exercise/templates/exercise/personalized_points_goal_modal.html Outdated Show resolved Hide resolved

mikaelGusse force-pushed the personalized_points_goal branch from b93cbd1 to 3a4d0d1 Compare August 15, 2024 11:17

github-advanced-security bot found potential problems Aug 15, 2024

View reviewed changes

exercise/static/exercise/personalized_points_goal.js Fixed Show fixed Hide fixed

Added remove option for personalized points goals and fixed issues fr…

debfa75

…om review

mikaelGusse force-pushed the personalized_points_goal branch from 3a4d0d1 to debfa75 Compare August 15, 2024 11:20

github-advanced-security bot found potential problems Aug 15, 2024

View reviewed changes

exercise/views.py Fixed Show fixed Hide fixed

Fix tooltip update on removal

67f5158

mikaelGusse force-pushed the personalized_points_goal branch from 7e200b7 to 67f5158 Compare August 15, 2024 12:15

mikaelGusse requested a review from ihalaij1 August 15, 2024 13:56

ihalaij1 requested changes Aug 19, 2024

View reviewed changes

locale/fi/LC_MESSAGES/django.po Outdated Show resolved Hide resolved

exercise/static/exercise/personalized_points_goal.js Outdated Show resolved Hide resolved

Refinements to delete button and input field in personalized points g…

4172f22

…oal modal

mikaelGusse requested a review from ihalaij1 August 19, 2024 09:37

ihalaij1 requested changes Aug 21, 2024

View reviewed changes

exercise/templatetags/exercise.py Outdated Show resolved Hide resolved

Small fixes to personalized points goal

00cb5b4

ihalaij1 approved these changes Aug 21, 2024

View reviewed changes

ihalaij1 assigned murhum1 and unassigned mikaelGusse Aug 26, 2024

murhum1 requested changes Sep 23, 2024

View reviewed changes

Fixes for personalized points goal

8caddf7

mikaelGusse force-pushed the personalized_points_goal branch from 8326413 to 8caddf7 Compare September 25, 2024 09:39

mikaelGusse requested a review from murhum1 September 25, 2024 10:27

Merge branch 'master' into personalized_points_goal

a49cf4d

github-advanced-security bot found potential problems Oct 8, 2024

View reviewed changes

More student module goal fixes

2f99612

murhum1 force-pushed the personalized_points_goal branch from 867c68a to 2f99612 Compare October 8, 2024 09:06

murhum1 approved these changes Oct 8, 2024

View reviewed changes

murhum1 merged commit 7f509ef into apluslms:master Oct 9, 2024
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Personalized points goal #1387

Personalized points goal #1387

mikaelGusse commented Aug 7, 2024 •

edited

Loading

ihalaij1 left a comment

ihalaij1 left a comment •

edited

Loading

ihalaij1 left a comment

ihalaij1 left a comment

murhum1 left a comment

murhum1 commented Oct 8, 2024

mikaelGusse commented Oct 8, 2024

Personalized points goal #1387

Personalized points goal #1387

Conversation

mikaelGusse commented Aug 7, 2024 • edited Loading

Description

Testing

Translation

Programming style

Have you updated the README or other relevant documentation?

Is it Done?

ihalaij1 left a comment

Choose a reason for hiding this comment

ihalaij1 left a comment • edited Loading

Choose a reason for hiding this comment

ihalaij1 left a comment

Choose a reason for hiding this comment

ihalaij1 left a comment

Choose a reason for hiding this comment

murhum1 left a comment

Choose a reason for hiding this comment

murhum1 commented Oct 8, 2024

mikaelGusse commented Oct 8, 2024

mikaelGusse commented Aug 7, 2024 •

edited

Loading

ihalaij1 left a comment •

edited

Loading