Skip to content
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.

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

fix(typecheck): use unique temp and tsbuildinfo file for each tsconfig file (fix #7107) #7112

Merged
merged 1 commit into from
Dec 23, 2024

Conversation

masnormen
Copy link
Contributor

@masnormen masnormen commented Dec 21, 2024

Description

Context:

This PR addresses an edge case outlined in issue #7107 (which also contains a reproduction example). The issue arises when a directory contains multiple tsconfig*.json files, each corresponding to different test workspaces. Merging this may fix #7107

Example:

image

In this scenario, each tsconfig file is linked to a separate workspace. However, Vitest might behave undeterministically, because for each tsconfig file found in the same directory, it attempts to write to the same temporary configuration file, tsconfig.vitest-temp.json.

This can lead to flaky test results due to broken temp tsconfig files (different content written on top of each other) or wrong config being applied.

397438346-009cbc69-1549-4411-ad47-1636d65f975f (1)

This PR changes Vitest's temp tsconfig and tsbuildinfo files generation to be unique for each tsconfig file it encounters.

  • file: tsconfig.json
    temp config: tsconfig.vitest-temp.json
    tsbuildinfo: tsconfig.tmp.tsbuildinfo
  • file: tsconfig.noStrict.json
    temp config: tsconfig.noStrict.vitest-temp.json
    tsbuildinfo: tsconfig.noStrict.tmp.tsbuildinfo

This change doesn't really introduce any new functionality, but helps ensure consistency in test behavior. As part of this change, I updated a test snapshot.

If there's something that I missed, please let me know.

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. If the feature is substantial or introduces breaking changes without a discussion, PR might be closed.
  • Ideally, include a test that fails without this PR but passes with it. (updated a snapshot)
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Tests

  • Run the tests with pnpm test:ci.

Documentation

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs command.

Changesets

  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.

Copy link

netlify bot commented Dec 21, 2024

Deploy Preview for vitest-dev ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit ce8aafe
🔍 Latest deploy log https://app.netlify.com/sites/vitest-dev/deploys/67667d2ec4ae31000838e7d5
😎 Deploy Preview https://deploy-preview-7112--vitest-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@masnormen masnormen marked this pull request as ready for review December 21, 2024 08:48
@sheremet-va sheremet-va merged commit 61b3016 into vitest-dev:main Dec 23, 2024
13 checks passed
@sheremet-va
Copy link
Member

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants