From f9330364d1da308dc04fd22a3c50b70f05020cbf Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Szikszai=20Guszt=C3=A1v?= <guszti5@hotmail.com>
Date: Tue, 19 Sep 2023 17:50:21 +0200
Subject: [PATCH 1/3] Added `--watch` flag for test command.

Fixes #644
---
 src/commands/test.cr                      |  26 ++++--
 src/render/terminal.cr                    |   4 +
 src/test_runner.cr                        | 103 +++++++++++++++-------
 src/test_runner.ecr                       |   3 +
 src/test_runner/documentation_reporter.cr |   3 +
 src/test_runner/dot_reporter.cr           |   4 +
 src/test_runner/reporter.cr               |   1 +
 7 files changed, 106 insertions(+), 38 deletions(-)

diff --git a/src/commands/test.cr b/src/commands/test.cr
index d238fa320..08ee705a2 100644
--- a/src/commands/test.cr
+++ b/src/commands/test.cr
@@ -48,14 +48,30 @@ module Mint
         description: "Will use supplied runtime path instead of the default distribution",
         required: false
 
-      define_argument test : String
+      define_flag watch : Bool,
+        description: "Watch files for changes and rerun tests",
+        required: false
+
+      define_argument test : String,
+        description: "The path to the test file to run"
 
       def run
-        succeeded = nil
-        execute "Running Tests" do
-          succeeded = TestRunner.new(flags, arguments).run
+        MintJson.parse_current.check_dependencies!
+
+        runner =
+          TestRunner.new(flags, arguments)
+
+        if flags.watch
+          runner.watch
+        else
+          succeeded = nil
+
+          execute "Running Tests" do
+            succeeded = runner.run
+          end
+
+          exit(1) unless succeeded
         end
-        exit(1) unless succeeded
       end
     end
   end
diff --git a/src/render/terminal.cr b/src/render/terminal.cr
index 1dce912a0..769df69c6 100644
--- a/src/render/terminal.cr
+++ b/src/render/terminal.cr
@@ -247,6 +247,10 @@ module Mint
         print contents.to_s
       end
 
+      def reset
+        print "\ec"
+      end
+
       def puts(contents = nil)
         print contents if contents
         print "\n"
diff --git a/src/test_runner.cr b/src/test_runner.cr
index d8b377942..e4d493727 100644
--- a/src/test_runner.cr
+++ b/src/test_runner.cr
@@ -5,6 +5,7 @@ module Mint
     class Message
       include JSON::Serializable
 
+      property id : String
       property type : String
       property name : String?
       property suite : String?
@@ -31,8 +32,10 @@ module Mint
     @reporter : Reporter
     @browser_path : String?
     @script : String?
+    @browser : {Process, String}? = nil
 
     @failed = [] of Message
+    @test_id = Random::Secure.hex
     @succeeded = 0
 
     def initialize(@flags : Cli::Test::Flags, @arguments : Cli::Test::Arguments)
@@ -46,14 +49,45 @@ module Mint
       @succeeded = 0
     end
 
-    def run : Bool
-      MintJson.parse_current.check_dependencies!
+    def watch
+      workspace = Workspace.current
+      workspace.on "change" { |result| run_tests }
+      workspace.watch
+
+      setup_kemal
+      run_tests
+
+      Server.run "Test", @flags.host, @flags.port
+    end
 
-      ast = terminal.measure "#{COG} Compiling tests..." do
+    def compile
+      terminal.measure "#{COG} Compiling tests..." do
         compile_ast.tap do |a|
           @script = compile_script(a)
         end
       end
+    end
+
+    def run_tests
+      @test_id = Random::Secure.hex
+      cleanup_browser
+      terminal.reset
+
+      begin
+        @reporter.reset
+        compile
+        open_page
+      rescue error : Error
+        terminal.reset
+        terminal.puts error.to_terminal
+      rescue error
+        terminal.reset
+        terminal.puts error.to_s
+      end
+    end
+
+    def run : Bool
+      ast = compile
 
       if ast.try(&.suites.empty?)
         terminal.puts
@@ -186,13 +220,17 @@ module Mint
 
       begin
         process = open_process(browser_path, profile_directory)
-        at_exit do
-          process.signal(:kill) rescue nil
-          FileUtils.rm_rf(profile_directory)
-        end
+        @browser = {process, profile_directory}
+        at_exit { cleanup_browser }
         @channel.receive
       ensure
-        process.try &.signal(:kill) rescue nil
+        cleanup_browser
+      end
+    end
+
+    def cleanup_browser
+      @browser.try do |(process, profile_directory)|
+        process.signal(:kill) rescue nil
         FileUtils.rm_rf(profile_directory)
       end
     end
@@ -206,9 +244,6 @@ module Mint
       ws_url =
         "ws://#{@flags.browser_host}:#{@flags.browser_port}/"
 
