Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2021 - E2150. Integrate suggestion detection algorithm

2021-11-30T01:15:31Z

Glbrook2: /* Important Links */

== Problem Definition ==
Peer-review systems like Expertiza utilize a lot of students’ input to determine each other’s performance. At the same time, students learn from the reviews they receive to improve their own performance. In order to make this happen, it would be good to have everyone give quality reviews instead of generic ones. Currently, Expertiza has a few classifiers that can detect useful features of review comments, such as whether they contain suggestions. The suggestion-detection algorithm has been coded as a web service, and other detection algorithms, such as problem detection and sentiment analysis, also exist as newer web services. We need to make the UI more intuitive by allowing users to view the feedback of specific review comments and the code needs to be refactored to remove redundancy to follow the DRY principle.

== Previous Implementation ==

=== Overview ===
The previous implementation added the following features:
# Setup a config file 'review_metric.yml' where the instructor can select what review metric to display for the current assignments
# API calls (sentiment, problem, suggestion) are made and a table is rendered below, displaying the feedback of the review comments.
# The total time taken by the API calls was also displayed.

=== UI Screenshots ===
The following image shows how a reviewer interacts with the system to get feedback on the review comments.
[[File:Steps_metric.png|1200px|thumb|center]]

=== Control Flow ===

[[File:Review_metric.png]]

== Issues with Previous Work ==

With the previous implementation of this project, students can write comments and request feedback for the comments. There are certain issues with the previous implementation that needs to be addressed.

# The criteria are numbered in the view, and those numbers do not correspond to anything on the rubric form. So if the rubric is long, it would be quite difficult for the reviewer to figure out what automated feedback referred to which comment.
# There are too many hardcoded values present in the previously implemented code. We plan to move these hardcoded values to a configuration file and access them when needed.
# Currently there are many repetitive blocks of code. For Ex.; in _response_analysis.html for the getReviewFeedback(), the API call for each type of tag (sentiment, suggestion, etc) is being repeated. Only the API link differs there.
# The previous implementation takes the text area field in the view to fetch the review comment, but it’s not updated dynamically when the user types a comment. The user needs to save the form then go back to edit view and then request feedback.

== Proposed Solution ==
[[File:PreviousImplementation.jpeg|1000px|thumb| center | previous Implementation]]
# We need to improve the UI so that if there are many rubric items, users can easily check the feedback for each comment given to each rubric item. We propose the following solution
## Each comment on hover shows the user's respective comment on the specific rubric review question so that the feedback is easily accessible.
### On click of the get review feedback button, we loop through the dynamically created review question form and store the mapping of questions and the reviewer's corresponding comments which on hovered are displayed as a popup.
[[File:Proposedsolution.jpeg|1000px|thumb| center | LOFI Design of Proposed Solution]]

# Another issue with the current implementation is that code is quite repetitive for making different API calls (Sentiment, Suggestion, etc). We propose to store the API link in the config file and refer to the variable in the getReviewFeedback()
# We also plan to remove a global variable response_general, which is being used to store the response of API calls. We will refactor the makeRequest function to directly return the response which can be used in various places. This will resolve implicit coupling issues in the code and make it more easily extendable.
# The previous implementation has hardcoded configuration information like the help text button. We propose to save this information in config files which can be easily modified and will remove unnecessary information from the code.

== Implementation ==

=== UI Changes ===
We refactored the UI of the generated table showing the problem, suggestion, and sentiment of the review comment, by adding a tooltip for prompting the Question and its corresponding review comment in the table itself.
==== UI screenshots ====
[[File:Review_table.PNG|500px|thumb|center]]
[[File:Retry.PNG|400px|thumb|center]]

==== Javascript implementation ====
#Description - We have added a tooltip in front of every comment number, which on hovering shows the question for which the feedback is given as well as the review comment given for that question.
#File changed - app/views/response/_response_analysis.html.erb

=== Bug Fixes (Dynamic Feedback) ===
Previously, the implementation took into account the text area field because of which we need to save the form before getting the feedback. We changed the implementation so that users can type in a review comment and dynamically get feedback on it before saving.
[[File:Bug-fix-1.PNG|1200px|thumb|center]]

==== Javascript implementation ====
#Description - The global variable response_general was used to store the response, which was not needed as the Promise will return the response and we threw an error in case of rejection, which is handled makeRequest method
#File changed - app/views/response/_response_analysis.html.erb
[[File:Api refact.PNG|1200px|thumb|center]]

=== Refactoring (removing code duplication) ===
In the previous implementation, code was duplicated for handling different scenarios of fetching the review comment. The code was mostly the same with some conditions. We abstracted the functionality into a method that can be used at multiple places instead of duplicating the code.

Also, the previous implementation was counting the number of rubric questions by parsing the DOM Structure, we refactored that logic as well.

==== Javascript implementation ====
#Description - The internal function create_comment_object is used for generating comment object according to question and class_name of DOM. This comment JSON is then used to pass to the API for fetching the predictions.
#File changed - app/views/response/_response_analysis.html.erb
[[File:Create_comment_object.PNG|1200px|thumb|center]]
[[File:While_loo.PNG|1200px|thumb|center]]

=== Error handling improvements ===
We introduced error handling by changing the “Loading…” text to “Request failed. Please try again.” if the API for generating feedback fails. Previously, this case was not handled
==== Javascript implementation ====
#Description - We have added try-catch blocks while making API call, and if the promise is rejected we catch the error and change the “Loading…” text at the bottom to “Request failed. Please try again.”
#Files changed - app/views/response/_response_analysis.html.erb
[[File:Request_error.PNG|1200px|thumb|center]]

[[File:Request error 2.PNG|1200px|thumb|center]]

=== Refactoring (Removing Hardcoded Values) ===
In the previous implementation the api urls for each analysis and the tool tip description for the analysis were hardcoded into the files. We moved theses values out into the config file below and the values for each of the hardcoded analysis values can be accessed anywhere in the _response_analysis.html.erb file which handles the processing for the analysis. This allows any hardcoded analysis value to be found in one location along with making it easier to append other hardcoded values to each analysis.

[[File:Config File.PNG|1200px|thumb|center]]

=== Refactoring (removing duplicate api values) ===
In the previous implementation each analysis in the _response_analysis.html.erb file had its own block of code for getting the response message, processing values and displaying it to the table. The issue was that many analysis had duplicate blocks of code for getting response message, processing data, and displaying data with only a few analysis requiring different getting, processing, and displaying methods. In the new implementation a for loop would loop through each analysis and would run a default block of code for getting, processing, and displaying data unless the analysis had its own unique getting, processing, and displaying methods where an if statement in the for loop would run the blocks of code for the given method.

[[File:ResponseOld.PNG|1200px|thumb|center]]

[[File:ResponseNew.PNG|1200px|thumb|center]]

=== Possible files to be edited ===
# review_metrics.yml
# response.html.erb
# _response_analysis.html.erb
# response_controller.rb
# response_controller_spec.rb

== Sample API Input/Output ==
* Input Text is passed in the following JSON format
{
"text": "This is an excellent project. Keep up the great work"
}

* Output is returned in the following JSON format:
{
"sentiment_score": 0.9,
"sentiment_tone": "Positive",
"suggestions": "absent",
"suggestions_chances": 10.17,
"text": "This is an excellent project. Keep up the great work",
"total_volume": 10,
"volume_without_stopwords": 6
}

== Testing Plan ==

===Automated Test===

====spec/controllers/response_controller_spec.rb====

Added a test that confirms the correct API URLS are being pulled from the config file.

[[File:Screen Shot 2021-11-29 at 10.43.16 AM.png|600px]]

===Manual Test===

#The functionality was written on the client side in javascript solely in _response_analysis.html.erb
#To test this view, any type of review must be accessible as a student.
#There is a button at the bottom of the review called 'Get Review Feedback'.
#When pressing button, API calls are issued and the metrics will show up within the table (a sample of which is shown in above screenshot).
#As API calls will take time, 'Loading..' text will appear until the API calls are complete
#All the review feedback for the comments will be displayed in a colorful table.
#In the feedback table, upon hovering on the comment number, we will be able to see the rubric item and review comments associated with that particular rubric item

== Important Links ==
# https://docs.google.com/document/d/1slx4HPIbgTH-psIKMSCF-HDF9brxf-FuYhzVT9ZiIrM/edit#heading=h.fxfungdw1d5r
# https://github.com/expertiza/expertiza/pull/2159
# https://youtu.be/oN7qCNTFBE8

== Team ==

* Prashan Sengo (psengo)

* Griffin Brookshire (glbrook2)

* Divyang Doshi (ddoshi2)

* Srujan Ponnur (sponnur)

CSC/ECE 517 Fall 2021 - E2150. Integrate suggestion detection algorithm

2021-11-29T15:46:40Z

Glbrook2: /* Testing Plan */

== Problem Definition ==
Peer-review systems like Expertiza utilize a lot of students’ input to determine each other’s performance. At the same time, students learn from the reviews they receive to improve their own performance. In order to make this happen, it would be good to have everyone give quality reviews instead of generic ones. Currently, Expertiza has a few classifiers that can detect useful features of review comments, such as whether they contain suggestions. The suggestion-detection algorithm has been coded as a web service, and other detection algorithms, such as problem detection and sentiment analysis, also exist as newer web services. We need to make the UI more intuitive by allowing users to view the feedback of specific review comments and the code needs to be refactored to remove redundancy to follow the DRY principle.

== Previous Implementation ==

=== Overview ===
The previous implementation added the following features:
# Setup a config file 'review_metric.yml' where the instructor can select what review metric to display for the current assignments
# API calls (sentiment, problem, suggestion) are made and a table is rendered below, displaying the feedback of the review comments.
# The total time taken by the API calls was also displayed.

=== UI Screenshots ===
The following image shows how a reviewer interacts with the system to get feedback on the review comments.
[[File:Steps_metric.png|1200px|thumb|center]]

=== Control Flow ===

[[File:Review_metric.png]]

== Issues with Previous Work ==

With the previous implementation of this project, students can write comments and request feedback for the comments. There are certain issues with the previous implementation that needs to be addressed.

# The criteria are numbered in the view, and those numbers do not correspond to anything on the rubric form. So if the rubric is long, it would be quite difficult for the reviewer to figure out what automated feedback referred to which comment.
# There are too many hardcoded values present in the previously implemented code. We plan to move these hardcoded values to a configuration file and access them when needed.
# Currently there are many repetitive blocks of code. For Ex.; in _response_analysis.html for the getReviewFeedback(), the API call for each type of tag (sentiment, suggestion, etc) is being repeated. Only the API link differs there.
# The previous implementation takes the text area field in the view to fetch the review comment, but it’s not updated dynamically when the user types a comment. The user needs to save the form then go back to edit view and then request feedback.

== Proposed Solution ==
[[File:PreviousImplementation.jpeg|1000px|thumb| center | previous Implementation]]
# We need to improve the UI so that if there are many rubric items, users can easily check the feedback for each comment given to each rubric item. We propose the following solution
## Each comment on hover shows the user's respective comment on the specific rubric review question so that the feedback is easily accessible.
### On click of the get review feedback button, we loop through the dynamically created review question form and store the mapping of questions and the reviewer's corresponding comments which on hovered are displayed as a popup.
[[File:Proposedsolution.jpeg|1000px|thumb| center | LOFI Design of Proposed Solution]]

# Another issue with the current implementation is that code is quite repetitive for making different API calls (Sentiment, Suggestion, etc). We propose to store the API link in the config file and refer to the variable in the getReviewFeedback()
# We also plan to remove a global variable response_general, which is being used to store the response of API calls. We will refactor the makeRequest function to directly return the response which can be used in various places. This will resolve implicit coupling issues in the code and make it more easily extendable.
# The previous implementation has hardcoded configuration information like the help text button. We propose to save this information in config files which can be easily modified and will remove unnecessary information from the code.

== Implementation ==

=== UI Changes ===
We refactored the UI of the generated table showing the problem, suggestion, and sentiment of the review comment, by adding a tooltip for prompting the Question and its corresponding review comment in the table itself.
==== UI screenshots ====
[[File:Review_table.PNG|500px|thumb|center]]
[[File:Retry.PNG|400px|thumb|center]]

==== Javascript implementation ====
#Description - We have added a tooltip in front of every comment number, which on hovering shows the question for which the feedback is given as well as the review comment given for that question.
#File changed - app/views/response/_response_analysis.html.erb

=== Bug Fixes (Dynamic Feedback) ===
Previously, the implementation took into account the text area field because of which we need to save the form before getting the feedback. We changed the implementation so that users can type in a review comment and dynamically get feedback on it before saving.
[[File:Bug-fix-1.PNG|1200px|thumb|center]]

==== Javascript implementation ====
#Description - The global variable response_general was used to store the response, which was not needed as the Promise will return the response and we threw an error in case of rejection, which is handled makeRequest method
#File changed - app/views/response/_response_analysis.html.erb
[[File:Api refact.PNG|1200px|thumb|center]]

=== Refactoring (removing code duplication) ===
In the previous implementation, code was duplicated for handling different scenarios of fetching the review comment. The code was mostly the same with some conditions. We abstracted the functionality into a method that can be used at multiple places instead of duplicating the code.

Also, the previous implementation was counting the number of rubric questions by parsing the DOM Structure, we refactored that logic as well.

==== Javascript implementation ====
#Description - The internal function create_comment_object is used for generating comment object according to question and class_name of DOM. This comment JSON is then used to pass to the API for fetching the predictions.
#File changed - app/views/response/_response_analysis.html.erb
[[File:Create_comment_object.PNG|1200px|thumb|center]]
[[File:While_loo.PNG|1200px|thumb|center]]

=== Error handling improvements ===
We introduced error handling by changing the “Loading…” text to “Request failed. Please try again.” if the API for generating feedback fails. Previously, this case was not handled
==== Javascript implementation ====
#Description - We have added try-catch blocks while making API call, and if the promise is rejected we catch the error and change the “Loading…” text at the bottom to “Request failed. Please try again.”
#Files changed - app/views/response/_response_analysis.html.erb
[[File:Request_error.PNG|1200px|thumb|center]]

[[File:Request error 2.PNG|1200px|thumb|center]]

=== Refactoring (Removing Hardcoded Values) ===
In the previous implementation the api urls for each analysis and the tool tip description for the analysis were hardcoded into the files. We moved theses values out into the config file below and the values for each of the hardcoded analysis values can be accessed anywhere in the _response_analysis.html.erb file which handles the processing for the analysis. This allows any hardcoded analysis value to be found in one location along with making it easier to append other hardcoded values to each analysis.

[[File:Config File.PNG|1200px|thumb|center]]

=== Refactoring (removing duplicate api values) ===
In the previous implementation each analysis in the _response_analysis.html.erb file had its own block of code for getting the response message, processing values and displaying it to the table. The issue was that many analysis had duplicate blocks of code for getting response message, processing data, and displaying data with only a few analysis requiring different getting, processing, and displaying methods. In the new implementation a for loop would loop through each analysis and would run a default block of code for getting, processing, and displaying data unless the analysis had its own unique getting, processing, and displaying methods where an if statement in the for loop would run the blocks of code for the given method.

[[File:ResponseOld.PNG|1200px|thumb|center]]

[[File:ResponseNew.PNG|1200px|thumb|center]]

=== Possible files to be edited ===
# review_metrics.yml
# response.html.erb
# _response_analysis.html.erb
# response_controller.rb
# response_controller_spec.rb

== Sample API Input/Output ==
* Input Text is passed in the following JSON format
{
"text": "This is an excellent project. Keep up the great work"
}

* Output is returned in the following JSON format:
{
"sentiment_score": 0.9,
"sentiment_tone": "Positive",
"suggestions": "absent",
"suggestions_chances": 10.17,
"text": "This is an excellent project. Keep up the great work",
"total_volume": 10,
"volume_without_stopwords": 6
}

== Testing Plan ==

===Automated Test===

====spec/controllers/response_controller_spec.rb====

Added a test that confirms the correct API URLS are being pulled from the config file.

[[File:Screen Shot 2021-11-29 at 10.43.16 AM.png|600px]]

===Manual Test===

#The functionality was written on the client side in javascript solely in _response_analysis.html.erb
#To test this view, any type of review must be accessible as a student.
#There is a button at the bottom of the review called 'Get Review Feedback'.
#When pressing button, API calls are issued and the metrics will show up within the table (a sample of which is shown in above screenshot).
#As API calls will take time, 'Loading..' text will appear until the API calls are complete
#All the review feedback for the comments will be displayed in a colorful table.
#In the feedback table, upon hovering on the comment number, we will be able to see the rubric item and review comments associated with that particular rubric item

== Important Links ==
# https://docs.google.com/document/d/1slx4HPIbgTH-psIKMSCF-HDF9brxf-FuYhzVT9ZiIrM/edit#heading=h.fxfungdw1d5r
# https://github.com/expertiza/expertiza/pull/1952 (Previous implementation pull request)
# https://youtu.be/oN7qCNTFBE8

== Team ==

* Prashan Sengo (psengo)

* Griffin Brookshire (glbrook2)

* Divyang Doshi (ddoshi2)

* Srujan Ponnur (sponnur)

File:Screen Shot 2021-11-29 at 10.43.16 AM.png

2021-11-29T15:44:26Z

Glbrook2: test code

test code

CSC/ECE 517 Fall 2021 - E2150. Integrate suggestion detection algorithm

2021-11-29T15:36:39Z

Glbrook2: /* Issues with Previous Work */

== Problem Definition ==
Peer-review systems like Expertiza utilize a lot of students’ input to determine each other’s performance. At the same time, students learn from the reviews they receive to improve their own performance. In order to make this happen, it would be good to have everyone give quality reviews instead of generic ones. Currently, Expertiza has a few classifiers that can detect useful features of review comments, such as whether they contain suggestions. The suggestion-detection algorithm has been coded as a web service, and other detection algorithms, such as problem detection and sentiment analysis, also exist as newer web services. We need to make the UI more intuitive by allowing users to view the feedback of specific review comments and the code needs to be refactored to remove redundancy to follow the DRY principle.

== Previous Implementation ==

=== Overview ===
The previous implementation added the following features:
# Setup a config file 'review_metric.yml' where the instructor can select what review metric to display for the current assignments
# API calls (sentiment, problem, suggestion) are made and a table is rendered below, displaying the feedback of the review comments.
# The total time taken by the API calls was also displayed.

=== UI Screenshots ===
The following image shows how a reviewer interacts with the system to get feedback on the review comments.
[[File:Steps_metric.png|1200px|thumb|center]]

=== Control Flow ===

[[File:Review_metric.png]]

== Issues with Previous Work ==

With the previous implementation of this project, students can write comments and request feedback for the comments. There are certain issues with the previous implementation that needs to be addressed.

# The criteria are numbered in the view, and those numbers do not correspond to anything on the rubric form. So if the rubric is long, it would be quite difficult for the reviewer to figure out what automated feedback referred to which comment.
# There are too many hardcoded values present in the previously implemented code. We plan to move these hardcoded values to a configuration file and access them when needed.
# Currently there are many repetitive blocks of code. For Ex.; in _response_analysis.html for the getReviewFeedback(), the API call for each type of tag (sentiment, suggestion, etc) is being repeated. Only the API link differs there.
# The previous implementation takes the text area field in the view to fetch the review comment, but it’s not updated dynamically when the user types a comment. The user needs to save the form then go back to edit view and then request feedback.

== Proposed Solution ==
[[File:PreviousImplementation.jpeg|1000px|thumb| center | previous Implementation]]
# We need to improve the UI so that if there are many rubric items, users can easily check the feedback for each comment given to each rubric item. We propose the following solution
## Each comment on hover shows the user's respective comment on the specific rubric review question so that the feedback is easily accessible.
### On click of the get review feedback button, we loop through the dynamically created review question form and store the mapping of questions and the reviewer's corresponding comments which on hovered are displayed as a popup.
[[File:Proposedsolution.jpeg|1000px|thumb| center | LOFI Design of Proposed Solution]]

# Another issue with the current implementation is that code is quite repetitive for making different API calls (Sentiment, Suggestion, etc). We propose to store the API link in the config file and refer to the variable in the getReviewFeedback()
# We also plan to remove a global variable response_general, which is being used to store the response of API calls. We will refactor the makeRequest function to directly return the response which can be used in various places. This will resolve implicit coupling issues in the code and make it more easily extendable.
# The previous implementation has hardcoded configuration information like the help text button. We propose to save this information in config files which can be easily modified and will remove unnecessary information from the code.

== Implementation ==

=== UI Changes ===
We refactored the UI of the generated table showing the problem, suggestion, and sentiment of the review comment, by adding a tooltip for prompting the Question and its corresponding review comment in the table itself.
==== UI screenshots ====
[[File:Review_table.PNG|500px|thumb|center]]
[[File:Retry.PNG|400px|thumb|center]]

==== Javascript implementation ====
#Description - We have added a tooltip in front of every comment number, which on hovering shows the question for which the feedback is given as well as the review comment given for that question.
#File changed - app/views/response/_response_analysis.html.erb

=== Bug Fixes (Dynamic Feedback) ===
Previously, the implementation took into account the text area field because of which we need to save the form before getting the feedback. We changed the implementation so that users can type in a review comment and dynamically get feedback on it before saving.
[[File:Bug-fix-1.PNG|1200px|thumb|center]]

==== Javascript implementation ====
#Description - The global variable response_general was used to store the response, which was not needed as the Promise will return the response and we threw an error in case of rejection, which is handled makeRequest method
#File changed - app/views/response/_response_analysis.html.erb
[[File:Api refact.PNG|1200px|thumb|center]]

=== Refactoring (removing code duplication) ===
In the previous implementation, code was duplicated for handling different scenarios of fetching the review comment. The code was mostly the same with some conditions. We abstracted the functionality into a method that can be used at multiple places instead of duplicating the code.

Also, the previous implementation was counting the number of rubric questions by parsing the DOM Structure, we refactored that logic as well.

==== Javascript implementation ====
#Description - The internal function create_comment_object is used for generating comment object according to question and class_name of DOM. This comment JSON is then used to pass to the API for fetching the predictions.
#File changed - app/views/response/_response_analysis.html.erb
[[File:Create_comment_object.PNG|1200px|thumb|center]]
[[File:While_loo.PNG|1200px|thumb|center]]

=== Error handling improvements ===
We introduced error handling by changing the “Loading…” text to “Request failed. Please try again.” if the API for generating feedback fails. Previously, this case was not handled
==== Javascript implementation ====
#Description - We have added try-catch blocks while making API call, and if the promise is rejected we catch the error and change the “Loading…” text at the bottom to “Request failed. Please try again.”
#Files changed - app/views/response/_response_analysis.html.erb
[[File:Request_error.PNG|1200px|thumb|center]]

[[File:Request error 2.PNG|1200px|thumb|center]]

=== Refactoring (Removing Hardcoded Values) ===
In the previous implementation the api urls for each analysis and the tool tip description for the analysis were hardcoded into the files. We moved theses values out into the config file below and the values for each of the hardcoded analysis values can be accessed anywhere in the _response_analysis.html.erb file which handles the processing for the analysis. This allows any hardcoded analysis value to be found in one location along with making it easier to append other hardcoded values to each analysis.

[[File:Config File.PNG|1200px|thumb|center]]

=== Refactoring (removing duplicate api values) ===
In the previous implementation each analysis in the _response_analysis.html.erb file had its own block of code for getting the response message, processing values and displaying it to the table. The issue was that many analysis had duplicate blocks of code for getting response message, processing data, and displaying data with only a few analysis requiring different getting, processing, and displaying methods. In the new implementation a for loop would loop through each analysis and would run a default block of code for getting, processing, and displaying data unless the analysis had its own unique getting, processing, and displaying methods where an if statement in the for loop would run the blocks of code for the given method.

[[File:ResponseOld.PNG|1200px|thumb|center]]

[[File:ResponseNew.PNG|1200px|thumb|center]]

=== Possible files to be edited ===
# review_metrics.yml
# response.html.erb
# _response_analysis.html.erb
# response_controller.rb
# response_controller_spec.rb

== Sample API Input/Output ==
* Input Text is passed in the following JSON format
{
"text": "This is an excellent project. Keep up the great work"
}

* Output is returned in the following JSON format:
{
"sentiment_score": 0.9,
"sentiment_tone": "Positive",
"suggestions": "absent",
"suggestions_chances": 10.17,
"text": "This is an excellent project. Keep up the great work",
"total_volume": 10,
"volume_without_stopwords": 6
}

== Testing Plan ==
This project mainly addresses the UI issues and some code refactoring in views. Therefore, we will be focussing on view tests as all the automated tests have been previously implemented and new code won't affect those.

===View Tests(Manual)===

#The functionality was written on the client side in javascript solely in _response_analysis.html.erb
#To test this view, any type of review must be accessible as a student.
#There is a button at the bottom of the review called 'Get Review Feedback'.
#When pressing button, API calls are issued and the metrics will show up within the table (a sample of which is shown in above screenshot).
#As API calls will take time, 'Loading..' text will appear until the API calls are complete
#All the review feedback for the comments will be displayed in a colorful table.
#In the feedback table, upon hovering on the comment number, we will be able to see the rubric item and review comments associated with that particular rubric item

== Important Links ==
# https://docs.google.com/document/d/1slx4HPIbgTH-psIKMSCF-HDF9brxf-FuYhzVT9ZiIrM/edit#heading=h.fxfungdw1d5r
# https://github.com/expertiza/expertiza/pull/1952 (Previous implementation pull request)
# https://youtu.be/oN7qCNTFBE8

== Team ==

* Prashan Sengo (psengo)

* Griffin Brookshire (glbrook2)

* Divyang Doshi (ddoshi2)

* Srujan Ponnur (sponnur)

CSC/ECE 517 Fall 2021 - E2150. Integrate suggestion detection algorithm

2021-11-03T01:04:14Z

Glbrook2: /* Team */

CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications

2021-10-27T03:53:08Z

Glbrook2: /* E2142. Improve e-mail notifications */

=E2142. Improve e-mail notifications=

==Brief Introduction==

* E2142. Improve e-mail notifications
* The forked repository can be found at: https://github.com/griffinbrookshire/expertiza

==Problem Statement==
The following tasks were accomplished in this project:

*Issue1: Send new account welcome email to user, when imported from CSV through assignment page.
*Issue2: Don't send email to reviewers for a new submission after review deadline has passed.
*Issue3: Adding relevant links to reminder emails.

==Issue1 (717) - Send new account welcome email to user, when imported from CSV through assignment page==

'''Pre conditions'''
* There exists an assignment and an instructor
* The instructor navigates to the 'Manage Assignments' page
* The instructor clicks 'Add Participants' for the existing assignment
* The instructor clicks 'Import assignment participants'
* The instructor imports a CSV file containing a user who does not exist yet

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/717 -
"When students' accounts are created by importing a CSV on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. Students should receive e-mails upon account creation, regardless of how their account is created."

So, when students accounts are created in any way, they should receive a welcome email. This includes adding them through importing a CSV.

'''Actual Behavior'''

The implementation and testing for this issue already existed in the beta branch, which will be discussed below. 
This behavior was already implemented through one simple line in the app/models/user.rb file. '''user.rb'''
<pre>
after_create :email_welcome
</pre>
This line calls the 'email_welcome' function every time a user is created, which sends a welcome email to the newly created user. '''user.rb'''
<pre>
# Function which has a MailerHelper which sends the mail welcome email to the user after signing up
def email_welcome
#this will send an account creation notification to user via email.
MailerHelper.send_mail_to_user(self, "Your Expertiza account and password has been created", "user_welcome", password).deliver_now
end
</pre>
This functionality was also completely tested in the spec/models/assignment_participant_spec.rb file show below. This test shows that when the import function is called an email is delivered. '''assignment_participant_spec.rb'''
<pre>
context 'when new user needs to be created' do
let(:row) do
{name: 'no one', fullname: 'no one', email: 'name@email.com', role:'user_role_name', parent: 'user_parent_name'}
end
let(:attributes) do
{role_id: 1, name: 'no one', fullname: 'no one', email: 'name@email.com', email_on_submission: 'name@email.com',
email_on_review: 'name@email.com', email_on_review_of_review: 'name@email.com'}
end
let(:test_user) do
{name: 'abc', email: 'abcbbc@gmail.com'}
end
it 'create the user and number of mails sent should be 1' do
ActionMailer::Base.deliveries.clear
allow(ImportFileHelper).to receive(:define_attributes).with(row).and_return(attributes)
allow(ImportFileHelper).to receive(:create_new_user) do
test_user = User.new(name: 'abc', fullname: 'abc bbc', email: 'abcbbc@gmail.com')
test_user.id = 123
test_user.save!
test_user
end
#allow(ImportFileHelper).to receive(:create_new_user).with(attributes, {}).and_return()
allow(Assignment).to receive(:find).with(1).and_return(assignment)
allow(User).to receive(:exists?).with(name: 'no one').and_return(false)
allow(participant).to receive(:set_handle).and_return('handle')
allow(AssignmentParticipant).to receive(:exists?).and_return(false)
allow(AssignmentParticipant).to receive(:create).and_return(participant)
allow(AssignmentParticipant).to receive(:set_handle)
expect{(AssignmentParticipant.import(row, nil, {}, 1))}.to change { ActionMailer::Base.deliveries.count }.by(1)
end
end
</pre>

'''Manual Testing Results'''

After following the step-by-step instructions for Issue1 in the Test Plan below, the following email was received. This shows that when a new user was imported through the assignment participants page, they received a welcome email.

[[File:Welcome email.png|750px]]

==Issue2 (345) - Don't send email to reviewers for a new submission after review deadline has passed==

