/
datasource.go
509 lines (434 loc) · 14.5 KB
/
datasource.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
package datasource
import (
"bytes"
"context"
"crypto/tls"
"encoding/json"
"errors"
"fmt"
"io"
"net"
"net/http"
"net/url"
"regexp"
"strconv"
"strings"
"time"
simplejson "github.com/bitly/go-simplejson"
"github.com/grafana/strava-datasource/pkg/grafanaclient"
"golang.org/x/net/context/ctxhttp"
"github.com/grafana/grafana-plugin-sdk-go/backend"
"github.com/grafana/grafana-plugin-sdk-go/backend/datasource"
"github.com/grafana/grafana-plugin-sdk-go/backend/gtime"
"github.com/grafana/grafana-plugin-sdk-go/backend/instancemgmt"
"github.com/grafana/grafana-plugin-sdk-go/backend/log"
)
const StravaAPIUrl = "https://www.strava.com/api/v3"
const StravaAPITokenUrl = "https://www.strava.com/api/v3/oauth/token"
const StravaApiQueryType = "stravaAPI"
const StravaAuthQueryType = "stravaAuth"
var ErrAlertingNotSupported = errors.New("alerting not supported")
type StravaDatasourcePlugin struct {
im instancemgmt.InstanceManager
dataDir string
saToken string
logger log.Logger
}
// StravaDatasourceInstance stores state about a specific datasource
// and provides methods to make requests to the Strava API
type StravaDatasourceInstance struct {
dsInfo *backend.DataSourceInstanceSettings
cache *DSCache
logger log.Logger
httpClient *http.Client
prefetcher *StravaPrefetcher
saToken string
grafanaClient grafanaclient.GrafanaHTTPClient
}
func NewStravaDatasourcePlugin(dataDir string, saToken string) *StravaDatasourcePlugin {
im := datasource.NewInstanceManager(newInstanceWithDataDir(dataDir, saToken))
return &StravaDatasourcePlugin{
im: im,
dataDir: dataDir,
saToken: saToken,
logger: log.New(),
}
}
func newInstanceWithDataDir(dataDir string, saToken string) func(context.Context, backend.DataSourceInstanceSettings) (instancemgmt.Instance, error) {
return func(ctx context.Context, settings backend.DataSourceInstanceSettings) (instancemgmt.Instance, error) {
return newStravaDatasourceInstance(ctx, settings, dataDir, saToken)
}
}
// newStravaDatasourceInstance returns an initialized datasource instance
func newStravaDatasourceInstance(ctx context.Context, settings backend.DataSourceInstanceSettings, dataDir string, saToken string) (instancemgmt.Instance, error) {
logger := log.New()
logger.Debug("Initializing new data source instance")
settingsDTO := &StravaDatasourceSettingsDTO{}
err := json.Unmarshal(settings.JSONData, settingsDTO)
if err != nil {
return nil, fmt.Errorf("cannot read data source settings: %w", err)
}
if settingsDTO.CacheTTL == "" {
settingsDTO.CacheTTL = "1h"
}
cacheTTL, err := gtime.ParseInterval(settingsDTO.CacheTTL)
if err != nil {
log.DefaultLogger.Warn("Cannot read cache TTL", "error", err)
}
grafanaClient, err := grafanaclient.NewGrafanaHTTPClient(ctx, settings, saToken)
if err != nil {
return nil, fmt.Errorf("cannot create grafana client: %w", err)
}
dsInstance := &StravaDatasourceInstance{
dsInfo: &settings,
logger: logger,
cache: NewDSCache(&settings, cacheTTL, 10*time.Minute, dataDir),
saToken: saToken,
grafanaClient: grafanaClient,
httpClient: &http.Client{
Transport: &http.Transport{
TLSClientConfig: &tls.Config{
Renegotiation: tls.RenegotiateFreelyAsClient,
},
Proxy: http.ProxyFromEnvironment,
Dial: (&net.Dialer{
Timeout: 30 * time.Second,
KeepAlive: 30 * time.Second,
}).Dial,
TLSHandshakeTimeout: 10 * time.Second,
ExpectContinueTimeout: 1 * time.Second,
MaxIdleConns: 100,
IdleConnTimeout: 90 * time.Second,
},
Timeout: time.Duration(time.Second * 30),
},
}
oauthPassThru := isOAuthPassThruEnabled(dsInstance)
if !oauthPassThru {
// Initialize and run prefetcher
prefetcher := NewStravaPrefetcher(5, dsInstance)
dsInstance.prefetcher = prefetcher
go func() {
dsInstance.prefetcher.Run()
}()
}
return dsInstance, nil
}
// getDSInstance Returns cached datasource or creates new one
func (ds *StravaDatasourcePlugin) getDSInstance(ctx context.Context, pluginContext backend.PluginContext) (*StravaDatasourceInstance, error) {
instance, err := ds.im.Get(ctx, pluginContext)
if err != nil {
return nil, err
}
return instance.(*StravaDatasourceInstance), nil
}
func (ds *StravaDatasourcePlugin) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) {
qdr := backend.NewQueryDataResponse()
for _, q := range req.Queries {
res := backend.DataResponse{}
res.Error = ErrAlertingNotSupported
qdr.Responses[q.RefID] = res
}
return qdr, nil
}
// CheckHealth checks if the plugin is running properly
func (ds *StravaDatasourcePlugin) CheckHealth(ctx context.Context, req *backend.CheckHealthRequest) (*backend.CheckHealthResult, error) {
res := &backend.CheckHealthResult{}
_, err := ds.getDSInstance(ctx, req.PluginContext)
if err != nil {
res.Status = backend.HealthStatusError
res.Message = "Error getting datasource instance"
ds.logger.Error("Error getting datasource instance", "err", err)
return res, nil
}
// TODO: implement real API health check
res.Status = backend.HealthStatusOk
res.Message = "Plugin up and running"
return res, nil
}
func (ds *StravaDatasourceInstance) StravaAuthQuery(ctx context.Context, req *StravaAuthRequest) (*StravaAuthResourceResponse, error) {
ds.logger.Debug("Performing authentication")
authCode := req.AuthCode
_, err := ds.ExchangeToken(authCode)
if err != nil {
return nil, err
}
tokenExchangeResp := map[string]string{
"message": "Authorization code successfully exchanged for refresh token",
}
response := &StravaAuthResourceResponse{
Result: tokenExchangeResp,
}
return response, nil
}
func (ds *StravaDatasourceInstance) GetAccessToken() (string, error) {
accessToken, expTime, found := ds.cache.gocache.GetWithExpiration("accessToken")
accessTokenExpired := time.Now().After(expTime)
if found && !accessTokenExpired {
return accessToken.(string), nil
} else if found && accessTokenExpired {
ds.logger.Debug("Access token expired, obtaining new one")
}
refreshToken, err := ds.GetRefreshToken()
if err != nil {
return "", err
}
tokenResp, err := ds.RefreshAccessToken(refreshToken)
if err != nil {
ds.logger.Error(err.Error())
return "", err
}
return tokenResp.AccessToken, nil
}
func (ds *StravaDatasourceInstance) GetRefreshToken() (string, error) {
cachedToken, found := ds.cache.Get("refreshToken")
if found {
ds.logger.Debug("Got refresh token from cache")
return cachedToken.(string), nil
}
secureJsonData := ds.dsInfo.DecryptedSecureJSONData
refreshToken := secureJsonData["refreshToken"]
if refreshToken == "" {
ds.logger.Error("Error loading refresh token")
return "", errors.New("Refresh token not found, authorize datasource first")
}
ds.logger.Debug("Got refresh token from secureJsonData")
return refreshToken, nil
}
// SaveRefreshToken saves refresh token in secureJsonData by calling update data source API endpoint
func (ds *StravaDatasourceInstance) SaveRefreshToken(token string) error {
ds.logger.Debug("saving refresh token")
ds.cache.SetWithNoExpiration("refreshToken", token)
res, err := ds.grafanaClient.Get(fmt.Sprintf("/api/datasources/uid/%s", ds.dsInfo.UID))
if err != nil {
return err
}
defer res.Body.Close()
body, err := io.ReadAll(res.Body)
if err != nil {
return err
}
jsonData := make(map[string]any)
err = json.Unmarshal(body, &jsonData)
if err != nil {
return err
}
secureJsonData := make(map[string]string)
secureJsonData["refreshToken"] = token
jsonData["secureJsonData"] = secureJsonData
updatedData, err := json.Marshal(jsonData)
if err != nil {
return err
}
reqData := bytes.NewReader(updatedData)
updateRes, err := ds.grafanaClient.DoRequest("PUT", fmt.Sprintf("/api/datasources/uid/%s", ds.dsInfo.UID), reqData)
if err != nil {
return err
}
ds.logger.Debug("data source updated", "status", updateRes.Status)
return nil
}
// ExchangeToken invokes first time when authentication required and exchange authorization code for the
// access and refresh tokens
// https://developers.strava.com/docs/authentication/#tokenexchange
func (ds *StravaDatasourceInstance) ExchangeToken(authCode string) (*TokenExchangeResponse, error) {
jsonDataStr := ds.dsInfo.JSONData
jsonData, err := simplejson.NewJson([]byte(jsonDataStr))
if err != nil {
return nil, err
}
clientId := jsonData.Get("clientID").MustString()
secureJsonData := ds.dsInfo.DecryptedSecureJSONData
clientSecret := secureJsonData["clientSecret"]
authParams := map[string][]string{
"client_id": {clientId},
"client_secret": {clientSecret},
"code": {authCode},
"grant_type": {"authorization_code"},
}
authResp, err := ds.httpClient.PostForm(StravaAPITokenUrl, authParams)
if err != nil {
return nil, err
} else if authResp.StatusCode != http.StatusOK {
return nil, fmt.Errorf("Auth error, status: %v", authResp.Status)
}
defer authResp.Body.Close()
body, err := io.ReadAll(authResp.Body)
if err != nil {
return nil, err
}
respJson, err := simplejson.NewJson(body)
if err != nil {
return nil, err
}
accessToken := respJson.Get("access_token").MustString()
accessTokenExpAt := respJson.Get("expires_at").MustInt64()
accessTokenExpIn := time.Until(time.Unix(accessTokenExpAt, 0))
refreshToken := respJson.Get("refresh_token").MustString()
ds.logger.Debug("Got new refresh token")
ds.cache.SetWithExpiration("accessToken", accessToken, accessTokenExpIn)
err = ds.SaveRefreshToken(refreshToken)
if err != nil {
ds.logger.Error("Error saving refresh token", "err", err)
return nil, fmt.Errorf("Error saving refresh token: %v", err)
}
return &TokenExchangeResponse{
AccessToken: accessToken,
AccessTokenExpAt: accessTokenExpAt,
RefreshToken: refreshToken,
}, nil
}
// RefreshAccessToken refreshes expired Access token using refresh token
// https://developers.strava.com/docs/authentication/#refreshingexpiredaccesstokens
func (ds *StravaDatasourceInstance) RefreshAccessToken(refreshToken string) (*TokenExchangeResponse, error) {
jsonDataStr := ds.dsInfo.JSONData
jsonData, err := simplejson.NewJson([]byte(jsonDataStr))
if err != nil {
return nil, err
}
clientId := jsonData.Get("clientID").MustString()
secureJsonData := ds.dsInfo.DecryptedSecureJSONData
clientSecret := secureJsonData["clientSecret"]
authParams := map[string][]string{
"client_id": {clientId},
"client_secret": {clientSecret},
"refresh_token": {refreshToken},
"grant_type": {"refresh_token"},
}
authResp, err := ds.httpClient.PostForm(StravaAPITokenUrl, authParams)
if err != nil {
return nil, err
}
if authResp.StatusCode != http.StatusOK {
return nil, fmt.Errorf("Token exchange failed: %v", authResp.Status)
}
defer authResp.Body.Close()
body, err := io.ReadAll(authResp.Body)
if err != nil {
return nil, err
}
respJson, err := simplejson.NewJson(body)
if err != nil {
return nil, err
}
accessToken := respJson.Get("access_token").MustString()
accessTokenExpAt := respJson.Get("expires_at").MustInt64()
accessTokenExpIn := time.Until(time.Unix(accessTokenExpAt, 0))
refreshTokenNew := respJson.Get("refresh_token").MustString()
ds.cache.SetWithExpiration("accessToken", accessToken, accessTokenExpIn)
if refreshTokenNew != refreshToken {
ds.logger.Debug("Got new refresh token")
err := ds.SaveRefreshToken(refreshToken)
if err != nil {
ds.logger.Error("Error saving refresh token", "err", err)
}
}
return &TokenExchangeResponse{
AccessToken: accessToken,
AccessTokenExpAt: accessTokenExpAt,
RefreshToken: refreshTokenNew,
}, nil
}
func (ds *StravaDatasourceInstance) ResetAccessToken() error {
ds.cache.Delete("accessToken")
ds.logger.Debug("Access token removed from cache")
return nil
}
func (ds *StravaDatasourceInstance) ResetCache() {
ds.cache.Flush()
ds.logger.Info("Cache has been reset", "data source", ds.dsInfo.Name)
}
func (ds *StravaDatasourceInstance) StravaAPIQueryWithCache(requestHash string) func(context.Context, *StravaAPIRequest) (*StravaApiResourceResponse, error) {
cachedEndpointsPattern := regexp.MustCompile(`activities/\d+|athlete|segments/\d`)
return func(ctx context.Context, query *StravaAPIRequest) (*StravaApiResourceResponse, error) {
if cachedEndpointsPattern.MatchString(query.Endpoint) || query.Endpoint == "athlete/activities" {
cachedResponse, found := ds.cache.Get(requestHash)
if found {
apiResponse, ok := cachedResponse.(*StravaApiResourceResponse)
if ok {
return apiResponse, nil
} else {
ds.logger.Error("Cannot get value from cache, type assertion failed")
}
}
response, err := ds.StravaAPIQuery(ctx, query)
if err != nil {
return nil, err
}
if query.Endpoint == "athlete/activities" {
ds.cache.Set(requestHash, response)
} else {
ds.cache.Set(requestHash, response)
}
return response, nil
} else {
return ds.StravaAPIQuery(ctx, query)
}
}
}
func (ds *StravaDatasourceInstance) StravaAPIQuery(ctx context.Context, query *StravaAPIRequest) (*StravaApiResourceResponse, error) {
accessToken := ""
var err error
if query.AccessToken == "" {
accessToken, err = ds.GetAccessToken()
if err != nil {
return nil, err
}
} else {
accessToken = query.AccessToken
}
endpoint := query.Endpoint
params := query.Params
requestUrlStr := fmt.Sprintf("%s/%s", StravaAPIUrl, strings.TrimLeft(endpoint, "/"))
requestUrl, err := url.Parse(requestUrlStr)
if err != nil {
return nil, err
}
q := requestUrl.Query()
for param, value := range params {
valueUnquoted, err := strconv.Unquote(string(value))
if err != nil {
valueUnquoted = string(value)
}
q.Add(param, valueUnquoted)
}
requestUrl.RawQuery = q.Encode()
ds.logger.Debug("Strava API query", "url", requestUrl.String())
req := &http.Request{
Method: "GET",
URL: requestUrl,
Header: map[string][]string{
"Authorization": {"Bearer " + accessToken},
},
}
apiResponse, err := makeHTTPRequest(ctx, ds.httpClient, req)
if err != nil {
return nil, err
}
return BuildAPIResponse(apiResponse)
}
func BuildAPIResponse(apiResponse []byte) (*StravaApiResourceResponse, error) {
resultJson, err := simplejson.NewJson(apiResponse)
if err != nil {
return nil, err
}
result := resultJson.Interface()
return &StravaApiResourceResponse{
Result: result,
}, nil
}
func makeHTTPRequest(ctx context.Context, httpClient *http.Client, req *http.Request) ([]byte, error) {
res, err := ctxhttp.Do(ctx, httpClient, req)
if err != nil {
return nil, err
}
defer res.Body.Close()
body, err := io.ReadAll(res.Body)
if res.StatusCode >= 400 {
return body, fmt.Errorf("Error status: %v", res.Status)
}
if err != nil {
return nil, err
}
return body, nil
}