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

Ignore instance id when comparing connections keys #1879

Merged
merged 1 commit into from
Sep 30, 2024
Merged

Conversation

amnonbc
Copy link
Contributor

@amnonbc amnonbc commented Sep 29, 2024

The connection key returned by frontdoor has the form

<instance-id>!<hmac>-<handleID>

where <hmac> is a hash of connectionID, appID, and clientID.

The test page_refresh_with_recovery checks that the connection ID which we get when a connection is recovered,
it gets the same connectionID. It does this by stripping the handleID off the end of the connection key.
But in frontdoor, requests are handled by an arbitrary frontdoor instance, which is not necessarily the same instance
as the previous connection. So this PR ignores the instance id when performing the comparison.

Fixes https://ably.atlassian.net/browse/RAR-712

Summary by CodeRabbit

  • New Features

    • Introduced a function for improved handling of connection keys, enhancing the accuracy of connection comparisons.
  • Bug Fixes

    • Enhanced logic for determining if two connection keys represent the same connection by utilizing a new extraction method.

@github-actions github-actions bot temporarily deployed to staging/pull/1879/bundle-report September 29, 2024 07:20 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1879/features September 29, 2024 07:20 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1879/typedoc September 29, 2024 07:20 Inactive
@amnonbc
Copy link
Contributor Author

amnonbc commented Sep 29, 2024

@coderabbitai review

Copy link

coderabbitai bot commented Sep 29, 2024

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@github-actions github-actions bot temporarily deployed to staging/pull/1879/bundle-report September 29, 2024 07:23 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1879/features September 29, 2024 07:23 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1879/typedoc September 29, 2024 07:23 Inactive
Copy link

coderabbitai bot commented Sep 29, 2024

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai[bot]

This comment was marked as resolved.

@github-actions github-actions bot temporarily deployed to staging/pull/1879/typedoc September 29, 2024 07:29 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1879/features September 29, 2024 07:29 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1879/bundle-report September 29, 2024 07:29 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1879/bundle-report September 29, 2024 08:49 Inactive
@amnonbc amnonbc marked this pull request as ready for review September 29, 2024 08:49
@github-actions github-actions bot temporarily deployed to staging/pull/1879/features September 29, 2024 08:49 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1879/typedoc September 29, 2024 08:49 Inactive
@ably ably deleted a comment from coderabbitai bot Sep 29, 2024
Copy link

coderabbitai bot commented Sep 29, 2024

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link

coderabbitai bot commented Sep 29, 2024

Walkthrough

The changes introduce a new function, connectionHmac, which extracts specific parts from a connection key by removing the handle ID and, if applicable, the instance ID. This function splits the key on a hyphen and checks for an exclamation mark to determine whether to skip the instance ID. Additionally, the existing sameConnection function has been modified to incorporate connectionHmac, enhancing the logic for comparing connection keys.

Changes

File Change Summary
test/browser/connection.test.js Added connectionHmac(key) function; modified sameConnection to use connectionHmac.

Poem

In the realm of keys, a change takes flight,
A rabbit hops in, with logic so bright.
ConnectionHmac, a clever new friend,
Splitting and checking, on it we depend.
With each little tweak, our code's a delight,
Hopping along, making everything right! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 0042004 and 93c4059.

📒 Files selected for processing (1)
  • test/browser/connection.test.js (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • test/browser/connection.test.js

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.

@amnonbc amnonbc requested a review from owenpearson September 29, 2024 08:54
@github-actions github-actions bot temporarily deployed to staging/pull/1879/bundle-report September 29, 2024 09:06 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1879/typedoc September 29, 2024 09:07 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1879/features September 29, 2024 09:07 Inactive
Copy link
Member

@owenpearson owenpearson left a comment

Choose a reason for hiding this comment

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

looks good!

@owenpearson owenpearson merged commit 458c1ca into main Sep 30, 2024
14 checks passed
@owenpearson owenpearson deleted the fix_RTN16D branch September 30, 2024 12:08
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