singleton-client-test 0.7.7.4 → 0.7.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b1a0ab0b7bfa8a2fef42c229aae91032941499667f0885882f924d6a3f75694
-  data.tar.gz: be51ed5dbdf30cbc7f67353b5d96ba49e4e20a5de61ea9bd7d99d4f27785e1a9
+  metadata.gz: 6ab2a482cbb7c83aca190392287160802cae5488a7356dfd24a79476817f40ac
+  data.tar.gz: e691e2eca4f3c2a2f747970ff746b045e4c1cbaa3de23e73eeba84a7f812c2ec
 SHA512:
-  metadata.gz: d3a9b167165b5d6f6726ed8be0b07fadc7ef4aeb0c8ecb8f941bc77e5ff7ada988557f97098c33d1907fb7f24b1cac17f7df4fa3de3b96cce2e64a4240633c58
-  data.tar.gz: 44e84a38eb2e592793546c812817b751b0366b5af2ed0591eeaed1e4dd5b014af70b33674b7da69cac2873e16fb9ab3b47ff85d7d5f463b3a3bcfd987930ee7e
+  metadata.gz: 619fed54ca5da856c0d8933724e69bb286deba7aebd94a6c98d674dc8c532dc2937cbee650ebb0e337351a3d0b8515dd06f1884066412009098f85c09a4373fc
+  data.tar.gz: 9500161a55b6e4a2c43f2955168895ddfbde82ae1fe68a6a2fcbe4aa1f1498bfaa99a3fe3f82962fac288f455f5a775e26c2193a945940eaaa4cdafbeca90fe8

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

@@ -1,9 +1,12 @@
 # Copyright 2022 VMware, Inc.
 # SPDX-License-Identifier: EPL-2.0
 
+require 'set'
+require 'time'
+
 module SgtnClient
   module Common
-    class BundleID
+    class BundleID # :nodoc:
       attr_reader :locale, :component
 
       def initialize(component, locale)
@@ -17,7 +20,7 @@ module SgtnClient
       end
 
       def ==(other)
-       (other.is_a? self.class) && @locale == other.locale && @component == other.component
+        (other.is_a? self.class) && @locale == other.locale && @component == other.component
       end
 
       alias eql? ==
@@ -26,5 +29,39 @@ module SgtnClient
         "{component: #{@component}, locale: #{@locale}}"
       end
     end
+
+    module DataInfo # :nodoc:
+      attr_accessor :last_update
+
+      def initialize(*)
+        @last_update = Time.now
+        super
+      end
+
+      def expired?
+        Time.now >= @last_update + DataInfo.age
+      end
+
+      def self.age
+        @age ||= SgtnClient.config.cache_expiry_period * 60
+      end
+    end
+
+    class BundleData < Hash # :nodoc:
+      include DataInfo
+
+      def initialize(*args)
+        if !args.empty? && args[0].is_a?(Hash)
+          update(args[0])
+          super()
+        else
+          super
+        end
+      end
+    end
+
+    class SetData < Set # :nodoc:
+      include DataInfo
+    end
   end
 end

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

@@ -3,51 +3,52 @@
 # Copyright 2022 VMware, Inc.
 # SPDX-License-Identifier: EPL-2.0
 
+require 'concurrent/map'
+
 module SgtnClient
   module TranslationLoader
     module Cache # :nodoc:
+      def initialize(*)
+        @cache_hash = Concurrent::Map.new
+        super
+      end
+
       # get from cache, return expired data immediately
       def get_bundle(component, locale)
-        SgtnClient.logger.debug { "[#{__FILE__}][#{__callee__}] component=#{component}, locale=#{locale}" }
-
-        key = Common::BundleID.new(component, locale)
-        cache_item = CacheUtil.get_cache(key)
-        if cache_item
-          load_bundle(component, locale, sync: false) if CacheUtil.is_expired(cache_item)
-          cache_item[:items]
-        else
-          load_bundle(component, locale)
-        end
+        SgtnClient.logger.debug { "[#{caller[2]}] component=#{component}, locale=#{locale}" }
+
+        result = @cache_hash[Common::BundleID.new(component, locale)] || load_bundle(component, locale)
+      ensure
+        load_bundle(component, locale, sync: false) if result&.expired?
       end
 
       def available_bundles
-        SgtnClient.logger.debug { "[#{__FILE__}][#{__callee__}]" }
-
-        cache_item = CacheUtil.get_cache(CONSTS::AVAILABLE_BUNDLES_KEY)
-        if cache_item
-          super(sync: false) if CacheUtil.is_expired(cache_item)
-          cache_item[:items]
-        else
-          super
-        end
+        SgtnClient.logger.debug { "[#{caller[2]}]" }
+
+        result = @cache_hash[CONSTS::AVAILABLE_BUNDLES_KEY] || super
+      ensure
+        super(sync: false) if result&.expired?
       end
     end
 
-    module CacheFiller
+    module CacheFiller # :nodoc:
       def load_bundle(component, locale)
-        SgtnClient.logger.debug { "[#{__FILE__}][#{__callee__}] component=#{component}, locale=#{locale}" }
+        SgtnClient.logger.debug { "[#{caller[2]}] component=#{component}, locale=#{locale}" }
 
-        item = super
-        CacheUtil.write_cache(Common::BundleID.new(component, locale), item) if item
-        item
+        @cache_hash[Common::BundleID.new(component, locale)] = Common::BundleData.new(super)
       end
 
       def available_bundles
-        SgtnClient.logger.debug { "[#{__FILE__}][#{__callee__}]" }
+        SgtnClient.logger.debug { "[#{caller[2]}]" }
 
         item = super
-        CacheUtil.write_cache(CONSTS::AVAILABLE_BUNDLES_KEY, item) if item # TODO: don't save when empty
-        item
+        old_item = @cache_hash[CONSTS::AVAILABLE_BUNDLES_KEY]
+        if item != old_item # only update if different
+          @cache_hash[CONSTS::AVAILABLE_BUNDLES_KEY] = Common::SetData.new(item)
+        else # if same, don't need to update the data, but update last_update
+          old_item.last_update = Time.now
+          old_item
+        end
       end
     end
   end

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

@@ -8,11 +8,6 @@ module SgtnClient # :nodoc:
   autoload :Common,             'sgtn-client/common'
   autoload :TranslationLoader,  'sgtn-client/loader'
   autoload :SingleOperation,    'sgtn-client/common/single_operation'
-
-  module Core # :nodoc:
-    autoload :Cache, 'sgtn-client/core/cache'
-  end
-
   autoload :Translation,        'sgtn-client/api/translation'
   autoload :T,                  'sgtn-client/api/t'
   autoload :Source,             'sgtn-client/api/source'
@@ -20,7 +15,6 @@ module SgtnClient # :nodoc:
   autoload :Exceptions,         'sgtn-client/core/exceptions'
   autoload :ValidateUtil,       'sgtn-client/util/validate-util'
   autoload :LocaleUtil,         'sgtn-client/util/locale-util'
-  autoload :CacheUtil,          'sgtn-client/util/cache-util'
   autoload :StringUtil,         'sgtn-client/util/string-util'
   autoload :SingletonError,     'sgtn-client/exceptions'
   autoload :I18nBackend,        'sgtn-client/i18n_backend'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: singleton-client-test
 version: !ruby/object:Gem::Version
-  version: 0.7.7.4
+  version: 0.7.7.5
 platform: ruby
 authors:
 - VMware G11n Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-12 00:00:00.000000000 Z
+date: 2022-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -141,7 +141,6 @@ files:
 - lib/sgtn-client/common.rb
 - lib/sgtn-client/common/data.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/exceptions.rb
@@ -158,7 +157,6 @@ files:
 - lib/sgtn-client/loader/source.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/locale-util.rb
 - lib/sgtn-client/util/string-util.rb
 - lib/sgtn-client/util/validate-util.rb

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

@@ -1,31 +0,0 @@
-# Copyright 2022 VMware, Inc.
-# SPDX-License-Identifier: EPL-2.0
-
-require 'time'
-
-module SgtnClient::Core
-        class Cache
-            Entry = Struct.new(:expiry, :items)
-
-            def self.get(key)
-                SgtnClient.logger.debug { "[Cache][get]get cache for key: #{key}" }
-                return data&.dig(key)
-            end
-
-            def self.put(key, items, 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
-                SgtnClient.logger.debug { "[Cache][clear]clear cache!" }
-                @data = {}
-            end
-
-            def self.data
-                @data ||= {}
-            end
-        end
-
-end

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

@@ -1,30 +0,0 @@
-# Copyright 2022 VMware, Inc.
-# SPDX-License-Identifier: EPL-2.0
-
-require 'time'
-
-module SgtnClient
-  class CacheUtil
-    def self.get_cache(cache_key)
-      Core::Cache.get(cache_key)
-    end
-
-    def self.clear_cache
-      Core::Cache.clear
-    end
-
-    def self.write_cache(cache_key, items)
-      return nil if items.nil? || items.empty?
-
-      cache_expiry_period = SgtnClient.config.cache_expiry_period
-      # expired after 24 hours
-      cache_expiry_period = 24 * 60 if cache_expiry_period.nil?
-      Core::Cache.put(cache_key, items, cache_expiry_period)
-    end
-
-    def self.is_expired(cache_item)
-      cache_item[:expiry] < Time.now
-    end
-
-  end
-end