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: separate scheduling and publishing logic for microlearnings with cronjob #4289

Merged
merged 7 commits into from
Oct 4, 2024

Conversation

sjschlapbach
Copy link
Member

@sjschlapbach sjschlapbach commented Oct 4, 2024

IMPORTANT:
In connection with this PR we also need to set all microlearning status values to SCHEDULED, which are PUBLISHED at the moment and where the start date still lies in the future:

SELECT * FROM "MicroLearning" WHERE status = 'PUBLISHED' AND "scheduledStartAt" > NOW();

This pull request adds the scheduled state for microlearnings in a similar way as they are already implemented for practice quizzes. Microlearnings with a start date in the future are now only scheduled and later published automatically through a cronjob. This should simplify the querying logic and provide more transparency regarding the state of a microlearning without the need to check for start and end dates during every query.

Screenshot 2024-10-04 at 12 00 04

Summary by CodeRabbit

Release Notes

  • New Features

    • Enhanced handling of micro-learning item statuses, including new dropdown actions for scheduled items.
    • Introduced a new mutation for publishing scheduled micro-learnings.
    • Added a new option to copy access links for integration into learning management systems.
    • Clarified the publishing process, emphasizing the scheduled state and editing options before the start date.
    • Added the ability to extend the duration of running micro-learnings.
  • Bug Fixes

    • Updated visual representation for scheduled quizzes to improve clarity.
  • Documentation

    • Expanded documentation for creating and publishing micro-learning sessions with clearer instructions and new options.

These updates improve user interaction with micro-learning content and enhance the overall functionality of the application.

Copy link

aviator-app bot commented Oct 4, 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

coderabbitai bot commented Oct 4, 2024

Warning

Rate limit exceeded

@sjschlapbach has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 8 minutes and 20 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Files that changed from the base of the PR and between c2848c0 and 021b536.

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces significant changes to the management of micro-learning sessions and practice quizzes, focusing on the PublicationStatus and user interactions. Enhancements include the addition of a new GraphQL mutation for publishing scheduled micro-learnings and updates to the handling of statuses in related components. The GraphQL schema has been expanded with new types and fields, improving the overall functionality for managing educational content. Additionally, modifications to localization files ensure clarity in user-facing messages regarding the publishing process.

Changes

File Change Summary
apps/docs/docs/tutorials/microlearning.mdx Updated instructions for creating and publishing microlearning sessions; added new options and clarifications.
apps/frontend-manage/src/components/courses/MicroLearningElement.tsx Enhanced handling of PublicationStatus; added dropdown for scheduled items.
apps/frontend-manage/src/components/courses/PracticeQuizElement.tsx Updated color for Scheduled status; maintained existing functionality.
apps/frontend-manage/src/components/courses/StatusTag.tsx Adjusted layout and spacing of elements.
apps/frontend-manage/src/components/courses/modals/PublishConfirmationModal.tsx Added loading states for publishing actions.
cypress/cypress/e2e/G-microlearning-workflow.cy.ts Added new test cases for microlearning workflows; modified existing tests for status verification.
packages/graphql/src/graphql/ops/MPublishScheduledMicroLearnings.graphql Introduced new mutation PublishScheduledMicroLearnings.
packages/graphql/src/ops.schema.json Added new scalar and object types related to micro-learnings and quizzes.
packages/graphql/src/ops.ts Expanded GraphQL schema with new types and updated existing types for micro-learning and quizzes.
packages/graphql/src/public/client.json Added entry for PublishScheduledMicroLearnings mutation.
packages/graphql/src/public/schema.graphql Expanded Mutation type with new fields for managing scheduled content.
packages/graphql/src/public/server.json Added new mutations for publishing scheduled micro-learnings and quizzes.
packages/graphql/src/schema/mutation.ts Introduced publishScheduledMicroLearnings mutation with resolver logic.
packages/graphql/src/services/microLearning.ts Updated publishing logic and added new function for handling scheduled micro-learnings.
packages/i18n/messages/de.ts Updated German localization strings for clarity in publishing process.
packages/i18n/messages/en.ts Updated English localization strings for clarity in publishing process.

Possibly related PRs

Suggested reviewers

  • rschlaefli

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 4, 2024

klicker-uzh    Run #3129

Run Properties:  status check passed Passed #3129  •  git commit dfe26845e9 ℹ️: Merge 021b536eef7fbf6686e0c98a37a877ddf0b23cbb into 48e81e9ae43898eee34ec362bbdc...
Project klicker-uzh
Branch Review scheduled-microlearnings
Run status status check passed Passed #3129
Run duration 10m 04s
Commit git commit dfe26845e9 ℹ️: Merge 021b536eef7fbf6686e0c98a37a877ddf0b23cbb into 48e81e9ae43898eee34ec362bbdc...
Committer Julius Schlapbach
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 3
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 47
View all changes introduced in this branch ↗︎

Copy link

sonarqubecloud bot commented Oct 4, 2024

Quality Gate Failed Quality Gate failed

Failed conditions
1 Security Hotspot

See analysis details on SonarCloud

@sjschlapbach sjschlapbach merged commit c368dc9 into v3 Oct 4, 2024
10 of 14 checks passed
@sjschlapbach sjschlapbach deleted the scheduled-microlearnings branch October 4, 2024 11:23
Copy link

cypress bot commented Oct 4, 2024

klicker-uzh    Run #3130

Run Properties:  status check passed Passed #3130  •  git commit c368dc99bc: enhance: separate scheduling and publishing logic for microlearnings with cronjo...
Project klicker-uzh
Branch Review v3
Run status status check passed Passed #3130
Run duration 09m 30s
Commit git commit c368dc99bc: enhance: separate scheduling and publishing logic for microlearnings with cronjo...
Committer Julius Schlapbach
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 1
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 47
View all changes introduced in this branch ↗︎

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