1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
|
/*
* Copyright (C) 2017-2023 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "config.h"
#include "AbortSignal.h"
#include "AbortAlgorithm.h"
#include "DOMException.h"
#include "DOMTimer.h"
#include "Event.h"
#include "EventNames.h"
#include "JSDOMException.h"
#include "ScriptExecutionContext.h"
#include "WebCoreOpaqueRoot.h"
#include <JavaScriptCore/Exception.h>
#include <JavaScriptCore/JSCast.h>
#include <wtf/IsoMallocInlines.h>
namespace WebCore {
WTF_MAKE_ISO_ALLOCATED_IMPL(AbortSignal);
Ref<AbortSignal> AbortSignal::create(ScriptExecutionContext* context)
{
return adoptRef(*new AbortSignal(context));
}
// https://dom.spec.whatwg.org/#dom-abortsignal-abort
Ref<AbortSignal> AbortSignal::abort(JSDOMGlobalObject& globalObject, ScriptExecutionContext& context, JSC::JSValue reason)
{
ASSERT(reason);
if (reason.isUndefined())
reason = toJS(&globalObject, &globalObject, DOMException::create(AbortError));
return adoptRef(*new AbortSignal(&context, Aborted::Yes, reason));
}
// https://dom.spec.whatwg.org/#dom-abortsignal-timeout
Ref<AbortSignal> AbortSignal::timeout(ScriptExecutionContext& context, uint64_t milliseconds)
{
auto signal = adoptRef(*new AbortSignal(&context));
signal->setHasActiveTimeoutTimer(true);
auto action = [signal](ScriptExecutionContext& context) mutable {
signal->setHasActiveTimeoutTimer(false);
auto* globalObject = JSC::jsCast<JSDOMGlobalObject*>(context.globalObject());
if (!globalObject)
return;
auto& vm = globalObject->vm();
Locker locker { vm.apiLock() };
signal->signalAbort(toJS(globalObject, globalObject, DOMException::create(TimeoutError)));
};
DOMTimer::install(context, WTFMove(action), Seconds::fromMilliseconds(milliseconds), DOMTimer::Type::SingleShot);
return signal;
}
Ref<AbortSignal> AbortSignal::any(ScriptExecutionContext& context, const Vector<RefPtr<AbortSignal>>& signals)
{
auto resultSignal = adoptRef(*new AbortSignal(&context));
auto abortedSignalIndex = signals.findIf([](auto& signal) { return signal->aborted(); });
if (abortedSignalIndex != notFound) {
resultSignal->signalAbort(signals[abortedSignalIndex]->reason().getValue());
return resultSignal;
}
resultSignal->markAsDependent();
for (auto& signal : signals)
resultSignal->addSourceSignal(*signal);
return resultSignal;
}
AbortSignal::AbortSignal(ScriptExecutionContext* context, Aborted aborted, JSC::JSValue reason)
: ContextDestructionObserver(context)
, m_reason(reason)
, m_aborted(aborted == Aborted::Yes)
{
ASSERT(reason);
}
AbortSignal::~AbortSignal() = default;
void AbortSignal::addSourceSignal(AbortSignal& signal)
{
if (signal.isDependent()) {
for (auto& sourceSignal : signal.sourceSignals())
addSourceSignal(sourceSignal);
return;
}
ASSERT(!signal.aborted());
ASSERT(signal.sourceSignals().isEmptyIgnoringNullReferences());
m_sourceSignals.add(signal);
signal.addDependentSignal(*this);
}
void AbortSignal::addDependentSignal(AbortSignal& signal)
{
m_dependentSignals.add(signal);
}
// https://dom.spec.whatwg.org/#abortsignal-signal-abort
void AbortSignal::signalAbort(JSC::JSValue reason)
{
// 1. If signal's aborted flag is set, then return.
if (m_aborted)
return;
// 2. Set signal’s aborted flag.
m_aborted = true;
m_sourceSignals.clear();
// FIXME: This code is wrong: we should emit a write-barrier. Otherwise, GC can collect it.
// https://bugs.webkit.org/show_bug.cgi?id=236353
ASSERT(reason);
m_reason.setWeakly(reason);
Ref protectedThis { *this };
auto algorithms = std::exchange(m_algorithms, { });
for (auto& algorithm : algorithms)
algorithm.second(reason);
// 5. Fire an event named abort at signal.
dispatchEvent(Event::create(eventNames().abortEvent, Event::CanBubble::No, Event::IsCancelable::No));
for (auto& dependentSignal : std::exchange(m_dependentSignals, { }))
Ref { dependentSignal }->signalAbort(reason);
}
// https://dom.spec.whatwg.org/#abortsignal-follow
void AbortSignal::signalFollow(AbortSignal& signal)
{
if (aborted())
return;
if (signal.aborted()) {
signalAbort(signal.reason().getValue());
return;
}
ASSERT(!m_followingSignal);
m_followingSignal = signal;
signal.addAlgorithm([weakThis = WeakPtr<AbortSignal, WeakPtrImplWithEventTargetData> { this }](JSC::JSValue reason) {
if (weakThis)
weakThis->signalAbort(reason);
});
}
void AbortSignal::eventListenersDidChange()
{
m_hasAbortEventListener = hasEventListeners(eventNames().abortEvent);
}
uint32_t AbortSignal::addAbortAlgorithmToSignal(AbortSignal& signal, Ref<AbortAlgorithm>&& algorithm)
{
if (signal.aborted()) {
algorithm->handleEvent(signal.m_reason.getValue());
return 0;
}
return signal.addAlgorithm([algorithm = WTFMove(algorithm)](JSC::JSValue value) mutable {
algorithm->handleEvent(value);
});
}
void AbortSignal::removeAbortAlgorithmFromSignal(AbortSignal& signal, uint32_t algorithmIdentifier)
{
signal.removeAlgorithm(algorithmIdentifier);
}
uint32_t AbortSignal::addAlgorithm(Algorithm&& algorithm)
{
m_algorithms.append(std::make_pair(++m_algorithmIdentifier, WTFMove(algorithm)));
return m_algorithmIdentifier;
}
void AbortSignal::removeAlgorithm(uint32_t algorithmIdentifier)
{
m_algorithms.removeFirstMatching([algorithmIdentifier](auto& pair) {
return pair.first == algorithmIdentifier;
});
}
void AbortSignal::throwIfAborted(JSC::JSGlobalObject& lexicalGlobalObject)
{
if (!aborted())
return;
auto& vm = lexicalGlobalObject.vm();
auto scope = DECLARE_THROW_SCOPE(vm);
throwException(&lexicalGlobalObject, scope, m_reason.getValue());
}
WebCoreOpaqueRoot root(AbortSignal* signal)
{
return WebCoreOpaqueRoot { signal };
}
} // namespace WebCore
|