evt-entity_cache 0.14.0.0 → 0.14.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60ce778606243f14d742f85711593dbf6fe226ec
-  data.tar.gz: eadfeebaaac7e8477278e938eaa90e8328d1d307
+  metadata.gz: 3014f3bc8543059ba7f26b57e2f8cd0963906a6a
+  data.tar.gz: 7acbff224fdc2ff7b6e75c6779a7cb4668e7c082
 SHA512:
-  metadata.gz: 5d77d5302fac329c64b7642d2553a0dbdc0e470aa1744b1922fd6f06102dd33bd64a67c911a0ddcf49360e6eaa2072f02ccfd307353ed55d22751c56840bc124
-  data.tar.gz: 0af5181fd7d7998c0d46972163ed1f3859b3c9f25ff5d64b35a72dbe1724374f4cd34584473521ef397ba4d9350a2a36aca03d73ae33b1dad0193fbc3a09af35
+  metadata.gz: 1e1f097e2c67571aab3ed85e145ac90bf840f59e7f7f0bf68a19e790f7081290ebfe0ef2bee47d1fb3be3d3229edaefeb8ea95d092d7a199b5929821cde55672
+  data.tar.gz: 78c4aef2dd3281b1e5e1220aae805477a5a899bbc33ef85539701c9675e7291a345415573837eab6c264bdd78700772a412da86ce0ddccc722916ec3016e6149

data/lib/entity_cache/entity_cache.rb

@@ -0,0 +1,122 @@
+class EntityCache
+  include Log::Dependency
+
+  configure :entity_cache
+
+  attr_writer :persist_interval
+  def persist_interval
+    @persist_interval ||= Defaults.persist_interval
+  end
+
+  dependency :clock, Clock::UTC
+  dependency :temporary_store, Store::Temporary
+  dependency :persistent_store, Store::Persistent
+
+  def self.build(subject, scope: nil, persist_interval: nil, persistent_store: nil, persistent_store_session: nil)
+    instance = new
+
+    instance.configure(
+      subject: subject,
+      scope: scope,
+      persist_interval: persist_interval,
+      persistent_store: persistent_store,
+      persistent_store_session: persistent_store_session
+    )
+
+    instance
+  end
+
+  def configure(subject:, scope: nil, persist_interval: nil, persistent_store: nil, persistent_store_session: nil)
+    persistent_store ||= Store::Persistent::Null
+
+    unless persist_interval.nil?
+      self.persist_interval = persist_interval
+    end
+
+    Store::Temporary.configure(self, subject, scope: scope)
+
+    persistent_store.configure(self, subject, session: persistent_store_session)
+
+    Clock::UTC.configure(self)
+  end
+
+  def get(id)
+    logger.trace { "Get entity (ID: #{id.inspect})" }
+
+    record = temporary_store.get(id)
+
+    if record.nil?
+      record = restore(id)
+    end
+
+    if record.nil?
+      logger.info { "Get entity failed; cache miss (ID: #{id.inspect}, #{Record::LogText.get(record)})" }
+    else
+      logger.info { "Get entity done (ID: #{id.inspect}, #{Record::LogText.get(record)})" }
+    end
+
+    record
+  end
+
+  def put(id, entity, version, time: nil, persisted_version: nil, persisted_time: nil)
+    time ||= clock.now
+
+    updated_persistent_store = false
+
+    record = Record.build(id, entity, version, time)
+
+    logger.trace { "Put entity (ID: #{id.inspect}, #{Record::LogText.get(record)}, Persist Interval: #{persist_interval.inspect})" }
+
+    if persist?(version, persisted_version)
+      persistent_store.put(id, entity, version, time)
+
+      persisted_version = version
+      persisted_time = time
+      updated_persistent_store = true
+    end
+
+    record.persisted_version = persisted_version
+    record.persisted_time = persisted_time
+
+    temporary_store.put(record)
+
+    logger.info { "Put entity done (ID: #{id.inspect}, #{Record::LogText.get(record)}, Persist Interval: #{persist_interval.inspect}, Updated Persistent Store: #{updated_persistent_store})" }
+
+    record
+  end
+
+  def restore(id)
+    logger.trace { "Restoring entity (ID: #{id.inspect})" }
+
+    entity, version, time = persistent_store.get(id)
+
+    if entity.nil?
+      logger.debug { "Could not restore entity (ID: #{id.inspect})" }
+
+      return nil
+    end
+
+    record = Record.build(
+      id,
+      entity,
+      version,
+      time,
+      persisted_version: version,
+      persisted_time: time
+    )
+
+    temporary_store.put(record)
+
+    logger.debug { "Restored entity (ID: #{id.inspect}, #{Record::LogText.get(record)})" }
+
+    record
+  end
+
+  def persist?(version, persisted_version)
+    persisted_version ||= -1
+
+    age_versions = version - persisted_version
+
+    age_versions >= persist_interval
+  end
+end

data/lib/entity_cache/store/persistent.rb

@@ -0,0 +1,80 @@
+class EntityCache
+  module Store
+    module Persistent
+      def self.included(cls)
+        cls.class_exec do
+          include Log::Dependency
+
+          extend Build
+          extend RegisterTelemetrySink
+
+          configure :persistent_store
+
+          dependency :telemetry, ::Telemetry
+
+          initializer :subject
+
+          virtual :configure
+          abstract :get
+          abstract :put
+
+          prepend Configure
+          prepend Get
+          prepend Put
+        end
+      end
+
+      module Configure
+        def configure(session: nil)
+          ::Telemetry.configure(self)
+
+          super
+        end
+      end
+
+      module Get
+        def get(id)
+          logger.trace { "Getting entity (ID: #{id.inspect})" }
+
+          entity, version, time = super
+
+          telemetry.record(:get, Telemetry::Data.new(id, entity, version, time))
+
+          logger.debug { "Get entity done (ID: #{id.inspect}, Entity Class: #{entity.class}, Version: #{version.inspect}, Time: #{Clock.iso8601(time)})" }
+
+          return entity, version, time
+        end
+      end
+
+      module Put
+        def put(id, entity, version, time)
+          logger.trace { "Putting entity (ID: #{id.inspect}, Entity Class: #{entity.class}, Version: #{version.inspect}, Time: #{Clock.iso8601(time)})" }
+
+          return_value = super
+
+          telemetry.record(:put, Telemetry::Data.new(id, entity, version, time))
+
+          logger.debug { "Put entity done (ID: #{id.inspect}, Entity Class: #{entity.class}, Version: #{version.inspect}, Time: #{Clock.iso8601(time)})" }
+
+          return_value
+        end
+      end
+
+      module Build
+        def build(subject, session: nil)
+          instance = new(subject)
+          instance.configure(session: session)
+          instance
+        end
+      end
+
+      module RegisterTelemetrySink
+        def register_telemetry_sink(persistent_store)
+          sink = Telemetry::Sink.new
+          persistent_store.telemetry.register(sink)
+          sink
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: evt-entity_cache
 version: !ruby/object:Gem::Version
-  version: 0.14.0.0
+  version: 0.14.0.1
 platform: ruby
 authors:
 - The Eventide Project
@@ -101,11 +101,13 @@ files:
 - lib/entity_cache/controls/time.rb
 - lib/entity_cache/controls/version.rb
 - lib/entity_cache/defaults.rb
+- lib/entity_cache/entity_cache.rb
 - lib/entity_cache/log.rb
 - lib/entity_cache/record.rb
 - lib/entity_cache/record/destructure.rb
 - lib/entity_cache/record/log_text.rb
 - lib/entity_cache/record/transformer.rb
+- lib/entity_cache/store/persistent.rb
 - lib/entity_cache/store/persistent/null.rb
 - lib/entity_cache/store/persistent/substitute.rb
 - lib/entity_cache/store/persistent/telemetry.rb