/
folder.go
332 lines (296 loc) · 9.98 KB
/
folder.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
package s3
import (
"io"
"path"
"strconv"
"strings"
"time"
"github.com/apecloud/dataprotection-wal-g/pkg/storages/storage"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/awserr"
"github.com/aws/aws-sdk-go/service/s3"
"github.com/aws/aws-sdk-go/service/s3/s3iface"
"github.com/pkg/errors"
)
const (
NotFoundAWSErrorCode = "NotFound"
NoSuchKeyAWSErrorCode = "NoSuchKey"
EndpointSetting = "AWS_ENDPOINT"
RegionSetting = "AWS_REGION"
ForcePathStyleSetting = "AWS_S3_FORCE_PATH_STYLE"
AccessKeyIDSetting = "AWS_ACCESS_KEY_ID"
AccessKeySetting = "AWS_ACCESS_KEY"
SecretAccessKeySetting = "AWS_SECRET_ACCESS_KEY"
SecretKeySetting = "AWS_SECRET_KEY"
SessionTokenSetting = "AWS_SESSION_TOKEN"
SessionName = "AWS_ROLE_SESSION_NAME"
RoleARN = "AWS_ROLE_ARN"
S3UseYcSessionToken = "S3_USE_YC_SESSION_TOKEN"
SseSetting = "S3_SSE"
SseCSetting = "S3_SSE_C"
SseKmsIDSetting = "S3_SSE_KMS_ID"
StorageClassSetting = "S3_STORAGE_CLASS"
UploadConcurrencySetting = "UPLOAD_CONCURRENCY"
s3CertFile = "S3_CA_CERT_FILE"
MaxPartSize = "S3_MAX_PART_SIZE"
EndpointSourceSetting = "S3_ENDPOINT_SOURCE"
EndpointPortSetting = "S3_ENDPOINT_PORT"
LogLevel = "S3_LOG_LEVEL"
UseListObjectsV1 = "S3_USE_LIST_OBJECTS_V1"
RangeBatchEnabled = "S3_RANGE_BATCH_ENABLED"
RangeQueriesMaxRetries = "S3_RANGE_MAX_RETRIES"
// MaxRetriesSetting limits retries during interaction with S3
MaxRetriesSetting = "S3_MAX_RETRIES"
RangeBatchEnabledDefault = false
RangeMaxRetriesDefault = 10
RangeQueryMinRetryDelay = 30 * time.Millisecond
RangeQueryMaxRetryDelay = 300 * time.Second
MaxRetriesDefault = 15
)
var (
// MaxRetries limit upload and download retries during interaction with S3
MaxRetries = 15
SettingList = []string{
EndpointPortSetting,
EndpointSetting,
EndpointSourceSetting,
RegionSetting,
ForcePathStyleSetting,
AccessKeyIDSetting,
AccessKeySetting,
SecretAccessKeySetting,
SecretKeySetting,
SessionTokenSetting,
SessionName,
RoleARN,
S3UseYcSessionToken,
SseSetting,
SseCSetting,
SseKmsIDSetting,
StorageClassSetting,
UploadConcurrencySetting,
s3CertFile,
MaxPartSize,
UseListObjectsV1,
LogLevel,
RangeBatchEnabled,
RangeQueriesMaxRetries,
MaxRetriesSetting,
}
)
func NewFolderError(err error, format string, args ...interface{}) storage.Error {
return storage.NewError(err, "S3", format, args...)
}
func NewConfiguringError(settingName string) storage.Error {
return NewFolderError(errors.New("Configuring error"),
"%s setting is not set", settingName)
}
type Folder struct {
uploader Uploader
S3API s3iface.S3API
Bucket *string
Path string
settings map[string]string
useListObjectsV1 bool
}
func NewFolder(uploader Uploader, s3API s3iface.S3API, settings map[string]string, bucket, path string, useListObjectsV1 bool) *Folder {
return &Folder{
uploader: uploader,
S3API: s3API,
settings: settings,
Bucket: aws.String(bucket),
Path: storage.AddDelimiterToPath(path),
useListObjectsV1: useListObjectsV1,
}
}
func ConfigureFolder(prefix string, settings map[string]string) (storage.Folder, error) {
bucket, storagePath, err := storage.GetPathFromPrefix(prefix)
if err != nil {
return nil, errors.Wrap(err, "failed to configure S3 path")
}
sess, err := createSession(bucket, settings)
if err != nil {
return nil, errors.Wrap(err, "failed to create new session")
}
client := s3.New(sess)
uploader, err := configureUploader(client, settings)
if err != nil {
return nil, errors.Wrap(err, "failed to configure S3 uploader")
}
useListObjectsV1 := false
if strUseListObjectsV1, ok := settings[UseListObjectsV1]; ok {
useListObjectsV1, err = strconv.ParseBool(strUseListObjectsV1)
if err != nil {
return nil, NewFolderError(err, "Invalid s3 list objects version setting")
}
}
folder := NewFolder(*uploader, client, settings, bucket, storagePath, useListObjectsV1)
return folder, nil
}
func (folder *Folder) Exists(objectRelativePath string) (bool, error) {
objectPath := folder.Path + objectRelativePath
stopSentinelObjectInput := &s3.HeadObjectInput{
Bucket: folder.Bucket,
Key: aws.String(objectPath),
}
_, err := folder.S3API.HeadObject(stopSentinelObjectInput)
if err != nil {
if isAwsNotExist(err) {
return false, nil
}
return false, errors.Wrapf(err, "failed to check s3 object '%s' existence", objectPath)
}
return true, nil
}
func (folder *Folder) PutObject(name string, content io.Reader) error {
return folder.uploader.upload(*folder.Bucket, folder.Path+name, content)
}
func (folder *Folder) CopyObject(srcPath string, dstPath string) error {
if exists, err := folder.Exists(srcPath); !exists {
if err == nil {
return errors.New("object does not exist")
}
return err
}
source := path.Join(*folder.Bucket, folder.Path, srcPath)
dst := path.Join(folder.Path, dstPath)
input := &s3.CopyObjectInput{CopySource: &source, Bucket: folder.Bucket, Key: &dst}
_, err := folder.S3API.CopyObject(input)
if err != nil {
return err
}
return nil
}
func (folder *Folder) ReadObject(objectRelativePath string) (io.ReadCloser, error) {
objectPath := folder.Path + objectRelativePath
input := &s3.GetObjectInput{
Bucket: folder.Bucket,
Key: aws.String(objectPath),
}
object, err := folder.S3API.GetObject(input)
if err != nil {
if isAwsNotExist(err) {
return nil, storage.NewObjectNotFoundError(objectPath)
}
return nil, errors.Wrapf(err, "failed to read object: '%s' from S3", objectPath)
}
rangeEnabled, maxRetries, minRetryDelay, maxRetryDelay := folder.getReaderSettings()
reader := object.Body
if rangeEnabled {
reader = NewS3Reader(object.Body, objectPath, maxRetries, folder, minRetryDelay, maxRetryDelay)
}
return reader, nil
}
func (folder *Folder) getReaderSettings() (rangeEnabled bool, retriesCount int, minRetryDelay, maxRetryDelay time.Duration) {
rangeEnabled = RangeBatchEnabledDefault
if rangeBatch, ok := folder.settings[RangeBatchEnabled]; ok {
if strings.TrimSpace(strings.ToLower(rangeBatch)) == "true" {
rangeEnabled = true
} else {
rangeEnabled = false
}
}
retriesCount = RangeMaxRetriesDefault
if maxRetriesRaw, ok := folder.settings[RangeQueriesMaxRetries]; ok {
if maxRetriesInt, err := strconv.Atoi(maxRetriesRaw); err == nil {
retriesCount = maxRetriesInt
}
}
if minRetryDelay == 0 {
minRetryDelay = RangeQueryMinRetryDelay
}
if maxRetryDelay == 0 {
maxRetryDelay = RangeQueryMaxRetryDelay
}
return rangeEnabled, retriesCount, minRetryDelay, maxRetryDelay
}
func (folder *Folder) GetSubFolder(subFolderRelativePath string) storage.Folder {
subFolder := NewFolder(folder.uploader, folder.S3API, folder.settings, *folder.Bucket,
storage.JoinPath(folder.Path, subFolderRelativePath)+"/", folder.useListObjectsV1)
return subFolder
}
func (folder *Folder) GetPath() string {
return folder.Path
}
func (folder *Folder) ListFolder() (objects []storage.Object, subFolders []storage.Folder, err error) {
listFunc := func(commonPrefixes []*s3.CommonPrefix, contents []*s3.Object) {
for _, prefix := range commonPrefixes {
subFolder := NewFolder(folder.uploader, folder.S3API, folder.settings, *folder.Bucket,
*prefix.Prefix, folder.useListObjectsV1)
subFolders = append(subFolders, subFolder)
}
for _, object := range contents {
// Some storages return root tar_partitions folder as a Key.
// We do not want to fail restoration due to this fact.
// Keep in mind that skipping files is very dangerous and any decision here must be weighted.
if *object.Key == folder.Path {
continue
}
objectRelativePath := strings.TrimPrefix(*object.Key, folder.Path)
objects = append(objects, storage.NewLocalObject(objectRelativePath, *object.LastModified, *object.Size))
}
}
prefix := aws.String(folder.Path)
delimiter := aws.String("/")
if folder.useListObjectsV1 {
err = folder.listObjectsPagesV1(prefix, delimiter, listFunc)
} else {
err = folder.listObjectsPagesV2(prefix, delimiter, listFunc)
}
if err != nil {
return nil, nil, errors.Wrapf(err, "failed to list s3 folder: '%s'", folder.Path)
}
return objects, subFolders, nil
}
func (folder *Folder) listObjectsPagesV1(prefix *string, delimiter *string,
listFunc func(commonPrefixes []*s3.CommonPrefix, contents []*s3.Object)) error {
s3Objects := &s3.ListObjectsInput{
Bucket: folder.Bucket,
Prefix: prefix,
Delimiter: delimiter,
}
return folder.S3API.ListObjectsPages(s3Objects, func(files *s3.ListObjectsOutput, lastPage bool) bool {
listFunc(files.CommonPrefixes, files.Contents)
return true
})
}
func (folder *Folder) listObjectsPagesV2(prefix *string, delimiter *string,
listFunc func(commonPrefixes []*s3.CommonPrefix, contents []*s3.Object)) error {
s3Objects := &s3.ListObjectsV2Input{
Bucket: folder.Bucket,
Prefix: prefix,
Delimiter: delimiter,
}
return folder.S3API.ListObjectsV2Pages(s3Objects, func(files *s3.ListObjectsV2Output, lastPage bool) bool {
listFunc(files.CommonPrefixes, files.Contents)
return true
})
}
func (folder *Folder) DeleteObjects(objectRelativePaths []string) error {
parts := partitionStrings(objectRelativePaths, 1000)
for _, part := range parts {
input := &s3.DeleteObjectsInput{Bucket: folder.Bucket, Delete: &s3.Delete{
Objects: folder.partitionToObjects(part),
}}
_, err := folder.S3API.DeleteObjects(input)
if err != nil {
return errors.Wrapf(err, "failed to delete s3 object: '%s'", part)
}
}
return nil
}
func (folder *Folder) partitionToObjects(keys []string) []*s3.ObjectIdentifier {
objects := make([]*s3.ObjectIdentifier, len(keys))
for id, key := range keys {
objects[id] = &s3.ObjectIdentifier{Key: aws.String(folder.Path + key)}
}
return objects
}
func isAwsNotExist(err error) bool {
if awsErr, ok := err.(awserr.Error); ok {
if awsErr.Code() == NotFoundAWSErrorCode || awsErr.Code() == NoSuchKeyAWSErrorCode {
return true
}
}
return false
}