Skip to content

A local-first personal finance app

Optimize scroll provider and replace usage of debounce package with lodash's debounce (#5750)

Joel Jeremy Marquezca5378c0e825
diff --git a/packages/desktop-client/package.json b/packages/desktop-client/package.json
index ab352753c0..15e89a9f0c 100644
--- a/packages/desktop-client/package.json
+++ b/packages/desktop-client/package.json
@@ -18,7 +18,6 @@
"@testing-library/jest-dom": "^6.6.3",
"@testing-library/react": "16.3.0",
"@testing-library/user-event": "14.6.1",
- "@types/debounce": "^1.2.4",
"@types/lodash": "^4",
"@types/promise-retry": "^1.1.6",
"@types/react": "^19.1.12",
@@ -34,7 +33,6 @@
"cmdk": "^1.1.1",
"cross-env": "^7.0.3",
"date-fns": "^4.1.0",
- "debounce": "^1.2.1",
"downshift": "7.6.2",
"focus-visible": "^4.1.5",
"i18next": "^25.2.1",
diff --git a/packages/desktop-client/src/components/ScrollProvider.tsx b/packages/desktop-client/src/components/ScrollProvider.tsx
index 83865c6903..f6bb4753ef 100644
--- a/packages/desktop-client/src/components/ScrollProvider.tsx
+++ b/packages/desktop-client/src/components/ScrollProvider.tsx
@@ -6,9 +6,10 @@ import React, {
useEffect,
useCallback,
useRef,
+ useMemo,
} from 'react';
-import debounce from 'debounce';
+import debounce from 'lodash/debounce';
type ScrollDirection = 'up' | 'down' | 'left' | 'right';
@@ -41,7 +42,7 @@ type ScrollProviderProps<T extends Element> = {
export function ScrollProvider<T extends Element>({
scrollableRef,
isDisabled,
- delayMs = 10,
+ delayMs = 250,
children,
}: ScrollProviderProps<T>) {
const previousScrollX = useRef<number | undefined>(undefined);
@@ -128,38 +129,49 @@ export function ScrollProvider<T extends Element>({
}
}, []);
+ const listenToScroll = useMemo(
+ () =>
+ debounce((e: Event) => {
+ const target = e.target;
+ if (target instanceof Element) {
+ previousScrollX.current = scrollX.current;
+ scrollX.current = target.scrollLeft;
+ scrollWidth.current = target.scrollWidth;
+ clientWidth.current = target.clientWidth;
+
+ previousScrollY.current = scrollY.current;
+ scrollY.current = target.scrollTop;
+ scrollHeight.current = target.scrollHeight;
+ clientHeight.current = target.clientHeight;
+
+ const currentScrollX = scrollX.current;
+ const currentScrollY = scrollY.current;
+
+ if (currentScrollX !== undefined && currentScrollY !== undefined) {
+ listeners.current.forEach(listener =>
+ listener({
+ scrollX: currentScrollX,
+ scrollY: currentScrollY,
+ isScrolling,
+ hasScrolledToEnd,
+ }),
+ );
+ }
+ }
+ }, delayMs),
+ [delayMs, hasScrolledToEnd, isScrolling],
+ );
+
+ useEffect(() => {
+ const toCancel = listenToScroll;
+ return () => toCancel.cancel();
+ }, [listenToScroll]);
+
useEffect(() => {
if (isDisabled) {
return;
}
- const listenToScroll = debounce((e: Event) => {
- const target = e.target;
- if (target instanceof Element) {
- previousScrollX.current = scrollX.current;
- scrollX.current = target.scrollLeft;
- scrollHeight.current = target.scrollHeight;
-
- previousScrollY.current = scrollY.current;
- scrollY.current = target.scrollTop;
- clientHeight.current = target.clientHeight;
-
- const currentScrollX = scrollX.current;
- const currentScrollY = scrollY.current;
-
- if (currentScrollX !== undefined && currentScrollY !== undefined) {
- listeners.current.forEach(listener =>
- listener({
- scrollX: currentScrollX,
- scrollY: currentScrollY,
- isScrolling,
- hasScrolledToEnd,
- }),
- );
- }
- }
- }, delayMs);
-
const ref = scrollableRef.current;
ref?.addEventListener('scroll', listenToScroll, {
@@ -170,7 +182,7 @@ export function ScrollProvider<T extends Element>({
ref?.removeEventListener('scroll', listenToScroll, {
capture: true,
});
- }, [delayMs, hasScrolledToEnd, isDisabled, isScrolling, scrollableRef]);
+ }, [isDisabled, listenToScroll, scrollableRef]);
const registerScrollListener: RegisterScrollListener = useCallback(
listener => {
diff --git a/packages/desktop-client/src/components/accounts/Account.tsx b/packages/desktop-client/src/components/accounts/Account.tsx
index 5dfac76e1b..8712a39f8a 100644
--- a/packages/desktop-client/src/components/accounts/Account.tsx
+++ b/packages/desktop-client/src/components/accounts/Account.tsx
@@ -12,8 +12,8 @@ import { Navigate, useParams, useLocation } from 'react-router';
import { styles } from '@actual-app/components/styles';
import { theme } from '@actual-app/components/theme';
import { View } from '@actual-app/components/view';
-import { debounce } from 'debounce';
import { t } from 'i18next';
+import debounce from 'lodash/debounce';
import { v4 as uuidv4 } from 'uuid';
import { send, listen } from 'loot-core/platform/client/fetch';
diff --git a/packages/desktop-client/src/components/modals/BudgetAutomationsModal.tsx b/packages/desktop-client/src/components/modals/BudgetAutomationsModal.tsx
index 9b02f93ff7..ae44235180 100644
--- a/packages/desktop-client/src/components/modals/BudgetAutomationsModal.tsx
+++ b/packages/desktop-client/src/components/modals/BudgetAutomationsModal.tsx
@@ -6,7 +6,7 @@ import { AnimatedLoading } from '@actual-app/components/icons/AnimatedLoading';
import { Stack } from '@actual-app/components/stack';
import { theme } from '@actual-app/components/theme';
import { View } from '@actual-app/components/view';
-import { uniqueId } from 'lodash';
+import uniqueId from 'lodash/uniqueId';
import { send } from 'loot-core/platform/client/fetch';
import { q } from 'loot-core/shared/query';
diff --git a/packages/desktop-client/src/components/reports/SummaryNumber.tsx b/packages/desktop-client/src/components/reports/SummaryNumber.tsx
index a13e8570cd..f011ab0191 100644
--- a/packages/desktop-client/src/components/reports/SummaryNumber.tsx
+++ b/packages/desktop-client/src/components/reports/SummaryNumber.tsx
@@ -2,7 +2,7 @@ import React, { type Ref, useRef, useState } from 'react';
import { useTranslation } from 'react-i18next';
import { View } from '@actual-app/components/view';
-import { debounce } from 'debounce';
+import debounce from 'lodash/debounce';
import { chartTheme } from './chart-theme';
import { LoadingIndicator } from './LoadingIndicator';
diff --git a/packages/desktop-client/src/components/reports/reports/CalendarCard.tsx b/packages/desktop-client/src/components/reports/reports/CalendarCard.tsx
index e29ad7527c..65330a6f21 100644
--- a/packages/desktop-client/src/components/reports/reports/CalendarCard.tsx
+++ b/packages/desktop-client/src/components/reports/reports/CalendarCard.tsx
@@ -22,7 +22,7 @@ import { theme } from '@actual-app/components/theme';
import { Tooltip } from '@actual-app/components/tooltip';
import { View } from '@actual-app/components/view';
import { format as formatDate } from 'date-fns';
-import { debounce } from 'debounce';
+import debounce from 'lodash/debounce';
import * as monthUtils from 'loot-core/shared/months';
import { type CalendarWidget } from 'loot-core/types/models';
@@ -403,8 +403,9 @@ function CalendarCardInner({
const monthNameResizeRef = useResizeObserver(debouncedResizeCallback);
useEffect(() => {
+ const toCancel = debouncedResizeCallback;
return () => {
- debouncedResizeCallback?.clear();
+ toCancel.cancel();
};
}, [debouncedResizeCallback]);
diff --git a/packages/desktop-client/src/hooks/useTransactionsSearch.ts b/packages/desktop-client/src/hooks/useTransactionsSearch.ts
index 29a01c3748..e9312f809d 100644
--- a/packages/desktop-client/src/hooks/useTransactionsSearch.ts
+++ b/packages/desktop-client/src/hooks/useTransactionsSearch.ts
@@ -1,6 +1,6 @@
import { useState, useMemo, useEffect, useRef } from 'react';
-import { debounce } from 'lodash';
+import debounce from 'lodash/debounce';
import type { Query } from 'loot-core/shared/query';
diff --git a/upcoming-release-notes/5750.md b/upcoming-release-notes/5750.md
new file mode 100644
index 0000000000..a8003eea0c
--- /dev/null
+++ b/upcoming-release-notes/5750.md
@@ -0,0 +1,6 @@
+---
+category: Maintenance
+authors: [joel-jeremy]
+---
+
+Optimize scroll provider and replace usage of debounce package with lodash's debounce
diff --git a/yarn.lock b/yarn.lock
index 0e0927427f..8a60ef57d2 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -146,7 +146,6 @@ __metadata:
"@testing-library/jest-dom": "npm:^6.6.3"
"@testing-library/react": "npm:16.3.0"
"@testing-library/user-event": "npm:14.6.1"
- "@types/debounce": "npm:^1.2.4"
"@types/lodash": "npm:^4"
"@types/promise-retry": "npm:^1.1.6"
"@types/react": "npm:^19.1.12"
@@ -162,7 +161,6 @@ __metadata:
cmdk: "npm:^1.1.1"
cross-env: "npm:^7.0.3"
date-fns: "npm:^4.1.0"
- debounce: "npm:^1.2.1"
downshift: "npm:7.6.2"
focus-visible: "npm:^4.1.5"
i18next: "npm:^25.2.1"
@@ -6526,13 +6524,6 @@ __metadata:
languageName: node
linkType: hard
-"@types/debounce@npm:^1.2.4":
- version: 1.2.4
- resolution: "@types/debounce@npm:1.2.4"
- checksum: 10/decef3eee65d681556d50f7fac346f1b33134f6b21f806d41326f9dfb362fa66b0282ff0640ae6791b690694c9dc3dad4e146e909e707e6f96650f3aa325b9da
- languageName: node
- linkType: hard
-
"@types/debug@npm:^4.0.0, @types/debug@npm:^4.1.6":
version: 4.1.8
resolution: "@types/debug@npm:4.1.8"
@@ -9904,13 +9895,6 @@ __metadata:
languageName: node
linkType: hard
-"debounce@npm:^1.2.1":
- version: 1.2.1
- resolution: "debounce@npm:1.2.1"
- checksum: 10/0b95b2a9d80ed69117d890f8dab8c0f2d6066f8d20edd1d810ae51f8f366a6d4c8b1d56e97dcb9304e93d57de4d5db440d34a03def7dad50403fc3f22bf16808
- languageName: node
- linkType: hard
-
"debug@npm:4, debug@npm:^4, debug@npm:^4.0.0, debug@npm:^4.1.0, debug@npm:^4.1.1, debug@npm:^4.3.1, debug@npm:^4.3.2, debug@npm:^4.3.3, debug@npm:^4.3.4, debug@npm:^4.3.6, debug@npm:^4.4.0":
version: 4.4.0
resolution: "debug@npm:4.4.0"