Merge branch 'zj-line-multi-delimeter-support-removal' into 'master'

lines.Send() only support byte delimiter

Closes #2846

See merge request gitlab-org/gitaly!2402

5 files changed, 15 insertions, 13 deletions

diff --git a/changelogs/unreleased/zj-line-multi-delimeter-support-removal.yml b/changelogs/unreleased/zj-line-multi-delimeter-support-removal.yml
new file mode 100644
index 000000000..e7514159c
--- /dev/null
+++ b/changelogs/unreleased/zj-line-multi-delimeter-support-removal.yml
@@ -0,0 +1,5 @@
+---
+title: lines.Send() only support byte delimiter
+merge_request: 2402
+author:
+type: fixed
diff --git a/internal/helper/lines/send.go b/internal/helper/lines/send.go
index d0b65d067..5777d3c51 100644
--- a/internal/helper/lines/send.go
+++ b/internal/helper/lines/send.go
@@ -12,8 +12,8 @@ import (
 // a line gets fed into the Sender.
 type SenderOpts struct {
 	// Delimiter is the separator used to split the sender's output into
-	// lines. Defaults to "\n".
-	Delimiter []byte
+	// lines. Defaults to an empty byte (0).
+	Delimiter byte
 	// Limit is the upper limit of how many lines will be sent. The zero
 	// value will cause no lines to be sent.
 	Limit int
@@ -93,14 +93,14 @@ func (w *writer) consume(r io.Reader) error {
 
 		for {
 			// delim can be multiple bytes, so we read till the end byte of it ...
-			chunk, err := buf.ReadBytes(w.delimiter()[len(w.delimiter())-1])
+			chunk, err := buf.ReadBytes(w.delimiter())
 			if err != nil && err != io.EOF {
 				return err
 			}
 
 			line = append(line, chunk...)
 			// ... then we check if the last bytes of line are the same as delim
-			if bytes.HasSuffix(line, w.delimiter()) {
+			if bytes.HasSuffix(line, []byte{w.delimiter()}) {
 				break
 			}
 
@@ -110,7 +110,7 @@ func (w *writer) consume(r io.Reader) error {
 			}
 		}
 
-		line = bytes.TrimSuffix(line, w.delimiter())
+		line = bytes.TrimSuffix(line, []byte{w.delimiter()})
 		if len(line) == 0 {
 			break
 		}
@@ -135,16 +135,12 @@ func (w *writer) consume(r io.Reader) error {
 	return w.flush()
 }
 
-func (w *writer) delimiter() []byte      { return w.options.Delimiter }
+func (w *writer) delimiter() byte        { return w.options.Delimiter }
 func (w *writer) filter() *regexp.Regexp { return w.options.Filter }
 
 // Send reads output from `r`, splits it at `opts.Delimiter`, then handles the
 // buffered lines using `sender`.
 func Send(r io.Reader, sender Sender, opts SenderOpts) error {
-	if len(opts.Delimiter) == 0 {
-		opts.Delimiter = []byte{'\n'}
-	}
-
 	if opts.IsPageToken == nil {
 		opts.IsPageToken = func(_ []byte) bool { return true }
 	}
diff --git a/internal/helper/lines/send_test.go b/internal/helper/lines/send_test.go
index 64b763a9b..a87f2486d 100644
--- a/internal/helper/lines/send_test.go
+++ b/internal/helper/lines/send_test.go
@@ -67,6 +67,7 @@ func TestLinesSend(t *testing.T) {
 				Limit:       tc.limit,
 				IsPageToken: tc.isPageToken,
 				Filter:      tc.filter,
+				Delimiter:   '\n',
 			})
 			require.NoError(t, err)
 			require.Equal(t, tc.output, out)
diff --git a/internal/service/ref/refs.go b/internal/service/ref/refs.go
index 7e127c612..6db83b80e 100644
--- a/internal/service/ref/refs.go
+++ b/internal/service/ref/refs.go
@@ -34,7 +34,7 @@ var (
 
 type findRefsOpts struct {
 	cmdArgs []git.Option
-	delim   []byte
+	delim   byte
 	lines.SenderOpts
 }
 
@@ -463,7 +463,7 @@ func validateFindTagRequest(in *gitalypb.FindTagRequest) error {
 }
 
 func paginationParamsToOpts(p *gitalypb.PaginationParameter) *findRefsOpts {
-	opts := &findRefsOpts{}
+	opts := &findRefsOpts{delim: '\n'}
 	opts.IsPageToken = func(_ []byte) bool { return true }
 	opts.Limit = math.MaxInt32
 
diff --git a/internal/service/repository/search_files.go b/internal/service/repository/search_files.go
index a8bedded7..958880097 100644
--- a/internal/service/repository/search_files.go
+++ b/internal/service/repository/search_files.go
@@ -143,7 +143,7 @@ func (s *server) SearchFilesByName(req *gitalypb.SearchFilesByNameRequest, strea
 		return stream.Send(&gitalypb.SearchFilesByNameResponse{Files: objs})
 	}
 
-	return lines.Send(cmd, lr, lines.SenderOpts{Delimiter: []byte{'\n'}, Limit: math.MaxInt32, Filter: filter})
+	return lines.Send(cmd, lr, lines.SenderOpts{Delimiter: '\n', Limit: math.MaxInt32, Filter: filter})
 }
 
 type searchFilesRequest interface {