splunk / splunk/stef

Review all panics and decide if they need to be errors

Open
#372 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug Go help wanted
Dominant language
Java
Stars
11
Forks
6
Avg merge
55m
Merged PRs (30d)
1

Description

See for example https://github.com/splunk/stef/issues/370

All panics that can happen due to invalid input received externally (e.g. in decoders or in converters from other formats) must be errors instead.

Fixes must be done carefully to avoid performance regressions since these are often on hot paths. Always fully benchmark affected code.

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

Start by reading issue 370 and reviewing panic sites in decoders and converters from other formats. Identify which panics can result from externally supplied invalid input, then benchmark each affected hot path. Done means those cases return errors without regressions in the affected benchmarks.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
backend
Issue type
Bug
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.