feature/stock-tools-update-perfo #21204

bm64 · 2024-05-22T13:29:24Z

Enhance stock tools with optimized update and redraw functionality.

- optional benchmark

highsoft-bot · 2024-05-22T13:32:42Z

File size comparison

No differences found

highsoft-bot · 2024-05-22T13:36:33Z

Visual test results - No difference found

highsoft-bot · 2024-05-22T13:54:48Z

Benchmark report - Stock

benchmarks/Stock/Stock-Annotations-update.bench.ts

Sample size	This PR avg (ms)	master avg (ms)	Diff	Percent diff
10000	11166.38	11253.76	-87.38	-1%

See all

Sample size	This PR avg (ms)	master avg (ms)	Diff	Percent diff
1000	11342.42	11498.07	-155.66	-1%
10000	11166.38	11253.76	-87.38	-1%

benchmarks/Stock/Stock-DataGrouping.bench.ts

Sample size	This PR avg (ms)	master avg (ms)	Diff	Percent diff
1000000	1040.13	1066.39	-26.26	-2%

See all

Sample size	This PR avg (ms)	master avg (ms)	Diff	Percent diff
1000	223.65	225.37	-1.72	-1%
10000	235.95	236.58	-0.63	0%
100000	327.96	328.96	-1	0%
1000000	1040.13	1066.39	-26.26	-2%

benchmarks/Stock/Stock-Tools-update.bench.ts

Sample size	This PR avg (ms)	master avg (ms)	Diff	Percent diff
10000	3116.88	3343.36	-226.49	-7.000000000000001%

See all

Sample size	This PR avg (ms)	master avg (ms)	Diff	Percent diff
1000	3293.31	3556.86	-263.55	-7.000000000000001%
10000	3116.88	3343.36	-226.49	-7.000000000000001%

benchmarks/Stock/Stock-Base.bench.ts

Sample size	This PR avg (ms)	master avg (ms)	Diff	Percent diff
1000000	6148.73	6162.59	-13.86	0%

See all

Sample size	This PR avg (ms)	master avg (ms)	Diff	Percent diff
1000	234.74	235.42	-0.69	0%
10000	323.83	324.86	-1.03	0%
100000	881.77	891.84	-10.07	-1%
1000000	6148.73	6162.59	-13.86	0%

benchmarks/Stock/Stock-Navigator-update.bench.ts

Sample size	This PR avg (ms)	master avg (ms)	Diff	Percent diff
10000	5535.54	5532.37	3.17	0%

See all

Sample size	This PR avg (ms)	master avg (ms)	Diff	Percent diff
1000	6058.9	6067.89	-8.99	0%
10000	5535.54	5532.37	3.17	0%

benchmarks/Stock/Stock-update.bench.ts

Sample size	This PR avg (ms)	master avg (ms)	Diff	Percent diff
10000	7239.09	7283.22	-44.13	-1%

See all

Sample size	This PR avg (ms)	master avg (ms)	Diff	Percent diff
1000	6739.97	6779.15	-39.17	-1%
10000	7239.09	7283.22	-44.13	-1%

benchmarks/Stock/Stock-Ordinal.bench.ts

Sample size	This PR avg (ms)	master avg (ms)	Diff	Percent diff
1000000	1380.11	1392.09	-11.98	-1%

See all

Sample size	This PR avg (ms)	master avg (ms)	Diff	Percent diff
1000	240.48	241.01	-0.53	0%
10000	261.56	258.91	2.64	1%
100000	428.97	429.64	-0.67	0%
1000000	1380.11	1392.09	-11.98	-1%

benchmarks/Stock/Stock-DataGrouping-Ordinal.bench.ts

Sample size	This PR avg (ms)	master avg (ms)	Diff	Percent diff
1000000	1371.64	1403.7	-32.06	-2%

See all

Sample size	This PR avg (ms)	master avg (ms)	Diff	Percent diff
1000	237.96	240.63	-2.67	-1%
10000	257.31	258.42	-1.11	0%
100000	433.72	432.45	1.27	0%
1000000	1371.64	1403.7	-32.06	-2%

benchmarks/Stock/Stock-Range-Selector-update.bench.ts

Sample size	This PR avg (ms)	master avg (ms)	Diff	Percent diff
10000	9070.13	9108.58	-38.46	0%

See all

Sample size	This PR avg (ms)	master avg (ms)	Diff	Percent diff
1000	9334.31	9395.58	-61.27	-1%
10000	9070.13	9108.58	-38.46	0%

pawellysy

Great job!
Apart from the comment below, please try fixing the failing test.
Also, could you add some tests? :)

pawellysy · 2024-05-28T05:10:31Z

ts/Stock/StockTools/StockToolbar.ts

