Skip to content

fix: remove just-debounce-it #9707

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 18, 2023
Merged

fix: remove just-debounce-it #9707

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e977d8e
fix: Switch UserAutocomplete to useDebouncedFunction
Parkreiner Sep 15, 2023
6a10a2b
fix: switch UserOrGroupAutocomplete to useDebouncedFunction
Parkreiner Sep 15, 2023
0e00bd5
chore: remove just-debounce-it dependency
Parkreiner Sep 15, 2023
1903e42
docs: Clean up comments
Parkreiner Sep 18, 2023
a7fd5d2
Merge remote-tracking branch 'origin' into debounce-fix
Parkreiner Sep 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion site/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,6 @@
"jest-runner-eslint": "2.1.0",
"jest-websocket-mock": "2.5.0",
"jest_workaround": "0.1.14",
"just-debounce-it": "3.2.0",
"msw": "1.3.0",
"prettier": "3.0.0",
"protobufjs": "7.2.4",
Expand Down
7 changes: 0 additions & 7 deletions site/pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

34 changes: 24 additions & 10 deletions site/src/components/UserAutocomplete/UserAutocomplete.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,17 @@ import { useMachine } from "@xstate/react";
import { User } from "api/typesGenerated";
import { Avatar } from "components/Avatar/Avatar";
import { AvatarData } from "components/AvatarData/AvatarData";
import debounce from "just-debounce-it";
import { ChangeEvent, ComponentProps, FC, useEffect, useState } from "react";
import {
ChangeEvent,
ComponentProps,
FC,
useEffect,
useRef,
useState,
} from "react";
import { searchUserMachine } from "xServices/users/searchUserXService";
import Box from "@mui/material/Box";
import { useDebouncedFunction } from "hooks/debounce";

export type UserAutocompleteProps = {
value: User | null;
Expand All @@ -31,16 +38,23 @@ export const UserAutocomplete: FC<UserAutocompleteProps> = ({
const [searchState, sendSearch] = useMachine(searchUserMachine);
const { searchResults } = searchState.context;

// seed list of options on the first page load if a user pases in a value
// since some organizations have long lists of users, we do not load all options on page load.
// Seed list of options on the first page load if a user passes in a value.
// Since some organizations have long lists of users, we do not want to load
// all options on page load.
const onMountRef = useRef(value);
useEffect(() => {
if (value) {
sendSearch("SEARCH", { query: value.email });
const mountValue = onMountRef.current;
if (mountValue) {
sendSearch("SEARCH", { query: mountValue.email });
}
// eslint-disable-next-line react-hooks/exhaustive-deps -- TODO look into this
}, []);

const handleFilterChange = debounce(
// This isn't in XState's docs, but its source code guarantees that the
// memory reference of sendSearch will stay stable across renders. This
// useEffect call will behave like an on-mount effect and will not ever need
// to resynchronize
}, [sendSearch]);

const { debounced: debouncedOnChange } = useDebouncedFunction(
(event: ChangeEvent<HTMLInputElement>) => {
sendSearch("SEARCH", { query: event.target.value });
},
Expand Down Expand Up @@ -93,7 +107,7 @@ export const UserAutocomplete: FC<UserAutocompleteProps> = ({
className={styles.textField}
InputProps={{
...params.InputProps,
onChange: handleFilterChange,
onChange: debouncedOnChange,
startAdornment: value && (
<Avatar size="sm" src={value.avatar_url}>
{value.username}
Expand Down
4 changes: 2 additions & 2 deletions site/src/components/UserOrGroupAutocomplete/UserOrGroupAutocomplete.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ import Autocomplete from "@mui/material/Autocomplete";
import { useMachine } from "@xstate/react";
import { Group, User } from "api/typesGenerated";
import { AvatarData } from "components/AvatarData/AvatarData";
import debounce from "just-debounce-it";
import { ChangeEvent, useState } from "react";
import { getGroupSubtitle } from "utils/groups";
import { searchUsersAndGroupsMachine } from "xServices/template/searchUsersAndGroupsXService";
import Box from "@mui/material/Box";
import { useDebouncedFunction } from "hooks/debounce";

export type UserOrGroupAutocompleteValue = User | Group | null;

Expand Down Expand Up @@ -44,7 +44,7 @@ export const UserOrGroupAutocomplete: React.FC<
return !excludeIds.includes(result.id);
});

const handleFilterChange = debounce(
const { debounced: handleFilterChange } = useDebouncedFunction(
(event: ChangeEvent<HTMLInputElement>) => {
sendSearch("SEARCH", { query: event.target.value });
},
Expand Down