lokalise_manager 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f9ca0fe8caf151e84dcc09f29368bc61b5bc3cdb4341ef5c1b21040b764a17a
-  data.tar.gz: 8c9194a836a1261638f2b22d8d2d7553bfbe605325911cb0c0ecef9332e9084c
+  metadata.gz: f3a7da094cb7939fd6826c89afbbbc525dff59b553a23fba7b49ed38046e68b9
+  data.tar.gz: c0a323464c864d12042f126d765a483adc128a4397604d012cdeadee31003fcf
 SHA512:
-  metadata.gz: 7c4b7131ea9d6b60ff4094d0e34c92484818eb3c608a016932426c83bbcab4a06f4c820399f2fa70cc2a78d9a60a73dcf442ec9ba082bdc095ab539b467e1677
-  data.tar.gz: b98c062b4ecc030c37fa1f1ad95126209749c99ec7aba72b616fad380819d55552dc6d4b2a611b94471f79b3748855eefbaab3c9397ab49e9f8e19a6a6afb1ab
+  metadata.gz: 79c0b5a93767b5ffa8cd55dbf6591a90cafbb586043e8e75ca040761b8fa882882971783358e6d342afab96e298d34c67ca5d414d376c909fa564e8ad03d2466
+  data.tar.gz: ed2ad8e59fb6e15db8ba7c60de48e808c2eab0ff94b8f287c54bb2e618e1c930d5d3244a2483a6e61e69b7094943a05db59ea54ef32fc3596ef344f5956553ee

data/CHANGELOG.md

@@ -1,5 +1,50 @@
 # Changelog
 
+## 2.1.0 (27-Jan-22)
+
+* **Breaking change**: `export!` will now return an array of objects responding to the following methods:
+  + `success` — usually returns `true` (to learn more, check documentation for the `:raise_on_export_fail` option below)
+  + `process` — returns an object (an instance of the `Lokalise::Resources::QueuedProcess`) representing a [queued background process](https://lokalise.github.io/ruby-lokalise-api/api/queued-processes) as uploading is done in the background on Lokalise. You can use this object to check the process status (whether the uploading is completed or not).
+  + `path` — returns an instance of the `Pathname` class which represent the file being uploaded.
+* Here's an example:
+
+```ruby
+def uploaded?(process)
+  5.times do # try to check the status 5 times
+    process = process.reload_data # load new data
+    return(true) if process.status == 'finished' # return true is the upload has finished
+    sleep 1 # wait for 1 second, adjust this number with regards to the upload size
+  end
+
+  false # if all 5 checks failed, return false (probably something is wrong)
+end
+
+processes = exporter.export!
+puts "Checking status for the #{processes[0].path} file"
+uploaded? processes[0].process
+```
+
+* Introduced a new option `raise_on_export_fail` (`boolean`) which is `true` by default. When this option is enabled, LokaliseManager will re-raise any exceptions that happened during the file uploading. When this option is disabled, the exporting process will continue even if something goes wrong. In this case you'll probably need to check the result yourself and make the necessary actions. For example:
+
+```ruby
+processes = exporter.export!
+
+processes.each do |proc_data|
+  if proc_data.success
+    # Everything is good, the uploading is queued
+    puts "#{proc_data.path} is sent to Lokalise!"
+    process = proc_data.process
+    puts "Current process status is #{process.status}"
+  else
+    # Something bad has happened
+    puts "Could not send #{proc_data.path} to Lokalise"
+    puts "Error #{proc_data.error.class}: #{proc_data.error.message}"
+    # Or you could re-raise this exception:
+    # raise proc_data.error.class
+  end
+end
+```
+
 ## 2.0.0 (27-Jan-22)
 
 * `export!` method is now taking advantage of multi-threading (as Lokalise API allows to send requests in parallel since January 2022)

data/README.md

@@ -65,7 +65,13 @@ To upload your translation files from a local directory (defaults to `locales/`)
 processes = exporter.export!
 ```
 
-`processes` will contain an array of queued background processes as uploading is done in the background on Lokalise. You can perform periodic checks to read the status of the process. Here's a very simple example:
+`processes` will contain an array of objects responding to the following methods:
+
+* `success` — usually returns `true` (to learn more, check documentation for the `:raise_on_export_fail` option below)
+* `process` — returns an object (an instance of the `Lokalise::Resources::QueuedProcess`) representing a [queued background process](https://lokalise.github.io/ruby-lokalise-api/api/queued-processes) as uploading is done in the background on Lokalise.
+* `path` — returns an instance of the `Pathname` class which represent the file being uploaded.
+
+You can perform periodic checks to read the status of the process. Here's a very simple example:
 
 ```ruby
 def uploaded?(process)
@@ -79,7 +85,8 @@ def uploaded?(process)
 end
 
 processes = exporter.export!
-uploaded? processes[0]
+puts "Checking status for the #{processes[0].path} file"
+uploaded? processes[0].process
 ```
 
 Please don't forget that Lokalise API has rate limiting and you cannot send more than six requests per second.
@@ -162,7 +169,29 @@ In this case the `export_opts` will have `detect_icu_plurals` set to `true` and
 c.skip_file_export = ->(file) { f.split[1].to_s.include?('fr') }
 ```
 
-* `max_retries_export` (`integer`) — this option is introduced to properly handle Lokalise API rate limiting. If the HTTP status code 429 (too many requests) has been received, LokaliseRails will apply an exponential backoff mechanism with a very simple formula: `2 ** retries` (initially `retries` is `0`). If the maximum number of retries has been reached, a `Lokalise::Error::TooManyRequests` exception will be raised and the export operation will be halted. By default, LokaliseRails will make up to `5` retries which potentially means `1 + 2 + 4 + 8 + 16 + 32 = 63` seconds of waiting time. If the `max_retries_export` is less than `1`, LokaliseRails will not perform any retries and give up immediately after receiving error 429.
+* `max_retries_export` (`integer`) — this option is introduced to properly handle Lokalise API rate limiting. If the HTTP status code 429 (too many requests) has been received, LokaliseRails will apply an exponential backoff mechanism with a very simple formula: `2 ** retries` (initially `retries` is `0`). If the maximum number of retries has been reached, a `Lokalise::Error::TooManyRequests` exception will be raised and the export operation will be halted. By default, LokaliseManager will make up to `5` retries which potentially means `1 + 2 + 4 + 8 + 16 + 32 = 63` seconds of waiting time. If the `max_retries_export` is less than `1`, LokaliseRails will not perform any retries and give up immediately after receiving error 429.
+* `raise_on_export_fail` (`boolean`) — default is `true`. When this option is enabled, LokaliseManager will re-raise any exceptions that happened during the file uploading. In other words, if any uploading thread raised an exception, your exporting process will exit with an exception. Suppose, you are uploading 12 translation files; these files will be split in 2 groups with 6 files each, and each group will be uploaded in parallel (using threads). However, suppose some exception happens when uploading the first group. By default this exception will be re-raised for the whole process and the script will never try to upload the second group. If you would like to continue uploading even if an exception happened, set the `raise_on_export_fail` to `false`. In this case the `export!` method will return an array with scheduled processes and with information about processes that were not successfully scheduled. This information is represented as an object with three methods: `path` (contains an instance of the `Pathname` class which says which file could not be uploaded), `error` (the actual exception), and `success` (returns `false`). So, you can use the following snippet to check your processes:
+
+```ruby
+processes = exporter.export!
+
+processes.each do |proc_data|
+  if proc_data.success
+    # Everything is good, the uploading is queued
+    puts "#{proc_data.path} is sent to Lokalise!"
+    process = proc_data.process
+    puts "Current process status is #{process.status}"
+  else
+    # Something bad has happened
+    puts "Could not send #{proc_data.path} to Lokalise"
+    puts "Error #{proc_data.error.class}: #{proc_data.error.message}"
+    # Or you could re-raise this exception:
+    # raise proc_data.error.class
+  end
+end
+```
+
+* For example, you could collect all the files that were uploaded successfully, re-create the exporter object with the `skip_file_export` option (skipping all files that were successfully imported), and re-run the whole exporting process once again.
 
 ### Config to work with formats other than YAML
 

data/lib/lokalise_manager/global_config.rb

@@ -7,13 +7,19 @@ module LokaliseManager
       attr_writer :import_opts, :import_safe_mode, :export_opts, :locales_path,
                   :file_ext_regexp, :skip_file_export, :branch, :timeouts,
                   :translations_loader, :translations_converter, :lang_iso_inferer,
-                  :max_retries_export, :max_retries_import, :use_oauth2_token, :silent_mode
+                  :max_retries_export, :max_retries_import, :use_oauth2_token, :silent_mode,
+                  :raise_on_export_fail
 
       # Main interface to provide configuration options
       def config
         yield self
       end
 
+      # When enabled, will re-raise any exception that happens during file exporting
+      def raise_on_export_fail
+        @raise_on_export_fail || true
+      end
+
       # When enabled, won't print any debugging info to $stdout
       def silent_mode
         @silent_mode || false

data/lib/lokalise_manager/task_definitions/exporter.rb

@@ -6,6 +6,9 @@ module LokaliseManager
   module TaskDefinitions
     class Exporter < Base
       using LokaliseManager::Utils::ArrayUtils
+
+      MAX_THREADS = 6
+
       # Performs translation file export to Lokalise and returns an array of queued processes
       #
       # @return [Array]
@@ -14,11 +17,11 @@ module LokaliseManager
 
         queued_processes = []
 
-        all_files.in_groups_of(6) do |files_group|
+        all_files.in_groups_of(MAX_THREADS) do |files_group|
           parallel_upload(files_group).each do |thr|
-            raise_on_fail thr
+            raise_on_fail(thr) if config.raise_on_export_fail
 
-            queued_processes.push thr[:process]
+            queued_processes.push thr
           end
         end
 
@@ -36,19 +39,21 @@ module LokaliseManager
       end
 
       def raise_on_fail(thread)
-        raise thread[:error].class, "Error while trying to upload #{thread[:path]}: #{thread[:error].message}" if thread[:status] == :fail
+        raise(thread.error.class, "Error while trying to upload #{thread.path}: #{thread.error.message}") unless thread.success
       end
 
       # Performs the actual file uploading to Lokalise. If the API rate limit is exceeed,
       # applies exponential backoff
       def do_upload(f_path, r_path)
+        proc_klass = Struct.new(:success, :process, :path, :error, keyword_init: true)
+
         Thread.new do
           process = with_exp_backoff(config.max_retries_export) do
             api_client.upload_file project_id_with_branch, opts(f_path, r_path)
           end
-          {status: :ok, process: process}
+          proc_klass.new success: true, process: process, path: f_path
         rescue StandardError => e
-          {status: :fail, path: f_path, error: e}
+          proc_klass.new success: false, path: f_path, error: e
         end
       end
 

data/lib/lokalise_manager/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LokaliseManager
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

data/spec/lib/lokalise_manager/global_config_spec.rb

@@ -14,6 +14,11 @@ describe LokaliseManager::GlobalConfig do
     fake_class.project_id = '123.abc'
   end
 
+  it 'is possible to set raise_on_export_fail' do
+    allow(fake_class).to receive(:raise_on_export_fail=).with(false)
+    fake_class.raise_on_export_fail = false
+  end
+
   it 'is possible to set silent_mode' do
     allow(fake_class).to receive(:silent_mode=).with(true)
     fake_class.silent_mode = true

data/spec/lib/lokalise_manager/task_definitions/exporter_spec.rb

@@ -27,7 +27,7 @@ describe LokaliseManager::TaskDefinitions::Exporter do
         process = nil
 
         VCR.use_cassette('upload_files_multiple') do
-          expect(-> { process = described_object.export!.first }).to output(/complete!/).to_stdout
+          expect(-> { process = described_object.export!.first.process }).to output(/complete!/).to_stdout
         end
 
         expect(process.project_id).to eq(project_id)
@@ -49,6 +49,28 @@ describe LokaliseManager::TaskDefinitions::Exporter do
         expect(described_object).to have_received(:api_client).at_least(12).times
         expect(fake_client).to have_received(:upload_file).exactly(12).times
       end
+
+      it 'handles too many requests but does not re-raise anything when raise_on_export_fail is false' do
+        allow(described_object.config).to receive(:max_retries_export).and_return(1)
+        allow(described_object.config).to receive(:raise_on_export_fail).and_return(false)
+        allow(described_object).to receive(:sleep).and_return(0)
+
+        fake_client = instance_double('Lokalise::Client')
+        allow(fake_client).to receive(:token).with(any_args).and_return('fake_token')
+        allow(fake_client).to receive(:upload_file).with(any_args).and_raise(Lokalise::Error::TooManyRequests)
+        allow(described_object).to receive(:api_client).and_return(fake_client)
+        processes = []
+        expect(-> { processes = described_object.export! }).not_to raise_error
+
+        expect(processes[0].path.to_s).to include('en_0')
+        expect(processes[0].success).to be false
+        expect(processes[1].error.class).to eq(Lokalise::Error::TooManyRequests)
+        expect(processes.count).to eq(7)
+
+        expect(described_object).to have_received(:sleep).exactly(7).times
+        expect(described_object).to have_received(:api_client).at_least(14).times
+        expect(fake_client).to have_received(:upload_file).exactly(14).times
+      end
     end
   end
 
@@ -68,7 +90,7 @@ describe LokaliseManager::TaskDefinitions::Exporter do
         process = nil
 
         VCR.use_cassette('upload_files') do
-          expect(-> { process = described_object.export!.first }).not_to output(/complete!/).to_stdout
+          expect(-> { process = described_object.export!.first.process }).not_to output(/complete!/).to_stdout
         end
 
         expect(process.status).to eq('queued')
@@ -78,7 +100,7 @@ describe LokaliseManager::TaskDefinitions::Exporter do
       it 'sends a proper API request' do
         process = VCR.use_cassette('upload_files') do
           described_object.export!
-        end.first
+        end.first.process
 
         expect(process.project_id).to eq(project_id)
         expect(process.status).to eq('queued')
@@ -87,11 +109,16 @@ describe LokaliseManager::TaskDefinitions::Exporter do
       it 'sends a proper API request when a different branch is provided' do
         allow(described_object.config).to receive(:branch).and_return('develop')
 
-        process = VCR.use_cassette('upload_files_branch') do
+        process_data = VCR.use_cassette('upload_files_branch') do
           described_object.export!
         end.first
 
         expect(described_object.config).to have_received(:branch).at_most(2).times
+        expect(process_data.success).to be true
+        expect(process_data.path.to_s).to include('en.yml')
+
+        process = process_data.process
+        expect(process).to be_an_instance_of(Lokalise::Resources::QueuedProcess)
         expect(process.project_id).to eq(project_id)
         expect(process.status).to eq('queued')
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lokalise_manager
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Ilya Bodrov