solid_cable 1.0.6 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a3ffe8d513e578210ffa1586b9f3fa921919ab9ff1d4b2a9cbf802ea550a37c
-  data.tar.gz: 9dab848172317e0046d8beced7fe6f3e889b1190c91e5e9be10b2f6b964e6780
+  metadata.gz: 7a7ca96eb444763611b76694a5a950ea8f131cd2d5a0141b3897af849daf5492
+  data.tar.gz: a25ebf8ac69c71fab4f270e9602a5f25c12f3d6fbc29be5c5e84e27c91abf507
 SHA512:
-  metadata.gz: 07f016353535c742c511d63dfc600d78e381963567b89ece4ba194b357e0c89bcc2633b40e1d8b7cd6c062ff27d15e316a3b8c99ed36f04cea6163e33d034dde
-  data.tar.gz: e6affe9d7b555a0892aae14092368d46392f7fcc6f563c7bce91353e3bae046a444dbc28148bc10a2ffbb08d0872aaf2e401a5bf5151ac9fa2d23c51e3b72df9
+  metadata.gz: 7ba93aa71e565208f9201740583bb9cf77854ff9880dbad396b54e67d95f4cc8650765c910a4bb9c9e743c53abf1f7a20cdf77e596edf49cfc55da4d684e5ad2
+  data.tar.gz: a1b7c4824a957d14984cbf5c39936b6769241d5ae026da6abd2c17a94fc42326bedeedb32038682bf0e5491385e33364414b1dcc30c40d891abd8846f4e818b7

data/README.md

@@ -1,34 +1,18 @@
-# SolidCable
+# Solid Cable
 
-Solid Cable is a DB-based backend for Action Cable.
+Solid Cable is a database-backed Action Cable adapter that keeps messages in a table and continously polls for updates. This makes it possible to drop the common dependency on Redis, if it isn't needed for any other purpose. Despite polling, the performance of Solid Cable is comparable to Redis in most situations. And in all circumstances, it makes it easier to deploy Rails when Redis is no longer a required dependency for Action Cable functionality.
 
 
 ## 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
-```
+Solid Cable is configured by default in new Rails 8 applications. But if you're running an earlier version, you can add it manually following these steps:
 
-Now, you need to run the installer:
+1. `bundle add solid_cable`
+2. `bin/rails solid_cable:install`
 
-```bash
-$ bin/rails generate solid_cable:install
-```
-
-This will create the `db/cable_schema.rb` file.
+This will configure Solid Cable as the production cable adapter by overwritting `config/cable.yml` and create `db/cable_schema.rb`.
 
-You will then have to add the configuration for the database in `config/database.yml`. If you're using SQLite, it'll look something like this:
+You will then have to add the configuration for the cable database in `config/database.yml`. If you're using SQLite, it'll look like this:
 
 ```yaml
 production:
@@ -57,42 +41,40 @@ production:
 ```
 
 > [!NOTE]
-> Calling `bin/rails generate solid_cable:install` will automatically setup `config/cable.yml`, so no additional configuration is needed there (although you must make sure that you use the `cable` name in `database.yml` for this to match!). But if you want to use Solid Cable in a different environment (like staging or even development), you'll have to manually add that `connects_to` block to the respective environment in the `config/cable.yml` file. And, as always, make sure that the name you're using for the database in `config/cable.yml` matches the name you define in `config/database.yml`.
+> Calling `bin/rails solid_cable:install` will automatically setup `config/cable.yml`, so no additional configuration is needed there (although you must make sure that you use the `cable` name in `database.yml` for this to match!). But if you want to use Solid Cable in a different environment (like staging or even development), you'll have to manually add that `connects_to` block to the respective environment in the `config/cable.yml` file. And, as always, make sure that the name you're using for the database in `config/cable.yml` matches the name you define in `config/database.yml`.
 
 Then run `db:prepare` in production to ensure the database is created and the schema is loaded.
 
-## Usage
-
-By default messages are kept around forever. SolidCable ships with a job to
-prune messages. You can run `SolidCable::PruneJob.perform_later` which removes
-Messages that are older than what is specified in `keep_messages_around_for`
-setting.
-
 ## Configuration
 
-All configuration is managed via the `config/cable.yml`file. To use Solid Cable, the `adapter` value *must be* `solid_cable`. When using Solid Cable, the other values you can set are: `connects_to`, `polling_interval`, `silence_polling`, and `keep_messages_around_for`. For example:
+All configuration is managed via the `config/cable.yml` file. By default, it'll be configured like this:
 
 ```yaml
-default: &default
+production:
   adapter: solid_cable
-  polling_interval: 1.second
-  keep_messages_around_for: 1.day
-
-development:
-  <<: *default
-  silence_polling: true
   connects_to:
     database:
-      writing: solid_cable_primary
-      reading: solid_cable_replica
-
-test:
-  adapter: test
-
-production:
-  <<: *default
+      writing: cable
   polling_interval: 0.1.seconds
