fork of https://github.com/sourcegraph/zoekt
api: JSON omitempty on optional fields in FileMatch (#721)
There are several fields which are optional in FileMatch. For example
branch and version are only set if indexing a git repo (zoekt can index
arbitrary files). We mark these fields as optional to marshal in JSON.
The main benefit of this is improving the readability of some golden
files.
Note: I noticed this when an unrelated commit touched these golden
files.
Test Plan: go test
author
Keegan Carruthers-Smith
committer
GitHub
date
(Jan 18, 2024, 5:59 AM +0200)
commit
18b69993
18b699936719b727b2d6c8ea08a745a7ceec2d65
parent
4be2929f
4be2929fd03415e63831a6e02878dd67b44041fc
+39
-165
+11
-11
api.go
+11
-11
api.go
···
43
43
44
44
// SubRepositoryName is the globally unique name of the repo,
45
45
// if it came from a subrepository
46
-
SubRepositoryName string
46
+
SubRepositoryName string `json:",omitempty"`
47
47
48
48
// SubRepositoryPath holds the prefix where the subrepository
49
49
// was mounted.
50
-
SubRepositoryPath string
50
+
SubRepositoryPath string `json:",omitempty"`
51
51
52
52
// Commit SHA1 (hex) of the (sub)repo holding the file.
53
-
Version string
53
+
Version string `json:",omitempty"`
54
54
55
55
// Detected language of the result.
56
56
Language string
57
57
58
58
// For debugging. Needs DebugScore set, but public so tests in
59
59
// other packages can print some diagnostics.
60
-
Debug string
60
+
Debug string `json:",omitempty"`
61
61
62
-
Branches []string
62
+
Branches []string `json:",omitempty"`
63
63
64
64
// One of LineMatches or ChunkMatches will be returned depending on whether
65
65
// the SearchOptions.ChunkMatches is set.
66
-
LineMatches []LineMatch
67
-
ChunkMatches []ChunkMatch
66
+
LineMatches []LineMatch `json:",omitempty"`
67
+
ChunkMatches []ChunkMatch `json:",omitempty"`
68
68
69
69
// Only set if requested
70
-
Content []byte
70
+
Content []byte `json:",omitempty"`
71
71
72
72
// Checksum of the content.
73
73
Checksum []byte
74
74
75
75
// Ranking; the higher, the better.
76
-
Score float64 // TODO - hide this field?
76
+
Score float64 `json:",omitempty"`
77
77
78
78
// RepositoryPriority is a Sourcegraph extension. It is used by Sourcegraph to
79
79
// order results from different repositories relative to each other.
80
-
RepositoryPriority float64
80
+
RepositoryPriority float64 `json:",omitempty"`
81
81
82
82
// RepositoryID is a Sourcegraph extension. This is the ID of Repository in
83
83
// Sourcegraph.
84
-
RepositoryID uint32
84
+
RepositoryID uint32 `json:",omitempty"`
85
85
}
86
86
87
87
func (m *FileMatch) sizeBytes() (sz uint64) {
+4
-22
testdata/golden/TestReadSearch/repo17_v17.00000.golden
+4
-22
testdata/golden/TestReadSearch/repo17_v17.00000.golden
···
4
4
"FileMatches": [
5
5
[
6
6
{
7
-
"Score": 510,
8
-
"Debug": "",
9
7
"FileName": "main.go",
10
8
"Repository": "repo17",
11
-
"Branches": null,
9
+
"Language": "Go",
12
10
"LineMatches": [
13
11
{
14
12
"Line": "ZnVuYyBtYWluKCkgew==",
···
30
28
]
31
29
}
32
30
],
33
-
"ChunkMatches": null,
34
-
"RepositoryID": 0,
35
-
"RepositoryPriority": 0,
36
-
"Content": null,
37
31
"Checksum": "n9fUYqacPXg=",
38
-
"Language": "Go",
39
-
"SubRepositoryName": "",
40
-
"SubRepositoryPath": "",
41
-
"Version": ""
32
+
"Score": 510
42
33
}
43
34
],
44
35
[
45
36
{
46
-
"Score": 510,
47
-
"Debug": "",
48
37
"FileName": "main.go",
49
38
"Repository": "repo17",
50
-
"Branches": null,
39
+
"Language": "Go",
51
40
"LineMatches": [
52
41
{
53
42
"Line": "cGFja2FnZSBtYWlu",
···
69
58
]
70
59
}
71
60
],
72
-
"ChunkMatches": null,
73
-
"RepositoryID": 0,
74
-
"RepositoryPriority": 0,
75
-
"Content": null,
76
61
"Checksum": "n9fUYqacPXg=",
77
-
"Language": "Go",
78
-
"SubRepositoryName": "",
79
-
"SubRepositoryPath": "",
80
-
"Version": ""
62
+
"Score": 510
81
63
}
82
64
],
83
65
null,
+4
-22
testdata/golden/TestReadSearch/repo2_v16.00000.golden
+4
-22
testdata/golden/TestReadSearch/repo2_v16.00000.golden
···
4
4
"FileMatches": [
5
5
[
6
6
{
7
-
"Score": 510,
8
-
"Debug": "",
9
7
"FileName": "main.go",
10
8
"Repository": "repo2",
11
-
"Branches": null,
9
+
"Language": "Go",
12
10
"LineMatches": [
13
11
{
14
12
"Line": "ZnVuYyBtYWluKCkgew==",
···
30
28
]
31
29
}
32
30
],
33
-
"ChunkMatches": null,
34
-
"RepositoryID": 0,
35
-
"RepositoryPriority": 0,
36
-
"Content": null,
37
31
"Checksum": "Ju1TnQKZ6mE=",
38
-
"Language": "Go",
39
-
"SubRepositoryName": "",
40
-
"SubRepositoryPath": "",
41
-
"Version": ""
32
+
"Score": 510
42
33
}
43
34
],
44
35
[
45
36
{
46
-
"Score": 510,
47
-
"Debug": "",
48
37
"FileName": "main.go",
49
38
"Repository": "repo2",
50
-
"Branches": null,
39
+
"Language": "Go",
51
40
"LineMatches": [
52
41
{
53
42
"Line": "cGFja2FnZSBtYWlu",
···
69
58
]
70
59
}
71
60
],
72
-
"ChunkMatches": null,
73
-
"RepositoryID": 0,
74
-
"RepositoryPriority": 0,
75
-
"Content": null,
76
61
"Checksum": "Ju1TnQKZ6mE=",
77
-
"Language": "Go",
78
-
"SubRepositoryName": "",
79
-
"SubRepositoryPath": "",
80
-
"Version": ""
62
+
"Score": 510
81
63
}
82
64
],
83
65
null,
+4
-22
testdata/golden/TestReadSearch/repo_v16.00000.golden
+4
-22
testdata/golden/TestReadSearch/repo_v16.00000.golden
···
4
4
"FileMatches": [
5
5
[
6
6
{
7
-
"Score": 510,
8
-
"Debug": "",
9
7
"FileName": "main.go",
10
8
"Repository": "repo",
11
-
"Branches": null,
9
+
"Language": "Go",
12
10
"LineMatches": [
13
11
{
14
12
"Line": "ZnVuYyBtYWluKCkgew==",
···
30
28
]
31
29
}
32
30
],
33
-
"ChunkMatches": null,
34
-
"RepositoryID": 0,
35
-
"RepositoryPriority": 0,
36
-
"Content": null,
37
31
"Checksum": "n9fUYqacPXg=",
38
-
"Language": "Go",
39
-
"SubRepositoryName": "",
40
-
"SubRepositoryPath": "",
41
-
"Version": ""
32
+
"Score": 510
42
33
}
43
34
],
44
35
[
45
36
{
46
-
"Score": 510,
47
-
"Debug": "",
48
37
"FileName": "main.go",
49
38
"Repository": "repo",
50
-
"Branches": null,
39
+
"Language": "Go",
51
40
"LineMatches": [
52
41
{
53
42
"Line": "cGFja2FnZSBtYWlu",
···
69
58
]
70
59
}
71
60
],
72
-
"ChunkMatches": null,
73
-
"RepositoryID": 0,
74
-
"RepositoryPriority": 0,
75
-
"Content": null,
76
61
"Checksum": "n9fUYqacPXg=",
77
-
"Language": "Go",
78
-
"SubRepositoryName": "",
79
-
"SubRepositoryPath": "",
80
-
"Version": ""
62
+
"Score": 510
81
63
}
82
64
],
83
65
null,