cable_room 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 928184ed2b2f5a529bb24cccde6e0048f9c9f5a7ce2b60b62779bc8f06a998ca
-  data.tar.gz: 440782d877fbdc28948fe8499de860bb0d99c4bcde01b1abb933a23f20a14074
+  metadata.gz: e7c2fd48ac93d24a9ae68aae23aee05c3373d60154f54b0c7900e8863559fa89
+  data.tar.gz: 48f564bb727ed8cfd5932d9a07d7ac6f24d969ce5622bf87f8ff5766f44b17e7
 SHA512:
-  metadata.gz: 95047199ea82748e023d3ca246ba942cc4e5845613bd7f76f18c2700e027027f60277f904bc9f3cc5514f808ae7ca4d9305d051fdf40b00d6c280a5fc4e8aba0
-  data.tar.gz: 5e4e966735dffddf5c074776ea44702dd52b6cd5559a5b814f7d87a03c3fb58e7acfb3b0b7401452b67e9444d7e67d29352ae726c8ab4ba35353e5390495685b
+  metadata.gz: b2bc85c458cf22927817827dd5d742f68060d0dee82b50338dfd27a9c78c5fe465afb8dc10e086c40c5e8171154542c9e6c1f39c9c72ab10b77199c85bba5cb0
+  data.tar.gz: e7f45e327bee8df3ffb82ae510a805900cce03ad710a6ab2b1986b29d51adbaf4b118aa21be299f4f495267777cf37f26e14e6a043528554d9ce4a46092c73e8

data/lib/cable_room/channel_base.rb

@@ -105,6 +105,8 @@ module CableRoom
       @mutex.synchronize do
         return if @current_state == :dead || @current_state == :shutting_down
 
+        logger.info "Initiating shutdown: #{reason}"
+
         # Stop streams immediately to prevent further messages from being added
         stop_all_streams
 

data/lib/cable_room/channel_tracker.rb

@@ -75,8 +75,6 @@ module CableRoom
       end
     end
 
-    protected
-
     def each_room_channel(&blk)
       @room_channels.dup.each(&blk)
     end

data/lib/cable_room/railtie.rb

@@ -14,9 +14,18 @@ module CableRoom
     runner do
     end
 
-    initializer "cable_room.shutdown" do
-      Rails.application.reloader.before_class_unload do
-        CableRoom::ChannelTracker.instance.shutdown_rooms!
+    initializer "cable_room.hook_action_cable_restart" do
+      module ActionCableServerExtensions
+        def restart
+          CableRoom::ChannelTracker.instance.each_room_channel do |chan|
+            chan.unsubscribe_from_channel
+          end
+          super
+        end
+      end
+
+      ActiveSupport.on_load(:action_cable) do
+        ActionCable::Server::Base.prepend(ActionCableServerExtensions)
       end
     end
 

data/lib/cable_room/room/port_management.rb

@@ -25,6 +25,8 @@ module CableRoom
 
         define_callbacks :port_connected, :port_disconnected
 
+        on_port_connected { reply({type: 'port_acknowledged' }) }
+
         set_callback(:receive_message, :around) do |_, blk|
           previous_mtok = @current_message_origin
           begin

data/lib/cable_room/room/reaping.rb

@@ -52,7 +52,7 @@ module CableRoom
             false
           }
 
-          reaper_checkers << cfg
+          self.reaper_checkers = reaper_checkers + [cfg]
         end
       end
 

data/lib/cable_room/room_member.rb

@@ -53,58 +53,36 @@ module CableRoom
       room_class,
       room_key,
       create: false,
-      on_closed: nil,
-      on_opened: nil,
+      on_room_opened: nil, # Not guaranteed (Only given if the Room Opens while we are trying to connect to it)
+      on_joined: nil,
       on_message: nil,
+      on_room_closed: nil, # Not guaranteed (Only given if the Room Closes while we are connected to it)
+      on_left: nil,
       tags: [],
       extra: nil,
       &preconfigure
     )
-      @token = SecureRandom.hex(16)
+      @mutex = Monitor.new
+
       @has_left = false
+      @has_established = false
 
       @cable_channel = cable_channel
       @room_class = room_class
       @room_key = room_key
       @allow_create = create
 
-      @on_opened = on_opened
-      @on_closed = on_closed
+      @on_room_opened = on_room_opened
+      @on_joined = on_joined
       @on_message = on_message
+      @on_room_closed = on_room_closed
+      @on_left = on_left
+      @preconfigure = preconfigure
 
       @tags = Array(tags).map(&:to_sym)
       @extra = extra
 
-      @cable_channel._room_memberships << self
-
-      # Listen to public/broadcast channel
-      stream_port(room_class::ROOM_OUT_CHANNEL) do |message|
-        handle_received_message(message)
-      end
-
-      # Listen to private channel
-      stream_port(@token) do |message|
-        handle_received_message(message)
-      end
-
-      # Listen to user-specific channel
-      if extra && extra[:as]
-        stream_port(extra[:as]) do |message|
-          handle_received_message(message)
-        end
-      end
-
-      @tags.each do |tag|
-        stream_port(tag) do |message|
-          handle_received_message(message)
-        end
-      end
-
-      preconfigure&.call(self)
-
-      transmit_port_connected
-
-      maybe_provision_room
+      initiate_connection
     end
 
     delegate :logger, to: :@cable_channel
@@ -113,25 +91,41 @@ module CableRoom
       port_transmit(room_class::ROOM_IN_CHANNEL, data)
     end
 
+    def connected?
+      !left? && @has_established
+    end
+
     def left?
-      @has_left
+      @mutex.synchronize { @has_left }
     end
 
     def ping!
       return if left?
-
       port_transmit(room_class::ROOM_IN_CHANNEL, { type: 'port_ping' }, secure_context: true)
-      maybe_provision_room
+      @mutex.synchronize do
+        maybe_provision_room
+      end
     end
 
     def leave!
-      return if left?
+      @mutex.synchronize do
+        return if left?
 
-      close_streamed_ports!
-      @cable_channel._room_memberships.delete(self)
-      port_transmit(room_class::ROOM_IN_CHANNEL, { type: 'port_disconnected' }, secure_context: true)
-      @has_left = true
-      @on_closed&.call(self)
+        close_streamed_ports!
+        @cable_channel._room_memberships.delete(self)
+        port_transmit(room_class::ROOM_IN_CHANNEL, { type: 'port_disconnected' }, secure_context: true)
+        @has_left = true
+      end
+      @on_left&.call(self)
+    end
+
+    def rejoin!
+      @mutex.synchronize do
+        return unless left?
+
+        @has_left = false
+        initiate_connection
+      end
     end
 
     def key; @room_key; end
@@ -160,12 +154,15 @@ module CableRoom
       return leave! if message == "KILL"
 
       case message['type']
+      when 'port_acknowledged'
+        @has_established = true
+        @on_joined&.call(self)
       when 'room_opened'
         transmit_port_connected
-        @on_opened&.call(self)
+        @on_room_opened&.call(self)
       when 'room_closed'
-        @on_closed&.call(self)
-        maybe_provision_room
+        leave!
+        @on_room_closed&.call(self)
       else
         logger.warn "Unknown room message type: #{message['type'].inspect}" unless @on_message
       end
@@ -175,6 +172,45 @@ module CableRoom
 
     private
 
+    def initiate_connection
+      @mutex.synchronize do
+        return if left?
+
+        @token = SecureRandom.hex(16)
+        @has_established = false
+        @cable_channel._room_memberships << self
+
+        # Listen to public/broadcast channel
+        stream_port(room_class::ROOM_OUT_CHANNEL) do |message|
+          handle_received_message(message)
+        end
+
+        # Listen to private channel
+        stream_port(@token) do |message|
+          handle_received_message(message)
+        end
+
+        # Listen to user-specific channel
+        if @extra && @extra[:as]
+          stream_port(@extra[:as]) do |message|
+            handle_received_message(message)
+          end
+        end
+
+        @tags.each do |tag|
+          stream_port(tag) do |message|
+            handle_received_message(message)
+          end
+        end
+
+        @preconfigure&.call(self)
+
+        transmit_port_connected
+
+        maybe_provision_room
+      end
+    end
+
     def transmit_port_connected
       msg = {
         type: 'port_connected',

data/lib/cable_room/room_proxy_channel.rb

@@ -0,0 +1,35 @@
+module CableRoom
+  module RoomProxyChannel
+    extend ActiveSupport::Concern
+    include CableRoom::RoomMember
+
+    class_methods do
+      def subscribe_to_room(&blk)
+        define_method(:subscribe_to_room, &blk)
+      end
+    end
+
+    def subscribed
+      @room_membership = subscribe_to_room
+    end
+
+    def receive(data)
+      @room_membership << data if @room_membership&.connected?
+    end
+
+    def unsubscribed
+      @room_membership&.leave!
+    end
+
+    protected
+
+    def subscribe_to_room
+      raise NotImplementedError
+    end
+
+    def join_room(*args, **kwargs, &blk)
+      kwargs[:forward] = true
+      super
+    end
+  end
+end

data/lib/cable_room/version.rb

@@ -1,3 +1,3 @@
 module CableRoom
-  VERSION = "0.4.4".freeze
+  VERSION = "0.5.0".freeze
 end

data/lib/cable_room.rb

@@ -13,6 +13,7 @@ require_relative 'cable_room/channel_base'
 require_relative 'cable_room/channel_tracker'
 require_relative 'cable_room/ports'
 require_relative 'cable_room/room_member'
+require_relative 'cable_room/room_proxy_channel'
 require_relative 'cable_room/room/'
 require_relative 'cable_room/version'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cable_room
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Ethan Knapp
@@ -126,6 +126,7 @@ files:
 - lib/cable_room/room/threading.rb
 - lib/cable_room/room/user_management.rb
 - lib/cable_room/room_member.rb
+- lib/cable_room/room_proxy_channel.rb
 - lib/cable_room/version.rb
 - spec/cable_room/room_member_spec.rb
 - spec/internal/config/cable.yml