Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: update the misleading proctoring verified message #63

Merged
merged 1 commit into from
Apr 6, 2022

Conversation

arslanashraf7
Copy link
Contributor

@arslanashraf7 arslanashraf7 commented Mar 16, 2022

Related Ticket:

mitodl/mitxonline#374

What's this PR do?

  • Updates a message that can be a bit misleading when the proctored exams have been reviewed and the grades haven't been published yet.
  • The message is changed from Your proctoring session was reviewed successfully. Go to your progress page to view your exam grade. to Your proctoring session was reviewed successfully. A final grade will be available soon.

Testing Instructions:

  • Create a proctored exam through the studio and take it to verified state. (You can follow the instructions here)
  • Check out this branch inside your devstack /frontend-app-learning/packages (If packages dir doesn't exist you can create one, that's easy to test it around)
  • Create a file named module.config.js inside your /frontend-app-learning directory and add the following:
module.exports = {
  localModules: [
    { moduleName: '@edx/frontend-lib-special-exams', dir: './packages/frontend-lib-special-exams', dist: 'src' },
  ],
};
  • In your terminal restart that frontend-app-learning container e.g. docker-compose restart frontend-app-learning

Documentation/Discussion:

A relevant discussion can be seen on this ticket

Reviewer Note:

  • Since this is a text/message change so this might be something that might require input from the product team too.

Screenshot:

New
Screenshot 2022-03-31 at 5 23 28 PM

Old
proctored_reviewed_old

@openedx-webhooks openedx-webhooks added needs triage open-source-contribution PR author is not from Axim or 2U labels Mar 16, 2022
@openedx-webhooks
Copy link

Thanks for the pull request, @arslanashraf7! I've created OSPR-6526 to keep track of it in JIRA, where we prioritize reviews. Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@natabene
Copy link

@arslanashraf7 Thank you for your contribution. Let's see how tests turn out.

@openedx-webhooks openedx-webhooks added waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. and removed needs triage labels Mar 18, 2022
@zacharis278
Copy link
Contributor

@arslanashraf7

Some feedback on the language here. I think Exams are being reviewed may be misleading to learners as other messaging about the review is referring the the state of their proctoring session. In this case Your proctoring session was reviewed successfully is an accurate statement we would like to affirm to avoid confusion.

The case brought up in the ticket makes sense, would we be able to simply modify the second statement regarding grades to be a bit more generic to fit your use case?

@openedx-webhooks openedx-webhooks added changes requested and removed waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. labels Mar 18, 2022
@arslanashraf7
Copy link
Contributor Author

@zacharis278 Thanks for taking a look at this.

In this case Your proctoring session was reviewed successfully is an accurate statement we would like to affirm to avoid confusion.

This also makes sense.

The case brought up in the ticket makes sense, would we be able to simply modify the second statement regarding grades to be a bit more generic to fit your use case?

For the above, let me take input from @pdpinch

