Adding upstream version 110.0.1.upstream/110.0.1upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 194 insertions, 0 deletions

diff --git a/dom/streams/ByteStreamHelpers.cpp b/dom/streams/ByteStreamHelpers.cpp
new file mode 100644
index 0000000000..1506d38611
--- /dev/null
+++ b/dom/streams/ByteStreamHelpers.cpp
@@ -0,0 +1,194 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim:set ts=2 sw=2 sts=2 et cindent: */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#include "mozilla/dom/BodyStream.h"
+#include "mozilla/dom/ByteStreamHelpers.h"
+#include "mozilla/dom/ReadableByteStreamController.h"
+#include "js/ArrayBuffer.h"
+#include "js/RootingAPI.h"
+#include "js/experimental/TypedData.h"
+#include "mozilla/ErrorResult.h"
+
+namespace mozilla::dom {
+
+// https://streams.spec.whatwg.org/#transfer-array-buffer
+// As some parts of the specifcation want to use the abrupt completion value,
+// this function may leave a pending exception if it returns nullptr.
+JSObject* TransferArrayBuffer(JSContext* aCx, JS::Handle<JSObject*> aObject) {
+  MOZ_ASSERT(JS::IsArrayBufferObject(aObject));
+
+  // Step 1.
+  MOZ_ASSERT(!JS::IsDetachedArrayBufferObject(aObject));
+
+  // Step 3 (Reordered)
+  size_t bufferLength = JS::GetArrayBufferByteLength(aObject);
+
+  // Step 2 (Reordered)
+  void* bufferData = JS::StealArrayBufferContents(aCx, aObject);
+
+  // Step 4.
+  if (!JS::DetachArrayBuffer(aCx, aObject)) {
+    return nullptr;
+  }
+
+  // Step 5.
+  return JS::NewArrayBufferWithContents(aCx, bufferLength, bufferData);
+}
+
+// https://streams.spec.whatwg.org/#can-transfer-array-buffer
+bool CanTransferArrayBuffer(JSContext* aCx, JS::Handle<JSObject*> aObject,
+                            ErrorResult& aRv) {
+  // Step 1. Assert: Type(O) is Object. (Implicit in types)
+  // Step 2. Assert: O has an [[ArrayBufferData]] internal slot.
+  MOZ_ASSERT(JS::IsArrayBufferObject(aObject));
+
+  // Step 3. If ! IsDetachedBuffer(O) is true, return false.
+  if (JS::IsDetachedArrayBufferObject(aObject)) {
+    return false;
+  }
+
+  // Step 4. If SameValue(O.[[ArrayBufferDetachKey]], undefined) is false,
+  // return false.
+  // Step 5. Return true.
+  // Note: WASM memories are the only buffers that would qualify
+  // as having an undefined [[ArrayBufferDetachKey]],
+  bool hasDefinedArrayBufferDetachKey = false;
+  if (!JS::HasDefinedArrayBufferDetachKey(aCx, aObject,
+                                          &hasDefinedArrayBufferDetachKey)) {
+    aRv.StealExceptionFromJSContext(aCx);
+    return false;
+  }
+  return !hasDefinedArrayBufferDetachKey;
+}
+
+// https://streams.spec.whatwg.org/#abstract-opdef-cloneasuint8array
+JSObject* CloneAsUint8Array(JSContext* aCx, JS::Handle<JSObject*> aObject) {
+  // Step 1. Assert: Type(O) is Object. Implicit.
+  // Step 2. Assert: O has an [[ViewedArrayBuffer]] internal slot.
+  MOZ_ASSERT(JS_IsArrayBufferViewObject(aObject));
+
+  // Step 3. Assert: !IsDetachedBuffer(O.[[ViewedArrayBuffer]]) is false.
+  bool isShared;
+  JS::Rooted<JSObject*> viewedArrayBuffer(
+      aCx, JS_GetArrayBufferViewBuffer(aCx, aObject, &isShared));
+  if (!viewedArrayBuffer) {
+    return nullptr;
+  }
+  MOZ_ASSERT(!JS::IsDetachedArrayBufferObject(viewedArrayBuffer));
+
+  // Step 4. Let buffer be ?CloneArrayBuffer(O.[[ViewedArrayBuffer]],
+  //         O.[[ByteOffset]], O.[[ByteLength]], %ArrayBuffer%).
+  size_t byteOffset = JS_GetTypedArrayByteOffset(aObject);
+  size_t byteLength = JS_GetTypedArrayByteLength(aObject);
+  JS::Rooted<JSObject*> buffer(
+      aCx,
+      JS::ArrayBufferClone(aCx, viewedArrayBuffer, byteOffset, byteLength));
+  if (!buffer) {
+    return nullptr;
+  }
+
+  // Step 5. Let array be ! Construct(%Uint8Array%, « buffer »).
+  JS::Rooted<JSObject*> array(
+      aCx, JS_NewUint8ArrayWithBuffer(aCx, buffer, 0,
+                                      static_cast<int64_t>(byteLength)));
+  if (!array) {
+    return nullptr;
+  }
+
+  // Step 6. Return array.
+  return array;
+}
+
+class BodyStreamUnderlyingSourceAlgorithms final
+    : public UnderlyingSourceAlgorithmsBase {
+ public:
+  NS_DECL_ISUPPORTS_INHERITED
+  NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(BodyStreamUnderlyingSourceAlgorithms,
+                                           UnderlyingSourceAlgorithmsBase)
+
+  explicit BodyStreamUnderlyingSourceAlgorithms(
+      nsIGlobalObject& aGlobal, BodyStreamHolder& aUnderlyingSource)
+      : mGlobal(&aGlobal), mUnderlyingSource(&aUnderlyingSource) {}
+
+  MOZ_CAN_RUN_SCRIPT void StartCallback(JSContext* aCx,
+                                        ReadableStreamController& aController,
+                                        JS::MutableHandle<JS::Value> aRetVal,
+                                        ErrorResult& aRv) override {
+    aRetVal.setUndefined();
+  }
+
+  MOZ_CAN_RUN_SCRIPT already_AddRefed<Promise> PullCallback(
+      JSContext* aCx, ReadableStreamController& aController,
+      ErrorResult& aRv) override {
+    RefPtr<BodyStream> bodyStream = mUnderlyingSource->GetBodyStream();
+    return bodyStream->PullCallback(aCx, aController, aRv);
+  }
+
+  MOZ_CAN_RUN_SCRIPT already_AddRefed<Promise> CancelCallback(
+      JSContext* aCx, const Optional<JS::Handle<JS::Value>>& aReason,
+      ErrorResult& aRv) override {
+    return Promise::CreateResolvedWithUndefined(mGlobal, aRv);
+  }
+
+  void ReleaseObjects() override {
+    RefPtr<BodyStreamHolder> holder = mUnderlyingSource.forget();
+    // BodyStream may not be available if this cleanup happened first from
+    // ByteStream side.
+    if (RefPtr<BodyStream> bodyStream = holder->GetBodyStream()) {
+      bodyStream->CloseInputAndReleaseObjects();
+    }
+  }
+
+  BodyStreamHolder* GetBodyStreamHolder() override { return mUnderlyingSource; }
+
+ protected:
+  ~BodyStreamUnderlyingSourceAlgorithms() override = default;
+
+ private:
+  nsCOMPtr<nsIGlobalObject> mGlobal;
+  RefPtr<BodyStreamHolder> mUnderlyingSource;
+};
+
+NS_IMPL_CYCLE_COLLECTION_INHERITED(BodyStreamUnderlyingSourceAlgorithms,
+                                   UnderlyingSourceAlgorithmsBase, mGlobal,
+                                   mUnderlyingSource)
+NS_IMPL_ADDREF_INHERITED(BodyStreamUnderlyingSourceAlgorithms,
+                         UnderlyingSourceAlgorithmsBase)
+NS_IMPL_RELEASE_INHERITED(BodyStreamUnderlyingSourceAlgorithms,
+                          UnderlyingSourceAlgorithmsBase)
+NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(BodyStreamUnderlyingSourceAlgorithms)
+NS_INTERFACE_MAP_END_INHERITING(UnderlyingSourceAlgorithmsBase)
+
+// This is gently modelled on the pre-existing
+// SetUpExternalReadableByteStreamController, but specialized to the
+// BodyStreamUnderlyingSource model vs. the External streams of the JS
+// implementation.
+//
+// https://streams.spec.whatwg.org/#set-up-readable-byte-stream-controller-from-underlying-source
+void SetUpReadableByteStreamControllerFromBodyStreamUnderlyingSource(
+    JSContext* aCx, ReadableStream* aStream,
+    BodyStreamHolder* aUnderlyingSource, ErrorResult& aRv) {
+  // Step 1.
+  auto controller =
+      MakeRefPtr<ReadableByteStreamController>(aStream->GetParentObject());
+
+  // Step 2 - 7.
+  auto algorithms = MakeRefPtr<BodyStreamUnderlyingSourceAlgorithms>(
+      *aStream->GetParentObject(), *aUnderlyingSource);
+
+  // Step 8
+  Maybe<uint64_t> autoAllocateChunkSize = mozilla::Nothing();
+  // Step 9 (Skipped)
+
+  // Not Specified: Native underlying sources always use 0.0 high water mark.
+  double highWaterMark = 0.0;
+
+  // Step 10.
+  SetUpReadableByteStreamController(aCx, aStream, controller, algorithms,
+                                    highWaterMark, autoAllocateChunkSize, aRv);
+}
+
+}  // namespace mozilla::dom