copy_tuner_client 0.20.1 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c80d48f19698dd5ffc3d27fc3b5a96d1a9b0ab6761f2eb3a4f7ff37463582bd1
-  data.tar.gz: 41c817b39c822106a04bcd4cffa4b8a50bc14cfd88b7e677f532987a2c293e62
+  metadata.gz: a06b43d1cbb58dfca8f7e340a52e0533cb1398b20e966702822ee90f3253515c
+  data.tar.gz: a751f0743edb5dc80802d08647c3ebeca82809f5034b6b14177d607f57c247bb
 SHA512:
-  metadata.gz: 55829ac0315b780958a1023339be01bb4750148b9a5d47b0b09bc980e7d5cf84d65aeb07c16ab68ec4e3e1c1361aad2d337e5f297af5df9abafd35b85bed0480
-  data.tar.gz: 858d7ea50128bd9079f3d8b35fd73910a821a3660de2336c1706129547b8f37492c95cbf4e8a31970dc3ac0985590f0de927019f537902ef17ccccce8b466b58
+  metadata.gz: 4f9de9656e80ff2ee79385663e60deecb0df8b3f0f5aa9f5a226dd60b1e1bc92dc287b522e04fcd8ced28fa5e37e98de112e0688ed3bbcdc0719bde21a554bc0
+  data.tar.gz: ff0f9f4f2fc05b37fcfe5395db70615fc4c8c019db48858c8e1c799faa907e35916e636a4fda0f6a91410d1db3b6a9b3f1e44ca731ca81faf3a491ef64cba4a6

data/.vscode/settings.json

@@ -4,4 +4,8 @@
   },
   "typescript.tsdk": "node_modules/typescript/lib",
   "typescript.preferences.importModuleSpecifier": "non-relative",
+  "rubocop.mode": "disable",
+  "cSpell.words": [
+    "mkpath"
+  ],
 }

data/lib/copy_tuner_client/cache.rb

@@ -8,6 +8,10 @@ module CopyTunerClient
   #
   # Responsible for locking down access to data used by both threads.
   class Cache
+    STATUS_NOT_READY = :not_ready
+    STATUS_PENDING = :pending
+    STATUS_READY = :ready
+
     # Usually instantiated when {Configuration#apply} is invoked.
     # @param client [Client] the client used to fetch and upload data
     # @param options [Hash]
@@ -25,8 +29,7 @@ module CopyTunerClient
       @blurbs = {}
       @blank_keys = Set.new
       @queued = {}
-      @started = false
-      @downloaded = false
+      @status = STATUS_NOT_READY
     end
 
     # Returns content for the given blurb.
@@ -97,23 +100,23 @@ module CopyTunerClient
     end
 
     def download
-      @started = true
+      @status = STATUS_PENDING unless ready?
 
-      res = client.download do |downloaded_blurbs|
+      res = client.download(cache_fallback: pending?) do |downloaded_blurbs|
         blank_blurbs, blurbs = downloaded_blurbs.partition { |_key, value| value == '' }
         lock do
-          @blank_keys = Set.new(blank_blurbs.to_h.keys)
+          @blank_keys = Set.new(blank_blurbs.map(&:first))
           @blurbs = blurbs.to_h
         end
       end
 
       @last_downloaded_at = Time.now.utc
+      @status = STATUS_READY unless ready?
 
       res
     rescue ConnectionError => e
       logger.error e.message
-    ensure
-      @downloaded = true
+      raise e unless ready?
     end
 
     # Downloads and then flushes
@@ -129,7 +132,11 @@ module CopyTunerClient
     end
 
     def pending?
-      @started && !@downloaded
+      @status == STATUS_PENDING
+    end
+
+    def ready?
+      @status == STATUS_READY
     end
 
     private

data/lib/copy_tuner_client/client.rb

@@ -29,10 +29,16 @@ module CopyTunerClient
     # @option options [Logger] :logger where to log transactions
     # @option options [String] :ca_file path to root certificate file for ssl verification
     def initialize(options)
+      @etag = nil
+      @downloaded_blurbs = {}
+
       [:api_key, :host, :port, :public, :http_read_timeout,
-        :http_open_timeout, :secure, :logger, :ca_file, :s3_host].each do |option|
+        :http_open_timeout, :secure, :logger, :ca_file, :s3_host, :download_cache_dir].each do |option|
         instance_variable_set "@#{option}", options[option]
       end
+
+      @download_cache_dir.mkpath
+      load_cachedata(last_download_path)
     end
 
     # Downloads all blurbs for the given api_key.
@@ -45,7 +51,7 @@ module CopyTunerClient
     #
     # @yield [Hash] downloaded blurbs
     # @raise [ConnectionError] if the connection fails
-    def download
+    def download(cache_fallback: false)
       connect(s3_host) do |http|
         request = Net::HTTP::Get.new(uri(download_resource))
         request['If-None-Match'] = @etag
@@ -53,15 +59,18 @@ module CopyTunerClient
         t = Time.now
         response = http.request(request)
         t_ms = ((Time.now - t) * 1000).to_i
-        if check response
+        downloaded = check(response)
+        if downloaded
           # NOTE: Net::HTTPではgzipが透過的に扱われるため正確なファイルサイズや速度をログに出すのは難しい
           log "Downloaded translations (#{t_ms}ms)"
-          yield JSON.parse(response.body)
+          @downloaded_blurbs = JSON.parse(response.body)
+          @etag = response['ETag']
+          last_download_path.write(JSON.pretty_generate(etag: @etag, downloaded_blurbs: @downloaded_blurbs))
         else
           log "No new translations (#{t_ms}ms)"
         end
 
-        @etag = response['ETag']
+        yield(@downloaded_blurbs) if downloaded || cache_fallback
       end
     end
 
@@ -107,6 +116,21 @@ module CopyTunerClient
       end
     end
 
+    def last_download_path
+      @download_cache_dir.join("last-download-#{download_resource}")
+    end
+
+    def load_cachedata(pathname)
+      return unless pathname.exist?
+
+      cache = JSON.parse(pathname.read.to_s).transform_keys(&:to_sym)
+      @etag = cache[:etag]
+      @downloaded_blurbs = cache[:downloaded_blurbs]
+      log "Loaded cache data from #{pathname}"
+    rescue JSON::JSONError, Errno::ENOENT, Errno::ENOTDIR
+      nil
+    end
+
     def connect(host)
       http = Net::HTTP.new(host, port)
       http.open_timeout = http_open_timeout

data/lib/copy_tuner_client/configuration.rb

@@ -18,7 +18,8 @@ module CopyTunerClient
                  proxy_port proxy_user secure polling_delay sync_interval
                  sync_interval_staging sync_ignore_path_regex logger
                  framework middleware disable_middleware disable_test_translation
-                 ca_file exclude_key_regexp s3_host locales ignored_keys ignored_key_handler].freeze
+                 ca_file exclude_key_regexp s3_host locales ignored_keys ignored_key_handler
+                 download_cache_dir].freeze
 
     # @return [String] The API key for your project, found on the project edit form.
     attr_accessor :api_key
@@ -139,6 +140,9 @@ module CopyTunerClient
     # @return [Integer] The project id
     attr_accessor :project_id
 
+    # @return [Pathname] The directory to cache downloaded files
+    attr_accessor :download_cache_dir
+
     alias secure? secure
 
     # Instantiated from {CopyTunerClient.configure}. Sets defaults.
@@ -164,6 +168,7 @@ module CopyTunerClient
       self.ignored_keys = []
       self.ignored_key_handler = ->(e) { raise e }
       self.project_id = nil
+      self.download_cache_dir = Pathname.new(Dir.pwd).join('tmp', 'cache', 'copy_tuner_client')
 
       @applied = false
     end

data/lib/copy_tuner_client/rails.rb

@@ -13,8 +13,9 @@ module CopyTunerClient
         else
           ::Rails.logger
         end
-        config.framework        = "Rails: #{::Rails::VERSION::STRING}"
-        config.middleware       = ::Rails.configuration.middleware
+        config.framework = "Rails: #{::Rails::VERSION::STRING}"
+        config.middleware = ::Rails.configuration.middleware
+        config.download_cache_dir = ::Rails.root.join('tmp', 'cache', 'copy_tuner_client')
       end
     end
 

data/lib/copy_tuner_client/version.rb

@@ -1,6 +1,6 @@
 module CopyTunerClient
   # Client version
-  VERSION = '0.20.1'.freeze
+  VERSION = '0.21.0'.freeze
 
   # API version being used to communicate with the server
   API_VERSION = '2.0'.freeze

data/spec/copy_tuner_client/cache_spec.rb

@@ -3,10 +3,13 @@ require 'spec_helper'
 describe CopyTunerClient::Cache do
   let(:client) { FakeClient.new }
 
-  def build_cache(config = {})
+  def build_cache(ready: false, **config)
+    config[:client] ||= client
     config[:logger] ||= FakeLogger.new
     default_config = CopyTunerClient::Configuration.new.to_hash
-    CopyTunerClient::Cache.new(client, default_config.update(config))
+    cache = CopyTunerClient::Cache.new(client, default_config.update(config))
+    cache.instance_variable_set(:@status, CopyTunerClient::Cache::STATUS_READY) if ready
+    cache
   end
 
   it 'provides access to downloaded data' do
@@ -143,7 +146,7 @@ describe CopyTunerClient::Cache do
     failure = 'server is napping'
     logger = FakeLogger.new
     expect(client).to receive(:download).and_raise(CopyTunerClient::ConnectionError.new(failure))
-    cache = build_cache(logger: logger)
+    cache = build_cache(logger: logger, ready: true)
 
     cache.download
 
@@ -169,31 +172,6 @@ describe CopyTunerClient::Cache do
     expect(t_wait.join(1)).not_to be_nil
   end
 
-  it "doesn't block if the first download fails" do
-    client.delay = true
-    client.error = StandardError.new('Failure')
-    cache = build_cache
-
-    error = nil
-    t_download = Thread.new do
-      begin
-        cache.download
-      rescue StandardError => e
-        error = e
-      end
-    end
-    sleep 0.1 until cache.pending?
-
-    t_wait = Thread.new do
-      cache.wait_for_download
-    end
-    client.go
-    expect(t_download.join(1)).not_to be_nil
-    expect(error).to be_kind_of(StandardError)
-    expect(t_wait.join(1)).not_to be_nil
-    expect { cache.download }.to raise_error(StandardError, 'Failure')
-  end
-
   it "doesn't block before downloading" do
     logger = FakeLogger.new
     cache = build_cache(logger: logger)

data/spec/copy_tuner_client/client_spec.rb

@@ -1,8 +1,15 @@
 require 'spec_helper'
 
 describe CopyTunerClient do
+  let(:download_cache_dir) { Pathname.new(Dir.mktmpdir('copy_tuner_client')) }
+
+  after do
+    FileUtils.rm_rf(download_cache_dir)
+  end
+
   def build_client(config = {})
     config[:logger] ||= FakeLogger.new
+    config[:download_cache_dir] = download_cache_dir
     default_config = CopyTunerClient::Configuration.new.to_hash
     default_config[:s3_host] = 'copy-tuner.com'
     client = CopyTunerClient::Client.new(default_config.update(config))

data/spec/support/fake_client.rb

@@ -16,7 +16,7 @@ class FakeClient
     @data[key] = value
   end
 
-  def download
+  def download(cache_fallback: false)
     wait_for_delay
     raise_error_if_present
     @downloads += 1
@@ -62,4 +62,3 @@ class FakeClient
     end
   end
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: copy_tuner_client
 version: !ruby/object:Gem::Version
-  version: 0.20.1
+  version: 0.21.0
 platform: ruby
 authors:
 - SonicGarden
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-28 00:00:00.000000000 Z
+date: 2025-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n