Skip to content

refactor: New() returns (*Limiter, error) instead of hiding errors #1

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.

Sign up for GitHub

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

Merged
cnlangzi merged 2 commits into from
Jan 11, 2026
Merged

refactor: New() returns (*Limiter, error) instead of hiding errors #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d8ef450
fix: remove panic from New(), use fallback validator
cnlangzi Jan 11, 2026
875773b
refactor: New() returns (*Limiter, error) instead of hiding errors
cnlangzi Jan 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 30 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ import (
)

func main() {
limiter := botrate.New(
limiter, err := botrate.New(
// Rate limiting for blacklisted IPs only
botrate.WithLimit(rate.Every(10*time.Minute)),

Expand All @@ -61,22 +61,17 @@ func main() {
botrate.WithAnalyzerPageThreshold(50),
botrate.WithAnalyzerQueueCap(10000),
)
if err != nil {
log.Fatalf("Failed to create limiter: %v", err)
}
defer limiter.Close()

handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
ua := r.UserAgent()
ip := extractIP(r)

result := limiter.Allow(ua, ip)
if !result.Allowed {
switch result.Reason {
case "fake bot":
http.Error(w, "Bot verification failed", http.StatusForbidden)
case "rate limited":
http.Error(w, "Rate limit exceeded", http.StatusTooManyRequests)
default:
http.Error(w, "Forbidden", http.StatusForbidden)
}
if !limiter.Allow(ua, ip) {
http.Error(w, "Too Many Requests", http.StatusTooManyRequests)
return
}

Expand Down Expand Up @@ -192,7 +187,10 @@ if err != nil {
Gracefully shuts down the limiter and releases resources. **Always call this when the limiter is no longer needed.**

```go
limiter := botrate.New(...)
limiter, err := botrate.New(...)
if err != nil {
log.Fatalf("Failed to create limiter: %v", err)
}
defer limiter.Close()
```

Expand Down Expand Up @@ -301,44 +299,59 @@ if !allowed {
### Strict Rate Limiting

```go
limiter := botrate.New(
limiter, err := botrate.New(
botrate.WithLimit(rate.Every(10*time.Minute)),
)
if err != nil {
log.Fatalf("Failed to create limiter: %v", err)
}
```

### Aggressive Bot Detection

```go
limiter := botrate.New(
limiter, err := botrate.New(
botrate.WithAnalyzerWindow(30*time.Second),
botrate.WithAnalyzerPageThreshold(20),
)
if err != nil {
log.Fatalf("Failed to create limiter: %v", err)
}
```

### High-Throughput Configuration

```go
limiter := botrate.New(
limiter, err := botrate.New(
botrate.WithAnalyzerWindow(10*time.Minute),
botrate.WithAnalyzerPageThreshold(100),
botrate.WithAnalyzerQueueCap(50000),
)
if err != nil {
log.Fatalf("Failed to create limiter: %v", err)
}
```

### Custom KnownBots Validator

```go
// Create custom validator with specific configuration
customKB := knownbots.New(
customKB, err := knownbots.New(
knownbots.WithRoot("./custom-bots"),
knownbots.WithSchedulerInterval(12*time.Hour),
)
if err != nil {
log.Fatalf("Failed to create validator: %v", err)
}

// Use custom validator
limiter := botrate.New(
limiter, err := botrate.New(
botrate.WithKnownbots(customKB),
botrate.WithLimit(rate.Every(5*time.Minute)),
)
if err != nil {
log.Fatalf("Failed to create limiter: %v", err)
}
```

## Architecture
Expand Down
Loading