feat(shuttle): Parametrize hub connection timeouts for HubSubscriber & MessageReconciliation #2367
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…and MessageReconciliation
🦋 Changeset detectedLatest commit: 7d66f04 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #2367 +/- ##
===========================================
- Coverage 74.05% 34.96% -39.10%
===========================================
Files 99 146 +47
Lines 9425 26201 +16776
Branches 2097 9297 +7200
===========================================
+ Hits 6980 9162 +2182
- Misses 2327 14675 +12348
- Partials 118 2364 +2246 ☔ View full report in Codecov by Sentry. |
sanjayprabhu
approved these changes
Oct 15, 2024
| @@ -767,7 +767,7 @@ describe("shuttle", () => { | |||
| }; | |||
|
|
|||
| // Only include 2 of the 3 messages in the time window | |||
| const reconciler = new MessageReconciliation(mockRPCClient as unknown as HubRpcClient, db, log); | |||
| const reconciler = new MessageReconciliation(mockRPCClient as unknown as HubRpcClient, db, log, 500); | |||
There was a problem hiding this comment.
I would make this a few ms shorter (or the timeout above longer) so we don't have flaky tests
tybook
added a commit
to tybook/hub-monorepo
that referenced
this pull request
Oct 25, 2024
…riber Follow-up to farcasterxyz#2367. Missed piping through BaseHubSubscriber's new `connectionTimeout` param through to EventStreamHubSubscriber.
tybook
added a commit
to tybook/hub-monorepo
that referenced
this pull request
Oct 25, 2024
…riber
Follow-up to farcasterxyz#2367. Missed piping through BaseHubSubscribers new `connectionTimeout` param through to EventStreamHubSubscriber.
4 tasks
sanjayprabhu
pushed a commit
that referenced
this pull request
Oct 28, 2024
…riber (#2382) ## Why is this change needed? Follow-up to #2367. I missed piping through BaseHubSubscriber's new `connectionTimeout` param through to EventStreamHubSubscriber, which means `connectionTimeout` isn't really configurable for streaming right now like it should be. ## Merge Checklist _Choose all relevant options below by adding an `x` now or at any time before submitting for review_ - [x] PR title adheres to the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) standard - [x] PR has a [changeset](https://github.com/farcasterxyz/hub-monorepo/blob/main/CONTRIBUTING.md#35-adding-changesets) - [ ] PR has been tagged with a change label(s) (i.e. documentation, feature, bugfix, or chore) - [x] PR includes [documentation](https://github.com/farcasterxyz/hub-monorepo/blob/main/CONTRIBUTING.md#32-writing-docs) if necessary. <!-- start pr-codex --> --- ## PR-Codex overview This PR focuses on adding a new optional parameter, `connectionTimeout`, to the `EventStreamHubSubscriber` class, allowing for better control over connection timeouts. ### Detailed summary - Added `connectionTimeout?: number` as an optional parameter in the constructor of `EventStreamHubSubscriber`. - Updated the call to `super` in the constructor to include the new `connectionTimeout` argument. > ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}` <!-- end pr-codex -->
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why is this change needed?
Running the latest version of Shuttle with its fixed 5000ms hub connection timeout for reconciliation has resulted in a lot of timeout failures even against a seemingly healthy hub. I've increased the default connection timeout of MessageReconciliation from 5000ms to 30000ms to match HubSubscriber's and parameterized both.
Merge Checklist
Choose all relevant options below by adding an
xnow or at any time before submitting for reviewPR-Codex overview
This PR introduces parameterized connection timeouts for the
HubSubscriberandMessageReconciliationclasses, allowing for more flexible timeout settings in handling unresponsive connections.Detailed summary
connectionTimeoutparameter to the constructors ofMessageReconciliationandBaseHubSubscriber, defaulting to 30000 milliseconds.MessageReconciliationto useconnectionTimeout.