stockpile_cache 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0cf5948f44622314a97af71ab6ce39aa3f59931092b7ac6d80f424e052be90d
-  data.tar.gz: bec173c3c11807350c3b4d4cb05f638fc4a90c71837882f7b64931db1dce8416
+  metadata.gz: '055681de81947f8bb1934929e2a0467a332c2c7bfaee62e3fe0c0fdac7c51033'
+  data.tar.gz: 7a38b8765377b2b3df4b7919c0148b543cc5f8465a559b1e08ddc9fb4cf4a1f6
 SHA512:
-  metadata.gz: '08218ce4ab3946ae6b418dd0d72c354170415eff8b041d0e02bbc261ffca83fe4afd7718d9bb7907d2b80093afaeeaa8f83dc57e7b9a7aa4d91c1384ccf965b7'
-  data.tar.gz: fddd745d31dae1f5509cd3988e216d2fdfe5e520a971e58ef3ede3ed864c5b2e34191abef7b67bfab0115134fa4cdceec43fd404d8d8430c53df931b4f01bde1
+  metadata.gz: b917312a5c31ac63518097609ee538a2699f8c629926386cff33c7c3ab9cf1ed6161a1486ac0b708cd9055d21d424c00c4e4945a315d3237db6c33440b9d65e2
+  data.tar.gz: 19f55f2f2b072d4a11f3af6c2fd6596068c6c31a5745eff056548c196ef3d2cda58af8dcaa00cf93a07355cf8b9e8f1fad43e9e8cf5ce1e4db6eaaefbe0e46db

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 1.3.0
+- Allowing optional compression of cached content
+
 ## 1.2.0
 - Adding support for multiple Redis databases/server
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stockpile_cache (1.2.0)
+    stockpile_cache (1.3.0)
       connection_pool
       oj
       rake
@@ -14,13 +14,13 @@ GEM
     connection_pool (2.2.2)
     diff-lcs (1.3)
     jaro_winkler (1.5.3)
-    oj (3.9.2)
+    oj (3.10.6)
     parallel (1.17.0)
     parser (2.6.4.1)
       ast (~> 2.4.0)
     rainbow (3.0.0)
     rake (13.0.1)
-    redis (4.1.3)
+    redis (4.1.4)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -53,4 +53,4 @@ DEPENDENCIES
   stockpile_cache!
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/README.md

@@ -149,6 +149,44 @@ Using `configuration_file` setting will make Stockpile ignore all other
 Redis connection related settings and it will read configuration from `.yml`
 file instead.
 
+### Compression of Cached Content
+Stockpile optionally supports compression of cached content; you will not see
+much benefit from compressing small strings but once you start caching bigger
+payloads like fragments of HTML you could see some improvements by using
+compression. To use compression you will have to use configuration file set by
+`STOCKPILE_CONFIGURATION_FILE`.
+
+To enable compression you have to do two things. First you have to set
+`configuration_file` setting to point at `.yml` containing your configuration.
+You can do so by either setting a `STOCKPILE_CONFIGURATION_FILE` environment
+variable or by executing a configuration block during runtime (for Rails create
+`config/initializers/stockpile.rb` with following content):
+
+```
+Stockpile.configure do |configuration|
+  configuration.configuration_file = <PATH/TO/FILE>
+end
+```
+
+Second thing to do is to create a `.yml` configuration file. It has to have at
+least one database definition. Providing `sentinels` and `compression` is
+optional. Everything else is mandatory:
+
+
+```
+---
+master:
+  url: 'redis://redis-1-host:6379/1'
+  sentinels: '8.8.8.8:42,8.8.4.4:42'
+  compression: true
+  pool_options:
+    size: 5
+    timeout: 5
+```
+
+From that point everything that will be cached in `master` database will be
+compressed.
+
 ## Caveats
 There is no timeout or rescue set for code you will be running through the cache. If
 you need to do either you have to handle it outside of Stockpile.

data/lib/stockpile/cache.rb

@@ -22,21 +22,32 @@ module Stockpile
   module Cache
     module_function
 
-    def get(db: :default, key:)
+    def get(db: :default, key:, compress: false)
       value_from_cache = Stockpile.redis(db: db) { |r| r.get(key) }
-      Oj.load(value_from_cache) if value_from_cache
+
+      return unless value_from_cache
+
+      if compress && value_from_cache
+        Oj.load(Zlib::Inflate.inflate(Base64.decode64(value_from_cache)))
+      else
+        Oj.load(value_from_cache)
+      end
     end
 
-    def get_deferred(db: :default, key:)
+    def get_deferred(db: :default, key:, compress: false)
       sleep(Stockpile::SLUMBER_COOLDOWN) until Stockpile.redis(db: db) { |r| r.exists(key) }
-      value_from_cache = Stockpile.redis(db: db) { |r| r.get(key) }
-      Oj.load(value_from_cache)
+
+      get(db: db, key: key, compress: compress)
     end
 
-    def set(db: :default, key:, payload:, ttl:)
-      payload = Oj.dump(payload)
-      Stockpile.redis(db: db) { |r| r.set(key, payload) }
-      Stockpile.redis(db: db) { |r| r.expire(key, ttl) }
+    def set(db: :default, key:, payload:, ttl:, compress: false)
+      payload = if compress
+                  Base64.encode64(Zlib::Deflate.deflate(Oj.dump(payload)))
+                else
+                  Oj.dump(payload)
+                end
+
+      Stockpile.redis(db: db) { |r| r.setex(key, ttl, payload) }
     end
   end
 end

data/lib/stockpile/constants.rb

@@ -23,5 +23,5 @@ module Stockpile
   DEFAULT_TTL = 60 * 5
   LOCK_PREFIX = 'stockpile_lock::'
   SLUMBER_COOLDOWN = 0.05
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/lib/stockpile/executor.rb

@@ -44,6 +44,10 @@ module Stockpile
 
     private
 
+    def compress?
+      RedisConnections.compression?(db: db)
+    end
+
     def execution
       @execution ||= Stockpile::Lock.perform_locked(db: db, lock_key: lock_key) do
         yield
@@ -55,7 +59,8 @@ module Stockpile
         db: db,
         key: key,
         payload: execution.result,
-        ttl: ttl
+        ttl: ttl,
+        compress: compress?
       )
 
       execution.release_lock
@@ -68,7 +73,7 @@ module Stockpile
 
     def wait_for_cache_or_yield
       Timeout.timeout(Stockpile.configuration.slumber) do
-        Stockpile::Cache.get_deferred(db: db, key: key)
+        Stockpile::Cache.get_deferred(db: db, key: key, compress: compress?)
       end
     rescue Timeout::Error
       yield

data/lib/stockpile/redis_connections.rb

@@ -22,6 +22,10 @@ module Stockpile
   module RedisConnections
     module_function
 
+    def compression?(db:)
+      instance_variable_get("@#{db}_compression".to_sym)
+    end
+
     def with(db:)
       instance_variable_get("@#{db}".to_sym).with do |connection|
         yield connection

data/lib/stockpile/redis_connections_factory.rb

@@ -29,10 +29,9 @@ module Stockpile
           Redis.new(database[:redis_configuration])
         end
 
-        RedisConnections.instance_variable_set(
-          "@#{database[:db]}".to_sym,
-          pool
-        )
+        RedisConnections.instance_variable_set("@#{database[:db]}".to_sym, pool)
+
+        RedisConnections.instance_variable_set("@#{database[:db]}_compression".to_sym, database[:compression])
       end
 
       RedisConnections

data/lib/stockpile/yaml_redis_configuration.rb

@@ -27,11 +27,18 @@ module Stockpile
         {
           db: database,
           pool_configuration: extract_pool(settings: settings),
-          redis_configuration: extract_redis(settings: settings)
+          redis_configuration: extract_redis(settings: settings),
+          compression: extract_compression(settings: settings)
         }
       end
     end
 
+    def extract_compression(settings:)
+      return true if settings['compression'].eql?(true)
+
+      false
+    end
+
     def extract_redis(settings:)
       sentinels = Stockpile::RedisConnectionsFactory.process_sentinels(
         sentinels: settings['sentinels'] || ''

data/lib/stockpile.rb

@@ -14,11 +14,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'base64'
 require 'connection_pool'
 require 'oj'
 require 'redis'
 require 'timeout'
 require 'yaml'
+require 'zlib'
 
 require 'stockpile/constants'
 require 'stockpile/configuration'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stockpile_cache
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - ConvertKit, LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-28 00:00:00.000000000 Z
+date: 2020-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool