MagicStack / MagicStack/asyncpg

`get_settings()` can get out of sync after a transaction with an error is rolled back

Open
#1,215 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
8.1k
Forks
468
PR merge metrics
No merged PRs in 30d

Description

* **asyncpg version**: 0.30.0
* **PostgreSQL version**: 17.2
* **Do you use a PostgreSQL SaaS? If so, which? Can you reproduce
the issue with a local PostgreSQL install?**: No
* **Python version**: 3.12.2
* **Platform**: Linux
* **Do you use pgbouncer?**: No
* **Did you install asyncpg with pip?**: Yes
* **If you built asyncpg locally, which version of Cython did you use?**:
* **Can the issue be reproduced under both asyncio and
[uvloop](https://github.com/magicstack/uvloop)?**: Only checked asyncio but it doesn't seem likely to matter

```
#!/usr/bin/env python3

import asyncio
import asyncpg

async def _check_encoding(con):
current_encoding = (await con.fetch(
"select current_setting('client_encoding')")
)[0]['current_setting']
print(current_encoding)
print(con.get_settings().client_encoding)

async def test(dsn):
con = await asyncpg.connect(dsn)

print("Orig")
await _check_encoding(con)

tran = con.transaction()
await tran.start()

await con.execute("set client_encoding to 'latin1'")
print("In transaction:")
await _check_encoding(con)
try:
await con.fetch("select 1 + 'a'")
except Exception:
pass

await tran.rollback()
print("After rollback:")
await _check_encoding(con)

res = await con.fetch('select $1::text', '💩')
print(res)

asyncio.run(test(
'postgres:///main?user=edgedb&port=5656&host=localhost'
))
```

In a transaction, if I set `client_encoding` to something, and then the transaction has an error and is rolled back, the `client_encoding` that `get_settings()` returns is never reverted.
If the transaction is rolled back without an error occuring, the right thing happens.

Output:
```
Orig
UTF8
UTF_8
In transaction:
LATIN1
LATIN1
After rollback:
UTF8
LATIN1
Traceback (most recent call last):
File "asyncpg/protocol/prepared_stmt.pyx", line 175, in asyncpg.protocol.protocol.PreparedStatementState._encode_bind_msg
File "asyncpg/protocol/codecs/base.pyx", line 227, in asyncpg.protocol.protocol.Codec.encode
File "asyncpg/protocol/codecs/base.pyx", line 129, in asyncpg.protocol.protocol.Codec.encode_scalar
File "asyncpg/pgproto/./codecs/text.pyx", line 29, in asyncpg.pgproto.pgproto.text_encode
File "asyncpg/pgproto/./codecs/text.pyx", line 17, in asyncpg.pgproto.pgproto.as_pg_string_and_size
UnicodeEncodeError: 'latin-1' codec can't encode character '\U0001f4a9' in position 0: ordinal not in range(256)
```

I would expect
```
After rollback:
UTF8
UTF8
```
and no encoding error.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the supplied Python reproducer, focusing on the transaction rollback path and the connection's get_settings() entry point. Confirm the difference between rollback after a transaction error and a clean rollback, then trace how client_encoding state is refreshed; done means get_settings() reports UTF8 after rollback and the subsequent text parameter query succeeds.

Written by the indexing model from the issue text.

Assessment

Tech stack
postgresql, python
Domain
backend, databases
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.