stockpile_cache 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0cf5948f44622314a97af71ab6ce39aa3f59931092b7ac6d80f424e052be90d
-  data.tar.gz: bec173c3c11807350c3b4d4cb05f638fc4a90c71837882f7b64931db1dce8416
+  metadata.gz: f7be09001963c6971d22e7538448f03c92f4be2d2c63da6cb69d3aaa4708e93e
+  data.tar.gz: 6db11eb490fd3387c5e17f5c6c6175cf99cddf0756883d5908ad6353ded57ed9
 SHA512:
-  metadata.gz: '08218ce4ab3946ae6b418dd0d72c354170415eff8b041d0e02bbc261ffca83fe4afd7718d9bb7907d2b80093afaeeaa8f83dc57e7b9a7aa4d91c1384ccf965b7'
-  data.tar.gz: fddd745d31dae1f5509cd3988e216d2fdfe5e520a971e58ef3ede3ed864c5b2e34191abef7b67bfab0115134fa4cdceec43fd404d8d8430c53df931b4f01bde1
+  metadata.gz: 3708ba5d7be994cf35b9ac0b98eef2a79b01bead9849234340b1cec61287b09f6e49b273ee87a73ce982d5aa45e61030ce0543664ff3821a0b0d61fadce538e5
+  data.tar.gz: 461d4d8adf44a2402f6e9d25338a2a49c52787225108acfd40cf1e2466cf18e1d67051230391d99c1bf14ba25d1792ad14c81cd6239f704831e05f4e95d94659

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 1.4.0
+- Bump redis-rb dependency to >= 4.2.0
+
+## 1.3.2
+- Fixing bug where cached content was not read
+
+## 1.3.1
+- Parsing ERB in YAML configs
+- Fill in missing README about cache expiration
+
+## 1.3.0
+- Allowing optional compression of cached content
+
 ## 1.2.0
 - Adding support for multiple Redis databases/server
 

data/Gemfile.lock

@@ -1,26 +1,26 @@
 PATH
   remote: .
   specs:
-    stockpile_cache (1.2.0)
+    stockpile_cache (1.4.0)
       connection_pool
       oj
       rake
-      redis
+      redis (>= 4.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
-    connection_pool (2.2.2)
+    connection_pool (2.2.5)
     diff-lcs (1.3)
     jaro_winkler (1.5.3)
-    oj (3.9.2)
+    oj (3.13.9)
     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)
+    rake (13.0.6)
+    redis (4.4.0)
     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

@@ -91,6 +91,12 @@ end
 | `db` | (optional) Name of the Redis database to cache value in. Defaults to `:default` |
 | `&block` | Block of code to execute; it's return value will be stored in cache. |
 
+To expire your cache immediately run:
+
+```
+Stockpile.expire_cached(key: 'meaning_of_life')
+```
+
 ### Multiple Database
 Stockpile comes with a support for multiple databases. A word of caution: unless
 you have very good reason to run multiple databases within single instance of
@@ -149,6 +155,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:)
-      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)
+    def get_deferred(db: :default, key:, compress: false)
+      sleep(Stockpile::SLUMBER_COOLDOWN) until Stockpile.redis(db: db) { |r| r.exists?(key) }
+
+      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/cached_value_reader.rb

@@ -23,7 +23,7 @@ module Stockpile
     module_function
 
     def read_or_yield(db: :default, key:, ttl:, &block)
-      if (result = Stockpile::Cache.get(db: db, key: key))
+      if (result = Stockpile::Cache.get(db: db, key: key, compress: RedisConnections.compression?(db: db)))
         result
       else
         Stockpile::Executor.perform(db: db, key: key, ttl: ttl, &block)

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.4.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,8 @@ 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'] || ''
@@ -51,7 +58,11 @@ module Stockpile
     end
 
     def parsed_configuration
-      YAML.safe_load(raw_configuration)
+      YAML.safe_load(
+        ERB.new(
+          raw_configuration
+        ).result
+      )
     end
 
     def raw_configuration

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'

data/stockpile-cache.gemspec

@@ -25,5 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'connection_pool'
   spec.add_dependency 'oj'
   spec.add_dependency 'rake'
-  spec.add_dependency 'redis'
+  spec.add_dependency 'redis', '>= 4.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stockpile_cache
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - ConvertKit, LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-28 00:00:00.000000000 Z
+date: 2021-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.2.0
 description: Simple redis based cache with stampede protection
 email:
 - engineering@convertkit.com
@@ -123,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Redis based cache