From 14ed971db694ce632363cd17e4abc82c79428c7f Mon Sep 17 00:00:00 2001
From: Alan Guo Xiang Tan <gxtan1990@gmail.com>
Date: Mon, 5 Jun 2023 09:01:41 +0900
Subject: [PATCH] DEV: Use runtime info to split test files for parallel
 testing (#21896)

Using the runtime information, we will be able to more efficiently group
the test files across the test processes hence leading to better
utilization of resources.
---
 .github/workflows/tests.yml | 13 +++++++------
 bin/turbo_rspec             | 20 ++++++++++++--------
 2 files changed, 19 insertions(+), 14 deletions(-)

diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
index 83814afb118..b6cbd383a15 100644
--- a/.github/workflows/tests.yml
+++ b/.github/workflows/tests.yml
@@ -150,10 +150,11 @@ jobs:
       - name: Fetch turbo_rspec_runtime.log cache
         uses: actions/cache@v3
         id: test-runtime-cache
-        if: matrix.build_type == 'backend' && matrix.target == 'core'
+        if: matrix.build_type == 'backend' || matrix.build_type == 'system'
         with:
           path: tmp/turbo_rspec_runtime.log
-          key: rspec-runtime-backend-core
+          key: rspec-runtime-${{ matrix.build_type }}-${{ matrix.target }}-${{ github.run_id }}
+          restore-keys: rspec-runtime-${{ matrix.build_type }}-${{ matrix.target }}-
 
       - name: Run Zeitwerk check
         if: matrix.build_type == 'backend'
@@ -173,11 +174,11 @@ jobs:
 
       - name: Core RSpec
         if: matrix.build_type == 'backend' && matrix.target == 'core'
-        run: bin/turbo_rspec --verbose
+        run: bin/turbo_rspec --use-runtime-info --verbose
 
       - name: Plugin RSpec
         if: matrix.build_type == 'backend' && matrix.target == 'plugins'
-        run: bin/rake plugin:turbo_spec['*','--verbose --format documentation']
+        run: bin/rake plugin:turbo_spec['*','--verbose --format documentation --use-runtime-info']
 
       - name: Plugin QUnit
         if: matrix.build_type == 'frontend' && matrix.target == 'plugins'
@@ -194,11 +195,11 @@ jobs:
 
       - name: Core System Tests
         if: matrix.build_type == 'system' && matrix.target == 'core'
-        run: PARALLEL_TEST_PROCESSORS=5 bin/turbo_rspec --profile=50 --verbose --format documentation spec/system
+        run: PARALLEL_TEST_PROCESSORS=5 bin/turbo_rspec --use-runtime-info --profile=50 --verbose --format documentation spec/system
 
       - name: Plugin System Tests
         if: matrix.build_type == 'system' && matrix.target == 'plugins'
-        run: LOAD_PLUGINS=1 PARALLEL_TEST_PROCESSORS=5 bin/turbo_rspec --profile=50 --verbose --format documentation plugins/*/spec/system
+        run: LOAD_PLUGINS=1 PARALLEL_TEST_PROCESSORS=5 bin/turbo_rspec --use-runtime-info --profile=50 --verbose --format documentation plugins/*/spec/system
         timeout-minutes: 30
 
       - name: Upload failed system test screenshots
diff --git a/bin/turbo_rspec b/bin/turbo_rspec
index 75cf12f4cf4..bdf8f42b6a7 100755
--- a/bin/turbo_rspec
+++ b/bin/turbo_rspec
@@ -14,6 +14,14 @@ seed = rand(2**16)
 profile = false
 profile_print_slowest_examples_count = 10
 
+if ARGV.empty?
+  files = TurboTests::Runner.default_spec_folders
+  use_runtime_info = true
+else
+  files = ARGV
+  use_runtime_info = false
+end
+
 OptionParser
   .new do |opts|
     opts.on("-r", "--require PATH", "Require a file.") { |filename| requires << filename }
@@ -49,6 +57,10 @@ OptionParser
     end
 
     opts.on("--seed SEED", "The seed for the random order") { |s| seed = s.to_i }
+
+    opts.on("--use-runtime-info", "Use runtime info for tests group splitting") do
+      use_runtime_info = true
+    end
   end
   .parse!(ARGV)
 
@@ -58,14 +70,6 @@ formatters << { name: "progress", outputs: [] } if formatters.empty?
 
 formatters.each { |formatter| formatter[:outputs] << "-" if formatter[:outputs].empty? }
 
-if ARGV.empty?
-  files = TurboTests::Runner.default_spec_folders
-  use_runtime_info = true
-else
-  files = ARGV
-  use_runtime_info = false
-end
-
 puts "::group::Run turbo_rspec" if ENV["GITHUB_ACTIONS"]
 puts "Running turbo_rspec (seed: #{seed}) using files in: #{files}"
 puts "::endgroup::" if ENV["GITHUB_ACTIONS"]