A platform for community discussion. Free, open, simple.
DEV: Let user search query a custom endpoint and a given set of users
Régis Hanol4d0c6a60b556
diff --git a/app/models/user_search.rb b/app/models/user_search.rbindex 3017dd56978..619f934d09a 100644--- a/app/models/user_search.rb+++ b/app/models/user_search.rb@@ -20,6 +20,8 @@ class UserSearch@last_seen_users = !!opts[:last_seen_users] && !@include_staged_users@limit = opts[:limit] || 20@groups = opts[:groups]+ # Callers are responsible for authorizing the users this exposes.+ @user_ids = opts[:user_ids]@can_review = opts[:can_review] || false@search_custom_fields = opts[:search_custom_fields] || false@@ -36,6 +38,7 @@ class UserSearchusers = users.where(approved: true) if SiteSetting.must_approve_users?users = users.where(staged: false) unless @include_staged_usersusers = users.not_suspended unless @guardian.is_staff?+ users = users.where(id: @user_ids) if @user_idsif @groupsusers = users.joins(:group_users).where("group_users.group_id IN (?)", @groups.map(&:id))diff --git a/frontend/discourse/app/lib/user-search.js b/frontend/discourse/app/lib/user-search.jsindex 4bba9b03bff..7eb41001bf4 100644--- a/frontend/discourse/app/lib/user-search.js+++ b/frontend/discourse/app/lib/user-search.js@@ -31,22 +31,7 @@ export function resetUserSearchCache() {rateLimitedUntil = 0;}-function performSearch(- term,- topicId,- categoryId,- includeGroups,- includeMentionableGroups,- includeMessageableGroups,- customUserSearchOptions,- allowedUsers,- groupMembersOf,- includeStagedUsers,- lastSeenUsers,- prioritizedUserId,- limit,- resultsFn-) {+function performSearch(url, term, params, resultsFn) {let cached = cache[term];if (cached) {resultsFn(cloneJSON(cached));@@ -58,40 +43,20 @@ function performSearch(return;}- const eagerComplete = eagerCompleteSearch(term, topicId || categoryId);+ const eagerComplete = eagerCompleteSearch(+ term,+ params.topic_id || params.category_id+ );- if (term === "" && !eagerComplete && !lastSeenUsers) {+ if (term === "" && !eagerComplete && !params.last_seen_users) {// The server returns no results in this case, so no point checking// do not return empty list, because autocomplete will get terminatedresultsFn(CANCELLED_STATUS);return;}- let data = {- term,- topic_id: topicId,- category_id: categoryId,- include_groups: includeGroups,- include_mentionable_groups: includeMentionableGroups,- include_messageable_groups: includeMessageableGroups,- groups: groupMembersOf,- topic_allowed_users: allowedUsers,- include_staged_users: includeStagedUsers,- last_seen_users: lastSeenUsers,- prioritized_user_id: prioritizedUserId,- limit,- };-- if (customUserSearchOptions) {- Object.keys(customUserSearchOptions).forEach((key) => {- data[camelCaseToSnakeCase(key)] = customUserSearchOptions[key];- });- }-// need to be able to cancel this- oldSearch = ajax(userPath("search/users"), {- data,- });+ oldSearch = ajax(url, { data: { term, ...params } });let returnVal = CANCELLED_STATUS;@@ -127,42 +92,9 @@ function performSearch(});}-let debouncedSearch = function (- term,- topicId,- categoryId,- includeGroups,- includeMentionableGroups,- includeMessageableGroups,- customUserSearchOptions,- allowedUsers,- groupMembersOf,- includeStagedUsers,- lastSeenUsers,- prioritizedUserId,- limit,- resultsFn-) {- discourseDebounce(- this,- performSearch,- term,- topicId,- categoryId,- includeGroups,- includeMentionableGroups,- includeMessageableGroups,- customUserSearchOptions,- allowedUsers,- groupMembersOf,- includeStagedUsers,- lastSeenUsers,- prioritizedUserId,- limit,- resultsFn,- 300- );-};+function debouncedSearch(url, term, params, resultsFn) {+ discourseDebounce(this, performSearch, url, term, params, resultsFn, 300);+}function lowerCaseIncludes(string, term) {return string && term && string.toLowerCase().includes(term.toLowerCase());@@ -368,19 +300,26 @@ export default function userSearch(options) {options.term = options.term.substring(1);}- let term = options.term || "",- includeGroups = options.includeGroups,- includeMentionableGroups = options.includeMentionableGroups,- includeMessageableGroups = options.includeMessageableGroups,- customUserSearchOptions = options.customUserSearchOptions,- allowedUsers = options.allowedUsers,- topicId = options.topicId,- categoryId = options.categoryId,- groupMembersOf = options.groupMembersOf,- includeStagedUsers = options.includeStagedUsers,- lastSeenUsers = options.lastSeenUsers,- prioritizedUserId = options.prioritizedUserId,- limit = options.limit || 6;+ const term = options.term || "";+ const limit = options.limit || 6;+ const url = options.url || userPath("search/users");+ const params = {+ topic_id: options.topicId,+ category_id: options.categoryId,+ include_groups: options.includeGroups,+ include_mentionable_groups: options.includeMentionableGroups,+ include_messageable_groups: options.includeMessageableGroups,+ groups: options.groupMembersOf,+ topic_allowed_users: options.allowedUsers,+ include_staged_users: options.includeStagedUsers,+ last_seen_users: options.lastSeenUsers,+ prioritized_user_id: options.prioritizedUserId,+ limit,+ };++ Object.entries(options.customUserSearchOptions || {}).forEach(+ ([key, value]) => (params[camelCaseToSnakeCase(key)] = value)+ );if (oldSearch) {oldSearch.abort();@@ -390,7 +329,7 @@ export default function userSearch(options) {currentTerm = term;return new Promise(function (resolve) {- const newCacheKey = `${topicId}-${categoryId}`;+ const newCacheKey = JSON.stringify([url, params]);if (new Date() - cacheTime > 30000 || cacheKey !== newCacheKey) {cache = {};@@ -408,25 +347,10 @@ export default function userSearch(options) {return;}- debouncedSearch(- term,- topicId,- categoryId,- includeGroups,- includeMentionableGroups,- includeMessageableGroups,- customUserSearchOptions,- allowedUsers,- groupMembersOf,- includeStagedUsers,- lastSeenUsers,- prioritizedUserId,- limit,- function (r) {- cancel(clearPromise);- resolve(organizeResults(r, { ...options, limit }));- }- );+ debouncedSearch(url, term, params, function (r) {+ cancel(clearPromise);+ resolve(organizeResults(r, { ...options, limit }));+ });});}diff --git a/frontend/discourse/select-kit/components/user-chooser.js b/frontend/discourse/select-kit/components/user-chooser.jsindex 6853a15b282..776fead279b 100644--- a/frontend/discourse/select-kit/components/user-chooser.js+++ b/frontend/discourse/select-kit/components/user-chooser.js@@ -28,6 +28,7 @@ export const CUSTOM_USER_SEARCH_OPTIONS = [];excludeCurrentUser: false,customSearchOptions: undefined,excludedUsernames: undefined,+ searchUrl: undefined,})@pluginApiIdentifiers("user-chooser")export default class UserChooser extends MultiSelectComponent {@@ -102,6 +103,7 @@ export default class UserChooser extends MultiSelectComponent {allowEmails: options.allowEmails,includeStagedUsers: this.includeStagedUsers,customUserSearchOptions,+ url: options.searchUrl,}).then((result) => {if (typeof result === "string") {// do nothing promise probably got cancelleddiff --git a/frontend/discourse/tests/unit/lib/user-search-test.js b/frontend/discourse/tests/unit/lib/user-search-test.jsindex 6bf22a8cac0..105b823514b 100644--- a/frontend/discourse/tests/unit/lib/user-search-test.js+++ b/frontend/discourse/tests/unit/lib/user-search-test.js@@ -102,6 +102,21 @@ module("Unit | Utility | user-search", function (hooks) {assert.strictEqual(results.length, 1);});+ test("it searches the given url without reusing results cached for another one", async function (assert) {+ pretender.get("/custom/search", () =>+ response({ users: [{ username: "custom_user" }] })+ );++ let results = await userSearch({ term: "hello" });+ assert.strictEqual(results[0].username, "TeaMoe");++ results = await userSearch({ term: "hello", url: "/custom/search" });+ assert.deepEqual(+ results.map((r) => r.username),+ ["custom_user"]+ );+ });+test("it returns cancel when eager completing with no results", async function (assert) {// Do everything twice, to check the cache works correctlydiff --git a/spec/models/user_search_spec.rb b/spec/models/user_search_spec.rbindex 87f28ab9086..335f7e6052c 100644--- a/spec/models/user_search_spec.rb+++ b/spec/models/user_search_spec.rb@@ -164,6 +164,13 @@ RSpec.describe UserSearch do).to eq(["mixedmember"])end+ it "allows restricting results to a set of users" do+ expect(search_for("mrb", user_ids: User.where(id: mr_blue.id).select(:id))).to eq(+ [mr_blue.username],+ )+ expect(search_for("mrb", user_ids: [])).to eq([])+ end+it "does not let membership in one group grant visibility into a co-filtered hidden group" dosearcher = Fabricate(:user)visible_group = Fabricate(:group, visibility_level: Group.visibility_levels[:public])