solid_cable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '00408473f35ef85d126584f435899efb2e921a9094c15b5a79bc76a975268adf'
+  data.tar.gz: 690b0c1bb50e20e17facb9255bdeb98f38877c02929903c518b826093a7e806a
+SHA512:
+  metadata.gz: 702654c332b42fab18bf27b427151617462d6d4ab42f81e29b50ba6adf106eefff3bb149b58da169dbed14221f8e68c6efe04148db385fd9bb9b8840f004f6d6
+  data.tar.gz: 2733a331ac2e4ca7b1ced62247ffeda561cb48615c6a9a33f1af6056bbda63f269d9eaa1e840d9dee51d23426406589b7d1bb5800fa6bf37851a59c7fae723e1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Nick Pezza
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# SolidCable
+
+Solid Cable is a DB-based queuing backend for Action Cabble, designed with simplicity and performance in mind.
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "solid_cable"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install solid_cable
+```
+
+Now, you need to install the necessary migrations and configure the Action Cable's adapter.
+
+```bash
+$ bin/rails generate solid_cable:install
+```
+
+Update `config/cable.yml` to use the new adapter:
+
+```yaml
+development:
+  adapter: solid_cable
+
+test:
+  adapter: test
+
+production:
+  adapter: solid_cable
+```
+
+Finally, you need to run the migrations:
+
+```bash
+$ bin/rails db:migrate
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/app/models/solid_cable/message.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SolidCable
+  class Message < SolidCable::Record
+    scope :prunable, -> { where(created_at: ..30.minutes.ago) }
+    scope :broadcastable, lambda { |channels, last_id|
+      where(channel: channels).where(id: (last_id + 1)..).order(:id)
+    }
+
+    def prune
+      prunable.delete_all
+    end
+  end
+end

data/app/models/solid_cable/record.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module SolidCable
+  class Record < ActiveRecord::Base
+    self.abstract_class = true
+
+    connects_to(**SolidCable.connects_to) if SolidCable.connects_to
+  end
+end

data/db/migrate/20240103034713_create_solid_cable_message.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+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

data/lib/action_cable/subscription_adapter/solid_cable.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module ActionCable
+  module SubscriptionAdapter
+    class SolidCable < Base
+      prepend ChannelPrefix
+
+      def initialize(*)
+        super
+        @listener = nil
+      end
+
+      def broadcast(channel, payload)
+        ::SolidCable::Message.create(channel:, payload:)
+      end
+
+      def subscribe(channel, callback, success_callback = nil)
+        listener.add_subscriber(channel, callback, success_callback)
+      end
+
+      def unsubscribe(channel, callback)
+        listener.remove_subscriber(channel, callback)
+      end
+
+      delegate :shutdown, to: :listener
+
+      private
+
+      def listener
+        @listener || @server.mutex.synchronize do
+          @listener ||= Listener.new(@server.event_loop)
+        end
+      end
+
+      class Listener < SubscriberMap
+        def initialize(event_loop)
+          super()
+
+          @event_loop = event_loop
+
+          @thread = Thread.new do
+            Thread.current.abort_on_exception = true
+            listen
+          end
+        end
+
+        def listen
+          while running?
+            with_polling_volume { broadcast_messages }
+
+            sleep 0.5
+          end
+        end
+
+        def shutdown
+          self.running = false
+          ::SolidCable::Message.prune
+          Thread.pass while thread.alive?
+        end
+
+        def add_channel(channel, on_success)
+          channels.add(channel)
+          event_loop.post(&on_success) if on_success
+        end
+
+        def remove_channel(channel)
+          channels.delete(channel)
+        end
+
+        def invoke_callback(*)
+          event_loop.post { super }
+        end
+
+        private
+
+        attr_reader :event_loop, :thread
+        attr_writer :running, :last_id
+
+        def running?
+          if defined?(@running)
+            @running
+          else
+            self.running = true
+          end
+        end
+
+        def last_id
+          @last_id ||= ::SolidCable::Message.maximum(:id) || 0
+        end
+
+        def channels
+          @channels ||= Set.new
+        end
+
+        def broadcast_messages
+          ::SolidCable::Message.broadcastable(channels, last_id).
+            each do |message|
+              broadcast(message.channel, message.payload)
+              self.last_id = message.id
+            end
+        end
+
+        def with_polling_volume
+          if ::SolidCable.silence_polling?
+            ActiveRecord::Base.logger.silence { yield }
+          else
+            yield
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/solid_cable/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Installs solid_cable as the Action Cable adapter
+
+Example:
+    bin/rails generate solid_cable:install
+
+    This will perform the following:
+        Installs solid_cable migrations

data/lib/generators/solid_cable/install/install_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class SolidCable::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path("templates", __dir__)
+
+  class_option :skip_migrations, type: :boolean, default: nil, 
+                                 desc: "Skip migrations"
+
+  def create_migrations
+    return if options[:skip_migrations]
+
+      rails_command "railties:install:migrations FROM=solid_cable", inline: true
+    
+  end
+end

data/lib/solid_cable/engine.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SolidCable
+  class Engine < ::Rails::Engine
+    isolate_namespace SolidCable
+
+    config.solid_cable = ActiveSupport::OrderedOptions.new
+
+    initializer "solid_cable.config" do
+      config.solid_cable.each do |name, value|
+        SolidCable.public_send("#{name}=", value)
+      end
+    end
+  end
+end

data/lib/solid_cable/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SolidCable
+  VERSION = "0.1.0"
+end

data/lib/solid_cable.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "solid_cable/version"
+require "solid_cable/engine"
+require "action_cable/subscription_adapter/solid_cable"
+
+module SolidCable
+  mattr_accessor :connects_to
+
+  def self.silence_polling?
+    !!Rails.application.config_for("cable")[:silence_polling]
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: solid_cable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Pezza
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+description: Database-backed Action Cable backend.
+email:
+- pezza@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/models/solid_cable/message.rb
+- app/models/solid_cable/record.rb
+- db/migrate/20240103034713_create_solid_cable_message.rb
+- lib/action_cable/subscription_adapter/solid_cable.rb
+- lib/generators/solid_cable/install/USAGE
+- lib/generators/solid_cable/install/install_generator.rb
+- lib/solid_cable.rb
+- lib/solid_cable/engine.rb
+- lib/solid_cable/version.rb
+homepage: http://github.com/npezza93/solid_cable
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://github.com/npezza93/solid_cable
+  source_code_uri: http://github.com/npezza93/solid_cable
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Database-backed Action Cable backend.
+test_files: []