Lineage: improved node details, withLineage by labkey-nicka · Pull Request #237 · LabKey/labkey-ui-components

labkey-nicka · 2020-04-28T00:34:49Z

Rationale

This PR updates our client-side <LineageGraph /> and related components to better support node details from the experiment-lineage.api. Runs, Run Steps, Data Inputs & Outputs, Material Inputs & Outputs are now supported in the detail pane.

Runs provide additional details:

Drill down into run steps:

Related Pull Requests

Experiment: support containerPath property, improve lineage types labkey-api-js#58

Changes

Lineage

Introduces a withLineage HoC which coordinates fetching, loading, error, and loaded states for a Lineage model. This model can be utilized by any component withLineage wraps.
All components that make use of Lineage, the model that wraps our experiment-lineage.api, are now wrapped by the withLineage HoC. This includes:
- <LineageGraph/>
- <LineageGrid/>
- <LineageSummary/>
- <SampleTypeLineageCounts/>
Removes persistence of Lineage models to reactn global store. Lineage components are no longer reactn-based rendering this persistence unnecessary as it is no longer utilized. Invalidation of lineage results, via invalidateLineageResults(), is still available, but the implementation has been moved.
Lineage now supports prefetching the lineage node for the specified seed. This utilizes the
recently introduced experiment-resolve.api which allows for fetching of a single node from the
server (as opposed to the entire lineage). This "prefetch" request is made asynchronous to the lineage request and allows for resolving the seed node to occur before the entire lineage result is loaded. This is a follow on performance enhancement for 39252.
fetchLineage now makes all requests against experiment-lineage.api with the includeInputsAndOutputs and includeRunSteps set to true.

Lineage Graph

initialModel prop has been removed in favor of using the prefetching of the seed result
(as mentioned above).
Adds a new component, <LineageNodeDetailFactory/>, which contains logic for determining what component to show in the right-hand side of the <LineageGraph/>. This logic was formerly handled via LineageGraph.renderSelectedNodes().

Lineage Grid

Factored out binding of properties from Location into a new component, <LineageGridFromLocation/>, which takes a location and parses the props into a <LineageGrid />.
<LineageGrid /> still derives a model from the provided Lineage, however, this now uses getDerivedStateFromProps to produce the next state.

withQueryModels

Adds <DetailPanelWithModel /> which utilizes withQueryModels to render "detail" information from a QueryModel.
A presentational component, <DetailDisplay/>, has been factored out of the QueryGridModel-based <Detail/> and is reused by he QueryModel-based <DetailPanelWithModel/>.
Makes LoadingState a reusable enum across components. Factored out of QueryModel and additionally used by Lineage.
A getter for detailColumns and updateColumns has been added to QueryInfo to allow for shared access to this logic.
A getter for isDetailColumn and isUpdateColumn has been added to QueryColumn to allow for shared access to this logic.

- attempt to fuzzy match against run types

- allows for quickly populating side pane - can be enabled via "prefetchSeed" option on a lineage graph (true by default)

- common display component, DetailDisplay, shared with Detail (QueryGridModel variant)

- wraps DetailWithModel to provide QueryModel based component for lineage nodes

# Conflicts: # packages/components/package.json # packages/components/src/components/base/models/QueryInfo.ts # packages/components/src/components/forms/detail/Detail.tsx # packages/components/src/components/forms/detail/DetailEditRenderer.tsx # packages/components/src/components/lineage/Lineage.spec.ts # packages/components/src/components/lineage/LineageGraph.tsx # packages/components/src/components/lineage/LineageSummary.tsx # packages/components/src/components/lineage/SampleTypeLineageCounts.tsx # packages/components/src/components/lineage/actions.ts # packages/components/src/components/lineage/grid/LineageGrid.spec.tsx # packages/components/src/components/lineage/grid/LineageGrid.tsx # packages/components/src/components/lineage/grid/LineageGridDisplay.tsx # packages/components/src/components/lineage/models.ts # packages/components/src/components/lineage/node/LineageNodeDetail.tsx # packages/components/src/components/lineage/node/LineageNodeList.tsx # packages/components/src/components/lineage/types.ts # packages/components/src/components/lineage/utils.ts # packages/components/src/components/lineage/vis/VisGraph.tsx # packages/components/src/components/lineage/vis/VisGraphGenerator.ts # packages/components/src/index.ts # packages/components/src/stories/Lineage.tsx # packages/components/src/stories/mock.tsx

- linting updates

- provides "lineage" as a context provided value to sub-nodes of a withLineage wrapped component

- prepare steps header

- caches result + post-processing

- custom components for rendering run steps, node lists

- fix will be applied to server-side for dispensing decoded schemaNames This reverts commit f5f3f27

- shared anchor wrapping component for displaying hover links in lineage

# Conflicts: # packages/components/package.json # packages/components/src/index.ts # packages/components/src/stories/mock.tsx

labkey-alan

Looks good, but I did leave some specific pieces of feedback. Also worth noting VisGraph.highlightNode is unused and probably worth deleting?

labkey-nicka · 2020-04-30T14:55:39Z

Looks good, but I did leave some specific pieces of feedback. Also worth noting VisGraph.highlightNode is unused and probably worth deleting?

It actually is in use in <LineageGraph /> via ref. I've updated the typings for the ref so that hopefully IntelliJ will better understand what is going on.

# Conflicts: # packages/components/package.json # packages/components/src/components/lineage/LineageSummary.tsx # packages/components/src/components/lineage/types.ts # packages/components/src/index.ts # packages/components/src/stories/Lineage.tsx

labkey-kevink · 2020-04-29T04:29:21Z

 return this.queryInfo?.getColumn(fieldKey);
 }

