Merge pull request rails#51588 from duduribeiro/add-devcontainer-forward-ports

Change devcontainer.json to forward used ports for the project

Author: rafaelfranca

railties/lib/rails/generators/devcontainer.rb

@@ -64,10 +64,27 @@ def devcontainer_mounts
           @devcontainer_mounts
         end
 
+        def devcontainer_forward_ports
+          return @devcontainer_forward_ports if @devcontainer_forward_ports
+
+          @devcontainer_forward_ports = [3000]
+          @devcontainer_forward_ports << db_port_for_devcontainer if db_port_for_devcontainer
+          @devcontainer_forward_ports << 6379 if devcontainer_needs_redis?
+
+          @devcontainer_forward_ports
+        end
+
         def devcontainer_needs_redis?
           !(options.skip_action_cable? && options.skip_active_job?)
         end
 
+        def db_port_for_devcontainer(database = options[:database])
+          case database
+          when "mysql", "trilogy" then 3306
+          when "postgresql"       then 5432
+          end
+        end
+
         def db_name_for_devcontainer(database = options[:database])
           case database
           when "mysql"          then "mysql"

railties/lib/rails/generators/rails/app/templates/.devcontainer/devcontainer.json.tt

@@ -18,7 +18,7 @@
 <%- end -%>
 
   // Use 'forwardPorts' to make a list of ports inside the container available locally.
-  // "forwardPorts": [],
+  "forwardPorts": <%= devcontainer_forward_ports.as_json %>,
 
   // Configure tool-specific properties.
   // "customizations": {},

railties/test/generators/app_generator_test.rb

@@ -1248,6 +1248,8 @@ def test_devcontainer
       assert_equal "selenium", content["containerEnv"]["SELENIUM_HOST"]
       assert_equal({}, content["features"]["ghcr.io/rails/devcontainer/features/activestorage"])
       assert_equal({}, content["features"]["ghcr.io/devcontainers/features/github-cli:1"])
+      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)
@@ -1295,9 +1297,13 @@ def test_devcontainer_no_redis_skipping_action_cable_and_active_job
       assert_nil compose_config["services"]["redis"]
       assert_nil compose_config["volumes"]
     end
+
+    assert_devcontainer_json_file do |content|
+      assert_not_includes content["forwardPorts"], 6379
+    end
   end
 
-  def test_devonctainer_postgresql
+  def test_devcontainer_postgresql
     run_generator [ destination_root, "-d", "postgresql" ]
 
     assert_compose_file do |compose_config|
@@ -1320,13 +1326,14 @@ def test_devonctainer_postgresql
     assert_devcontainer_json_file do |content|
       assert_equal "postgres", content["containerEnv"]["DB_HOST"]
       assert_equal({}, content["features"]["ghcr.io/rails/devcontainer/features/postgres-client"])
+      assert_includes(content["forwardPorts"], 5432)
     end
     assert_file("config/database.yml") do |content|
       assert_match(/host: <%= ENV\["DB_HOST"\] %>/, content)
     end
   end
 
-  def test_devonctainer_mysql
+  def test_devcontainer_mysql
     run_generator [ destination_root, "-d", "mysql" ]
 
     assert_compose_file do |compose_config|
@@ -1349,13 +1356,14 @@ def test_devonctainer_mysql
     assert_devcontainer_json_file do |content|
       assert_equal "mysql", content["containerEnv"]["DB_HOST"]
       assert_equal({}, content["features"]["ghcr.io/rails/devcontainer/features/mysql-client"])
+      assert_includes(content["forwardPorts"], 3306)
     end
     assert_file("config/database.yml") do |content|
       assert_match(/host: <%= ENV.fetch\("DB_HOST"\) \{ "localhost" } %>/, content)
     end
   end
 
-  def test_devonctainer_mariadb
+  def test_devcontainer_mariadb
     run_generator [ destination_root, "-d", "trilogy" ]
 
     assert_compose_file do |compose_config|
@@ -1375,6 +1383,7 @@ def test_devonctainer_mariadb
     end
     assert_devcontainer_json_file do |content|
       assert_equal "mariadb", content["containerEnv"]["DB_HOST"]
+      assert_includes(content["forwardPorts"], 3306)
     end
     assert_file("config/database.yml") do |content|
       assert_match(/host: <%= ENV.fetch\("DB_HOST"\) \{ "localhost" } %>/, content)