refactor: decouple HTTP and WebSocket engines

[ttypic]

• Extracted HTTP calls and WebSocket listeners into a separate module.
• Introduced an abstraction layer for easier implementation swapping.

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced new Gradle build configurations for network-client-core and network-client-default modules to streamline development.
  • Added essential libraries and dependencies to enhance functionality and testing capabilities.
  • Implemented new classes and interfaces for HTTP and WebSocket handling, improving network communication features.

• Bug Fixes

  • Updated method signatures to improve handling of HTTP requests and responses.

• Refactor

  • Refactored project structure to improve modularity and maintainability.

• Chores

  • Updated project settings to include new modules for better organization.
  • Enhanced metadata in gradle.properties files for improved project management.

[coderabbitai[bot]]

Walkthrough

The changes include updates to the CONTRIBUTING.md file, which now features a new section on adding network engine implementations. Additionally, several new interfaces have been introduced in the io.ably.lib.network package, including HttpCall, HttpEngine, WebSocketClient, WebSocketEngine, WebSocketEngineFactory, and WebSocketListener. These interfaces define the structures and methods for managing HTTP requests and WebSocket connections, enhancing the library's network functionality.

Changes

File/Path	Change Summary
CONTRIBUTING.md	Added a new section titled "Adding a New Network Engine Implementation," detailing the support for Default and OkHttp engines, including implementation processes and code snippets.
network-client-core/src/main/java/io/ably/lib/network/HttpCall.java	Introduced HttpCall interface with methods execute() and cancel(), designed for cancelable HTTP requests.
network-client-core/src/main/java/io/ably/lib/network/HttpEngine.java	Introduced HttpEngine interface with methods call(HttpRequest request) and isUsingProxy(), defining an HTTP engine for cancelable requests.
network-client-core/src/main/java/io/ably/lib/network/HttpEngineFactory.java	Added HttpEngineFactory interface with static methods for retrieving available HTTP engine factories and instance methods for creating engines based on configuration.
network-client-core/src/main/java/io/ably/lib/network/WebSocketClient.java	Introduced WebSocketClient interface with methods for managing WebSocket connections, including connect(), close(), cancel(), and send().
network-client-core/src/main/java/io/ably/lib/network/WebSocketEngine.java	Introduced WebSocketEngine interface with a method create(String url, WebSocketListener listener) for creating WebSocket clients.
network-client-core/src/main/java/io/ably/lib/network/WebSocketEngineFactory.java	Added WebSocketEngineFactory interface with static methods for retrieving WebSocket engine factories and instance methods for creating engines based on configuration.
network-client-core/src/main/java/io/ably/lib/network/WebSocketListener.java	Introduced WebSocketListener interface with callback methods for handling WebSocket events, including connection open, message reception, and error handling.

Poem

🐇 In the meadow where code does play,
New classes hop and dance all day.
With WebSockets and HTTP calls,
Our project now stands tall,
Lombok's magic, less code to sway,
In this vibrant code ballet! 🌼

---

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.