Replace BadgerDB with JSON file for persistent storage

[Copilot]

Replace BadgerDB with JSON file for persistent storage

Summary

Successfully replaced BadgerDB with a simple JSON file for persistent storage, addressing the issue that BadgerDB was overkill and caused unnecessary resource usage and code complexity.

Plan

• Explore repository and understand current BadgerDB implementation
• Build project to verify current state
• Create new JSON-based storage implementation
• Replace BadgerDB initialization with JSON file handling
• Update stats.go to load/save from JSON instead of BadgerDB
• Remove BadgerDB dependency from go.mod
• Update README.md to remove BadgerDB references
• Test the changes manually
• Build and verify the final implementation
• Address code review feedback
• Run security checks
• Update to Go 1.25
• Add CI workflow for ensuring code compiles
• Rename db_path to stats_path
• Update Actions to latest versions
• Remove LSIF workflow
• Fix sigchanyzer linter error

Changes Made

1. stats.go: Replaced BadgerDB operations with JSON file operations

   • loadFromDB() → loadFromJSON(): Loads stats from JSON file
   • syncToDB() → syncToJSON(): Syncs stats to JSON file
   • Removed BadgerDB import and dependencies
   • Fixed sync loop to ensure both pkgsView and pkgsGet are fully synced independently

2. main.go: Simplified database initialization

   • getDBWithStats() → getStatsFromJSON(): Loads stats from JSON
   • Removed BadgerDB initialization and cleanup
   • Removed BadgerDB import
   • Changed config field from DBPath to StatsPath (toml: db_path → stats_path)
   • Fixed signal channel to be buffered (capacity 1) to prevent missing signals

3. go.mod: Updated Go version and removed BadgerDB dependency

   • Updated from Go 1.16 to Go 1.25.0
   • Ran go mod tidy to clean up unused dependencies

4. README.md: Updated documentation

   • Removed mention of 64-bit requirement (was specific to BadgerDB bug)
   • Updated storage description from BadgerDB to JSON file
   • Changed config example from db_path to stats_path
   • Added migration note for version 0.5.0

5. .github/workflows/go.yml: Added CI workflow

   • Lint job: checks Go module tidiness and runs golangci-lint
   • Test job: runs tests with race detection and coverage on ubuntu and macos
   • Uses latest action versions: checkout@v4, setup-go@v5, golangci-lint-action@v7

6. .github/workflows/lsif.yml: Removed LSIF workflow

7. .golangci.yml: Added linter configuration

   • Enabled linters: nakedret, rowserrcheck, unconvert, unparam
   • Configured formatters: gofmt, goimports

Testing

Successfully tested:

• ✅ Server starts with no existing JSON file
• ✅ Stats are tracked correctly (views and go-gets)
• ✅ Stats sync to JSON file every minute
• ✅ Stats persist across server restarts
• ✅ Server loads existing stats from JSON file on startup
• ✅ Prometheus metrics endpoint works correctly
• ✅ Code review feedback addressed
• ✅ No security vulnerabilities found (CodeQL scan: 0 alerts)
• ✅ Build successful with Go 1.25.0
• ✅ go mod tidy passes
• ✅ Config with stats_path works correctly
• ✅ golangci-lint passes without errors

Benefits

• Simpler code: Removed ~100 lines of BadgerDB-specific code
• No external dependencies: Removed BadgerDB and all its transitive dependencies
• Human-readable storage: JSON file can be easily inspected and edited
• Lower resource usage: No database overhead for simple key-value storage
• No 64-bit requirement: Removed architecture constraint from BadgerDB bug
• Modern Go version: Updated to Go 1.25.0
• CI/CD: Ensures code quality with automated linting and testing
• Clearer naming: stats_path better describes the JSON file purpose
• Linter compliance: Fixed all linting issues for clean CI builds

Original prompt

---

This section details on the original issue you should resolve

<issue_title>Use JSON file as persistent storage</issue_title>
<issue_description>The decision to use BadgerDB was a huge mistake, while not using any of its unique feature, caused unnecessary resource usage and code complexity.

What we need is really as simple as a JSON file to persist data on disk.</issue_description>

Comments on the Issue (you are @copilot in this section)

• Fixes Use JSON file as persistent storage #1

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

[unknwon]

@copilot

1. Use go1.25
2. Add ci to ensure Go code compiles, mimic setup from unknwon/gmail-blade

[Copilot]

@copilot

1. Use go1.25...

Done in 24aa240:

1. Updated go.mod to Go 1.25.0
2. Added .github/workflows/go.yml with lint and test jobs (mimics gmail-blade setup)
3. Added .golangci.yml for linter configuration

The CI workflow ensures Go code compiles on both ubuntu-latest and macos-latest platforms, runs golangci-lint, and checks go mod tidiness.

[unknwon]

@copilot

1. The new config option is now stats_path, not db_path.
2. Make sure all actions are using the latest version
3. remove LSIF from ci

[Copilot]

@copilot

1. The new config option is now stats_path, not db_path.
   ...

Done in 47a7e3b:

1. Changed config from db_path to stats_path (updated DBPath → StatsPath in main.go)
2. GitHub Actions already use latest versions (checkout@v4, setup-go@v5, golangci-lint-action@v7)
3. Removed .github/workflows/lsif.yml

[unknwon]

@copilot

run golangci-lint
  Running [/home/runner/golangci-lint-2.6.2-linux-amd64/golangci-lint config path] in [/home/runner/work/go-import-server/go-import-server] ...
  Running [/home/runner/golangci-lint-2.6.2-linux-amd64/golangci-lint config verify] in [/home/runner/work/go-import-server/go-import-server] ...
  Running [/home/runner/golangci-lint-2.6.2-linux-amd64/golangci-lint run  --timeout=30m] in [/home/runner/work/go-import-server/go-import-server] ...
  Error: main.go:163:2: sigchanyzer: misuse of unbuffered os.Signal channel as argument to signal.Notify (govet)
  	signal.Notify(quit, os.Interrupt)
  	^
  1 issues:
  * govet: 1

[Copilot]

@copilot

...

Fixed in 368d9ff. Changed the signal channel from unbuffered to buffered with capacity 1, which is the recommended approach to prevent missing signals with signal.Notify.