Merge pull request #28154 from aripollak/remove-comments-from-structu…

…re-sql

Drop comments from structure.sql in postgresql

activerecord/CHANGELOG.md

@@ -1,3 +1,10 @@
+*   Remove comments from structure.sql when using postgresql adapter to avoid
+    version-specific parts of the file.
+
+    Fixes #28153.
+
+    *Ari Pollak*
+
 *   Add `:default` option to `belongs_to`.
 
     Use it to specify that an association should be initialized with a particular

activerecord/lib/active_record/tasks/postgresql_database_tasks.rb

@@ -1,8 +1,11 @@
+require "tempfile"
+
 module ActiveRecord
   module Tasks # :nodoc:
     class PostgreSQLDatabaseTasks # :nodoc:
       DEFAULT_ENCODING = ENV["CHARSET"] || "utf8"
       ON_ERROR_STOP_1 = "ON_ERROR_STOP=1".freeze
+      SQL_COMMENT_BEGIN = "--".freeze
 
       delegate :connection, :establish_connection, :clear_active_connections!,
         to: ActiveRecord::Base
@@ -65,6 +68,7 @@ def structure_dump(filename, extra_flags)
         end
         args << configuration["database"]
         run_cmd("pg_dump", args, "dumping")
+        remove_sql_header_comments(filename)
         File.open(filename, "a") { |f| f << "SET search_path TO #{connection.schema_search_path};\n\n" }
       end
 
@@ -110,6 +114,22 @@ def run_cmd_error(cmd, args, action)
           msg << "Please check the output above for any errors and make sure that `#{cmd}` is installed in your PATH and has proper permissions.\n\n"
           msg
         end
+
+        def remove_sql_header_comments(filename)
+          removing_comments = true
+          tempfile = Tempfile.open("uncommented_structure.sql")
+          begin
+            File.foreach(filename) do |line|
+              unless removing_comments && (line.start_with?(SQL_COMMENT_BEGIN) || line.blank?)
+                tempfile << line
+                removing_comments = false
+              end
+            end
+          ensure
+            tempfile.close
+          end
+          FileUtils.mv(tempfile.path, filename)
+        end
     end
   end
 end

activerecord/test/cases/tasks/postgresql_rake_test.rb

@@ -217,17 +217,21 @@ def test_db_retrieves_collation
 
     class PostgreSQLStructureDumpTest < ActiveRecord::TestCase
       def setup
-        @connection    = stub(structure_dump: true)
+        @connection    = stub(schema_search_path: nil, structure_dump: true)
         @configuration = {
           "adapter"  => "postgresql",
           "database" => "my-app-db"
         }
-        @filename = "awesome-file.sql"
+        @filename = "/tmp/awesome-file.sql"
+        FileUtils.touch(@filename)
 
         ActiveRecord::Base.stubs(:connection).returns(@connection)
         ActiveRecord::Base.stubs(:establish_connection).returns(true)
         Kernel.stubs(:system)
-        File.stubs(:open)
+      end
+
+      def teardown
+        FileUtils.rm_f(@filename)
       end
 
       def test_structure_dump
@@ -236,6 +240,15 @@ def test_structure_dump
         ActiveRecord::Tasks::DatabaseTasks.structure_dump(@configuration, @filename)
       end
 
+      def test_structure_dump_header_comments_removed
+        Kernel.stubs(:system).returns(true)
+        File.write(@filename, "-- header comment\n\n-- more header comment\n statement \n-- lower comment\n")
+
+        ActiveRecord::Tasks::DatabaseTasks.structure_dump(@configuration, @filename)
+
+        assert_equal [" statement \n", "-- lower comment\n"], File.readlines(@filename).first(2)
+      end
+
       def test_structure_dump_with_extra_flags
         expected_command = ["pg_dump", "-s", "-x", "-O", "-f", @filename, "--noop", "my-app-db"]