fix: skip sub-directories when copying a plugin directory#582
Open
arpitjain099 wants to merge 1 commit into
Open
fix: skip sub-directories when copying a plugin directory#582arpitjain099 wants to merge 1 commit into
arpitjain099 wants to merge 1 commit into
Conversation
CopyDirToDir is documented to copy only the top-level regular files of a directory, but its WalkDir callback names its path parameter "path", which shadows nothing useful and makes the skip check d.Name() != filepath.Base(path) always false (both sides resolve to the current entry's base name). As a result the walk descended into every sub-directory and copied nested files, flattening them into the destination. Compare the walked path against the source root instead, matching the pattern already used in parsePluginFromDir. Add a regression test. Signed-off-by: Arpit Jain <arpitjain099@gmail.com>
arpitjain099
requested review from
NiazFK,
gokarnm,
priteshbandi,
rgnote,
shizhMSFT,
toddysm,
vaninrao10 and
yizha1
as code owners
There was a problem hiding this comment.
Pull request overview
This PR fixes internal/file.CopyDirToDir so it truly copies only the top-level regular files of a directory by preventing filepath.WalkDir from descending into subdirectories. It also adds a regression test to ensure nested files in subdirectories are not copied during plugin installation.
Changes:
- Fix subdirectory skipping logic in
CopyDirToDirby comparing walked paths against the walk root (src). - Add a regression test verifying only top-level regular files are copied and that non-directory sources return
ErrNotDirectory.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| internal/file/file.go | Corrects the WalkDir callback logic so subdirectories are properly skipped when copying. |
| internal/file/file_test.go | Adds a regression test to prevent nested files from being copied and validates non-directory error behavior. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or 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
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.
While reading the plugin install path I noticed that
internal/file.CopyDirToDirdoesn't behave the way its comment describes. It's meant to copy only the top-level regular files of a directory, but the skip-subdirectories guard never fires.The
WalkDircallback names its path parameterpath, so the checkd.Name() != filepath.Base(path)compares the current entry's base name against itself and is always false. The walk therefore descends into every sub-directory and copies nested files, flattening them into the destination.parsePluginFromDirin the same package gets this right by comparing against the walk root, so the two disagree on what a plugin directory contains:Installvalidates the top level but then copies nested files too.The fix compares the walked path against the source root, matching the existing
parsePluginFromDirpattern. I added a regression test that fails before the change (a nested file gets copied) and passes after. Verified withgo test ./internal/file/... ./plugin/...on linux/amd64.Thanks for taking a look.