-      page_source =
-        ECR.render("#{__DIR__}/test_runner.ecr")
-
       runtime =
         if runtime_path = @flags.runtime
           Cli.runtime_file_not_found(runtime_path) unless File.exists?(runtime_path)
@@ -219,7 +254,7 @@ module Mint
 
       get "/" do
         reset
-        page_source
+        ECR.render("#{__DIR__}/test_runner.ecr")
       end
 
       get "/external-javascripts.js" do |env|
@@ -277,26 +312,28 @@ module Mint
     end
 
     def handle_message(data : Message) : Nil
-      case data.type
-      when "LOG"
-        terminal.puts data.result
-      when "SUITE"
-        @reporter.suite data.suite
-      when "SUCCEEDED"
-        @reporter.succeeded data.name
-        @succeeded += 1
-      when "FAILED"
-        @reporter.failed data.name, data.result
-        @failed << data
-      when "ERRORED"
-        @reporter.errored data.name, data.result
-        @failed << data
-      when "CRASHED"
-        @reporter.crashed data.result
-        @failed << data
-
-        @reporter.done
-        stop_server
+      if data.id == @test_id
+        case data.type
+        when "LOG"
+          terminal.puts data.result
+        when "SUITE"
+          @reporter.suite data.suite
+        when "SUCCEEDED"
+          @reporter.succeeded data.name
+          @succeeded += 1
+        when "FAILED"
+          @reporter.failed data.name, data.result
+          @failed << data
+        when "ERRORED"
+          @reporter.errored data.name, data.result
+          @failed << data
+        when "CRASHED"
+          @reporter.crashed data.result
+          @failed << data
+
+          @reporter.done
+          stop_server unless @flags.watch
+        end
       end
     end
 
@@ -335,7 +372,7 @@ module Mint
           end
         end
 
-      stop_server
+      stop_server unless @flags.watch
     end
 
     def stop_server
diff --git a/src/test_runner.ecr b/src/test_runner.ecr
index 10f270f95..45f7d4ef7 100644
--- a/src/test_runner.ecr
+++ b/src/test_runner.ecr
@@ -8,6 +8,8 @@
     <script src="/external-javascripts.js"></script>
     <script src="/runtime.js"></script>
     <script>
