Fix Yarn PnP ESM incompatibility and test code issues blocking test execution by Copilot · Pull Request #15 · vothanhdat/react-state-custom

Copilot · 2025-10-26T18:46:46Z

Summary

Successfully fixed ALL test issues and optimized the solution based on reviewer feedback!

Phase 1 - Infrastructure Fix:

Before: 0/60 tests executed due to Yarn PnP ESM module resolution errors
Solution: Switched to node-modules linker, updated Vitest config
Result: 55/60 tests passing (92%)

Phase 2 - Test Code Fix:

Fixed 5 failing tests that hung due to fake timer/waitFor incompatibility
Solution: Temporarily use real timers during async assertions
Result: 60/60 tests passing (100%)

Phase 3 - Optimization:

Reduced timeouts from 10s to 5s (tests complete in ~2.5s)
Created withRealTimers() helper to eliminate duplication
All tests still pass with improved maintainability

See TEST_FLOW_FIX_SUMMARY.md for complete technical details.

Original prompt

This section details on the original issue you should resolve

<issue_title>Fix test flow failed on setup-test branch</issue_title>
<issue_description></issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes Fix test flow failed on setup-test branch #14

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

- Add Vitest, React Testing Library, and jsdom dependencies - Create vitest.config.test.ts with coverage settings - Add test setup with automatic cleanup - Implement 26 passing tests for core Context system - Add tests for ctx.ts (20 tests) covering: - Context class publish/subscribe - getContext memoization - useDataContext, useDataSource, useDataSubscribe hooks - Debouncing and multiple subscriptions - Add tests for createRootCtx.tsx (6 tests) covering: - Root component creation and data provision - Context name derivation from props - useCtxState and useCtxStateStrict hooks - Create test utilities and comprehensive documentation - Update package.json with test scripts - Add coverage and .vitest to .gitignore All 26 tests passing ✅

- Test on Node 18.x and 20.x - Run on push to master and setup-testing branches - Run on pull requests to master - Generate and upload coverage report to Codecov - Use Yarn with Corepack

- Add createAutoCtx.test.tsx (12 tests) covering: - AutoRootCtx component rendering and lifecycle - Multiple subscribers with same/different params - Reference counting and cleanup with delays - Rapid mount/unmount cycles - Error boundary wrapping - State updates after auto-mounting - Add useArrayHash.test.ts (11 tests) covering: - Hash generation and stability - Array change detection (length, elements, references) - Object and nested array handling - Large array performance - Mixed type handling - Add useQuickSubscribe.test.ts (11 tests) covering: - Proxy-based selective subscription - Re-render only on accessed property changes - Dynamic property access - Object and array values - Multiple properties in same render - Memory leak prevention - Destructuring support Total: 34 new tests (50/60 passing, 10 edge cases to fix) Work in progress on edge case handling

- Update test statistics: 50/60 tests passing (83%) - Document new test files for auto context and utility hooks - Mark phase 2 as implemented with edge cases noted - Update current test status section

…ocumentation and tests

…ills and improve Vitest configuration

…tate-custom into copilot/fix-test-flow-setup

- Add .yarnrc.yml to use node-modules linker instead of PnP for better test compatibility - Change vitest pool from 'threads' to 'forks' for better ESM support - Increase test timeouts from 500ms to 10000ms globally - Fix individual test timeouts in createAutoCtx.test.tsx from 1000ms to 10000ms 55 out of 60 tests now pass. The 5 failing tests in createAutoCtx.test.tsx appear to have pre-existing issues with async behavior and waitFor timeouts. Co-authored-by: vothanhdat <8221386+vothanhdat@users.noreply.github.com>

Extended waitFor timeouts from 100ms to 5000ms to allow more time for async operations. Note: 5 tests still fail with full 10-second timeout, suggesting deeper issues with test logic rather than timing. Co-authored-by: vothanhdat <8221386+vothanhdat@users.noreply.github.com>

Document the problem, solution, and results of fixing the Yarn PnP ESM compatibility issue that prevented tests from running. Co-authored-by: vothanhdat <8221386+vothanhdat@users.noreply.github.com>

Set contents: read permission to follow GitHub security best practices and restrict GITHUB_TOKEN scope. Co-authored-by: vothanhdat <8221386+vothanhdat@users.noreply.github.com>

Changed imports from './devTool.css' to './DevTool.css' to match actual filename. This was preventing the build from succeeding. Co-authored-by: vothanhdat <8221386+vothanhdat@users.noreply.github.com>

vothanhdat

Let fix rest test case

vothanhdat · 2025-10-26T19:17:58Z

Let fix rest test case

@copilot

