test(spanner): add integration test for inline-begin error handling (step 3)#5322
Conversation
Adds support for inlining the BeginTransaction with the first query in a read-only transaction. This saves one round-trip to Spanner for multi-use read-only transactions. This implementation is intentionally simple: 1. It does not support parallel queries at the start of the transaction. 2. It does not include error handling for the first query. 3. It only supports read-only transactions. This is step 1. Follow-up pull requests addresses the above points.
Adds error handling for inline-begin-transaction. If the first statement in a transaction fails, and that statement included a BeginTransaction option, then the transaction has not been started. In order to keep the semantics of the transaction consistent for an 'outside observer', we need to do the following: 1. Catch the error that was thrown by the initial statement. 2. Start the transaction using an explicit BeginTransaction RPC. 3. Retry the initial statement, but now using the transaction ID from step 2. 4. Return the error or result for the retried initial statement. The above makes sure that: 1. The transaction is actually started when the first statement is executed, also when the statement failed. 2. The statement becomes part of the transaction, and the result of the statement is consistent with the read-timestamp of the transaction. The second part is important in order to comply with Spanner's strong consistency guarantees; If for example a statement returns a 'Table not found' error, then that error is only valid for the read timestamp that was used for executing the statement. This is the reason that we retry the statement after the BeginTransaction RPC to be able to return a result that is guaranteed to be consistent with any other queries/reads that will be executed in the same transaction.
Adds error handling for inline-begin-transaction. If the first statement in a transaction fails, and that statement included a BeginTransaction option, then the transaction has not been started. In order to keep the semantics of the transaction consistent for an 'outside observer', we need to do the following: 1. Catch the error that was thrown by the initial statement. 2. Start the transaction using an explicit BeginTransaction RPC. 3. Retry the initial statement, but now using the transaction ID from step 2. 4. Return the error or result for the retried initial statement. The above makes sure that: 1. The transaction is actually started when the first statement is executed, also when the statement failed. 2. The statement becomes part of the transaction, and the result of the statement is consistent with the read-timestamp of the transaction. The second part is important in order to comply with Spanner's strong consistency guarantees; If for example a statement returns a 'Table not found' error, then that error is only valid for the read timestamp that was used for executing the statement. This is the reason that we retry the statement after the BeginTransaction RPC to be able to return a result that is guaranteed to be consistent with any other queries/reads that will be executed in the same transaction.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5322 +/- ##
==========================================
- Coverage 97.74% 97.74% -0.01%
==========================================
Files 216 216
Lines 47572 47572
==========================================
- Hits 46501 46499 -2
- Misses 1071 1073 +2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
6db264c to
3f52671
Compare
Adds an integration test for error handling for inline-begin-transaction. This test uses a gRPC proxy to intercept calls from the client to Spanner to be able to deterministically emulate specific concurrency issues. This test shows how a query that failed during the first attempt, and thereby also failed to start the transaction, could succeed during a retry after the transaction has been started with an explicit BeginTransaction RPC.
3f52671 to
0efcab8
Compare
| begin_transaction_entered_latch: Arc::clone(&begin_transaction_entered_latch), | ||
| }; | ||
|
|
||
| let _server_handle = tokio::spawn(async move { |
There was a problem hiding this comment.
should we shutdown the server handle when test is completed?
There was a problem hiding this comment.
Yeah, good point. I added that in 1d21817
| include!("generated/protos/google.rpc.rs"); | ||
| } | ||
| pub mod spanner { | ||
| #[allow(rustdoc::broken_intra_doc_links, rustdoc::bare_urls)] |
There was a problem hiding this comment.
grpc-mock is fully generated since #5433
If we need these #[allow]s, let me know, and I'll update the template
|
@dbolduc This PR seems to require a review from you or one of the other owners. |
dbolduc
left a comment
There was a problem hiding this comment.
Rubber stamp. Seems weird to need an emulator + a fake server + a proxy, but what do I know.
Yeah, only my team owns the |
Adds an integration test for error handling for inline-begin-transaction. This test uses
a gRPC proxy to intercept calls from the client to Spanner to be able to deterministically
emulate specific concurrency issues. This test shows how a query that failed during the
first attempt, and thereby also failed to start the transaction, could succeed during a
retry after the transaction has been started with an explicit BeginTransaction RPC.
This is step 3 of the implementation of inline-begin-transaction for Spanner. A preliminary view of the full implementation after all steps can be seen in #5307