i18n-backend-http 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6253fa4b449db0c86fc538654b5d435d1cbcf0a7
-  data.tar.gz: 7672f4606b3645647594312efe3e3c1f4f93bfc3
+  metadata.gz: c8ef7e0cc698935821cf0bc559a97a73e29185c4
+  data.tar.gz: df9271b1c5f1f2301061695042ed6eaa474c3900
 SHA512:
-  metadata.gz: f98a33068b3b8766b80d6c32c4939ed2546b7ebf9fd3b0f4d9f4ff47821b80ea089a7960ce645870f233e49f404f2131f0085441d5b87dd21477e4b16bee1ebd
-  data.tar.gz: b80e56c5688166d236e6f941000a23f958dd27b768fc7cd600e4772c83bffe7676dc250a91c93012dee400cb455e5a8b5cfbfc7d5e82ede0e892a5e5e2e85843
+  metadata.gz: b420d096c879cca888b43130e643b34c0e21b05eca68f7c84eca4fa873a67ad611490703d5d300a8a0bbab6ef72831f449d6bfee92f64d3624526c1f2640ca49
+  data.tar.gz: 859c684dd33e4dee4828051e65664fceca3a826cc25a867fc8101df01d792b2ec558091e9731f897d6cbed0f60ff4af72017e2bfe3faa505ee37da6814e80f81

data/lib/i18n/backend/http.rb

@@ -3,7 +3,6 @@ require 'i18n/backend/transliterator'
 require 'i18n/backend/base'
 require 'i18n/backend/http/version'
 require 'i18n/backend/http/etag_http_client'
-require 'i18n/backend/http/null_cache'
 require 'i18n/backend/http/lru_cache'
 require 'socket'
 
@@ -11,16 +10,17 @@ module I18n
   module Backend
     class Http
       include ::I18n::Backend::Base
+      FAILED_GET = {}.freeze
 
       def initialize(options)
         @options = {
-          :http_open_timeout => 1,
-          :http_read_timeout => 1,
-          :polling_interval => 10*60,
-          :cache => NullCache.new,
-          :poll => true,
-          :exception_handler => lambda{|e| $stderr.puts e },
-          :memory_cache_size => 10,
+          http_open_timeout: 1,
+          http_read_timeout: 1,
+          polling_interval: 10*60,
+          cache: nil,
+          poll: true,
+          exception_handler: -> (e) { $stderr.puts e },
+          memory_cache_size: 10,
         }.merge(options)
 
         @http_client = EtagHttpClient.new(@options)
@@ -41,7 +41,7 @@ module I18n
       def start_polling
         Thread.new do
           until @stop_polling
-            sleep(@options[:polling_interval])
+            sleep(@options.fetch(:polling_interval))
             update_caches
           end
         end
@@ -53,69 +53,62 @@ module I18n
       end
 
       def translations(locale)
-        @translations[locale] ||= (
-          translations_from_cache(locale) ||
-          download_and_cache_translations(locale)
-        )
+        (@translations[locale] ||= fetch_and_update_cached_translations(locale, nil, update: false)).first
       end
 
-      def update_caches
-        @translations.keys.each do |locale|
-          if @options[:cache].is_a?(NullCache)
-            download_and_cache_translations(locale)
-          else
-            locked_update_cache(locale)
-          end
-        end
-      end
-
-      def locked_update_cache(locale)
-        unless update_cache(locale) { download_and_cache_translations(locale) }
-          update_memory_cache_from_cache(locale)
-        end
-      end
+      def fetch_and_update_cached_translations(locale, old_etag, update:)
+        if cache = @options.fetch(:cache)
+          key = cache_key(locale)
+          interval = @options.fetch(:polling_interval)
+          now = Time.now # capture time before we do slow work to stay on schedule
+          old_value, old_etag, expires_at = cache.read(key) # assumes the cache is more recent then our local storage
 
-      def update_cache(locale)
-        cache = @options.fetch(:cache)
-        key = "i18n/backend/http/locked_update_caches/#{locale}"
-        me = "#{Socket.gethostname}-#{Process.pid}-#{Thread.current.object_id}"
-        if current = cache.read(key)
-          if current == me
-            try = false  # I am responsible, renew expiration
-          else
-            return # someone else is responsible, do not touch
+          if old_value && (!update || expires_at > now || !updater?(cache, key, interval))
+            return [old_value, old_etag]
           end
+
+          new_value, new_etag = download_translations(locale, etag: old_etag)
+          new_expires_at = now + interval
+          cache.write(key, [new_value, new_etag, new_expires_at])
+          [new_value, new_etag]
         else
-          try = true # nobody is responsible, try to get responsibility
+          download_translations(locale, etag: old_etag)
         end
-
-        return unless cache.write(key, me, expires_in: (@options[:polling_interval] * 3).ceil, unless_exist: try)
-
-        yield
-        true
       end
 
-      def update_memory_cache_from_cache(locale)
-        @translations[locale] = translations_from_cache(locale)
+      # sync with the cache who is going to update the cache
+      # this overlaps with the expiration interval, so worst case we will get 2x the interval
+      # if all servers are in sync and check updater at the same time
+      def updater?(cache, key, interval)
+        cache.write(
+          "#{key}-lock",
+          true,
+          expires_in: interval,
+          unless_exist: true
+        )
       end
 
-      def translations_from_cache(locale)
-        @options[:cache].read(cache_key(locale))
+      # when download fails we keep our old caches since they are most likely better then nothing
+      def update_caches
+        @translations.keys.each do |locale|
+          _, old_etag = @translations[locale]
+          result = fetch_and_update_cached_translations(locale, old_etag, update: true)
+          if result && result.first != self.class::FAILED_GET
+            @translations[locale] = result
+          end
+        end
       end
 
       def cache_key(locale)
-        "i18n/backend/http/translations/#{locale}"
+        "i18n/backend/http/translations/#{locale}/v2"
       end
 
-      def download_and_cache_translations(locale)
-        @http_client.download(path(locale)) do |result|
-          translations = parse_response(result)
-          @options[:cache].write(cache_key(locale), translations)
-          @translations[locale] = translations
-        end
+      def download_translations(locale, etag:)
+        result, etag = @http_client.download(path(locale), etag: etag)
+        [parse_response(result), etag] if result
       rescue => e
-        @options[:exception_handler].call(e)
-        @translations[locale] = {} # do not write distributed cache
+        @options.fetch(:exception_handler).call(e)
+        [self.class::FAILED_GET, nil]
       end
 
       def parse_response(body)

data/lib/i18n/backend/http/etag_http_client.rb

@@ -6,22 +6,19 @@ module I18n
       class I18n::Backend::Http::EtagHttpClient
         def initialize(options)
           @options = options
-          @etags = {}
         end
 
-        def download(path)
+        def download(path, etag:)
           @client ||= Faraday.new(@options[:host])
           response = @client.get(path) do |request|
-            request.headers["If-None-Match"] = @etags[path] if @etags[path]
+            request.headers["If-None-Match"] = etag if etag
             request.options[:timeout] = @options[:http_read_timeout]
             request.options[:open_timeout] = @options[:http_open_timeout]
           end
 
-          @etags[path] = response['ETag']
-
           case response.status
-          when 200 then yield response.body
-          when 304
+          when 200 then [response.body, response['ETag']]
+          when 304 then nil
           else
             raise "Failed request: #{response.inspect}"
           end

data/lib/i18n/backend/http/version.rb

@@ -1,7 +1,7 @@
 module I18n
   module Backend
     class Http
-      VERSION = Version = "0.2.0"
+      VERSION = Version = "0.3.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-backend-http
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-10 00:00:00.000000000 Z
+date: 2017-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -173,7 +173,6 @@ files:
 - lib/i18n/backend/http.rb
 - lib/i18n/backend/http/etag_http_client.rb
 - lib/i18n/backend/http/lru_cache.rb
-- lib/i18n/backend/http/null_cache.rb
 - lib/i18n/backend/http/version.rb
 homepage: https://github.com/grosser/i18n-backend-http
 licenses:
@@ -187,7 +186,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/i18n/backend/http/null_cache.rb

@@ -1,18 +0,0 @@
-module I18n
-  module Backend
-    class Http
-      class I18n::Backend::Http::NullCache
-        def fetch(*args)
-          yield
-        end
-
-        def read(key)
-        end
-
-        def write(key, value)
-          value
-        end
-      end
-    end
-  end
-end