Add runtime.on performance warning #32222

rebloor · 2024-02-11T16:08:45Z

Description

Adds API documentation and release note for the runtime.on performance event introduced by Bug 1861445 Add new hang warning event API for WebExtensionswarning.

See mdn/browser-compat-data#22196 and mdn/browser-compat-data#22617 for browser compatibility data.

DO NOT MERGE until related BCD content is ready to merge.

github-actions · 2024-02-11T16:09:57Z

Preview URLs

Flaws (3)

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

URL: /en-US/docs/Mozilla/Add-ons/WebExtensions/API/runtime/OnPerformanceWarningSeverity
Title: runtime.OnPerformanceWarningSeverity
Flaw count: 1

bad_bcd_queries:
- No BCD data for query: webextensions.api.runtime.OnPerformanceWarningSeverity

URL: /en-US/docs/Mozilla/Add-ons/WebExtensions/API/runtime/onPerformanceWarning
Title: runtime.onPerformanceWarning
Flaw count: 1

bad_bcd_queries:
- No BCD data for query: webextensions.api.runtime.onPerformanceWarning

URL: /en-US/docs/Mozilla/Add-ons/WebExtensions/API/runtime/OnPerformanceWarningCategory
Title: runtime.OnPerformanceWarningCategory
Flaw count: 1

bad_bcd_queries:
- No BCD data for query: webextensions.api.runtime.OnPerformanceWarningCategory

External URLs (1)

URL: /en-US/docs/Mozilla/Firefox/Releases/124
Title: Firefox 124 for developers

https://bugzil.la/1861445 (1 time) (Note! This may be a new URL 👀)

(comment last updated: 2024-03-14 03:00:47)

Rob--W · 2024-03-04T20:02:54Z

files/en-us/mozilla/add-ons/webextensions/api/runtime/onperformancewarning/index.md

+
+  - : The function called when this event occurs. The function is passed these arguments:
+    - `category`
+      - : `string`. "content_script", the performance warning event category.


This should be the OnPerformanceWarningCategory enum. It is also exposed as the runtime.OnPerformanceWarningCategory object. It currently reports content_script categories only, but the API by design is extensible to other kinds of warnings.

Rob--W · 2024-03-04T20:03:15Z

files/en-us/mozilla/add-ons/webextensions/api/runtime/onperformancewarning/index.md

+      - : `string`. "content_script", the performance warning event category.
+    - `severity`
+      - : `string`. The performance warning event severity. One of "low", "medium", or "high".
+    - `tabId`


tabId is optional.

files/en-us/mozilla/add-ons/webextensions/api/runtime/onperformancewarning/index.md

Rob--W · 2024-03-04T20:05:07Z

files/en-us/mozilla/add-ons/webextensions/api/runtime/onperformancewarning/index.md

+
+- `listener`
+
+  - : The function called when this event occurs. The function is passed these arguments:


It is not passed these args but an object with the following properties.

See this example: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/webNavigation/onBeforeNavigate

Rob--W · 2024-03-04T20:05:46Z

files/en-us/mozilla/add-ons/webextensions/api/runtime/onperformancewarning/index.md

+
+{{Compat}}
+
+> **Note:** This API is based on Chromium's [`chrome.runtime`](https://developer.chrome.com/docs/extensions/reference/runtime/#event-onPerformanceWarning) API. This documentation is derived from [`runtime.json`](https://chromium.googlesource.com/chromium/src/+/master/extensions/common/api/runtime.json) in the Chromium code.


Please drop this boiletplate. This API doesn't even exist in Chromium.

files/en-us/mozilla/firefox/releases/124/index.md

Co-authored-by: Rob Wu <[email protected]>

rebloor · 2024-03-05T03:10:49Z

files/en-us/mozilla/add-ons/webextensions/api/runtime/onperformancewarning/index.md

+
+        - `category`
+          - : A {{WebExtAPIRef("runtime.OnPerformanceWarningCategory")}} object indicating the category of the warning.
+        - `severity`


@Rob--W Is this also an object?, e.g. OnPerformanceWarningSeverity

@rebloor If it helps, here are the entries from /toolkit/components/extensions/schemas/runtime.json:

{ "id": "OnPerformanceWarningCategory", "type": "string", "enum": ["content_script"], "description": "The performance warning event category, e.g. 'content_script'." }, { "id": "OnPerformanceWarningSeverity", "type": "string", "enum": ["low", "medium", "high"], "description": "The performance warning event severity. Will be 'high' for serious and user-visible issues." }

@kzar exactly, hence the question.

Let's inline the potential values for now; I'll clarify with other engineers whether we really want to expose the supported values on an object. If so, then we can update the documentation to add extra articles with the enum values.

I requested clarification at w3c/webextensions#456 (comment). Let's wait a week or so to allow for an answer before merging this PR.

I think that the most likely outcome is that we would retain these objects. Let's shape this patch towards that assumption since it is the least amount of work for you.

@Rob--W I see that @kzar responded to w3c/webextensions#456 (comment) - do I read that correctly that we are agreeing to document OnPerformanceWarningCategory and OnPerformanceWarningSeverity as types?

Rob--W · 2024-03-08T11:52:58Z

files/en-us/mozilla/add-ons/webextensions/api/runtime/onperformancewarning/index.md

