Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Addition of missing devtools details #20403

Merged
merged 26 commits into from
Jan 22, 2025

Conversation

rebloor
Copy link
Contributor

@rebloor rebloor commented Jul 23, 2023

Summary

Add details, previously missing for devtools features not supported in Firefox

Related issues

Fixes #16859

@rebloor rebloor added the data:webext Compat data for Browser Extensions. https://developer.mozilla.org/Add-ons/WebExtensions label Jul 23, 2023
@rebloor rebloor requested a review from Rob--W July 23, 2023 10:58
@rebloor rebloor self-assigned this Jul 23, 2023
Copy link
Member

@Rob--W Rob--W left a comment

Choose a reason for hiding this comment

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

Question: why are some features of edge not a mirror of Chrome?

@rebloor
Copy link
Contributor Author

rebloor commented Jul 27, 2023

@Rob--W

Question: why are some features of edge not a mirror of Chrome?

Because I missed updating them from the copied content. I will fix that.

@rebloor rebloor marked this pull request as ready for review August 9, 2023 02:09
@rebloor rebloor requested a review from Rob--W August 9, 2023 02:09
@github-actions github-actions bot added the merge conflicts 🚧 This PR needs to merge latest "main" branch to resolve a merge conflict or other issue. label Oct 27, 2023
@github-actions
Copy link

This pull request has merge conflicts that must be resolved before it can be merged.

@github-actions github-actions bot removed the merge conflicts 🚧 This PR needs to merge latest "main" branch to resolve a merge conflict or other issue. label Oct 27, 2023
@queengooborg
Copy link
Contributor

Hey @Rob--W, looks like this has been waiting on your review for a while!

@Rob--W
Copy link
Member

Rob--W commented Nov 7, 2023

While I'm not against adding explicit entries for API support statuses in the BCD, the BCD also link to MDN documentation that haven't been merged yet.

I am reluctant to merge these MDN articles, because they document Chrome-only behavior. It's my intent to revisit these PRs eventually, but it's a low priority for me.

@Elchi3
Copy link
Member

Elchi3 commented Nov 10, 2023

Should we try to get a Chrome reviewer for this one?

@Rob--W
Copy link
Member

Rob--W commented Nov 10, 2023

That's not necessary. I am familiar with this API in both Firefox and Chrome.

The difficulty here is presenting the content in a way such that it is obvious which parts are cross-browser and which ones are Chrome-only. The current documentation lists the least common denominator, so anyone who relies on that can build an extension that works across browsers.

If we add the Chrome-specific bits here as well, then I'm concerned that an extension dev would try out the documentation and then become disappointed when they discovered that the documented features don't actually work in Firefox.

@queengooborg
Copy link
Contributor

I think that so long as the browser compatibility data is up to date, then we should be fine on that front. Web extensions don't have a standard specification that we can refer to, so since browsers are free to implement what they want to, I wouldn't expect much cross-browser support anyways.

@rebloor
Copy link
Contributor Author

rebloor commented Nov 13, 2023

Also addresses #16859

@github-actions github-actions bot added the merge conflicts 🚧 This PR needs to merge latest "main" branch to resolve a merge conflict or other issue. label Mar 8, 2024
Copy link

github-actions bot commented Mar 8, 2024

This pull request has merge conflicts that must be resolved before it can be merged.

@queengooborg
Copy link
Contributor

This PR has been sitting around in need of a review for a while, and is the second oldest PR open. We should get this reviewed and landed, or close it!

@Rob--W
Copy link
Member

Rob--W commented May 12, 2024

I think that it is okay for BCD notes to be added, even without mdn documentation. @rebloor could you update the PR and tag dotproto for review? If there is anything that requires my attention, please pm me.

@github-actions github-actions bot removed the merge conflicts 🚧 This PR needs to merge latest "main" branch to resolve a merge conflict or other issue. label Aug 9, 2024
@queengooborg queengooborg marked this pull request as draft August 28, 2024 13:44
@rebloor rebloor marked this pull request as ready for review September 13, 2024 18:47
@github-actions github-actions bot added the size:l [PR only] 101-1000 LoC changed label Nov 22, 2024
@caugner
Copy link
Contributor

caugner commented Dec 3, 2024

@rebloor Since this PR updates support data for Chromium, Firefox, and Safari, and we seem to be differently certain about each of the browsers, how about we split this up and extract Chromium/Safari changes into two separate PRs? I think it'll be easier to land it that way.

