Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

enhance: switch group activity publication to cronjob-based approach #4302

Merged
merged 9 commits into from
Oct 9, 2024

Conversation

sjschlapbach
Copy link
Member

@sjschlapbach sjschlapbach commented Oct 9, 2024

This pull request modifies the group activity publication logic such that group activities that start in the future are only set to a SCHEDULED state on publishing. A separate cronjob that runs every 5 minutes then publishes the group activities together with the practice quizzes and microlearnings with start dates around a similar time.

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced a new status SCHEDULED for group activities, enhancing activity management.
    • Added functionality for publishing scheduled activities, replacing previous practices for microlearnings and quizzes.
    • Improved UI elements for managing group activities, including grading links and unpublish buttons.
  • Bug Fixes

    • Enhanced error handling for group activity management to ensure valid operations.
  • Documentation

    • Updated GraphQL schema to reflect new mutations and types related to scheduled activities.
  • Chores

    • Removed outdated functions and streamlined the codebase by eliminating unnecessary features.

Copy link

aviator-app bot commented Oct 9, 2024

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.

Copy link

gitguardian bot commented Oct 9, 2024

⚠️ GitGuardian has uncovered 7 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request
GitGuardian id GitGuardian status Secret Commit Filename
1509427 Triggered Generic Password 589508d packages/prisma/src/data/seedTEST.ts View secret
1509427 Triggered Generic Password 589508d packages/prisma/src/data/seedTEST.ts View secret
1509427 Triggered Generic Password 589508d cypress/cypress.config.ts View secret
1509427 Triggered Generic Password 589508d cypress/cypress.config.ts View secret
14050276 Triggered Generic Password 589508d packages/prisma/src/data/seedTEST.ts View secret
14050276 Triggered Generic Password 589508d packages/prisma/src/data/seedTEST.ts View secret
14050276 Triggered Generic Password 589508d cypress/cypress.config.ts View secret
🛠 Guidelines to remediate hardcoded secrets
  1. Understand the implications of revoking this secret by investigating where it is used in your code.
  2. Replace and store your secrets safely. Learn here the best practices.
  3. Revoke and rotate these secrets.
  4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider


🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Copy link

coderabbitai bot commented Oct 9, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces significant changes across various components and files, primarily focusing on the management of group activities and their statuses. The GroupActivityElement component has been updated to include a new status, SCHEDULED, and modifications to how statuses are displayed and managed. New GraphQL mutations and updates to the schema reflect these changes, while Cypress tests have been adjusted to accommodate new functionality. Additionally, several deprecated functionalities related to publishing scheduled quizzes and microlearnings have been removed, streamlining the overall application structure.

Changes

File Change Summary
apps/frontend-manage/src/components/courses/GroupActivityElement.tsx Restructured status handling for GroupActivityStatus, renamed deletionItem to DeletionItem, and added new components for grading links, unpublish buttons, and extension buttons.
cypress/cypress/e2e/D-questions-workflow.cy.ts Added cy.wait(500) after saving new questions; replaced cy.wait(1000) with cy.wait(500) in duplication test.
cypress/cypress/support/commands.ts Added new custom commands for user login and question creation, including loginFactory for different user roles and various createQuestion commands.
deploy/charts/klicker-uzh-v2/templates/cron-async-activity-publications.yaml Modified Kubernetes CronJob name and schedule; updated HTTP headers and operation names.
deploy/charts/klicker-uzh-v2/templates/cron-practice-quiz-publications.yaml Deleted file defining a Kubernetes CronJob for practice quiz publications.
deploy/charts/klicker-uzh-v2/values.yaml Updated cron job entry for activityPublications, removed practiceQuizPublications and microLearningPublications.
packages/graphql/src/graphql/ops/MPublishScheduledMicroLearnings.graphql Deleted GraphQL mutation for publishing scheduled micro-learnings.
packages/graphql/src/graphql/ops/MPublishScheduledPracticeQuizzes.graphql Deleted GraphQL mutation for publishing scheduled practice quizzes.
packages/graphql/src/graphql/ops/PublishScheduledActivities.graphql Introduced new mutation for publishing scheduled activities.
packages/graphql/src/ops.schema.json Added new scalar and object types related to question management; introduced new input and enum types.
packages/graphql/src/ops.ts Updated type definitions and added new scalar types; modified existing types to include new fields.
packages/graphql/src/public/client.json Removed actions for publishing micro-learnings and practice quizzes; added action for publishing scheduled activities.
packages/graphql/src/public/schema.graphql Updated GroupActivityStatus enum to include SCHEDULED; added mutation field for publishing scheduled activities.
packages/graphql/src/public/server.json Added new mutations and queries for activity management; removed deprecated mutations.
packages/graphql/src/schema/mutation.ts Renamed publishScheduledPracticeQuizzes to publishScheduledActivities, updated resolver.
packages/graphql/src/services/courses.ts Added publishScheduledActivities function for managing scheduled activities.
packages/graphql/src/services/groups.ts Updated functions to manage group activities, including publishing and unpublishing logic.
packages/graphql/src/services/microLearning.ts Removed publishScheduledMicroLearnings function.
packages/graphql/src/services/practiceQuizzes.ts Removed publishScheduledPracticeQuizzes function.
packages/prisma/src/data/seedTEST.ts Updated identifiers and statuses for group activities and microlearning instances.
packages/prisma/src/prisma/migrations/20241009123046_group_activity_scheduled_status/migration.sql Added SCHEDULED value to GroupActivityStatus enum in the database schema.
packages/prisma/src/prisma/schema/quiz.prisma Added SCHEDULED value to GroupActivityStatus enum.

Possibly related PRs

Suggested reviewers

  • rschlaefli

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between ebe2dee and 5f45694.

📒 Files selected for processing (1)
  • packages/graphql/src/services/groups.ts (8 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/graphql/src/services/groups.ts

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
🪧 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.

Copy link

cypress bot commented Oct 9, 2024

klicker-uzh    Run #3190

Run Properties:  status check passed Passed #3190  •  git commit 369bd5622f ℹ️: Merge 5f456948a8e6ebfe22dd68495830e11d8e89fa17 into 367f34673619c742f6e4527a3d3d...
Project klicker-uzh
Run status status check passed Passed #3190
Run duration 09m 24s
Commit git commit 369bd5622f ℹ️: Merge 5f456948a8e6ebfe22dd68495830e11d8e89fa17 into 367f34673619c742f6e4527a3d3d...
Committer Julius Schlapbach
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 92

Copy link

sonarqubecloud bot commented Oct 9, 2024

Quality Gate Failed Quality Gate failed

Failed conditions
1 Security Hotspot

See analysis details on SonarCloud

@sjschlapbach sjschlapbach merged commit c13fcd9 into v3 Oct 9, 2024
8 of 13 checks passed
@sjschlapbach sjschlapbach deleted the group-activity-scheduled-state branch October 9, 2024 15:52
Copy link

cypress bot commented Oct 9, 2024

klicker-uzh    Run #3191

Run Properties:  status check passed Passed #3191  •  git commit c13fcd9d40: enhance: switch group activity publication to cronjob-based approach (#4302)
Project klicker-uzh
Run status status check passed Passed #3191
Run duration 09m 22s
Commit git commit c13fcd9d40: enhance: switch group activity publication to cronjob-based approach (#4302)
Committer Julius Schlapbach
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 92

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant