feat: option to show/hide ungraded assignment in progress page #1380

navinkarkera · 2024-05-06T10:48:05Z

Adds option to show ungraded assignment/problems in progress page.

Private-ref: BB-8824
Product roadmap ticket: [Pull request] Option to include ungraded subsections in progress page platform-roadmap#359
Documentation PR: feat: document mfe_config flag to display ungraded problems in progress page edx-documentation#2268

Test instructions:

Setup tutor nightly locally.
Mount this repository using tutor mounts add /path/to/frontend-app-learning.
Run npm install in this directory.
Run tutor dev launch -I.
Add "SHOW_UNGRADED_ASSIGNMENT_PROGRESS": True, to MFE_CONFIG dict $(tutor config printroot)/env/apps/openedx/settings/lms/development.py
Go to progress tab in any course in learning mfe and confirm that ungraded assignments are displayed.

Screenshots:

SHOW_UNGRADED_ASSIGNMENT_PROGRESS = True

SHOW_UNGRADED_ASSIGNMENT_PROGRESS = False (default)

openedx-webhooks · 2024-05-06T10:48:09Z

Thanks for the pull request, @navinkarkera!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
- This process (including the steps you'll need to take) is documented here.
If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

Dependencies

This PR must be merged before / after / at the same time as ...
Blockers

This PR is waiting for OEP-1234 to be accepted.
Timeline information

This PR must be merged by XX date because ...
Partner information

This is for a course on edx.org.
Supporting documentation
Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/committers-frontend-app-learning. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

The size and impact of the changes that it introduces
The need for product review
Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

codecov · 2024-05-06T10:55:06Z

Codecov Report

Attention: Patch coverage is 92.30769% with 1 line in your changes missing coverage. Please review.

Project coverage is 88.69%. Comparing base (2a58ad2) to head (1686988).
Report is 8 commits behind head on master.

Files with missing lines	Patch %	Lines
src/index.jsx	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1380      +/-   ##
==========================================
- Coverage   88.69%   88.69%   -0.01%     
==========================================
  Files         312      313       +1     
  Lines        5501     5509       +8     
  Branches     1365     1334      -31     
==========================================
+ Hits         4879     4886       +7     
- Misses        605      606       +1     
  Partials       17       17

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

itsjeyd · 2024-05-23T15:22:56Z

Hey @navinkarkera, this seems to be affecting user-facing features -- is there a product proposal for it? If not, you'll need to create one. See Product Review Process to get started.

CC @Agrendalath

Agrendalath · 2024-05-23T15:25:17Z

@itsjeyd, this is still under the client QA, and we'll need to make some adjustments to the current approach. ~~I'll convert this to a draft for now.~~

Edit: I don't have permission to change this to a draft, but please feel free to do this if you can.

itsjeyd · 2024-05-23T15:47:06Z

@Agrendalath I don't have permission to change to draft either, looks like @navinkarkera would have to do it himself.

... this is still under the client QA, and we'll need to make some adjustments to the current approach.

Good to know! If you don't expect to be making massive changes, I'd suggest to get started on the product proposal sooner rather than later, as it can take a while to complete.

navinkarkera · 2024-05-28T11:41:37Z

@Agrendalath @itsjeyd Created a ticket: openedx/platform-roadmap#359 in platform-roadmap GitHub repository

itsjeyd · 2024-05-31T07:36:52Z

Thanks @navinkarkera. I think you'll also need to add a proposal to the wiki (per step 1a of Product Review Process).

CC @ali-hugo @cassiezamparini for confirmation -- the process hasn't changed, right? Starting the product review process requires both a wiki proposal and a road map ticket?

ali-hugo · 2024-06-03T07:37:36Z

@itsjeyd There doesn't seem to be a hard and fast rule about this. I've seen some smaller proposals accepted with just the road map ticket, and no wiki proposal - I think this proposal might fall into that category (like @navinkarkera mentioned on the wg-product-core Slack channel, the change is relatively minor, and reintroduces a legacy feature that's missing from the new MFE).

I will confirm this in the Core Product meeting tomorrow and let you both know.

ali-hugo · 2024-06-05T09:34:56Z

@navinkarkera @itsjeyd Ok, I got some clarification about the review process (I will be updating the wiki procedure soon).

If openedx/platform-roadmap#359 simply reintroduces missing legacy functionality, and does not introduce/change any user-facing features, it does not require a separate wiki proposal (@navinkarkera Can you confirm that this is the case?)

What we do need, is a second reviewer who is not from OpenCraft. Do either of you know of a Product person who might have some experience with the Progress Page?

itsjeyd · 2024-06-06T08:02:03Z

Thanks a lot for the follow-up and info @ali-hugo!

Do either of you know of a Product person who might have some experience with the Progress Page?

I don't, unfortunately.

navinkarkera · 2024-06-06T09:04:37Z

@ali-hugo Thanks for the clarification!

simply reintroduces missing legacy functionality, and does not introduce/change any user-facing features, it does not require a separate wiki proposal (@navinkarkera Can you confirm that this is the case?)

I haven't used this feature before but I think @Agrendalath can confirm that it was part of legacy.

What we do need, is a second reviewer who is not from OpenCraft. Do either of you know of a Product person who might have some experience with the Progress Page?

Unfortunately, no.

ali-hugo · 2024-06-06T13:26:35Z

@navinkarkera I decided to take a look through the screenshots in the meantime. Everything looks good to me! Once we have confirmation that this is indeed a legacy feature, I will find a second person to do a product review.

Agrendalath · 2024-06-06T13:41:30Z

@ali-hugo, this is how ungraded and graded subsections look on the legacy Progress page. We just changed "Practice Scores" to "Ungraded Problem Scores", as the latter is more self-explanatory.

ali-hugo · 2024-06-06T14:04:18Z

@Agrendalath Thanks for the screenshot. That wording update makes sense to me. 👍

@asma-ahmedd Would you mind taking a look through this PR when you have a moment, please? We need a second product thumbs up before it can move forward. Here is a link to the roadmap ticket with some background.

Feel free to reach out to me if you have any questions.

asma-ahmedd · 2024-06-10T05:09:26Z

@ali-hugo
Thank you for including me in this PR. I really appreciate the effort put into it. Here are my thoughts and feedback on the proposal:

Positive Aspect

It's crucial to maintain consistency between the legacy system and the new MFE, and adding the option to display ungraded assignments/problems addresses this need effectively.

Enabling the feature via a flag in MFE_CONFIG allows for easy toggling and testing without affecting the entire system immediately.

The display of ungraded assignment progress will undoubtedly benefit both learners and instructors.

For Learners: Providing visibility into completed and pending ungraded assignments will empower learners to take control of their study schedules and feel a sense of achievement. This, in turn, will foster motivation and encourage continued engagement with course materials.
For Instructors: The ability to track progress on ungraded assignments will provide invaluable insights into learner engagement beyond graded assessments. This will allow instructors to fine-tune their teaching strategies and create content that resonates more effectively with their students.

Recommendations
I suggest considering the use of the terms "Practice Scores" and "Graded Scores," supplemented with tooltips for additional clarity.

Practice Scores (with a tooltip: "Scores from non-graded activities meant for practice and self-assessment.")
Graded Scores (with a tooltip: "Scores from activities that contribute to your final grade.")

Questions
How will we address these specific scenarios?

Scenario where ungraded assignments are closely related to or integrated with graded assessments.
Scenario where learners partially complete an assignment.

Conclusion
Overall, this is a valuable addition to the learning MFE, ensuring continuity and enhancing user experience by incorporating ungraded assignments in the progress view. I support moving forward with this PR and look forward to seeing it in action.

navinkarkera · 2024-06-10T09:13:30Z

@asma-ahmedd Thanks for responding.

Scenario where ungraded assignments are closely related to or integrated with graded assessments.

I believe that all problems under a graded subsection are considered as graded problems except for the problems with weight set to 0 in which case the progress page already shows something like 0/0.

Scenario where learners partially complete an assignment.

Not sure if I understand the question here. I think until a learner completes the problem, no score is awarded which translates to 0 in the progress page.

ali-hugo · 2024-06-10T11:14:13Z

@asma-ahmedd Thanks for the detailed review!

I suggest considering the use of the terms "Practice Scores" and "Graded Scores," supplemented with tooltips for additional clarity.

@navinkarkera

How much additional work would it be to add tooltips?
I quite like "Practice Scores" and "Graded Scores". Do you think they work well?
Out of interest, if we were to change the terms (i.e. "practice scores" and "graded scores"), who would be responsible for updating the docs?

Agrendalath · 2024-06-10T11:29:29Z

@ali-hugo,

Out of interest, if we were to change the terms (i.e. "practice scores" and "graded scores"), who would be responsible for updating the docs?

This is the up-to-date version of this document. We could update the linked section to add information about the option to display ungraded assignments.

cc: @navinkarkera

ali-hugo · 2024-06-10T12:57:48Z

Thanks @Agrendalath 🙂

…ss page Implementation PR: openedx/frontend-app-learning#1380

itsjeyd · 2024-08-08T07:01:55Z

Hey @navinkarkera, any updates on when this PR will be ready to move out of draft state and get a technical review?

navinkarkera · 2024-08-08T12:46:56Z

@itsjeyd @Agrendalath Is planning to deploy this for client's QA this week.

Agrendalath

@navinkarkera, @itsjeyd, we're good to move forward with this.

👍

I tested this: checked that the ungraded assignments are displayed on the Progress page, along with the explanation at the top
I read through the code
I checked for accessibility issues
Includes documentation: feat: document mfe_config flag to display ungraded problems in progress page edx-documentation#2268

Agrendalath · 2024-08-13T22:45:53Z

@navinkarkera, @itsjeyd, who should we ask to review and merge this?

Agrendalath · 2024-09-06T09:20:56Z

@navinkarkera, @itsjeyd, a quick reminder on the ping above ^

itsjeyd · 2024-09-07T08:19:20Z

@Agrendalath Sorry for the late response, I was off when you pinged me and only came back to work earlier this week.

Maintainership for this repo was transferred from 2U (Aurora) to OpenCraft (@bradenmacdonald and @farhaanbukhsh), so the two of them should be able to merge the changes once @navinkarkera marks them as ready and the build turns green.

navinkarkera · 2024-09-10T06:27:49Z

Rebased, ready to be merged.

farhaanbukhsh · 2024-09-10T08:00:55Z

I can review this cc: @itsjeyd @Agrendalath @bradenmacdonald

farhaanbukhsh

@navinkarkera Thank you for the work on the PR, overall the approach looks good but can you look into this one comment

farhaanbukhsh · 2024-10-03T21:19:06Z

src/course-home/progress-tab/grades/detailed-grades/DetailedGrades.jsx

@@ -28,6 +29,11 @@ const DetailedGrades = ({ intl }) => {
  } = useModel('progress', courseId);

  const hasSectionScores = sectionScores.length > 0;
+  const showUngradedAssignments = (


This can be moved to a separate place since this function is getting duplicated.

@farhaanbukhsh Done. 1686988

test: add tests for show ungraded toggle feat: update score label in progress page based on grading refactor: update score label text and add tooltip refactor: move label tooltip near header as normal text refactor: update problem score label Graded scores

itsjeyd · 2024-10-24T08:21:51Z

@farhaanbukhsh This is ready for another review pass :)

farhaanbukhsh · 2024-10-26T02:25:18Z

@farhaanbukhsh This is ready for another review pass :)

on it :)

