Add pause feature to backend

wolfemir commented 1 week ago

feat: Add media item pause functionality with FastAPI endpoints

Implement comprehensive pause/unpause API endpoints for media item processing control.

API Endpoints:

POST /items/{id}/pause - Pause single item
POST /items/pause?ids=id1,id2 - Bulk pause items
POST /items/{id}/unpause - Unpause single item
POST /items/unpause?ids=id1,id2 - Bulk unpause items
GET /items/{id}/pause - Get item pause state
GET /items/paused - List all paused items
GET /items/paused/count - Get count of paused items

Response Models:

PauseResponse: {message: str, ids: list[str]}
PauseStateResponse: {is_paused: bool, paused_at: str, item_id: str, title: str}
AllPausedResponse: {count: int, items: list[dict]}

Features:

Support for individual and bulk pause operations
Type-based filtering for paused item queries
Transaction-safe database operations
Detailed error handling and status codes
Integration with existing state transition system

Database Changes:

Add columns: is_paused (Boolean), paused_at (DateTime), paused_by (String)
Create index on is_paused for query optimization

Breaking changes: None Migration: Required (adds new columns to MediaItem table)

Summary by CodeRabbit

Release Notes

New Features
- Introduced pause and unpause functionality for media items, allowing users to manage media processing states.
- Added new API endpoints to pause, unpause, and check the status of media items, as well as retrieve all paused items and their counts.
Bug Fixes
- Enhanced error handling for operations involving paused items and non-existent media.

These updates improve user control over media processing and streamline interactions with the system.

coderabbitai[bot] commented 1 week ago

Walkthrough

This pull request introduces a new Alembic migration script that adds pause functionality to the MediaItem table, including three new columns: is_paused, paused_at, and paused_by. It modifies the MediaItem class to incorporate these attributes and adds methods for pausing and unpausing media items. Additionally, the process_event function in the state transition module is updated to skip processing paused items. New API endpoints and response models are created to manage pause and unpause operations for media items.

Changes

File Path	Change Summary
`src/alembic/versions/20241114_1400_c99239e3445f_add_pause_functionality.py`	Added migration script with new columns `is_paused`, `paused_at`, `paused_by`, and an index on `is_paused`.
`src/program/media/item.py`	Modified `MediaItem` class to include `is_paused` and `paused_at` attributes; added `pause` and `unpause` methods.
`src/program/state_transition.py`	Updated `process_event` function to skip processing for paused items and refine logic for handling various item states.
`src/routers/secure/items.py`	Introduced new response models and endpoints for pausing/unpausing media items and retrieving pause states and counts.

Poem

In the burrow where the media flows,
A pause was added, as everyone knows.
With a hop and a skip, we now can say,
"Pause and unpause, let's play today!"
🐇✨
New states to track, like a dance in the night,
Media's now managed, all snug and tight!

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

wolfemir commented 3 days ago

@Gaisberg i have removed the rest in state transition, please let me know if anything else need to be changed

Gaisberg commented 3 days ago

@Gaisberg i have removed the rest in state transition, please let me know if anything else need to be changed

Please squash and amend the commit message to follow conventional commits

rivenmedia / riven