Add Solid Cable adapter for ActionCable

Switching the adapter is not expected to make any noticeable difference. The previous gem used was an interim solution and is now replaced by the new Solid Cable adapter shipping with Rails 8 by default.

Gemfile

@@ -2,7 +2,6 @@
 
 source 'https://rubygems.org'
 
-gem 'actioncable-enhanced-postgresql-adapter'
 gem 'bcrypt'
 gem 'bootsnap', require: false
 gem 'bootstrap-will_paginate'
@@ -47,6 +46,7 @@ gem 'rubyzip'
 gem 'sassc-rails'
 gem 'shakapacker', '8.0.2'
 gem 'slim-rails'
+gem 'solid_cable'
 gem 'solid_queue'
 gem 'sorcery'
 gem 'sprockets-rails'

Gemfile.lock

@@ -7,10 +7,6 @@ GEM
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
       zeitwerk (~> 2.6)
-    actioncable-enhanced-postgresql-adapter (1.0.1)
-      actioncable (>= 6.0)
-      connection_pool (>= 2.2.5)
-      pg (~> 1.5)
     actionmailbox (7.2.1)
       actionpack (= 7.2.1)
       activejob (= 7.2.1)
@@ -515,6 +511,8 @@ GEM
     snaky_hash (2.0.1)
       hashie
       version_gem (~> 1.1, >= 1.1.1)
+    solid_cable (1.0.3)
+      rails (< 9)
     solid_queue (0.9.0)
       activejob (>= 7.1)
       activerecord (>= 7.1)
@@ -589,7 +587,6 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  actioncable-enhanced-postgresql-adapter
   bcrypt
   better_errors
   binding_of_caller
@@ -662,6 +659,7 @@ DEPENDENCIES
   simplecov
   slim-rails
   slim_lint
+  solid_cable
   solid_queue
   sorcery
   sprockets-rails

config/cable.yml

@@ -1,20 +1,27 @@
+default: &default
+  adapter: solid_cable # OR postgresql OR redis
+
+  ### Config options for `solid_cable`
+  connects_to:
+    database:
+      writing: cable
+  polling_interval: 0.1.seconds
+  message_retention: 1.day
+  autotrim: true
+  silence_polling: true
+
+  ### Config options for `redis`
+  # url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
+  # channel_prefix: codeocean_production
+
 development:
-  adapter: enhanced_postgresql
+  <<: *default
 
 test:
   adapter: test
 
 staging:
-  adapter: enhanced_postgresql
+  <<: *default
 
 production:
-  adapter: enhanced_postgresql # OR postgresql OR redis
-
-  ### Config options for `enhanced_postgresql`
-  # payload_encryptor_secret: # Required. Will be the defined value or `Rails.application.secret_key_base` or `ENV["SECRET_KEY_BASE"]`
-  # url: <%= ENV.fetch("DATABASE_URL") { "postgresql://localhost:5432/code_ocean_production" } %>
-  # connection_pool_size: <%= ENV.fetch("RAILS_MAX_THREADS", 5).to_i %> # Only used in conjunction with `url`
-
-  ### Config options for `redis`
-  # url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
-  # channel_prefix: code_ocean_production
+  <<: *default

config/database.yml.example

@@ -32,6 +32,10 @@ development:
   primary: &primary_development
     <<: *default
     database: codeocean_development
+  cable:
+    <<: *primary_development
+    database: codeocean_development_cable
+    migrations_paths: db/cable_migrate
   queue:
     <<: *primary_development
     database: codeocean_development_queue
@@ -64,6 +68,10 @@ production:
   primary: &primary_production
     <<: *default
     database: codeocean_production
+  cable:
+    <<: *primary_production
+    database: codeocean_production_cable
+    migrations_paths: db/cable_migrate
   queue:
     <<: *primary_production
     database: codeocean_production_queue

db/migrate/20240912101506_drop_action_cable_large_payloads.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class DropActionCableLargePayloads < ActiveRecord::Migration[7.2]
+  def change
+    # Drop the previously-used table for large payloads in ActionCable.
+    # This table was implicitly created by the EnhancedPostgresql adapter.
+    # Solid Cable used from now on manages the required schema separately.
+    drop_table :action_cable_large_payloads, if_exists: true
+  end
+end