@@ -6,8 +6,7 @@ const VerifiedProctoredExamInstructions = () => (
<h3 className="h3" data-testid="proctored-exam-instructions-title">
<FormattedMessage
id="exam.VerifiedProctoredExamInstructions.title"
defaultMessage={'Your proctoring session was reviewed successfully. '
+ 'Go to your progress page to view your exam grade.'}
defaultMessage={'Exams are being reviewed and a final grade will be available soon.'}
Copy link

@pdpinch pdpinch Mar 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about this @sfrucht @shellyu ?

Suggested change
defaultMessage={'Exams are being reviewed and a final grade will be available soon.'}
defaultMessage={'Your exam was submitted successfully. Exams are being reviewed and a final grade will be available soon.'}

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this. I realize it's more vague than the 'reviewed' version, but it is still accurate, and and won't lead learners to think they have definitely passed review when we still may fail them for cheating.

Copy link
Contributor Author

@arslanashraf7 arslanashraf7 Mar 24, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PR has been updated with the suggested text and the screenshots in the description have also been updated.

Copy link
Contributor

@zacharis278 zacharis278 Mar 25, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a bit unclear on the change from reviewed to submitted. There already exists a view that will confirm successful submission prior to a review being completed (SubmittedProctoredExamInstructions). This view however is only shown after the review has been verified is that not what's happening?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@zacharis278 we want to try to make a distinction between reviewed by the proctoring provider and reviewed by the course team.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is there any state in the platform we can inspect to know if these attempts require the additional course team review step? Maybe a new interstitial page to account for that state? My overall concern here is we rely on these messages to communicate if the exam is awaiting review (submitted), or has been rejected/verified. This change would make attempts appear to be 'submitted' indefinitely.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@zacharis278 There is not really an interstitial state. The course team does a lot of review and grade calculation after the proctoring review by the proctoring vendor. I see your point that you don’t want the reviews to appear to be in a submitted state indefinitely. If you feel that the first statement should remain ‘Your proctoring session was reviewed successfully.’ then we are okay with that as long as the second sentence is ‘A final grade will be available soon.’

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sfrucht ‘A final grade will be available soon.’ would be good, we'd just like to avoid losing the first statement for all exams. Let me run this past the team but I don't expect any issues with that change.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@zacharis278 I've updated the text based on the above discussion. Screenshots are also added in the PR description.

@arslanashraf7
Copy link
Contributor Author

@natabene Could you re-run the tests? I don't think I have permission to run them.

@arslanashraf7
Copy link
Contributor Author

@zacharis278 Could you review this PR?

@natabene
Copy link

@arslanashraf7 I kicked off the tests again.

@codecov
Copy link

codecov bot commented Mar 25, 2022

Codecov Report

Merging #63 (212b25c) into main (6a0b61e) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #63   +/-   ##
=======================================
  Coverage   88.63%   88.63%           
=======================================
  Files          68       68           
  Lines         906      906           
  Branches      242      242           
=======================================
  Hits          803      803           
  Misses         96       96           
  Partials        7        7           
Impacted Files Coverage Δ
...octored_exam/VerifiedProctoredExamInstructions.jsx 100.00% <ø> (ø)

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

@natabene
Copy link

@zacharis278 Does this PR need anything else or is it fit to merge?

@zacharis278
Copy link
Contributor

@natabene left a comment in the thread above. I still have some questions about the proposed language change.

@pdpinch
Copy link

pdpinch commented Apr 1, 2022

@arslanashraf7 can you squash your commits? And a nit: I think this is a "fix" not a "refactor", but I could be wrong.

@arslanashraf7 arslanashraf7 force-pushed the arslan/374-update-review-message branch from 9fd267c to 3ab94c5 Compare April 1, 2022 13:03
@arslanashraf7 arslanashraf7 changed the title refactor: update the misleading proctoring verified message fix: update the misleading proctoring verified message Apr 1, 2022
@arslanashraf7
Copy link
Contributor Author

@arslanashraf7 can you squash your commits? And a nit: I think this is a "fix" not a "refactor", but I could be wrong.

@pdpinch Squashed. I was generally following this edx guide. But I think we can use "fix", I think it makes more sense than "refactor". Updated the commit message and PR title accordingly.

@arslanashraf7 arslanashraf7 force-pushed the arslan/374-update-review-message branch from 3ab94c5 to 212b25c Compare April 6, 2022 06:43
@zacharis278
Copy link
Contributor

@arslanashraf7 this looks good to me. Just shoot me a ping when you believe this is all set to merge

@pdpinch
Copy link

pdpinch commented Apr 6, 2022

Thanks @zacharis278 -- Arslan asked me to take a last look, and it looks good to me. Can you merge for us?

@zacharis278 zacharis278 merged commit b592568 into openedx:main Apr 6, 2022
@openedx-webhooks
Copy link

@arslanashraf7 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

@github-actions
Copy link

github-actions bot commented Apr 6, 2022

🎉 This PR is included in version 1.16.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merged open-source-contribution PR author is not from Axim or 2U released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants