Fix backup retry behavior #543
Merged
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
tstirrat15
force-pushed
the
542-fix-backup-behavior
branch
2 times, most recently
from
fad38c0 to
f5033bb
Compare
tstirrat15
force-pushed
the
542-fix-backup-behavior
branch
2 times, most recently
from
c1a2031 to
c9afd03
Compare
tstirrat15
commented
Sep 8, 2025
| // retrying the bulk import in backup/restore logic is handled manually. | ||
| // retrying bulk export is also handled manually, because the default behavior is | ||
| // to start at the beginning of the stream, which produces duplicate values. | ||
| selector.StreamClientInterceptor(retry.StreamClientInterceptor(retryOpts...), selector.MatchFunc(isNoneOf(importBulkRoute, exportBulkRoute))), |
There was a problem hiding this comment.
This is half of the fix - we don't want to automatically retry ExportBulk requests, because then we're not properly handling restarting the stream.
internal/cmd/backup.go
Outdated
Comment on lines
435
to
440
| // Clone the request to ensure that we are keeping all other fields the same | ||
| newReq := req.CloneVT() | ||
| newReq.OptionalCursor = lastResponse.AfterResultCursor | ||
|
|
||
| relationshipStream, err = spiceClient.ExportBulkRelationships(ctx, newReq) | ||
| log.Info().Err(err).Str("cursor token", lastResponse.AfterResultCursor.Token).Msg("encountered retryable error, resuming stream after token") |
There was a problem hiding this comment.
This is the other half of the fix - manually catching retryable errors and ensuring that we resume the stream in the correct spot.
Comment on lines
+744
to
+768
| func (m *mockClientForBackup) Recv() (*v1.ExportBulkRelationshipsResponse, error) { | ||
| // If we've run through all our calls, return an EOF | ||
| if m.recvCallIndex == len(m.recvCalls) { | ||
| return nil, io.EOF | ||
| } | ||
| recvCall := m.recvCalls[m.recvCallIndex] | ||
| m.recvCallIndex++ | ||
| return recvCall() | ||
| } | ||
|
|
||
| func (m *mockClientForBackup) ExportBulkRelationships(_ context.Context, req *v1.ExportBulkRelationshipsRequest, _ ...grpc.CallOption) (grpc.ServerStreamingClient[v1.ExportBulkRelationshipsResponse], error) { | ||
| if m.exportCalls == nil { | ||
| // If the caller doesn't supply exportCalls, pass through | ||
| return m, nil | ||
| } | ||
| if m.exportCallsIndex == len(m.exportCalls) { | ||
| // If invoked too many times, fail the test | ||
| m.t.FailNow() | ||
| return m, nil | ||
| } | ||
| exportCall := m.exportCalls[m.exportCallsIndex] | ||
| m.exportCallsIndex++ | ||
| exportCall(m.t, req) | ||
| return m, nil | ||
| } |
There was a problem hiding this comment.
This feels a little awkward/verbose, but it felt like the best way to represent multiple calls to each of these functions.
| @@ -183,9 +183,9 @@ func TestRestorer(t *testing.T) { | |||
| } | |||
| } | |||
|
|
|||
| type mockClient struct { | |||
| type mockClientForRestore struct { | |||
There was a problem hiding this comment.
Renaming because I created a different one for Backup
tstirrat15
force-pushed
the
542-fix-backup-behavior
branch
2 times, most recently
from
9d3cef7 to
9a58bfc
Compare
tstirrat15
force-pushed
the
542-fix-backup-behavior
branch
from
9a58bfc to
314ec3a
Compare
since at that point we would have not received any response and we wouldn't have a token. Also made sure to verify the tests failed if I removed the usage of the last known token, which led me to improve the assertions, as the tests were SIGSEV'ing too. Also inverted the !errors.Is(err, io.EOF) check, which is more idiomatic
vroldanbet
approved these changes
Sep 9, 2025
miparnisari
reviewed
Sep 10, 2025
| // last received response. | ||
|
|
||
| // Clone the request to ensure that we are keeping all other fields the same | ||
| newReq := req.CloneVT() |
There was a problem hiding this comment.
why do you need to clone the request? does req.OptionalCursor = lastResponse.AfterResultCursor not work?
There was a problem hiding this comment.
I don't strictly need to, but it's not expensive and I don't like mutating function parameters.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Fixes #542
Description
Currently,
ExportBulkis on the list of retryable methods. That means that when an export stream errors for any reason, the request is re-issued. This is a problem because it starts at the beginning and the relations are appended naively to the output. Ideally we'd resume from the place where the error occurred, and that's what this PR implements.TODO
Changes
ExportBulkto the list of things that doesn't get retriedTesting
Review. See that tests pass.