[#11039] [#10677] [#9083] Remove fake google ID in sample students + …

…add migration scripts (#11322)

src/client/java/teammates/client/scripts/DataMigrationForConstSumForceUnevenDistribution.java

@@ -0,0 +1,58 @@
+package teammates.client.scripts;
+
+import java.io.IOException;
+
+import com.googlecode.objectify.cmd.Query;
+
+import teammates.common.datatransfer.attributes.FeedbackQuestionAttributes;
+import teammates.common.datatransfer.questions.FeedbackConstantSumDistributePointsType;
+import teammates.common.datatransfer.questions.FeedbackConstantSumQuestionDetails;
+import teammates.common.datatransfer.questions.FeedbackQuestionType;
+import teammates.storage.entity.FeedbackQuestion;
+
+/**
+ * Script to set distributePointsFor to DISTRIBUTE_ALL_UNEVENLY if forceUnevenDistribution is true.
+ *
+ * <p>See issue #8577.
+ */
+public class DataMigrationForConstSumForceUnevenDistribution extends
+        DataMigrationEntitiesBaseScript<FeedbackQuestion> {
+
+    public static void main(String[] args) throws IOException {
+        new DataMigrationForConstSumForceUnevenDistribution().doOperationRemotely();
+    }
+
+    @Override
+    protected Query<FeedbackQuestion> getFilterQuery() {
+        return ofy().load().type(FeedbackQuestion.class)
+                .filter("questionType =", FeedbackQuestionType.CONSTSUM.name());
+    }
+
+    @Override
+    protected boolean isPreview() {
+        return true;
+    }
+
+    @Override
+    protected boolean isMigrationNeeded(FeedbackQuestion question) {
+        FeedbackQuestionAttributes fqa = FeedbackQuestionAttributes.valueOf(question);
+        FeedbackConstantSumQuestionDetails fcsqd = (FeedbackConstantSumQuestionDetails) fqa.getQuestionDetails();
+
+        return fcsqd.isForceUnevenDistribution()
+                && FeedbackConstantSumDistributePointsType.NONE.getDisplayedOption().equals(fcsqd.getDistributePointsFor());
+    }
+
+    @Override
+    protected void migrateEntity(FeedbackQuestion question) {
+        FeedbackQuestionAttributes fqa = FeedbackQuestionAttributes.valueOf(question);
+        FeedbackConstantSumQuestionDetails fcsqd = (FeedbackConstantSumQuestionDetails) fqa.getQuestionDetails();
+
+        fcsqd.setDistributePointsFor(
+                FeedbackConstantSumDistributePointsType.DISTRIBUTE_ALL_UNEVENLY.getDisplayedOption());
+
+        fqa.setQuestionDetails(fcsqd);
+
+        saveEntityDeferred(question);
+    }
+
+}

src/client/java/teammates/client/scripts/DataMigrationForNullCommentGiverType.java

@@ -0,0 +1,46 @@
+package teammates.client.scripts;
+
+import java.io.IOException;
+
+import com.googlecode.objectify.cmd.Query;
+
+import teammates.common.datatransfer.FeedbackParticipantType;
+import teammates.storage.entity.FeedbackResponseComment;
+
+/**
+ * Script to set commentGiverType as INSTRUCTOR in all comments by instructor.
+ *
+ * <p>See issue #9083</p>
+ */
+public class DataMigrationForNullCommentGiverType extends
+        DataMigrationEntitiesBaseScript<FeedbackResponseComment> {
+
+    public static void main(String[] args) throws IOException {
+        new DataMigrationForNullCommentGiverType().doOperationRemotely();
+    }
+
+    @Override
+    protected Query<FeedbackResponseComment> getFilterQuery() {
+        return ofy().load().type(FeedbackResponseComment.class)
+                .filter("commentGiverType =", null);
+    }
+
+    @Override
+    protected boolean isPreview() {
+        return true;
+    }
+
+    @Override
+    protected boolean isMigrationNeeded(FeedbackResponseComment comment) {
+        return comment.getCommentGiverType() == null;
+    }
+
+    @Override
+    protected void migrateEntity(FeedbackResponseComment comment) {
+        comment.setCommentGiverType(FeedbackParticipantType.INSTRUCTORS);
+        comment.setIsCommentFromFeedbackParticipant(false);
+
+        saveEntityDeferred(comment);
+    }
+
+}

src/client/java/teammates/client/scripts/DataMigrationForSampleGoogleIdInStudentAttributes.java

@@ -0,0 +1,53 @@
+package teammates.client.scripts;
+
+import java.io.IOException;
+
+import com.googlecode.objectify.cmd.Query;
+
+import teammates.storage.entity.CourseStudent;
+
+/**
+ * Script to remove google ID of {@link CourseStudent} if it is fake google ID.
+ */
+public class DataMigrationForSampleGoogleIdInStudentAttributes
+        extends DataMigrationEntitiesBaseScript<CourseStudent> {
+
+    public static void main(String[] args) throws IOException {
+        DataMigrationForSampleGoogleIdInStudentAttributes migrator =
+                new DataMigrationForSampleGoogleIdInStudentAttributes();
+        migrator.doOperationRemotely();
+    }
+
+    @Override
+    protected Query<CourseStudent> getFilterQuery() {
+        String sampleGoogleId = "alice.b.tmms.sampleData";
+        // Uncomment the google ID to be removed as necessary
+        // sampleGoogleId = "benny.c.tmms.sampleData";
+        // sampleGoogleId = "charlie.d.tmms.sampleData";
+        // sampleGoogleId = "danny.e.tmms.sampleData";
+        // sampleGoogleId = "emma.f.tmms.sampleData";
+        // sampleGoogleId = "francis.g.tmms.sampleData";
+        // sampleGoogleId = "gene.h.tmms.sampleData";
+        // sampleGoogleId = "teammates.demo.instructor";
+
+        return ofy().load().type(CourseStudent.class)
+                .filter("googleId =", sampleGoogleId);
+    }
+
+    @Override
+    protected boolean isPreview() {
+        return true;
+    }
+
+    @Override
+    protected boolean isMigrationNeeded(CourseStudent student) throws Exception {
+        return true;
+    }
+
+    @Override
+    protected void migrateEntity(CourseStudent student) throws Exception {
+        student.setGoogleId("");
+
+        saveEntityDeferred(student);
+    }
+}

src/client/java/teammates/client/scripts/DataMigrationForTextQuestionRecommendedLength.java

@@ -0,0 +1,53 @@
+package teammates.client.scripts;
+
+import java.io.IOException;
+
+import com.googlecode.objectify.cmd.Query;
+
+import teammates.common.datatransfer.attributes.FeedbackQuestionAttributes;
+import teammates.common.datatransfer.questions.FeedbackQuestionType;
+import teammates.common.datatransfer.questions.FeedbackTextQuestionDetails;
+import teammates.storage.entity.FeedbackQuestion;
+
+/**
+ * Script to set recommendedLength as null in all text questions whose recommendedLength is 0.
+ *
+ * <p>See issue #10677</p>
+ */
+public class DataMigrationForTextQuestionRecommendedLength extends
+        DataMigrationEntitiesBaseScript<FeedbackQuestion> {
+
+    public static void main(String[] args) throws IOException {
+        new DataMigrationForTextQuestionRecommendedLength().doOperationRemotely();
+    }
+
+    @Override
+    protected Query<FeedbackQuestion> getFilterQuery() {
+        return ofy().load().type(FeedbackQuestion.class)
+                .filter("questionType =", FeedbackQuestionType.TEXT.name());
+    }
+
+    @Override
+    protected boolean isPreview() {
+        return true;
+    }
+
+    @Override
+    protected boolean isMigrationNeeded(FeedbackQuestion question) {
+        FeedbackQuestionAttributes fqa = FeedbackQuestionAttributes.valueOf(question);
+        FeedbackTextQuestionDetails ftqd = (FeedbackTextQuestionDetails) fqa.getQuestionDetails();
+        return ftqd.getRecommendedLength() != null && ftqd.getRecommendedLength() == 0;
+    }
+
+    @Override
+    protected void migrateEntity(FeedbackQuestion question) {
+        FeedbackQuestionAttributes fqa = FeedbackQuestionAttributes.valueOf(question);
+        FeedbackTextQuestionDetails ftqd = (FeedbackTextQuestionDetails) fqa.getQuestionDetails();
+        ftqd.setRecommendedLength(null);
+
+        fqa.setQuestionDetails(ftqd);
+
+        saveEntityDeferred(fqa.toEntity());
+    }
+
+}

src/main/java/teammates/common/datatransfer/attributes/InstructorAttributes.java

@@ -1,5 +1,6 @@
 package teammates.common.datatransfer.attributes;
 
+import java.time.Instant;
 import java.util.ArrayList;
 import java.util.Comparator;
 import java.util.List;
@@ -38,6 +39,9 @@ public class InstructorAttributes extends EntityAttributes<Instructor> {
     public boolean isDisplayedToStudents;
     public InstructorPrivileges privileges;
 
+    private transient Instant createdAt;
+    private transient Instant updatedAt;
+
     private InstructorAttributes(String courseId, String email) {
         this.courseId = courseId;
         this.email = email;
@@ -47,6 +51,9 @@ private InstructorAttributes(String courseId, String email) {
         this.isArchived = false;
         this.isDisplayedToStudents = true;
         this.privileges = new InstructorPrivileges(Const.InstructorPermissionRoleNames.INSTRUCTOR_PERMISSION_ROLE_COOWNER);
+
+        this.createdAt = Const.TIME_REPRESENTS_DEFAULT_TIMESTAMP;
+        this.updatedAt = Const.TIME_REPRESENTS_DEFAULT_TIMESTAMP;
     }
 
     /**
@@ -79,6 +86,12 @@ public static InstructorAttributes valueOf(Instructor instructor) {
             instructorAttributes.privileges =
                     JsonUtils.fromJson(instructor.getInstructorPrivilegesAsText(), InstructorPrivileges.class);
         }
+        if (instructor.getCreatedAt() != null) {
+            instructorAttributes.createdAt = instructor.getCreatedAt();
+        }
+        if (instructor.getUpdatedAt() != null) {
+            instructorAttributes.updatedAt = instructor.getUpdatedAt();
+        }
 
         return instructorAttributes;
     }
@@ -93,6 +106,8 @@ public InstructorAttributes getCopy() {
         instructorAttributes.isArchived = isArchived;
         instructorAttributes.isDisplayedToStudents = isDisplayedToStudents;
         instructorAttributes.privileges = privileges;
+        instructorAttributes.createdAt = createdAt;
+        instructorAttributes.updatedAt = updatedAt;
 
         return instructorAttributes;
     }
@@ -263,6 +278,22 @@ public String getRole() {
         return role;
     }
 
+    public Instant getCreatedAt() {
+        return createdAt;
+    }
+
+    public Instant getUpdatedAt() {
+        return updatedAt;
+    }
+
+    public void setCreatedAt(Instant createdAt) {
+        this.createdAt = createdAt;
+    }
+
+    public void setUpdatedAt(Instant updatedAt) {
+        this.updatedAt = updatedAt;
+    }
+
     /**
      * Updates with {@link UpdateOptionsWithEmail}.
      */

src/main/java/teammates/common/datatransfer/questions/FeedbackQuestionType.java

@@ -11,7 +11,8 @@ public enum FeedbackQuestionType {
 
     CONSTSUM(FeedbackConstantSumQuestionDetails.class, FeedbackConstantSumResponseDetails.class),
 
-    // TODO: dummy enum, need to migrate CONSTSUM to either CONSTSUM_OPTIONS or CONSTSUM_RECIPIENTS
+    // In the back-end, only CONSTSUM and not its branched versions is recognized as a valid question type.
+    // The branching here is done to make it simpler for the front-end to render the right items.
     CONSTSUM_OPTIONS(FeedbackConstantSumQuestionDetails.class, FeedbackConstantSumResponseDetails.class),
     CONSTSUM_RECIPIENTS(FeedbackConstantSumQuestionDetails.class, FeedbackConstantSumResponseDetails.class),
 

src/main/java/teammates/storage/entity/Instructor.java

@@ -1,11 +1,14 @@
 package teammates.storage.entity;
 
 import java.security.SecureRandom;
+import java.time.Instant;
 
 import com.google.appengine.api.datastore.Text;
 import com.googlecode.objectify.annotation.Entity;
 import com.googlecode.objectify.annotation.Id;
 import com.googlecode.objectify.annotation.Index;
+import com.googlecode.objectify.annotation.OnSave;
+import com.googlecode.objectify.annotation.Translate;
 import com.googlecode.objectify.annotation.Unindex;
 
 /**
@@ -54,6 +57,12 @@ public class Instructor extends BaseEntity {
 
     private Text instructorPrivilegesAsText;
 
+    @Translate(InstantTranslatorFactory.class)
+    private Instant createdAt;
+
+    @Translate(InstantTranslatorFactory.class)
+    private Instant updatedAt;
+
     @SuppressWarnings("unused")
     private Instructor() {
         // required by Objectify
@@ -74,6 +83,7 @@ public Instructor(String instructorGoogleId, String courseId, boolean isArchived
         // setId should be called after setting email and courseId
         this.setUniqueId(generateId(this.getEmail(), this.getCourseId()));
         this.setRegistrationKey(generateRegistrationKey());
+        this.setCreatedAt(Instant.now());
     }
 
     /**
@@ -211,4 +221,33 @@ public String getInstructorPrivilegesAsText() {
     public void setInstructorPrivilegeAsText(String instructorPrivilegesAsText) {
         this.instructorPrivilegesAsText = new Text(instructorPrivilegesAsText);
     }
+
+    public Instant getCreatedAt() {
+        return createdAt;
+    }
+
+    /**
+     * Sets the createdAt timestamp.
+     */
+    public void setCreatedAt(Instant created) {
+        this.createdAt = created;
+        setLastUpdate(created);
+    }
+
+    public Instant getUpdatedAt() {
+        return updatedAt;
+    }
+
+    public void setLastUpdate(Instant updatedAt) {
+        this.updatedAt = updatedAt;
+    }
+
+    /**
+     * Updates the updatedAt timestamp when saving.
+     */
+    @OnSave
+    public void updateLastUpdateTimestamp() {
+        this.setLastUpdate(Instant.now());
+    }
+
 }

src/main/java/teammates/ui/output/FeedbackQuestionData.java

@@ -81,9 +81,6 @@ public FeedbackQuestionData(FeedbackQuestionAttributes feedbackQuestionAttribute
         }
 
         if (this.questionType == FeedbackQuestionType.CONSTSUM) {
-            // TODO: remove the abstraction after migration
-            // need to migrate CONSTSUM to either CONSTSUM_OPTIONS or CONSTSUM_RECIPIENTS
-            // correct to either CONSTSUM_OPTIONS or CONSTSUM_RECIPIENTS
             FeedbackConstantSumQuestionDetails constantSumQuestionDetails =
                     (FeedbackConstantSumQuestionDetails) this.questionDetails;
             this.questionType = constantSumQuestionDetails.isDistributeToRecipients()

src/main/java/teammates/ui/request/FeedbackQuestionBasicRequest.java

@@ -72,7 +72,6 @@ public FeedbackQuestionDetails getQuestionDetails() {
         FeedbackQuestionDetails details =
                 JsonUtils.fromJson(JsonUtils.toCompactJson(questionDetails), questionType.getQuestionDetailsClass());
         details.setQuestionText(questionBrief);
-        // TODO remove this after migrate CONSTSUM to either CONSTSUM_OPTIONS or CONSTSUM_RECIPIENTS
         if (questionType == FeedbackQuestionType.CONSTSUM_OPTIONS
                 || questionType == FeedbackQuestionType.CONSTSUM_RECIPIENTS) {
             details.setQuestionType(FeedbackQuestionType.CONSTSUM);