pgbus 0.17.2 → 0.17.3

data/lib/pgbus/web/streamer/presence_tracker.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+module Pgbus
+  module Web
+    module Streamer
+      # Connection-driven presence (issues #169, #515), run on the
+      # StreamEventDispatcher thread, which owns AR connection release.
+      #
+      # On a seat table (Pgbus::Streams::Presence.seats_supported?) every SSE
+      # connection is its own row, keyed by connection id and carrying the
+      # client's seat; two tabs of one member are two rows. On an older
+      # table it falls back to one member-keyed row, as before.
+      #
+      # The heartbeat posts a PresenceTouchMessage each tick; #touch refreshes
+      # the live seats, re-joins any whose row was expired while the
+      # connection stayed open, and expires silent seats across all streams
+      # (rows of crashed processes included) at most every min_ttl / 2 after
+      # a successful sweep.
+      #
+      # Each connection remembers whether it joined as a seat or as a
+      # member-keyed row, so a table migrated while it is open still has
+      # its row removed on leave (and converted to a seat on the next touch).
+      #
+      # Every failure is logged and swallowed: a presence DB hiccup must not
+      # knock a live SSE connection out of the registry.
+      class PresenceTracker
+        def initialize(config:, presence_provider:, logger:, sweeper: nil, clock: nil)
+          @config = config
+          @presence_provider = presence_provider
+          @logger = logger
+          @sweeper = sweeper || method(:expire_seats)
+          @clock = clock || -> { ::Process.clock_gettime(::Process::CLOCK_MONOTONIC) }
+          @last_sweep_at = nil
+        end
+
+        def join(connection, stream = connection.stream_name)
+          return unless @config&.stream_presence?(stream)
+
+          member = @config.presence_member_for(connection.context)
+          return unless member
+
+          presence = @presence_provider.call(stream)
+          seat = seats?(presence)
+          join_member(presence, connection, member, seat)
+          connection.presence_member = member[:id] if connection.respond_to?(:presence_member=)
+          connection.presence_seat = seat if connection.respond_to?(:presence_seat=)
+        rescue StandardError => e
+          log_failure("join", e)
+        end
+
+        def leave(connection, stream = connection.stream_name)
+          member_id = presence_member_of(connection)
+          return unless member_id
+
+          # Cleared first: a heartbeat touch already queued behind this
+          # disconnect must not re-join the seat it removes.
+          connection.presence_member = nil if connection.respond_to?(:presence_member=)
+          presence = @presence_provider.call(stream)
+          if joined_as_seat?(connection, presence)
+            presence.leave(connection_id: connection.id)
+          else
+            presence.leave(member_id: member_id)
+          end
+        rescue StandardError => e
+          log_failure("leave", e)
+        end
+
+        def touch(connections)
+          connections.select { |conn| presence_member_of(conn) }.group_by(&:stream_name).each do |stream, conns|
+            touch_stream(stream, conns)
+          rescue StandardError => e
+            log_failure("touch", e)
+          end
+          sweep_if_due
+        end
+
+        private
+
+        def join_member(presence, connection, member, seat)
+          metadata = member[:metadata] || {}
+          if seat
+            presence.join(member_id: member[:id], metadata: metadata,
+                          connection_id: connection.id, seat: seat_of(connection))
+          else
+            presence.join(member_id: member[:id], metadata: metadata)
+          end
+        end
+
+        def touch_stream(stream, conns)
+          presence = @presence_provider.call(stream)
+          unless seats?(presence)
+            conns.each { |conn| presence.touch(member_id: presence_member_of(conn)) }
+            return
+          end
+
+          live = presence.touch(connection_id: conns.map(&:id))
+          conns.reject { |conn| live.include?(conn.id) }.each { |conn| rejoin_as_seat(presence, conn, stream) }
+        end
+
+        # A connection that joined as a member-keyed row before the table
+        # was migrated drops that row before it takes a seat.
+        def rejoin_as_seat(presence, connection, stream)
+          presence.leave(member_id: presence_member_of(connection)) unless joined_as_seat?(connection, presence)
+          join(connection, stream)
+        end
+
+        def sweep_if_due
+          return if Array(@config.streams_presence_patterns).empty?
+
+          at = now
+          return if @last_sweep_at && at - @last_sweep_at < @config.presence_min_ttl / 2.0
+
+          @sweeper.call
+          @last_sweep_at = at
+        rescue StandardError => e
+          log_failure("expiry", e)
+        end
+
+        def expire_seats
+          Pgbus::Streams::Presence.expire_seats!(
+            ttl_for: ->(stream) { @config.presence_ttl_for(stream) }, min_ttl: @config.presence_min_ttl
+          )
+        end
+
+        def seats?(presence)
+          presence.respond_to?(:seats?) && presence.seats?
+        end
+
+        # The mode recorded at join; a connection without the accessor
+        # follows the table's current schema.
+        def joined_as_seat?(connection, presence)
+          return connection.presence_seat if connection.respond_to?(:presence_seat)
+
+          seats?(presence)
+        end
+
+        def seat_of(connection)
+          connection.respond_to?(:seat) ? connection.seat : nil
+        end
+
+        def presence_member_of(connection)
+          connection.respond_to?(:presence_member) ? connection.presence_member : nil
+        end
+
+        def now
+          @clock.call
+        end
+
+        def log_failure(action, error)
+          @logger.error { "[Pgbus::Streamer::PresenceTracker] presence #{action} failed: #{error.class}: #{error.message}" }
+        end
+      end
+    end
+  end
+end

