Add test

Author: npezza93

.rubocop.yml

@@ -9,6 +9,8 @@ AllCops:
     - tmp/**/*
     - bin/**/*
     - test/dummy/**/*
+    - bench/**/*
+    - test/lib/action_cable/subscription_adapter/solid_cable_test.rb
   TargetRubyVersion: 3.3
 
 # Department Bundler

test/dummy/db/migrate/20240823212657_create_solid_cable_message.solid_cable.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# This migration comes from solid_cable (originally 20240103034713)
+class CreateSolidCableMessage < ActiveRecord::Migration[7.1]
+  def change
+    create_table :solid_cable_messages, if_not_exists: true do |t|
+      t.text :channel
+      t.text :payload
+
+      t.timestamps
+
+      t.index :created_at
+    end
+  end
+end

test/dummy/db/migrate/20240823212658_index_channels.solid_cable.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# This migration comes from solid_cable (originally 20240607184711)
+class IndexChannels < ActiveRecord::Migration[7.1]
+  def change
+    add_index :solid_cable_messages, :channel, length: 500
+  end
+end

test/dummy/db/schema.rb

@@ -0,0 +1,22 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# This file is the source Rails uses to define your schema when running `bin/rails
+# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to
+# be faster and is potentially less error prone than running all of your
+# migrations from scratch. Old migrations may fail to apply correctly if those
+# migrations use external dependencies or application code.
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema[7.2].define(version: 2024_08_23_212658) do
+  create_table "solid_cable_messages", force: :cascade do |t|
+    t.text "channel"
+    t.text "payload"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["channel"], name: "index_solid_cable_messages_on_channel"
+    t.index ["created_at"], name: "index_solid_cable_messages_on_created_at"
+  end
+end

test/lib/action_cable/subscription_adapter/solid_cable_test.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require "concurrent"
+
+require "active_support/core_ext/hash/indifferent_access"
+require "pathname"
+
+class ActionCable::SubscriptionAdapter::SolidCableTest < ActionCable::TestCase
+
+  WAIT_WHEN_EXPECTING_EVENT = 3
+  WAIT_WHEN_NOT_EXPECTING_EVENT = 0.2
+
+  def setup
+    server = ActionCable::Server::Base.new
+    server.config.cable = cable_config.with_indifferent_access
+    server.config.logger = Logger.new(StringIO.new).tap do |l|
+      l.level = Logger::UNKNOWN
+    end
+
+    adapter_klass = server.config.pubsub_adapter
+
+    @rx_adapter = adapter_klass.new(server)
+    @tx_adapter = adapter_klass.new(server)
+
+    @tx_adapter.shutdown
+    @tx_adapter = @rx_adapter
+  end
+
+  def cable_config
+    { adapter: "solid_cable", polling_interval: "0.01.seconds" }
+  end
+
+  def teardown
+    [@rx_adapter, @tx_adapter].uniq.compact.each(&:shutdown)
+  end
+
+  def subscribe_as_queue(channel, adapter = @rx_adapter)
+    queue = Queue.new
+
+    callback = ->(data) { queue << data }
+    subscribed = Concurrent::Event.new
+    adapter.subscribe(channel, callback, proc { subscribed.set })
+    subscribed.wait(WAIT_WHEN_EXPECTING_EVENT)
+    sleep WAIT_WHEN_EXPECTING_EVENT
+    assert_predicate subscribed, :set?
+
+    yield queue
+
+    sleep WAIT_WHEN_NOT_EXPECTING_EVENT
+    assert_empty queue
+  ensure
+    adapter.unsubscribe(channel, callback) if subscribed.set?
+  end
+
+  def test_subscribe_and_unsubscribe
+    subscribe_as_queue("channel") do |queue|
+    end
+  end
+
+  def test_basic_broadcast
+    subscribe_as_queue("channel") do |queue|
+      @tx_adapter.broadcast("channel", "hello world")
+
+      assert_equal "hello world", queue.pop
+    end
+  end
+
+  def test_broadcast_after_unsubscribe
+    keep_queue = nil
+    subscribe_as_queue("channel") do |queue|
+      keep_queue = queue
+
+      @tx_adapter.broadcast("channel", "hello world")
+
+      assert_equal "hello world", queue.pop
+    end
+
+    @tx_adapter.broadcast("channel", "hello void")
+
+    sleep WAIT_WHEN_NOT_EXPECTING_EVENT
+    assert_empty keep_queue
+  end
+
+  def test_multiple_broadcast
+    subscribe_as_queue("channel") do |queue|
+      @tx_adapter.broadcast("channel", "bananas")
+      @tx_adapter.broadcast("channel", "apples")
+
+      received = []
+      2.times { received << queue.pop }
+      assert_equal %w(apples bananas), received.sort
+    end
+  end
+
+  def test_identical_subscriptions
+    subscribe_as_queue("channel") do |queue|
+      subscribe_as_queue("channel") do |queue_2|
+        @tx_adapter.broadcast("channel", "hello")
+
+        assert_equal "hello", queue_2.pop
+      end
+
+      assert_equal "hello", queue.pop
+    end
+  end
+
+  def test_simultaneous_subscriptions
+    subscribe_as_queue("channel") do |queue|
+      subscribe_as_queue("other channel") do |queue_2|
+        @tx_adapter.broadcast("channel", "apples")
+        @tx_adapter.broadcast("other channel", "oranges")
+
+        assert_equal "apples", queue.pop
+        assert_equal "oranges", queue_2.pop
+      end
+    end
+  end
+
+  def test_channel_filtered_broadcast
+    subscribe_as_queue("channel") do |queue|
+      @tx_adapter.broadcast("other channel", "one")
+      @tx_adapter.broadcast("channel", "two")
+
+      assert_equal "two", queue.pop
+    end
+  end
+
+  def test_long_identifiers
+    channel_1 = "#{'a' * 100}1"
+    channel_2 = "#{'a' * 100}2"
+    subscribe_as_queue(channel_1) do |queue|
+      subscribe_as_queue(channel_2) do |queue_2|
+        @tx_adapter.broadcast(channel_1, "apples")
+        @tx_adapter.broadcast(channel_2, "oranges")
+
+        assert_equal "apples", queue.pop
+        assert_equal "oranges", queue_2.pop
+      end
+    end
+  end
+end