[#11402] Submission status stays as pending for team submissions #11518

shadowezz · 2022-01-09T08:42:12Z

Fixes #11402

Outline of Solution

As discussed with @damithc under the issue:

individual questions: pending if the student has not answered any questions i.e., all questions are blank
team questions: pending if no team member has answered any of them
If a session has both types, it is considered pending if the individual questions are pending (with no consideration of team questions)

ypinhsuan

Looks good overall, just some minor comments

ypinhsuan · 2022-01-11T03:23:12Z

src/main/java/teammates/logic/core/FeedbackSessionsLogic.java

+        if (allQuestions.isEmpty()) {
+            return true;
+        }
+        Boolean isAllTeamQuestions = true;


Can use the primitive type boolean here

ypinhsuan · 2022-01-16T02:32:28Z

src/test/java/teammates/logic/core/FeedbackSessionsLogicTest.java

+        student = dataBundle.students.get("student5InCourse1");
+        assertFalse(fsLogic.isFeedbackSessionCompletedByStudent(fs, student.getEmail(), student.getTeam()));
+
+        ______TS("success: second feedback session (both team and individual questions");


Missing a close bracket questions)

…ssions

ypinhsuan

LGTM

moziliar

Minor comments.

You can also help to deprecate fqLogic.sessionHasQuestions if you have removed the only place it is used! The old way of checking this seems irrelevant.

moziliar · 2022-01-18T04:05:21Z

src/main/java/teammates/logic/core/FeedbackSessionsLogic.java

@@ -237,15 +238,33 @@ public boolean isFeedbackSessionHasQuestionForStudents(
     *
     * <p> If there is no question for students, the feedback session is completed</p>


Would be good to update the logic in the javadoc writeup:)

moziliar · 2022-01-18T04:09:40Z

src/main/java/teammates/logic/core/FeedbackSessionsLogic.java

+            return frLogic.hasGiverRespondedForSession(userTeam, feedbackSessionName, courseId);
+        } else {
+            // if there are individual questions, session is complete only if
+            // the student has responded to the individual questions
+            return frLogic.hasGiverRespondedForSession(userEmail, feedbackSessionName, courseId);


The userEmail param in hasGiverRespondedForSession seems overloaded with userTeam now. Do you have a better way of phrasing it?

I think a more accurate name for userEmail param in hasGiverRespondedForSession is giverIdentifier since from what I understand, email is used for individual responses but team name is used for team responses. It will be good to probably change the giverEmail column in FeedbackResponse entity to giverIdentifier also.

Sounds good to me. Let's see how it looks?

It will be good to probably change the giverEmail column in FeedbackResponse entity to giverIdentifier also.

I think this might not be backward compatible... An alternative way would be to get all students in the team and return true if at least one of the students in the team has responded for the session.

@moziliar what do you think.

Oh sorry, I missed out the part about changing the entity field... @jianhandev you are right. Let's keep the entity untouched. We should only touch the code logic.

Changing the userEmail param to giverIdentifier or something similar will do. The problem is minor in that a userTeam is given as userEmail param.

Changing the userEmail param to giverIdentifier or something similar will do.

Ok sure

…ssions

moziliar

I am good with the change in code. However, the addition of entity reads makes raise my eyebrows a little. @damithc is it ok?

moziliar · 2022-01-20T01:00:03Z

src/main/java/teammates/logic/core/FeedbackQuestionsLogic.java

+    @Deprecated
    public boolean sessionHasQuestions(String feedbackSessionName, String courseId) {
        return fqDb.hasFeedbackQuestionsForGiverType(feedbackSessionName, courseId, FeedbackParticipantType.STUDENTS)
                || fqDb.hasFeedbackQuestionsForGiverType(feedbackSessionName, courseId, FeedbackParticipantType.TEAMS);


Can just remove this altogether since it is not used anywhere after this change.

moziliar · 2022-01-20T01:16:18Z

src/main/java/teammates/logic/core/FeedbackSessionsLogic.java

+        String courseId = fsa.getCourseId();
+
+        List<FeedbackQuestionAttributes> allQuestions =
+                fqLogic.getFeedbackQuestionsForStudents(feedbackSessionName, courseId);


This might actually incur many data read. @damithc can we evaluate the volume of such call?
Before this change, this execution flow only performs key only queries (in frLogic.hasGiverRespondedForSession and fqLogic.sessionHasQuestions). This solution is clean if adding back entity reads will not incur any concern on the cost.
From the logs, I don't see it though. Perhaps it is about the period.

I have refactored to only perform key-only queries.

moziliar · 2022-01-20T01:17:39Z

src/main/java/teammates/ui/webapi/FeedbackSessionRemindEmailWorkerAction.java

            List<StudentAttributes> studentsToRemindList = new ArrayList<>();
            for (StudentAttributes student : studentList) {
-                if (!logic.isFeedbackSessionCompletedByStudent(session, student.getEmail())) {
+                if (!logic.isFeedbackSessionCompletedByStudent(session, student.getEmail(), student.getTeam())) {
                    studentsToRemindList.add(student);
                }
            }


Can try to use stream for this part of code:)

List<StudentAttributes> studentsToRemindList = studentList.stream().filter(student -> !logic.isFeedbackSessionCompletedByStudent(session, student.getEmail()) );

Use of stream is encouraged, as it presents a cleaner, possibly immutable semantics. The use of filter means that we are getting the same set of data, possibly less, instead of potentially doing something to the data.

jianhandev · 2022-01-20T03:05:24Z

src/main/java/teammates/logic/core/FeedbackSessionsLogic.java

+        if (isAllTeamQuestions) {
+            return frLogic.hasGiverRespondedForSession(userTeam, feedbackSessionName, courseId);
+        } else {
+            return frLogic.hasGiverRespondedForSession(userEmail, feedbackSessionName, courseId);


If we trace hasGiverRespondedForSession until the DB layer, in FeedbackResponseDb.java, the hasResponsesFromGiverInSession method filters the responses by giverEmail. Passing the team name to hasResponsesFromGiverInSession does not seem to make sense as giverEmail is different from team name.

teammates/src/main/java/teammates/storage/api/FeedbackResponsesDb.java

Lines 175 to 189 in d4dbaa2

public boolean hasResponsesFromGiverInSession(

String giverEmail, String feedbackSessionName, String courseId) {

assert giverEmail != null;

assert feedbackSessionName != null;

assert courseId != null;

return !load()

.filter("giverEmail =", giverEmail)

.filter("feedbackSessionName =", feedbackSessionName)

.filter("courseId =", courseId)

.limit(1)

.keys() // key query is free query

.list()

.isEmpty();

}

Yea but from what I understand for team questions, the team name is what is actually stored in the db under giverEmail, which is why I initially suggest renaming the entity field. But I do agree there will prob be backward compatibility issues.

Yes. The entity field is unfortunately giverEmail, possibly due to legacy issue. However, FeedbackResponseAttribute class has a more neutral field called giver with brief explanation about the nature of the field. We can also put some remark in the form of comment in the FeedbackResponse class to indicate this the same way the Attribute class does.

The gitblame shows that the entity class is created back in 2013, and the renaming of giverEmail to giver in the Attribute class was performed in 2016 by PR #5547.

I am ok with renaming in code logic and adding comments in entity class to reflect this ambiguity.

(Alternatively) we could try fetching all students in the team and for each student check if the student has responded using hasResponsesFromGiverInSession, return true if at least one of the students in the team has responded for the session, but this will incur more DB reads I believe.

Yea that does seem a little expensive and will require storing the student email instead of the team name for team question responses.

We can also put some remark in the form of comment in the FeedbackResponse class to indicate this the same way the Attribute class does.

Personally I think this should be sufficient for now unless we need to track which team member answered the team questions.

Slowly I feel like the cost might not justify the improvement of the UX as we moved away from key only query to reading many entities.

moziliar

Neat. LGTM.

moziliar · 2022-01-22T13:28:03Z

@jianhandev take a final look? Am good with the kind of additional read (1 entity max)

jianhandev

LGTM too, although you have written tests to verify that it works, which should be sufficient in this case, but it'll be even better if you can provide a few screenshots of the changes in the PR description as well.

jianhandev · 2022-01-27T15:49:32Z

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

+    /**
+     * {@code giverEmail} does not necessarily contain an email. Depending on the question giver type,
+     * it may contain the giver's email, the team name, "anonymous", etc.
+     */
    private String giverEmail;


We might want to change giverEmail to giver as well in the future, but maybe not now

…ssions

…ions (TEAMMATES#11518) * Fixed team questions submission stauts bug. * Updated tests. * Fixed linting. * Minor fixes. * Add javadoc and minor refactoring. * Refactor code to use key-only db query. * Fix linting. Co-authored-by: Ahmed Bahajjaj <42177597+madanalogy@users.noreply.github.com>

shadowezz added 3 commits January 9, 2022 12:01

Fixed team questions submission stauts bug.

a03fd5b

Updated tests.

e347c61

Fixed linting.

c7f65d2

ypinhsuan self-requested a review January 11, 2022 02:13

ypinhsuan added the s.ToReview The PR is waiting for review(s) label Jan 11, 2022

ypinhsuan reviewed Jan 16, 2022

View reviewed changes

shadowezz added 2 commits January 16, 2022 11:15

Merge branch 'master' into 11402-submission-status-pending-team-submi…

1a88ae4

…ssions

Minor fixes.

d861ea1

shadowezz requested a review from ypinhsuan January 16, 2022 03:49

ypinhsuan approved these changes Jan 17, 2022

View reviewed changes

madanalogy added s.FinalReview The PR is ready for final review and removed s.ToReview The PR is waiting for review(s) labels Jan 18, 2022

madanalogy requested review from moziliar and jianhandev January 18, 2022 02:36

moziliar requested changes Jan 18, 2022

View reviewed changes

jianhandev added s.Ongoing The PR is being worked on by the author(s) and removed s.FinalReview The PR is ready for final review labels Jan 19, 2022

shadowezz added 2 commits January 19, 2022 23:24

Add javadoc and minor refactoring.

f8f4cba

Merge branch 'master' into 11402-submission-status-pending-team-submi…

34af806

…ssions

shadowezz requested a review from moziliar January 19, 2022 15:55

moziliar reviewed Jan 20, 2022

View reviewed changes

jianhandev requested changes Jan 20, 2022

View reviewed changes

shadowezz added 2 commits January 21, 2022 10:58

Refactor code to use key-only db query.

6ca9a54

Fix linting.

40a76f2

shadowezz requested review from moziliar and jianhandev January 21, 2022 03:34

moziliar approved these changes Jan 22, 2022

View reviewed changes

moziliar added s.FinalReview The PR is ready for final review and removed s.Ongoing The PR is being worked on by the author(s) labels Jan 22, 2022

jianhandev approved these changes Jan 27, 2022

View reviewed changes

Merge branch 'master' into 11402-submission-status-pending-team-submi…

a56ebee

…ssions

madanalogy added c.Bug Bug/defect report s.ToMerge The PR is approved by all reviewers including final reviewer; ready for merging and removed s.FinalReview The PR is ready for final review labels Jan 29, 2022

madanalogy assigned moziliar, ypinhsuan and jianhandev Jan 29, 2022

madanalogy added this to the V8.7.0 milestone Jan 29, 2022

madanalogy merged commit 55debdb into TEAMMATES:master Jan 31, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[#11402] Submission status stays as pending for team submissions #11518

[#11402] Submission status stays as pending for team submissions #11518

shadowezz commented Jan 9, 2022

ypinhsuan left a comment

ypinhsuan Jan 11, 2022

ypinhsuan Jan 16, 2022

ypinhsuan left a comment

moziliar left a comment

moziliar Jan 18, 2022

moziliar Jan 18, 2022

shadowezz Jan 18, 2022

moziliar Jan 19, 2022

jianhandev Jan 19, 2022

moziliar Jan 19, 2022

shadowezz Jan 19, 2022

moziliar left a comment

moziliar Jan 20, 2022

moziliar Jan 20, 2022

shadowezz Jan 21, 2022

moziliar Jan 20, 2022

moziliar Jan 20, 2022

jianhandev Jan 20, 2022

shadowezz Jan 20, 2022

moziliar Jan 20, 2022

moziliar Jan 20, 2022

jianhandev Jan 20, 2022 •

edited

Loading

shadowezz Jan 20, 2022

moziliar Jan 20, 2022

moziliar left a comment

moziliar commented Jan 22, 2022

jianhandev left a comment

jianhandev Jan 27, 2022

		@@ -237,15 +238,33 @@ public boolean isFeedbackSessionHasQuestionForStudents(
		*
		* <p> If there is no question for students, the feedback session is completed</p>

	public boolean hasResponsesFromGiverInSession(
	String giverEmail, String feedbackSessionName, String courseId) {
	assert giverEmail != null;
	assert feedbackSessionName != null;
	assert courseId != null;

	return !load()
	.filter("giverEmail =", giverEmail)
	.filter("feedbackSessionName =", feedbackSessionName)
	.filter("courseId =", courseId)
	.limit(1)
	.keys() // key query is free query
	.list()
	.isEmpty();
	}

[#11402] Submission status stays as pending for team submissions #11518

[#11402] Submission status stays as pending for team submissions #11518

Conversation

shadowezz commented Jan 9, 2022

ypinhsuan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ypinhsuan left a comment

Choose a reason for hiding this comment

moziliar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

moziliar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jianhandev Jan 20, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

moziliar left a comment

Choose a reason for hiding this comment

moziliar commented Jan 22, 2022

jianhandev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jianhandev Jan 20, 2022 •

edited

Loading