feat(tree): improve Tree Data speed considerably, fixes #307

[ghiscoding]

• some fixes Tree Sort on first page load is incorrect #307 and a lot more

TODOs

• refactor flat to tree structure and vice versa to optimize speed
  • so far it seems to be ~40-50x faster 😮🚀 (previous code to convert from tree to flat was extremely slow, deep copy and item search were the main culprit).
  • with 100k rows test after sorting "Title" column
    • (before) 3354.64892578125 ms
    • (after) 70.06689453125 ms
• add ways to change dataset dynamically in the demo (2 buttons to change from 500 to 50k rows)
  • use 500 and 25k instead since 50k is a bit excessive for a demo
• throw error when trying to use Tree Data without filtering enabled (this is required for Tree Data)
• we shouldn't sort the dataset if user didn't provide the initialSort property
  • when not provided that means it's assuming the user already sorted the dataset, possibly while querying it from the dataset. However this is not recommended to do, we still have that option, technically speaking Example 5 is already sorted because of how it is constructed).
• remove previous throw error of multi-columns sort, it seems to work after all (need to test a bit more)
  • it seems to be broken after all, so we should probably leave it as unsupported
• rename some of the methods, the word "hierarchical" can simply be renamed to "tree"
• update all unit tests
• try adding more Cypress E2E tests to cover at least insert of items
  • test that clear filters shows all original items count
• remove all benchmark console logs before merging the PR
• add optional prefixes to the Tree Formatter rows
• test that we should still be able to add new item in both Example 5 and 6
• add pub/sub events (onBeforeSortChange, onBeforeFilterChange, onBeforeCollapse, ...) to help display spinner when dealing
• when calling clearFilters remove possibly unnecessary dataView.refresh(), need to test a bit more with backend service as well
• adding new item should also update formatter on Title column but it doesn't currently do that
• add SASS vertical alignment variable for the tree collapsing icons
• add custom title formatter in tree data options for the tree formatter to process

[codecov]

Codecov Report

Merging #336 (a67f2f3) into master (3e059dc) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##            master      #336   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          213       212    -1     
  Lines        13063     13110   +47     
  Branches      4279      4297   +18     
=========================================
+ Hits         13063     13110   +47     

Impacted Files	Coverage Δ
packages/common/src/services/index.ts	100.00% <ø> (ø)
...ages/common/src/extensions/contextMenuExtension.ts	100.00% <100.00%> (ø)
...ckages/common/src/formatters/formatterUtilities.ts	100.00% <100.00%> (ø)
...kages/common/src/formatters/treeExportFormatter.ts	100.00% <100.00%> (ø)
packages/common/src/formatters/treeFormatter.ts	100.00% <100.00%> (ø)
packages/common/src/services/filter.service.ts	100.00% <100.00%> (ø)
packages/common/src/services/grid.service.ts	100.00% <100.00%> (ø)
packages/common/src/services/pubSub.service.ts	100.00% <100.00%> (ø)
packages/common/src/services/sort.service.ts	100.00% <100.00%> (ø)
packages/common/src/services/treeData.service.ts	100.00% <100.00%> (ø)
... and 6 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3e059dc...a67f2f3. Read the comment docs.