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 TypeError: '>' not supported between instances of 'float' and 'NoneType' in http #573

Merged
merged 1 commit into from
Jan 10, 2025

Conversation

VeskeR
Copy link
Contributor

@VeskeR VeskeR commented Jan 9, 2025

See internal slack discussion for errors received by a client: https://ably-real-time.slack.com/archives/CURL4U2FP/p1735900004756929.

Fixes the race condition error in http.get_rest_hosts when options.fallback_realtime_host is set.
You can see the error being reproduced in CI in this run: https://github.com/ably/ably-python/actions/runs/12692221157/job/35377048528?pr=573

Summary by CodeRabbit

  • Tests

    • Added two new test cases to verify the behavior of REST host retrieval under different fallback host configurations.
    • Ensures proper functionality of host retrieval with and without a fallback realtime host.
  • Bug Fixes

    • Improved host expiration logic to clarify checks for valid expiration time before evaluating host expiration.

Copy link

coderabbitai bot commented Jan 9, 2025

Walkthrough

The pull request introduces modifications to the host expiration logic in the get_rest_hosts method of the Http class. The changes involve a more explicit condition for checking host expiration by first verifying if the expiration time exists. Corresponding unit tests have been added to validate the behavior of REST host retrieval under different fallback host configurations.

Changes

File Change Summary
ably/http/http.py Updated host expiration check to explicitly verify self.__host_expires is not None. Added a comment regarding "unstoring" the fallback host after timeout.
test/unit/http_test.py Added two new test functions to validate get_rest_hosts method behavior with different fallback host scenarios.

Poem

🐰 Hosts expire, but logic stays clear
A rabbit's code, with conditions sincere
Fallback paths, now tested with care
Explicit checks, beyond compare
Hopping through networks, without a fear! 🌐


📜 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 36a599e and 1c22c68.

📒 Files selected for processing (2)
  • ably/http/http.py (1 hunks)
  • test/unit/http_test.py (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • ably/http/http.py
  • test/unit/http_test.py
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: check (3.12)
  • GitHub Check: check (3.11)
  • GitHub Check: check (3.10)
  • GitHub Check: check (3.9)
  • GitHub Check: check (3.8)

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>, 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@VeskeR VeskeR changed the title Fix type comparison error in http [WIP] Fix type comparison error in http Jan 9, 2025
@github-actions github-actions bot temporarily deployed to staging/pull/573/features January 9, 2025 14:24 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/573/features January 9, 2025 14:30 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/573/features January 9, 2025 14:44 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/573/features January 9, 2025 14:48 Inactive
@VeskeR VeskeR force-pushed the http-fallback-host-fix branch 2 times, most recently from 750dc29 to 20cbabf Compare January 9, 2025 14:54
@VeskeR VeskeR changed the title [WIP] Fix type comparison error in http Fix TypeError: '>' not supported between instances of 'float' and 'NoneType' in http Jan 9, 2025
@github-actions github-actions bot temporarily deployed to staging/pull/573/features January 9, 2025 14:55 Inactive
@VeskeR VeskeR force-pushed the http-fallback-host-fix branch from 20cbabf to 36a599e Compare January 9, 2025 14:56
@github-actions github-actions bot temporarily deployed to staging/pull/573/features January 9, 2025 14:57 Inactive
@VeskeR VeskeR marked this pull request as ready for review January 9, 2025 14:57
@VeskeR VeskeR requested review from ttypic and sacOO7 January 9, 2025 14:57
Copy link

@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: 2

🧹 Nitpick comments (2)
ably/http/http.py (1)

149-150: The fix looks good but could be more robust.

The explicit None check prevents the TypeError, but we could make the code more maintainable by:

  1. Adding a comment explaining why the None check is necessary
  2. Using a more descriptive variable name for clarity

Consider this improvement:

-        # unstore saved fallback host after fallbackRetryTimeout (RSC15f)
-        if self.__host_expires is not None and time.time() > self.__host_expires:
+        # Check if fallback host has expired (RSC15f)
+        # host_expires can be None if no fallback host was cached or it was already cleared
+        fallback_host_expiry = self.__host_expires
+        if fallback_host_expiry is not None and time.time() > fallback_host_expiry:
test/unit/http_test.py (1)

1-13: Add test utilities for better maintainability.

The tests could benefit from utility functions to reduce duplication and improve readability.

Consider adding these utilities:

import time
from typing import List

def get_default_ably_rest() -> AblyRest:
    return AblyRest(token="foo")

def verify_host_list(hosts: List[str], expected_hosts: List[str], fallback_first: bool = False) -> None:
    """Verify that the host list contains all expected hosts in the correct order."""
    assert isinstance(hosts, list), "Expected list of hosts"
    assert all(isinstance(host, str) for host in hosts), "All hosts should be strings"
    assert set(hosts) == set(expected_hosts), "All expected hosts should be present"
    if fallback_first:
        assert hosts[0] == expected_hosts[-1], "Fallback host should be first"
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f98e3d1 and 36a599e.

📒 Files selected for processing (2)
  • ably/http/http.py (1 hunks)
  • test/unit/http_test.py (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: check (3.12)
  • GitHub Check: check (3.11)
  • GitHub Check: check (3.10)
  • GitHub Check: check (3.9)
  • GitHub Check: check (3.8)

test/unit/http_test.py Outdated Show resolved Hide resolved
test/unit/http_test.py Outdated Show resolved Hide resolved
Copy link
Collaborator

@sacOO7 sacOO7 left a comment

Choose a reason for hiding this comment

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

You can check coderabbit ai suggestions regarding tests, otherwise LGTM

Copy link
Collaborator

@sacOO7 sacOO7 left a comment

Choose a reason for hiding this comment

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

Also, not sure why CI is failing, can you check

@VeskeR VeskeR mentioned this pull request Jan 9, 2025
@VeskeR
Copy link
Contributor Author

VeskeR commented Jan 10, 2025

Mergin as tests failures are not related to this PR

@VeskeR VeskeR merged commit c7ca09b into main Jan 10, 2025
3 of 9 checks passed
@VeskeR VeskeR deleted the http-fallback-host-fix branch January 10, 2025 17:44
@coderabbitai coderabbitai bot mentioned this pull request Jan 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants