Bug 22718 – Implement WindowTimers interface in Workers

• Status: RESOLVED
• Resolution: FIXED
• Component: DOM

[Alexey Proskuryakov]

We need to make timers function in Workers.

[NoInterfaceObject] interface WindowTimers {
  // timers
  long setTimeout(in TimeoutHandler handler, in long timeout);
  long setTimeout(in TimeoutHandler handler, in long timeout, arguments...);
  long setTimeout(in DOMString code, in long timeout);
  long setTimeout(in DOMString code, in long timeout, in DOMString language);
  void clearTimeout(in long handle);
  long setInterval(in TimeoutHandler handler, in long timeout);
  long setInterval(in TimeoutHandler handler, in long timeout, arguments...);
  long setInterval(in DOMString code, in long timeout);
  long setInterval(in DOMString code, in long timeout, in DOMString language);
  void clearInterval(in long handle);
};

interface TimeoutHandler {
  void handleEvent([Variadic] in any args);
};

[Alexey Proskuryakov]

<rdar://problem/6425804>

[Dmitry Titov]

*** Bug 22328 has been marked as a duplicate of this bug. ***

[Dmitry Titov]

Adding timers to Workers (setTimeout,setInterval,clearTimeout,clearInterval) happened to be a big enough work to split it into multiple patches. So I keep this bug as a "root" and make small patches in separate bugs that refer to this one for context.

Here is a rough plan of this work. The main changes are related to sharing timer functionality between Document/DOMWindow and a new WorkerContext, making TimerBase to be threading-aware and changing Worker thread's run loop to support timers.

More detailed list (likely to change somewhat as a result of reviews and feedback of others):

1. Move timer-related code from JSDOMWindowBase where it currently lives into a new DOMTimer object, abstract JS engine - related parts into ScheduledAction class. This will allow to use timer functionality from both DOMWindow and WorkerContext.

2. Create a new RunLoop class to encapsulate the worker thread's run loop which has to deal with message queue and timers. This includes changes to WTF::MessageQueue (to add timedWait), TimeBase (to make it able to work on worker threads too) and other threading-related changes.

3. Expose timer functions on WorkerContext/JSWorkerContext.

[Dmitry Titov]

Created attachment 27273 [details]
Proposed patch

Final patch - enables JS API, adds a test.

[Dmitry Titov]

This patch depends on a relatively simple patch in bug 23560 for timers to actually fire. But otherwise it doesn't depend on it so it can be reviewed separately. If patch for the bug 23560 will be further modified, it won't affect this one.

[Alexey Proskuryakov]

Comment on attachment 27273 [details]
Proposed patch

r=me

[Alexey Proskuryakov]

Committed revision 40534.

Nice test case!