PS: Meanwhile eef1292 has added some Chromium data for the devtools API.

@caugner
Copy link
Contributor

caugner commented Jan 8, 2025

@rebloor Please let me know if there is anything I can help with to advance this PR.

@rebloor
Copy link
Contributor Author

rebloor commented Jan 10, 2025

@caugner Sorry for not responding earlier. This one has been held up as I originally tied it to MDN doc changes for the APIs but it became subject to an, as yet unresolved, discussion about how far we go in the documenting features that aren't available on Firefox. In looking back, however, I do notice that Rob was happy to add the BCD.

I'm also not sure how much of a challenge we have in eliminating the "version_added": true references.

Before your Monday, I'll have a look at:

  • resolving the merge conflicts
  • figure out what we need to do to remove the remaining "true" refs
  • determine whether splitting the Firefox changes is useful.

Copy link
Contributor

@caugner caugner left a comment

Choose a reason for hiding this comment

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

I looked into all the version_added: true instances.

webextensions/api/devtools.json Outdated Show resolved Hide resolved
webextensions/api/devtools.json Outdated Show resolved Hide resolved
webextensions/api/devtools.json Outdated Show resolved Hide resolved
webextensions/api/devtools.json Outdated Show resolved Hide resolved
webextensions/api/devtools.json Outdated Show resolved Hide resolved
webextensions/api/devtools.json Outdated Show resolved Hide resolved
webextensions/api/devtools.json Outdated Show resolved Hide resolved
webextensions/api/devtools.json Outdated Show resolved Hide resolved
webextensions/api/devtools.json Outdated Show resolved Hide resolved
webextensions/api/devtools.json Outdated Show resolved Hide resolved
@rebloor
Copy link
Contributor Author

rebloor commented Jan 10, 2025

Thanks @caugner - more from me by Monday

@rebloor
Copy link
Contributor Author

rebloor commented Jan 13, 2025

@caugner thanks for tracking down the version information. I've incorporated the changes. If you're happy with the update, so am I, please go ahead and merge.

Copy link
Contributor

@caugner caugner left a comment

Choose a reason for hiding this comment

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

@rebloor I had another look at those remaining ranges, and some of them appeared to be wrong (probably my own fault):

webextensions/api/devtools.json Outdated Show resolved Hide resolved
webextensions/api/devtools.json Outdated Show resolved Hide resolved
webextensions/api/devtools.json Outdated Show resolved Hide resolved
webextensions/api/devtools.json Outdated Show resolved Hide resolved
webextensions/api/devtools.json Outdated Show resolved Hide resolved
webextensions/api/devtools.json Outdated Show resolved Hide resolved
webextensions/api/devtools.json Outdated Show resolved Hide resolved
webextensions/api/devtools.json Outdated Show resolved Hide resolved
@rebloor rebloor requested a review from caugner January 14, 2025 15:57
Copy link
Contributor

@caugner caugner left a comment

Choose a reason for hiding this comment

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

So panels.sources was first documented in Chrome 38 (chromium/chromium@8e78a4d), and referencedSourcesPanel, for which documentation was only added in Chrome 41 (chromium/chromium@35a3d25).

Also, createSidebarPane on SourcesPanel was first documented in Chrome 41 (chromium/chromium@35a3d25).

I will see if I can dig into blink history to find out more, but overall this suggests these were added in or before Chrome 38. In Chrome 18, createSidebarPane was only added on the ElementsPanel, and this is likely where prior confusion came from.

webextensions/api/devtools.json Show resolved Hide resolved
webextensions/api/devtools.json Outdated Show resolved Hide resolved
webextensions/api/devtools.json Show resolved Hide resolved
webextensions/api/devtools.json Outdated Show resolved Hide resolved
@caugner
Copy link
Contributor

caugner commented Jan 21, 2025

@rebloor Sorry for these extra rounds, but I think this is finally in a state we can comfortably merge it?!

@rebloor
Copy link
Contributor Author

rebloor commented Jan 22, 2025

Thanks @caugner was all rather old detail details to track down.

@rebloor rebloor merged commit 182193b into mdn:main Jan 22, 2025
9 checks passed
@mdn-bot mdn-bot mentioned this pull request Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
data:webext Compat data for Browser Extensions. https://developer.mozilla.org/Add-ons/WebExtensions size:l [PR only] 101-1000 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Content suggestion: chrome.devtools.panels.SourcesPanel
6 participants