actioncable 5.2.6.2 → 6.0.0.beta1

data/lib/action_cable/server/base.rb

@@ -36,7 +36,9 @@ module ActionCable
       end
 
       def restart
-        connections.each(&:close)
+        connections.each do |connection|
+          connection.close(reason: ActionCable::INTERNAL[:disconnect_reasons][:server_restart])
+        end
 
         @mutex.synchronize do
           # Shutdown the worker pool

data/lib/action_cable/server/worker.rb

@@ -56,14 +56,12 @@ module ActionCable
 
       def invoke(receiver, method, *args, connection:, &block)
         work(connection) do
-          begin
-            receiver.send method, *args, &block
-          rescue Exception => e
-            logger.error "There was an exception - #{e.class}(#{e.message})"
-            logger.error e.backtrace.join("\n")
+          receiver.send method, *args, &block
+        rescue Exception => e
+          logger.error "There was an exception - #{e.class}(#{e.message})"
+          logger.error e.backtrace.join("\n")
 
-            receiver.handle_exception if receiver.respond_to?(:handle_exception)
-          end
+          receiver.handle_exception if receiver.respond_to?(:handle_exception)
         end
       end
 

data/lib/action_cable/subscription_adapter/postgresql.rb

@@ -14,7 +14,7 @@ module ActionCable
       end
 
       def broadcast(channel, payload)
-        with_connection do |pg_conn|
+        with_broadcast_connection do |pg_conn|
           pg_conn.exec("NOTIFY #{pg_conn.escape_identifier(channel_identifier(channel))}, '#{pg_conn.escape_string(payload)}'")
         end
       end
@@ -31,14 +31,24 @@ module ActionCable
         listener.shutdown
       end
 
-      def with_connection(&block) # :nodoc:
-        ActiveRecord::Base.connection_pool.with_connection do |ar_conn|
-          pg_conn = ar_conn.raw_connection
+      def with_subscriptions_connection(&block) # :nodoc:
+        ar_conn = ActiveRecord::Base.connection_pool.checkout.tap do |conn|
+          # Action Cable is taking ownership over this database connection, and
+          # will perform the necessary cleanup tasks
+          ActiveRecord::Base.connection_pool.remove(conn)
+        end
+        pg_conn = ar_conn.raw_connection
 
-          unless pg_conn.is_a?(PG::Connection)
-            raise "The Active Record database must be PostgreSQL in order to use the PostgreSQL Action Cable storage adapter"
-          end
+        verify!(pg_conn)
+        yield pg_conn
+      ensure
+        ar_conn.disconnect!
+      end
 
+      def with_broadcast_connection(&block) # :nodoc:
+        ActiveRecord::Base.connection_pool.with_connection do |ar_conn|
+          pg_conn = ar_conn.raw_connection
+          verify!(pg_conn)
           yield pg_conn
         end
       end
@@ -52,6 +62,12 @@ module ActionCable
           @listener || @server.mutex.synchronize { @listener ||= Listener.new(self, @server.event_loop) }
         end
 
+        def verify!(pg_conn)
+          unless pg_conn.is_a?(PG::Connection)
+            raise "The Active Record database must be PostgreSQL in order to use the PostgreSQL Action Cable storage adapter"
+          end
+        end
+
         class Listener < SubscriberMap
           def initialize(adapter, event_loop)
             super()
@@ -67,7 +83,7 @@ module ActionCable
           end
 
           def listen
-            @adapter.with_connection do |pg_conn|
+            @adapter.with_subscriptions_connection do |pg_conn|
               catch :shutdown do
                 loop do
                   until @queue.empty?

data/lib/action_cable/subscription_adapter/redis.rb

@@ -13,7 +13,8 @@ module ActionCable
       # Overwrite this factory method for Redis connections if you want to use a different Redis library than the redis gem.
       # This is needed, for example, when using Makara proxies for distributed Redis.
       cattr_accessor :redis_connector, default: ->(config) do
