-
Notifications
You must be signed in to change notification settings - Fork 192
/
shotness.go
493 lines (462 loc) · 15.9 KB
/
shotness.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
488
489
490
491
492
493
package leaves
import (
"fmt"
"io"
"sort"
"unicode/utf8"
"github.com/gogo/protobuf/proto"
"github.com/sergi/go-diff/diffmatchpatch"
"gopkg.in/bblfsh/client-go.v3/tools"
"gopkg.in/bblfsh/sdk.v2/uast"
uast_nodes "gopkg.in/bblfsh/sdk.v2/uast/nodes"
"gopkg.in/bblfsh/sdk.v2/uast/query"
"gopkg.in/src-d/go-git.v4"
"gopkg.in/src-d/go-git.v4/plumbing/object"
"gopkg.in/src-d/hercules.v10/internal/core"
"gopkg.in/src-d/hercules.v10/internal/pb"
items "gopkg.in/src-d/hercules.v10/internal/plumbing"
uast_items "gopkg.in/src-d/hercules.v10/internal/plumbing/uast"
)
// ShotnessAnalysis contains the intermediate state which is mutated by Consume(). It should implement
// LeafPipelineItem.
type ShotnessAnalysis struct {
core.NoopMerger
core.OneShotMergeProcessor
XpathStruct string
XpathName string
nodes map[string]*nodeShotness
files map[string]map[string]*nodeShotness
l core.Logger
}
const (
// ConfigShotnessXpathStruct is the name of the configuration option (ShotnessAnalysis.Configure())
// which sets the UAST XPath to choose the analysed nodes.
// The format is Semantic UASTv2, see https://docs.sourced.tech/babelfish/using-babelfish/uast-querying
ConfigShotnessXpathStruct = "Shotness.XpathStruct"
// ConfigShotnessXpathName is the name of the configuration option (ShotnessAnalysis.Configure())
// which sets the UAST XPath to find the name of the nodes chosen by ConfigShotnessXpathStruct.
// The format is Semantic UASTv2, see https://docs.sourced.tech/babelfish/using-babelfish/uast-querying
ConfigShotnessXpathName = "Shotness.XpathName"
// DefaultShotnessXpathStruct is the default UAST XPath to choose the analysed nodes.
// It extracts functions.
DefaultShotnessXpathStruct = "//uast:FunctionGroup"
// DefaultShotnessXpathName is the default UAST XPath to choose the names of the analysed nodes.
// It looks at the current tree level and at the immediate children.
DefaultShotnessXpathName = "/Nodes/uast:Alias/Name"
)
type nodeShotness struct {
Count int
Summary NodeSummary
Couples map[string]int
}
// NodeSummary carries the node attributes which annotate the "shotness" analysis' counters.
// These attributes are supposed to uniquely identify each node.
type NodeSummary struct {
Type string
Name string
File string
}
// ShotnessResult is returned by ShotnessAnalysis.Finalize() and represents the analysis result.
type ShotnessResult struct {
Nodes []NodeSummary
Counters []map[int]int
}
func (node NodeSummary) String() string {
return node.Type + "_" + node.Name + "_" + node.File
}
// Name of this PipelineItem. Uniquely identifies the type, used for mapping keys, etc.
func (shotness *ShotnessAnalysis) Name() string {
return "Shotness"
}
// 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 (shotness *ShotnessAnalysis) 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 (shotness *ShotnessAnalysis) Requires() []string {
return []string{items.DependencyFileDiff, uast_items.DependencyUastChanges}
}
// ListConfigurationOptions returns the list of changeable public properties of this PipelineItem.
func (shotness *ShotnessAnalysis) ListConfigurationOptions() []core.ConfigurationOption {
opts := [...]core.ConfigurationOption{{
Name: ConfigShotnessXpathStruct,
Description: "Semantic UAST XPath query to use for filtering the nodes. " +
"Refer to https://docs.sourced.tech/babelfish/using-babelfish/uast-querying",
Flag: "shotness-xpath-struct",
Type: core.StringConfigurationOption,
Default: DefaultShotnessXpathStruct}, {
Name: ConfigShotnessXpathName,
Description: "Semantic UAST XPath query to determine the names of the filtered nodes. " +
"Refer to https://docs.sourced.tech/babelfish/using-babelfish/uast-querying",
Flag: "shotness-xpath-name",
Type: core.StringConfigurationOption,
Default: DefaultShotnessXpathName},
}
return opts[:]
}
// Flag returns the command line switch which activates the analysis.
func (shotness *ShotnessAnalysis) Flag() string {
return "shotness"
}
// Features returns the Hercules features required to deploy this leaf.
func (shotness *ShotnessAnalysis) Features() []string {
return []string{uast_items.FeatureUast}
}
// Description returns the text which explains what the analysis is doing.
func (shotness *ShotnessAnalysis) Description() string {
return "Structural hotness - a fine-grained alternative to --couples. " +
"Given an XPath over UASTs - selecting functions by default - we build the square " +
"co-occurrence matrix. The value in each cell equals to the number of times the pair " +
"of selected UAST units appeared in the same commit."
}
// Configure sets the properties previously published by ListConfigurationOptions().
func (shotness *ShotnessAnalysis) Configure(facts map[string]interface{}) error {
if l, exists := facts[core.ConfigLogger].(core.Logger); exists {
shotness.l = l
}
if val, exists := facts[ConfigShotnessXpathStruct]; exists {
shotness.XpathStruct = val.(string)
} else {
shotness.XpathStruct = DefaultShotnessXpathStruct
}
if val, exists := facts[ConfigShotnessXpathName]; exists {
shotness.XpathName = val.(string)
} else {
shotness.XpathName = DefaultShotnessXpathName
}
return nil
}
// 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 (shotness *ShotnessAnalysis) Initialize(repository *git.Repository) error {
shotness.l = core.NewLogger()
shotness.nodes = map[string]*nodeShotness{}
shotness.files = map[string]map[string]*nodeShotness{}
shotness.OneShotMergeProcessor.Initialize()
return nil
}
// 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 (shotness *ShotnessAnalysis) Consume(deps map[string]interface{}) (map[string]interface{}, error) {
if !shotness.ShouldConsumeCommit(deps) {
return nil, nil
}
commit := deps[core.DependencyCommit].(*object.Commit)
changesList := deps[uast_items.DependencyUastChanges].([]uast_items.Change)
diffs := deps[items.DependencyFileDiff].(map[string]items.FileDiffData)
allNodes := map[string]bool{}
addNode := func(name string, node uast_nodes.Node, fileName string) {
nodeSummary := NodeSummary{
Type: uast.TypeOf(node),
Name: name,
File: fileName,
}
key := nodeSummary.String()
exists := allNodes[key]
allNodes[key] = true
var count int
if ns := shotness.nodes[key]; ns != nil {
count = ns.Count
}
if count == 0 {
shotness.nodes[key] = &nodeShotness{
Summary: nodeSummary, Count: 1, Couples: map[string]int{}}
fmap := shotness.files[nodeSummary.File]
if fmap == nil {
fmap = map[string]*nodeShotness{}
}
fmap[key] = shotness.nodes[key]
shotness.files[nodeSummary.File] = fmap
} else if !exists { // in case there are removals and additions in the same node
shotness.nodes[key].Count = count + 1
}
}
for _, change := range changesList {
if change.After == nil {
for key, summary := range shotness.files[change.Change.From.Name] {
for subkey := range summary.Couples {
delete(shotness.nodes[subkey].Couples, key)
}
}
for key := range shotness.files[change.Change.From.Name] {
delete(shotness.nodes, key)
}
delete(shotness.files, change.Change.From.Name)
continue
}
toName := change.Change.To.Name
if change.Before == nil {
nodes, err := shotness.extractNodes(change.After)
if err != nil {
shotness.l.Warnf("Shotness: commit %s file %s failed to filter UAST: %s\n",
commit.Hash.String(), toName, err.Error())
continue
}
for name, node := range nodes {
addNode(name, node, toName)
}
continue
}
// Before -> After
if change.Change.From.Name != toName {
// renamed
oldFile := shotness.files[change.Change.From.Name]
newFile := map[string]*nodeShotness{}
shotness.files[toName] = newFile
for oldKey, ns := range oldFile {
ns.Summary.File = toName
newKey := ns.Summary.String()
newFile[newKey] = ns
shotness.nodes[newKey] = ns
for coupleKey, count := range ns.Couples {
coupleCouples := shotness.nodes[coupleKey].Couples
delete(coupleCouples, oldKey)
coupleCouples[newKey] = count
}
}
// deferred cleanup is needed
for key := range oldFile {
delete(shotness.nodes, key)
}
delete(shotness.files, change.Change.From.Name)
}
// pass through old UAST
// pass through new UAST
nodesBefore, err := shotness.extractNodes(change.Before)
if err != nil {
shotness.l.Warnf("Shotness: commit ^%s file %s failed to filter UAST: %s\n",
commit.Hash.String(), change.Change.From.Name, err.Error())
continue
}
reversedNodesBefore := reverseNodeMap(nodesBefore)
nodesAfter, err := shotness.extractNodes(change.After)
if err != nil {
shotness.l.Warnf("Shotness: commit %s file %s failed to filter UAST: %s\n",
commit.Hash.String(), toName, err.Error())
continue
}
reversedNodesAfter := reverseNodeMap(nodesAfter)
genLine2Node := func(nodes map[string]uast_nodes.Node, linesNum int) [][]uast_nodes.Node {
res := make([][]uast_nodes.Node, linesNum)
for _, node := range nodes {
pos := uast.PositionsOf(node.(uast_nodes.Object))
if pos.Start() == nil {
continue
}
startLine := pos.Start().Line
endLine := pos.Start().Line
if pos.End() != nil && pos.End().Line > pos.Start().Line {
endLine = pos.End().Line
} else {
// we need to determine pos.End().Line
uast_items.VisitEachNode(node, func(child uast_nodes.Node) {
childPos := uast.PositionsOf(child.(uast_nodes.Object))
if childPos.Start() != nil {
candidate := childPos.Start().Line
if childPos.End() != nil {
candidate = childPos.End().Line
}
if candidate > endLine {
endLine = candidate
}
}
})
}
for l := startLine; l <= endLine; l++ {
lineNodes := res[l-1]
if lineNodes == nil {
lineNodes = []uast_nodes.Node{}
}
lineNodes = append(lineNodes, node)
res[l-1] = lineNodes
}
}
return res
}
diff := diffs[toName]
line2nodeBefore := genLine2Node(nodesBefore, diff.OldLinesOfCode)
line2nodeAfter := genLine2Node(nodesAfter, diff.NewLinesOfCode)
// Scan through all the edits. Given the line numbers, get the list of active nodes
// and add them.
var lineNumBefore, lineNumAfter int
for _, edit := range diff.Diffs {
size := utf8.RuneCountInString(edit.Text)
switch edit.Type {
case diffmatchpatch.DiffDelete:
for l := lineNumBefore; l < lineNumBefore+size; l++ {
nodes := line2nodeBefore[l]
for _, node := range nodes {
// toName because we handled a possible rename before
addNode(reversedNodesBefore[uast_nodes.UniqueKey(node)], node, toName)
}
}
lineNumBefore += size
case diffmatchpatch.DiffInsert:
for l := lineNumAfter; l < lineNumAfter+size; l++ {
nodes := line2nodeAfter[l]
for _, node := range nodes {
addNode(reversedNodesAfter[uast_nodes.UniqueKey(node)], node, toName)
}
}
lineNumAfter += size
case diffmatchpatch.DiffEqual:
lineNumBefore += size
lineNumAfter += size
}
}
}
for keyi := range allNodes {
for keyj := range allNodes {
if keyi == keyj {
continue
}
shotness.nodes[keyi].Couples[keyj]++
}
}
return nil, nil
}
// Fork clones this PipelineItem.
func (shotness *ShotnessAnalysis) Fork(n int) []core.PipelineItem {
return core.ForkSamePipelineItem(shotness, n)
}
// Finalize returns the result of the analysis. Further Consume() calls are not expected.
func (shotness *ShotnessAnalysis) Finalize() interface{} {
result := ShotnessResult{
Nodes: make([]NodeSummary, len(shotness.nodes)),
Counters: make([]map[int]int, len(shotness.nodes)),
}
keys := make([]string, len(shotness.nodes))
i := 0
for key := range shotness.nodes {
keys[i] = key
i++
}
sort.Strings(keys)
reverseKeys := map[string]int{}
for i, key := range keys {
reverseKeys[key] = i
}
for i, key := range keys {
node := shotness.nodes[key]
result.Nodes[i] = node.Summary
counter := map[int]int{}
result.Counters[i] = counter
counter[i] = node.Count
for ck, val := range node.Couples {
counter[reverseKeys[ck]] = val
}
}
return result
}
// 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 (shotness *ShotnessAnalysis) Serialize(result interface{}, binary bool, writer io.Writer) error {
shotnessResult := result.(ShotnessResult)
if binary {
return shotness.serializeBinary(&shotnessResult, writer)
}
shotness.serializeText(&shotnessResult, writer)
return nil
}
func (shotness *ShotnessAnalysis) serializeText(result *ShotnessResult, writer io.Writer) {
for i, summary := range result.Nodes {
fmt.Fprintf(writer, " - name: %s\n file: %s\n internal_role: %s\n counters: {",
summary.Name, summary.File, summary.Type)
keys := make([]int, len(result.Counters[i]))
j := 0
for key := range result.Counters[i] {
keys[j] = key
j++
}
sort.Ints(keys)
j = 0
for _, key := range keys {
val := result.Counters[i][key]
if j < len(result.Counters[i])-1 {
fmt.Fprintf(writer, "\"%d\":%d,", key, val)
} else {
fmt.Fprintf(writer, "\"%d\":%d}\n", key, val)
}
j++
}
}
}
func (shotness *ShotnessAnalysis) serializeBinary(result *ShotnessResult, writer io.Writer) error {
message := pb.ShotnessAnalysisResults{
Records: make([]*pb.ShotnessRecord, len(result.Nodes)),
}
for i, summary := range result.Nodes {
record := &pb.ShotnessRecord{
Name: summary.Name,
File: summary.File,
Type: summary.Type,
Counters: map[int32]int32{},
}
for key, val := range result.Counters[i] {
record.Counters[int32(key)] = int32(val)
}
message.Records[i] = record
}
serialized, err := proto.Marshal(&message)
if err != nil {
return err
}
_, err = writer.Write(serialized)
return err
}
func (shotness *ShotnessAnalysis) extractNodes(root uast_nodes.Node) (map[string]uast_nodes.Node, error) {
it, err := tools.Filter(root, shotness.XpathStruct)
if err != nil {
return nil, err
}
structs := query.AllNodes(it)
// some structs may be inside other structs; we pick the outermost
// otherwise due to UAST quirks there may be false positives
internal := map[uast_nodes.Comparable]bool{}
for _, ext := range structs {
mainNode := ext.(uast_nodes.Node)
if internal[uast_nodes.UniqueKey(mainNode)] {
continue
}
subs, err := tools.Filter(mainNode, shotness.XpathStruct)
if err != nil {
return nil, err
}
for subs.Next() {
sub := subs.Node().(uast_nodes.Node)
if uast_nodes.UniqueKey(sub) != uast_nodes.UniqueKey(mainNode) {
internal[uast_nodes.UniqueKey(sub)] = true
}
}
}
res := map[string]uast_nodes.Node{}
for _, ext := range structs {
node := ext.(uast_nodes.Node)
if internal[uast_nodes.UniqueKey(node)] {
continue
}
nodeName, err := tools.FilterNode(node, "/*"+shotness.XpathName)
if err != nil {
return nil, err
}
res[string(nodeName.(uast_nodes.Object)["Name"].(uast_nodes.String))] = node
}
return res, nil
}
func reverseNodeMap(nodes map[string]uast_nodes.Node) map[uast_nodes.Comparable]string {
res := map[uast_nodes.Comparable]string{}
for key, node := range nodes {
res[uast_nodes.UniqueKey(node)] = key
}
return res
}
func init() {
core.Registry.Register(&ShotnessAnalysis{})
}