forked from apache/superset
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
perf: faster legacy table chart (apache#385)
* feat: faster legacy table chart This commit tries to optimize the performance of the legacy data table. 1. Converting everything to Typescript. 2. Create a native React component instead of `reactify` (although all DOM operaions still happen in the jQuery.DataTables plugin. 3. Remove dependency on d3, optimize how bars are rendered. Plus some minor changes to fix linting and building. Also added a script to build only specific plugin for faster development. * feat(legacy-table-chart): use React to render DOM Unfortunately jquery.datatables uses innerHTML to create cell content, and all rows are created even with pagination. https://github.com/DataTables/DataTables/blob/83657a29e33ce93ee940ce25684940eb3acb2913/media/js/jquery.dataTables.js#L3113-L3117 This is slow and insecure. We are reverting to DOM data source as in previous implementation, but instead of using D3 to create the table rows, we use React. This also renders `dompurify.sanitize` unnecessary since React will take care of it. * feat(legacy-table-chart): support html in data cells Also 1. improve height adjustment 2. add page size control to storybook 3. hide rows from later pages at initial rendering * fix(legacy-data-table): minor formatting fixes * chore(legacy-table): add xss dependency Plus minor variable name and comment update * fix(legacy-table): linting errors * refactor(legacy-table): more predictable metric labels * feat(legacy-table): also display title for percent metric * fix(legacy-table): typos, var names, etc * docs: update notes for metric.label * refactor(legacy-table): upgrade number-format * fix(legacy-table): upgrade dependency for storybook and yarn
- Loading branch information
1 parent
f5e0ff4
commit 7ee4a7a
Showing
22 changed files
with
26,627 additions
and
1,546 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
250 changes: 250 additions & 0 deletions
250
...superset-ui-plugins/packages/superset-ui-legacy-plugin-chart-table/src/ReactDataTable.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,250 @@ | ||
| /** | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| import { t } from '@superset-ui/translation'; | ||
| import React, { useEffect, createRef } from 'react'; | ||
| import { formatNumber, NumberFormats } from '@superset-ui/number-format'; | ||
| import { getTimeFormatter } from '@superset-ui/time-format'; | ||
| import { filterXSS } from 'xss'; | ||
|
|
||
| // initialize datatables.net | ||
| import $ from 'jquery'; | ||
| import dt from 'datatables.net-bs/js/dataTables.bootstrap'; | ||
| import 'datatables.net-bs/css/dataTables.bootstrap.css'; | ||
| import './Table.css'; | ||
|
|
||
| import { DataTableProps } from './transformProps'; | ||
|
|
||
| // Depending on how the modules are imported, `dt` may be a CommonJS init function, | ||
| // or the DataTable class itself. In case it is the former, we'd need to tell it | ||
| // where is jQuery. | ||
| if (!dt.$) { | ||
| dt(window, $); | ||
| } | ||
|
|
||
| const { PERCENT_3_POINT } = NumberFormats; | ||
| const isProbablyHTML = (text: string) => /<[^>]+>/.test(text); | ||
|
|
||
| export default function ReactDataTable(props: DataTableProps) { | ||
| const { | ||
| data, | ||
| height, | ||
| alignPositiveNegative = false, | ||
| colorPositiveNegative = false, | ||
| columns, | ||
| includeSearch = false, | ||
| metrics: aggMetrics, | ||
| pageLength, | ||
| percentMetrics, | ||
| tableTimestampFormat, | ||
| // orderDesc, | ||
| // TODO: add back the broken dashboard filters feature | ||
| // filters = {}, | ||
| // onAddFilter = NOOP, | ||
| // onRemoveFilter = NOOP, | ||
| // tableFilter, | ||
| // timeseriesLimitMetric, | ||
| } = props; | ||
|
|
||
| const formatTimestamp = getTimeFormatter(tableTimestampFormat); | ||
| const metrics = (aggMetrics || []) | ||
| .concat(percentMetrics || []) | ||
| // actual records must be of numeric types as well | ||
| .filter(m => typeof data[0][m] === 'number'); | ||
|
|
||
| // check whethere a key is a metric | ||
| const metricsSet = new Set(aggMetrics); | ||
| const percentMetricsSet = new Set(percentMetrics); | ||
|
|
||
| // collect min/max for rendering bars | ||
| const maxes: { [key: string]: number } = {}; | ||
| const mins: { [key: string]: number } = {}; | ||
| columns.forEach(({ key }) => { | ||
| const vals = data.map(row => row[key]); | ||
| if (metrics.includes(key)) { | ||
| const nums = vals as number[]; | ||
| if (alignPositiveNegative) { | ||
| maxes[key] = Math.max(...nums.map(Math.abs)); | ||
| } else { | ||
| maxes[key] = Math.max(...nums); | ||
| mins[key] = Math.min(...nums); | ||
| } | ||
| } | ||
| }); | ||
|
|
||
| const viewportHeight = Math.min(height, window.innerHeight); | ||
| const pageLengthChoices = [10, 25, 40, 50, 75, 100, 150, 200]; | ||
| const hasPagination = pageLength > 0; | ||
|
|
||
| const rootElem = createRef<HTMLDivElement>(); | ||
|
|
||
| /** | ||
| * Adjust styles after rendering the table | ||
| */ | ||
| function drawCallback(this: DataTables.JQueryDataTables) { | ||
| const root = rootElem.current as HTMLElement; | ||
| // force smaller pagination, because datatables-bs hard-corded pagination styles | ||
| $('.pagination', root).addClass('pagination-sm'); | ||
| // display tr rows on current page | ||
| $('tr', root).css('display', ''); | ||
| } | ||
|
|
||
| /** | ||
| * Format text for cell value | ||
| */ | ||
| function cellText(key: string, format: string | undefined, val: unknown) { | ||
| if (key === '__timestamp') { | ||
| return formatTimestamp(val); | ||
| } | ||
| if (typeof val === 'string') { | ||
| return filterXSS(val, { stripIgnoreTag: true }); | ||
| } | ||
| if (percentMetricsSet.has(key)) { | ||
| // in case percent metric can specify percent format in the future | ||
| return formatNumber(format || PERCENT_3_POINT, val as number); | ||
| } | ||
| if (metricsSet.has(key)) { | ||
| // default format '' will return human readable numbers (e.g. 50M, 33k) | ||
| return formatNumber(format, val as number); | ||
| } | ||
| return val; | ||
| } | ||
|
|
||
| /** | ||
| * Cell background to render columns as horizontal bar chart | ||
| */ | ||
| function cellBar(key: string, val: number) { | ||
| const r = colorPositiveNegative && val < 0 ? 150 : 0; | ||
| if (alignPositiveNegative) { | ||
| const perc = Math.abs(Math.round((val / maxes[key]) * 100)); | ||
| // The 0.01 to 0.001 is a workaround for what appears to be a | ||
| // CSS rendering bug on flat, transparent colors | ||
| return ( | ||
| `linear-gradient(to right, rgba(${r},0,0,0.2), rgba(${r},0,0,0.2) ${perc}%, ` + | ||
| `rgba(0,0,0,0.01) ${perc}%, rgba(0,0,0,0.001) 100%)` | ||
| ); | ||
| } | ||
| const posExtent = Math.abs(Math.max(maxes[key], 0)); | ||
| const negExtent = Math.abs(Math.min(mins[key], 0)); | ||
| const tot = posExtent + negExtent; | ||
| const perc1 = Math.round((Math.min(negExtent + val, negExtent) / tot) * 100); | ||
| const perc2 = Math.round((Math.abs(val) / tot) * 100); | ||
| // The 0.01 to 0.001 is a workaround for what appears to be a | ||
| // CSS rendering bug on flat, transparent colors | ||
| return ( | ||
| `linear-gradient(to right, rgba(0,0,0,0.01), rgba(0,0,0,0.001) ${perc1}%, ` + | ||
| `rgba(${r},0,0,0.2) ${perc1}%, rgba(${r},0,0,0.2) ${perc1 + perc2}%, ` + | ||
| `rgba(0,0,0,0.01) ${perc1 + perc2}%, rgba(0,0,0,0.001) 100%)` | ||
| ); | ||
| } | ||
|
|
||
| const options = { | ||
| aaSorting: [], // initial sorting order, reset to [] to use backend ordering | ||
| autoWidth: false, | ||
| paging: hasPagination, | ||
| pagingType: 'first_last_numbers', | ||
| pageLength, | ||
| lengthMenu: [ | ||
| [...pageLengthChoices, -1], | ||
| [...pageLengthChoices, t('All')], | ||
| ], | ||
| searching: includeSearch, | ||
| language: { | ||
| paginate: { | ||
| first: t('First'), | ||
| last: t('Last'), | ||
| previous: t('Previous'), | ||
| next: t('Next'), | ||
| }, | ||
| }, | ||
| bInfo: false, | ||
| scrollY: `${viewportHeight}px`, | ||
| scrollCollapse: true, | ||
| scrollX: true, | ||
| drawCallback, | ||
| }; | ||
|
|
||
| useEffect(() => { | ||
| const $root = $(rootElem.current as HTMLElement); | ||
| const dataTable = $root.find('table').DataTable(options); | ||
|
|
||
| // adjust table height | ||
| const scrollHeadHeight = 34; | ||
| const paginationHeight = hasPagination ? 35 : 0; | ||
| const searchBarHeight = hasPagination || includeSearch ? 35 : 0; | ||
| const scrollBodyHeight = viewportHeight - scrollHeadHeight - paginationHeight - searchBarHeight; | ||
| $root.find('.dataTables_scrollBody').css('max-height', scrollBodyHeight); | ||
|
|
||
| return () => { | ||
| // there may be weird lifecycle issues, so put destroy in try/catch | ||
| try { | ||
| dataTable.destroy(); | ||
| // reset height | ||
| $root.find('.dataTables_scrollBody').css('max-height', ''); | ||
| } catch (error) { | ||
| // pass | ||
| } | ||
| }; | ||
| }); | ||
|
|
||
| return ( | ||
| <div ref={rootElem} className="superset-legacy-chart-table"> | ||
| <table className="table table-striped table-condensed table-hover"> | ||
| <thead> | ||
| <tr> | ||
| {columns.map(col => ( | ||
| // by default all columns will have sorting | ||
| <th key={col.key} className="sorting" title={col.label}> | ||
| {col.label} | ||
| </th> | ||
| ))} | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| {data.map((record, i) => ( | ||
| // hide rows after first page makes the initial render faster (less layout computation) | ||
| // eslint-disable-next-line react/no-array-index-key | ||
| <tr key={i} style={{ display: pageLength > 0 && i >= pageLength ? 'none' : undefined }}> | ||
| {columns.map(({ key, format }) => { | ||
| const val = record[key]; | ||
| const keyIsMetric = metricsSet.has(key); | ||
| const text = cellText(key, format, val); | ||
| const isHtml = !keyIsMetric && isProbablyHTML(text); | ||
| return ( | ||
| <td | ||
| key={key} | ||
| // only set innerHTML for actual html content, this saves time | ||
| dangerouslySetInnerHTML={isHtml ? { __html: text } : undefined} | ||
| data-sort={val} | ||
| className={keyIsMetric ? 'text-right' : ''} | ||
| style={{ | ||
| backgroundImage: keyIsMetric ? cellBar(key, val as number) : undefined, | ||
| }} | ||
| title={keyIsMetric || percentMetricsSet.has(key) ? (val as string) : ''} | ||
| > | ||
| {isHtml ? null : text} | ||
| </td> | ||
| ); | ||
| })} | ||
| </tr> | ||
| ))} | ||
| </tbody> | ||
| </table> | ||
| </div> | ||
| ); | ||
| } |
22 changes: 0 additions & 22 deletions
22
...gins/superset-ui-plugins/packages/superset-ui-legacy-plugin-chart-table/src/ReactTable.js
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.