Merge pull request ibi-group#474 from ibi-group/improve-user-search

Filter datatool users using any substring

Author: binh-dam-ibigroup

src/main/java/com/conveyal/datatools/manager/controllers/api/UserController.java

@@ -107,7 +107,7 @@ private static String getAllUsers(Request req, Response res) {
     private static String filterUserSearchQuery(Request req) {
         Auth0UserProfile userProfile = req.attribute("user");
         String queryString = req.queryParams("queryString");
-        if(queryString != null) queryString = "email:" + queryString + "*";
+        if(queryString != null) queryString = makeEmailFilterQuery(queryString);
 
         if (userProfile.canAdministerApplication()) {
             // do not filter further based on permissions, proceed with search
@@ -206,6 +206,20 @@ private static Auth0UserSearchResult checkForExistingAuth0User(Request req, Stri
         }
     }
 
+    /**
+     * Generates an email search query for the given base query string.
+     */
+    public static String makeEmailFilterQuery(String queryString) {
+        // Don't insert the "begins with" wildcard if the search term is less than 3 characters long.
+        // per https://auth0.com/docs/manage-users/user-search/user-search-query-syntax#wildcards.
+        boolean isAtLeast3Chars = queryString != null && queryString.length() >= 3;
+        return String.format(
+            "email:%s%s*",
+            isAtLeast3Chars ? "*" : "",
+            queryString
+        );
+    }
+
     /**
      * Class to hold a user's profile and raw JSON permissions.
      */

src/test/java/com/conveyal/datatools/manager/controllers/api/UserControllerTest.java

@@ -12,9 +12,13 @@
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
 
 import java.io.IOException;
 import java.net.URLEncoder;
+import java.util.stream.Stream;
 
 import static com.conveyal.datatools.TestUtils.parseJson;
 import static com.conveyal.datatools.manager.auth.Auth0Users.USERS_API_PATH;
@@ -464,6 +468,26 @@ public void updateUserFailsWhenApiTokenInvalid() throws IOException {
         setCachedApiToken(null);
     }
 
+    /**
+     * Ensures that search wildcards are correctly inserted into search queries.
+     */
+    @ParameterizedTest
+    @MethodSource("createMakeEmailFilterQueryCases")
+    public void shouldMakeEmailFilterQuery(String queryString, String result) {
+        assertThat(
+            "Auth0 email user queries should be valid.",
+            UserController.makeEmailFilterQuery(queryString).equals(result)
+        );
+    }
+
+    private static Stream<Arguments> createMakeEmailFilterQueryCases() {
+        return Stream.of(
+            Arguments.of("Joe", "email:*Joe*"),
+            // Don't insert the "begins with" wildcard if the search term is less than 3 characters long.
+            Arguments.of("Jo", "email:Jo*")
+        );
+    }
+
     private static void stubForApiToken(String bodyFile) {
         wireMockServer.stubFor(
             post(urlPathEqualTo("/oauth/token"))