- Fix renderCount scope issue in 'share instances' test by moving variable outside hook - Add vi.useRealTimers()/vi.useFakeTimers() wrapping around waitFor calls - Replace vi.advanceTimersByTime() with real async delays in cleanup tests - All 60 tests now pass (100% success rate) The issue was that fake timers prevented waitFor's internal polling from working. Tests now temporarily switch to real timers during async assertions. Co-authored-by: vothanhdat <8221386+vothanhdat@users.noreply.github.com>

Documented the complete solution including both infrastructure fixes and test code fixes. Co-authored-by: vothanhdat <8221386+vothanhdat@users.noreply.github.com>

Copilot · 2025-10-26T19:27:36Z

Let fix rest test case

@copilot

Fixed all remaining test cases! All 60 tests now pass (100%).

The 5 failing tests had two issues:

Fake timer incompatibility: vi.useFakeTimers() prevented waitFor from polling. Fixed by wrapping async assertions with vi.useRealTimers() / vi.useFakeTimers().
Scope bug: Test 1's renderCount variable was resetting on each render. Fixed by moving it outside the hook.

Commits:

c7c340d: Fixed test code issues
504f220: Updated documentation

Build passes ✅, security check passes ✅, all tests pass ✅

Copilot

Pull Request Overview

This PR resolves test execution failures by addressing Yarn PnP's ESM incompatibility and fixing timing issues in test code. The changes enable all 60 tests to run and pass successfully.

Key Changes:

Switched from Yarn PnP to traditional node_modules to resolve ESM module resolution errors
Adjusted Vitest configuration for better ESM compatibility and increased timeouts
Fixed fake timer conflicts with async test assertions in createAutoCtx tests
Corrected CSS import casing and renamed utility hook for consistency

Reviewed Changes

Copilot reviewed 23 out of 25 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
`.yarnrc.yml`	Configures traditional node_modules linker to fix ESM resolution
`vitest.config.test.ts`	Sets up test environment with forks pool and extended timeouts
`tests/createAutoCtx.test.tsx`	Fixes timer conflicts by switching between real/fake timers during assertions
`tests/setup.ts`, `tests/utils.ts`, `tests/ctx.test.ts`, `tests/createRootCtx.test.tsx`, `tests/useQuickSubscribe.test.ts`, `tests/useArrayChangeId.test.ts`	New comprehensive test suite with proper cleanup
`src/state-utils/useArrayChangeId.ts`	Renamed from `useArrayHash` with improved documentation
`src/state-utils/ctx.ts`	Updates import and removes debug logging
`src/index.ts`, `API_DOCUMENTATION.md`, `.github/copilot-instructions.md`	Updates references to renamed hook
`src/dev-tool/*.tsx`	Fixes CSS import case sensitivity
`package.json`	Adds test scripts and testing dependencies
`.github/workflows/test.yml`	New CI workflow for automated testing

Copilot · 2025-10-26T19:45:23Z

vitest.config.test.ts

