Optimized endpints for pulling back lots O' results

You can now exclude pseudonym info on api requests.
users_json will now preload section information when you include[]=section

Fixes CNVS-14836
Fixes CNVS-13093
Fixes CNVS-12932
Fixes CNVS-16216
Fixes CNVS-16218

Test Plan:

- Create a course with 800 users
- Create a group set; add 150 groups to set.
- Load groups page it should load way faster than before
- Make sure search isn't slow

Change-Id: Icff28b00141fb3573b9ed9493e8dc38521a368e4
Reviewed-on: https://gerrit.instructure.com/43356
Reviewed-by: Jacob Fugal <jacob@instructure.com>
Reviewed-by: Andrew Butterfield <abutterfield@instructure.com>
Tested-by: Jenkins <jenkins@instructure.com>
Reviewed-by: Joel Hough <joel@instructure.com>
QA-Review: Steven Shepherd <sshepherd@instructure.com>
Product-Review: Brad Horrocks <bhorrocks@instructure.com>

Author: Brad Horrocks

app/coffeescripts/collections/GroupUserCollection.coffee

@@ -14,7 +14,7 @@ define [
     @optionProperty 'category'
 
     url: ->
-      @url = "/api/v1/groups/#{@group.id}/users?per_page=50"
+      @url = "/api/v1/groups/#{@group.id}/users?per_page=50&include[]=sections&exclude[]=pseudonym"
 
     initialize: (models) ->
       super

app/coffeescripts/collections/UnassignedGroupUserCollection.coffee

@@ -6,7 +6,7 @@ define [
   class UnassignedGroupUserCollection extends GroupUserCollection
 
     url: ->
-      _url = "/api/v1/group_categories/#{@category.id}/users?per_page=50"
+      _url = "/api/v1/group_categories/#{@category.id}/users?per_page=50&include[]=sections&exclude[]=pseudonym"
       _url += "&unassigned=true" unless @category.get('allows_multiple_memberships')
       @url = _url
 
@@ -16,4 +16,19 @@ define [
       @category.get('allows_multiple_memberships')
 
     increment: (amount) ->
-      @category.increment 'unassigned_users_count', amount
+      @category.increment 'unassigned_users_count', amount
+
+    search: (filter, options) ->
+      options = options || {}
+      options.reset = true
+
+      if filter && filter.length >= 3
+        options.url = @url + "&search_term=" + filter
+        @filtered = true
+        return @fetch(options)
+      else if @filtered
+        @filtered = false
+        options.url = @url
+        return @fetch(options)
+
+      # do nothing

app/coffeescripts/views/groups/manage/GroupCategoriesView.coffee

@@ -40,7 +40,6 @@ define [
       @refreshTabs()
       @loadTabFromUrl()
 
-
     refreshTabs: ->
       if @collection.length > 0
         @$tabs.find('ul.ui-tabs-nav li.static').remove()
@@ -132,6 +131,7 @@ define [
       @loadPanelView($panel)
 
     loadPanelView: ($panel) ->
+      # there is a bug here where we load the first tab, then immediately load the tab from the hash
       if !$panel.data('loaded')
         model = $panel.data('model')
         categoryView = new GroupCategoryView model: model

app/coffeescripts/views/groups/manage/GroupCategoryView.coffee

@@ -1,14 +1,15 @@
 define [
   'i18n!groups'
   'Backbone'
+  'underscore'
   'compiled/views/groups/manage/GroupCategoryDetailView'
   'compiled/views/groups/manage/GroupsView'
   'compiled/views/groups/manage/UnassignedUsersView'
   'compiled/views/groups/manage/AddUnassignedMenu'
   'jst/groups/manage/groupCategory'
   'compiled/jquery.rails_flash_notifications'
   'jquery.disableWhileLoading'
-], (I18n, {View}, GroupCategoryDetailView, GroupsView, UnassignedUsersView, AddUnassignedMenu, template) ->
+], (I18n, {View}, _, GroupCategoryDetailView, GroupsView, UnassignedUsersView, AddUnassignedMenu, template) ->
 
   class GroupCategoryView extends View
 
@@ -55,6 +56,12 @@ define [
         groupsCollection: @groups
       }
 
+    filterChange: (event) ->
+      search_term = event.target.value
+      @options.unassignedUsersView.setFilter(search_term)
+
+      @_setUnassignedHeading(@originalCount) unless search_term.length >= 3
+
     attach: ->
       @model.on 'destroy', @remove, this
       @model.on 'change', => @groupsView.updateDetails()
@@ -73,6 +80,11 @@ define [
 
     cacheEls: ->
       super
+
+      if !@attachedFilter
+        @$filterUnassignedUsers.on "keyup", _.debounce(@filterChange.bind(this), 300)
+        @attachedFilter = true
+
       # need to be set before their afterRender's run (i.e. before this
       # view's afterRender)
       @groupsView.$externalFilter = @$filter
@@ -84,6 +96,10 @@ define [
 
     setUnassignedHeading: ->
       count = @model.unassignedUsersCount() ? 0
+      @originalCount = @originalCount || count
+      @_setUnassignedHeading(count)
+
+    _setUnassignedHeading: (count) ->
       @unassignedUsersView.render() if @unassignedUsersView
       @$unassignedUsersHeading.text(
         if @model.get('allows_multiple_memberships')

app/coffeescripts/views/groups/manage/GroupUserView.coffee

@@ -1,8 +1,9 @@
 define [
+  'i18n!groups'
   'underscore'
   'Backbone'
   'jst/groups/manage/groupUser'
-], (_, {View}, template) ->
+], (I18n, _, {View}, template) ->
 
   class GroupUserView extends View
 
@@ -14,6 +15,8 @@ define [
     className: 'group-user'
 
     template: template
+    attributes:
+      "data-tooltip": "top"
 
     els:
       '.al-trigger': '$userActions'
@@ -25,6 +28,7 @@ define [
       @model.on 'change', @render, this
 
     afterRender: ->
+      @$el.attr("title", I18n.t('Sections: %{sections}', sections: @model.get('sections')))
       @$el.data('model', @model)
 
     highlight: ->

app/coffeescripts/views/groups/manage/UnassignedUsersView.coffee

@@ -1,12 +1,12 @@
 define [
+  'i18n!groups'
   'jquery'
   'underscore'
   'compiled/views/groups/manage/GroupUsersView'
   'compiled/views/groups/manage/AssignToGroupMenu'
   'compiled/views/groups/manage/Scrollable'
-  'compiled/views/Filterable'
   'jst/groups/manage/groupUsers'
-], ($, _, GroupUsersView, AssignToGroupMenu, Scrollable, Filterable, template) ->
+], (I18n, $, _, GroupUsersView, AssignToGroupMenu, Scrollable, template) ->
 
   class UnassignedUsersView extends GroupUsersView
 
@@ -24,8 +24,9 @@ define [
       GroupUsersView::els,
       '.no-results-wrapper': '$noResultsWrapper'
       '.no-results': '$noResults'
+      '.invalid-filter': '$invalidFilter'
 
-    @mixin Filterable, Scrollable
+    @mixin Scrollable
 
     dropOptions:
       accept: '.group-user'
@@ -37,13 +38,11 @@ define [
       @collection.on 'reset', @render
       @collection.on 'remove', @render
       @collection.on 'moved', @highlightUser
-      @collection.on 'filterOut', _(=> @checkScroll()).debounce(50)
 
       @collection.once 'fetch', => @$noResultsWrapper.hide()
       @collection.on 'fetched:last', => @$noResultsWrapper.show()
 
     afterRender: ->
-      @$filter = @$externalFilter
       super
       @collection.load('first')
       @$el.parent().droppable(_.extend({}, @dropOptions))
@@ -77,6 +76,15 @@ define [
     hideAssignToGroup: ->
       @assignToGroupMenu?.hide()
 
+    setFilter: (search_term, options) ->
+      searchDefer = @collection.search(search_term, options)
+      searchDefer.always(=>
+        if search_term.length < 3
+          shouldShow = search_term.length > 0
+          @$invalidFilter.toggleClass("hidden", !shouldShow)
+          @$noResultsWrapper.toggle(shouldShow)
+      ) if searchDefer
+
     canAssignToGroup: ->
       @options.canAssignToGroup and @groupsCollection.length
 

app/controllers/group_categories_controller.rb

@@ -332,7 +332,6 @@ def users
     end
 
     search_term = params[:search_term].presence
-
     search_params = params.slice(:search_term)
     search_params[:enrollment_type] = "student" if @context.is_a? Course
 
@@ -347,7 +346,7 @@ def users
     end
 
     users = Api.paginate(users, self, api_v1_group_category_users_url)
-    render :json => users.map { |u| user_json(u, @current_user, session, [], @context) }
+    render :json => users_json(users, @current_user, session, Array(params[:include]), @context, nil, Array(params[:exclude]))
   end
 
   # @API Assign unassigned members

app/controllers/groups_controller.rb

@@ -626,15 +626,14 @@ def users
     return unless authorized_action(@context, @current_user, :read)
 
     search_term = params[:search_term].presence
-
     if search_term
       users = UserSearch.for_user_in_context(search_term, @context, @current_user, session)
     else
       users = UserSearch.scope_for(@context, @current_user)
     end
 
     users = Api.paginate(users, self, api_v1_group_users_url)
-    render :json => users_json(users, @current_user, session, Array(params[:include]))
+    render :json => users_json(users, @current_user, session, Array(params[:include]), @context, nil, Array(params[:exclude]))
   end
 
   def edit

app/views/jst/groups/manage/groupUsers.handlebars

@@ -1,5 +1,4 @@
 {{#ifAny count loading}}
-  <ul class="collectionViewItems unstyled"></ul>
   <div class="no-results-wrapper">
     <div class="no-results hidden">
       {{#ifEqual ENV.group_user_type "student"}}
@@ -8,7 +7,11 @@
         {{#t "no_matching_users"}}No matching users.{{/t}}
       {{/ifEqual}}
     </div>
+    <div class="invalid-filter hidden">
+      {{#t "greater_than_three"}}Please enter a search term with three or more characters{{/t}}
+    </div>
   </div>
+  <ul class="collectionViewItems unstyled"></ul>
   <div class="paginatedLoadingIndicator"></div>
 {{else}}
   <div class="no-results">

lib/api/v1/user.rb

@@ -36,10 +36,11 @@ def user_json_preloads(users, preload_email=false)
     end
   end
 
-  def user_json(user, current_user, session, includes = [], context = @context, enrollments = nil)
+  def user_json(user, current_user, session, includes = [], context = @context, enrollments = nil, excludes = [])
     includes ||= []
+    excludes ||= []
     api_json(user, current_user, session, API_USER_JSON_OPTS).tap do |json|
-      if user_json_is_admin?(context, current_user)
+      if !excludes.include?('pseudonym') && user_json_is_admin?(context, current_user)
         include_root_account = @domain_root_account.trust_exists?
         if sis_pseudonym = user.sis_pseudonym_for(@domain_root_account, include_root_account)
           # the sis fields on pseudonym are poorly named -- sis_user_id is
@@ -67,6 +68,13 @@ def user_json(user, current_user, session, includes = [], context = @context, en
       if includes.include?('email') && context.grants_right?(current_user, session, :read_as_admin)
         json[:email] = user.email
       end
+
+      if includes.include?('sections')
+        json[:sections] = user.enrollments.
+          map(&:course_section).compact.uniq.
+          map(&:name).join(", ")
+      end
+
       json[:locale] = user.locale if includes.include?('locale')
       json[:confirmation_url] = user.communication_channels.email.first.try(:confirmation_url) if includes.include?('confirmation_url')
 
@@ -80,8 +88,13 @@ def user_json(user, current_user, session, includes = [], context = @context, en
     end
   end
 
-  def users_json(users, current_user, session, includes = [], context = @context, enrollments = nil)
-    users.map{ |user| user_json(user, current_user, session, includes, context, enrollments) }
+  def users_json(users, current_user, session, includes = [], context = @context, enrollments = nil, excludes = [])
+
+    if includes.include?('sections')
+      ActiveRecord::Associations::Preloader.new(users, enrollments: :course_section).run
+    end
+
+    users.map{ |user| user_json(user, current_user, session, includes, context, enrollments, excludes) }
   end
 
   # this mini-object is used for secondary user responses, when we just want to