[#8607] Student: edit submission: show evaluees in alphabetical order

[NicolasCwy]

Fixes #8607

Sort the list of FeedbackResponseRecipient according to their name, using the recipientList - which is sorted within the component - as a reference. This will fix ensure that names of evaluees for number scale questions will not be shown according to their email address.

Example

Current implementation (sort by email)

Screen.Recording.2022-01-15.at.8.07.52.PM.mov

New implementation from PR (sort by name)

Screen.Recording.2022-01-15.at.8.02.00.PM.mov

[NicolasCwy]

1. Should I be creating a test for this feature? If so would it be found in question-submission-form.component.spec.ts

[ypinhsuan]

1. Should I be creating a test for this feature? If so would it be found in question-submission-form.component.spec.ts

It would be good if you can add tests for it, and yes it should be in question-submission-form.component.spec.ts

[NicolasCwy]

Hi @ypinhsuan, my comment was hidden in the review page but

Should the sort go into a method? Was thinking of putting it as a component class method but felt that it should be private as it is merely a class helper function, although javascript does not seem to have such a concept, so I'm not sure how to abstract it out.

I'm also trying to implement this idea, as I would be able to just test this method instead of creating the whole component which I think would require a stub for QuestionSubmissionFormModel to instantiate the component and it seems complicated as the model is quite big. Any advice is appreciated.

I'll be working on E2E tests in the meantime as I think I know how it should be done.
Edit: Are the emails used in E2E testing real valid emails? E.g ISList.charlie.tmms@gmail.tmt. Trying to test the sort, but the student emails are coincidentally in the same alphabetical order as their name, and it wouldn't be possible to test the sort with the current students used in FeedbackNumScaleQuestionE2ETest.java

[ypinhsuan]

Hi! Sorry for missing your previous comment, I've replied in that thread.

require a stub for QuestionSubmissionFormModel to instantiate the component

For front-end component tests, you can create a QuestionSubmissionModel object for testing. Perhaps looking at how instructor-course-edit-page.component.spec.ts create test course and test instructors can help.

Are the emails used in E2E testing real valid emails?

Nope. Emails for E2E testing are fake emails.

[NicolasCwy]

@ypinhsuan Thanks for pointing me to the right places! I'm currently working on the E2E tests in src/e2e/java/teammates/e2e/cases/FeedbackNumScaleQuestionE2ETest.java.

I've got a few questions on my approach.

1. I am going to test the evaluee sorting order in testSubmitPage(), since the setup has to be done in the instructor page, should I add it as a ___TS test case in the testEditPage, since I don't see a setup function prior to the tests

2. How should I debug the E2E test, I have an assertion failure from parts of the test I have not changed, and am not sure how to check the difference. I tried searching stuff on TestNG but it seems that the projects setup doesn't allow you to run the test directly and instead goes through gradle

3. The tests in the E2E tests seems to have a single option therefore the method submitNumScaleResponse() in src/e2e/java/teammates/e2e/pageobjects/FeedbackSubmitPage.java seems to be sufficient. I was not able to find anything for num scale questions with multiple responses. Should I be creating a function similar to submitMsqResponse() to let me select multiple options in a numScale question which has multiple evaluees?

[ypinhsuan]

The frontend component tests look great!

[ypinhsuan]

It seems like adding E2E test requires quite a bit of work (adding a new numscale question with multiple response and creating methods in pageobjects/FeedbackSubmitPage.java for it). Personally I think the frontend component tests should be sufficient for this issue. E2E tests are mainly for making sure the interaction between different parts of the application is correct.

For debugging E2E tests:

teammates.e2e.pageobjects.InstructorFeedbackEditPage.verifyNumScaleQuestionDetails(InstructorFeedbackEditPage.java:608)
        at teammates.e2e.cases.FeedbackNumScaleQuestionE2ETest.testEditPage(FeedbackNumScaleQuestionE2ETest.java:54)
        at teammates.e2e.cases.FeedbackNumScaleQuestionE2ETest.testAll(FeedbackNumScaleQuestionE2ETest.java:33)

This part points you to the part which causes test failure. And the assertion error shows the actual vs expected output. In this case expected:<[1]> but was:<[0]> suggests that the expected MinNumscaleInput should be 1 but you are getting 0

[ypinhsuan]

Looks good!

[ypinhsuan]

LGTM. For your review @jianhandev @daongochieu2810

[nusoss-bot]

Guys, This PR seems to be stalling (no activities for the past 8 days). 🐌 😢
Hope someone can get it to move forward again soon...

[hhdqirui]

For your kind review @jianhandev @daongochieu2810

[jianhandev]

Looking good, just some minor issues I've picked up:

[nusoss-bot]

Guys, This PR seems to be stalling (no activities for the past 7 days). 🐌 😢
Hope someone can get it to move forward again soon...