create training basics --> implement take training feature and resume training feature for user #1951

amitupreti · 2023-03-28T20:15:32Z

What?

Here i have added a feature that will allow users to take the training from settings. User can choose from a list of available
trainings and take the onplatform training. Users can also see the progress of the training and can resume the training from where they left off.

Why?

This is a follow up PR for #1950

How?

Here we create 3 new views to handle the training.

1. training.views.take_training

This view will take care of training homepage. It will show progress of the training if the user has already started the training, show them details of the training and allow them to start/resume and review the training.

2. training.views.take_module_training

This view will take care of letting users take individual modules of the training. It will allow users to take the module from where they left off.
Users will need to finish module1 before they can start module2 and so on.

Here we have used a considerable amount of javascript to make the training interactive. How it works is when the user loads the module page,
we initially load all the content, quizzes and order them based on the order field, and initially we hide all the content and quizzes.

Then we show either the first content,quiz or the next one after a content, quiz that they had completed last time. and we keep doing this until the user has completed the module.

3. training.views.update_module_progress

This view uses a simple post request and expects an ajax request from the client. It will update the progress of the module and the progress of the training.

Testing? [WIP]

Following tests will be added

Check access to the training homepage
Check access to the training module page
Check valid and invalid submission of the training module
Check valid and invalid submission of the training

Screenshots (optional)

Anything Else?

How to take a training as a user?

Login as user
Navigate to Settings
Select the training from the dropdown
Start the training

amitupreti · 2023-03-29T15:41:29Z

Quick Note: There is a weird bug i just noticed

Currently OnPlatform training is treated unique based on version_number and training_type. So if a user had taken a training with version 1.1, and then next month there is a minor update with version 1.2, their previous training would still be valid.

But if they go and they try to review the training again, they will be retaking the new version 1.2 of training.(because by default we always provide them with the latest version of training).

Which brings to the weird bug which is that if the user hadn't finished the training 1.1 and the version 1.2 was lunched, then when they try to resume the training, it will be like taking the training from scratch for them

tompollard · 2023-06-26T18:33:07Z

I merged this PR on top of #1950 to do some testing. There were a few issues I came across while testing:

Duplicate training:

Minor thing, but it is currently possible to upload duplicate training courses at:
http://localhost:8000/console/courses/

Getting stuck after hitting "back"

Sign in and start a training course at: http://localhost:8000/settings/training/
Click "Start" to start the training
Click "Next" after reading the explanatory content on "The Americas"
Select a response to the first question, then click "Back"
"Next" is greyed out and cannot be clicked. You are stuck!

Reloading the page after following point 2 above

Reloading the page after following the points above triggers the following error. Returning to http://localhost:8000/settings/platform-training/3/ and clicking "Continue" triggers the same error.

Request Method: GET
Request URL: http://localhost:8000/settings/platform-training/3/module/3/

Traceback (most recent call last):
  File "/Users/tompollard/projects/physionet-build/env/lib/python3.10/site-packages/django/core/handlers/exception.py", line 56, in inner
    response = get_response(request)
  File "/Users/tompollard/projects/physionet-build/env/lib/python3.10/site-packages/django/core/handlers/base.py", line 197, in _get_response
    response = wrapped_callback(request, *callback_args, **callback_kwargs)
  File "/Users/tompollard/projects/physionet-build/env/lib/python3.10/site-packages/django/contrib/auth/decorators.py", line 23, in _wrapped_view
    return view_func(request, *args, **kwargs)
  File "/Users/tompollard/projects/physionet-build/physionet-django/training/views.py", line 147, in take_module_training
    resume_content_or_quiz_object = resume_content_or_quiz_module.get_next_content_or_quiz()

Exception Type: AttributeError at /settings/platform-training/3/module/3/
Exception Value: 'ModuleProgress' object has no attribute 'get_next_content_or_quiz'

Reviewing a completed course

After completing a course, returning to http://localhost:8000/settings/platform-training/3/ and clicking "Review" triggers the same Exception Value: 'ModuleProgress' object has no attribute 'get_next_content_or_quiz' error.

Rutvikrj26 · 2023-07-06T20:57:22Z

Addressing the comments by @tompollard

Added a Check in course creation workflow, ensuring that two course with same name can not be added. Check for appropriate versions have already been added in create training basics --> Add create training from admin console by uploading json #1950.
Added the get_next_content_or_quiz method in module progress. It was removed while addressing refactor comments from 1950, which might have caused the error.

The course addition & usage functionality should be working. Please check and let me know.

…uploading json (#1950) ## What? Here i have added a feature that will allow admin to create training from admin console by uploading json file. This also lays foundation to implement take training feature and resume training feature for user later. ## Why? A training feature was desired by HDN so that we can build/customize a onplatform training for users which will ultimately be used to control access to projects. The new onplatform training will work just like the existing Trainings and work with projects without any additional changes, Currently users take training outside the platform and then upload the certificate to the platform. ## How? We created a separate app called Training. This app will be used to create/manage training courses, and allow users to take onplatform training. We created two major types of Models in training.models **1. Platform Training (`training.models.OnPlatformTraining`)** The idea here is that a new Training Course will be defined with `user.models.TrainingType`. This is the ultimate(top) model for a training course. The training content for `TrainingType` model will be implemented by the new training app. On Training app, `OnPlatformTraining` instance can be created for each TrainingType. For different versions of the same training course, we can create as many `OnPlatformTraining` models as we want as long as the version is different. A training is divided into modules. Each module has a description and a list of contents and quizzes. Modules are like chapters in a book. Each module has a list of contents and quizzes. Contents are like paragraphs in a chapter. Quizzes are like questions in a chapter. Contents and quizes can be organized in any order which is controlled by `order` field. For ordering the modules, contents and quizzes, we have used `order` field. The ordering is unique for each instance of the parent model. For example : Under Module 1, we have content 1(order=1), content 2(order=2), content 3(order=4) and quiz 1(order=3). Then the ordering of the contents and quizzes will be content 1, content 2, quiz 1, content 3. It is expected that the order will start from 1 and will be incremented by 1 with no gaps. **2. Tracking User Progress during training** (`training.models.OnPlatformTrainingProgress`) When a user starts a training, a `OnPlatformTrainingProgress` instance should be created for that user and the version of the training type that they are taking. This model tracks the progress of the user during the training. Similarly, when a user starts a module, a `ModuleProgress` model should be created for each module in the training. For quiz, content progress, we should create a instance of `CompletedContent` or `CompletedQuiz` model when the user completes a content or quiz. I don't think we need to track when someone started a content or quiz as these are expected to complete in few minutes. ## Testing? Next PR #1951 ## Screenshots (optional) ## Anything Else? ### How to create a training from admin console? 1. Login as admin 2. Navigate to `Training` tab in admin console 3. Click on `Create/Update OP Training` button 4. Select `Create New Training` from the dropdown 5. Upload the example json from `training/fixtures/example-training-create.json` ### How to edit a training from admin console? 1. Follow steps 1-3 from above 2. Select Existing Training from the dropdown 3. Upload the example json from `training/fixtures/example-training-update.json` Notes: This is the first part of Training PR, there is another PR #1951 which is rebased on this PR.

tompollard · 2024-04-19T19:45:31Z

Thanks for running through this today @Rutvikrj26. As discussed, please could you remove all javascript elements as far as possible? If dynamic features are needed, consider HTMX.

This adds test coverage for most of the URLs in the `project` app. See the previous pull requests #1695, #1922, #2108 for background. With this change, the bulk of site functionality should now be included in the TestURLs framework. A few small apps are left to add: - `oauth` (should be easy) - `sso` (should be easy but I'm not sure this is enabled in test configs) - `training` (awaiting pull #1951) And a number of URLs across the site are skipped due to a lack of fixture data: - `console` - `edit_submission` - `copyedit_submission` - `awaiting_authors` - `publish_submission` - `event_agreement_detail` - `event_agreement_delete` - `event_agreement_new_version` - `project` - `serve_document` - `published_project_request_access` - `search` - `redirect_challenge_project`

Rutvikrj26 · 2024-05-24T14:53:53Z

@bemoody I've updated the URL for the heading and the PR is ready for further review / merge.

Rutvikrj26 · 2024-07-15T22:22:33Z

Location of the "update" button in the console

Versions of a course are immutable by design (a course version that has been published and taken by users are certified for that particular version of the course - and hence once published on the platform, it cannot be - updated)
What the update button does is, it created a new version.

May be I can rename the button to upload new version which might make it more clear.

"View" training on Certification page

This was abstracted out to a different PR #2223 as it dealt with updating the certifications page and had an updated in the queryset logic. It is a followup PR on this, and will be addressed in it.

Add to "In Progress" tab to the Certification page?

This sounds like a good idea - I'll update the #2223 with this as a requirement.

Clicking the "Continue" button to continue a course raises a NoReverseMatch error

I haven't been able to replicate the error.

What is the expected behaviour of the "Review" button for completed courses

Yes, the review is just to go through the text once again to brush up anything if the user wants. Given that these are going to be basic mandatory courses on it security or something similar, it doesn't have any real purpose.

Display the expiry date to the admin user and explain impact of the course expiring.

Display the expiry date in the user settings and explain impact of the course expiring.

Ideally do something better than returning a 404 to someone in the middle of the course (though perhaps save for later PR).

The Expiry date is the date the admin chooses on the date field on the side of the expire button. I can add a new column of date for the archived courses and then add a line at the top of the archived table detailing that the trainings allotted to the people who took that version of the course will no longer be valid after the expiry date listed. And yes, a new issue/pr sounds better for that, as this one is long as it is.
(edit) as I see, that note is already there.

Are you sure you want to start the training?

Agreed, this looks a bit misleading. It should rather say open the training page, where you can then choose to start/continue/review the training modules.

Rutvikrj26 · 2024-07-16T19:56:04Z

@tompollard I've made the changes you requested on switching from expiring to archiving and simplifying the logic. However, there is a weird issue I am facing in the tests. The test keeps giving 404 error - which it technically shouldn't.

The two url endpoints failing in the tests are:
/settings/platform-training/world-101-introduction-to-continents-and-countries/
/settings/platform-training/world-101-introduction-to-continents-and-countries/module/1-1/

But these work perfectly fine when I open them in my desktop. I tried figuring out what's going on, but couldn't figure out the error. One reason of something like this happening is the training element not getting loaded up - but the loaddemo command loads up the demo training when I test locally.
@tompollard @bemoody any ideas what could be the issue here.

tompollard · 2024-07-17T03:50:27Z

@Rutvikrj26 odd, it's not immediately clear to me why the tests are failing. i added a breakpoint at:

physionet-build/physionet-django/physionet/test_urls.py

Lines 191 to 194 in 75b7f91

    
           response = self.client.get(url, _query_) 
        
           self.assertGreaterEqual(response.status_code, 200) 
        
           self.assertLess(response.status_code, 400)

...to catch the error. The url and parameters appear to be set correctly ('/settings/platform-training/world-101-introduction-to-continents-and-countries/', <User: tompollard>) but as you say, the page returns a 404.

Course.objects.all() returns: <QuerySet [<Course: World 101: Introduction to Continents and Countries v1.0>]> so it looks like the data is loaded.

tompollard · 2024-07-17T04:09:53Z

@Rutvikrj26 It looks like the issue is that the course is not active. If you drop a breakpoint() around self.assertLess(response.status_code, 400) :

try:
    self.assertLess(response.status_code, 400) 
except:
    breakpoint()

Then run:

from training.models import Course
course = Course.objects.all()[0]

You'll see that course.is_active returns False. Perhaps the course gets archived in an earlier test? (Fix is to reverse the archive action that happens previously, or add another course to the fixtures).

physionet-django/training/templates/training/course_block.html

physionet-django/training/views.py

physionet-django/console/urls.py

physionet-django/static/custom/js/quiz.js

physionet-django/training/models.py

Rutvikrj26 · 2024-07-22T20:46:42Z

@tompollard I've addressed all the comments and updated the fixtures to have a fallback version of the course so that even after archiving tests works fine.

Rutvikrj26 · 2024-07-24T13:38:59Z

@tompollard I need this PR to be merged to complete the work on certifications page #2223. Please merge it if everything looks okay.

physionet-django/training/views.py

Rutvikrj26 · 2024-08-06T14:34:43Z

@tompollard @bemoody There is a weird error in the Testing where it fails while running Docker commands saying docker-compose is command is not available. Any recent changes that might have triggered this?

We are seeing a new "`docker-compose: command not found`" error on the [docker-build-test.yml github workflow](https://github.com/MIT-LCP/physionet-build/blob/dev/.github/workflows/docker-build-test.yml). See: #2268 It looks like "`docker-compose`" is being phased out, in favour of "`docker compose`": https://docs.docker.com/compose/migrate/. This pull request switches all mentions to `docker-compose` to `docker compose`. Merging this pull request should fix the error in: #1951

tompollard · 2024-08-06T16:20:00Z

There is a weird error in the Testing where it fails while running Docker commands saying docker-compose is command is not available. Any recent changes that might have triggered this?

@Rutvikrj26 Should be fixed by #2269. Please could you rebase on the dev branch?

Rutvikrj26 · 2024-08-06T19:48:07Z

@tompollard Looks good to merge.

tompollard · 2024-08-20T13:56:39Z

@Rutvikrj26 it looks like the user migrations are stale (0061_cloudinformation_aws_userid_and_more.py collides with 0061_training_course.py).

Please could you regenerate the migrations so we can go ahead and merge? This is also an opportunity to rebase and clean up commit history if you'd like to do that.

Here users should be able to see their progress and basic training details, modules, etc implement basic features trainings for the user This commit allows users to take the test from settings. The quiz.html file loads all the content and questions for a module based on the order. All the data is hidden from user and gradually displayed as users go through the training We have two level of verifications of answers. the first one is done on quiz.html 1. When users go through the content and they will see the related questions and answer the questions. Users can go to next section or skip the question only if they have answered the question correctly previously. 2. We also have another verification done on view. Here if the users had correctly answered the questions a json string is generated at the end of module and sent via POST, we will then check the database to verify that the data in json string(question,answer) and match it with the database. This should help us stop someone from just sending a post request to complete the training. How the resume works? 1. When users go through the training module, we will track the contents, quiz that they have completed and store it in the database. 2. If the user clicks Next after completing a section or quiz, we will check if it was completed in previous session, 1. If not we will send a post request to the server to update the database, and then load the next section or quiz. 2. If yes we will just load the next section or quiz. 3. One the user reaches the end of the module, we will send submit the form and the server will check if the user has completed all the sections and quizzes. If yes, we will update the database and redirect the user to the training dashboard. Quick note: 1. Only multiple choice questions is supported yet. Add Training to user settings tests for training/courses Fully working version to take online-trainings Fully working version to take online-trainings Updated the Queryset logic to use the course's valid_duration for the determining of the training is valid or expired. Fixing test_views.py to switch from name to title Updated the query to no use union - failing a lot of tests Fixing the tests for Update logic change from courses view to course_details view Updated the test to adjust for schema change & the new updated schema. Fixing styling changes Reverting changes in training status querying logic - extracted into a seperate PR Updated the UI & forms to show active courses, and only showup when there are active courses on the platform Changed the location of the urls Switched the existing dynamic implementation to stateful implementation. Fixing the module-progress error Removed remaining debug statements Removing redundant views remaining from initial dynamic behavior. Removed redundant url from training Removed redundant view imports from user.urls Updated the course-training connect from M2M to 12M Updated the views and methods according to the new 12M model between training and courses Updated the last_completed_order to have a default value of 1 rather than 0 remove redundant test views Fixing the trainig tests Added basic tests for new views Fixed styling issues Fixed the issues with new tests Added TEST_DEFAULTS & TEST_CASES for training app Added _user_ for logged in training Added _user_ for logged in training added course_progress to the demo_training fixture updated the training test urls to skip post requesrts updated url endpoint to the correct training page updated the template and test view updated the template to conditionally show the line on training Improving the queries to use inbuilt django commands for hanling checks and deletions updated module_order in test cases fxing styling issues refactoring the url name to match the view name (WIP) rebased onto dev & fixed leaf migration fixing the views for errors mentioned in PR comments Addressed the issues raised in the comments and fixed the views to handle requests more efficiently. updated the tests to match with the updated url routes Added a unique constraint on the completed content to fix the applciation crashing on multiple attempts. Cleaned up the views.py to remove unused imports and residual function imports updated the function to fix more than required imports Update the console to address tom's comments updated the training page to say open training rather than start training Updated the view logic to fix the crashing behavior on start Updated the expiring functionality to archiving switched the model method name Fixed the code to cleanup left-out files and added docstrings cleaning up the accidentally pushed changes to test_urls.py added another course version and enabled the testing for archive Added docstrings for the views.py Fixed styling issue. Removed migrations Revert "Removed migrations" This reverts commit 67c31ce93d29abbe4f90d78b4ef9d8539599d994. Removed migrations removed the merge for 61/52

Rutvikrj26 · 2024-08-20T19:10:57Z

@bemoody @tompollard I've squashed the commits and converted it to one - plus added migrations separately.

A quick question - The python manage.py resetdb command fails to run in the GitHub action workflow. I tried re-running with debugging logs but can't get to the bottom of why it is occurring. Locally, I've been able to test and run it - so can't reproduce for further debugging as well.

tompollard · 2024-08-20T20:46:16Z

@Rutvikrj26 in case you didn't receive the notification, tests are failing.

Rutvikrj26 · 2024-08-20T20:57:28Z

@Rutvikrj26 in case you didn't receive the notification, tests are failing.

@tompollard I'm not looking to get this one merged yet. I saw the tests are failing. The comment was to ask if you have an idea of what could be causing this, as I am not able to replicate the command failure locally.

tompollard · 2024-08-20T21:00:06Z

@tompollard I'm not looking to get this one merged yet. I saw the tests are failing. The comment was to ask if you have an idea of what could be causing this, as I am not able to replicate the command failure locally.

Oh sorry, I'd missed the earlier question. I'll try to take a look shortly/

Rutvikrj26 · 2024-08-20T21:01:02Z

@tompollard I'm not looking to get this one merged yet. I saw the tests are failing. The comment was to ask if you have an idea of what could be causing this, as I am not able to replicate the command failure locally.

Oh sorry, I'd missed the earlier question. I'll try to take a look shortly/

I think I just fixed it. I had generated migrations but for some reason, it did not get added to tracking files. This should fix the issue.

tompollard · 2024-08-20T21:02:04Z

I think I just fixed it. I had generated migrations but for some reason, it did not get added to tracking files. This should fix the issue.

Easy to miss new, untracked files!

Rutvikrj26 · 2024-08-20T21:07:18Z

@tompollard The PR is now finally ready to be merged!

amitupreti marked this pull request as draft March 28, 2023 20:15

amitupreti force-pushed the au/training/feature/create_training_basics__implement_training_user branch from 3a7bb55 to 4bf486d Compare March 28, 2023 20:53

This was referenced Mar 28, 2023

create training basics --> Add create training from admin console by uploading json #1950

Merged

Platform Training and Quiz 2 #1889

Closed

Platform Training and Quiz 1 #1887

Closed

amitupreti force-pushed the au/training/feature/create_training_basics__implement_training_user branch 2 times, most recently from 7a3246d to 662d905 Compare March 29, 2023 15:36

amitupreti force-pushed the au/training/feature/create_training_basics__implement_training_user branch 7 times, most recently from 9c4f330 to 905f170 Compare April 13, 2023 21:44

amitupreti marked this pull request as ready for review April 13, 2023 21:46

amitupreti assigned Rutvikrj26 Jun 8, 2023

Rutvikrj26 force-pushed the au/training/feature/create_training_basics__implement_training_user branch from 0913bd7 to d4d94ec Compare July 6, 2023 19:14

Rutvikrj26 force-pushed the au/training/feature/create_training_basics__implement_training_user branch 2 times, most recently from 3411cdf to 673b3c3 Compare April 10, 2024 19:05

Rutvikrj26 mentioned this pull request May 1, 2024

Updating the Certification Page for course based trainings #2223

Open

bemoody mentioned this pull request May 6, 2024

TestURLs coverage for project app #2229

Merged

Rutvikrj26 requested review from tompollard and bemoody May 17, 2024 15:13

Rutvikrj26 force-pushed the au/training/feature/create_training_basics__implement_training_user branch from 1b8a9f2 to 0fcc163 Compare July 16, 2024 19:31

tompollard reviewed Jul 17, 2024

View reviewed changes

tompollard reviewed Aug 6, 2024

View reviewed changes

physionet-django/training/views.py Show resolved Hide resolved

physionet-django/training/views.py Show resolved Hide resolved

This was referenced Aug 6, 2024

docker-build-test.yml github workflow fails with "docker-compose: command not found" #2268

Closed

docker-compose -> docker compose #2269

Merged

Rutvikrj26 force-pushed the au/training/feature/create_training_basics__implement_training_user branch from 6282a5d to 0630a93 Compare August 6, 2024 18:22

Rutvikrj26 force-pushed the au/training/feature/create_training_basics__implement_training_user branch from 0630a93 to 2f4e7b0 Compare August 20, 2024 18:55

added migrations

ef8e456

added migration for user

64ef39e

tompollard merged commit e782806 into MIT-LCP:dev Aug 20, 2024
8 checks passed

Rutvikrj26 mentioned this pull request Sep 20, 2024

Implement on-platform courses in Physionet #2299

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

create training basics --> implement take training feature and resume training feature for user #1951

create training basics --> implement take training feature and resume training feature for user #1951

amitupreti commented Mar 28, 2023 •

edited

Loading

amitupreti commented Mar 29, 2023

tompollard commented Jun 26, 2023 •

edited

Loading

Rutvikrj26 commented Jul 6, 2023

tompollard commented Apr 19, 2024

Rutvikrj26 commented May 24, 2024

Rutvikrj26 commented Jul 15, 2024 •

edited

Loading

Add to "In Progress" tab to the Certification page?

Rutvikrj26 commented Jul 16, 2024

tompollard commented Jul 17, 2024 •

edited

Loading

tompollard commented Jul 17, 2024 •

edited

Loading

Rutvikrj26 commented Jul 22, 2024

Rutvikrj26 commented Jul 24, 2024

Rutvikrj26 commented Aug 6, 2024

tompollard commented Aug 6, 2024

Rutvikrj26 commented Aug 6, 2024

tompollard commented Aug 20, 2024 •

edited

Loading

Rutvikrj26 commented Aug 20, 2024

tompollard commented Aug 20, 2024

Rutvikrj26 commented Aug 20, 2024 •

edited

Loading

tompollard commented Aug 20, 2024

Rutvikrj26 commented Aug 20, 2024

tompollard commented Aug 20, 2024

Rutvikrj26 commented Aug 20, 2024

create training basics --> implement take training feature and resume training feature for user #1951

create training basics --> implement take training feature and resume training feature for user #1951

Conversation

amitupreti commented Mar 28, 2023 • edited Loading

What?

Why?

How?

Testing? [WIP]

Screenshots (optional)

Anything Else?

How to take a training as a user?

amitupreti commented Mar 29, 2023

tompollard commented Jun 26, 2023 • edited Loading

Rutvikrj26 commented Jul 6, 2023

tompollard commented Apr 19, 2024

Rutvikrj26 commented May 24, 2024

Rutvikrj26 commented Jul 15, 2024 • edited Loading

Add to "In Progress" tab to the Certification page?

Rutvikrj26 commented Jul 16, 2024

tompollard commented Jul 17, 2024 • edited Loading

tompollard commented Jul 17, 2024 • edited Loading

Rutvikrj26 commented Jul 22, 2024

Rutvikrj26 commented Jul 24, 2024

Rutvikrj26 commented Aug 6, 2024

tompollard commented Aug 6, 2024

Rutvikrj26 commented Aug 6, 2024

tompollard commented Aug 20, 2024 • edited Loading

Rutvikrj26 commented Aug 20, 2024

tompollard commented Aug 20, 2024

Rutvikrj26 commented Aug 20, 2024 • edited Loading

tompollard commented Aug 20, 2024

Rutvikrj26 commented Aug 20, 2024

tompollard commented Aug 20, 2024

Rutvikrj26 commented Aug 20, 2024

amitupreti commented Mar 28, 2023 •

edited

Loading

tompollard commented Jun 26, 2023 •

edited

Loading

Rutvikrj26 commented Jul 15, 2024 •

edited

Loading

tompollard commented Jul 17, 2024 •

edited

Loading

tompollard commented Jul 17, 2024 •

edited

Loading

tompollard commented Aug 20, 2024 •

edited

Loading

Rutvikrj26 commented Aug 20, 2024 •

edited

Loading