upkeep-rails 0.1.9 → 0.1.12

data/lib/upkeep/subscriptions/store.rb

@@ -4,6 +4,8 @@ require "securerandom"
 require "time"
 require "active_support/notifications"
 require_relative "active_registry"
+require_relative "base_store"
+require_relative "lookup_instrumentation"
 
 module Upkeep
   module Subscriptions
@@ -123,24 +125,15 @@ module Upkeep
     end
 
     class MemoryReverseIndex
-      LOOKUP_NOTIFICATION = "lookup_subscription_index.upkeep"
+      include LookupInstrumentation
+
+      LOOKUP_NOTIFICATION = LookupInstrumentation::LOOKUP_NOTIFICATION
 
       def initialize(active_registry:, pending_registry:)
         @active_registry = active_registry
         @pending_registry = pending_registry
       end
 
-      def entries_for(changes)
-        if ActiveSupport::Notifications.notifier.listening?(LOOKUP_NOTIFICATION)
-          payload = { changes: Array(changes).size, store: "memory" }
-          ActiveSupport::Notifications.instrument(LOOKUP_NOTIFICATION, payload) do
-            entries_for_with_payload(changes, payload)
-          end
-        else
-          active_registry.entries_for(changes)
-        end
-      end
-
       def summary
         active_registry.summary
       end
@@ -149,6 +142,14 @@ module Upkeep
 
       attr_reader :active_registry, :pending_registry
 
+      def lookup_store
+        "memory"
+      end
+
+      def entries_for_without_payload(changes)
+        active_registry.entries_for(changes)
+      end
+
       def entries_for_with_payload(changes, payload)
         active_entries = active_registry.entries_for(changes)
         pending_entries = pending_registry.entries_for(changes)
@@ -173,13 +174,9 @@ module Upkeep
 
         active_entries
       end
-
-      def miss_reason(pending_entries)
-        pending_entries.any? ? "not_activated_yet" : "no_matching_subscriber"
-      end
     end
 
-    class Store
+    class Store < BaseStore
       PERSIST_NOTIFICATION = "persist_subscription_store.upkeep"
 
       attr_reader :reverse_index
@@ -193,69 +190,34 @@ module Upkeep
       end
 
       def register(subscriber_id:, recorder:, metadata: {}, entries: nil)
-        if ActiveSupport::Notifications.notifier.listening?(PERSIST_NOTIFICATION)
-          payload = memory_persist_payload(operation: :persist_subscription)
-          ActiveSupport::Notifications.instrument(PERSIST_NOTIFICATION, payload) do
-            register_subscription(subscriber_id: subscriber_id, recorder: recorder, metadata: metadata, entries: entries, payload: payload)
-          end
-        else
-          register_subscription(subscriber_id: subscriber_id, recorder: recorder, metadata: metadata, entries: entries)
+        subscription = with_optional_notification(PERSIST_NOTIFICATION, memory_persist_payload(operation: :persist_subscription)) do |payload|
+          register_subscription(subscriber_id: subscriber_id, recorder: recorder, metadata: metadata, entries: entries, payload: payload)
         end
+        trim_opportunistically
+        subscription
       end
 
-      def touch(id, now: Time.now)
-        fetch(id)
-        metadata = { "last_seen_at" => now.utc.iso8601 }
-        pending_registry.touch(id, metadata: metadata)
-        active_registry.touch(id, metadata: metadata)
-        true
-      end
-
-      def prune_stale!(older_than:)
+      def prune_stale!(older_than: stale_threshold, limit: nil)
         stale_ids = subscriptions.filter_map do |subscription|
           id = subscription.id
           id if last_seen_at(subscription) && last_seen_at(subscription) < older_than
         end
+        stale_ids = stale_ids.first(limit) if limit
 
         unregister(stale_ids)
         stale_ids.size
       end
 
-      def unregister(ids)
-        ids = Array(ids)
-        ids.each { |id| @pending_index_entries.delete(id) }
-        pending_registry.unregister(ids)
-        active_registry.unregister(ids)
-        ids.size
-      end
-
       def activate(id)
-        if ActiveSupport::Notifications.notifier.listening?(PERSIST_NOTIFICATION)
-          payload = memory_persist_payload(operation: :persist_index)
-          ActiveSupport::Notifications.instrument(PERSIST_NOTIFICATION, payload) do
-            activate_subscription(id, payload: payload)
-          end
-        else
-          activate_subscription(id)
+        with_optional_notification(PERSIST_NOTIFICATION, memory_persist_payload(operation: :persist_index)) do |payload|
+          activate_subscription(id, payload: payload)
         end
       end
 
-      def drain
-        true
-      end
-
       def shutdown
         true
       end
 
-      def fetch(id)
-        active_registry.fetch(id) || pending_registry.fetch(id) || raise(NotFound, id)
-      end
-
-      def explain(id)
-        fetch(id).explain
-      end
-
       def subscriptions
         active_registry.subscriptions + pending_registry.subscriptions
       end
@@ -289,6 +251,22 @@ module Upkeep
 
       attr_reader :pending_registry, :active_registry
 
+      def after_touch(id, metadata:, now:)
+        true
+      end
+
+      def store_label
+        "memory"
+      end
+
+      def before_unregister(ids)
+        ids.each { |id| @pending_index_entries.delete(id) }
+      end
+
+      def fetch_missing(id)
+        raise NotFound, id
+      end
+
       def register_subscription(subscriber_id:, recorder:, metadata: {}, entries: nil, payload: nil)
         recorder.flush_pending_dependencies if recorder.respond_to?(:flush_pending_dependencies)
         subscription = Subscription.new(
@@ -366,10 +344,6 @@ module Upkeep
         value = subscription.metadata["last_seen_at"] || subscription.metadata[:last_seen_at]
         Time.parse(value.to_s) if value
       end
-
-      def next_subscription_id
-        "subscription-#{SecureRandom.uuid}"
-      end
     end
   end
 end

data/lib/upkeep/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Upkeep
-  VERSION = "0.1.9"
+  VERSION = "0.1.12"
 end

data/upkeep-rails.gemspec

@@ -44,7 +44,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "actionview", ">= 7.1", "< 9.0"
   spec.add_dependency "actionpack", ">= 7.1", "< 9.0"
   spec.add_dependency "actioncable", ">= 7.1", "< 9.0"
-  spec.add_dependency "activejob", ">= 7.1", "< 9.0"
   spec.add_dependency "activerecord", ">= 7.1", "< 9.0"
   spec.add_dependency "activesupport", ">= 7.1", "< 9.0"
   spec.add_dependency "herb", ">= 0.10.1", "< 0.11"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: upkeep-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.12
 platform: ruby
 authors:
 - Felipe dos Anjos
@@ -69,26 +69,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '9.0'
-- !ruby/object:Gem::Dependency
-  name: activejob
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '7.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '9.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '7.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -219,6 +199,8 @@ extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
+- docs/drafts/turbo-streams-is-cache-invalidation-you-write-by-hand.md
+- docs/handoffs/_archive/2026-06-10-main.md
 - docs/how-it-works.md
 - lib/generators/upkeep/install/install_generator.rb
 - lib/generators/upkeep/install/templates/create_upkeep_subscriptions.rb.erb
@@ -255,9 +237,9 @@ files:
 - lib/upkeep/rails/cable/channel.rb
 - lib/upkeep/rails/cable/subscriber_identity.rb
 - lib/upkeep/rails/client_subscription.rb
+- lib/upkeep/rails/cluster_guard.rb
 - lib/upkeep/rails/configuration.rb
 - lib/upkeep/rails/controller_runtime.rb
-- lib/upkeep/rails/delivery_job.rb
 - lib/upkeep/rails/install.rb
 - lib/upkeep/rails/railtie.rb
 - lib/upkeep/rails/replay.rb
@@ -269,9 +251,10 @@ files:
 - lib/upkeep/subscriptions/active_record_store.rb
 - lib/upkeep/subscriptions/active_record_subscription_persistence.rb
 - lib/upkeep/subscriptions/active_registry.rb
-- lib/upkeep/subscriptions/async_durable_writer.rb
+- lib/upkeep/subscriptions/base_store.rb
 - lib/upkeep/subscriptions/json_snapshot.rb
 - lib/upkeep/subscriptions/layered_reverse_index.rb
+- lib/upkeep/subscriptions/lookup_instrumentation.rb
 - lib/upkeep/subscriptions/persistent_reverse_index.rb
 - lib/upkeep/subscriptions/registrar.rb
 - lib/upkeep/subscriptions/reverse_index.rb
@@ -285,7 +268,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/fc-anjos/upkeep-rails
-  source_code_uri: https://github.com/fc-anjos/upkeep-rails/tree/v0.1.9
+  source_code_uri: https://github.com/fc-anjos/upkeep-rails/tree/v0.1.12
   bug_tracker_uri: https://github.com/fc-anjos/upkeep-rails/issues
   rubygems_mfa_required: 'true'
 rdoc_options: []

data/lib/upkeep/rails/delivery_job.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require "active_job"
-
-module Upkeep
-  module Rails
-    class DeliveryJob < ::ActiveJob::Base
-      queue_as { Upkeep::Rails.configuration.delivery_queue }
-
-      def perform(changes)
-        Upkeep::Rails.deliver_changes_now!(normalize_changes(changes))
-      end
-
-      private
-
-      def normalize_changes(changes)
-        Array(changes).map { |change| normalize_change(change) }
-      end
-
-      def normalize_change(change)
-        return change unless change.respond_to?(:to_h)
-
-        change.to_h.transform_keys do |key|
-          key.respond_to?(:to_sym) ? key.to_sym : key
-        end
-      end
-    end
-  end
-end

data/lib/upkeep/subscriptions/async_durable_writer.rb

@@ -1,131 +0,0 @@
-# frozen_string_literal: true
-
-module Upkeep
-  module Subscriptions
-    class AsyncDurableWriter
-      DEFAULT_BATCH_SIZE = 100
-      DEFAULT_FLUSH_INTERVAL = 1.0
-      Job = Data.define(:subscription, :entries, :operation)
-
-      def initialize(batch_size: DEFAULT_BATCH_SIZE, flush_interval: DEFAULT_FLUSH_INTERVAL, &persist_batch)
-        @batch_size = batch_size
-        @flush_interval = flush_interval
-        @persist_batch = persist_batch
-        @mutex = Mutex.new
-        @available = ConditionVariable.new
-        @drained = ConditionVariable.new
-        @queue = []
-        @pending = 0
-        @inflight_ids = Hash.new(0)
-        @closed = false
-        @flush_now = false
-        @errors = []
-        @worker = Thread.new { work_loop }
-        @worker.name = "upkeep-durable-writer" if @worker.respond_to?(:name=)
-      end
-
-      def enqueue(subscription, entries:, operation:)
-        @mutex.synchronize do
-          raise IOError, "Upkeep durable writer is closed" if @closed
-
-          @queue << Job.new(subscription, entries, operation)
-          @pending += 1
-          @available.signal
-        end
-      end
-
-      def cancel(ids)
-        ids = Array(ids)
-        return [] if ids.empty?
-
-        requested_ids = ids.to_h { |id| [id, true] }
-
-        @mutex.synchronize do
-          removed = 0
-          @queue.delete_if do |job|
-            id = job.subscription.id
-            requested_ids.key?(id).tap do |matched|
-              removed += 1 if matched
-            end
-          end
-          @pending -= removed
-          @drained.broadcast if @pending.zero?
-          @drained.wait(@mutex) while ids.any? { |id| @inflight_ids.fetch(id, 0).positive? }
-          ids
-        end
-      end
-
-      def drain(raise_errors: true)
-        errors = @mutex.synchronize do
-          @flush_now = true
-          @available.broadcast
-          @drained.wait(@mutex) while @pending.positive?
-          drained_errors = @errors
-          @errors = [] if raise_errors
-          drained_errors
-        end
-
-        raise errors.first if raise_errors && errors.any?
-
-        errors
-      end
-
-      def shutdown
-        drain(raise_errors: false)
-        @mutex.synchronize do
-          @closed = true
-          @available.broadcast
-        end
-        @worker.join
-      end
-
-      private
-
-      def work_loop
-        loop do
-          batch = next_batch
-          break unless batch
-
-          begin
-            @persist_batch.call(batch)
-          rescue StandardError => error
-            @mutex.synchronize { @errors << error }
-          ensure
-            @mutex.synchronize do
-              batch.each do |job|
-                id = job.subscription.id
-                @inflight_ids[id] -= 1
-                @inflight_ids.delete(id) unless @inflight_ids[id].positive?
-              end
-              @pending -= batch.size
-              @drained.broadcast if @pending.zero?
-            end
-          end
-        end
-      end
-
-      def next_batch
-        @mutex.synchronize do
-          @available.wait(@mutex) while @queue.empty? && !@closed
-          return nil if @queue.empty? && @closed
-
-          wait_for_batch_fill
-          @flush_now = false
-          @queue.shift(@batch_size).tap do |batch|
-            batch.each { |job| @inflight_ids[job.subscription.id] += 1 }
-          end
-        end
-      end
-
-      def wait_for_batch_fill
-        deadline = Process.clock_gettime(Process::CLOCK_MONOTONIC) + @flush_interval
-        while @queue.size < @batch_size && !@closed && !@flush_now
-          remaining = deadline - Process.clock_gettime(Process::CLOCK_MONOTONIC)
-          break unless remaining.positive?
-
-          @available.wait(@mutex, remaining)
-        end
-      end
-    end
-  end
-end