1569023 - Expose a helper on protocol's Front class to help retrieve the parent front

Status: RESOLVED FIXED

(DevTools :: Framework, enhancement, P1)

Description

[Gabriel Luong [:gl] (ΦωΦ)]

In Bug 1539764, we added a targetFront attribute to retrieve the target front. This would allow us to do async calls to retrieve target-scoped fronts like the Inspector via await nodeFront.target.getInspector().

Since we know these child fronts of target-scoped fronts are initialized and managed by their parent target-scoped fronts, we could add an attribute targetScoped to retrieve their ancestor target-scoped fronts. Allowing us to have synchronous access to the target-scoped fronts.

As an example, nodeFront is a child front of walkerFront. nodeFront.targetScoped and walkerFront.targetScoped would both point to the inspectorFront which is the target-scoped front.

Comment 1

[Gabriel Luong [:gl] (ΦωΦ)]

Attachment: Bug 1569023 - Expose a helper on protocol's Front class to help retrieve the parent front. r=ochameau,yulia

Only children of the target-scoped fronts will have a targetScoped attribute set.
This targetScoped attribute returns the ancestor target-scoped front. As an example,
nodeFront.targetScoped would return the InspectorFront.

Comment 2

[Jason Laster [:jlast]]

Out of curiosity, in terms of naming was there a discussion around suffixing properties with Front? Naively, it seems like that would be assumed. i.e I would assume that a parent property of a front would be a front.

Comment 3

[Gabriel Luong [:gl] (ΦωΦ)]

(In reply to Jason Laster [:jlast] from comment #2)

Out of curiosity, in terms of naming was there a discussion around suffixing properties with Front? Naively, it seems like that would be assumed. i.e I would assume that a parent property of a front would be a front.

This has came up before. You can imagine the problem in the inspector where we have a InspectorFront and call it inspector on the client. We end up calling something like inspector.inspector instead of inspector.inspectorFront. So, we added the Front suffix to be explicit about what we are calling. You can also see in the phabricator comments why we couldn't use parent as the name because we have conflict with the NodeFront already using _parent.

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/59052299b371
Expose a helper on protocol's Front class to help retrieve the parent front. r=ochameau,yulia

Comment 5

[Andrei Ciure[:aciure]]

https://hg.mozilla.org/mozilla-central/rev/59052299b371