Bug 1990921 - Enqueue the decode result even if stream end is met r=smaug

This corresponds to the not-merged-yet spec PR: whatwg/compression#77

Differential Revision: https://phabricator.services.mozilla.com/D266433

Author: saschanaz

dom/base/DecompressionStream.cpp

@@ -201,10 +201,6 @@ class ZLibDecompressionStreamAlgorithms : public DecompressionStreamAlgorithms {
           // after stream end.
           // Note that additional calls for inflate() immediately emits
           // Z_STREAM_END after this point.
-          if (mZStream.avail_in > 0) {
-            aRv.ThrowTypeError("Unexpected input after the end of stream");
-            return;
-          }
           mObservedStreamEnd = true;
           break;
         case Z_OK:
@@ -255,15 +251,6 @@ class ZLibDecompressionStreamAlgorithms : public DecompressionStreamAlgorithms {
     // * inflate() should normally be called until it returns Z_STREAM_END or an
     // error.
 
-    if (aFlush == Flush::Yes && !mObservedStreamEnd) {
-      // Step 2 of
-      // https://wicg.github.io/compression/#decompress-flush-and-enqueue
-      // If the end of the compressed input has not been reached, then throw a
-      // TypeError.
-      aRv.ThrowTypeError("The input is ended without reaching the stream end");
-      return;
-    }
-
     // Step 5: For each Uint8Array array, enqueue array in ds's transform.
     for (const auto& view : array) {
       JS::Rooted<JS::Value> value(aCx, JS::ObjectValue(*view));
@@ -272,6 +259,22 @@ class ZLibDecompressionStreamAlgorithms : public DecompressionStreamAlgorithms {
         return;
       }
     }
+
+    // Step 6: If the end of the compressed input has been reached, and ds's
+    // context has not fully consumed chunk, then throw a TypeError.
+    if (mObservedStreamEnd && mZStream.avail_in > 0) {
+      aRv.ThrowTypeError("Unexpected input after the end of stream");
+      return;
+    }
+
+    // Step 3 of
+    // https://wicg.github.io/compression/#decompress-flush-and-enqueue
+    // If the end of the compressed input has not been reached, then throw a
+    // TypeError.
+    if (aFlush == Flush::Yes && !mObservedStreamEnd) {
+      aRv.ThrowTypeError("The input is ended without reaching the stream end");
+      return;
+    }
   }
 
   ~ZLibDecompressionStreamAlgorithms() override { inflateEnd(&mZStream); }
@@ -345,7 +348,7 @@ class ZstdDecompressionStreamAlgorithms : public DecompressionStreamAlgorithms {
 
     JS::RootedVector<JSObject*> array(aCx);
 
-    while (inBuffer.pos < inBuffer.size) {
+    while (inBuffer.pos < inBuffer.size && !mObservedStreamEnd) {
       UniquePtr<uint8_t[], JS::FreePolicy> buffer(
           static_cast<uint8_t*>(JS_malloc(aCx, kBufferSize)));
       if (!buffer) {
@@ -366,10 +369,6 @@ class ZstdDecompressionStreamAlgorithms : public DecompressionStreamAlgorithms {
 
       if (rv == 0) {
         mObservedStreamEnd = true;
-        if (inBuffer.pos < inBuffer.size) {
-          aRv.ThrowTypeError("Unexpected input after the end of stream");
-          return;
-        }
       }
 
       // Step 3: If buffer is empty, return.
@@ -391,15 +390,6 @@ class ZstdDecompressionStreamAlgorithms : public DecompressionStreamAlgorithms {
       }
     }
 
-    if (aFlush == Flush::Yes && !mObservedStreamEnd) {
-      // Step 2 of
-      // https://wicg.github.io/compression/#decompress-flush-and-enqueue
-      // If the end of the compressed input has not been reached, then throw a
-      // TypeError.
-      aRv.ThrowTypeError("The input is ended without reaching the stream end");
-      return;
-    }
-
     // Step 5: For each Uint8Array array, enqueue array in ds's transform.
     for (const auto& view : array) {
       JS::Rooted<JS::Value> value(aCx, JS::ObjectValue(*view));
@@ -408,6 +398,22 @@ class ZstdDecompressionStreamAlgorithms : public DecompressionStreamAlgorithms {
         return;
       }
     }
+
+    // Step 6: If the end of the compressed input has been reached, and ds's
+    // context has not fully consumed chunk, then throw a TypeError.
+    if (mObservedStreamEnd && inBuffer.pos < inBuffer.size) {
+      aRv.ThrowTypeError("Unexpected input after the end of stream");
+      return;
+    }
+
+    // Step 3 of
+    // https://wicg.github.io/compression/#decompress-flush-and-enqueue
+    // If the end of the compressed input has not been reached, then throw a
+    // TypeError.
+    if (aFlush == Flush::Yes && !mObservedStreamEnd) {
+      aRv.ThrowTypeError("The input is ended without reaching the stream end");
+      return;
+    }
   }
 
   ~ZstdDecompressionStreamAlgorithms() override {

testing/web-platform/meta/compression/decompression-correct-input.any.js.ini

@@ -0,0 +1,30 @@
+[decompression-correct-input.any.html]
+
+[decompression-correct-input.any.shadowrealm.html]
+  expected: ERROR
+
+[decompression-correct-input.any.sharedworker.html]
+
+[decompression-correct-input.any.serviceworker.html]
+
+[decompression-correct-input.any.worker.html]
+  expected:
+    if not sessionHistoryInParent and not debug: [OK, TIMEOUT]
+
+[decompression-correct-input.any.shadowrealm-in-sharedworker.html]
+  expected: ERROR
+
+[decompression-correct-input.any.shadowrealm-in-shadowrealm.html]
+  expected: ERROR
+
+[decompression-correct-input.any.shadowrealm-in-window.html]
+  expected: ERROR
+
+[decompression-correct-input.https.any.shadowrealm-in-audioworklet.html]
+  expected: ERROR
+
+[decompression-correct-input.https.any.shadowrealm-in-serviceworker.html]
+  expected: [ERROR, TIMEOUT]
+
+[decompression-correct-input.any.shadowrealm-in-dedicatedworker.html]
+  expected: ERROR

testing/web-platform/meta/compression/decompression-correct-input.tentative.any.js.ini

@@ -0,0 +1,25 @@
+[decompression-extra-input.any.html]
+
+[decompression-extra-input.https.any.shadowrealm-in-serviceworker.html]
+  expected: ERROR
+
+[decompression-extra-input.any.sharedworker.html]
+
+[decompression-extra-input.https.any.shadowrealm-in-audioworklet.html]
+  expected: ERROR
+
+[decompression-extra-input.any.serviceworker.html]
+
+[decompression-extra-input.any.shadowrealm-in-shadowrealm.html]
+  expected: ERROR
+
+[decompression-extra-input.any.shadowrealm-in-sharedworker.html]
+  expected: ERROR
+
+[decompression-extra-input.any.shadowrealm-in-dedicatedworker.html]
+  expected: ERROR
+
+[decompression-extra-input.any.worker.html]
+
+[decompression-extra-input.any.shadowrealm-in-window.html]
+  expected: ERROR

testing/web-platform/meta/compression/decompression-extra-input.any.js.ini

@@ -1,14 +1,8 @@
 // META: global=window,worker
+// META: script=decompression-correct-input.js
 
 "use strict";
 
-// The zstd-compressed bytes for the string "expected output".
-const compressedZstdBytes = new Uint8Array([
-  0x28, 0xb5, 0x2f, 0xfd, 0x04, 0x58, 0x79, 0x00, 0x00, 0x65, 0x78, 0x70, 0x65,
-  0x63, 0x74, 0x65, 0x64, 0x20, 0x6f, 0x75, 0x74, 0x70, 0x75, 0x74, 0x5b, 0x11,
-  0xc6, 0x85,
-]);
-
 promise_test(async t => {
   const ds = new DecompressionStream("zstd");
   const writer = ds.writable.getWriter();
@@ -27,10 +21,5 @@ promise_test(async t => {
   await writePromise;
   await writerClosePromise;
 
-  const decompressedText = new TextDecoder().decode(value);
-  assert_equals(
-    decompressedText,
-    "expected output",
-    "The decompressed text should match the expected text"
-  );
+  assert_array_equals(Array.from(value), trueChunkValue, "value should match");
 }, "decompressing valid zstd input should yield 'expected output'");

testing/web-platform/mozilla/tests/compression/zstd/decompression-correct-input.tentative.any.js renamed to testing/web-platform/mozilla/tests/compression/zstd/decompression-correct-input.any.js

@@ -0,0 +1,7 @@
+// The zstd-compressed bytes for the string "expected output".
+const compressedZstdBytes = new Uint8Array([
+  0x28, 0xb5, 0x2f, 0xfd, 0x04, 0x58, 0x79, 0x00, 0x00, 0x65, 0x78, 0x70, 0x65,
+  0x63, 0x74, 0x65, 0x64, 0x20, 0x6f, 0x75, 0x74, 0x70, 0x75, 0x74, 0x5b, 0x11,
+  0xc6, 0x85,
+]);
+const trueChunkValue = new TextEncoder().encode('expected output');

testing/web-platform/mozilla/tests/compression/zstd/decompression-correct-input.js

@@ -0,0 +1,20 @@
+// META: global=window,worker
+// META: script=decompression-correct-input.js
+
+'use strict';
+
+const tests = [
+  ["zstd", new Uint8Array([...compressedZstdBytes, 0])],
+];
+
+for (const [format, chunk] of tests) {
+  promise_test(async t => {
+    const ds = new DecompressionStream(format);
+    const reader = ds.readable.getReader();
+    const writer = ds.writable.getWriter();
+    writer.write(chunk).catch(() => { });
+    const { done, value } = await reader.read();
+    assert_array_equals(Array.from(value), trueChunkValue, "value should match");
+    await promise_rejects_js(t, TypeError, reader.read(), "Extra input should eventually throw");
+  }, `decompressing ${format} input with extra pad should still give the output`);
+}

testing/web-platform/mozilla/tests/compression/zstd/decompression-extra-input.any.js

@@ -1,15 +1,8 @@
 // META: global=window,worker,shadowrealm
+// META: script=decompression-correct-input.js
 
 'use strict';
 
-const deflateChunkValue = new Uint8Array([120, 156, 75, 173, 40, 72, 77, 46, 73, 77, 81, 200, 47, 45, 41, 40, 45, 1, 0, 48, 173, 6, 36]);
-const gzipChunkValue = new Uint8Array([31, 139, 8, 0, 0, 0, 0, 0, 0, 3, 75, 173, 40, 72, 77, 46, 73, 77, 81, 200, 47, 45, 41, 40, 45, 1, 0, 176, 1, 57, 179, 15, 0, 0, 0]);
-const deflateRawChunkValue = new Uint8Array([
-    0x4b, 0xad, 0x28, 0x48, 0x4d, 0x2e, 0x49, 0x4d, 0x51, 0xc8,
-    0x2f, 0x2d, 0x29, 0x28, 0x2d, 0x01, 0x00,
-]);
-const trueChunkValue = new TextEncoder().encode('expected output');
-
 promise_test(async t => {
     const ds = new DecompressionStream('deflate');
     const reader = ds.readable.getReader();
@@ -19,7 +12,6 @@ promise_test(async t => {
     assert_array_equals(Array.from(value), trueChunkValue, "value should match");
 }, 'decompressing deflated input should work');
 
-
 promise_test(async t => {
     const ds = new DecompressionStream('gzip');
     const reader = ds.readable.getReader();

testing/web-platform/tests/compression/decompression-correct-input.tentative.any.js renamed to testing/web-platform/tests/compression/decompression-correct-input.any.js

@@ -0,0 +1,7 @@
+const deflateChunkValue = new Uint8Array([120, 156, 75, 173, 40, 72, 77, 46, 73, 77, 81, 200, 47, 45, 41, 40, 45, 1, 0, 48, 173, 6, 36]);
+const gzipChunkValue = new Uint8Array([31, 139, 8, 0, 0, 0, 0, 0, 0, 3, 75, 173, 40, 72, 77, 46, 73, 77, 81, 200, 47, 45, 41, 40, 45, 1, 0, 176, 1, 57, 179, 15, 0, 0, 0]);
+const deflateRawChunkValue = new Uint8Array([
+    0x4b, 0xad, 0x28, 0x48, 0x4d, 0x2e, 0x49, 0x4d, 0x51, 0xc8,
+    0x2f, 0x2d, 0x29, 0x28, 0x2d, 0x01, 0x00,
+]);
+const trueChunkValue = new TextEncoder().encode('expected output');

testing/web-platform/tests/compression/decompression-correct-input.js

@@ -0,0 +1,22 @@
+// META: global=window,worker,shadowrealm
+// META: script=decompression-correct-input.js
+
+'use strict';
+
+const tests = [
+  ["deflate", new Uint8Array([...deflateChunkValue, 0])],
+  ["gzip", new Uint8Array([...gzipChunkValue, 0])],
+  ["deflate-raw", new Uint8Array([...deflateRawChunkValue, 0])],
+];
+
+for (const [format, chunk] of tests) {
+  promise_test(async t => {
+    const ds = new DecompressionStream(format);
+    const reader = ds.readable.getReader();
+    const writer = ds.writable.getWriter();
+    writer.write(chunk).catch(() => { });
+    const { done, value } = await reader.read();
+    assert_array_equals(Array.from(value), trueChunkValue, "value should match");
+    await promise_rejects_js(t, TypeError, reader.read(), "Extra input should eventually throw");
+  }, `decompressing ${format} input with extra pad should still give the output`);
+}