/
devs.go
414 lines (389 loc) · 12.1 KB
/
devs.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
package leaves
import (
"fmt"
"io"
"sort"
"unicode/utf8"
"github.com/gogo/protobuf/proto"
"github.com/sergi/go-diff/diffmatchpatch"
"gopkg.in/src-d/go-git.v4"
"gopkg.in/src-d/go-git.v4/plumbing"
"gopkg.in/src-d/go-git.v4/plumbing/object"
"gopkg.in/src-d/go-git.v4/utils/merkletrie"
"gopkg.in/src-d/hercules.v5/internal/core"
"gopkg.in/src-d/hercules.v5/internal/pb"
items "gopkg.in/src-d/hercules.v5/internal/plumbing"
"gopkg.in/src-d/hercules.v5/internal/plumbing/identity"
"gopkg.in/src-d/hercules.v5/internal/yaml"
)
// DevsAnalysis calculates the number of commits through time per developer.
// It also records the numbers of added, deleted and changed lines through time per developer.
type DevsAnalysis struct {
core.NoopMerger
core.OneShotMergeProcessor
// ConsiderEmptyCommits indicates whether empty commits (e.g., merges) should be taken
// into account.
ConsiderEmptyCommits bool
// days maps days to developers to stats
days map[int]map[int]*DevDay
// reversedPeopleDict references IdentityDetector.ReversedPeopleDict
reversedPeopleDict []string
}
// DevsResult is returned by DevsAnalysis.Finalize() and carries the daily statistics
// per developer.
type DevsResult struct {
// Days is <day index> -> <developer index> -> daily stats
Days map[int]map[int]*DevDay
// reversedPeopleDict references IdentityDetector.ReversedPeopleDict
reversedPeopleDict []string
}
// DevDay is the statistics for a development day and a particular developer.
type DevDay struct {
// Commits is the number of commits made by a particular developer in a particular day.
Commits int
// Added is the number of added lines by a particular developer in a particular day.
Added int
// Removed is the number of removed lines by a particular developer in a particular day.
Removed int
// Changed is the number of changed lines by a particular developer in a particular day.
Changed int
}
const (
// ConfigDevsConsiderEmptyCommits is the name of the option to set DevsAnalysis.ConsiderEmptyCommits.
ConfigDevsConsiderEmptyCommits = "Devs.ConsiderEmptyCommits"
)
// Name of this PipelineItem. Uniquely identifies the type, used for mapping keys, etc.
func (devs *DevsAnalysis) Name() string {
return "Devs"
}
// Provides returns the list of names of entities which are produced by this PipelineItem.
// Each produced entity will be inserted into `deps` of dependent Consume()-s according
// to this list. Also used by core.Registry to build the global map of providers.
func (devs *DevsAnalysis) Provides() []string {
return []string{}
}
// Requires returns the list of names of entities which are needed by this PipelineItem.
// Each requested entity will be inserted into `deps` of Consume(). In turn, those
// entities are Provides() upstream.
func (devs *DevsAnalysis) Requires() []string {
arr := [...]string{
identity.DependencyAuthor, items.DependencyTreeChanges, items.DependencyFileDiff,
items.DependencyBlobCache, items.DependencyDay}
return arr[:]
}
// ListConfigurationOptions returns the list of changeable public properties of this PipelineItem.
func (devs *DevsAnalysis) ListConfigurationOptions() []core.ConfigurationOption {
options := [...]core.ConfigurationOption{{
Name: ConfigDevsConsiderEmptyCommits,
Description: "Take into account empty commits such as trivial merges.",
Flag: "--empty-commits",
Type: core.BoolConfigurationOption,
Default: false}}
return options[:]
}
// Configure sets the properties previously published by ListConfigurationOptions().
func (devs *DevsAnalysis) Configure(facts map[string]interface{}) {
if val, exists := facts[ConfigDevsConsiderEmptyCommits].(bool); exists {
devs.ConsiderEmptyCommits = val
}
if val, exists := facts[identity.FactIdentityDetectorReversedPeopleDict].([]string); exists {
devs.reversedPeopleDict = val
}
}
// Flag for the command line switch which enables this analysis.
func (devs *DevsAnalysis) Flag() string {
return "devs"
}
// Description returns the text which explains what the analysis is doing.
func (devs *DevsAnalysis) Description() string {
return "Calculates the number of commits, added, removed and changed lines per developer through time."
}
// Initialize resets the temporary caches and prepares this PipelineItem for a series of Consume()
// calls. The repository which is going to be analysed is supplied as an argument.
func (devs *DevsAnalysis) Initialize(repository *git.Repository) {
devs.days = map[int]map[int]*DevDay{}
devs.OneShotMergeProcessor.Initialize()
}
// Consume runs this PipelineItem on the next commit data.
// `deps` contain all the results from upstream PipelineItem-s as requested by Requires().
// Additionally, DependencyCommit is always present there and represents the analysed *object.Commit.
// This function returns the mapping with analysis results. The keys must be the same as
// in Provides(). If there was an error, nil is returned.
func (devs *DevsAnalysis) Consume(deps map[string]interface{}) (map[string]interface{}, error) {
if !devs.ShouldConsumeCommit(deps) {
return nil, nil
}
author := deps[identity.DependencyAuthor].(int)
treeDiff := deps[items.DependencyTreeChanges].(object.Changes)
if len(treeDiff) == 0 && !devs.ConsiderEmptyCommits {
return nil, nil
}
day := deps[items.DependencyDay].(int)
devsDay, exists := devs.days[day]
if !exists {
devsDay = map[int]*DevDay{}
devs.days[day] = devsDay
}
dd, exists := devsDay[author]
if !exists {
dd = &DevDay{}
devsDay[author] = dd
}
dd.Commits++
cache := deps[items.DependencyBlobCache].(map[plumbing.Hash]*items.CachedBlob)
fileDiffs := deps[items.DependencyFileDiff].(map[string]items.FileDiffData)
for _, change := range treeDiff {
action, err := change.Action()
if err != nil {
return nil, err
}
switch action {
case merkletrie.Insert:
blob := cache[change.To.TreeEntry.Hash]
lines, err := blob.CountLines()
if err != nil {
// binary
continue
}
dd.Added += lines
case merkletrie.Delete:
blob := cache[change.From.TreeEntry.Hash]
lines, err := blob.CountLines()
if err != nil {
// binary
continue
}
dd.Removed += lines
case merkletrie.Modify:
thisDiffs := fileDiffs[change.To.Name]
var removedPending int
for _, edit := range thisDiffs.Diffs {
switch edit.Type {
case diffmatchpatch.DiffEqual:
if removedPending > 0 {
dd.Removed += removedPending
}
removedPending = 0
case diffmatchpatch.DiffInsert:
added := utf8.RuneCountInString(edit.Text)
if removedPending > added {
dd.Changed += added
dd.Removed += removedPending - added
} else {
dd.Changed += removedPending
dd.Added += added - removedPending
}
removedPending = 0
case diffmatchpatch.DiffDelete:
removedPending = utf8.RuneCountInString(edit.Text)
}
}
if removedPending > 0 {
dd.Removed += removedPending
}
}
}
return nil, nil
}
// Finalize returns the result of the analysis. Further Consume() calls are not expected.
func (devs *DevsAnalysis) Finalize() interface{} {
return DevsResult{
Days: devs.days,
reversedPeopleDict: devs.reversedPeopleDict,
}
}
// Fork clones this pipeline item.
func (devs *DevsAnalysis) Fork(n int) []core.PipelineItem {
return core.ForkSamePipelineItem(devs, n)
}
// Serialize converts the analysis result as returned by Finalize() to text or bytes.
// The text format is YAML and the bytes format is Protocol Buffers.
func (devs *DevsAnalysis) Serialize(result interface{}, binary bool, writer io.Writer) error {
devsResult := result.(DevsResult)
if binary {
return devs.serializeBinary(&devsResult, writer)
}
devs.serializeText(&devsResult, writer)
return nil
}
// Deserialize converts the specified protobuf bytes to DevsResult.
func (devs *DevsAnalysis) Deserialize(pbmessage []byte) (interface{}, error) {
message := pb.DevsAnalysisResults{}
err := proto.Unmarshal(pbmessage, &message)
if err != nil {
return nil, err
}
days := map[int]map[int]*DevDay{}
for day, dd := range message.Days {
rdd := map[int]*DevDay{}
days[int(day)] = rdd
for dev, stats := range dd.Devs {
if dev == -1 {
dev = identity.AuthorMissing
}
rdd[int(dev)] = &DevDay{
Commits: int(stats.Commits),
Added: int(stats.Added),
Removed: int(stats.Removed),
Changed: int(stats.Changed),
}
}
}
result := DevsResult{
Days: days,
reversedPeopleDict: message.DevIndex,
}
return result, nil
}
// MergeResults combines two DevsAnalysis-es together.
func (devs *DevsAnalysis) MergeResults(r1, r2 interface{}, c1, c2 *core.CommonAnalysisResult) interface{} {
cr1 := r1.(DevsResult)
cr2 := r2.(DevsResult)
merged := DevsResult{}
type devIndexPair struct {
Index1 int
Index2 int
}
devIndex := map[string]devIndexPair{}
for dev, devName := range cr1.reversedPeopleDict {
devIndex[devName] = devIndexPair{Index1: dev+1, Index2: devIndex[devName].Index2}
}
for dev, devName := range cr2.reversedPeopleDict {
devIndex[devName] = devIndexPair{Index1: devIndex[devName].Index1, Index2: dev+1}
}
jointDevSeq := make([]string, len(devIndex))
{
i := 0
for dev := range devIndex {
jointDevSeq[i] = dev
i++
}
}
sort.Strings(jointDevSeq)
merged.reversedPeopleDict = jointDevSeq
invDevIndex1 := map[int]int{}
invDevIndex2 := map[int]int{}
for i, dev := range jointDevSeq {
pair := devIndex[dev]
if pair.Index1 > 0 {
invDevIndex1[pair.Index1-1] = i
}
if pair.Index2 > 0 {
invDevIndex2[pair.Index2-1] = i
}
}
newDays := map[int]map[int]*DevDay{}
merged.Days = newDays
for day, dd := range cr1.Days {
newdd, exists := newDays[day]
if !exists {
newdd = map[int]*DevDay{}
newDays[day] = newdd
}
for dev, stats := range dd {
newdev := dev
if newdev != identity.AuthorMissing {
newdev = invDevIndex1[dev]
}
newstats, exists := newdd[newdev]
if !exists {
newstats = &DevDay{}
newdd[newdev] = newstats
}
newstats.Commits += stats.Commits
newstats.Added += stats.Added
newstats.Removed += stats.Removed
newstats.Changed += stats.Changed
}
}
for day, dd := range cr2.Days {
newdd, exists := newDays[day]
if !exists {
newdd = map[int]*DevDay{}
newDays[day] = newdd
}
for dev, stats := range dd {
newdev := dev
if newdev != identity.AuthorMissing {
newdev = invDevIndex2[dev]
}
newstats, exists := newdd[newdev]
if !exists {
newstats = &DevDay{}
newdd[newdev] = newstats
}
newstats.Commits += stats.Commits
newstats.Added += stats.Added
newstats.Removed += stats.Removed
newstats.Changed += stats.Changed
}
}
return merged
}
func (devs *DevsAnalysis) serializeText(result *DevsResult, writer io.Writer) {
fmt.Fprintln(writer, " days:")
days := make([]int, len(result.Days))
{
i := 0
for day := range result.Days {
days[i] = day
i++
}
}
sort.Ints(days)
for _, day := range days {
fmt.Fprintf(writer, " %d:\n", day)
rday := result.Days[day]
devseq := make([]int, len(rday))
{
i := 0
for dev := range rday {
devseq[i] = dev
i++
}
}
sort.Ints(devseq)
for _, dev := range devseq {
stats := rday[dev]
if dev == identity.AuthorMissing {
dev = -1
}
fmt.Fprintf(writer, " %d: [%d, %d, %d, %d]\n",
dev, stats.Commits, stats.Added, stats.Removed, stats.Changed)
}
}
fmt.Fprintln(writer, " people:")
for _, person := range result.reversedPeopleDict {
fmt.Fprintf(writer, " - %s\n", yaml.SafeString(person))
}
}
func (devs *DevsAnalysis) serializeBinary(result *DevsResult, writer io.Writer) error {
message := pb.DevsAnalysisResults{}
message.DevIndex = result.reversedPeopleDict
message.Days = map[int32]*pb.DayDevs{}
for day, devs := range result.Days {
dd := &pb.DayDevs{}
message.Days[int32(day)] = dd
dd.Devs = map[int32]*pb.DevDay{}
for dev, stats := range devs {
if dev == identity.AuthorMissing {
dev = -1
}
dd.Devs[int32(dev)] = &pb.DevDay{
Commits: int32(stats.Commits),
Added: int32(stats.Added),
Changed: int32(stats.Changed),
Removed: int32(stats.Removed),
}
}
}
serialized, err := proto.Marshal(&message)
if err != nil {
return err
}
_, err = writer.Write(serialized)
return err
}
func init() {
core.Registry.Register(&DevsAnalysis{})
}