Skip to content

Rename pkg/fileutil private helpers for discoverability #52582

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.

Sign up for GitHub

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

Merged
pelikhan merged 4 commits into from
Aug 15, 2026
+8 −8
Merged

Rename pkg/fileutil private helpers for discoverability #52582

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5def9de
Initial plan
Copilot Aug 13, 2026
0e43c90
Rename fileutil helpers for clarity
Copilot Aug 13, 2026
75e1e92
Merge branch 'main' into copilot/function-namer-go-function-rename-plan
github-actions[bot] Aug 14, 2026
9eb3c90
Rename TestCopyFileContents to TestCopyToFileAndSync
Copilot Aug 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions pkg/fileutil/fileutil.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ func ValidatePathWithinBase(base, candidate string) error {
return fmt.Errorf("failed to resolve base path %q: %w", base, err)
}
}
absCand, err := resolveWithAncestorSymlinks(candidate)
absCand, err := resolvePathWithExistingAncestorSymlinks(candidate)
if err != nil {
return fmt.Errorf("failed to resolve candidate path %q: %w", candidate, err)
}
Expand All @@ -97,13 +97,13 @@ func ValidatePathWithinBase(base, candidate string) error {
return nil
}

// resolveWithAncestorSymlinks resolves a path to its absolute real form, following
// resolvePathWithExistingAncestorSymlinks resolves a path to its absolute real form, following
// symlinks for every existing component. For paths whose final component does not
// yet exist on disk, it walks up to the longest existing ancestor, resolves that
// through filepath.EvalSymlinks (catching any symlinked directories along the way),
// and then re-appends the non-existing suffix. This prevents a symlinked directory
// inside base from being used to escape the boundary when the target file is new.
func resolveWithAncestorSymlinks(p string) (string, error) {
func resolvePathWithExistingAncestorSymlinks(p string) (string, error) {
// Fast path: path exists — EvalSymlinks fully resolves it.
if resolved, err := filepath.EvalSymlinks(p); err == nil {
return resolved, nil
Expand Down Expand Up @@ -188,7 +188,7 @@ type syncWriteCloser interface {
Close() error
}

func copyFileContents(in io.Reader, out syncWriteCloser, dst string) (err error) {
func copyToFileAndSync(in io.Reader, out syncWriteCloser, dst string) (err error) {
removePartial := false

defer func() {
Expand Down Expand Up @@ -225,7 +225,7 @@ func CopyFile(src, dst string) error {
fileutilLog.Printf("Failed to create destination file: %s", err)
return err
}
err = copyFileContents(in, out, dst)
err = copyToFileAndSync(in, out, dst)
if err != nil {
return err
}
Expand Down
6 changes: 3 additions & 3 deletions pkg/fileutil/fileutil_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -438,14 +438,14 @@ func TestCopyFile(t *testing.T) {
})
}

func TestCopyFileContents(t *testing.T) {
func TestCopyToFileAndSync(t *testing.T) {
t.Parallel()
t.Run("returns close error after successful sync", func(t *testing.T) {
t.Parallel()
closeErr := errors.New("close failed")

@github-actions github-actions Bot Aug 14, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[/codebase-design] The test function is still named TestCopyFileContents — the old helper name — which reduces discoverability to the same degree as the renamed symbol.

💡 Suggested rename

Rename the test function to match the new production name:

func TestCopyToFileAndSync(t *testing.T) {

Consistent naming between the helper and its test makes it easier to navigate from production code to tests and back.

@copilot please address this.

Copilot AI Aug 14, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Renamed the test to TestCopyToFileAndSync in 9eb3c90.

out := &stubSyncWriteCloser{closeErr: closeErr}

err := copyFileContents(strings.NewReader("hello"), out, filepath.Join(t.TempDir(), "dst.txt"))
err := copyToFileAndSync(strings.NewReader("hello"), out, filepath.Join(t.TempDir(), "dst.txt"))

require.ErrorIs(t, err, closeErr)
assert.Equal(t, 1, out.closeCalls, "destination should be closed once")
Expand All @@ -464,7 +464,7 @@ func TestCopyFileContents(t *testing.T) {
dst := filepath.Join(t.TempDir(), "dst.txt")
require.NoError(t, os.WriteFile(dst, []byte("partial"), 0600), "Should create destination placeholder")

err := copyFileContents(strings.NewReader("hello"), out, dst)
err := copyToFileAndSync(strings.NewReader("hello"), out, dst)

require.ErrorIs(t, err, writeErr)
assert.Equal(t, 1, out.closeCalls, "destination should be closed once during cleanup")
Expand Down
Loading