Skip to content
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

Jump to bottom

FindFiles exits and returns no files when it can't open a directory #99

Open
jreisinger opened this issue Mar 12, 2022 · 7 comments · May be fixed by #122
Open

FindFiles exits and returns no files when it can't open a directory #99

jreisinger opened this issue Mar 12, 2022 · 7 comments · May be fixed by #122

Comments

@jreisinger
Copy link

jreisinger commented Mar 12, 2022 •
edited

This program

package main

import (
	"log"
	"os"

	"github.com/bitfield/script"
)

func main() {
	h, err := os.UserHomeDir()
	if err != nil {
		log.Fatal(err)
	}
	_, err = script.FindFiles(h).Stdout()
	if err != nil {
		log.Fatal(err)
	}
}

yields:

$ go build
$ ./script
2022/03/12 11:51:51 open /Users/user/.Trash: operation not permitted

I expected behavior similar to find $HOME -type f, i.e. to return files from directories it can open.
@bitfield
Copy link
Owner

Thanks, @jreisinger! Yes, that seems a reasonable expectation.

@jreisinger jreisinger changed the title FindFiles exits and prints no files when it can't open a directory FindFiles exits and returns no files when it can't open a directory Mar 12, 2022
@bitfield
Copy link
Owner

It seems like FindFiles should just ignore any errors encountered by filepath.Walk. I think while we're working on that, it would make sense to update FindFiles to use fs.WalkDir instead of filepath.Walk, wouldn't it? Then it would be easier to test (see Walking with filesystems).

@parkerduckworth
Copy link

@bitfield agree that using fs.WalkDir with fs.SkipDir would provide a nice DX here.

Thinking that we'd still want to include the permission errors in the output though (rather than completely swallowing), as this is more aligned with the default behavior of find?

Maybe checking to see if the fs.WalkDirFunc returns fs.ErrPermission, and if so, append <path-to-file>: permission denied to filenames. Otherwise if any other err type is encountered, it should be piped out WithError.

The developer could always just Reject lines containing "permission denied" from the resulting pipe of a successful find.

@bitfield
Copy link
Owner

@parkerduckworth it's a tricky area, because one of the design goals for script is to just get out of your way so that you can cook up quick hacks, and in the event of errors it should just "do the right thing", without blocking your task.

@parkerduckworth
Copy link

parkerduckworth commented Mar 27, 2022 via email

@bitfield
Copy link
Owner

bitfield commented Jun 2, 2022

Happy to accept PRs for this.

@parkerduckworth parkerduckworth linked a pull request Jun 2, 2022 that will close this issue
Open
@parkerduckworth
Copy link

@bitfield great, just submitted one

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Ignore fs.WalkDir errors in FindFiles parkerduckworth/script
3 participants
@bitfield @jreisinger @parkerduckworth