'''Pre conditions'''
* There is an assignment, a student as a participant, a participant as a reviewer who is reviewing the this particular assignment
* a review is made for a submission by the student
* review deadline has passed
* the student is allowed to submit after the review deadline has passed

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/345 -
"Evidently, if a submission is revised after review, the system e-mails the reviewer saying to revise the review. This is just fine ... except if the last round of review has been completed.
The message telling reviewers to revise their reviews should not be sent after the last review deadline has passed."

So basically, When the student makes a new submission after the LAST review deadline has passed. The reviewer should not receive an email, asking the reviewer to update the review according to the new submission.

'''Actual Behavior'''

According to the current Code scenario on the beta branch '''''if the deadline has passed, a student(participant) cannot make new submissions'''''. So, automatically if the participant doe not make a new submission then the reviewer wont receive an email. So this issue does not really exist by the virtue of the state of the system.
the stack trace for the check if the submission is allowed or not is as follows -
assignment.rb
<pre>
def submission_allowed(topic_id = nil)
check_condition('submission_allowed_id', topic_id)
end
</pre>

assignment.rb
<pre>
def check_condition(column, topic_id = nil)
next_due_date = DueDate.get_next_due_date(self.id, topic_id)
return false if next_due_date.nil?
right_id = next_due_date.send column
right = DeadlineRight.find(right_id)
right && (right.name == 'OK' || right.name == 'Late')
end
</pre>

due_date.rb
<pre>
def self.get_next_due_date(assignment_id, topic_id = nil)
if Assignment.find(assignment_id).staggered_deadline?
next_due_date = TopicDueDate.find_by(['parent_id = ? and due_at >= ?', topic_id, Time.zone.now])
# if certion TopicDueDate is not exist, we should query next corresponding AssignmentDueDate.
# eg. Time.now is 08/28/2016
# One topic uses following deadlines:
# TopicDueDate 08/01/2016
# TopicDueDate 08/02/2016
# TopicDueDate 08/03/2016
# AssignmentDueDate 09/04/2016
# In this case, we cannot find due_at later than Time.now in TopicDueDate.
# So we should find next corrsponding AssignmentDueDate, starting with the 4th one, not the 1st one!
if next_due_date.nil?
topic_due_date_size = TopicDueDate.where(parent_id: topic_id).size
following_assignment_due_dates = AssignmentDueDate.where(parent_id: assignment_id)[topic_due_date_size..-1]
unless following_assignment_due_dates.nil?
following_assignment_due_dates.each do |assignment_due_date|
if assignment_due_date.due_at >= Time.zone.now
next_due_date = assignment_due_date
break
end
end
end
end
else
next_due_date = AssignmentDueDate.find_by(['parent_id = ? && due_at >= ?', assignment_id, Time.zone.now])
end
next_due_date
end
</pre>

So this is issue is resolved by the state of the system itself. 
'''''BUT Surprisingly on beta branch Reviewers aren't getting any emails at all'''''
on beta branch, in submitted_content_controller, in function "submit_file", this lines is supposed to send email to the reviewers to notify them about the new submission
<pre> participant.assignment.email(participant.id) rescue nil </pre>
''BUT'' here email function is undefined. we checked for email function in assignment class, there was none. The error "undefined function on assignment" is always rescued and hence no errors were raised previously and hence it wasn't highlighted before. 
So, in beta branch reviewers are not being notified anytime a new submission is made to an assignment that they have previously reviewed. So we fixed that
Taking inspiration from the Master branch the previous team's work we added following code to send an email notifying the reviewer of an new submission.

in submitted_content_controller.rb, in the functions, submit_file, submit_hyperlink
<pre>
Team.mail_assigned_reviewers(@participant)
</pre>

participant.rb

<pre>
def mail_assigned_reviewers()
team = self.team
maps = ResponseMap.where(reviewed_object_id: self.assignment.id, reviewee_id: team.id, type: 'ReviewResponseMap')
unless maps.nil?
maps.each do |map|
reviewer = User.find(Participant.find(map.reviewer_id).user_id)
Mailer.sync_message(
{
:to => reviewer.email,
subject: "Assignment '#{self.assignment.name}': A submission has been updated since you last reviewed it",
cc: User.find_by(self.assignment.instructor_id).email,
:body => {
:obj_name => self.assignment.name,
:link => "https://expertiza.ncsu.edu/response/new?id=#{map.id}",
:type => 'submission',
:first_name => ApplicationHelper::get_user_first_name(User.find(Participant.find(map.reviewer_id).user_id)),
:partial_name => 'updated_submission_since_review'
}
}
).deliver_now
end
end
end
</pre>

app/views/mailer/partials/_updated_submission_since_review_plain.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review.
Hence, to update your review please click on the following link.
<% if @link != nil %><%= @link %><% end %>
</pre>

app/views/mailer/partials/_updated_submission_since_review_html.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review. 
Hence, to update your review please click on the following link. 
<% if @link != nil %><a href="<%= @link %>"><%= @link %></a><% end %>

</pre>

added a line in app/mailers/mailer.rb
<pre>
@link = defn[:body][:link]
</pre>

----

==Issue3 (111) - Adding relevant links to reminder emails==

'''Pre conditions'''
* There exists an assignment and a participant associated with that assignment
* The due date for the assignment is approaching

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/111 -
"E-mails about reviews should direct the user to the page where the review is found. Deadline reminders should include a link on where to go to perform the needed function."

So, when assignment reminder emails are sent to students, they should include a link to the relevant assignment.

'''Actual Behavior'''

We implemented this behavior by enhancing the 'email_reminder' function within the app/mailers/mail_worker.rb file. First we get the user associated with the email, then we get the participant object associated with the particular user and the assignment. The ID of this object is the query parameter located at the end of the relevant link. '''mail_worker.rb'''
<pre>
def email_reminder(emails, deadline_type)
assignment = Assignment.find(self.assignment_id)
subject = "Message regarding #{deadline_type} for assignment #{assignment.name}"

# Defining the body of mail
body = "This is a reminder to complete #{deadline_type} for assignment #{assignment.name}.\n"

emails.each do |mail|
# Since the email is not unique fetching the first instance in results returned when searching via email
user = User.where(email: mail).first

# Finding the mapping between participant and assignment so that it can be sent as a query param
participant_assignment_id = Participant.find(user_id: user.id.to_s, parent_id: self.assignment_id.to_s).first.id

# This is the link which User can use to navigate
link_to_destination = "Please follow the link: http://expertiza.ncsu.edu/student_task/view?id=#{participant_assignment_id}\n"
body += link_to_destination + "Deadline is #{self.due_at}. If you have already done the #{deadline_type}, then please ignore this mail.";

# Send mail to the user
@mail = Mailer.delayed_message(bcc: mail, subject: subject, body: body)
@mail.deliver_now
Rails.logger.info mail
end
end
</pre>
This function is clearly tested through a new test we added to the spec/workers/sidekiq_mail_worker_spec.rb '''sidekiq_mail_worker_spec.rb'''
<pre>
it "should send reminder email to required email address with proper content" do
Sidekiq::Testing.inline!
ActionMailer::Base.deliveries.clear
worker = MailWorker.new
worker.perform("1", "metareview", "2018-12-31 00:00:01")
expect(ActionMailer::Base.deliveries.size).to eq(1)
email = ActionMailer::Base.deliveries.first
expect(email.from[0]).to eq("expertiza.development@gmail.com")
expect(email.bcc[0]).to eq("psingh22@ncsu.edu")
expect(email.subject).to eq("Message regarding teammate review for assignment no assignment")
expect(email.body).to eq("This is a reminder to complete teammate review for assignment no assignment.\nPlease follow the link: http://expertiza.ncsu.edu/student_task/view?id=1\nDeadline is 2018-12-31 00:00:01. If you have already done the teammate review, then please ignore this mail.")
end
</pre>

==Test Plan==

'''Issue 1'''

Step 1: Navigate to Manage --> Assignment page.

Step 2: Click on add participants for any of the assignments.

Step 3: Click "Import course participants"

Step 4: Choose a csv file to be imported (follow the format given on the website).

Step 5: The users mentioned in the csv file and don't exist on Expertiza should get a new user email.

'''Issue 2'''

Step 1: Create new assignment [Manage --> Assignment --> + Button (to create new assignment)]

Step 2: Fill the details for the assignments.

Step 3: Navigate to due dates.

Step 4: Change the number of review rounds to 2.

Step 5: Select "Yes" in the dropdown for review allowed during submission and select "Yes" for submission during the review.

Step 6: Add two users to the assignment(author and reviewer).

Step 7: Log in with some user credentials (author credential).

Step 8: Make a new submission to this assignment.

Step 9: Log in with another user (reviewer).

Step 10: Submit a review of the assignment submission.

Step 11: Login as an author again.

Step 12: Edit the submission.

Step 13: After this check the mailbox of the reviewer [development mail for development].

Step 14: Reviewer should get the mail to re-review the work.

Step 15: Change the due date to some date and time which has passed.

Step 16: Now the author should not be able to make a new submission.

'''Issue 3'''

Step 1: Create new assignment [Manage --> Assignment --> + Button (to create new assignment)]

Step 2: Fill the details for the assignments.

Step 3: Add an existing user to the new assignment

Step 3: Navigate to due dates for the new assignment.

Step 4: Set the due date to 1 hour and 5 seconds from now.

Step 5: The user should recieve a reminder email with the relevant links to the assignment.

CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications

2021-10-27T03:51:51Z

Glbrook2: /* E2142. Improve e-mail notifications */

=E2142. Improve e-mail notifications=

==Brief Introduction==

* E2142. Improve e-mail notifications
* The forked repository can be found at: https://github.com/griffinbrookshire/expertiza

==Problem Statement==
The following tasks were accomplished in this project:

*Issue1: Send new account welcome email to user, when imported from CSV through assignment page.
*Issue2: Don't send email to reviewers for a new submission after review deadline has passed.
*Issue3: Adding relevant links to reminder emails.

==Issue1 (717) - Send new account welcome email to user, when imported from CSV through assignment page==

'''Pre conditions'''
* There exists an assignment and an instructor
* The instructor navigates to the 'Manage Assignments' page
* The instructor clicks 'Add Participants' for the existing assignment
* The instructor clicks 'Import assignment participants'
* The instructor imports a CSV file containing a user who does not exist yet

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/717 -
"When students' accounts are created by importing a CSV on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. Students should receive e-mails upon account creation, regardless of how their account is created."

So, when students accounts are created in any way, they should receive a welcome email. This includes adding them through importing a CSV.

'''Actual Behavior'''

The implementation and testing for this issue already existed in the beta branch, which will be discussed below. 
This behavior was already implemented through one simple line in the app/models/user.rb file. '''user.rb'''
<pre>
after_create :email_welcome
</pre>
This line calls the 'email_welcome' function every time a user is created, which sends a welcome email to the newly created user. '''user.rb'''
<pre>
# Function which has a MailerHelper which sends the mail welcome email to the user after signing up
def email_welcome
#this will send an account creation notification to user via email.
MailerHelper.send_mail_to_user(self, "Your Expertiza account and password has been created", "user_welcome", password).deliver_now
end
</pre>
This functionality was also completely tested in the spec/models/assignment_participant_spec.rb file show below. This test shows that when the import function is called an email is delivered. '''assignment_participant_spec.rb'''
<pre>
context 'when new user needs to be created' do
let(:row) do
{name: 'no one', fullname: 'no one', email: 'name@email.com', role:'user_role_name', parent: 'user_parent_name'}
end
let(:attributes) do
{role_id: 1, name: 'no one', fullname: 'no one', email: 'name@email.com', email_on_submission: 'name@email.com',
email_on_review: 'name@email.com', email_on_review_of_review: 'name@email.com'}
end
let(:test_user) do
{name: 'abc', email: 'abcbbc@gmail.com'}
end
it 'create the user and number of mails sent should be 1' do
ActionMailer::Base.deliveries.clear
allow(ImportFileHelper).to receive(:define_attributes).with(row).and_return(attributes)
allow(ImportFileHelper).to receive(:create_new_user) do
test_user = User.new(name: 'abc', fullname: 'abc bbc', email: 'abcbbc@gmail.com')
test_user.id = 123
test_user.save!
test_user
end
#allow(ImportFileHelper).to receive(:create_new_user).with(attributes, {}).and_return()
allow(Assignment).to receive(:find).with(1).and_return(assignment)
allow(User).to receive(:exists?).with(name: 'no one').and_return(false)
allow(participant).to receive(:set_handle).and_return('handle')
allow(AssignmentParticipant).to receive(:exists?).and_return(false)
allow(AssignmentParticipant).to receive(:create).and_return(participant)
allow(AssignmentParticipant).to receive(:set_handle)
expect{(AssignmentParticipant.import(row, nil, {}, 1))}.to change { ActionMailer::Base.deliveries.count }.by(1)
end
end
</pre>

'''Manual Testing Results'''

After following the step-by-step instructions for Issue1 in the Test Plan below, the following email was received. This shows that when a new user was imported through the assignment participants page, they received a welcome email.

[[File:Welcome email.png]]

==Issue2 (345) - Don't send email to reviewers for a new submission after review deadline has passed==

'''Pre conditions'''
* There is an assignment, a student as a participant, a participant as a reviewer who is reviewing the this particular assignment
* a review is made for a submission by the student
* review deadline has passed
* the student is allowed to submit after the review deadline has passed

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/345 -
"Evidently, if a submission is revised after review, the system e-mails the reviewer saying to revise the review. This is just fine ... except if the last round of review has been completed.
The message telling reviewers to revise their reviews should not be sent after the last review deadline has passed."

So basically, When the student makes a new submission after the LAST review deadline has passed. The reviewer should not receive an email, asking the reviewer to update the review according to the new submission.

'''Actual Behavior'''

According to the current Code scenario on the beta branch '''''if the deadline has passed, a student(participant) cannot make new submissions'''''. So, automatically if the participant doe not make a new submission then the reviewer wont receive an email. So this issue does not really exist by the virtue of the state of the system.
the stack trace for the check if the submission is allowed or not is as follows -
assignment.rb
<pre>
def submission_allowed(topic_id = nil)
check_condition('submission_allowed_id', topic_id)
end
</pre>

assignment.rb
<pre>
def check_condition(column, topic_id = nil)
next_due_date = DueDate.get_next_due_date(self.id, topic_id)
return false if next_due_date.nil?
right_id = next_due_date.send column
right = DeadlineRight.find(right_id)
right && (right.name == 'OK' || right.name == 'Late')
end
</pre>

due_date.rb
<pre>
def self.get_next_due_date(assignment_id, topic_id = nil)
if Assignment.find(assignment_id).staggered_deadline?
next_due_date = TopicDueDate.find_by(['parent_id = ? and due_at >= ?', topic_id, Time.zone.now])
# if certion TopicDueDate is not exist, we should query next corresponding AssignmentDueDate.
# eg. Time.now is 08/28/2016
# One topic uses following deadlines:
# TopicDueDate 08/01/2016
# TopicDueDate 08/02/2016
# TopicDueDate 08/03/2016
# AssignmentDueDate 09/04/2016
# In this case, we cannot find due_at later than Time.now in TopicDueDate.
# So we should find next corrsponding AssignmentDueDate, starting with the 4th one, not the 1st one!
if next_due_date.nil?
topic_due_date_size = TopicDueDate.where(parent_id: topic_id).size
following_assignment_due_dates = AssignmentDueDate.where(parent_id: assignment_id)[topic_due_date_size..-1]
unless following_assignment_due_dates.nil?
following_assignment_due_dates.each do |assignment_due_date|
if assignment_due_date.due_at >= Time.zone.now
next_due_date = assignment_due_date
break
end
end
end
end
else
next_due_date = AssignmentDueDate.find_by(['parent_id = ? && due_at >= ?', assignment_id, Time.zone.now])
end
next_due_date
end
</pre>

So this is issue is resolved by the state of the system itself. 
'''''BUT Surprisingly on beta branch Reviewers aren't getting any emails at all'''''
on beta branch, in submitted_content_controller, in function "submit_file", this lines is supposed to send email to the reviewers to notify them about the new submission
<pre> participant.assignment.email(participant.id) rescue nil </pre>
''BUT'' here email function is undefined. we checked for email function in assignment class, there was none. The error "undefined function on assignment" is always rescued and hence no errors were raised previously and hence it wasn't highlighted before. 
So, in beta branch reviewers are not being notified anytime a new submission is made to an assignment that they have previously reviewed. So we fixed that
Taking inspiration from the Master branch the previous team's work we added following code to send an email notifying the reviewer of an new submission.

in submitted_content_controller.rb, in the functions, submit_file, submit_hyperlink
<pre>
Team.mail_assigned_reviewers(@participant)
</pre>

participant.rb

<pre>
def mail_assigned_reviewers()
team = self.team
maps = ResponseMap.where(reviewed_object_id: self.assignment.id, reviewee_id: team.id, type: 'ReviewResponseMap')
unless maps.nil?
maps.each do |map|
reviewer = User.find(Participant.find(map.reviewer_id).user_id)
Mailer.sync_message(
{
:to => reviewer.email,
subject: "Assignment '#{self.assignment.name}': A submission has been updated since you last reviewed it",
cc: User.find_by(self.assignment.instructor_id).email,
:body => {
:obj_name => self.assignment.name,
:link => "https://expertiza.ncsu.edu/response/new?id=#{map.id}",
:type => 'submission',
:first_name => ApplicationHelper::get_user_first_name(User.find(Participant.find(map.reviewer_id).user_id)),
:partial_name => 'updated_submission_since_review'
}
}
).deliver_now
end
end
end
</pre>

app/views/mailer/partials/_updated_submission_since_review_plain.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review.
Hence, to update your review please click on the following link.
<% if @link != nil %><%= @link %><% end %>
</pre>

app/views/mailer/partials/_updated_submission_since_review_html.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review. 
Hence, to update your review please click on the following link. 
<% if @link != nil %><a href="<%= @link %>"><%= @link %></a><% end %>

</pre>

added a line in app/mailers/mailer.rb
<pre>
@link = defn[:body][:link]
</pre>

----

==Issue3 (111) - Adding relevant links to reminder emails==

'''Pre conditions'''
* There exists an assignment and a participant associated with that assignment
* The due date for the assignment is approaching

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/111 -
"E-mails about reviews should direct the user to the page where the review is found. Deadline reminders should include a link on where to go to perform the needed function."

So, when assignment reminder emails are sent to students, they should include a link to the relevant assignment.

'''Actual Behavior'''

We implemented this behavior by enhancing the 'email_reminder' function within the app/mailers/mail_worker.rb file. First we get the user associated with the email, then we get the participant object associated with the particular user and the assignment. The ID of this object is the query parameter located at the end of the relevant link. '''mail_worker.rb'''
<pre>
def email_reminder(emails, deadline_type)
assignment = Assignment.find(self.assignment_id)
subject = "Message regarding #{deadline_type} for assignment #{assignment.name}"

# Defining the body of mail
body = "This is a reminder to complete #{deadline_type} for assignment #{assignment.name}.\n"

emails.each do |mail|
# Since the email is not unique fetching the first instance in results returned when searching via email
user = User.where(email: mail).first

# Finding the mapping between participant and assignment so that it can be sent as a query param
participant_assignment_id = Participant.find(user_id: user.id.to_s, parent_id: self.assignment_id.to_s).first.id

# This is the link which User can use to navigate
link_to_destination = "Please follow the link: http://expertiza.ncsu.edu/student_task/view?id=#{participant_assignment_id}\n"
body += link_to_destination + "Deadline is #{self.due_at}. If you have already done the #{deadline_type}, then please ignore this mail.";

# Send mail to the user
@mail = Mailer.delayed_message(bcc: mail, subject: subject, body: body)
@mail.deliver_now
Rails.logger.info mail
end
end
</pre>
This function is clearly tested through a new test we added to the spec/workers/sidekiq_mail_worker_spec.rb '''sidekiq_mail_worker_spec.rb'''
<pre>
it "should send reminder email to required email address with proper content" do
Sidekiq::Testing.inline!
ActionMailer::Base.deliveries.clear
worker = MailWorker.new
worker.perform("1", "metareview", "2018-12-31 00:00:01")
expect(ActionMailer::Base.deliveries.size).to eq(1)
email = ActionMailer::Base.deliveries.first
expect(email.from[0]).to eq("expertiza.development@gmail.com")
expect(email.bcc[0]).to eq("psingh22@ncsu.edu")
expect(email.subject).to eq("Message regarding teammate review for assignment no assignment")
expect(email.body).to eq("This is a reminder to complete teammate review for assignment no assignment.\nPlease follow the link: http://expertiza.ncsu.edu/student_task/view?id=1\nDeadline is 2018-12-31 00:00:01. If you have already done the teammate review, then please ignore this mail.")
end
</pre>

==Test Plan==

'''Issue 1'''

Step 1: Navigate to Manage --> Assignment page.

Step 2: Click on add participants for any of the assignments.

Step 3: Click "Import course participants"

Step 4: Choose a csv file to be imported (follow the format given on the website).

Step 5: The users mentioned in the csv file and don't exist on Expertiza should get a new user email.

'''Issue 2'''

Step 1: Create new assignment [Manage --> Assignment --> + Button (to create new assignment)]

Step 2: Fill the details for the assignments.

Step 3: Navigate to due dates.

Step 4: Change the number of review rounds to 2.

Step 5: Select "Yes" in the dropdown for review allowed during submission and select "Yes" for submission during the review.

Step 6: Add two users to the assignment(author and reviewer).

Step 7: Log in with some user credentials (author credential).

Step 8: Make a new submission to this assignment.

Step 9: Log in with another user (reviewer).

Step 10: Submit a review of the assignment submission.

Step 11: Login as an author again.

Step 12: Edit the submission.

Step 13: After this check the mailbox of the reviewer [development mail for development].

Step 14: Reviewer should get the mail to re-review the work.

Step 15: Change the due date to some date and time which has passed.

Step 16: Now the author should not be able to make a new submission.

'''Issue 3'''

Step 1: Create new assignment [Manage --> Assignment --> + Button (to create new assignment)]

Step 2: Fill the details for the assignments.

Step 3: Add an existing user to the new assignment

Step 3: Navigate to due dates for the new assignment.

Step 4: Set the due date to 1 hour and 5 seconds from now.

Step 5: The user should recieve a reminder email with the relevant links to the assignment.

File:Welcome email.png

2021-10-27T03:48:18Z

Glbrook2: Screenshot of email received after importing a new student via csv

Screenshot of email received after importing a new student via csv

CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications

2021-10-27T03:46:35Z

Glbrook2: /* E2142. Improve e-mail notifications */

=E2142. Improve e-mail notifications=

==Brief Introduction==

* E2142. Improve e-mail notifications
* The forked repository can be found at: https://github.com/griffinbrookshire/expertiza

==Problem Statement==
The following tasks were accomplished in this project:

*Issue1: Send new account welcome email to user, when imported from CSV through assignment page.
*Issue2: Don't send email to reviewers for a new submission after review deadline has passed.
*Issue3: Adding relevant links to reminder emails.

==Issue1 (717) - Send new account welcome email to user, when imported from CSV through assignment page==

'''Pre conditions'''
* There exists an assignment and an instructor
* The instructor navigates to the 'Manage Assignments' page
* The instructor clicks 'Add Participants' for the existing assignment
* The instructor clicks 'Import assignment participants'
* The instructor imports a CSV file containing a user who does not exist yet

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/717 -
"When students' accounts are created by importing a CSV on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. Students should receive e-mails upon account creation, regardless of how their account is created."

So, when students accounts are created in any way, they should receive a welcome email. This includes adding them through importing a CSV.

'''Actual Behavior'''

The implementation and testing for this issue already existed in the beta branch, which will be discussed below. 
This behavior was already implemented through one simple line in the app/models/user.rb file. '''user.rb'''
<pre>
after_create :email_welcome
</pre>
This line calls the 'email_welcome' function every time a user is created, which sends a welcome email to the newly created user. '''user.rb'''
<pre>
# Function which has a MailerHelper which sends the mail welcome email to the user after signing up
def email_welcome
#this will send an account creation notification to user via email.
MailerHelper.send_mail_to_user(self, "Your Expertiza account and password has been created", "user_welcome", password).deliver_now
end
</pre>
This functionality was also completely tested in the spec/models/assignment_participant_spec.rb file show below. This test shows that when the import function is called an email is delivered. '''assignment_participant_spec.rb'''
<pre>
context 'when new user needs to be created' do
let(:row) do
{name: 'no one', fullname: 'no one', email: 'name@email.com', role:'user_role_name', parent: 'user_parent_name'}
end
let(:attributes) do
{role_id: 1, name: 'no one', fullname: 'no one', email: 'name@email.com', email_on_submission: 'name@email.com',
email_on_review: 'name@email.com', email_on_review_of_review: 'name@email.com'}
end
let(:test_user) do
{name: 'abc', email: 'abcbbc@gmail.com'}
end
it 'create the user and number of mails sent should be 1' do
ActionMailer::Base.deliveries.clear
allow(ImportFileHelper).to receive(:define_attributes).with(row).and_return(attributes)
allow(ImportFileHelper).to receive(:create_new_user) do
test_user = User.new(name: 'abc', fullname: 'abc bbc', email: 'abcbbc@gmail.com')
test_user.id = 123
test_user.save!
test_user
end
#allow(ImportFileHelper).to receive(:create_new_user).with(attributes, {}).and_return()
allow(Assignment).to receive(:find).with(1).and_return(assignment)
allow(User).to receive(:exists?).with(name: 'no one').and_return(false)
allow(participant).to receive(:set_handle).and_return('handle')
allow(AssignmentParticipant).to receive(:exists?).and_return(false)
allow(AssignmentParticipant).to receive(:create).and_return(participant)
allow(AssignmentParticipant).to receive(:set_handle)
expect{(AssignmentParticipant.import(row, nil, {}, 1))}.to change { ActionMailer::Base.deliveries.count }.by(1)
end
end
</pre>

Manual Testing Results

[[File:Example.jpg]]

==Issue2 (345) - Don't send email to reviewers for a new submission after review deadline has passed==

'''Pre conditions'''
* There is an assignment, a student as a participant, a participant as a reviewer who is reviewing the this particular assignment
* a review is made for a submission by the student
* review deadline has passed
* the student is allowed to submit after the review deadline has passed

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/345 -
"Evidently, if a submission is revised after review, the system e-mails the reviewer saying to revise the review. This is just fine ... except if the last round of review has been completed.
The message telling reviewers to revise their reviews should not be sent after the last review deadline has passed."

So basically, When the student makes a new submission after the LAST review deadline has passed. The reviewer should not receive an email, asking the reviewer to update the review according to the new submission.

'''Actual Behavior'''

According to the current Code scenario on the beta branch '''''if the deadline has passed, a student(participant) cannot make new submissions'''''. So, automatically if the participant doe not make a new submission then the reviewer wont receive an email. So this issue does not really exist by the virtue of the state of the system.
the stack trace for the check if the submission is allowed or not is as follows -
assignment.rb
<pre>
def submission_allowed(topic_id = nil)
check_condition('submission_allowed_id', topic_id)
end
</pre>

assignment.rb
<pre>
def check_condition(column, topic_id = nil)
next_due_date = DueDate.get_next_due_date(self.id, topic_id)
return false if next_due_date.nil?
right_id = next_due_date.send column
right = DeadlineRight.find(right_id)
right && (right.name == 'OK' || right.name == 'Late')
end
</pre>

due_date.rb
<pre>
def self.get_next_due_date(assignment_id, topic_id = nil)
if Assignment.find(assignment_id).staggered_deadline?
next_due_date = TopicDueDate.find_by(['parent_id = ? and due_at >= ?', topic_id, Time.zone.now])
# if certion TopicDueDate is not exist, we should query next corresponding AssignmentDueDate.
# eg. Time.now is 08/28/2016
# One topic uses following deadlines:
# TopicDueDate 08/01/2016
# TopicDueDate 08/02/2016
# TopicDueDate 08/03/2016
# AssignmentDueDate 09/04/2016
# In this case, we cannot find due_at later than Time.now in TopicDueDate.
# So we should find next corrsponding AssignmentDueDate, starting with the 4th one, not the 1st one!
if next_due_date.nil?
topic_due_date_size = TopicDueDate.where(parent_id: topic_id).size
following_assignment_due_dates = AssignmentDueDate.where(parent_id: assignment_id)[topic_due_date_size..-1]
unless following_assignment_due_dates.nil?
following_assignment_due_dates.each do |assignment_due_date|
if assignment_due_date.due_at >= Time.zone.now
next_due_date = assignment_due_date
break
end
end
end
end
else
next_due_date = AssignmentDueDate.find_by(['parent_id = ? && due_at >= ?', assignment_id, Time.zone.now])
end
next_due_date
end
</pre>

So this is issue is resolved by the state of the system itself. 
'''''BUT Surprisingly on beta branch Reviewers aren't getting any emails at all'''''
on beta branch, in submitted_content_controller, in function "submit_file", this lines is supposed to send email to the reviewers to notify them about the new submission
<pre> participant.assignment.email(participant.id) rescue nil </pre>
''BUT'' here email function is undefined. we checked for email function in assignment class, there was none. The error "undefined function on assignment" is always rescued and hence no errors were raised previously and hence it wasn't highlighted before. 
So, in beta branch reviewers are not being notified anytime a new submission is made to an assignment that they have previously reviewed. So we fixed that
Taking inspiration from the Master branch the previous team's work we added following code to send an email notifying the reviewer of an new submission.

in submitted_content_controller.rb, in the functions, submit_file, submit_hyperlink
<pre>
Team.mail_assigned_reviewers(@participant)
</pre>

participant.rb

<pre>
def mail_assigned_reviewers()
team = self.team
maps = ResponseMap.where(reviewed_object_id: self.assignment.id, reviewee_id: team.id, type: 'ReviewResponseMap')
unless maps.nil?
maps.each do |map|
reviewer = User.find(Participant.find(map.reviewer_id).user_id)
Mailer.sync_message(
{
:to => reviewer.email,
subject: "Assignment '#{self.assignment.name}': A submission has been updated since you last reviewed it",
cc: User.find_by(self.assignment.instructor_id).email,
:body => {
:obj_name => self.assignment.name,
:link => "https://expertiza.ncsu.edu/response/new?id=#{map.id}",
:type => 'submission',
:first_name => ApplicationHelper::get_user_first_name(User.find(Participant.find(map.reviewer_id).user_id)),
:partial_name => 'updated_submission_since_review'
}
}
).deliver_now
end
end
end
</pre>

app/views/mailer/partials/_updated_submission_since_review_plain.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review.
Hence, to update your review please click on the following link.
<% if @link != nil %><%= @link %><% end %>
</pre>

app/views/mailer/partials/_updated_submission_since_review_html.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review. 
Hence, to update your review please click on the following link. 
<% if @link != nil %><a href="<%= @link %>"><%= @link %></a><% end %>

</pre>

added a line in app/mailers/mailer.rb
<pre>
@link = defn[:body][:link]
</pre>

----

==Issue3 (111) - Adding relevant links to reminder emails==

'''Pre conditions'''
* There exists an assignment and a participant associated with that assignment
* The due date for the assignment is approaching

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/111 -
"E-mails about reviews should direct the user to the page where the review is found. Deadline reminders should include a link on where to go to perform the needed function."

So, when assignment reminder emails are sent to students, they should include a link to the relevant assignment.

'''Actual Behavior'''

We implemented this behavior by enhancing the 'email_reminder' function within the app/mailers/mail_worker.rb file. First we get the user associated with the email, then we get the participant object associated with the particular user and the assignment. The ID of this object is the query parameter located at the end of the relevant link. '''mail_worker.rb'''
<pre>
def email_reminder(emails, deadline_type)
assignment = Assignment.find(self.assignment_id)
subject = "Message regarding #{deadline_type} for assignment #{assignment.name}"

# Defining the body of mail
body = "This is a reminder to complete #{deadline_type} for assignment #{assignment.name}.\n"

emails.each do |mail|
# Since the email is not unique fetching the first instance in results returned when searching via email
user = User.where(email: mail).first

# Finding the mapping between participant and assignment so that it can be sent as a query param
participant_assignment_id = Participant.find(user_id: user.id.to_s, parent_id: self.assignment_id.to_s).first.id

# This is the link which User can use to navigate
link_to_destination = "Please follow the link: http://expertiza.ncsu.edu/student_task/view?id=#{participant_assignment_id}\n"
body += link_to_destination + "Deadline is #{self.due_at}. If you have already done the #{deadline_type}, then please ignore this mail.";

# Send mail to the user
@mail = Mailer.delayed_message(bcc: mail, subject: subject, body: body)
@mail.deliver_now
Rails.logger.info mail
end
end
</pre>
This function is clearly tested through a new test we added to the spec/workers/sidekiq_mail_worker_spec.rb '''sidekiq_mail_worker_spec.rb'''
<pre>
it "should send reminder email to required email address with proper content" do
Sidekiq::Testing.inline!
ActionMailer::Base.deliveries.clear
worker = MailWorker.new
worker.perform("1", "metareview", "2018-12-31 00:00:01")
expect(ActionMailer::Base.deliveries.size).to eq(1)
email = ActionMailer::Base.deliveries.first
expect(email.from[0]).to eq("expertiza.development@gmail.com")
expect(email.bcc[0]).to eq("psingh22@ncsu.edu")
expect(email.subject).to eq("Message regarding teammate review for assignment no assignment")
expect(email.body).to eq("This is a reminder to complete teammate review for assignment no assignment.\nPlease follow the link: http://expertiza.ncsu.edu/student_task/view?id=1\nDeadline is 2018-12-31 00:00:01. If you have already done the teammate review, then please ignore this mail.")
end
</pre>

==Test Plan==

'''Issue 1'''

Step 1: Navigate to Manage --> Assignment page.

Step 2: Click on add participants for any of the assignments.

Step 3: Click "Import course participants"

Step 4: Choose a csv file to be imported (follow the format given on the website).

Step 5: The users mentioned in the csv file and don't exist on Expertiza should get a new user email.

'''Issue 2'''

Step 1: Create new assignment [Manage --> Assignment --> + Button (to create new assignment)]

Step 2: Fill the details for the assignments.

Step 3: Navigate to due dates.

Step 4: Change the number of review rounds to 2.

Step 5: Select "Yes" in the dropdown for review allowed during submission and select "Yes" for submission during the review.

Step 6: Add two users to the assignment(author and reviewer).

Step 7: Log in with some user credentials (author credential).

Step 8: Make a new submission to this assignment.

Step 9: Log in with another user (reviewer).

Step 10: Submit a review of the assignment submission.

Step 11: Login as an author again.

Step 12: Edit the submission.

Step 13: After this check the mailbox of the reviewer [development mail for development].

Step 14: Reviewer should get the mail to re-review the work.

Step 15: Change the due date to some date and time which has passed.

Step 16: Now the author should not be able to make a new submission.

'''Issue 3'''

Step 1: Create new assignment [Manage --> Assignment --> + Button (to create new assignment)]

Step 2: Fill the details for the assignments.

Step 3: Add an existing user to the new assignment

Step 3: Navigate to due dates for the new assignment.

Step 4: Set the due date to 1 hour and 5 seconds from now.

Step 5: The user should recieve a reminder email with the relevant links to the assignment.

CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications

2021-10-26T23:14:00Z

Glbrook2: /* Test Plan */

=E2142. Improve e-mail notifications=

==Brief Introduction==

* E2142. Improve e-mail notifications
* The forked repository can be found at: https://github.com/griffinbrookshire/expertiza

==Problem Statement==
The following tasks were accomplished in this project:

*Issue1: Send new account welcome email to user, when imported from CSV through assignment page.
*Issue2: Don't send email to reviewers for a new submission after review deadline has passed.
*Issue3: Adding relevant links to reminder emails.

==Issue1 (717) - Send new account welcome email to user, when imported from CSV through assignment page==

'''Pre conditions'''
* There exists an assignment and an instructor
* The instructor navigates to the 'Manage Assignments' page
* The instructor clicks 'Add Participants' for the existing assignment
* The instructor clicks 'Import assignment participants'
* The instructor imports a CSV file containing a user who does not exist yet

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/717 -
"When students' accounts are created by importing a CSV on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. Students should receive e-mails upon account creation, regardless of how their account is created."

So, when students accounts are created in any way, they should receive a welcome email. This includes adding them through importing a CSV.

'''Actual Behavior'''

The implementation and testing for this issue already existed in the beta branch, which will be discussed below. 
This behavior was already implemented through one simple line in the app/models/user.rb file. '''user.rb'''
<pre>
after_create :email_welcome
</pre>
This line calls the 'email_welcome' function every time a user is created, which sends a welcome email to the newly created user. '''user.rb'''
<pre>
# Function which has a MailerHelper which sends the mail welcome email to the user after signing up
def email_welcome
#this will send an account creation notification to user via email.
MailerHelper.send_mail_to_user(self, "Your Expertiza account and password has been created", "user_welcome", password).deliver_now
end
</pre>
This functionality was also completely tested in the spec/models/assignment_participant_spec.rb file show below. This test shows that when the import function is called an email is delivered. '''assignment_participant_spec.rb'''
<pre>
context 'when new user needs to be created' do
let(:row) do
{name: 'no one', fullname: 'no one', email: 'name@email.com', role:'user_role_name', parent: 'user_parent_name'}
end
let(:attributes) do
{role_id: 1, name: 'no one', fullname: 'no one', email: 'name@email.com', email_on_submission: 'name@email.com',
email_on_review: 'name@email.com', email_on_review_of_review: 'name@email.com'}
end
let(:test_user) do
{name: 'abc', email: 'abcbbc@gmail.com'}
end
it 'create the user and number of mails sent should be 1' do
ActionMailer::Base.deliveries.clear
allow(ImportFileHelper).to receive(:define_attributes).with(row).and_return(attributes)
allow(ImportFileHelper).to receive(:create_new_user) do
test_user = User.new(name: 'abc', fullname: 'abc bbc', email: 'abcbbc@gmail.com')
test_user.id = 123
test_user.save!
test_user
end
#allow(ImportFileHelper).to receive(:create_new_user).with(attributes, {}).and_return()
allow(Assignment).to receive(:find).with(1).and_return(assignment)
allow(User).to receive(:exists?).with(name: 'no one').and_return(false)
allow(participant).to receive(:set_handle).and_return('handle')
allow(AssignmentParticipant).to receive(:exists?).and_return(false)
allow(AssignmentParticipant).to receive(:create).and_return(participant)
allow(AssignmentParticipant).to receive(:set_handle)
expect{(AssignmentParticipant.import(row, nil, {}, 1))}.to change { ActionMailer::Base.deliveries.count }.by(1)
end
end
</pre>

==Issue2 (345) - Don't send email to reviewers for a new submission after review deadline has passed==

'''Pre conditions'''
* There is an assignment, a student as a participant, a participant as a reviewer who is reviewing the this particular assignment
* a review is made for a submission by the student
* review deadline has passed
* the student is allowed to submit after the review deadline has passed

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/345 -
"Evidently, if a submission is revised after review, the system e-mails the reviewer saying to revise the review. This is just fine ... except if the last round of review has been completed.
The message telling reviewers to revise their reviews should not be sent after the last review deadline has passed."

So basically, When the student makes a new submission after the LAST review deadline has passed. The reviewer should not receive an email, asking the reviewer to update the review according to the new submission.

'''Actual Behavior'''

According to the current Code scenario on the beta branch '''''if the deadline has passed, a student(participant) cannot make new submissions'''''. So, automatically if the participant doe not make a new submission then the reviewer wont receive an email. So this issue does not really exist by the virtue of the state of the system.
the stack trace for the check if the submission is allowed or not is as follows -
assignment.rb
<pre>
def submission_allowed(topic_id = nil)
check_condition('submission_allowed_id', topic_id)
end
</pre>

assignment.rb
<pre>
def check_condition(column, topic_id = nil)
next_due_date = DueDate.get_next_due_date(self.id, topic_id)
return false if next_due_date.nil?
right_id = next_due_date.send column
right = DeadlineRight.find(right_id)
right && (right.name == 'OK' || right.name == 'Late')
end
</pre>

due_date.rb
<pre>
def self.get_next_due_date(assignment_id, topic_id = nil)
if Assignment.find(assignment_id).staggered_deadline?
next_due_date = TopicDueDate.find_by(['parent_id = ? and due_at >= ?', topic_id, Time.zone.now])
# if certion TopicDueDate is not exist, we should query next corresponding AssignmentDueDate.
# eg. Time.now is 08/28/2016
# One topic uses following deadlines:
# TopicDueDate 08/01/2016
# TopicDueDate 08/02/2016
# TopicDueDate 08/03/2016
# AssignmentDueDate 09/04/2016
# In this case, we cannot find due_at later than Time.now in TopicDueDate.
# So we should find next corrsponding AssignmentDueDate, starting with the 4th one, not the 1st one!
if next_due_date.nil?
topic_due_date_size = TopicDueDate.where(parent_id: topic_id).size
following_assignment_due_dates = AssignmentDueDate.where(parent_id: assignment_id)[topic_due_date_size..-1]
unless following_assignment_due_dates.nil?
following_assignment_due_dates.each do |assignment_due_date|
if assignment_due_date.due_at >= Time.zone.now
next_due_date = assignment_due_date
break
end
end
end
end
else
next_due_date = AssignmentDueDate.find_by(['parent_id = ? && due_at >= ?', assignment_id, Time.zone.now])
end
next_due_date
end
</pre>

So this is issue is resolved by the state of the system itself. 
'''''BUT Surprisingly on beta branch Reviewers aren't getting any emails at all'''''
on beta branch, in submitted_content_controller, in function "submit_file", this lines is supposed to send email to the reviewers to notify them about the new submission
<pre> participant.assignment.email(participant.id) rescue nil </pre>
''BUT'' here email function is undefined. we checked for email function in assignment class, there was none. The error "undefined function on assignment" is always rescued and hence no errors were raised previously and hence it wasn't highlighted before. 
So, in beta branch reviewers are not being notified anytime a new submission is made to an assignment that they have previously reviewed. So we fixed that
Taking inspiration from the Master branch the previous team's work we added following code to send an email notifying the reviewer of an new submission.

in submitted_content_controller.rb, in the functions, submit_file, submit_hyperlink
<pre>
Team.mail_assigned_reviewers(@participant)
</pre>

participant.rb

<pre>
def mail_assigned_reviewers()
team = self.team
maps = ResponseMap.where(reviewed_object_id: self.assignment.id, reviewee_id: team.id, type: 'ReviewResponseMap')
unless maps.nil?
maps.each do |map|
reviewer = User.find(Participant.find(map.reviewer_id).user_id)
Mailer.sync_message(
{
:to => reviewer.email,
subject: "Assignment '#{self.assignment.name}': A submission has been updated since you last reviewed it",
cc: User.find_by(self.assignment.instructor_id).email,
:body => {
:obj_name => self.assignment.name,
:link => "https://expertiza.ncsu.edu/response/new?id=#{map.id}",
:type => 'submission',
:first_name => ApplicationHelper::get_user_first_name(User.find(Participant.find(map.reviewer_id).user_id)),
:partial_name => 'updated_submission_since_review'
}
}
).deliver_now
end
end
end
</pre>

app/views/mailer/partials/_updated_submission_since_review_plain.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review.
Hence, to update your review please click on the following link.
<% if @link != nil %><%= @link %><% end %>
</pre>

app/views/mailer/partials/_updated_submission_since_review_html.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review. 
Hence, to update your review please click on the following link. 
<% if @link != nil %><a href="<%= @link %>"><%= @link %></a><% end %>

</pre>

added a line in app/mailers/mailer.rb
<pre>
@link = defn[:body][:link]
</pre>

----

==Issue3 (111) - Adding relevant links to reminder emails==

'''Pre conditions'''
* There exists an assignment and a participant associated with that assignment
* The due date for the assignment is approaching

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/111 -
"E-mails about reviews should direct the user to the page where the review is found. Deadline reminders should include a link on where to go to perform the needed function."

So, when assignment reminder emails are sent to students, they should include a link to the relevant assignment.

'''Actual Behavior'''

We implemented this behavior by enhancing the 'email_reminder' function within the app/mailers/mail_worker.rb file. First we get the user associated with the email, then we get the participant object associated with the particular user and the assignment. The ID of this object is the query parameter located at the end of the relevant link. '''mail_worker.rb'''
<pre>
def email_reminder(emails, deadline_type)
assignment = Assignment.find(self.assignment_id)
subject = "Message regarding #{deadline_type} for assignment #{assignment.name}"

# Defining the body of mail
body = "This is a reminder to complete #{deadline_type} for assignment #{assignment.name}.\n"

emails.each do |mail|
# Since the email is not unique fetching the first instance in results returned when searching via email
user = User.where(email: mail).first

# Finding the mapping between participant and assignment so that it can be sent as a query param
participant_assignment_id = Participant.find(user_id: user.id.to_s, parent_id: self.assignment_id.to_s).first.id

# This is the link which User can use to navigate
link_to_destination = "Please follow the link: http://expertiza.ncsu.edu/student_task/view?id=#{participant_assignment_id}\n"
body += link_to_destination + "Deadline is #{self.due_at}. If you have already done the #{deadline_type}, then please ignore this mail.";

# Send mail to the user
@mail = Mailer.delayed_message(bcc: mail, subject: subject, body: body)
@mail.deliver_now
Rails.logger.info mail
end
end
</pre>
This function is clearly tested through a new test we added to the spec/workers/sidekiq_mail_worker_spec.rb '''sidekiq_mail_worker_spec.rb'''
<pre>
it "should send reminder email to required email address with proper content" do
Sidekiq::Testing.inline!
ActionMailer::Base.deliveries.clear
worker = MailWorker.new
worker.perform("1", "metareview", "2018-12-31 00:00:01")
expect(ActionMailer::Base.deliveries.size).to eq(1)
email = ActionMailer::Base.deliveries.first
expect(email.from[0]).to eq("expertiza.development@gmail.com")
expect(email.bcc[0]).to eq("psingh22@ncsu.edu")
expect(email.subject).to eq("Message regarding teammate review for assignment no assignment")
expect(email.body).to eq("This is a reminder to complete teammate review for assignment no assignment.\nPlease follow the link: http://expertiza.ncsu.edu/student_task/view?id=1\nDeadline is 2018-12-31 00:00:01. If you have already done the teammate review, then please ignore this mail.")
end
</pre>

==Test Plan==

'''Issue 1'''

Step 1: Navigate to Manage --> Assignment page.

Step 2: Click on add participants for any of the assignments.

Step 3: Click "Import course participants"

Step 4: Choose a csv file to be imported (follow the format given on the website).

Step 5: The users mentioned in the csv file and don't exist on Expertiza should get a new user email.

'''Issue 2'''

Step 1: Create new assignment [Manage --> Assignment --> + Button (to create new assignment)]

Step 2: Fill the details for the assignments.

Step 3: Navigate to due dates.

Step 4: Change the number of review rounds to 2.

Step 5: Select "Yes" in the dropdown for review allowed during submission and select "Yes" for submission during the review.

Step 6: Add two users to the assignment(author and reviewer).

Step 7: Log in with some user credentials (author credential).

Step 8: Make a new submission to this assignment.

Step 9: Log in with another user (reviewer).

Step 10: Submit a review of the assignment submission.

Step 11: Login as an author again.

Step 12: Edit the submission.

Step 13: After this check the mailbox of the reviewer [development mail for development].

Step 14: Reviewer should get the mail to re-review the work.

Step 15: Change the due date to some date and time which has passed.

Step 16: Now the author should not be able to make a new submission.

'''Issue 3'''

Step 1: Create new assignment [Manage --> Assignment --> + Button (to create new assignment)]

Step 2: Fill the details for the assignments.

Step 3: Add an existing user to the new assignment

Step 3: Navigate to due dates for the new assignment.

Step 4: Set the due date to 1 hour and 5 seconds from now.

Step 5: The user should recieve a reminder email with the relevant links to the assignment.

CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications

2021-10-21T03:52:22Z

Glbrook2: /* Issue1 (717) - Send new account welcome email to user, when imported from CSV through assignment page */

=E2142. Improve e-mail notifications=

==Brief Introduction==

* E2142. Improve e-mail notifications
* The forked repository can be found at: https://github.com/griffinbrookshire/expertiza

==Problem Statement==
The following tasks were accomplished in this project:

*Issue1: Send new account welcome email to user, when imported from CSV through assignment page.
*Issue2: Don't send email to reviewers for a new submission after review deadline has passed.
*Issue3: Adding relevant links to reminder emails.

==Issue1 (717) - Send new account welcome email to user, when imported from CSV through assignment page==

'''Pre conditions'''
* There exists an assignment and an instructor
* The instructor navigates to the 'Manage Assignments' page
* The instructor clicks 'Add Participants' for the existing assignment
* The instructor clicks 'Import assignment participants'
* The instructor imports a CSV file containing a user who does not exist yet

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/717 -
"When students' accounts are created by importing a CSV on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. Students should receive e-mails upon account creation, regardless of how their account is created."

So, when students accounts are created in any way, they should receive a welcome email. This includes adding them through importing a CSV.

'''Actual Behavior'''

The implementation and testing for this issue already existed in the beta branch, which will be discussed below. 
This behavior was already implemented through one simple line in the app/models/user.rb file. '''user.rb'''
<pre>
after_create :email_welcome
</pre>
This line calls the 'email_welcome' function every time a user is created, which sends a welcome email to the newly created user. '''user.rb'''
<pre>
# Function which has a MailerHelper which sends the mail welcome email to the user after signing up
def email_welcome
#this will send an account creation notification to user via email.
MailerHelper.send_mail_to_user(self, "Your Expertiza account and password has been created", "user_welcome", password).deliver_now
end
</pre>
This functionality was also completely tested in the spec/models/assignment_participant_spec.rb file show below. This test shows that when the import function is called an email is delivered. '''assignment_participant_spec.rb'''
<pre>
context 'when new user needs to be created' do
let(:row) do
{name: 'no one', fullname: 'no one', email: 'name@email.com', role:'user_role_name', parent: 'user_parent_name'}
end
let(:attributes) do
{role_id: 1, name: 'no one', fullname: 'no one', email: 'name@email.com', email_on_submission: 'name@email.com',
email_on_review: 'name@email.com', email_on_review_of_review: 'name@email.com'}
end
let(:test_user) do
{name: 'abc', email: 'abcbbc@gmail.com'}
end
it 'create the user and number of mails sent should be 1' do
ActionMailer::Base.deliveries.clear
allow(ImportFileHelper).to receive(:define_attributes).with(row).and_return(attributes)
allow(ImportFileHelper).to receive(:create_new_user) do
test_user = User.new(name: 'abc', fullname: 'abc bbc', email: 'abcbbc@gmail.com')
test_user.id = 123
test_user.save!
test_user
end
#allow(ImportFileHelper).to receive(:create_new_user).with(attributes, {}).and_return()
allow(Assignment).to receive(:find).with(1).and_return(assignment)
allow(User).to receive(:exists?).with(name: 'no one').and_return(false)
allow(participant).to receive(:set_handle).and_return('handle')
allow(AssignmentParticipant).to receive(:exists?).and_return(false)
allow(AssignmentParticipant).to receive(:create).and_return(participant)
allow(AssignmentParticipant).to receive(:set_handle)
expect{(AssignmentParticipant.import(row, nil, {}, 1))}.to change { ActionMailer::Base.deliveries.count }.by(1)
end
end
</pre>

==Issue2 (345) - Don't send email to reviewers for a new submission after review deadline has passed==

'''Pre conditions'''
* There is an assignment, a student as a participant, a participant as a reviewer who is reviewing the this particular assignment
* a review is made for a submission by the student
* review deadline has passed
* the student is allowed to submit after the review deadline has passed

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/345 -
"Evidently, if a submission is revised after review, the system e-mails the reviewer saying to revise the review. This is just fine ... except if the last round of review has been completed.
The message telling reviewers to revise their reviews should not be sent after the last review deadline has passed."

So basically, When the student makes a new submission after the LAST review deadline has passed. The reviewer should not receive an email, asking the reviewer to update the review according to the new submission.

'''Actual Behavior'''

According to the current Code scenario on the beta branch '''''if the deadline has passed, a student(participant) cannot make new submissions'''''. So, automatically if the participant doe not make a new submission then the reviewer wont receive an email. So this issue does not really exist by the virtue of the state of the system.
the stack trace for the check if the submission is allowed or not is as follows -
assignment.rb
<pre>
def submission_allowed(topic_id = nil)
check_condition('submission_allowed_id', topic_id)
end
</pre>

assignment.rb
<pre>
def check_condition(column, topic_id = nil)
next_due_date = DueDate.get_next_due_date(self.id, topic_id)
return false if next_due_date.nil?
right_id = next_due_date.send column
right = DeadlineRight.find(right_id)
right && (right.name == 'OK' || right.name == 'Late')
end
</pre>

due_date.rb
<pre>
def self.get_next_due_date(assignment_id, topic_id = nil)
if Assignment.find(assignment_id).staggered_deadline?
next_due_date = TopicDueDate.find_by(['parent_id = ? and due_at >= ?', topic_id, Time.zone.now])
# if certion TopicDueDate is not exist, we should query next corresponding AssignmentDueDate.
# eg. Time.now is 08/28/2016
# One topic uses following deadlines:
# TopicDueDate 08/01/2016
# TopicDueDate 08/02/2016
# TopicDueDate 08/03/2016
# AssignmentDueDate 09/04/2016
# In this case, we cannot find due_at later than Time.now in TopicDueDate.
# So we should find next corrsponding AssignmentDueDate, starting with the 4th one, not the 1st one!
if next_due_date.nil?
topic_due_date_size = TopicDueDate.where(parent_id: topic_id).size
following_assignment_due_dates = AssignmentDueDate.where(parent_id: assignment_id)[topic_due_date_size..-1]
unless following_assignment_due_dates.nil?
following_assignment_due_dates.each do |assignment_due_date|
if assignment_due_date.due_at >= Time.zone.now
next_due_date = assignment_due_date
break
end
end
end
end
else
next_due_date = AssignmentDueDate.find_by(['parent_id = ? && due_at >= ?', assignment_id, Time.zone.now])
end
next_due_date
end
</pre>

So this is issue is resolved by the state of the system itself. 
'''''BUT Surprisingly on beta branch Reviewers aren't getting any emails at all'''''
on beta branch, in submitted_content_controller, in function "submit_file", this lines is supposed to send email to the reviewers to notify them about the new submission
<pre> participant.assignment.email(participant.id) rescue nil </pre>
''BUT'' here email function is undefined. we checked for email function in assignment class, there was none. The error "undefined function on assignment" is always rescued and hence no errors were raised previously and hence it wasn't highlighted before. 
So, in beta branch reviewers are not being notified anytime a new submission is made to an assignment that they have previously reviewed. So we fixed that
Taking inspiration from the Master branch the previous team's work we added following code to send an email notifying the reviewer of an new submission.

in submitted_content_controller.rb, in the functions, submit_file, submit_hyperlink
<pre>
Team.mail_assigned_reviewers(@participant)
</pre>

participant.rb

<pre>
def mail_assigned_reviewers()
team = self.team
maps = ResponseMap.where(reviewed_object_id: self.assignment.id, reviewee_id: team.id, type: 'ReviewResponseMap')
unless maps.nil?
maps.each do |map|
reviewer = User.find(Participant.find(map.reviewer_id).user_id)
Mailer.sync_message(
{
:to => reviewer.email,
subject: "Assignment '#{self.assignment.name}': A submission has been updated since you last reviewed it",
cc: User.find_by(self.assignment.instructor_id).email,
:body => {
:obj_name => self.assignment.name,
:link => "https://expertiza.ncsu.edu/response/new?id=#{map.id}",
:type => 'submission',
:first_name => ApplicationHelper::get_user_first_name(User.find(Participant.find(map.reviewer_id).user_id)),
:partial_name => 'updated_submission_since_review'
}
}
).deliver_now
end
end
end
</pre>

app/views/mailer/partials/_updated_submission_since_review_plain.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review.
Hence, to update your review please click on the following link.
<% if @link != nil %><%= @link %><% end %>
</pre>

app/views/mailer/partials/_updated_submission_since_review_html.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review. 
Hence, to update your review please click on the following link. 
<% if @link != nil %><a href="<%= @link %>"><%= @link %></a><% end %>

</pre>

added a line in app/mailers/mailer.rb
<pre>
@link = defn[:body][:link]
</pre>

----

==Issue3 (111) - Adding relevant links to reminder emails==

'''Pre conditions'''
* There exists an assignment and a participant associated with that assignment
* The due date for the assignment is approaching

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/111 -
"E-mails about reviews should direct the user to the page where the review is found. Deadline reminders should include a link on where to go to perform the needed function."

So, when assignment reminder emails are sent to students, they should include a link to the relevant assignment.

'''Actual Behavior'''

We implemented this behavior by enhancing the 'email_reminder' function within the app/mailers/mail_worker.rb file. First we get the user associated with the email, then we get the participant object associated with the particular user and the assignment. The ID of this object is the query parameter located at the end of the relevant link. '''mail_worker.rb'''
<pre>
def email_reminder(emails, deadline_type)
assignment = Assignment.find(self.assignment_id)
subject = "Message regarding #{deadline_type} for assignment #{assignment.name}"

# Defining the body of mail
body = "This is a reminder to complete #{deadline_type} for assignment #{assignment.name}.\n"

emails.each do |mail|
# Since the email is not unique fetching the first instance in results returned when searching via email
user = User.where(email: mail).first

# Finding the mapping between participant and assignment so that it can be sent as a query param
participant_assignment_id = Participant.find(user_id: user.id.to_s, parent_id: self.assignment_id.to_s).first.id

# This is the link which User can use to navigate
link_to_destination = "Please follow the link: http://expertiza.ncsu.edu/student_task/view?id=#{participant_assignment_id}\n"
body += link_to_destination + "Deadline is #{self.due_at}. If you have already done the #{deadline_type}, then please ignore this mail.";

# Send mail to the user
@mail = Mailer.delayed_message(bcc: mail, subject: subject, body: body)
@mail.deliver_now
Rails.logger.info mail
end
end
</pre>
This function is clearly tested through a new test we added to the spec/workers/sidekiq_mail_worker_spec.rb '''sidekiq_mail_worker_spec.rb'''
<pre>
it "should send reminder email to required email address with proper content" do
Sidekiq::Testing.inline!
ActionMailer::Base.deliveries.clear
worker = MailWorker.new
worker.perform("1", "metareview", "2018-12-31 00:00:01")
expect(ActionMailer::Base.deliveries.size).to eq(1)
email = ActionMailer::Base.deliveries.first
expect(email.from[0]).to eq("expertiza.development@gmail.com")
expect(email.bcc[0]).to eq("psingh22@ncsu.edu")
expect(email.subject).to eq("Message regarding teammate review for assignment no assignment")
expect(email.body).to eq("This is a reminder to complete teammate review for assignment no assignment.\nPlease follow the link: http://expertiza.ncsu.edu/student_task/view?id=1\nDeadline is 2018-12-31 00:00:01. If you have already done the teammate review, then please ignore this mail.")
end
</pre>

==Test Plan==

'''Issue 1'''

Step 1: Navigate to Manage --> Assignment page.

Step 2: Click on add participants for any of the assignments.

Step 3: Click "Import course participants"

Step 4: Choose a csv file to be imported (follow the format given on the website).

Step 5: The users mentioned in the csv file and don't exist on Expertiza should get a new user email.

Step 6: To check e-mail is received or not, log in with following credentials: username [ 'expertiza.development@gmail.com' ] password [ 'qwer@1234' ].

'''Issue 2'''

Step 1: Create new assignment [Manage --> Assignment --> + Button (to create new assignment)]

Step 2: Fill the details for the assignments.

Step 3: Navigate to due dates.

Step 4: Change the number of review rounds to 2.

Step 5: Select "Yes" in the dropdown for review allowed during submission and select "Yes" for submission during the review.

Step 6: Add two users to the assignment(author and reviewer).

Step 7: Log in with some user credentials (author credential).

Step 8: Make a new submission to this assignment.

Step 9: Log in with another user (reviewer).

Step 10: Submit a review of the assignment submission.

Step 11: Login as an author again.

Step 12: Edit the submission.

Step 13: After this check the mailbox of the reviewer [development mail for development].

Step 14: Reviewer should get the mail to re-review the work.

Step 15: Change the due date to some date and time which has passed.

Step 16: Now the author should not be able to make a new submission.

'''Issue 3'''

Step 1: Create new assignment [Manage --> Assignment --> + Button (to create new assignment)]

Step 2: Fill the details for the assignments.

Step 3: Add an existing user to the new assignment

Step 3: Navigate to due dates for the new assignment.

Step 4: Set the due date to 1 hour and 5 seconds from now.

Step 5: To check e-mail is received or not, log in with following credentials: username [ 'expertiza.development@gmail.com' ] password [ 'qwer@1234' ].

CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications

2021-10-21T03:40:17Z

Glbrook2: /* Test Plan */

=E2142. Improve e-mail notifications=

==Brief Introduction==

* E2142. Improve e-mail notifications
* The forked repository can be found at: https://github.com/griffinbrookshire/expertiza

==Problem Statement==
The following tasks were accomplished in this project:

*Issue1: Send new account welcome email to user, when imported from CSV through assignment page.
*Issue2: Don't send email to reviewers for a new submission after review deadline has passed.
*Issue3: Adding relevant links to reminder emails.

==Issue1 (717) - Send new account welcome email to user, when imported from CSV through assignment page==

'''Pre conditions'''
* There exists an assignment and an instructor
* The instructor navigates to the 'Manage Assignments' page
* The instructor clicks 'Add Participants' for the existing assignment
* The instructor clicks 'Import assignment participants'
* The instructor imports a CSV file containing a user who does not exist yet

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/717 -
"When students' accounts are created by importing a CSV on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. Students should receive e-mails upon account creation, regardless of how their account is created."

So, when students accounts are created in any way, they should receive a welcome email. This includes adding them through importing a CSV.

'''Actual Behavior'''

This behavior was actually already implemented through one simple line in the app/models/user.rb file. '''user.rb'''
<pre>
after_create :email_welcome
</pre>
This line calls the 'email_welcome' function every time a user is created, which sends a welcome email to the newly created user. '''user.rb'''
<pre>
# Function which has a MailerHelper which sends the mail welcome email to the user after signing up
def email_welcome
#this will send an account creation notification to user via email.
MailerHelper.send_mail_to_user(self, "Your Expertiza account and password has been created", "user_welcome", password).deliver_now
end
</pre>
This functionality is also completely tested in the spec/models/assignment_participant_spec.rb file show below. This test shows that when the import function is called an email is delivered. '''assignment_participant_spec.rb'''
<pre>
context 'when new user needs to be created' do
let(:row) do
{name: 'no one', fullname: 'no one', email: 'name@email.com', role:'user_role_name', parent: 'user_parent_name'}
end
let(:attributes) do
{role_id: 1, name: 'no one', fullname: 'no one', email: 'name@email.com', email_on_submission: 'name@email.com',
email_on_review: 'name@email.com', email_on_review_of_review: 'name@email.com'}
end
let(:test_user) do
{name: 'abc', email: 'abcbbc@gmail.com'}
end
it 'create the user and number of mails sent should be 1' do
ActionMailer::Base.deliveries.clear
allow(ImportFileHelper).to receive(:define_attributes).with(row).and_return(attributes)
allow(ImportFileHelper).to receive(:create_new_user) do
test_user = User.new(name: 'abc', fullname: 'abc bbc', email: 'abcbbc@gmail.com')
test_user.id = 123
test_user.save!
test_user
end
#allow(ImportFileHelper).to receive(:create_new_user).with(attributes, {}).and_return()
allow(Assignment).to receive(:find).with(1).and_return(assignment)
allow(User).to receive(:exists?).with(name: 'no one').and_return(false)
allow(participant).to receive(:set_handle).and_return('handle')
allow(AssignmentParticipant).to receive(:exists?).and_return(false)
allow(AssignmentParticipant).to receive(:create).and_return(participant)
allow(AssignmentParticipant).to receive(:set_handle)
expect{(AssignmentParticipant.import(row, nil, {}, 1))}.to change { ActionMailer::Base.deliveries.count }.by(1)
end
end
</pre>

==Issue2 (345) - Don't send email to reviewers for a new submission after review deadline has passed==

'''Pre conditions'''
* There is an assignment, a student as a participant, a participant as a reviewer who is reviewing the this particular assignment
* a review is made for a submission by the student
* review deadline has passed
* the student is allowed to submit after the review deadline has passed

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/345 -
"Evidently, if a submission is revised after review, the system e-mails the reviewer saying to revise the review. This is just fine ... except if the last round of review has been completed.
The message telling reviewers to revise their reviews should not be sent after the last review deadline has passed."

So basically, When the student makes a new submission after the LAST review deadline has passed. The reviewer should not receive an email, asking the reviewer to update the review according to the new submission.

'''Actual Behavior'''

According to the current Code scenario on the beta branch '''''if the deadline has passed, a student(participant) cannot make new submissions'''''. So, automatically if the participant doe not make a new submission then the reviewer wont receive an email. So this issue does not really exist by the virtue of the state of the system.
the stack trace for the check if the submission is allowed or not is as follows -
assignment.rb
<pre>
def submission_allowed(topic_id = nil)
check_condition('submission_allowed_id', topic_id)
end
</pre>

assignment.rb
<pre>
def check_condition(column, topic_id = nil)
next_due_date = DueDate.get_next_due_date(self.id, topic_id)
return false if next_due_date.nil?
right_id = next_due_date.send column
right = DeadlineRight.find(right_id)
right && (right.name == 'OK' || right.name == 'Late')
end
</pre>

due_date.rb
<pre>
def self.get_next_due_date(assignment_id, topic_id = nil)
if Assignment.find(assignment_id).staggered_deadline?
next_due_date = TopicDueDate.find_by(['parent_id = ? and due_at >= ?', topic_id, Time.zone.now])
# if certion TopicDueDate is not exist, we should query next corresponding AssignmentDueDate.
# eg. Time.now is 08/28/2016
# One topic uses following deadlines:
# TopicDueDate 08/01/2016
# TopicDueDate 08/02/2016
# TopicDueDate 08/03/2016
# AssignmentDueDate 09/04/2016
# In this case, we cannot find due_at later than Time.now in TopicDueDate.
# So we should find next corrsponding AssignmentDueDate, starting with the 4th one, not the 1st one!
if next_due_date.nil?
topic_due_date_size = TopicDueDate.where(parent_id: topic_id).size
following_assignment_due_dates = AssignmentDueDate.where(parent_id: assignment_id)[topic_due_date_size..-1]
unless following_assignment_due_dates.nil?
following_assignment_due_dates.each do |assignment_due_date|
if assignment_due_date.due_at >= Time.zone.now
next_due_date = assignment_due_date
break
end
end
end
end
else
next_due_date = AssignmentDueDate.find_by(['parent_id = ? && due_at >= ?', assignment_id, Time.zone.now])
end
next_due_date
end
</pre>

So this is issue is resolved by the state of the system itself. 
'''''BUT Surprisingly on beta branch Reviewers aren't getting any emails at all'''''
on beta branch, in submitted_content_controller, in function "submit_file", this lines is supposed to send email to the reviewers to notify them about the new submission
<pre> participant.assignment.email(participant.id) rescue nil </pre>
''BUT'' here email function is undefined. we checked for email function in assignment class, there was none. The error "undefined function on assignment" is always rescued and hence no errors were raised previously and hence it wasn't highlighted before. 
So, in beta branch reviewers are not being notified anytime a new submission is made to an assignment that they have previously reviewed. So we fixed that
Taking inspiration from the Master branch the previous team's work we added following code to send an email notifying the reviewer of an new submission.

in submitted_content_controller.rb, in the functions, submit_file, submit_hyperlink
<pre>
Team.mail_assigned_reviewers(@participant)
</pre>

participant.rb

<pre>
def mail_assigned_reviewers()
team = self.team
maps = ResponseMap.where(reviewed_object_id: self.assignment.id, reviewee_id: team.id, type: 'ReviewResponseMap')
unless maps.nil?
maps.each do |map|
reviewer = User.find(Participant.find(map.reviewer_id).user_id)
Mailer.sync_message(
{
:to => reviewer.email,
subject: "Assignment '#{self.assignment.name}': A submission has been updated since you last reviewed it",
cc: User.find_by(self.assignment.instructor_id).email,
:body => {
:obj_name => self.assignment.name,
:link => "https://expertiza.ncsu.edu/response/new?id=#{map.id}",
:type => 'submission',
:first_name => ApplicationHelper::get_user_first_name(User.find(Participant.find(map.reviewer_id).user_id)),
:partial_name => 'updated_submission_since_review'
}
}
).deliver_now
end
end
end
</pre>

app/views/mailer/partials/_updated_submission_since_review_plain.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review.
Hence, to update your review please click on the following link.
<% if @link != nil %><%= @link %><% end %>
</pre>

app/views/mailer/partials/_updated_submission_since_review_html.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review. 
Hence, to update your review please click on the following link. 
<% if @link != nil %><a href="<%= @link %>"><%= @link %></a><% end %>

</pre>

added a line in app/mailers/mailer.rb
<pre>
@link = defn[:body][:link]
</pre>

----

==Issue3 (111) - Adding relevant links to reminder emails==

'''Pre conditions'''
* There exists an assignment and a participant associated with that assignment
* The due date for the assignment is approaching

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/111 -
"E-mails about reviews should direct the user to the page where the review is found. Deadline reminders should include a link on where to go to perform the needed function."

So, when assignment reminder emails are sent to students, they should include a link to the relevant assignment.

'''Actual Behavior'''

We implemented this behavior by enhancing the 'email_reminder' function within the app/mailers/mail_worker.rb file. First we get the user associated with the email, then we get the participant object associated with the particular user and the assignment. The ID of this object is the query parameter located at the end of the relevant link. '''mail_worker.rb'''
<pre>
def email_reminder(emails, deadline_type)
assignment = Assignment.find(self.assignment_id)
subject = "Message regarding #{deadline_type} for assignment #{assignment.name}"

# Defining the body of mail
body = "This is a reminder to complete #{deadline_type} for assignment #{assignment.name}.\n"

emails.each do |mail|
# Since the email is not unique fetching the first instance in results returned when searching via email
user = User.where(email: mail).first

# Finding the mapping between participant and assignment so that it can be sent as a query param
participant_assignment_id = Participant.find(user_id: user.id.to_s, parent_id: self.assignment_id.to_s).first.id

# This is the link which User can use to navigate
link_to_destination = "Please follow the link: http://expertiza.ncsu.edu/student_task/view?id=#{participant_assignment_id}\n"
body += link_to_destination + "Deadline is #{self.due_at}. If you have already done the #{deadline_type}, then please ignore this mail.";

# Send mail to the user
@mail = Mailer.delayed_message(bcc: mail, subject: subject, body: body)
@mail.deliver_now
Rails.logger.info mail
end
end
</pre>
This function is clearly tested through a new test we added to the spec/workers/sidekiq_mail_worker_spec.rb '''sidekiq_mail_worker_spec.rb'''
<pre>
it "should send reminder email to required email address with proper content" do
Sidekiq::Testing.inline!
ActionMailer::Base.deliveries.clear
worker = MailWorker.new
worker.perform("1", "metareview", "2018-12-31 00:00:01")
expect(ActionMailer::Base.deliveries.size).to eq(1)
email = ActionMailer::Base.deliveries.first
expect(email.from[0]).to eq("expertiza.development@gmail.com")
expect(email.bcc[0]).to eq("psingh22@ncsu.edu")
expect(email.subject).to eq("Message regarding teammate review for assignment no assignment")
expect(email.body).to eq("This is a reminder to complete teammate review for assignment no assignment.\nPlease follow the link: http://expertiza.ncsu.edu/student_task/view?id=1\nDeadline is 2018-12-31 00:00:01. If you have already done the teammate review, then please ignore this mail.")
end
</pre>

==Test Plan==

'''Issue 1'''

Step 1: Navigate to Manage --> Assignment page.

Step 2: Click on add participants for any of the assignments.

Step 3: Click "Import course participants"

Step 4: Choose a csv file to be imported (follow the format given on the website).

Step 5: The users mentioned in the csv file and don't exist on Expertiza should get a new user email.

Step 6: To check e-mail is received or not, log in with following credentials: username [ 'expertiza.development@gmail.com' ] password [ 'qwer@1234' ].

'''Issue 2'''

Step 1: Create new assignment [Manage --> Assignment --> + Button (to create new assignment)]

Step 2: Fill the details for the assignments.

Step 3: Navigate to due dates.

Step 4: Change the number of review rounds to 2.

Step 5: Select "Yes" in the dropdown for review allowed during submission and select "Yes" for submission during the review.

Step 6: Add two users to the assignment(author and reviewer).

Step 7: Log in with some user credentials (author credential).

Step 8: Make a new submission to this assignment.

Step 9: Log in with another user (reviewer).

Step 10: Submit a review of the assignment submission.

Step 11: Login as an author again.

Step 12: Edit the submission.

Step 13: After this check the mailbox of the reviewer [development mail for development].

Step 14: Reviewer should get the mail to re-review the work.

Step 15: Change the due date to some date and time which has passed.

Step 16: Now the author should not be able to make a new submission.

'''Issue 3'''

Step 1: Create new assignment [Manage --> Assignment --> + Button (to create new assignment)]

Step 2: Fill the details for the assignments.

Step 3: Add an existing user to the new assignment

Step 3: Navigate to due dates for the new assignment.

Step 4: Set the due date to 1 hour and 5 seconds from now.

Step 5: To check e-mail is received or not, log in with following credentials: username [ 'expertiza.development@gmail.com' ] password [ 'qwer@1234' ].

CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications

2021-10-21T03:38:49Z

Glbrook2: /* Test Plan */

=E2142. Improve e-mail notifications=

==Brief Introduction==

* E2142. Improve e-mail notifications
* The forked repository can be found at: https://github.com/griffinbrookshire/expertiza

==Problem Statement==
The following tasks were accomplished in this project:

*Issue1: Send new account welcome email to user, when imported from CSV through assignment page.
*Issue2: Don't send email to reviewers for a new submission after review deadline has passed.
*Issue3: Adding relevant links to reminder emails.

==Issue1 (717) - Send new account welcome email to user, when imported from CSV through assignment page==

'''Pre conditions'''
* There exists an assignment and an instructor
* The instructor navigates to the 'Manage Assignments' page
* The instructor clicks 'Add Participants' for the existing assignment
* The instructor clicks 'Import assignment participants'
* The instructor imports a CSV file containing a user who does not exist yet

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/717 -
"When students' accounts are created by importing a CSV on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. Students should receive e-mails upon account creation, regardless of how their account is created."

So, when students accounts are created in any way, they should receive a welcome email. This includes adding them through importing a CSV.

'''Actual Behavior'''

This behavior was actually already implemented through one simple line in the app/models/user.rb file. '''user.rb'''
<pre>
after_create :email_welcome
</pre>
This line calls the 'email_welcome' function every time a user is created, which sends a welcome email to the newly created user. '''user.rb'''
<pre>
# Function which has a MailerHelper which sends the mail welcome email to the user after signing up
def email_welcome
#this will send an account creation notification to user via email.
MailerHelper.send_mail_to_user(self, "Your Expertiza account and password has been created", "user_welcome", password).deliver_now
end
</pre>
This functionality is also completely tested in the spec/models/assignment_participant_spec.rb file show below. This test shows that when the import function is called an email is delivered. '''assignment_participant_spec.rb'''
<pre>
context 'when new user needs to be created' do
let(:row) do
{name: 'no one', fullname: 'no one', email: 'name@email.com', role:'user_role_name', parent: 'user_parent_name'}
end
let(:attributes) do
{role_id: 1, name: 'no one', fullname: 'no one', email: 'name@email.com', email_on_submission: 'name@email.com',
email_on_review: 'name@email.com', email_on_review_of_review: 'name@email.com'}
end
let(:test_user) do
{name: 'abc', email: 'abcbbc@gmail.com'}
end
it 'create the user and number of mails sent should be 1' do
ActionMailer::Base.deliveries.clear
allow(ImportFileHelper).to receive(:define_attributes).with(row).and_return(attributes)
allow(ImportFileHelper).to receive(:create_new_user) do
test_user = User.new(name: 'abc', fullname: 'abc bbc', email: 'abcbbc@gmail.com')
test_user.id = 123
test_user.save!
test_user
end
#allow(ImportFileHelper).to receive(:create_new_user).with(attributes, {}).and_return()
allow(Assignment).to receive(:find).with(1).and_return(assignment)
allow(User).to receive(:exists?).with(name: 'no one').and_return(false)
allow(participant).to receive(:set_handle).and_return('handle')
allow(AssignmentParticipant).to receive(:exists?).and_return(false)
allow(AssignmentParticipant).to receive(:create).and_return(participant)
allow(AssignmentParticipant).to receive(:set_handle)
expect{(AssignmentParticipant.import(row, nil, {}, 1))}.to change { ActionMailer::Base.deliveries.count }.by(1)
end
end
</pre>

==Issue2 (345) - Don't send email to reviewers for a new submission after review deadline has passed==

'''Pre conditions'''
* There is an assignment, a student as a participant, a participant as a reviewer who is reviewing the this particular assignment
* a review is made for a submission by the student
* review deadline has passed
* the student is allowed to submit after the review deadline has passed

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/345 -
"Evidently, if a submission is revised after review, the system e-mails the reviewer saying to revise the review. This is just fine ... except if the last round of review has been completed.
The message telling reviewers to revise their reviews should not be sent after the last review deadline has passed."

So basically, When the student makes a new submission after the LAST review deadline has passed. The reviewer should not receive an email, asking the reviewer to update the review according to the new submission.

'''Actual Behavior'''

According to the current Code scenario on the beta branch '''''if the deadline has passed, a student(participant) cannot make new submissions'''''. So, automatically if the participant doe not make a new submission then the reviewer wont receive an email. So this issue does not really exist by the virtue of the state of the system.
the stack trace for the check if the submission is allowed or not is as follows -
assignment.rb
<pre>
def submission_allowed(topic_id = nil)
check_condition('submission_allowed_id', topic_id)
end
</pre>

assignment.rb
<pre>
def check_condition(column, topic_id = nil)
next_due_date = DueDate.get_next_due_date(self.id, topic_id)
return false if next_due_date.nil?
right_id = next_due_date.send column
right = DeadlineRight.find(right_id)
right && (right.name == 'OK' || right.name == 'Late')
end
</pre>

due_date.rb
<pre>
def self.get_next_due_date(assignment_id, topic_id = nil)
if Assignment.find(assignment_id).staggered_deadline?
next_due_date = TopicDueDate.find_by(['parent_id = ? and due_at >= ?', topic_id, Time.zone.now])
# if certion TopicDueDate is not exist, we should query next corresponding AssignmentDueDate.
# eg. Time.now is 08/28/2016
# One topic uses following deadlines:
# TopicDueDate 08/01/2016
# TopicDueDate 08/02/2016
# TopicDueDate 08/03/2016
# AssignmentDueDate 09/04/2016
# In this case, we cannot find due_at later than Time.now in TopicDueDate.
# So we should find next corrsponding AssignmentDueDate, starting with the 4th one, not the 1st one!
if next_due_date.nil?
topic_due_date_size = TopicDueDate.where(parent_id: topic_id).size
following_assignment_due_dates = AssignmentDueDate.where(parent_id: assignment_id)[topic_due_date_size..-1]
unless following_assignment_due_dates.nil?
following_assignment_due_dates.each do |assignment_due_date|
if assignment_due_date.due_at >= Time.zone.now
next_due_date = assignment_due_date
break
end
end
end
end
else
next_due_date = AssignmentDueDate.find_by(['parent_id = ? && due_at >= ?', assignment_id, Time.zone.now])
end
next_due_date
end
</pre>

So this is issue is resolved by the state of the system itself. 
'''''BUT Surprisingly on beta branch Reviewers aren't getting any emails at all'''''
on beta branch, in submitted_content_controller, in function "submit_file", this lines is supposed to send email to the reviewers to notify them about the new submission
<pre> participant.assignment.email(participant.id) rescue nil </pre>
''BUT'' here email function is undefined. we checked for email function in assignment class, there was none. The error "undefined function on assignment" is always rescued and hence no errors were raised previously and hence it wasn't highlighted before. 
So, in beta branch reviewers are not being notified anytime a new submission is made to an assignment that they have previously reviewed. So we fixed that
Taking inspiration from the Master branch the previous team's work we added following code to send an email notifying the reviewer of an new submission.

in submitted_content_controller.rb, in the functions, submit_file, submit_hyperlink
<pre>
Team.mail_assigned_reviewers(@participant)
</pre>

participant.rb

<pre>
def mail_assigned_reviewers()
team = self.team
maps = ResponseMap.where(reviewed_object_id: self.assignment.id, reviewee_id: team.id, type: 'ReviewResponseMap')
unless maps.nil?
maps.each do |map|
reviewer = User.find(Participant.find(map.reviewer_id).user_id)
Mailer.sync_message(
{
:to => reviewer.email,
subject: "Assignment '#{self.assignment.name}': A submission has been updated since you last reviewed it",
cc: User.find_by(self.assignment.instructor_id).email,
:body => {
:obj_name => self.assignment.name,
:link => "https://expertiza.ncsu.edu/response/new?id=#{map.id}",
:type => 'submission',
:first_name => ApplicationHelper::get_user_first_name(User.find(Participant.find(map.reviewer_id).user_id)),
:partial_name => 'updated_submission_since_review'
}
}
).deliver_now
end
end
end
</pre>

app/views/mailer/partials/_updated_submission_since_review_plain.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review.
Hence, to update your review please click on the following link.
<% if @link != nil %><%= @link %><% end %>
</pre>

app/views/mailer/partials/_updated_submission_since_review_html.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review. 
Hence, to update your review please click on the following link. 
<% if @link != nil %><a href="<%= @link %>"><%= @link %></a><% end %>

</pre>

added a line in app/mailers/mailer.rb
<pre>
@link = defn[:body][:link]
</pre>

----

==Issue3 (111) - Adding relevant links to reminder emails==

'''Pre conditions'''
* There exists an assignment and a participant associated with that assignment
* The due date for the assignment is approaching

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/111 -
"E-mails about reviews should direct the user to the page where the review is found. Deadline reminders should include a link on where to go to perform the needed function."

So, when assignment reminder emails are sent to students, they should include a link to the relevant assignment.

'''Actual Behavior'''

We implemented this behavior by enhancing the 'email_reminder' function within the app/mailers/mail_worker.rb file. First we get the user associated with the email, then we get the participant object associated with the particular user and the assignment. The ID of this object is the query parameter located at the end of the relevant link. '''mail_worker.rb'''
<pre>
def email_reminder(emails, deadline_type)
assignment = Assignment.find(self.assignment_id)
subject = "Message regarding #{deadline_type} for assignment #{assignment.name}"

# Defining the body of mail
body = "This is a reminder to complete #{deadline_type} for assignment #{assignment.name}.\n"

emails.each do |mail|
# Since the email is not unique fetching the first instance in results returned when searching via email
user = User.where(email: mail).first

# Finding the mapping between participant and assignment so that it can be sent as a query param
participant_assignment_id = Participant.find(user_id: user.id.to_s, parent_id: self.assignment_id.to_s).first.id

# This is the link which User can use to navigate
link_to_destination = "Please follow the link: http://expertiza.ncsu.edu/student_task/view?id=#{participant_assignment_id}\n"
body += link_to_destination + "Deadline is #{self.due_at}. If you have already done the #{deadline_type}, then please ignore this mail.";

# Send mail to the user
@mail = Mailer.delayed_message(bcc: mail, subject: subject, body: body)
@mail.deliver_now
Rails.logger.info mail
end
end
</pre>
This function is clearly tested through a new test we added to the spec/workers/sidekiq_mail_worker_spec.rb '''sidekiq_mail_worker_spec.rb'''
<pre>
it "should send reminder email to required email address with proper content" do
Sidekiq::Testing.inline!
ActionMailer::Base.deliveries.clear
worker = MailWorker.new
worker.perform("1", "metareview", "2018-12-31 00:00:01")
expect(ActionMailer::Base.deliveries.size).to eq(1)
email = ActionMailer::Base.deliveries.first
expect(email.from[0]).to eq("expertiza.development@gmail.com")
expect(email.bcc[0]).to eq("psingh22@ncsu.edu")
expect(email.subject).to eq("Message regarding teammate review for assignment no assignment")
expect(email.body).to eq("This is a reminder to complete teammate review for assignment no assignment.\nPlease follow the link: http://expertiza.ncsu.edu/student_task/view?id=1\nDeadline is 2018-12-31 00:00:01. If you have already done the teammate review, then please ignore this mail.")
end
</pre>

==Test Plan==

'''Issue 1'''

Step 1: Navigate to Manage --> Assignment page.

Step 2: Click on add participants for any of the assignments.

Step 3: Click "Import course participants"

Step 4: Choose a csv file to be imported (follow the format given on the website).

Step 5: The users mentioned in the csv file and don't exist on Expertiza should get a new user email.

Step 6: To check e-mail is received or not, log in with following credentials: username [ 'expertiza.development@gmail.com' ] password [ 'qwer@1234' ].

'''Issue 2'''

Step 1: Create new assignment [Manage --> Assignment --> + Button (to create new assignment)]

Step 2: Fill the details for the assignments.

Step 3: Navigate to due dates.

Step 4: Change the number of review rounds to 2.

Step 5: Select "Yes" in the dropdown for review allowed during submission and select "Yes" for submission during the review.

Step 6: Add two users to the assignment(author and reviewer).

Step 7: Log in with some user credentials (author credential).

Step 8: Make a new submission to this assignment.

Step 9: Log in with another user (reviewer).

Step 10: Submit a review of the assignment submission.

Step 11: Login as an author again.

Step 12: Edit the submission.

Step 13: After this check the mailbox of the reviewer [development mail for development].

Step 14: Reviewer should get the mail to re-review the work.

Step 15: Change the due date to some date and time which has passed.

Step 16: Now the author should not be able to make a new submission.

'''Issue 3'''

Step 1: Create new assignment [Manage --> Assignment --> + Button (to create new assignment)]

Step 2: Fill the details for the assignments.

Step 3: Add an existing user to the new assignment

Step 3: Navigate to due dates for the new assignment.

Step 4: Set the due date to 1 hour and 5 seconds from now.

Step 5: Sign into the participants account and check for email.

CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications

2021-10-21T03:30:02Z

Glbrook2: /* Test Plan */

=E2142. Improve e-mail notifications=

==Brief Introduction==

* E2142. Improve e-mail notifications
* The forked repository can be found at: https://github.com/griffinbrookshire/expertiza

==Problem Statement==
The following tasks were accomplished in this project:

*Issue1: Send new account welcome email to user, when imported from CSV through assignment page.
*Issue2: Don't send email to reviewers for a new submission after review deadline has passed.
*Issue3: Adding relevant links to reminder emails.

==Issue1 (717) - Send new account welcome email to user, when imported from CSV through assignment page==

'''Pre conditions'''
* There exists an assignment and an instructor
* The instructor navigates to the 'Manage Assignments' page
* The instructor clicks 'Add Participants' for the existing assignment
* The instructor clicks 'Import assignment participants'
* The instructor imports a CSV file containing a user who does not exist yet

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/717 -
"When students' accounts are created by importing a CSV on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. Students should receive e-mails upon account creation, regardless of how their account is created."

So, when students accounts are created in any way, they should receive a welcome email. This includes adding them through importing a CSV.

'''Actual Behavior'''

This behavior was actually already implemented through one simple line in the app/models/user.rb file. '''user.rb'''
<pre>
after_create :email_welcome
</pre>
This line calls the 'email_welcome' function every time a user is created, which sends a welcome email to the newly created user. '''user.rb'''
<pre>
# Function which has a MailerHelper which sends the mail welcome email to the user after signing up
def email_welcome
#this will send an account creation notification to user via email.
MailerHelper.send_mail_to_user(self, "Your Expertiza account and password has been created", "user_welcome", password).deliver_now
end
</pre>
This functionality is also completely tested in the spec/models/assignment_participant_spec.rb file show below. This test shows that when the import function is called an email is delivered. '''assignment_participant_spec.rb'''
<pre>
context 'when new user needs to be created' do
let(:row) do
{name: 'no one', fullname: 'no one', email: 'name@email.com', role:'user_role_name', parent: 'user_parent_name'}
end
let(:attributes) do
{role_id: 1, name: 'no one', fullname: 'no one', email: 'name@email.com', email_on_submission: 'name@email.com',
email_on_review: 'name@email.com', email_on_review_of_review: 'name@email.com'}
end
let(:test_user) do
{name: 'abc', email: 'abcbbc@gmail.com'}
end
it 'create the user and number of mails sent should be 1' do
ActionMailer::Base.deliveries.clear
allow(ImportFileHelper).to receive(:define_attributes).with(row).and_return(attributes)
allow(ImportFileHelper).to receive(:create_new_user) do
test_user = User.new(name: 'abc', fullname: 'abc bbc', email: 'abcbbc@gmail.com')
test_user.id = 123
test_user.save!
test_user
end
#allow(ImportFileHelper).to receive(:create_new_user).with(attributes, {}).and_return()
allow(Assignment).to receive(:find).with(1).and_return(assignment)
allow(User).to receive(:exists?).with(name: 'no one').and_return(false)
allow(participant).to receive(:set_handle).and_return('handle')
allow(AssignmentParticipant).to receive(:exists?).and_return(false)
allow(AssignmentParticipant).to receive(:create).and_return(participant)
allow(AssignmentParticipant).to receive(:set_handle)
expect{(AssignmentParticipant.import(row, nil, {}, 1))}.to change { ActionMailer::Base.deliveries.count }.by(1)
end
end
</pre>

==Issue2 (345) - Don't send email to reviewers for a new submission after review deadline has passed==

'''Pre conditions'''
* There is an assignment, a student as a participant, a participant as a reviewer who is reviewing the this particular assignment
* a review is made for a submission by the student
* review deadline has passed
* the student is allowed to submit after the review deadline has passed

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/345 -
"Evidently, if a submission is revised after review, the system e-mails the reviewer saying to revise the review. This is just fine ... except if the last round of review has been completed.
The message telling reviewers to revise their reviews should not be sent after the last review deadline has passed."

So basically, When the student makes a new submission after the LAST review deadline has passed. The reviewer should not receive an email, asking the reviewer to update the review according to the new submission.

'''Actual Behavior'''

According to the current Code scenario on the beta branch '''''if the deadline has passed, a student(participant) cannot make new submissions'''''. So, automatically if the participant doe not make a new submission then the reviewer wont receive an email. So this issue does not really exist by the virtue of the state of the system.
the stack trace for the check if the submission is allowed or not is as follows -
assignment.rb
<pre>
def submission_allowed(topic_id = nil)
check_condition('submission_allowed_id', topic_id)
end
</pre>

assignment.rb
<pre>
def check_condition(column, topic_id = nil)
next_due_date = DueDate.get_next_due_date(self.id, topic_id)
return false if next_due_date.nil?
right_id = next_due_date.send column
right = DeadlineRight.find(right_id)
right && (right.name == 'OK' || right.name == 'Late')
end
</pre>

due_date.rb
<pre>
def self.get_next_due_date(assignment_id, topic_id = nil)
if Assignment.find(assignment_id).staggered_deadline?
next_due_date = TopicDueDate.find_by(['parent_id = ? and due_at >= ?', topic_id, Time.zone.now])
# if certion TopicDueDate is not exist, we should query next corresponding AssignmentDueDate.
# eg. Time.now is 08/28/2016
# One topic uses following deadlines:
# TopicDueDate 08/01/2016
# TopicDueDate 08/02/2016
# TopicDueDate 08/03/2016
# AssignmentDueDate 09/04/2016
# In this case, we cannot find due_at later than Time.now in TopicDueDate.
# So we should find next corrsponding AssignmentDueDate, starting with the 4th one, not the 1st one!
if next_due_date.nil?
topic_due_date_size = TopicDueDate.where(parent_id: topic_id).size
following_assignment_due_dates = AssignmentDueDate.where(parent_id: assignment_id)[topic_due_date_size..-1]
unless following_assignment_due_dates.nil?
following_assignment_due_dates.each do |assignment_due_date|
if assignment_due_date.due_at >= Time.zone.now
next_due_date = assignment_due_date
break
end
end
end
end
else
next_due_date = AssignmentDueDate.find_by(['parent_id = ? && due_at >= ?', assignment_id, Time.zone.now])
end
next_due_date
end
</pre>

So this is issue is resolved by the state of the system itself. 
'''''BUT Surprisingly on beta branch Reviewers aren't getting any emails at all'''''
on beta branch, in submitted_content_controller, in function "submit_file", this lines is supposed to send email to the reviewers to notify them about the new submission
<pre> participant.assignment.email(participant.id) rescue nil </pre>
''BUT'' here email function is undefined. we checked for email function in assignment class, there was none. The error "undefined function on assignment" is always rescued and hence no errors were raised previously and hence it wasn't highlighted before. 
So, in beta branch reviewers are not being notified anytime a new submission is made to an assignment that they have previously reviewed. So we fixed that
Taking inspiration from the Master branch the previous team's work we added following code to send an email notifying the reviewer of an new submission.

in submitted_content_controller.rb, in the functions, submit_file, submit_hyperlink
<pre>
Team.mail_assigned_reviewers(@participant)
</pre>

participant.rb

<pre>
def mail_assigned_reviewers()
team = self.team
maps = ResponseMap.where(reviewed_object_id: self.assignment.id, reviewee_id: team.id, type: 'ReviewResponseMap')
unless maps.nil?
maps.each do |map|
reviewer = User.find(Participant.find(map.reviewer_id).user_id)
Mailer.sync_message(
{
:to => reviewer.email,
subject: "Assignment '#{self.assignment.name}': A submission has been updated since you last reviewed it",
cc: User.find_by(self.assignment.instructor_id).email,
:body => {
:obj_name => self.assignment.name,
:link => "https://expertiza.ncsu.edu/response/new?id=#{map.id}",
:type => 'submission',
:first_name => ApplicationHelper::get_user_first_name(User.find(Participant.find(map.reviewer_id).user_id)),
:partial_name => 'updated_submission_since_review'
}
}
).deliver_now
end
end
end
</pre>

app/views/mailer/partials/_updated_submission_since_review_plain.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review.
Hence, to update your review please click on the following link.
<% if @link != nil %><%= @link %><% end %>
</pre>

app/views/mailer/partials/_updated_submission_since_review_html.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review. 
Hence, to update your review please click on the following link. 
<% if @link != nil %><a href="<%= @link %>"><%= @link %></a><% end %>

</pre>

added a line in app/mailers/mailer.rb
<pre>
@link = defn[:body][:link]
</pre>

----

==Issue3 (111) - Adding relevant links to reminder emails==

'''Pre conditions'''
* There exists an assignment and a participant associated with that assignment
* The due date for the assignment is approaching

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/111 -
"E-mails about reviews should direct the user to the page where the review is found. Deadline reminders should include a link on where to go to perform the needed function."

So, when assignment reminder emails are sent to students, they should include a link to the relevant assignment.

'''Actual Behavior'''

We implemented this behavior by enhancing the 'email_reminder' function within the app/mailers/mail_worker.rb file. First we get the user associated with the email, then we get the participant object associated with the particular user and the assignment. The ID of this object is the query parameter located at the end of the relevant link. '''mail_worker.rb'''
<pre>
def email_reminder(emails, deadline_type)
assignment = Assignment.find(self.assignment_id)
subject = "Message regarding #{deadline_type} for assignment #{assignment.name}"

# Defining the body of mail
body = "This is a reminder to complete #{deadline_type} for assignment #{assignment.name}.\n"

emails.each do |mail|
# Since the email is not unique fetching the first instance in results returned when searching via email
user = User.where(email: mail).first

# Finding the mapping between participant and assignment so that it can be sent as a query param
participant_assignment_id = Participant.find(user_id: user.id.to_s, parent_id: self.assignment_id.to_s).first.id

# This is the link which User can use to navigate
link_to_destination = "Please follow the link: http://expertiza.ncsu.edu/student_task/view?id=#{participant_assignment_id}\n"
body += link_to_destination + "Deadline is #{self.due_at}. If you have already done the #{deadline_type}, then please ignore this mail.";

# Send mail to the user
@mail = Mailer.delayed_message(bcc: mail, subject: subject, body: body)
@mail.deliver_now
Rails.logger.info mail
end
end
</pre>
This function is clearly tested through a new test we added to the spec/workers/sidekiq_mail_worker_spec.rb '''sidekiq_mail_worker_spec.rb'''
<pre>
it "should send reminder email to required email address with proper content" do
Sidekiq::Testing.inline!
ActionMailer::Base.deliveries.clear
worker = MailWorker.new
worker.perform("1", "metareview", "2018-12-31 00:00:01")
expect(ActionMailer::Base.deliveries.size).to eq(1)
email = ActionMailer::Base.deliveries.first
expect(email.from[0]).to eq("expertiza.development@gmail.com")
expect(email.bcc[0]).to eq("psingh22@ncsu.edu")
expect(email.subject).to eq("Message regarding teammate review for assignment no assignment")
expect(email.body).to eq("This is a reminder to complete teammate review for assignment no assignment.\nPlease follow the link: http://expertiza.ncsu.edu/student_task/view?id=1\nDeadline is 2018-12-31 00:00:01. If you have already done the teammate review, then please ignore this mail.")
end
</pre>

==Test Plan==

'''Issue 3'''

'''Issue 2''

Step 1: Create new assignment [Manage --> Assignment --> + Button (to create new assignment)]

Step 2: Fill the details for the assignments.

Step 3: Navigate to due dates.

Step 4: Change the number of review rounds to 2.

Step 5: Select "Yes" in the dropdown for review allowed during submission and select "Yes" for submission during the review.

Step 6: Add two users to the assignment(author and reviewer).

Step 7: Log in with some user credentials (author credential).

Step 8: Make a new submission to this assignment.

Step 9: Log in with another user (reviewer).

Step 10: Submit a review of the assignment submission.

Step 11: Login as an author again.

Step 12: Edit the submission.

Step 13: After this check the mailbox of the reviewer [development mail for development].

Step 14: Reviewer should get the mail to re-review the work.

Step 15: Change the due date to some date and time which has passed.

Step 16: Now the author should not be able to make a new submission.

'''Issue 3'''

CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications

2021-10-21T03:26:45Z

Glbrook2: /* Testing */

=E2142. Improve e-mail notifications=

==Brief Introduction==

* E2142. Improve e-mail notifications
* The forked repository can be found at: https://github.com/griffinbrookshire/expertiza

==Problem Statement==
The following tasks were accomplished in this project:

*Issue1: Send new account welcome email to user, when imported from CSV through assignment page.
*Issue2: Don't send email to reviewers for a new submission after review deadline has passed.
*Issue3: Adding relevant links to reminder emails.

==Issue1 (717) - Send new account welcome email to user, when imported from CSV through assignment page==

'''Pre conditions'''
* There exists an assignment and an instructor
* The instructor navigates to the 'Manage Assignments' page
* The instructor clicks 'Add Participants' for the existing assignment
* The instructor clicks 'Import assignment participants'
* The instructor imports a CSV file containing a user who does not exist yet

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/717 -
"When students' accounts are created by importing a CSV on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. Students should receive e-mails upon account creation, regardless of how their account is created."

So, when students accounts are created in any way, they should receive a welcome email. This includes adding them through importing a CSV.

'''Actual Behavior'''

This behavior was actually already implemented through one simple line in the app/models/user.rb file. '''user.rb'''
<pre>
after_create :email_welcome
</pre>
This line calls the 'email_welcome' function every time a user is created, which sends a welcome email to the newly created user. '''user.rb'''
<pre>
# Function which has a MailerHelper which sends the mail welcome email to the user after signing up
def email_welcome
#this will send an account creation notification to user via email.
MailerHelper.send_mail_to_user(self, "Your Expertiza account and password has been created", "user_welcome", password).deliver_now
end
</pre>
This functionality is also completely tested in the spec/models/assignment_participant_spec.rb file show below. This test shows that when the import function is called an email is delivered. '''assignment_participant_spec.rb'''
<pre>
context 'when new user needs to be created' do
let(:row) do
{name: 'no one', fullname: 'no one', email: 'name@email.com', role:'user_role_name', parent: 'user_parent_name'}
end
let(:attributes) do
{role_id: 1, name: 'no one', fullname: 'no one', email: 'name@email.com', email_on_submission: 'name@email.com',
email_on_review: 'name@email.com', email_on_review_of_review: 'name@email.com'}
end
let(:test_user) do
{name: 'abc', email: 'abcbbc@gmail.com'}
end
it 'create the user and number of mails sent should be 1' do
ActionMailer::Base.deliveries.clear
allow(ImportFileHelper).to receive(:define_attributes).with(row).and_return(attributes)
allow(ImportFileHelper).to receive(:create_new_user) do
test_user = User.new(name: 'abc', fullname: 'abc bbc', email: 'abcbbc@gmail.com')
test_user.id = 123
test_user.save!
test_user
end
#allow(ImportFileHelper).to receive(:create_new_user).with(attributes, {}).and_return()
allow(Assignment).to receive(:find).with(1).and_return(assignment)
allow(User).to receive(:exists?).with(name: 'no one').and_return(false)
allow(participant).to receive(:set_handle).and_return('handle')
allow(AssignmentParticipant).to receive(:exists?).and_return(false)
allow(AssignmentParticipant).to receive(:create).and_return(participant)
allow(AssignmentParticipant).to receive(:set_handle)
expect{(AssignmentParticipant.import(row, nil, {}, 1))}.to change { ActionMailer::Base.deliveries.count }.by(1)
end
end
</pre>

==Issue2 (345) - Don't send email to reviewers for a new submission after review deadline has passed==

'''Pre conditions'''
* There is an assignment, a student as a participant, a participant as a reviewer who is reviewing the this particular assignment
* a review is made for a submission by the student
* review deadline has passed
* the student is allowed to submit after the review deadline has passed

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/345 -
"Evidently, if a submission is revised after review, the system e-mails the reviewer saying to revise the review. This is just fine ... except if the last round of review has been completed.
The message telling reviewers to revise their reviews should not be sent after the last review deadline has passed."

So basically, When the student makes a new submission after the LAST review deadline has passed. The reviewer should not receive an email, asking the reviewer to update the review according to the new submission.

'''Actual Behavior'''

According to the current Code scenario on the beta branch '''''if the deadline has passed, a student(participant) cannot make new submissions'''''. So, automatically if the participant doe not make a new submission then the reviewer wont receive an email. So this issue does not really exist by the virtue of the state of the system.
the stack trace for the check if the submission is allowed or not is as follows -
assignment.rb
<pre>
def submission_allowed(topic_id = nil)
check_condition('submission_allowed_id', topic_id)
end
</pre>

assignment.rb
<pre>
def check_condition(column, topic_id = nil)
next_due_date = DueDate.get_next_due_date(self.id, topic_id)
return false if next_due_date.nil?
right_id = next_due_date.send column
right = DeadlineRight.find(right_id)
right && (right.name == 'OK' || right.name == 'Late')
end
</pre>

due_date.rb
<pre>
def self.get_next_due_date(assignment_id, topic_id = nil)
if Assignment.find(assignment_id).staggered_deadline?
next_due_date = TopicDueDate.find_by(['parent_id = ? and due_at >= ?', topic_id, Time.zone.now])
# if certion TopicDueDate is not exist, we should query next corresponding AssignmentDueDate.
# eg. Time.now is 08/28/2016
# One topic uses following deadlines:
# TopicDueDate 08/01/2016
# TopicDueDate 08/02/2016
# TopicDueDate 08/03/2016
# AssignmentDueDate 09/04/2016
# In this case, we cannot find due_at later than Time.now in TopicDueDate.
# So we should find next corrsponding AssignmentDueDate, starting with the 4th one, not the 1st one!
if next_due_date.nil?
topic_due_date_size = TopicDueDate.where(parent_id: topic_id).size
following_assignment_due_dates = AssignmentDueDate.where(parent_id: assignment_id)[topic_due_date_size..-1]
unless following_assignment_due_dates.nil?
following_assignment_due_dates.each do |assignment_due_date|
if assignment_due_date.due_at >= Time.zone.now
next_due_date = assignment_due_date
break
end
end
end
end
else
next_due_date = AssignmentDueDate.find_by(['parent_id = ? && due_at >= ?', assignment_id, Time.zone.now])
end
next_due_date
end
</pre>

So this is issue is resolved by the state of the system itself. 
'''''BUT Surprisingly on beta branch Reviewers aren't getting any emails at all'''''
on beta branch, in submitted_content_controller, in function "submit_file", this lines is supposed to send email to the reviewers to notify them about the new submission
<pre> participant.assignment.email(participant.id) rescue nil </pre>
''BUT'' here email function is undefined. we checked for email function in assignment class, there was none. The error "undefined function on assignment" is always rescued and hence no errors were raised previously and hence it wasn't highlighted before. 
So, in beta branch reviewers are not being notified anytime a new submission is made to an assignment that they have previously reviewed. So we fixed that
Taking inspiration from the Master branch the previous team's work we added following code to send an email notifying the reviewer of an new submission.

in submitted_content_controller.rb, in the functions, submit_file, submit_hyperlink
<pre>
Team.mail_assigned_reviewers(@participant)
</pre>

participant.rb

<pre>
def mail_assigned_reviewers()
team = self.team
maps = ResponseMap.where(reviewed_object_id: self.assignment.id, reviewee_id: team.id, type: 'ReviewResponseMap')
unless maps.nil?
maps.each do |map|
reviewer = User.find(Participant.find(map.reviewer_id).user_id)
Mailer.sync_message(
{
:to => reviewer.email,
subject: "Assignment '#{self.assignment.name}': A submission has been updated since you last reviewed it",
cc: User.find_by(self.assignment.instructor_id).email,
:body => {
:obj_name => self.assignment.name,
:link => "https://expertiza.ncsu.edu/response/new?id=#{map.id}",
:type => 'submission',
:first_name => ApplicationHelper::get_user_first_name(User.find(Participant.find(map.reviewer_id).user_id)),
:partial_name => 'updated_submission_since_review'
}
}
).deliver_now
end
end
end
</pre>

app/views/mailer/partials/_updated_submission_since_review_plain.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review.
Hence, to update your review please click on the following link.
<% if @link != nil %><%= @link %><% end %>
</pre>

app/views/mailer/partials/_updated_submission_since_review_html.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review. 
Hence, to update your review please click on the following link. 
<% if @link != nil %><a href="<%= @link %>"><%= @link %></a><% end %>

</pre>

added a line in app/mailers/mailer.rb
<pre>
@link = defn[:body][:link]
</pre>

----

==Issue3 (111) - Adding relevant links to reminder emails==

'''Pre conditions'''
* There exists an assignment and a participant associated with that assignment
* The due date for the assignment is approaching

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/111 -
"E-mails about reviews should direct the user to the page where the review is found. Deadline reminders should include a link on where to go to perform the needed function."

So, when assignment reminder emails are sent to students, they should include a link to the relevant assignment.

'''Actual Behavior'''

We implemented this behavior by enhancing the 'email_reminder' function within the app/mailers/mail_worker.rb file. First we get the user associated with the email, then we get the participant object associated with the particular user and the assignment. The ID of this object is the query parameter located at the end of the relevant link. '''mail_worker.rb'''
<pre>
def email_reminder(emails, deadline_type)
assignment = Assignment.find(self.assignment_id)
subject = "Message regarding #{deadline_type} for assignment #{assignment.name}"

# Defining the body of mail
body = "This is a reminder to complete #{deadline_type} for assignment #{assignment.name}.\n"

emails.each do |mail|
# Since the email is not unique fetching the first instance in results returned when searching via email
user = User.where(email: mail).first

# Finding the mapping between participant and assignment so that it can be sent as a query param
participant_assignment_id = Participant.find(user_id: user.id.to_s, parent_id: self.assignment_id.to_s).first.id

# This is the link which User can use to navigate
link_to_destination = "Please follow the link: http://expertiza.ncsu.edu/student_task/view?id=#{participant_assignment_id}\n"
body += link_to_destination + "Deadline is #{self.due_at}. If you have already done the #{deadline_type}, then please ignore this mail.";

# Send mail to the user
@mail = Mailer.delayed_message(bcc: mail, subject: subject, body: body)
@mail.deliver_now
Rails.logger.info mail
end
end
</pre>
This function is clearly tested through a new test we added to the spec/workers/sidekiq_mail_worker_spec.rb '''sidekiq_mail_worker_spec.rb'''
<pre>
it "should send reminder email to required email address with proper content" do
Sidekiq::Testing.inline!
ActionMailer::Base.deliveries.clear
worker = MailWorker.new
worker.perform("1", "metareview", "2018-12-31 00:00:01")
expect(ActionMailer::Base.deliveries.size).to eq(1)
email = ActionMailer::Base.deliveries.first
expect(email.from[0]).to eq("expertiza.development@gmail.com")
expect(email.bcc[0]).to eq("psingh22@ncsu.edu")
expect(email.subject).to eq("Message regarding teammate review for assignment no assignment")
expect(email.body).to eq("This is a reminder to complete teammate review for assignment no assignment.\nPlease follow the link: http://expertiza.ncsu.edu/student_task/view?id=1\nDeadline is 2018-12-31 00:00:01. If you have already done the teammate review, then please ignore this mail.")
end
</pre>

==Test Plan==
'''Testing Reviewe's Email manually'''

Step 1: Create new assignment [Manage --> Assignment --> + Button (to create new assignment)]

Step 2: Fill the details for the assignments.

Step 3: Navigate to due dates.

Step 4: Change the number of review rounds to 2.

Step 5: Select "Yes" in the dropdown for review allowed during submission and select "Yes" for submission during the review.

Step 6: Add two users to the assignment(author and reviewer).

Step 7: Log in with some user credentials (author credential).

Step 8: Make a new submission to this assignment.

Step 9: Log in with another user (reviewer).

Step 10: Submit a review of the assignment submission.

Step 11: Login as an author again.

Step 12: Edit the submission.

Step 13: After this check the mailbox of the reviewer [development mail for development].

Step 14: Reviewer should get the mail to re-review the work.

Step 15: Change the due date to some date and time which has passed.

Step 16: Now the author should not be able to make a new submission.

'''Testing Reviewe's Email via rspec'''

CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications

2021-10-21T03:22:08Z

Glbrook2: /* Issue3 (111) - Adding relevant links to reminder emails */

=E2142. Improve e-mail notifications=

==Brief Introduction==

* E2142. Improve e-mail notifications
* The forked repository can be found at: https://github.com/griffinbrookshire/expertiza

==Problem Statement==
The following tasks were accomplished in this project:

*Issue1: Send new account welcome email to user, when imported from CSV through assignment page.
*Issue2: Don't send email to reviewers for a new submission after review deadline has passed.
*Issue3: Adding relevant links to reminder emails.

==Issue1 (717) - Send new account welcome email to user, when imported from CSV through assignment page==

'''Pre conditions'''
* There exists an assignment and an instructor
* The instructor navigates to the 'Manage Assignments' page
* The instructor clicks 'Add Participants' for the existing assignment
* The instructor clicks 'Import assignment participants'
* The instructor imports a CSV file containing a user who does not exist yet

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/717 -
"When students' accounts are created by importing a CSV on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. Students should receive e-mails upon account creation, regardless of how their account is created."

So, when students accounts are created in any way, they should receive a welcome email. This includes adding them through importing a CSV.

'''Actual Behavior'''

This behavior was actually already implemented through one simple line in the app/models/user.rb file. '''user.rb'''
<pre>
after_create :email_welcome
</pre>
This line calls the 'email_welcome' function every time a user is created, which sends a welcome email to the newly created user. '''user.rb'''
<pre>
# Function which has a MailerHelper which sends the mail welcome email to the user after signing up
def email_welcome
#this will send an account creation notification to user via email.
MailerHelper.send_mail_to_user(self, "Your Expertiza account and password has been created", "user_welcome", password).deliver_now
end
</pre>
This functionality is also completely tested in the spec/models/assignment_participant_spec.rb file show below. This test shows that when the import function is called an email is delivered. '''assignment_participant_spec.rb'''
<pre>
context 'when new user needs to be created' do
let(:row) do
{name: 'no one', fullname: 'no one', email: 'name@email.com', role:'user_role_name', parent: 'user_parent_name'}
end
let(:attributes) do
{role_id: 1, name: 'no one', fullname: 'no one', email: 'name@email.com', email_on_submission: 'name@email.com',
email_on_review: 'name@email.com', email_on_review_of_review: 'name@email.com'}
end
let(:test_user) do
{name: 'abc', email: 'abcbbc@gmail.com'}
end
it 'create the user and number of mails sent should be 1' do
ActionMailer::Base.deliveries.clear
allow(ImportFileHelper).to receive(:define_attributes).with(row).and_return(attributes)
allow(ImportFileHelper).to receive(:create_new_user) do
test_user = User.new(name: 'abc', fullname: 'abc bbc', email: 'abcbbc@gmail.com')
test_user.id = 123
test_user.save!
test_user
end
#allow(ImportFileHelper).to receive(:create_new_user).with(attributes, {}).and_return()
allow(Assignment).to receive(:find).with(1).and_return(assignment)
allow(User).to receive(:exists?).with(name: 'no one').and_return(false)
allow(participant).to receive(:set_handle).and_return('handle')
allow(AssignmentParticipant).to receive(:exists?).and_return(false)
allow(AssignmentParticipant).to receive(:create).and_return(participant)
allow(AssignmentParticipant).to receive(:set_handle)
expect{(AssignmentParticipant.import(row, nil, {}, 1))}.to change { ActionMailer::Base.deliveries.count }.by(1)
end
end
</pre>

==Issue2 (345) - Don't send email to reviewers for a new submission after review deadline has passed==

'''Pre conditions'''
* There is an assignment, a student as a participant, a participant as a reviewer who is reviewing the this particular assignment
* a review is made for a submission by the student
* review deadline has passed
* the student is allowed to submit after the review deadline has passed

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/345 -
"Evidently, if a submission is revised after review, the system e-mails the reviewer saying to revise the review. This is just fine ... except if the last round of review has been completed.
The message telling reviewers to revise their reviews should not be sent after the last review deadline has passed."

So basically, When the student makes a new submission after the LAST review deadline has passed. The reviewer should not receive an email, asking the reviewer to update the review according to the new submission.

'''Actual Behavior'''

According to the current Code scenario on the beta branch '''''if the deadline has passed, a student(participant) cannot make new submissions'''''. So, automatically if the participant doe not make a new submission then the reviewer wont receive an email. So this issue does not really exist by the virtue of the state of the system.
the stack trace for the check if the submission is allowed or not is as follows -
assignment.rb
<pre>
def submission_allowed(topic_id = nil)
check_condition('submission_allowed_id', topic_id)
end
</pre>

assignment.rb
<pre>
def check_condition(column, topic_id = nil)
next_due_date = DueDate.get_next_due_date(self.id, topic_id)
return false if next_due_date.nil?
right_id = next_due_date.send column
right = DeadlineRight.find(right_id)
right && (right.name == 'OK' || right.name == 'Late')
end
</pre>

due_date.rb
<pre>
def self.get_next_due_date(assignment_id, topic_id = nil)
if Assignment.find(assignment_id).staggered_deadline?
next_due_date = TopicDueDate.find_by(['parent_id = ? and due_at >= ?', topic_id, Time.zone.now])
# if certion TopicDueDate is not exist, we should query next corresponding AssignmentDueDate.
# eg. Time.now is 08/28/2016
# One topic uses following deadlines:
# TopicDueDate 08/01/2016
# TopicDueDate 08/02/2016
# TopicDueDate 08/03/2016
# AssignmentDueDate 09/04/2016
# In this case, we cannot find due_at later than Time.now in TopicDueDate.
# So we should find next corrsponding AssignmentDueDate, starting with the 4th one, not the 1st one!
if next_due_date.nil?
topic_due_date_size = TopicDueDate.where(parent_id: topic_id).size
following_assignment_due_dates = AssignmentDueDate.where(parent_id: assignment_id)[topic_due_date_size..-1]
unless following_assignment_due_dates.nil?
following_assignment_due_dates.each do |assignment_due_date|
if assignment_due_date.due_at >= Time.zone.now
next_due_date = assignment_due_date
break
end
end
end
end
else
next_due_date = AssignmentDueDate.find_by(['parent_id = ? && due_at >= ?', assignment_id, Time.zone.now])
end
next_due_date
end
</pre>

So this is issue is resolved by the state of the system itself. 
'''''BUT Surprisingly on beta branch Reviewers aren't getting any emails at all'''''
on beta branch, in submitted_content_controller, in function "submit_file", this lines is supposed to send email to the reviewers to notify them about the new submission
<pre> participant.assignment.email(participant.id) rescue nil </pre>
''BUT'' here email function is undefined. we checked for email function in assignment class, there was none. The error "undefined function on assignment" is always rescued and hence no errors were raised previously and hence it wasn't highlighted before. 
So, in beta branch reviewers are not being notified anytime a new submission is made to an assignment that they have previously reviewed. So we fixed that
Taking inspiration from the Master branch the previous team's work we added following code to send an email notifying the reviewer of an new submission.

in submitted_content_controller.rb, in the functions, submit_file, submit_hyperlink
<pre>
Team.mail_assigned_reviewers(@participant)
</pre>

participant.rb

<pre>
def mail_assigned_reviewers()
team = self.team
maps = ResponseMap.where(reviewed_object_id: self.assignment.id, reviewee_id: team.id, type: 'ReviewResponseMap')
unless maps.nil?
maps.each do |map|
reviewer = User.find(Participant.find(map.reviewer_id).user_id)
Mailer.sync_message(
{
:to => reviewer.email,
subject: "Assignment '#{self.assignment.name}': A submission has been updated since you last reviewed it",
cc: User.find_by(self.assignment.instructor_id).email,
:body => {
:obj_name => self.assignment.name,
:link => "https://expertiza.ncsu.edu/response/new?id=#{map.id}",
:type => 'submission',
:first_name => ApplicationHelper::get_user_first_name(User.find(Participant.find(map.reviewer_id).user_id)),
:partial_name => 'updated_submission_since_review'
}
}
).deliver_now
end
end
end
</pre>

