Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -885,6 +885,7 @@ The following sets of tools are available:
- **Required OAuth Scopes**: `repo`
- `after`: Cursor for pagination. Use the endCursor from the previous page's PageInfo for GraphQL APIs. (string, optional)
- `direction`: Order direction. If provided, the 'orderBy' also needs to be provided. (string, optional)
- `field_filters`: Filter by custom issue field values. Each entry takes a field_name and a value; the server looks up the field and coerces the value to its type (single-select option name, text, number, or YYYY-MM-DD date). (object[], optional)
- `labels`: Filter by labels (string[], optional)
- `orderBy`: Order issues by field. If provided, the 'direction' also needs to be provided. (string, optional)
- `owner`: Repository owner (string, required)
Expand Down
21 changes: 21 additions & 0 deletions pkg/github/__toolsnaps__/list_issues.snap
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,27 @@
],
"type": "string"
},
"field_filters": {
"description": "Filter by custom issue field values. Each entry takes a field_name and a value; the server looks up the field and coerces the value to its type (single-select option name, text, number, or YYYY-MM-DD date).",
"items": {
"properties": {
"field_name": {
"description": "Name of the custom field (e.g. \"Priority\"). Case-insensitive.",
"type": "string"
},
"value": {
"description": "Value to filter on. For single-select fields, the option name (e.g. \"P1\"). For dates, YYYY-MM-DD. For numbers, the numeric value as a string. For text, the text value.",
"type": "string"
}
},
"required": [
"field_name",
"value"
],
"type": "object"
},
"type": "array"
},
"labels": {
"description": "Filter by labels",
"items": {
Expand Down
163 changes: 88 additions & 75 deletions pkg/github/issue_fields.go
Original file line number Diff line number Diff line change
Expand Up @@ -136,81 +136,9 @@ func ListIssueFields(t translations.TranslationHelperFunc) inventory.ServerTool
return utils.NewToolResultErrorFromErr("failed to get GitHub GraphQL client", err), nil, nil
}

ctxWithFeatures := ghcontext.WithGraphQLFeatures(ctx, "issue_fields", "repo_issue_fields")
var nodes []issueFieldNode
if repo != "" {
var query issueFieldsRepoQuery
vars := map[string]any{
"owner": githubv4.String(owner),
"name": githubv4.String(repo),
}
if err := gqlClient.Query(ctxWithFeatures, &query, vars); err != nil {
return ghErrors.NewGitHubGraphQLErrorResponse(ctx, "failed to list issue fields", err), nil, nil
}
nodes = query.Repository.IssueFields.Nodes
} else {
var query issueFieldsOrgQuery
vars := map[string]any{
"login": githubv4.String(owner),
}
if err := gqlClient.Query(ctxWithFeatures, &query, vars); err != nil {
return ghErrors.NewGitHubGraphQLErrorResponse(ctx, "failed to list issue fields", err), nil, nil
}
nodes = query.Organization.IssueFields.Nodes
}

fields := make([]IssueField, 0, len(nodes))
for _, node := range nodes {
var f IssueField
// Read from the fragment matching __typename; the other fragments are zero-valued.
switch string(node.TypeName) {
case "IssueFieldSingleSelect":
opts := make([]IssueSingleSelectFieldOption, 0, len(node.IssueFieldSingleSelect.Options))
for _, o := range node.IssueFieldSingleSelect.Options {
opts = append(opts, IssueSingleSelectFieldOption{
ID: fmt.Sprintf("%v", o.ID),
Name: string(o.Name),
Description: string(o.Description),
Color: string(o.Color),
Priority: o.Priority,
})
}
f = IssueField{
ID: fmt.Sprintf("%v", node.IssueFieldSingleSelect.ID),
Name: string(node.IssueFieldSingleSelect.Name),
Description: string(node.IssueFieldSingleSelect.Description),
DataType: string(node.IssueFieldSingleSelect.DataType),
Visibility: string(node.IssueFieldSingleSelect.Visibility),
Options: opts,
}
case "IssueFieldText":
f = IssueField{
ID: fmt.Sprintf("%v", node.IssueFieldText.ID),
Name: string(node.IssueFieldText.Name),
Description: string(node.IssueFieldText.Description),
DataType: string(node.IssueFieldText.DataType),
Visibility: string(node.IssueFieldText.Visibility),
}
case "IssueFieldNumber":
f = IssueField{
ID: fmt.Sprintf("%v", node.IssueFieldNumber.ID),
Name: string(node.IssueFieldNumber.Name),
Description: string(node.IssueFieldNumber.Description),
DataType: string(node.IssueFieldNumber.DataType),
Visibility: string(node.IssueFieldNumber.Visibility),
}
case "IssueFieldDate":
f = IssueField{
ID: fmt.Sprintf("%v", node.IssueFieldDate.ID),
Name: string(node.IssueFieldDate.Name),
Description: string(node.IssueFieldDate.Description),
DataType: string(node.IssueFieldDate.DataType),
Visibility: string(node.IssueFieldDate.Visibility),
}
default:
continue
}
fields = append(fields, f)
fields, err := fetchIssueFields(ctx, gqlClient, owner, repo)
if err != nil {
return ghErrors.NewGitHubGraphQLErrorResponse(ctx, "failed to list issue fields", err), nil, nil
}

r, err := json.Marshal(fields)
Expand All @@ -221,3 +149,88 @@ func ListIssueFields(t translations.TranslationHelperFunc) inventory.ServerTool
return utils.NewToolResultText(string(r)), nil, nil
})
}

