clockworklabs / clockworklabs/SpacetimeDB
Classify SQL execution errors for logging
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 25.2k
- Forks
- 1.1k
- Avg merge
- 2d 7h
- Merged PRs (30d)
- 46
Description
Follow-up from https://github.com/clockworklabs/SpacetimeDB/pull/5640.
Host::exec_sql in crates/client-api/src/lib.src currently receives a broad DBError containing both client SQL errors and internal datastore, transaction, or durability failures, so all failures are logged at warn! as a default.
Audit the errors returned by sql::execute::run and preserve enough classification to log clear internal failures at error!, while keeping client SQL errors at warn! or lower.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with Host::exec_sql in crates/client-api/src/lib.src, then trace the errors returned by sql::execute::run. Audit how client SQL errors differ from datastore, transaction, and durability failures. Done means internal failures retain enough classification to log at error!, while client SQL errors remain at warn! or lower.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust, sql
- Domain
- databases, observability
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100