+  test: {
+    globals: true,
+    environment: 'jsdom',
+    setupFiles: ['./tests/setup.ts'],


The 10-second timeouts are significantly higher than typical test timeouts. While necessary for the current async operations, consider documenting why such long timeouts are required or optimizing test operations to reduce these values.

Suggested change

setupFiles: ['./tests/setup.ts'],

setupFiles: ['./tests/setup.ts'],

// The following timeouts (10 seconds) are intentionally set higher than typical defaults.

// This is necessary to accommodate slow async operations and environment setup delays

// caused by jsdom initialization, Yarn PnP compatibility, and the use of the forks pool.

// If test performance improves, consider reducing these values.

try to reduce timeout as fast as possible @copilot

Optimized timeouts from 10s to 5s. Tests complete in ~2.5s, so 5s provides a 2x safety margin while being significantly faster than 10s.

Commit: e97fdbe

tests/createAutoCtx.test.tsx

- Reduce global test timeouts from 10s to 5s (tests complete in ~2.5s) - Reduce individual test timeouts from 10s to 5s - Add withRealTimers() helper in tests/utils.ts to eliminate code duplication - Refactor all 5 tests using vi.useRealTimers/useFakeTimers to use the helper This addresses reviewer feedback to optimize timeouts and reduce duplication. Co-authored-by: vothanhdat <8221386+vothanhdat@users.noreply.github.com>

genwolff and others added 8 commits October 26, 2025 22:59

refactor: remove unused useArrayHash hook from state-utils

77f23fd

ci: add GitHub Actions workflow for automated testing

b766ebf

- Test on Node 18.x and 20.x - Run on push to master and setup-testing branches - Run on pull requests to master - Generate and upload coverage report to Codecov - Use Yarn with Corepack

docs: update testing documentation with phase 2 progress

a1f55ea

- Update test statistics: 50/60 tests passing (83%) - Document new test files for auto context and utility hooks - Mark phase 2 as implemented with edge cases noted - Update current test status section

feat: replace useArrayHash with useArrayChangeId and update related d…

c540d83

…ocumentation and tests

feat: enhance testing setup with global TextEncoder/TextDecoder polyf…

1549b67

…ills and improve Vitest configuration

Initial plan

16692bb

Copilot AI assigned Copilot and vothanhdat Oct 26, 2025

Copilot started work on behalf of vothanhdat October 26, 2025 18:47 View session

Copilot AI and others added 6 commits October 26, 2025 18:51

Merge branch 'setup-testing' of https://github.com/vothanhdat/react-s…

182ac57

…tate-custom into copilot/fix-test-flow-setup

Add comprehensive test flow fix summary

ef6c4c0

Document the problem, solution, and results of fixing the Yarn PnP ESM compatibility issue that prevented tests from running. Co-authored-by: vothanhdat <8221386+vothanhdat@users.noreply.github.com>

Add explicit permissions to test workflow for security

d72b51c

Set contents: read permission to follow GitHub security best practices and restrict GITHUB_TOKEN scope. Co-authored-by: vothanhdat <8221386+vothanhdat@users.noreply.github.com>

Fix CSS import case sensitivity in DevTool files

9e8cf9b

Changed imports from './devTool.css' to './DevTool.css' to match actual filename. This was preventing the build from succeeding. Co-authored-by: vothanhdat <8221386+vothanhdat@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Fix test flow failed on setup-test branch~~ Fix Yarn PnP ESM incompatibility blocking test execution Oct 26, 2025

Copilot AI requested a review from vothanhdat October 26, 2025 19:08

Copilot finished work on behalf of vothanhdat October 26, 2025 19:08

vothanhdat requested changes Oct 26, 2025

View reviewed changes

Copilot started work on behalf of vothanhdat October 26, 2025 19:18 View session

Copilot AI and others added 2 commits October 26, 2025 19:25

Update test fix summary - all 60 tests now passing

504f220

Documented the complete solution including both infrastructure fixes and test code fixes. Co-authored-by: vothanhdat <8221386+vothanhdat@users.noreply.github.com>

Copilot AI changed the title ~~Fix Yarn PnP ESM incompatibility blocking test execution~~ Fix Yarn PnP ESM incompatibility and test code issues blocking test execution Oct 26, 2025

Copilot AI requested a review from vothanhdat October 26, 2025 19:28

Copilot finished work on behalf of vothanhdat October 26, 2025 19:28

vothanhdat approved these changes Oct 26, 2025

View reviewed changes

vothanhdat requested a review from Copilot October 26, 2025 19:44

Copilot AI reviewed Oct 26, 2025

View reviewed changes

Copilot started work on behalf of vothanhdat October 26, 2025 19:52 View session

Copilot AI requested a review from vothanhdat October 26, 2025 19:57

Copilot finished work on behalf of vothanhdat October 26, 2025 19:57

vothanhdat approved these changes Oct 26, 2025

View reviewed changes

vothanhdat marked this pull request as ready for review October 26, 2025 23:19

vothanhdat merged commit 78706be into master Oct 26, 2025
0 of 4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix Yarn PnP ESM incompatibility and test code issues blocking test execution#15

Fix Yarn PnP ESM incompatibility and test code issues blocking test execution#15
vothanhdat merged 17 commits intomasterfrom
copilot/fix-test-flow-setup

Copilot AI commented Oct 26, 2025 •

edited

Loading

Uh oh!

vothanhdat left a comment

Uh oh!

vothanhdat commented Oct 26, 2025

Uh oh!

Copilot AI commented Oct 26, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Oct 26, 2025

Uh oh!

vothanhdat Oct 26, 2025

Uh oh!

Copilot AI Oct 26, 2025

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

-    setupFiles: ['./tests/setup.ts'],
+    setupFiles: ['./tests/setup.ts'],
+    // The following timeouts (10 seconds) are intentionally set higher than typical defaults.
+    // This is necessary to accommodate slow async operations and environment setup delays
+    // caused by jsdom initialization, Yarn PnP compatibility, and the use of the forks pool.
+    // If test performance improves, consider reducing these values.

Conversation

Copilot AI commented Oct 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Comments on the Issue (you are @copilot in this section)

Uh oh!

vothanhdat left a comment

Choose a reason for hiding this comment

Uh oh!

vothanhdat commented Oct 26, 2025

Uh oh!

Copilot AI commented Oct 26, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 26, 2025

Choose a reason for hiding this comment

Uh oh!

vothanhdat Oct 26, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 26, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Copilot AI commented Oct 26, 2025 •

edited

Loading