// fetchIssueFields returns the issue field definitions for the given owner.
// If repo is provided, fields are scoped to that repository (inherited from its
// organization); otherwise fields are returned directly from the organization.
func fetchIssueFields(ctx context.Context, gqlClient *githubv4.Client, owner, repo string) ([]IssueField, error) {
ctxWithFeatures := ghcontext.WithGraphQLFeatures(ctx, "issue_fields", "repo_issue_fields")
if repo != "" {
var query issueFieldsRepoQuery
vars := map[string]any{
"owner": githubv4.String(owner),
"name": githubv4.String(repo),
}
if err := gqlClient.Query(ctxWithFeatures, &query, vars); err != nil {
return nil, err
}
return issueFieldsFromNodes(query.Repository.IssueFields.Nodes), nil
}

var query issueFieldsOrgQuery
vars := map[string]any{
"login": githubv4.String(owner),
}
if err := gqlClient.Query(ctxWithFeatures, &query, vars); err != nil {
return nil, err
}
return issueFieldsFromNodes(query.Organization.IssueFields.Nodes), nil
}

// issueFieldsFromNodes converts GraphQL issue field union nodes into IssueField values.
// Read from the fragment matching __typename; the other fragments are zero-valued.
func issueFieldsFromNodes(nodes []issueFieldNode) []IssueField {
fields := make([]IssueField, 0, len(nodes))
for _, node := range nodes {
var f IssueField
switch string(node.TypeName) {
case "IssueFieldSingleSelect":
opts := make([]IssueSingleSelectFieldOption, 0, len(node.IssueFieldSingleSelect.Options))
for _, o := range node.IssueFieldSingleSelect.Options {
opts = append(opts, IssueSingleSelectFieldOption{
ID: fmt.Sprintf("%v", o.ID),
Name: string(o.Name),
Description: string(o.Description),
Color: string(o.Color),
Priority: o.Priority,
})
}
f = IssueField{
ID: fmt.Sprintf("%v", node.IssueFieldSingleSelect.ID),
Name: string(node.IssueFieldSingleSelect.Name),
Description: string(node.IssueFieldSingleSelect.Description),
DataType: string(node.IssueFieldSingleSelect.DataType),
Visibility: string(node.IssueFieldSingleSelect.Visibility),
Options: opts,
}
case "IssueFieldText":
f = IssueField{
ID: fmt.Sprintf("%v", node.IssueFieldText.ID),
Name: string(node.IssueFieldText.Name),
Description: string(node.IssueFieldText.Description),
DataType: string(node.IssueFieldText.DataType),
Visibility: string(node.IssueFieldText.Visibility),
}
case "IssueFieldNumber":
f = IssueField{
ID: fmt.Sprintf("%v", node.IssueFieldNumber.ID),
Name: string(node.IssueFieldNumber.Name),
Description: string(node.IssueFieldNumber.Description),
DataType: string(node.IssueFieldNumber.DataType),
Visibility: string(node.IssueFieldNumber.Visibility),
}
case "IssueFieldDate":
f = IssueField{
ID: fmt.Sprintf("%v", node.IssueFieldDate.ID),
Name: string(node.IssueFieldDate.Name),
Description: string(node.IssueFieldDate.Description),
DataType: string(node.IssueFieldDate.DataType),
Visibility: string(node.IssueFieldDate.Visibility),
}
default:
continue
}
fields = append(fields, f)
}
return fields
}
Loading
Loading