feat: support backup relayers #640
Conversation
WalkthroughThe code changes introduce a backup relayer mechanism that allows for a secondary relaying process to take over if the primary relayer fails. This includes new flags for enabling the backup relayer and setting a wait time before it takes action, as well as logic to handle the conditional relaying based on these settings. Changes
Assessment against linked issues
Related issues
Poem
TipsChat with CodeRabbit Bot (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 4
Configuration used: CodeRabbit UI
Files selected for processing (5)
- cmd/blobstream/base/config.go (2 hunks)
- cmd/blobstream/relayer/cmd.go (1 hunks)
- cmd/blobstream/relayer/config.go (3 hunks)
- relayer/relayer.go (5 hunks)
- testing/blobstream.go (1 hunks)
Additional comments: 11
cmd/blobstream/base/config.go (4)
85-91: The addition of the new flags
FlagBackupRelayerandFlagBackupRelayerWaitTimealigns with the PR objective to introduce backup relayer functionality. These flags will enable the configuration of a relayer to act as a backup and define the wait time before taking action.277-282: The
AddBackupRelayerFlagfunction correctly adds a boolean flag to enable the backup relayer functionality. The description provided in the flag is clear and indicates the intended behavior when the flag is set to true.294-298: The
AddBackupRelayerWaitTimeFlagfunction adds a flag to specify the wait time for a backup relayer. The default value is set to 15, which is assumed to be minutes based on the comment. Please verify that this unit is intentional and consistent with the rest of the system's time units.277-311: The newly added functions for handling the backup relayer flags are consistent with the existing pattern of flag management in the file. This maintains a clean and consistent codebase.
cmd/blobstream/relayer/cmd.go (1)
- 206-211: The changes to the
NewRelayerfunction call with the addition ofconfig.isBackupRelayerandtime.Duration(config.backupRelayerWaitTime)*time.Minutealign with the PR objective to implement backup relayer functionality. Ensure that all other parts of the codebase that interact with theNewRelayerfunction are updated to handle the new signature.cmd/blobstream/relayer/config.go (2)
140-141: The validation logic in
ValidateBasicscorrectly ensures thatbackupRelayerWaitTimeis not zero whenisBackupRelayeris set to true, aligning with the PR objective to handle backup relayer functionality.266-276: The parsing logic in
parseRelayerStartFlagscorrectly handles the new backup relayer flags and updates theStartConfigstruct accordingly.relayer/relayer.go (3)
33-43: The addition of
IsBackupRelayerandBackupRelayerWaitTimefields to theRelayerstruct aligns with the PR objective to support backup relayers.52-71: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [46-70]
The
NewRelayerfunction correctly accepts and initializes the newIsBackupRelayerandBackupRelayerWaitTimefields, which is necessary for the backup relayer feature.
- 102-118: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [77-146]
The conditional logic in the
Startmethod based on theIsBackupRelayerfield correctly implements the intended behavior for backup relayers to wait before relaying if the official relayer fails.testing/blobstream.go (1)
- 49-53: The changes to the
NewRelayerfunction call in the test file correctly reflect the updated function signature and the intent to not use the backup relayer functionality in tests.
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #640 +/- ##
==========================================
- Coverage 25.91% 25.44% -0.48%
==========================================
Files 29 29
Lines 3044 3101 +57
==========================================
Hits 789 789
- Misses 2160 2217 +57
Partials 95 95 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Review Status
Actionable comments generated: 3
Configuration used: CodeRabbit UI
Files selected for processing (1)
- relayer/relayer.go (5 hunks)
Additional comments: 5
relayer/relayer.go (5)
36-46: The addition of
IsBackupRelayerandBackupRelayerWaitTimefields to theRelayerstruct aligns with the PR objective to support backup relayers.55-74: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [49-73]
The
NewRelayerfunction has been correctly updated to accept and initialize the newIsBackupRelayerandBackupRelayerWaitTimefields.
83-85: The introduction of
backupRelayerShouldRelayvariable is consistent with the PR objective to control when the backup relayer should start relaying.142-146: The reset mechanism for
backupRelayerShouldRelayafter a successful transaction is a good practice to ensure the backup relayer only acts when necessary.105-121: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [80-149]
The
processFuncwithin theStartmethod has been modified to include conditional behavior based on theIsBackupRelayerfield. This change is in line with the PR objective to introduce conditional behavior for backup relayers.
Overview
Closes #624
Checklist
Summary by CodeRabbit
New Features
Improvements
Bug Fixes
NewRelayerfunction call.