app/views/mailer/partials/_updated_submission_since_review_plain.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review.
Hence, to update your review please click on the following link.
<% if @link != nil %><%= @link %><% end %>
</pre>

app/views/mailer/partials/_updated_submission_since_review_html.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review. 
Hence, to update your review please click on the following link. 
<% if @link != nil %><a href="<%= @link %>"><%= @link %></a><% end %>

</pre>

added a line in app/mailers/mailer.rb
<pre>
@link = defn[:body][:link]
</pre>

----

==Issue3 (111) - Adding relevant links to reminder emails==

'''Pre conditions'''
* There exists an assignment and a participant associated with that assignment
* The due date for the assignment is approaching

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/111 -
"E-mails about reviews should direct the user to the page where the review is found. Deadline reminders should include a link on where to go to perform the needed function."

So, when assignment reminder emails are sent to students, they should include a link to the relevant assignment.

'''Actual Behavior'''

We implemented this behavior by enhancing the 'email_reminder' function within the app/mailers/mail_worker.rb file. First we get the user associated with the email, then we get the participant object associated with the particular user and the assignment. The ID of this object is the query parameter located at the end of the relevant link. '''mail_worker.rb'''
<pre>
def email_reminder(emails, deadline_type)
assignment = Assignment.find(self.assignment_id)
subject = "Message regarding #{deadline_type} for assignment #{assignment.name}"

# Defining the body of mail
body = "This is a reminder to complete #{deadline_type} for assignment #{assignment.name}.\n"

emails.each do |mail|
# Since the email is not unique fetching the first instance in results returned when searching via email
user = User.where(email: mail).first

# Finding the mapping between participant and assignment so that it can be sent as a query param
participant_assignment_id = Participant.find(user_id: user.id.to_s, parent_id: self.assignment_id.to_s).first.id

# This is the link which User can use to navigate
link_to_destination = "Please follow the link: http://expertiza.ncsu.edu/student_task/view?id=#{participant_assignment_id}\n"
body += link_to_destination + "Deadline is #{self.due_at}. If you have already done the #{deadline_type}, then please ignore this mail.";

# Send mail to the user
@mail = Mailer.delayed_message(bcc: mail, subject: subject, body: body)
@mail.deliver_now
Rails.logger.info mail
end
end
</pre>
This function is clearly tested through a new test we added to the spec/workers/sidekiq_mail_worker_spec.rb '''sidekiq_mail_worker_spec.rb'''
<pre>
it "should send reminder email to required email address with proper content" do
Sidekiq::Testing.inline!
ActionMailer::Base.deliveries.clear
worker = MailWorker.new
worker.perform("1", "metareview", "2018-12-31 00:00:01")
expect(ActionMailer::Base.deliveries.size).to eq(1)
email = ActionMailer::Base.deliveries.first
expect(email.from[0]).to eq("expertiza.development@gmail.com")
expect(email.bcc[0]).to eq("psingh22@ncsu.edu")
expect(email.subject).to eq("Message regarding teammate review for assignment no assignment")
expect(email.body).to eq("This is a reminder to complete teammate review for assignment no assignment.\nPlease follow the link: http://expertiza.ncsu.edu/student_task/view?id=1\nDeadline is 2018-12-31 00:00:01. If you have already done the teammate review, then please ignore this mail.")
end
</pre>

==Testing==
'''Testing Reviewe's Email manually'''

Step 1: Create new assignment [Manage --> Assignment --> + Button (to create new assignment)]

Step 2: Fill the details for the assignments.

Step 3: Navigate to due dates.

Step 4: Change the number of review rounds to 2.

Step 5: Select "Yes" in the dropdown for review allowed during submission and select "Yes" for submission during the review.

Step 6: Add two users to the assignment(author and reviewer).

Step 7: Log in with some user credentials (author credential).

Step 8: Make a new submission to this assignment.

Step 9: Log in with another user (reviewer).

Step 10: Submit a review of the assignment submission.

Step 11: Login as an author again.

Step 12: Edit the submission.

Step 13: After this check the mailbox of the reviewer [development mail for development].

Step 14: Reviewer should get the mail to re-review the work.

Step 15: Change the due date to some date and time which has passed.

Step 16: Now the author should not be able to make a new submission.

'''Testing Reviewe's Email via rspec'''

CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications

2021-10-21T03:21:40Z

Glbrook2: /* Issue3 (111) - Adding relevant links to reminder emails */

=E2142. Improve e-mail notifications=

==Brief Introduction==

* E2142. Improve e-mail notifications
* The forked repository can be found at: https://github.com/griffinbrookshire/expertiza

==Problem Statement==
The following tasks were accomplished in this project:

*Issue1: Send new account welcome email to user, when imported from CSV through assignment page.
*Issue2: Don't send email to reviewers for a new submission after review deadline has passed.
*Issue3: Adding relevant links to reminder emails.

==Issue1 (717) - Send new account welcome email to user, when imported from CSV through assignment page==

'''Pre conditions'''
* There exists an assignment and an instructor
* The instructor navigates to the 'Manage Assignments' page
* The instructor clicks 'Add Participants' for the existing assignment
* The instructor clicks 'Import assignment participants'
* The instructor imports a CSV file containing a user who does not exist yet

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/717 -
"When students' accounts are created by importing a CSV on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. Students should receive e-mails upon account creation, regardless of how their account is created."

So, when students accounts are created in any way, they should receive a welcome email. This includes adding them through importing a CSV.

'''Actual Behavior'''

This behavior was actually already implemented through one simple line in the app/models/user.rb file. '''user.rb'''
<pre>
after_create :email_welcome
</pre>
This line calls the 'email_welcome' function every time a user is created, which sends a welcome email to the newly created user. '''user.rb'''
<pre>
# Function which has a MailerHelper which sends the mail welcome email to the user after signing up
def email_welcome
#this will send an account creation notification to user via email.
MailerHelper.send_mail_to_user(self, "Your Expertiza account and password has been created", "user_welcome", password).deliver_now
end
</pre>
This functionality is also completely tested in the spec/models/assignment_participant_spec.rb file show below. This test shows that when the import function is called an email is delivered. '''assignment_participant_spec.rb'''
<pre>
context 'when new user needs to be created' do
let(:row) do
{name: 'no one', fullname: 'no one', email: 'name@email.com', role:'user_role_name', parent: 'user_parent_name'}
end
let(:attributes) do
{role_id: 1, name: 'no one', fullname: 'no one', email: 'name@email.com', email_on_submission: 'name@email.com',
email_on_review: 'name@email.com', email_on_review_of_review: 'name@email.com'}
end
let(:test_user) do
{name: 'abc', email: 'abcbbc@gmail.com'}
end
it 'create the user and number of mails sent should be 1' do
ActionMailer::Base.deliveries.clear
allow(ImportFileHelper).to receive(:define_attributes).with(row).and_return(attributes)
allow(ImportFileHelper).to receive(:create_new_user) do
test_user = User.new(name: 'abc', fullname: 'abc bbc', email: 'abcbbc@gmail.com')
test_user.id = 123
test_user.save!
test_user
end
#allow(ImportFileHelper).to receive(:create_new_user).with(attributes, {}).and_return()
allow(Assignment).to receive(:find).with(1).and_return(assignment)
allow(User).to receive(:exists?).with(name: 'no one').and_return(false)
allow(participant).to receive(:set_handle).and_return('handle')
allow(AssignmentParticipant).to receive(:exists?).and_return(false)
allow(AssignmentParticipant).to receive(:create).and_return(participant)
allow(AssignmentParticipant).to receive(:set_handle)
expect{(AssignmentParticipant.import(row, nil, {}, 1))}.to change { ActionMailer::Base.deliveries.count }.by(1)
end
end
</pre>

==Issue2 (345) - Don't send email to reviewers for a new submission after review deadline has passed==

'''Pre conditions'''
* There is an assignment, a student as a participant, a participant as a reviewer who is reviewing the this particular assignment
* a review is made for a submission by the student
* review deadline has passed
* the student is allowed to submit after the review deadline has passed

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/345 -
"Evidently, if a submission is revised after review, the system e-mails the reviewer saying to revise the review. This is just fine ... except if the last round of review has been completed.
The message telling reviewers to revise their reviews should not be sent after the last review deadline has passed."

So basically, When the student makes a new submission after the LAST review deadline has passed. The reviewer should not receive an email, asking the reviewer to update the review according to the new submission.

'''Actual Behavior'''

According to the current Code scenario on the beta branch '''''if the deadline has passed, a student(participant) cannot make new submissions'''''. So, automatically if the participant doe not make a new submission then the reviewer wont receive an email. So this issue does not really exist by the virtue of the state of the system.
the stack trace for the check if the submission is allowed or not is as follows -
assignment.rb
<pre>
def submission_allowed(topic_id = nil)
check_condition('submission_allowed_id', topic_id)
end
</pre>

assignment.rb
<pre>
def check_condition(column, topic_id = nil)
next_due_date = DueDate.get_next_due_date(self.id, topic_id)
return false if next_due_date.nil?
right_id = next_due_date.send column
right = DeadlineRight.find(right_id)
right && (right.name == 'OK' || right.name == 'Late')
end
</pre>

due_date.rb
<pre>
def self.get_next_due_date(assignment_id, topic_id = nil)
if Assignment.find(assignment_id).staggered_deadline?
next_due_date = TopicDueDate.find_by(['parent_id = ? and due_at >= ?', topic_id, Time.zone.now])
# if certion TopicDueDate is not exist, we should query next corresponding AssignmentDueDate.
# eg. Time.now is 08/28/2016
# One topic uses following deadlines:
# TopicDueDate 08/01/2016
# TopicDueDate 08/02/2016
# TopicDueDate 08/03/2016
# AssignmentDueDate 09/04/2016
# In this case, we cannot find due_at later than Time.now in TopicDueDate.
# So we should find next corrsponding AssignmentDueDate, starting with the 4th one, not the 1st one!
if next_due_date.nil?
topic_due_date_size = TopicDueDate.where(parent_id: topic_id).size
following_assignment_due_dates = AssignmentDueDate.where(parent_id: assignment_id)[topic_due_date_size..-1]
unless following_assignment_due_dates.nil?
following_assignment_due_dates.each do |assignment_due_date|
if assignment_due_date.due_at >= Time.zone.now
next_due_date = assignment_due_date
break
end
end
end
end
else
next_due_date = AssignmentDueDate.find_by(['parent_id = ? && due_at >= ?', assignment_id, Time.zone.now])
end
next_due_date
end
</pre>

So this is issue is resolved by the state of the system itself. 
'''''BUT Surprisingly on beta branch Reviewers aren't getting any emails at all'''''
on beta branch, in submitted_content_controller, in function "submit_file", this lines is supposed to send email to the reviewers to notify them about the new submission
<pre> participant.assignment.email(participant.id) rescue nil </pre>
''BUT'' here email function is undefined. we checked for email function in assignment class, there was none. The error "undefined function on assignment" is always rescued and hence no errors were raised previously and hence it wasn't highlighted before. 
So, in beta branch reviewers are not being notified anytime a new submission is made to an assignment that they have previously reviewed. So we fixed that
Taking inspiration from the Master branch the previous team's work we added following code to send an email notifying the reviewer of an new submission.

in submitted_content_controller.rb, in the functions, submit_file, submit_hyperlink
<pre>
Team.mail_assigned_reviewers(@participant)
</pre>

participant.rb

<pre>
def mail_assigned_reviewers()
team = self.team
maps = ResponseMap.where(reviewed_object_id: self.assignment.id, reviewee_id: team.id, type: 'ReviewResponseMap')
unless maps.nil?
maps.each do |map|
reviewer = User.find(Participant.find(map.reviewer_id).user_id)
Mailer.sync_message(
{
:to => reviewer.email,
subject: "Assignment '#{self.assignment.name}': A submission has been updated since you last reviewed it",
cc: User.find_by(self.assignment.instructor_id).email,
:body => {
:obj_name => self.assignment.name,
:link => "https://expertiza.ncsu.edu/response/new?id=#{map.id}",
:type => 'submission',
:first_name => ApplicationHelper::get_user_first_name(User.find(Participant.find(map.reviewer_id).user_id)),
:partial_name => 'updated_submission_since_review'
}
}
).deliver_now
end
end
end
</pre>

app/views/mailer/partials/_updated_submission_since_review_plain.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review.
Hence, to update your review please click on the following link.
<% if @link != nil %><%= @link %><% end %>
</pre>

app/views/mailer/partials/_updated_submission_since_review_html.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review. 
Hence, to update your review please click on the following link. 
<% if @link != nil %><a href="<%= @link %>"><%= @link %></a><% end %>

</pre>

added a line in app/mailers/mailer.rb
<pre>
@link = defn[:body][:link]
</pre>

----

==Issue3 (111) - Adding relevant links to reminder emails==

'''Pre conditions'''
* There exists an assignment and a participant associated with that assignment
* The due date for the assignment is approaching

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/111 -
"E-mails about reviews should direct the user to the page where the review is found. Deadline reminders should include a link on where to go to perform the needed function."

So, when assignment reminder emails are sent to students, they should include a link to the relevant assignment.

'''Actual Behavior'''

We implemented this behavior by enhancing the 'email_reminder' function within the app/mailers/mail_worker.rb file. First we get the user associated with the email, then we get the participant object associated with the particular user and the assignment. The ID of this object is the query parameter located at the end of the relevant link. '''mail_worker.rb'''
<pre>
def email_reminder(emails, deadline_type)
assignment = Assignment.find(self.assignment_id)
subject = "Message regarding #{deadline_type} for assignment #{assignment.name}"

# Defining the body of mail
body = "This is a reminder to complete #{deadline_type} for assignment #{assignment.name}.\n"

emails.each do |mail|
# Since the email is not unique fetching the first instance in results returned when searching via email
user = User.where(email: mail).first

# Finding the mapping between participant and assignment so that it can be sent as a query param
participant_assignment_id = Participant.find(user_id: user.id.to_s, parent_id: self.assignment_id.to_s).first.id

# This is the link which User can use to navigate
link_to_destination = "Please follow the link: http://expertiza.ncsu.edu/student_task/view?id=#{participant_assignment_id}\n"
body += link_to_destination + "Deadline is #{self.due_at}. If you have already done the #{deadline_type}, then please ignore this mail.";

# Send mail to the user
@mail = Mailer.delayed_message(bcc: mail, subject: subject, body: body)
@mail.deliver_now
Rails.logger.info mail
end
end
</pre>
This function is clearly tested through a new test we added to the spec/workers/sidekiq_mail_worker_spec.rb '''sidekiq_mail_worker_spec.rb'''
<pre>
it "should send reminder email to required email address with proper content" do
Sidekiq::Testing.inline!
ActionMailer::Base.deliveries.clear
worker = MailWorker.new
worker.perform("1", "metareview", "2018-12-31 00:00:01")
expect(ActionMailer::Base.deliveries.size).to eq(1)
email = ActionMailer::Base.deliveries.first
expect(email.from[0]).to eq("expertiza.development@gmail.com")
expect(email.bcc[0]).to eq("psingh22@ncsu.edu")
expect(email.subject).to eq("Message regarding teammate review for assignment no assignment")
expect(email.body).to eq("This is a reminder to complete teammate review for assignment no assignment.\n Please follow the link: http://expertiza.ncsu.edu/student_task/view?id=1\n Deadline is 2018-12-31 00:00:01. If you have already done the teammate review, then please ignore this mail.")
end
</pre>

==Testing==
'''Testing Reviewe's Email manually'''

Step 1: Create new assignment [Manage --> Assignment --> + Button (to create new assignment)]

Step 2: Fill the details for the assignments.

Step 3: Navigate to due dates.

Step 4: Change the number of review rounds to 2.

Step 5: Select "Yes" in the dropdown for review allowed during submission and select "Yes" for submission during the review.

Step 6: Add two users to the assignment(author and reviewer).

Step 7: Log in with some user credentials (author credential).

Step 8: Make a new submission to this assignment.

Step 9: Log in with another user (reviewer).

Step 10: Submit a review of the assignment submission.

Step 11: Login as an author again.

Step 12: Edit the submission.

Step 13: After this check the mailbox of the reviewer [development mail for development].

Step 14: Reviewer should get the mail to re-review the work.

Step 15: Change the due date to some date and time which has passed.

Step 16: Now the author should not be able to make a new submission.

'''Testing Reviewe's Email via rspec'''

CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications

2021-10-21T03:14:58Z

Glbrook2: /* Issue3 (111) - Adding relevant links to reminder emails */

=E2142. Improve e-mail notifications=

==Brief Introduction==

* E2142. Improve e-mail notifications
* The forked repository can be found at: https://github.com/griffinbrookshire/expertiza

==Problem Statement==
The following tasks were accomplished in this project:

*Issue1: Send new account welcome email to user, when imported from CSV through assignment page.
*Issue2: Don't send email to reviewers for a new submission after review deadline has passed.
*Issue3: Adding relevant links to reminder emails.

==Issue1 (717) - Send new account welcome email to user, when imported from CSV through assignment page==

'''Pre conditions'''
* There exists an assignment and an instructor
* The instructor navigates to the 'Manage Assignments' page
* The instructor clicks 'Add Participants' for the existing assignment
* The instructor clicks 'Import assignment participants'
* The instructor imports a CSV file containing a user who does not exist yet

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/717 -
"When students' accounts are created by importing a CSV on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. Students should receive e-mails upon account creation, regardless of how their account is created."

So, when students accounts are created in any way, they should receive a welcome email. This includes adding them through importing a CSV.

'''Actual Behavior'''

This behavior was actually already implemented through one simple line in the app/models/user.rb file. '''user.rb'''
<pre>
after_create :email_welcome
</pre>
This line calls the 'email_welcome' function every time a user is created, which sends a welcome email to the newly created user. '''user.rb'''
<pre>
# Function which has a MailerHelper which sends the mail welcome email to the user after signing up
def email_welcome
#this will send an account creation notification to user via email.
MailerHelper.send_mail_to_user(self, "Your Expertiza account and password has been created", "user_welcome", password).deliver_now
end
</pre>
This functionality is also completely tested in the spec/models/assignment_participant_spec.rb file show below. This test shows that when the import function is called an email is delivered. '''assignment_participant_spec.rb'''
<pre>
context 'when new user needs to be created' do
let(:row) do
{name: 'no one', fullname: 'no one', email: 'name@email.com', role:'user_role_name', parent: 'user_parent_name'}
end
let(:attributes) do
{role_id: 1, name: 'no one', fullname: 'no one', email: 'name@email.com', email_on_submission: 'name@email.com',
email_on_review: 'name@email.com', email_on_review_of_review: 'name@email.com'}
end
let(:test_user) do
{name: 'abc', email: 'abcbbc@gmail.com'}
end
it 'create the user and number of mails sent should be 1' do
ActionMailer::Base.deliveries.clear
allow(ImportFileHelper).to receive(:define_attributes).with(row).and_return(attributes)
allow(ImportFileHelper).to receive(:create_new_user) do
test_user = User.new(name: 'abc', fullname: 'abc bbc', email: 'abcbbc@gmail.com')
test_user.id = 123
test_user.save!
test_user
end
#allow(ImportFileHelper).to receive(:create_new_user).with(attributes, {}).and_return()
allow(Assignment).to receive(:find).with(1).and_return(assignment)
allow(User).to receive(:exists?).with(name: 'no one').and_return(false)
allow(participant).to receive(:set_handle).and_return('handle')
allow(AssignmentParticipant).to receive(:exists?).and_return(false)
allow(AssignmentParticipant).to receive(:create).and_return(participant)
allow(AssignmentParticipant).to receive(:set_handle)
expect{(AssignmentParticipant.import(row, nil, {}, 1))}.to change { ActionMailer::Base.deliveries.count }.by(1)
end
end
</pre>

==Issue2 (345) - Don't send email to reviewers for a new submission after review deadline has passed==

'''Pre conditions'''
* There is an assignment, a student as a participant, a participant as a reviewer who is reviewing the this particular assignment
* a review is made for a submission by the student
* review deadline has passed
* the student is allowed to submit after the review deadline has passed

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/345 -
"Evidently, if a submission is revised after review, the system e-mails the reviewer saying to revise the review. This is just fine ... except if the last round of review has been completed.
The message telling reviewers to revise their reviews should not be sent after the last review deadline has passed."

So basically, When the student makes a new submission after the LAST review deadline has passed. The reviewer should not receive an email, asking the reviewer to update the review according to the new submission.

'''Actual Behavior'''

According to the current Code scenario on the beta branch '''''if the deadline has passed, a student(participant) cannot make new submissions'''''. So, automatically if the participant doe not make a new submission then the reviewer wont receive an email. So this issue does not really exist by the virtue of the state of the system.
the stack trace for the check if the submission is allowed or not is as follows -
assignment.rb
<pre>
def submission_allowed(topic_id = nil)
check_condition('submission_allowed_id', topic_id)
end
</pre>

assignment.rb
<pre>
def check_condition(column, topic_id = nil)
next_due_date = DueDate.get_next_due_date(self.id, topic_id)
return false if next_due_date.nil?
right_id = next_due_date.send column
right = DeadlineRight.find(right_id)
right && (right.name == 'OK' || right.name == 'Late')
end
</pre>

due_date.rb
<pre>
def self.get_next_due_date(assignment_id, topic_id = nil)
if Assignment.find(assignment_id).staggered_deadline?
next_due_date = TopicDueDate.find_by(['parent_id = ? and due_at >= ?', topic_id, Time.zone.now])
# if certion TopicDueDate is not exist, we should query next corresponding AssignmentDueDate.
# eg. Time.now is 08/28/2016
# One topic uses following deadlines:
# TopicDueDate 08/01/2016
# TopicDueDate 08/02/2016
# TopicDueDate 08/03/2016
# AssignmentDueDate 09/04/2016
# In this case, we cannot find due_at later than Time.now in TopicDueDate.
# So we should find next corrsponding AssignmentDueDate, starting with the 4th one, not the 1st one!
if next_due_date.nil?
topic_due_date_size = TopicDueDate.where(parent_id: topic_id).size
following_assignment_due_dates = AssignmentDueDate.where(parent_id: assignment_id)[topic_due_date_size..-1]
unless following_assignment_due_dates.nil?
following_assignment_due_dates.each do |assignment_due_date|
if assignment_due_date.due_at >= Time.zone.now
next_due_date = assignment_due_date
break
end
end
end
end
else
next_due_date = AssignmentDueDate.find_by(['parent_id = ? && due_at >= ?', assignment_id, Time.zone.now])
end
next_due_date
end
</pre>

So this is issue is resolved by the state of the system itself. 
'''''BUT Surprisingly on beta branch Reviewers aren't getting any emails at all'''''
on beta branch, in submitted_content_controller, in function "submit_file", this lines is supposed to send email to the reviewers to notify them about the new submission
<pre> participant.assignment.email(participant.id) rescue nil </pre>
''BUT'' here email function is undefined. we checked for email function in assignment class, there was none. The error "undefined function on assignment" is always rescued and hence no errors were raised previously and hence it wasn't highlighted before. 
So, in beta branch reviewers are not being notified anytime a new submission is made to an assignment that they have previously reviewed. So we fixed that
Taking inspiration from the Master branch the previous team's work we added following code to send an email notifying the reviewer of an new submission.

in submitted_content_controller.rb, in the functions, submit_file, submit_hyperlink
<pre>
Team.mail_assigned_reviewers(@participant)
</pre>

participant.rb

<pre>
def mail_assigned_reviewers()
team = self.team
maps = ResponseMap.where(reviewed_object_id: self.assignment.id, reviewee_id: team.id, type: 'ReviewResponseMap')
unless maps.nil?
maps.each do |map|
reviewer = User.find(Participant.find(map.reviewer_id).user_id)
Mailer.sync_message(
{
:to => reviewer.email,
subject: "Assignment '#{self.assignment.name}': A submission has been updated since you last reviewed it",
cc: User.find_by(self.assignment.instructor_id).email,
:body => {
:obj_name => self.assignment.name,
:link => "https://expertiza.ncsu.edu/response/new?id=#{map.id}",
:type => 'submission',
:first_name => ApplicationHelper::get_user_first_name(User.find(Participant.find(map.reviewer_id).user_id)),
:partial_name => 'updated_submission_since_review'
}
}
).deliver_now
end
end
end
</pre>

app/views/mailer/partials/_updated_submission_since_review_plain.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review.
Hence, to update your review please click on the following link.
<% if @link != nil %><%= @link %><% end %>
</pre>

app/views/mailer/partials/_updated_submission_since_review_html.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review. 
Hence, to update your review please click on the following link. 
<% if @link != nil %><a href="<%= @link %>"><%= @link %></a><% end %>

</pre>

added a line in app/mailers/mailer.rb
<pre>
@link = defn[:body][:link]
</pre>

----

==Issue3 (111) - Adding relevant links to reminder emails==

'''Pre conditions'''
* There exists an assignment and a participant associated with that assignment
* The due date for the assignment is approaching

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/111 -
"E-mails about reviews should direct the user to the page where the review is found. Deadline reminders should include a link on where to go to perform the needed function."

So, when assignment reminder emails are sent to students, they should include a link to the relevant assignment.

'''Actual Behavior'''

We implemented this behavior by enhancing the 'email_reminder' function within the app/mailers/mail_worker.rb file. First we get the user associated with the email, then we get the participant object associated with the particular user and the assignment. The ID of this object is the query parameter located at the end of the relevant link. '''mail_worker.rb'''
<pre>
def email_reminder(emails, deadline_type)
assignment = Assignment.find(self.assignment_id)
subject = "Message regarding #{deadline_type} for assignment #{assignment.name}"

# Defining the body of mail
body = "This is a reminder to complete #{deadline_type} for assignment #{assignment.name}.\n"

emails.each do |mail|
# Since the email is not unique fetching the first instance in results returned when searching via email
user = User.where(email: mail).first

# Finding the mapping between participant and assignment so that it can be sent as a query param
participant_assignment_id = Participant.find(user_id: user.id.to_s, parent_id: self.assignment_id.to_s).first.id

# This is the link which User can use to navigate
link_to_destination = "Please follow the link: http://expertiza.ncsu.edu/student_task/view?id=#{participant_assignment_id}\n"
body += link_to_destination + "Deadline is #{self.due_at}. If you have already done the #{deadline_type}, then please ignore this mail.";

# Send mail to the user
@mail = Mailer.delayed_message(bcc: mail, subject: subject, body: body)
@mail.deliver_now
Rails.logger.info mail
end
end
</pre>
This function is clearly tested through a new test we added to the spec/workers/sidekiq_mail_worker_spec.rb '''sidekiq_mail_worker_spec.rb'''
<pre>
it "should send reminder email to required email address with proper content" do
Sidekiq::Testing.inline!
ActionMailer::Base.deliveries.clear
worker = MailWorker.new
worker.perform("1", "metareview", "2018-12-31 00:00:01")
expect(ActionMailer::Base.deliveries.size).to eq(1)
email = ActionMailer::Base.deliveries.first
expect(email.from[0]).to eq("expertiza.development@gmail.com")
expect(email.bcc[0]).to eq("psingh22@ncsu.edu")
expect(email.subject).to eq("Message regarding teammate review for assignment no assignment")
expect(email.body).to eq("This is a reminder to complete teammate review for assignment no assignment.\nPlease follow the link: http://expertiza.ncsu.edu/student_task/view?id=1\nDeadline is 2018-12-31 00:00:01. If you have already done the teammate review, then please ignore this mail.")
end
</pre>

==Testing==
'''Testing Reviewe's Email manually'''

Step 1: Create new assignment [Manage --> Assignment --> + Button (to create new assignment)]

Step 2: Fill the details for the assignments.

Step 3: Navigate to due dates.

Step 4: Change the number of review rounds to 2.

Step 5: Select "Yes" in the dropdown for review allowed during submission and select "Yes" for submission during the review.

Step 6: Add two users to the assignment(author and reviewer).

Step 7: Log in with some user credentials (author credential).

Step 8: Make a new submission to this assignment.

Step 9: Log in with another user (reviewer).

Step 10: Submit a review of the assignment submission.

Step 11: Login as an author again.

Step 12: Edit the submission.

Step 13: After this check the mailbox of the reviewer [development mail for development].

Step 14: Reviewer should get the mail to re-review the work.

Step 15: Change the due date to some date and time which has passed.

Step 16: Now the author should not be able to make a new submission.

'''Testing Reviewe's Email via rspec'''

CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications

2021-10-21T03:13:39Z

Glbrook2: /* E2142. Improve e-mail notifications */

=E2142. Improve e-mail notifications=

==Brief Introduction==

* E2142. Improve e-mail notifications
* The forked repository can be found at: https://github.com/griffinbrookshire/expertiza

==Problem Statement==
The following tasks were accomplished in this project:

*Issue1: Send new account welcome email to user, when imported from CSV through assignment page.
*Issue2: Don't send email to reviewers for a new submission after review deadline has passed.
*Issue3: Adding relevant links to reminder emails.

==Issue1 (717) - Send new account welcome email to user, when imported from CSV through assignment page==

'''Pre conditions'''
* There exists an assignment and an instructor
* The instructor navigates to the 'Manage Assignments' page
* The instructor clicks 'Add Participants' for the existing assignment
* The instructor clicks 'Import assignment participants'
* The instructor imports a CSV file containing a user who does not exist yet

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/717 -
"When students' accounts are created by importing a CSV on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. Students should receive e-mails upon account creation, regardless of how their account is created."

So, when students accounts are created in any way, they should receive a welcome email. This includes adding them through importing a CSV.

'''Actual Behavior'''

