surface rather than hide error handling #135
Draft
Conversation
This file contains hidden or 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
Signed-off-by: Max Englander <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the sync process to expose errors more clearly and simplify error handling during the VStream processing. Key changes include:
- Splitting up the sync() function parameters for better readability.
- Introducing a local logf closure for consistent logging.
- Replacing panic calls in unexpected event cases with error returns.
| switch { | ||
| case ok && s.Code() == codes.DeadlineExceeded: | ||
| // No next VGTID found within deadline. | ||
| logf(LOGLEVEL_ERROR, "no new VGTID found before deadline exceeded: %v", err) |
There was a problem hiding this comment.
The DeadlineExceeded condition is likely an expected scenario; consider using an informational log level instead of LOGLEVEL_ERROR.
Suggested change
| logf(LOGLEVEL_ERROR, "no new VGTID found before deadline exceeded: %v", err) | |
| logf(LOGLEVEL_INFO, "no new VGTID found before deadline exceeded: %v", err) |
| logf(LOGLEVEL_ERROR, "no new VGTID found before deadline exceeded: %v", err) | ||
| case errors.Is(err, io.EOF): | ||
| // EOF is an acceptable error indicating VStream is finished. | ||
| logf(LOGLEVEL_ERROR, "encountered EOF, possibly indicating end of VStream") |
There was a problem hiding this comment.
EOF is typically an acceptable signal indicating the end of the stream; consider logging it at an informational level rather than as an error.
Suggested change
| logf(LOGLEVEL_ERROR, "encountered EOF, possibly indicating end of VStream") | |
| logf(LOGLEVEL_INFO, "encountered EOF, possibly indicating end of VStream") |
nickvanw
reviewed
Apr 3, 2025
| isFullSync := syncMode == "full" | ||
| vtgateReq := buildVStreamRequest(tabletType, s.Name, tc.Shard, tc.Keyspace, tc.Position, tc.LastKnownPk) | ||
| p.Logger.Log(LOGLEVEL_INFO, fmt.Sprintf("%sRequesting VStream with %+v", preamble, vtgateReq)) | ||
| logf(LOGLEVEL_INFO, "Requesting VStream with %+v", vtgateReq) |
There was a problem hiding this comment.
This logging change is a very welcome change
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Surface rather than hide errors that are encountered throughout the sync process. Only update table cursor position after successfully flushing records to Airbyte.
This is a lot, so splitting across multiple PRs:
sync()a bit to make subsequent refactoring a bit easier.Once all PRs are approved, I'll merge them from the bottom up, and then merge this PR into
main.