fix: improved episode handling on manual scraping

[dreulavelle]

Pull Request Check List

Resolves: #issue-number-here

• Added tests for changed code.
• Updated documentation for changed code.

Description:

Summary by CodeRabbit

• Refactor
  • Streamlined the media update process to ensure more consistent handling of both movies and episodic content.
  • Enhanced error reporting now provides clearer feedback when updates can’t be applied, leading to smoother and more reliable media operations for users.

[coderabbitai]

Walkthrough

The pull request refactors the manual_update_attributes function in src/routers/secure/scrape.py. It changes the collection variable item_ids_to_submit from a list to a set and introduces an inner function named update_item to encapsulate the update logic for both media items and episodes. The logic for handling movie items is simplified by using update_item, and for non-movie items, the episode update process now uses a single loop with a call to get_episode. If an episode is not found, an error is logged instead of canceling jobs or resetting properties.

Changes

File	Change Summary
src/routers/.../scrape.py	- Changed item_ids_to_submit from a list to a set. - Introduced update_item(item: MediaItem, data: DebridFile) to encapsulate update logic. - Simplified update logic for movies by calling update_item. - Streamlined non-movie updates by using a single loop with get_episode and logging errors when episodes are missing.

Sequence Diagram(s)

sequenceDiagram
    participant MUA as manual_update_attributes
    participant UI as update_item
    participant GE as get_episode
    participant Log as Logger

    %% Handling movie items
    MUA->>UI: Call update_item(movie_item, data)
    
    %% Handling non-movie items
    MUA->>GE: Call get_episode(episode_identifier)
    alt Episode found
        GE-->>MUA: Returns episode
        MUA->>UI: Call update_item(episode, data)
    else Episode not found
        GE-->>MUA: Returns null
        MUA->>Log: Log error message
    end

Loading

Suggested reviewers

• davidemarcoli
• Gaisberg

Poem

I'm a hopping rabbit, light on my feet,
Coding through changes, oh what a treat!
Functions now sparkle with logic so neat,
Leaping over bugs with a joyful beat,
Celebrating streamlined code in every line –
Carrots and code, all perfectly divine!
🐰💻

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fcae2bb and b5dc611.

📒 Files selected for processing (1)

• src/routers/secure/scrape.py (3 hunks)

🔇 Additional comments (4)

src/routers/secure/scrape.py (4)

363-363: Improved collection type for item_ids_to_submit

Changing from a list to a set is a good improvement. This prevents duplicate processing of the same item ID, which can happen if an item appears multiple times in the data structure.

---

365-372: Well-structured function extraction for common update logic

Good refactoring to extract the common item update logic into a dedicated function. This follows the DRY principle and makes the code more maintainable.

---

374-378: Simplified movie handling logic

The movie handling has been simplified by leveraging the new update_item function. The code is now more concise and follows a consistent pattern with episode handling.

---

379-389:

❓ Verification inconclusive

Improved episode handling with better error recovery

The new implementation for non-movie items significantly improves error handling. Rather than failing the entire process when an episode isn't found, it now logs an error and continues processing other episodes.

This is a more resilient approach that allows partial updates to succeed when only some episodes are problematic.

Verify that the get_episode method reliably finds episodes when they exist:

---

🏁 Script executed:

#!/bin/bash
# Check the implementation of get_episode method to understand how it works
ast-grep --pattern $'def get_episode' | grep -A 15 "def get_episode"

# Find all instances where get_episode is called to ensure consistent usage
rg "get_episode" --type py

Length of output: 539

---

Improved Episode Retrieval and Error Recovery

The updates in src/routers/secure/scrape.py now handle missing episodes more gracefully by logging an error and continuing with subsequent episodes instead of halting the entire update process. The use of item.get_episode (defined in src/program/media/item.py) appears consistent across the codebase—as confirmed by the shell script output—indicating that episodes are retrieved in a standard manner wherever this method is invoked.

• Verification Points:
  • The shell script confirms that get_episode is defined and used in multiple contexts across the project.
  • The revised workflow now logs missing episodes without disrupting processing of valid ones.

Please ensure that the get_episode implementation reliably returns valid episodes (and only None when an episode truly does not exist) across all edge cases.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 generate docstrings to generate docstrings for this 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

src/routers/secure/scrape.py (2)

11-11: Remove unused import.

The static analysis shows that the GarbageTorrent exception is imported but never used in this file.

-from RTN.exceptions import GarbageTorrent

🧰 Tools

🪛 Ruff (0.8.2)

11-11: RTN.exceptions.GarbageTorrent imported but unused

Remove unused import: RTN.exceptions.GarbageTorrent

(F401)

---

16-16: Remove unused import.

The Show class is imported but never used in this file.

-from program.media.item import MediaItem, Show
+from program.media.item import MediaItem

🧰 Tools

🪛 Ruff (0.8.2)

16-16: program.media.item.Show imported but unused

Remove unused import: program.media.item.Show

(F401)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7aa78a6 and fcae2bb.

📒 Files selected for processing (1)

• src/routers/secure/scrape.py (2 hunks)

🧰 Additional context used

🪛 Ruff (0.8.2)

src/routers/secure/scrape.py

11-11: RTN.exceptions.GarbageTorrent imported but unused

Remove unused import: RTN.exceptions.GarbageTorrent

(F401)

---

16-16: program.media.item.Show imported but unused

Remove unused import: program.media.item.Show

(F401)

🔇 Additional comments (4)

src/routers/secure/scrape.py (4)

365-365: Great use of a set instead of a list!

Using a set for item_ids_to_submit is a good optimization since:

1. It prevents duplicate item IDs from being processed multiple times
2. Set lookup operations are O(1) instead of O(n) for lists

---

367-374: Well-designed helper function improves code organization.

Extracting the common item update logic into a reusable function is excellent refactoring. This reduces code duplication and centralizes the logic for updating media items.

---

376-379: Cleaner movie handling implementation.

The logic for handling movie items is now more straightforward and readable. Using the update_item function makes the code more maintainable.

---

381-390: Improved episode handling with better error management.

This is a significant improvement over the previous implementation. The changes:

1. Make the episode handling logic more concise
2. Use a more robust approach to find episodes with get_episode
3. Properly log errors for missing episodes instead of silently failing
4. Continue processing other episodes even if one is not found

This directly addresses the PR objective of improving episode handling during manual scraping.