Skip to content

Enable vitest --detect-async-leaks and fix uncovered leaks #596

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Enable vitest --detect-async-leaks and fix uncovered leaks #596

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8efe59f
Initial plan
Copilot Mar 1, 2026
e4062fc
Enable --detect-async-leaks and fix framer-motion Promise leaks in Do…
Copilot Mar 1, 2026
770f51b
Add changeset for document-internationalization test fix
Copilot Mar 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fix-async-leaks-tests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@sanity/document-internationalization": patch
---

Fix async leaks in DocumentInternationalizationMenu tests by using fake timers to flush framer-motion animation Promises
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
"turbo": "^2.8.2",
"typescript": "catalog:",
"validate-npm-package-name": "^7.0.2",
"vitest": "^4.0.18",
"vitest": "4.1.0-beta.5",
"vitest-package-exports": "^1.1.2"
},
"lint-staged": {
Expand Down
10 changes: 9 additions & 1 deletion ...ty/document-internationalization/src/components/DocumentInternationalizationMenu.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ describe('DocumentInternationalizationMenu', () => {
const articleSchemaType = schema.get('article') as ObjectSchemaType

beforeEach(() => {
vi.useFakeTimers({shouldAdvanceTime: true})
vi.mocked(useDocumentInternationalizationContext).mockReturnValue(MOCK_PLUGIN_CONFIG)
vi.mocked(useTranslationMetadata).mockReturnValue({
data: [],
Expand All @@ -73,9 +74,16 @@ describe('DocumentInternationalizationMenu', () => {
})
})

afterEach(() => {
afterEach(async () => {
// Advance timers to flush pending framer-motion animation Promises
// that would otherwise leak (MotionValue.start creates Promises
// resolved only on animation completion)
await vi.advanceTimersByTimeAsync(1000)
cleanup()
// Advance again in case cleanup triggered exit animations
await vi.advanceTimersByTimeAsync(1000)
vi.clearAllMocks()
vi.useRealTimers()
})

test('returns null when documentId is empty', () => {
Expand Down
Loading