This behavior was actually already implemented through one simple line in the app/models/user.rb file. '''user.rb'''
<pre>
after_create :email_welcome
</pre>
This line calls the 'email_welcome' function every time a user is created, which sends a welcome email to the newly created user. '''user.rb'''
<pre>
# Function which has a MailerHelper which sends the mail welcome email to the user after signing up
def email_welcome
#this will send an account creation notification to user via email.
MailerHelper.send_mail_to_user(self, "Your Expertiza account and password has been created", "user_welcome", password).deliver_now
end
</pre>
This functionality is also completely tested in the spec/models/assignment_participant_spec.rb file show below. This test shows that when the import function is called an email is delivered. '''assignment_participant_spec.rb'''
<pre>
context 'when new user needs to be created' do
let(:row) do
{name: 'no one', fullname: 'no one', email: 'name@email.com', role:'user_role_name', parent: 'user_parent_name'}
end
let(:attributes) do
{role_id: 1, name: 'no one', fullname: 'no one', email: 'name@email.com', email_on_submission: 'name@email.com',
email_on_review: 'name@email.com', email_on_review_of_review: 'name@email.com'}
end
let(:test_user) do
{name: 'abc', email: 'abcbbc@gmail.com'}
end
it 'create the user and number of mails sent should be 1' do
ActionMailer::Base.deliveries.clear
allow(ImportFileHelper).to receive(:define_attributes).with(row).and_return(attributes)
allow(ImportFileHelper).to receive(:create_new_user) do
test_user = User.new(name: 'abc', fullname: 'abc bbc', email: 'abcbbc@gmail.com')
test_user.id = 123
test_user.save!
test_user
end
#allow(ImportFileHelper).to receive(:create_new_user).with(attributes, {}).and_return()
allow(Assignment).to receive(:find).with(1).and_return(assignment)
allow(User).to receive(:exists?).with(name: 'no one').and_return(false)
allow(participant).to receive(:set_handle).and_return('handle')
allow(AssignmentParticipant).to receive(:exists?).and_return(false)
allow(AssignmentParticipant).to receive(:create).and_return(participant)
allow(AssignmentParticipant).to receive(:set_handle)
expect{(AssignmentParticipant.import(row, nil, {}, 1))}.to change { ActionMailer::Base.deliveries.count }.by(1)
end
end
</pre>

==Issue2 (345) - Don't send email to reviewers for a new submission after review deadline has passed==

'''Pre conditions'''
* There is an assignment, a student as a participant, a participant as a reviewer who is reviewing the this particular assignment
* a review is made for a submission by the student
* review deadline has passed
* the student is allowed to submit after the review deadline has passed

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/345 -
"Evidently, if a submission is revised after review, the system e-mails the reviewer saying to revise the review. This is just fine ... except if the last round of review has been completed.
The message telling reviewers to revise their reviews should not be sent after the last review deadline has passed."

So basically, When the student makes a new submission after the LAST review deadline has passed. The reviewer should not receive an email, asking the reviewer to update the review according to the new submission.

'''Actual Behavior'''

According to the current Code scenario on the beta branch '''''if the deadline has passed, a student(participant) cannot make new submissions'''''. So, automatically if the participant doe not make a new submission then the reviewer wont receive an email. So this issue does not really exist by the virtue of the state of the system.
the stack trace for the check if the submission is allowed or not is as follows -
assignment.rb
<pre>
def submission_allowed(topic_id = nil)
check_condition('submission_allowed_id', topic_id)
end
</pre>

assignment.rb
<pre>
def check_condition(column, topic_id = nil)
next_due_date = DueDate.get_next_due_date(self.id, topic_id)
return false if next_due_date.nil?
right_id = next_due_date.send column
right = DeadlineRight.find(right_id)
right && (right.name == 'OK' || right.name == 'Late')
end
</pre>

due_date.rb
<pre>
def self.get_next_due_date(assignment_id, topic_id = nil)
if Assignment.find(assignment_id).staggered_deadline?
next_due_date = TopicDueDate.find_by(['parent_id = ? and due_at >= ?', topic_id, Time.zone.now])
# if certion TopicDueDate is not exist, we should query next corresponding AssignmentDueDate.
# eg. Time.now is 08/28/2016
# One topic uses following deadlines:
# TopicDueDate 08/01/2016
# TopicDueDate 08/02/2016
# TopicDueDate 08/03/2016
# AssignmentDueDate 09/04/2016
# In this case, we cannot find due_at later than Time.now in TopicDueDate.
# So we should find next corrsponding AssignmentDueDate, starting with the 4th one, not the 1st one!
if next_due_date.nil?
topic_due_date_size = TopicDueDate.where(parent_id: topic_id).size
following_assignment_due_dates = AssignmentDueDate.where(parent_id: assignment_id)[topic_due_date_size..-1]
unless following_assignment_due_dates.nil?
following_assignment_due_dates.each do |assignment_due_date|
if assignment_due_date.due_at >= Time.zone.now
next_due_date = assignment_due_date
break
end
end
end
end
else
next_due_date = AssignmentDueDate.find_by(['parent_id = ? && due_at >= ?', assignment_id, Time.zone.now])
end
next_due_date
end
</pre>

So this is issue is resolved by the state of the system itself. 
'''''BUT Surprisingly on beta branch Reviewers aren't getting any emails at all'''''
on beta branch, in submitted_content_controller, in function "submit_file", this lines is supposed to send email to the reviewers to notify them about the new submission
<pre> participant.assignment.email(participant.id) rescue nil </pre>
''BUT'' here email function is undefined. we checked for email function in assignment class, there was none. The error "undefined function on assignment" is always rescued and hence no errors were raised previously and hence it wasn't highlighted before. 
So, in beta branch reviewers are not being notified anytime a new submission is made to an assignment that they have previously reviewed. So we fixed that
Taking inspiration from the Master branch the previous team's work we added following code to send an email notifying the reviewer of an new submission.

in submitted_content_controller.rb, in the functions, submit_file, submit_hyperlink
<pre>
Team.mail_assigned_reviewers(@participant)
</pre>

participant.rb

<pre>
def mail_assigned_reviewers()
team = self.team
maps = ResponseMap.where(reviewed_object_id: self.assignment.id, reviewee_id: team.id, type: 'ReviewResponseMap')
unless maps.nil?
maps.each do |map|
reviewer = User.find(Participant.find(map.reviewer_id).user_id)
Mailer.sync_message(
{
:to => reviewer.email,
subject: "Assignment '#{self.assignment.name}': A submission has been updated since you last reviewed it",
cc: User.find_by(self.assignment.instructor_id).email,
:body => {
:obj_name => self.assignment.name,
:link => "https://expertiza.ncsu.edu/response/new?id=#{map.id}",
:type => 'submission',
:first_name => ApplicationHelper::get_user_first_name(User.find(Participant.find(map.reviewer_id).user_id)),
:partial_name => 'updated_submission_since_review'
}
}
).deliver_now
end
end
end
</pre>

app/views/mailer/partials/_updated_submission_since_review_plain.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review.
Hence, to update your review please click on the following link.
<% if @link != nil %><%= @link %><% end %>
</pre>

app/views/mailer/partials/_updated_submission_since_review_html.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review. 
Hence, to update your review please click on the following link. 
<% if @link != nil %><a href="<%= @link %>"><%= @link %></a><% end %>

</pre>

added a line in app/mailers/mailer.rb
<pre>
@link = defn[:body][:link]
</pre>

----

==Issue3 (111) - Adding relevant links to reminder emails==

'''Pre conditions'''
* There exists an assignment and a participant associated with that assignment
* The due date for the assignment is approaching

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/111 -
"E-mails about reviews should direct the user to the page where the review is found. Deadline reminders should include a link on where to go to perform the needed function."

So, when assignment reminder emails are sent to students, they should include a link to the relevant assignment.

'''Actual Behavior'''

We implemented this behavior by enhancing the 'email_reminder' function within the app/mailers/mail_worker.rb file. First I added a line that gets the user associated with the email. Then I get the participant object associated with the particular user and the assignment. The ID of this object is the query parameter located at the end of the relevant link. '''mail_worker.rb'''
<pre>
def email_reminder(emails, deadline_type)
assignment = Assignment.find(self.assignment_id)
subject = "Message regarding #{deadline_type} for assignment #{assignment.name}"

# Defining the body of mail
body = "This is a reminder to complete #{deadline_type} for assignment #{assignment.name}.\n"

emails.each do |mail|
# Since the email is not unique fetching the first instance in results returned when searching via email
user = User.where(email: mail).first

# Finding the mapping between participant and assignment so that it can be sent as a query param
participant_assignment_id = Participant.find(user_id: user.id.to_s, parent_id: self.assignment_id.to_s).first.id

# This is the link which User can use to navigate
link_to_destination = "Please follow the link: http://expertiza.ncsu.edu/student_task/view?id=#{participant_assignment_id}\n"
body += link_to_destination + "Deadline is #{self.due_at}. If you have already done the #{deadline_type}, then please ignore this mail.";

# Send mail to the user
@mail = Mailer.delayed_message(bcc: mail, subject: subject, body: body)
@mail.deliver_now
Rails.logger.info mail
end
end
</pre>
This function is clearly tested through a new test we added to the spec/workers/sidekiq_mail_worker_spec.rb '''sidekiq_mail_worker_spec.rb'''
<pre>
it "should send reminder email to required email address with proper content" do
Sidekiq::Testing.inline!
ActionMailer::Base.deliveries.clear
worker = MailWorker.new
worker.perform("1", "metareview", "2018-12-31 00:00:01")
expect(ActionMailer::Base.deliveries.size).to eq(1)
email = ActionMailer::Base.deliveries.first
expect(email.from[0]).to eq("expertiza.development@gmail.com")
expect(email.bcc[0]).to eq("psingh22@ncsu.edu")
expect(email.subject).to eq("Message regarding teammate review for assignment no assignment")
expect(email.body).to eq("This is a reminder to complete teammate review for assignment no assignment.\nPlease follow the link: http://expertiza.ncsu.edu/student_task/view?id=1\nDeadline is 2018-12-31 00:00:01. If you have already done the teammate review, then please ignore this mail.")
end
</pre>

==Testing==
'''Testing Reviewe's Email manually'''

Step 1: Create new assignment [Manage --> Assignment --> + Button (to create new assignment)]

Step 2: Fill the details for the assignments.

Step 3: Navigate to due dates.

Step 4: Change the number of review rounds to 2.

Step 5: Select "Yes" in the dropdown for review allowed during submission and select "Yes" for submission during the review.

Step 6: Add two users to the assignment(author and reviewer).

Step 7: Log in with some user credentials (author credential).

Step 8: Make a new submission to this assignment.

Step 9: Log in with another user (reviewer).

Step 10: Submit a review of the assignment submission.

Step 11: Login as an author again.

Step 12: Edit the submission.

Step 13: After this check the mailbox of the reviewer [development mail for development].

Step 14: Reviewer should get the mail to re-review the work.

Step 15: Change the due date to some date and time which has passed.

Step 16: Now the author should not be able to make a new submission.

'''Testing Reviewe's Email via rspec'''

CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications

2021-10-21T02:54:10Z

Glbrook2: /* E2142. Improve e-mail notifications */

=E2142. Improve e-mail notifications=

==Brief Introduction==

* E2142. Improve e-mail notifications
* The forked repository can be found at: https://github.com/griffinbrookshire/expertiza

==Problem Statement==
The following tasks were accomplished in this project:

*Issue1: Send new account welcome email to user, when imported from CSV through assignment page.
*Issue2: Don't send email to reviewers for a new submission after review deadline has passed.
*Issue3: Adding relevant links to reminder emails.

==Issue1 (717) - Send new account welcome email to user, when imported from CSV through assignment page==

'''Pre conditions'''
* There exists an assignment and an instructor
* The instructor navigates to the 'Manage Assignments' page
* The instructor clicks 'Add Participants' for the existing assignment
* The instructor clicks 'Import assignment participants'
* The instructor imports a CSV file containing a user who does not exist yet

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/717 -
"When students' accounts are created by importing a CSV on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. Students should receive e-mails upon account creation, regardless of how their account is created."

So, when students accounts are created in any way, they should receive a welcome email. This includes adding them through importing a CSV.

'''Actual Behavior'''

This behavior was actually already implemented through one simple line in the app/models/user.rb file. '''user.rb'''
<pre>
after_create :email_welcome
</pre>
This line calls the 'email_welcome' function every time a user is created, which sends a welcome email to the newly created user. '''user.rb'''
<pre>
# Function which has a MailerHelper which sends the mail welcome email to the user after signing up
def email_welcome
#this will send an account creation notification to user via email.
MailerHelper.send_mail_to_user(self, "Your Expertiza account and password has been created", "user_welcome", password).deliver_now
end
</pre>
This functionality is also completely tested in the spec/models/assignment_participant_spec.rb file show below. This test shows that when the import function is called an email is delivered. '''assignment_participant_spec.rb'''
<pre>
context 'when new user needs to be created' do
let(:row) do
{name: 'no one', fullname: 'no one', email: 'name@email.com', role:'user_role_name', parent: 'user_parent_name'}
end
let(:attributes) do
{role_id: 1, name: 'no one', fullname: 'no one', email: 'name@email.com', email_on_submission: 'name@email.com',
email_on_review: 'name@email.com', email_on_review_of_review: 'name@email.com'}
end
let(:test_user) do
{name: 'abc', email: 'abcbbc@gmail.com'}
end
it 'create the user and number of mails sent should be 1' do
ActionMailer::Base.deliveries.clear
allow(ImportFileHelper).to receive(:define_attributes).with(row).and_return(attributes)
allow(ImportFileHelper).to receive(:create_new_user) do
test_user = User.new(name: 'abc', fullname: 'abc bbc', email: 'abcbbc@gmail.com')
test_user.id = 123
test_user.save!
test_user
end
#allow(ImportFileHelper).to receive(:create_new_user).with(attributes, {}).and_return()
allow(Assignment).to receive(:find).with(1).and_return(assignment)
allow(User).to receive(:exists?).with(name: 'no one').and_return(false)
allow(participant).to receive(:set_handle).and_return('handle')
allow(AssignmentParticipant).to receive(:exists?).and_return(false)
allow(AssignmentParticipant).to receive(:create).and_return(participant)
allow(AssignmentParticipant).to receive(:set_handle)
expect{(AssignmentParticipant.import(row, nil, {}, 1))}.to change { ActionMailer::Base.deliveries.count }.by(1)
end
end
</pre>

==Issue2 (345) - Don't send email to reviewers for a new submission after review deadline has passed==

'''Pre conditions'''
* There is an assignment, a student as a participant, a participant as a reviewer who is reviewing the this particular assignment
* a review is made for a submission by the student
* review deadline has passed
* the student is allowed to submit after the review deadline has passed

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/345 -
"Evidently, if a submission is revised after review, the system e-mails the reviewer saying to revise the review. This is just fine ... except if the last round of review has been completed.
The message telling reviewers to revise their reviews should not be sent after the last review deadline has passed."

So basically, When the student makes a new submission after the LAST review deadline has passed. The reviewer should not receive an email, asking the reviewer to update the review according to the new submission.

'''Actual Behavior'''

According to the current Code scenario on the beta branch '''''if the deadline has passed, a student(participant) cannot make new submissions'''''. So, automatically if the participant doe not make a new submission then the reviewer wont receive an email. So this issue does not really exist by the virtue of the state of the system.
the stack trace for the check if the submission is allowed or not is as follows -
assignment.rb
<pre>
def submission_allowed(topic_id = nil)
check_condition('submission_allowed_id', topic_id)
end
</pre>

assignment.rb
<pre>
def check_condition(column, topic_id = nil)
next_due_date = DueDate.get_next_due_date(self.id, topic_id)
return false if next_due_date.nil?
right_id = next_due_date.send column
right = DeadlineRight.find(right_id)
right && (right.name == 'OK' || right.name == 'Late')
end
</pre>

due_date.rb
<pre>
def self.get_next_due_date(assignment_id, topic_id = nil)
if Assignment.find(assignment_id).staggered_deadline?
next_due_date = TopicDueDate.find_by(['parent_id = ? and due_at >= ?', topic_id, Time.zone.now])
# if certion TopicDueDate is not exist, we should query next corresponding AssignmentDueDate.
# eg. Time.now is 08/28/2016
# One topic uses following deadlines:
# TopicDueDate 08/01/2016
# TopicDueDate 08/02/2016
# TopicDueDate 08/03/2016
# AssignmentDueDate 09/04/2016
# In this case, we cannot find due_at later than Time.now in TopicDueDate.
# So we should find next corrsponding AssignmentDueDate, starting with the 4th one, not the 1st one!
if next_due_date.nil?
topic_due_date_size = TopicDueDate.where(parent_id: topic_id).size
following_assignment_due_dates = AssignmentDueDate.where(parent_id: assignment_id)[topic_due_date_size..-1]
unless following_assignment_due_dates.nil?
following_assignment_due_dates.each do |assignment_due_date|
if assignment_due_date.due_at >= Time.zone.now
next_due_date = assignment_due_date
break
end
end
end
end
else
next_due_date = AssignmentDueDate.find_by(['parent_id = ? && due_at >= ?', assignment_id, Time.zone.now])
end
next_due_date
end
</pre>

So this is issue is resolved by the state of the system itself. 
'''''BUT Surprisingly on beta branch Reviewers aren't getting any emails at all'''''
on beta branch, in submitted_content_controller, in function "submit_file", this lines is supposed to send email to the reviewers to notify them about the new submission
<pre> participant.assignment.email(participant.id) rescue nil </pre>
''BUT'' here email function is undefined. we checked for email function in assignment class, there was none. The error "undefined function on assignment" is always rescued and hence no errors were raised previously and hence it wasn't highlighted before. 
So, in beta branch reviewers are not being notified anytime a new submission is made to an assignment that they have previously reviewed. So we fixed that
Taking inspiration from the Master branch the previous team's work we added following code to send an email notifying the reviewer of an new submission.

in submitted_content_controller.rb, in the functions, submit_file, submit_hyperlink
<pre>
Team.mail_assigned_reviewers(@participant)
</pre>

participant.rb

<pre>
def mail_assigned_reviewers()
team = self.team
maps = ResponseMap.where(reviewed_object_id: self.assignment.id, reviewee_id: team.id, type: 'ReviewResponseMap')
unless maps.nil?
maps.each do |map|
reviewer = User.find(Participant.find(map.reviewer_id).user_id)
Mailer.sync_message(
{
:to => reviewer.email,
subject: "Assignment '#{self.assignment.name}': A submission has been updated since you last reviewed it",
cc: User.find_by(self.assignment.instructor_id).email,
:body => {
:obj_name => self.assignment.name,
:link => "https://expertiza.ncsu.edu/response/new?id=#{map.id}",
:type => 'submission',
:first_name => ApplicationHelper::get_user_first_name(User.find(Participant.find(map.reviewer_id).user_id)),
:partial_name => 'updated_submission_since_review'
}
}
).deliver_now
end
end
end
</pre>

app/views/mailer/partials/_updated_submission_since_review_plain.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review.
Hence, to update your review please click on the following link.
<% if @link != nil %><%= @link %><% end %>
</pre>

app/views/mailer/partials/_updated_submission_since_review_html.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review. 
Hence, to update your review please click on the following link. 
<% if @link != nil %><a href="<%= @link %>"><%= @link %></a><% end %>

</pre>

added a line in app/mailers/mailer.rb
<pre>
@link = defn[:body][:link]
</pre>

----

==Issue3 (111) - Adding relevant links to reminder emails==

'''Pre conditions'''
* There exists an assignment and a participant associated with that assignment
* The due date for the assignment is approaching

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/111 -
"E-mails about reviews should direct the user to the page where the review is found. Deadline reminders should include a link on where to go to perform the needed function."

So, when assignment reminder emails are sent to students, they should include a link to the relevant assignment.

'''Actual Behavior'''

This behavior was actually already implemented through one simple line in the app/models/user.rb file. '''user.rb'''
<pre>
after_create :email_welcome
</pre>
This line calls the 'email_welcome' function every time a user is created, which sends a welcome email to the newly created user. '''user.rb'''
<pre>
# Function which has a MailerHelper which sends the mail welcome email to the user after signing up
def email_welcome
#this will send an account creation notification to user via email.
MailerHelper.send_mail_to_user(self, "Your Expertiza account and password has been created", "user_welcome", password).deliver_now
end
</pre>
This functionality is also completely tested in the spec/models/assignment_participant_spec.rb file show below. This test shows that when the import function is called an email is delivered. '''assignment_participant_spec.rb'''
<pre>
context 'when new user needs to be created' do
let(:row) do
{name: 'no one', fullname: 'no one', email: 'name@email.com', role:'user_role_name', parent: 'user_parent_name'}
end
let(:attributes) do
{role_id: 1, name: 'no one', fullname: 'no one', email: 'name@email.com', email_on_submission: 'name@email.com',
email_on_review: 'name@email.com', email_on_review_of_review: 'name@email.com'}
end
let(:test_user) do
{name: 'abc', email: 'abcbbc@gmail.com'}
end
it 'create the user and number of mails sent should be 1' do
ActionMailer::Base.deliveries.clear
allow(ImportFileHelper).to receive(:define_attributes).with(row).and_return(attributes)
allow(ImportFileHelper).to receive(:create_new_user) do
test_user = User.new(name: 'abc', fullname: 'abc bbc', email: 'abcbbc@gmail.com')
test_user.id = 123
test_user.save!
test_user
end
#allow(ImportFileHelper).to receive(:create_new_user).with(attributes, {}).and_return()
allow(Assignment).to receive(:find).with(1).and_return(assignment)
allow(User).to receive(:exists?).with(name: 'no one').and_return(false)
allow(participant).to receive(:set_handle).and_return('handle')
allow(AssignmentParticipant).to receive(:exists?).and_return(false)
allow(AssignmentParticipant).to receive(:create).and_return(participant)
allow(AssignmentParticipant).to receive(:set_handle)
expect{(AssignmentParticipant.import(row, nil, {}, 1))}.to change { ActionMailer::Base.deliveries.count }.by(1)
end
end
</pre>

==Testing==
'''Testing Reviewe's Email manually'''

Step 1: Create new assignment [Manage --> Assignment --> + Button (to create new assignment)]

Step 2: Fill the details for the assignments.

Step 3: Navigate to due dates.

Step 4: Change the number of review rounds to 2.

Step 5: Select "Yes" in the dropdown for review allowed during submission and select "Yes" for submission during the review.

Step 6: Add two users to the assignment(author and reviewer).

Step 7: Log in with some user credentials (author credential).

Step 8: Make a new submission to this assignment.

Step 9: Log in with another user (reviewer).

Step 10: Submit a review of the assignment submission.

Step 11: Login as an author again.

Step 12: Edit the submission.

Step 13: After this check the mailbox of the reviewer [development mail for development].

Step 14: Reviewer should get the mail to re-review the work.

Step 15: Change the due date to some date and time which has passed.

Step 16: Now the author should not be able to make a new submission.

'''Testing Reviewe's Email via rspec'''

CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications

2021-10-21T02:43:23Z

Glbrook2: /* E2142. Improve e-mail notifications */

=E2142. Improve e-mail notifications=

==Brief Introduction==

* E2142. Improve e-mail notifications
* The forked repository can be found at: https://github.com/griffinbrookshire/expertiza

==Problem Statement==
The following tasks were accomplished in this project:

*Issue1: Send new account welcome email to user, when imported from CSV through assignment page.
*Issue2: Don't send email to reviewers for a new submission after review deadline has passed.
*Issue3: Adding relevant links to reminder emails.

==Issue1 (717) - Send new account welcome email to user, when imported from CSV through assignment page==

'''Pre conditions'''
* There exists an assignment and an instructor
* The instructor navigates to the 'Manage Assignments' page
* The instructor clicks 'Add Participants' for the existing assignment
* The instructor clicks 'Import assignment participants'
* The instructor imports a CSV file containing a user who does not exist yet

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/717 -
"When students' accounts are created by importing a CSV on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. Students should receive e-mails upon account creation, regardless of how their account is created."

So, when students accounts are created in any way, they should receive a welcome email. This includes adding them through importing a CSV.

'''Actual Behavior'''

This behavior was actually already implemented through one simple line in the app/models/user.rb file. '''user.rb'''
<pre>
after_create :email_welcome
</pre>
This line calls the 'email_welcome' function every time a user is created, which sends a welcome email to the newly created user. '''user.rb'''
<pre>
# Function which has a MailerHelper which sends the mail welcome email to the user after signing up
def email_welcome
#this will send an account creation notification to user via email.
MailerHelper.send_mail_to_user(self, "Your Expertiza account and password has been created", "user_welcome", password).deliver_now
end
</pre>
This functionality is also completely tested in the spec/models/assignment_participant_spec.rb file show below. This test shows that when the import function is called an email is delivered. '''assignment_participant_spec.rb'''
<pre>
context 'when new user needs to be created' do
let(:row) do
{name: 'no one', fullname: 'no one', email: 'name@email.com', role:'user_role_name', parent: 'user_parent_name'}
end
let(:attributes) do
{role_id: 1, name: 'no one', fullname: 'no one', email: 'name@email.com', email_on_submission: 'name@email.com',
email_on_review: 'name@email.com', email_on_review_of_review: 'name@email.com'}
end
let(:test_user) do
{name: 'abc', email: 'abcbbc@gmail.com'}
end
it 'create the user and number of mails sent should be 1' do
ActionMailer::Base.deliveries.clear
allow(ImportFileHelper).to receive(:define_attributes).with(row).and_return(attributes)
allow(ImportFileHelper).to receive(:create_new_user) do
test_user = User.new(name: 'abc', fullname: 'abc bbc', email: 'abcbbc@gmail.com')
test_user.id = 123
test_user.save!
test_user
end
#allow(ImportFileHelper).to receive(:create_new_user).with(attributes, {}).and_return()
allow(Assignment).to receive(:find).with(1).and_return(assignment)
allow(User).to receive(:exists?).with(name: 'no one').and_return(false)
allow(participant).to receive(:set_handle).and_return('handle')
allow(AssignmentParticipant).to receive(:exists?).and_return(false)
allow(AssignmentParticipant).to receive(:create).and_return(participant)
allow(AssignmentParticipant).to receive(:set_handle)
expect{(AssignmentParticipant.import(row, nil, {}, 1))}.to change { ActionMailer::Base.deliveries.count }.by(1)
end
end
</pre>

==Issue2 (345) - Don't send email to reviewers for a new submission after review deadline has passed==

'''Pre conditions'''
* There is an assignment, a student as a participant, a participant as a reviewer who is reviewing the this particular assignment
* a review is made for a submission by the student
* review deadline has passed
* the student is allowed to submit after the review deadline has passed

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/345 -
"Evidently, if a submission is revised after review, the system e-mails the reviewer saying to revise the review. This is just fine ... except if the last round of review has been completed.
The message telling reviewers to revise their reviews should not be sent after the last review deadline has passed."

So basically, When the student makes a new submission after the LAST review deadline has passed. The reviewer should not receive an email, asking the reviewer to update the review according to the new submission.

'''Actual Behavior'''

According to the current Code scenario on the beta branch '''''if the deadline has passed, a student(participant) cannot make new submissions'''''. So, automatically if the participant doe not make a new submission then the reviewer wont receive an email. So this issue does not really exist by the virtue of the state of the system.
the stack trace for the check if the submission is allowed or not is as follows -
assignment.rb
<pre>
def submission_allowed(topic_id = nil)
check_condition('submission_allowed_id', topic_id)
end
</pre>

assignment.rb
<pre>
def check_condition(column, topic_id = nil)
next_due_date = DueDate.get_next_due_date(self.id, topic_id)
return false if next_due_date.nil?
right_id = next_due_date.send column
right = DeadlineRight.find(right_id)
right && (right.name == 'OK' || right.name == 'Late')
end
</pre>

due_date.rb
<pre>
def self.get_next_due_date(assignment_id, topic_id = nil)
if Assignment.find(assignment_id).staggered_deadline?
next_due_date = TopicDueDate.find_by(['parent_id = ? and due_at >= ?', topic_id, Time.zone.now])
# if certion TopicDueDate is not exist, we should query next corresponding AssignmentDueDate.
# eg. Time.now is 08/28/2016
# One topic uses following deadlines:
# TopicDueDate 08/01/2016
# TopicDueDate 08/02/2016
# TopicDueDate 08/03/2016
# AssignmentDueDate 09/04/2016
# In this case, we cannot find due_at later than Time.now in TopicDueDate.
# So we should find next corrsponding AssignmentDueDate, starting with the 4th one, not the 1st one!
if next_due_date.nil?
topic_due_date_size = TopicDueDate.where(parent_id: topic_id).size
following_assignment_due_dates = AssignmentDueDate.where(parent_id: assignment_id)[topic_due_date_size..-1]
unless following_assignment_due_dates.nil?
following_assignment_due_dates.each do |assignment_due_date|
if assignment_due_date.due_at >= Time.zone.now
next_due_date = assignment_due_date
break
end
end
end
end
else
next_due_date = AssignmentDueDate.find_by(['parent_id = ? && due_at >= ?', assignment_id, Time.zone.now])
end
next_due_date
end
</pre>

So this is issue is resolved by the state of the system itself. 
'''''BUT Surprisingly on beta branch Reviewers aren't getting any emails at all'''''
on beta branch, in submitted_content_controller, in function "submit_file", this lines is supposed to send email to the reviewers to notify them about the new submission
<pre> participant.assignment.email(participant.id) rescue nil </pre>
''BUT'' here email function is undefined. we checked for email function in assignment class, there was none. The error "undefined function on assignment" is always rescued and hence no errors were raised previously and hence it wasn't highlighted before. 
So, in beta branch reviewers are not being notified anytime a new submission is made to an assignment that they have previously reviewed. So we fixed that
Taking inspiration from the Master branch the previous team's work we added following code to send an email notifying the reviewer of an new submission.

in submitted_content_controller.rb, in the functions, submit_file, submit_hyperlink
<pre>
Team.mail_assigned_reviewers(@participant)
</pre>

participant.rb

<pre>
def mail_assigned_reviewers()
team = self.team
maps = ResponseMap.where(reviewed_object_id: self.assignment.id, reviewee_id: team.id, type: 'ReviewResponseMap')
unless maps.nil?
maps.each do |map|
reviewer = User.find(Participant.find(map.reviewer_id).user_id)
Mailer.sync_message(
{
:to => reviewer.email,
subject: "Assignment '#{self.assignment.name}': A submission has been updated since you last reviewed it",
cc: User.find_by(self.assignment.instructor_id).email,
:body => {
:obj_name => self.assignment.name,
:link => "https://expertiza.ncsu.edu/response/new?id=#{map.id}",
:type => 'submission',
:first_name => ApplicationHelper::get_user_first_name(User.find(Participant.find(map.reviewer_id).user_id)),
:partial_name => 'updated_submission_since_review'
}
}
).deliver_now
end
end
end
</pre>

app/views/mailer/partials/_updated_submission_since_review_plain.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review.
Hence, to update your review please click on the following link.
<% if @link != nil %><%= @link %><% end %>
</pre>

app/views/mailer/partials/_updated_submission_since_review_html.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review. 
Hence, to update your review please click on the following link. 
<% if @link != nil %><a href="<%= @link %>"><%= @link %></a><% end %>

</pre>

added a line in app/mailers/mailer.rb
<pre>
@link = defn[:body][:link]
</pre>

----

==Issue3 (111) - Adding relevant links to reminder emails==

==Testing==
'''Testing Reviewe's Email manually'''

Step 1: Create new assignment [Manage --> Assignment --> + Button (to create new assignment)]

Step 2: Fill the details for the assignments.

Step 3: Navigate to due dates.

Step 4: Change the number of review rounds to 2.

Step 5: Select "Yes" in the dropdown for review allowed during submission and select "Yes" for submission during the review.

Step 6: Add two users to the assignment(author and reviewer).

Step 7: Log in with some user credentials (author credential).

Step 8: Make a new submission to this assignment.

Step 9: Log in with another user (reviewer).

Step 10: Submit a review of the assignment submission.

Step 11: Login as an author again.

Step 12: Edit the submission.

Step 13: After this check the mailbox of the reviewer [development mail for development].

Step 14: Reviewer should get the mail to re-review the work.

Step 15: Change the due date to some date and time which has passed.

Step 16: Now the author should not be able to make a new submission.

'''Testing Reviewe's Email via rspec'''

CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications

2021-10-21T02:41:49Z

Glbrook2: /* Issue1 (717) - Send new account welcome email to user, when imported from CSV through assignment page */

=E2142. Improve e-mail notifications=

==Brief Introduction==

* E2142. Improve e-mail notifications
* The forked repository can be found at: https://github.com/griffinbrookshire/expertiza

==Problem Statement==
The following tasks were accomplished in this project:

*Issue1: Send new account welcome email to user, when imported from CSV through assignment page.
*Issue2: Don't send email to reviewers for a new submission after review deadline has passed.
*Issue3: Adding relevant links to reminder emails.

==Issue1 (717) - Send new account welcome email to user, when imported from CSV through assignment page==

'''Pre conditions'''
* There exists an assignment and an instructor
* The instructor navigates to the 'Manage Assignments' page
* The instructor clicks 'Add Participants' for the existing assignment
* The instructor clicks 'Import assignment participants'
* The instructor imports a CSV file containing a user who does not exist yet

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/717 -
"When students' accounts are created by importing a CSV on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. Students should receive e-mails upon account creation, regardless of how their account is created."

So, when students accounts are created in any way, they should receive a welcome email. This includes adding them through importing a CSV.

'''Actual Behavior'''

This behavior was actually already implemented through one simple line in the expertiza/app/models/user.rb file. '''user.rb'''
<pre>
after_create :email_welcome
</pre>
This line calls the 'email_welcome' function every time a user is created, which sends a welcome email to the newly created user. '''user.rb'''
<pre>
# Function which has a MailerHelper which sends the mail welcome email to the user after signing up
def email_welcome
#this will send an account creation notification to user via email.
MailerHelper.send_mail_to_user(self, "Your Expertiza account and password has been created", "user_welcome", password).deliver_now
end
</pre>
This functionality is also completely tested in the expertiza/spec/models/assignment_participant_spec.rb file show below. This test shows that when the import function is called an email is delivered. '''assignment_participant_spec.rb'''
<pre>
context 'when new user needs to be created' do
let(:row) do
{name: 'no one', fullname: 'no one', email: 'name@email.com', role:'user_role_name', parent: 'user_parent_name'}
end
let(:attributes) do
{role_id: 1, name: 'no one', fullname: 'no one', email: 'name@email.com', email_on_submission: 'name@email.com',
email_on_review: 'name@email.com', email_on_review_of_review: 'name@email.com'}
end
let(:test_user) do
{name: 'abc', email: 'abcbbc@gmail.com'}
end
it 'create the user and number of mails sent should be 1' do
ActionMailer::Base.deliveries.clear
allow(ImportFileHelper).to receive(:define_attributes).with(row).and_return(attributes)
allow(ImportFileHelper).to receive(:create_new_user) do
test_user = User.new(name: 'abc', fullname: 'abc bbc', email: 'abcbbc@gmail.com')
test_user.id = 123
test_user.save!
test_user
end
#allow(ImportFileHelper).to receive(:create_new_user).with(attributes, {}).and_return()
allow(Assignment).to receive(:find).with(1).and_return(assignment)
allow(User).to receive(:exists?).with(name: 'no one').and_return(false)
allow(participant).to receive(:set_handle).and_return('handle')
allow(AssignmentParticipant).to receive(:exists?).and_return(false)
allow(AssignmentParticipant).to receive(:create).and_return(participant)
allow(AssignmentParticipant).to receive(:set_handle)
expect{(AssignmentParticipant.import(row, nil, {}, 1))}.to change { ActionMailer::Base.deliveries.count }.by(1)
end
end
</pre>

==Issue2 (345) - Don't send email to reviewers for a new submission after review deadline has passed==

'''Pre conditions'''
* There is an assignment, a student as a participant, a participant as a reviewer who is reviewing the this particular assignment
* a review is made for a submission by the student
* review deadline has passed
* the student is allowed to submit after the review deadline has passed

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/345 -
"Evidently, if a submission is revised after review, the system e-mails the reviewer saying to revise the review. This is just fine ... except if the last round of review has been completed.
The message telling reviewers to revise their reviews should not be sent after the last review deadline has passed."

So basically, When the student makes a new submission after the LAST review deadline has passed. The reviewer should not receive an email, asking the reviewer to update the review according to the new submission.

'''Actual Behavior'''

According to the current Code scenario on the beta branch '''''if the deadline has passed, a student(participant) cannot make new submissions'''''. So, automatically if the participant doe not make a new submission then the reviewer wont receive an email. So this issue does not really exist by the virtue of the state of the system.
the stack trace for the check if the submission is allowed or not is as follows -
assignment.rb
<pre>
def submission_allowed(topic_id = nil)
check_condition('submission_allowed_id', topic_id)
end
</pre>

assignment.rb
<pre>
def check_condition(column, topic_id = nil)
next_due_date = DueDate.get_next_due_date(self.id, topic_id)
return false if next_due_date.nil?
right_id = next_due_date.send column
right = DeadlineRight.find(right_id)
right && (right.name == 'OK' || right.name == 'Late')
end
</pre>

due_date.rb
<pre>
def self.get_next_due_date(assignment_id, topic_id = nil)
if Assignment.find(assignment_id).staggered_deadline?
next_due_date = TopicDueDate.find_by(['parent_id = ? and due_at >= ?', topic_id, Time.zone.now])
# if certion TopicDueDate is not exist, we should query next corresponding AssignmentDueDate.
# eg. Time.now is 08/28/2016
# One topic uses following deadlines:
# TopicDueDate 08/01/2016
# TopicDueDate 08/02/2016
# TopicDueDate 08/03/2016
# AssignmentDueDate 09/04/2016
# In this case, we cannot find due_at later than Time.now in TopicDueDate.
# So we should find next corrsponding AssignmentDueDate, starting with the 4th one, not the 1st one!
if next_due_date.nil?
topic_due_date_size = TopicDueDate.where(parent_id: topic_id).size
following_assignment_due_dates = AssignmentDueDate.where(parent_id: assignment_id)[topic_due_date_size..-1]
unless following_assignment_due_dates.nil?
following_assignment_due_dates.each do |assignment_due_date|
if assignment_due_date.due_at >= Time.zone.now
next_due_date = assignment_due_date
break
end
end
end
end
else
next_due_date = AssignmentDueDate.find_by(['parent_id = ? && due_at >= ?', assignment_id, Time.zone.now])
end
next_due_date
end
</pre>

So this is issue is resolved by the state of the system itself. 
'''''BUT Surprisingly on beta branch Reviewers aren't getting any emails at all'''''
on beta branch, in submitted_content_controller, in function "submit_file", this lines is supposed to send email to the reviewers to notify them about the new submission
<pre> participant.assignment.email(participant.id) rescue nil </pre>
''BUT'' here email function is undefined. we checked for email function in assignment class, there was none. The error "undefined function on assignment" is always rescued and hence no errors were raised previously and hence it wasn't highlighted before. 
So, in beta branch reviewers are not being notified anytime a new submission is made to an assignment that they have previously reviewed. So we fixed that
Taking inspiration from the Master branch the previous team's work we added following code to send an email notifying the reviewer of an new submission.

in submitted_content_controller.rb, in the functions, submit_file, submit_hyperlink
<pre>
Team.mail_assigned_reviewers(@participant)
</pre>

participant.rb

<pre>
def mail_assigned_reviewers()
team = self.team
maps = ResponseMap.where(reviewed_object_id: self.assignment.id, reviewee_id: team.id, type: 'ReviewResponseMap')
unless maps.nil?
maps.each do |map|
reviewer = User.find(Participant.find(map.reviewer_id).user_id)
Mailer.sync_message(
{
:to => reviewer.email,
subject: "Assignment '#{self.assignment.name}': A submission has been updated since you last reviewed it",
cc: User.find_by(self.assignment.instructor_id).email,
:body => {
:obj_name => self.assignment.name,
:link => "https://expertiza.ncsu.edu/response/new?id=#{map.id}",
:type => 'submission',
:first_name => ApplicationHelper::get_user_first_name(User.find(Participant.find(map.reviewer_id).user_id)),
:partial_name => 'updated_submission_since_review'
}
}
).deliver_now
end
end
end
</pre>

app/views/mailer/partials/_updated_submission_since_review_plain.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review.
Hence, to update your review please click on the following link.
<% if @link != nil %><%= @link %><% end %>
</pre>

app/views/mailer/partials/_updated_submission_since_review_html.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review. 
Hence, to update your review please click on the following link. 
<% if @link != nil %><a href="<%= @link %>"><%= @link %></a><% end %>

</pre>

added a line in app/mailers/mailer.rb
<pre>
@link = defn[:body][:link]
</pre>

----

==Issue3 (111) - Adding relevant links to reminder emails==

==Testing==
'''Testing Reviewe's Email manually'''

Step 1: Create new assignment [Manage --> Assignment --> + Button (to create new assignment)]

Step 2: Fill the details for the assignments.

Step 3: Navigate to due dates.

Step 4: Change the number of review rounds to 2.

Step 5: Select "Yes" in the dropdown for review allowed during submission and select "Yes" for submission during the review.

Step 6: Add two users to the assignment(author and reviewer).

Step 7: Log in with some user credentials (author credential).

Step 8: Make a new submission to this assignment.

Step 9: Log in with another user (reviewer).

Step 10: Submit a review of the assignment submission.

Step 11: Login as an author again.

Step 12: Edit the submission.

Step 13: After this check the mailbox of the reviewer [development mail for development].

Step 14: Reviewer should get the mail to re-review the work.

Step 15: Change the due date to some date and time which has passed.

Step 16: Now the author should not be able to make a new submission.

'''Testing Reviewe's Email via rspec'''

CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications

2021-10-21T02:41:21Z

Glbrook2: /* Issue1 (717) - Send new account welcome email to user, when imported from CSV through assignment page */

=E2142. Improve e-mail notifications=

==Brief Introduction==

* E2142. Improve e-mail notifications
* The forked repository can be found at: https://github.com/griffinbrookshire/expertiza

==Problem Statement==
The following tasks were accomplished in this project:

*Issue1: Send new account welcome email to user, when imported from CSV through assignment page.
*Issue2: Don't send email to reviewers for a new submission after review deadline has passed.
*Issue3: Adding relevant links to reminder emails.

==Issue1 (717) - Send new account welcome email to user, when imported from CSV through assignment page==

'''Pre conditions'''
* There exists an assignment and an instructor
* The instructor navigates to the 'Manage Assignments' page
* The instructor clicks 'Add Participants' for the existing assignment
* The instructor clicks 'Import assignment participants'
* The instructor imports a CSV file containing a user who does not exist yet

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/717 -
"When students' accounts are created by importing a CSV on the Users page, they receive e-mails with their user-ID and password. But if an account is created by adding them as participants to an assignment when they don't already have an account, e-mail is not sent. Students should receive e-mails upon account creation, regardless of how their account is created."

So, when students accounts are created in any way, they should receive a welcome email. This includes adding them through importing a CSV.

'''Actual Behavior'''

This behavior was actually already implemented through one simple line in the expertiza/app/models/user.rb file. '''user.rb'''
<pre>
after_create :email_welcome
</pre>
This line calls the 'email_welcome' function every time a user is created, which sends a welcome email to the newly created user. '''user.rb'''
<pre>
# Function which has a MailerHelper which sends the mail welcome email to the user after signing up
def email_welcome
#this will send an account creation notification to user via email.
MailerHelper.send_mail_to_user(self, "Your Expertiza account and password has been created", "user_welcome", password).deliver_now
end
</pre>
This functionality is also completely tested in the expertiza/spec/models/assignment_participant_spec.rb file show below. This test shows that when the import function is called an email is delivered. '''assignment_participant_spec.rb'''
<pre>
context 'when new user needs to be created' do
let(:row) do
{name: 'no one', fullname: 'no one', email: 'name@email.com', role:'user_role_name', parent: 'user_parent_name'}
end
let(:attributes) do
{role_id: 1, name: 'no one', fullname: 'no one', email: 'name@email.com', email_on_submission: 'name@email.com',
email_on_review: 'name@email.com', email_on_review_of_review: 'name@email.com'}
end
let(:test_user) do
{name: 'abc', email: 'abcbbc@gmail.com'}
end
it 'create the user and number of mails sent should be 1' do
ActionMailer::Base.deliveries.clear
allow(ImportFileHelper).to receive(:define_attributes).with(row).and_return(attributes)
allow(ImportFileHelper).to receive(:create_new_user) do
test_user = User.new(name: 'abc', fullname: 'abc bbc', email: 'abcbbc@gmail.com')
test_user.id = 123
test_user.save!
test_user
end
#allow(ImportFileHelper).to receive(:create_new_user).with(attributes, {}).and_return()
allow(Assignment).to receive(:find).with(1).and_return(assignment)
allow(User).to receive(:exists?).with(name: 'no one').and_return(false)
allow(participant).to receive(:set_handle).and_return('handle')
allow(AssignmentParticipant).to receive(:exists?).and_return(false)
allow(AssignmentParticipant).to receive(:create).and_return(participant)
allow(AssignmentParticipant).to receive(:set_handle)
expect{(AssignmentParticipant.import(row, nil, {}, 1))}.to change { ActionMailer::Base.deliveries.count }.by(1)
end
end
</pre>

==Issue2 (345) - Don't send email to reviewers for a new submission after review deadline has passed==

'''Pre conditions'''
* There is an assignment, a student as a participant, a participant as a reviewer who is reviewing the this particular assignment
* a review is made for a submission by the student
* review deadline has passed
* the student is allowed to submit after the review deadline has passed

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/345 -
"Evidently, if a submission is revised after review, the system e-mails the reviewer saying to revise the review. This is just fine ... except if the last round of review has been completed.
The message telling reviewers to revise their reviews should not be sent after the last review deadline has passed."

So basically, When the student makes a new submission after the LAST review deadline has passed. The reviewer should not receive an email, asking the reviewer to update the review according to the new submission.

'''Actual Behavior'''

According to the current Code scenario on the beta branch '''''if the deadline has passed, a student(participant) cannot make new submissions'''''. So, automatically if the participant doe not make a new submission then the reviewer wont receive an email. So this issue does not really exist by the virtue of the state of the system.
the stack trace for the check if the submission is allowed or not is as follows -
assignment.rb
<pre>
def submission_allowed(topic_id = nil)
check_condition('submission_allowed_id', topic_id)
end
</pre>

assignment.rb
<pre>
def check_condition(column, topic_id = nil)
next_due_date = DueDate.get_next_due_date(self.id, topic_id)
return false if next_due_date.nil?
right_id = next_due_date.send column
right = DeadlineRight.find(right_id)
right && (right.name == 'OK' || right.name == 'Late')
end
</pre>

due_date.rb
<pre>
def self.get_next_due_date(assignment_id, topic_id = nil)
if Assignment.find(assignment_id).staggered_deadline?
next_due_date = TopicDueDate.find_by(['parent_id = ? and due_at >= ?', topic_id, Time.zone.now])
# if certion TopicDueDate is not exist, we should query next corresponding AssignmentDueDate.
# eg. Time.now is 08/28/2016
# One topic uses following deadlines:
# TopicDueDate 08/01/2016
# TopicDueDate 08/02/2016
# TopicDueDate 08/03/2016
# AssignmentDueDate 09/04/2016
# In this case, we cannot find due_at later than Time.now in TopicDueDate.
# So we should find next corrsponding AssignmentDueDate, starting with the 4th one, not the 1st one!
if next_due_date.nil?
topic_due_date_size = TopicDueDate.where(parent_id: topic_id).size
following_assignment_due_dates = AssignmentDueDate.where(parent_id: assignment_id)[topic_due_date_size..-1]
unless following_assignment_due_dates.nil?
following_assignment_due_dates.each do |assignment_due_date|
if assignment_due_date.due_at >= Time.zone.now
next_due_date = assignment_due_date
break
end
end
end
end
else
next_due_date = AssignmentDueDate.find_by(['parent_id = ? && due_at >= ?', assignment_id, Time.zone.now])
end
next_due_date
end
</pre>

So this is issue is resolved by the state of the system itself. 
'''''BUT Surprisingly on beta branch Reviewers aren't getting any emails at all'''''
on beta branch, in submitted_content_controller, in function "submit_file", this lines is supposed to send email to the reviewers to notify them about the new submission
<pre> participant.assignment.email(participant.id) rescue nil </pre>
''BUT'' here email function is undefined. we checked for email function in assignment class, there was none. The error "undefined function on assignment" is always rescued and hence no errors were raised previously and hence it wasn't highlighted before. 
So, in beta branch reviewers are not being notified anytime a new submission is made to an assignment that they have previously reviewed. So we fixed that
Taking inspiration from the Master branch the previous team's work we added following code to send an email notifying the reviewer of an new submission.

in submitted_content_controller.rb, in the functions, submit_file, submit_hyperlink
<pre>
Team.mail_assigned_reviewers(@participant)
</pre>

participant.rb

<pre>
def mail_assigned_reviewers()
team = self.team
maps = ResponseMap.where(reviewed_object_id: self.assignment.id, reviewee_id: team.id, type: 'ReviewResponseMap')
unless maps.nil?
maps.each do |map|
reviewer = User.find(Participant.find(map.reviewer_id).user_id)
Mailer.sync_message(
{
:to => reviewer.email,
subject: "Assignment '#{self.assignment.name}': A submission has been updated since you last reviewed it",
cc: User.find_by(self.assignment.instructor_id).email,
:body => {
:obj_name => self.assignment.name,
:link => "https://expertiza.ncsu.edu/response/new?id=#{map.id}",
:type => 'submission',
:first_name => ApplicationHelper::get_user_first_name(User.find(Participant.find(map.reviewer_id).user_id)),
:partial_name => 'updated_submission_since_review'
}
}
).deliver_now
end
end
end
</pre>

app/views/mailer/partials/_updated_submission_since_review_plain.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review.
Hence, to update your review please click on the following link.
<% if @link != nil %><%= @link %><% end %>
</pre>

app/views/mailer/partials/_updated_submission_since_review_html.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review. 
Hence, to update your review please click on the following link. 
<% if @link != nil %><a href="<%= @link %>"><%= @link %></a><% end %>

</pre>

added a line in app/mailers/mailer.rb
<pre>
@link = defn[:body][:link]
</pre>

----

==Issue3 (111) - Adding relevant links to reminder emails==

==Testing==
'''Testing Reviewe's Email manually'''

Step 1: Create new assignment [Manage --> Assignment --> + Button (to create new assignment)]

Step 2: Fill the details for the assignments.

Step 3: Navigate to due dates.

Step 4: Change the number of review rounds to 2.

Step 5: Select "Yes" in the dropdown for review allowed during submission and select "Yes" for submission during the review.

Step 6: Add two users to the assignment(author and reviewer).

Step 7: Log in with some user credentials (author credential).

Step 8: Make a new submission to this assignment.

Step 9: Log in with another user (reviewer).

Step 10: Submit a review of the assignment submission.

Step 11: Login as an author again.

Step 12: Edit the submission.

Step 13: After this check the mailbox of the reviewer [development mail for development].

Step 14: Reviewer should get the mail to re-review the work.

Step 15: Change the due date to some date and time which has passed.

Step 16: Now the author should not be able to make a new submission.

'''Testing Reviewe's Email via rspec'''

CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications

2021-10-21T02:38:23Z

Glbrook2: /* Issue1 (717) - Send new account welcome email to user, when imported from CSV through assignment page */

CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications

2021-10-21T02:32:29Z

Glbrook2: /* Issue1 (717) - Send new account welcome email to user, when imported from CSV through assignment page */

CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications

2021-10-21T02:32:15Z

Glbrook2: /* Issue1 (717) - Send new account welcome email to user, when imported from CSV through assignment page */

CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications

2021-10-21T02:31:02Z

Glbrook2: /* E2142. Improve e-mail notifications */

CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications

2021-10-21T02:29:55Z

Glbrook2: /* E2142. Improve e-mail notifications */

CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications

2021-10-21T02:28:05Z

Glbrook2: /* Issue1 (717) - Send new account welcome email to user, when imported from CSV through assignment page */

CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications

2021-10-21T02:27:05Z

Glbrook2: /* Issue1 (717) - Send new account welcome email to user, when imported from CSV through assignment page */

CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications

2021-10-21T02:22:49Z

Glbrook2: /* E2142. Improve e-mail notifications */

CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications

2021-10-21T02:03:29Z

Glbrook2: /* E2142. Improve e-mail notifications */

CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications

2021-10-21T01:54:34Z

Glbrook2: /* E2142. Improve e-mail notifications */

CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications

2021-10-21T01:52:18Z

Glbrook2: /* E2142. Improve e-mail notifications */

=E2142. Improve e-mail notifications=

==Brief Introduction==

* E2142. Improve e-mail notifications
* The forked repository can be found at: https://github.com/griffinbrookshire/expertiza

== Issue - Don't send email to reviewers for a new submission after the review deadline has passed ==

'''Pre conditions'''
* There is an assignment, a student as a participant, a participant as a reviewer who is reviewing the this particular assignment
* a review is made for a submission by the student
* review deadline has passed
* the student is allowed to submit after the review deadline has passed

'''Expected Behavior'''

Exact issue stating the expected behavior can be found at https://github.com/expertiza/expertiza/issues/345 -
"Evidently, if a submission is revised after review, the system e-mails the reviewer saying to revise the review. This is just fine ... except if the last round of review has been completed.
The message telling reviewers to revise their reviews should not be sent after the last review deadline has passed."

So basically, When the student makes a new submission after the LAST review deadline has passed. The reviewer should not receive an email, asking the reviewer to update the review according to the new submission.

'''Actual Behavior'''

According to the current Code scenario on the beta branch '''''if the deadline has passed, a student(participant) cannot make new submissions'''''. So, automatically if the participant doe not make a new submission then the reviewer wont receive an email. So this issue does not really exist by the virtue of the state of the system.
the stack trace for the check if the submission is allowed or not is as follows -
assignment.rb
<pre>
def submission_allowed(topic_id = nil)
check_condition('submission_allowed_id', topic_id)
end
</pre>

assignment.rb
<pre>
def check_condition(column, topic_id = nil)
next_due_date = DueDate.get_next_due_date(self.id, topic_id)
return false if next_due_date.nil?
right_id = next_due_date.send column
right = DeadlineRight.find(right_id)
right && (right.name == 'OK' || right.name == 'Late')
end
</pre>

due_date.rb
<pre>
def self.get_next_due_date(assignment_id, topic_id = nil)
if Assignment.find(assignment_id).staggered_deadline?
next_due_date = TopicDueDate.find_by(['parent_id = ? and due_at >= ?', topic_id, Time.zone.now])
# if certion TopicDueDate is not exist, we should query next corresponding AssignmentDueDate.
# eg. Time.now is 08/28/2016
# One topic uses following deadlines:
# TopicDueDate 08/01/2016
# TopicDueDate 08/02/2016
# TopicDueDate 08/03/2016
# AssignmentDueDate 09/04/2016
# In this case, we cannot find due_at later than Time.now in TopicDueDate.
# So we should find next corrsponding AssignmentDueDate, starting with the 4th one, not the 1st one!
if next_due_date.nil?
topic_due_date_size = TopicDueDate.where(parent_id: topic_id).size
following_assignment_due_dates = AssignmentDueDate.where(parent_id: assignment_id)[topic_due_date_size..-1]
unless following_assignment_due_dates.nil?
following_assignment_due_dates.each do |assignment_due_date|
if assignment_due_date.due_at >= Time.zone.now
next_due_date = assignment_due_date
break
end
end
end
end
else
next_due_date = AssignmentDueDate.find_by(['parent_id = ? && due_at >= ?', assignment_id, Time.zone.now])
end
next_due_date
end
</pre>

So this is issue is resolved by the state of the system itself. 
'''''BUT Surprisingly on beta branch Reviewers aren't getting any emails at all'''''
on beta branch, in submitted_content_controller, in function "submit_file", this lines is supposed to send email to the reviewers to notify them about the new submission
<pre> participant.assignment.email(participant.id) rescue nil </pre>
''BUT'' here email function is undefined. we checked for email function in assignment class, there was none. The error "undefined function on assignment" is always rescued and hence no errors were raised previously and hence it wasn't highlighted before. 
So, in beta branch reviewers are not being notified anytime a new submission is made to an assignment that they have previously reviewed. So we fixed that
Taking inspiration from the Master branch the previous team's work we added following code to send an email notifying the reviewer of an new submission.

in submitted_content_controller.rb, in the functions, submit_file, submit_hyperlink
<pre>
Team.mail_assigned_reviewers(@participant)
</pre>

participant.rb

<pre>
def mail_assigned_reviewers()
team = self.team
maps = ResponseMap.where(reviewed_object_id: self.assignment.id, reviewee_id: team.id, type: 'ReviewResponseMap')
unless maps.nil?
maps.each do |map|
reviewer = User.find(Participant.find(map.reviewer_id).user_id)
Mailer.sync_message(
{
:to => reviewer.email,
subject: "Assignment '#{self.assignment.name}': A submission has been updated since you last reviewed it",
cc: User.find_by(self.assignment.instructor_id).email,
:body => {
:obj_name => self.assignment.name,
:link => "https://expertiza.ncsu.edu/response/new?id=#{map.id}",
:type => 'submission',
:first_name => ApplicationHelper::get_user_first_name(User.find(Participant.find(map.reviewer_id).user_id)),
:partial_name => 'updated_submission_since_review'
}
}
).deliver_now
end
end
end
</pre>

app/views/mailer/partials/_updated_submission_since_review_plain.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review.
Hence, to update your review please click on the following link.
<% if @link != nil %><%= @link %><% end %>
</pre>

app/views/mailer/partials/_updated_submission_since_review_html.html.erb
<pre>
Hi <%= @first_name %>,

A <%=@type%> you were reviewing for Assignment '<%= @obj_name %>' has been updated since you last review. 
Hence, to update your review please click on the following link. 
<% if @link != nil %><a href="<%= @link %>"><%= @link %></a><% end %>

</pre>

added a line in app/mailers/mailer.rb
<pre>
@link = defn[:body][:link]
</pre>

----

==Testing==
'''Testing Reviewe's Email manually'''

Step 1: Create new assignment [Manage --> Assignment --> + Button (to create new assignment)]

Step 2: Fill the details for the assignments.

Step 3: Navigate to due dates.

Step 4: Change the number of review rounds to 2.

Step 5: Select "Yes" in the dropdown for review allowed during submission and select "Yes" for submission during the review.

Step 6: Add two users to the assignment(author and reviewer).

Step 7: Log in with some user credentials (author credential).

Step 8: Make a new submission to this assignment.

Step 9: Log in with another user (reviewer).

Step 10: Submit a review of the assignment submission.

Step 11: Login as an author again.

Step 12: Edit the submission.

Step 13: After this check the mailbox of the reviewer [development mail for development].

Step 14: Reviewer should get the mail to re-review the work.

Step 15: Change the due date to some date and time which has passed.

Step 16: Now the author should not be able to make a new submission.

'''Testing Reviewe's Email via rspec'''