feat: add MentionsSearchSource with support for discarding obsolete middleware results

Author: MartinCupela

src/channel.ts

@@ -161,7 +161,7 @@ export class Channel {
     this._messageComposer = new MessageComposer({ channel: this });
     this._messageComposer.textComposer.use([
       createCommandsMiddleware(this),
-      createMentionsMiddleware(client),
+      createMentionsMiddleware(this),
     ] as TextComposerMiddleware[]);
   }
 

src/constants.ts

@@ -3,3 +3,4 @@ export const DEFAULT_QUERY_CHANNEL_MESSAGE_LIST_PAGE_SIZE = 100;
 export const DEFAULT_MESSAGE_SET_PAGINATION = { hasNext: false, hasPrev: false };
 export const DEFAULT_UPLOAD_SIZE_LIMIT_BYTES = 100 * 1024 * 1024; // 100 MB
 export const API_MAX_FILES_ALLOWED_PER_MESSAGE = 10;
+export const MAX_CHANNEL_MEMBER_COUNT_IN_CHANNEL_QUERY = 100;

src/messageComposer/middleware/commands.ts

@@ -17,7 +17,12 @@ class CommandSearchSource extends BaseSearchSource<CommandSuggestion> {
     this.channel = channel;
   }
 
-  protected query(searchQuery: string) {
+  canExecuteQuery = (newSearchString?: string) => {
+    const hasNewSearchQuery = typeof newSearchString !== 'undefined';
+    return this.isActive && !this.isLoading && (this.hasNext || hasNewSearchQuery);
+  };
+
+  query(searchQuery: string) {
     const channelConfig = this.channel.getConfig();
     const commands = channelConfig?.commands || [];
     const selectedCommands: (CommandResponse & { name: string })[] = commands.filter(
@@ -80,6 +85,9 @@ export const createCommandsMiddleware = (
   options?: TextComposerMiddlewareOptions,
 ) => {
   const finalOptions = mergeWith(DEFAULT_OPTIONS, options ?? {});
+  const searchSource = new CommandSearchSource(channel);
+  searchSource.activate();
+
   return {
     id: finalOptions.trigger,
     onChange: ({ input, nextHandler }: MiddlewareParams<CommandSuggestion>) => {
@@ -92,13 +100,15 @@ export const createCommandsMiddleware = (
       );
 
       if (!lastToken || lastToken.length < finalOptions.minChars) {
-        // check whether suggestions already exist and if so remove them
-        return nextHandler(input);
+        const hasStaleSuggestions =
+          input.state.suggestions?.trigger === finalOptions.trigger;
+        const newInput = { ...input };
+        if (hasStaleSuggestions) {
+          delete newInput.state.suggestions;
+        }
+        return nextHandler(newInput);
       }
 
-      const searchSource = new CommandSearchSource(channel);
-      searchSource.activate();
-
       return Promise.resolve({
         state: {
           ...state,