Add Solid Cache (and get ready for Solid Queue) (rails#52790)

* Add Solid Cache (and get ready for Solid Queue)

Author: dhh

Gemfile

@@ -21,6 +21,7 @@ gem "cssbundling-rails"
 gem "importmap-rails", ">= 1.2.3"
 gem "tailwindcss-rails"
 gem "dartsass-rails"
+gem "solid_cache"
 gem "kamal", require: false
 gem "thruster", require: false
 # require: false so bcrypt is loaded only when has_secure_password is used.

Gemfile.lock

@@ -545,6 +545,10 @@ GEM
       rake
       serverengine (~> 2.0.5)
       thor
+    solid_cache (1.0.4)
+      activejob (>= 7.2)
+      activerecord (>= 7.2)
+      railties (>= 7.2)
     sorted_set (1.0.3)
       rbtree
       set (~> 1.0)
@@ -691,6 +695,7 @@ DEPENDENCIES
   selenium-webdriver (>= 4.20.0)
   sidekiq
   sneakers
+  solid_cache
   sprockets-rails (>= 2.0.0)
   sqlite3 (>= 2.0)
   stackprof

railties/CHANGELOG.md

@@ -1,3 +1,7 @@
+*   Use [Solid Cache](https://github.com/rails/solid_cache) as the default Rails.cache backend in production, configured as a separate cache database in config/database.yml.
+
+    *DHH*
+
 *   Add Rails::Rack::SilenceRequest middleware and use it via `config.silence_healthcheck_path = path`
     to silence requests to "/up". This prevents the Kamal-required healthchecks from clogging up
     the production logs.

railties/lib/rails/generators/app_base.rb

@@ -114,6 +114,9 @@ def self.add_shared_options_for(name)
         class_option :skip_kamal,          type: :boolean, default: false,
                                            desc: "Skip Kamal setup"
 
+        class_option :skip_solid,          type: :boolean, default: false,
+                                           desc: "Skip Solid Cache & Queue setup"
+
         class_option :dev,                 type: :boolean, default: nil,
                                            desc: "Set up the #{name} with Gemfile pointing to your Rails checkout"
 
@@ -428,6 +431,10 @@ def skip_kamal?
         options[:skip_kamal]
       end
 
+      def skip_solid?
+        options[:skip_active_record] || options[:skip_solid]
+      end
+
       class GemfileEntry < Struct.new(:name, :version, :comment, :options, :commented_out)
         def initialize(name, version, comment, options = {}, commented_out = false)
           super
@@ -746,6 +753,12 @@ def run_kamal
         template "config/deploy.yml", force: true
       end
 
+      def run_solid
+        return if skip_solid? || !bundle_install?
+
+        rails_command "solid_cache:install"
+      end
+
       def add_bundler_platforms
         if bundle_install?
           # The vast majority of Rails apps will be deployed on `x86_64-linux`.

railties/lib/rails/generators/rails/app/app_generator.rb

@@ -575,6 +575,7 @@ def finish_template
       public_task :run_hotwire
       public_task :run_css
       public_task :run_kamal
+      public_task :run_solid
 
       def run_after_bundle_callbacks
         @after_bundle_callbacks.each(&:call)

railties/lib/rails/generators/rails/app/templates/Gemfile.tt

@@ -14,6 +14,11 @@ source "https://rubygems.org"
 
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
 gem "tzinfo-data", platforms: %i[ <%= bundler_windows_platforms %> jruby ]
+<% unless options.skip_solid? -%>
+
+# Use the database-backed Solid Cache adapter for Rails.cache [https://github.com/rails/solid_cache]
+gem "solid_cache"
+<% end -%>
 <% if depend_on_bootsnap? -%>
 
 # Reduces boot times through caching; required in config/boot.rb

railties/lib/rails/generators/rails/app/templates/config/databases/mysql.yml.tt

@@ -52,8 +52,21 @@ test:
 # Read https://guides.rubyonrails.org/configuring.html#configuring-a-database
 # for a full overview on how database connection configuration can be specified.
 #
+<%- if options.skip_solid? -%>
 production:
   <<: *default
   database: <%= app_name %>_production
   username: <%= app_name %>
   password: <%%= ENV["<%= app_name.upcase %>_DATABASE_PASSWORD"] %>
+<%- else -%>
+production:
+  primary: &primary_production
+    <<: *default
+    database: <%= app_name %>_production
+    username: <%= app_name %>
+    password: <%%= ENV["<%= app_name.upcase %>_DATABASE_PASSWORD"] %>
+  cache:
+    <<: *primary_production
+    database: <%= app_name %>_production_cache
+    migrations_paths: db/cache_migrate
+<%- end -%>

railties/lib/rails/generators/rails/app/templates/config/databases/postgresql.yml.tt

@@ -84,8 +84,21 @@ test:
 # Read https://guides.rubyonrails.org/configuring.html#configuring-a-database
 # for a full overview on how database connection configuration can be specified.
 #
+<%- if options.skip_solid? -%>
 production:
   <<: *default
   database: <%= app_name %>_production
   username: <%= app_name %>
   password: <%%= ENV["<%= app_name.upcase %>_DATABASE_PASSWORD"] %>
+<%- else -%>
+production:
+  primary: &primary_production
+    <<: *default
+    database: <%= app_name %>_production
+    username: <%= app_name %>
+    password: <%%= ENV["<%= app_name.upcase %>_DATABASE_PASSWORD"] %>
+  cache:
+    <<: *primary_production
+    database: <%= app_name %>_production_cache
+    migrations_paths: db/cache_migrate
+<%- end -%>

railties/lib/rails/generators/rails/app/templates/config/databases/sqlite3.yml.tt

@@ -28,13 +28,35 @@ test:
 #
 # Similarly, if you deploy your application as a Docker container, you must
 # ensure the database is located in a persisted volume.
+<%- if options.skip_solid? -%>
 production:
   <<: *default
   # database: path/to/persistent/storage/production.sqlite3
 <%- else -%>
+production:
+  primary:
+    <<: *default
+    # database: path/to/persistent/storage/production.sqlite3
+  cache:
+    <<: *default
+    # database: path/to/persistent/storage/production_cache.sqlite3
+    migrations_paths: db/cache_migrate
+<%- end -%>
+<%- else -%>
 # Store production database in the storage/ directory, which by default
 # is mounted as a persistent Docker volume in config/deploy.yml.
+<%- if options.skip_solid? -%>
 production:
   <<: *default
   database: storage/production.sqlite3
-<%- end -%>
+<%- else -%>
+production:
+  primary:
+    <<: *default
+    database: storage/production.sqlite3
+  cache:
+    <<: *default
+    database: storage/production_cache.sqlite3
+    migrations_paths: db/cache_migrate
+<%- end -%>
+<%- end -%>

railties/lib/rails/generators/rails/app/templates/config/databases/trilogy.yml.tt

@@ -52,8 +52,21 @@ test:
 # Read https://guides.rubyonrails.org/configuring.html#configuring-a-database
 # for a full overview on how database connection configuration can be specified.
 #
+<%- if options.skip_solid? -%>
 production:
   <<: *default
   database: <%= app_name %>_production
   username: <%= app_name %>
   password: <%%= ENV["<%= app_name.upcase %>_DATABASE_PASSWORD"] %>
+<%- else -%>
+production:
+  primary: &primary_production
+    <<: *default
+    database: <%= app_name %>_production
+    username: <%= app_name %>
+    password: <%%= ENV["<%= app_name.upcase %>_DATABASE_PASSWORD"] %>
+  cache:
+    <<: *primary_production
+    database: <%= app_name %>_production_cache
+    migrations_paths: db/cache_migrate
+<%- end -%>