-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathsdk.go
More file actions
297 lines (256 loc) · 7.9 KB
/
sdk.go
File metadata and controls
297 lines (256 loc) · 7.9 KB
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
package sdk
import (
"crypto/rand"
"encoding/json"
"errors"
"fmt"
"net/http"
"slices"
"strings"
"time"
"github.com/google/uuid"
"golang.org/x/crypto/nacl/box"
)
var (
ErrInvalidRequest = errors.New("invalid request")
ErrInvalidConfiguration = errors.New("invalid configuration")
ErrClientInternal = errors.New("internal client error")
// server errors - needs exact match with server response.code
ErrBadGateway = errors.New("bad gateway") // temporary - can retry
ErrServerInternal = errors.New("internal server error") // temporary - can retry
ErrBadRequest = errors.New("bad request") // fatal - don't retry
ErrForbidden = errors.New("forbidden") // fatal - don't retry
ErrNotFound = errors.New("not found") // fatal - don't retry
ErrTooManyRequests = errors.New("rate limit exceeded") // temporary - can retry with default delay
ErrTooManyRequestsRPM = errors.New("RPM limit exceeded") // temporary - can retry with RestTime
ErrTooManyRequestsRPH = errors.New("RPH limit exceeded") // fatal - too long wait
ErrTooManyRequestsRPD = errors.New("RPD limit exceeded") // fatal - too long wait
ErrInvalidSignature = errors.New("invalid signature") // fatal - crypto issue
ErrReplayAttack = errors.New("replay attack") // fatal - security issue
// client errors
ErrTicketFailed = errors.New("failed to get ticket")
ErrPoWFailed = errors.New("proof of work failed")
ErrCryptoFailed = errors.New("cryptographic operation failed")
ErrRequestFailed = errors.New("request execution failed")
ErrMaxRetriesExceeded = errors.New("maximum retry attempts exceeded")
)
// ServerErrorResponse represents server error response format
type ServerErrorResponse struct {
Status string `json:"status"`
Code string `json:"code"`
}
// isTemporaryError determines if error is temporary and can be retried
func isTemporaryError(err error) bool {
switch err {
case ErrBadGateway, ErrServerInternal, ErrTooManyRequests, ErrTooManyRequestsRPM, ErrExperimentTimeout:
return true
default:
return false
}
}
// parseServerError parses server error response and returns appropriate error
func parseServerError(statusCode int, body []byte) error {
if statusCode == 200 {
return nil
}
var serverErr ServerErrorResponse
if err := json.Unmarshal(body, &serverErr); err != nil {
return fmt.Errorf("HTTP %d: %w", statusCode, ErrRequestFailed)
}
switch serverErr.Code {
case "BadGateway":
return ErrBadGateway
case "Internal":
return ErrServerInternal
case "BadRequest":
return ErrBadRequest
case "Forbidden":
return ErrForbidden
case "NotFound":
return ErrNotFound
case "TooManyRequests":
return ErrTooManyRequests
case "TooManyRequestsRPM":
return ErrTooManyRequestsRPM
case "TooManyRequestsRPH":
return ErrTooManyRequestsRPH
case "TooManyRequestsRPD":
return ErrTooManyRequestsRPD
default:
return fmt.Errorf("%s: %w", serverErr.Code, ErrRequestFailed)
}
}
type Option func(*sdk)
func WithTransport(transport *http.Transport) Option {
return func(s *sdk) {
if transport != nil {
s.transport = transport
}
}
}
func WithLogger(logger Logger) Option {
return func(s *sdk) {
if logger != nil {
s.logger = logger
}
}
}
func WithClient(name string, version string) Option {
return func(s *sdk) {
s.clientName = name
s.clientVersion = version
}
}
func WithPowTimeout(timeout time.Duration) Option {
return func(s *sdk) {
s.powTimeout = timeout
}
}
func WithMaxRetries(maxRetries int) Option {
return func(s *sdk) {
s.maxRetries = maxRetries
}
}
func WithLicenseKey(key string) Option {
return func(s *sdk) {
info, err := IntrospectLicenseKey(key)
if err == nil && info != nil && info.IsValid() {
s.licenseKey = decodeLicenseKey(key)
s.licenseFP = computeLicenseKeyFP(s.licenseKey)
}
}
}
func WithInstallationID(installationID [16]byte) Option {
return func(s *sdk) {
s.installationID = installationID
}
}
func withServerPublicKey(serverPublicKey *[32]byte) Option {
return func(s *sdk) {
s.serverPublicKey = serverPublicKey
}
}
type sdk struct {
clientName string
clientVersion string
client *http.Client
transport *http.Transport
logger Logger
powTimeout time.Duration
maxRetries int
licenseKey [10]byte
licenseFP [16]byte
installationID [16]byte
// NaCL keypair for session key encryption
clientPublicKey *[32]byte
clientPrivateKey *[32]byte
serverPublicKey *[32]byte
}
func defaultSDK() *sdk {
installationID := [16]byte(uuid.New())
return &sdk{
clientName: DefaultClientName,
clientVersion: DefaultClientVersion,
transport: DefaultTransport(),
logger: DefaultLogger(),
powTimeout: DefaultPowTimeout,
maxRetries: DefaultMaxRetries,
installationID: installationID,
serverPublicKey: getServerPublicKey(),
}
}
func Build(configs []CallConfig, options ...Option) error {
sdk := defaultSDK()
for _, option := range options {
option(sdk)
}
sdk.client = &http.Client{
Transport: sdk.transport,
}
var err error
if sdk.clientPublicKey, sdk.clientPrivateKey, err = box.GenerateKey(rand.Reader); err != nil {
return fmt.Errorf("%w: failed to generate client NaCL keypair: %w", ErrClientInternal, err)
}
if sdk.clientPublicKey == nil || sdk.clientPrivateKey == nil {
return fmt.Errorf("%w: failed to generate client NaCL keypair", ErrClientInternal)
}
for idx, cfg := range configs {
if err := sdk.buildCall(cfg); err != nil {
format := "failed to build call[%d] '%s': %w: %w"
return fmt.Errorf(format, idx, cfg.Name, ErrInvalidConfiguration, err)
}
}
return nil
}
func (s sdk) buildCall(cfg CallConfig) error {
if cfg.Host == "" {
return fmt.Errorf("host is required")
}
if cfg.Name == "" {
return fmt.Errorf("name is required")
}
for _, call := range cfg.Calls {
if err := checkCallType(call); err != nil {
return err
}
}
switch cfg.Method {
case CallMethodGET, CallMethodDELETE:
if slices.ContainsFunc(cfg.Calls, isCallWithBody) {
return fmt.Errorf("call with body is not supported for GET and DELETE methods")
}
case CallMethodPUT, CallMethodPATCH:
if !slices.ContainsFunc(cfg.Calls, isCallWithBody) {
return fmt.Errorf("call with body is required for POST, PUT and PATCH methods")
}
fallthrough
case CallMethodPOST:
if slices.ContainsFunc(cfg.Calls, isCallWithQuery) {
return fmt.Errorf("call with query is not supported for POST, PUT and PATCH methods")
}
default:
return fmt.Errorf("invalid call method: '%s'", cfg.Method)
}
pathGenerator, argsNumber, err := s.parsePath(cfg.Path)
if err != nil {
return fmt.Errorf("invalid path: '%s': %w", cfg.Path, err)
}
for _, call := range cfg.Calls {
if argsNumber > 0 && !isCallWithArgs(call) {
return fmt.Errorf("call with position arguments must use variant call type with args")
}
}
if err := fillCallFunc(cfg, s, pathGenerator); err != nil {
return fmt.Errorf("failed to fill call func: %w", err)
}
return nil
}
// parsePath parses the path and returns the path template and position arguments number
func (s sdk) parsePath(p string) (pathGenerator, int, error) {
parts := make([]string, 0)
names := make([]string, 0)
indices := make([]int, 0)
for idx, part := range strings.Split(p, "/") {
if strings.HasPrefix(part, ":") {
indices = append(indices, idx)
names = append(names, strings.TrimPrefix(part, ":"))
}
parts = append(parts, part)
}
return func(args []string) (string, error) {
if len(indices) == 0 {
return p, nil
}
if len(args) == 0 {
return "", fmt.Errorf("no arguments provided: must be %d: %v", len(indices), names)
}
if len(args) != len(indices) {
return "", fmt.Errorf("invalid number of arguments: must be %d: %v", len(indices), names)
}
parts = slices.Clone(parts)
for idx, arg := range args {
parts[indices[idx]] = arg
}
return strings.Join(parts, "/"), nil
}, len(indices), nil
}