Bug 1864406 - Add ReadableStreamBYOBReader.prototype.read(view, { min…

… }). r=saschanaz,webidl,smaug Implements whatwg/streams#1145 Differential Revision: https://phabricator.services.mozilla.com/D226225
erichdongubler-mozilla · Oct 28, 2024 · 619cbba · 619cbba
1 parent 862bfbe
commit 619cbba
Show file tree

Hide file tree

Showing 7 changed files with 188 additions and 325 deletions.
diff --git a/dom/streams/ReadableByteStreamController.cpp b/dom/streams/ReadableByteStreamController.cpp
diff --git a/dom/streams/ReadableByteStreamController.h b/dom/streams/ReadableByteStreamController.h
@@ -187,8 +187,8 @@ MOZ_CAN_RUN_SCRIPT void ReadableByteStreamControllerRespondWithNewView(
 
 MOZ_CAN_RUN_SCRIPT void ReadableByteStreamControllerPullInto(
     JSContext* aCx, ReadableByteStreamController* aController,
-    JS::Handle<JSObject*> aView, ReadIntoRequest* aReadIntoRequest,
-    ErrorResult& aRv);
+    JS::Handle<JSObject*> aView, uint64_t aMin,
+    ReadIntoRequest* aReadIntoRequest, ErrorResult& aRv);
 
 void ReadableByteStreamControllerError(
     ReadableByteStreamController* aController, JS::Handle<JS::Value> aValue,

diff --git a/dom/streams/ReadableStreamBYOBReader.cpp b/dom/streams/ReadableStreamBYOBReader.cpp
@@ -173,7 +173,7 @@ namespace streams_abstract {
 // https://streams.spec.whatwg.org/#readable-stream-byob-reader-read
 void ReadableStreamBYOBReaderRead(JSContext* aCx,
                                   ReadableStreamBYOBReader* aReader,
-                                  JS::Handle<JSObject*> aView,
+                                  JS::Handle<JSObject*> aView, uint64_t aMin,
                                   ReadIntoRequest* aReadIntoRequest,
                                   ErrorResult& aRv) {
   // Step 1.Let stream be reader.[[stream]].
@@ -195,19 +195,20 @@ void ReadableStreamBYOBReaderRead(JSContext* aCx,
   }
 
   // Step 5. Otherwise, perform
-  // !ReadableByteStreamControllerPullInto(stream.[[controller]], view,
+  // !ReadableByteStreamControllerPullInto(stream.[[controller]], view, min,
   // readIntoRequest).
   MOZ_ASSERT(stream->Controller()->IsByte());
   RefPtr<ReadableByteStreamController> controller(
       stream->Controller()->AsByte());
-  ReadableByteStreamControllerPullInto(aCx, controller, aView, aReadIntoRequest,
-                                       aRv);
+  ReadableByteStreamControllerPullInto(aCx, controller, aView, aMin,
+                                       aReadIntoRequest, aRv);
 }
 }  // namespace streams_abstract
 
 // https://streams.spec.whatwg.org/#byob-reader-read
 already_AddRefed<Promise> ReadableStreamBYOBReader::Read(
-    const ArrayBufferView& aArray, ErrorResult& aRv) {
+    const ArrayBufferView& aArray,
+    const ReadableStreamBYOBReaderReadOptions& aOptions, ErrorResult& aRv) {
   AutoJSAPI jsapi;
   if (!jsapi.Init(GetParentObject())) {
     aRv.ThrowUnknownError("Internal error");
@@ -247,28 +248,60 @@ already_AddRefed<Promise> ReadableStreamBYOBReader::Read(
     return nullptr;
   }
 
-  // Step 4. If this.[[stream]] is undefined, return a promise rejected with a
+  // Step 4. If options["min"] is 0, return a promise rejected with a TypeError
+  // exception.
+  if (aOptions.mMin == 0) {
+    aRv.ThrowTypeError(
+        "Zero is not a valid value for 'min' member of "
+        "ReadableStreamBYOBReaderReadOptions.");
+    return nullptr;
+  }
+
+  // Step 5. If view has a [[TypedArrayName]] internal slot,
+  if (JS_IsTypedArrayObject(view)) {
+    // Step 5.1. If options["min"] > view.[[ArrayLength]], return a promise
+    // rejected with a RangeError exception.
+    if (aOptions.mMin > JS_GetTypedArrayLength(view)) {
+      aRv.ThrowRangeError(
+          "Array length exceeded by 'min' member of "
+          "ReadableStreamBYOBReaderReadOptions.");
+      return nullptr;
+    }
+  } else {
+    // Step 6. Otherwise (i.e., it is a DataView),
+    // Step 6.1. If options["min"] > view.[[ByteLength]], return a promise
+    // rejected with a RangeError exception.
+    if (aOptions.mMin > JS_GetArrayBufferViewByteLength(view)) {
+      aRv.ThrowRangeError(
+          "byteLength exceeded by 'min' member of "
+          "ReadableStreamBYOBReaderReadOptions.");
+      return nullptr;
+    }
+  }
+
+  // Step 7. If this.[[stream]] is undefined, return a promise rejected with a
   // TypeError exception.
   if (!GetStream()) {
     aRv.ThrowTypeError("Reader has undefined stream");
     return nullptr;
   }
 
-  // Step 5.
+  // Step 8. Let promise be a new promise.
   RefPtr<Promise> promise = Promise::CreateInfallible(GetParentObject());
 
-  // Step 6. Let readIntoRequest be a new read-into request with the following
+  // Step 9. Let readIntoRequest be a new read-into request with the following
   // items:
   RefPtr<ReadIntoRequest> readIntoRequest = new Read_ReadIntoRequest(promise);
 
-  // Step 7. Perform ! ReadableStreamBYOBReaderRead(this, view,
+  // Step 10. Perform ! ReadableStreamBYOBReaderRead(this, view, options["min"],
   // readIntoRequest).
-  ReadableStreamBYOBReaderRead(cx, this, view, readIntoRequest, aRv);
+  ReadableStreamBYOBReaderRead(cx, this, view, aOptions.mMin, readIntoRequest,
+                               aRv);
   if (aRv.Failed()) {
     return nullptr;
   }
 
-  // Step 8. Return promise.
+  // Step 11. Return promise.
   return promise.forget();
 }
 

diff --git a/dom/streams/ReadableStreamBYOBReader.h b/dom/streams/ReadableStreamBYOBReader.h
@@ -22,6 +22,7 @@ namespace mozilla::dom {
 class Promise;
 struct ReadIntoRequest;
 class ReadableStream;
+struct ReadableStreamBYOBReaderReadOptions;
 
 }  // namespace mozilla::dom
 
@@ -52,7 +53,8 @@ class ReadableStreamBYOBReader final : public ReadableStreamGenericReader,
       const GlobalObject& global, ReadableStream& stream, ErrorResult& rv);
 
   MOZ_CAN_RUN_SCRIPT already_AddRefed<Promise> Read(
-      const ArrayBufferView& aArray, ErrorResult& rv);
+      const ArrayBufferView& aArray,
+      const ReadableStreamBYOBReaderReadOptions& aOptions, ErrorResult& rv);
 
   void ReleaseLock(ErrorResult& rv);
 