+            if (this.options.className !== this.guiClassName) {
+                if (this.guiClassName) {
+                    this.wrapper.classList.remove(this.guiClassName);
+                }
+                if (this.options.className) {
+                    this.wrapper.classList.add(this.options.className);
+                }
+                this.guiClassName = this.options.className;
+            }
+
+            if (this.options.toolbarClassName !== this.toolbarClassName) {
+                if (this.toolbarClassName) {
+                    this.toolbar.classList.remove(this.toolbarClassName);
+                }
+                if (this.options.toolbarClassName) {
+                    this.toolbar.classList.add(this.options.toolbarClassName);
+                }
+                this.toolbarClassName = this.options.toolbarClassName;
+            }
+
+            if (
+                !shallowArraysEqual(this.options.buttons, this.buttonList) ||
+                this.isDirty
+            ) {
+                this.toolbar.innerHTML = AST.emptyHTML;
+                this.createButtons();
+            }
+
+            if (this.options.enabled === false) {
+                this.destroy();
+            }
+
+            if (defined(this.options.visible)) {
+                this.visible = this.options.visible;
+            }


There are a lot of if statements here. Would you mind splitting that into separate methods to improve code readability?

pawellysy

Great work! Just one small comment.

pawellysy · 2024-06-05T16:54:11Z

ts/Stock/StockTools/StockToolbar.ts

+                chart.update({
+                    stockTools: {
+                        gui: {
+                            visible: !self.visible,
+                            placed: true
+                        }
+                    }
+                });


StockTools has it's update method. Maybe we could use that to avoid some unnecessary logic?

PS: there is no placed property in the API. Should it be there?

kamil-musialowski

Just a few comments, nothing major tbh. Great job overall! 👏

kamil-musialowski · 2024-06-06T11:23:51Z

ts/Stock/StockTools/StockToolbar.ts

        container.appendChild(wrapper);

+        this.showhideBtn = createElement('div', {


Is it showhideBtn on purpose, or should it be showHideBtn?

kamil-musialowski · 2024-06-06T11:26:09Z

ts/Stock/StockTools/StockToolsGui.ts

@@ -144,20 +143,29 @@ function onChartAfterGetContainer(
 function onChartBeforeRedraw(
    this: Chart
 ): void {
-    if (this.stockTools) {
+    onChartRedraw.call(this);
+    if (this.stockTools && this.stockTools.guiEnabled) {


Can we change it to optional chaining?

Suggested change

if (this.stockTools && this.stockTools.guiEnabled) {

if (this.stockTools?.guiEnabled) {

kamil-musialowski · 2024-06-06T11:35:20Z

ts/Stock/StockTools/StockToolbar.ts

        const chart = this.chart,
            guiOptions = this.options,
            container = chart.container,
            navigation = chart.options.navigation,
-            bindingsClassName = navigation && navigation.bindingsClassName;
+            bindingsClassName = navigation && navigation.bindingsClassName,


Suggested change

bindingsClassName = navigation && navigation.bindingsClassName,

bindingsClassName = navigation?.bindingsClassName,

kamil-musialowski · 2024-06-06T11:44:14Z

ts/Stock/StockTools/StockToolbar.ts

+     * Remove highcharts-active class from button.
+     * @private
+     */
+    public removeButtonActiveClass(


I'm afraid that 4fd095a removed the usage of this method, and we just have a function, but it's not used anywhere.

So we either need to remove this function, or revert the changes from the commit that removed the usage.

pawelfus

Nice! See my suggestions below

ts/Stock/StockTools/StockToolsDefaults.ts

ts/Stock/StockTools/StockToolsGui.ts

ts/Stock/StockTools/StockToolbar.ts

samples/unit-tests/stock-tools/gui/demo.js

ts/Stock/StockTools/StockToolbar.ts

DJTechnoo

Amazing work!

pawelfus

Merge with master to get rid of failing tests. Other than that it looks good, nice! 🎉

ts/Stock/StockTools/StockToolsGui.ts

kamil-musialowski

All good imo! Please verify that one little comment 👍

ts/Stock/StockTools/StockToolsDefaults.ts

pawelfus

Thanks!

TorsteinHonsi

Thanks!

Stock tools improved update and redraw.

f68f94a

bm64 added 2 commits May 27, 2024 09:37

Improved stock tools definitions update.

56efe53

Added array utils function.

4455003

bm64 requested review from pawelfus, DJTechnoo, pawellysy and kamil-musialowski May 27, 2024 09:39

bm64 changed the title ~~Stock tools improved update and redraw.~~ feature/stock-tools-update-perfo May 27, 2024

bm64 marked this pull request as ready for review May 27, 2024 09:42

bm64 self-assigned this May 27, 2024

pawellysy requested changes May 28, 2024

View reviewed changes

bm64 added 4 commits May 30, 2024 08:40

Fixed stock tools active state toggle.

8f42f66

Improved code readability.

26fb6fa

Added tests.

562020b

Merge master.

4fd095a

bm64 requested a review from pawellysy June 5, 2024 13:19

pawellysy requested changes Jun 5, 2024

View reviewed changes

kamil-musialowski requested changes Jun 6, 2024

View reviewed changes

pawelfus requested changes Jun 6, 2024

View reviewed changes

DJTechnoo approved these changes Jun 10, 2024

View reviewed changes

bm64 added 2 commits June 13, 2024 12:50

Requested changes

b879d61

Added test.

111f605

bm64 requested review from pawellysy, kamil-musialowski and pawelfus June 13, 2024 13:31

pawelfus requested changes Jun 14, 2024

View reviewed changes

ts/Stock/StockTools/StockToolsGui.ts Outdated Show resolved Hide resolved

kamil-musialowski approved these changes Jun 14, 2024

View reviewed changes

ts/Stock/StockTools/StockToolsDefaults.ts Outdated Show resolved Hide resolved

pawellysy approved these changes Jun 17, 2024

View reviewed changes

bm64 added 4 commits June 17, 2024 16:22

Merge branch 'master' into feature/stock-tools-update-perfo

0a99d43

Added stock tools benchmark.

de00450

Extracted setOffset fn from Stock Tools onChartBeforeRedraw.

a40ff5e

Removed benchmark.

59c9962

bm64 requested a review from pawelfus June 25, 2024 14:27

Merge branch 'master'

220975a

pawelfus approved these changes Jun 28, 2024

View reviewed changes

pawelfus requested a review from TorsteinHonsi June 28, 2024 07:36

TorsteinHonsi approved these changes Jun 28, 2024

View reviewed changes

TorsteinHonsi merged commit bc2396a into master Jun 28, 2024
14 checks passed

TorsteinHonsi deleted the feature/stock-tools-update-perfo branch June 28, 2024 11:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature/stock-tools-update-perfo #21204

feature/stock-tools-update-perfo #21204

bm64 commented May 22, 2024 •

edited

Loading

highsoft-bot commented May 22, 2024

highsoft-bot commented May 22, 2024

highsoft-bot commented May 22, 2024 •

edited

Loading

pawellysy left a comment

pawellysy May 28, 2024

pawellysy left a comment

pawellysy Jun 5, 2024

kamil-musialowski left a comment

kamil-musialowski Jun 6, 2024

kamil-musialowski Jun 6, 2024

kamil-musialowski Jun 6, 2024

kamil-musialowski Jun 6, 2024

pawelfus left a comment

DJTechnoo left a comment

pawelfus left a comment

kamil-musialowski left a comment

pawelfus left a comment

TorsteinHonsi left a comment

		container.appendChild(wrapper);

		this.showhideBtn = createElement('div', {

	if (this.stockTools && this.stockTools.guiEnabled) {
	if (this.stockTools?.guiEnabled) {

	bindingsClassName = navigation && navigation.bindingsClassName,
	bindingsClassName = navigation?.bindingsClassName,

feature/stock-tools-update-perfo #21204

feature/stock-tools-update-perfo #21204

Conversation

bm64 commented May 22, 2024 • edited Loading

highsoft-bot commented May 22, 2024

File size comparison

highsoft-bot commented May 22, 2024

Visual test results - No difference found

highsoft-bot commented May 22, 2024 • edited Loading

Benchmark report - Stock

benchmarks/Stock/Stock-Annotations-update.bench.ts

benchmarks/Stock/Stock-DataGrouping.bench.ts

benchmarks/Stock/Stock-Tools-update.bench.ts

benchmarks/Stock/Stock-Base.bench.ts

benchmarks/Stock/Stock-Navigator-update.bench.ts

benchmarks/Stock/Stock-update.bench.ts

benchmarks/Stock/Stock-Ordinal.bench.ts

benchmarks/Stock/Stock-DataGrouping-Ordinal.bench.ts

benchmarks/Stock/Stock-Range-Selector-update.bench.ts

pawellysy left a comment

Choose a reason for hiding this comment

pawellysy May 28, 2024

Choose a reason for hiding this comment

pawellysy left a comment

Choose a reason for hiding this comment

pawellysy Jun 5, 2024

Choose a reason for hiding this comment

kamil-musialowski left a comment

Choose a reason for hiding this comment

kamil-musialowski Jun 6, 2024

Choose a reason for hiding this comment

kamil-musialowski Jun 6, 2024

Choose a reason for hiding this comment

kamil-musialowski Jun 6, 2024

Choose a reason for hiding this comment

kamil-musialowski Jun 6, 2024

Choose a reason for hiding this comment

pawelfus left a comment

Choose a reason for hiding this comment

DJTechnoo left a comment

Choose a reason for hiding this comment

pawelfus left a comment

Choose a reason for hiding this comment

kamil-musialowski left a comment

Choose a reason for hiding this comment

pawelfus left a comment

Choose a reason for hiding this comment

TorsteinHonsi left a comment

Choose a reason for hiding this comment

bm64 commented May 22, 2024 •

edited

Loading

highsoft-bot commented May 22, 2024 •

edited

Loading