Merge branch 'da-refactor-broadcast-message' into 'master'

Refactor BroadcastMessage to use Gitlab::JsonCache

See merge request gitlab-org/gitlab-ee!8808

app/models/broadcast_message.rb

@@ -22,49 +22,30 @@ class BroadcastMessage < ActiveRecord::Base
   after_commit :flush_redis_cache
 
   def self.current
-    raw_messages = Rails.cache.fetch(CACHE_KEY, expires_in: cache_expires_in) do
+    messages = cache.fetch(CACHE_KEY, as: BroadcastMessage, expires_in: cache_expires_in) do
       remove_legacy_cache_key
-      current_and_future_messages.to_json
+      current_and_future_messages
     end
 
-    messages = decode_messages(raw_messages)
-
     return [] unless messages&.present?
 
     now_or_future = messages.select(&:now_or_future?)
 
     # If there are cached entries but none are to be displayed we'll purge the
     # cache so we don't keep running this code all the time.
-    Rails.cache.delete(CACHE_KEY) if now_or_future.empty?
+    cache.expire(CACHE_KEY) if now_or_future.empty?
 
     now_or_future.select(&:now?)
   end
 
-  def self.decode_messages(raw_messages)
-    return unless raw_messages&.present?
-
-    message_list = ActiveSupport::JSON.decode(raw_messages)
-
-    return unless message_list.is_a?(Array)
-
-    valid_attr = BroadcastMessage.attribute_names
-
-    message_list.map do |raw|
-      BroadcastMessage.new(raw) if valid_cache_entry?(raw, valid_attr)
-    end.compact
-  rescue ActiveSupport::JSON.parse_error
-  end
-
-  def self.valid_cache_entry?(raw, valid_attr)
-    return false unless raw.is_a?(Hash)
-
-    (raw.keys - valid_attr).empty?
-  end
-
   def self.current_and_future_messages
     where('ends_at > :now', now: Time.zone.now).order_id_asc
   end
 
+  def self.cache
+    Gitlab::JsonCache.new(cache_key_with_version: false)
+  end
+
   def self.cache_expires_in
     nil
   end
@@ -74,7 +55,7 @@ class BroadcastMessage < ActiveRecord::Base
   # environment a one-shot migration would not work because the cache
   # would be repopulated by a node that has not been upgraded.
   def self.remove_legacy_cache_key
-    Rails.cache.delete(LEGACY_CACHE_KEY)
+    cache.expire(LEGACY_CACHE_KEY)
   end
 
   def active?
@@ -102,7 +83,7 @@ class BroadcastMessage < ActiveRecord::Base
   end
 
   def flush_redis_cache
-    Rails.cache.delete(CACHE_KEY)
+    self.class.cache.expire(CACHE_KEY)
     self.class.remove_legacy_cache_key
   end
 end

ee/spec/lib/gitlab/json_cache_spec.rb → spec/lib/gitlab/json_cache_spec.rb

@@ -7,7 +7,7 @@ describe Gitlab::JsonCache do
   let(:namespace) { 'geo' }
   let(:key) { 'foo' }
   let(:expanded_key) { "#{namespace}:#{key}:#{Rails.version}" }
-  let(:node) { create(:geo_node) }
+  let(:broadcast_message) { create(:broadcast_message) }
 
   subject(:cache) { described_class.new(namespace: namespace, backend: backend) }
 
@@ -110,15 +110,15 @@ describe Gitlab::JsonCache do
       it 'parses the cached value' do
         allow(backend).to receive(:read)
           .with(expanded_key)
-          .and_return(node.to_json)
+          .and_return(broadcast_message.to_json)
 
-        expect(cache.read(key, GeoNode)).to eq(node)
+        expect(cache.read(key, BroadcastMessage)).to eq(broadcast_message)
       end
 
       it 'returns nil when klass is nil' do
         allow(backend).to receive(:read)
           .with(expanded_key)
-          .and_return(node.to_json)
+          .and_return(broadcast_message.to_json)
 
         expect(cache.read(key)).to be_nil
       end
@@ -128,7 +128,7 @@ describe Gitlab::JsonCache do
           .with(expanded_key)
           .and_return('{')
 
-        expect(cache.read(key, GeoNode)).to be_nil
+        expect(cache.read(key, BroadcastMessage)).to be_nil
       end
 
       it 'gracefully handles an empty hash' do
@@ -136,15 +136,15 @@ describe Gitlab::JsonCache do
           .with(expanded_key)
           .and_return('{}')
 
-        expect(cache.read(key, GeoNode)).to be_a(GeoNode)
+        expect(cache.read(key, BroadcastMessage)).to be_a(BroadcastMessage)
       end
 
       it 'gracefully handles unknown attributes' do
         allow(backend).to receive(:read)
           .with(expanded_key)
-          .and_return(node.attributes.merge(unknown_attribute: 1).to_json)
+          .and_return(broadcast_message.attributes.merge(unknown_attribute: 1).to_json)
 
