MagicStack / MagicStack/asyncpg

Extremely long delay grabbing type info for string array (and likely other types) on CockroachDB

Open
#1,158 15 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

I was having atrocious and unacceptable delays in my production environment that I wasn't seeing locally, using CockroachDB cloud. Found the cause was the introspection of types. I'm using the latest version of the CockroachDB drivers.

![recursion-statements](https://github.com/MagicStack/asyncpg/assets/122519877/cc7102c1-7115-4a7d-a5d0-52c1a8b68d68)

I wrote this hack to work around the issue. It caches the result in local memory and also caches it to redis so that new instances don't see it. You can change the key for the redis cache using an environment variable so that new versions aren't locked to old values.

If someone wants to turn it into part of the product, please be my guest. I won't have time for it. In the mean time. here's the hack that does monkey patching:

```python
introspection_result_cache: dict[tuple[str, int, str], Any] = {}

orig_introspection_types = asyncpg.Connection._introspect_types

INTROSPECTION_KEY = os.environ.get(
"ASYNCPG_INTROSPECTION_CACHE_KEY", "ASYNCPG_INTROSPECTION_CACHE_KEY"
)

introspection_lock = asyncio.Lock()

class FauxResult:
_binary_fields = ("kind", "elemdelim")
column_order = [
"oid",
"ns",
"name",
"kind",
"basetype",
"elemtype",
"elemdelim",
"range_subtype",
"attrtypoids",
"attrnames",
"depth",
"basetype_name",
"elemtype_name",
"range_subtype_name",
]

def __init__(self, row=None, data: dict | None = None) -> None:
if row:
self.data = dict(row)
else:
assert data
self.data = data

def __getattr__(self, name: str) -> Any:
return self.data[name]

def __getitem__(self, idx_or_column_name: int | str) -> Any:
if isinstance(idx_or_column_name, int):
return self.data[self.column_order[idx_or_column_name]]
return self.data[idx_or_column_name]

def for_serialization(self) -> dict:
result = copy.copy(self.data)
for field in self._binary_fields:
if (value := self.data.get(field)) is not None:
result[field] = value.decode()
return result

@classmethod
def from_serialization(cls, data: dict) -> Self:
for field in cls._binary_fields:
if (value := data.get(field)) is not None:
data[field] = value.encode()
return cls(data=data)

class FauxPreparedStatementState:
def __init__(self, name) -> None:
self.name = name

async def to_redis_cache(
host: str, port: int, database: str, inspection_types: tuple[list, Any]
) -> None:
pss = FauxPreparedStatementState(inspection_types[1].name)
results = [FauxResult(row) for row in inspection_types[0]]
await redis_client().set(
INTROSPECTION_KEY + f"-{host}-{port}-{database}",
orjson.dumps([[result.for_serialization() for result in results], pss.name]),
)

async def from_redis_cache(host: str, port: int, database: str) -> tuple[list, Any] | None:
data = await redis_client().get(INTROSPECTION_KEY + f"-{host}-{port}-{database}")
if data is None:
return None
results, pss_name = orjson.loads(data)
pss = FauxPreparedStatementState(pss_name)
return [FauxResult.from_serialization(row) for row in results], pss

def apply_introspection_caching():

async def new_introspect_types(self, *args, **kwargs) -> Any:
host: str
port: int
database: str
host, port = self._addr
database = self._params.database
if (cached_val := introspection_result_cache.get((host, port, database))) is not None:
return cached_val
async with introspection_lock:
redis_cached_value = await from_redis_cache(host, port, database)
if redis_cached_value is not None:
introspection_result_cache[host, port, database] = redis_cached_value
return redis_cached_value
result = await orig_introspection_types(self, *args, **kwargs)
await to_redis_cache(host, port, database, result)
return result

asyncpg.Connection._introspect_types = new_introspect_types

```

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

The issue identifies asyncpg.Connection._introspect_types as the entry point and reports severe delays with CockroachDB type introspection; start there and reproduce the behavior against CockroachDB. The proposed caching workaround shows one possible direction, but the intended fix and completion criteria need maintainer agreement.

Written by the indexing model from the issue text.

Assessment

Tech stack
postgresql, python
Domain
databases
Issue type
Bug
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.