Merge pull request #4306 from tgxworld/add_discourse_event_trigger_when_user_logs_out

FEATURE: Add event trigger when a user is logged out.

app/controllers/admin/users_controller.rb

@@ -56,7 +56,7 @@ class Admin::UsersController < Admin::AdminController
     @user.save!
     @user.revoke_api_key
     StaffActionLogger.new(current_user).log_user_suspend(@user, params[:reason])
-    MessageBus.publish "/logout", @user.id, user_ids: [@user.id]
+    @user.logged_out
     render nothing: true
   end
 
@@ -73,7 +73,7 @@ class Admin::UsersController < Admin::AdminController
     if @user
       @user.auth_token = nil
       @user.save!
-      MessageBus.publish "/logout", @user.id, user_ids: [@user.id]
+      @user.logged_out
       render json: success_json
     else
       render json: {error: I18n.t('admin_js.admin.users.id_not_found')}, status: 404

app/models/user.rb

@@ -854,6 +854,11 @@ class User < ActiveRecord::Base
     User.where(admin: true).where.not(id: id).where.not(id: Discourse::SYSTEM_USER_ID).blank?
   end
 
+  def logged_out
+    MessageBus.publish "/logout", self.id, user_ids: [self.id]
+    DiscourseEvent.trigger(:user_logged_out, self)
+  end
+
   protected
 
   def badge_grant
@@ -999,7 +1004,6 @@ class User < ActiveRecord::Base
     end
   end
 
-
 end
 
 # == Schema Information

lib/auth/default_current_user_provider.rb

@@ -100,7 +100,7 @@ class Auth::DefaultCurrentUserProvider
         cookies["__profilin"] = nil
       end
 
-      MessageBus.publish "/logout", user.id, user_ids: [user.id]
+      user.logged_out
     end
     cookies[TOKEN_COOKIE] = nil
   end

spec/models/user_spec.rb

@@ -1276,4 +1276,15 @@ describe User do
 
   end
 
+  describe "#logged_out" do
+    let(:user) { Fabricate(:user) }
+
+    it 'should publish the right message' do
+      message = MessageBus.track_publish { user.logged_out }.first
+
+      expect(message.channel).to eq('/logout')
+      expect(message.data).to eq(user.id)
+    end
+  end
+
 end