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

Update expected error code in a test #1935

Merged
merged 1 commit into from
Dec 9, 2024

Conversation

lawrence-forooghian
Copy link
Collaborator

@lawrence-forooghian lawrence-forooghian commented Dec 9, 2024

Realtime is now returning 40101 (invalid credentials) when unable to extract an app ID from the key. The Realtime team have confirmed (internal Slack thread) that this new behaviour is correct and that the test should be updated.

Summary by CodeRabbit

  • Bug Fixes
    • Updated expected error codes for connection failures with invalid credentials.
    • Enhanced error handling for operations on a failed channel.
    • Adjusted tests to verify connection lifecycle events with invalid hosts.
    • Modified timeout error checks for attaching to failed channels.

Realtime is now returning 40101 (invalid credentials) when unable to
extract an app ID from the key. The Realtime team have confirmed that
this new behaviour is correct and that the test should be updated [1].

[1] https://ably-real-time.slack.com/archives/CURL4U2FP/p1733479167314059?thread_ts=1733420816.469159&cid=CURL4U2FP
Copy link

coderabbitai bot commented Dec 9, 2024

Walkthrough

The changes in this pull request focus on refining the error handling logic within the test cases for the Ably Realtime library. Key modifications include updating expected error codes for connection failures due to invalid credentials, adjusting connection parameters for lifecycle testing with invalid hosts, and standardizing error codes for operations on failed channels. Additionally, timeout error handling has been improved for attaching to channels in a failed state. These updates ensure that the tests accurately reflect the expected behavior of the library under various failure conditions.

Changes

File Change Summary
test/realtime/failure.test.js - Updated expected error codes for connection failures with invalid credentials (from 40400 to 40101).
- Adjusted no_connection_lifecycle test for invalid hosts and verified connection state sequences.
- Enhanced failed_channel test to standardize error codes for operations on failed channels to 90001.
- Modified attach_timeout test to check for timeout errors with expected code 90007 and status 408.

Poem

🐇 In the realm of code where errors play,
A rabbit hops with joy today!
With codes refined and tests anew,
The library's strength shines bright and true.
Hooray for changes, let’s all cheer,
For smoother connections, year after year! 🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 416c9b0 and 8482d8c.

📒 Files selected for processing (1)
  • test/realtime/failure.test.js (1 hunks)
🔇 Additional comments (1)
test/realtime/failure.test.js (1)

34-36: LGTM! Error code update aligns with the service behavior.

The change from error code 40400 to 40101 correctly reflects the Realtime service's behavior when it fails to extract an app ID from the key.

Let's verify that this error code is consistently used across the codebase:


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

Copy link
Member

@SimonWoolf SimonWoolf left a comment

Choose a reason for hiding this comment

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

fine with this, though if you're swapping to t40101 instead of just removing the assertion, bear in mind there's a chance that this will then fail again if we have to temporarily switch sandbox back to frontends handling websockets

@lawrence-forooghian lawrence-forooghian merged commit 7984d55 into main Dec 9, 2024
14 checks passed
@lawrence-forooghian lawrence-forooghian deleted the change-error-code-expectation branch December 9, 2024 15:40
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.

2 participants