Skip to content

Commit d00a650

Browse files
sawyer0x110sawyer0x110
committed
Add html_url to list_issues results
1 parent 2bd162a commit d00a650

3 files changed

Lines changed: 23 additions & 7 deletions

File tree

‎pkg/github/issues.go‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -484,6 +484,7 @@ type IssueFragment struct {
484484
Title githubv4.String
485485
Body githubv4.String
486486
State githubv4.String
487+
URL githubv4.URI `graphql:"url"`
487488
DatabaseID int64
488489

489490
Author struct {
@@ -620,6 +621,7 @@ type LegacyIssueFragment struct {
620621
Title githubv4.String
621622
Body githubv4.String
622623
State githubv4.String
624+
URL githubv4.URI `graphql:"url"`
623625
DatabaseID int64
624626

625627
Author struct {

‎pkg/github/issues_test.go‎

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1729,6 +1729,7 @@ func Test_ListIssues(t *testing.T) {
17291729
"title": "First Issue",
17301730
"body": "This is the first test issue",
17311731
"state": "OPEN",
1732+
"url": "https://github.com/owner/repo/issues/123",
17321733
"databaseId": 1001,
17331734
"createdAt": "2023-01-01T00:00:00Z",
17341735
"updatedAt": "2023-01-01T00:00:00Z",
@@ -1756,6 +1757,7 @@ func Test_ListIssues(t *testing.T) {
17561757
"title": "Second Issue",
17571758
"body": "This is the second test issue",
17581759
"state": "OPEN",
1760+
"url": "https://github.com/owner/repo/issues/456",
17591761
"databaseId": 1002,
17601762
"createdAt": "2023-02-01T00:00:00Z",
17611763
"updatedAt": "2023-02-01T00:00:00Z",
@@ -1797,6 +1799,7 @@ func Test_ListIssues(t *testing.T) {
17971799
"title": "Closed Issue",
17981800
"body": "This is a closed issue",
17991801
"state": "CLOSED",
1802+
"url": "https://github.com/owner/repo/issues/789",
18001803
"databaseId": 1003,
18011804
"createdAt": "2023-03-01T00:00:00Z",
18021805
"updatedAt": "2023-03-01T00:00:00Z",
@@ -1992,8 +1995,8 @@ func Test_ListIssues(t *testing.T) {
19921995

19931996
// Define the actual query strings that match the implementation
19941997
issueFieldValuesSelection := "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}}}"
1995-
qBasicNoLabels := "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}," + issueFieldValuesSelection + "},pageInfo{hasNextPage,hasPreviousPage,startCursor,endCursor},totalCount},isPrivate}}"
1996-
qWithLabels := "query($after:String$direction:OrderDirection!$first:Int!$issueFieldValues:[IssueFieldValueFilter!]!$labels:[String!]!$orderBy:IssueOrderField!$owner:String!$repo:String!$states:[IssueState!]!){repository(owner: $owner, name: $repo){issues(first: $first, after: $after, labels: $labels, 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}," + issueFieldValuesSelection + "},pageInfo{hasNextPage,hasPreviousPage,startCursor,endCursor},totalCount},isPrivate}}"
1998+
qBasicNoLabels := "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,url,databaseId,author{login},createdAt,updatedAt,labels(first: 100){nodes{name,id,description}},comments{totalCount}," + issueFieldValuesSelection + "},pageInfo{hasNextPage,hasPreviousPage,startCursor,endCursor},totalCount},isPrivate}}"
1999+
qWithLabels := "query($after:String$direction:OrderDirection!$first:Int!$issueFieldValues:[IssueFieldValueFilter!]!$labels:[String!]!$orderBy:IssueOrderField!$owner:String!$repo:String!$states:[IssueState!]!){repository(owner: $owner, name: $repo){issues(first: $first, after: $after, labels: $labels, states: $states, orderBy: {field: $orderBy, direction: $direction}, filterBy: {issueFieldValues: $issueFieldValues}){nodes{number,title,body,state,url,databaseId,author{login},createdAt,updatedAt,labels(first: 100){nodes{name,id,description}},comments{totalCount}," + issueFieldValuesSelection + "},pageInfo{hasNextPage,hasPreviousPage,startCursor,endCursor},totalCount},isPrivate}}"
19972000

19982001
for _, tc := range tests {
19992002
t.Run(tc.name, func(t *testing.T) {
@@ -2050,6 +2053,11 @@ func Test_ListIssues(t *testing.T) {
20502053
assert.False(t, response.PageInfo.HasPreviousPage)
20512054

20522055
// Verify that returned issues have expected structure
2056+
expectedHTMLURLs := map[int]string{
2057+
123: "https://github.com/owner/repo/issues/123",
2058+
456: "https://github.com/owner/repo/issues/456",
2059+
789: "https://github.com/owner/repo/issues/789",
2060+
}
20532061
for _, issue := range response.Issues {
20542062
assert.NotZero(t, issue.Number, "Issue should have number")
20552063
assert.NotEmpty(t, issue.Title, "Issue should have title")
@@ -2058,7 +2066,7 @@ func Test_ListIssues(t *testing.T) {
20582066
assert.NotEmpty(t, issue.UpdatedAt, "Issue should have updated_at")
20592067
assert.NotNil(t, issue.User, "Issue should have user")
20602068
assert.NotEmpty(t, issue.User.Login, "Issue user should have login")
2061-
assert.Empty(t, issue.HTMLURL, "html_url should be empty (not populated by GraphQL fragment)")
2069+
assert.Equal(t, expectedHTMLURLs[issue.Number], issue.HTMLURL)
20622070

20632071
// Labels should be flattened to name strings
20642072
for _, label := range issue.Labels {
@@ -2096,6 +2104,7 @@ func Test_ListIssues_FieldFilters(t *testing.T) {
20962104
"title": "An issue",
20972105
"body": "body",
20982106
"state": "OPEN",
2107+
"url": "https://github.com/owner/repo/issues/1",
20992108
"databaseId": 1,
21002109
"createdAt": "2026-01-01T00:00:00Z",
21012110
"updatedAt": "2026-01-01T00:00:00Z",
@@ -2176,8 +2185,8 @@ func Test_ListIssues_FieldFilters(t *testing.T) {
21762185
)
21772186
}
21782187

2179-
qNoLabels := "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},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}}}},pageInfo{hasNextPage,hasPreviousPage,startCursor,endCursor},totalCount},isPrivate}}"
2180-
qWithLabels := "query($after:String$direction:OrderDirection!$first:Int!$issueFieldValues:[IssueFieldValueFilter!]!$labels:[String!]!$orderBy:IssueOrderField!$owner:String!$repo:String!$states:[IssueState!]!){repository(owner: $owner, name: $repo){issues(first: $first, after: $after, labels: $labels, 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},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}}}},pageInfo{hasNextPage,hasPreviousPage,startCursor,endCursor},totalCount},isPrivate}}"
2188+
qNoLabels := "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,url,databaseId,author{login},createdAt,updatedAt,labels(first: 100){nodes{name,id,description}},comments{totalCount},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}}}},pageInfo{hasNextPage,hasPreviousPage,startCursor,endCursor},totalCount},isPrivate}}"
2189+
qWithLabels := "query($after:String$direction:OrderDirection!$first:Int!$issueFieldValues:[IssueFieldValueFilter!]!$labels:[String!]!$orderBy:IssueOrderField!$owner:String!$repo:String!$states:[IssueState!]!){repository(owner: $owner, name: $repo){issues(first: $first, after: $after, labels: $labels, states: $states, orderBy: {field: $orderBy, direction: $direction}, filterBy: {issueFieldValues: $issueFieldValues}){nodes{number,title,body,state,url,databaseId,author{login},createdAt,updatedAt,labels(first: 100){nodes{name,id,description}},comments{totalCount},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}}}},pageInfo{hasNextPage,hasPreviousPage,startCursor,endCursor},totalCount},isPrivate}}"
21812190

21822191
baseVars := func() map[string]any {
21832192
return map[string]any{
@@ -2509,6 +2518,7 @@ func Test_ListIssues_IFC_InsidersMode(t *testing.T) {
25092518
"title": "An issue",
25102519
"body": "body",
25112520
"state": "OPEN",
2521+
"url": "https://github.com/octocat/hello/issues/1",
25122522
"databaseId": 1,
25132523
"createdAt": "2023-01-01T00:00:00Z",
25142524
"updatedAt": "2023-01-01T00:00:00Z",
@@ -2538,7 +2548,7 @@ func Test_ListIssues_IFC_InsidersMode(t *testing.T) {
25382548
})
25392549
}
25402550

2541-
query := "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},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}}}},pageInfo{hasNextPage,hasPreviousPage,startCursor,endCursor},totalCount},isPrivate}}"
2551+
query := "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,url,databaseId,author{login},createdAt,updatedAt,labels(first: 100){nodes{name,id,description}},comments{totalCount},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}}}},pageInfo{hasNextPage,hasPreviousPage,startCursor,endCursor},totalCount},isPrivate}}"
25422552

25432553
vars := map[string]any{
25442554
"owner": "octocat",
@@ -2675,6 +2685,7 @@ func Test_LegacyListIssues_OmitsFieldValuesAndFilters(t *testing.T) {
26752685
"title": "Legacy issue",
26762686
"body": "body",
26772687
"state": "OPEN",
2688+
"url": "https://github.com/owner/repo/issues/7",
26782689
"databaseId": 7,
26792690
"createdAt": "2026-01-01T00:00:00Z",
26802691
"updatedAt": "2026-01-01T00:00:00Z",
@@ -2692,7 +2703,7 @@ func Test_LegacyListIssues_OmitsFieldValuesAndFilters(t *testing.T) {
26922703

26932704
// The legacy query must NOT reference issueFieldValues (neither in the selection
26942705
// set nor in filterBy). The matcher's query string therefore omits both.
2695-
const legacyQuery = "query($after:String$direction:OrderDirection!$first:Int!$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}){nodes{number,title,body,state,databaseId,author{login},createdAt,updatedAt,labels(first: 100){nodes{name,id,description}},comments{totalCount}},pageInfo{hasNextPage,hasPreviousPage,startCursor,endCursor},totalCount},isPrivate}}"
2706+
const legacyQuery = "query($after:String$direction:OrderDirection!$first:Int!$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}){nodes{number,title,body,state,url,databaseId,author{login},createdAt,updatedAt,labels(first: 100){nodes{name,id,description}},comments{totalCount}},pageInfo{hasNextPage,hasPreviousPage,startCursor,endCursor},totalCount},isPrivate}}"
26962707
vars := map[string]any{
26972708
"owner": "owner",
26982709
"repo": "repo",
@@ -2728,6 +2739,7 @@ func Test_LegacyListIssues_OmitsFieldValuesAndFilters(t *testing.T) {
27282739
require.NoError(t, json.Unmarshal([]byte(getTextResult(t, result).Text), &resp))
27292740
require.Len(t, resp.Issues, 1)
27302741
assert.Equal(t, 7, resp.Issues[0].Number)
2742+
assert.Equal(t, "https://github.com/owner/repo/issues/7", resp.Issues[0].HTMLURL)
27312743
assert.Nil(t, resp.Issues[0].FieldValues, "legacy list_issues must not return field_values")
27322744
}
27332745

‎pkg/github/minimal_types.go‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -560,6 +560,7 @@ func fragmentToMinimalIssue(fragment IssueFragment) MinimalIssue {
560560
Title: sanitize.Sanitize(string(fragment.Title)),
561561
Body: sanitize.Sanitize(string(fragment.Body)),
562562
State: string(fragment.State),
563+
HTMLURL: fragment.URL.String(),
563564
Comments: int(fragment.Comments.TotalCount),
564565
CreatedAt: fragment.CreatedAt.Format(time.RFC3339),
565566
UpdatedAt: fragment.UpdatedAt.Format(time.RFC3339),
@@ -637,6 +638,7 @@ func legacyFragmentToMinimalIssue(fragment LegacyIssueFragment) MinimalIssue {
637638
Title: sanitize.Sanitize(string(fragment.Title)),
638639
Body: sanitize.Sanitize(string(fragment.Body)),
639640
State: string(fragment.State),
641+
HTMLURL: fragment.URL.String(),
640642
Comments: int(fragment.Comments.TotalCount),
641643
CreatedAt: fragment.CreatedAt.Format(time.RFC3339),
642644
UpdatedAt: fragment.UpdatedAt.Format(time.RFC3339),

0 commit comments

Comments
 (0)