+ get detailColumns(): QueryColumn[] {


Should the function return type be QueryColumn[] | undefined ?

labkey-kevink · 2020-04-29T04:30:10Z

 return this.queryInfo?.getAllColumns(this.viewName, List(this.omittedColumns)).toArray();
 }

+ get updateColumns(): QueryColumn[] {


Should the function return type be QueryColumn[] | undefined ?

labkey-kevink · 2020-04-29T04:52:37Z

+ body = (
+ <div>
+ {data.map((row: any, i: number) => {
+ // key safety


The 'key safety' comment could be more descriptive. Creating a case-insensitive (ordered) map seems like something we might have a utility method for. If not, then maybe we should?

labkey-nicka added 30 commits April 17, 2020 17:07

Initial lineage storybook for runs
092c34d

LineageGrid: use immer
e5a1c53

Use run icon for any type that contains "run"
e37346b
- attempt to fuzzy match against run types

Cleanup nits
938d562

Lineage can prefetch seed node info
f2d1272
- allows for quickly populating side pane - can be enabled via "prefetchSeed" option on a lineage graph (true by default)

DetailWithModel
34bc4fb
- common display component, DetailDisplay, shared with Detail (QueryGridModel variant)

Fix import paths
a1f6603

Introduce NodeDetail
abec35a
- wraps DetailWithModel to provide QueryModel based component for lineage nodes

Remove console.log
47fa4be

v0.51.1-fb-rungraph-deets.0
1d61516

DetailPanel: respect model.error
b2e2c98

withLineage: function that returns wrapped component with lineage
8697451

withLinage: add componentDidUpdate
327b729

Code style updates
43982d2

Fix DetailPanel to pass props
7596b40
- linting updates

loadLineageIfNeeded promises to return loaded lineage
f1be2aa

LineageContext
ab16bd4
- provides "lineage" as a context provided value to sub-nodes of a withLineage wrapped component

Remove showSummary
1c14377

LineageNodeDetailFactory
ff92f70

withLineage: make state immutable
ee52796

Consolidate RunNodeDetail and LineageNodeDetail
2e7784c
- prepare steps header

Use PureComponent
8d30aef

withLineage: prevent unmount setState calls
8745894

Cache LineageResult
75c92e4
- caches result + post-processing

withQueryModel: override defaultProps
9a8da97

withLineage: remove cache, add override defaultProps
b5cc54d

DetailsList: common components for expandable detail lists
c76975e
- custom components for rendering run steps, node lists

Adjust subheader styling
3867f42

Pass lineage options props
6dcbdd3

labkey-nicka added 5 commits April 29, 2020 12:29

Revert "Decode schemaName lineage props"
8c9a28d
- fix will be applied to server-side for dispensing decoded schemaNames This reverts commit f5f3f27

Resolve group nodes URLs in server resolver
bd603df

LineageDataLink
a49299f
- shared anchor wrapping component for displaying hover links in lineage

Merge branch 'master' into fb_rungraph_deets
02f2d27
# Conflicts: # packages/components/package.json # packages/components/src/index.ts # packages/components/src/stories/mock.tsx

v0.55.0-fb-rungraph-deets.0
89d04cd

labkey-alan requested changes Apr 29, 2020
View reviewed changes

labkey-nicka added 4 commits April 29, 2020 21:48

Code review feedback
a028e1a

Expose limited set of lineage request options
a5836e2

Fix click on nested data link
f238258

v0.55.0-fb-rungraph-deets.1
6902d35

labkey-nicka added 6 commits April 30, 2020 11:39

Bump @labkey/api
69f2658

Use Experiment typings
5e5475d

Support container path in lineage requests
51cf9c6

v0.55.0-fb-rungraph-deets.2
12ef2f2

v0.56.0-fb-rungraph-deets.0
34dc3d3

labkey-nicka mentioned this pull request Apr 30, 2020
Experiment: support containerPath property, improve lineage types LabKey/labkey-api-js#58
Merged

labkey-nicka added 4 commits April 30, 2020 15:09

Fix step breadcrumb spacing
51fe62a

Bump @labkey/api
6645e71

v0.56.0-fb-rungraph-deets.1
ab14db8

Columns are real
5d892fc

labkey-alan approved these changes Apr 30, 2020
View reviewed changes

labkey-nicka added 2 commits April 30, 2020 17:00

Linting
c714895

v0.56.0-fb-rungraph-deets.2
230f81b

labkey-kevink approved these changes May 1, 2020
View reviewed changes

labkey-nicka added 2 commits May 1, 2020 07:56

v0.56.0
e708cd3

Update components.md
db1cf00

labkey-nicka merged commit cf8ede5 into masterMay 1, 2020

labkey-nicka deleted the fb_rungraph_deets branch May 1, 2020 15:11

Navigation Menu

Uh oh!

Lineage: improved node details, withLineage - #237

Lineage: improved node details, withLineage#237
labkey-nicka merged 93 commits into
masterfrom
fb_rungraph_deets

labkey-nicka commented Apr 28, 2020•
edited
Loading

Uh oh!

labkey-alan left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

labkey-nicka commented Apr 30, 2020

Uh oh!

labkey-kevinkApr 29, 2020

Uh oh!

labkey-kevinkApr 29, 2020

Uh oh!

labkey-kevinkApr 29, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

labkey-nicka commented Apr 28, 2020• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Rationale

Related Pull Requests

Changes

Uh oh!

labkey-alan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

labkey-nicka commented Apr 30, 2020

Uh oh!

labkey-kevinkApr 29, 2020

Choose a reason for hiding this comment

Uh oh!

labkey-kevinkApr 29, 2020

Choose a reason for hiding this comment

Uh oh!

labkey-kevinkApr 29, 2020

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

labkey-nicka commented Apr 28, 2020•
edited
Loading