Testing: handle case when connectionKey contains more than one '-' #1903

amnonbc · 2024-10-22T19:05:48Z

Summary by CodeRabbit

Bug Fixes
- Improved handling of connection states during online and offline transitions.
- Enhanced error management for connection tests to ensure proper resource cleanup.
New Features
- Added comprehensive test cases for connection recovery and persistence of transport settings.
- Refined event simulation for accurate representation of network connectivity changes.

coderabbitai · 2024-10-22T19:05:57Z

Walkthrough

The pull request introduces modifications to the connection.test.js file, enhancing the handling of connection states and connection keys. Key updates include improved logic for extracting connection keys, expanded test cases for various connection scenarios, enhanced error handling, and refined event simulation for online and offline states. These changes aim to ensure robust testing of connection behaviors, including state transitions and recovery processes.

Changes

File	Change Summary
test/browser/connection.test.js	- Modified `connectionHmac` function for better key extraction.
	- Added test cases for connection state transitions (offline/online) and recovery on page refresh.
	- Enhanced error handling with structured try-catch blocks.
	- Refined simulation of online and offline events.

Possibly related PRs

Ignore instance id when comparing connections keys #1879: This PR introduces the connectionHmac function, which processes connection keys similarly to the modifications made in the main PR, enhancing the logic for extracting parts of the connection key and affecting the sameConnection function.

Suggested reviewers

owenpearson

Poem

In the land of code where rabbits play,
Connection tests hop and sway.
With keys in hand, we check the flow,
From offline to online, watch them go!
Errors caught, no need to fret,
Robust and ready, our tests are set! 🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 0bd7aa5 and 46823bc.

📒 Files selected for processing (1)

test/browser/connection.test.js (1 hunks)

🧰 Additional context used

🔇 Additional comments (2)

test/browser/connection.test.js (2)

221-224: Correctly handling connection keys with multiple '-' characters

The updated logic using lastIndexOf('-') appropriately removes the handleID from the connection key, even when the key contains multiple '-' characters. This ensures that the HMAC portion is preserved accurately.

227-228: Proper extraction of HMAC after '!' character

The condition if (key.includes('!')) and splitting the key on '!' correctly handle cases where the connection key includes an instance ID. This ensures that only the HMAC portion is returned after removing both the handleID and the instance ID.

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.

VeskeR · 2024-10-23T10:50:52Z

test/browser/connection.test.js

-        let k = key.split('-')[0];
+        const lastIndex = key.lastIndexOf('-');
+        if (lastIndex !== -1) {
+          key = key.slice(0, lastIndex);


I think key is never declared now?
should add let key; before if statement

I think in line 217, it is declared as a parameter of function connectionHmac?

right, sorry, it was outside of the visible diff, didn't see it

i do think we should revert back to let k ... return k - it's bad practice to mutate arguments like this

i do think we should revert back to let k ... return k - it's bad practice to mutate arguments like this

agree

Testing: handle case when connectionKey contains more than one '-'

46823bc

github-actions bot deployed to staging/pull/1903/bundle-report October 22, 2024 19:06 View deployment

github-actions bot deployed to staging/pull/1903/features October 22, 2024 19:06 View deployment

github-actions bot deployed to staging/pull/1903/typedoc October 22, 2024 19:06 View deployment

amnonbc requested a review from owenpearson October 22, 2024 19:06

VeskeR reviewed Oct 23, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Testing: handle case when connectionKey contains more than one '-' #1903

Testing: handle case when connectionKey contains more than one '-' #1903

amnonbc commented Oct 22, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 22, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

VeskeR Oct 23, 2024

amnonbc Oct 23, 2024 •

edited

Loading

VeskeR Oct 23, 2024 •

edited

Loading

owenpearson Oct 23, 2024

VeskeR Oct 25, 2024

Testing: handle case when connectionKey contains more than one '-' #1903

Are you sure you want to change the base?

Testing: handle case when connectionKey contains more than one '-' #1903

Conversation

amnonbc commented Oct 22, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Oct 22, 2024 • edited Loading

Walkthrough

Changes

Possibly related PRs

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

VeskeR Oct 23, 2024

Choose a reason for hiding this comment

amnonbc Oct 23, 2024 • edited Loading

Choose a reason for hiding this comment

VeskeR Oct 23, 2024 • edited Loading

Choose a reason for hiding this comment

owenpearson Oct 23, 2024

Choose a reason for hiding this comment

VeskeR Oct 25, 2024

Choose a reason for hiding this comment

amnonbc commented Oct 22, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 22, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

amnonbc Oct 23, 2024 •

edited

Loading

VeskeR Oct 23, 2024 •

edited

Loading