farhaanbukhsh

👍

Thanks @navinkarkera and @Agrendalath for the persistence.

✅ I tested this on tutor devstack, tested with the flag on and off
✅ I read through the code
✅ I checked for accessibility issues
✅ Includes documentation

…ss page Implementation PR: openedx/frontend-app-learning#1380

* feat: option to show/hide ungraded assignment in progress page test: add tests for show ungraded toggle feat: update score label in progress page based on grading refactor: update score label text and add tooltip refactor: move label tooltip near header as normal text refactor: update problem score label Graded scores * refactor: move config check to utils

…ss page Implementation PR: openedx/frontend-app-learning#1380

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label May 6, 2024

navinkarkera force-pushed the navin/show-ungraded-progress branch 2 times, most recently from 62e36e7 to bc3c4eb Compare May 10, 2024 09:28

navinkarkera mentioned this pull request May 10, 2024

feat: option to show/hide ungraded assignment in progress page open-craft/frontend-app-learning#14

Merged

itsjeyd added the core contributor PR author is a Core Contributor (who may or may not have write access to this repo). label May 23, 2024

itsjeyd added the product review PR requires product review before merging label May 23, 2024

navinkarkera marked this pull request as draft May 28, 2024 07:09

navinkarkera force-pushed the navin/show-ungraded-progress branch from bc3c4eb to 993ab24 Compare May 28, 2024 07:45

