phraseapp_updater 3.3.0 → 3.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a32efb606f930f644881f15a2c3c1edf0bf72eddefd4de9de61524145e8b74c0
-  data.tar.gz: 3fd1b4164ee16b056b8ecc964863d66dac48a459aee374f1056268b524d2bbaf
+  metadata.gz: b44812204928f9576633c2d59bd8c4deb220cdd70e7cfb2f52cdc059368b7b8a
+  data.tar.gz: 13e282dcfc436150b6edecf384ae6b54c4133c8cb19a73bd5f723fe90bbb923b
 SHA512:
-  metadata.gz: c03c6ffd3ef4c33825884d9e14552445d5a86d3e7248d3295e3998a66b482f496bf716961bb61df602f293681ad4a755082813ce997e41a3507414f7973f586e
-  data.tar.gz: 0b08b5b4ddec6a3fd38675acf3d00c79f9bf3bc51dba94290cfde4a2f5223414b87ce50d7d9e06834c9c64872b111469625f4419afee17012c4dcc1171e3e3ea
+  metadata.gz: 5bd3fe2ab57e511236b31902d21d31d3e80d2e07029c1c7f2d52c4983bf263d5839ab85a6eef904967f6560f387af4312170d3032307b73a2456a816ef97f59b
+  data.tar.gz: c0d4677afd153d1b8f0aa95d0f58bb2b1c1568abd6ee68b646610316c8cd7f28a82e0670e5302d6e39c4f4543a025fa867f4850e05922892d22276b5ba771f11

data/lib/phraseapp_updater/phraseapp_api.rb

@@ -4,6 +4,7 @@ require 'phraseapp_updater/locale_file'
 require 'phraseapp_updater/index_by'
 require 'uri'
 require 'phrase'
+require 'concurrent'
 require 'parallel'
 require 'tempfile'
 
@@ -96,39 +97,61 @@ class PhraseAppUpdater
       end
     end
 
-    # Empirically, PhraseApp fails to parse the uploaded files when uploaded in
-    # parallel. Give it a better chance by uploading them one at a time.
     def upload_files(locale_files, default_locale:)
-      is_default = ->(l) { l.locale_name == default_locale }
+      locale_files = locale_files.sort_by(&:locale_name)
+      default_locale_file = locale_files.detect { |l| l.locale_name == default_locale }
+      locale_files.delete(default_locale_file) if default_locale_file
 
-      # Ensure the locales all exist
-      STDERR.puts('Creating locales')
       known_locales = fetch_locales.index_by(&:name)
+
+      # Phraseapp appears to use to use the first file uploaded to resolve conflicts
+      # between pluralized and non-pluralized keys. Upload and verify the canonical
+      # default locale first before uploading translated locales.
+      if default_locale_file
+        unless known_locales.has_key?(default_locale_file.locale_name)
+          STDERR.puts("Creating default locale (#{default_locale_file})")
+          create_locale(default_locale_file.locale_name, default: true)
+        end
+
+        STDERR.puts("Uploading default locale (#{default_locale_file})")
+        upload_id = upload_file(default_locale_file)
+
+        successful_default_upload = verify_uploads({ upload_id => default_locale_file })
+      else
+        STDERR.puts("No upload for default locale (#{default_locale})")
+      end
+
+      # Ensure the locales all exist
+      STDERR.puts('Creating translation locales')
       threaded_request(locale_files) do |locale_file|
         unless known_locales.has_key?(locale_file.locale_name)
-          create_locale(locale_file.locale_name, default: is_default.(locale_file))
+          create_locale(locale_file.locale_name, default: false)
         end
       end
 
-      # Upload the files in a stable order, ensuring the default locale is first.
-      locale_files.sort! do |a, b|
-        next -1 if is_default.(a)
-        next 1  if is_default.(b)
+      uploads = Concurrent::Hash.new
 
-        a.locale_name <=> b.locale_name
+      threaded_request(locale_files) do |locale_file|
+        STDERR.puts("Uploading #{locale_file}")
+        upload_id = upload_file(locale_file)
+        uploads[upload_id] = locale_file
       end
 
-      uploads = {}
+      successful_uploads = verify_uploads(uploads)
 
-      uploads = locale_files.to_h do |locale_file|
-        STDERR.puts("Uploading #{locale_file}")
-        upload_id = upload_file(locale_file)
-        [upload_id, locale_file]
+      if default_locale_file
+        successful_uploads = successful_uploads.merge(successful_default_upload)
       end
 
-      # Validate the uploads, retrying failures as necessary
-      successful_upload_ids = {}
+      successful_uploads
+    end
 
+    # Given a map of {upload_id => locale_file} pairs, use the upload_show
+    # API to verify that they're complete, and re-upload them if they failed.
+    # Return a map of locale name to upload id.
+    def verify_uploads(uploads)
+      successful_upload_ids = Concurrent::Hash.new
+      attempts = 1
       STDERR.puts('Verifying uploads...')
       until uploads.empty?
         threaded_request(uploads.to_a) do |upload_id, locale_file|
@@ -151,12 +174,18 @@ class PhraseAppUpdater
           end
         end
 
-        sleep(2) unless uploads.empty?
+        unless uploads.empty?
+          delay = attempts ** 1.6 + 1
+          STDERR.puts("#{uploads.size} remaining, waiting #{delay.round} seconds...")
+          sleep(delay)
+          attempts += 1
+        end
       end
 
       successful_upload_ids
     end
 
+
     def remove_keys_not_in_uploads(upload_ids)
       threaded_request(upload_ids) do |upload_id|
         STDERR.puts "Removing keys not in upload #{upload_id}"
@@ -209,17 +238,30 @@ class PhraseAppUpdater
       phraseapp_request(Phrase::TagsApi,:tag_create, @project_id, params)
     end
 
-    def wrap_phrase_errors
-      yield
-    rescue Phrase::ApiError => e
-      if e.code == 401
-        raise BadAPIKeyError.new(e)
-      elsif e.message.match?(/not found/)
-        raise BadProjectIDError.new(e, @project_id)
-      elsif e.message.match?(/has already been taken/)
-        raise ProjectNameTakenError.new(e)
-      else
-        raise
+    def wrap_phrase_errors(retries: 10)
+      begin
+        yield
+      rescue Phrase::ApiError => e
+        if e.code == 401
+          raise BadAPIKeyError.new(e)
+        elsif e.code == 429
+          # If we bail mid-sync, it can be expensive to recover from a partial
+          # merge. Instead, aggressively try to retry.
+          if retries >= 0
+            retries -= 1
+            STDERR.puts('Rate limited, retrying in 5...')
+            sleep(5)
+            retry
+          end
+
+          raise RateLimitError.new(e)
+        elsif e.message.match?(/not found/)
+          raise BadProjectIDError.new(e, @project_id)
+        elsif e.message.match?(/has already been taken/)
+          raise ProjectNameTakenError.new(e)
+        else
+          raise
+        end
       end
     end
 
@@ -324,5 +366,11 @@ class PhraseAppUpdater
         super(original_error.message)
       end
     end
+
+    class RateLimitError < RuntimeError
+      def initialize(original_error)
+        super(original_error.message)
+      end
+    end
   end
 end

data/lib/phraseapp_updater/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class PhraseAppUpdater
-  VERSION = '3.3.0'
+  VERSION = '3.3.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phraseapp_updater
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.3.2
 platform: ruby
 authors:
 - iKnow Team
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-24 00:00:00.000000000 Z
+date: 2025-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.23'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -178,7 +192,7 @@ homepage: https://github.com/iknow/phraseapp_updater
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -194,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.27
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A three-way differ for PhraseApp projects.
 test_files: []