[webkit-changes] [WebKit/WebKit] 40f801: sequence<T> should map to Ref<T>, not RefPtr<T>

Sam Weinig noreply at github.com
Mon Apr 15 14:36:12 PDT 2024 

  Branch: refs/heads/main
  Home:   https://github.com/WebKit/WebKit
  Commit: 40f8011866933c1c5c07169d4fe5ef141ed18a1c
      https://github.com/WebKit/WebKit/commit/40f8011866933c1c5c07169d4fe5ef141ed18a1c
  Author: Sam Weinig <weinig at apple.com>
  Date:   2024-04-15 (Mon, 15 Apr 2024)

  Changed paths:
    M Source/WebCore/Modules/WebGPU/GPUPipelineLayoutDescriptor.h
    M Source/WebCore/Modules/WebGPU/GPUQueue.cpp
    M Source/WebCore/Modules/WebGPU/GPUQueue.h
    M Source/WebCore/Modules/WebGPU/GPURenderPassEncoder.cpp
    M Source/WebCore/Modules/WebGPU/GPURenderPassEncoder.h
    M Source/WebCore/Modules/applepay/ApplePayCouponCodeUpdate.h
    M Source/WebCore/Modules/applepay/ApplePayPaymentAuthorizationResult.h
    M Source/WebCore/Modules/applepay/ApplePayPaymentMethodUpdate.h
    M Source/WebCore/Modules/applepay/ApplePaySetup.cpp
    M Source/WebCore/Modules/applepay/ApplePaySetupWebCore.h
    M Source/WebCore/Modules/applepay/ApplePayShippingContactUpdate.h
    M Source/WebCore/Modules/applepay/PaymentCoordinator.cpp
    M Source/WebCore/Modules/applepay/PaymentCoordinator.h
    M Source/WebCore/Modules/applepay/PaymentCoordinatorClient.h
    M Source/WebCore/Modules/applepay/paymentrequest/ApplePayPaymentHandler.cpp
    M Source/WebCore/Modules/applepay/paymentrequest/ApplePayPaymentHandler.h
    M Source/WebCore/Modules/async-clipboard/Clipboard.cpp
    M Source/WebCore/Modules/async-clipboard/Clipboard.h
    M Source/WebCore/Modules/gamepad/Navigator+Gamepad.idl
    M Source/WebCore/Modules/mediasession/MediaSession.cpp
    M Source/WebCore/Modules/mediasession/MediaSession.h
    M Source/WebCore/Modules/mediastream/MediaStream.cpp
    M Source/WebCore/Modules/mediastream/MediaStream.h
    M Source/WebCore/Modules/mediastream/PeerConnectionBackend.cpp
    M Source/WebCore/Modules/mediastream/PeerConnectionBackend.h
    M Source/WebCore/Modules/mediastream/RTCConfiguration.h
    M Source/WebCore/Modules/mediastream/RTCPeerConnection.cpp
    M Source/WebCore/Modules/mediastream/RTCPeerConnection.h
    M Source/WebCore/Modules/mediastream/RTCRtpScriptTransform.cpp
    M Source/WebCore/Modules/mediastream/RTCRtpScriptTransformer.cpp
    M Source/WebCore/Modules/mediastream/RTCRtpScriptTransformer.h
    M Source/WebCore/Modules/mediastream/RTCTrackEvent.cpp
    M Source/WebCore/Modules/mediastream/RTCTrackEvent.h
    M Source/WebCore/Modules/mediastream/gstreamer/GStreamerPeerConnectionBackend.cpp
    M Source/WebCore/Modules/mediastream/libwebrtc/LibWebRTCMediaEndpoint.cpp
    M Source/WebCore/Modules/notifications/Notification.cpp
    M Source/WebCore/Modules/webxr/WebXRFrame.cpp
    M Source/WebCore/Modules/webxr/WebXRFrame.h
    M Source/WebCore/Modules/webxr/WebXRInputSourceArray.cpp
    M Source/WebCore/Modules/webxr/WebXRInputSourceArray.h
    M Source/WebCore/Modules/webxr/XRInputSourcesChangeEvent.cpp
    M Source/WebCore/Modules/webxr/XRInputSourcesChangeEvent.h
    M Source/WebCore/Modules/webxr/XRRenderStateInit.h
    M Source/WebCore/accessibility/AXObjectCache.cpp
    M Source/WebCore/accessibility/AXObjectCache.h
    M Source/WebCore/accessibility/AccessibilityObject.cpp
    M Source/WebCore/bindings/IDLTypes.h
    M Source/WebCore/bindings/js/IDBBindingUtilities.cpp
    M Source/WebCore/bindings/js/JSDOMConvertSequences.h
    M Source/WebCore/bindings/js/JSElementCustom.cpp
    M Source/WebCore/bindings/js/JSElementInternalsCustom.cpp
    M Source/WebCore/bindings/js/SerializedScriptValue.cpp
    M Source/WebCore/bindings/js/SerializedScriptValue.h
    M Source/WebCore/css/CSSStyleSheetObservableArray.cpp
    M Source/WebCore/css/CSSStyleSheetObservableArray.h
    M Source/WebCore/css/FontFaceSet.cpp
    M Source/WebCore/css/FontFaceSet.h
    M Source/WebCore/css/typedom/transform/CSSTransformValue.cpp
    M Source/WebCore/css/typedom/transform/CSSTransformValue.h
    M Source/WebCore/dom/AbortSignal.cpp
    M Source/WebCore/dom/AbortSignal.h
    M Source/WebCore/dom/BroadcastChannel.cpp
    M Source/WebCore/dom/CustomElementDefaultARIA.cpp
    M Source/WebCore/dom/CustomElementDefaultARIA.h
    M Source/WebCore/dom/Element.cpp
    M Source/WebCore/dom/Element.h
    M Source/WebCore/dom/ElementInternals.cpp
    M Source/WebCore/dom/ElementInternals.h
    M Source/WebCore/dom/GetHTMLOptions.h
    M Source/WebCore/dom/MessageEvent.cpp
    M Source/WebCore/dom/MessageEvent.h
    M Source/WebCore/dom/MessagePort.cpp
    M Source/WebCore/dom/MessagePort.h
    M Source/WebCore/dom/TreeScope.cpp
    M Source/WebCore/dom/TreeScope.h
    M Source/WebCore/editing/MarkupAccumulator.cpp
    M Source/WebCore/editing/MarkupAccumulator.h
    M Source/WebCore/editing/markup.cpp
    M Source/WebCore/editing/markup.h
    M Source/WebCore/html/canvas/WebGLRenderingContextBase.cpp
    M Source/WebCore/html/canvas/WebGLRenderingContextBase.h
    M Source/WebCore/inspector/InspectorAuditAccessibilityObject.cpp
    M Source/WebCore/inspector/InspectorAuditAccessibilityObject.h
    M Source/WebCore/page/LocalDOMWindow.cpp
    M Source/WebCore/page/Navigation.cpp
    M Source/WebCore/page/PerformanceMark.cpp
    M Source/WebCore/page/PerformanceUserTiming.cpp
    M Source/WebCore/page/RemoteDOMWindow.cpp
    M Source/WebCore/page/ShareData.h
    M Source/WebCore/page/ShareDataReader.cpp
    M Source/WebCore/page/WindowOrWorkerGlobalScope.cpp
    M Source/WebCore/style/StyleScope.cpp
    M Source/WebCore/testing/MockPaymentCoordinator.cpp
    M Source/WebCore/testing/MockPaymentCoordinator.h
    M Source/WebCore/workers/DedicatedWorkerGlobalScope.cpp
    M Source/WebCore/workers/Worker.cpp
    M Source/WebCore/workers/service/ExtendableMessageEvent.cpp
    M Source/WebCore/workers/service/ExtendableMessageEvent.h
    M Source/WebCore/workers/service/ServiceWorker.cpp
    M Source/WebCore/workers/service/ServiceWorkerClient.cpp
    M Source/WebCore/workers/shared/SharedWorkerGlobalScope.cpp
    M Source/WebKit/Platform/cocoa/PaymentAuthorizationPresenter.mm
    M Source/WebKit/Shared/ApplePay/ApplePayPaymentSetupFeatures.mm
    M Source/WebKit/Shared/ApplePay/ApplePayPaymentSetupFeaturesWebKit.h
    M Source/WebKit/Shared/WebCoreArgumentCoders.serialization.in
    M Source/WebKit/WebProcess/ApplePay/WebPaymentCoordinator.cpp
    M Source/WebKit/WebProcess/ApplePay/WebPaymentCoordinator.h

  Log Message:
  -----------
  sequence<T> should map to Ref<T>, not RefPtr<T>
