[PR #90] [MERGED] feat: add MSW for mocking GitHub API in tests #91

New issue

Closed

opened 2026-10-27 21:09:28 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-27 21:09:28 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/Comfy-Org/Comfy-PR/pull/90
Author: @snomiao
Created: 10/22/2025
Status: ✅ Merged
Merged: 10/25/2025
Merged by: @snomiao

Base: main ← Head: sno-external-service-mocking

📝 Commits (3)

2a361c4 feat: add MSW for mocking GitHub API in tests
c52c56c Merge branch 'main' into sno-external-service-mocking
078b998 fix: improve type safety and clean up test code

📊 Changes

9 files changed (+1806 additions, -82 deletions)

View changed files

📝 .env.test (+1 -1)
📝 bun.lock (+99 -2)
📝 bunfig.toml (+1 -1)
📝 package.json (+1 -0)
➖ src/check/security-scan.spec.ts (+0 -78)
➕ src/gh.spec.ts (+564 -0)
➕ src/test/README.md (+296 -0)
➕ src/test/github-handlers.ts (+816 -0)
➕ src/test/msw-setup.ts (+28 -0)

📄 Description

Summary

This PR sets up Mock Service Worker (MSW) for comprehensive GitHub API mocking in tests, providing a more realistic and maintainable alternative to manual jest.mock patterns.

What's New

🧪 Testing Infrastructure

MSW Setup: Network-level HTTP interception for GitHub API
35+ Mock Handlers: Complete coverage of all GitHub API endpoints used in the codebase
Comprehensive Test Suite: src/gh.spec.ts with 35 tests (all passing)

📚 Documentation

src/test/README.md: Complete guide for using MSW in tests
Migration examples for existing tests
Best practices and troubleshooting tips

🎯 Coverage

All GitHub API endpoints used in Comfy-PR:

Repos API (8 endpoints)

get, createFork, getBranch, listTags, getCommit, listReleases, webhooks

Pulls API (6 endpoints)

list, get, create, update, requestReviewers, listReviewComments

Issues API (9 endpoints)

list, get, update, comments (list/create/update/get), labels, timeline

Git API (2 endpoints)

getTag, deleteRef

Users API (2 endpoints)

getAuthenticated, getByUsername

Benefits

✅ More Realistic: Mocks actual HTTP requests, not module implementations
✅ Type Safe: Full TypeScript support with Octokit types
✅ Centralized: Single source of truth for mock data
✅ Maintainable: Easy to add/update endpoints
✅ Transparent: Existing tests continue to work without changes

Test Results

bun test src/gh.spec.ts

 35 pass
 0 fail
 87 expect() calls
Ran 35 tests across 1 file. [10.02s]

All tests cover:

✅ CRUD operations for repos, pulls, issues
✅ Cached client (ghc) behavior
✅ Error handling (404, rate limits)
✅ Concurrent requests
✅ Response filtering and pagination

Migration Path

Existing tests using jest.mock("@/src/gh") can:

Continue working as-is (jest.mock takes precedence)
Gradually migrate to MSW by removing manual mocks
Mix both approaches (jest.mock for DB/Slack, MSW for GitHub)

Files Changed

src/test/msw-setup.ts - MSW server lifecycle
src/test/github-handlers.ts - All GitHub API mock handlers
src/test/README.md - Documentation
src/gh.spec.ts - Test suite
bunfig.toml - Test configuration
package.json - Added msw@^2.11.6

Next Steps

Review mock response structures match real GitHub API
Consider migrating existing tests to use MSW
Add more test cases as needed

🤖 Generated with Claude Code

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/Comfy-Org/Comfy-PR/pull/90 **Author:** [@snomiao](https://github.com/snomiao) **Created:** 10/22/2025 **Status:** ✅ Merged **Merged:** 10/25/2025 **Merged by:** [@snomiao](https://github.com/snomiao) **Base:** `main` ← **Head:** `sno-external-service-mocking` --- ### 📝 Commits (3) - [`2a361c4`](https://github.com/Comfy-Org/Comfy-PR/commit/2a361c4b7b2387f693cff60e7381f492e542a9f4) feat: add MSW for mocking GitHub API in tests - [`c52c56c`](https://github.com/Comfy-Org/Comfy-PR/commit/c52c56cd6bcf53591ed7961deef157965e4eb4e4) Merge branch 'main' into sno-external-service-mocking - [`078b998`](https://github.com/Comfy-Org/Comfy-PR/commit/078b998978211337334098fe09ac614259b0c61d) fix: improve type safety and clean up test code ### 📊 Changes **9 files changed** (+1806 additions, -82 deletions) <details> <summary>View changed files</summary> 📝 `.env.test` (+1 -1) 📝 `bun.lock` (+99 -2) 📝 `bunfig.toml` (+1 -1) 📝 `package.json` (+1 -0) ➖ `src/check/security-scan.spec.ts` (+0 -78) ➕ `src/gh.spec.ts` (+564 -0) ➕ `src/test/README.md` (+296 -0) ➕ `src/test/github-handlers.ts` (+816 -0) ➕ `src/test/msw-setup.ts` (+28 -0) </details> ### 📄 Description ## Summary This PR sets up Mock Service Worker (MSW) for comprehensive GitHub API mocking in tests, providing a more realistic and maintainable alternative to manual `jest.mock` patterns. ## What's New ### 🧪 Testing Infrastructure - **MSW Setup**: Network-level HTTP interception for GitHub API - **35+ Mock Handlers**: Complete coverage of all GitHub API endpoints used in the codebase - **Comprehensive Test Suite**: `src/gh.spec.ts` with 35 tests (all passing) ### 📚 Documentation - **src/test/README.md**: Complete guide for using MSW in tests - Migration examples for existing tests - Best practices and troubleshooting tips ### 🎯 Coverage All GitHub API endpoints used in Comfy-PR: **Repos API** (8 endpoints) - get, createFork, getBranch, listTags, getCommit, listReleases, webhooks **Pulls API** (6 endpoints) - list, get, create, update, requestReviewers, listReviewComments **Issues API** (9 endpoints) - list, get, update, comments (list/create/update/get), labels, timeline **Git API** (2 endpoints) - getTag, deleteRef **Users API** (2 endpoints) - getAuthenticated, getByUsername ## Benefits ✅ **More Realistic**: Mocks actual HTTP requests, not module implementations ✅ **Type Safe**: Full TypeScript support with Octokit types ✅ **Centralized**: Single source of truth for mock data ✅ **Maintainable**: Easy to add/update endpoints ✅ **Transparent**: Existing tests continue to work without changes ## Test Results ``` bun test src/gh.spec.ts 35 pass 0 fail 87 expect() calls Ran 35 tests across 1 file. [10.02s] ``` All tests cover: - ✅ CRUD operations for repos, pulls, issues - ✅ Cached client (ghc) behavior - ✅ Error handling (404, rate limits) - ✅ Concurrent requests - ✅ Response filtering and pagination ## Migration Path Existing tests using `jest.mock("@/src/gh")` can: 1. Continue working as-is (jest.mock takes precedence) 2. Gradually migrate to MSW by removing manual mocks 3. Mix both approaches (jest.mock for DB/Slack, MSW for GitHub) ## Files Changed - `src/test/msw-setup.ts` - MSW server lifecycle - `src/test/github-handlers.ts` - All GitHub API mock handlers - `src/test/README.md` - Documentation - `src/gh.spec.ts` - Test suite - `bunfig.toml` - Test configuration - `package.json` - Added msw@^2.11.6 ## Next Steps - [ ] Review mock response structures match real GitHub API - [ ] Consider migrating existing tests to use MSW - [ ] Add more test cases as needed 🤖 Generated with [Claude Code](https://claude.com/claude-code) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-27 21:09:28 +00:00