[#11755] 'Session closing soon' email: highlight 'No action is requir…

…ed if you have already submitted' (#11897)
TEAMMATES · Jul 23, 2022 · 46979fb · 46979fb
1 parent e3e910a
commit 46979fb
Show file tree

Hide file tree

Showing 15 changed files with 101 additions and 35 deletions.
diff --git a/src/main/java/teammates/common/util/Templates.java b/src/main/java/teammates/common/util/Templates.java
@@ -52,6 +52,8 @@ public static class EmailTemplates {
                 FileHelper.readResourceFile("instructorEmailFragment-registrationKeyReset.html");
         public static final String USER_FEEDBACK_SESSION =
                 FileHelper.readResourceFile("userEmailTemplate-feedbackSession.html");
+        public static final String USER_FEEDBACK_SESSION_OPENING =
+                FileHelper.readResourceFile("userEmailTemplate-feedbackSessionOpening.html");
         public static final String USER_FEEDBACK_SESSION_PUBLISHED =
                 FileHelper.readResourceFile("userEmailTemplate-feedbackSessionPublished.html");
         public static final String FRAGMENT_SESSION_LINKS_RECOVERY_ACCESS_LINKS_BY_SESSION =

diff --git a/src/main/java/teammates/logic/api/EmailGenerator.java b/src/main/java/teammates/logic/api/EmailGenerator.java
@@ -37,19 +37,22 @@
  * @see EmailWrapper
  */
 public final class EmailGenerator {
+    // feedback action strings
+    private static final String FEEDBACK_ACTION_SUBMIT_EDIT_OR_VIEW = "submit, edit or view";
+    private static final String FEEDBACK_ACTION_VIEW = "view";
+    private static final String FEEDBACK_ACTION_SUBMIT_OR_UPDATE =
+                            ", in case you have not submitted yet or wish to update your submission. ";
+    private static final String HTML_NO_ACTION_REQUIRED = "<mark>No action is required if you have already submitted</mark>";
+
     // status-related strings
-    private static final String FEEDBACK_STATUS_SESSION_OPEN = "is still open for submissions";
+    private static final String FEEDBACK_STATUS_SESSION_OPEN = "is still open for submissions"
+                                        + FEEDBACK_ACTION_SUBMIT_OR_UPDATE + HTML_NO_ACTION_REQUIRED;
     private static final String FEEDBACK_STATUS_SESSION_OPENING = "is now open";
-    private static final String FEEDBACK_STATUS_SESSION_CLOSING = "is closing soon";
+    private static final String FEEDBACK_STATUS_SESSION_CLOSING = "is closing soon"
+                                        + FEEDBACK_ACTION_SUBMIT_OR_UPDATE + HTML_NO_ACTION_REQUIRED;
     private static final String FEEDBACK_STATUS_SESSION_CLOSED = "is now closed for submission";
     private static final String FEEDBACK_STATUS_SESSION_OPENING_SOON = "is due to open soon";
 
-    // feedback action strings
-    private static final String FEEDBACK_ACTION_SUBMIT_EDIT_OR_VIEW = "submit, edit or view";
-    private static final String FEEDBACK_ACTION_VIEW = "view";
-    private static final String HTML_NO_ACTION_REQUIRED =
-            "<p>No action is required if you have already submitted.</p>" + System.lineSeparator();
-
     private static final String DATETIME_DISPLAY_FORMAT = "EEE, dd MMM yyyy, hh:mm a z";
 
     private static final long SESSION_LINK_RECOVERY_DURATION_IN_DAYS = 90;
@@ -107,7 +110,10 @@ private List<EmailWrapper> generateFeedbackSessionOpeningOrClosingEmails(
                 ? FEEDBACK_STATUS_SESSION_OPENING
                 : FEEDBACK_STATUS_SESSION_CLOSING;
 
-        String template = EmailTemplates.USER_FEEDBACK_SESSION.replace("${status}", status);
+        String template = emailType == EmailType.FEEDBACK_OPENING
+                ? EmailTemplates.USER_FEEDBACK_SESSION_OPENING.replace("${status}", status)
+                : EmailTemplates.USER_FEEDBACK_SESSION.replace("${status}", status);
+
         return generateFeedbackSessionEmailBases(course, session, students, instructors, instructorsToNotify, template,
                 emailType, FEEDBACK_ACTION_SUBMIT_EDIT_OR_VIEW);
     }
@@ -695,10 +701,6 @@ private List<EmailWrapper> generateFeedbackSessionEmailBases(
             EmailType type, String feedbackAction) {
         StringBuilder studentAdditionalContactBuilder = new StringBuilder();
         StringBuilder instructorAdditionalContactBuilder = new StringBuilder();
-        if (type == EmailType.FEEDBACK_CLOSING || type == EmailType.FEEDBACK_SESSION_REMINDER) {
-            studentAdditionalContactBuilder.append(HTML_NO_ACTION_REQUIRED);
-            instructorAdditionalContactBuilder.append(HTML_NO_ACTION_REQUIRED);
-        }
         studentAdditionalContactBuilder.append(getAdditionalContactInformationFragment(course, false));
         instructorAdditionalContactBuilder.append(getAdditionalContactInformationFragment(course, true));
 

diff --git a/src/main/resources/userEmailTemplate-feedbackSession.html b/src/main/resources/userEmailTemplate-feedbackSession.html
@@ -3,7 +3,7 @@
 ${instructorPreamble}
 
 <p>
-  The following feedback session ${status}.
+  Just a gentle reminder that the following feedback session ${status}.
   <div>
     <table style="max-width:600px;border:1px solid black;">
       <tr>

diff --git a/src/main/resources/userEmailTemplate-feedbackSessionOpening.html b/src/main/resources/userEmailTemplate-feedbackSessionOpening.html
@@ -0,0 +1,73 @@
+<p>Hello ${userName},</p>
+
+${instructorPreamble}
+
+<p>
+  The following feedback session ${status}.
+  <div>
+    <table style="max-width:600px;border:1px solid black;">
+      <tr>
+        <td style="padding:5px;">
+          <strong>
+            Course:
+          </strong>
+        </td>
+        <td style="padding:5px;">
+          [${courseId}] ${courseName}
+        </td>
+      </tr>
+
+      <tr>
+        <td style="padding:5px;">
+          <strong>
+            Feedback Session Name:
+          </strong>
+        </td>
+        <td style="padding:5px;">
+          ${feedbackSessionName}
+        </td>
+      </tr>
+
+      <tr>
+        <td style="padding:5px;">
+          <strong>
+            Deadline:
+          </strong>
+        </td>
+        <td style="padding:5px;">
+          ${deadline}
+        </td>
+      </tr>
+
+      <tr>
+        <td style="padding:5px;vertical-align:top">
+          <strong>
+            Session Instructions:
+          </strong>
+        </td>
+        <td style="padding:5px;">
+          ${sessionInstructions}
+        </td>
+      </tr>
+    </table>
+  </div>
+  <ul>
+    <li>
+      <strong>To ${feedbackAction} your feedback for the above session, please go to this Web address: </strong>
+      <a href="${submitUrl}">${submitUrl}</a>
+    </li>
+    <li>
+      The above link is unique to you. Please do not share it with others.
+    </li>
+    <li>
+      After submitting, you are encouraged to download the proof of submission, which will contain your latest responses.
+    </li>
+  </ul>
+</p>
+
+${additionalContactInformation}
+
+<p>
+  Regards,
+  <br>TEAMMATES Team.
+</p>
diff --git a/src/test/java/teammates/logic/api/EmailGeneratorTest.java b/src/test/java/teammates/logic/api/EmailGeneratorTest.java
@@ -767,5 +767,4 @@ private void verifyEmailReceivedCorrectly(
         }
         assertTrue(hasReceivedEmailCorrectly);
     }
-
 }
diff --git a/src/test/resources/emails/sessionClosingEmailCopyToInstructor.html b/src/test/resources/emails/sessionClosingEmailCopyToInstructor.html
@@ -7,7 +7,7 @@
 </p>
 
 <p>
-  The following feedback session is closing soon.
+  Just a gentle reminder that the following feedback session is closing soon, in case you have not submitted yet or wish to update your submission. <mark>No action is required if you have already submitted</mark>.
   <div>
     <table style="max-width:600px;border:1px solid black;">
       <tr>
@@ -69,7 +69,6 @@
   </ul>
 </p>
 
-<p>No action is required if you have already submitted.</p>
 <p>
   <ul>
     <li>

diff --git a/src/test/resources/emails/sessionClosingEmailForInstructor.html b/src/test/resources/emails/sessionClosingEmailForInstructor.html
@@ -3,7 +3,7 @@
 
 
 <p>
-  The following feedback session is closing soon.
+  Just a gentle reminder that the following feedback session is closing soon, in case you have not submitted yet or wish to update your submission. <mark>No action is required if you have already submitted</mark>.
   <div>
     <table style="max-width:600px;border:1px solid black;">
       <tr>
@@ -65,7 +65,6 @@
   </ul>
 </p>
 
-<p>No action is required if you have already submitted.</p>
 <p>
   <ul>
     <li>

diff --git a/src/test/resources/emails/sessionClosingEmailForInstructorWithExtension.html b/src/test/resources/emails/sessionClosingEmailForInstructorWithExtension.html
@@ -3,7 +3,7 @@
 
 
 <p>
-  The following feedback session is closing soon.
+  Just a gentle reminder that the following feedback session is closing soon, in case you have not submitted yet or wish to update your submission. <mark>No action is required if you have already submitted</mark>.
   <div>
     <table style="max-width:600px;border:1px solid black;">
       <tr>
@@ -65,7 +65,6 @@
   </ul>
 </p>
 
-<p>No action is required if you have already submitted.</p>
 <p>
   <ul>
     <li>

diff --git a/src/test/resources/emails/sessionClosingEmailForStudent.html b/src/test/resources/emails/sessionClosingEmailForStudent.html
@@ -3,7 +3,7 @@
 
 
 <p>
-  The following feedback session is closing soon.
+  Just a gentle reminder that the following feedback session is closing soon, in case you have not submitted yet or wish to update your submission. <mark>No action is required if you have already submitted</mark>.
   <div>
     <table style="max-width:600px;border:1px solid black;">
       <tr>
@@ -65,7 +65,6 @@
   </ul>
 </p>
 
-<p>No action is required if you have already submitted.</p>
 <p>
   <ul>
     <li>

diff --git a/src/test/resources/emails/sessionClosingEmailForStudentWithExtension.html b/src/test/resources/emails/sessionClosingEmailForStudentWithExtension.html
@@ -3,7 +3,7 @@
 
 
 <p>
-  The following feedback session is closing soon.
+  Just a gentle reminder that the following feedback session is closing soon, in case you have not submitted yet or wish to update your submission. <mark>No action is required if you have already submitted</mark>.
   <div>
     <table style="max-width:600px;border:1px solid black;">
       <tr>
@@ -65,7 +65,6 @@
   </ul>
 </p>
 
-<p>No action is required if you have already submitted.</p>
 <p>
   <ul>
     <li>

diff --git a/src/test/resources/emails/sessionClosingEmailTestingSanitizationCopyToInstructor.html b/src/test/resources/emails/sessionClosingEmailTestingSanitizationCopyToInstructor.html
@@ -7,7 +7,7 @@
 </p>
 
 <p>
-  The following feedback session is closing soon.
+  Just a gentle reminder that the following feedback session is closing soon, in case you have not submitted yet or wish to update your submission. <mark>No action is required if you have already submitted</mark>.
   <div>
     <table style="max-width:600px;border:1px solid black;">
       <tr>
@@ -69,7 +69,6 @@
   </ul>
 </p>
 
-<p>No action is required if you have already submitted.</p>
 <p>
   <ul>
     <li>

diff --git a/src/test/resources/emails/sessionClosingEmailTestingSanitizationForStudent.html b/src/test/resources/emails/sessionClosingEmailTestingSanitizationForStudent.html
@@ -3,7 +3,7 @@
 
 
 <p>
-  The following feedback session is closing soon.
+  Just a gentle reminder that the following feedback session is closing soon, in case you have not submitted yet or wish to update your submission. <mark>No action is required if you have already submitted</mark>.
   <div>
     <table style="max-width:600px;border:1px solid black;">
       <tr>
@@ -65,7 +65,6 @@
   </ul>
 </p>
 
-<p>No action is required if you have already submitted.</p>
 <p>
   <ul>
     <li>

diff --git a/src/test/resources/emails/sessionReminderEmailCopyToInstructor.html b/src/test/resources/emails/sessionReminderEmailCopyToInstructor.html
@@ -7,7 +7,7 @@
 </p>
 
 <p>
-  The following feedback session is still open for submissions.
+  Just a gentle reminder that the following feedback session is still open for submissions, in case you have not submitted yet or wish to update your submission. <mark>No action is required if you have already submitted</mark>.
   <div>
     <table style="max-width:600px;border:1px solid black;">
       <tr>
@@ -69,7 +69,6 @@
   </ul>
 </p>
 
-<p>No action is required if you have already submitted.</p>
 <p>
   <ul>
     <li>

diff --git a/src/test/resources/emails/sessionReminderEmailForInstructor.html b/src/test/resources/emails/sessionReminderEmailForInstructor.html
@@ -3,7 +3,7 @@
 
 
 <p>
-  The following feedback session is still open for submissions.
+  Just a gentle reminder that the following feedback session is still open for submissions, in case you have not submitted yet or wish to update your submission. <mark>No action is required if you have already submitted</mark>.
   <div>
     <table style="max-width:600px;border:1px solid black;">
       <tr>
@@ -65,7 +65,6 @@
   </ul>
 </p>
 
-<p>No action is required if you have already submitted.</p>
 <p>
   <ul>
     <li>

diff --git a/src/test/resources/emails/sessionReminderEmailForStudent.html b/src/test/resources/emails/sessionReminderEmailForStudent.html
@@ -3,7 +3,7 @@
 
 
 <p>
-  The following feedback session is still open for submissions.
+  Just a gentle reminder that the following feedback session is still open for submissions, in case you have not submitted yet or wish to update your submission. <mark>No action is required if you have already submitted</mark>.
   <div>
     <table style="max-width:600px;border:1px solid black;">
       <tr>
@@ -65,7 +65,6 @@
   </ul>
 </p>
 
-<p>No action is required if you have already submitted.</p>
 <p>
   <ul>
     <li>