-
Notifications
You must be signed in to change notification settings - Fork 1.8k
feat(bigtable): Reroute Mutations Batcher to use data client #18200
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
daniel-sanche
wants to merge
26
commits into
shim/12-batcher-callback
from
shim/13-mutations-batcher
Draft
Changes from all commits
Commits
Show all changes
26 commits
Select commit
Hold shift + click to select a range
7c09a0a
feat: Rerouted CheckAndMutateRows and ReadModifyWriteRows (#1257)
gkevinzheng c99a253
Resolve merge conflicts
daniel-sanche 68f942b
fixed lint
daniel-sanche 0e78cb1
feat: Rerouted DirectRow.commit to use MutateRow (#1276)
gkevinzheng 78727a7
resolved merge conflicts
daniel-sanche fd63ef0
fixed lint
daniel-sanche bb3b4d1
feat: Reworked MutateRows to use the data client (#1290)
gkevinzheng fbf671c
fix merge conflicts
daniel-sanche 56a0bb1
feat: Shimmed RowSet and RowRange for ReadRows. (#1296)
gkevinzheng 06102a1
handled merge conflicts
daniel-sanche ed6ec4e
feat: Added rst_stream exception handling for ReadRows. (#1298)
gkevinzheng 6348bb9
resolve merge conflicts
daniel-sanche b70383f
feat: Rerouted ReadRows to data client (#1299)
gkevinzheng db0479a
resolved merge conflicts
daniel-sanche adb399c
added placeholders for deprecated properties
daniel-sanche 4150947
capture and raise warnings if constructor is used with old args
daniel-sanche 9b142d7
handle None retry
daniel-sanche e435179
add generator typing
daniel-sanche e334aa0
feat: Added a batch completed callback to the data client mutations b…
gkevinzheng 2729a5c
resolve merge conflicts
daniel-sanche b7ec06b
address gemini comments
daniel-sanche 54a9ba3
feat: Mutations Batcher shim (#1309)
gkevinzheng 661bbfe
fix merge conflicts
daniel-sanche 4128ea1
fixed property references
daniel-sanche c169575
un-deprecate flush_interval
daniel-sanche 57774e9
added guard against None causes
daniel-sanche File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
348 changes: 51 additions & 297 deletions
348
packages/google-cloud-bigtable/google/cloud/bigtable/batcher.py
Large diffs are not rendered by default.
Oops, something went wrong.
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -20,12 +20,26 @@ | |
| import enum | ||
| import time | ||
| from collections import namedtuple | ||
| from typing import TYPE_CHECKING, List, Sequence, Tuple, Union | ||
| from typing import ( | ||
| TYPE_CHECKING, | ||
| Callable, | ||
| List, | ||
| Optional, | ||
| Sequence, | ||
| Tuple, | ||
| Union, | ||
| cast, | ||
| ) | ||
|
|
||
| from google.api_core import exceptions as core_exceptions | ||
| from google.api_core import retry as retries | ||
| from google.api_core.retry import RetryFailureReason, exponential_sleep_generator | ||
| from google.rpc import code_pb2, status_pb2 | ||
|
|
||
| from google.cloud.bigtable.data.exceptions import RetryExceptionGroup | ||
| from google.cloud.bigtable.data.exceptions import ( | ||
| MutationsExceptionGroup, | ||
| RetryExceptionGroup, | ||
| ) | ||
| from google.cloud.bigtable.data.read_rows_query import ReadRowsQuery | ||
|
|
||
| if TYPE_CHECKING: | ||
|
|
@@ -50,6 +64,15 @@ | |
| # used by every data client as a default project name for testing on Bigtable emulator. | ||
| _DEFAULT_BIGTABLE_EMULATOR_CLIENT = "google-cloud-bigtable-emulator" | ||
|
|
||
| # Internal error messages that can be retried during ReadRows. Internal error messages with this error | ||
| # text should be treated as Unavailable error messages with the same error text, and will therefore be | ||
| # treated as Unavailable errors rather than Internal errors. | ||
| _RETRYABLE_INTERNAL_ERROR_MESSAGES = ( | ||
| "rst_stream", | ||
| "rst stream", | ||
| "received unexpected eos on data frame from server", | ||
| ) | ||
|
|
||
| # used to identify an active bigtable resource that needs to be warmed through PingAndWarm | ||
| # each instance/app_profile_id pair needs to be individually tracked | ||
| _WarmedInstanceKey = namedtuple( | ||
|
|
@@ -126,6 +149,35 @@ def _retry_exception_factory( | |
| return source_exc, cause_exc | ||
|
|
||
|
|
||
| def _rst_stream_aware_predicate( | ||
| *exception_types: type[Exception], | ||
| ) -> Callable[[Exception], bool]: | ||
| """A custom retry predicate. | ||
|
|
||
| This predicate treats Internal error messages with RST_STREAM errors as | ||
| ServiceUnavailable errors and will retry them if the Unavailable exception is retryable. | ||
|
|
||
| Args: | ||
| exception_types: Exception types to be retried during operation | ||
|
|
||
| Returns: | ||
| Callable[[Exception], bool]: A retry predicate that takes in an exception and | ||
| returns whether or not that exception is retryable | ||
| """ | ||
| # predicate to check for retryable error types | ||
| if_exception_type = retries.if_exception_type(*exception_types) | ||
|
|
||
| # special case: treat InternalServerError with rst_stream error message as ServiceUnavailable | ||
| def rst_check(e): | ||
| return ( | ||
| core_exceptions.ServiceUnavailable in exception_types | ||
| and isinstance(e, core_exceptions.InternalServerError) | ||
| and any(m in e.message.lower() for m in _RETRYABLE_INTERNAL_ERROR_MESSAGES) | ||
| ) | ||
|
|
||
| return lambda e: if_exception_type(e) or rst_check(e) | ||
|
|
||
|
|
||
| def _get_timeouts( | ||
| operation: float | TABLE_DEFAULT, | ||
| attempt: float | None | TABLE_DEFAULT, | ||
|
|
@@ -191,6 +243,69 @@ def _align_timeouts(operation: float, attempt: float | None) -> tuple[float, flo | |
| return operation, final_attempt | ||
|
|
||
|
|
||
| def _get_statuses_from_mutations_exception_group( | ||
| exc_group: MutationsExceptionGroup, batch_size: int | ||
| ) -> list[status_pb2.Status]: | ||
| """ | ||
| Helper function that populates a list of Status objects with exception information from | ||
| the exception group. | ||
|
|
||
| Args: | ||
| exc_group: The exception group from a mutate rows operation | ||
| batch_size: How many RowMutationGroups were provided to the batch | ||
| Returns: | ||
| list[status_pb2.Status]: A list of Status proto objects | ||
| """ | ||
| # We exception handle as follows: | ||
| # | ||
| # 1. Each exception in the error group is a FailedMutationEntryError, and its | ||
| # cause is either a singular exception or a RetryExceptionGroup consisting of | ||
| # multiple exceptions. | ||
| # | ||
| # 2. In the case of a singular exception, if the error does not have a gRPC status | ||
| # code, we return a status code of UNKNOWN. | ||
| # | ||
| # 3. In the case of a RetryExceptionGroup, we use terminal exception in the exception | ||
| # group and process that. | ||
| statuses = [status_pb2.Status(code=code_pb2.OK) for _ in range(batch_size)] | ||
| for error in exc_group.exceptions: | ||
| if isinstance(error.index, int) and 0 <= error.index < len(statuses): | ||
| cause = error.__cause__ | ||
| if isinstance(cause, RetryExceptionGroup): | ||
| statuses[error.index] = _get_status(cause.exceptions[-1]) | ||
| else: | ||
| statuses[error.index] = _get_status(cause) | ||
| return statuses | ||
|
|
||
|
|
||
| def _get_status(exc: Optional[Exception]) -> status_pb2.Status: | ||
| """ | ||
| Helper function that returns a Status object corresponding to the given exception. | ||
|
|
||
| Args: | ||
| exc: An exception to be converted into a Status. | ||
| Returns: | ||
| status_pb2.Status: A Status proto object. | ||
| """ | ||
| if isinstance(exc, core_exceptions.GoogleAPICallError): | ||
| status_code = cast(Optional["grpc.StatusCode"], exc.grpc_status_code) | ||
| if status_code is not None: | ||
| return status_pb2.Status( | ||
| code=status_code.value[0], | ||
| message=exc.message, | ||
| details=exc.details, | ||
| ) | ||
| return status_pb2.Status( | ||
| code=code_pb2.Code.UNKNOWN, | ||
| message="An unknown error has occurred", | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. maybe change this to GoogleApiCAllError with Unknown status code |
||
| ) | ||
|
|
||
| return status_pb2.Status( | ||
| code=code_pb2.UNKNOWN, | ||
| message=str(exc) if exc else "An unknown error has occurred", | ||
| ) | ||
|
|
||
|
|
||
| def _validate_timeouts( | ||
| operation_timeout: float, attempt_timeout: float | None, allow_none: bool = False | ||
| ): | ||
|
|
||
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what does field_index=None mean? should it be the index of the current entry?