From 4846c88d5e03107398a2c7b03f55ef1315f39d4f Mon Sep 17 00:00:00 2001
From: Sebastian Serth <Sebastian.Serth@hpi.de>
Date: Fri, 13 Sep 2024 01:24:36 +0200
Subject: [PATCH] Add Solid Cable adapter for ActionCable

Switching the adapter is not expected to make any noticeable difference and is in line with CodeOcean. The new Solid Cable adapter is also shipping with Rails 8 by default.
---
 .rubocop.yml                |  2 +-
 Gemfile                     |  1 +
 Gemfile.lock                |  3 +++
 config/cable.yml            | 23 ++++++++++++++++++-----
 config/database.yml.example | 18 ++++++++++++++----
 db/cable_schema.rb          | 25 +++++++++++++++++++++++++
 6 files changed, 62 insertions(+), 10 deletions(-)
 create mode 100644 db/cable_schema.rb

diff --git a/.rubocop.yml b/.rubocop.yml
index 20989103c..db56e2aea 100644
--- a/.rubocop.yml
+++ b/.rubocop.yml
@@ -23,7 +23,7 @@ AllCops:
   NewCops: enable
   Exclude:
     - 'bin/*'
-    - 'db/schema.rb'
+    - 'db/*schema.rb'
     - 'vendor/**/*'
     # Ignore local files for faster processing
     - 'tmp/**/*'
diff --git a/Gemfile b/Gemfile
index 2402bb94a..c974ca23d 100644
--- a/Gemfile
+++ b/Gemfile
@@ -41,6 +41,7 @@ gem 'sassc-rails'
 gem 'shakapacker', '8.0.2'
 gem 'simple_form'
 gem 'slim-rails'
+gem 'solid_cable'
 gem 'solid_queue'
 gem 'sprockets-rails'
 gem 'terser', require: false
diff --git a/Gemfile.lock b/Gemfile.lock
index 42065148a..7418afb94 100644
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -526,6 +526,8 @@ GEM
       rexml (~> 3.2)
       rubocop (>= 1.0, < 2.0)
       slim (>= 3.0, < 6.0)
+    solid_cable (2.0.2)
+      rails (>= 7.2)
     solid_queue (0.7.1)
       activejob (>= 7.1)
       activerecord (>= 7.1)
@@ -666,6 +668,7 @@ DEPENDENCIES
   simplecov
   slim-rails
   slim_lint
+  solid_cable
   solid_queue
   sprockets-rails
   stackprof
diff --git a/config/cable.yml b/config/cable.yml
index 633e318b5..b6bb293f5 100644
--- a/config/cable.yml
+++ b/config/cable.yml
@@ -1,11 +1,24 @@
+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: codeharbor_production
+
 development:
-  adapter: postgresql
+  <<: *default
 
 test:
   adapter: test
 
 production:
-  adapter: postgresql # redis
-  # all other options below are only used for redis
-  # url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
-  # channel_prefix: codeharbor_production
+  <<: *default
diff --git a/config/database.yml.example b/config/database.yml.example
index e0ab1ccf2..3c82d9c12 100644
--- a/config/database.yml.example
+++ b/config/database.yml.example
@@ -29,8 +29,13 @@ default: &default
   <% end %>
 
 development:
-  <<: *default
-  database: codeharbor_development
+  primary: &primary_development
+    <<: *default
+    database: codeharbor_development
+  cable:
+    <<: *primary_development
+    database: codeharbor_development_cable
+    migrations_paths: db/cable_migrate
 
 # Warning: The database defined as "test" will be erased and
 # re-generated from your development database when you run "rake".
@@ -56,5 +61,10 @@ test:
 # for a full overview on how database connection configuration can be specified.
 #
 production:
-  <<: *default
-  database: codeharbor_production
+  primary: &primary_production
+    <<: *default
+    database: codeharbor_production
+  cable:
+    <<: *primary_production
+    database: codeharbor_production_cable
+    migrations_paths: db/cable_migrate
diff --git a/db/cable_schema.rb b/db/cable_schema.rb
new file mode 100644
index 000000000..d86a8d3b2
--- /dev/null
+++ b/db/cable_schema.rb
@@ -0,0 +1,25 @@
+# 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: 1) do
+  # These are extensions that must be enabled in order to support this database
+  enable_extension "plpgsql"
+
+  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