singleton-client-test 0.7.0.32 → 0.7.0.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c3518e9f8e872dd00acd151a9157c273f274c5398d773c42e75d07e0667413b
-  data.tar.gz: 0eec546d1df60f066a1f346c04da0cac374f1944980477ccb32b5055a70e62b0
+  metadata.gz: a2a32a268d9bc9b395baeb2d296049cbbb29a40c081968d6e8a5ae364c39444c
+  data.tar.gz: fdf427aaf792fbff1bf6afa404d6e0aeeea030b9fa90b7eab578cbe46659656e
 SHA512:
-  metadata.gz: b8eb7e6e83057a56fa3a0d618b14ef83e61458319ccbbea388028961bbeae0ea061c82c87ed34f89cfe43c2336fc390b4ffe6801c1e9e6c85e43a2c4dd366e9f
-  data.tar.gz: 10eb576187a7ff47e04e409ff292862397e956de6adfbe9f2a39565cd5219c22397a959a23b399c96627aeab85562992f0abc92edec3a590f0ec7a7b610c4794
+  metadata.gz: 1ecfa3b8fbc1ef494e41a517a102856f4717d408845eeac43cd751c24df2a590404082cd00670b280fd8c404b3dd95ecd2ae5c06f7b0c0b23172b9eb7ab2fff7
+  data.tar.gz: 0a8aee2dd03eaa02c981cdfaa097ffbddebc2118c7c7a63625ad19ca332ecf582fac19a812339ef9920dac37765a03b30d9800d69cfe9dd2b854762ee0796170

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

@@ -1,73 +1,24 @@
 # Copyright 2022 VMware, Inc.
 # SPDX-License-Identifier: EPL-2.0
 
+require 'sgtn-client/loader/local_source_bundle'
+
 module SgtnClient
-  
-  autoload :CacheUtil,       "sgtn-client/util/cache-util"
+  autoload :CacheUtil, 'sgtn-client/util/cache-util'
 
   class Source
-
-      def self.getSource(component, key, locale)
-        SgtnClient.logger.debug "[Source][getSource]component=#{component}, key=#{key}, locale=#{locale}"
-        cache_key = SgtnClient::CacheUtil.get_cachekey(component, locale)
-        expired, items = SgtnClient::CacheUtil.get_cache(cache_key)
-        if items.nil?
-          items = getBundle(component, locale)    
-          SgtnClient::CacheUtil.write_cache(cache_key, items)
-        else
-          SgtnClient.logger.debug "[Source][getSource]getting sources from cache with key: " + cache_key
-        end
-        s = (items.nil? || items[locale].nil?)? nil : items[locale][key]  
-        if items.nil? || s.nil?
-          SgtnClient.logger.debug "[Source][getSource]source not found, return key: " + key
-          #return key
-          return nil
-        else
-          return s
-        end
-      end
-
-      def self.getSources(component, locale)
-        SgtnClient.logger.debug "[Source][getSources]component=#{component}, locale=#{locale}"
-        cache_key = SgtnClient::CacheUtil.get_cachekey(component, locale)
-        expired, items = SgtnClient::CacheUtil.get_cache(cache_key)
-        if items.nil? || expired
-          items = getBundle(component, locale)
-          SgtnClient::CacheUtil.write_cache(cache_key, items)
-        else
-          SgtnClient.logger.debug "[Source][getSources]getting sources from cache with key: " + cache_key
-        end
-        return items
-      end
-
-      def self.loadBundles(locale)
-        SgtnClient.logger.debug "[Source][loadBundles]locale=#{locale}"
-        env = SgtnClient::Config.default_environment
-        SgtnClient::Config.configurations.default = locale
-        source_bundle = SgtnClient::Config.configurations[env]["source_bundle"]
-        Dir.foreach(source_bundle) do |component|
-          next if component == '.' || component == '..'
-          yamlfile = File.join(source_bundle, component + "/" + locale + ".yml")
-          bundle = SgtnClient::FileUtil.read_yml(yamlfile)
-          cachekey = SgtnClient::CacheUtil.get_cachekey(component, locale)
-          SgtnClient::CacheUtil.write_cache(cachekey,bundle)
-        end
-      end
-
-      private
-      def self.getBundle(component, locale)
-        SgtnClient.logger.debug "[Source][getBundle]component=#{component}, locale=#{locale}"
-        env = SgtnClient::Config.default_environment
-        source_bundle = SgtnClient::Config.configurations[env]["source_bundle"]
-        bundlepath = source_bundle  + "/" + component + "/" + locale + ".yml"
-        begin
-          bundle = SgtnClient::FileUtil.read_yml(bundlepath)
-        rescue => exception
-          SgtnClient.logger.error exception.message
-        end
-        return bundle
+    def self.loadBundles(locale)
+      SgtnClient.logger.debug "[Source][loadBundles]locale=#{locale}"
+      env = SgtnClient::Config.default_environment
+      SgtnClient::Config.configurations.default = locale
+      source_bundle = SgtnClient::Config.configurations[env]['source_bundle']
+      Dir.foreach(source_bundle) do |component|
+        next if %w[. ..].include? component
+
+        bundle = load_bundle(component)
+        cachekey = SgtnClient::CacheUtil.get_cachekey(component, LocaleUtil.get_source_locale)
+        SgtnClient::CacheUtil.write_cache(cachekey, bundle)
       end
-
+    end
   end
-
 end

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

@@ -2,24 +2,23 @@
 # SPDX-License-Identifier: EPL-2.0
 
 module SgtnClient
-    class T < Translation
-
-        def self.s(key)
-            locale = RequestStore.store[:locale]
-            component = RequestStore.store[:component]
-            return getString(component, key, locale)
-        end
+  class T
+    def self.s(key)
+      locale = RequestStore.store[:locale]
+      component = RequestStore.store[:component]
+      Translation.getString(component, key, locale)
+    end
 
-        def self.s_f(key, args)
-            locale = RequestStore.store[:locale]
-            component = RequestStore.store[:component]
-            return getString_f(component, key, args, locale)
-        end
+    def self.s_f(key, args)
+      locale = RequestStore.store[:locale]
+      component = RequestStore.store[:component]
+      Translation.getString_f(component, key, args, locale)
+    end
 
-        def self.c()
-            locale = RequestStore.store[:locale]
-            component = RequestStore.store[:component]
-            return getStrings(component, locale)
-        end
+    def self.c
+      locale = RequestStore.store[:locale]
+      component = RequestStore.store[:component]
+      Translation.getStrings(component, locale)
     end
+  end
 end

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

@@ -1,158 +1,110 @@
 # Copyright 2022 VMware, Inc.
 # SPDX-License-Identifier: EPL-2.0
 
-require 'multi_json'
-
 module SgtnClient
-
-  module Core
-    autoload :Request,     "sgtn-client/core/request"
-    autoload :Cache,       "sgtn-client/core/cache"
-    autoload :CacheUtil,   "sgtn-client/util/cache-util"
-    autoload :LocaleUtil,   "sgtn-client/util/locale-util"
+  autoload :StringUtil, 'sgtn-client/util/string-util'
+
+  module TranslationLoader
+    autoload :LocalBundle, 'sgtn-client/loader/local_bundle'
+    autoload :ServerBundle, 'sgtn-client/loader/server_bundle'
+    autoload :SourceComparer, 'sgtn-client/loader/source_comparer'
+    autoload :SingleLoader, 'sgtn-client/loader/single_loader'
+    autoload :Cache, 'sgtn-client/loader/cache'
   end
-  
-  class Translation
-
-      def self.getString(component, key, locale)
-        SgtnClient.logger.debug "[Translation.getString]component: #{component}, key: #{key}, locale: #{locale}"
-        str = getTranslation(component, key, locale)
-        if str.nil?
-          str = SgtnClient::Source.getSource(component, key, SgtnClient::Config.configurations.default)
-          if str.nil?
-            SgtnClient.logger.debug "[Translation][getString] Missing source string with key: #{key}, component: #{component}, locale: #{locale}"
-          end
-        end
-        str
-      end
 
-      def self.getString_p(component, key, plural_args, locale)
-        SgtnClient.logger.debug "[Translation][getString_p]component=#{component}, key=#{key}, locale=#{locale}"
-        str = getTranslation(component, key, locale)
-        if str.nil?
-          str = SgtnClient::Source.getSource(component, key, SgtnClient::Config.configurations.default)
-          if str.nil?
-            SgtnClient.logger.debug "[Translation][getString_p] Missing source string with key: #{key}, component: #{component}, locale: #{locale}"
-            return nil
-          end
-          str.to_plural_s(:en, plural_args)
-        else
-          str.to_plural_s(locale, plural_args)
+  module Translation
+    def self.getString(component, key, locale)
+      SgtnClient.logger.debug "[Translation.getString]component: #{component}, key: #{key}, locale: #{locale}"
+      str = getTranslation(component, key, locale)
+      if str.nil? && !LocaleUtil.is_source_locale(locale)
+        str = getTranslation(component, key, LocaleUtil.get_source_locale)
+      end
+      str
+    end
+
+    def self.getString_p(component, key, plural_args, locale)
+      SgtnClient.logger.debug "[Translation][getString_p]component=#{component}, key=#{key}, locale=#{locale}"
+      str = getTranslation(component, key, locale)
+      if str.nil?
+        unless LocaleUtil.is_source_locale(locale)
+          str = getTranslation(component, key, LocaleUtil.get_source_locale)
+          str.to_plural_s(LocaleUtil.get_source_locale, plural_args) if str
         end
+      else
+        locale = str.locale if str.is_a?(SgtnClient::StringUtil)
+        str.to_plural_s(locale, plural_args)
       end
+    end
 
-      def self.getString_f(component, key, args, locale, *optionals)
-         SgtnClient.logger.debug "[Translation][getString_f]component=#{component}, key=#{key}, locale=#{locale}"
-         s = getString(component, key, locale, *optionals)
-         if s.nil?
-          return nil
-         end
-         if args.is_a?(Hash)
-          args.each do |source, arg|
-            s.gsub! "{#{source}}", arg
-          end
-         elsif args.is_a?(Array)
-          s = sprintf s % args
-         end
-         return s
-      end
+    def self.getString_f(component, key, args, locale, *optionals)
+      SgtnClient.logger.debug "[Translation][getString_f]component=#{component}, key=#{key}, locale=#{locale}"
+      s = getString(component, key, locale, *optionals)
+      return nil if s.nil?
 
-      def self.getStrings(component, locale)
-        SgtnClient.logger.debug "[Translation][getStrings]component=#{component}, locale=#{locale}"
-        locale = SgtnClient::LocaleUtil.get_best_locale(locale)
-        items = get_cs(component, locale)
-        default = SgtnClient::Config.configurations.default
-        if items.nil? || items["messages"] == nil
-          items = {}
-          s = SgtnClient::Source.getSources(component, default)
-          if s.nil?
-            SgtnClient.logger.error "[Translation][getStrings] Missing component: #{component}, locale: #{locale}"
-          else
-            default_component, value = s.first
-            items["component"] = component
-            items["messages"] = value
-            items["locale"] = 'source'
-          end
+      if args.is_a?(Hash)
+        args.each do |source, arg|
+          s.gsub! "{#{source}}", arg
         end
-        return items
-       end
-
+      elsif args.is_a?(Array)
+        s = s % args
+      end
+      s
+    end
+
+    def self.getStrings(component, locale)
+      SgtnClient.logger.debug "[Translation][getStrings]component=#{component}, locale=#{locale}"
+      locale = SgtnClient::LocaleUtil.get_best_locale(locale)
+      items = get_cs(component, locale)
+      if (items.nil? || items['messages'].nil?) && !LocaleUtil.is_source_locale(locale)
+        items = get_cs(component, LocaleUtil.get_source_locale)
+      end
 
-      private
+      items
+    end
 
-      def self.getTranslation(component, key, locale)
-        locale = SgtnClient::LocaleUtil.get_best_locale(locale)
-        items = get_cs(component, locale)
-        if items.nil? || items["messages"] == nil
-          nil
-        else
-          items["messages"][key]
-        end
-      end
+    def self.getTranslation(component, key, locale)
+      locale = SgtnClient::LocaleUtil.get_best_locale(locale)
+      items = get_cs(component, locale)
+      items&.dig('messages', key)
+    end
 
-      def self.get_cs(component, locale)
-        # source locale always return source bundle
-        if locale == LocaleUtil.get_source_locale
-          sources = SgtnClient::Source.getSources(component, SgtnClient::Config.configurations.default)
-          messages = sources&.first&.last
-          return {'locale' => locale, 'component' => component, 'messages' => messages} if messages
-        end
+    def self.get_cs(component, locale)
+      cache_item = load_bundle(component, locale)
+      cache_item&.dig(:items)
+    end
 
-        cache_key = SgtnClient::CacheUtil.get_cachekey(component, locale)
-        SgtnClient.logger.debug "[Translation][get_cs]cache_key=#{cache_key}"
-        expired, items = SgtnClient::CacheUtil.get_cache(cache_key)
-        if items.nil? || expired
-          items = load(component, locale)
-          if items.nil?
-            items = SgtnClient::Source.getSources(component, SgtnClient::Config.configurations.default)
-            SgtnClient::Core::Cache.put(cache_key, items, 60)
-          else
-            SgtnClient::CacheUtil.write_cache(cache_key, items)
-          end
-        else
-          SgtnClient.logger.debug "[Translation]get translations from cache with key: " + cache_key
-        end
+    def self.load_bundle(component, locale)
+      init_translations unless initialized?
+      super
+    end
 
-        return items
-       end
+    class << self
+      def initialized?
+        @initialized ||= false
+      end
 
-      def self.load(component, locale)
+      def init_translations
+        # TODO: Lock to initialize?
         env = SgtnClient::Config.default_environment
-        mode = SgtnClient::Config.configurations[env]["bundle_mode"]
-        SgtnClient.logger.debug "[Translation][load]mode=#{mode}"
+        mode = SgtnClient::Config.configurations[env]['bundle_mode']
+        SgtnClient.logger.debug "[Translation][init_translations]mode=#{mode}"
+
         if mode == 'offline'
-          return load_o(component, locale)
+          extend SgtnClient::TranslationLoader::LocalBundle
         else
-          return load_s(component, locale)
+          extend SgtnClient::TranslationLoader::ServerBundle
         end
-      end
 
-      def self.load_o(component, locale)
-        env = SgtnClient::Config.default_environment
-        product_name = SgtnClient::Config.configurations[env]["product_name"]
-        version = SgtnClient::Config.configurations[env]["version"].to_s
-        translation_bundle = SgtnClient::Config.configurations[env]["translation_bundle"]
-        bundlepath = translation_bundle + "/" + product_name + "/" + version + "/" + component + "/messages_" + locale + ".json"
-        SgtnClient::FileUtil.read_json(bundlepath)
-      end
+        extend SgtnClient::TranslationLoader::SourceComparer
+        extend SgtnClient::TranslationLoader::Cache
 
-      def self.load_s(component, locale)
-        env = SgtnClient::Config.default_environment
-        product_name = SgtnClient::Config.configurations[env]["product_name"]
-        vip_server = SgtnClient::Config.configurations[env]["vip_server"]
-        version = SgtnClient::Config.configurations[env]["version"].to_s
-        url = vip_server + "/i18n/api/v2/translation/products/" + product_name + "/versions/" + version + "/locales/" + locale + "/components/" + component+ "?checkTranslationStatus=false&machineTranslation=false&pseudo=false"
-        begin
-          obj = SgtnClient::Core::Request.get(url)
-        rescue => exception
-          SgtnClient.logger.error exception.message
-        end
-        if obj != nil
-          obj = obj["data"]
-        end
-        return obj
+        load_translations
+        @initialized = true
       end
 
-  end
+      def load_translations; end
+    end
 
+    private_class_method :getTranslation, :get_cs, :load_bundle, :initialized?, :load_translations
+  end
 end

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

@@ -0,0 +1,33 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
+module SgtnClient
+  class SingleOperation
+    def initialize(*conditions, &block)
+      raise 'no way to create a new obj' unless block
+
+      @lock = Mutex.new
+      @hash = {}
+
+      @conditions = conditions
+      @creator = block
+    end
+
+    # return new created object
+    def operate(id, *args)
+      @lock.synchronize do
+        obj = @hash[id]
+        @conditions.each do |con|
+          return obj unless con.call(id, obj, *args)
+        end
+        @hash[id] = @creator.call(id, obj, *args)
+      end
+    end
+
+    def remove_object(id)
+      @lock.synchronize do
+        @hash.delete(id)
+      end
+    end
+  end
+end

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

@@ -5,99 +5,30 @@ require 'date'
 
 module SgtnClient::Core
         class Cache
-            Entry = Struct.new(:expiry, :value)
+            Entry = Struct.new(:expiry, :items)
 
             def self.initialize(disabled=false, opts={})
                 @@opts = opts
-                @mutex = Mutex.new
-                if disabled == false
-                    @@data = Hash.new
-                    SgtnClient.logger.debug "[Cache][initialize]cache is enabled!"
-                else
-                    @@data = nil
-                    SgtnClient.logger.debug "[Cache][initialize]cache is disabled!"
-                end
-            end
-
-            def self.keys
-                if @@data == nil
-                    return nil
-                end
-                SgtnClient.logger.debug "[Cache][keys]get cache keys"
-                @@data.keys
+                SgtnClient.logger.debug "[Cache][initialize] Disable cache? #{disabled}"
+                @@data = Hash.new
             end
 
             def self.get(key)
-                if @@data == nil
-                    return nil, nil
-                end
                 SgtnClient.logger.debug "[Cache][get]get cache for key: " + key
-                invalidate(key)
-            end
-
-            def self.has(key)
-                if @@data == nil
-                    return nil
-                end
-                SgtnClient.logger.debug "[Cache][has]check if the cache has key: #{(@@data.has_key? key)}"
-                @@data.has_key? key
+                return @@data&.dig(key)
             end
 
-            def self.put(key, value, ttl=nil)
-                @mutex.synchronize do
-                    if @@data == nil || value == nil
-                        return nil
-                    end
-                    ttl ||= @@opts[:ttl]
-                    # hours from new
-                    SgtnClient.logger.debug "[Cache][put]put cache for key '" + key + "' with expired time at'" + (Time.now + ttl*60).to_s
-                    @@data[key] = Entry.new(Time.now + ttl*60, value)
-                end
-            end
-
-            def self.delete(key)
-                @mutex.synchronize do
-                    if @@data == nil
-                        return nil
-                    end
-                    SgtnClient.logger.debug "[Cache][delete]delete cache for key: " + key
-                    @@data.delete key
-                end
+            def self.put(key, items, ttl=nil)
+                ttl ||= @@opts[:ttl]
+                # hours from new
+                SgtnClient.logger.debug "[Cache][put]put cache for key '" + key + "' with expired time at'" + (Time.now + ttl*60).to_s
+                @@data[key] = Entry.new(Time.now + ttl*60, items)
             end
 
             def self.clear
-                @mutex.synchronize do
-                    if @@data == nil
-                        return nil
-                    end
-                    SgtnClient.logger.debug "[Cache][clear]clear cache!"
-                    @@data = Hash.new
-                end
-            end
-
-            def self.invalidate(key)
-                @mutex.synchronize do
-                    if @@data == nil
-                        return nil, nil
-                    end
-                    SgtnClient.logger.debug "[Cache][invalidate]invalidate expired cache......"
-                    now = Time.now
-                    if has(key)
-                        v = @@data[key]
-                        expired = false
-                        SgtnClient.logger.debug "[Cache][invalidate]check cache: key=#{key}, expiredtime=#{v[:expiry]}, now=#{now}, expired=#{(v[:expiry] < now)}"
-                        if v[:expiry] < now
-                            SgtnClient.logger.debug "[Cache][invalidate]before deleting the cache: data=#{@@data}"
-                            @@data.delete(key)
-                            SgtnClient.logger.debug "[Cache][invalidate]after deleting the cache: data=#{@@data}"
-                            expired = true
-                        end
-                        return expired, v[:value]
-                    else
-                        return nil, nil
-                    end
-                end
+                SgtnClient.logger.debug "[Cache][clear]clear cache!"
+                @@data = Hash.new
             end
         end
 
-end
+end

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

@@ -0,0 +1,47 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
+module SgtnClient
+  autoload :CacheUtil, 'sgtn-client/util/cache-util'
+  autoload :SingleOperation, 'sgtn-client/common/single_operation'
+end
+module SgtnClient::TranslationLoader::Cache
+  def load_bundle(component, locale)
+    cache_key = SgtnClient::CacheUtil.get_cachekey(component, locale)
+    SgtnClient.logger.debug "[#{self.to_s}][#{__FILE__}][#{__method__}] cache_key=#{cache_key}"
+    cache_item = SgtnClient::CacheUtil.get_cache(cache_key)
+    if cache_item.nil?
+      # refresh synchronously if not in cache
+      SgtnClient.logger.debug "[#{self.to_s}][#{__FILE__}][#{__method__}] Cache miss. cache_key=#{cache_key}"
+      cache_item = (single_loader { |c, l| super(c, l) }).operate(cache_key, component, locale).value 
+      # TODO: if an error occurs when requesting a bundle, need to avoid more requests
+    elsif SgtnClient::CacheUtil.is_expired(cache_item) && locale != SgtnClient::LocaleUtil.get_source_locale # local source never expires.
+      SgtnClient.logger.debug "[#{self.to_s}][#{__FILE__}][#{__method__}] Bundle cache is expired. cache_key=#{cache_key}"
+      @single_loader.operate(cache_key, component, locale) # refresh in background
+    end
+    cache_item
+  end
+
+  private
+
+  def single_loader
+    @single_loader ||= begin
+      none_alive = proc { |_, thread| thread.nil? || thread.alive? == false }
+      to_run = proc do |id|
+        cache_item = SgtnClient::CacheUtil.get_cache(id)
+        cache_item&.dig(:items).nil? || SgtnClient::CacheUtil.is_expired(cache_item)
+      end
+      creator = proc do |id, _, c, l|
+        Thread.new do
+          SgtnClient.logger.debug "Refreshing cache for #{c}/#{l}"
+          cache_item = SgtnClient::CacheUtil.write_cache(id, yield(c, l))
+          # delete thread from hash after finish
+          Thread.new { @single_loader.remove_object(id) }
+          cache_item
+        end
+      end
+
+      SgtnClient::SingleOperation.new(none_alive, to_run, &creator)
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
+module SgtnClient::TranslationLoader::LocalBundle
+  def load_bundle(component, locale)
+    env = SgtnClient::Config.default_environment
+    product_name = SgtnClient::Config.configurations[env]['product_name']
+    version = SgtnClient::Config.configurations[env]['version'].to_s
+    translation_bundle = SgtnClient::Config.configurations[env]['translation_bundle']
+    bundlepath = translation_bundle + '/' + product_name + '/' + version + '/' + component + '/messages_' + locale + '.json'
+    SgtnClient::FileUtil.read_json(bundlepath)
+  end
+end

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

@@ -0,0 +1,29 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
+module SgtnClient
+  class Source
+    def self.load_bundle(component)
+      SgtnClient.logger.debug "[Source][getBundle]component=#{component}"
+      env = SgtnClient::Config.default_environment
+      source_bundle = SgtnClient::Config.configurations[env]['source_bundle']
+      component_path = "#{source_bundle}/#{component}"
+      total_messages = nil
+      Dir.glob('**/*.{yml, yaml}', base: component_path) do |f|
+        bundle = SgtnClient::FileUtil.read_yml("#{component_path}/#{f}")
+        if total_messages.nil?
+          total_messages = bundle&.first&.last
+        else
+          total_messages.merge!(bundle&.first&.last)
+        end
+      end
+
+      if total_messages
+        return { 'component' => component, 'locale' => SgtnClient::LocaleUtil.get_source_locale, 'messages' => total_messages }
+      end
+    rescue StandardError => e
+      SgtnClient.logger.error e.message
+      nil
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
+module SgtnClient::Core
+  autoload :Request, 'sgtn-client/core/request'
+end
+
+module SgtnClient::TranslationLoader::ServerBundle
+  def load_bundle(component, locale)
+    env = SgtnClient::Config.default_environment
+    product_name = SgtnClient::Config.configurations[env]['product_name']
+    vip_server = SgtnClient::Config.configurations[env]['vip_server']
+    version = SgtnClient::Config.configurations[env]['version'].to_s
+    url = vip_server + '/i18n/api/v2/translation/products/' + product_name + '/versions/' + version + '/locales/' + locale + '/components/' + component + '?checkTranslationStatus=false&machineTranslation=false&pseudo=false'
+    begin
+      obj = SgtnClient::Core::Request.get(url)
+    rescue StandardError => e
+      SgtnClient.logger.error e.message
+    end
+    obj && obj['data']
+  end
+end

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

@@ -0,0 +1,38 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
+module SgtnClient
+  autoload :Source, 'sgtn-client/loader/local_source_bundle'
+end
+module SgtnClient::TranslationLoader::SourceComparer
+  def load_bundle(component, locale)
+    # source locale always uses source bundles
+    return SgtnClient::Source.load_bundle(component) if SgtnClient::LocaleUtil.is_source_locale(locale)
+
+    translation_bundle_thread = Thread.new { super(component, locale) }
+    old_source_bundle = super(component, SgtnClient::LocaleUtil.get_source_locale)
+    source_bundle = get_cs(component, SgtnClient::LocaleUtil.get_source_locale)
+    translation_bundle = translation_bundle_thread.value
+
+    compare_source(translation_bundle, old_source_bundle, source_bundle)
+  end
+
+  private
+
+  def compare_source(translation_bundle, old_source_bundle, source_bundle)
+    return translation_bundle if translation_bundle.nil? || source_bundle.nil? || old_source_bundle.nil?
+
+    old_source_messages = old_source_bundle['messages']
+    translation_messages = translation_bundle['messages']
+    translation_bundle['messages'] = new_translation_messages = {}
+    source_bundle['messages'].each do |key, value|
+      translation = translation_messages[key]
+      new_translation_messages[key] = if old_source_messages[key] == value && !translation.nil?
+                                        translation
+                                      else
+                                        SgtnClient::StringUtil.new(value, SgtnClient::LocaleUtil.get_source_locale)
+                                      end
+    end
+    translation_bundle
+  end
+end

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

@@ -1,48 +1,43 @@
 # Copyright 2022 VMware, Inc.
 # SPDX-License-Identifier: EPL-2.0
 
-require 'erb'
-require 'yaml'
-
 module SgtnClient
-
   module Core
-    autoload :Cache,       "sgtn-client/core/cache"
+    autoload :Cache, 'sgtn-client/core/cache'
   end
-  
+
   class CacheUtil
+    def self.get_cache(cache_key)
+      SgtnClient.logger.debug "[CacheUtil]get cache with key #{cache_key}"
+      SgtnClient::Core::Cache.get(cache_key)
+    end
+
+    def self.clear_cache
+      SgtnClient::Core::Cache.clear
+      SgtnClient.logger.debug '[CacheUtil]clear cache'
+    end
+
+    def self.write_cache(cache_key, items)
+      return nil if items.nil? || items.empty?
+
+      env = SgtnClient::Config.default_environment
+      cache_expiry_period = SgtnClient::Config.configurations[env]['cache_expiry_period']
+      # expired after 24 hours
+      cache_expiry_period = 24 * 60 if cache_expiry_period.nil?
+      SgtnClient.logger.debug "[CacheUtil]write cache with key #{cache_key}, cache_expiry_period #{cache_expiry_period}"
+      SgtnClient::Core::Cache.put(cache_key, items, cache_expiry_period)
+    end
+
+    def self.get_cachekey(component, locale)
+      env = SgtnClient::Config.default_environment
+      product_name = SgtnClient::Config.configurations[env]['product_name']
+      version = SgtnClient::Config.configurations[env]['version'].to_s
+      product_name + '_' + version + '_' + component + '_' + locale
+    end
+
+    def self.is_expired(cache_item)
+      cache_item[:expiry] < Time.now
+    end
 
-      def self.get_cache(cache_key)
-        expired, items = SgtnClient::Core::Cache.get(cache_key)
-        SgtnClient.logger.debug "[CacheUtil]get cache with key #{cache_key}, expired #{expired}"
-        return expired, items
-      end
-
-      def self.clear_cache()
-        SgtnClient::Core::Cache.clear()
-        SgtnClient.logger.debug "[CacheUtil]clear cache"
-      end
-
-      def self.write_cache(cache_key, items)
-        if items.nil?
-          return nil
-        end
-        env = SgtnClient::Config.default_environment
-        cache_expiry_period = SgtnClient::Config.configurations[env]["cache_expiry_period"]
-        # expired after 24 hours
-        if cache_expiry_period == nil
-            cache_expiry_period = 24*60
-        end
-        SgtnClient.logger.debug "[CacheUtil]write cache with key #{cache_key}, cache_expiry_period #{cache_expiry_period}, itmes #{items}"
-        SgtnClient::Core::Cache.put(cache_key, items, cache_expiry_period)
-      end
-
-      def self.get_cachekey(component, locale)
-        env = SgtnClient::Config.default_environment
-        product_name = SgtnClient::Config.configurations[env]["product_name"]
-        version = SgtnClient::Config.configurations[env]["version"].to_s
-        product_name + "_" + version + "_" + component + "_" + locale
-      end
   end
-
 end

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

@@ -1,37 +1,24 @@
 # Copyright 2022 VMware, Inc.
 # SPDX-License-Identifier: EPL-2.0
 
-require 'erb'
-require 'yaml'
+autoload :YAML, 'yaml'
+autoload :MultiJson, 'multi_json'
 
 module SgtnClient
 
   class FileUtil
-
-      @mutex = Mutex.new
-
       def self.read_json(bundlepath)
         SgtnClient.logger.debug "[FileUtil]read json file from: " + bundlepath
-        @mutex.synchronize do
-          data_hash = nil
-          begin
-            file = File.read(bundlepath)
-            data_hash = MultiJson.load(file)
-          rescue => exception
-            SgtnClient.logger.error exception.message
-          end
-          return data_hash
+        begin
+          return MultiJson.load(File.read(bundlepath))
+        rescue => exception
+          SgtnClient.logger.error exception.message
         end
+        nil
       end
 
       def self.read_yml(file_name)
-        SgtnClient.logger.debug "[FileUtil]read yml file from: " + file_name
-        @mutex.synchronize do
-          erb = ERB.new(File.read(file_name))
-          erb.filename = file_name
-          YAML.load(erb.result)
-        end
+        YAML::load(File.read(file_name))
       end
   end
-
 end

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

@@ -1,46 +1,48 @@
 # Copyright 2022 VMware, Inc.
 # SPDX-License-Identifier: EPL-2.0
+require 'set'
 
 module SgtnClient
+  SUPPORTED_LOCALES = %w[en de es fr ko ja zh-Hans zh-Hant zh de-CH].freeze # TODO get this from service in online mode
+  
+  MAP_LOCALES = {
+    'zh-CN' => 'zh-Hans',
+    'zh-TW' => 'zh-Hant',
+    'zh-Hans-CN' => 'zh-Hans',
+    'zh-Hant-TW' => 'zh-Hant'
+  }.freeze
 
-    DEFAULT_LOCALES = ['en', 'de', 'es', 'fr', 'ko', 'ja', 'zh-Hans', 'zh-Hant']
-
-    MAP_LOCALES = {
-                    "zh-CN" =>"zh-Hans",
-                    "zh-TW" =>"zh-Hant",
-                    "zh-Hans-CN" =>"zh-Hans",
-                    "zh-Hant-TW" =>"zh-Hant",
-                  }
-
-    class LocaleUtil
-        def self.get_best_locale(locale)
-            fallback(process_locale(locale))
-        end
-        def self.process_locale(locale=nil)
-            locale ||= SgtnClient::Config.configurations.default
-            locale.to_s
-        end
-        def self.fallback(locale)
-            found = SgtnClient::DEFAULT_LOCALES.select {|e| e == locale}
-            if !found.empty?
-                return found[0]
-            end
-            if SgtnClient::MAP_LOCALES.key?(locale)
-                return SgtnClient::MAP_LOCALES[locale]
-            end
-            parts = locale.split("-")
-            if parts.size > 1
-                f = SgtnClient::DEFAULT_LOCALES.select {|e| e == parts[0]}
-                if !f.empty?
-                    return f[0]
-                end
-            end 
-            return locale
-        end
-        def self.get_source_locale
-            env = SgtnClient::Config.default_environment
-            source_locale = SgtnClient::Config.configurations[env]["default_language"]
-            source_locale || 'en'
-        end
+  class LocaleUtil
+    def self.get_best_locale(locale)
+      return get_default_locale if locale.nil?
+
+      locale = locale.to_s
+      return get_default_locale if locale.empty?
+
+      get_best_match(locale)
+    end
+
+    def self.is_source_locale(locale = nil)
+      locale == get_source_locale
+    end
+
+    def self.get_best_match(locale)
+      locale = locale.gsub('_', '-')
+      locale = SgtnClient::MAP_LOCALES[locale] if SgtnClient::MAP_LOCALES.key?(locale)
+      return locale if SUPPORTED_LOCALES.include?(locale)
+      return LocaleUtil.get_source_locale if locale.index('-').nil?
+      get_best_match(locale.slice(0..(locale.rindex('-')-1)) )  
     end
+
+    def self.get_source_locale
+      'en'
+    end
+
+    def self.get_default_locale
+      env = SgtnClient::Config.default_environment
+      SgtnClient::Config.configurations[env]['default_language'] || 'en'
+    end
+
+    private_class_method :get_best_match
+  end
 end

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

@@ -0,0 +1,12 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
+module SgtnClient
+  class StringUtil < String
+    def initialize(str, locale)
+      super(str)
+      @locale = locale
+    end
+    attr_accessor :locale
+  end
+end 

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: singleton-client-test
 version: !ruby/object:Gem::Version
-  version: 0.7.0.32
+  version: 0.7.0.33
 platform: ruby
 authors:
 - VMware G11n Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-09 00:00:00.000000000 Z
+date: 2022-03-30 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rest-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -94,34 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-doc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -244,6 +202,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: twitter_cldr
   requirement: !ruby/object:Gem::Requirement
@@ -274,16 +246,23 @@ files:
 - lib/sgtn-client/cldr/localized_datetime.rb
 - lib/sgtn-client/cldr/localized_str.rb
 - lib/sgtn-client/cldr/localized_time.rb
+- lib/sgtn-client/common/single_operation.rb
 - lib/sgtn-client/core/cache.rb
 - lib/sgtn-client/core/config.rb
 - lib/sgtn-client/core/exceptions.rb
 - lib/sgtn-client/core/logging.rb
 - lib/sgtn-client/core/request.rb
 - lib/sgtn-client/formatters/plurals/plural_formatter.rb
+- lib/sgtn-client/loader/cache.rb
+- lib/sgtn-client/loader/local_bundle.rb
+- lib/sgtn-client/loader/local_source_bundle.rb
+- lib/sgtn-client/loader/server_bundle.rb
+- lib/sgtn-client/loader/source_comparer.rb
 - lib/sgtn-client/sgtn-client.rb
 - lib/sgtn-client/util/cache-util.rb
 - lib/sgtn-client/util/file-util.rb
 - lib/sgtn-client/util/locale-util.rb
+- lib/sgtn-client/util/string-util.rb
 - lib/sgtn-client/util/validate-util.rb
 - lib/singleton-ruby.rb
 - lib/version.rb