1231883 - Implement HeapSnapshot.describeNode

Status: RESOLVED FIXED

(DevTools :: Memory, defect)

Description

[Nick Fitzgerald [:fitzgen] [⏰PST; UTC-8]]

This commit implements the HeapSnapshot.describeNode method which allows chrome
JS code to request a description of a given node as specified by our existing
"breakdown" language. This description can be used to generate a human-readable
label for the node.

Comment 1

[Nick Fitzgerald [:fitzgen] [⏰PST; UTC-8]]

Attachment: Implement HeapSnapshot.describeNode

This commit implements the HeapSnapshot.describeNode method which allows chrome
JS code to request a description of a given node as specified by our existing
"breakdown" language. This description can be used to generate a human-readable
label for the node.

Comment 2

[Nick Fitzgerald [:fitzgen] [⏰PST; UTC-8]]

Try push: https://treeherder.mozilla.org/#/jobs?repo=try&revision=dde98340e063

Comment 3

[Nick Fitzgerald [:fitzgen] [⏰PST; UTC-8]]

Attachment: Implement HeapSnapshot.describeNode

Fix the test to work after small and mostly unrelated changes in bug 1233096.

Comment 4

[Nick Fitzgerald [:fitzgen] [⏰PST; UTC-8]]

Try push: https://treeherder.mozilla.org/#/jobs?repo=try&revision=51a1ced6e84f

Comment 5

[Blake Kaplan (:mrbkap) (inactive)]

Comment on attachment 8699641 [details] [diff] [review]
Implement HeapSnapshot.describeNode

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

This seems reasonable.

::: devtools/shared/heapsnapshot/HeapSnapshot.cpp
@@ +526,5 @@
> +HeapSnapshot::DescribeNode(JSContext* cx, JS::HandleObject breakdown, uint64_t nodeId,
> +                           JS::MutableHandleValue rval, ErrorResult& rv) {
> +  MOZ_ASSERT(breakdown);
> +  JS::RootedValue breakdownVal(cx, JS::ObjectValue(*breakdown));
> +  JS::ubi::CountTypePtr rootType = JS::ubi::ParseBreakdown(cx, breakdownVal);

IMO it'd be nice to 'using namespace JS; using namespace JS::ubi;' either in this file or in this function to avoid having to repeat the namespace everywhere.

::: dom/webidl/HeapSnapshot.webidl
@@ +58,5 @@
>    any takeCensus(object? options);
>  
>    /**
> +   * Describe `node` with the specified `breakdown`. See the comment above
> +   * `takeCensus` or `js/src/dom/Debugger/Debugger.Memory.md` for detailed

Nit: .../doc/... (instead of "dom").

Comment 6

[Nick Fitzgerald [:fitzgen] [⏰PST; UTC-8]]

Attachment: Implement HeapSnapshot.describeNode

This commit implements the HeapSnapshot.describeNode method which allows chrome
JS code to request a description of a given node as specified by our existing
"breakdown" language. This description can be used to generate a human-readable
label for the node.

Comment 7

[Pulsebot]

https://hg.mozilla.org/integration/mozilla-inbound/rev/85f5b4e4c9a2

Comment 8

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/mozilla-central/rev/85f5b4e4c9a2

Comment 9

[Mayur Patil]

[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