feat: Automatically split STDIN on null characters on push #70
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| package command | ||
|
|
||
| import ( | ||
| "bufio" | ||
| "errors" | ||
| "fmt" | ||
| "io" | ||
| "os" | ||
| "runtime" | ||
| "strings" | ||
|
|
||
| "github.com/gotify/cli/v2/utils" | ||
| "github.com/mattn/go-isatty" | ||
| ) | ||
|
|
||
| func readMessage(args []string, r io.Reader, output chan<- string, splitOnNull bool) { | ||
| defer close(output) | ||
|
|
||
| if len(args) > 0 { | ||
| if utils.ProbeStdin(r) { | ||
| utils.Exit1With("message is set via arguments and stdin, use only one of them") | ||
| } | ||
|
|
||
| output <- strings.Join(args, " ") | ||
| return | ||
| } | ||
|
|
||
| if isatty.IsTerminal(os.Stdin.Fd()) { | ||
| eofKey := "Ctrl+D" | ||
| if runtime.GOOS == "windows" { | ||
| eofKey = "Ctrl+Z" | ||
| } | ||
| fmt.Fprintf(os.Stderr, "Enter your message, press Enter and then %s to finish:\n", eofKey) | ||
| } | ||
|
|
||
| if splitOnNull { | ||
| read := bufio.NewReader(r) | ||
| for { | ||
| s, err := read.ReadString('\x00') | ||
| if err != nil { | ||
|
There was a problem hiding this comment. This could be simplified, if we always trim the suffix: s, err := read.ReadString('\x00')
s = strings.TrimSuffix(s, "\x00")
if len(s) > 0 {
output <- s
}
if errors.Is(err, io.EOF) {
return
}
if err != nil {
utils.Exit1With("read error", err)
} |
||
| if !errors.Is(err, io.EOF) { | ||
| utils.Exit1With("read error", err) | ||
| } | ||
| if len(s) > 0 { | ||
| output <- s | ||
| } | ||
| return | ||
| } else { | ||
| if len(s) > 1 { | ||
| output <- strings.TrimSuffix(s, "\x00") | ||
| } | ||
| } | ||
| } | ||
| } else { | ||
| bytes, err := io.ReadAll(r) | ||
| if err != nil { | ||
| utils.Exit1With("cannot read", err) | ||
| } | ||
| output <- string(bytes) | ||
| return | ||
| } | ||
|
|
||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| package command | ||
|
|
||
| import ( | ||
| "bufio" | ||
| "bytes" | ||
| "strings" | ||
| "testing" | ||
| ) | ||
|
|
||
| // Polyfill for slices.Equal for Go 1.20 | ||
| func slicesEqual[T comparable](a, b []T) bool { | ||
| if len(a) != len(b) { | ||
| return false | ||
| } | ||
| for i, v := range a { | ||
| if v != b[i] { | ||
| return false | ||
| } | ||
| } | ||
| return true | ||
| } | ||
|
|
||
| func readChanAll[T any](c chan T) []T { | ||
| var res []T | ||
| for s := range c { | ||
| res = append(res, s) | ||
| } | ||
| return res | ||
| } | ||
|
|
||
| func TestReadMessage(t *testing.T) { | ||
| if bytes.IndexByte([]byte("Hello\x00World"), '\x00') != len("Hello") { | ||
| t.Errorf("Expected %v, but got %v", len("Hello"), bytes.IndexByte([]byte("Hello\x00World"), '\x00')) | ||
| } | ||
| rdr := bufio.NewReader(strings.NewReader("Hello\x00World")) | ||
| if s, _ := rdr.ReadString('\x00'); s != "Hello\x00" { | ||
| t.Errorf("Expected %x, but got %x", "Hello\x00", s) | ||
| } | ||
| // Test case 1: message set via arguments | ||
| output := make(chan string) | ||
| go readMessage([]string{"Hello", "World"}, nil, output, false) | ||
|
|
||
| if res := readChanAll(output); !(slicesEqual(res, []string{"Hello World"})) { | ||
| t.Errorf("Expected %v, but got %v", []string{"Hello World"}, res) | ||
| } | ||
|
|
||
| // Test case 2: message set via arguments should not split on 'split' character | ||
| output = make(chan string) | ||
| go readMessage([]string{"Hello\x00World"}, nil, output, true) | ||
|
|
||
| if res := readChanAll(output); !(slicesEqual(res, []string{"Hello\x00World"})) { | ||
| t.Errorf("Expected %v, but got %v", []string{"Hello\x00World"}, res) | ||
| } | ||
|
|
||
| // Test case 3: message set via stdin | ||
| output = make(chan string) | ||
| go readMessage([]string{}, strings.NewReader("Hello\x00World"), output, true) | ||
|
|
||
| if res := readChanAll(output); !(slicesEqual(res, []string{"Hello", "World"})) { | ||
| t.Errorf("Expected %v, but got %v", []string{"Hello", "World"}, res) | ||
| } | ||
|
|
||
| // Test case 4: multiple null bytes should be split as one | ||
| output = make(chan string) | ||
| go readMessage([]string{}, strings.NewReader("Hello\x00\x00World"), output, true) | ||
|
|
||
| if res := readChanAll(output); !(slicesEqual(res, []string{"Hello", "World"})) { | ||
| t.Errorf("Expected %v, but got %v", []string{"Hello", "World"}, res) | ||
| } | ||
|
|
||
| // Test case 5: multiple null bytes at the end should be split as one | ||
| output = make(chan string) | ||
| go readMessage([]string{}, strings.NewReader("Hello\x00\x00"), output, true) | ||
|
|
||
| if res := readChanAll(output); !(slicesEqual(res, []string{"Hello"})) { | ||
| t.Errorf("Expected %v, but got %v", []string{"Hello"}, res) | ||
| } | ||
|
|
||
| // Test case 6: multiple null bytes at the start should be split as one | ||
| output = make(chan string) | ||
| go readMessage([]string{}, strings.NewReader("\x00\x00World"), output, true) | ||
|
|
||
| if res := readChanAll(output); !(slicesEqual(res, []string{"World"})) { | ||
| t.Errorf("Expected %v, but got %v", []string{"World"}, res) | ||
| } | ||
|
|
||
| } |
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,22 +1,23 @@ | ||
| package utils | ||
|
|
||
| import ( | ||
| "io" | ||
| "os" | ||
| ) | ||
|
|
||
| func ProbeStdin(file io.Reader) bool { | ||
| if file == nil { | ||
| return false | ||
| } | ||
| if file, ok := file.(*os.File); ok { | ||
| fi, err := file.Stat() | ||
| if err != nil { | ||
| return false | ||
| } | ||
| if fi.Mode()&os.ModeNamedPipe == 0 && !fi.Mode().IsRegular() { | ||
| return false | ||
| } | ||
| } | ||
|
|
||
| return true | ||
| } |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How would I use this feature to simplify the journalctl call in #69?
I'm also not 100% sure about the actual use-case of feature, is there something not possible with the current cli feature set and xargs? I don't find the argument that we don't have to use xargs very strong for implementing this inside gotify/cli.
I think if someone doesn't have access to xargs then they probably don't use gotify/cli and instead use some "raw" http call.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
makes sense, maybe I will just cherry pick the formatting bugs to a different PR and do that