test: add comprehensive tests for GitHub data fetching and scoring algorithms

Author: O2sa

test/api/compare.route.test.ts

@@ -0,0 +1,158 @@
+import { beforeEach, describe, expect, test, vi } from "vitest";
+import { GitHubApiError } from "@/lib/github-graphql-client";
+
+const mocks = vi.hoisted(() => ({
+  fetchGitHubUserData: vi.fn(),
+  calculateUserScore: vi.fn(),
+}));
+
+vi.mock("@/lib/github", () => ({
+  fetchGitHubUserData: mocks.fetchGitHubUserData,
+}));
+
+vi.mock("@/lib/score", () => ({
+  calculateUserScore: mocks.calculateUserScore,
+}));
+
+import { GET } from "@/app/api/compare/route";
+
+function makeRequest(params: Record<string, string | string[]>): Request {
+  const search = new URLSearchParams();
+  for (const [key, value] of Object.entries(params)) {
+    if (Array.isArray(value)) {
+      for (const item of value) {
+        search.append(key, item);
+      }
+    } else {
+      search.append(key, value);
+    }
+  }
+
+  return new Request(`http://localhost/api/compare?${search.toString()}`, {
+    method: "GET",
+  });
+}
+
+function makeScore(finalScore: number) {
+  return {
+    repoScore: 10,
+    prScore: 20,
+    contributionScore: 3,
+    finalScore,
+    normalizedRepoScore: 30,
+    normalizedPRScore: 40,
+    normalizedContributionScore: 5,
+    normalizedFinalScore: 35,
+    topRepos: [],
+    topPullRequests: [],
+    topCommunityContributions: [],
+    languageScores: undefined,
+    signals: {
+      reposAnalyzed: 1,
+      pullRequestsAnalyzed: 1,
+      mergedExternalPRs: 1,
+      ownRepoPRsIgnored: 0,
+      unmergedPRsIgnored: 0,
+      uniqueExternalPRRepos: 1,
+      issuesAnalyzed: 0,
+      externalIssuesCounted: 0,
+      discussionsAnalyzed: 0,
+      externalDiscussionsCounted: 0,
+    },
+    explanations: {
+      repo: [],
+      pr: [],
+      contribution: [],
+      overall: [],
+    },
+  };
+}
+
+describe("GET /api/compare", () => {
+  beforeEach(() => {
+    mocks.fetchGitHubUserData.mockReset();
+    mocks.calculateUserScore.mockReset();
+  });
+
+  test("returns structured friendly error when GitHub rate limit is hit", async () => {
+    mocks.fetchGitHubUserData.mockRejectedValueOnce(
+      new GitHubApiError({
+        message: "API rate limit exceeded for user.",
+        kind: "PRIMARY_RATE_LIMIT",
+        status: 200,
+        rateLimit: {
+          limit: 5000,
+          remaining: 0,
+          used: 5000,
+          resetAt: Math.floor(Date.now() / 1000) + 60,
+          resource: "graphql",
+        },
+        retryAfterMs: 60_000,
+      }),
+    );
+
+    const response = await GET(
+      makeRequest({
+        username: ["user-a", "user-b"],
+      }),
+    );
+    const body = (await response.json()) as {
+      success: boolean;
+      error?: string;
+      errorDetails?: { code?: string; retryAfterSeconds?: number };
+    };
+
+    expect(response.status).toBe(429);
+    expect(body.success).toBe(false);
+    expect(body.errorDetails?.code).toBe("RATE_LIMITED");
+    expect(body.errorDetails?.retryAfterSeconds).toBe(60);
+  });
+
+  test("returns success payload when both users are processed", async () => {
+    mocks.fetchGitHubUserData.mockResolvedValueOnce({
+      name: "User A",
+      avatarUrl: "https://example.com/a.png",
+      repos: [],
+      pullRequests: [],
+      contributions: {
+        totalCommitContributions: 0,
+        totalPullRequestContributions: 0,
+        totalIssueContributions: 0,
+      },
+      issues: [],
+      discussions: [],
+    });
+    mocks.fetchGitHubUserData.mockResolvedValueOnce({
+      name: "User B",
+      avatarUrl: "https://example.com/b.png",
+      repos: [],
+      pullRequests: [],
+      contributions: {
+        totalCommitContributions: 0,
+        totalPullRequestContributions: 0,
+        totalIssueContributions: 0,
+      },
+      issues: [],
+      discussions: [],
+    });
+
+    mocks.calculateUserScore.mockReturnValueOnce(makeScore(20));
+    mocks.calculateUserScore.mockReturnValueOnce(makeScore(10));
+
+    const response = await GET(
+      makeRequest({
+        username: ["user-a", "user-b"],
+      }),
+    );
+    const body = (await response.json()) as {
+      success: boolean;
+      users?: Array<{ username: string }>;
+      winner?: { username: string };
+    };
+
+    expect(response.status).toBe(200);
+    expect(body.success).toBe(true);
+    expect(body.users).toHaveLength(2);
+    expect(body.winner?.username).toBe("user-a");
+  });
+});

test/fixtures/github.ts

@@ -3,7 +3,6 @@ import type {
   DiscussionNode,
   IssueNode,
   PullRequestNode,
-  ReactionSummary,
   RepoLanguages,
   RepoNode,
 } from "@/types/github";
@@ -56,22 +55,10 @@ const defaultContributions: ContributionTotals = {
   totalIssueContributions: 0,
 };
 
-const defaultReactions: ReactionSummary = {
-  thumbsUp: 0,
-  thumbsDown: 0,
-  heart: 0,
-  hooray: 0,
-  rocket: 0,
-  eyes: 0,
-  confused: 0,
-  laugh: 0,
-};
-
 const defaultIssue: IssueNode = {
   title: "Issue about improving docs",
   url: "https://example.com/external-owner/repo/issues/1",
   comments: { totalCount: 2 },
-  reactions: defaultReactions,
   repository: {
     nameWithOwner: "external-owner/repo",
     stargazerCount: 10,
@@ -83,7 +70,6 @@ const defaultDiscussion: DiscussionNode = {
   title: "Discussion about roadmap",
   url: "https://example.com/external-owner/repo/discussions/1",
   comments: { totalCount: 2 },
-  reactions: defaultReactions,
   repository: {
     nameWithOwner: "external-owner/repo",
     stargazerCount: 10,
@@ -134,7 +120,6 @@ export function makeIssue(overrides: Partial<IssueNode> = {}): IssueNode {
     ...defaultIssue,
     ...overrides,
     comments: overrides.comments ?? defaultIssue.comments,
-    reactions: overrides.reactions ?? defaultIssue.reactions,
     repository: overrides.repository ?? defaultIssue.repository,
   };
 }
@@ -146,7 +131,6 @@ export function makeDiscussion(
     ...defaultDiscussion,
     ...overrides,
     comments: overrides.comments ?? defaultDiscussion.comments,
-    reactions: overrides.reactions ?? defaultDiscussion.reactions,
     repository: overrides.repository ?? defaultDiscussion.repository,
   };
 }