Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document NewDefaultInMemoryKVStore options #1489

Open
oxnr opened this issue Jan 17, 2024 · 0 comments
Open

Document NewDefaultInMemoryKVStore options #1489

oxnr opened this issue Jan 17, 2024 · 0 comments
Labels
bb-audit-issue T:code-hygiene General cleanup and restructuring of code to provide clarity, flexibility, and modularity.

Comments

@oxnr
Copy link

oxnr commented Jan 17, 2024

Finding 023 - Document NewDefaultInMemoryKVStore options

ID 023
Finding Document NewDefaultInMemoryKVStore options
Severity 1 - Informational
Description The NewDefaultInMemoryKVStore function creates a data store with BadgerDB options that indicate usage for in-memory contexts. However, the hard-coded options use specific values without any context, which could lead to debugging oddities and inefficiencies down the line where it may not be clear why those specific values were chosen.
Recommendation Document the rationale and/or purpose behind each option in the badger3.Options struct.
Code References
inMemoryOptions := &badger3.Options{
@Manav-Aggarwal Manav-Aggarwal added T:code-hygiene General cleanup and restructuring of code to provide clarity, flexibility, and modularity. bb-audit-issue and removed needs-triage labels Jan 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bb-audit-issue T:code-hygiene General cleanup and restructuring of code to provide clarity, flexibility, and modularity.
Projects
Status: No status
Development

No branches or pull requests

2 participants