Merge pull request #774 from capnproto/harris/debug-vector-output-stream

Log more info in VectorOutputStream::write() KJ_REQUIRE

c++/src/kj/io-test.c++

@@ -175,5 +175,27 @@ KJ_TEST("InputStream::readAllText() / readAllBytes()") {
   }
 }
 
+KJ_TEST("ArrayOutputStream::write() does not assume adjacent write buffer is its own") {
+  // Previously, if ArrayOutputStream::write(src, size) saw that `src` equaled its fill position, it
+  // would assume that the write was already in its buffer. This assumption was buggy if the write
+  // buffer was directly adjacent in memory to the ArrayOutputStream's buffer, and the
+  // ArrayOutputStream was full (i.e., its fill position was one-past-the-end).
+  //
+  // VectorOutputStream also suffered a similar bug, but it is much harder to test, since it
+  // performs its own allocation.
+
+  kj::byte buffer[10] = { 0 };
+
+  ArrayOutputStream output(arrayPtr(buffer, buffer + 5));
+
+  // Succeeds and fills the ArrayOutputStream.
+  output.write(buffer + 5, 5);
+
+  // Previously this threw an inscrutable "size <= array.end() - fillPos" requirement failure.
+  KJ_EXPECT_THROW_MESSAGE(
+      "backing array was not large enough for the data written",
+      output.write(buffer + 5, 5));
+}
+
 }  // namespace
 }  // namespace kj

c++/src/kj/io.c++

@@ -271,9 +271,9 @@ ArrayPtr<byte> ArrayOutputStream::getWriteBuffer() {
 }
 
 void ArrayOutputStream::write(const void* src, size_t size) {
-  if (src == fillPos) {
+  if (src == fillPos && fillPos != array.end()) {
     // Oh goody, the caller wrote directly into our buffer.
-    KJ_REQUIRE(size <= array.end() - fillPos);
+    KJ_REQUIRE(size <= array.end() - fillPos, size, fillPos, array.end() - fillPos);
     fillPos += size;
   } else {
     KJ_REQUIRE(size <= (size_t)(array.end() - fillPos),
@@ -299,9 +299,9 @@ ArrayPtr<byte> VectorOutputStream::getWriteBuffer() {
 }
 
 void VectorOutputStream::write(const void* src, size_t size) {
-  if (src == fillPos) {
+  if (src == fillPos && fillPos != vector.end()) {
     // Oh goody, the caller wrote directly into our buffer.
-    KJ_REQUIRE(size <= vector.end() - fillPos);
+    KJ_REQUIRE(size <= vector.end() - fillPos, size, fillPos, vector.end() - fillPos);
     fillPos += size;
   } else {
     if (vector.end() - fillPos < size) {