Draft: Add support to keep a Radarr item that contains a specific tag

[tiagodj]

Description

Add support to configure a tag that, if such tag is added to the Radarr item, Watchlistarr will skip and not delete that entry from Radarr when the associated movie is removed from Plex Watchlist.

Checklist

• [ ] Documentation Updated
• [ ] sbt scalafmtAll Run (and optionally sbt scalafmtSbt)
• [ ] At least one approval from a codeowner

Summary by CodeRabbit

• New Features
  • Introduced a new configuration option that lets users specify a skip tag to prevent unwanted movie deletion in Radarr.
  • Enhanced deletion logic to respect the skip tag setting, improving the safety of automated operations.
  • Upgraded Radarr tagging functionality so that configurations now clearly include the new skip tag option for greater control.

[coderabbitai[bot]]

Walkthrough

The pull request introduces a new Radarr configuration option and extends several Radarr-related functionalities. A commented configuration line is added to specify a "skip tag" for bypassing movie deletion in Radarr. Related Scala files are updated to include a new field in the configuration, adjust conversion logic to accommodate a tags list in movies, and modify deletion logic to check for the presence of the skip tag. Additional utility methods in Radarr integrations and test configurations are also modified accordingly.

Changes

File(s)	Change Summary
src/main/resources/config-template.yaml	Added a commented skipTag: "keep" line in the Radarr section as a new configuration option.
src/main/scala/configuration/Configuration.scala, ConfigurationRedactor.scala, ConfigurationUtils.scala, Keys.scala	Updated Radarr configuration to include a new radarrSkipTag field; modified string redactor, utility functions, and added a new constant for handling the skip tag.
src/main/scala/PlexTokenDeleteSync.scala	Modified the deleteMovie method to extract the TMDB ID, check for the skip tag using hasSkipMovieTag, log warnings/errors, and conditionally skip movie deletion.
src/main/scala/radarr/RadarrConversions.scala, RadarrMovie.scala	Updated the conversion to instantiate RadarrMovie with an additional empty list for tags; modified the RadarrMovie case class to include a tags: List[Int] parameter.
src/main/scala/radarr/RadarrTag.scala	Introduced a new case class RadarrTag(label: String, id: Int) for representing Radarr tags.
src/main/scala/radarr/RadarrUtils.scala	Added new methods getSkipTagId and hasSkipMovieTag to handle skip tag retrieval and checking; updated HTTP request methods to support query parameters via getToArrWithParams.
src/test/scala/PlexTokenSyncSpec.scala	Updated test configuration by adding "keep" to the Radarr tag IDs set.

Sequence Diagram(s)

sequenceDiagram
    participant R as Requester
    participant Sync as PlexTokenDeleteSync
    participant Utils as RadarrUtils
    participant Radarr as Radarr API
    R->>Sync: deleteMovie(movie)
    Sync->>Sync: Extract TMDB ID from movie
    Sync->>Utils: hasSkipMovieTag(apiKey, baseUrl, skipTag, tmdbId)
    alt Skip tag exists
        Utils-->>Sync: true
        Sync->>Sync: Log "deletion will be skipped"
        Sync-->>R: Return without deletion
    else No skip tag
        Utils-->>Sync: false
        Sync->>Radarr: deleteFromRadarr(movie)
        Radarr-->>Sync: Deletion result
        Sync-->>R: Return deletion result
    end

Poem

I'm a clever rabbit, leaping high,
New tags and checks make my code fly.
With a skip tag to guide the way,
Movies are spared at the end of the day.
Hoppin' through changes, I cheer in delight!

[!TIP]

🌐 Web search-backed reviews and chat

• We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
• You can disable this feature by setting web_search: false in the knowledge_base settings.
• Please share any feedback in the Discord discussion.

---

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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.

[tiagodj]

Please note, I've never coded in Scala before, so feel free to suggest changes.