enhance: resolve seed-dependency of group activity through extended test suite

[sjschlapbach]

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced an activityIndex property to enhance tracking in group activity submissions.

• Enhancements

  • Simplified validation schemas across several components for improved readability while maintaining existing validation logic.
  • Improved sorting logic for submissions in the grading interface for better user experience.

• Bug Fixes

  • Corrected various typos and grammatical errors in the localization strings to enhance clarity and user guidance.

• Tests

  • Expanded Cypress tests for group activities, adding scenarios for grading and submission verification.

• Chores

  • Updated Cypress commands to include a new optional multiplier parameter for question creation functions.

[aviator-app]

Current Aviator status

Aviator will automatically update this comment as the status of the PR changes.
Comment /aviator refresh to force Aviator to re-examine your PR (or learn about other /aviator commands).

This PR was merged manually (without Aviator). Merging manually can negatively impact the performance of the queue. Consider using Aviator next time.

---

See the real-time status of this PR on the Aviator webapp.

Use the Aviator Chrome Extension to see the status of your PR within GitHub.

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request introduces several changes across various components related to group activities in the frontend application. Key modifications include the removal of useMemo hooks for validation schemas in multiple components, streamlining their initialization. Additionally, new properties such as activityIndex are introduced to enhance data handling in the GroupActivitySubmission component. The sorting logic for submissions is refined, and Cypress tests are expanded to cover new grading scenarios. Localization strings are also updated for clarity and correctness, ensuring a consistent user experience.

Changes

File Path	Change Summary
apps/frontend-manage/src/components/courses/groupActivity/GroupActivityGradingStack.tsx	Removed useMemo for gradingSchema, simplified to direct assignment. Removed import of useMemo. Core functionality remains unchanged.
apps/frontend-manage/src/components/courses/groupActivity/GroupActivitySubmission.tsx	Added activityIndex to GroupActivitySubmissionProps. Updated Button data attribute to use activityIndex instead of submission.id.
apps/frontend-manage/src/components/courses/modals/CourseManipulationModal.tsx	Refactored Yup validation schema to eliminate useMemo. Validation rules for dates and group sizes remain unchanged but are clearer.
apps/frontend-manage/src/components/questions/QuestionEditModal.tsx	Removed useMemo for questionManipulationSchema, now directly calls createValidationSchema. Minor adjustments to studentResponse state.
apps/frontend-manage/src/pages/courses/grading/groupActivity/[id].tsx	Added ix parameter for mapping submissions. Updated sorting logic and conditional checks for submission handling. Button styling adjusted.
cypress/cypress/e2e/J-group-activity-workflow.cy.ts	Added constants for grading process. Expanded test cases for group activities and submissions. Updated logic for grading visualization.
cypress/cypress/support/commands.ts	Added optional multiplier parameter to question creation commands. Updated function signatures and internal logic to handle this parameter.
packages/i18n/messages/en.ts	Corrected typos and grammatical errors in localization strings. Added new strings for clarity. No structural changes to localization hierarchy.

Possibly related PRs

• enhance(apps/frontend-manage): limit group activity creation to courses where group creation is enabled #4259: Changes to the GroupActivitySubmission component, related to group activity management.
• feat: add possibility to extend microlearnings and group activities before end date #4283: Adds ability to extend microlearnings and group activities, directly related to the main PR.
• enhance: separate scheduling and publishing logic for microlearnings with cronjob #4289: Discusses scheduling and publishing logic for microlearnings, relevant to group activity timelines.
• feat: allow deletion of all activities independent of status and distinguish between hard and soft deletion in backend #4294: Allows deletion of all activities independent of status, directly relevant to managing group activities.
• enhance: implement more detailed deletion confirmation modal for group activities #4298: Implements a detailed deletion confirmation modal for group activities, directly related to the main PR.
• fix(apps/frontend-manage): properly enforce that end dates are after start dates and in the future #4301: Enforces that end dates are after start dates, relevant to validation logic in the main PR.
• feat: add possibility to end group activity manually and introduce additional ended status #4303: Adds the possibility to end group activities manually, directly aligned with changes in the main PR.

Suggested reviewers

• rschlaefli: Suggested for review based on expertise in the relevant components and changes made.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between fa6c196 and 416ee1e.

📒 Files selected for processing (8)

• apps/frontend-manage/src/components/courses/groupActivity/GroupActivityGradingStack.tsx (2 hunks)
• apps/frontend-manage/src/components/courses/groupActivity/GroupActivitySubmission.tsx (2 hunks)
• apps/frontend-manage/src/components/courses/modals/CourseManipulationModal.tsx (2 hunks)
• apps/frontend-manage/src/components/questions/QuestionEditModal.tsx (1 hunks)
• apps/frontend-manage/src/pages/courses/grading/groupActivity/[id].tsx (1 hunks)
• cypress/cypress/e2e/J-group-activity-workflow.cy.ts (11 hunks)
• cypress/cypress/support/commands.ts (12 hunks)
• packages/i18n/messages/en.ts (1 hunks)

🧰 Additional context used

🔇 Additional comments (18)

apps/frontend-manage/src/components/courses/groupActivity/GroupActivitySubmission.tsx (2)

19-19: LGTM: Addition of activityIndex prop

The activityIndex prop has been correctly added to both the GroupActivitySubmissionProps interface and the component's parameter list. This change is consistent with the summary and appears to be implemented correctly.

Also applies to: 27-27

---

Line range hint 1-116: Summary: Minor enhancements to GroupActivitySubmission component

The changes to this file are minimal and focused:

1. Addition of the activityIndex prop to the component.
2. Modification of the data-cy attribute to use activityIndex instead of submission.id.

These changes enhance the component's flexibility and potentially improve test stability. The implementation is consistent with the provided summary and appears to be correct.

To ensure a smooth integration:

1. Verify that the activityIndex is correctly passed from the parent component.
2. Update any Cypress tests that may be affected by the data-cy attribute change.

Overall, these changes seem to be a positive enhancement to the component.

apps/frontend-manage/src/pages/courses/grading/groupActivity/[id].tsx (4)

105-108: LGTM: Improved submission tracking

The addition of the activityIndex prop to the GroupActivitySubmission component enhances the ability to track each submission's position in the list. This change is well-implemented and aligns with the PR objectives.

---

Line range hint 191-196: LGTM: Improved type safety in getStaticProps

The addition of the GetStaticPropsContext type to the getStaticProps function signature enhances type safety and aligns with Next.js best practices. This change improves code quality and maintainability.

---

Line range hint 198-203: LGTM: Consistent getStaticPaths implementation

The updated getStaticPaths function signature aligns with Next.js conventions and improves code consistency. This change contributes to better maintainability and readability of the codebase.

---

Line range hint 1-205: Overall assessment: Well-implemented enhancements

The changes in this file successfully address the PR objectives by improving the group activity grading interface. Key improvements include:

1. Enhanced submission tracking with the activityIndex prop.
2. Refined submission selection logic to prevent switching when grading is finalized.
3. Improved finalize grading button logic to prevent premature finalization.
4. Better type safety and consistency in getStaticProps and getStaticPaths functions.

These changes contribute to a more robust and user-friendly grading experience. The code quality is maintained, with only minor suggestions for readability improvements.

apps/frontend-manage/src/components/courses/groupActivity/GroupActivityGradingStack.tsx (3)

24-24: LGTM: Removed unused import.

The removal of the useMemo import is consistent with its non-usage in the component. This change helps keep the imports clean and removes unused dependencies.

---

126-140: LGTM: Simplified gradingSchema initialization.

The removal of useMemo for gradingSchema is a good optimization:

1. It simplifies the code without changing the validation logic.
2. Yup schemas are typically static and lightweight to create, so memoization isn't necessary here.
3. This change aligns with React's recommendation to avoid premature optimization.

The performance impact should be negligible, and the code is now more straightforward.

---

Line range hint 1-400: Overall assessment: Changes improve code clarity.

The modifications in this file, particularly the removal of useMemo for gradingSchema, contribute to code simplification without compromising functionality or performance. These changes align well with React best practices and make the component more maintainable.

apps/frontend-manage/src/components/courses/modals/CourseManipulationModal.tsx (2)

16-16: LGTM: Simplified imports

The removal of the useMemo import is consistent with the changes in the validation schema definition. This simplification reduces unnecessary memoization and improves code clarity.

---

Line range hint 1-365: Overall assessment: Improved code structure with maintained functionality

The changes in this file focus on simplifying the validation schema definition by removing the useMemo hook. This modification improves code readability and maintainability without altering the component's functionality. The validation rules and form structure remain intact, ensuring that the course manipulation modal continues to work as expected.

To ensure that the removal of useMemo doesn't impact performance, we should verify that this component is not rendered frequently. Run the following script to check for potential performance issues:

If the script reveals that CourseManipulationModal is used in frequently re-rendered components, we may need to reconsider the removal of useMemo for the validation schema.

✅ Verification successful

Action Required: Re-run Verification with Updated Search Parameters

The previous verification attempt failed because the tsx file type was not recognized by rg. To proceed, please execute the following scripts without specifying the file type to ensure all relevant files are searched:

