cache_failover 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8d5991671822e08f31cb2622b1acfc7e0f916e6666f5cbab87021a066ada840f
+  data.tar.gz: 77e29f1e8151e7ffead1e13edf1d2ab422724f8acfe260dd1fe842cd1a03254e
+SHA512:
+  metadata.gz: d4cb4b6a5a2804d1eb6de0450f03070870d3c56c9fb4cd78be4fed51f32485479762ddba8c03ad3dd6a067fddc703627000b8eb1988c22e2328e5de5ee3bbbd9
+  data.tar.gz: 55e91982231ace2529ecc8a47e81be6bbec454d2f695142fea8c2984a346be120a1ecbc3a679c63767d51cb205976cdcc13b12a945266c91b36efa996eb29cd1

data/.idea/.gitignore

@@ -0,0 +1,6 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

data/.idea/CacheFailover.iml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="ModuleRunConfigurationManager">
+    <shared />
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/features" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+    </content>
+    <orderEntry type="jdk" jdkName="RVM: ruby-3.3.1 [global]" jdkType="RUBY_SDK" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v13.1.0, RVM: ruby-3.3.1 [global]) [gem]" level="application" />
+  </component>
+</module>

data/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/CacheFailover.iml" filepath="$PROJECT_DIR$/.idea/CacheFailover.iml" />
+    </modules>
+  </component>
+</project>

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

data/cache_failover.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cache_failover/version"
+
+Gem::Specification.new do |gem|
+  gem.name = "cache_failover"
+  gem.version = CacheFailover::VERSION
+  gem.authors = ["chronicaust"]
+  gem.email = ["jamiep@supportabilit.com"]
+  gem.summary = %q{ Failover Handling Cache Store for Rails w/ Brotli compression support. (Redis[Hiredis]/Memcached[Dalli]/SolidCache[MySQL/PG])  }
+  gem.description = %q{ This gem enabled automatic failover to a secondary caching method when the primary fails. }
+  gem.homepage = "https://github.com/chronicaust/cache_failover"
+  gem.files = `git ls-files`.split("\n")
+  gem.test_files = gem.files.grep(%r{^(spec)/})
+  gem.require_paths = ["lib"]
+  gem.license = "MIT"
+  gem.add_dependency "activesupport"
+  gem.add_dependency "brotli"
+  gem.add_dependency "rails-brotli-cache"
+  gem.add_dependency "msgpack"
+  gem.add_development_dependency "solid_cache"
+  gem.add_development_dependency "redis"
+  gem.add_development_dependency "hiredis"
+  gem.add_development_dependency "dalli"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "railties"
+  gem.add_development_dependency "activemodel"
+  gem.add_development_dependency "actionpack"
+  gem.add_development_dependency "byebug"
+  gem.add_development_dependency "rufo"
+
+  if gem.respond_to?(:metadata=)
+    gem.metadata = { "rubygems_mfa_required" => "true" }
+  end
+end

data/lib/README.md

@@ -0,0 +1,50 @@
+# Cache Failover Gem [![Gem Version]]
+
+## Installation
+
+`Gemfile`
+
+```ruby
+  gem 'cache_failover'
+```
+
+You will need at least 2 cache stores for failover capability.
+
+```ruby
+  gem 'solid_cache' #  optional, but you will need at least 2 cache stores
+  gem 'redis' # optional, but you will need at least 2 cache stores
+  gem 'hiredis' # optional, only for redis
+  gem 'dalli' # optional, but you will need at least 2 cache stores (WIP)
+  gem 'cache_failover'
+```
+
+## Configuration
+
+Configure your cache_store normally, but use `CacheFailover::Store` with one argument, an array of hashes with the keys `store` and `options` in the order you would like to failover. Example is shown below:
+
+```ruby
+config.cache_store = CacheFailover::Store.new(
+  [
+    {
+      store: ActiveSupport::Cache::RedisCacheStore.new(
+        url: CONFIG[:REDIS_URL],
+        password: CONFIG[:REDIS_PASSWORD],
+      ),
+      options: {}
+    },
+    {
+      store: SolidCache::Store.new(),
+      options: {
+        expiry_method: :job
+      }
+    }
+  ]
+)
+```
+
+## WIP
+- Dalli/Memcached support
+- Memory Cache Support
+- File Cache support
+- More options
+- Tests

data/lib/cache_failover/store.rb

@@ -0,0 +1,259 @@
+# frozen_string_literal: true
+module CacheFailover
+  class Store < ::ActiveSupport::Cache::Store
+    MARK_BR_COMPRESSED = "\x02".b
+
+    class BrotliCompressor
+      def self.deflate(payload)
+        ::Brotli.deflate(payload, quality: 1)
+      end
+
+      def self.inflate(payload)
+        ::Brotli.inflate(payload)
+      end
+    end
+
+    DEFAULT_OPTIONS = {
+      timeout: 5,
+      compress: true,
+      cache_db: 'cache'
+    }
+
+    attr_reader :core_store
+
+    def initialize(cache_stores)
+      _core_store = cache_stores.find do |cs|
+        options(cs[:options])
+        Logger.new("log/#{CONFIG[:RAILS_ENV]}.log").info("CacheFailover: caching_up?: #{cs[:store].class.name}")
+        Logger.new("log/#{CONFIG[:RAILS_ENV]}.log").info("CacheFailover: caching_up?: #{options}")
+        Logger.new("log/#{CONFIG[:RAILS_ENV]}.log").info("#{caching_up?(cs[:store], options)}")
+        caching_up?(cs[:store], options)
+      end
+      @core_store = _core_store[:store]
+    end
+
+    def options(init_options = {})
+      return @init_options if defined?(@init_options) && init_options.blank?
+      @init_options = init_options.reverse_merge(DEFAULT_OPTIONS)
+    end
+
+    def fetch(name, init_options = nil, &block)
+      options(init_options)
+
+      if !block_given? && options[:force]
+        raise ArgumentError, "Missing block: Calling `Cache#fetch` with `force: true` requires a block."
+      end
+
+      get_value(
+        @core_store.fetch(expanded_cache_key(name), options.merge(compress: false)) do
+          if block_given?
+            store_value(block.call, options)
+          else
+            nil
+          end
+        end,
+        options
+      )
+    end
+
+    def write(name, value, init_options = nil)
+      options(init_options)
+
+      payload = store_value(value, options)
+
+      @core_store.write(
+        expanded_cache_key(name),
+        payload,
+        options.merge(compress: false)
+      )
+    end
+
+    def read(name, init_options = nil)
+      options(init_options)
+
+      payload = @core_store.read(
+        expanded_cache_key(name),
+        options
+      )
+
+      get_value(payload, options)
+    end
+
+    def write_multi(hash, init_options = nil)
+      options(init_options)
+
+      new_hash = hash.map do |key, val|
+        [
+          expanded_cache_key(key),
+          store_value(val, options),
+        ]
+      end
+
+      @core_store.write_multi(
+        new_hash,
+        options.merge(compress: false)
+      )
+    end
+
+    def read_multi(*names)
+      options = names.extract_options!
+      names = names.map { |name| expanded_cache_key(name) }
+      options(options)
+
+      core_store.read_multi(*names, options).map do |key, val|
+        [key, get_value(val, options)]
+      end.to_h
+    end
+
+    def fetch_multi(*names)
+      options = names.extract_options!
+      expanded_names = names.map { |name| expanded_cache_key(name) }
+      options(options)
+
+      reads = core_store.send(:read_multi_entries, expanded_names, **options)
+      reads.map do |key, val|
+        [key, store_value(val, options)]
+      end.to_h
+
+      writes = {}
+      ordered = names.index_with do |name|
+        reads.fetch(name) { writes[name] = yield(name) }
+      end
+
+      write_multi(writes)
+      ordered
+    end
+
+    def exist?(name, init_options = {})
+      @core_store.exist?(expanded_cache_key(name), init_options)
+    end
+
+    def delete(name, init_options = {})
+      @core_store.delete(expanded_cache_key(name), init_options)
+    end
+
+    def clear(init_options = {})
+      @core_store.clear(**init_options)
+    end
+
+    def increment(name, amount = 1, **init_options)
+      @core_store.increment(expanded_cache_key(name), amount, **init_options)
+    end
+
+    def decrement(name, amount = 1, **init_options)
+      @core_store.decrement(expanded_cache_key(name), amount, **init_options)
+    end
+
+    def self.supports_cache_versioning?
+      true
+    end
+
+    REDIS ||=
+
+      private
+
+    def redis_cnxn(init_options)
+      @redis_cache_client ||=
+        RedisClient.config(
+          url: CONFIG[:REDIS_URL],
+          password: CONFIG[:REDIS_PASSWORD],
+          driver: init_options[:adapter] || :hiredis,
+          timeout: init_options[:timeout] || 1,
+          inherit_socket: true,
+          ).new_pool
+    end
+
+    def cache_db_cnxn(init_options)
+      @db_cache_client ||=
+        ActiveRecord::Base.
+          establish_connection(
+            Rails.configuration.database_configuration[Rails.env.to_s][init_options[:cache_db]]
+          )
+    end
+
+    def caching_up?(store, init_options)
+      begin
+        Timeout.timeout((init_options[:timeout] || 1)) do
+          case store.class.name
+          when 'ActiveSupport::Cache::RedisCacheStore'
+            (redis_cnxn(init_options).call('ping') == 'PONG' rescue false)
+          when 'ActiveSupport::Cache::MemCacheStore'
+          when 'SolidCache::Store'
+            cache_db_cnxn(init_options).with_connection { ActiveRecord::Base.connection.select_value('SELECT 1=1') == 1 }
+          when 'ActiveSupport::Cache::MemoryStore'
+          when 'ActiveSupport::Cache::FileStore'
+          when 'ActiveSupport::Cache::NullStore'
+          end
+        end
+      rescue => ex
+        false
+      end
+    end
+
+    def serialized(value)
+      mpval = (value.try(:to_msgpack) rescue nil)
+      msval = (Marshal.dump(value) rescue nil)
+      if mpval.present? && mpval.bytesize < msval.bytesize
+        mpval
+      else
+        msval
+      end
+    end
+
+    def unserialized(payload)
+      begin
+        MessagePack.unpack(payload)
+      rescue => ex
+        Marshal.load(payload)
+      end
+    end
+
+    def compressed(value)
+      begin
+        BrotliCompressor.deflate(value)
+      rescue Brotli::Error => ex
+        Rails.logger.info("CacheFailover Error: BrotliCompressor.deflate: #{ex.message}")
+        value
+      end
+    end
+
+    def uncompressed(payload)
+      begin
+        BrotliCompressor.inflate(payload.byteslice(1..-1))
+      rescue Brotli::Error => ex
+        Rails.logger.info("CacheFailover Error: BrotliCompressor.inflate: #{ex.message}")
+        payload
+      end
+    end
+
+    def store_value(value, init_options)
+      return value if value.is_a?(Integer)
+      value = serialized(value)
+      if init_options.blank? || init_options[:compress].blank? || !options[:compress] == false
+        value = compressed(value)
+        MARK_BR_COMPRESSED + value
+      else
+        value
+      end
+    end
+
+    def get_value(payload, init_options)
+      return nil unless payload.present?
+      return payload if payload.is_a?(Integer)
+      payload =
+        if payload.start_with?(MARK_BR_COMPRESSED)
+          uncompressed(payload)
+        else
+          payload
+        end
+      payload = unserialized(payload)
+      payload
+    end
+
+    def expanded_cache_key(name)
+      "#{::ActiveSupport::Cache.expand_cache_key(name)}"
+    end
+
+  end
+end
+

