[fix] Add auto-migration for RecentlyAdded config

[nwithan8]

• Add migrator to automatically add "RecentlyAdded" section to each per-library stat config section
• Make "RecentlyAdded" optional/default in config parsing and schema spec

Summary by CodeRabbit

• New Features

  • Enhanced configuration flexibility by updating the schema for library and voice channel definitions.
  • Introduced a new migration for adding "Recently Added" webhooks, improving library statistics management.

• Bug Fixes

  • Improved error handling in the configuration parsing for "RecentlyAdded" keys, ensuring robustness when keys are absent.

• Documentation

  • Added a new constant for the migration process related to the "Recently Added" webhook.

• Refactor

  • Updated migration classes to support abstract methods for improved migration management.

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

This pull request includes modifications to the JSON schema for Tauticord configuration files, updates to migration classes to enhance their functionality, and the introduction of a new migration script for handling YAML configuration files. Key changes involve the addition of abstract methods for migration management, the introduction of utility functions for YAML handling, and enhancements to error handling in configuration parsing. Additionally, a new migration class is added to the migration manager, and a constant is introduced for the new migration configuration file.

Changes

File	Change Summary
.schema/config_v2.schema.json	Adjusted required properties for library and combinedLibrary; added Hours to recentlyAddedVoiceChannel.
migrations/base.py	Added abstract methods: pre_forward_check, forward, post_forward_check, pre_backwards_check, backwards, post_backwards_check to BaseMigration.
migrations/m001_env_var_to_config_yaml.py	Made Migration an abstract base class; added pre_backwards_check, post_backwards_check; updated backwards method.
migrations/m002_old_config_to_new_config.py	Made Migration an abstract base class; added pre_backwards_check, post_backwards_check; updated backwards method.
migrations/m003_add_recently_added_webhook.py	Introduced migration script for YAML configuration; added utility functions and methods for migration logic in Migration.
migrations/migration_manager.py	Added new migration class Migration003 to manage the "Recently Added" webhooks.
migrations/migration_names.py	Added constant MIGRATION_003_CONFIG_FILE for the new migration configuration file.
modules/settings/config_parser.py	Updated to_model method in StatsLibrariesConfig and CombinedLibrariesSubLibraryConfig to handle recently_added more robustly.

Possibly related PRs

• [feat] New slash command to generate play count/duration graphs #228: The changes in the main PR regarding the JSON schema for configuration files, particularly the handling of the RecentlyAdded property, are related to the new /graphs command introduced in this PR, which generates graphs that may utilize the updated configuration for displaying play counts and durations.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between db87a9e and 4ac06d8.

📒 Files selected for processing (8)

• .schema/config_v2.schema.json (2 hunks)
• migrations/base.py (2 hunks)
• migrations/m001_env_var_to_config_yaml.py (3 hunks)
• migrations/m002_old_config_to_new_config.py (3 hunks)
• migrations/m003_add_recently_added_webhook.py (1 hunks)
• migrations/migration_manager.py (2 hunks)
• migrations/migration_names.py (1 hunks)
• modules/settings/config_parser.py (2 hunks)

---

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.