---

Verification Complete: Removal of useMemo is Safe

The CourseManipulationModal is not rendered within loops or high-frequency components. Its usage in index.tsx and CourseOverviewHeader.tsx ensures that removing the useMemo hook does not adversely affect the component's performance.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for frequent re-renders of CourseManipulationModal
# Expected result: No instances of CourseManipulationModal being rendered in loops or high-frequency components

# Search for imports of CourseManipulationModal
echo "Searching for imports of CourseManipulationModal:"
rg "import.*CourseManipulationModal" --type tsx

# Search for usage of CourseManipulationModal in components
echo "\nSearching for usage of CourseManipulationModal:"
rg "<CourseManipulationModal" --type tsx -C 5

Length of output: 371

---

Script:

#!/bin/bash
# Description: Check for frequent re-renders of CourseManipulationModal
# Expected result: No instances of CourseManipulationModal being rendered in loops or high-frequency components

# Search for imports of CourseManipulationModal
echo "Searching for imports of CourseManipulationModal:"
rg "import.*CourseManipulationModal"

# Search for usage of CourseManipulationModal in components
echo "\nSearching for usage of CourseManipulationModal:"
rg "<CourseManipulationModal" -C 5

Length of output: 2843

packages/i18n/messages/en.ts (2)

1709-1709: Typo correction in group activity pass/fail message

The line has been corrected to fix a grammatical error:

-      didGroupPass: 'Is the group activitied passed?',
+      didGroupPass: 'Is the group activity passed?',

This change improves the clarity and correctness of the English translation for this message.

---

Line range hint 1-3000: Well-structured and comprehensive translations

The overall structure and content of this translation file are well-organized and comprehensive. The nested object structure makes it easy to locate and update specific translations for different parts of the application. The file covers a wide range of features, including authentication, courses, quizzes, and evaluations, providing a solid foundation for the English localization of the KlickerUZH application.

cypress/cypress/support/commands.ts (1)

Line range hint 691-719: Function declarations updated appropriately with 'multiplier' parameter

The function declarations within the global namespace have been correctly updated to include the optional multiplier parameter. This ensures that the custom Cypress commands have accurate typings, enhancing code reliability and developer experience.

cypress/cypress/e2e/J-group-activity-workflow.cy.ts (4)

91-91: Verify Correct Multiplier Usage for SC Question

The multiplier for the Single Choice (SC) question is set to messages.manage.sessionForms.multiplier2. Please verify that this is the intended multiplier for the SC question and aligns with the test objectives.

---

131-131: Verify Correct Multiplier Usage for Numerical Response Question

The multiplier for the Numerical Response (NR) question is set to messages.manage.sessionForms.multiplier3. Ensure that this multiplier is appropriate for the NR question and matches the expected test parameters.

---

444-444: Update Indices After Adding New Questions

After adding new questions to the group activity, ensure that the indices used in your selectors (e.g., question-6-stack-0) correctly reflect the updated order of questions. This prevents potential mismatches between the expected and actual elements in the UI.

Also applies to: 447-447

---

999-1014: Confirm Correct Status Display for Non-Participating Groups

The test checks that groups who have not attempted the activity see the status messages.pwa.groupActivity.past. Ensure that this status accurately represents the group's state and that the activity cannot be initiated post-deadline. This validation helps maintain consistency in user experience.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[sonarcloud]

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
6.2% Duplication on New Code

See analysis details on SonarCloud

[cypress]

klicker-uzh    Run #3205

Run Properties:   Passed #3205  •  4ef883668f ℹ️: Merge 416ee1e69f2b42d09a2f100fad4aaf40131b817d into fa6c196f8225e976b2d9ea656ed8...

Project	klicker-uzh
Run status	Passed #3205
Run duration	09m 41s
Commit	4ef883668f ℹ️: Merge 416ee1e69f2b42d09a2f100fad4aaf40131b817d into fa6c196f8225e976b2d9ea656ed8...
Committer	Julius Schlapbach
View all properties for this run ↗︎

---

Test results
Failures	0
Flaky	0
Pending	0
Skipped	0
Passing	101

[cypress]

klicker-uzh    Run #3207

Run Properties:   Passed #3207  •  dd00908932: enhance: resolve seed-dependency of group activity through extended test suite (...

Project	klicker-uzh
Run status	Passed #3207
Run duration	10m 56s
Commit	dd00908932: enhance: resolve seed-dependency of group activity through extended test suite (...
Committer	Julius Schlapbach
View all properties for this run ↗︎

---

Test results
Failures	0
Flaky	0
Pending	0
Skipped	0
Passing	101