+      window.TEST_ID = "<%= @test_id %>";
+
       class TestRunner {
         constructor () {
           this.socket = new WebSocket("<%= ws_url %>")
@@ -66,6 +68,7 @@
             message = message.toString()
           }
           this.socket.send(JSON.stringify({
+            id: window.TEST_ID,
             type: type,
             suite: suite,
             name: name,
diff --git a/src/test_runner/documentation_reporter.cr b/src/test_runner/documentation_reporter.cr
index e59447699..a1244d07c 100644
--- a/src/test_runner/documentation_reporter.cr
+++ b/src/test_runner/documentation_reporter.cr
@@ -23,6 +23,9 @@ module Mint
       def done
       end
 
+      def reset
+      end
+
       def crashed(message)
         puts "❗ An internal error occurred while executing a test: #{message}".colorize(:red)
       end
diff --git a/src/test_runner/dot_reporter.cr b/src/test_runner/dot_reporter.cr
index 5fb2b5c9c..6f1f28a9c 100644
--- a/src/test_runner/dot_reporter.cr
+++ b/src/test_runner/dot_reporter.cr
@@ -44,6 +44,10 @@ module Mint
         puts
       end
 
+      def reset
+        @count = 0
+      end
+
       def crashed(message)
         puts
         puts "❗ An internal error occurred while executing a test: #{message}".colorize(:red)
diff --git a/src/test_runner/reporter.cr b/src/test_runner/reporter.cr
index fdab20090..499aaa349 100644
--- a/src/test_runner/reporter.cr
+++ b/src/test_runner/reporter.cr
@@ -6,6 +6,7 @@ module Mint
       abstract def errored(name, error)
       abstract def suite(name)
       abstract def done
+      abstract def reset
       abstract def crashed(message)
     end
   end

From 0860274d7e5a4b53f8f5127515fed703e876bfe2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Szikszai=20Guszt=C3=A1v?= <guszti5@hotmail.com>
Date: Tue, 19 Sep 2023 20:50:27 +0200
Subject: [PATCH 2/3] Compile tests on the request instead of caching it.

---
 src/test_runner.cr  | 25 ++++++++-----------------
 src/utils/server.cr |  4 ++--
 2 files changed, 10 insertions(+), 19 deletions(-)

diff --git a/src/test_runner.cr b/src/test_runner.cr
index e4d493727..8c68eb476 100644
--- a/src/test_runner.cr
+++ b/src/test_runner.cr
@@ -31,7 +31,6 @@ module Mint
     @artifacts : TypeChecker::Artifacts?
     @reporter : Reporter
     @browser_path : String?
-    @script : String?
     @browser : {Process, String}? = nil
 
     @failed = [] of Message
@@ -51,21 +50,13 @@ module Mint
 
     def watch
       workspace = Workspace.current
-      workspace.on "change" { |result| run_tests }
+      workspace.on "change" { run_tests }
       workspace.watch
 
       setup_kemal
       run_tests
 
-      Server.run "Test", @flags.host, @flags.port
-    end
-
-    def compile
-      terminal.measure "#{COG} Compiling tests..." do
-        compile_ast.tap do |a|
-          @script = compile_script(a)
-        end
-      end
+      Server.run "Test", @flags.host, @flags.port, false
     end
 
     def run_tests
@@ -74,8 +65,10 @@ module Mint
       terminal.reset
 
       begin
+        type_checker = TypeChecker.new(ast)
+        type_checker.check
+
         @reporter.reset
-        compile
         open_page
       rescue error : Error
         terminal.reset
@@ -87,8 +80,6 @@ module Mint
     end
 
     def run : Bool
-      ast = compile
-
       if ast.try(&.suites.empty?)
         terminal.puts
         terminal.puts "There are no tests to run!"
@@ -108,7 +99,7 @@ module Mint
       @failed.empty?
     end
 
-    def compile_ast
+    def ast
       file_argument =
         @arguments.test
 
@@ -130,7 +121,7 @@ module Mint
       end
     end
 
-    def compile_script(ast)
+    def script
       type_checker = TypeChecker.new(ast)
       type_checker.check
 
@@ -293,7 +284,7 @@ module Mint
       end
 
       get "/tests" do
-        @script
+        script
       end
 
       ws "/" do |socket|
diff --git a/src/utils/server.cr b/src/utils/server.cr
index 645f08844..29d233e25 100644
--- a/src/utils/server.cr
+++ b/src/utils/server.cr
@@ -12,14 +12,14 @@ module Mint
       true
     end
 
-    def run(name, host = "127.0.0.1", port = 3000)
+    def run(name, host = "127.0.0.1", port = 3000, verbose = true)
       config = Kemal.config
       config.logging = false
       config.setup
 
       if port_open?(host, port)
         server = HTTP::Server.new(config.handlers)
-        terminal.puts "#{COG} #{name} server started on http://#{host}:#{port}/"
+        terminal.puts "#{COG} #{name} server started on http://#{host}:#{port}/" if verbose
       elsif STDIN.tty?
         new_port = config.port + 1
         until port_open?(host, new_port)

From ef4c8b6d4514cfd08f0b70c2debb82c4e88fe857 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Szikszai=20Guszt=C3=A1v?= <guszti5@hotmail.com>
Date: Tue, 19 Sep 2023 21:05:40 +0200
Subject: [PATCH 3/3] Implement suggestions from code review.

---
 src/test_runner.cr | 48 ++++++++++++++++++++++++----------------------
 1 file changed, 25 insertions(+), 23 deletions(-)

diff --git a/src/test_runner.cr b/src/test_runner.cr
index 8c68eb476..f3029e133 100644
--- a/src/test_runner.cr
+++ b/src/test_runner.cr
@@ -31,7 +31,7 @@ module Mint
     @artifacts : TypeChecker::Artifacts?
     @reporter : Reporter
     @browser_path : String?
-    @browser : {Process, String}? = nil
+    @browser : {Process, String}?
 
     @failed = [] of Message
     @test_id = Random::Secure.hex
@@ -224,6 +224,8 @@ module Mint
         process.signal(:kill) rescue nil
         FileUtils.rm_rf(profile_directory)
       end
+
+      @browser = nil
     end
 
     def open_page
@@ -303,28 +305,28 @@ module Mint
     end
 
     def handle_message(data : Message) : Nil
-      if data.id == @test_id
-        case data.type
-        when "LOG"
-          terminal.puts data.result
-        when "SUITE"
-          @reporter.suite data.suite
-        when "SUCCEEDED"
-          @reporter.succeeded data.name
-          @succeeded += 1
-        when "FAILED"
-          @reporter.failed data.name, data.result
-          @failed << data
-        when "ERRORED"
-          @reporter.errored data.name, data.result
-          @failed << data
-        when "CRASHED"
-          @reporter.crashed data.result
-          @failed << data
-
-          @reporter.done
-          stop_server unless @flags.watch
-        end
+      return unless data.id == @test_id
+
+      case data.type
+      when "LOG"
+        terminal.puts data.result
+      when "SUITE"
+        @reporter.suite data.suite
+      when "SUCCEEDED"
+        @reporter.succeeded data.name
+        @succeeded += 1
+      when "FAILED"
+        @reporter.failed data.name, data.result
+        @failed << data
+      when "ERRORED"
+        @reporter.errored data.name, data.result
+        @failed << data
+      when "CRASHED"
+        @reporter.crashed data.result
+        @failed << data
+
+        @reporter.done
+        stop_server unless @flags.watch
       end
     end