+  message_retention: 1.day
 ```
 
+The options are:
+
+- `connects_to` - set the Active Record database configuration for the Solid Cable models. All options available in Active Record can be used here.
+- `polling_interval` - sets the frequency of the polling interval. (Defaults to
+  0.1.seconds)
+- `message_retention` - sets the retention time for messages kept in the database. Used as the cut-off when trimming is performed. (Defaults to 1.day)
+- `autotrim` - sets wether you want Solid Cable to handle autotrimming messages. (Defaults to true)
+- `silence_polling` - whether to silence Active Record logs emitted when polling (Defaults to true)
+
+## Trimming
+
+Messages are autotrimmed based upon the `message_retention` setting to determine how long messages are to be kept around. If no `message_retention` is given or parsing fails, it defaults to `1.day`. Messages are trimmed when a subscriber unsubscribes.
+
+Autotrimming can negatively impact performance depending on your workload because it is doing a delete on ubsubscribe. If
+you would prefer, you can disable autotrimming by setting `autotrim: false` and you can manually enqueue the job later, `SolidCable::TrimJob.perform_later`, or run it on a recurring interval out of band.
+
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/jobs/solid_cable/{prune_job.rb → trim_job.rb}

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 module SolidCable
-  class PruneJob < ActiveJob::Base
+  class TrimJob < ActiveJob::Base
     def perform
-      ::SolidCable::Message.prunable.delete_all
+      ::SolidCable::Message.trimmable.delete_all
     end
   end
 end

data/app/models/solid_cable/message.rb

@@ -2,8 +2,8 @@
 
 module SolidCable
   class Message < SolidCable::Record
-    scope :prunable, lambda {
-      where(created_at: ..::SolidCable.keep_messages_around_for.ago)
+    scope :trimmable, lambda {
+      where(created_at: ..::SolidCable.message_retention.ago)
     }
     scope :broadcastable, lambda { |channels, last_id|
       where(channel: channels).where(id: (last_id + 1)..).order(:id)

data/lib/action_cable/subscription_adapter/solid_cable.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+require "action_cable/subscription_adapter/base"
+
 module ActionCable
   module SubscriptionAdapter
-    class SolidCable < Base
+    class SolidCable < ::ActionCable::SubscriptionAdapter::Base
       prepend ChannelPrefix
 
       def initialize(*)
@@ -64,6 +66,8 @@ module ActionCable
 
         def remove_channel(channel)
           channels.delete(channel)
+
+          ::SolidCable::TrimJob.perform_now if ::SolidCable.autotrim?
         end
 
         def invoke_callback(*)

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

@@ -3,48 +3,8 @@
 class SolidCable::InstallGenerator < Rails::Generators::Base
   source_root File.expand_path("templates", __dir__)
 
-  def add_solid_errors_db_schema
+  def copy_files
     template "db/cable_schema.rb"
-  end
-
-  def configure_production_cable
-    gsub_file("config/cable.yml",
-              /production:\n(^\s*.*$\n){2,}/,
-              new_production_cable_config)
-  end
-
-  def configure_development_cable
-    gsub_file("config/cable.yml",
-              /development:\n\s*adapter: redis\n  url: .*\n/,
-              new_development_cable_config)
-  end
-
-  private
-
-  def new_production_cable_config
-    <<~YAML
-      production:
-        adapter: solid_cable
-        connects_to:
-          database:
-            writing: cable
-            reading: cable
-        polling_interval: 0.1.seconds
-        keep_messages_around_for: 1.day
-    YAML
-  end
-
-  def new_development_cable_config
-    <<~YAML
-      development:
-        adapter: solid_cable
-        connects_to:
-          database:
-            writing: cable
-            reading: cable
-        polling_interval: 1.second
-        keep_messages_around_for: 1.day
-        silence_polling: true
-    YAML
+    template "config/cable.yml", force: true
   end
 end

data/lib/generators/solid_cable/install/templates/config/cable.yml

@@ -0,0 +1,13 @@
+development:
+  adapter: async
+
+test:
+  adapter: test
+
+production:
+  adapter: solid_cable
+  connects_to:
+    database:
+      writing: cable
+  polling_interval: 0.1.seconds
+  message_retention: 1.day

data/lib/solid_cable/version.rb

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

data/lib/solid_cable.rb

@@ -18,8 +18,12 @@ module SolidCable
       parse_duration(cable_config.polling_interval, default: 0.1.seconds)
     end
 
-    def keep_messages_around_for
-      parse_duration(cable_config.keep_messages_around_for, default: 1.day)
+    def message_retention
+      parse_duration(cable_config.message_retention, default: 1.day)
+    end
+
+    def autotrim?
+      cable_config.autotrim != false
     end
 
     private

data/lib/tasks/solid_cable_tasks.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+desc "Copy over the schema and set cable adapter for Solid Cable"
+namespace :solid_cable do
+  task :install do
+    Rails::Command.invoke :generate, ["solid_cable:install"]
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solid_cable
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 2.0.0
 platform: ruby
 authors:
 - Nick Pezza
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-10 00:00:00.000000000 Z
+date: 2024-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -34,17 +34,19 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/jobs/solid_cable/prune_job.rb
+- app/jobs/solid_cable/trim_job.rb
 - app/models/solid_cable/message.rb
 - app/models/solid_cable/record.rb
 - lib/action_cable/subscription_adapter/solid_cable.rb
 - lib/generators/solid_cable/install/USAGE
 - lib/generators/solid_cable/install/install_generator.rb
+- lib/generators/solid_cable/install/templates/config/cable.yml
 - lib/generators/solid_cable/install/templates/db/cable_schema.rb
 - lib/solid_cable.rb
 - lib/solid_cable/engine.rb
 - lib/solid_cable/railtie.rb
 - lib/solid_cable/version.rb
+- lib/tasks/solid_cable_tasks.rake
 homepage: http://github.com/npezza93/solid_cable
 licenses:
 - MIT