data/lib/cache_failover/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CacheFailover
+  VERSION = "0.1.0"
+end

data/lib/cache_failover.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "cache_failover/store"
+
+module CacheFailover
+end

metadata

@@ -0,0 +1,251 @@
+--- !ruby/object:Gem::Specification
+name: cache_failover
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- chronicaust
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: brotli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails-brotli-cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: solid_cache
+  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: redis
+  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: hiredis
+  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: dalli
+  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: rspec
+  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: railties
+  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: activemodel
+  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: actionpack
+  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: byebug
+  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: rufo
+  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'
+description: " This gem enabled automatic failover to a secondary caching method when
+  the primary fails. "
+email:
+- jamiep@supportabilit.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".idea/.gitignore"
+- ".idea/CacheFailover.iml"
+- ".idea/modules.xml"
+- ".idea/vcs.xml"
+- Rakefile
+- cache_failover.gemspec
+- lib/README.md
+- lib/cache_failover.rb
+- lib/cache_failover/store.rb
+- lib/cache_failover/version.rb
+homepage: https://github.com/chronicaust/cache_failover
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key: 
+specification_version: 4
+summary: Failover Handling Cache Store for Rails w/ Brotli compression support. (Redis[Hiredis]/Memcached[Dalli]/SolidCache[MySQL/PG])
+test_files: []