Merge pull request rails#52934 from Shopify/no-redis-by-default-in-devcontainer

Do not include redis by default in dev container

Author: rafaelfranca

railties/CHANGELOG.md

@@ -1,3 +1,14 @@
+*   Do not include redis by default in generated Dev Containers.
+
+    Now that applications use the Solid Queue and Solid Cache gems by default, we do not need to include redis
+    in the Dev Container. We will only include redis if `--skip-solid` is used when generating an app that uses
+    Active Job or Action Cable.
+
+    When generating a Dev Container for an existing app, we will not include redis if either of the solid gems
+    are in use.
+
+    *Andrew Novoselac*
+
 *   Use [Solid Cable](https://github.com/rails/solid_cable) as the default Action Cable adapter in production, configured as a separate queue database in config/database.yml. It keeps messages in a table and continuously 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.
 
     *DHH*

railties/lib/rails/commands/devcontainer/devcontainer_command.rb

@@ -24,7 +24,7 @@ def devcontainer_options
             app_name: Rails.application.railtie_name.chomp("_application"),
             database: !!defined?(ActiveRecord) && database,
             active_storage: !!defined?(ActiveStorage),
-            redis: !!(defined?(ActionCable) || defined?(ActiveJob)),
+            redis: !!((defined?(ActionCable) && !defined?(SolidCable)) || (defined?(ActiveJob) && !defined?(SolidQueue))),
             system_test: File.exist?("test/application_system_test_case.rb"),
             node: File.exist?(".node-version"),
           }

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

@@ -265,7 +265,7 @@ def config_target_version
     def devcontainer
       devcontainer_options = {
         database: options[:database],
-        redis: !(options[:skip_action_cable] && options[:skip_active_job]),
+        redis: options[:skip_solid] && !(options[:skip_action_cable] && options[:skip_active_job]),
         system_test: depends_on_system_test?,
         active_storage: !options[:skip_active_storage],
         dev: options[:dev],

railties/test/commands/devcontainer_test.rb

@@ -8,33 +8,39 @@ class Rails::Command::DevcontainerTest < ActiveSupport::TestCase
 
   teardown { teardown_app }
 
-  test "generates devcontainer for default app" do
+  test "generates devcontainer for default app with solid gems" do
     build_app
 
+    require "solid_cable"
+    require "solid_queue"
+
     output = rails "devcontainer"
 
     assert_match "app_name: app_template", output
     assert_match "database: sqlite3", output
     assert_match "active_storage: true", output
-    assert_match "redis: true", output
+    assert_match "redis: false", output
     assert_match "system_test: true", output
     assert_match "node: false", output
   end
 
-  test "generates devcontainer for using mysql2 app" do
+  test "generates dev container for without solid gems" do
+    build_app
+
+    output = rails "devcontainer"
+
+    assert_match "redis: true", output
+  end
+
+  test "generates dev container for using mysql2 app" do
     build_app
 
     Dir.chdir(app_path) do
       use_mysql2
 
       output = rails "devcontainer"
 
-      assert_match "app_name: app_template", output
       assert_match "database: mysql", output
-      assert_match "active_storage: true", output
-      assert_match "redis: true", output
-      assert_match "system_test: true", output
-      assert_match "node: false", output
 
       assert_match "ghcr.io/rails/devcontainer/features/mysql-client", read_file(".devcontainer/devcontainer.json")
     end

railties/test/generators/app_generator_test.rb

@@ -1256,14 +1256,12 @@ def test_devcontainer
 
     assert_devcontainer_json_file do |content|
       assert_equal "my_app", content["name"]
-      assert_equal "redis://redis:6379/1", content["containerEnv"]["REDIS_URL"]
       assert_equal "45678", content["containerEnv"]["CAPYBARA_SERVER_PORT"]
       assert_equal "selenium", content["containerEnv"]["SELENIUM_HOST"]
       assert_includes content["features"].keys, "ghcr.io/rails/devcontainer/features/activestorage"
       assert_includes content["features"].keys, "ghcr.io/devcontainers/features/github-cli:1"
       assert_includes content["features"].keys, "ghcr.io/rails/devcontainer/features/sqlite3"
       assert_includes(content["forwardPorts"], 3000)
-      assert_includes(content["forwardPorts"], 6379)
     end
     assert_file(".devcontainer/Dockerfile") do |content|
       assert_match(/ARG RUBY_VERSION=#{RUBY_VERSION}/, content)
@@ -1284,7 +1282,7 @@ def test_devcontainer
         },
         "volumes" => ["../..:/workspaces:cached"],
         "command" => "sleep infinity",
-        "depends_on" => ["selenium", "redis"]
+        "depends_on" => ["selenium"]
       }
 
       assert_equal expected_rails_app_config, compose_config["services"]["rails-app"]
@@ -1295,6 +1293,19 @@ def test_devcontainer
       }
 
       assert_equal expected_selenium_conifg, compose_config["services"]["selenium"]
+    end
+  end
+
+  def test_devcontainer_include_redis_skipping_solid
+    run_generator [destination_root, "--devcontainer", "--name=my-app", "--skip-solid"]
+
+    assert_devcontainer_json_file do |content|
+      assert_equal "redis://redis:6379/1", content["containerEnv"]["REDIS_URL"]
+      assert_includes content["forwardPorts"], 6379
+    end
+
+    assert_compose_file do |compose_config|
+      assert_includes compose_config["services"]["rails-app"]["depends_on"], "redis"
 
       expected_redis_config = {
         "image" => "redis:7.2",
@@ -1303,12 +1314,12 @@ def test_devcontainer
       }
 
       assert_equal expected_redis_config, compose_config["services"]["redis"]
-      assert_equal ["redis-data"], compose_config["volumes"].keys
+      assert_includes compose_config["volumes"].keys, "redis-data"
     end
   end
 
-  def test_devcontainer_no_redis_skipping_action_cable_and_active_job
-    run_generator [ destination_root, "--devcontainer", "--skip-action-cable", "--skip-active-job" ]
+  def test_devcontainer_no_redis_skipping_solid_action_cable_and_active_job
+    run_generator [ destination_root, "--devcontainer", "--skip-action-cable", "--skip-active-job", "--skip-solid" ]
 
     assert_compose_file do |compose_config|
       assert_not_includes compose_config["services"]["rails-app"]["depends_on"], "redis"
@@ -1468,11 +1479,11 @@ def test_devcontainer_no_selenium_when_skipping_system_test
     run_generator [ destination_root, "--devcontainer", "--skip-system-test" ]
 
     assert_compose_file do |compose_config|
-      assert_not_includes compose_config["services"]["rails-app"]["depends_on"], "selenium"
+      assert_nil compose_config["services"]["rails-app"]["depends_on"]
       assert_not_includes compose_config["services"].keys, "selenium"
     end
     assert_devcontainer_json_file do |content|
-      assert_nil content["containerEnv"]["CAPYBARA_SERVER_PORT"]
+      assert_nil content["containerEnv"]
     end
   end