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

fix: jellyfin test notification endpoint update #8766

Open
wants to merge 9 commits into
base: develop
Choose a base branch
from

Conversation

speedfreak01
Copy link

@speedfreak01 speedfreak01 commented Jun 8, 2024

Summary

In a recent update to Jellyfin (v10.9.0), they have merged a change which removes the older Emby Notifications endpoint which sickchill used when checking if an api key and url provided were correct.

My fix changes the endpoint used for something that does exist and still requires authentication.

Jellyfin PR that removes the endpoint: jellyfin/jellyfin#8952

Proposed changes in this pull request:

  • Replace Notifications/Admin endpoint with System/Endpoint for jellyfin notifier.

Checklist

  • PR is based on the DEVELOP branch
  • Don't send big changes all at once. Split up big PRs into multiple smaller PRs that are easier to manage and review
  • Read contribution guide

Summary by CodeRabbit

  • Bug Fixes
    • Updated Jellyfin notification to use the correct API endpoint and HTTP method, ensuring accurate data retrieval.

Copy link
Contributor

coderabbitai bot commented Jun 8, 2024

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The _notify_jellyfin method in the Notifier class has been updated to change the URL endpoint from creating an admin notification to retrieving endpoint information. Additionally, the HTTP method has been modified from POST to GET, and the method signature has been altered to remove the message parameter.

Changes

File Change Summary
sickchill/oldbeard/notifiers/jellyfin.py Modified _notify_jellyfin method to use a different URL endpoint and change HTTP method to GET. Also, removed the message parameter from the method signature.

Sequence Diagram(s)

sequenceDiagram
    participant Notifier
    participant JellyfinAPI

    Notifier->>JellyfinAPI: GET /endpoint-information
    JellyfinAPI-->>Notifier: Endpoint information response
Loading

Poem

In code so fine, a change we see,
From POST to GET, simplicity.
No message now, just endpoint's call,
Jellyfin's info, we fetch it all.
With each new tweak, our software grows,
A smoother path, the data flows.
🐇✨


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

@speedfreak01
Copy link
Author

@coderabbitai review

Copy link
Contributor

coderabbitai bot commented Jun 8, 2024

Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Outside diff range and nitpick comments (1)
sickchill/oldbeard/notifiers/jellyfin.py (1)

27-27: Check for adequate logging.

Consider enhancing the logging by including more details about the request, such as headers or parameters, which could be useful for debugging.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 19e898b and c69ba4a.

Files selected for processing (1)
  • sickchill/oldbeard/notifiers/jellyfin.py (2 hunks)
Additional comments not posted (4)
sickchill/oldbeard/notifiers/jellyfin.py (4)

14-14: Updated method signature and endpoint URL.

The method signature and endpoint URL have been updated as per the Jellyfin API changes. Ensure that all calls to _notify_jellyfin are updated to match the new signature.

Also applies to: 19-20


42-42: Wrapper method correctly forwards parameters.

The test_notify method correctly forwards parameters to _notify_jellyfin. Ensure that the changes in _notify_jellyfin are reflected here if any additional parameters are later added or modified.


42-42: Ensure correct API endpoint usage in update_library.

Verify that the API endpoints used in update_library are correct and up-to-date with the Jellyfin API documentation.


27-27: Ensure proper error handling.

Ensure that all possible exceptions are caught and handled appropriately, especially given the change in HTTP method which might affect the response behavior.

@speedfreak01
Copy link
Author

Additional refactor looks good 👍 I didn't really think to do any cleanup!

@miigotu miigotu enabled auto-merge (squash) June 11, 2024 15:13
remove last line
@BKSteve
Copy link
Collaborator

BKSteve commented Jun 12, 2024

Ran poe format which spotted the 2 blank lines at the end of the jellyfin.py file.

@BKSteve BKSteve disabled auto-merge June 20, 2024 15:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants