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
|
package runsummary
import (
"os"
"github.com/vercel/turbo/cli/internal/cache"
"github.com/vercel/turbo/cli/internal/fs"
"github.com/vercel/turbo/cli/internal/turbopath"
"github.com/vercel/turbo/cli/internal/util"
)
// TaskCacheSummary is an extended version of cache.ItemStatus
// that includes TimeSaved and some better data.
type TaskCacheSummary struct {
Local bool `json:"local"` // Deprecated, but keeping around for --dry=json
Remote bool `json:"remote"` // Deprecated, but keeping around for --dry=json
Status string `json:"status"` // should always be there
Source string `json:"source,omitempty"` // can be empty on status:miss
TimeSaved int `json:"timeSaved"` // always include, but can be 0
}
// NewTaskCacheSummary decorates a cache.ItemStatus into a TaskCacheSummary
// Importantly, it adds the derived keys of `source` and `status` based on
// the local/remote booleans. It would be nice if these were just included
// from upstream, but that is a more invasive change.
func NewTaskCacheSummary(itemStatus cache.ItemStatus, timeSaved *int) TaskCacheSummary {
status := cache.CacheEventMiss
if itemStatus.Local || itemStatus.Remote {
status = cache.CacheEventHit
}
var source string
if itemStatus.Local {
source = cache.CacheSourceFS
} else if itemStatus.Remote {
source = cache.CacheSourceRemote
}
cs := TaskCacheSummary{
// copy these over
Local: itemStatus.Local,
Remote: itemStatus.Remote,
Status: status,
Source: source,
}
// add in a dereferences timeSaved, should be 0 if nil
if timeSaved != nil {
cs.TimeSaved = *timeSaved
}
return cs
}
// TaskSummary contains information about the task that was about to run
// TODO(mehulkar): `Outputs` and `ExcludedOutputs` are slightly redundant
// as the information is also available in ResolvedTaskDefinition. We could remove them
// and favor a version of Outputs that is the fully expanded list of files.
type TaskSummary struct {
TaskID string `json:"taskId,omitempty"`
Task string `json:"task"`
Package string `json:"package,omitempty"`
Hash string `json:"hash"`
ExpandedInputs map[turbopath.AnchoredUnixPath]string `json:"inputs"`
ExternalDepsHash string `json:"hashOfExternalDependencies"`
CacheSummary TaskCacheSummary `json:"cache"`
Command string `json:"command"`
CommandArguments []string `json:"cliArguments"`
Outputs []string `json:"outputs"`
ExcludedOutputs []string `json:"excludedOutputs"`
LogFile string `json:"logFile"`
Dir string `json:"directory,omitempty"`
Dependencies []string `json:"dependencies"`
Dependents []string `json:"dependents"`
ResolvedTaskDefinition *fs.TaskDefinition `json:"resolvedTaskDefinition"`
ExpandedOutputs []turbopath.AnchoredSystemPath `json:"expandedOutputs"`
Framework string `json:"framework"`
EnvMode util.EnvMode `json:"envMode"`
EnvVars TaskEnvVarSummary `json:"environmentVariables"`
Execution *TaskExecutionSummary `json:"execution,omitempty"` // omit when it's not set
}
// GetLogs reads the Logfile and returns the data
func (ts *TaskSummary) GetLogs() []byte {
bytes, err := os.ReadFile(ts.LogFile)
if err != nil {
return []byte{}
}
return bytes
}
// TaskEnvVarSummary contains the environment variables that impacted a task's hash
type TaskEnvVarSummary struct {
Configured []string `json:"configured"`
Inferred []string `json:"inferred"`
Global []string `json:"global"`
Passthrough []string `json:"passthrough"`
GlobalPassthrough []string `json:"globalPassthrough"`
}
// cleanForSinglePackage converts a TaskSummary to remove references to workspaces
func (ts *TaskSummary) cleanForSinglePackage() {
dependencies := make([]string, len(ts.Dependencies))
for i, dependency := range ts.Dependencies {
dependencies[i] = util.StripPackageName(dependency)
}
dependents := make([]string, len(ts.Dependents))
for i, dependent := range ts.Dependents {
dependents[i] = util.StripPackageName(dependent)
}
task := util.StripPackageName(ts.TaskID)
ts.TaskID = task
ts.Task = task
ts.Dependencies = dependencies
ts.Dependents = dependents
ts.Dir = ""
ts.Package = ""
}
|