Skip to content

Commit eb50910

Browse files
mblaschkemblaschke
committed
refactoring
- preparation for resty@v3 - switch back to resty@v2, digest seems to be broken in beta-2 - fixing some issues Signed-off-by: Markus Blaschke <[email protected]>
1 parent f88f629 commit eb50910

File tree

10 files changed

+130
-80
lines changed

10 files changed

+130
-80
lines changed

‎discovery/discoverytarget.go‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ package discovery
22

33
import (
44
"fmt"
5-
"strings"
65
)
76

87
type (
@@ -21,6 +20,10 @@ func (t *DiscoveryTarget) Name() string {
2120
return fmt.Sprintf(`%v [%v]`, t.Hostname, t.Address)
2221
}
2322

24-
func (t *DiscoveryTarget) Url(path string) string {
25-
return fmt.Sprintf("http://%v:%v/%s", t.Address, t.Port, strings.TrimLeft(path, "/"))
23+
func (t *DiscoveryTarget) BaseUrl() string {
24+
if t.Port == 80 {
25+
return fmt.Sprintf("http://%v", t.Address)
26+
} else {
27+
return fmt.Sprintf("http://%v:%v", t.Address, t.Port)
28+
}
2629
}

‎go.mod‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ require (
1212
github.com/prometheus/client_golang v1.22.0
1313
go.uber.org/zap v1.27.0
1414
go.uber.org/zap/exp v0.3.0
15-
resty.dev/v3 v3.0.0-beta.2
1615
)
1716

1817
require (

‎go.sum‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,5 +136,3 @@ google.golang.org/protobuf v1.36.6 h1:z1NpPI8ku2WgiWnf+t9wTPsn6eP1L7ksHUlkfLvd9x
136136
google.golang.org/protobuf v1.36.6/go.mod h1:jduwjTPXsFjZGTmRluh+L6NjiWu7pchiJ2/5YcXBHnY=
137137
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
138138
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
139-
resty.dev/v3 v3.0.0-beta.2 h1:xu4mGAdbCLuc3kbk7eddWfWm4JfhwDtdapwss5nCjnQ=
140-
resty.dev/v3 v3.0.0-beta.2/go.mod h1:OgkqiPvTDtOuV4MGZuUDhwOpkY8enjOsjjMzeOHefy4=

‎shellyplug/prober.gen1.go‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,11 @@ import (
1111
)
1212

1313
func (sp *ShellyPlug) collectFromTargetGen1(target discovery.DiscoveryTarget, logger *zap.SugaredLogger, infoLabels, targetLabels prometheus.Labels) {
14+
client := sp.restyClient(sp.ctx, target)
15+
1416
shellyProber := shellyprober.ShellyProberGen1{
1517
Target: target,
16-
Client: sp.cloneRestyClient(),
18+
Client: client,
1719
Ctx: sp.ctx,
1820
Cache: globalCache,
1921
}

‎shellyplug/prober.gen2.go‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,11 @@ type (
2222
func (sp *ShellyPlug) collectFromTargetGen2(target discovery.DiscoveryTarget, logger *zap.SugaredLogger, infoLabels, targetLabels prometheus.Labels) {
2323
sp.prometheus.info.With(infoLabels).Set(1)
2424

25+
client := sp.restyClient(sp.ctx, target)
26+
2527
shellyProber := shellyprober.ShellyProberGen2{
2628
Target: target,
27-
Client: sp.cloneRestyClient(),
29+
Client: client,
2830
Ctx: sp.ctx,
2931
Cache: globalCache,
3032
}

‎shellyplug/prober.go‎

Lines changed: 8 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,20 @@ package shellyplug
22

33
import (
44
"context"
5-
"errors"
6-
"fmt"
75
"strconv"
86
"sync"
97
"time"
108

11-
resty "github.com/go-resty/resty/v2"
129
cache "github.com/patrickmn/go-cache"
1310
"github.com/prometheus/client_golang/prometheus"
1411
"go.uber.org/zap"
1512

1613
"github.com/webdevops/shelly-plug-exporter/discovery"
1714
)
1815

19-
var (
20-
restyClient *resty.Client
21-
)
22-
2316
type (
2417
ShellyPlug struct {
2518
ctx context.Context
26-
client *resty.Client
2719
logger *zap.SugaredLogger
2820
registry *prometheus.Registry
2921

@@ -32,6 +24,11 @@ type (
3224
password string
3325
}
3426

27+
resty struct {
28+
timeout time.Duration
29+
userAgent string
30+
}
31+
3532
targets struct {
3633
list []discovery.DiscoveryTarget
3734
lock sync.RWMutex
@@ -46,59 +43,17 @@ func New(ctx context.Context, registry *prometheus.Registry, logger *zap.Sugared
4643
sp.ctx = ctx
4744
sp.registry = registry
4845
sp.logger = logger
49-
sp.initResty()
5046
sp.initMetrics()
5147

5248
if globalCache == nil {
5349
globalCache = cache.New(15*time.Minute, 1*time.Minute)
5450
}
5551

56-
return &sp
57-
}
58-
59-
func (sp *ShellyPlug) initResty() {
60-
if restyClient == nil {
61-
restyClient = resty.New()
62-
63-
restyClient.OnAfterResponse(func(client *resty.Client, response *resty.Response) error {
64-
switch statusCode := response.StatusCode(); statusCode {
65-
case 401:
66-
return errors.New(`shelly plug requires authentication and/or credentials are invalid`)
67-
case 200:
68-
// all ok, proceed
69-
return nil
70-
default:
71-
return fmt.Errorf(`expected http status 200, got %v`, response.StatusCode())
72-
}
73-
})
52+
if restyCache == nil {
53+
restyCache = cache.New(1*time.Hour, 1*time.Minute)
7454
}
7555

76-
sp.client = restyClient
77-
}
78-
79-
func (sp *ShellyPlug) SetUserAgent(val string) {
80-
sp.client.SetHeader("User-Agent", val)
81-
}
82-
83-
func (sp *ShellyPlug) SetTimeout(timeout time.Duration) {
84-
sp.client.SetTimeout(timeout)
85-
}
86-
87-
func (sp *ShellyPlug) SetHttpAuth(username, password string) {
88-
sp.auth.username = username
89-
sp.auth.password = password
90-
}
91-
92-
func (sp *ShellyPlug) cloneRestyClient() *resty.Client {
93-
client := sp.client.Clone()
94-
95-
if sp.auth.username != "" {
96-
client.SetDisableWarn(true)
97-
client.SetBasicAuth(sp.auth.username, sp.auth.password)
98-
client.SetDigestAuth(sp.auth.username, sp.auth.password)
99-
}
100-
101-
return client
56+
return &sp
10257
}
10358

10459
func (sp *ShellyPlug) SetTargets(targets []discovery.DiscoveryTarget) {

‎shellyplug/resty.go‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
package shellyplug
2+
3+
import (
4+
"context"
5+
"errors"
6+
"fmt"
7+
"time"
8+
9+
resty "github.com/go-resty/resty/v2"
10+
"github.com/patrickmn/go-cache"
11+
"go.uber.org/zap"
12+
13+
"github.com/webdevops/shelly-plug-exporter/discovery"
14+
)
15+
16+
var (
17+
restyCache *cache.Cache
18+
)
19+
20+
func (sp *ShellyPlug) SetUserAgent(val string) {
21+
sp.resty.userAgent = val
22+
}
23+
24+
func (sp *ShellyPlug) SetTimeout(timeout time.Duration) {
25+
sp.resty.timeout = timeout
26+
}
27+
28+
func (sp *ShellyPlug) SetHttpAuth(username, password string) {
29+
sp.auth.username = username
30+
sp.auth.password = password
31+
}
32+
33+
func (sp *ShellyPlug) restyClient(ctx context.Context, target discovery.DiscoveryTarget) (client *resty.Client) {
34+
cacheKey := target.Address
35+
if val, ok := restyCache.Get(cacheKey); ok {
36+
if client, ok := val.(*resty.Client); ok {
37+
return client
38+
}
39+
}
40+
41+
restyLogger := sp.logger.With(
42+
zap.String("target", target.Address),
43+
zap.String("type", target.Type),
44+
)
45+
46+
client = resty.New()
47+
client.SetBaseURL(target.BaseUrl())
48+
client.SetLogger(restyLogger)
49+
if sp.resty.timeout.Seconds() > 0 {
50+
client.SetTimeout(sp.resty.timeout)
51+
}
52+
53+
if sp.resty.userAgent != "" {
54+
client.SetHeader("User-Agent", sp.resty.userAgent)
55+
}
56+
// client.SetRetryCount(2).
57+
// SetRetryWaitTime(1 * time.Second).
58+
// SetRetryMaxWaitTime(5 * time.Second)
59+
60+
if sp.auth.username != "" {
61+
client.SetDisableWarn(true)
62+
client.SetBasicAuth(sp.auth.username, sp.auth.password)
63+
client.SetDigestAuth(sp.auth.username, sp.auth.password)
64+
}
65+
66+
// client.AddRequestMiddleware(func(c *resty.Client, req *resty.Request) error {
67+
// c.Logger().Debugf(`send request: %s %s`, req.Method, req.URL)
68+
// return nil
69+
// })
70+
//
71+
// client.AddResponseMiddleware(func(c *resty.Client, res *resty.Response) error {
72+
// c.Logger().Debugf(`got response: %s %s with status %v`, res.Request.Method, res.Request.RawRequest.URL.String(), res.StatusCode())
73+
// return nil
74+
// })
75+
76+
client.OnAfterResponse(func(c *resty.Client, res *resty.Response) error {
77+
switch res.StatusCode() {
78+
case 401:
79+
return errors.New(`shelly plug requires authentication and/or credentials are invalid`)
80+
case 200:
81+
// all ok, proceed
82+
return nil
83+
default:
84+
return fmt.Errorf(`expected http status 200, got %v`, res.StatusCode())
85+
}
86+
})
87+
88+
restyCache.SetDefault(cacheKey, client)
89+
90+
return
91+
}

‎shellyplug/results.go‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ type (
2222
func (sp *ShellyPlug) targetGetShellyInfo(target discovery.DiscoveryTarget) (ResultShellyInfo, error) {
2323
result := ResultShellyInfo{}
2424

25-
r := sp.client.R().SetContext(sp.ctx).SetResult(&result).ForceContentType("application/json")
26-
_, err := r.Get(target.Url("/shelly"))
25+
client := sp.restyClient(sp.ctx, target)
26+
27+
r := client.R().ForceContentType("application/json").SetResult(&result)
28+
_, err := r.Get("/shelly")
2729
return result, err
2830
}

‎shellyprober/gen1.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ package shellyprober
33
import (
44
"context"
55

6+
resty "github.com/go-resty/resty/v2"
67
"github.com/patrickmn/go-cache"
7-
resty "resty.dev/v3"
88

99
"github.com/webdevops/shelly-plug-exporter/discovery"
1010
)
@@ -99,9 +99,9 @@ type (
9999
}
100100
)
101101

102-
func (sp *ShellyProberGen1) fetch(url string, target interface{}) error {
103-
r := sp.Client.R().SetContext(sp.Ctx).SetResult(&target).ForceContentType("application/json")
104-
_, err := r.Get(sp.Target.Url(url))
102+
func (sp *ShellyProberGen1) fetch(url string, response interface{}) error {
103+
r := sp.Client.R().ForceContentType("application/json").SetResult(&response)
104+
_, err := r.Get(url)
105105
return err
106106
}
107107

‎shellyprober/gen2.go‎

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ import (
55
"encoding/json"
66
"fmt"
77

8+
resty "github.com/go-resty/resty/v2"
89
"github.com/patrickmn/go-cache"
9-
resty "resty.dev/v3"
1010

1111
"github.com/webdevops/shelly-plug-exporter/discovery"
1212
)
@@ -113,29 +113,27 @@ type (
113113
}
114114
)
115115

116-
func (sp *ShellyProberGen2) fetch(url string, target interface{}) error {
117-
r := sp.Client.R().SetContext(sp.Ctx).SetResult(&target).ForceContentType("application/json")
118-
_, err := r.Get(sp.Target.Url(url))
116+
func (sp *ShellyProberGen2) fetch(url string, response interface{}) error {
117+
r := sp.Client.R().ForceContentType("application/json").SetResult(&response)
118+
_, err := r.Get(url)
119119
return err
120120
}
121121

122-
func (sp *ShellyProberGen2) fetchWithCache(url string, target interface{}) error {
123-
url = sp.Target.Url(url)
124-
cacheKey := url
122+
func (sp *ShellyProberGen2) fetchWithCache(url string, response interface{}) error {
123+
cacheKey := fmt.Sprintf("%s/%s", sp.Client.BaseURL, url)
125124

126125
if val, ok := sp.Cache.Get(cacheKey); ok {
127126
if data, err := json.Marshal(val); err == nil {
128-
if err := json.Unmarshal(data, target); err == nil {
127+
if err := json.Unmarshal(data, &response); err == nil {
129128
return nil
130129
}
131130
}
132131
}
133132

134-
r := sp.Client.R().SetContext(sp.Ctx).SetResult(&target).ForceContentType("application/json")
135-
_, err := r.Get(url)
136-
137-
sp.Cache.SetDefault(cacheKey, target)
138-
133+
err := sp.fetch(url, &response)
134+
if err == nil {
135+
sp.Cache.SetDefault(cacheKey, response)
136+
}
139137
return err
140138
}
141139

0 commit comments

Comments
 (0)