-        ::Redis.new(config.slice(:url, :host, :port, :db, :password))
+        config[:id] ||= "ActionCable-PID-#{$$}"
+        ::Redis.new(config.slice(:url, :host, :port, :db, :password, :id))
       end
 
       def initialize(*)

data/lib/action_cable/subscription_adapter/test.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "async"
+
+module ActionCable
+  module SubscriptionAdapter
+    # == Test adapter for Action Cable
+    #
+    # The test adapter should be used only in testing. Along with
+    # <tt>ActionCable::TestHelper</tt> it makes a great tool to test your Rails application.
+    #
+    # To use the test adapter set +adapter+ value to +test+ in your +config/cable.yml+ file.
+    #
+    # NOTE: Test adapter extends the <tt>ActionCable::SubscriptionsAdapter::Async</tt> adapter,
+    # so it could be used in system tests too.
+    class Test < Async
+      def broadcast(channel, payload)
+        broadcasts(channel) << payload
+        super
+      end
+
+      def broadcasts(channel)
+        channels_data[channel] ||= []
+      end
+
+      def clear_messages(channel)
+        channels_data[channel] = []
+      end
+
+      def clear
+        @channels_data = nil
+      end
+
+      private
+        def channels_data
+          @channels_data ||= {}
+        end
+    end
+  end
+end

data/lib/action_cable/subscription_adapter.rb

@@ -5,6 +5,7 @@ module ActionCable
     extend ActiveSupport::Autoload
 
     autoload :Base
+    autoload :Test
     autoload :SubscriberMap
     autoload :ChannelPrefix
   end

data/lib/action_cable/test_case.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "active_support/test_case"
+
+module ActionCable
+  class TestCase < ActiveSupport::TestCase
+    include ActionCable::TestHelper
+
+    ActiveSupport.run_load_hooks(:action_cable_test_case, self)
+  end
+end

