View source for CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

==<b>E1956. There is no shortcut to get free review points: Review Assignment Bug</b>==
 

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open-source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Project Description==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review. 

====Issue 1====
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
====Issue 2====
*There is no check to see if the submission is already assigned to the student.
====Issue 3====
*There is no check on the number of outstanding reviews a user can have.

===Motivation===

This project, in particular intends that the students collaborate and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open-source project and learn further about software deployment etc.

Currently, there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy. Also, there is no check to see if the user has submitted enough reviews for that assignment before getting a new review.

==Current Implementation==
<b>Problem 1: No limitation on the maximum number of peer reviews.</b>
*There is no check in the backend that limits the number of reviews assigned to a student. There is a check in the UI, but one could evade the limit by typing in a URL to make the same post request. One can also evade it by clicking multiple times on "Request a review for submission" button in UI.

<b>Problem 2: No check on duplicate submissions</b>
* There is no check to see if the submission is already assigned to a student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

<b>Problem 3: There is no check on the number of outstanding reviews</b>
*A user can request for submissions even if the current outstanding ones are pending.

[[File:Process resize.png]]
[[File:Issue.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller.rb'''
* The is_reviews_allowed method checks the number of reviews assigned to a student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then it returns False.
<pre>
def is_review_allowed?(assignment, reviewer)
  @review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id:  assignment.id)
  assignment.num_reviews_allowed > @review_mappings.size
end
</pre>
* The check_outstanding_reviews checks the number of outstanding assignment reviews a user can have at a time. The check_outstanding_reviews keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_reviews returns True.
<pre>
def check_outstanding_reviews?(assignment, reviewer)
    @review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
    @num_reviews_total = @review_mappings.size
    if @num_reviews_total == 0
      true
    else
      @num_reviews_completed = 0
      @review_mappings.each do |map|
        @num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
      end
      @num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
      @num_reviews_in_progress < Assignment.max_outstanding_reviews
    end
  end
</pre>

'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where a new check was added. This check fetches the number of reviews done by a student currently from ReviewResponseMap table. To adapt to those changes, two new mocks were added to the review_mapping_controller_spec.rb. 
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes:<br/>
1. Login as instructor.<br/>
2. Go to Manage->Assignments and navigate to assignment name 'test1'. <br/>
3. Click on add participants. This will give a list of all participants. <br/>
4. Now click on any student username in order to impersonate. <br/>
5. Go to test1->other's_work and click on request submission button continuously and wait for the response.<br/>
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has done reviews less than assignment policy: <pre>context 'when number of reviews are less than the assignment policy'</pre>
::::1. Assign Review Dynamically.
::::2. Redirect to Student review page.

::2. Student has done reviews more than the assignment policy: <pre>context 'when number of reviews are greater than the assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"]

===Automated Test Cases For Review pending check===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has pending reviews less than assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews less than assignment policy'</pre>
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews greater than assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more reviews when you have "+ assignment.max_outstanding_reviews + "reviews to do"]

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

<b>Mentor: Suraj Siddharudh</b>

==References==
1.[https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]