Skip to content

fix: add DatabaseID to parent team GraphQL query to eliminate N+1 REST calls #3384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yoshi-taka wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −17
Open

fix: add DatabaseID to parent team GraphQL query to eliminate N+1 REST calls #3384

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 8 additions & 14 deletions github/data_source_github_organization_teams.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import (
"context"
"strconv"

"github.com/google/go-github/v85/github"
"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
Expand Down Expand Up @@ -98,7 +97,6 @@ func dataSourceGithubOrganizationTeamsRead(ctx context.Context, d *schema.Resour
return diag.FromErr(err)
}

clientv3 := meta.(*Owner).v3client
client := meta.(*Owner).v4client
orgName := meta.(*Owner).name
rootTeamsOnly := d.Get("root_teams_only").(bool)
Expand All @@ -122,7 +120,7 @@ func dataSourceGithubOrganizationTeamsRead(ctx context.Context, d *schema.Resour
return diag.FromErr(err)
}

additionalTeams, err := flattenGitHubTeams(clientv3, meta.(*Owner).StopContext, orgName, query)
+ additionalTeams, err := flattenGitHubTeams(query)
if err != nil {
return diag.FromErr(err)
}
Expand All @@ -143,7 +141,7 @@ func dataSourceGithubOrganizationTeamsRead(ctx context.Context, d *schema.Resour
return nil
}

func flattenGitHubTeams(client *github.Client, ctx context.Context, org string, tq TeamsQuery) ([]any, error) {
func flattenGitHubTeams(tq TeamsQuery) ([]any, error) {
teams := tq.Organization.Teams.Nodes

if len(teams) == 0 {
Expand Down Expand Up @@ -171,21 +169,17 @@ func flattenGitHubTeams(client *github.Client, ctx context.Context, org string,
t["members"] = flatMembers

var parentTeamId string
if len(team.Parent.Slug) != 0 {
parentTeam, _, err := client.Teams.GetTeamBySlug(ctx, org, string(team.Parent.Slug))
if err != nil {
return nil, err
}
parentTeamId = strconv.FormatInt(parentTeam.GetID(), 10)
}

t["parent_team_id"] = parentTeamId
t["parent_team_slug"] = team.Parent.Slug

parentTeam := make(map[string]any)
if team.Parent.DatabaseID != 0 {
parentTeamId = strconv.FormatInt(int64(team.Parent.DatabaseID), 10)
}
parentTeam["id"] = team.Parent.ID
parentTeam["slug"] = team.Parent.Slug
parentTeam["name"] = team.Parent.Name

t["parent_team_id"] = parentTeamId
t["parent_team_slug"] = team.Parent.Slug
t["parent"] = parentTeam

repositories := team.Repositories.Nodes
Expand Down
7 changes: 4 additions & 3 deletions github/util_v4_teams.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,10 @@ type TeamsQuery struct {
Description githubv4.String
Privacy githubv4.String
Parent struct {
ID githubv4.String
Slug githubv4.String
Name githubv4.String
ID githubv4.String
DatabaseID githubv4.Int
Slug githubv4.String
Name githubv4.String
} `graphql:"parentTeam"`
Members struct {
Nodes []struct {
Expand Down