Fix connection issues

[theshadow76]

Summary by CodeRabbit

• New Features

  • Added comprehensive, user-friendly documentation with installation guides, usage examples, architecture diagrams, configuration options, and a changelog.
  • Introduced advanced monitoring, diagnostics, and performance analytics in the documentation.
  • Added support for persistent and multi-region connections, connection pooling, and full SSID format support.
  • Enhanced error handling, logging control, and asynchronous event handling.
  • Provided new testing tools and scripts for connection, balance, order placement, and candle data retrieval.

• Bug Fixes

  • Fixed order tracking and result checking, ensuring accurate detection and handling of order lifecycle events.
  • Corrected demo/live mode selection and SSID parsing to respect user settings.
  • Improved handshake and connection reliability, including robust reconnection and keep-alive logic.
  • Resolved issues with minimum order duration, now allowing durations as low as 5 seconds.

• Documentation

  • Completely overhauled and expanded the README with detailed sections for all user-facing features and advanced usage.
  • Added contribution guidelines, support channels, and licensing information.

• Tests

  • Introduced multiple new test scripts covering connection, balance retrieval, candle data, order placement, and complete order lifecycle tracking.
  • Added tests for demo/live mode handling, logging behavior, and message formatting.

• Refactor

  • Refactored core client logic for improved clarity, modularity, and maintainability, including event handler setup, order management, and connection flow.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This update introduces major enhancements to the PocketOption Async API client and its documentation. The README is fully rewritten, providing comprehensive usage, architecture, and testing details. The core client is refactored for robust asynchronous order and candle tracking, persistent and multi-region connections, improved logging, and error handling. Numerous new and updated test scripts validate connection, order, and candle functionality, as well as recent bug fixes.

Changes

File(s)	Change Summary
README.md, README_ENHANCED.md	README completely rewritten and expanded; new introductory and support sections added.
pocketoptionapi_async/client.py	Major refactor: persistent/multi-region connections, enhanced async order/candle tracking, logging control, error handling, new methods and events.
pocketoptionapi_async/constants.py, pocketoptionapi_async/models.py	Regions class: added get_all_regions(); API minimum duration reduced to 5 seconds; Order validation updated for 5s minimum.
pocketoptionapi_async/websocket_client.py	Handshake rewritten for protocol compliance; message processing extended for bytes/JSON; improved event emission and logging.
test.py	Refactored to async main function with explicit connect/disconnect, error handling, and improved flow.
test_balance_fix.py, test_candles_fix.py, test_complete_order_tracking.py, test_demo_live_connection.py, test_demo_live_fix.py, test_fixed_connection.py, test_order_fix.py, test_order_logging_fixes.py, test_order_placement_fix.py, test_order_tracking_complete.py, test_order_tracking_fix.py	New/updated test scripts: verify connection, order/candle tracking, demo/live modes, logging, and recent bug fixes.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant AsyncPocketOptionClient
    participant WebSocketClient
    participant PocketOptionServer

    User->>AsyncPocketOptionClient: connect(regions, persistent)
    AsyncPocketOptionClient->>WebSocketClient: initiate connection
    WebSocketClient->>PocketOptionServer: handshake & authenticate
    PocketOptionServer-->>WebSocketClient: handshake response
    WebSocketClient-->>AsyncPocketOptionClient: emit 'authenticated'
    AsyncPocketOptionClient->>WebSocketClient: subscribe/init data
    User->>AsyncPocketOptionClient: place_order(asset, amount, direction, duration)
    AsyncPocketOptionClient->>WebSocketClient: send order
    PocketOptionServer-->>WebSocketClient: order confirmation/result
    WebSocketClient-->>AsyncPocketOptionClient: emit 'order_opened'/'order_closed'
    AsyncPocketOptionClient-->>User: return OrderResult
    User->>AsyncPocketOptionClient: get_candles(asset, timeframe, count)
    AsyncPocketOptionClient->>WebSocketClient: request candles
    PocketOptionServer-->>WebSocketClient: candles data
    WebSocketClient-->>AsyncPocketOptionClient: emit 'candles_received'
    AsyncPocketOptionClient-->>User: return candles

Loading

Poem

In the warren of code, new tunnels appear,
Async connections hop far and near!
Orders tracked, candles bright,
Regions and logging—now all just right.
With tests that leap and docs that shine,
This rabbit’s API is simply divine!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bcf7ace and 5c639b5.

📒 Files selected for processing (18)

• README.md (2 hunks)
• README_ENHANCED.md (1 hunks)
• pocketoptionapi_async/client.py (16 hunks)
• pocketoptionapi_async/constants.py (3 hunks)
• pocketoptionapi_async/models.py (1 hunks)
• pocketoptionapi_async/websocket_client.py (4 hunks)
• test.py (1 hunks)
• test_balance_fix.py (1 hunks)
• test_candles_fix.py (1 hunks)
• test_complete_order_tracking.py (1 hunks)
• test_demo_live_connection.py (1 hunks)
• test_demo_live_fix.py (1 hunks)
• test_fixed_connection.py (1 hunks)
• test_order_fix.py (1 hunks)
• test_order_logging_fixes.py (1 hunks)
• test_order_placement_fix.py (1 hunks)
• test_order_tracking_complete.py (1 hunks)
• test_order_tracking_fix.py (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.