refactor(geoip): drop dataset dep, become barebones load/open/get

Databases is now just two *geoip2.Reader fields with Open/Close/PrintInfo.
OpenDatabases still auto-discovers conf and downloads stale .mmdb files
via httpcache before opening, but it no longer runs background goroutines
or holds atomic pointers. Long-running callers that want refresh can wire
httpcache.Cacher to atomic.Pointer themselves.

check-ip drops geo.Init/geo.Run — OpenDatabases does the fetch+open work
itself, and a one-shot CLI doesn't need background refresh.
This commit is contained in:
AJ ONeal 2026-04-20 13:20:34 -06:00
parent 990b9e430c
commit 5985ea5e2d
No known key found for this signature in database
4 changed files with 121 additions and 124 deletions

View File

@ -123,12 +123,9 @@ func run(cfg Config, ipStr string) (blocked bool, err error) {
geo, err := geoip.OpenDatabases(cfg.GeoIPConf, cfg.CityDB, cfg.ASNDB) geo, err := geoip.OpenDatabases(cfg.GeoIPConf, cfg.CityDB, cfg.ASNDB)
if err != nil { if err != nil {
return false, err
}
if err := geo.Init(); err != nil {
return false, fmt.Errorf("geoip: %w", err) return false, fmt.Errorf("geoip: %w", err)
} }
geo.Run(ctx, refreshInterval) defer func() { _ = geo.Close() }()
blockedIn := isBlocked(ipStr, whitelist, inbound.Load()) blockedIn := isBlocked(ipStr, whitelist, inbound.Load())
blockedOut := isBlocked(ipStr, whitelist, outbound.Load()) blockedOut := isBlocked(ipStr, whitelist, outbound.Load())

View File

@ -1,82 +1,125 @@
package geoip package geoip
import ( import (
"context" "errors"
"fmt" "fmt"
"io" "io"
"net/netip" "net/netip"
"os"
"path/filepath"
"strings" "strings"
"time"
"github.com/oschwald/geoip2-golang" "github.com/oschwald/geoip2-golang"
"github.com/therootcompany/golib/net/dataset"
) )
// Databases pairs city and ASN datasets. All methods are nil-safe no-ops so // Databases holds open GeoLite2 readers. A nil field means that edition
// callers need not check whether geoip was configured. // wasn't configured. A nil *Databases means geoip is disabled; all methods
// are nil-safe no-ops so callers need not branch.
type Databases struct { type Databases struct {
City *dataset.Dataset[geoip2.Reader] City *geoip2.Reader
ASN *dataset.Dataset[geoip2.Reader] ASN *geoip2.Reader
} }
// NewDatabases creates Databases for the given paths without a Downloader // OpenDatabases resolves configuration, downloads stale .mmdb files (when a
// (uses whatever is already on disk). // GeoIP.conf with credentials is available), and opens the readers.
func NewDatabases(cityPath, asnPath string) *Databases { //
return &Databases{ // - confPath="" → auto-discover from DefaultConfPaths
City: newDataset(nil, CityEdition, cityPath), // - conf found → auto-download; cityPath/asnPath override default locations
ASN: newDataset(nil, ASNEdition, asnPath), // - no conf → cityPath and asnPath must point to existing .mmdb files
// - no conf and no paths → returns nil, nil (geoip disabled)
func OpenDatabases(confPath, cityPath, asnPath string) (*Databases, error) {
if confPath == "" {
for _, p := range DefaultConfPaths() {
if _, err := os.Stat(p); err == nil {
confPath = p
break
}
} }
} }
// NewDatabases creates Databases backed by this Downloader. if confPath != "" {
func (d *Downloader) NewDatabases(cityPath, asnPath string) *Databases { cfg, err := ParseConf(confPath)
return &Databases{ if err != nil {
City: newDataset(d, CityEdition, cityPath), return nil, fmt.Errorf("geoip-conf: %w", err)
ASN: newDataset(d, ASNEdition, asnPath),
} }
dbDir := cfg.DatabaseDirectory
if dbDir == "" {
if dbDir, err = DefaultCacheDir(); err != nil {
return nil, fmt.Errorf("geoip cache dir: %w", err)
}
}
if err := os.MkdirAll(dbDir, 0o755); err != nil {
return nil, fmt.Errorf("mkdir %s: %w", dbDir, err)
}
if cityPath == "" {
cityPath = filepath.Join(dbDir, CityEdition+".mmdb")
}
if asnPath == "" {
asnPath = filepath.Join(dbDir, ASNEdition+".mmdb")
}
dl := New(cfg.AccountID, cfg.LicenseKey)
if _, err := dl.NewCacher(CityEdition, cityPath).Fetch(); err != nil {
return nil, fmt.Errorf("fetch %s: %w", CityEdition, err)
}
if _, err := dl.NewCacher(ASNEdition, asnPath).Fetch(); err != nil {
return nil, fmt.Errorf("fetch %s: %w", ASNEdition, err)
}
return Open(cityPath, asnPath)
} }
func newDataset(d *Downloader, edition, path string) *dataset.Dataset[geoip2.Reader] { if cityPath == "" && asnPath == "" {
var syncer dataset.Syncer return nil, nil
if d != nil {
syncer = d.NewCacher(edition, path)
} else {
syncer = dataset.NopSyncer{}
} }
ds := dataset.New(syncer, func() (*geoip2.Reader, error) { return Open(cityPath, asnPath)
return geoip2.Open(path)
})
ds.Name = edition
ds.Close = func(r *geoip2.Reader) { r.Close() }
return ds
} }
// Init downloads (if needed) and opens both databases. Returns the first error. // Open opens city and ASN .mmdb files from the given paths. Empty paths are
// No-op on nil receiver. // treated as unconfigured (the corresponding field stays nil).
func (dbs *Databases) Init() error { func Open(cityPath, asnPath string) (*Databases, error) {
if dbs == nil { d := &Databases{}
if cityPath != "" {
r, err := geoip2.Open(cityPath)
if err != nil {
return nil, fmt.Errorf("open %s: %w", cityPath, err)
}
d.City = r
}
if asnPath != "" {
r, err := geoip2.Open(asnPath)
if err != nil {
if d.City != nil {
_ = d.City.Close()
}
return nil, fmt.Errorf("open %s: %w", asnPath, err)
}
d.ASN = r
}
return d, nil
}
// Close closes any open readers. No-op on nil receiver.
func (d *Databases) Close() error {
if d == nil {
return nil return nil
} }
if err := dbs.City.Init(); err != nil { var errs []error
return err if d.City != nil {
if err := d.City.Close(); err != nil {
errs = append(errs, err)
} }
return dbs.ASN.Init() }
if d.ASN != nil {
if err := d.ASN.Close(); err != nil {
errs = append(errs, err)
}
}
return errors.Join(errs...)
} }
// Run starts background refresh goroutines for both databases. // PrintInfo writes city and ASN info for ip to w. No-op on nil receiver or
// No-op on nil receiver. // unparseable IP; missing readers are skipped silently.
func (dbs *Databases) Run(ctx context.Context, interval time.Duration) { func (d *Databases) PrintInfo(w io.Writer, ip string) {
if dbs == nil { if d == nil {
return
}
go dbs.City.Run(ctx, interval)
go dbs.ASN.Run(ctx, interval)
}
// PrintInfo writes city and ASN info for ip to w.
// No-op on nil receiver or unparseable IP.
func (dbs *Databases) PrintInfo(w io.Writer, ip string) {
if dbs == nil {
return return
} }
addr, err := netip.ParseAddr(ip) addr, err := netip.ParseAddr(ip)
@ -85,7 +128,8 @@ func (dbs *Databases) PrintInfo(w io.Writer, ip string) {
} }
stdIP := addr.AsSlice() stdIP := addr.AsSlice()
if rec, err := dbs.City.Load().City(stdIP); err == nil { if d.City != nil {
if rec, err := d.City.City(stdIP); err == nil {
city := rec.City.Names["en"] city := rec.City.Names["en"]
country := rec.Country.Names["en"] country := rec.Country.Names["en"]
iso := rec.Country.IsoCode iso := rec.Country.IsoCode
@ -105,9 +149,12 @@ func (dbs *Databases) PrintInfo(w io.Writer, ip string) {
fmt.Fprintf(w, " Location: %s\n", strings.Join(parts, ", ")) fmt.Fprintf(w, " Location: %s\n", strings.Join(parts, ", "))
} }
} }
}
if rec, err := dbs.ASN.Load().ASN(stdIP); err == nil && rec.AutonomousSystemNumber != 0 { if d.ASN != nil {
if rec, err := d.ASN.ASN(stdIP); err == nil && rec.AutonomousSystemNumber != 0 {
fmt.Fprintf(w, " ASN: AS%d %s\n", fmt.Fprintf(w, " ASN: AS%d %s\n",
rec.AutonomousSystemNumber, rec.AutonomousSystemOrganization) rec.AutonomousSystemNumber, rec.AutonomousSystemOrganization)
} }
} }
}

