Merge pull request #72 from prograils/async_synchronization

Asynchronous loading of translations synchronized via API

Author: mlitwiniuk

app/assets/javascripts/lit/sources.js.coffee

@@ -0,0 +1,24 @@
+$ ->
+  sourceId = $('#source_id').attr('value')
+
+  updateFunc = ->
+    $.ajax "/lit/sources/" + sourceId + "/sync_complete",
+      type: 'GET'
+      format: 'json'
+      success: (xml, textStatus, xhr) ->
+        if xhr.responseJSON.sync_complete
+          $('.loading').addClass('loaded').removeClass('loading')
+          clearInterval(interval)
+          location.reload()
+      statusCode:
+        404: ->
+          $('.loading').text('Could not update synchronization status, please try refreshing page')
+        401: ->
+          $('.loading').text('You are not authorized. Please check if you are properly logged in')
+        500: ->
+          $('.loading').text('Something went wrong, please try synchronizing again')
+      error: ->
+        clearInterval(interval)
+
+  if $('.loading').length > 0
+    interval = window.setInterval(updateFunc, 500)

app/assets/stylesheets/lit/application.css

@@ -51,3 +51,9 @@ padding: 5px 7px;
 .localization_row em{
   color: #bbb;
 }
+.loading {
+  display: inline;
+}
+.loaded {
+  display: none;
+}

app/controllers/lit/sources_controller.rb

@@ -20,7 +20,12 @@ def edit
 
     def synchronize
       @source = Source.find(params[:id])
-      @source.synchronize
+      @source.update_column(:sync_complete, false)
+      if defined?(ActiveJob)
+        SynchronizeSourceJob.perform_later(@source)
+      else
+        @source.synchronize
+      end
       redirect_to lit.source_incomming_localizations_path(@source)
     end
 
@@ -54,6 +59,11 @@ def destroy
       redirect_to sources_url
     end
 
+    def sync_complete
+      @source = Source.find(params[:id])
+      render json: { sync_complete: @source.sync_complete }
+    end
+
     private
 
     def clear_params

app/helpers/lit/sources_helper.rb

@@ -1,4 +1,7 @@
 module Lit
   module SourcesHelper
+    def source_loading_class(source)
+      source.sync_complete ? 'loaded' : 'loading'
+    end
   end
 end

app/jobs/lit/synchronize_source_job.rb

@@ -0,0 +1,11 @@
+module Lit
+  if defined?(::ActiveJob)
+    class SynchronizeSourceJob < ::ActiveJob::Base
+      queue_as :default
+
+      def perform(source)
+        source.synchronize
+      end
+    end
+  end
+end

app/models/lit/source.rb

@@ -48,12 +48,13 @@ def synchronize
             unless il.is_duplicate?(r['value'])
               il.save!
               IncommingLocalization.where(id: il.id).
-                update_all ['translated_value=?', r['value']]
+                update_all(translated_value: r['value'])
             end
           end
           last_change = get_last_change
           last_change = DateTime.parse(last_change) unless last_change.nil?
           touch_last_updated_at(last_change)
+          update_column(:sync_complete, true)
           save
         end
       end

app/views/lit/incomming_localizations/index.html.erb

@@ -1,15 +1,20 @@
 <h1>Incomming localizations</h1>
-<div class="row">
-  <span class="pull-right">
-    <%= link_to accept_all_source_incomming_localizations_path(@source), :class=>"btn btn-success btn-sm", :data=>{:confirm=>t('lit.common.you_sure', :default=>"Are you sure?")} do %>
-      <%= t('lit.common.accept_all', :default=>"Accept all") %>
-    <% end %>
-    <%= link_to reject_all_source_incomming_localizations_path(@source), :class=>"btn btn-danger btn-sm", :method=>:post, :data=>{:confirm=>t('lit.common.you_sure', :default=>"Are you sure?")} do %>
-      <%= t('lit.common.reject_all', :default=>"Reject all") %>
-    <% end %>
-  </span>
+<input type="hidden" id="source_id" value="<%= @source.id %>">
+<div class="container">
+  <div class="row inline-headers">
+    <h4 class="<%= source_loading_class(@source) %>">Synchronization in progress, please wait. The page will refresh automatically when done.</h2>
+    <span class="pull-right">
+      <%= link_to accept_all_source_incomming_localizations_path(@source), :class=>"btn btn-success btn-sm", :data=>{:confirm=>t('lit.common.you_sure', :default=>"Are you sure?")} do %>
+        <%= t('lit.common.accept_all', :default=>"Accept all") %>
+      <% end %>
+      <%= link_to reject_all_source_incomming_localizations_path(@source), :class=>"btn btn-danger btn-sm", :method=>:post, :data=>{:confirm=>t('lit.common.you_sure', :default=>"Are you sure?")} do %>
+        <%= t('lit.common.reject_all', :default=>"Reject all") %>
+      <% end %>
+    </span>
+  </div>
 </div>
 
+
 <table class="table table-bordered table-striped incomming-localizations-table">
   <tr>
     <th>Current value</th>

config/routes.rb

@@ -32,6 +32,7 @@
   resources :sources do
     member do
       get :synchronize
+      get :sync_complete
       put :touch
     end
     resources :incomming_localizations, :only=>[:index, :destroy] do

db/migrate/20160510125412_add_sync_complete_to_lit_sources.rb

@@ -0,0 +1,5 @@
+class AddSyncCompleteToLitSources < ActiveRecord::Migration
+  def change
+    add_column :lit_sources, :sync_complete, :boolean
+  end
+end

test/functional/lit/sources_controller_test.rb

@@ -62,5 +62,12 @@ class SourcesControllerTest < ActionController::TestCase
       end
       assert_redirected_to sources_path
     end
+
+    test 'should indicate sync completion' do
+      @source.update_column(:sync_complete, true)
+      get :sync_complete, format: :json, id: @source.id
+      body = JSON.parse(response.body)
+      assert_equal true, body['sync_complete']
+    end
   end
 end

test/jobs/lit/synchronize_source_job_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+require 'fakeweb'
+
+# Applicable only in an ActiveJob-enabled environment (Rails 4.2+ or 4.0/4.1
+# with additional gem)
+if defined?(ActiveJob)
+  module Lit
+    class SynchronizeSourceJobTest < ActiveJob::TestCase
+      include ActiveJob::TestHelper
+      fixtures :all
+
+      def setup
+        after = 3.hours.ago
+        after_str = after.strftime('%F %T')
+        after_param = Rack::Utils.escape(after_str)
+        @source = Source.first
+        puts @source.incomming_localizations
+        @source.update_column(:last_updated_at, after)
+        localizations_addr = "http://testhost.com/lit/api/v1/localizations.json?after=#{after_param}"
+        last_change_addr = 'http://testhost.com/lit/api/v1/last_change.json'
+        FakeWeb.register_uri(:get, localizations_addr,
+                             body: Localization.all.to_json)
+        FakeWeb.register_uri(:get, last_change_addr,
+                             body: { last_change: after_str }.to_json)
+      end
+
+      def do_job
+        SynchronizeSourceJob.perform_later(@source)
+      end
+
+      test 'performs synchronization' do
+        assert_performed_jobs(1) do
+          assert_equal 0, @source.incomming_localizations.count
+          do_job
+          assert_equal 2, @source.incomming_localizations.count
+        end
+      end
+    end
+  end
+end

test/unit/helpers/lit/sources_helper_test.rb

@@ -1,6 +1,19 @@
 require 'test_helper'
 
-module Lit
-  class SourcesHelperTest < ActionView::TestCase
+class SourcesHelperTest < ActionView::TestCase
+  include Lit::SourcesHelper
+  
+  def setup
+    @source = Lit::Source.new
+  end
+
+  test 'returns "loaded" when source sync is complete' do
+    @source.sync_complete = true
+    assert_equal source_loading_class(@source), 'loaded'
+  end
+
+  test 'returns "loading" when source sync is not complete' do
+    @source.sync_complete = false
+    assert_equal source_loading_class(@source), 'loading'
   end
 end