Added ModuleRunner extension points for user search extension

src/components/views/dialogs/InviteDialog.tsx

@@ -76,6 +76,7 @@ import { SdkContextClass } from "../../../contexts/SDKContext";
 import { UserProfilesStore } from "../../../stores/UserProfilesStore";
 import { Key } from "../../../Keyboard";
 import SpaceStore from "../../../stores/spaces/SpaceStore";
+import { ModuleRunner } from "../../../modules/ModuleRunner";
 
 // we have a number of types defined from the Matrix spec which can't reasonably be altered here.
 /* eslint-disable camelcase */
@@ -641,8 +642,12 @@ export default class InviteDialog extends React.PureComponent<Props, IInviteDial
 
         let foundUser = false;
         try {
-            await MatrixClientPeg.get()
-                ?.searchUserDirectory({ term: this.state.filterText.trim().split(":")[0] ?? this.state.filterText })
+            var client = await MatrixClientPeg.get();
+
+            const searchContext = await ModuleRunner.instance.extensions.userSearch.getSearchContext(client, SdkContextClass.instance);
+
+            client
+                ?.searchUserDirectory({ term: this.state.filterText.trim().split(":")[0] ?? this.state.filterText }, searchContext.extraBodyArgs, searchContext.extraRequestOptions,)
                 .then(async (r) => {
                     this.setState({ busy: false });
 
@@ -946,9 +951,16 @@ export default class InviteDialog extends React.PureComponent<Props, IInviteDial
         this.props.onFinished(false);
     };
 
+
+
+
     private updateSuggestions = async (term: string): Promise<void> => {
-        MatrixClientPeg.safeGet()
-            .searchUserDirectory({ term })
+
+        var client =  MatrixClientPeg.safeGet();
+        var searchContext = await ModuleRunner.instance.extensions.userSearch.getSearchContext(client, SdkContextClass.instance);
+
+        client
+            .searchUserDirectory({ term }, searchContext.extraBodyArgs, searchContext.extraRequestOptions)
             .then(async (r): Promise<void> => {
                 if (term !== this.state.filterText) {
                     // Discard the results - we were probably too slow on the server-side to make
@@ -1157,8 +1169,11 @@ export default class InviteDialog extends React.PureComponent<Props, IInviteDial
         this.setState({ busy: true });
 
         let directoryUsers: any[] = [];
-        await MatrixClientPeg.get()
-            ?.searchUserDirectory({ term: text })
+
+        let client = await MatrixClientPeg.get();
+        const searchContext = await ModuleRunner.instance.extensions.userSearch.getSearchContext(client, SdkContextClass.instance);
+        client
+            ?.searchUserDirectory({ term: text }, searchContext.extraBodyArgs, searchContext.extraRequestOptions)
             .then(async (r) => {
                 this.setState({ busy: false });
 

src/hooks/useUserDirectory.ts

@@ -19,6 +19,8 @@ import { useCallback, useState } from "react";
 import { MatrixClientPeg } from "../MatrixClientPeg";
 import { DirectoryMember } from "../utils/direct-messages";
 import { useLatestResult } from "./useLatestResult";
+import { ModuleRunner } from "../modules/ModuleRunner";
+import { SdkContextClass } from "../contexts/SDKContext";
 
 export interface IUserDirectoryOpts {
     limit: number;
@@ -49,7 +51,10 @@ export const useUserDirectory = (): {
 
             try {
                 setLoading(true);
-                const { results } = await MatrixClientPeg.safeGet().searchUserDirectory(opts);
+                const client = await MatrixClientPeg.safeGet();
+                var searchContext = await ModuleRunner.instance.extensions.userSearch.getSearchContext(client, SdkContextClass.instance);
+                const { results } = await client.searchUserDirectory(opts, searchContext.extraBodyArgs, searchContext.extraRequestOptions);
+
                 updateResult(
                     opts,
                     results.map((user) => new DirectoryMember(user)),

src/modules/ModuleRunner.ts

@@ -25,6 +25,10 @@ import {
     DefaultExperimentalExtensions,
     ProvideExperimentalExtensions,
 } from "@matrix-org/react-sdk-module-api/lib/lifecycles/ExperimentalExtensions";
+import {
+    DefaultUserSearchExtensions,
+    ProvideUserSearchExtensions,
+} from "@matrix-org/react-sdk-module-api/lib/lifecycles/UserSearchExtensions";
 
 import { AppModule } from "./AppModule";
 import { ModuleFactory } from "./ModuleFactory";
@@ -38,20 +42,26 @@ class ExtensionsManager {
     // Private backing fields for extensions
     private cryptoSetupExtension: ProvideCryptoSetupExtensions;
     private experimentalExtension: ProvideExperimentalExtensions;
+    private userSearchExtension: ProvideUserSearchExtensions;
 
     /** `true` if `cryptoSetupExtension` is the default implementation; `false` if it is implemented by a module. */
     private hasDefaultCryptoSetupExtension = true;
 
+    /** `true` if `userSearchExtension` is the default implementation; `false` if it is implemented by a module. */
+    private hasDefaultUserSearchExtension = true;
+
     /** `true` if `experimentalExtension` is the default implementation; `false` if it is implemented by a module. */
     private hasDefaultExperimentalExtension = true;
 
+
     /**
      * Create a new instance.
      */
     public constructor() {
         // Set up defaults
         this.cryptoSetupExtension = new DefaultCryptoSetupExtensions();
         this.experimentalExtension = new DefaultExperimentalExtensions();
+        this.userSearchExtension  = new DefaultUserSearchExtensions();
     }
 
     /**
@@ -63,6 +73,16 @@ class ExtensionsManager {
         return this.cryptoSetupExtension;
     }
 
+    /**
+     * Provides a user search extension.
+     *
+     * @returns The registered extension. If no module provides this extension, a default implementation is returned.
+     */
+    public get userSearch(): ProvideUserSearchExtensions {
+        return this.userSearchExtension;
+    }
+
+
     /**
      * Provides an experimental extension.
      *
@@ -97,6 +117,18 @@ class ExtensionsManager {
             }
         }
 
+        /* Add the userSearch extension if any */
+        if (runtimeModule.extensions?.userSearch) {
+            if (this.hasDefaultUserSearchExtension) {
+                this.userSearchExtension = runtimeModule.extensions?.userSearch;
+                this.hasDefaultCryptoSetupExtension = false;
+            } else {
+                throw new Error(
+                    `adding userSearch extension implementation from module ${runtimeModule.moduleName} but an implementation was already provided.`,
+                );
+            }
+        }
+
         /* Add the experimental extension if any */
         if (runtimeModule.extensions?.experimental) {
             if (this.hasDefaultExperimentalExtension) {
@@ -190,4 +222,4 @@ export class ModuleRunner {
             module.module.emit(lifecycleEvent, ...args);
         }
     }
-}
+}

src/stores/widgets/StopGapWidgetDriver.ts

@@ -539,7 +539,9 @@ export class StopGapWidgetDriver extends WidgetDriver {
     public async searchUserDirectory(searchTerm: string, limit?: number): Promise<ISearchUserDirectoryResult> {
         const client = MatrixClientPeg.safeGet();
 
-        const { limited, results } = await client.searchUserDirectory({ term: searchTerm, limit });
+        var searchContext = await ModuleRunner.instance.extensions.userSearch.getSearchContext(client, SdkContextClass.instance);
+
+        const { limited, results } = await client.searchUserDirectory({ term: searchTerm, limit }, searchContext.extraBodyArgs, searchContext.extraRequestOptions);
 
         return {
             limited,

test/stores/widgets/StopGapWidgetDriver-test.ts

@@ -430,7 +430,7 @@ describe("StopGapWidgetDriver", () => {
                 results: [{ userId: "@user", displayName: "Name", avatarUrl: "mxc://" }],
             });
 
-            expect(client.searchUserDirectory).toHaveBeenCalledWith({ term: "foo", limit: undefined });
+            expect(client.searchUserDirectory).toHaveBeenCalledWith({ term: "foo", limit: undefined }, {});
         });
 
         it("searches for users with a custom limit", async () => {
@@ -444,7 +444,7 @@ describe("StopGapWidgetDriver", () => {
                 results: [],
             });
 
-            expect(client.searchUserDirectory).toHaveBeenCalledWith({ term: "foo", limit: 25 });
+            expect(client.searchUserDirectory).toHaveBeenCalledWith({ term: "foo", limit: 25 }, {});
         });
     });