dom/workers/MessageEventRunnable.cpp

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #include "MessageEventRunnable.h"
   8
   9 #include "mozilla/dom/MessageEvent.h"
  10 #include "mozilla/dom/MessageEventBinding.h"
  11 #include "mozilla/dom/RootedDictionary.h"
  12 #include "mozilla/TimelineConsumers.h"
  13 #include "mozilla/WorkerTimelineMarker.h"
  14 #include "nsQueryObject.h"
  15 #include "WorkerScope.h"
  16
  17 namespace mozilla::dom {
  18
  19 MessageEventRunnable::MessageEventRunnable(WorkerPrivate* aWorkerPrivate,
  20                                            TargetAndBusyBehavior aBehavior)
  21     : WorkerDebuggeeRunnable(aWorkerPrivate, aBehavior),
  22       StructuredCloneHolder(CloningSupported, TransferringSupported,
  23                             StructuredCloneScope::SameProcess) {}
  24
  25 bool MessageEventRunnable::DispatchDOMEvent(JSContext* aCx,
  26                                             WorkerPrivate* aWorkerPrivate,
  27                                             DOMEventTargetHelper* aTarget,
  28                                             bool aIsMainThread) {
  29   nsCOMPtr<nsIGlobalObject> parent = aTarget->GetParentObject();
  30
  31   // For some workers without window, parent is null and we try to find it
  32   // from the JS Context.
  33   if (!parent) {
  34     JS::Rooted<JSObject*> globalObject(aCx, JS::CurrentGlobalOrNull(aCx));
  35     if (NS_WARN_IF(!globalObject)) {
  36       return false;
  37     }
  38
  39     parent = xpc::NativeGlobal(globalObject);
  40     if (NS_WARN_IF(!parent)) {
  41       return false;
  42     }
  43   }
  44
  45   MOZ_ASSERT(parent);
  46
  47   JS::Rooted<JS::Value> messageData(aCx);
  48   IgnoredErrorResult rv;
  49
  50   UniquePtr<AbstractTimelineMarker> start;
  51   UniquePtr<AbstractTimelineMarker> end;
  52   bool isTimelineRecording = !TimelineConsumers::IsEmpty();
  53
  54   if (isTimelineRecording) {
  55     start = MakeUnique<WorkerTimelineMarker>(
  56         aIsMainThread
  57             ? ProfileTimelineWorkerOperationType::DeserializeDataOnMainThread
  58             : ProfileTimelineWorkerOperationType::DeserializeDataOffMainThread,
  59         MarkerTracingType::START);
  60   }
  61
  62   JS::CloneDataPolicy cloneDataPolicy;
  63   if (parent->GetClientInfo().isSome() &&
  64       parent->GetClientInfo()->AgentClusterId().isSome() &&
  65       parent->GetClientInfo()->AgentClusterId()->Equals(
  66           aWorkerPrivate->AgentClusterId())) {
  67     cloneDataPolicy.allowIntraClusterClonableSharedObjects();
  68   }
  69
  70   if (aWorkerPrivate->IsSharedMemoryAllowed()) {
  71     cloneDataPolicy.allowSharedMemoryObjects();
  72   }
  73
  74   Read(parent, aCx, &messageData, cloneDataPolicy, rv);
  75
  76   if (isTimelineRecording) {
  77     end = MakeUnique<WorkerTimelineMarker>(
  78         aIsMainThread
  79             ? ProfileTimelineWorkerOperationType::DeserializeDataOnMainThread
  80             : ProfileTimelineWorkerOperationType::DeserializeDataOffMainThread,
  81         MarkerTracingType::END);
  82     TimelineConsumers::AddMarkerForAllObservedDocShells(start);
  83     TimelineConsumers::AddMarkerForAllObservedDocShells(end);
  84   }
  85
  86   if (NS_WARN_IF(rv.Failed())) {
  87     DispatchError(aCx, aTarget);
  88     return false;
  89   }
  90
  91   Sequence<OwningNonNull<MessagePort>> ports;
  92   if (!TakeTransferredPortsAsSequence(ports)) {
  93     DispatchError(aCx, aTarget);
  94     return false;
  95   }
  96
  97   RefPtr<MessageEvent> event = new MessageEvent(aTarget, nullptr, nullptr);
  98   event->InitMessageEvent(nullptr, u"message"_ns, CanBubble::eNo,
  99                           Cancelable::eNo, messageData, u""_ns, u""_ns, nullptr,
 100                           ports);
 101
 102   event->SetTrusted(true);
 103
 104   aTarget->DispatchEvent(*event);
 105
 106   return true;
 107 }
 108
 109 bool MessageEventRunnable::WorkerRun(JSContext* aCx,
 110                                      WorkerPrivate* aWorkerPrivate) {
 111   if (mBehavior == ParentThreadUnchangedBusyCount) {
 112     // Don't fire this event if the JS object has been disconnected from the
 113     // private object.
 114     if (!aWorkerPrivate->IsAcceptingEvents()) {
 115       return true;
 116     }
 117
 118     // Once a window has frozen its workers, their
 119     // mMainThreadDebuggeeEventTargets should be paused, and their
 120     // WorkerDebuggeeRunnables should not be being executed. The same goes for
 121     // WorkerDebuggeeRunnables sent from child to parent workers, but since a
 122     // frozen parent worker runs only control runnables anyway, that is taken
 123     // care of naturally.
 124     MOZ_ASSERT(!aWorkerPrivate->IsFrozen());
 125
 126     // Similarly for paused windows; all its workers should have been informed.
 127     // (Subworkers are unaffected by paused windows.)
 128     MOZ_ASSERT(!aWorkerPrivate->IsParentWindowPaused());
 129
 130     aWorkerPrivate->AssertInnerWindowIsCorrect();
 131
 132     return DispatchDOMEvent(aCx, aWorkerPrivate,
 133                             aWorkerPrivate->ParentEventTargetRef(),
 134                             !aWorkerPrivate->GetParent());
 135   }
 136
 137   MOZ_ASSERT(aWorkerPrivate == GetWorkerPrivateFromContext(aCx));
 138
 139   return DispatchDOMEvent(aCx, aWorkerPrivate, aWorkerPrivate->GlobalScope(),
 140                           false);
 141 }
 142
 143 void MessageEventRunnable::DispatchError(JSContext* aCx,
 144                                          DOMEventTargetHelper* aTarget) {
 145   RootedDictionary<MessageEventInit> init(aCx);
 146   init.mBubbles = false;
 147   init.mCancelable = false;
 148
 149   RefPtr<Event> event =
 150       MessageEvent::Constructor(aTarget, u"messageerror"_ns, init);
 151   event->SetTrusted(true);
 152
 153   aTarget->DispatchEvent(*event);
 154 }
 155
 156 }  // namespace mozilla::dom