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 failing connection recovery tests #1957

Merged
merged 1 commit into from
Jan 27, 2025
Merged

Conversation

lawrence-forooghian
Copy link
Collaborator

@lawrence-forooghian lawrence-forooghian commented Jan 22, 2025

It seems like the Realtime connection key format, which as the removed comment implies is not guaranteed to be stable, has changed on sandbox. Stop using our knowledge of it.

Summary by CodeRabbit

  • Refactor
    • Updated connection key handling in test cases
    • Simplified connection identification logic
    • Replaced connection key references with connection ID

It seems like the Realtime connection key format, which as the removed
comment implies is not guaranteed to be stable, has changed on sandbox.
Stop using our knowledge of it.
Copy link

coderabbitai bot commented Jan 22, 2025

Walkthrough

The pull request modifies the test/browser/connection.test.js file by removing two functions: connectionHmac and sameConnection. These functions were previously used for processing and comparing connection keys. The changes reflect a shift from using connection keys to connection IDs in the test cases, simplifying the connection identification logic. The test structure remains consistent, but the underlying approach to handling connection-related assertions has been updated.

Changes

File Change Summary
test/browser/connection.test.js - Removed connectionHmac(key) function
- Removed sameConnection(keyA, keyB) function
- Replaced connectionKey with connectionId in test cases

Possibly related PRs

Suggested reviewers

  • VeskeR
  • ttypic
  • SimonWoolf

Poem

🐰 Connections shift, keys take flight,
IDs now dance in testing's light
Old functions fade, new logic gleams
Simplicity reigns in coding dreams
A rabbit's hop through test terrain! 🔑

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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.

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: 0

🧹 Nitpick comments (1)
test/browser/connection.test.js (1)

Line range hint 342-360: Consider improving the assertion message.

While the change to use connection ID is good, the assertion message could be more descriptive.

-              expect(newRealtime.connection.id).to.equal(connectionId, 'Check new realtime recovered the old');
+              expect(newRealtime.connection.id).to.equal(connectionId, 'Check connection was recovered using the recovery key');
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 18ed0f6 and 8bc268f.

📒 Files selected for processing (1)
  • test/browser/connection.test.js (6 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: test-node (20.x)
  • GitHub Check: test-browser (webkit)
  • GitHub Check: test-node (18.x)
  • GitHub Check: test-browser (firefox)
  • GitHub Check: test-node (16.x)
  • GitHub Check: test-browser (chromium)
🔇 Additional comments (3)
test/browser/connection.test.js (3)

Line range hint 234-253: LGTM! Good change to use connection ID instead of key.

The switch from connection key to connection ID makes the test more reliable since it doesn't depend on the unstable connection key format. The connection ID is a more stable identifier for verifying connection recovery.


Line range hint 278-297: LGTM! Consistent use of connection ID for denied recovery test.

The change maintains consistency with other tests by using connection ID instead of key, while correctly verifying that a new connection is created when recovery is denied.


Line range hint 1-1: Verify safe removal of connection key processing functions.

The PR removes connectionHmac and sameConnection functions. Let's verify they're not used elsewhere in the codebase.

✅ Verification successful

Functions safely removed - no remaining references found

Thorough codebase analysis confirms that connectionHmac and sameConnection functions have been completely removed with no remaining references, indicating a safe removal.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any remaining usage of the removed functions
echo "Searching for connectionHmac usage..."
rg "connectionHmac"

echo "Searching for sameConnection usage..."
rg "sameConnection"

Length of output: 209


Script:

#!/bin/bash
# Perform a more thorough search with case-insensitive matching and word boundaries
echo "Searching for connectionHmac usage (case-insensitive, word boundaries)..."
rg -iw "connectionHmac"

echo "Searching for sameConnection usage (case-insensitive, word boundaries)..."
rg -iw "sameConnection"

# Also search in the specific test file to see the context of removal
echo "Checking the test file context..."
rg -A 5 -B 5 "connectionHmac|sameConnection" "test/browser/connection.test.js" || echo "No matches in test file"

Length of output: 574

Copy link
Contributor

@VeskeR VeskeR left a comment

Choose a reason for hiding this comment

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

Thanks!

@lawrence-forooghian lawrence-forooghian merged commit 65a89fb into main Jan 27, 2025
14 checks passed
@lawrence-forooghian lawrence-forooghian deleted the fix-recovery-tests branch January 27, 2025 12:29
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