Merge branch '1128-geo-custom-avatars' into 'master'

Geo: Display Custom Avatars in secondary nodes

This MR introduces some small patches for `User`, `Project` and `Group` models and related classes to build the avatar URL pointing to the primary node.
We should be able to remove this in the future when we start replicating local assets in Geo (#76).

For the changes to take effect on all pages, it's required to run:

```
# for Omnibus GitLab installs:
gitlab-rake cache:clear

# for Source installs:
RAILS_ENV=production bundle exec rake cache:clear
```

Closes #1128

See merge request !904

app/helpers/groups_helper.rb

@@ -8,11 +8,7 @@ module GroupsHelper
       group = Group.find_by(path: group)
     end
 
-    if group && group.avatar.present?
-      group.avatar.url
-    else
-      image_path('no_group_avatar.png')
-    end
+    group.try(:avatar_url) || image_path('no_group_avatar.png')
   end
 
   def group_title(group, name = nil, url = nil)

app/models/ee/geo_aware_avatar.rb

+module EE
+  # Avatars in Geo mixin
+  #
+  # This module is intended to encapsulate Geo-specific logic
+  # and be **prepended** in the `Group`, `User`, `Project` models
+  module GeoAwareAvatar
+    def avatar_url(size = nil, scale = 2)
+      if self[:avatar].present? && ::Gitlab::Geo.secondary?
+        File.join(::Gitlab::Geo.primary_node.url, avatar.url)
+      else
+        super
+      end
+    end
+  end
+end

app/models/ee/group.rb

-# Group EE mixin
-#
-# This module is intended to encapsulate EE-specific model logic
-# and be included in the `Group` model
 module EE
+  # Group EE mixin
+  #
+  # This module is intended to encapsulate EE-specific model logic
+  # and be included in the `Group` model
   module Group
     extend ActiveSupport::Concern
 

app/models/group.rb

@@ -9,6 +9,7 @@ class Group < Namespace
   include AccessRequestable
   include Referable
   include SelectForProjectAuthorization
+  prepend EE::GeoAwareAvatar
 
   has_many :group_members, -> { where(requested_at: nil) }, dependent: :destroy, as: :source
   alias_method :members, :group_members
@@ -116,7 +117,7 @@ class Group < Namespace
     allowed_by_projects
   end
 
-  def avatar_url(size = nil)
+  def avatar_url(size = nil, scale = nil)
     if self[:avatar].present?
       [gitlab_config.url, avatar.url].join
     end

app/models/project.rb

@@ -15,6 +15,7 @@ class Project < ActiveRecord::Base
   include Elastic::ProjectsSearch
   include ProjectFeaturesCompatibility
   include SelectForProjectAuthorization
+  prepend EE::GeoAwareAvatar
 
   extend Gitlab::ConfigHelper
 
@@ -915,7 +916,7 @@ class Project < ActiveRecord::Base
     repository.avatar
   end
 
-  def avatar_url
+  def avatar_url(size = nil, scale = nil)
     if self[:avatar].present?
       [gitlab_config.url, avatar.url].join
     elsif avatar_in_git

app/models/user.rb

@@ -9,6 +9,7 @@ class User < ActiveRecord::Base
   include Sortable
   include CaseSensitivity
   include TokenAuthenticatable
+  prepend EE::GeoAwareAvatar
 
   DEFAULT_NOTIFICATION_LEVEL = :participating
 

changelogs/unreleased-ee/geo-display-custom-avatars.yml

+---
+title: Geo: Display Custom Avatars in secondary nodes
+merge_request: 904
+author:

lib/ee/workers/project_cache_worker.rb

@@ -18,7 +18,7 @@ module EE
       # Geo should only update Redis based cache, as data store in the database
       # will be updated on primary and replicated to the secondaries.
       def perform_geo_secondary(project_id, refresh = [])
-        project = Project.find_by(id: project_id)
+        project = ::Project.find_by(id: project_id)
 
         return unless project && project.repository.exists?
 

spec/helpers/groups_helper_spec.rb

 require 'spec_helper'
 
 describe GroupsHelper do
+  let(:group) { create(:group) }
+
   describe 'group_icon' do
     avatar_file_path = File.join(Rails.root, 'spec', 'fixtures', 'banana_sample.gif')
 
     it 'returns an url for the avatar' do
-      group = create(:group)
       group.avatar = File.open(avatar_file_path)
       group.save!
-      expect(group_icon(group.path).to_s).
-        to match("/uploads/group/avatar/#{group.id}/banana_sample.gif")
+      expect(group_icon(group.path).to_s).to match("/uploads/group/avatar/#{group.id}/banana_sample.gif")
     end
 
     it 'gives default avatar_icon when no avatar is present' do
-      group = create(:group)
       group.save!
       expect(group_icon(group.path)).to match('group_avatar.png')
     end
+
+    context 'in a geo secondary node' do
+      let(:geo_url) { 'http://geo.example.com' }
+
+      before do
+        allow(Gitlab::Geo).to receive(:secondary?) { true }
+        allow(Gitlab::Geo).to receive_message_chain(:primary_node, :url) { geo_url }
+      end
+
+      it 'returns an url for the avatar pointing to the primary node base url' do
+        group.avatar = File.open(avatar_file_path)
+        group.save!
+        expect(group_icon(group.path).to_s).to match("#{geo_url}/uploads/group/avatar/#{group.id}/banana_sample.gif")
+      end
+
+      it 'gives default avatar_icon when no avatar is present' do
+        group.save!
+        expect(group_icon(group.path)).to match('group_avatar.png')
+      end
+    end
   end
 
   describe 'group_lfs_status' do
-    let(:group) { create(:group) }
     let!(:project) { create(:empty_project, namespace_id: group.id) }
 
     before do

spec/models/group_spec.rb

@@ -140,6 +140,36 @@ describe Group, models: true do
     end
   end
 
+  describe '#avatar_url' do
+    let(:user) { create(:user) }
+    subject { group.avatar_url }
+
+    context 'when avatar file is uploaded' do
+      before do
+        group.add_user(user, GroupMember::MASTER)
+        group.update_columns(avatar: 'avatar.png')
+        allow(group.avatar).to receive(:present?) { true }
+      end
+
+      let(:avatar_path) do
+        "/uploads/group/avatar/#{group.id}/avatar.png"
+      end
+
+      it { should eq "http://#{Gitlab.config.gitlab.host}#{avatar_path}" }
+
+      context 'when in a geo secondary node' do
+        let(:geo_url) { 'http://geo.example.com' }
+
+        before do
+          allow(Gitlab::Geo).to receive(:secondary?) { true }
+          allow(Gitlab::Geo).to receive_message_chain(:primary_node, :url) { geo_url }
+        end
+
+        it { should eq "#{geo_url}#{avatar_path}" }
+      end
+    end
+  end
+
   describe '.search' do
     it 'returns groups with a matching name' do
       expect(described_class.search(group.name)).to eq([group])

spec/models/project_spec.rb

@@ -818,6 +818,17 @@ describe Project, models: true do
       end
 
       it { should eq "http://#{Gitlab.config.gitlab.host}#{avatar_path}" }
+
+      context 'When in a geo secondary node' do
+        let(:geo_url) { 'http://geo.example.com' }
+
+        before do
+          allow(Gitlab::Geo).to receive(:secondary?) { true }
+          allow(Gitlab::Geo).to receive_message_chain(:primary_node, :url) { geo_url }
+        end
+
+        it { should eq "#{geo_url}#{avatar_path}" }
+      end
     end
 
     context 'When avatar file in git' do

spec/models/user_spec.rb

@@ -814,6 +814,35 @@ describe User, models: true do
     end
   end
 
+  describe '#avatar_url' do
+    let(:user) { create(:user) }
+    subject { user.avatar_url }
+
+    context 'when avatar file is uploaded' do
+      before do
+        user.update_columns(avatar: 'uploads/avatar.png')
+        allow(user.avatar).to receive(:present?) { true }
+      end
+
+      let(:avatar_path) do
+        "/uploads/user/avatar/#{user.id}/uploads/avatar.png"
+      end
+
+      it { should eq "http://#{Gitlab.config.gitlab.host}#{avatar_path}" }
+
+      context 'when in a geo secondary node' do
+        let(:geo_url) { 'http://geo.example.com' }
+
+        before do
+          allow(Gitlab::Geo).to receive(:secondary?) { true }
+          allow(Gitlab::Geo).to receive_message_chain(:primary_node, :url) { geo_url }
+        end
+
+        it { should eq "#{geo_url}#{avatar_path}" }
+      end
+    end
+  end
+
   describe '#requires_ldap_check?' do
     let(:user) { User.new }