add ui notification of bouncing channels

test plan:
 * add various communication methods to your user
 * navigate to any page other than your user's settings
 * using the console, increase the bounce count of all channels:
     User.find(id).communication_channels.unretired.each do |cc|
       cc.bounce_count = 100
       cc.save
     end
 * refresh the page
	 - a notification should show at the top of the page, indicating a
	   potential problem on your settings page
	 - navigating anywhere other than the settings page will cause the
	   notification to persist

 * navigate to the settings page
   - the notification should disappear
   - your communication channels should all indicate a problem with
     delivering messages to you
 * removing and re-adding the channels should remove all indicators

 * navigate to any page other than your user's settings
 * using the console, increase the bounce count of one channel:
     cc = User.find(id).communication_channels.unretired.first
     cc.bounce_count = 100
     cc.save
 * refresh the page
   - once again, the notification should show at the top of the page

fixes CNVS-15255

Change-Id: If45664c1b33d75fbfe8aa3480dfebd8872c6b064
Reviewed-on: https://gerrit.instructure.com/40534
Reviewed-by: Joel Hough <joel@instructure.com>
QA-Review: Trevor deHaan <tdehaan@instructure.com>
Tested-by: Jenkins <jenkins@instructure.com>
Product-Review: Janelle Seegmiller <jseegmiller@instructure.com>

Author: miquella

app/controllers/profile_controller.rb

@@ -194,6 +194,7 @@ def settings
       return unless @user == @current_user || authorized_action(@user, @current_user, :view_statistics)
     else
       @user = @current_user
+      @user.dismiss_bouncing_channel_message!
     end
     @user_data = profile_data(@user.profile, @current_user, session, [])
     @channels = @user.communication_channels.unretired

app/models/communication_channel.rb

@@ -44,6 +44,7 @@ class CommunicationChannel < ActiveRecord::Base
   validate :uniqueness_of_path
   validate :not_otp_communication_channel, :if => lambda { |cc| cc.path_type == TYPE_SMS && cc.retired? && !cc.new_record? }
   validates_presence_of :access_token_id, if: lambda { |cc| cc.path_type == TYPE_PUSH }
+  after_commit :check_if_bouncing_changed
 
   acts_as_list :scope => :user
 
@@ -386,6 +387,29 @@ def bouncing?
     self.bounce_count >= RETIRE_THRESHOLD
   end
 
+  def was_bouncing?
+    old_bounce_count = self.previous_changes[:bounce_count].try(:first)
+    old_bounce_count ||= self.bounce_count
+    old_bounce_count >= RETIRE_THRESHOLD
+  end
+
+  def was_retired?
+    old_workflow_state = self.previous_changes[:workflow_state].try(:first)
+    old_workflow_state ||= self.workflow_state
+    old_workflow_state.to_s == 'retired'
+  end
+
+  def check_if_bouncing_changed
+    if retired?
+      self.user.update_bouncing_channel_message!(self) if !was_retired? && was_bouncing?
+    else
+      if (was_retired? && bouncing?) || (was_bouncing? != bouncing?)
+        self.user.update_bouncing_channel_message!(self)
+      end
+    end
+  end
+  private :check_if_bouncing_changed
+
   def self.bounce_for_path(path)
     Shard.with_each_shard(CommunicationChannel.associated_shards(path)) do
       CommunicationChannel.unretired.email.by_path(path).each do |channel|

app/models/user.rb

@@ -2534,4 +2534,35 @@ def stamp_logout_time!
   def content_exports_visible_to(user)
     self.content_exports.where(user_id: user)
   end
+
+  def show_bouncing_channel_message!
+    self.preferences[:show_bouncing_channel_message] = true
+    self.save!
+  end
+
+  def show_bouncing_channel_message?
+    !!self.preferences[:show_bouncing_channel_message]
+  end
+
+  def dismiss_bouncing_channel_message!
+    self.preferences[:show_bouncing_channel_message] = false
+    self.save!
+  end
+
+  def bouncing_channel_message_dismissed?
+    self.preferences[:show_bouncing_channel_message] == false
+  end
+
+  def update_bouncing_channel_message!(channel=nil)
+    force_set_bouncing = channel && channel.bouncing? && !channel.imported?
+    set_bouncing = force_set_bouncing || self.communication_channels.unretired.any? { |cc| cc.bouncing? && !cc.imported? }
+
+    if force_set_bouncing
+      show_bouncing_channel_message!
+    elsif set_bouncing
+      show_bouncing_channel_message! unless bouncing_channel_message_dismissed?
+    else
+      dismiss_bouncing_channel_message!
+    end
+  end
 end

app/views/layouts/application.html.erb

@@ -37,6 +37,12 @@
   <noscript><div role="alert" class="ic-flash-static ic-flash-error"><h1><%= t :javascript_required, "You need to have JavaScript enabled in order to access this site." %></h1></div></noscript>
   <%= render :partial => 'shared/flash_notices' %>
 
+  <% if @current_user.try(:show_bouncing_channel_message?) %>
+    <div role="alert" class="ic-flash-static ic-flash-warning">
+    <%= t(:bouncing_communication_channels, "There appears to be a problem with one of your contact methods. Please check your *Settings Page*.", wrapper: link_to('\1', settings_profile_path)) %>
+    </div>
+  <% end %>
+
   <div id="header" class="no-print <%= 'no-user' unless @current_user %>">
     <div id="header-inner">
       <a href="#content" id="skip_navigation_link"><%= t 'links.skip_to_content', "Skip To Content" %></a>

app/views/profile/_ways_to_contact.html.erb

@@ -62,6 +62,11 @@
         <a href="#" class="path email_channel" title="<%=h c.path %>"><%= c.path %></a>
       </td>
       <td class="email_actions hidden_for_single">
+        <% if c.bouncing? %>
+          <span class="bouncing-channel" data-tooltip="left" title="<%= t('bouncing_email', 'Canvas was unable to send email to this address. Please ensure the address is correct to continue receiving email from Canvas.') %>" aria-label="<%= t('bouncing_email', 'Canvas was unable to send email to this address. Please ensure the address is correct to continue receiving email from Canvas.') %>">
+            <i class="text text-warning icon-warning"></i>
+          </span>
+        <% end %>
         <% if c.state == :unconfirmed && (@user.grants_right?(@current_user, :manage_user_details) || (@real_current_user && @user.grants_right?(@real_current_user, :manage_user_details))) %>
             <a href="<%= registration_confirmation_url(c.confirmation_code) %>" class="confirm_channel_link no-hover" aria-label="<%= t('titles.confirm_email_address_aria_label', "Confirm Email Address") %>"><i class="icon-check standalone-icon" alt="<%= t('titles.confirm_email_address_alt', "Confirm Email Address") %>" title="<%= t('titles.confirm_email_address', "Confirm Email Address") %>"></i></a>
         <% end %>
@@ -110,6 +115,11 @@
       <td><a href="#" class="path"><%= c.path_description %></a></td>
       <td><%= c.path_type %></td>
       <td style="padding: 0; text-align: center;">
+        <% if c.bouncing? %>
+          <span class="bouncing-channel" data-tooltip="left" title="<%= t('bouncing_channel', 'Canvas was unable to send messages to you using this contact method. Please ensure the contact information is correct to continue receiving messages from Canvas.') %>" aria-label="<%= t('bouncing_channel', 'Canvas was unable to send messages to you using this contact method. Please ensure the contact information is correct to continue receiving messages from Canvas.') %>">
+            <i class="text text-warning icon-warning"></i>
+          </span>
+        <% end %>
         <% if c.state == :unconfirmed && (@user.grants_right?(@current_user, :manage_user_details) || (@real_current_user && @user.grants_right?(@real_current_user, :manage_user_details))) %>
             <a href="<%= registration_confirmation_url(c.confirmation_code) %>" class="confirm_channel_link no-hover"><i class="icon-check standalone-icon" title="<%= t('titles.confirm_email_address', "Confirm Email Address") %>"></i></a>
         <% end %>