Merge pull request rabbitmq#6990 from rabbitmq/mgmt-users-filter-fix-4908

Fix Users filtering in Management UI

Author: ikavgo

.gitignore

@@ -1,5 +1,6 @@
 *~
 .sw?
+*.tmp
 .*.sw?
 /.erlang.mk/
 /_build/

deps/rabbitmq_management/priv/www/js/dispatcher.js

@@ -194,9 +194,9 @@ dispatcher_add(function(sammy) {
             return false;
         });
 
-    path('#/users', {'users': {path:    '/users',
-                               options: {sort:true}},
-                     'permissions': '/permissions'}, 'users');
+    sammy.get('#/users', function() {
+        renderUsers();
+    });
     sammy.get('#/users/:id', function() {
         var vhosts = JSON.parse(sync_get('/vhosts'));
         const current_vhost = get_pref('vhost');

deps/rabbitmq_management/priv/www/js/main.js

@@ -778,6 +778,7 @@ function update_pages(template, page_start){
          case 'exchanges' : renderExchanges(); break;
          case 'connections' : renderConnections(); break;
          case 'channels' : renderChannels(); break;
+         case 'users' : renderUsers(); break;
          default:
              renderCallback = RENDER_CALLBACKS[template];
              if (renderCallback != undefined) {
@@ -799,6 +800,16 @@ function renderQueues() {
     }, 'vhosts': '/vhosts'}, 'queues', '#/queues');
 }
 
+function renderUsers() {
+    render({'users': {path: url_pagination_template('users', 1, 100),
+		      options: {
+			  sort: true,
+			  pagination: true
+		      }
+		     },
+            'permissions': '/permissions'}, 'users', '#/users');
+}
+
 function renderExchanges() {
     render({'exchanges': {path: url_pagination_template('exchanges', 1, 100),
                           options: {sort:true, vhost:true, pagination:true}},

deps/rabbitmq_management/priv/www/js/tmpl/limits.ejs

@@ -146,9 +146,9 @@
                 <th><label>User:</label></th>
                 <td>
                   <select name="user">
-                      <% for (var i = 0; i < users.length; i++) { %>
-                      <option value="<%= fmt_string(users[i].name) %>">
-                          <%= fmt_string(users[i].name) %>
+                      <% for (var i = 0; i < users.items.length; i++) { %>
+                      <option value="<%= fmt_string(users.items[i].name) %>">
+                          <%= fmt_string(users.items[i].name) %>
                       </option>
                       <% } %>
                   </select>

deps/rabbitmq_management/priv/www/js/tmpl/permissions.ejs

@@ -55,8 +55,8 @@ for (var i = 0; i < permissions.length; i++) {
           <td>
             <input type="hidden" name="vhost" value="<%= fmt_string(parent.name) %>"/>
             <select name="username">
-              <% for (var i = 0; i < users.length; i++) { %>
-              <option value="<%= fmt_string(users[i].name) %>"><%= fmt_string(users[i].name) %></option>
+              <% for (var i = 0; i < users.items.length; i++) { %>
+              <option value="<%= fmt_string(users.items[i].name) %>"><%= fmt_string(users.items[i].name) %></option>
               <% } %>
             </select>
           </td>

deps/rabbitmq_management/priv/www/js/tmpl/topic-permissions.ejs

@@ -56,8 +56,8 @@ for (var i = 0; i < topic_permissions.length; i++) {
           <td>
             <input type="hidden" name="vhost" value="<%= fmt_string(parent.name) %>"/>
             <select name="username">
-              <% for (var i = 0; i < users.length; i++) { %>
-              <option value="<%= fmt_string(users[i].name) %>"><%= fmt_string(users[i].name) %></option>
+              <% for (var i = 0; i < users.items.length; i++) { %>
+              <option value="<%= fmt_string(users.items[i].name) %>"><%= fmt_string(users.items[i].name) %></option>
               <% } %>
             </select>
           </td>

deps/rabbitmq_management/priv/www/js/tmpl/users.ejs

@@ -1,10 +1,9 @@
 <h1>Users</h1>
-<div class="section" id="users-section">
-  <h2>All users</h2>
-  <div class="hider">
-<%= filter_ui(users) %>
-  <div class="updatable">
-<% if (users.length > 0) { %>
+<div class="section">
+    <%= paginate_ui(users, 'users') %>
+</div>
+<div class="updatable">
+    <% if (users.items.length > 0) { %>
 <table class="list">
   <thead>
     <tr>
@@ -16,8 +15,8 @@
   </thead>
   <tbody>
     <%
-       for (var i = 0; i < users.length; i++) {
-         var user = users[i];
+       for (var i = 0; i < users.items.length; i++) {
+         var user = users.items[i];
     %>
        <tr<%= alt_rows(i)%>>
          <td><%= link_user(user.name) %></td>

deps/rabbitmq_management/selenium/test/pageobjects/AdminTab.js

@@ -4,7 +4,7 @@ const OverviewPage = require('./OverviewPage')
 
 const ALL_USERS_SECTION = By.css('div#users-section')
 const USER_LINK = By.css('div#menu ul#tabs li a[href="#/connections"]')
-const FILTER_USER = By.css('input#filter')
+const FILTER_USER = By.css('input#users-name')
 const CHECKBOX_REGEX = By.css('input#filter-regex-mode')
 const FILTERED_USER = By.css('span.filter-highlight')
 
@@ -14,13 +14,17 @@ module.exports = class AdminTab extends OverviewPage {
   }
 
   async searchForUser(user, regex = false) {
+
+    var filtered_user = By.css('a[href="#/users/' + user + '"]')
+
     await this.sendKeys(FILTER_USER, user)
+    await this.sendKeys(FILTER_USER, Key.RETURN)
     if (regex) {
       await this.click(CHECKBOX_REGEX)
     }
     await this.driver.sleep(250)
-    await this.waitForDisplayed(FILTERED_USER)
-    return await this.driver.findElement(FILTERED_USER) != undefined    
+    await this.waitForDisplayed(filtered_user)
+    return await this.driver.findElement(filtered_user) != undefined
   }
 
 }

deps/rabbitmq_management/src/rabbit_mgmt_wm_users.erl

@@ -18,6 +18,15 @@
 -include_lib("rabbitmq_management_agent/include/rabbit_mgmt_records.hrl").
 -include_lib("rabbit_common/include/rabbit.hrl").
 
+-define(BASIC_COLUMNS, ["hashing_algorithm",
+			"rabbit_password_hashing_sha256",
+			"limits",
+			"name",
+			"password_hash",
+			"tags"]).
+
+-define(DEFAULT_SORT, ["name"]).
+
 %%--------------------------------------------------------------------
 
 init(Req, [Mode]) ->
@@ -33,7 +42,17 @@ allowed_methods(ReqData, Context) ->
     {[<<"HEAD">>, <<"GET">>, <<"OPTIONS">>], ReqData, Context}.
 
 to_json(ReqData, {Mode, Context}) ->
-    rabbit_mgmt_util:reply_list(users(Mode), ReqData, Context).
+    try
+        Basic = users(Mode),
+        Data = rabbit_mgmt_util:augment_resources(Basic, ?DEFAULT_SORT,
+                                                  ?BASIC_COLUMNS, ReqData,
+                                                  Context, fun augment/2),
+        rabbit_mgmt_util:reply(Data, ReqData, Context)
+    catch
+        {error, invalid_range_parameters, Reason} ->
+            rabbit_mgmt_util:bad_request(iolist_to_binary(Reason), ReqData,
+                                         Context)
+    end.
 
 is_authorized(ReqData, {Mode, Context}) ->
     {Res, Req2, Context2} = rabbit_mgmt_util:is_authorized_admin(ReqData, Context),
@@ -57,3 +76,6 @@ users(without_permissions) ->
                                 Acc
                         end
                 end, [], rabbit_auth_backend_internal:list_users()).
+
+augment(Basic, _ReqData) ->
+    Basic.