https://bugs.webkit.org/show_bug.cgi?id=272512

Reviewed by Chris Dumez.

Improve non-null hygiene by correctly mapping WebIDL sequence<T>
(and FrozenArray<T>) to Vector<Ref<T>> rather than Vector<RefPtr<T>>
when T is an interface.

If Vector<RefPtr<T>> is needed to allow nullptr values, sequence<T?>
(and FrozenArray<T?>) will work. An example of this would be
`Navigator.getGamepads()` in Navigator+Gamepad.idl (see below).

The main implementation changes for this are:

* Source/WebCore/bindings/IDLTypes.h:
    IDLWrapper gained a SequenceStorageType, changing it from the
    default value which was RefPtr<T> to Ref<T>.

    IDLSequence and IDLFrozenArray had their ImplementationTypes
    updated to use T::InnerParameterType rather than T::ImplementationType
    (which map to Ref<T> rather than RefPtr<T>) and IDLFrozenArray
    was further updated to have its ParameterType and NullableParameterType
    match IDLSequence (having them differ has no value, they should both
    be using Ref<T> rather than RefPtr<T> for non-nullable interfaces).

* Source/WebCore/bindings/js/JSDOMConvertSequences.h:
    Conversion of the inner types was pulled out into a GenericSequenceInnerConverter
    type so that it could be specialized for IDLInterface<T>. This is needed
    because Converter<IDLInterface<T>>::convert() returns T* but guarantees
    that T* is non-null when there is no exception. We use this to convert
    it to the needed Ref<T>.

    A better long term change would be to update Converter to return a result
    type (similar, though distinct from ExceptionOr) that can encapsulate
    the result state fully, removing the need for the specialization.

* Source/WebCore/Modules/gamepad/Navigator+Gamepad.idl:
    Updated to use `sequence<Gamepad?>` rather than `sequence<Gamepad>` as this
    explicitly wants to support null values in the sequence. This now correctly
    matches the spec https://w3c.github.io/gamepad/#extensions-to-the-navigator-interface.

The remainder is all updating implementation files from using RefPtr<T> to Ref<T>.

Future improvements would be to tackle replacing more use of RefPtr<T> for known
non-null values. Some places to start:

    In WebCore alone, there are 537 matches for `Vector<RefPtr<`. From a cursory
    look, most of these should be `Vector<Ref<` (there are some examples like the
    Gamepad one above that should stay).

    IDL dictionaries currently require interface members to use RefPtr<T> (for
    example, see XRInputSourcesChangeEventInit and its session member). To resolve
    this, code generation of the convertDictionary<> functions would be need to be
    updated to delay construction of the struct until all the values are available
    since otherwise it can't have a Ref<> member.

    IDL record and unions currently use RefPtr<T> for interfaces and should be
    improved like sequence to use Ref<T>.

* Source/WebCore/Modules/WebGPU/GPUPipelineLayoutDescriptor.h:
(WebCore::GPUPipelineLayoutDescriptor::convertToBacking const):
* Source/WebCore/Modules/WebGPU/GPUQueue.cpp:
(WebCore::GPUQueue::submit):
* Source/WebCore/Modules/WebGPU/GPUQueue.h:
* Source/WebCore/Modules/WebGPU/GPURenderPassEncoder.cpp:
(WebCore::GPURenderPassEncoder::executeBundles):
* Source/WebCore/Modules/WebGPU/GPURenderPassEncoder.h:
* Source/WebCore/Modules/applepay/ApplePayCouponCodeUpdate.h:
* Source/WebCore/Modules/applepay/ApplePayPaymentAuthorizationResult.h:
* Source/WebCore/Modules/applepay/ApplePayPaymentMethodUpdate.h:
* Source/WebCore/Modules/applepay/ApplePaySetup.cpp:
(WebCore::ApplePaySetup::begin):
* Source/WebCore/Modules/applepay/ApplePaySetupWebCore.h:
* Source/WebCore/Modules/applepay/ApplePayShippingContactUpdate.h:
* Source/WebCore/Modules/applepay/PaymentCoordinator.cpp:
(WebCore::PaymentCoordinator::beginApplePaySetup):
* Source/WebCore/Modules/applepay/PaymentCoordinator.h:
* Source/WebCore/Modules/applepay/PaymentCoordinatorClient.h:
(WebCore::PaymentCoordinatorClient::beginApplePaySetup):
* Source/WebCore/Modules/applepay/paymentrequest/ApplePayPaymentHandler.cpp:
(WebCore::appendShippingContactInvalidError):
(WebCore::ApplePayPaymentHandler::computeErrors const):
(WebCore::ApplePayPaymentHandler::computeAddressErrors const):
(WebCore::ApplePayPaymentHandler::computePayerErrors const):
(WebCore::ApplePayPaymentHandler::computePaymentMethodErrors const):
(WebCore::ApplePayPaymentHandler::shippingAddressUpdated):
(WebCore::ApplePayPaymentHandler::paymentMethodUpdated):
(WebCore::ApplePayPaymentHandler::retry):
* Source/WebCore/Modules/applepay/paymentrequest/ApplePayPaymentHandler.h:
* Source/WebCore/Modules/async-clipboard/Clipboard.cpp:
(WebCore::Clipboard::write):
(WebCore::Clipboard::ItemWriter::write):
* Source/WebCore/Modules/async-clipboard/Clipboard.h:
* Source/WebCore/Modules/mediasession/MediaSession.cpp:
(WebCore::MediaSession::setPlaylist):
* Source/WebCore/Modules/mediasession/MediaSession.h:
* Source/WebCore/Modules/mediastream/MediaStream.cpp:
(WebCore::MediaStream::create):
(WebCore::MediaStream::clone):
* Source/WebCore/Modules/mediastream/MediaStream.h:
* Source/WebCore/Modules/mediastream/PeerConnectionBackend.cpp:
(WebCore::setAssociatedRemoteStreams):
* Source/WebCore/Modules/mediastream/PeerConnectionBackend.h:
* Source/WebCore/Modules/mediastream/RTCConfiguration.h:
* Source/WebCore/Modules/mediastream/RTCPeerConnection.cpp:
(WebCore::RTCPeerConnection::setConfiguration):
* Source/WebCore/Modules/mediastream/RTCPeerConnection.h:
* Source/WebCore/Modules/mediastream/RTCRtpScriptTransform.cpp:
(WebCore::RTCRtpScriptTransform::create):
* Source/WebCore/Modules/mediastream/RTCRtpScriptTransformer.cpp:
(WebCore::RTCRtpScriptTransformer::RTCRtpScriptTransformer):
* Source/WebCore/Modules/mediastream/RTCRtpScriptTransformer.h:
* Source/WebCore/Modules/mediastream/RTCTrackEvent.cpp:
(WebCore::RTCTrackEvent::create):
(WebCore::RTCTrackEvent::RTCTrackEvent):
* Source/WebCore/Modules/mediastream/RTCTrackEvent.h:
* Source/WebCore/Modules/mediastream/libwebrtc/LibWebRTCMediaEndpoint.cpp:
(WebCore::LibWebRTCMediaEndpoint::setLocalSessionDescriptionSucceeded):
(WebCore::LibWebRTCMediaEndpoint::setRemoteSessionDescriptionSucceeded):
* Source/WebCore/Modules/notifications/Notification.cpp:
(WebCore::createSerializedScriptValue):
* Source/WebCore/Modules/webxr/WebXRFrame.cpp:
(WebCore::WebXRFrame::fillJointRadii):
(WebCore::WebXRFrame::fillPoses):
* Source/WebCore/Modules/webxr/WebXRFrame.h:
* Source/WebCore/Modules/webxr/WebXRInputSourceArray.cpp:
(WebCore::WebXRInputSourceArray::update):
(WebCore::WebXRInputSourceArray::handleRemovedInputSources):
(WebCore::WebXRInputSourceArray::handleAddedOrUpdatedInputSources):
* Source/WebCore/Modules/webxr/WebXRInputSourceArray.h:
* Source/WebCore/Modules/webxr/XRInputSourcesChangeEvent.h:
* Source/WebCore/Modules/webxr/XRRenderStateInit.h:
* Source/WebCore/accessibility/AXObjectCache.cpp:
(WebCore::validRelation):
(WebCore::AXObjectCache::addRelation):
(WebCore::AXObjectCache::addLabelForRelation):
* Source/WebCore/accessibility/AXObjectCache.h:
* Source/WebCore/accessibility/AccessibilityObject.cpp:
(WebCore::AccessibilityObject::elementsFromAttribute const):
* Source/WebCore/bindings/js/IDBBindingUtilities.cpp:
(WebCore::deserializeIDBValueToJSValue):
* Source/WebCore/bindings/js/JSElementCustom.cpp:
(WebCore::getElementsArrayAttribute):
* Source/WebCore/bindings/js/JSElementInternalsCustom.cpp:
(WebCore::getElementsArrayAttribute):
* Source/WebCore/bindings/js/SerializedScriptValue.cpp:
(WebCore::CloneSerializer::serialize):
(WebCore::CloneSerializer::CloneSerializer):
(WebCore::CloneSerializer::dumpIfTerminal):
(WebCore::CloneDeserializer::deserialize):
(WebCore::CloneDeserializer::CloneDeserializer):
(WebCore::CloneDeserializer::readTerminal):
(WebCore::validateSerializedResult):
(WebCore::SerializedScriptValue::SerializedScriptValue):
(WebCore::SerializedScriptValue::create):
(WebCore::SerializedScriptValue::deserialize):
* Source/WebCore/bindings/js/SerializedScriptValue.h:
* Source/WebCore/css/CSSStyleSheetObservableArray.cpp:
(WebCore::CSSStyleSheetObservableArray::setValueAt):
(WebCore::CSSStyleSheetObservableArray::removeLast):
(WebCore::CSSStyleSheetObservableArray::valueAt const):
(WebCore::CSSStyleSheetObservableArray::setSheets):
* Source/WebCore/css/CSSStyleSheetObservableArray.h:
(WebCore::CSSStyleSheetObservableArray::sheets const):
* Source/WebCore/css/FontFaceSet.cpp:
(WebCore::FontFaceSet::create):
(WebCore::FontFaceSet::FontFaceSet):
* Source/WebCore/css/FontFaceSet.h:
* Source/WebCore/css/typedom/transform/CSSTransformValue.cpp:
(WebCore::CSSTransformValue::create):
(WebCore::CSSTransformValue::item):
(WebCore::CSSTransformValue::setItem):
(WebCore::CSSTransformValue::is2D const):
(WebCore::CSSTransformValue::CSSTransformValue):
* Source/WebCore/css/typedom/transform/CSSTransformValue.h:
* Source/WebCore/dom/AbortSignal.cpp:
(WebCore::AbortSignal::any):
* Source/WebCore/dom/AbortSignal.h:
* Source/WebCore/dom/BroadcastChannel.cpp:
(WebCore::BroadcastChannel::postMessage):
* Source/WebCore/dom/CustomElementDefaultARIA.cpp:
(WebCore::CustomElementDefaultARIA::elementsForAttribute const):
(WebCore::CustomElementDefaultARIA::setElementsForAttribute):
* Source/WebCore/dom/CustomElementDefaultARIA.h:
* Source/WebCore/dom/Element.cpp:
(WebCore::Element::getElementsArrayAttribute const):
(WebCore::Element::setElementsArrayAttribute):
* Source/WebCore/dom/Element.h:
* Source/WebCore/dom/ElementInternals.cpp:
(WebCore::ElementInternals::getElementsArrayAttribute const):
(WebCore::ElementInternals::setElementsArrayAttribute):
* Source/WebCore/dom/ElementInternals.h:
* Source/WebCore/dom/MessageEvent.cpp:
(WebCore::MessageEvent::MessageEvent):
(WebCore::MessageEvent::create):
(WebCore::MessageEvent::initMessageEvent):
* Source/WebCore/dom/MessageEvent.h:
* Source/WebCore/dom/MessagePort.cpp:
(WebCore::MessagePort::postMessage):
(WebCore::MessagePort::disentanglePorts):
(WebCore::MessagePort::entanglePorts):
* Source/WebCore/dom/MessagePort.h:
* Source/WebCore/dom/TreeScope.cpp:
(WebCore::TreeScope::adoptedStyleSheets const):
(WebCore::TreeScope::setAdoptedStyleSheets):
* Source/WebCore/dom/TreeScope.h:
* Source/WebCore/html/canvas/WebGLRenderingContextBase.cpp:
(WebCore::WebGLRenderingContextBase::getAttachedShaders):
* Source/WebCore/html/canvas/WebGLRenderingContextBase.h:
* Source/WebCore/inspector/InspectorAuditAccessibilityObject.cpp:
(WebCore::addChildren):
(WebCore::InspectorAuditAccessibilityObject::getChildNodes):
(WebCore::InspectorAuditAccessibilityObject::getControlledNodes):
(WebCore::InspectorAuditAccessibilityObject::getFlowedNodes):
(WebCore::InspectorAuditAccessibilityObject::getOwnedNodes):
(WebCore::InspectorAuditAccessibilityObject::getSelectedChildNodes):
* Source/WebCore/inspector/InspectorAuditAccessibilityObject.h:
* Source/WebCore/page/LocalDOMWindow.cpp:
(WebCore::LocalDOMWindow::postMessage):
* Source/WebCore/page/Navigation.cpp:
(WebCore::Navigation::serializeState):
* Source/WebCore/page/PerformanceMark.cpp:
(WebCore::PerformanceMark::create):
* Source/WebCore/page/PerformanceUserTiming.cpp:
(WebCore::PerformanceUserTiming::measure):
* Source/WebCore/page/RemoteDOMWindow.cpp:
(WebCore::RemoteDOMWindow::postMessage):
* Source/WebCore/page/ShareData.h:
* Source/WebCore/page/ShareDataReader.cpp:
(WebCore::ShareDataReader::start):
* Source/WebCore/page/WindowOrWorkerGlobalScope.cpp:
(WebCore::WindowOrWorkerGlobalScope::structuredClone):
* Source/WebCore/style/StyleScope.cpp:
(WebCore::Style::Scope::collectActiveStyleSheets):
* Source/WebCore/testing/MockPaymentCoordinator.cpp:
(WebCore::convert):
(WebCore::MockPaymentCoordinator::beginApplePaySetup):
* Source/WebCore/testing/MockPaymentCoordinator.h:
* Source/WebCore/workers/DedicatedWorkerGlobalScope.cpp:
(WebCore::DedicatedWorkerGlobalScope::postMessage):
* Source/WebCore/workers/Worker.cpp:
(WebCore::Worker::postMessage):
* Source/WebCore/workers/service/ExtendableMessageEvent.cpp:
(WebCore::ExtendableMessageEvent::create):
(WebCore::ExtendableMessageEvent::ExtendableMessageEvent):
* Source/WebCore/workers/service/ExtendableMessageEvent.h:
* Source/WebCore/workers/service/ServiceWorker.cpp:
(WebCore::ServiceWorker::postMessage):
* Source/WebCore/workers/service/ServiceWorkerClient.cpp:
(WebCore::ServiceWorkerClient::postMessage):
* Source/WebCore/workers/shared/SharedWorkerGlobalScope.cpp:
(WebCore::SharedWorkerGlobalScope::postConnectEvent):
* Source/WebKit/Platform/cocoa/PaymentAuthorizationPresenter.mm:
(WebKit::toNSErrors):
* Source/WebKit/Shared/ApplePay/ApplePayPaymentSetupFeatures.mm:
(WebKit::PaymentSetupFeatures::PaymentSetupFeatures):
* Source/WebKit/Shared/ApplePay/ApplePayPaymentSetupFeaturesWebKit.h:
* Source/WebKit/Shared/WebCoreArgumentCoders.serialization.in:
* Source/WebKit/WebProcess/ApplePay/WebPaymentCoordinator.cpp:
(WebKit::WebPaymentCoordinator::beginApplePaySetup):
* Source/WebKit/WebProcess/ApplePay/WebPaymentCoordinator.h:

Canonical link: https://commits.webkit.org/277512@main



To unsubscribe from these emails, change your notification settings at https://github.com/WebKit/WebKit/settings/notifications

More information about the webkit-changes mailing list