clockworklabs / clockworklabs/SpacetimeDB

Audit log_and_500 callers

Open
#5,769 0 comments 0 reactions 0 assignees View on GitHub

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

In crates/client-api/src/lib.rs, log_and_500 is overused across unrelated failures such as loading, durability, authentication, and control-state in over 100 locations. We've changed it to log as warn! from error! as there is no way to choose the correct severity.

The goal is to audit its callers and split logging from the 500 response so each failure can use the appropriate log level.

Private should also be reviewed alongside.

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 in crates/client-api/src/lib.rs by auditing the over 100 log_and_500 callers, including failures related to loading, durability, authentication, and control-state. Review Private alongside them, then separate logging from the 500 response so each failure uses an appropriate log level.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
api, backend
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.