View File

@ -44,52 +44,6 @@ func DefaultConfPaths() []string {
return paths return paths
} }
// OpenDatabases discovers credentials and paths, then returns a ready-to-Init
// Databases. Returns nil with no error when geoip is not configured.
//
// - confPath="" → auto-discover from DefaultConfPaths
// - conf found → auto-download; cityPath/asnPath override default locations
// - no conf → cityPath and asnPath must point to existing .mmdb files
// - no conf and no paths → geoip disabled (returns nil, nil)
func OpenDatabases(confPath, cityPath, asnPath string) (*Databases, error) {
if confPath == "" {
for _, p := range DefaultConfPaths() {
if _, err := os.Stat(p); err == nil {
confPath = p
break
}
}
}
if confPath != "" {
cfg, err := ParseConf(confPath)
if err != nil {
return nil, fmt.Errorf("geoip-conf: %w", err)
}
dbDir := cfg.DatabaseDirectory
if dbDir == "" {
if dbDir, err = DefaultCacheDir(); err != nil {
return nil, fmt.Errorf("geoip cache dir: %w", err)
}
}
if err := os.MkdirAll(dbDir, 0o755); err != nil {
return nil, fmt.Errorf("mkdir %s: %w", dbDir, err)
}
if cityPath == "" {
cityPath = filepath.Join(dbDir, CityEdition+".mmdb")
}
if asnPath == "" {
asnPath = filepath.Join(dbDir, ASNEdition+".mmdb")
}
return New(cfg.AccountID, cfg.LicenseKey).NewDatabases(cityPath, asnPath), nil
}
if cityPath == "" && asnPath == "" {
return nil, nil
}
return NewDatabases(cityPath, asnPath), nil
}
// DefaultCacheDir returns the OS cache directory for MaxMind databases, // DefaultCacheDir returns the OS cache directory for MaxMind databases,
// e.g. ~/.cache/maxmind on Linux or ~/Library/Caches/maxmind on macOS. // e.g. ~/.cache/maxmind on Linux or ~/Library/Caches/maxmind on macOS.
func DefaultCacheDir() (string, error) { func DefaultCacheDir() (string, error) {

View File

@ -4,6 +4,5 @@ go 1.26.0
require ( require (
github.com/oschwald/geoip2-golang v1.13.0 github.com/oschwald/geoip2-golang v1.13.0
github.com/therootcompany/golib/net/dataset v0.0.0
github.com/therootcompany/golib/net/httpcache v0.0.0 github.com/therootcompany/golib/net/httpcache v0.0.0
) )