navinkarkera mentioned this pull request May 28, 2024

[Pull request] Option to include ungraded subsections in progress page openedx/platform-roadmap#359

Open

navinkarkera force-pushed the navin/show-ungraded-progress branch from 993ab24 to 26e9860 Compare June 10, 2024 13:26

navinkarkera added a commit to open-craft/edx-documentation that referenced this pull request Jun 10, 2024

feat: document mfe_config flag to display ungraded problems in progre…

8cd1f33

…ss page Implementation PR: openedx/frontend-app-learning#1380

Agrendalath approved these changes Aug 8, 2024

View reviewed changes

navinkarkera mentioned this pull request Aug 12, 2024

feat: option to show/hide ungraded assignment in progress page open-craft/frontend-app-learning#29

Merged

navinkarkera marked this pull request as ready for review September 10, 2024 06:26

navinkarkera force-pushed the navin/show-ungraded-progress branch from bd4715b to c484d0c Compare September 10, 2024 06:27

farhaanbukhsh self-requested a review September 10, 2024 08:01

itsjeyd added the waiting for eng review PR is ready for review. Review and merge it, or suggest changes. label Sep 20, 2024

farhaanbukhsh requested changes Oct 3, 2024

View reviewed changes

itsjeyd added waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. and removed waiting for eng review PR is ready for review. Review and merge it, or suggest changes. labels Oct 11, 2024