data/lib/action_cable/test_helper.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+module ActionCable
+  # Provides helper methods for testing Action Cable broadcasting
+  module TestHelper
+    def before_setup # :nodoc:
+      server = ActionCable.server
+      test_adapter = ActionCable::SubscriptionAdapter::Test.new(server)
+
+      @old_pubsub_adapter = server.pubsub
+
+      server.instance_variable_set(:@pubsub, test_adapter)
+      super
+    end
+
+    def after_teardown # :nodoc:
+      super
+      ActionCable.server.instance_variable_set(:@pubsub, @old_pubsub_adapter)
+    end
+
+    # Asserts that the number of broadcasted messages to the stream matches the given number.
+    #
+    #   def test_broadcasts
+    #     assert_broadcasts 'messages', 0
+    #     ActionCable.server.broadcast 'messages', { text: 'hello' }
+    #     assert_broadcasts 'messages', 1
+    #     ActionCable.server.broadcast 'messages', { text: 'world' }
+    #     assert_broadcasts 'messages', 2
+    #   end
+    #
+    # If a block is passed, that block should cause the specified number of
+    # messages to be broadcasted.
+    #
+    #   def test_broadcasts_again
+    #     assert_broadcasts('messages', 1) do
+    #       ActionCable.server.broadcast 'messages', { text: 'hello' }
+    #     end
+    #
+    #     assert_broadcasts('messages', 2) do
+    #       ActionCable.server.broadcast 'messages', { text: 'hi' }
+    #       ActionCable.server.broadcast 'messages', { text: 'how are you?' }
+    #     end
+    #   end
+    #
+    def assert_broadcasts(stream, number)
+      if block_given?
+        original_count = broadcasts_size(stream)
+        yield
+        new_count = broadcasts_size(stream)
+        actual_count = new_count - original_count
+      else
+        actual_count = broadcasts_size(stream)
+      end
+
+      assert_equal number, actual_count, "#{number} broadcasts to #{stream} expected, but #{actual_count} were sent"
+    end
+
+    # Asserts that no messages have been sent to the stream.
+    #
+    #   def test_no_broadcasts
+    #     assert_no_broadcasts 'messages'
+    #     ActionCable.server.broadcast 'messages', { text: 'hi' }
+    #     assert_broadcasts 'messages', 1
+    #   end
+    #
+    # If a block is passed, that block should not cause any message to be sent.
+    #
+    #   def test_broadcasts_again
+    #     assert_no_broadcasts 'messages' do
+    #       # No job messages should be sent from this block
+    #     end
+    #   end
+    #
+    # Note: This assertion is simply a shortcut for:
+    #
+    #   assert_broadcasts 'messages', 0, &block
+    #
+    def assert_no_broadcasts(stream, &block)
+      assert_broadcasts stream, 0, &block
+    end
+
+    # Asserts that the specified message has been sent to the stream.
+    #
+    #   def test_assert_transmitted_message
+    #     ActionCable.server.broadcast 'messages', text: 'hello'
+    #     assert_broadcast_on('messages', text: 'hello')
+    #   end
+    #
+    # If a block is passed, that block should cause a message with the specified data to be sent.
+    #
+    #   def test_assert_broadcast_on_again
+    #     assert_broadcast_on('messages', text: 'hello') do
+    #       ActionCable.server.broadcast 'messages', text: 'hello'
+    #     end
+    #   end
+    #
+    def assert_broadcast_on(stream, data)
+      # Encode to JSON and back–we want to use this value to compare
+      # with decoded JSON.
+      # Comparing JSON strings doesn't work due to the order if the keys.
+      serialized_msg =
+        ActiveSupport::JSON.decode(ActiveSupport::JSON.encode(data))
+
+      new_messages = broadcasts(stream)
+      if block_given?
+        old_messages = new_messages
+        clear_messages(stream)
+
+        yield
+        new_messages = broadcasts(stream)
+        clear_messages(stream)
+
+        # Restore all sent messages
+        (old_messages + new_messages).each { |m| pubsub_adapter.broadcast(stream, m) }
+      end
+
+      message = new_messages.find { |msg| ActiveSupport::JSON.decode(msg) == serialized_msg }
+
+      assert message, "No messages sent with #{data} to #{stream}"
+    end
+
+    def pubsub_adapter # :nodoc:
+      ActionCable.server.pubsub
+    end
+
+    delegate :broadcasts, :clear_messages, to: :pubsub_adapter
+
+    private
+      def broadcasts_size(channel)
+        broadcasts(channel).size
+      end
+  end
+end

data/lib/action_cable.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #--
-# Copyright (c) 2015-2018 Basecamp, LLC
+# Copyright (c) 2015-2019 Basecamp, LLC
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -32,13 +32,19 @@ module ActionCable
 
   INTERNAL = {
     message_types: {
-      welcome: "welcome".freeze,
-      ping: "ping".freeze,
-      confirmation: "confirm_subscription".freeze,
-      rejection: "reject_subscription".freeze
+      welcome: "welcome",
+      disconnect: "disconnect",
+      ping: "ping",
+      confirmation: "confirm_subscription",
+      rejection: "reject_subscription"
     },
-    default_mount_path: "/cable".freeze,
-    protocols: ["actioncable-v1-json".freeze, "actioncable-unsupported".freeze].freeze
+    disconnect_reasons: {
+      unauthorized: "unauthorized",
+      invalid_request: "invalid_request",
+      server_restart: "server_restart"
+    },
+    default_mount_path: "/cable",
+    protocols: ["actioncable-v1-json", "actioncable-unsupported"].freeze
   }
 
   # Singleton instance of the server
@@ -51,4 +57,6 @@ module ActionCable
   autoload :Channel
   autoload :RemoteConnections
   autoload :SubscriptionAdapter
+  autoload :TestHelper
+  autoload :TestCase
 end

