googleapis / googleapis/google-cloud-python
A client called `run_in_transaction` be stuck if Spanner is down
- Dominant language
- Python
- Stars
- 5.4k
- Forks
- 1.8k
- Avg merge
- 3d 4h
- Merged PRs (30d)
- 122
Description
### Determine this is the right repository
- [x] I determined this is the correct repository in which to report this bug.
### Summary of the issue
**Context**
When the Spanner is unavailable. If we call [`run_in_transaction`](https://github.com/googleapis/google-cloud-python/blob/main/packages/google-cloud-spanner/google/cloud/spanner_v1/database.py#L1015), the Spanner client will stuck forever.
We believe the [get_session](https://github.com/googleapis/google-cloud-python/blob/main/packages/google-cloud-spanner/google/cloud/spanner_v1/database.py#L1064) should in the try catch block. Otherwise, the `self._local.transaction_running = True` will be forever True.
**Expected Behavior:**
The client will retry when the Spanner DB is back.
**Actual Behavior:**
The client stuck forever.
### API client name and version
_No response_
### Reproduction steps: code
_No response_
### Reproduction steps: supporting files
- Try to create a session when Spanner is unavailable.
- The client will be stuck forever.
### Reproduction steps: actual results
_No response_
### Reproduction steps: expected results
_No response_
### OS & version + platform
_No response_
### Python environment
_No response_
### Python dependencies
_No response_
### Additional context
_No response_
Contributor guide
Research direction
Start in packages/google-cloud-spanner/google/cloud/spanner_v1/database.py at run_in_transaction and its get_session call. Trace the transaction-running state when session creation fails while Spanner is unavailable, then add coverage for that failure path. Done means the client does not remain stuck and can retry when Spanner becomes available.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- databases
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 72/100