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

misc(treemap): root node selector #12360

Merged
merged 5 commits into from
Apr 22, 2021
Merged

misc(treemap): root node selector #12360

merged 5 commits into from
Apr 22, 2021

Conversation

connorjclark
Copy link
Collaborator

@connorjclark connorjclark commented Apr 13, 2021

image

ref #11254

@connorjclark connorjclark requested a review from a team as a code owner April 13, 2021 23:25
@connorjclark connorjclark requested review from jckr and removed request for a team April 13, 2021 23:25
@google-cla google-cla bot added the cla: yes label Apr 13, 2021
Copy link
Member

@paulirish paulirish left a comment

Choose a reason for hiding this comment

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

I spent time time on this and found that we can simplify the data selector idea, both in theory and in code.

Currently it relies on this new selector object, but really all render() needs to know is 1) what's our currentTreemapRoot and 2) what viewMode are we in. So I'm proposing we allow the bundleSelector to set the the first, and the existing viewmode buttons to set the latter. render is then just called in both cases.

Tactically, instead of the array of selectors, we can use a weakmap of type {WeakMap<HTMLOptionElement, LH.Treemap.Node>}. Extrapolating a bit, this means that for the 'All' item, we'll call this.wrapNodesInNewRootNode when building these options (instead of in setViewMode).
Then in the <option> onchange, we can use bundleSelectorEl.selectedOptions[0] to get the selected dom node. we don't call setViewMode because the viewmode didn't change. just set the currentTreeMapRoot and render.

With this in place, we can delete nearly all of setViewMode.

(I do have some working code implementing this idea if you're interested, but i'll leave that to you)

const optionEl = TreemapUtil.createChildOf(bundleSelectorEl, 'option');
optionEl.value = String(selectors.length);
selectors.push(selector);
optionEl.innerText = text;
Copy link
Member

Choose a reason for hiding this comment

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

textContent is cheaper and cleaner

lighthouse-treemap/app/src/main.js Show resolved Hide resolved
@connorjclark
Copy link
Collaborator Author

connorjclark commented Apr 16, 2021

The selector object is meant to be varied by deep-links in the report, while still sending all the treemap data necessary to look at any other view. See Options: eventually viewMode will be added.

For example, the unused js audit could link directly to a bundle view using {lhr: {...}, viewMode: {id: 'unused-bytes', selector: {type: 'depthOneNode', url: '...'}}}}. Treemap app loads to that specific view mode, but user can change viewMode to see any other view. I'm not certain but I wonder if this criteria changes your suggestion.

@paulirish
Copy link
Member

carrying over some things from our chat for posterity:

so in the case where we deeplink from report to a specific script, we have some options for how it's displayed..

  1. we could basically select it in bundleSelector so its the entire focus AKA setTreemapRoot
  2. or we could still be view all Scripts but visually annotate it AKA annotation
  3. or we can could be viewing All Scripts, but zoom in to it AKA zoom

we were a little skeptical about zoom.. like about treemap area percentages and also the probably awkward UX.

the annotation approach seems most successful for folks repeatedly clicking table items and wanting to see them in the TMViewer..

Copy link
Member

@paulirish paulirish left a comment

Choose a reason for hiding this comment

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

This selector concept currently is just resolving to a Node to set as currentTreemapRoot, but using a string value and string type to refer to it. If we didnt care about these item-level deep links, we could just shortcut things and just only deal with the Nodes that may be set as treemapRoot… I took this approach with a refactor that removed the selector concept.

I think the current separation of treemapRootNode, viewMode aka colorizingMode, and nodesToVisuallyAnnotate makes sense and that's basically the renderState. It makes me think that once we're making deep-linking items happen, then the API could be passing those 3 things, rather than this intermediate selector. But if you're not convinced, sure. Once the deep-linking comes to life I expect we can take another look at how the whole system works.

@@ -256,35 +254,59 @@ class TreemapViewer {
throw new Error('unknown selector: ' + JSON.stringify(selector));
}

this.render();
this.viewModes = this.createViewModes();
Copy link
Member

Choose a reason for hiding this comment

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

doing this inside of setSelector seems odd. why not create viewmodes in constructor?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

the labels are based on the bundle selected. also could be that some view modes are not relevant for a selected bundle (like the upcoming duplicated modules)

lighthouse-treemap/app/src/main.js Outdated Show resolved Hide resolved
lighthouse-treemap/app/src/main.js Show resolved Hide resolved
Copy link
Member

@paulirish paulirish left a comment

Choose a reason for hiding this comment

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

i have doubts, but we can move this forward and we'll revisit those at the next iteration.

some nits and thoughts below.

/** @type {LH.Treemap.ViewMode[]} */
this.viewModes;
/** @type {RenderState=} */
this.previousRenderState;
Copy link
Member

Choose a reason for hiding this comment

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

cant this also be initialized with the same shape? it'd mean you can remove the awkward !this.previousRenderState || bits below, right?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I did try, but it made things more awkward.

let node;
outer: for (const depthOneNodes of Object.values(this.depthOneNodesByGroup)) {
for (const depthOneNode of depthOneNodes) {
if (depthOneNode.name === selector.value) {
Copy link
Member

Choose a reason for hiding this comment

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

if there any any duplicates, then this can match incorrectly.
with the current data, it seems unlikely, but once we go intra-bundle, i suspect we'll run into this.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

this is just depth one nodes, so for a duplicate to be possible that would mean there are multiple instances of network requests with the same URL.

@connorjclark connorjclark merged commit dd33036 into master Apr 22, 2021
@connorjclark connorjclark deleted the treemap-selector branch April 22, 2021 21:59
@connorjclark connorjclark mentioned this pull request Apr 22, 2021
24 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants