singleton-client-test 0.7.7.5 → 0.7.7.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ab2a482cbb7c83aca190392287160802cae5488a7356dfd24a79476817f40ac
-  data.tar.gz: e691e2eca4f3c2a2f747970ff746b045e4c1cbaa3de23e73eeba84a7f812c2ec
+  metadata.gz: 71f20276ef709f5a183ab1e6572f171bfe9e5cdb0d0f09decea0fdb2e3aa2e88
+  data.tar.gz: 1eeebcc0cc3a964c90a00523fdda8aae09d3dc69ddc51af658c6218eb8e97c05
 SHA512:
-  metadata.gz: 619fed54ca5da856c0d8933724e69bb286deba7aebd94a6c98d674dc8c532dc2937cbee650ebb0e337351a3d0b8515dd06f1884066412009098f85c09a4373fc
-  data.tar.gz: 9500161a55b6e4a2c43f2955168895ddfbde82ae1fe68a6a2fcbe4aa1f1498bfaa99a3fe3f82962fac288f455f5a775e26c2193a945940eaaa4cdafbeca90fe8
+  metadata.gz: cd7cd9a1b977ddfd9110758b997c26bda3d8f2507f95036c87db24e130b7249f9c57871ce7f46c45827c810f0c7dd991b36dde656d3ce8a809e9ef4792554a65
+  data.tar.gz: 1d8c12a9f7dc6c65ebddcdf1eef50907cd8838a38a0c1a4c98c7001b4b9c77c55c5486d109fc7d9aca01c2c85c99e658ab381e8f2994e7818c73eb3d2a220295

data/lib/sgtn-client/api/translation.rb

@@ -39,63 +39,57 @@ module SgtnClient
         get_translations(component, locale)
       end
 
-      def translate(key, component, locale = nil, **kwargs)
+      def get_translation!(key, component, locale)
+        [get_bundle!(component, locale)[key], locale]
+      end
+
+      def translate(key, component, locale = nil, **kwargs, &block)
+        translate!(key, component, locale, **kwargs, &block)
+      rescue StandardError => e
+        SgtnClient.logger.debug { "[#{method(__callee__).owner}.#{__callee__}] {#{key}, #{component}, #{locale}}. #{e}" }
+        key
+      end
+      alias t translate
+
+      # raise error when translation is not found
+      def translate!(key, component, locale = nil, **kwargs, &block)
         SgtnClient.logger.debug { "[#{method(__callee__).owner}.#{__callee__}] key: #{key}, component: #{component}, locale: #{locale}, args: #{kwargs}" }
 
         begin
-          best_match_locale = LocaleUtil.get_best_locale(locale || self.locale, component)
-          messages, actual_locale = get_bundle_with_fallback(component, best_match_locale)
-          result = messages&.fetch(key, nil)
+          best_match_locale = LocaleUtil.get_best_locale(locale || SgtnClient.locale, component)
+          result, actual_locale = get_translation!(key, component, best_match_locale)
         rescue StandardError => e
-          SgtnClient.logger.debug { "[#{method(__callee__).owner}.#{__callee__}] translation is missing. {#{key}, #{component}, #{locale}}. #{e}" }
-          result = nil
+          raise e if block.nil?
         end
-
         if result.nil?
-          return key unless block_given?
+          raise SingletonError, 'translation is missing.' if block.nil?
 
-          result = yield
+          result = block.call
           return if result.nil?
         end
 
-        if kwargs.empty?
-          result
-        else
-          result.localize(actual_locale) % kwargs
-        end
+        kwargs.empty? ? result : result.localize(actual_locale) % kwargs
       end
-      alias t translate
+      alias t! translate!
 
       def get_translations(component, locale = nil)
-        SgtnClient.logger.debug { "[#{method(__callee__).owner}.#{__callee__}] component: #{component}, locale: #{locale}" }
-
-        best_match_locale = LocaleUtil.get_best_locale(locale || self.locale, component)
-        messages, actual_locale = get_bundle_with_fallback(component, best_match_locale)
-
-        { 'component' => component, 'locale' => actual_locale, 'messages' => messages } if messages
+        get_translations!(component, locale)
       rescue StandardError => e
-        SgtnClient.logger.error "[#{method(__callee__).owner}.#{__callee__}] translations are missing. {#{component}, #{locale}}. #{e}"
+        SgtnClient.logger.error "[#{method(__callee__).owner}.#{__callee__}] {#{component}, #{locale}}. #{e}"
         nil
       end
 
-      def locale
-        RequestStore.store[:locale] ||= LocaleUtil.get_fallback_locale
-      end
+      def get_translations!(component, locale = nil)
+        SgtnClient.logger.debug { "[#{method(__callee__).owner}.#{__callee__}] component: #{component}, locale: #{locale}" }
+
+        best_match_locale = LocaleUtil.get_best_locale(locale || SgtnClient.locale, component)
+        messages = get_bundle!(component, best_match_locale)
 
-      def locale=(value)
-        RequestStore.store[:locale] = value
+        { 'component' => component, 'locale' => best_match_locale, 'messages' => messages } if messages
       end
 
       private
 
-      def get_bundle(component, locale)
-        get_bundle!(component, locale)
-      rescue StandardError => e
-        SgtnClient.logger.error "[#{method(__callee__).owner}.#{__callee__}] failed to get a bundle. component: #{component}, locale: #{locale}"
-        SgtnClient.logger.error e
-        nil
-      end
-
       def get_bundle!(component, locale)
         SgtnClient.config.loader.get_bundle(component, locale)
       rescue StandardError
@@ -106,20 +100,9 @@ module SgtnClient
         SgtnClient.config.notify_observers(:available_locales, component)
         raise
       end
-
-      def get_bundle_with_fallback(component, locale)
-        messages = get_bundle(component, locale)
-        return messages, locale if messages
-
-        LocaleUtil.locale_fallbacks.each do |l|
-          next if l == locale
-
-          messages = get_bundle(component, l)
-          return messages, l if messages
-        end
-      end
     end
 
     extend Implementation
+    extend Fallbacks
   end
 end

data/lib/sgtn-client/common/data.rb

@@ -43,7 +43,7 @@ module SgtnClient
       end
 
       def self.age
-        @age ||= SgtnClient.config.cache_expiry_period * 60
+        @age ||= (SgtnClient.config.cache_expiry_period || 24 * 60) * 60
       end
     end
 

data/lib/sgtn-client/core/config.rb

@@ -18,8 +18,10 @@ module SgtnClient
     def logger
       @logger ||= if log_file
                     puts "create log file: '#{log_file}', level: #{log_level}"
-                    require 'lumberjack'
-                    Lumberjack::Logger.new(log_file, level: log_level, max_size: '1M', keep: 4)
+                    require 'logging'
+                    logger = Logging.logger(log_file, 4, 1_048_576)
+                    logger.level = log_level
+                    logger
                   else
                     require 'logger'
                     Logger.new(STDOUT, level: log_level || Logger::INFO)

data/lib/sgtn-client/fallbacks.rb

@@ -0,0 +1,38 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
+module SgtnClient
+  module Fallbacks # :nodoc:
+    def get_translation!(key, component, locale)
+      error = nil
+      localechain(locale) do |l|
+        return super(key, component, l)
+      rescue StandardError => e
+        error = e
+      end
+      raise error if error
+    end
+
+    def get_translations!(component, locale = nil)
+      error = nil
+      localechain(locale) do |l|
+        result = super(component, l)
+        return result if result
+      rescue StandardError => e
+        error = e
+      end
+      raise error if error
+    end
+
+    private
+
+    def localechain(locale)
+      yield locale
+      LocaleUtil.locale_fallbacks.each do |l|
+        next if l == locale
+
+        yield l
+      end
+    end
+  end
+end

data/lib/sgtn-client/loader/cache.rb

@@ -15,7 +15,7 @@ module SgtnClient
 
       # get from cache, return expired data immediately
       def get_bundle(component, locale)
-        SgtnClient.logger.debug { "[#{caller[2]}] component=#{component}, locale=#{locale}" }
+        SgtnClient.logger.debug { "[#{__FILE__}][#{__callee__}] component=#{component}, locale=#{locale}" }
 
         result = @cache_hash[Common::BundleID.new(component, locale)] || load_bundle(component, locale)
       ensure
@@ -23,7 +23,7 @@ module SgtnClient
       end
 
       def available_bundles
-        SgtnClient.logger.debug { "[#{caller[2]}]" }
+        SgtnClient.logger.debug { "[#{__FILE__}][#{__callee__}]" }
 
         result = @cache_hash[CONSTS::AVAILABLE_BUNDLES_KEY] || super
       ensure
@@ -33,13 +33,13 @@ module SgtnClient
 
     module CacheFiller # :nodoc:
       def load_bundle(component, locale)
-        SgtnClient.logger.debug { "[#{caller[2]}] component=#{component}, locale=#{locale}" }
+        SgtnClient.logger.debug { "[#{__FILE__}][#{__callee__}] CacheFiller, component=#{component}, locale=#{locale}" }
 
         @cache_hash[Common::BundleID.new(component, locale)] = Common::BundleData.new(super)
       end
 
       def available_bundles
-        SgtnClient.logger.debug { "[#{caller[2]}]" }
+        SgtnClient.logger.debug { "[#{__FILE__}][#{__callee__}] CacheFiller" }
 
         item = super
         old_item = @cache_hash[CONSTS::AVAILABLE_BUNDLES_KEY]

data/lib/sgtn-client/loader/server.rb

@@ -9,27 +9,34 @@ require 'set'
 
 module SgtnClient
   module TranslationLoader
-    class SgtnServer
+    class SgtnServer # :nodoc:
       ERROR_ILLEGAL_DATA = 'server returned illegal data.'
       ERROR_BUSINESS_ERROR = 'server returned business error.'
+      ERROR_PARTIAL_SUCCESS = 'the request to server was partially successful.'
+      ERROR_NO_DATA = 'no expected data in response from server. path: %s. Body is: %s'
 
       REQUEST_ARGUMENTS = { timeout: 10 }.freeze
 
       def initialize(config)
-        @server_url = config.vip_server
-
-        product_root = format('i18n/api/v2/translation/products/%s/versions/%s', config.product_name, config.version)
+        product_root = format('i18n/api/v2/translation/products/%<name>s/versions/%<version>s',
+                              name: config.product_name, version: config.version)
 
         @bundle_url = "#{product_root}/locales/%s/components/%s"
         @locales_url = "#{product_root}/localelist"
         @components_url = "#{product_root}/componentlist"
+
+        @conn = Faraday.new(config.vip_server, request: REQUEST_ARGUMENTS) do |f|
+          f.response :json # decode response bodies as JSON
+          f.use :gzip
+          f.response :raise_error
+          f.response :logger, config.logger, { log_level: :debug, headers: false, bodies: true }
+        end
       end
 
       def load_bundle(component, locale)
         SgtnClient.logger.debug { "[#{method(__callee__).owner}.#{__callee__}] component=#{component}, locale=#{locale}" }
 
-        messages = query_server(format(@bundle_url, locale, component), ['messages'])
-        messages
+        query_server(format(@bundle_url, locale, component), ['messages'])
       end
 
       def available_bundles
@@ -54,23 +61,12 @@ module SgtnClient
       end
 
       def query_server(url, path_to_data = [], queries = nil, headers = nil)
-        conn = Faraday.new(@server_url, request: REQUEST_ARGUMENTS) do |f|
-          f.response :json # decode response bodies as JSON
-          f.use :gzip
-          f.response :raise_error
-          f.response :logger, SgtnClient.logger, { log_level: :debug }
-        end
-        resp = conn.get(url, queries, headers)
+        resp = @conn.get(url, queries, headers)
 
         process_business_error(resp.body)
-        extract_data(resp.body, path_to_data)
-      end
-
-      def extract_data(parsedbody, path_to_data)
-        data = parsedbody.dig('data', *path_to_data)
-        raise SingletonError, "no expected data in response. Body is: #{parsedbody}" unless data
 
-        data
+        resp.body&.dig('data', *path_to_data) ||
+          (raise SingletonError, format(ERROR_NO_DATA, path_to_data, resp.body))
       end
 
       def process_business_error(parsedbody)
@@ -79,8 +75,8 @@ module SgtnClient
           raise SingletonError, "#{ERROR_BUSINESS_ERROR} #{parsedbody['response']}"
         end
 
-        # 600 means a successful response, 6xx means partial successful.
-        SgtnClient.logger.warn "#{ERROR_BUSINESS_ERROR} #{parsedbody['response']}" if b_code > 600
+        # 600/200 means a successful response, 6xx/2xx means partial successful.
+        SgtnClient.logger.warn "#{ERROR_PARTIAL_SUCCESS} #{parsedbody['response']}" if b_code != 600 && b_code != 200
       rescue TypeError, ArgumentError, NoMethodError => e
         raise SingletonError, "#{ERROR_ILLEGAL_DATA} #{e}. Body is: #{parsedbody}"
       end

data/lib/sgtn-client/sgtn-client.rb

@@ -9,6 +9,7 @@ module SgtnClient # :nodoc:
   autoload :TranslationLoader,  'sgtn-client/loader'
   autoload :SingleOperation,    'sgtn-client/common/single_operation'
   autoload :Translation,        'sgtn-client/api/translation'
+  autoload :Fallbacks,          'sgtn-client/fallbacks'
   autoload :T,                  'sgtn-client/api/t'
   autoload :Source,             'sgtn-client/api/source'
   autoload :Config,             'sgtn-client/core/config'
@@ -38,5 +39,13 @@ module SgtnClient # :nodoc:
       config.update(config_hash)
       ValidateUtil.validate_config
     end
+
+    def locale
+      RequestStore.store[:locale] ||= LocaleUtil.get_fallback_locale
+    end
+
+    def locale=(value)
+      RequestStore.store[:locale] = value
+    end
   end
 end

data/lib/sgtn-client/util/locale-util.rb

@@ -29,7 +29,8 @@ module SgtnClient
       end
 
       component_result[locale] ||= begin
-                # component_result.shift if component_result.size >= 50
+                component_result.delete(component_result.keys[Random.rand(component_result.size)]) if component_result.size >= 50
+
                 if SgtnClient.config.available_locales(component).include?(locale)
                   locale
                 elsif locale.nil?
@@ -73,7 +74,7 @@ module SgtnClient
     end
 
     def self.locale_fallbacks
-      @locale_fallbacks ||= [get_default_locale, get_source_locale, EN_LOCALE].uniq(&:to_s) - [nil, '']
+      @locale_fallbacks ||= ([get_default_locale, get_source_locale, EN_LOCALE].uniq(&:to_s) - [nil, '']).freeze
     end
 
     def self.lowercase_locales_map(component)

data/lib/singleton-client.rb

@@ -14,11 +14,26 @@ module Sgtn # :nodoc:
     end
 
     def_delegator SgtnClient::Config, :instance, :config
-    delegate %i[translate t get_translations locale locale=] => SgtnClient::Translation,
+    delegate %i[translate! t! translate t get_translations! get_translations] => SgtnClient::Translation,
+             %i[locale locale=] => SgtnClient,
              %i[logger product_name version vip_server translation_bundle
                 source_bundle cache_expiry_period log_file log_level].flat_map { |m|
                [m, "#{m}=".to_sym]
              } => :config
+
+    def with_locale(tmp_locale = nil)
+      if tmp_locale.nil?
+        yield
+      else
+        current_locale = locale
+        self.locale = tmp_locale
+        begin
+          yield
+        ensure
+          self.locale = current_locale
+        end
+      end
+    end
   end
 
   I18nBackend = SgtnClient::I18nBackend

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: singleton-client-test
 version: !ruby/object:Gem::Version
-  version: 0.7.7.5
+  version: 0.7.7.7
 platform: ruby
 authors:
 - VMware G11n Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-20 00:00:00.000000000 Z
+date: 2022-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: lumberjack
+  name: logging
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -144,6 +144,7 @@ files:
 - lib/sgtn-client/core/config.rb
 - lib/sgtn-client/core/exceptions.rb
 - lib/sgtn-client/exceptions.rb
+- lib/sgtn-client/fallbacks.rb
 - lib/sgtn-client/formatters/plurals/plural_formatter.rb
 - lib/sgtn-client/i18n_backend.rb
 - lib/sgtn-client/loader.rb