View source for CSE/ECE 517 Spring 2021 - E2105. Track the time students look at other submissions

This is the wiki page of project E2105 of the OSS assignment in Spring 2021 for CSC/ECE 517.

== For Peer Reviewers ==
When testing our deployed app, use the login credentials below:

   Username: instructor6 , Password: password

Then follow along with the methods outlined in the testing section to help you get started!

== Project Description ==
=== Background ===
Currently in Expertiza, students complete peer review questionnaires during the many rounds of an assignment. This is a great way to gather information about submissions and complete lots of testing while also exposing the reviewing student to practices and skills used in industry.

The instructor can view these reviews on the "Review Reports" screen. This can be found by getting the "Management" dropdown -> Assignments to list all assignments for that instructor. On the far right of each of these rows, one will see multiple buttons for possible actions, select "Review Report" [[File:ExpertizaReviewReport.png|frameless|x20px|border]] . Once the page has loaded, clicking the "View" button while "Review Reports" is selected in the dropdown will open the reports. A list of students who have completed reviews, the teams they reviewed, the amount of written text they submitted in comments, as well as other metrics will be displayed.

The issue with this system is that there is no metric currently for how long a user spends on reviews.

Because this project involves logging data real-time, the interactions with the database also need to be minimal.

=== Motivations ===
This project was created to give the instructors more information about how students complete reviews, specifically the time they spend on a review. This will give the instructor insight into each review and allow them to improve the teaching experience when it comes to peer reviews.

This "review time" metric should be broken down by each link in a submission.

== Previous Implementations ==
The previous project teams and their Pull Requests and Wikis are listed here

