View source for CSC/ECE 517 Fall 2023 - E2383. Grading Audit Trail

=='''Introduction'''==

===Problem Statement===
In the current implementation of expertiza, any instructor can assign or edit a grade but there is no way to track who gave the grade and when. 

A grading audit trail must be created and the following information needs to be stored:

1. When a grade is assigned by an instructor, there needs to be an indication of who did it and when it was done.
2. Comments previously provided by other instructors must also be preserved.
This information needs to be stored every time an instructor edits a grade/comment and clicks the save button.

Currently, there are two places need to add grading audit trail:

1. Review grade: Log in as instructor -> Manage -> Assignments -> View Review Report
2. Submission grade: Log in as instructor -> Manage -> Assignments -> View submissions
The grading audit trail can probably be implemented as the submission records history on Expertiza. The required page can be reached by logging in as instructor -> Manage -> Assignments -> View Submissions -> History

At the minimum, a grading log entry must include the instructor id, assignment id, student id, grade, comment and timestamp.

Previous student teams have attempted to implement this functionality, but their implementations had issues. Our solution will build on the work of teams E1934 and E2237, addressing the problems in their implementations.

== '''Overview of Major Changes By Previous Teams''' ==
===[https://wiki-expertiza.csc.ncsu.edu/index.php/E1934_-_Grading_Audit_Trail E1934]===
[https://youtu.be/yyxX_kRYxLc Their Screencast]

*Created a database called grading_history to store elements for the Grading Audit Trail (instructor id, assignment id, grade tyoe, student id, grade, comment and timestamp)
*Used MVC design to create a model, a controller, and a view for both of Review Grade and Submission Grade. These will be the links used in the View Submissions view and View Review Report view so that the grading trail for an assignments submission and reviews are seperate.
*Modified grades controller, so that every time, a grade is submitted or edited, grading_history_controller.rb will call a method to create an entry that saves into the database.
'''Problems/Issues''' 
:1. For review grades, the “Grading History” link must not be in a separate column. It should be in :smaller text below the in the “Save” button. 
:2. In the view grading record page, remove the receiver column and add it to the title 
:3. Restrict the column width on the grading record page 
:4. Add comments on list_submissions.html.erb to indicate that the alignment was changed to fix code climate issues 
:5. Ensure that white space changes are separate commits 
:6. Revert changes made to list_review_mapping.html.erb 
:7. Remove the review_report_html.erb file
:8. Design doc – mention why each of those files were changed

This is the design plan in which they followed:

[[File:E1869 Grading Audit Trails UML.jpg]]

===[https://wiki-expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2237:_Grading_audit_trail E2237]===

*They fixed some issues that were causing the system to crash during testing
*Altered the Grading History view
*Explained the reasoning for changes made to files using diagrams and justifications
'''Problems/Issues''' 
:1. Redundant files generated by scaffolding need to be removed, along with debugging code. Ex) Coffee created by scaffolding and console logging for debugging. 
:2. Authentication could be done using existing utilities, no need to create their own. 
:3. Some formatting changes could be done especially on how cells span in review report page. Ex) Formatting change for spans in between cells in review report.
:4. Code from previous implementation is a concern.

This is the updated design flow in which they created to improve previous implementations further:

[[File:Kai diagram1.jpg]]

=='''Proposed Solution'''==
We plan on using the implementation of E2237 since it is the latest in the Grading Audit Trail projects and has the latest in terms of testing. These files cannot be added haphazardly since parts of the implementation is a cause to concern and caused the changes to not be implemented. It is also using an older version of expertiza so some parts may not be compatible.  

We must first figure out exactly what changes and issues to address in their implementation by meeting with our mentor. We also need to reimplement the following files since none of their changes were implemented:

*app/controllers/grading_histories_controller.rb
'''
     Calls the grading history view after validating Submission and Review Type.

'''

*app/models/grading_history.rb 
'''
     Model for Grading History.
'''

*app/models/review_grading_history.rb 

'''
     Model containing specifics of Review Grading History. Inherits Grading History.
'''

*app/models/submission_grading_history.rb 
'''
     Model containing specifics of Submission Grading History. Inherits Grading History.
'''

*app/views/grading_history/index_html.erb
'''
     This is a view for grading audit trail, it will display all grading histories of a 
     submission/review
'''

*spec/features/grade_histories_spec.rb

'''
     Feature test to check if the grades appear in chronological order
'''

*spec/features/helpers/grade_histories_helper.rb

'''
     Helper file to facilitate the above mentioned feature test.
'''

=='''Reimplementation'''==
Since the previous teams implementations were not integrated we have to reimplement their files which we will do by looking at their commits and pull request to see what files are necessary and what can be left out to address the issues of their implementation.

'''[https://github.com/ErikLG360/expertiza/commit/e28a857695549cc91c477587707e48100d2bd333 Files being Reimplemented/Modified]'''


'''Reimplemented'''
*app/controllers/grading_histories_controller.rb
'''
     This file was added to deal with allowing only the correct people to view the grading history, checking the assignment type whether it be a submission or review, and indexing all the grading history for the assignment in chronological order.
'''
*app/models/grading_history.rb
'''
     This file was added to create the relationships that the grading history has with an instructor who is creating the parts of the grading history and the assignments that will have a grading history.
'''
*app/models/review_grading_history.rb
'''
     This file creates the relationship that a participant will have a Review Grading History 
'''
*app/models/submission_grading_history.rb
'''
     This file create the relationship that a participant/grade_reciever will have a Submission Grading History
'''

*app/views/grading_histories/index.html.erb
'''
     This file contains the view for the grading history table which will change depending on if its a Review or submission type
'''
*app/views/grading_histories/_form.html.erb
'''
     This file contains the view for when a grading history contains any error when it is about to be saved
'''

'''Modified'''
*app/controllers/grades_controller.rb
'''
     This file was modified based off the previous teams implementation because when the method save_grade_and_comment_for_submission was called it should also create a grading history so that
 the grading audit can be created and added to. This was mainly focusing on the grading history of submissions and not reviews.
'''
*app/controllers/review_mapping_controller.rb
'''
     This file was modified based off the previous teams implementation because when the method save_grade_and_comment_for_reviewer was called it should also create a grading history so that
 the grading audit can be created and added to. This was mainly focusing on the grading history of reviews and not submissions.
'''
*app/views/assignments/list_submissions.html.erb
'''
     It was modified to add the new hyperlink to display the grading history of a submission.
'''
*config/routes.rb
'''
     It was to add the new route for grading histories
'''

=='''Solutions - Implemented'''==

'''E1934'''

'''Problems/Issues''' 
:1. For review grades, the “Grading History” link must not be in a separate column. It should be in :smaller text below the in the “Save” button. 
:2. In the view grading record page, remove the receiver column and add it to the title 
:3. Restrict the column width on the grading record page 
:4. Add comments on list_submissions.html.erb to indicate that the alignment was changed to fix code climate issues 
:5. Ensure that white space changes are separate commits 
:6. Revert changes made to list_review_mapping.html.erb 
:7. Remove the review_report_html.erb file
:8. Design doc – mention why each of those files were changed

'''Solutions''' 
:1. Found the correct location to put the Review Grading History link and also fix the previous teams creation of a grading history to work with the latest expertiza update. 
Files changed include: 
*[https://github.com/ErikLG360/expertiza/commit/c0352cb73f7de1fba72938df2953ee82cb84bb6a app/controllers/review_mapping_controller.rb]
*[https://github.com/ErikLG360/expertiza/commit/c0352cb73f7de1fba72938df2953ee82cb84bb6a app/views/reports/_review_report.html.erb]

:2. The previous implementatation of E2237 tackled this problem and moved it to the title.
[[File:GradingTableTitle.png|1100px]]
:3. The column widths were lessened by about 15px in the grading record page

Files changed include:
*[https://github.com/ErikLG360/expertiza/commit/124bd12d23f75db0a68e2fac8a8487c5f7a7ed67 app/views/grading_histories/index.html.erb]

:4. There were no code climate issues regarding this issue

:5. All code climate changes are their own commits such as [https://github.com/ErikLG360/expertiza/commit/e95656f4d5e4f2ba4fc8d3f40716673ccafb41b1 This]

:6. This issue was resolved by not adding in their implementation for the list_review_mapping.html.erb

:7. This issue was resolved by not adding in the review_report_html.erb file

:8. This issue is resolved in the '''Reimplementation''' section of this document


'''E2237'''

'''Problems/Issues''' 
:1. Redundant files generated by scaffolding need to be removed, along with debugging code. Ex) Coffee created by scaffolding and console logging for debugging. 
:2. Authentication could be done using existing utilities, no need to create their own. 
:3. Some formatting changes could be done especially on how cells span in review report page. Ex) Formatting change for spans in between cells in review report.
:4. Code from previous implementation is a concern.

'''Solutions''' 
:1. These files have not been added.
:2. The authentication already used the necessary parts
:3. The column width was reduced by 15px refer to the solution for E1934 number 3.
:4. Code for the review_mapping_controller was changed to match the current state of expertiza refer to the solution for E1934 number 1.

=='''Resulting Views'''==
This is the view in the view submissions page that displays the link for the Submissions Grading History which is circled in red.
[[File:SubmissionsGradingHistoryLink.jpeg|1100px]]

This is the resulting view after clicking the link:
[[File:SubmissionGradingHist.png|1100px]]

This is the view in the review report page that displays the link for the Reviews Grading History which is circled in red.
[[File:ReviewGradingHistoryLink.jpeg|1100px]]

This is the resulting view after clicking the Reviews Grading History link:
[[File:ReviewsGradingHist.png|1100px]]

=='''Testing Plan'''==

=== Rspec Unit Tests ===

==== For History of the Grades ====
The history of the grade and comments are related to the new model grading_history.rb and the new controller grading_history_controller.rb.

So the related RSpec tests are planned to be executed:

    spec/controllers/grading_history_controller_test.rb

For the feature part, test if the grading history and instructor can be shown in chronological order:

    spec/features/grade_histories_spec.rb
    spec/helpers/grade_histories_helper_spec.rb

The link to test files inorder to test the creation of grading history with valid parameters is https://github.com/expertiza/expertiza/commit/067b52315ac1ff7ce1b89fc44121393cadbabc6a

=== Manual UI Tests ===
To start the test, we need to log in as instructor or TA first. These accounts should have access to the assignment. For example: we can use '''intructor6/password'''

==== Scenario 1: Grading histories of submissions ====
Step 1. Log in as instructor -> Manage -> Assignments -> View submissions
<br>
<br>
[[File: E2383 1.png|1100px]]
<br>
<br>
<br>
Step 2. The instructor can assign grades to a team by clicking 'Assign Grade' in the 'Team name' column:
<br>
<br>
[[File:E2383 2.png|1100px]]
<br>
<br>
<br>
Step 3. The instructor can view the grading audit trail by clicking 'Grading History' in the 'History' column, here is the record page:
<br>
<br>
[[File:E2383 3.png|1100px]]
<br>
<br>

==== Scenario 2: Grading histories of reviews ====
Step 1. Log in as instructor -> Manage -> Assignments -> View Reports
<br>
[[File:E2383 4.png|1100px]]
<br>
<br>
Step 2. Select 'Review Report' then click 'View', here is the Review Report page. The instructor can assign grades to a review by inputing 'Grade' and 'Comment' then clicking 'Save' button:
<br>
<br>
[[File:E2383 5.png|1100px]]
<br>
<br>
Step 3. The instructor/TA can view the grading audit trail by clicking 'Grading History' as Step 2 figure shows, here is the record page:
<br>
<br>
[[File:E2383 6.png|1100px]]
<br>
<br>

=='''Future Scope'''==
This project may need further improvement since it does not seem like there should be an abundance of files added and perhaps using the MVC design is not necessarily needed. There can also be a reduction of code since the difference between the two main grading histories is just whether it is a review or submission type.

=='''Relevant Links'''==
* '''Github Repository:''' https://github.com/ErikLG360/expertiza
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2696
* '''VCL Server (Valid until 12/15/23):'''  http://152.7.179.44:8080
* '''Video:''' https://drive.google.com/file/d/1HIrJtCsbZXSqGPHShuV6mbSTOKvV5MxT/view?usp=drive_link

=='''Contributors to this project'''==
*Amulya Usem
*Erik Lopez-Godinez
*Gowtham Pollam

*'''Mentor''': Srilekha Gudipati