feat: add DownloadCopilotMetrics helper method and commented legacy metrics endpoints

Author: MasterOogway1466

github/copilot.go

@@ -10,6 +10,7 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	"net/http"
 	"time"
 )
 
@@ -491,6 +492,10 @@ func (s *CopilotService) GetSeatDetails(ctx context.Context, org, user string) (
 
 // GetEnterpriseMetrics gets Copilot usage metrics for an enterprise.
 //
+// Deprecated: Focus has shifted to the new Download Copilot Usage Metrics APIs.
+// These endpoints are kept around for GitHub Enterprise Server users, but are no longer supported on the Public GitHub service.
+// Use GetEnterpriseDailyMetricsReport or GetEnterpriseMetricsReport instead.
+//
 // GitHub API docs: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise
 //
 //meta:operation GET /enterprises/{enterprise}/copilot/metrics
@@ -517,6 +522,9 @@ func (s *CopilotService) GetEnterpriseMetrics(ctx context.Context, enterprise st
 
 // GetEnterpriseTeamMetrics gets Copilot usage metrics for an enterprise team.
 //
+// Deprecated: Focus has shifted to the new Download Copilot Usage Metrics APIs.
+// These endpoints are kept around for GitHub Enterprise Server users, but are no longer supported on the Public GitHub service.
+//
 // GitHub API docs: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team
 //
 //meta:operation GET /enterprises/{enterprise}/team/{team_slug}/copilot/metrics
@@ -543,6 +551,10 @@ func (s *CopilotService) GetEnterpriseTeamMetrics(ctx context.Context, enterpris
 
 // GetOrganizationMetrics gets Copilot usage metrics for an organization.
 //
+// Deprecated: Focus has shifted to the new Download Copilot Usage Metrics APIs.
+// These endpoints are kept around for GitHub Enterprise Server users, but are no longer supported on the Public GitHub service.
+// Use GetOrganizationDailyMetricsReport or GetOrganizationMetricsReport instead.
+//
 // GitHub API docs: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization
 //
 //meta:operation GET /orgs/{org}/copilot/metrics
@@ -569,6 +581,9 @@ func (s *CopilotService) GetOrganizationMetrics(ctx context.Context, org string,
 
 // GetOrganizationTeamMetrics gets Copilot usage metrics for an organization team.
 //
+// Deprecated: Focus has shifted to the new Download Copilot Usage Metrics APIs.
+// These endpoints are kept around for GitHub Enterprise Server users, but are no longer supported on the Public GitHub service.
+//
 // GitHub API docs: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team
 //
 //meta:operation GET /orgs/{org}/team/{team_slug}/copilot/metrics
@@ -784,3 +799,32 @@ func (s *CopilotService) GetOrganizationUsersMetricsReport(ctx context.Context,
 
 	return report, resp, nil
 }
+
+// DownloadCopilotMetrics downloads a Copilot metrics report from the provided download link
+// and returns the metric data. This can be used to download metrics from a link returned by
+// GetEnterpriseDailyMetricsReport, GetEnterpriseMetricsReport, GetEnterpriseUsersDailyMetricsReport,
+// GetEnterpriseUsersMetricsReport, GetOrganizationDailyMetricsReport, GetOrganizationMetricsReport,
+// GetOrganizationUsersDailyMetricsReport, GetOrganizationUsersMetricsReport.
+func (s *CopilotService) DownloadCopilotMetrics(ctx context.Context, url string) ([]*CopilotMetrics, *Response, error) {
+	req, err := http.NewRequestWithContext(ctx, "GET", url, nil)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	resp, err := s.client.client.Do(req)
+	if err != nil {
+		return nil, nil, err
+	}
+	defer resp.Body.Close()
+
+	if err := CheckResponse(resp); err != nil {
+		return nil, newResponse(resp), err
+	}
+
+	var metrics []*CopilotMetrics
+	if err := json.NewDecoder(resp.Body).Decode(&metrics); err != nil {
+		return nil, newResponse(resp), err
+	}
+
+	return metrics, newResponse(resp), nil
+}

github/copilot_test.go

@@ -2778,3 +2778,113 @@ func TestCopilotService_GetOrganizationUsersMetricsReport(t *testing.T) {
 		return resp, err
 	})
 }
+
+func TestCopilotService_DownloadCopilotMetrics(t *testing.T) {
+	t.Parallel()
+	client, mux, _ := setup(t)
+
+	mux.HandleFunc("/path/to/download", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "GET")
+		fmt.Fprint(w, `[{
+			"date": "2023-01-01",
+			"total_active_users": 100,
+			"total_engaged_users": 50,
+			"copilot_ide_code_completions": {
+				"total_engaged_users": 50,
+				"languages": [
+					{
+						"name": "go",
+						"total_engaged_users": 10
+					}
+				],
+				"editors": [
+					{
+						"name": "vscode",
+						"total_engaged_users": 10,
+						"models": [
+							{
+								"name": "model1",
+								"is_custom_model": false,
+								"custom_model_training_date": null,
+								"total_engaged_users": 10,
+								"languages": [
+									{
+										"name": "go",
+										"total_engaged_users": 10,
+										"total_code_suggestions": 100,
+										"total_code_acceptances": 50,
+										"total_code_lines_suggested": 1000,
+										"total_code_lines_accepted": 500
+									}
+								]
+							}
+						]
+					}
+				]
+			}
+		}]`)
+	})
+
+	ctx := t.Context()
+	url := client.BaseURL.String() + "path/to/download"
+	got, _, err := client.Copilot.DownloadCopilotMetrics(ctx, url)
+	if err != nil {
+		t.Errorf("Copilot.DownloadCopilotMetrics returned error: %v", err)
+	}
+
+	want := []*CopilotMetrics{
+		{
+			Date:              "2023-01-01",
+			TotalActiveUsers:  Ptr(100),
+			TotalEngagedUsers: Ptr(50),
+			CopilotIDECodeCompletions: &CopilotIDECodeCompletions{
+				TotalEngagedUsers: 50,
+				Languages: []*CopilotIDECodeCompletionsLanguage{
+					{
+						Name:              "go",
+						TotalEngagedUsers: 10,
+					},
+				},
+				Editors: []*CopilotIDECodeCompletionsEditor{
+					{
+						Name:              "vscode",
+						TotalEngagedUsers: 10,
+						Models: []*CopilotIDECodeCompletionsModel{
+							{
+								Name:              "model1",
+								IsCustomModel:     false,
+								TotalEngagedUsers: 10,
+								Languages: []*CopilotIDECodeCompletionsModelLanguage{
+									{
+										Name:                    "go",
+										TotalEngagedUsers:       10,
+										TotalCodeSuggestions:    100,
+										TotalCodeAcceptances:    50,
+										TotalCodeLinesSuggested: 1000,
+										TotalCodeLinesAccepted:  500,
+									},
+								},
+							},
+						},
+					},
+				},
+			},
+		},
+	}
+
+	if !cmp.Equal(got, want) {
+		t.Errorf("Copilot.DownloadCopilotMetrics returned %+v, want %+v", got, want)
+	}
+
+	// Test unexpected status code
+	mux.HandleFunc("/path/to/download/error", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "GET")
+		w.WriteHeader(http.StatusNotFound)
+	})
+
+	urlErr := client.BaseURL.String() + "path/to/download/error"
+	_, _, err = client.Copilot.DownloadCopilotMetrics(ctx, urlErr)
+	if err == nil {
+		t.Errorf("Copilot.DownloadCopilotMetrics expected error but got none")
+	}
+}