{| class="wikitable"
! Group
! Pull Request
! Wiki
|-
! E1791
| [https://github.com/expertiza/expertiza/pull/1124/files PR] || [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E1791._Track_the_time_that_students_look_at_the_other_submissions_-_logging_improvement Wiki]
|-
! E1872
| [https://github.com/expertiza/expertiza/pull/1309 PR] || [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2018/E1872_Track_Time_Students_Look_At_Other_Submissions Wiki]
|-
! E1989
| [https://github.com/rohanpillai20/expertiza PR] || [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1989._Track_the_time_students_look_at_other_submissions Wiki]
|-
! E2080
| [https://github.com/expertiza/expertiza/pull/1847 PR] || [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2020_-_E2080._Track_the_time_students_look_at_other_submissions Wiki]
|}

=== Requested Changes ===
With the general functionality outline by previous groups, our team was asked to:
* Design a database schema for logging time a reviewer spends on a submission
* Modify the Review Report to show the time spent on each submission
* Add tests for the code written

== Our Implementation ==
=== Overview and Pattern ===
Overall, our implementation works using a proxy pattern for data storage and the façade pattern to get the requested data and statistics. 

When the reviewer navigates to a page from the expertiza review page a submission_viewing_event is created for that url and a start time is saved. Once the reviewer closes this page an end time is saved in that same submission_viewing_event, a total time is calculated and this is saved to local storage using pstore. As the reviewer navigates to different links from the review page, submission_viewing_events are created for each link accessed and these accumulate a total time spent with the link open. This is done using polling for all external links. Once the reviewer saves or submits their review, these events are saved to the database from local storage, and deleted from local storage. This minimizes the amount of times the application is interacting with the actual database. If the user is returning to finish a saved review, these rows are pulled from the database, added to as stated above, and saved to local storage again until saved or submitted.

When the instructor goes to view the "Review Report", each row from that students review is pulled for display as seen here:

[[File: Time_Spent_On_Review.png|x600px]]

The pop-up shows:
* Percentage of total review for each link in a pie chart
* The time the reviewer spent on each link
* The total time spent on the review
* The average times spent on each link for this submission by all reviewers
* The average time spent reviewing this submission by all reviewers
* Class statistics including:
** Average review time for all submissions
** Median review time
** Standard deviation for review times

=== Development ===
''*Links provided as scale of development is very large''
==== Github Info ====
Our Pull Request can be found [https://github.com/expertiza/expertiza/pull/1898 here]

==== Tasks Identified ====
Along with the tasks above, upon reviewing existing code and discussing with our mentor we realized there was more to be done. A refactor of the previous teams code was needed as well as proper comments to document how this feature functioned. This extended the scope of our project significantly.

Our list of tasks included:
* Review and understand previous teams code
* Refactor and comment usable code from previous groups (Added after reviewing previous code)
* Create new UI for viewing data
* Improve current database schema to hold the total time spent on a review
* Add tests

==== Review Previous Code ====
Upon reviewing all the previous groups code, it seemed that E2080 (our previous group) had the best starting point for our project having improved their previous groups code. They had a way of tracking the time spent on a review, storing it in a local file, saving this file to the database, and displaying the data. We did however find the code was hard to follow and needed to be refactored if we were to have this feature merged with the main Expertiza repository.

==== Refactor and Comment ====
Pulling E2080s code as a base, we refactored this code to have comments, proper formatting, and move most functionality out of client side javascript to the rails controller.
* Most of the client side javascript is now located in [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-8603b9e3a5873ea183cf8f2102f980272cbf9b34de0876f42b7218019109aca5 app/assets/javascripts/review_time.js] and [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-8847cbbe7255e3786b40435c99f4e9a1da960237c32c44f7ee717daf7ebe543c app/assets/javascripts/window_manager.js]
* Functionality like calculating time between entries is now done in [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-356e07e962d70d0f366852ab9098771aa79e5f844415f000ce68d4efe1dab5f3 app/controllers/submission_viewing_events_controller.rb] using functions from [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-858804ef297c49f9d2aaad4a850da3500fbe1745663bb424fe2a8e2140cc02ce app/helpers/submission_viewing_event_helper.rb] to assist with any math.

==== New UI ====
As we moved a lot of the functionality from the previous groups UI to the controller and helper functions, we then wanted to improve the UI to still function correctly but also easily display the given information and be easily edited for future use. We did this using simple javascript calls in [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-53bcd690326197b4d0343db0e97b969c9b7a653381be9ed72ac34271f95168e4 app/assets/javascripts/time_canvas_handler.js] to get the relevant information using the controller and moved much of the formatting to [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-00d7e8781704258b2aa199a04eadfcd3c247438b0358d73df98fb283df28b636 app/assets/stylesheets/time_canvas_css.css]. This new UI is displayed above in the Overview and Pattern section

==== Improve Database Schema ====
The schema as it stands only recorded start time and end time for accessing a link. This becomes a problem as users creating reviews normally access a link multiple times. To allow for this, we added a new column to the submission_viewing_events table allowing for total_time to be calculated as the user moves between links.

New Submission_Viewing_Event Database Schema:

[[File:ExpertizaReviewTimeSchema.png|x600px]]

== Test Plan ==
When conducting live testing, you need to create a new review so the system can gather the timing data. (This is why most reviews show 0 as they were made before our implementation)

=== General Test ===
'''NOTE: This is our process. We have listed it here as getting to this feature and functionality can be confusing without knowledge of the Expertiza site. This is a guideline to help our peers. Please feel free to test the functionality beyond this.'''

To do this, here is our method:
* As instructor6, find assignment "Final project (and design doc)". This is a previously created assignment that functions correctly.
* Add a new participant to the assignment using the options to the right of the row. (We found student2150 and up to be easiest)
* Impersonate the added student. "Management" dropdown -> impersonate user
* You should now see a pending review for "Final project (and design doc)". Select this to get to the review page.
* Select the available submission and begin the review
* Now you should be taken tot he questionnaire for that assignment. Conduct the review however you like. Your activity will be timed. 
** Note: You must open the teams submitted links and files from the review page for it to be timed
** Note: If you have a link open, you will not be able to open it again
* Once complete, submit the review
* You can now "Revert" back to your instructor account using the button in the Expertiza site heading
* Navigate to the "Review Report" page as outlined in the '''Background''' section of this site
* Find the student account you used and there will be an R1 or R2 next to your review. Click on these to see the breakdown of your review times for that respective round.

=== Edge Cases ===
Edge cases that we tested using the UI include:
* Not opening a few or all of the links submitted
** This will result in those links not being displayed in final breakdown
* User closes browser mid-review
** pstore contains data
* User spends 0 seconds on a review
** Displayed as "No Data" on report page

=== Automated Tests ===
Our automated testing spans our controller and our helper functions.

==== Submission Viewing Events Controller Tests ====
Rspec file: [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=.rb#diff-708c777d29aa46dfe24168f477cbb1f78e77464bf0a3ae00d9ffaa830e7f12f7 spec/controllers/submission_viewing_events_controller_spec.rb]
 Ensure:
 1. action_allowed returns true
 2. start_timing sets start_time and clears end time for link
 3. start_timing sets start_time and clears end time for all links in round
 4. end_timing sets end_time and updates total_time for link
 5. end_timing sets end_time and updates total_time for all links
 6. reset_timing sets end_time to current time, updates total_time, and restarts timing for link
 7. reset_timing sets end_time to current time, updates total_time, and restarts timing for all links
 8. hard_save saves storage proxy file to database and clears file
 9. end_round_and_save stops all timing and saves to database

==== Local Storage Tests ====
Rspec file: [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-3dc543fde86eeea3420716c53f8b8fc619006921bb5eebd6d9b17c49d8420d95 spec/helpers/local_storage_spec.rb]
 Ensure:
 1. save records to pstore file
 2. sync fetches registry from pstore file
 3. where retrieves single matching instance from pstore file
 4. read saves instance to database
 5. hard_save saves timing instance to database
 6. hard_save_all saves all registry instances to database
 7. remove removes instance from pstore file
 8. remove_all removes all instances from pstore file

==== Local Submitted Content Tests ====
Rspec file: [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=.rb#diff-c687c7fc9d3982ba43e08c5e516645a8bf10052ca8cecbc03fd36cf3a3f76522 spec/models/local_submitted_content_spec.rb]
 Ensure:
 1. initialize successfully creates object with params
 2. to_h successfully converts object to hash
 3. == successfully compares the content of two objects

== Added / Changed Files ==
Due to the size of our feature, our PR contains many additions. We have limited these to new files as much as possible in order to maintain the current Expertiza files and avoid unnecessary conflicts.

Added Files or Changes:
* [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-8603b9e3a5873ea183cf8f2102f980272cbf9b34de0876f42b7218019109aca5 app/assets/javascripts/review_time.js]
* [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-53bcd690326197b4d0343db0e97b969c9b7a653381be9ed72ac34271f95168e4 app/assets/javascripts/time_canvas_handler.js]
* [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-8847cbbe7255e3786b40435c99f4e9a1da960237c32c44f7ee717daf7ebe543c app/assets/javascripts/window_manager.js]
* [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-00d7e8781704258b2aa199a04eadfcd3c247438b0358d73df98fb283df28b636 app/assets/stylesheets/time_canvas_css.css]
* [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-858804ef297c49f9d2aaad4a850da3500fbe1745663bb424fe2a8e2140cc02ce app/helpers/submission_viewing_event_helper.rb]
* [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-52a4487c125f78c29e9b0cec0fbae1a2330507596d5f7cdd32c3d52886c84d4a config/initializers/assets.rb]
* [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-df74508b74c64c3ad154f8b8b10afa2cdde9d72047ba1eb1ecd2c5e8991b6ba4 db/migrate/20210315184532_update_review_time_schema.rb]
* [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-356e07e962d70d0f366852ab9098771aa79e5f844415f000ce68d4efe1dab5f3 app/controllers/submission_viewing_events_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-5f7be2d729751ba21cd053cdaba79aab311cb079e81a37af132b43417b76afd2 app/helpers/local_storage.rb]
* [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=.rb#diff-ef54cbcb0eece026fde3847d4ab7ffb1d0f003f6a4d770f6d0d44914ab1ff796 app/models/local_submitted_content.rb]
* [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-3dc543fde86eeea3420716c53f8b8fc619006921bb5eebd6d9b17c49d8420d95 spec/helpers/local_storage_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=.rb#diff-c687c7fc9d3982ba43e08c5e516645a8bf10052ca8cecbc03fd36cf3a3f76522 spec/models/local_submitted_content_spec.rb]

Refactored Changes:
* [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-536af1fd58b1157cf616d913061c6040a205948c34c0e87a563fb8594baaf4ce app/helpers/submitted_content_helper.rb]
* [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-10395a909ed1f2034b4a4c8f57c0e30382d9492e0b16bb6fe6fb91a424f6f034 app/views/reports/_review_report.html.erb]
* [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-307431f3c6121f841db70af502fb724b7369eb0f985975667adb68a9b99f55a6 app/views/response/response.html.erb]
* [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-c128395a536bf99a86d32c67d705bcc898c7c73d3d7553ebbbf61427d029d749 app/views/submitted_content/_hyperlink.html.erb]
* [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-64e78884c4050bc8a9a2e91ee875d1620b9dafc858a87926b44af9ae1fb5094f app/views/submitted_content/_main.html.erb]
* [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-f6a1f103da9ba05a288483610bea700e47a571becfd25b8ceeb47b8e88704f45 app/views/submitted_content/_submitted_files.html.erb]
* [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-959bc9abc46a55332bb64d5155a79323afa75a50ec1a2137ddd22d926f62c6c5 config/routes.rb]
* [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-cbf8b25d6d853acf58fa9057841f407d29ffe90649c75cf9e3f51b2d6e3aa1d3 db/schema.rb]
* [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-708c777d29aa46dfe24168f477cbb1f78e77464bf0a3ae00d9ffaa830e7f12f7 spec/controllers/submission_viewing_events_controller_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-9c5b1c34d8ea305233bc45e4ca9016a86c3fa9cb4c52d11910906ac2b777830b spec/helpers/submitted_content_helper_spec.rb]
* [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=.rb#diff-708c777d29aa46dfe24168f477cbb1f78e77464bf0a3ae00d9ffaa830e7f12f7 spec/controllers/submission_viewing_events_controller_spec.rb]

Untouched Changes by Previous Teams:
* [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-a80a25a6ffa89a5829356f2ce3a3f031933dbfb31e992d22e90d80e5b1a8c94f app/models/submission_viewing_event.rb]
* [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-413d18ff2d5c3c7b127e703108f7a85d614245d727ada2c1411ad316650a885d app/controllers/response_controller.rb]
* [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-6778cf735412502f0641303fb1cf809ea4b4569dc2299e11e26e7aa74117ccb7 app/views/response/view.html.erb]
* [https://github.com/expertiza/expertiza/pull/1898/files?file-filters%5B%5D=#diff-418aa85dcf11e7e8ca0719fe05c98fe87d936fc3c03aef002793dae65e7f8ed6 db/migrate/20191116182414_create_submission_viewing_events.rb]