+      - : `object`. An object with the following properties:
+
+        - `category`
+          - : A {{WebExtAPIRef("runtime.OnPerformanceWarningCategory")}} object indicating the category of the warning.


Is it not an object, but a string that holds one of the enum values.

Rob--W · 2024-03-08T12:02:22Z

files/en-us/mozilla/add-ons/webextensions/api/runtime/onperformancewarning/index.md

+
+        - `category`
+          - : A {{WebExtAPIRef("runtime.OnPerformanceWarningCategory")}} object indicating the category of the warning.
+        - `severity`


Let's inline the potential values for now; I'll clarify with other engineers whether we really want to expose the supported values on an object. If so, then we can update the documentation to add extra articles with the enum values.

kzar · 2024-03-13T18:08:50Z

files/en-us/mozilla/add-ons/webextensions/api/runtime/onperformancewarningcategory/index.md

+
+Values of this type are strings. Possible values are:
+
+- `"content_script"`: The performance warning originated from a content script.


Suggested change

- `"content_script"`: The performance warning originated from a content script.

- `"content_script"`: The performance warning relates to a slow extension content script.

Note: avoid ambiguity: the event is for content scripts of the extension itself, not others.

Rob--W

Approved with kzar's suggestion applied.

files/en-us/mozilla/add-ons/webextensions/api/runtime/onperformancewarningcategory/index.md

rebloor added 2 commits February 12, 2024 04:47

Add runtime.onPerformanceWarning

1f442bc

Release note

b1832c7

rebloor added the Content:WebExt WebExtensions docs label Feb 11, 2024

rebloor requested a review from Rob--W February 11, 2024 16:08

rebloor self-assigned this Feb 11, 2024

rebloor requested review from a team as code owners February 11, 2024 16:08

rebloor requested review from pepelsbey and removed request for a team February 11, 2024 16:08

github-actions bot added Content:Firefox Content in the Mozilla/Firefox subtree size/m [PR only] 51-500 LoC changed labels Feb 11, 2024

rebloor mentioned this pull request Feb 11, 2024

Add runtime.onPerformanceWarning mdn/browser-compat-data#22196

Merged

Rob--W requested changes Mar 4, 2024

View reviewed changes

rebloor and others added 2 commits March 5, 2024 15:10

Apply suggestions from review

49d3f48

Co-authored-by: Rob Wu <[email protected]>

Update from feedback

670f349

rebloor commented Mar 5, 2024

View reviewed changes

rebloor requested a review from Rob--W March 5, 2024 03:11

Rob--W reviewed Mar 8, 2024

View reviewed changes

rebloor mentioned this pull request Mar 13, 2024

Add runtime.onPerformanceWarning types mdn/browser-compat-data#22617

Merged

add runtime.OnPerformanceWarningSeverity

31fc90e

rebloor requested review from Rob--W and kzar March 13, 2024 10:15

kzar reviewed Mar 13, 2024

View reviewed changes

Rob--W approved these changes Mar 13, 2024

View reviewed changes

rebloor commented Mar 14, 2024

View reviewed changes

files/en-us/mozilla/add-ons/webextensions/api/runtime/onperformancewarningcategory/index.md Outdated Show resolved Hide resolved

Apply suggestions from review

b8bb8f2

rebloor merged commit 0bbf7b0 into mdn:main Mar 14, 2024
9 checks passed

rebloor deleted the add-runtime.onPerformanceWarning branch March 14, 2024 03:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add runtime.on performance warning #32222

Add runtime.on performance warning #32222

rebloor commented Feb 11, 2024 •

edited

Loading

github-actions bot commented Feb 11, 2024 •

edited

Loading

Rob--W Mar 4, 2024

Rob--W Mar 4, 2024

Rob--W Mar 4, 2024

Rob--W Mar 4, 2024

rebloor Mar 5, 2024

kzar Mar 7, 2024

rebloor Mar 8, 2024

Rob--W Mar 8, 2024

Rob--W Mar 8, 2024

rebloor Mar 11, 2024

Rob--W Mar 12, 2024

Rob--W Mar 8, 2024

Rob--W Mar 8, 2024

kzar Mar 13, 2024 •

edited

Loading

Rob--W Mar 13, 2024

Rob--W left a comment


		- `listener`

		- : The function called when this event occurs. The function is passed these arguments:


		{{Compat}}

		> Note: This API is based on Chromium's [`chrome.runtime`](https://developer.chrome.com/docs/extensions/reference/runtime/#event-onPerformanceWarning) API. This documentation is derived from [`runtime.json`](https://chromium.googlesource.com/chromium/src/+/master/extensions/common/api/runtime.json) in the Chromium code.


		Values of this type are strings. Possible values are:

		- `"content_script"`: The performance warning originated from a content script.

Add runtime.on performance warning #32222

Add runtime.on performance warning #32222

Conversation

rebloor commented Feb 11, 2024 • edited Loading

Description

github-actions bot commented Feb 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kzar Mar 13, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Rob--W left a comment

Choose a reason for hiding this comment

rebloor commented Feb 11, 2024 •

edited

Loading

github-actions bot commented Feb 11, 2024 •

edited

Loading

kzar Mar 13, 2024 •

edited

Loading