Skip to content

Commit 11a37a0

Browse files
author
Rob Figueiredo
committed
(*Stream).WriteMore: remove implicit Flush
I believe that WriteMore should not call Flush for these reasons: 1. This is surprising for users because of inconsistency. Why call Flush in WriteMore and not in WriteObjectEnd? 2. It is not necessary; callers are free to call Flush if their use case demands it. 3. It harms performance in the common case by flushing the buffer much more frequently than it needs to be flushed. The stream benchmark shows a 7% benefit to removing the Flush call, and I observed a similar speedup in my real-world use case. benchmark old ns/op new ns/op delta Benchmark_encode_string_with_SetEscapeHTML-8 442 437 -1.13% Benchmark_jsoniter_large_file-8 21222 21062 -0.75% Benchmark_json_large_file-8 40187 40266 +0.20% Benchmark_stream_encode_big_object-8 8611 7956 -7.61% benchmark old allocs new allocs delta Benchmark_encode_string_with_SetEscapeHTML-8 6 6 +0.00% Benchmark_jsoniter_large_file-8 78 78 +0.00% Benchmark_json_large_file-8 13 13 +0.00% Benchmark_stream_encode_big_object-8 0 0 +0.00% benchmark old bytes new bytes delta Benchmark_encode_string_with_SetEscapeHTML-8 760 760 +0.00% Benchmark_jsoniter_large_file-8 4920 4920 +0.00% Benchmark_json_large_file-8 6640 6640 +0.00% Benchmark_stream_encode_big_object-8 0 0 +0.00% Backwards compatibility - I believe there is little to no risk that this breaks callers. WriteMore does not leave the JSON in a valid state, so it must be followed by other Write* methods. To get the finished JSON out, the caller must already be calling Flush.
1 parent 91f4a64 commit 11a37a0

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

stream.go

-1
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,6 @@ func (stream *Stream) WriteEmptyObject() {
177177
func (stream *Stream) WriteMore() {
178178
stream.writeByte(',')
179179
stream.writeIndention(0)
180-
stream.Flush()
181180
}
182181

183182
// WriteArrayStart write [ with possible indention

stream_test.go

+12-1
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,19 @@ func (w *NopWriter) Write(p []byte) (n int, err error) {
6363
}
6464

6565
func Test_flush_buffer_should_stop_grow_buffer(t *testing.T) {
66+
// Stream an array of a zillion zeros.
6667
writer := new(NopWriter)
67-
NewEncoder(writer).Encode(make([]int, 10000000))
68+
stream := NewStream(ConfigDefault, writer, 512)
69+
stream.WriteArrayStart()
70+
for i := 0; i < 10000000; i++ {
71+
stream.WriteInt(0)
72+
stream.WriteMore()
73+
stream.Flush()
74+
}
75+
stream.WriteInt(0)
76+
stream.WriteArrayEnd()
77+
78+
// Confirm that the buffer didn't have to grow.
6879
should := require.New(t)
6980

7081
// 512 is the internal buffer size set in NewEncoder

0 commit comments

Comments
 (0)