feat: OkHttp implementation for making HTTP calls and WebSocket connections

[ttypic]

Resolves https://github.com/ably/ably-java/issues/120

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced support for using the Ably SDK under a proxy, with detailed instructions in the README.
  • Added a new network-client-okhttp module to enhance HTTP and WebSocket connections.
  • Implemented classes for HTTP calls and WebSocket clients using the OkHttp library.
  • Enhanced WebSocket functionality with ping listener support in the new classes.

• Documentation

  • Enhanced README with proxy configuration details and examples.

• Chores

  • Updated project settings to include the new network-client-okhttp module.

[coderabbitai[bot]]

Walkthrough

The changes introduce a new module, network-client-okhttp, implementing HTTP and WebSocket functionality using the OkHttp library. The README.md file has been updated to include instructions for using the Ably SDK under a proxy. Build configuration files have been modified to include necessary dependencies, and new classes and utility methods have been added to facilitate HTTP calls and WebSocket connections, including proxy settings and SSL configurations.

Changes

Files	Change Summary
README.md	Added a section on using the Ably SDK under a proxy, including configuration instructions and a Java example.
gradle/libs.versions.toml	Introduced a new dependency for the okhttp library (version "4.12.0") and test-retry library (version "1.6.0").
network-client-default/build.gradle.kts	Changed dependency scope from api to implementation for network-client-core.
network-client-okhttp/build.gradle.kts	Created a new build configuration for the network-client-okhttp module, specifying dependencies and Java compatibility.
network-client-okhttp/src/main/java/io/ably/lib/network/OkHttpWebSocketClient.java	Implemented WebSocket client functionality using OkHttp.
network-client-okhttp/src/main/java/io/ably/lib/network/OkHttpWebSocketEngine.java	Introduced OkHttpWebSocketEngine for creating WebSocket clients.
settings.gradle.kts	Added inclusion of the network-client-okhttp module in the project configuration.
.github/workflows/integration-test.yml	Introduced new jobs for integration testing with OkHttp configuration.
build.gradle.kts	Added test.retry plugin for enhanced testing capabilities.
java/build.gradle.kts	Enhanced testing framework with retry capabilities and conditional dependency management.
android/src/androidTest/java/io/ably/lib/test/RetryTestRule.java	Added a new class RetryTestRule to implement test retry functionality.
android/src/androidTest/java/io/ably/lib/test/android/AndroidPushTest.java	Integrated RetryTestRule into AndroidPushTest class for improved test reliability.

Assessment against linked issues

Objective	Addressed	Explanation
Expand proxy support for HTTP and WebSocket connections (#120)	✅
Allow manual proxy configuration for HTTP and WebSocket (#120)	✅

Poem

In the meadow where the bunnies play,
New changes hop in, brightening the day.
With OkHttp, we call and connect,
WebSockets dancing, all perfect!
Proxy settings, oh what a treat,
A joyful leap, our work's complete! 🐇✨

---

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