fix(zip-it-and-ship-it): create missing symlinks when archiveFormat=none #5836
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
ndhoule
changed the title
This change updates zisi's node bundler to create missing symlinks in
when `archiveFormat: 'none'` (the code path used by `netlify dev`).
Currently, in projects where two or more symlinks resolve to the same
target, we only ever create one symlink. In practice, how this usually
presents a problem is when a package manager dedupes a dependency by
symlinking it into two different packages; users end up getting a
runtime error when their code hits the code path that tries to resolve
the missing symlink.
For example, given this scenario (which I took from a project that
exhibits this issue):
```
{
targetPath: '../../../@netlify[email protected]/node_modules/@netlify/sdk--extension-api-client',
absoluteDestPath: '/home/ndhoule/dev/src/github.com/netlify/integration-csp/.netlify/functions-serve/trpc/node_modules/.pnpm/@netlify[email protected]_@[email protected]/node_modules/@netlify/sdk--extension-api-client'
}
{
targetPath: '../../../@netlify[email protected]/node_modules/@netlify/sdk--extension-api-client',
absoluteDestPath: '/home/ndhoule/dev/src/github.com/netlify/integration-csp/.netlify/functions-serve/trpc/node_modules/.pnpm/@netlify[email protected]_@[email protected]_@[email protected]_@[email protected]._vp3jgimrs3u5kdeagmtefgn5zi/node_modules/@netlify/sdk--extension-api-client'
}
```
...only the second symlink is created. This is because as we walk
through the list of files to output to the build directory, we only
track a single symlink destination per target. Many symlinks can point
at the same target, though, so we need to track multiple symlink
destinations per target.
I tested this out in my problem projects and it solved the problem. I
took a stab at adding a test for this, but got a little lost in the test
setup, which seems to have the `.zip` code path in mind rather than the
`'none'` path. Happy to write some tests if someone can point me at a
test setup.
ndhoule
force-pushed
the
fix/create-all-symlinks-when-archive-format-none
branch
from
b0ae4f7 to
b47e049
Compare
eduardoboucas
approved these changes
Sep 18, 2024
|
This pull request adds or modifies JavaScript ( |
ndhoule
force-pushed
the
fix/create-all-symlinks-when-archive-format-none
branch
3 times, most recently
from
70de5fb to
f2c66b1
Compare
ndhoule
force-pushed
the
fix/create-all-symlinks-when-archive-format-none
branch
from
f2c66b1 to
ee659fb
Compare
|
Added a test. Not sure why this macOS test is timing out, but it seems unrelated to my changes. |
ndhoule
deleted the
fix/create-all-symlinks-when-archive-format-none
branch
Merged
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.
This change updates zisi's node bundler to create missing symlinks in when
archiveFormat: 'none'(the code path used bynetlify dev).Currently, in projects where two or more symlinks resolve to the same target, we only ever create one symlink. In practice, how this usually presents a problem is when a package manager dedupes a dependency by symlinking it into two different packages; users end up getting a runtime error when their code hits the code path that tries to resolve the missing symlink.
For example, given this scenario (which I took from a project that exhibits this issue):
...only the second symlink is created. This is because as we walk through the list of files to output to the build directory, we only track a single symlink destination per target. Many symlinks can point at the same target, though, so we need to track multiple symlink destinations per target.
I tested this out in my problem projects and it solved the problem. I took a stab at adding a test for this, but got a little lost in the test setup, which seems to have the
.zipcode path in mind rather than the'none'path. Happy to write some tests if someone can point me at a test setup.