Skip to content

Prioritized Task Scheduling API#15978

Merged
hamishwillee merged 5 commits intomdn:mainfrom
hamishwillee:prioritized_task_api
Jun 13, 2022
Merged

Prioritized Task Scheduling API#15978
hamishwillee merged 5 commits intomdn:mainfrom
hamishwillee:prioritized_task_api

Conversation

@hamishwillee
Copy link
Collaborator

@hamishwillee hamishwillee commented May 13, 2022 •
edited
Loading

FF101 delivers the Prioritized Task Scheduling API (a prototype) in https://bugzilla.mozilla.org/show_bug.cgi?id=1734997

This documents the API. Guide is in the API Overview doc.
It also includes update to experimental features.

Other docs work can be tracked in #15468

@github-actions github-actions bot added the Content:WebAPI Web API docs label May 13, 2022
@github-actions
Copy link
Contributor

github-actions bot commented May 13, 2022 •
edited
Loading

Preview URLs

Flaws

Note! 10 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/API/TaskSignal
Title: TaskSignal
on GitHub
Flaw count: 1

  • bad_bcd_links:
    • no explanation!

URL: /en-US/docs/Web/API/TaskSignal/prioritychange_event
Title: TaskSignal: prioritychange event
on GitHub
Flaw count: 1

  • bad_bcd_links:
    • no explanation!

URL: /en-US/docs/Web/API/Window
Title: Window
on GitHub
Flaw count: 25

  • macros:
    • /en-US/docs/Web/API/Window/messageManager does not exist
    • /en-US/docs/Web/API/Window/performance redirects to /en-US/docs/Web/API/performance_property
    • /en-US/docs/Web/API/Window/returnValue does not exist
    • /en-US/docs/Web/API/Window/setResizable does not exist
    • /en-US/docs/Web/API/Window/home does not exist
    • and 16 more flaws omitted
  • broken_links:
    • Can't resolve /en-US/docs/The_message_manager
  • bad_bcd_links:
    • no explanation!
    • no explanation!
    • no explanation!

URL: /en-US/docs/Web/API/Scheduler/postTask
Title: Scheduler.postTask()
on GitHub
Flaw count: 1

  • broken_links:
    • Anchor not lowercase

URL: /en-US/docs/Web/API/WorkerGlobalScope
Title: WorkerGlobalScope
on GitHub
Flaw count: 1

  • macros:
    • /en-US/docs/Web/API/WorkerGlobalScope/performance redirects to /en-US/docs/Web/API/performance_property

URL: /en-US/docs/Mozilla/Firefox/Experimental_features
Title: Experimental features in Firefox
on GitHub
Flaw count: 1

  • macros:
    • /en-US/docs/Web/API/Document/autoplayPolicy does not exist

External URLs

URL: /en-US/docs/Web/API/TaskController
Title: TaskController
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/TaskController/TaskController
Title: TaskController()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/TaskController/setPriority
Title: TaskController.setPriority()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/TaskSignal
Title: TaskSignal
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/TaskSignal/prioritychange_event
Title: TaskSignal: prioritychange event
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/TaskSignal/priority
Title: TaskSignal.priority
on GitHub

URL: /en-US/docs/Web/API/Window
Title: Window
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Window/scheduler
Title: scheduler
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/TaskPriorityChangeEvent
Title: TaskPriorityChangeEvent
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/TaskPriorityChangeEvent/TaskPriorityChangeEvent
Title: TaskPriorityChangeEvent()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/TaskPriorityChangeEvent/previousPriority
Title: TaskPriorityChangeEvent.previousPriority
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Scheduler
Title: Scheduler
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Scheduler/postTask
Title: Scheduler.postTask()
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/WorkerGlobalScope
Title: WorkerGlobalScope
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Prioritized_Task_Scheduling_API
Title: Prioritized Task Scheduling API
on GitHub

URL: /en-US/docs/Mozilla/Firefox/Experimental_features
Title: Experimental features in Firefox
on GitHub

No new external URLs

(this comment was updated 2022-06-10 01:38:45.271214)

hamishwillee
hamishwillee commented May 13, 2022
View reviewed changes
hamishwillee
hamishwillee commented May 13, 2022
View reviewed changes
hamishwillee
hamishwillee commented May 13, 2022
View reviewed changes
teoli2003
teoli2003 reviewed May 13, 2022
View reviewed changes
Copy link
Contributor

@teoli2003 teoli2003 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a few drive-by comments.

