useDebouncedViewportSearch: removed cancel effect

deephaven · May 8, 2023 · 77a3ae4 · 77a3ae4
1 parent 7d56f97
commit 77a3ae4
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 13 deletions.
diff --git a/packages/jsapi-components/src/useDebouncedViewportSearch.test.ts b/packages/jsapi-components/src/useDebouncedViewportSearch.test.ts
@@ -114,17 +114,21 @@ it.each(['', '    '])(
   }
 );
 
-it('should cancel debounce on unmount', () => {
+it('should allow cancelling debounced search function call', () => {
   const searchText = 'mock.searchText';
   const debounceMs = 400;
 
-  const { result, unmount } = renderHook(() =>
+  const { result } = renderHook(() =>
     useDebouncedViewportSearch(viewportData, 'mock.column', debounceMs)
   );
 
-  result.current(searchText);
+  const searchFn = result.current;
+
+  searchFn(searchText);
   jest.advanceTimersByTime(5);
-  unmount();
+
+  searchFn.cancel();
+
   jest.advanceTimersByTime(debounceMs);
 
   expect(TableUtils.makeFilterValue).not.toHaveBeenCalled();

diff --git a/packages/jsapi-components/src/useDebouncedViewportSearch.ts b/packages/jsapi-components/src/useDebouncedViewportSearch.ts
@@ -1,9 +1,13 @@
+import type { DebouncedFunc } from 'lodash';
 import debounce from 'lodash.debounce';
 import type { Table, TreeTable } from '@deephaven/jsapi-types';
 import { TableUtils } from '@deephaven/jsapi-utils';
-import { useEffect, useMemo } from 'react';
+import Log from '@deephaven/log';
+import { useMemo } from 'react';
 import { UseViewportDataResult } from './useViewportData';
 
+const log = Log.module('useDebouncedViewportSearch');
+
 export const DEBOUNCE_VIEWPORT_SEARCH_MS = 200;
 
 /**
@@ -20,10 +24,12 @@ export default function useDebouncedViewportSearch<
   viewportData: UseViewportDataResult<I, T>,
   columnName: string,
   debounceMs = DEBOUNCE_VIEWPORT_SEARCH_MS
-): (searchText: string) => void {
+): DebouncedFunc<(searchText: string) => void> {
   const debouncedSearch = useMemo(
     () =>
       debounce((searchText: string) => {
+        log.debug(`Applying debounced searchText '${searchText}'`);
+
         if (viewportData.table == null) {
           return;
         }
@@ -47,12 +53,5 @@ export default function useDebouncedViewportSearch<
     [columnName, debounceMs, viewportData]
   );
 
-  useEffect(
-    () => () => {
-      debouncedSearch.cancel();
-    },
-    [debouncedSearch]
-  );
-
   return debouncedSearch;
 }