-
Notifications
You must be signed in to change notification settings - Fork 4.8k
Expand file tree
/
Copy pathfields_filtering_test.go
More file actions
466 lines (404 loc) · 18.1 KB
/
Copy pathfields_filtering_test.go
File metadata and controls
466 lines (404 loc) · 18.1 KB
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
package github
import (
"context"
"encoding/json"
"net/http"
"testing"
"github.com/github/github-mcp-server/internal/githubv4mock"
"github.com/github/github-mcp-server/pkg/inventory"
"github.com/github/github-mcp-server/pkg/translations"
"github.com/google/go-github/v89/github"
"github.com/shurcooL/githubv4"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
// --- list_commits ---------------------------------------------------------
func mockListCommits() []*github.RepositoryCommit {
return []*github.RepositoryCommit{
{
SHA: github.Ptr("abc123def456"),
HTMLURL: github.Ptr("https://github.com/owner/repo/commit/abc123def456"),
Commit: &github.Commit{
Message: github.Ptr("First commit with a reasonably long message to add bytes"),
Author: &github.CommitAuthor{
Name: github.Ptr("Test User"),
Email: github.Ptr("test@example.com"),
},
},
Author: &github.User{Login: github.Ptr("testuser")},
},
}
}
func Test_ListCommits_FieldFiltering(t *testing.T) {
serverTool := ListCommits(translations.NullTranslationHelper)
client := mustNewGHClient(t, MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetReposCommitsByOwnerByRepo: mockResponse(t, http.StatusOK, mockListCommits()),
}))
deps := BaseDeps{Client: client}
handler := serverTool.Handler(deps)
request := createMCPRequest(map[string]any{
"owner": "owner",
"repo": "repo",
"fields": []any{"sha"},
})
result, err := handler(ContextWithDeps(context.Background(), deps), &request)
require.NoError(t, err)
require.False(t, result.IsError)
textContent := getTextResult(t, result)
var items []map[string]any
require.NoError(t, json.Unmarshal([]byte(textContent.Text), &items))
require.Len(t, items, 1)
require.Len(t, items[0], 1)
assert.Contains(t, items[0], "sha")
assert.NotContains(t, textContent.Text, "html_url")
assert.NotContains(t, textContent.Text, "commit")
}
func Test_ListCommits_FieldsTelemetry(t *testing.T) {
serverTool := ListCommits(translations.NullTranslationHelper)
client := mustNewGHClient(t, MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetReposCommitsByOwnerByRepo: mockResponse(t, http.StatusOK, mockListCommits()),
}))
assertFieldsTelemetry(t, serverTool, client, "list_commits",
map[string]any{"owner": "owner", "repo": "repo", "fields": []any{"sha"}},
map[string]any{"owner": "owner", "repo": "repo"})
}
// --- list_releases --------------------------------------------------------
func mockListReleases() []*github.RepositoryRelease {
return []*github.RepositoryRelease{
{
ID: 1,
TagName: "v1.0.0",
Name: github.Ptr("First Release"),
Body: github.Ptr("Release notes with a reasonably long body to add bytes"),
HTMLURL: "https://github.com/owner/repo/releases/tag/v1.0.0",
},
}
}
func Test_ListReleases_FieldFiltering(t *testing.T) {
serverTool := ListReleases(translations.NullTranslationHelper)
client := mustNewGHClient(t, MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetReposReleasesByOwnerByRepo: mockResponse(t, http.StatusOK, mockListReleases()),
}))
deps := BaseDeps{Client: client}
handler := serverTool.Handler(deps)
request := createMCPRequest(map[string]any{
"owner": "owner",
"repo": "repo",
"fields": []any{"tag_name", "name"},
})
result, err := handler(ContextWithDeps(context.Background(), deps), &request)
require.NoError(t, err)
require.False(t, result.IsError)
textContent := getTextResult(t, result)
var items []map[string]any
require.NoError(t, json.Unmarshal([]byte(textContent.Text), &items))
require.Len(t, items, 1)
require.Len(t, items[0], 2)
assert.Contains(t, items[0], "tag_name")
assert.Contains(t, items[0], "name")
assert.NotContains(t, textContent.Text, "body")
assert.NotContains(t, textContent.Text, "html_url")
}
func Test_ListReleases_FieldsTelemetry(t *testing.T) {
serverTool := ListReleases(translations.NullTranslationHelper)
client := mustNewGHClient(t, MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetReposReleasesByOwnerByRepo: mockResponse(t, http.StatusOK, mockListReleases()),
}))
assertFieldsTelemetry(t, serverTool, client, "list_releases",
map[string]any{"owner": "owner", "repo": "repo", "fields": []any{"tag_name"}},
map[string]any{"owner": "owner", "repo": "repo"})
}
// --- list_pull_requests ---------------------------------------------------
func mockListPullRequests() []*github.PullRequest {
return []*github.PullRequest{
{
Number: github.Ptr(42),
Title: github.Ptr("First PR"),
Body: github.Ptr("PR body with a reasonably long description to add bytes"),
State: github.Ptr("open"),
HTMLURL: github.Ptr("https://github.com/owner/repo/pull/42"),
User: &github.User{Login: github.Ptr("user1")},
},
}
}
func Test_ListPullRequests_FieldFiltering(t *testing.T) {
serverTool := ListPullRequests(translations.NullTranslationHelper)
client := mustNewGHClient(t, MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetReposPullsByOwnerByRepo: mockResponse(t, http.StatusOK, mockListPullRequests()),
}))
deps := BaseDeps{Client: client}
handler := serverTool.Handler(deps)
request := createMCPRequest(map[string]any{
"owner": "owner",
"repo": "repo",
"fields": []any{"number", "title"},
})
result, err := handler(ContextWithDeps(context.Background(), deps), &request)
require.NoError(t, err)
require.False(t, result.IsError)
textContent := getTextResult(t, result)
var items []map[string]any
require.NoError(t, json.Unmarshal([]byte(textContent.Text), &items))
require.Len(t, items, 1)
require.Len(t, items[0], 2)
assert.Contains(t, items[0], "number")
assert.Contains(t, items[0], "title")
assert.NotContains(t, textContent.Text, "html_url")
assert.NotContains(t, textContent.Text, "body")
}
func Test_ListPullRequests_FieldsTelemetry(t *testing.T) {
serverTool := ListPullRequests(translations.NullTranslationHelper)
client := mustNewGHClient(t, MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetReposPullsByOwnerByRepo: mockResponse(t, http.StatusOK, mockListPullRequests()),
}))
assertFieldsTelemetry(t, serverTool, client, "list_pull_requests",
map[string]any{"owner": "owner", "repo": "repo", "fields": []any{"number"}},
map[string]any{"owner": "owner", "repo": "repo"})
}
// --- search_pull_requests -------------------------------------------------
// mockIssueSearchResult returns a single-item issues search result. It is used
// for both search_pull_requests and search_issues since both hit the REST
// issues search endpoint. Issues intentionally omit NodeID so search_issues
// does not attempt the follow-up GraphQL field-values enrichment.
func mockIssueSearchResult() *github.IssuesSearchResult {
return &github.IssuesSearchResult{
Total: github.Ptr(1),
IncompleteResults: github.Ptr(false),
Issues: []*github.Issue{
{
Number: github.Ptr(42),
Title: github.Ptr("A result"),
Body: github.Ptr("Body with a reasonably long description to add bytes"),
State: github.Ptr("open"),
HTMLURL: github.Ptr("https://github.com/owner/repo/pull/42"),
User: &github.User{Login: github.Ptr("user1")},
},
},
}
}
func Test_SearchPullRequests_FieldFiltering(t *testing.T) {
serverTool := SearchPullRequests(translations.NullTranslationHelper)
client := mustNewGHClient(t, MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetSearchIssues: mockResponse(t, http.StatusOK, mockIssueSearchResult()),
}))
deps := BaseDeps{Client: client}
handler := serverTool.Handler(deps)
request := createMCPRequest(map[string]any{
"query": "fix",
"fields": []any{"number", "title"},
})
result, err := handler(ContextWithDeps(context.Background(), deps), &request)
require.NoError(t, err)
require.False(t, result.IsError)
textContent := getTextResult(t, result)
assertSearchWrapperFiltered(t, textContent.Text)
}
func Test_SearchPullRequests_FieldsTelemetry(t *testing.T) {
serverTool := SearchPullRequests(translations.NullTranslationHelper)
client := mustNewGHClient(t, MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetSearchIssues: mockResponse(t, http.StatusOK, mockIssueSearchResult()),
}))
assertFieldsTelemetry(t, serverTool, client, "search_pull_requests",
map[string]any{"query": "fix", "fields": []any{"number"}},
map[string]any{"query": "fix"})
}
// --- search_issues --------------------------------------------------------
func Test_SearchIssues_FieldFiltering(t *testing.T) {
serverTool := SearchIssues(translations.NullTranslationHelper)
client := mustNewGHClient(t, MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetSearchIssues: mockResponse(t, http.StatusOK, mockIssueSearchResult()),
}))
deps := BaseDeps{Client: client}
handler := serverTool.Handler(deps)
request := createMCPRequest(map[string]any{
"query": "bug",
"fields": []any{"number", "title"},
})
result, err := handler(ContextWithDeps(context.Background(), deps), &request)
require.NoError(t, err)
require.False(t, result.IsError)
textContent := getTextResult(t, result)
assertSearchWrapperFiltered(t, textContent.Text)
}
func Test_SearchIssues_FieldsTelemetry(t *testing.T) {
serverTool := SearchIssues(translations.NullTranslationHelper)
client := mustNewGHClient(t, MockHTTPClientWithHandlers(map[string]http.HandlerFunc{
GetSearchIssues: mockResponse(t, http.StatusOK, mockIssueSearchResult()),
}))
assertFieldsTelemetry(t, serverTool, client, "search_issues",
map[string]any{"query": "bug", "fields": []any{"number"}},
map[string]any{"query": "bug"})
}
// --- list_issues (GraphQL) ------------------------------------------------
// listIssuesFieldsQuery and listIssuesFieldsVars mirror the exact GraphQL query
// and variables list_issues issues for owner/repo with default parameters (no
// labels, no since). They must stay in sync with the query built in
// getIssueQueryType; see Test_ListIssues for the canonical copies.
const listIssuesFieldsFieldValuesSelection = "issueFieldValues(first: 25){nodes{__typename,... on IssueFieldDateValue{field{... on IssueFieldDate{name,fullDatabaseId},... on IssueFieldNumber{name,fullDatabaseId},... on IssueFieldSingleSelect{name,fullDatabaseId},... on IssueFieldText{name,fullDatabaseId}},value},... on IssueFieldNumberValue{field{... on IssueFieldDate{name,fullDatabaseId},... on IssueFieldNumber{name,fullDatabaseId},... on IssueFieldSingleSelect{name,fullDatabaseId},... on IssueFieldText{name,fullDatabaseId}},valueNumber: value},... on IssueFieldSingleSelectValue{field{... on IssueFieldDate{name,fullDatabaseId},... on IssueFieldNumber{name,fullDatabaseId},... on IssueFieldSingleSelect{name,fullDatabaseId},... on IssueFieldText{name,fullDatabaseId}},value},... on IssueFieldTextValue{field{... on IssueFieldDate{name,fullDatabaseId},... on IssueFieldNumber{name,fullDatabaseId},... on IssueFieldSingleSelect{name,fullDatabaseId},... on IssueFieldText{name,fullDatabaseId}},value}}}"
const listIssuesFieldsQuery = "query($after:String$direction:OrderDirection!$first:Int!$issueFieldValues:[IssueFieldValueFilter!]!$orderBy:IssueOrderField!$owner:String!$repo:String!$states:[IssueState!]!){repository(owner: $owner, name: $repo){issues(first: $first, after: $after, states: $states, orderBy: {field: $orderBy, direction: $direction}, filterBy: {issueFieldValues: $issueFieldValues}){nodes{number,title,body,state,databaseId,author{login},createdAt,updatedAt,labels(first: 100){nodes{name,id,description}},comments{totalCount}," + listIssuesFieldsFieldValuesSelection + "},pageInfo{hasNextPage,hasPreviousPage,startCursor,endCursor},totalCount},isPrivate}}"
func listIssuesFieldsMockClient() *http.Client {
vars := map[string]any{
"owner": "owner",
"repo": "repo",
"states": []any{"OPEN", "CLOSED"},
"orderBy": "CREATED_AT",
"direction": "DESC",
"first": float64(30),
"after": (*string)(nil),
"issueFieldValues": []any{},
}
response := githubv4mock.DataResponse(map[string]any{
"repository": map[string]any{
"issues": map[string]any{
"nodes": []map[string]any{
{
"number": 123,
"title": "First Issue",
"body": "This is a reasonably long issue body to add bytes",
"state": "OPEN",
"databaseId": 1001,
"createdAt": "2023-01-01T00:00:00Z",
"updatedAt": "2023-01-01T00:00:00Z",
"author": map[string]any{"login": "user1"},
"labels": map[string]any{"nodes": []map[string]any{}},
"comments": map[string]any{"totalCount": 1},
"issueFieldValues": map[string]any{"nodes": []map[string]any{}},
},
},
"pageInfo": map[string]any{
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "",
"endCursor": "",
},
"totalCount": 1,
},
"isPrivate": false,
},
})
matcher := githubv4mock.NewQueryMatcher(listIssuesFieldsQuery, vars, response)
return githubv4mock.NewMockedHTTPClient(matcher)
}
func Test_ListIssues_FieldFiltering(t *testing.T) {
serverTool := ListIssues(translations.NullTranslationHelper)
deps := BaseDeps{GQLClient: githubv4.NewClient(listIssuesFieldsMockClient())}
handler := serverTool.Handler(deps)
request := createMCPRequest(map[string]any{
"owner": "owner",
"repo": "repo",
"fields": []any{"number", "title"},
})
result, err := handler(ContextWithDeps(context.Background(), deps), &request)
require.NoError(t, err)
require.False(t, result.IsError)
textContent := getTextResult(t, result)
// The wrapper metadata is preserved while each issue is reduced to the
// requested fields only.
var returned struct {
Issues []map[string]any `json:"issues"`
TotalCount int `json:"totalCount"`
PageInfo map[string]any `json:"pageInfo"`
}
require.NoError(t, json.Unmarshal([]byte(textContent.Text), &returned))
assert.Equal(t, 1, returned.TotalCount)
require.NotNil(t, returned.PageInfo)
require.Len(t, returned.Issues, 1)
require.Len(t, returned.Issues[0], 2)
assert.Contains(t, returned.Issues[0], "number")
assert.Contains(t, returned.Issues[0], "title")
assert.NotContains(t, textContent.Text, "\"body\"")
}
func Test_ListIssues_FieldsTelemetry(t *testing.T) {
serverTool := ListIssues(translations.NullTranslationHelper)
t.Run("filtered call records savings", func(t *testing.T) {
deps, rec := depsWithRecordingMetrics(t, BaseDeps{GQLClient: githubv4.NewClient(listIssuesFieldsMockClient())})
handler := serverTool.Handler(deps)
request := createMCPRequest(map[string]any{
"owner": "owner",
"repo": "repo",
"fields": []any{"number"},
})
result, err := handler(ContextWithDeps(context.Background(), deps), &request)
require.NoError(t, err)
require.False(t, result.IsError)
assertFilteredCounters(t, rec, "list_issues")
})
t.Run("unfiltered call records adoption only", func(t *testing.T) {
deps, rec := depsWithRecordingMetrics(t, BaseDeps{GQLClient: githubv4.NewClient(listIssuesFieldsMockClient())})
handler := serverTool.Handler(deps)
request := createMCPRequest(map[string]any{
"owner": "owner",
"repo": "repo",
})
result, err := handler(ContextWithDeps(context.Background(), deps), &request)
require.NoError(t, err)
require.False(t, result.IsError)
call, ok := rec.increment(metricFieldsToolCall)
require.True(t, ok)
assert.Equal(t, "false", call.tags["filtered"])
_, ok = rec.counter(metricFieldsBytesFull)
assert.False(t, ok, "no byte counters when not filtered")
})
}
// --- shared assertion helpers ---------------------------------------------
// assertSearchWrapperFiltered asserts that a filtered search response preserves
// the total_count / incomplete_results wrapper while reducing each item to the
// requested number/title fields only.
func assertSearchWrapperFiltered(t *testing.T, text string) {
t.Helper()
var returned struct {
TotalCount int `json:"total_count"`
IncompleteResults bool `json:"incomplete_results"`
Items []map[string]any `json:"items"`
}
require.NoError(t, json.Unmarshal([]byte(text), &returned))
assert.Equal(t, 1, returned.TotalCount)
require.Len(t, returned.Items, 1)
require.Len(t, returned.Items[0], 2)
assert.Contains(t, returned.Items[0], "number")
assert.Contains(t, returned.Items[0], "title")
assert.NotContains(t, text, "html_url")
assert.NotContains(t, text, "\"body\"")
}
// assertFilteredCounters asserts the full set of counters emitted for a filtered
// call: an increment tagged filtered=true plus positive byte counters where
// full > sent.
func assertFilteredCounters(t *testing.T, rec *recordingMetrics, tool string) {
t.Helper()
call, ok := rec.increment(metricFieldsToolCall)
require.True(t, ok)
assert.Equal(t, tool, call.tags["tool"])
assert.Equal(t, "true", call.tags["filtered"])
full, ok := rec.counter(metricFieldsBytesFull)
require.True(t, ok)
sent, ok := rec.counter(metricFieldsBytesSent)
require.True(t, ok)
assert.Greater(t, full.value, sent.value, "filtering should remove bytes")
}
// assertFieldsTelemetry runs a filtered and an unfiltered call against the given
// tool and asserts the expected adoption and savings telemetry for each.
func assertFieldsTelemetry(t *testing.T, serverTool inventory.ServerTool, client *github.Client, tool string, filteredArgs, unfilteredArgs map[string]any) {
t.Helper()
t.Run("filtered call records savings", func(t *testing.T) {
deps, rec := depsWithRecordingMetrics(t, BaseDeps{Client: client})
handler := serverTool.Handler(deps)
request := createMCPRequest(filteredArgs)
result, err := handler(ContextWithDeps(context.Background(), deps), &request)
require.NoError(t, err)
require.False(t, result.IsError)
assertFilteredCounters(t, rec, tool)
})
t.Run("unfiltered call records adoption only", func(t *testing.T) {
deps, rec := depsWithRecordingMetrics(t, BaseDeps{Client: client})
handler := serverTool.Handler(deps)
request := createMCPRequest(unfilteredArgs)
result, err := handler(ContextWithDeps(context.Background(), deps), &request)
require.NoError(t, err)
require.False(t, result.IsError)
call, ok := rec.increment(metricFieldsToolCall)
require.True(t, ok)
assert.Equal(t, "false", call.tags["filtered"])
_, ok = rec.counter(metricFieldsBytesFull)
assert.False(t, ok, "no byte counters when not filtered")
})
}