Skip to content
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

Jump to bottom

fix(useUserTrigger): default filters/sorting #2201

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

fix(useUserTrigger): default filters/sorting #2201

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
55d7680
Refactor trigger, switch to debounce, remove unused stuff
arnautov-anton Dec 1, 2023
8282956
Proposed, but breaking solution
arnautov-anton Dec 1, 2023
376d7b7
Change mechanism back to throttle, increase delay
arnautov-anton Dec 13, 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
111 changes: 51 additions & 60 deletions src/components/MessageInput/hooks/useUserTrigger.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { useCallback, useState } from 'react';
import { useCallback } from 'react';
import throttle from 'lodash.throttle';

import { SearchLocalUserParams, searchLocalUsers } from './utils';
Expand All @@ -25,6 +25,8 @@ export type UserTriggerParams<
useMentionsTransliteration?: boolean;
};

const THROTTLE_DELAY = 500;

export const useUserTrigger = <
StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics
>(
Expand All @@ -38,8 +40,6 @@ export const useUserTrigger = <
useMentionsTransliteration,
} = params;

const [searching, setSearching] = useState(false);

const { client, mutes, themeVersion } = useChatContext<StreamChatGenerics>('useUserTrigger');
const { channel } = useChannelStateContext<StreamChatGenerics>('useUserTrigger');

Expand All @@ -52,7 +52,7 @@ export const useUserTrigger = <
const users = [...memberUsers, ...watcherUsers];

// make sure we don't list users twice
const uniqueUsers = {} as Record<string, UserResponse<StreamChatGenerics>>;
const uniqueUsers: Record<string, UserResponse<StreamChatGenerics>> = {};

users.forEach((user) => {
if (user && !uniqueUsers[user.id]) {
Expand Down Expand Up @@ -85,72 +85,64 @@ export const useUserTrigger = <
console.log({ error });
}
},
200,
THROTTLE_DELAY,
{ leading: true, trailing: true },
),
[channel],
);

const queryUsers = async (
query: string,
onReady: (users: UserResponse<StreamChatGenerics>[]) => void,
) => {
if (!query || searching) return;
setSearching(true);

try {
const { users } = await client.queryUsers(
// @ts-expect-error
{
$or: [{ id: { $autocomplete: query } }, { name: { $autocomplete: query } }],
id: { $ne: client.userID },
...(typeof mentionQueryParams.filters === 'function'
? mentionQueryParams.filters(query)
: mentionQueryParams.filters),
},
Array.isArray(mentionQueryParams.sort)
? [{ id: 1 }, ...mentionQueryParams.sort]
: { id: 1, ...mentionQueryParams.sort },
{ limit: 10, ...mentionQueryParams.options },
);
const queryUsersThrottled = useCallback(
throttle(
async (query: string, onReady: (users: UserResponse<StreamChatGenerics>[]) => void) => {
if (!query) return;

if (onReady && users.length) {
onReady(users);
} else {
onReady([]);
}
} catch (error) {
console.log({ error });
const {
filters = { id: { $ne: client.user?.id }, name: { $autocomplete: query } },
sort = { name: 1 },
options = { limit: 10 },
} = mentionQueryParams;

try {
const { users } = await client.queryUsers(
// @ts-expect-error
typeof filters === 'function' ? filters(query) : filters,
sort,
options,
);

onReady?.(users);
} catch (error) {
console.log({ error });
}
},
THROTTLE_DELAY,
{ leading: true, trailing: true },
),
[client, mentionQueryParams],
);

const filterMutes = (data: UserResponse<StreamChatGenerics>[], text: string) => {
if (text.includes('/unmute') && !mutes.length) {
return [];
}
if (!mutes.length) return data;

setSearching(false);
if (text.includes('/unmute')) {
return data.filter((suggestion) => mutes.some((mute) => mute.target.id === suggestion.id));
}
return data.filter((suggestion) => mutes.every((mute) => mute.target.id !== suggestion.id));
};

const queryUsersThrottled = throttle(queryUsers, 200);

return {
callback: (item) => onSelectUser(item),
callback: onSelectUser,
component: UserItem,
dataProvider: (query, text, onReady) => {
if (disableMentions) return;

const filterMutes = (data: UserResponse<StreamChatGenerics>[]) => {
if (text.includes('/unmute') && !mutes.length) {
return [];
}
if (!mutes.length) return data;

if (text.includes('/unmute')) {
return data.filter((suggestion) =>
mutes.some((mute) => mute.target.id === suggestion.id),
);
}
return data.filter((suggestion) => mutes.every((mute) => mute.target.id !== suggestion.id));
};

if (mentionAllAppUsers) {
return queryUsersThrottled(query, (data: UserResponse<StreamChatGenerics>[]) => {
if (onReady) onReady(filterMutes(data), query);
});
return queryUsersThrottled(query, (data: UserResponse<StreamChatGenerics>[]) =>
onReady?.(filterMutes(data, text), query),
);
}

/**
Expand All @@ -175,13 +167,12 @@ export const useUserTrigger = <
const usersToShow = mentionQueryParams.options?.limit ?? (themeVersion === '2' ? 7 : 10);
const data = matchingUsers.slice(0, usersToShow);

if (onReady) onReady(filterMutes(data), query);
return data;
return onReady?.(filterMutes(data, text), query);
}

return queryMembersThrottled(query, (data: UserResponse<StreamChatGenerics>[]) => {
if (onReady) onReady(filterMutes(data), query);
});
queryMembersThrottled(query, (data: UserResponse<StreamChatGenerics>[]) =>
onReady?.(filterMutes(data, text), query),
);
},
output: (entity) => ({
caretPosition: 'next',
Expand Down
Loading