data/lib/rails/generators/channel/USAGE

@@ -1,14 +1,13 @@
 Description:
 ============
-    Stubs out a new cable channel for the server (in Ruby) and client (in CoffeeScript).
+    Stubs out a new cable channel for the server (in Ruby) and client (in JavaScript).
     Pass the channel name, either CamelCased or under_scored, and an optional list of channel actions as arguments.
 
-    Note: Turn on the cable connection in app/assets/javascripts/cable.js after generating any channels.
-
 Example:
 ========
     rails generate channel Chat speak
 
-    creates a Chat channel class and CoffeeScript asset:
+    creates a Chat channel class, test and JavaScript asset:
         Channel:    app/channels/chat_channel.rb
-        Assets:     app/assets/javascripts/channels/chat.coffee
+        Test:       test/channels/chat_channel_test.rb
+        Assets:     app/javascript/channels/chat_channel.js

data/lib/rails/generators/channel/channel_generator.rb

@@ -11,15 +11,18 @@ module Rails
 
       check_class_collision suffix: "Channel"
 
+      hook_for :test_framework
+
       def create_channel_file
         template "channel.rb", File.join("app/channels", class_path, "#{file_name}_channel.rb")
 
         if options[:assets]
           if behavior == :invoke
-            template "assets/cable.js", "app/assets/javascripts/cable.js"
+            template "javascript/index.js", "app/javascript/channels/index.js"
+            template "javascript/consumer.js", "app/javascript/channels/consumer.js"
           end
 
-          js_template "assets/channel", File.join("app/assets/javascripts/channels", class_path, "#{file_name}")
+          js_template "javascript/channel", File.join("app/javascript/channels", class_path, "#{file_name}_channel")
         end
 
         generate_application_cable_files
@@ -27,7 +30,7 @@ module Rails
 
       private
         def file_name
-          @_file_name ||= super.gsub(/_channel/i, "")
+          @_file_name ||= super.sub(/_channel\z/i, "")
         end
 
         # FIXME: Change these files to symlinks once RubyGems 2.5.0 is required.

data/lib/rails/generators/channel/templates/{assets → javascript}/channel.js.tt

@@ -1,4 +1,6 @@
-App.<%= class_name.underscore %> = App.cable.subscriptions.create("<%= class_name %>Channel", {
+import consumer from "./consumer"
+
+consumer.subscriptions.create("<%= class_name %>Channel", {
   connected: function() {
     // Called when the subscription is ready for use on the server
   },

data/lib/rails/generators/channel/templates/{assets/cable.js.tt → javascript/consumer.js.tt}

@@ -1,13 +1,6 @@
 // Action Cable provides the framework to deal with WebSockets in Rails.
 // You can generate new channels where WebSocket features live using the `rails generate channel` command.
-//
-//= require action_cable
-//= require_self
-//= require_tree ./channels
 
-(function() {
-  this.App || (this.App = {});
+import ActionCable from "@rails/actioncable"
 
-  App.cable = ActionCable.createConsumer();
-
-}).call(this);
+export default ActionCable.createConsumer()

data/lib/rails/generators/channel/templates/javascript/index.js.tt

@@ -0,0 +1,5 @@
+// Load all the channels within this directory and all subdirectories.
+// Channel files must be named *_channel.js.
+
+const channels = require.context('.', true, /_channel\.js$/)
+channels.keys().forEach(channels)

data/lib/rails/generators/test_unit/channel_generator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module TestUnit
+  module Generators
+    class ChannelGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      check_class_collision suffix: "ChannelTest"
+
+      def create_test_files
+        template "channel_test.rb", File.join("test/channels", class_path, "#{file_name}_channel_test.rb")
+      end
+
+      private
+        def file_name # :doc:
+          @_file_name ||= super.sub(/_channel\z/i, "")
+        end
+    end
+  end
+end

data/lib/rails/generators/test_unit/templates/channel_test.rb.tt

@@ -0,0 +1,8 @@
+require "test_helper"
+
+class <%= class_name %>ChannelTest < ActionCable::Channel::TestCase
+  # test "subscribes" do
+  #   subscribe
+  #   assert subscription.confirmed?
+  # end
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: actioncable
 version: !ruby/object:Gem::Version
-  version: 5.2.6.2
+  version: 6.0.0.beta1
 platform: ruby
 authors:
 - Pratik Naik
 - David Heinemeier Hansson
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-11 00:00:00.000000000 Z
+date: 2019-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.6.2
+        version: 6.0.0.beta1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.6.2
+        version: 6.0.0.beta1
 - !ruby/object:Gem::Dependency
   name: nio4r
   requirement: !ruby/object:Gem::Requirement
@@ -65,6 +65,7 @@ files:
 - CHANGELOG.md
 - MIT-LICENSE
 - README.md
+- app/assets/javascripts/action_cable.js
 - lib/action_cable.rb
 - lib/action_cable/channel.rb
 - lib/action_cable/channel/base.rb
@@ -73,6 +74,7 @@ files:
 - lib/action_cable/channel/naming.rb
 - lib/action_cable/channel/periodic_timers.rb
 - lib/action_cable/channel/streams.rb
+- lib/action_cable/channel/test_case.rb
 - lib/action_cable/connection.rb
 - lib/action_cable/connection/authorization.rb
 - lib/action_cable/connection/base.rb
@@ -84,6 +86,7 @@ files:
 - lib/action_cable/connection/stream_event_loop.rb
 - lib/action_cable/connection/subscriptions.rb
 - lib/action_cable/connection/tagged_logger_proxy.rb
+- lib/action_cable/connection/test_case.rb
 - lib/action_cable/connection/web_socket.rb
 - lib/action_cable/engine.rb
 - lib/action_cable/gem_version.rb
@@ -104,23 +107,27 @@ files:
 - lib/action_cable/subscription_adapter/postgresql.rb
 - lib/action_cable/subscription_adapter/redis.rb
 - lib/action_cable/subscription_adapter/subscriber_map.rb
+- lib/action_cable/subscription_adapter/test.rb
+- lib/action_cable/test_case.rb
+- lib/action_cable/test_helper.rb
 - lib/action_cable/version.rb
-- lib/assets/compiled/action_cable.js
 - lib/rails/generators/channel/USAGE
 - lib/rails/generators/channel/channel_generator.rb
 - lib/rails/generators/channel/templates/application_cable/channel.rb.tt
 - lib/rails/generators/channel/templates/application_cable/connection.rb.tt
-- lib/rails/generators/channel/templates/assets/cable.js.tt
-- lib/rails/generators/channel/templates/assets/channel.coffee.tt
-- lib/rails/generators/channel/templates/assets/channel.js.tt
 - lib/rails/generators/channel/templates/channel.rb.tt
+- lib/rails/generators/channel/templates/javascript/channel.js.tt
+- lib/rails/generators/channel/templates/javascript/consumer.js.tt
+- lib/rails/generators/channel/templates/javascript/index.js.tt
+- lib/rails/generators/test_unit/channel_generator.rb
+- lib/rails/generators/test_unit/templates/channel_test.rb.tt
 homepage: http://rubyonrails.org
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/rails/rails/tree/v5.2.6.2/actioncable
-  changelog_uri: https://github.com/rails/rails/blob/v5.2.6.2/actioncable/CHANGELOG.md
-post_install_message:
+  source_code_uri: https://github.com/rails/rails/tree/v6.0.0.beta1/actioncable
+  changelog_uri: https://github.com/rails/rails/blob/v6.0.0.beta1/actioncable/CHANGELOG.md
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -128,15 +135,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.2
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.0.1
+signing_key: 
 specification_version: 4
 summary: WebSocket framework for Rails.
 test_files: []