forked from dagger/dagger
/
filesync.go
431 lines (388 loc) · 12.7 KB
/
filesync.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
package buildkit
import (
"bytes"
"context"
"errors"
"fmt"
"io"
"os"
"path"
"path/filepath"
"strings"
"github.com/containerd/continuity/fs"
"github.com/dagger/dagger/engine"
bkclient "github.com/moby/buildkit/client"
"github.com/moby/buildkit/client/llb"
bkgw "github.com/moby/buildkit/frontend/gateway/client"
"github.com/moby/buildkit/session/filesync"
"github.com/moby/buildkit/snapshot"
bksolverpb "github.com/moby/buildkit/solver/pb"
"github.com/moby/buildkit/util/bklog"
specs "github.com/opencontainers/image-spec/specs-go/v1"
fsutiltypes "github.com/tonistiigi/fsutil/types"
"github.com/vito/progrock"
)
func (c *Client) LocalImport(
ctx context.Context,
recorder *progrock.Recorder,
platform specs.Platform,
srcPath string,
excludePatterns []string,
includePatterns []string,
) (*bksolverpb.Definition, specs.Descriptor, error) {
var desc specs.Descriptor
srcPath = path.Clean(srcPath)
if srcPath == ".." || strings.HasPrefix(srcPath, "../") {
return nil, desc, fmt.Errorf("path %q escapes workdir; use an absolute path instead", srcPath)
}
clientMetadata, err := engine.ClientMetadataFromContext(ctx)
if err != nil {
return nil, desc, err
}
localOpts := []llb.LocalOption{
llb.SessionID(clientMetadata.ClientID),
llb.SharedKeyHint(strings.Join([]string{clientMetadata.ClientHostname, srcPath}, " ")),
}
localName := fmt.Sprintf("upload %s from %s (client id: %s)", srcPath, clientMetadata.ClientHostname, clientMetadata.ClientID)
if len(excludePatterns) > 0 {
localName += fmt.Sprintf(" (exclude: %s)", strings.Join(excludePatterns, ", "))
localOpts = append(localOpts, llb.ExcludePatterns(excludePatterns))
}
if len(includePatterns) > 0 {
localName += fmt.Sprintf(" (include: %s)", strings.Join(includePatterns, ", "))
localOpts = append(localOpts, llb.IncludePatterns(includePatterns))
}
localOpts = append(localOpts, llb.WithCustomName(localName))
localLLB := llb.Local(srcPath, localOpts...)
// We still need to do a copy here for now because buildkit's cache calls
// Finalize on refs when getting their blobs which makes the cache ref for the
// local ref unable to be reused.
//
// TODO: we should ensure that this doesn't create a new cache entry, without
// this the entire local directory is uploaded to the cache. See also
// blobSource.CacheKey for more context
copyLLB := llb.Scratch().File(
llb.Copy(localLLB, "/", "/"),
llb.WithCustomNamef("%scopy %s", InternalPrefix, localName),
)
copyDef, err := copyLLB.Marshal(ctx, llb.Platform(platform))
if err != nil {
return nil, desc, err
}
copyPB := copyDef.ToPB()
RecordVertexes(recorder, copyPB)
return c.DefToBlob(ctx, copyPB)
}
// Import a directory from the engine container, as opposed to from a client
func (c *Client) EngineContainerLocalImport(
ctx context.Context,
recorder *progrock.Recorder,
platform specs.Platform,
srcPath string,
excludePatterns []string,
includePatterns []string,
) (*bksolverpb.Definition, specs.Descriptor, error) {
hostname, err := os.Hostname()
if err != nil {
return nil, specs.Descriptor{}, fmt.Errorf("failed to get hostname for engine local import: %s", err)
}
ctx = engine.ContextWithClientMetadata(ctx, &engine.ClientMetadata{
ClientID: c.ID(),
ClientHostname: hostname,
})
return c.LocalImport(ctx, recorder, platform, srcPath, excludePatterns, includePatterns)
}
func (c *Client) ReadCallerHostFile(ctx context.Context, path string) ([]byte, error) {
ctx, cancel, err := c.withClientCloseCancel(ctx)
if err != nil {
return nil, err
}
defer cancel()
clientMetadata, err := engine.ClientMetadataFromContext(ctx)
if err != nil {
return nil, fmt.Errorf("failed to get requester session ID: %s", err)
}
ctx = engine.LocalImportOpts{
Path: path,
ReadSingleFileOnly: true,
MaxFileSize: MaxFileContentsChunkSize,
}.AppendToOutgoingContext(ctx)
clientCaller, err := c.SessionManager.Get(ctx, clientMetadata.ClientID, false)
if err != nil {
return nil, fmt.Errorf("failed to get requester session: %s", err)
}
diffCopyClient, err := filesync.NewFileSyncClient(clientCaller.Conn()).DiffCopy(ctx)
if err != nil {
return nil, fmt.Errorf("failed to create diff copy client: %s", err)
}
defer diffCopyClient.CloseSend()
msg := filesync.BytesMessage{}
err = diffCopyClient.RecvMsg(&msg)
if err != nil {
return nil, fmt.Errorf("failed to receive file bytes message: %s", err)
}
return msg.Data, nil
}
func (c *Client) StatCallerHostPath(ctx context.Context, path string, returnAbsPath bool) (*fsutiltypes.Stat, error) {
ctx, cancel, err := c.withClientCloseCancel(ctx)
if err != nil {
return nil, err
}
defer cancel()
clientMetadata, err := engine.ClientMetadataFromContext(ctx)
if err != nil {
return nil, fmt.Errorf("failed to get requester session ID: %s", err)
}
ctx = engine.LocalImportOpts{
Path: path,
StatPathOnly: true,
StatReturnAbsPath: returnAbsPath,
}.AppendToOutgoingContext(ctx)
clientCaller, err := c.SessionManager.Get(ctx, clientMetadata.ClientID, false)
if err != nil {
return nil, fmt.Errorf("failed to get requester session: %s", err)
}
diffCopyClient, err := filesync.NewFileSyncClient(clientCaller.Conn()).DiffCopy(ctx)
if err != nil {
return nil, fmt.Errorf("failed to create diff copy client: %s", err)
}
defer diffCopyClient.CloseSend()
msg := fsutiltypes.Stat{}
err = diffCopyClient.RecvMsg(&msg)
if err != nil {
return nil, fmt.Errorf("failed to receive file bytes message: %s", err)
}
return &msg, nil
}
func (c *Client) LocalDirExport(
ctx context.Context,
def *bksolverpb.Definition,
destPath string,
merge bool,
) (rerr error) {
ctx = bklog.WithLogger(ctx, bklog.G(ctx).WithField("export_path", destPath))
bklog.G(ctx).Debug("exporting local dir")
defer func() {
lg := bklog.G(ctx)
if rerr != nil {
lg = lg.WithError(rerr)
}
lg.Debug("finished exporting local dir")
}()
ctx, cancel, err := c.withClientCloseCancel(ctx)
if err != nil {
return err
}
defer cancel()
destPath = path.Clean(destPath)
if destPath == ".." || strings.HasPrefix(destPath, "../") {
return fmt.Errorf("path %q escapes workdir; use an absolute path instead", destPath)
}
res, err := c.Solve(ctx, bkgw.SolveRequest{Definition: def})
if err != nil {
return fmt.Errorf("failed to solve for local export: %s", err)
}
cacheRes, err := ConvertToWorkerCacheResult(ctx, res)
if err != nil {
return fmt.Errorf("failed to convert result: %s", err)
}
exporter, err := c.Worker.Exporter(bkclient.ExporterLocal, c.SessionManager)
if err != nil {
return err
}
expInstance, err := exporter.Resolve(ctx, 0, nil)
if err != nil {
return fmt.Errorf("failed to resolve exporter: %s", err)
}
clientMetadata, err := engine.ClientMetadataFromContext(ctx)
if err != nil {
return fmt.Errorf("failed to get requester session ID: %s", err)
}
ctx = engine.LocalExportOpts{
Path: destPath,
Merge: merge,
}.AppendToOutgoingContext(ctx)
_, descRef, err := expInstance.Export(ctx, cacheRes, nil, clientMetadata.ClientID)
if err != nil {
return fmt.Errorf("failed to export: %s", err)
}
if descRef != nil {
descRef.Release()
}
return nil
}
func (c *Client) LocalFileExport(
ctx context.Context,
def *bksolverpb.Definition,
destPath string,
filePath string,
allowParentDirPath bool,
) (rerr error) {
ctx = bklog.WithLogger(ctx, bklog.G(ctx).
WithField("export_path", destPath).
WithField("file_path", filePath).
WithField("allow_parent_dir_path", allowParentDirPath),
)
bklog.G(ctx).Debug("exporting local file")
defer func() {
lg := bklog.G(ctx)
if rerr != nil {
lg = lg.WithError(rerr)
}
lg.Debug("finished exporting local file")
}()
ctx, cancel, err := c.withClientCloseCancel(ctx)
if err != nil {
return err
}
defer cancel()
destPath = path.Clean(destPath)
if destPath == ".." || strings.HasPrefix(destPath, "../") {
return fmt.Errorf("path %q escapes workdir; use an absolute path instead", destPath)
}
res, err := c.Solve(ctx, bkgw.SolveRequest{Definition: def, Evaluate: true})
if err != nil {
return fmt.Errorf("failed to solve for local export: %s", err)
}
ref, err := res.SingleRef()
if err != nil {
return fmt.Errorf("failed to get single ref: %s", err)
}
mountable, err := ref.getMountable(ctx)
if err != nil {
return fmt.Errorf("failed to get mountable: %s", err)
}
mounter := snapshot.LocalMounter(mountable)
mountPath, err := mounter.Mount()
if err != nil {
return fmt.Errorf("failed to mount: %s", err)
}
defer mounter.Unmount()
mntFilePath, err := fs.RootPath(mountPath, filePath)
if err != nil {
return fmt.Errorf("failed to get root path: %s", err)
}
file, err := os.Open(mntFilePath)
if err != nil {
return fmt.Errorf("failed to open file: %s", err)
}
defer file.Close()
stat, err := file.Stat()
if err != nil {
return fmt.Errorf("failed to stat file: %s", err)
}
clientMetadata, err := engine.ClientMetadataFromContext(ctx)
if err != nil {
return fmt.Errorf("failed to get requester session ID: %s", err)
}
ctx = engine.LocalExportOpts{
Path: destPath,
IsFileStream: true,
FileOriginalName: filepath.Base(filePath),
AllowParentDirPath: allowParentDirPath,
FileMode: stat.Mode().Perm(),
}.AppendToOutgoingContext(ctx)
clientCaller, err := c.SessionManager.Get(ctx, clientMetadata.ClientID, false)
if err != nil {
return fmt.Errorf("failed to get requester session: %s", err)
}
diffCopyClient, err := filesync.NewFileSendClient(clientCaller.Conn()).DiffCopy(ctx)
if err != nil {
return fmt.Errorf("failed to create diff copy client: %s", err)
}
defer diffCopyClient.CloseSend()
fileSizeLeft := stat.Size()
chunkSize := int64(MaxFileContentsChunkSize)
for fileSizeLeft > 0 {
buf := new(bytes.Buffer) // TODO: more efficient to use bufio.Writer, reuse buffers, sync.Pool, etc.
n, err := io.CopyN(buf, file, chunkSize)
if errors.Is(err, io.EOF) {
err = nil
}
if err != nil {
return fmt.Errorf("failed to read file: %s", err)
}
fileSizeLeft -= n
err = diffCopyClient.SendMsg(&filesync.BytesMessage{Data: buf.Bytes()})
if errors.Is(err, io.EOF) {
err := diffCopyClient.RecvMsg(struct{}{})
if err != nil {
return fmt.Errorf("diff copy client error: %s", err)
}
} else if err != nil {
return fmt.Errorf("failed to send file chunk: %s", err)
}
}
if err := diffCopyClient.CloseSend(); err != nil {
return fmt.Errorf("failed to close send: %s", err)
}
// wait for receiver to finish
var msg filesync.BytesMessage
if err := diffCopyClient.RecvMsg(&msg); err != io.EOF {
return fmt.Errorf("unexpected closing recv msg: %s", err)
}
return nil
}
// IOReaderExport exports the contents of an io.Reader to the caller's local fs as a file
// TODO: de-dupe this with the above method to extent possible
func (c *Client) IOReaderExport(ctx context.Context, r io.Reader, destPath string, destMode os.FileMode) (rerr error) {
ctx = bklog.WithLogger(ctx, bklog.G(ctx).WithField("export_path", destPath))
bklog.G(ctx).Debug("exporting bytes")
defer func() {
lg := bklog.G(ctx)
if rerr != nil {
lg = lg.WithError(rerr)
}
lg.Debug("finished exporting bytes")
}()
clientMetadata, err := engine.ClientMetadataFromContext(ctx)
if err != nil {
return fmt.Errorf("failed to get requester session ID: %s", err)
}
ctx = engine.LocalExportOpts{
Path: destPath,
IsFileStream: true,
FileOriginalName: filepath.Base(destPath),
FileMode: destMode,
}.AppendToOutgoingContext(ctx)
clientCaller, err := c.SessionManager.Get(ctx, clientMetadata.ClientID, false)
if err != nil {
return fmt.Errorf("failed to get requester session: %s", err)
}
diffCopyClient, err := filesync.NewFileSendClient(clientCaller.Conn()).DiffCopy(ctx)
if err != nil {
return fmt.Errorf("failed to create diff copy client: %s", err)
}
defer diffCopyClient.CloseSend()
chunkSize := int64(MaxFileContentsChunkSize)
keepGoing := true
for keepGoing {
buf := new(bytes.Buffer) // TODO: more efficient to use bufio.Writer, reuse buffers, sync.Pool, etc.
_, err := io.CopyN(buf, r, chunkSize)
if errors.Is(err, io.EOF) {
keepGoing = false
err = nil
}
if err != nil {
return fmt.Errorf("failed to read file: %s", err)
}
err = diffCopyClient.SendMsg(&filesync.BytesMessage{Data: buf.Bytes()})
if errors.Is(err, io.EOF) {
err := diffCopyClient.RecvMsg(struct{}{})
if err != nil {
return fmt.Errorf("diff copy client error: %s", err)
}
} else if err != nil {
return fmt.Errorf("failed to send file chunk: %s", err)
}
}
if err := diffCopyClient.CloseSend(); err != nil {
return fmt.Errorf("failed to close send: %s", err)
}
// wait for receiver to finish
var msg filesync.BytesMessage
if err := diffCopyClient.RecvMsg(&msg); err != io.EOF {
return fmt.Errorf("unexpected closing recv msg: %s", err)
}
return nil
}