navinkarkera added 2 commits October 17, 2024 10:05

refactor: move config check to utils

1686988

navinkarkera force-pushed the navin/show-ungraded-progress branch from c484d0c to 1686988 Compare October 17, 2024 05:16

itsjeyd requested a review from farhaanbukhsh October 17, 2024 07:41

itsjeyd added waiting for eng review PR is ready for review. Review and merge it, or suggest changes. and removed waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. labels Oct 17, 2024

farhaanbukhsh approved these changes Oct 31, 2024

View reviewed changes

farhaanbukhsh merged commit e69114a into openedx:master Oct 31, 2024
8 checks passed

farhaanbukhsh deleted the navin/show-ungraded-progress branch October 31, 2024 10:18

Agrendalath pushed a commit to open-craft/edx-documentation that referenced this pull request Oct 31, 2024

feat: document mfe_config flag to display ungraded problems in progre…

1ed4568

…ss page Implementation PR: openedx/frontend-app-learning#1380

feanil pushed a commit to openedx/edx-documentation that referenced this pull request Nov 4, 2024

feat: document mfe_config flag to display ungraded problems in progre…

975a290

…ss page Implementation PR: openedx/frontend-app-learning#1380

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: option to show/hide ungraded assignment in progress page #1380

feat: option to show/hide ungraded assignment in progress page #1380

navinkarkera commented May 6, 2024 •

edited

Loading

openedx-webhooks commented May 6, 2024 •

edited

Loading

codecov bot commented May 6, 2024 •

edited

Loading

itsjeyd commented May 23, 2024

Agrendalath commented May 23, 2024 •

edited

Loading

itsjeyd commented May 23, 2024 •

edited

Loading

navinkarkera commented May 28, 2024

itsjeyd commented May 31, 2024 •

edited

Loading

