-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
run.go
487 lines (428 loc) · 14.1 KB
/
run.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
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
package run
import (
gocontext "context"
"fmt"
"os"
"sort"
"sync"
"time"
"github.com/vercel/turbo/cli/internal/analytics"
"github.com/vercel/turbo/cli/internal/cache"
"github.com/vercel/turbo/cli/internal/cmdutil"
"github.com/vercel/turbo/cli/internal/context"
"github.com/vercel/turbo/cli/internal/core"
"github.com/vercel/turbo/cli/internal/daemon"
"github.com/vercel/turbo/cli/internal/daemonclient"
"github.com/vercel/turbo/cli/internal/env"
"github.com/vercel/turbo/cli/internal/fs"
"github.com/vercel/turbo/cli/internal/graph"
"github.com/vercel/turbo/cli/internal/process"
"github.com/vercel/turbo/cli/internal/runsummary"
"github.com/vercel/turbo/cli/internal/scm"
"github.com/vercel/turbo/cli/internal/scope"
"github.com/vercel/turbo/cli/internal/signals"
"github.com/vercel/turbo/cli/internal/taskhash"
"github.com/vercel/turbo/cli/internal/turbostate"
"github.com/vercel/turbo/cli/internal/ui"
"github.com/vercel/turbo/cli/internal/util"
"github.com/pkg/errors"
)
// ExecuteRun executes the run command
func ExecuteRun(ctx gocontext.Context, helper *cmdutil.Helper, signalWatcher *signals.Watcher, executionState *turbostate.ExecutionState) error {
base, err := helper.GetCmdBase(executionState)
LogTag(base.Logger)
if err != nil {
return err
}
tasks := executionState.CLIArgs.Command.Run.Tasks
passThroughArgs := executionState.CLIArgs.Command.Run.PassThroughArgs
if len(tasks) == 0 {
return errors.New("at least one task must be specified")
}
opts, err := optsFromArgs(&executionState.CLIArgs)
if err != nil {
return err
}
opts.runOpts.PassThroughArgs = passThroughArgs
run := configureRun(base, opts, signalWatcher)
if err := run.run(ctx, tasks); err != nil {
base.LogError("run failed: %v", err)
return err
}
return nil
}
func optsFromArgs(args *turbostate.ParsedArgsFromRust) (*Opts, error) {
runPayload := args.Command.Run
opts := getDefaultOptions()
// aliases := make(map[string]string)
if err := scope.OptsFromArgs(&opts.scopeOpts, args); err != nil {
return nil, err
}
opts.cacheOpts.SkipFilesystem = runPayload.RemoteOnly
opts.cacheOpts.OverrideDir = runPayload.CacheDir
opts.cacheOpts.Workers = runPayload.CacheWorkers
// Run flags
opts.runOpts.LogPrefix = runPayload.LogPrefix
opts.runOpts.Summarize = runPayload.Summarize
opts.runOpts.ExperimentalSpaceID = runPayload.ExperimentalSpaceID
opts.runOpts.EnvMode = runPayload.EnvMode
// Runcache flags
opts.runcacheOpts.SkipReads = runPayload.Force
opts.runcacheOpts.SkipWrites = runPayload.NoCache
if runPayload.OutputLogs != "" {
err := opts.runcacheOpts.SetTaskOutputMode(runPayload.OutputLogs)
if err != nil {
return nil, err
}
}
// Run flags
if runPayload.Concurrency != "" {
concurrency, err := util.ParseConcurrency(runPayload.Concurrency)
if err != nil {
return nil, err
}
opts.runOpts.Concurrency = concurrency
}
opts.runOpts.Parallel = runPayload.Parallel
opts.runOpts.Profile = runPayload.Profile
opts.runOpts.ContinueOnError = runPayload.ContinueExecution
opts.runOpts.Only = runPayload.Only
opts.runOpts.NoDaemon = runPayload.NoDaemon
opts.runOpts.SinglePackage = args.Command.Run.SinglePackage
// See comment on Graph in turbostate.go for an explanation on Graph's representation.
// If flag is passed...
if runPayload.Graph != nil {
// If no value is attached, we print to stdout
if *runPayload.Graph == "" {
opts.runOpts.GraphDot = true
} else {
// Otherwise, we emit to the file name attached as value
opts.runOpts.GraphDot = false
opts.runOpts.GraphFile = *runPayload.Graph
}
}
if runPayload.DryRun != "" {
opts.runOpts.DryRunJSON = runPayload.DryRun == _dryRunJSONValue
if runPayload.DryRun == _dryRunTextValue || runPayload.DryRun == _dryRunJSONValue {
opts.runOpts.DryRun = true
} else {
return nil, fmt.Errorf("invalid dry-run mode: %v", runPayload.DryRun)
}
}
return opts, nil
}
func configureRun(base *cmdutil.CmdBase, opts *Opts, signalWatcher *signals.Watcher) *run {
if os.Getenv("TURBO_REMOTE_ONLY") == "true" {
opts.cacheOpts.SkipFilesystem = true
}
processes := process.NewManager(base.Logger.Named("processes"))
signalWatcher.AddOnClose(processes.Close)
return &run{
base: base,
opts: opts,
processes: processes,
}
}
type run struct {
base *cmdutil.CmdBase
opts *Opts
processes *process.Manager
}
func (r *run) run(ctx gocontext.Context, targets []string) error {
startAt := time.Now()
packageJSONPath := r.base.RepoRoot.UntypedJoin("package.json")
rootPackageJSON, err := fs.ReadPackageJSON(packageJSONPath)
if err != nil {
return fmt.Errorf("failed to read package.json: %w", err)
}
isStructuredOutput := r.opts.runOpts.GraphDot || r.opts.runOpts.DryRunJSON
var pkgDepGraph *context.Context
if r.opts.runOpts.SinglePackage {
pkgDepGraph, err = context.SinglePackageGraph(r.base.RepoRoot, rootPackageJSON)
} else {
pkgDepGraph, err = context.BuildPackageGraph(r.base.RepoRoot, rootPackageJSON)
}
if err != nil {
var warnings *context.Warnings
if errors.As(err, &warnings) {
r.base.LogWarning("Issues occurred when constructing package graph. Turbo will function, but some features may not be available", err)
} else {
return err
}
}
if ui.IsCI && !r.opts.runOpts.NoDaemon {
r.base.Logger.Info("skipping turbod since we appear to be in a non-interactive context")
} else if !r.opts.runOpts.NoDaemon {
turbodClient, err := daemon.GetClient(ctx, r.base.RepoRoot, r.base.Logger, r.base.TurboVersion, daemon.ClientOpts{})
if err != nil {
r.base.LogWarning("", errors.Wrap(err, "failed to contact turbod. Continuing in standalone mode"))
} else {
defer func() { _ = turbodClient.Close() }()
r.base.Logger.Debug("running in daemon mode")
daemonClient := daemonclient.New(turbodClient)
r.opts.runcacheOpts.OutputWatcher = daemonClient
}
}
if err := util.ValidateGraph(&pkgDepGraph.WorkspaceGraph); err != nil {
return errors.Wrap(err, "Invalid package dependency graph")
}
// TODO: consolidate some of these arguments
// Note: not all properties are set here. GlobalHash and Pipeline keys are set later
g := &graph.CompleteGraph{
WorkspaceGraph: pkgDepGraph.WorkspaceGraph,
WorkspaceInfos: pkgDepGraph.WorkspaceInfos,
RootNode: pkgDepGraph.RootNode,
TaskDefinitions: map[string]*fs.TaskDefinition{},
RepoRoot: r.base.RepoRoot,
}
turboJSON, err := g.GetTurboConfigFromWorkspace(util.RootPkgName, r.opts.runOpts.SinglePackage)
if err != nil {
return err
}
// TODO: these values come from a config file, hopefully viper can help us merge these
r.opts.cacheOpts.RemoteCacheOpts = turboJSON.RemoteCacheOptions
// If a spaceID wasn't passed as a flag, read it from the turbo.json config.
// If that is not set either, we'll still end up with a blank string.
if r.opts.runOpts.ExperimentalSpaceID == "" {
r.opts.runOpts.ExperimentalSpaceID = turboJSON.SpaceID
}
pipeline := turboJSON.Pipeline
g.Pipeline = pipeline
scmInstance, err := scm.FromInRepo(r.base.RepoRoot)
if err != nil {
if errors.Is(err, scm.ErrFallback) {
r.base.Logger.Debug("", err)
} else {
return errors.Wrap(err, "failed to create SCM")
}
}
filteredPkgs, isAllPackages, err := scope.ResolvePackages(&r.opts.scopeOpts, r.base.RepoRoot, scmInstance, pkgDepGraph, r.base.UI, r.base.Logger)
if err != nil {
return errors.Wrap(err, "failed to resolve packages to run")
}
if isAllPackages {
// if there is a root task for any of our targets, we need to add it
for _, target := range targets {
key := util.RootTaskID(target)
if _, ok := pipeline[key]; ok {
filteredPkgs.Add(util.RootPkgName)
// we only need to know we're running a root task once to add it for consideration
break
}
}
}
globalHashInputs, err := getGlobalHashInputs(
r.base.RepoRoot,
rootPackageJSON,
pipeline,
turboJSON.GlobalEnv,
turboJSON.GlobalDeps,
pkgDepGraph.PackageManager,
pkgDepGraph.Lockfile,
turboJSON.GlobalPassthroughEnv,
r.opts.runOpts.EnvMode,
r.base.Logger,
r.base.UI,
isStructuredOutput,
)
if err != nil {
return fmt.Errorf("failed to collect global hash inputs: %v", err)
}
if globalHash, err := calculateGlobalHashFromHashableInputs(globalHashInputs); err == nil {
r.base.Logger.Debug("global hash", "value", globalHash)
g.GlobalHash = globalHash
} else {
return fmt.Errorf("failed to calculate global hash: %v", err)
}
r.base.Logger.Debug("local cache folder", "path", r.opts.cacheOpts.OverrideDir)
rs := &runSpec{
Targets: targets,
FilteredPkgs: filteredPkgs,
Opts: r.opts,
}
packageManager := pkgDepGraph.PackageManager
engine, err := buildTaskGraphEngine(
g,
rs,
r.opts.runOpts.SinglePackage,
)
if err != nil {
return errors.Wrap(err, "error preparing engine")
}
taskHashTracker := taskhash.NewTracker(
g.RootNode,
g.GlobalHash,
// TODO(mehulkar): remove g,Pipeline, because we need to get task definitions from CompleteGaph instead
g.Pipeline,
)
g.TaskHashTracker = taskHashTracker
// CalculateFileHashes assigns PackageInputsExpandedHashes as a side-effect
err = taskHashTracker.CalculateFileHashes(
engine.TaskGraph.Vertices(),
rs.Opts.runOpts.Concurrency,
g.WorkspaceInfos,
g.TaskDefinitions,
r.base.RepoRoot,
)
if err != nil {
return errors.Wrap(err, "error hashing package files")
}
// If we are running in parallel, then we remove all the edges in the graph
// except for the root. Rebuild the task graph for backwards compatibility.
// We still use dependencies specified by the pipeline configuration.
if rs.Opts.runOpts.Parallel {
for _, edge := range g.WorkspaceGraph.Edges() {
if edge.Target() != g.RootNode {
g.WorkspaceGraph.RemoveEdge(edge)
}
}
engine, err = buildTaskGraphEngine(
g,
rs,
r.opts.runOpts.SinglePackage,
)
if err != nil {
return errors.Wrap(err, "error preparing engine")
}
}
// Graph Run
if rs.Opts.runOpts.GraphFile != "" || rs.Opts.runOpts.GraphDot {
return GraphRun(ctx, rs, engine, r.base)
}
packagesInScope := rs.FilteredPkgs.UnsafeListOfStrings()
sort.Strings(packagesInScope)
// Initiate analytics and cache
analyticsClient := r.initAnalyticsClient(ctx)
defer analyticsClient.CloseWithTimeout(50 * time.Millisecond)
turboCache, err := r.initCache(ctx, rs, analyticsClient)
if err != nil {
if errors.Is(err, cache.ErrNoCachesEnabled) {
r.base.UI.Warn("No caches are enabled. You can try \"turbo login\", \"turbo link\", or ensuring you are not passing --remote-only to enable caching")
} else {
return errors.Wrap(err, "failed to set up caching")
}
}
var envVarPassthroughMap env.EnvironmentVariableMap
if globalHashInputs.envVarPassthroughs != nil {
if envVarPassthroughDetailedMap, err := env.GetHashableEnvVars(globalHashInputs.envVarPassthroughs, nil, ""); err == nil {
envVarPassthroughMap = envVarPassthroughDetailedMap.BySource.Explicit
}
}
globalEnvMode := rs.Opts.runOpts.EnvMode
if globalEnvMode == util.Infer && turboJSON.GlobalPassthroughEnv != nil {
globalEnvMode = util.Strict
}
// RunSummary contains information that is statically analyzable about
// the tasks that we expect to run based on the user command.
summary := runsummary.NewRunSummary(
startAt,
r.base.UI,
r.base.RepoRoot,
rs.Opts.scopeOpts.PackageInferenceRoot,
r.base.TurboVersion,
r.base.APIClient,
rs.Opts.runOpts,
packagesInScope,
globalEnvMode,
runsummary.NewGlobalHashSummary(
globalHashInputs.globalFileHashMap,
globalHashInputs.rootExternalDepsHash,
globalHashInputs.envVars,
envVarPassthroughMap,
globalHashInputs.globalCacheKey,
globalHashInputs.pipeline,
),
rs.Opts.SynthesizeCommand(rs.Targets),
)
// Dry Run
if rs.Opts.runOpts.DryRun {
return DryRun(
ctx,
g,
rs,
engine,
taskHashTracker,
turboCache,
turboJSON,
globalEnvMode,
r.base,
summary,
)
}
// Regular run
return RealRun(
ctx,
g,
rs,
engine,
taskHashTracker,
turboCache,
turboJSON,
globalEnvMode,
packagesInScope,
r.base,
summary,
// Extra arg only for regular runs, dry-run doesn't get this
packageManager,
r.processes,
)
}
func (r *run) initAnalyticsClient(ctx gocontext.Context) analytics.Client {
apiClient := r.base.APIClient
var analyticsSink analytics.Sink
if apiClient.IsLinked() {
analyticsSink = apiClient
} else {
r.opts.cacheOpts.SkipRemote = true
analyticsSink = analytics.NullSink
}
analyticsClient := analytics.NewClient(ctx, analyticsSink, r.base.Logger.Named("analytics"))
return analyticsClient
}
func (r *run) initCache(ctx gocontext.Context, rs *runSpec, analyticsClient analytics.Client) (cache.Cache, error) {
apiClient := r.base.APIClient
// Theoretically this is overkill, but bias towards not spamming the console
once := &sync.Once{}
return cache.New(rs.Opts.cacheOpts, r.base.RepoRoot, apiClient, analyticsClient, func(_cache cache.Cache, err error) {
// Currently the HTTP Cache is the only one that can be disabled.
// With a cache system refactor, we might consider giving names to the caches so
// we can accurately report them here.
once.Do(func() {
r.base.LogWarning("Remote Caching is unavailable", err)
})
})
}
func buildTaskGraphEngine(
g *graph.CompleteGraph,
rs *runSpec,
isSinglePackage bool,
) (*core.Engine, error) {
engine := core.NewEngine(g, isSinglePackage)
// Note: g.Pipeline is a map, but this for loop only cares about the keys
for taskName := range g.Pipeline {
engine.AddTask(taskName)
}
if err := engine.Prepare(&core.EngineBuildingOptions{
Packages: rs.FilteredPkgs.UnsafeListOfStrings(),
TaskNames: rs.Targets,
TasksOnly: rs.Opts.runOpts.Only,
}); err != nil {
return nil, err
}
// Check for cycles in the DAG.
if err := util.ValidateGraph(engine.TaskGraph); err != nil {
return nil, fmt.Errorf("Invalid task dependency graph:\n%v", err)
}
// Check that no tasks would be blocked by a persistent task
if err := engine.ValidatePersistentDependencies(g, rs.Opts.runOpts.Concurrency); err != nil {
return nil, fmt.Errorf("Invalid persistent task configuration:\n%v", err)
}
return engine, nil
}
// dry run custom flag
// NOTE: These *must* be kept in sync with the corresponding Rust
// enum definitions in shim/src/commands/mod.rs
const (
_dryRunJSONValue = "Json"
_dryRunTextValue = "Text"
)