Improve "TEAMS" Dashboard Tab: Optimize Metrics Retrieval Based on GitHub Enterprise Type #272

liguori · 2025-09-19T23:36:34Z

This pull request adds support for distinguishing between "Full GitHub Enterprises" and "Copilot Business Only" enterprises, enabling more accurate team retrieval and metrics for each enterprise type. The change introduces a new enterpriseType option throughout the configuration, API, and model layers, updates documentation, and provides comprehensive tests for the new logic.

Enterprise Type Support and API Logic:

Added NUXT_PUBLIC_ENTERPRISE_TYPE environment variable and propagated its usage throughout the codebase to distinguish between full and copilot-only enterprise types, affecting how teams and metrics are retrieved. (.env, nuxt.config.ts, [1] [2]
Updated Options model to include enterpriseType, with serialization, deserialization, and merging logic, and modified API URL construction to support both enterprise types for team and enterprise scopes. (app/model/Options.ts, [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14]

Backend Team Retrieval Logic:

Enhanced the teams API handler to use GraphQL for enumerating organizations and fetching teams for full enterprises, while maintaining existing logic for copilot-only enterprises and organizations. (server/api/teams.ts, [1] [2] [3] [4]

Documentation Updates:

Updated deployment and README documentation to explain the new enterprise type configuration, usage, and behavioral differences for team retrieval and metrics. (DEPLOYMENT.md, [1]; README.md, [2]

Testing:

Added comprehensive tests for Options enterprise type handling, including serialization, merging, API URL logic, and error cases. (tests/enterprise-type.spec.ts, tests/enterprise-type.spec.tsR1-R122)

@karpikpl as discussed this is a first implementation created with the help of Coding Agent and tested by myself in a Codespaces, should start to address #271, please verify it.

NOTE: A new scope is required for the GitHub Token (read:org)

Co-authored-by: liguori <[email protected]>

…d of REST API Co-authored-by: liguori <[email protected]>

…rprises Co-authored-by: liguori <[email protected]>

Add GitHub Enterprise type support for TEAMS tab functionality

Copilot

Pull Request Overview

This PR introduces support for distinguishing between "Full GitHub Enterprises" and "Copilot Business Only" enterprises to optimize team retrieval and metrics access. The implementation adds a new enterpriseType configuration option that affects how teams are fetched - using GraphQL to enumerate organizations for full enterprises versus using enterprise-level APIs for copilot-only enterprises.

Key changes include:

Added enterpriseType configuration with values full or copilot-only (defaulting to copilot-only for backward compatibility)
Enhanced team retrieval logic to use GraphQL for full enterprises and existing enterprise APIs for copilot-only
Updated API URL construction to handle different enterprise types appropriately

Reviewed Changes

Copilot reviewed 7 out of 8 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
`tests/enterprise-type.spec.ts`	Comprehensive test suite covering enterprise type handling, serialization, and API URL generation
`server/api/teams.ts`	Enhanced teams API with GraphQL support for full enterprises and organization enumeration
`nuxt.config.ts`	Added default `enterpriseType` configuration
`app/model/Options.ts`	Extended Options class with enterprise type support and API URL logic
`README.md`	Updated documentation explaining enterprise type differences
`DEPLOYMENT.md`	Added deployment examples for both enterprise types
`.env`	Added environment variable configuration for enterprise type

Copilot · 2025-09-20T19:01:00Z

server/api/teams.ts

+        logger.info(`Fetching organizations for full enterprise ${options.githubEnt} using GraphQL`)
+
+        const graphqlQuery = {
+            query: `query { enterprise(slug: "${options.githubEnt}") { organizations(first: 100) { nodes { login name url } } } }`


Direct string interpolation in GraphQL query creates a potential injection vulnerability. The enterprise slug should be properly escaped or parameterized to prevent GraphQL injection attacks.

Suggested change

query: `query { enterprise(slug: "${options.githubEnt}") { organizations(first: 100) { nodes { login name url } } } }`

query: `query($slug: String!) { enterprise(slug: $slug) { organizations(first: 100) { nodes { login name url } } } }`,

variables: { slug: options.githubEnt }

Copilot · 2025-09-20T19:01:00Z

server/api/teams.ts

+        const graphqlQuery = {
+            query: `query { enterprise(slug: "${options.githubEnt}") { organizations(first: 100) { nodes { login name url } } } }`
+        }
+
+        const graphqlResponse = await $fetch<GraphQLResponse>('https://api.github.com/graphql', {
+            method: 'POST',
+            headers: event.context.headers,
+            body: JSON.stringify(graphqlQuery)
        })
-
-        const data = res._data as GitHubTeam[]
-        for (const t of data) {
-            const name: string = t.name
-            const slug: string = t.slug
-            const description: string = t.description || ''
-            if (name && slug) allTeams.push({ name, slug, description })
+
+        const organizations = graphqlResponse.data.enterprise.organizations.nodes
+        logger.info(`Found ${organizations.length} organizations in enterprise`)
+


The hardcoded limit of 100 organizations could be problematic for large enterprises. Consider implementing pagination or making this configurable to handle enterprises with more than 100 organizations.

Suggested change

const graphqlQuery = {

query: `query { enterprise(slug: "${options.githubEnt}") { organizations(first: 100) { nodes { login name url } } } }`

}

const graphqlResponse = await $fetch<GraphQLResponse>('https://api.github.com/graphql', {

method: 'POST',

headers: event.context.headers,

body: JSON.stringify(graphqlQuery)

})

const data = res._data as GitHubTeam[]

for (const t of data) {

const name: string = t.name

const slug: string = t.slug

const description: string = t.description || ''

if (name && slug) allTeams.push({ name, slug, description })

const organizations = graphqlResponse.data.enterprise.organizations.nodes

logger.info(`Found ${organizations.length} organizations in enterprise`)

// Paginate through all organizations in the enterprise

let organizations: GraphQLOrganization[] = [];

let hasNextPage = true;

let endCursor: string | null = null;

while (hasNextPage) {

const graphqlQuery = {

query: `query {

enterprise(slug: "${options.githubEnt}") {

organizations(first: 100${endCursor ? `, after: "${endCursor}"` : ''}) {

nodes { login name url }

pageInfo { hasNextPage endCursor }

}

}

}`

};

const graphqlResponse = await $fetch<any>('https://api.github.com/graphql', {

method: 'POST',

headers: event.context.headers,

body: JSON.stringify(graphqlQuery)

});

const orgs = graphqlResponse.data.enterprise.organizations.nodes;

organizations = organizations.concat(orgs);

const pageInfo = graphqlResponse.data.enterprise.organizations.pageInfo;

hasNextPage = pageInfo.hasNextPage;

endCursor = pageInfo.endCursor;

}

logger.info(`Found ${organizations.length} organizations in enterprise`);

Copilot · 2025-09-20T19:01:01Z

app/model/Options.ts

+                    const teamParts = this.githubTeam.split(' - ');
+                    if (teamParts.length >= 2) {
+                        const orgName = teamParts[0];
+                        const teamName = teamParts[1];


The team slug parsing logic uses teamParts.length >= 2 but only extracts the first two parts. If a team name contains ' - ', this could lead to incorrect parsing. Consider using a more robust parsing approach like split(' - ', 2) or joining remaining parts for the team name.

Suggested change

const teamParts = this.githubTeam.split(' - ');

if (teamParts.length >= 2) {

const orgName = teamParts[0];

const teamName = teamParts[1];

const separator = ' - ';

const sepIndex = this.githubTeam.indexOf(separator);

if (sepIndex > 0) {

const orgName = this.githubTeam.substring(0, sepIndex);

const teamName = this.githubTeam.substring(sepIndex + separator.length);

karpikpl · 2025-09-30T20:32:30Z

nuxt.config.ts

      githubOrg: '',
      githubEnt: '',
      githubTeam: '',
+      enterpriseType: 'copilot-only',  // can be overridden by NUXT_PUBLIC_ENTERPRISE_TYPE environment variable


I think default should be 'full'

I agree too, but i left like it in order to have the same behavior as the current implementation. Anyway, this new flag could be documented for deployment.

karpikpl · 2025-09-30T21:11:58Z

app/model/Options.ts

+                        const teamName = teamParts[1];
+                        url = `${baseUrl}/orgs/${orgName}/team/${teamName}/copilot/metrics`;
+                    } else {
+                        throw new Error('Team slug must be in format "org-name - team-name" for full enterprise scope');


@liguori are you sure team slug is going to be in this format?

No i think here it was Copilot Agent mistake, I didn't have chance to review it. This code must be tested with all the combinations.

Copilot AI and others added 7 commits September 19, 2025 21:40

Initial plan

c0ad00b

Initial analysis and plan for enterprise type support in TEAMS tab

f61b4ac

Co-authored-by: liguori <[email protected]>

Implement enterprise type support for TEAMS tab

45be598

Co-authored-by: liguori <[email protected]>

Add documentation for enterprise type configuration

3197fd7

Co-authored-by: liguori <[email protected]>

Fix organization retrieval for full enterprises to use GraphQL instea…

e5a6a7a

…d of REST API Co-authored-by: liguori <[email protected]>

Fix Authorization header forwarding in GraphQL requests for full ente…

02e5fe3

…rprises Co-authored-by: liguori <[email protected]>

Merge pull request #2 from liguori/copilot/fix-1

720e7df

Add GitHub Enterprise type support for TEAMS tab functionality

karpikpl requested a review from Copilot September 20, 2025 19:00

Copilot AI reviewed Sep 20, 2025

View reviewed changes

karpikpl reviewed Sep 30, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Improve "TEAMS" Dashboard Tab: Optimize Metrics Retrieval Based on GitHub Enterprise Type #272

Improve "TEAMS" Dashboard Tab: Optimize Metrics Retrieval Based on GitHub Enterprise Type #272

liguori commented Sep 19, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Sep 20, 2025

Uh oh!

Copilot AI Sep 20, 2025

Uh oh!

Copilot AI Sep 20, 2025

Uh oh!

karpikpl Sep 30, 2025

Uh oh!

liguori Oct 3, 2025

Uh oh!

karpikpl Sep 30, 2025

Uh oh!

liguori Oct 3, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	query: `query { enterprise(slug: "${options.githubEnt}") { organizations(first: 100) { nodes { login name url } } } }`
	query: `query($slug: String!) { enterprise(slug: $slug) { organizations(first: 100) { nodes { login name url } } } }`,
	variables: { slug: options.githubEnt }

-                    const teamParts = this.githubTeam.split(' - ');
-                    if (teamParts.length >= 2) {
-                        const orgName = teamParts[0];
-                        const teamName = teamParts[1];
+                    const separator = ' - ';
+                    const sepIndex = this.githubTeam.indexOf(separator);
+                    if (sepIndex > 0) {
+                        const orgName = this.githubTeam.substring(0, sepIndex);
+                        const teamName = this.githubTeam.substring(sepIndex + separator.length);

Improve "TEAMS" Dashboard Tab: Optimize Metrics Retrieval Based on GitHub Enterprise Type #272

Are you sure you want to change the base?

Improve "TEAMS" Dashboard Tab: Optimize Metrics Retrieval Based on GitHub Enterprise Type #272

Conversation

liguori commented Sep 19, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 20, 2025

Choose a reason for hiding this comment

Uh oh!

karpikpl Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

liguori Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

karpikpl Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

liguori Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants