Use skip_solid_cache? in templates

Adding this highlighted that we need to add support to the change
template for deciding whether to include the solid cache configuration
when migrating.

Author: djmb

railties/lib/rails/generators/app_base.rb

@@ -649,7 +649,7 @@ def cable_gemfile_entry
       end
 
       def solid_cache_gemfile_entry
-        return if options[:skip_solid_cache]
+        return if skip_solid_cache?
 
         comment = "Use Solid Cache for caching (https://github.com/rails/solid_cache)"
         GemfileEntry.new("solid_cache", ">= 1.0.1", comment, {}, false)

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

@@ -22,10 +22,10 @@ default: &default
 <% end -%>
 
 development:
-  primary:<% unless options[:skip_solid_cache] %> &development_primary<% end %>
+  primary:<% unless skip_solid_cache? %> &development_primary<% end %>
     <<: *default
     database: <%= app_name %>_development
-<% unless options[:skip_solid_cache] -%>
+<% unless skip_solid_cache? -%>
   cache:
     <<: *development_primary
 <% end -%>
@@ -34,10 +34,10 @@ development:
 # re-generated from your development database when you run "rake".
 # Do not set this db to the same as development or production.
 test:
-  primary:<% unless options[:skip_solid_cache] %> &test_primary<% end %>
+  primary:<% unless skip_solid_cache? %> &test_primary<% end %>
     <<: *default
     database: <%= app_name %>_test
-<% unless options[:skip_solid_cache] -%>
+<% unless skip_solid_cache? -%>
   cache:
     <<: *test_primary
 <% end -%>
@@ -63,12 +63,12 @@ test:
 # for a full overview on how database connection configuration can be specified.
 #
 production:
-  primary:<% unless options[:skip_solid_cache] %> &production_primary<% end %>
+  primary:<% unless skip_solid_cache? %> &production_primary<% end %>
     <<: *default
     database: <%= app_name %>_production
     username: <%= app_name %>
     password: <%%= ENV["<%= app_name.upcase %>_DATABASE_PASSWORD"] %>
-<% unless options[:skip_solid_cache] -%>
+<% unless skip_solid_cache? -%>
   cache:
     <<: *production_primary
 <% end -%>

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

@@ -27,7 +27,7 @@ default: &default
 <% end %>
 
 development:
-  primary:<% unless options[:skip_solid_cache] %> &development_primary<% end %>
+  primary:<% unless skip_solid_cache? %> &development_primary<% end %>
     <<: *default
     database: <%= app_name %>_development
 
@@ -57,7 +57,7 @@ development:
     #   log, notice, warning, error, fatal, and panic
     # Defaults to warning.
     #min_messages: notice
-<% unless options[:skip_solid_cache] -%>
+<% unless skip_solid_cache? -%>
   cache:
     <<: *development_primary
 <% end -%>
@@ -66,10 +66,10 @@ development:
 # re-generated from your development database when you run "rake".
 # Do not set this db to the same as development or production.
 test:
-  primary: <% unless options[:skip_solid_cache] %> &test_primary<% end %>
+  primary: <% unless skip_solid_cache? %> &test_primary<% end %>
     <<: *default
     database: <%= app_name %>_test
-<% unless options[:skip_solid_cache] -%>
+<% unless skip_solid_cache? -%>
   cache:
     <<: *test_primary
 <% end -%>
@@ -95,12 +95,12 @@ test:
 # for a full overview on how database connection configuration can be specified.
 #
 production:
-  primary:<% unless options[:skip_solid_cache] %> &production_primary<% end %>
+  primary:<% unless skip_solid_cache? %> &production_primary<% end %>
     <<: *default
     database: <%= app_name %>_production
     username: <%= app_name %>
     password: <%%= ENV["<%= app_name.upcase %>_DATABASE_PASSWORD"] %>
-<% unless options[:skip_solid_cache] -%>
+<% unless skip_solid_cache? -%>
   cache:
     <<: *production_primary
 <% end -%>

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

@@ -13,7 +13,7 @@ development:
   primary:
     <<: *default
     database: storage/development.sqlite3
-<% unless options[:skip_solid_cache] -%>
+<% unless skip_solid_cache? -%>
   cache:
     <<: *default
     database: storage/development_cache.sqlite3
@@ -27,7 +27,7 @@ test:
   primary:
     <<: *default
     database: storage/test.sqlite3
-<% unless options[:skip_solid_cache] -%>
+<% unless skip_solid_cache? -%>
   cache:
     <<: *default
     database: storage/test_cache.sqlite3
@@ -45,7 +45,7 @@ production:
   primary:
     <<: *default
     # database: path/to/persistent/storage/production.sqlite3
-<% unless options[:skip_solid_cache] -%>
+<% unless skip_solid_cache? -%>
   cache:
     <<: *default
     # database: path/to/persistent/storage/production_cache.sqlite3
@@ -58,7 +58,7 @@ production:
   primary:
     <<: *default
     database: storage/production.sqlite3
-<% unless options[:skip_solid_cache] -%>
+<% unless skip_solid_cache? -%>
   cache:
     <<: *default
     database: storage/production_cache.sqlite3

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

@@ -22,10 +22,10 @@ default: &default
 <% end -%>
 
 development:
-  primary:<% unless options[:skip_solid_cache] %> &development_primary<% end %>
+  primary:<% unless skip_solid_cache? %> &development_primary<% end %>
     <<: *default
     database: <%= app_name %>_development
-<% unless options[:skip_solid_cache] -%>
+<% unless skip_solid_cache? -%>
   cache:
     <<: *development_primary
 <% end -%>
@@ -34,10 +34,10 @@ development:
 # re-generated from your development database when you run "rake".
 # Do not set this db to the same as development or production.
 test:
-  primary:<% unless options[:skip_solid_cache] %> &test_primary<% end %>
+  primary:<% unless skip_solid_cache? %> &test_primary<% end %>
     <<: *default
     database: <%= app_name %>_test
-<% unless options[:skip_solid_cache] -%>
+<% unless skip_solid_cache? -%>
   cache:
     <<: *test_primary
 <% end -%>
@@ -63,12 +63,12 @@ test:
 # for a full overview on how database connection configuration can be specified.
 #
 production:
-  primary:<% unless options[:skip_solid_cache] %> &production_primary<% end %>
+  primary:<% unless skip_solid_cache? %> &production_primary<% end %>
     <<: *default
     database: <%= app_name %>_production
     username: <%= app_name %>
     password: <%%= ENV["<%= app_name.upcase %>_DATABASE_PASSWORD"] %>
-<% unless options[:skip_solid_cache] -%>
+<% unless skip_solid_cache? -%>
   cache:
     <<: *production_primary
 <% end -%>

railties/lib/rails/generators/rails/app/templates/config/environments/production.rb.tt

@@ -73,7 +73,7 @@ Rails.application.configure do
   # want to log everything, set the level to "debug".
   config.log_level = ENV.fetch("RAILS_LOG_LEVEL", "info")
 
-  <%- if options[:skip_solid_cache] -%>
+  <%- if skip_solid_cache? -%>
   # Use a different cache store in production.
   # config.cache_store = :mem_cache_store
   <%- else -%>

railties/lib/rails/generators/rails/db/system/change/change_generator.rb

@@ -60,10 +60,12 @@ def edit_devcontainer_files
           end
 
           def move_migrations
-            if database.name == "sqlite3"
-              move_solid_cache_migrations from: "db/migrate", to: "db/cache/migrate"
-            else
-              move_solid_cache_migrations from: "db/cache/migrate", to: "db/migrate"
+            unless skip_solid_cache?
+              if database.name == "sqlite3"
+                move_solid_cache_migrations from: "db/migrate", to: "db/cache/migrate"
+              else
+                move_solid_cache_migrations from: "db/cache/migrate", to: "db/migrate"
+              end
             end
           end
 
@@ -208,6 +210,14 @@ def devcontainer?
               @devcontainer = File.exist?(File.expand_path(".devcontainer", destination_root))
             end
 
+            def skip_solid_cache?
+              return @skip_solid_cache if defined?(@skip_solid_cache)
+
+              @skip_solid_cache = \
+                Dir.glob(File.expand_path("db/cache/migrate/*.solid_cache.rb", destination_root)).empty? &&
+                Dir.glob(File.expand_path("db/migrate/*.solid_cache.rb", destination_root)).empty?
+            end
+
             def move_solid_cache_migrations(from:, to:)
               migrations_from_folder = File.expand_path(from, destination_root)
               migrations_to_folder = File.expand_path(to, destination_root)

railties/lib/rails/generators/rails/devcontainer/devcontainer_generator.rb

@@ -55,6 +55,10 @@ def devcontainer?
           true
         end
 
+        def skip_solid_cache?
+          options[:skip_solid_cache]
+        end
+
         def app_name
           options[:app_name]
         end

railties/test/generators/db_system_change_generator_test.rb

@@ -40,6 +40,7 @@ class ChangeGeneratorTest < Rails::Generators::TestCase
               assert_match "adapter: postgresql", content
               assert_match "database: tmp_production", content
               assert_match "host: <%= ENV[\"DB_HOST\"] %>", content
+              assert_match "cache:\n    <<: *production_primary", content
             end
 
             assert_file("Gemfile") do |content|
@@ -85,6 +86,7 @@ class ChangeGeneratorTest < Rails::Generators::TestCase
             assert_file("config/database.yml") do |content|
               assert_match "adapter: mysql2", content
               assert_match "database: tmp_production", content
+              assert_match "cache:\n    <<: *production_primary", content
             end
 
             assert_file("Gemfile") do |content|
@@ -129,6 +131,7 @@ class ChangeGeneratorTest < Rails::Generators::TestCase
             assert_file("config/database.yml") do |content|
               assert_match "adapter: sqlite3", content
               assert_match "storage/development.sqlite3", content
+              assert_match "cache:\n    <<: *default", content
             end
 
             assert_file("Gemfile") do |content|
@@ -186,9 +189,9 @@ class ChangeGeneratorTest < Rails::Generators::TestCase
 
               assert_equal expected_mariadb_config, compose_config["services"]["mariadb"]
               assert_includes compose_config["volumes"].keys, "mariadb-data"
-
-              assert_solid_cache_migration here: "db/migrate", not_here: "db/cache/migrate"
             end
+
+            assert_solid_cache_migration here: "db/migrate", not_here: "db/cache/migrate"
           end
 
           test "change from versioned gem to other versioned gem" do
@@ -198,6 +201,7 @@ class ChangeGeneratorTest < Rails::Generators::TestCase
             assert_file("config/database.yml") do |content|
               assert_match "adapter: mysql2", content
               assert_match "database: tmp_production", content
+              assert_match "cache:\n    <<: *production_primary", content
             end
 
             assert_file("Gemfile") do |content|
@@ -223,6 +227,21 @@ class ChangeGeneratorTest < Rails::Generators::TestCase
               assert_not_includes compose_config.keys, "volumes"
             end
           end
+
+          test "change without solid cache" do
+            rm_r(File.expand_path("db/cache/migrate", destination_root))
+
+            run_generator ["--to", "postgresql"]
+
+            assert_file("config/database.yml") do |content|
+              assert_match "adapter: postgresql", content
+              assert_match "database: tmp_production", content
+              assert_match "host: <%= ENV[\"DB_HOST\"] %>", content
+              assert_no_match "cache:\n    <<: *production_primary", content
+            end
+
+            assert_no_solid_cache_migration
+          end
         end
       end
     end

railties/test/generators/generators_test_helper.rb

@@ -144,6 +144,11 @@ def assert_solid_cache_migration(here:, not_here:)
     assert_no_file "#{not_here}/20240821135818_create_solid_cache_entries.solid_cache.rb"
   end
 
+  def assert_no_solid_cache_migration
+    assert_no_file "db/migrate/20240821135818_create_solid_cache_entries.solid_cache.rb"
+    assert_no_file "db/cache/migrate/20240821135818_create_solid_cache_entries.solid_cache.rb"
+  end
+
   def run_app_update(app_root = destination_root, flags: "--force")
     Dir.chdir(app_root) do
       gemfile_contents = File.read("Gemfile")