requestAnimationFrame is also available in Dedicated Workers

[chrisdavidmills]

@chrisdavidmills commented on Mon Oct 05 2020

@Kaiido commented on Mon Oct 05 2020

Content Issue

• Please close this issue, I accidentally submitted it without adding any details
• New documentation
• Correction or update

URLs of page you are seeing the problem on:

• https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
• https://developer.mozilla.org/en-US/docs/Web/API/window/cancelAnimationFrame

Details

requestAnimationFrame and cancelAnimationFrame used to be Window only methods, but it has recently been added to DedicatedWorkerGlobalScope too. https://html.spec.whatwg.org/multipage/imagebitmap-and-animations.html#animationframeprovider

interface mixin AnimationFrameProvider {
  unsigned long requestAnimationFrame(FrameRequestCallback callback);
  undefined cancelAnimationFrame(unsigned long handle);
};
Window includes AnimationFrameProvider;
DedicatedWorkerGlobalScope includes AnimationFrameProvider;

I guess the page should now be Web/API/WindowOrWorkerGlobalScope/requestAnimationFrame, but I fear this would break any link to the current /Web/API/window/requestAnimationFrame. So I'm not sure how it should get handled.

Also, compat-data should probably be updated (currently these methods are supported in Blink only).

[hamishwillee]

Yes the location is a bit messy.

@chrisdavidmills How would this normally be fixed?

My thought is that these should move below AnimationFrameProvider and then in both Window and DedicatedWorkerGlobalScope add them to a section on methods from parent classes (i.e. "Methods implemented from elsewhere" (or similar)).

Probably also a comment in https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API#worker_global_contexts_and_functions

We can support the document move in using the files/en_us/_redirects.txt

Bigger problem is perhaps example code for workers. Could be deferred to a second step.

[hamishwillee]

@ddbeck The methods window.requestAnimationFrame and window.cancelAnimationFrame are now inherited (from AnimationFrameProvider) by both window and DedicatedWorkerGlobalScope.

How does that get handled in BCD? Do the methods simply get added to DedicatedWorkerGlobalScope (as well)?

Or is it a matter of there being a separate AnimationFrameProvider entry (which will include the web_workers key)? And if the later, how is it obvious that these methods are part of window and DedicatedWorkerGlobalScope? [it looks like this way according to similar cases]

[Josh-Cena]

Fixed in #23801