ali-hugo commented Jun 3, 2024

ali-hugo commented Jun 5, 2024

itsjeyd commented Jun 6, 2024

navinkarkera commented Jun 6, 2024

ali-hugo commented Jun 6, 2024 •

edited

Loading

Agrendalath commented Jun 6, 2024 •

edited

Loading

ali-hugo commented Jun 6, 2024

asma-ahmedd commented Jun 10, 2024

navinkarkera commented Jun 10, 2024

ali-hugo commented Jun 10, 2024

Agrendalath commented Jun 10, 2024

ali-hugo commented Jun 10, 2024

itsjeyd commented Aug 8, 2024

navinkarkera commented Aug 8, 2024

Agrendalath left a comment

Agrendalath commented Aug 13, 2024

Agrendalath commented Sep 6, 2024

itsjeyd commented Sep 7, 2024 •

edited

Loading

navinkarkera commented Sep 10, 2024

farhaanbukhsh commented Sep 10, 2024

farhaanbukhsh left a comment •

edited

Loading

farhaanbukhsh Oct 3, 2024

navinkarkera Oct 17, 2024

itsjeyd commented Oct 24, 2024

farhaanbukhsh commented Oct 26, 2024

farhaanbukhsh left a comment

feat: option to show/hide ungraded assignment in progress page #1380

feat: option to show/hide ungraded assignment in progress page #1380

Conversation

navinkarkera commented May 6, 2024 • edited Loading

openedx-webhooks commented May 6, 2024 • edited Loading

What's next?

🔘 Get product approval

🔘 Provide context

🔘 Get a green build

🔘 Let us know that your PR is ready for review:

Who will review my changes?

Where can I find more information?

When can I expect my changes to be merged?

codecov bot commented May 6, 2024 • edited Loading

Codecov Report

itsjeyd commented May 23, 2024

Agrendalath commented May 23, 2024 • edited Loading

itsjeyd commented May 23, 2024 • edited Loading

navinkarkera commented May 28, 2024

itsjeyd commented May 31, 2024 • edited Loading

ali-hugo commented Jun 3, 2024

ali-hugo commented Jun 5, 2024

itsjeyd commented Jun 6, 2024

navinkarkera commented Jun 6, 2024

ali-hugo commented Jun 6, 2024 • edited Loading

Agrendalath commented Jun 6, 2024 • edited Loading

ali-hugo commented Jun 6, 2024

asma-ahmedd commented Jun 10, 2024

navinkarkera commented Jun 10, 2024

ali-hugo commented Jun 10, 2024

Agrendalath commented Jun 10, 2024

ali-hugo commented Jun 10, 2024

itsjeyd commented Aug 8, 2024

navinkarkera commented Aug 8, 2024

Agrendalath left a comment

Choose a reason for hiding this comment

Agrendalath commented Aug 13, 2024

Agrendalath commented Sep 6, 2024

itsjeyd commented Sep 7, 2024 • edited Loading

navinkarkera commented Sep 10, 2024

farhaanbukhsh commented Sep 10, 2024

farhaanbukhsh left a comment • edited Loading

Choose a reason for hiding this comment

farhaanbukhsh Oct 3, 2024

Choose a reason for hiding this comment

navinkarkera Oct 17, 2024

Choose a reason for hiding this comment

itsjeyd commented Oct 24, 2024

farhaanbukhsh commented Oct 26, 2024

farhaanbukhsh left a comment

Choose a reason for hiding this comment

navinkarkera commented May 6, 2024 •

edited

Loading

openedx-webhooks commented May 6, 2024 •

edited

Loading

codecov bot commented May 6, 2024 •

edited

Loading

Agrendalath commented May 23, 2024 •

edited

Loading

itsjeyd commented May 23, 2024 •

edited

Loading

itsjeyd commented May 31, 2024 •

edited

Loading

ali-hugo commented Jun 6, 2024 •

edited

Loading

Agrendalath commented Jun 6, 2024 •

edited

Loading

itsjeyd commented Sep 7, 2024 •

edited

Loading

farhaanbukhsh left a comment •

edited

Loading