Skip to content

Commit 22b741b

Browse files
authored
Update GraphQL schema for github_organization table and remove projects_total_count column as per deprecation notice Closes #487 (#488)
1 parent ce957eb commit 22b741b

3 files changed

Lines changed: 12 additions & 21 deletions

File tree

github/models/organization.go

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,7 @@ type BasicOrganization struct {
1616

1717
type Organization struct {
1818
BasicOrganization
19-
Announcement string `graphql:"announcement @include(if:$includeAnnouncement)" json:"announcement"`
20-
AnnouncementExpiresAt NullableTime `graphql:"announcementExpiresAt @include(if:$includeAnnouncementExpiresAt)" json:"announcement_expires_at"`
21-
AnnouncementUserDismissible bool `graphql:"announcementUserDismissible @include(if:$includeAnnouncementUserDismissible)" json:"announcement_user_dismissible"`
19+
AnnouncementBanner AnnouncementBannerInfo `graphql:"announcementBanner @include(if:$includeAnnouncementBanner)" json:"announcement_banner"`
2220
AnyPinnableItems bool `graphql:"anyPinnableItems @include(if:$includeAnyPinnableItems)" json:"any_pinnable_items"`
2321
AvatarUrl string `graphql:"avatarUrl @include(if:$includeAvatarUrl)" json:"avatar_url"`
2422
EstimatedNextSponsorsPayoutInCents int `graphql:"estimatedNextSponsorsPayoutInCents @include(if:$includeEstimatedNextSponsorsPayoutInCents)" json:"estimated_next_sponsors_payout_in_cents"`
@@ -84,13 +82,19 @@ type OrganizationWithOwnerProperties struct {
8482
WebCommitSignoffRequired bool `json:"web_commit_signoff_required"`
8583
}
8684

85+
type AnnouncementBannerInfo struct {
86+
Message string `json:"message"`
87+
CreatedAt NullableTime `json:"created_at"`
88+
ExpiresAt NullableTime `json:"expires_at"`
89+
IsUserDismissible bool `json:"is_user_dismissible"`
90+
}
91+
8792
type OrganizationWithCounts struct {
8893
Organization
8994
MembersWithRole Count `graphql:"membersWithRole @include(if:$includeMembersWithRole)" json:"members_with_role"`
9095
Packages Count `graphql:"packages @include(if:$includePackages)" json:"packages"`
9196
PinnableItems Count `graphql:"pinnableItems @include(if:$includePinnableItems)" json:"pinnable_items"`
9297
PinnedItems Count `graphql:"pinnedItems @include(if:$includePinnedItems)" json:"pinned_items"`
93-
Projects Count `graphql:"projects @include(if:$includeProjects)" json:"projects"`
9498
ProjectsV2 Count `graphql:"projectsV2 @include(if:$includeProjectsV2)" json:"projects_v2"`
9599
Sponsoring Count `graphql:"sponsoring @include(if:$includeSponsoring)" json:"sponsoring"`
96100
Sponsors Count `graphql:"sponsors @include(if:$includeSponsors)" json:"sponsors"`

github/organization_utils.go

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -120,9 +120,7 @@ func extractOrgCollaboratorFromHydrateItem(h *plugin.HydrateData) (OrgCollaborat
120120
}
121121

122122
func appendOrganizationColumnIncludes(m *map[string]interface{}, cols []string) {
123-
(*m)["includeAnnouncement"] = githubv4.Boolean(slices.Contains(cols, "announcement"))
124-
(*m)["includeAnnouncementExpiresAt"] = githubv4.Boolean(slices.Contains(cols, "announcement_expires_at"))
125-
(*m)["includeAnnouncementUserDismissible"] = githubv4.Boolean(slices.Contains(cols, "announcement_user_dismissible"))
123+
(*m)["includeAnnouncementBanner"] = githubv4.Boolean(slices.Contains(cols, "announcement") || slices.Contains(cols, "announcement_expires_at") || slices.Contains(cols, "announcement_user_dismissible"))
126124
(*m)["includeAnyPinnableItems"] = githubv4.Boolean(slices.Contains(cols, "any_pinnable_items"))
127125
(*m)["includeAvatarUrl"] = githubv4.Boolean(slices.Contains(cols, "avatar_url"))
128126
(*m)["includeEstimatedNextSponsorsPayoutInCents"] = githubv4.Boolean(slices.Contains(cols, "estimated_next_sponsors_payout_in_cents"))
@@ -149,7 +147,6 @@ func appendOrganizationColumnIncludes(m *map[string]interface{}, cols []string)
149147
(*m)["includePackages"] = githubv4.Boolean(slices.Contains(cols, "packages_total_count"))
150148
(*m)["includePinnableItems"] = githubv4.Boolean(slices.Contains(cols, "pinnable_items_total_count"))
151149
(*m)["includePinnedItems"] = githubv4.Boolean(slices.Contains(cols, "pinned_items_total_count"))
152-
(*m)["includeProjects"] = githubv4.Boolean(slices.Contains(cols, "projects_total_count"))
153150
(*m)["includeProjectsV2"] = githubv4.Boolean(slices.Contains(cols, "projects_v2_total_count"))
154151
(*m)["includeSponsoring"] = githubv4.Boolean(slices.Contains(cols, "sponsoring_total_count"))
155152
(*m)["includeSponsors"] = githubv4.Boolean(slices.Contains(cols, "sponsors_total_count"))
@@ -191,15 +188,6 @@ func orgHydratePinnedItemsTotalCount(_ context.Context, _ *plugin.QueryData, h *
191188
}
192189
return org.PinnedItems.TotalCount, nil
193190
}
194-
195-
func orgHydrateProjectsTotalCount(_ context.Context, _ *plugin.QueryData, h *plugin.HydrateData) (interface{}, error) {
196-
org, err := extractOrganizationFromHydrateItem(h)
197-
if err != nil {
198-
return nil, err
199-
}
200-
return org.Projects.TotalCount, nil
201-
}
202-
203191
func orgHydrateProjectsV2TotalCount(_ context.Context, _ *plugin.QueryData, h *plugin.HydrateData) (interface{}, error) {
204192
org, err := extractOrganizationFromHydrateItem(h)
205193
if err != nil {
@@ -269,23 +257,23 @@ func orgHydrateAnnouncement(_ context.Context, _ *plugin.QueryData, h *plugin.Hy
269257
if err != nil {
270258
return nil, err
271259
}
272-
return org.Announcement, nil
260+
return org.AnnouncementBanner.Message, nil
273261
}
274262

275263
func orgHydrateAnnouncementExpiresAt(_ context.Context, _ *plugin.QueryData, h *plugin.HydrateData) (interface{}, error) {
276264
org, err := extractOrganizationFromHydrateItem(h)
277265
if err != nil {
278266
return nil, err
279267
}
280-
return org.AnnouncementExpiresAt, nil
268+
return org.AnnouncementBanner.ExpiresAt, nil
281269
}
282270

283271
func orgHydrateAnnouncementUserDismissible(_ context.Context, _ *plugin.QueryData, h *plugin.HydrateData) (interface{}, error) {
284272
org, err := extractOrganizationFromHydrateItem(h)
285273
if err != nil {
286274
return nil, err
287275
}
288-
return org.AnnouncementUserDismissible, nil
276+
return org.AnnouncementBanner.IsUserDismissible, nil
289277
}
290278

291279
func orgHydrateAnyPinnableItems(_ context.Context, _ *plugin.QueryData, h *plugin.HydrateData) (interface{}, error) {

github/table_github_organization.go

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,6 @@ func sharedOrganizationCountColumns() []*plugin.Column {
8686
{Name: "packages_total_count", Type: proto.ColumnType_INT, Hydrate: orgHydratePackagesTotalCount, Transform: transform.FromValue(), Description: "Count of packages within the organization."},
8787
{Name: "pinnable_items_total_count", Type: proto.ColumnType_INT, Hydrate: orgHydratePinnableItemsTotalCount, Transform: transform.FromValue(), Description: "Count of pinnable items within the organization."},
8888
{Name: "pinned_items_total_count", Type: proto.ColumnType_INT, Hydrate: orgHydratePinnedItemsTotalCount, Transform: transform.FromValue(), Description: "Count of itesm pinned to the organization's profile."},
89-
{Name: "projects_total_count", Type: proto.ColumnType_INT, Hydrate: orgHydrateProjectsTotalCount, Transform: transform.FromValue(), Description: "Count of projects within the organization."},
9089
{Name: "projects_v2_total_count", Type: proto.ColumnType_INT, Hydrate: orgHydrateProjectsV2TotalCount, Transform: transform.FromValue(), Description: "Count of V2 projects within the organization."},
9190
{Name: "repositories_total_count", Type: proto.ColumnType_INT, Hydrate: orgHydrateRepositoriesTotalCount, Transform: transform.FromValue(), Description: "Count of all repositories within the organization."},
9291
{Name: "sponsoring_total_count", Type: proto.ColumnType_INT, Hydrate: orgHydrateSponsoringTotalCount, Transform: transform.FromValue(), Description: "Count of users the organization is sponsoring."},

0 commit comments

Comments
 (0)