-
Notifications
You must be signed in to change notification settings - Fork 0
/
s3iofs.go
284 lines (239 loc) · 6.46 KB
/
s3iofs.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
package s3iofs
import (
"bytes"
"errors"
"io/fs"
"net/url"
"os"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/s3"
"github.com/aws/aws-sdk-go-v2/service/s3/types"
"golang.org/x/net/context"
)
var (
_ fs.FS = (*S3FS)(nil)
_ fs.StatFS = (*S3FS)(nil)
_ fs.ReadDirFS = (*S3FS)(nil)
_ RemoveFS = (*S3FS)(nil)
_ WriteFileFS = (*S3FS)(nil)
)
// RemoveFS extend the fs.FS interface to add the Remove method.
type RemoveFS interface {
fs.FS
Remove(name string) error
}
// WriteFileFS extend the fs.FS interface to add the WriteFile method.
type WriteFileFS interface {
fs.FS
WriteFile(name string, data []byte, perm os.FileMode) error
}
// S3FS is a filesystem implementation using S3.
type S3FS struct {
bucket string
s3client S3API
}
// New returns a new filesystem which provides access to the specified s3 bucket.
func New(bucket string, awscfg aws.Config) *S3FS {
// Create an Amazon S3 service client
client := s3.NewFromConfig(awscfg)
return &S3FS{
s3client: client,
bucket: bucket,
}
}
// NewWithClient returns a new filesystem which provides access to the specified s3 bucket.
func NewWithClient(bucket string, client S3API) *S3FS {
return &S3FS{
s3client: client,
bucket: bucket,
}
}
// Open opens the named file.
func (s3fs *S3FS) Open(name string) (fs.File, error) {
if !fs.ValidPath(name) {
return nil, &os.PathError{Op: "open", Path: name, Err: os.ErrInvalid}
}
if name == "." {
return &s3File{
s3client: s3fs.s3client,
name: name,
bucket: s3fs.bucket,
mode: fs.ModeDir,
}, nil
}
req := &s3.GetObjectInput{
Bucket: aws.String(s3fs.bucket),
Key: aws.String(name),
}
// optimistic GetObject, with the body setup as the default stream used for reading
// the goal here is to avoid subsequent get object calls triggered by small reads as observed
// when testing with files larger than 3-5 kilobytes
res, err := s3fs.s3client.GetObject(context.TODO(), req)
if err != nil {
var nfe *types.NotFound
if errors.As(err, &nfe) {
// fall back directory list
return s3fs.openDirectory(name)
}
return nil, err
}
return &s3File{
s3client: s3fs.s3client,
name: name,
bucket: s3fs.bucket,
size: aws.ToInt64(res.ContentLength),
modTime: aws.ToTime(res.LastModified),
body: res.Body,
}, nil
}
// Stat returns a FileInfo describing the file.
func (s3fs *S3FS) Stat(name string) (fs.FileInfo, error) {
f, err := s3fs.stat(name)
if err != nil {
return nil, &fs.PathError{
Op: "stat",
Path: name,
Err: err,
}
}
return f, nil
}
// ReadDir reads the named directory.
func (s3fs *S3FS) ReadDir(name string) ([]fs.DirEntry, error) {
f, err := s3fs.stat(name)
if err != nil {
return nil, err
}
if !f.IsDir() {
return nil, &fs.PathError{Op: opRead, Path: name, Err: fs.ErrNotExist}
}
prefix, err := url.JoinPath(name, "/")
if err != nil {
return nil, err
}
if name == "." {
prefix = ""
}
listRes, err := s3fs.s3client.ListObjectsV2(context.TODO(), &s3.ListObjectsV2Input{
Bucket: aws.String(s3fs.bucket),
Prefix: aws.String(prefix),
Delimiter: aws.String("/"),
})
if err != nil {
return nil, err
}
return listResToEntries(s3fs.bucket, s3fs.s3client, listRes)
}
// Remove removes the named file or directory.
//
// Note if the file doesn't exist in the s3 bucket, Remove returns nil.
func (s3fs *S3FS) Remove(name string) error {
if name == "." {
return &fs.PathError{Op: "remove", Path: name, Err: fs.ErrInvalid}
}
if name == "" {
return &fs.PathError{Op: "remove", Path: name, Err: fs.ErrInvalid}
}
_, err := s3fs.s3client.DeleteObject(context.TODO(), &s3.DeleteObjectInput{
Bucket: aws.String(s3fs.bucket),
Key: aws.String(name),
})
if err != nil {
return &fs.PathError{Op: "remove", Path: name, Err: err}
}
return nil
}
// WriteFile writes the data to the named file in s3.
//
// Note:
// - If the file exists, WriteFile overwrites it.
// - The provided mode is unused by this implementation.
func (s3fs *S3FS) WriteFile(name string, data []byte, perm os.FileMode) error {
if name == "." {
return &fs.PathError{Op: "write", Path: name, Err: fs.ErrInvalid}
}
if name == "" {
return &fs.PathError{Op: "write", Path: name, Err: fs.ErrInvalid}
}
_, err := s3fs.s3client.PutObject(context.TODO(), &s3.PutObjectInput{
Bucket: aws.String(s3fs.bucket),
Key: aws.String(name),
Body: bytes.NewReader(data),
})
if err != nil {
return &fs.PathError{Op: "write", Path: name, Err: err}
}
return nil
}
func (s3fs *S3FS) stat(name string) (fs.FileInfo, error) {
if name == "." {
return &s3File{
name: name,
bucket: s3fs.bucket,
mode: fs.ModeDir,
}, nil
}
list, err := s3fs.s3client.ListObjectsV2(context.TODO(), &s3.ListObjectsV2Input{
Bucket: aws.String(s3fs.bucket),
Prefix: aws.String(name),
Delimiter: aws.String("/"),
MaxKeys: aws.Int32(1),
})
if err != nil {
return nil, &fs.PathError{Op: "open", Path: name, Err: fs.ErrNotExist}
}
if len(list.CommonPrefixes) > 0 &&
aws.ToString(list.CommonPrefixes[0].Prefix) == name+"/" {
return &s3File{
name: name,
bucket: s3fs.bucket,
mode: fs.ModeDir,
}, nil
}
if len(list.Contents) > 0 &&
aws.ToString(list.Contents[0].Key) == name {
return &s3File{
name: name,
bucket: s3fs.bucket,
size: aws.ToInt64(list.Contents[0].Size),
modTime: aws.ToTime(list.Contents[0].LastModified),
}, nil
}
return nil, &fs.PathError{Op: "open", Path: name, Err: fs.ErrNotExist}
}
func (s3fs *S3FS) openDirectory(name string) (fs.File, error) {
f, err := s3fs.stat(name)
if err != nil {
return nil, err
}
if f.IsDir() {
return f.(fs.File), nil
}
return nil, &fs.PathError{Op: "open", Path: name, Err: fs.ErrNotExist}
}
func listResToEntries(bucket string, s3client S3API, listRes *s3.ListObjectsV2Output) ([]fs.DirEntry, error) {
entries := []fs.DirEntry{}
// common prefixes are directories
for _, commonPrefix := range listRes.CommonPrefixes {
prefix := aws.ToString(commonPrefix.Prefix)
// dir := path.Base(prefix)
entries = append(entries, &s3File{
s3client: s3client,
name: prefix,
bucket: bucket,
mode: fs.ModeDir,
})
}
// contents are files
for _, obj := range listRes.Contents {
// _, file := path.Split(aws.ToString(obj.Key))
entries = append(entries, &s3File{
s3client: s3client,
name: aws.ToString(obj.Key),
bucket: bucket,
size: aws.ToInt64(obj.Size),
modTime: aws.ToTime(obj.LastModified),
})
}
return entries, nil
}