@hamishwillee hamishwillee mentioned this pull request May 13, 2022
Closed
7 tasks
teoli2003
teoli2003 reviewed May 16, 2022
View reviewed changes
@github-actions github-actions bot added Content:Accessibility Accessibility docs Content:CSS Cascading Style Sheets docs Content:Glossary Glossary entries Content:HTML Hypertext Markup Language docs Content:HTTP HTTP docs Content:JS JavaScript docs Content:Learn Learning area docs Content:MathML MathML docs Content:Media Media docs Content:Other Any docs not covered by another "Content:" label Content:SVG SVG docs Content:wasm WebAssembly docs Content:WebExt WebExtensions docs labels May 23, 2022
@hamishwillee hamishwillee force-pushed the prioritized_task_api branch from cae83c3 to 50dbbcd Compare May 23, 2022 08:06
@github-actions github-actions bot removed Content:WebExt WebExtensions docs Content:Glossary Glossary entries Content:Accessibility Accessibility docs Content:Learn Learning area docs Content:HTML Hypertext Markup Language docs Content:JS JavaScript docs labels May 23, 2022
@hamishwillee hamishwillee requested a review from fiji-flo May 24, 2022 10:34
hamishwillee
hamishwillee commented May 24, 2022
View reviewed changes
@hamishwillee
Copy link
Collaborator Author

hamishwillee commented May 24, 2022 •
edited
Loading

@teoli2003 This is getting close but isn't quite ready for full review. However I would appreciate a partial review of the bits that have been done if you are able?

EDITED: Remaining tasks:

  • Scheduler.postTask() example
  • WindowOrWorkerGlobalScope.scheduler - create a doc and cross link
  • Add ^^ to window and the worker global scope
  • Review/spellcheck/mark

@hamishwillee hamishwillee force-pushed the prioritized_task_api branch from e0f57e2 to e54fa8d Compare May 24, 2022 10:51
@hamishwillee hamishwillee force-pushed the prioritized_task_api branch from 9fc74f5 to 7ee4d87 Compare May 31, 2022 01:53
hamishwillee
hamishwillee commented May 31, 2022
View reviewed changes
files/en-us/web/api/window/scheduler/index.md
@@ -0,0 +1,66 @@
---
Copy link
Collaborator Author

@hamishwillee hamishwillee May 31, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI , this is the global object. To prevent file clash with the Scheduler interface this file lives under Window. However it is described as a global object where it is referenced.

@hamishwillee
Copy link
Collaborator Author

hamishwillee commented May 31, 2022

This is now ready for review. It is waiting on BCD for the global scheduler property, and I will also need to add that to the sidebar, provided this gets merged.

@hamishwillee hamishwillee requested a review from a team as a code owner May 31, 2022 04:00
@hamishwillee hamishwillee requested review from dipikabh and removed request for a team May 31, 2022 04:00
@github-actions github-actions bot added the Content:Other Any docs not covered by another "Content:" label label May 31, 2022
hamishwillee
hamishwillee commented May 31, 2022
View reviewed changes
files/en-us/mozilla/firefox/experimental_features/index.md
The [Prioritized Task Scheduling API](/en-US/docs/Web/API/Prioritized_Task_Scheduling_API) provides a standardized way to prioritize all tasks belonging to an application, whether they defined in a website developer's code, or in third party libraries and frameworks.

This is enabled on Firefox Nightly (only) from Firefox 101.
No preference is provided to allow it to be enabled in other releases.
Copy link
Collaborator Author

@hamishwillee hamishwillee May 31, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As no preference provided you can't turn is on for other releases. As such, no point in adding the normal table showing what's enabled or not in each release.

teoli2003
teoli2003 reviewed Jun 3, 2022
View reviewed changes
teoli2003
teoli2003 reviewed Jun 3, 2022
View reviewed changes
teoli2003
teoli2003 reviewed Jun 3, 2022
View reviewed changes
teoli2003
teoli2003 reviewed Jun 3, 2022
View reviewed changes
teoli2003
teoli2003 reviewed Jun 3, 2022
View reviewed changes
teoli2003
teoli2003 reviewed Jun 3, 2022
View reviewed changes
teoli2003
teoli2003 reviewed Jun 3, 2022
View reviewed changes
teoli2003
teoli2003 reviewed Jun 3, 2022
View reviewed changes
teoli2003
teoli2003 approved these changes Jun 10, 2022
View reviewed changes
Copy link
Contributor

@teoli2003 teoli2003 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@teoli2003
Copy link
Contributor

teoli2003 commented Jun 10, 2022

@hamishwillee Not sure if you want more people to review, so I'm not merging. But if not, you can just merge it.

@hamishwillee
Copy link
Collaborator Author

hamishwillee commented Jun 13, 2022

Thanks very much @teoli2003 . I wasn't sure if you'd done a drive-by review or a full review - so I'd also asked Will for a review. Since you're happy and he's on holiday, let's merge. We can always iterated (it is unlikely to be "wrong", just not necessarily best examples etc.)

@hamishwillee hamishwillee merged commit 283e8a7 into mdn:main Jun 13, 2022
@hamishwillee hamishwillee deleted the prioritized_task_api branch June 13, 2022 01:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jpmedley jpmedley Awaiting requested review from jpmedley jpmedley was automatically assigned from mdn/yari-content-web-api

@fiji-flo fiji-flo Awaiting requested review from fiji-flo

@dipikabh dipikabh Awaiting requested review from dipikabh dipikabh was automatically assigned from mdn/yari-content-mdn

1 more reviewer

@teoli2003 teoli2003 teoli2003 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Content:Other Any docs not covered by another "Content:" label Content:WebAPI Web API docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@hamishwillee @teoli2003