Add a high-level inspector-panel architecture doc to devtools/docs

RESOLVED FIXED in Firefox 46

Status

()

Firefox
Developer Tools: Inspector
RESOLVED FIXED
3 years ago
2 years ago

People

(Reporter: pbro, Assigned: pbro)

Tracking

unspecified
Firefox 46
Points:
---

Firefox Tracking Flags

(firefox46 fixed)

Details

Attachments

(1 attachment)

Comment hidden (empty)
(Assignee)

Updated

3 years ago
Assignee: nobody → pbrosset
Status: NEW → ASSIGNED
(Assignee)

Comment 1

3 years ago
Created attachment 8699903 [details] [diff] [review]
Bug_1233663_-_Create_high-level_architecture_inspe.diff

These are essentially the notes from my 5 minutes tech talk about the inspector-panel at one of our devtools meetings, converted to markdown, and added to /devtools/docs (as discussed with jlongster).
We can iterate/clarify/add but that's a start I guess.
Attachment #8699903 - Flags: review?(bgrinstead)
Comment on attachment 8699903 [details] [diff] [review]
Bug_1233663_-_Create_high-level_architecture_inspe.diff

Review of attachment 8699903 [details] [diff] [review]:
-----------------------------------------------------------------

::: devtools/docs/inspector-panel.md
@@ +24,5 @@
> +                                                     +- AnimationInspector
> +
> +## Server dependencies
> +- The inspector panel relies on a series of actors that live on the server.
> +- Some of the most important actors are actually instantiated by the toolbox. Because these actors are useful to other panels too (mostly to preview and/or link DOM nodes, for example the webconsole needs to output DOM nodes and highlight them in the page on mouseover and select them in the inspector on click, this is achieved using some of the same actors that the inspector panel uses).

long parenthesized block here.  What about something like:

Some of the most important actors are actually instantiated by the toolbox, because these actors are needed for other panels to preview and link to DOM nodes.  For example, the webconsole needs to output DOM nodes, highlight them in the page on mouseover, and open them in the inspector on click.  This is achieved using some of the same actors that the inspector panel uses.

@@ +28,5 @@
> +- Some of the most important actors are actually instantiated by the toolbox. Because these actors are useful to other panels too (mostly to preview and/or link DOM nodes, for example the webconsole needs to output DOM nodes and highlight them in the page on mouseover and select them in the inspector on click, this is achieved using some of the same actors that the inspector panel uses).
> +- See Toolbox.prototype.initInspector: This method instantiates the InspectorActor, WalkerActor and HighlighterActor lazily, whenever they're needed by a panel.
> +
> +## Panel loading overview
> +- As for other panels, this starts with Toolbox.prototype.loadTool(id)

'As with' or 'Like'

@@ +56,5 @@
> +
> +__InspectorActor__
> +
> +The (tab-level) actor the inspector panel connects to.
> +Doesn't do much apart from creating and returning the WalkerActor and

Looks like some manual word wrappping here, shouldn't need that as it isn't done elsewhere in the file

@@ +75,5 @@
> +- Emits events when there are DOM mutations. These events are sent to the front-end and used to, for example refresh the markup-view. This uses an instance of MutationObserver (https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver) configured with, in particular, nativeAnonymousChildList set to true, so that mutation events are also sent when pseudo elements are added/removed via css.
> +
> +__NodeActor__
> +
> +- Representation of a single DOM node (tagname, namespace, attributes,

Word wrapping comment again
Attachment #8699903 - Flags: review?(bgrinstead) → review+
I have a couple of things to add (like about walker search) but can do that as a follow up once we get the structure in place

Comment 5

2 years ago
bugherder
https://hg.mozilla.org/mozilla-central/rev/79e8243e94f7
Status: ASSIGNED → RESOLVED
Last Resolved: 2 years ago
status-firefox46: --- → fixed
Resolution: --- → FIXED
Target Milestone: --- → Firefox 46

Comment 6

2 years ago
[bugday-20160323]

Status: RESOLVED,FIXED -> UNVERIFIED

Comments:
STR: Not clear.
Developer specific testing

Component: 
Name			Firefox
Version			46.0b9
Build ID		20160322075646
Update Channel	beta
User Agent		Mozilla/5.0 (Windows NT 6.1; WOW64; rv:46.0) Gecko/20100101 Firefox/46.0
OS				Windows 7 SP1 x86_64

Expected Results: 
Developer specific testing

Actual Results: 
As expected
You need to log in before you can comment on or make changes to this bug.