Add HTTP debug logs

[nylonee]

Description

Add debug logs for HTTP requests to better identify issues around requests we send to Plex and other services

Checklist

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

Summary by CodeRabbit

• New Features
  • Enhanced logging for HTTP requests to provide better insights and debugging capabilities.

[coderabbitai]

Walkthrough

In the HttpClient.scala file, logging functionality was added using SLF4J. This includes new logging statements to enhance debugging before and after making HTTP requests, providing better insight into the execution flow.

Changes

File	Change Summary
.../main/scala/http/HttpClient.scala	Addition of SLF4J for logging and new log statements for debugging

Sequence Diagram(s)

sequenceDiagram
    participant Client as Application Client
    participant HttpClient as HttpClient
    participant Logger as SLF4J Logger
    
    Client->>HttpClient: Send HTTP Request
    HttpClient->>Logger: Log request start
    HttpClient->>HttpClient: Make HTTP Request
    HttpClient->>Logger: Log request end
    HttpClient-->>Client: Return HTTP Response

Loading

Poem

In the world of bytes and binary,
Logs now sparkle, clarity so fine.
Debugging made easy, no longer weary,
With SLF4J, the code now shines.
An HTTP dance, now tracked neatly,
Bugs and woes defeated completely. 🐇✨

---

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>.
  • 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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6e9fb57 and 57d7823.

Files selected for processing (1)

• src/main/scala/http/HttpClient.scala (2 hunks)

Additional comments not posted (3)

src/main/scala/http/HttpClient.scala (3)

12-12: Approved import addition for logging.

The import of LoggerFactory is correctly placed and follows Scala's convention for integrating logging.

---

18-18: Logger instance correctly declared.

The logger instance is declared as private and uses getClass to ensure it logs with the correct class context, which is a good practice in Scala for class-specific logging.

---

67-74: Review the added logging statements.

The debug logging before and after the HTTP request is appropriate. However, consider improving the log message format to include more context or differentiate the request and response more clearly.
[REFACTOR_SUGGESTion]

-    logger.debug(s"HTTP Request: ${requestWithPayload.toString()}")
+    logger.debug(s"HTTP Request - Method: ${method.name}, URL: ${url.toString}, Headers: ${requestWithPayload.headers}")
-    logger.debug(s"HTTP Response: $response")
+    logger.debug(s"HTTP Response - Status: ${response.status.code}, Body: ${response.asString}")