actioncable 6.1.5 → 7.0.0.alpha1

data/lib/action_cable/channel/broadcasting.rb

@@ -25,7 +25,7 @@ module ActionCable
           serialize_broadcasting([ channel_name, model ])
         end
 
-        def serialize_broadcasting(object) #:nodoc:
+        def serialize_broadcasting(object) # :nodoc:
           case
           when object.is_a?(Array)
             object.map { |m| serialize_broadcasting(m) }.join(":")

data/lib/action_cable/channel/streams.rb

@@ -124,13 +124,11 @@ module ActionCable
         end.clear
       end
 
-      # Calls stream_for if record is present, otherwise calls reject.
-      # This method is intended to be called when you're looking
-      # for a record based on a parameter, if its found it will start
-      # streaming. If the record is nil then it will reject the connection.
-      def stream_or_reject_for(record)
-        if record
-          stream_for record
+      # Calls stream_for with the given <tt>model</tt> if it's present to start streaming,
+      # otherwise rejects the subscription.
+      def stream_or_reject_for(model)
+        if model
+          stream_for model
         else
           reject
         end

data/lib/action_cable/channel/test_case.rb

@@ -246,7 +246,7 @@ module ActionCable
         # Returns messages transmitted into channel
         def transmissions
           # Return only directly sent message (via #transmit)
-          connection.transmissions.map { |data| data["message"] }.compact
+          connection.transmissions.filter_map { |data| data["message"] }
         end
 
         # Enhance TestHelper assertions to handle non-String

data/lib/action_cable/connection/base.rb

@@ -68,7 +68,7 @@ module ActionCable
 
       # Called by the server when a new WebSocket connection is established. This configures the callbacks intended for overwriting by the user.
       # This method should not be called directly -- instead rely upon on the #connect (and #disconnect) callbacks.
-      def process #:nodoc:
+      def process # :nodoc:
         logger.info started_request_message
 
         if websocket.possible? && allow_request_origin?
@@ -80,11 +80,11 @@ module ActionCable
 
       # Decodes WebSocket messages and dispatches them to subscribed channels.
       # WebSocket message transfer encoding is always JSON.
-      def receive(websocket_message) #:nodoc:
+      def receive(websocket_message) # :nodoc:
         send_async :dispatch_websocket_message, websocket_message
       end
 
-      def dispatch_websocket_message(websocket_message) #:nodoc:
+      def dispatch_websocket_message(websocket_message) # :nodoc:
         if websocket.alive?
           subscriptions.execute_command decode(websocket_message)
         else

data/lib/action_cable/connection/identification.rb

@@ -26,7 +26,7 @@ module ActionCable
       # Return a single connection identifier that combines the value of all the registered identifiers into a single gid.
       def connection_identifier
         unless defined? @connection_identifier
-          @connection_identifier = connection_gid identifiers.map { |id| instance_variable_get("@#{id}") }.compact
+          @connection_identifier = connection_gid identifiers.filter_map { |id| instance_variable_get("@#{id}") }
         end
 
         @connection_identifier

data/lib/action_cable/connection/subscriptions.rb

@@ -33,7 +33,7 @@ module ActionCable
 
         subscription_klass = id_options[:channel].safe_constantize
 
-        if subscription_klass && ActionCable::Channel::Base >= subscription_klass
+        if subscription_klass && ActionCable::Channel::Base > subscription_klass
           subscription = subscription_klass.new(connection, id_key, id_options)
           subscriptions[id_key] = subscription
           subscription.subscribe_to_channel

data/lib/action_cable/connection/tagged_logger_proxy.rb

@@ -18,10 +18,10 @@ module ActionCable
         @tags = @tags.uniq
       end
 
-      def tag(logger)
+      def tag(logger, &block)
         if logger.respond_to?(:tagged)
           current_tags = tags - logger.formatter.current_tags
-          logger.tagged(*current_tags) { yield }
+          logger.tagged(*current_tags, &block)
         else
           yield
         end

data/lib/action_cable/engine.rb

@@ -9,6 +9,7 @@ module ActionCable
   class Engine < Rails::Engine # :nodoc:
     config.action_cable = ActiveSupport::OrderedOptions.new
     config.action_cable.mount_path = ActionCable::INTERNAL[:default_mount_path]
+    config.action_cable.precompile_assets = true
 
     config.eager_load_namespaces << ActionCable
 
@@ -22,6 +23,14 @@ module ActionCable
       ActiveSupport.on_load(:action_cable) { self.logger ||= ::Rails.logger }
     end
 
+    initializer "action_cable.asset" do
+      config.after_initialize do |app|
+        if Rails.application.config.respond_to?(:assets) && app.config.action_cable.precompile_assets
+          Rails.application.config.assets.precompile += %w( actioncable.js actioncable.esm.js )
+        end
+      end
+    end
+
     initializer "action_cable.set_configs" do |app|
       options = app.config.action_cable
       options.allowed_request_origins ||= /https?:\/\/localhost:\d+/ if ::Rails.env.development?

data/lib/action_cable/gem_version.rb

@@ -7,10 +7,10 @@ module ActionCable
   end
 
   module VERSION
-    MAJOR = 6
-    MINOR = 1
-    TINY  = 5
-    PRE   = nil
+    MAJOR = 7
+    MINOR = 0
+    TINY  = 0
+    PRE   = "alpha1"
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end

data/lib/action_cable/helpers/action_cable_helper.rb

@@ -8,14 +8,15 @@ module ActionCable
       #
       #   <head>
       #     <%= action_cable_meta_tag %>
-      #     <%= javascript_include_tag 'application', 'data-turbolinks-track' => 'reload' %>
+      #     <%= javascript_include_tag 'application', 'data-turbo-track' => 'reload' %>
       #   </head>
       #
       # This is then used by Action Cable to determine the URL of your WebSocket server.
       # Your JavaScript can then connect to the server without needing to specify the
       # URL directly:
       #
-      #   window.Cable = require("@rails/actioncable")
+      #   import Cable from "@rails/actioncable"
+      #   window.Cable = Cable
       #   window.App = {}
       #   App.cable = Cable.createConsumer()
       #

data/lib/action_cable/server/configuration.rb

@@ -9,6 +9,7 @@ module ActionCable
       attr_accessor :connection_class, :worker_pool_size
       attr_accessor :disable_request_forgery_protection, :allowed_request_origins, :allow_same_origin_as_host
       attr_accessor :cable, :url, :mount_path
+      attr_accessor :precompile_assets
 
       def initialize
         @log_tags = []

data/lib/action_cable/server/worker/active_record_connection_management.rb

@@ -12,8 +12,8 @@ module ActionCable
           end
         end
 
-        def with_database_connections
-          connection.logger.tag(ActiveRecord::Base.logger) { yield }
+        def with_database_connections(&block)
+          connection.logger.tag(ActiveRecord::Base.logger, &block)
         end
       end
     end

data/lib/action_cable/server/worker.rb

@@ -19,6 +19,7 @@ module ActionCable
 
       def initialize(max_size: 5)
         @executor = Concurrent::ThreadPoolExecutor.new(
+          name: "ActionCable",
           min_threads: 1,
           max_threads: max_size,
           max_queue: 0,
@@ -35,12 +36,10 @@ module ActionCable
         @executor.shuttingdown?
       end
 
-      def work(connection)
+      def work(connection, &block)
         self.connection = connection
 
-        run_callbacks :work do
-          yield
-        end
+        run_callbacks :work, &block
       ensure
         self.connection = nil
       end

data/lib/action_cable/subscription_adapter/postgresql.rb

@@ -3,7 +3,7 @@
 gem "pg", "~> 1.1"
 require "pg"
 require "thread"
-require "digest/sha1"
+require "openssl"
 
 module ActionCable
   module SubscriptionAdapter
@@ -58,7 +58,7 @@ module ActionCable
 
       private
         def channel_identifier(channel)
-          channel.size > 63 ? Digest::SHA1.hexdigest(channel) : channel
+          channel.size > 63 ? OpenSSL::Digest::SHA1.hexdigest(channel) : channel
         end
 
         def listener

data/lib/action_cable/test_helper.rb

@@ -45,7 +45,7 @@ module ActionCable
     def assert_broadcasts(stream, number, &block)
       if block_given?
         original_count = broadcasts_size(stream)
-        assert_nothing_raised(&block)
+        _assert_nothing_raised_or_warn("assert_broadcasts", &block)
         new_count = broadcasts_size(stream)
         actual_count = new_count - original_count
       else
@@ -106,7 +106,7 @@ module ActionCable
         old_messages = new_messages
         clear_messages(stream)
 
-        assert_nothing_raised(&block)
+        _assert_nothing_raised_or_warn("assert_broadcast_on", &block)
         new_messages = broadcasts(stream)
         clear_messages(stream)
 

data/lib/action_cable.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #--
-# Copyright (c) 2015-2022 Basecamp, LLC
+# Copyright (c) 2015-2021 Basecamp, LLC
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/lib/rails/generators/channel/USAGE

@@ -10,4 +10,4 @@ Example:
     creates a Chat channel class, test and JavaScript asset:
         Channel:    app/channels/chat_channel.rb
         Test:       test/channels/chat_channel_test.rb
-        Assets:     app/javascript/channels/chat_channel.js
+        Assets:     $JAVASCRIPT_PATH/channels/chat_channel.js

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

@@ -13,39 +13,98 @@ module Rails
 
       hook_for :test_framework
 
-      def create_channel_file
-        template "channel.rb", File.join("app/channels", class_path, "#{file_name}_channel.rb")
+      def create_channel_files
+        create_shared_channel_files
+        create_channel_file
 
-        if options[:assets]
-          if behavior == :invoke
-            template "javascript/index.js", "app/javascript/channels/index.js"
-            template "javascript/consumer.js", "app/javascript/channels/consumer.js"
+        if using_javascript?
+          if first_setup_required?
+            create_shared_channel_javascript_files
+            import_channels_in_javascript_entrypoint
+
+            if using_importmap?
+              pin_javascript_dependencies
+            elsif using_node?
+              install_javascript_dependencies
+            end
           end
 
-          js_template "javascript/channel", File.join("app/javascript/channels", class_path, "#{file_name}_channel")
+          create_channel_javascript_file
+          import_channel_in_javascript_entrypoint
         end
-
-        generate_application_cable_files
       end
 
       private
+        def create_shared_channel_files
+          return if behavior != :invoke
+
+          copy_file "#{__dir__}/templates/application_cable/channel.rb",
+            "app/channels/application_cable/channel.rb"
+          copy_file "#{__dir__}/templates/application_cable/connection.rb",
+            "app/channels/application_cable/connection.rb"
+        end
+
+        def create_channel_file
+          template "channel.rb",
+            File.join("app/channels", class_path, "#{file_name}_channel.rb")
+        end
+
+        def create_shared_channel_javascript_files
+          template "javascript/index.js", "app/javascript/channels/index.js"
+          template "javascript/consumer.js", "app/javascript/channels/consumer.js"
+        end
+
+        def create_channel_javascript_file
+          channel_js_path = File.join("app/javascript/channels", class_path, "#{file_name}_channel")
+          js_template "javascript/channel", channel_js_path
+          gsub_file "#{channel_js_path}.js", /\.\/consumer/, "channels/consumer" unless using_node?
+        end
+
+        def import_channels_in_javascript_entrypoint
+          append_to_file "app/javascript/application.js",
+            using_node? ? %(import "./channels"\n) : %(import "channels"\n)
+        end
+
+        def import_channel_in_javascript_entrypoint
+          append_to_file "app/javascript/channels/index.js",
+            using_node? ? %(import "./#{file_name}_channel"\n) : %(import "channels/#{file_name}_channel"\n)
+        end
+
+        def install_javascript_dependencies
+          say "Installing JavaScript dependencies", :green
+          run "yarn add @rails/actioncable"
+        end
+
+        def pin_javascript_dependencies
+          append_to_file "config/importmap.rb", <<-RUBY
+pin "@rails/actioncable", to: "actioncable.esm.js"
+pin_all_from "app/javascript/channels", under: "channels"
+          RUBY
+        end
+
+
         def file_name
           @_file_name ||= super.sub(/_channel\z/i, "")
         end
 
-        # FIXME: Change these files to symlinks once RubyGems 2.5.0 is required.
-        def generate_application_cable_files
-          return if behavior != :invoke
+        def first_setup_required?
+          !root.join("app/javascript/channels/index.js").exist?
+        end
 
-          files = [
-            "application_cable/channel.rb",
-            "application_cable/connection.rb"
-          ]
+        def using_javascript?
+          @using_javascript ||= options[:assets] && root.join("app/javascript").exist?
+        end
 
-          files.each do |name|
-            path = File.join("app/channels/", name)
-            template(name, path) if !File.exist?(path)
-          end
+        def using_node?
+          @using_node ||= root.join("package.json").exist?
+        end
+
+        def using_importmap?
+          @using_importmap ||= root.join("config/importmap.rb").exist?
+        end
+
+        def root
+          @root ||= Pathname(destination_root)
         end
     end
   end

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

@@ -1,5 +1 @@
-// 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)
+// Import all the channels to be used by Action Cable

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: actioncable
 version: !ruby/object:Gem::Version
-  version: 6.1.5
+  version: 7.0.0.alpha1
 platform: ruby
 authors:
 - Pratik Naik
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-10 00:00:00.000000000 Z
+date: 2021-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,28 +17,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.1.5
+        version: 7.0.0.alpha1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.1.5
+        version: 7.0.0.alpha1
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.1.5
+        version: 7.0.0.alpha1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.1.5
+        version: 7.0.0.alpha1
 - !ruby/object:Gem::Dependency
   name: nio4r
   requirement: !ruby/object:Gem::Requirement
@@ -127,8 +127,8 @@ files:
 - lib/action_cable/version.rb
 - 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/application_cable/channel.rb
+- lib/rails/generators/channel/templates/application_cable/connection.rb
 - 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
@@ -140,11 +140,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rails/rails/issues
-  changelog_uri: https://github.com/rails/rails/blob/v6.1.5/actioncable/CHANGELOG.md
-  documentation_uri: https://api.rubyonrails.org/v6.1.5/
+  changelog_uri: https://github.com/rails/rails/blob/v7.0.0.alpha1/actioncable/CHANGELOG.md
+  documentation_uri: https://api.rubyonrails.org/v7.0.0.alpha1/
   mailing_list_uri: https://discuss.rubyonrails.org/c/rubyonrails-talk
-  source_code_uri: https://github.com/rails/rails/tree/v6.1.5/actioncable
-  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/rails/rails/tree/v7.0.0.alpha1/actioncable
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -153,14 +152,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: WebSocket framework for Rails.