pingcap / pingcap/ticdc

Review all panic usages for upgrade compatibility and error handling

Open
#2,846 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
56
Forks
63
Avg merge
2d 20h
Merged PRs (30d)
34

Description

We should review all places in the project where panic is used. The goal is to evaluate whether each usage is reasonable and whether it could cause issues during rolling upgrades or future version compatibility.

Tasks:
1. Identify all occurrences of panic across the codebase.
2. Review each case to determine if it’s necessary or if it should be replaced with proper error handling.
3. Identify which panic usages are acceptable (e.g., truly unrecoverable states).
4. Propose improvements or refactoring where needed to ensure safe rolling upgrades and backward compatibility.

Contributor guide

Open the contributing guide

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

Search the Go codebase for every panic usage and read each surrounding call path. Review whether each case is acceptable during rolling upgrades and future compatibility, or needs error handling. Done means every occurrence is assessed, acceptable cases are identified, and proposed refactoring is documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
backend, distributed-systems
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.