data/lib/pgbus/web/streamer/stream_event_dispatcher.rb

@@ -105,6 +105,7 @@ module Pgbus
           # process-wide setting. Falls back to the global config
           # for production call sites that don't specify one.
           @config = config || Pgbus.configuration
+          @presence = PresenceTracker.new(config: @config, presence_provider: @presence_provider, logger: @logger)
           # Two write deadlines (issue #315 item 3). Fanout writes run serially
           # on this single thread, so a slow client stalls the connections
           # queued behind it — the short fanout deadline bounds that stall.
@@ -436,19 +437,11 @@ module Pgbus
           )
         end
 
-        # Touches (refreshes last_seen_at for) the presence members on the
-        # given connections. Posted by the Heartbeat each tick so idle but
-        # still-connected members don't get swept. Connections without a
-        # presence member (non-presence streams, anonymous) are skipped.
+        # Touches the presence rows of the given connections and expires
+        # silent seats. Posted by the Heartbeat each tick so idle but
+        # still-connected members don't get swept (see PresenceTracker).
         def handle_presence_touch(msg)
-          msg.connections.each do |connection|
-            member_id = presence_member_of(connection)
-            next unless member_id
-
-            @presence_provider.call(connection.stream_name).touch(member_id: member_id)
-          rescue StandardError => e
-            @logger.error { "[Pgbus::Streamer::StreamEventDispatcher] presence touch failed: #{e.class}: #{e.message}" }
-          end
+          @presence.touch(msg.connections)
         end
 
         # If this stream has no remaining subscribers (registered or
@@ -640,35 +633,13 @@ module Pgbus
           connection.respond_to?(:id) && connection.id.to_s == exclude.to_s
         end
 
-        # Connection-driven presence (issue #169). Auto-joins a member when
-        # the stream is configured for presence and the connection's
-        # authorize-context yields a member id. Stores the member id on the
-        # connection so handle_disconnect/handle_presence_touch can act on
-        # it. Failures are logged and swallowed: a presence DB hiccup must
-        # not knock a live SSE connection out of the registry.
+        # Connection-driven presence (issues #169, #515): see PresenceTracker.
         def presence_join(connection, stream)
-          return unless @config&.stream_presence?(stream)
-
-          member = @config.presence_member_for(connection.context)
-          return unless member
-
-          @presence_provider.call(stream).join(member_id: member[:id], metadata: member[:metadata] || {})
-          connection.presence_member = member[:id] if connection.respond_to?(:presence_member=)
-        rescue StandardError => e
-          @logger.error { "[Pgbus::Streamer::StreamEventDispatcher] presence join failed: #{e.class}: #{e.message}" }
+          @presence.join(connection, stream)
         end
 
         def presence_leave(connection, stream)
-          member_id = presence_member_of(connection)
-          return unless member_id
-
-          @presence_provider.call(stream).leave(member_id: member_id)
-        rescue StandardError => e
-          @logger.error { "[Pgbus::Streamer::StreamEventDispatcher] presence leave failed: #{e.class}: #{e.message}" }
-        end
-
-        def presence_member_of(connection)
-          connection.respond_to?(:presence_member) ? connection.presence_member : nil
+          @presence.leave(connection, stream)
         end
 
         def monotonic_ms

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pgbus
 version: !ruby/object:Gem::Version
-  version: 0.17.2
+  version: 0.17.3
 platform: ruby
 authors:
 - Mikael Henriksson
@@ -123,6 +123,8 @@ files:
 - README.md
 - Rakefile
 - app/assets/javascripts/pgbus/stream_source_element.js
+- app/assets/javascripts/pgbus/stream_source_element.min.js
+- app/assets/javascripts/pgbus/stream_source_element.min.js.map
 - app/controllers/concerns/pgbus/job_listing.rb
 - app/controllers/concerns/pgbus/process_listing.rb
 - app/controllers/pgbus/api/insights_controller.rb
@@ -143,11 +145,17 @@ files:
 - app/controllers/pgbus/queues_controller.rb
 - app/controllers/pgbus/recurring_tasks_controller.rb
 - app/frontend/pgbus/application.js
+- app/frontend/pgbus/application.min.js
+- app/frontend/pgbus/application.min.js.map
 - app/frontend/pgbus/modules/charts.js
+- app/frontend/pgbus/modules/charts.min.js
+- app/frontend/pgbus/modules/charts.min.js.map
 - app/frontend/pgbus/style.css
 - app/frontend/pgbus/tailwind.css
 - app/frontend/pgbus/vendor/apexcharts.js
 - app/frontend/pgbus/vendor/turbo.js
+- app/frontend/pgbus/vendor/turbo.min.js
+- app/frontend/pgbus/vendor/turbo.min.js.map
 - app/helpers/pgbus/application_helper.rb
 - app/helpers/pgbus/button_helper.rb
 - app/helpers/pgbus/dashboard_helper.rb
@@ -244,6 +252,7 @@ files:
 - lib/generators/pgbus/add_job_stats_queue_index_generator.rb
 - lib/generators/pgbus/add_outbox_generator.rb
 - lib/generators/pgbus/add_presence_generator.rb
+- lib/generators/pgbus/add_presence_seats_generator.rb
 - lib/generators/pgbus/add_processed_event_completion_generator.rb
 - lib/generators/pgbus/add_queue_states_generator.rb
 - lib/generators/pgbus/add_recurring_generator.rb
@@ -261,6 +270,7 @@ files:
 - lib/generators/pgbus/templates/add_job_stats_queue_index.rb.erb
 - lib/generators/pgbus/templates/add_outbox.rb.erb
 - lib/generators/pgbus/templates/add_presence.rb.erb
+- lib/generators/pgbus/templates/add_presence_seats.rb.erb
 - lib/generators/pgbus/templates/add_processed_event_completion.rb.erb
 - lib/generators/pgbus/templates/add_queue_states.rb.erb
 - lib/generators/pgbus/templates/add_recurring_tables.rb.erb
@@ -305,6 +315,7 @@ files:
 - lib/pgbus/concurrency/semaphore.rb
 - lib/pgbus/configuration.rb
 - lib/pgbus/configuration/capsule_dsl.rb
+- lib/pgbus/configuration/presence_settings.rb
 - lib/pgbus/current_attributes.rb
 - lib/pgbus/database_tasks_guard.rb
 - lib/pgbus/dead_letter_header.rb
@@ -466,6 +477,7 @@ files:
 - lib/pgbus/web/streamer/master_hub.rb
 - lib/pgbus/web/streamer/master_hub_boot.rb
 - lib/pgbus/web/streamer/outbound_pump.rb
+- lib/pgbus/web/streamer/presence_tracker.rb
 - lib/pgbus/web/streamer/registry.rb
 - lib/pgbus/web/streamer/stream_counter.rb
 - lib/pgbus/web/streamer/stream_event_dispatcher.rb