-        expect(cache.read(key, GeoNode)).to be_nil
+        expect(cache.read(key, BroadcastMessage)).to be_nil
       end
     end
 
@@ -152,15 +152,15 @@ describe Gitlab::JsonCache do
       it 'parses the cached value' do
         allow(backend).to receive(:read)
           .with(expanded_key)
-          .and_return([node].to_json)
+          .and_return([broadcast_message].to_json)
 
-        expect(cache.read(key, GeoNode)).to eq([node])
+        expect(cache.read(key, BroadcastMessage)).to eq([broadcast_message])
       end
 
       it 'returns an empty array when klass is nil' do
         allow(backend).to receive(:read)
           .with(expanded_key)
-          .and_return([node].to_json)
+          .and_return([broadcast_message].to_json)
 
         expect(cache.read(key)).to eq([])
       end
@@ -170,7 +170,7 @@ describe Gitlab::JsonCache do
           .with(expanded_key)
           .and_return('[')
 
-        expect(cache.read(key, GeoNode)).to be_nil
+        expect(cache.read(key, BroadcastMessage)).to be_nil
       end
 
       it 'gracefully handles an empty array' do
@@ -178,15 +178,15 @@ describe Gitlab::JsonCache do
           .with(expanded_key)
           .and_return('[]')
 
-        expect(cache.read(key, GeoNode)).to eq([])
+        expect(cache.read(key, BroadcastMessage)).to eq([])
       end
 
       it 'gracefully handles unknown attributes' do
         allow(backend).to receive(:read)
           .with(expanded_key)
-          .and_return([{ unknown_attribute: 1 }, node.attributes].to_json)
+          .and_return([{ unknown_attribute: 1 }, broadcast_message.attributes].to_json)
 
-        expect(cache.read(key, GeoNode)).to eq([node])
+        expect(cache.read(key, BroadcastMessage)).to eq([broadcast_message])
       end
     end
   end
@@ -199,10 +199,10 @@ describe Gitlab::JsonCache do
     end
 
     it 'writes a string containing a JSON representation of the value to the cache' do
-      cache.write(key, node)
+      cache.write(key, broadcast_message)
 
       expect(backend).to have_received(:write)
-        .with(expanded_key, node.to_json, nil)
+        .with(expanded_key, broadcast_message.to_json, nil)
     end
 
     it 'passes options the underlying cache implementation' do
@@ -288,13 +288,13 @@ describe Gitlab::JsonCache do
     context 'when the given key exists in the cache' do
       context 'when the cached value is a hash' do
         before do
-          backend.write(expanded_key, node.to_json)
+          backend.write(expanded_key, broadcast_message.to_json)
         end
 
         it 'parses the cached value' do
-          result = cache.fetch(key, as: GeoNode) { 'block result' }
+          result = cache.fetch(key, as: BroadcastMessage) { 'block result' }
 
-          expect(result).to eq(node)
+          expect(result).to eq(broadcast_message)
         end
 
         it "returns the result of the block when 'as' option is nil" do
@@ -312,13 +312,13 @@ describe Gitlab::JsonCache do
 
       context 'when the cached value is a array' do
         before do
-          backend.write(expanded_key, [node].to_json)
+          backend.write(expanded_key, [broadcast_message].to_json)
         end
 
         it 'parses the cached value' do
-          result = cache.fetch(key, as: GeoNode) { 'block result' }
+          result = cache.fetch(key, as: BroadcastMessage) { 'block result' }
 
-          expect(result).to eq([node])
+          expect(result).to eq([broadcast_message])
         end
 
         it "returns an empty array when 'as' option is nil" do

spec/models/broadcast_message_spec.rb

@@ -49,7 +49,7 @@ describe BroadcastMessage do
     it 'caches the output of the query' do
       create(:broadcast_message)
 
-      expect(described_class).to receive(:where).and_call_original.once
+      expect(described_class).to receive(:current_and_future_messages).and_call_original.once
 
       described_class.current
 
@@ -93,27 +93,6 @@ describe BroadcastMessage do
       expect(Rails.cache).to receive(:delete).with(described_class::LEGACY_CACHE_KEY)
       expect(described_class.current.length).to eq(0)
     end
-
-    it 'gracefully handles bad cache entry' do
-      allow(described_class).to receive(:current_and_future_messages).and_return('{')
-
-      expect(described_class.current).to be_empty
-    end
-
-    it 'gracefully handles an empty hash' do
-      allow(described_class).to receive(:current_and_future_messages).and_return('{}')
-
-      expect(described_class.current).to be_empty
-    end
-
-    it 'gracefully handles unknown attributes' do
-      message = create(:broadcast_message)
-
-      allow(described_class).to receive(:current_and_future_messages)
-                                 .and_return([{ bad_attr: 1 }, message])
-
-      expect(described_class.current).to eq([message])
-    end
   end
 
   describe '#active?' do