File: WorkerTestUtils.cpp

package info (click to toggle)
firefox 143.0.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,617,328 kB
  • sloc: cpp: 7,478,492; javascript: 6,417,157; ansic: 3,720,058; python: 1,396,372; xml: 627,523; asm: 438,677; java: 186,156; sh: 63,477; makefile: 19,171; objc: 13,059; perl: 12,983; yacc: 4,583; cs: 3,846; pascal: 3,405; lex: 1,720; ruby: 1,003; exp: 762; php: 436; lisp: 258; awk: 247; sql: 66; sed: 53; csh: 10
file content (176 lines) | stat: -rw-r--r-- 5,553 bytes parent folder | download | duplicates (4)
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
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* 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/WorkerTestUtils.h"

#include "mozilla/ErrorResult.h"
#include "mozilla/Monitor.h"
#include "mozilla/RefPtr.h"
#include "mozilla/dom/WorkerPrivate.h"
#include "mozilla/dom/WorkerRef.h"
#include "mozilla/dom/WorkerTestUtilsBinding.h"
#include "nsIObserverService.h"
#include "nsThreadUtils.h"

namespace mozilla::dom {

uint32_t WorkerTestUtils::CurrentTimerNestingLevel(const GlobalObject& aGlobal,
                                                   ErrorResult& aErr) {
  MOZ_ASSERT(!NS_IsMainThread());
  WorkerPrivate* worker = GetCurrentThreadWorkerPrivate();
  MOZ_ASSERT(worker);
  return worker->GetCurrentTimerNestingLevel();
}

bool WorkerTestUtils::IsRunningInBackground(const GlobalObject&,
                                            ErrorResult& aErr) {
  MOZ_ASSERT(!NS_IsMainThread());
  WorkerPrivate* worker = GetCurrentThreadWorkerPrivate();
  MOZ_ASSERT(worker);
  return worker->IsRunningInBackground();
}

namespace {

// Helper for HoldStrongWorkerRefUntilMainThreadObserverNotified that optionally
// holds a ThreadSafeWorkerRef until the given observer notification is notified
// and also notifies a monitor.
class WorkerTestUtilsObserver final : public nsIObserver {
 public:
  WorkerTestUtilsObserver(const nsACString& aTopic,
                          RefPtr<ThreadSafeWorkerRef>&& aWorkerRef)
      : mMonitor("WorkerTestUtils"),
        mTopic(aTopic),
        mWorkerRef(std::move(aWorkerRef)),
        mRegistered(false),
        mObserved(false) {}

  NS_DECL_THREADSAFE_ISUPPORTS
  NS_IMETHOD Observe(nsISupports* aSubject, const char* aTopic,
                     const char16_t* aData) override {
    // We only register for one topic so we don't actually need to compare it.
    nsCOMPtr<nsIObserverService> observerService =
        services::GetObserverService();
    MOZ_ALWAYS_SUCCEEDS(observerService->RemoveObserver(this, mTopic.get()));

    // The ThreadSafeWorkerRef is responsible for / knows how to drop the
    // underlying StrongWorkerRef on the worker.
    mWorkerRef = nullptr;

    MonitorAutoLock lock(mMonitor);
    mObserved = true;
    mMonitor.Notify();

    return NS_OK;
  }

  void Register() {
    nsCOMPtr<nsIObserverService> observerService =
        services::GetObserverService();
    MOZ_ALWAYS_SUCCEEDS(
        observerService->AddObserver(this, mTopic.get(), false));

    MonitorAutoLock lock(mMonitor);
    mRegistered = true;
    mMonitor.Notify();
  }

  void WaitOnRegister() {
    MonitorAutoLock lock(mMonitor);
    while (!mRegistered) {
      mMonitor.Wait();
    }
  }

  void WaitOnObserver() {
    MonitorAutoLock lock(mMonitor);
    while (!mObserved) {
      mMonitor.Wait();
    }
  }

 private:
  ~WorkerTestUtilsObserver() = default;

  Monitor mMonitor;
  nsAutoCString mTopic;
  RefPtr<ThreadSafeWorkerRef> mWorkerRef;
  bool mRegistered;
  bool mObserved;
};

NS_IMPL_ISUPPORTS(WorkerTestUtilsObserver, nsIObserver)

}  // anonymous namespace

void WorkerTestUtils::HoldStrongWorkerRefUntilMainThreadObserverNotified(
    const GlobalObject&, const nsACString& aTopic, ErrorResult& aErr) {
  MOZ_ASSERT(!NS_IsMainThread());

  WorkerPrivate* workerPrivate = GetCurrentThreadWorkerPrivate();
  MOZ_ASSERT(workerPrivate);

  RefPtr<StrongWorkerRef> strongWorkerRef =
      StrongWorkerRef::Create(workerPrivate, "WorkerTestUtils");
  if (NS_WARN_IF(!strongWorkerRef)) {
    aErr.Throw(NS_ERROR_FAILURE);
    return;
  }

  RefPtr<ThreadSafeWorkerRef> tsWorkerRef =
      new ThreadSafeWorkerRef(strongWorkerRef);

  auto observer =
      MakeRefPtr<WorkerTestUtilsObserver>(aTopic, std::move(tsWorkerRef));

  aErr = NS_DispatchToMainThread(NewRunnableMethod(
      "WorkerTestUtils::HoldStrongWorkerRefUntilMainThreadObserverNotified",
      observer, &WorkerTestUtilsObserver::Register));

  // Wait for the observer to be registered before returning control so that we
  // can be certain we won't miss an observer notification.
  observer->WaitOnRegister();
}

void WorkerTestUtils::BlockUntilMainThreadObserverNotified(
    const GlobalObject&, const nsACString& aTopic,
    WorkerTestCallback& aWhenObserving, ErrorResult& aErr) {
  MOZ_ASSERT(!NS_IsMainThread());

  auto observer = MakeRefPtr<WorkerTestUtilsObserver>(aTopic, nullptr);

  aErr = NS_DispatchToMainThread(
      NewRunnableMethod("WorkerTestUtils::BlockUntilMainThreadObserverNotified",
                        observer, &WorkerTestUtilsObserver::Register));
  if (aErr.Failed()) {
    return;
  }

  observer->WaitOnRegister();

  aWhenObserving.Call(aErr);
  if (aErr.Failed()) {
    return;
  }

  observer->WaitOnObserver();
}

void WorkerTestUtils::NotifyObserverOnMainThread(const GlobalObject&,
                                                 const nsACString& aTopic,
                                                 ErrorResult& aErr) {
  MOZ_ASSERT(!NS_IsMainThread());

  aErr = NS_DispatchToMainThread(NS_NewRunnableFunction(
      "WorkerTestUtils::NotifyObserverOnMainThread",
      [topic = nsCString(aTopic)] {
        nsCOMPtr<nsIObserverService> observerService =
            services::GetObserverService();
        observerService->NotifyObservers(nullptr, topic.get(), nullptr);
      }));
}

}  // namespace mozilla::dom