Merge branch 'notes_finder_updated_at' into 'master'

NotesFinder filters by updated_at

Merge branch 'notes_finder_updated_at' into 'master'
NotesFinder filters by updated_at
Dmitriy Zaporozhets
2 parents 27f31a7e bd8b2b7f
Showing 7 changed files with 62 additions and 5 deletions Show diff stats
app/assets/javascripts/notes.js.coffee
app/controllers/projects/notes_controller.rb
app/finders/notes_finder.rb
app/views/projects/notes/_notes_with_form.html.haml
db/migrate/20140428105831_add_notes_index_updated_at.rb
db/schema.rb
spec/finders/notes_finder_spec.rb
 class Notes
   @interval: null
-  constructor: (notes_url, note_ids) ->
+  constructor: (notes_url, note_ids, last_fetched_at) ->
     @notes_url = notes_url
     @notes_url = gon.relative_url_root + @notes_url if gon.relative_url_root?
     @note_ids = note_ids
+    @last_fetched_at = last_fetched_at
     @initRefresh()
     @setupMainTargetNoteForm()
     @cleanBinding()
@@ -76,9 +77,11 @@ class Notes
   getContent: ->
     $.ajax
       url: @notes_url
+      data: "last_fetched_at=" + @last_fetched_at
       dataType: "json"
       success: (data) =>
         notes = data.notes
+        @last_fetched_at = data.last_fetched_at
         $.each notes, (i, note) =>
           @renderNote(note)
@@ -5,9 +5,10 @@ class Projects::NotesController &lt; Projects::ApplicationController
   before_filter :authorize_admin_note!, only: [:update, :destroy]
   def index
+    current_fetched_at = Time.now.to_i
     @notes = NotesFinder.new.execute(project, current_user, params)
-    notes_json = { notes: [] }
+    notes_json = { notes: [], last_fetched_at: current_fetched_at }
     @notes.each do |note|
       notes_json[:notes] << {
 class NotesFinder
+  FETCH_OVERLAP = 5.seconds
+
   def execute(project, current_user, params)
     target_type = params[:target_type]
     target_id   = params[:target_id]
+    # Default to 0 to remain compatible with old clients
+    last_fetched_at = Time.at(params.fetch(:last_fetched_at, 0).to_i)
-    case target_type
+    notes = case target_type
     when "commit"
       project.notes.for_commit_id(target_id).not_inline.fresh
     when "issue"
@@ -12,6 +16,11 @@ class NotesFinder
       project.merge_requests.find(target_id).mr_and_commit_notes.inc_author.fresh
     when "snippet"
       project.snippets.find(target_id).notes.fresh
+    else
+      raise 'invalid target_type'
     end
+
+    # Use overlapping intervals to avoid worrying about race conditions
+    notes.where('updated_at > ?', last_fetched_at - FETCH_OVERLAP)
   end
 end
@@ -7,4 +7,4 @@
   = render "projects/notes/form"
 :javascript
-  new Notes("#{project_notes_path(target_id: @noteable.id, target_type: @noteable.class.name.underscore)}", #{@notes.map(&:id).to_json})
+  new Notes("#{project_notes_path(target_id: @noteable.id, target_type: @noteable.class.name.underscore)}", #{@notes.map(&:id).to_json}, #{Time.now.to_i})
@@ -0,0 +1,5 @@
+class AddNotesIndexUpdatedAt < ActiveRecord::Migration
+  def change
+    add_index :notes, :updated_at
+  end
+end
@@ -11,7 +11,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
-ActiveRecord::Schema.define(version: 20140416185734) do
+ActiveRecord::Schema.define(version: 20140428105831) do
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
@@ -200,6 +200,7 @@ ActiveRecord::Schema.define(version: 20140416185734) do
   add_index "notes", ["noteable_type"], name: "index_notes_on_noteable_type", using: :btree
   add_index "notes", ["project_id", "noteable_type"], name: "index_notes_on_project_id_and_noteable_type", using: :btree
   add_index "notes", ["project_id"], name: "index_notes_on_project_id", using: :btree
+  add_index "notes", ["updated_at"], name: "index_notes_on_updated_at", using: :btree
   create_table "projects", force: true do |t|
     t.string   "name"
@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe NotesFinder do
+  let(:user) { create :user }
+  let(:project) { create :project }
+  let(:note1) { create :note_on_commit, project: project }
+  let(:note2) { create :note_on_commit, project: project }
+  let(:commit) { note1.noteable }
+
+  before do
+    project.team << [user, :master]
+  end
+
+  describe :execute do
+    let(:params)  { { target_id: commit.id, target_type: 'commit', last_fetched_at: 1.hour.ago.to_i } }
+
+    before do
+      note1
+      note2
+    end
+
+    it 'should find all notes' do
+      notes = NotesFinder.new.execute(project, user, params)
+      notes.size.should eq(2)
+    end
+
+    it 'should raise an exception for an invalid target_type' do
+      params.merge!(target_type: 'invalid')
+      expect { NotesFinder.new.execute(project, user, params) }.to raise_error('invalid target_type')
+    end
+
+    it 'filters out old notes' do
+      note2.update_attribute(:updated_at, 2.hours.ago)
+      notes = NotesFinder.new.execute(project, user, params)
+      notes.should eq([note1])
+    end
+  end
+end
	@@ -7,4 +7,4 @@		@@ -7,4 +7,4 @@
7	= render "projects/notes/form"	7	= render "projects/notes/form"
8		8
9	:javascript	9	:javascript
10	- new Notes("#{project_notes_path(target_id: @noteable.id, target_type: @noteable.class.name.underscore)}", #{@notes.map(&:id).to_json})	10	+ new Notes("#{project_notes_path(target_id: @noteable.id, target_type: @noteable.class.name.underscore)}", #{@notes.map(&:id).to_json}, #{Time.now.to_i})
@@ -0,0 +1,5 @@		@@ -0,0 +1,5 @@
	1	+class AddNotesIndexUpdatedAt < ActiveRecord::Migration
	2	+ def change
	3	+ add_index :notes, :updated_at
	4	+ end
	5	+end
@@ -0,0 +1,38 @@		@@ -0,0 +1,38 @@
	1	+require 'spec_helper'
	2	+
	3	+describe NotesFinder do
	4	+ let(:user) { create :user }
	5	+ let(:project) { create :project }
	6	+ let(:note1) { create :note_on_commit, project: project }
	7	+ let(:note2) { create :note_on_commit, project: project }
	8	+ let(:commit) { note1.noteable }
	9	+
	10	+ before do
	11	+ project.team << [user, :master]
	12	+ end
	13	+
	14	+ describe :execute do
	15	+ let(:params) { { target_id: commit.id, target_type: 'commit', last_fetched_at: 1.hour.ago.to_i } }
	16	+
	17	+ before do
	18	+ note1
	19	+ note2
	20	+ end
	21	+
	22	+ it 'should find all notes' do
	23	+ notes = NotesFinder.new.execute(project, user, params)
	24	+ notes.size.should eq(2)
	25	+ end
	26	+
	27	+ it 'should raise an exception for an invalid target_type' do
	28	+ params.merge!(target_type: 'invalid')
	29	+ expect { NotesFinder.new.execute(project, user, params) }.to raise_error('invalid target_type')
	30	+ end
	31	+
	32	+ it 'filters out old notes' do
	33	+ note2.update_attribute(:updated_at, 2.hours.ago)
	34	+ notes = NotesFinder.new.execute(project, user, params)
	35	+ notes.should eq([note1])
	36	+ end
	37	+ end
	38	+end