fix: resolving dep optimizer issues with workspace by thebanjomatic · Pull Request #4036 · vitest-dev/vitest

thebanjomatic · 2023-08-28T17:45:01Z

Description

We now use a different cache directory per project in the workspace this way we don't wind up accidentally deleting the cache directory from one project as the next one starts running.

I'm using a hash of the project name as the basis for constructing the cache sub-directory. Using a hash here is primarily done as a way to avoid sanitizing the project name to remove characters that aren't valid directory names and dealing with collisions for similarly named projects that contain invalid characters ("Foo<" and "Foo>" might both sanitize to "Foo_") for example.

A potential downside to using project name (hashed or not) is that workspaces which don't define project names for their projects will fall back to using an index as the project name. As a result, changing the order of the projects in a workspace, can result in the wrong cache directory being used.

In some ways, it might be better to do something like hash the resolved config that way order wouldn't matter, and changing the config would result in a different hash, but I don't necessarily love that approach either since it would result in more directories being created and we don't currently ever clean-up the node_modules/.vitest directory to remove stale project dirs.

@sheremet-va please let me know if you have a preference for the above

Fixes #4020

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.
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:.

bolt-new-by-stackblitz · 2023-08-28T17:45:03Z

Run & review this pull request in StackBlitz Codeflow.

netlify · 2023-08-28T17:45:06Z

✅ Deploy Preview for fastidious-cascaron-4ded94 ready!

Name	Link
🔨 Latest commit	`1d2221c`
🔍 Latest deploy log	https://app.netlify.com/sites/fastidious-cascaron-4ded94/deploys/64ee673fecbdfd000814206e
😎 Deploy Preview	https://deploy-preview-4036--fastidious-cascaron-4ded94.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

sheremet-va

Looks good to me 👍🏻

sheremet-va · 2023-08-29T07:14:12Z

packages/vitest/src/node/cache/index.ts

 import { findUp } from 'find-up'
 import { resolve } from 'pathe'
 import { loadConfigFromFile } from 'vite'
+import { generateHash } from '@vitest/runner/utils'


Runner package should not be used in node

Ok, providing you are still ok with hashing the project name as a solution, I have switched this to use node:crypto to generate an md5 hash

We now use a different cache directory per project in the workspace this way we don't wind up accidentally deleting the cache directory from one project as the next one starts running.

sheremet-va requested changes Aug 29, 2023

View reviewed changes

thebanjomatic force-pushed the fix/workspace-deps-optimizer branch from 35f32b4 to fe30982 Compare August 29, 2023 17:10

thebanjomatic requested a review from sheremet-va August 29, 2023 17:11

fix: resolving dep optimizer issues with workspace

1d2221c

We now use a different cache directory per project in the workspace this way we don't wind up accidentally deleting the cache directory from one project as the next one starts running.

thebanjomatic force-pushed the fix/workspace-deps-optimizer branch from 71ae736 to 1d2221c Compare August 29, 2023 21:45

sheremet-va approved these changes Aug 31, 2023

View reviewed changes

sheremet-va merged commit 0c13c39 into vitest-dev:main Aug 31, 2023

thebanjomatic deleted the fix/workspace-deps-optimizer branch September 2, 2023 03:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Comments

fix: resolving dep optimizer issues with workspace#4036

fix: resolving dep optimizer issues with workspace#4036
sheremet-va merged 1 commit intovitest-dev:mainfrom
thebanjomatic:fix/workspace-deps-optimizer

thebanjomatic commented Aug 28, 2023 •

edited

Loading

Uh oh!

bolt-new-by-stackblitz bot commented Aug 28, 2023

Uh oh!

netlify bot commented Aug 28, 2023 •

edited

Loading

Uh oh!

sheremet-va left a comment

Uh oh!

sheremet-va Aug 29, 2023

Uh oh!

thebanjomatic Aug 29, 2023

Uh oh!

Uh oh!

Comments

Conversation

thebanjomatic commented Aug 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

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

Tests

Documentation

Changesets

Uh oh!

bolt-new-by-stackblitz bot commented Aug 28, 2023

Uh oh!

netlify bot commented Aug 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for fastidious-cascaron-4ded94 ready!

Uh oh!

sheremet-va left a comment

Choose a reason for hiding this comment

Uh oh!

sheremet-va Aug 29, 2023

Choose a reason for hiding this comment

Uh oh!

thebanjomatic Aug 29, 2023

Choose a reason for hiding this comment

Uh oh!

thebanjomatic commented Aug 28, 2023 •

edited

Loading

netlify bot commented Aug 28, 2023 •

edited

Loading