linkedin / linkedin/Burrow

Config naming conventions should not cause fatal burrow exit

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

Nobody has claimed this yet.

Dominant language
Go
Stars
4k
Forks
818
Avg merge
1h 14m
Merged PRs (30d)
1

Description

For folks that are upgrading burrow versions, upgrades should not cause a fatal crash if the config has not been migrated to the latest politically correct terms.

For example:

```
Please change configurations to allowlist and denylist
```

While I agree with the renaming, that should be a warn with deprecation notice versus a panic. In a future release after a period of deprecation, then it would be appropriate to have it be a fatal error.

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 by locating Burrow's configuration parsing and the fatal path triggered by legacy naming such as allowlist and denylist. Trace the existing migration or validation tests, then make the legacy configuration produce a warning and deprecation notice rather than a fatal exit, with coverage confirming the behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
stream-processing
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.