chore: WriteEntry cleaner write() handling

isaacs · Aug 9, 2021 · fd2a38d · fd2a38d
1 parent 7b2acc5
commit fd2a38d
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 9 deletions.
diff --git a/lib/write-entry.js b/lib/write-entry.js
@@ -144,8 +144,8 @@ const WriteEntry = warner(class WriteEntry extends MiniPass {
       ctime: this.portable ? null : this.stat.ctime
     })
 
-    if (this.header.encode() && !this.noPax)
-      this.write(new Pax({
+    if (this.header.encode() && !this.noPax) {
+      super.write(new Pax({
         atime: this.portable ? null : this.header.atime,
         ctime: this.portable ? null : this.header.ctime,
         gid: this.portable ? null : this.header.gid,
@@ -159,7 +159,8 @@ const WriteEntry = warner(class WriteEntry extends MiniPass {
         ino: this.portable ? null : this.stat.ino,
         nlink: this.portable ? null : this.stat.nlink
       }).encode())
-    this.write(this.header.block)
+    }
+    super.write(this.header.block)
   }
 
   [DIRECTORY] () {
@@ -280,10 +281,6 @@ const WriteEntry = warner(class WriteEntry extends MiniPass {
 
     const writeBuf = this.offset === 0 && bytesRead === this.buf.length ?
       this.buf : this.buf.slice(this.offset, this.offset + bytesRead)
-    this.remain -= writeBuf.length
-    this.blockRemain -= writeBuf.length
-    this.pos += writeBuf.length
-    this.offset += writeBuf.length
 
     const flushed = this.write(writeBuf)
     if (!flushed)
@@ -296,10 +293,23 @@ const WriteEntry = warner(class WriteEntry extends MiniPass {
     this.once('drain', cb)
   }
 
+  write (writeBuf) {
+    if (this.blockRemain < writeBuf.length) {
+      const er = new Error('writing more data than expected')
+      er.path = this.absolute
+      return this.emit('error', er)
+    }
+    this.remain -= writeBuf.length
+    this.blockRemain -= writeBuf.length
+    this.pos += writeBuf.length
+    this.offset += writeBuf.length
+    return super.write(writeBuf)
+  }
+
   [ONDRAIN] () {
     if (!this.remain) {
       if (this.blockRemain)
-        this.write(Buffer.alloc(this.blockRemain))
+        super.write(Buffer.alloc(this.blockRemain))
       return this[CLOSE](/* istanbul ignore next - legacy */
         er => er ? this.emit('error', er) : this.end())
     }
@@ -454,7 +464,7 @@ const WriteEntryTar = warner(class WriteEntryTar extends MiniPass {
 
   end () {
     if (this.blockRemain)
-      this.write(Buffer.alloc(this.blockRemain))
+      super.write(Buffer.alloc(this.blockRemain))
     return super.end()
   }
 })

diff --git a/test/write-entry.js b/test/write-entry.js
@@ -919,6 +919,20 @@ t.test('portable dir entries, no mtime', t => {
   })
 })
 
+t.test('writing more data than is appropriate', t => {
+  const path = t.testdir({
+    file: 'hello',
+  })
+  const wss = new WriteEntry(`${path}/file`)
+  wss.on('error', er => {
+    t.match(er, {
+      message: 'writing more data than expected',
+    })
+    t.end()
+  })
+  wss.on('stat', () => wss.write(Buffer.from('some more stuff')))
+})
+
 t.test('write entry from read entry', t => {
   const data = makeTar([
     {