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
|
package api
import (
"bytes"
"context"
"fmt"
"io"
"io/ioutil"
"net/http"
"os"
"reflect"
"time"
"golang.org/x/time/rate"
)
const DefaultEndpoint = "https://api.dns-platform.jp/dpf/v1"
type ClientInterface interface {
SetRoundTripper(rt http.RoundTripper)
Read(ctx context.Context, s Spec) (string, error)
List(ctx context.Context, s ListSpec, keywords SearchParams) (string, error)
ListAll(ctx context.Context, s CountableListSpec, keywords SearchParams) (string, error)
Count(ctx context.Context, s CountableListSpec, keywords SearchParams) (string, error)
Update(ctx context.Context, s Spec, body interface{}) (string, error)
Create(ctx context.Context, s Spec, body interface{}) (string, error)
Apply(ctx context.Context, s Spec, body interface{}) (string, error)
Delete(ctx context.Context, s Spec) (string, error)
Cancel(ctx context.Context, s Spec) (string, error)
WatchRead(ctx context.Context, interval time.Duration, s Spec) error
WatchList(ctx context.Context, interval time.Duration, s ListSpec, keyword SearchParams) error
WatchListAll(ctx context.Context, interval time.Duration, s CountableListSpec, keyword SearchParams) error
}
var _ ClientInterface = &Client{}
type Client struct {
Endpoint string
Token string
logger Logger
client *http.Client
LastRequest *RequestInfo
LastResponse *ResponseInfo
}
type RequestInfo struct {
Method string
URL string
Body []byte
}
type ResponseInfo struct {
Response *http.Response
Body []byte
}
type RateRoundTripper struct {
RroundTripper http.RoundTripper
Limiter *rate.Limiter
}
func NewRateRoundTripper(rt http.RoundTripper, limiter *rate.Limiter) *RateRoundTripper {
return &RateRoundTripper{
RroundTripper: rt,
Limiter: limiter,
}
}
func (r *RateRoundTripper) RoundTrip(req *http.Request) (*http.Response, error) {
if r.Limiter == nil {
r.Limiter = rate.NewLimiter(rate.Limit(1.0), 5)
}
if r.RroundTripper == nil {
r.RroundTripper = http.DefaultTransport
}
if err := r.Limiter.Wait(req.Context()); err != nil {
return nil, fmt.Errorf("request rate-limit by client side: %w", err)
}
return r.RroundTripper.RoundTrip(req)
}
func NewClient(token string, endpoint string, logger Logger) *Client {
if endpoint == "" {
endpoint = DefaultEndpoint
}
if logger == nil {
logger = NewStdLogger(os.Stderr, "dpf-client", 0, 4)
}
return &Client{Endpoint: endpoint, Token: token, logger: logger, client: &http.Client{Transport: NewRateRoundTripper(nil, nil)}}
}
func (c *Client) SetRoundTripper(rt http.RoundTripper) {
c.client.Transport = rt
}
func (c *Client) marshalJSON(action Action, body interface{}) ([]byte, error) {
var (
jsonBody []byte
err error
)
switch action {
case ActionCreate:
jsonBody, err = JSON.MarshalCreate(body)
case ActionUpdate:
jsonBody, err = JSON.MarshalUpdate(body)
case ActionApply:
jsonBody, err = JSON.MarshalApply(body)
default:
return nil, fmt.Errorf("not support action `%s` with body request", action)
}
if err != nil {
return nil, fmt.Errorf("failed to encode body to json: %w", err)
}
return jsonBody, nil
}
func (c *Client) doSetup(ctx context.Context, spec Spec, action Action, body interface{}, params SearchParams) (*http.Request, error) {
var r io.Reader
if action == ActionCount {
_, ok := spec.(CountableListSpec)
if !ok {
return nil, fmt.Errorf("spec is not CountableListSpec")
}
}
c.LastRequest = &RequestInfo{}
c.LastResponse = nil
// create URL
method, path := spec.GetPathMethod(action)
if path == "" {
return nil, fmt.Errorf("not support action %s", action)
}
c.LastRequest.Method = method
url := c.Endpoint + path
if params != nil {
p, err := params.GetValues()
if err != nil {
return nil, fmt.Errorf("failed to get search params: %w", err)
}
url += "?" + p.Encode()
}
c.LastRequest.URL = url
c.logger.Debugf("method: %s request-url: %s", method, url)
// make request body
if body != nil {
jsonBody, err := c.marshalJSON(action, body)
if err != nil {
return nil, err
}
c.logger.Tracef("request-body: `%s`", string(jsonBody))
c.LastRequest.Body = jsonBody
r = bytes.NewBuffer(jsonBody)
}
// make request
req, err := http.NewRequest(method, url, r)
if err != nil {
return nil, fmt.Errorf("failed to create http request: %w", err)
}
// authorized
req.Header.Add("Authorization", "Bearer "+c.Token)
req.Header.Add("Content-Type", "application/json")
return req.WithContext(ctx), nil
}
func (c *Client) Do(ctx context.Context, spec Spec, action Action, body interface{}, params SearchParams) (string, error) {
req, err := c.doSetup(ctx, spec, action, body, params)
if err != nil {
return "", err
}
// request
resp, err := c.client.Do(req)
if err != nil {
return "", fmt.Errorf("failed to get http response: %w", err)
}
defer resp.Body.Close()
c.LastResponse = &ResponseInfo{
Response: resp,
}
// get body
bs, err := ioutil.ReadAll(resp.Body)
if err != nil {
return "", fmt.Errorf("failed to get http response body: %w", err)
}
c.LastResponse.Body = bs
c.logger.Debugf("status-code: `%d`", resp.StatusCode)
c.logger.Tracef("response-body: `%s`", string(bs))
// if statiscode is error, response body type is BadResponse or Plantext
if resp.StatusCode >= http.StatusBadRequest {
badRequest := &BadResponse{StatusCode: resp.StatusCode}
if err := UnmarshalRead(bs, badRequest); err != nil {
return "", fmt.Errorf("failed to request: status code: %d body: %s err: %w", resp.StatusCode, string(bs), err)
}
return badRequest.RequestID, badRequest
}
// parse raw response
rawResponse := &RawResponse{}
if err := UnmarshalRead(bs, rawResponse); err != nil {
// maybe not executed
return "", fmt.Errorf("failed to parse get response: %w", err)
}
if req.Method == http.MethodGet {
if err := c.doReadResponse(action, spec, bs, rawResponse); err != nil {
return rawResponse.RequestID, err
}
}
// initialize process
if d, ok := spec.(Initializer); ok {
d.Init()
}
return rawResponse.RequestID, nil
}
func (c *Client) doReadResponse(action Action, spec Spec, bs []byte, rawResponse *RawResponse) error {
switch {
case action == ActionCount:
// ActionCount
count := &Count{}
if err := UnmarshalRead(rawResponse.Result, count); err != nil {
return fmt.Errorf("failed to parse count response result: %w", err)
}
if cl, ok := spec.(CountableListSpec); ok {
cl.SetCount(count.Count)
}
case rawResponse.Result != nil:
// ActionRead
if err := UnmarshalRead(rawResponse.Result, spec); err != nil {
return fmt.Errorf("failed to parse response result: %w", err)
}
case rawResponse.Results != nil:
// ActionList
listSpec, ok := spec.(ListSpec)
if !ok {
return fmt.Errorf("not support ListSpec %s", spec.GetName())
}
items := listSpec.GetItems()
if err := UnmarshalRead(rawResponse.Results, items); err != nil {
return fmt.Errorf("failed to parse list response results: %w", err)
}
default:
if err := UnmarshalRead(bs, spec); err != nil {
return fmt.Errorf("failed to parse response result: %w", err)
}
}
return nil
}
func (c *Client) Read(ctx context.Context, s Spec) (string, error) {
return c.Do(ctx, s, ActionRead, nil, nil)
}
func (c *Client) List(ctx context.Context, s ListSpec, keywords SearchParams) (string, error) {
return c.Do(ctx, s, ActionList, nil, keywords)
}
func (c *Client) ListAll(ctx context.Context, s CountableListSpec, keywords SearchParams) (string, error) {
req, err := c.Count(ctx, s, keywords)
if err != nil {
return req, err
}
if keywords == nil {
keywords = &CommonSearchParams{}
keywords.SetLimit(s.GetMaxLimit())
}
count := s.GetCount()
cList := DeepCopyCountableListSpec(s)
for offset := int32(0); offset < count; offset += keywords.GetLimit() {
keywords.SetOffset(offset)
req, err = c.List(ctx, cList, keywords)
if err != nil {
return req, err
}
for i := 0; i < cList.Len(); i++ {
s.AddItem(cList.Index(i))
}
}
return req, nil
}
func (c *Client) Count(ctx context.Context, s CountableListSpec, keywords SearchParams) (string, error) {
return c.Do(ctx, s, ActionCount, nil, keywords)
}
func (c *Client) Update(ctx context.Context, s Spec, body interface{}) (string, error) {
if body == nil {
body = s
}
return c.Do(ctx, s, ActionUpdate, body, nil)
}
func (c *Client) Create(ctx context.Context, s Spec, body interface{}) (string, error) {
if body == nil {
body = s
}
return c.Do(ctx, s, ActionCreate, body, nil)
}
func (c *Client) Apply(ctx context.Context, s Spec, body interface{}) (string, error) {
if body == nil {
body = s
}
return c.Do(ctx, s, ActionApply, body, nil)
}
func (c *Client) Delete(ctx context.Context, s Spec) (string, error) {
return c.Do(ctx, s, ActionDelete, nil, nil)
}
func (c *Client) Cancel(ctx context.Context, s Spec) (string, error) {
return c.Do(ctx, s, ActionCancel, nil, nil)
}
func (c *Client) watch(ctx context.Context, interval time.Duration, f func(context.Context) (keep bool, err error)) error {
if interval < time.Second {
return fmt.Errorf("interval must greater than equals to 1s")
}
ticker := time.NewTicker(interval)
defer ticker.Stop()
LOOP:
for {
select {
case <-ticker.C:
loopBreak, err := f(ctx)
if err != nil {
return err
}
if loopBreak {
break LOOP
}
case <-ctx.Done():
break LOOP
}
}
return ctx.Err()
}
// ctx should set Deadline or Timeout
// interval must be grater than equals to 1s
// s is Readable Spec.
func (c *Client) WatchRead(ctx context.Context, interval time.Duration, s Spec) error {
org := DeepCopySpec(s)
return c.watch(ctx, interval, func(cctx context.Context) (bool, error) {
_, err := c.Read(cctx, s)
if err != nil {
return true, err
}
if reflect.DeepEqual(s, org) {
return false, nil
}
return true, nil
})
}
// ctx should set Deadline or Timeout
// interval must be grater than equals to 1s
// s is ListAble Spec.
func (c *Client) WatchList(ctx context.Context, interval time.Duration, s ListSpec, keyword SearchParams) error {
org := DeepCopyListSpec(s)
return c.watch(ctx, interval, func(cctx context.Context) (bool, error) {
_, err := c.List(cctx, s, keyword)
if err != nil {
return true, err
}
if reflect.DeepEqual(s, org) {
return false, nil
}
return true, nil
})
}
// ctx should set Deadline or Timeout
// interval must be grater than equals to 1s
// s is CountableListSpec Spec.
func (c *Client) WatchListAll(ctx context.Context, interval time.Duration, s CountableListSpec, keyword SearchParams) error {
copySpec := DeepCopyCountableListSpec(s)
copySpec.ClearItems()
err := c.watch(ctx, interval, func(cctx context.Context) (bool, error) {
_, err := c.ListAll(cctx, copySpec, keyword)
if err != nil {
return true, err
}
if reflect.DeepEqual(s, copySpec) {
return false, nil
}
return true, nil
})
if err != nil {
return err
}
s.ClearItems()
for i := 0; i < copySpec.Len(); i++ {
s.AddItem(copySpec.Index(i))
}
s.SetCount(int32(copySpec.Len()))
return nil
}
|