chore(all): return concrete types, accept interfaces

- Remove exported interfaces unused locally
- Define interfaces to accept arguments
- Return concrete types, not interfaces
This commit is contained in:
Quentin McGaw
2022-06-11 01:34:30 +00:00
parent 0378fe4a7b
commit 578ef768ab
132 changed files with 594 additions and 935 deletions

View File

@@ -1,6 +0,0 @@
package publicip
import "github.com/qdm12/gluetun/internal/publicip/state"
type GetSetter = state.DataGetSetter
type SettingsGetSetter = state.SettingsGetSetter

View File

@@ -12,12 +12,6 @@ import (
"strings"
)
var _ Fetcher = (*Fetch)(nil)
type Fetcher interface {
FetchPublicIP(ctx context.Context) (ip net.IP, err error)
}
type Fetch struct {
client *http.Client
randIntn func(n int) int

View File

@@ -0,0 +1,28 @@
package publicip
import (
"context"
"net"
"github.com/qdm12/gluetun/internal/configuration/settings"
"github.com/qdm12/gluetun/internal/models"
publicipmodels "github.com/qdm12/gluetun/internal/publicip/models"
)
type statusManager interface {
GetStatus() (status models.LoopStatus)
SetStatus(status models.LoopStatus)
ApplyStatus(ctx context.Context, status models.LoopStatus) (
outcome string, err error)
}
type stateManager interface {
GetData() (data publicipmodels.IPInfoData)
SetData(data publicipmodels.IPInfoData)
GetSettings() (settings settings.PublicIP)
SetSettings(ctx context.Context, settings settings.PublicIP) (outcome string)
}
type fetcher interface {
FetchPublicIP(ctx context.Context) (ip net.IP, err error)
}

View File

@@ -11,22 +11,11 @@ import (
"github.com/qdm12/gluetun/internal/publicip/state"
)
var _ Looper = (*Loop)(nil)
type Looper interface {
Runner
RestartTickerRunner
loopstate.Getter
loopstate.Applier
SettingsGetSetter
GetSetter
}
type Loop struct {
statusManager loopstate.Manager
state state.Manager
statusManager statusManager
state stateManager
// Objects
fetcher Fetcher
fetcher fetcher
client *http.Client
logger Logger
// Fixed settings

View File

@@ -8,10 +8,6 @@ import (
"github.com/qdm12/gluetun/internal/constants"
)
type Runner interface {
Run(ctx context.Context, done chan<- struct{})
}
func (l *Loop) Run(ctx context.Context, done chan<- struct{}) {
defer close(done)

View File

@@ -4,11 +4,6 @@ import (
"github.com/qdm12/gluetun/internal/publicip/models"
)
type DataGetSetter interface {
GetData() (data models.IPInfoData)
SetData(data models.IPInfoData)
}
func (s *State) GetData() (data models.IPInfoData) {
s.ipDataMu.RLock()
defer s.ipDataMu.RUnlock()

View File

@@ -7,12 +7,6 @@ import (
"github.com/qdm12/gluetun/internal/configuration/settings"
)
type SettingsGetSetter interface {
GetSettings() (settings settings.PublicIP)
SetSettings(ctx context.Context,
settings settings.PublicIP) (outcome string)
}
func (s *State) GetSettings() (settings settings.PublicIP) {
s.settingsMu.RLock()
defer s.settingsMu.RUnlock()

View File

@@ -1,21 +1,15 @@
package state
import (
"context"
"sync"
"github.com/qdm12/gluetun/internal/configuration/settings"
"github.com/qdm12/gluetun/internal/loopstate"
"github.com/qdm12/gluetun/internal/publicip/models"
"github.com/qdm12/gluetun/internal/models"
publicipmodels "github.com/qdm12/gluetun/internal/publicip/models"
)
var _ Manager = (*State)(nil)
type Manager interface {
SettingsGetSetter
DataGetSetter
}
func New(statusApplier loopstate.Applier,
func New(statusApplier StatusApplier,
settings settings.PublicIP,
updateTicker chan<- struct{}) *State {
return &State{
@@ -26,13 +20,18 @@ func New(statusApplier loopstate.Applier,
}
type State struct {
statusApplier loopstate.Applier
statusApplier StatusApplier
settings settings.PublicIP
settingsMu sync.RWMutex
ipData models.IPInfoData
ipData publicipmodels.IPInfoData
ipDataMu sync.RWMutex
updateTicker chan<- struct{}
}
type StatusApplier interface {
ApplyStatus(ctx context.Context, status models.LoopStatus) (
outcome string, err error)
}

View File

@@ -7,10 +7,6 @@ import (
"github.com/qdm12/gluetun/internal/constants"
)
type RestartTickerRunner interface {
RunRestartTicker(ctx context.Context, done chan<- struct{})
}
func (l *Loop) RunRestartTicker(ctx context.Context, done chan<- struct{}) {
defer close(done)
timer := time.NewTimer(time.Hour)
@@ -30,7 +26,7 @@ func (l *Loop) RunRestartTicker(ctx context.Context, done chan<- struct{}) {
return
case <-timer.C:
lastTick = l.timeNow()
_, _ = l.ApplyStatus(ctx, constants.Running)
_, _ = l.statusManager.ApplyStatus(ctx, constants.Running)
timer.Reset(*l.state.GetSettings().Period)
case <-l.updateTicker:
if !timerIsStopped && !timer.Stop() {