@@ -73,8 +75,8 @@ already_AddRefed<ReadableStreamBYOBReader> AcquireReadableStreamBYOBReader(
 
 MOZ_CAN_RUN_SCRIPT void ReadableStreamBYOBReaderRead(
     JSContext* aCx, ReadableStreamBYOBReader* aReader,
-    JS::Handle<JSObject*> aView, ReadIntoRequest* aReadIntoRequest,
-    ErrorResult& aRv);
+    JS::Handle<JSObject*> aView, uint64_t aMin,
+    ReadIntoRequest* aReadIntoRequest, ErrorResult& aRv);
 
 void ReadableStreamBYOBReaderErrorReadIntoRequests(
     JSContext* aCx, ReadableStreamBYOBReader* aReader,

diff --git a/dom/streams/ReadableStreamTee.cpp b/dom/streams/ReadableStreamTee.cpp
@@ -911,10 +911,11 @@ void PullWithBYOBReader(JSContext* aCx, TeeState* aTeeState,
   RefPtr<ReadIntoRequest> readIntoRequest =
       new PullWithBYOBReader_ReadIntoRequest(aTeeState, aForBranch);
 
-  // Step 16.5.
+  // Step 16.5. Perform ! ReadableStreamBYOBReaderRead(reader, view, 1,
+  // readIntoRequest).
   RefPtr<ReadableStreamBYOBReader> byobReader =
       aTeeState->GetReader()->AsBYOB();
-  ReadableStreamBYOBReaderRead(aCx, byobReader, aView, readIntoRequest, aRv);
+  ReadableStreamBYOBReaderRead(aCx, byobReader, aView, 1, readIntoRequest, aRv);
 }
 
 // See https://streams.spec.whatwg.org/#abstract-opdef-readablebytestreamtee

diff --git a/dom/webidl/ReadableStreamBYOBReader.webidl b/dom/webidl/ReadableStreamBYOBReader.webidl
@@ -13,9 +13,13 @@ interface ReadableStreamBYOBReader {
   constructor(ReadableStream stream);
 
   [NewObject]
-  Promise<ReadableStreamReadResult> read(ArrayBufferView view);
+  Promise<ReadableStreamReadResult> read(ArrayBufferView view, optional ReadableStreamBYOBReaderReadOptions options = {});
 
   [Throws]
   undefined releaseLock();
 };
 ReadableStreamBYOBReader includes ReadableStreamGenericReader;
+
+dictionary ReadableStreamBYOBReaderReadOptions {
+  [EnforceRange] unsigned long long min = 1;
+};
diff --git a/testing/web-platform/meta/streams/readable-byte-streams/read-min.any.js.ini b/testing/web-platform/meta/streams/readable-byte-streams/read-min.any.js.ini
@@ -1,214 +1,2 @@
-[read-min.any.worker.html]
-  [ReadableStream with byte source: read({ min }) rejects if min is 0]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) rejects if min is negative]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) rejects if min is larger than view's length (Uint8Array)]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) rejects if min is larger than view's length (Uint16Array)]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) rejects if min is larger than view's length (DataView)]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }), then read()]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) with a DataView]
-    expected: FAIL
-
-  [ReadableStream with byte source: enqueue(), then read({ min })]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min: 3 }) on a 3-byte Uint8Array, then multiple enqueue() up to 3 bytes]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min: 3 }) on a 5-byte Uint8Array, then multiple enqueue() up to 3 bytes]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min: 3 }) on a 5-byte Uint8Array, then multiple enqueue() up to 4 bytes]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) when closed before view is filled]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) when closed immediately after view is filled]
-    expected: FAIL
-
-  [ReadableStream with byte source: cancel() with partially filled pending read({ min }) request]
-    expected: FAIL
-
-  [ReadableStream with byte source: 3 byte enqueue(), then close(), then read({ min }) with 2-element Uint16Array must fail]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) with 2-element Uint16Array, then 3 byte enqueue(), then close() must fail]
-    expected: FAIL
-
-  [ReadableStream with byte source: tee() with read({ min }) from branch1 and read() from branch2]
-    expected: FAIL
-
-
-[read-min.any.html]
-  [ReadableStream with byte source: read({ min }) rejects if min is 0]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) rejects if min is negative]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) rejects if min is larger than view's length (Uint8Array)]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) rejects if min is larger than view's length (Uint16Array)]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) rejects if min is larger than view's length (DataView)]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }), then read()]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) with a DataView]
-    expected: FAIL
-
-  [ReadableStream with byte source: enqueue(), then read({ min })]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min: 3 }) on a 3-byte Uint8Array, then multiple enqueue() up to 3 bytes]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min: 3 }) on a 5-byte Uint8Array, then multiple enqueue() up to 3 bytes]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min: 3 }) on a 5-byte Uint8Array, then multiple enqueue() up to 4 bytes]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) when closed before view is filled]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) when closed immediately after view is filled]
-    expected: FAIL
-
-  [ReadableStream with byte source: cancel() with partially filled pending read({ min }) request]
-    expected: FAIL
-
-  [ReadableStream with byte source: 3 byte enqueue(), then close(), then read({ min }) with 2-element Uint16Array must fail]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) with 2-element Uint16Array, then 3 byte enqueue(), then close() must fail]
-    expected: FAIL
-
-  [ReadableStream with byte source: tee() with read({ min }) from branch1 and read() from branch2]
-    expected: FAIL
-
-
-[read-min.any.serviceworker.html]
-  [ReadableStream with byte source: read({ min }) rejects if min is 0]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) rejects if min is negative]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) rejects if min is larger than view's length (Uint8Array)]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) rejects if min is larger than view's length (Uint16Array)]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) rejects if min is larger than view's length (DataView)]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }), then read()]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) with a DataView]
-    expected: FAIL
-
-  [ReadableStream with byte source: enqueue(), then read({ min })]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min: 3 }) on a 3-byte Uint8Array, then multiple enqueue() up to 3 bytes]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min: 3 }) on a 5-byte Uint8Array, then multiple enqueue() up to 3 bytes]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min: 3 }) on a 5-byte Uint8Array, then multiple enqueue() up to 4 bytes]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) when closed before view is filled]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) when closed immediately after view is filled]
-    expected: FAIL
-
-  [ReadableStream with byte source: cancel() with partially filled pending read({ min }) request]
-    expected: FAIL
-
-  [ReadableStream with byte source: 3 byte enqueue(), then close(), then read({ min }) with 2-element Uint16Array must fail]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) with 2-element Uint16Array, then 3 byte enqueue(), then close() must fail]
-    expected: FAIL
-
-  [ReadableStream with byte source: tee() with read({ min }) from branch1 and read() from branch2]
-    expected: FAIL
-
-
-[read-min.any.sharedworker.html]
-  [ReadableStream with byte source: read({ min }) rejects if min is 0]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) rejects if min is negative]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) rejects if min is larger than view's length (Uint8Array)]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) rejects if min is larger than view's length (Uint16Array)]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) rejects if min is larger than view's length (DataView)]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }), then read()]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) with a DataView]
-    expected: FAIL
-
-  [ReadableStream with byte source: enqueue(), then read({ min })]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min: 3 }) on a 3-byte Uint8Array, then multiple enqueue() up to 3 bytes]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min: 3 }) on a 5-byte Uint8Array, then multiple enqueue() up to 3 bytes]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min: 3 }) on a 5-byte Uint8Array, then multiple enqueue() up to 4 bytes]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) when closed before view is filled]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) when closed immediately after view is filled]
-    expected: FAIL
-
-  [ReadableStream with byte source: cancel() with partially filled pending read({ min }) request]
-    expected: FAIL
-
-  [ReadableStream with byte source: 3 byte enqueue(), then close(), then read({ min }) with 2-element Uint16Array must fail]
-    expected: FAIL
-
-  [ReadableStream with byte source: read({ min }) with 2-element Uint16Array, then 3 byte enqueue(), then close() must fail]
-    expected: FAIL
-
-  [ReadableStream with byte source: tee() with read({ min }) from branch1 and read() from branch2]
-    expected: FAIL
-
-
 [read-min.any.shadowrealm.html]
   expected: ERROR