Leverage PROJECT_CWD to set cwd in yarn 3 bin "proxies" #6199
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
☁️ Nx Cloud ReportCI is running/has finished running commands for commit c1478a7. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this branch ✅ Successfully ran 14 targets
Sent with 💌 from NxCloud. |
✅ Deploy Preview for redwoodjs-docs canceled.
|
|
Yarn master Dom at it again, nice one! |
jtoar
commented
Aug 11, 2022
| @@ -79,7 +79,7 @@ const loadDotEnvDefaultsMiddleware = () => { | |||
| config({ | |||
| path: path.join(getPaths().base, '.env'), | |||
| defaults: path.join(getPaths().base, '.env.defaults'), | |||
| encoding: 'utf8', | |||
There was a problem hiding this comment.
This is the default value
jtoar
commented
Aug 11, 2022
| @@ -79,7 +79,7 @@ const loadDotEnvDefaultsMiddleware = () => { | |||
| config({ | |||
| path: path.join(getPaths().base, '.env'), | |||
| defaults: path.join(getPaths().base, '.env.defaults'), | |||
| encoding: 'utf8', | |||
| multiline: true, | |||
There was a problem hiding this comment.
Do you think we could add a test for this?
There was a problem hiding this comment.
Sorry I didn't see this comment; I'll revisit
jtoar
commented
Aug 11, 2022
Comment on lines
-32
to
-35
| // Ensure we run all commands from the base of the RW project | ||
| // even if you invoke from ./web or ./api | ||
| const rwProjectRoot = requireFromCli('./dist/lib/index.js').getPaths().base | ||
| process.chdir(rwProjectRoot) |
There was a problem hiding this comment.
This one (core) is already at the root, so no need to change to it
|
I've tested this locally and it works so far, so I'm going to merge once checks past and test again in canary. |
dac09
added a commit
to dac09/redwood
that referenced
this pull request
Aug 15, 2022
…9/redwood into fix/cell-prerender-graphql-fallback * 'fix/cell-prerender-graphql-fallback' of github.com:dac09/redwood: Stylistic suggestions Leverage PROJECT_CWD to set cwd in yarn 3 bin "proxies" (redwoodjs#6199) chore(cli): Add additional tests for sdl generator (redwoodjs#6200)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To upgrade RW projects to yarn 3, we had to make bin "proxy" files so that we could still access the bins of our dependencies. See #4444 for the full break down.
When you run a bin, yarn 3 sets the cwd to the workspace calling it. This revealed a hidden dependency in many of our CLI commands that expect the cwd to be the root, so we imported
getPathsfrom@redwoodjs/cli(an export of the one in@redwoodjs/internal) in many of the bin proxy files to find the root and change to it.This works and has worked for a long time, but turns out to be a not-so-great idea because it means pulling in a massive amount of
@redwoodjs/internalfor any CLI command, and possibly introducing some indeterminacy around the way env vars are loaded.Instead of importing
getPaths, this PR leverages thePROJECT_CWDenv var provided by yarn 3. It's value is what you expect. See https://yarnpkg.com/advanced/lifecycle-scripts/#environment-variables.Next step is to confirm whether or not this change fixes #5657.
Here's a visualization of the change using
0xto generate a flamegraph:The exact command for reproduction is