Function TestCopilotService_DownloadUserPeriodicMetrics

github/copilot_test.go:3411–3501

(t *testing.T)

}

func TestCopilotService_DownloadUserPeriodicMetrics(t *testing.T) {
	t.Parallel()
	client, mux, _ := setup(t)

	mux.HandleFunc("/path/to/users-periodic", func(w http.ResponseWriter, r *http.Request) {
		testMethod(t, r, "GET")
		fmt.Fprint(w, `{"report_start_day":"2026-03-05","report_end_day":"2026-04-01","day":"2026-03-05","user_id":1,"user_login":"alice","user_initiated_interaction_count":3,"used_copilot_code_review_active":true}
{"report_start_day":"2026-03-05","report_end_day":"2026-04-01","day":"2026-03-06","user_id":1,"user_login":"alice","used_cli":true,"used_copilot_code_review_passive":true,"used_copilot_coding_agent":true,"totals_by_cli":{"session_count":1,"request_count":3,"prompt_count":2,"token_usage":{"avg_tokens_per_request":1200.5,"output_tokens_sum":2400,"prompt_tokens_sum":1201}}}
`)
	})

	ctx := t.Context()
	url := client.baseURL.String() + "path/to/users-periodic"
	got, resp, err := client.Copilot.DownloadUserPeriodicMetrics(ctx, url)
	if err != nil {
		t.Errorf("Copilot.DownloadUserPeriodicMetrics returned error: %v", err)
	}
	if resp.StatusCode != http.StatusOK {
		t.Errorf("Copilot.DownloadUserPeriodicMetrics returned status code: %v", resp.StatusCode)
	}

	want := []*CopilotUserPeriodicMetrics{
		{
			ReportStartDay:                "2026-03-05",
			ReportEndDay:                  "2026-04-01",
			Day:                           "2026-03-05",
			UserID:                        1,
			UserLogin:                     "alice",
			UserInitiatedInteractionCount: Ptr(3),
			UsedCopilotCodeReviewActive:   Ptr(true),
		},
		{
			ReportStartDay:               "2026-03-05",
			ReportEndDay:                 "2026-04-01",
			Day:                          "2026-03-06",
			UserID:                       1,
			UserLogin:                    "alice",
			UsedCLI:                      Ptr(true),
			UsedCopilotCodeReviewPassive: Ptr(true),
			UsedCopilotCodingAgent:       Ptr(true),
			TotalsByCLI: &CopilotMetricsCLI{
				SessionCount: Ptr(1),
				RequestCount: Ptr(3),
				PromptCount:  Ptr(2),
				TokenUsage: &CopilotMetricsCLITokenUsage{
					AvgTokensPerRequest: Ptr(1200.5),
					OutputTokensSum:     Ptr(2400),
					PromptTokensSum:     Ptr(1201),
				},
			},
		},
	}

	if !cmp.Equal(got, want) {
		t.Errorf("Copilot.DownloadUserPeriodicMetrics returned %+v, want %+v", got, want)
	}

	// Empty body parses to a nil slice (no records).