groonga-query-log 1.6.4 → 1.6.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2d80e83a4e97eef62575b74225fb3906bba84cfdfe27d3322f57cc6a2a5ecad
-  data.tar.gz: a9c6085392cc0be54614d2d6cf465b716718867d54274968afe69ed06c93f2b8
+  metadata.gz: a6c1fa15ed54fa3eb2c15e9791c4dbf7c9cd7109b2384954c384ff5fad69059c
+  data.tar.gz: 656d2240444743749d32b1304164d75f30a6c462bd938fae28aa9dda6be0f74d
 SHA512:
-  metadata.gz: b861443cf20f694818b4457a3e657a09bc5b3aef46e30e3173445216d945b91ead35e4b03c955110ebad03485c111f47cc9f08b1ad314b57909d982c869e44c2
-  data.tar.gz: f429713e01e280273e2511f02b121e50d5999ef38b9a5531402690a8bb1bf8f13e57fe499f11c3981eedee12dba29766c2144c4676bd133bc3da4f1f343d2c40
+  metadata.gz: 93b3bd2a44c10f675856317c69ba9d2abe12f48ead686272d32f611f552278e2ac14f05917eee5c26555ccd17fc18c9c5c81dc2dbcf64e5a8a85e25b02be88a2
+  data.tar.gz: d83aebd5c4bff439c65de360ebf44244a3c1ba8c0ec7fb4477081d7c73418b3db0d867ba9cf21ab548c0eab4f784dd596c9d570e847effe5c1bbb4cd332fe4db

data/doc/text/news.md

@@ -1,5 +1,52 @@
 # News
 
+## 1.6.9: 2020-05-30
+
+### Fixes
+
+  * `server-verifier`: Fixed a bug that performance verification
+    doesn't work.
+
+## 1.6.8: 2020-05-30
+
+### Improvements
+
+  * `server-verifier`: Stopped sorting elapsed times.
+
+  * `run-regression-test`: Ensured killing Groonga server on start up
+    error.
+
+## 1.6.7: 2020-05-30
+
+### Improvements
+
+  * `extract`: Added support for no command request case such as `/`.
+
+  * `server-verifier`: Reduced the number of requests for performance
+    verification.
+
+  * `server-verifier`: Added all elapsed times on slow.
+
+  * `format-regression-test-logs`: Added support for all elapsed times
+    on slow.
+
+## 1.6.6: 2020-05-20
+
+### Fixes
+
+  * `run-regression-test`: Fixed a bug that
+    `--old-groonga-warm-up-command` is ignored.
+
+## 1.6.5: 2020-05-19
+
+### Improvements
+
+  * `run-regression-test`: Added options to customize how to warm up:
+
+    * `--old-groonga-warm-up-command`
+
+    * `--new-groonga-warm-up-command`
+
 ## 1.6.4: 2020-05-18
 
 ### Improvements

data/lib/groonga-query-log/command/extract.rb

@@ -182,6 +182,8 @@ module GroongaQueryLog
       end
 
       def target?(command)
+        return false if command.nil?
+
         name = command.command_name
         target_commands = @options.commands
         exclude_commands = @options.exclude_commands

data/lib/groonga-query-log/command/format-regression-test-logs.rb

@@ -74,6 +74,8 @@ module GroongaQueryLog
         elapsed_time_old = nil
         elapsed_time_new = nil
         elapsed_time_ratio = nil
+        elapsed_times_old = nil
+        elapsed_times_new = nil
 
         input.each_line do |line|
           unless line.valid_encoding?
@@ -100,11 +102,21 @@ module GroongaQueryLog
             elapsed_time_old = Float($POSTMATCH.chomp)
           when /\Aelapsed_time_new: /
             elapsed_time_new = Float($POSTMATCH.chomp)
+          when /\Aelapsed_times_old: /
+            elapsed_times_old = $POSTMATCH.chomp.split.collect do |value|
+              Float(value)
+            end
+          when /\Aelapsed_times_new: /
+            elapsed_times_new = $POSTMATCH.chomp.split.collect do |value|
+              Float(value)
+            end
           when /\Aelapsed_time_ratio: /
             elapsed_time_ratio = Float($POSTMATCH.chomp)
             report_slow(command,
                         elapsed_time_old,
                         elapsed_time_new,
+                        elapsed_times_old,
+                        elapsed_times_new,
                         elapsed_time_ratio)
           end
         end
@@ -196,11 +208,21 @@ module GroongaQueryLog
       def report_slow(command,
                       elapsed_time_old,
                       elapsed_time_new,
+                      elapsed_times_old,
+                      elapsed_times_new,
                       elapsed_time_ratio)
         report_command(command)
+        elapsed_times_old ||= [elapsed_time_old]
+        elapsed_times_new ||= [elapsed_time_new]
         @output.puts("Slow:")
-        @output.puts("  Old: %s" % format_elapsed_time(elapsed_time_old))
-        @output.puts("  New: %s" % format_elapsed_time(elapsed_time_new))
+        @output.puts("  Old: %s (%s)" % [
+                       format_elapsed_time(elapsed_time_old),
+                       format_elapsed_times(elapsed_times_old),
+                     ])
+        @output.puts("  New: %s (%s)" % [
+                       format_elapsed_time(elapsed_time_new),
+                       format_elapsed_times(elapsed_times_new),
+                     ])
         @output.puts("  Ratio: +%.1f%%" % ((elapsed_time_ratio * 100) - 100))
       end
 

data/lib/groonga-query-log/command/run-regression-test.rb

@@ -42,11 +42,13 @@ module GroongaQueryLog
         @old_database = "db.old/db"
         @old_groonga_options = []
         @old_groonga_env = {}
+        @old_groonga_warm_up_commands = []
 
         @new_groonga = "groonga"
         @new_database = "db.new/db"
         @new_groonga_options = []
         @new_groonga_env = {}
+        @new_groonga_warm_up_commands = []
 
         @recreate_database = false
         @warm_up = true
@@ -177,6 +179,14 @@ module GroongaQueryLog
           @old_groonga_env[key] = value
         end
 
+        parser.on("--old-groonga-warm-up-commands=COMMAND",
+                  "Run COMMAND before running tests to warm old groonga up",
+                  "You can specify this option multiple times",
+                  "to specify multiple warm up commands",
+                  "(no additional warm up commands)") do |command|
+          @old_groonga_warm_up_commands << command
+        end
+
         parser.separator("")
         parser.separator("New Groonga:")
         parser.on("--new-groonga=GROONGA",
@@ -202,6 +212,14 @@ module GroongaQueryLog
           @new_groonga_env[key] = value
         end
 
+        parser.on("--new-groonga-warm-up-commands=COMMAND",
+                  "Run COMMAND before running tests to warm new groonga up",
+                  "You can specify this option multiple times",
+                  "to specify multiple warm up commands",
+                  "(no additional warm up commands)") do |command|
+          @new_groonga_warm_up_commands << command
+        end
+
         parser.separator("")
         parser.separator("Operations:")
         parser.on("--recreate-database",
@@ -457,19 +475,23 @@ module GroongaQueryLog
       end
 
       def old_groonga_server
+        options = server_options
+        options[:warm_up_commands] = @old_groonga_warm_up_commands
         GroongaServer.new(@old_groonga,
                           @old_groonga_options,
                           @old_groonga_env,
                           @old_database,
-                          server_options)
+                          options)
       end
 
       def new_groonga_server
+        options = server_options
+        options[:warm_up_commands] = @new_groonga_warm_up_commands
         GroongaServer.new(@new_groonga,
                           @new_groonga_options,
                           @new_groonga_env,
                           @new_database,
-                          server_options)
+                          options)
       end
 
       def format_report(success,
@@ -537,6 +559,7 @@ module GroongaQueryLog
           @host = "127.0.0.1"
           @port = find_unused_port
           @options = options
+          @pid = nil
         end
 
         def run
@@ -557,21 +580,28 @@ module GroongaQueryLog
           spawn_args << @database_path.to_s
           @pid = spawn(*spawn_args)
 
-          n_retries = 10
           begin
-            send_command("status")
-          rescue SystemCallError
-            sleep(1)
-            n_retries -= 1
-            raise if n_retries.zero?
-            retry
-          end
+            n_retries = 60
+            begin
+              send_command("status")
+            rescue SystemCallError
+              sleep(1)
+              n_retries -= 1
+              raise if n_retries.zero?
+              retry
+            end
 
-          if @options[:warm_up]
-            send_command("dump?dump_records=no")
+            if @options[:warm_up]
+              send_command("dump?dump_records=no")
+              warm_up_commands = @options[:warm_up_commands] || []
+              warm_up_commands.each do |command|
+                send_command(command)
+              end
+            end
+          rescue
+            shutdown
+            raise
           end
-
-          yield if block_given?
         end
 
         def ensure_database
@@ -662,11 +692,14 @@ module GroongaQueryLog
         end
 
         def shutdown
+          return if @pid.nil?
           begin
             send_command("shutdown")
           rescue SystemCallError
+            Process.kill(:KILL, @pid)
           end
           Process.waitpid(@pid)
+          @pid = nil
         end
 
         def n_leaked_objects
@@ -743,7 +776,6 @@ module GroongaQueryLog
           @n_clients = options[:n_clients] || 1
           @stop_on_failure = options[:stop_on_failure]
           @options = options
-          @n_ready_waits = 2
           @n_executed_commands = 0
         end
 
@@ -751,21 +783,39 @@ module GroongaQueryLog
           @old.ensure_database
           @new.ensure_database
 
+          ready_queue = Thread::Queue.new
+          wait_queue = Thread::Queue.new
           old_thread = Thread.new do
-            @old.run do
-              run_test
+            @old.run
+            begin
+              ready_queue.push(true)
+              wait_queue.pop
+            ensure
+              @old.shutdown
             end
           end
           new_thread = Thread.new do
-            @new.run do
-              run_test
+            @new.run
+            begin
+              ready_queue.push(true)
+              wait_queue.pop
+            ensure
+              @new.shutdown
             end
           end
+          test_thread = Thread.new do
+            ready_queue.pop
+            ready_queue.pop
+            run_test
+            wait_queue.push(true)
+            wait_queue.push(true)
+          end
 
           old_thread_success = old_thread.value
           new_thread_success = new_thread.value
+          test_thread_success = test_thread.value
 
-          old_thread_success and new_thread_success
+          old_thread_success and new_thread_success and test_thread_success
         end
 
         def n_executed_commands
@@ -774,9 +824,6 @@ module GroongaQueryLog
 
         private
         def run_test
-          @n_ready_waits -= 1
-          return true unless @n_ready_waits.zero?
-
           same = true
           query_log_paths.each do |query_log_path|
             log_path = test_log_path(query_log_path)
@@ -809,16 +856,6 @@ module GroongaQueryLog
               puts("Interrupt: #{query_log_path}")
             end
           end
-
-          old_thread = Thread.new do
-            @old.shutdown
-          end
-          new_thread = Thread.new do
-            @new.shutdown
-          end
-          old_thread.join
-          new_thread.join
-
           same
         end
 

data/lib/groonga-query-log/formattable.rb

@@ -30,5 +30,12 @@ module GroongaQueryLog
         "%.1fmin" % (elapsed_time / 60)
       end
     end
+
+    def format_elapsed_times(elapsed_times)
+      formatted_epalsed_times = elapsed_times.collect do |elapsed_time|
+        format_elapsed_time(elapsed_time)
+      end
+      formatted_epalsed_times.join(" ")
+    end
   end
 end

data/lib/groonga-query-log/performance-verifier.rb

@@ -47,10 +47,18 @@ module GroongaQueryLog
       diff_ratio > @threshold_ratio
     end
 
+    def old_elapsed_times
+      collect_elapsed_times(@old_responses)
+    end
+
     def old_elapsed_time
       choose_target_elapsed_time(@old_responses)
     end
 
+    def new_elapsed_times
+      collect_elapsed_times(@new_responses)
+    end
+
     def new_elapsed_time
       choose_target_elapsed_time(@new_responses)
     end
@@ -66,18 +74,21 @@ module GroongaQueryLog
       end
     end
 
-    def choose_target_elapsed_time(responses)
-      elapsed_times = responses.collect do |response|
+    def collect_elapsed_times(responses)
+      responses.collect do |response|
         response.elapsed_time
       end
-      sorted_elapsed_times = elapsed_times.sort
+    end
+
+    def choose_target_elapsed_time(responses)
+      sorted_elapsed_times = collect_elapsed_times(responses).sort
 
       strategy = @options.choose_strategy
       case strategy
       when :fastest
         sorted_elapsed_times.first
       when :median
-        sorted_elapsed_times[elapsed_times.size / 2]
+        sorted_elapsed_times[sorted_elapsed_times.size / 2]
       else
         message =
           "choose strategy must be :fastest or :median: #{strategy.inspect}"

data/lib/groonga-query-log/server-verifier.rb

@@ -187,24 +187,46 @@ module GroongaQueryLog
         return
       end
 
-      return unless @options.verify_performance?
+      if @options.verify_performance?
+        verify_performance(command,
+                           groonga1_client,
+                           groonga2_client,
+                           response1,
+                           response2)
+      end
+    end
+
+    def verify_performance(command,
+                           groonga1_client,
+                           groonga2_client,
+                           response1,
+                           response2)
       responses1 = [response1]
       responses2 = [response2]
-      n_tries = 4
-      n_tries.times do
-        responses1 << groonga1_client.execute(command)
-        responses2 << groonga2_client.execute(command)
-      end
       verifier = PerformanceVerifier.new(command,
                                          responses1,
                                          responses2,
                                          @options.performance_verifier_options)
-      if verifier.slow?
-        @slow = true
-        @events.push([:slow,
-                      command,
-                      verifier.old_elapsed_time,
-                      verifier.new_elapsed_time])
+      return unless verifier.slow?
+
+      n_tries = 4
+      n_tries.times do
+        responses1 << groonga1_client.execute(command)
+        responses2 << groonga2_client.execute(command)
+        verifier = PerformanceVerifier.new(command,
+                                           responses1,
+                                           responses2,
+                                           @options.performance_verifier_options)
+        if verifier.slow?
+          @slow = true
+          @events.push([:slow,
+                        command,
+                        verifier.old_elapsed_time,
+                        verifier.new_elapsed_time,
+                        verifier.old_elapsed_time,
+                        verifier.new_elapsed_time])
+          return
+        end
       end
     end
 
@@ -233,11 +255,18 @@ module GroongaQueryLog
       output.flush
     end
 
-    def report_slow(output, command, old_elapsed_time, new_elapsed_time)
+    def report_slow(output,
+                    command,
+                    old_elapsed_time,
+                    new_elapsed_time,
+                    old_elapsed_times,
+                    new_elapsed_times)
       command_source = command.original_source || command.to_uri_format
       output.puts("command: #{command_source}")
       output.puts("elapsed_time_old: #{old_elapsed_time}")
       output.puts("elapsed_time_new: #{new_elapsed_time}")
+      output.puts("elapsed_times_old: #{old_elapsed_times.join(' ')}")
+      output.puts("elapsed_times_new: #{new_elapsed_times.join(' ')}")
       output.puts("elapsed_time_ratio: #{new_elapsed_time / old_elapsed_time}")
       output.flush
     end

data/lib/groonga-query-log/version.rb

@@ -15,5 +15,5 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
 module GroongaQueryLog
-  VERSION = "1.6.4"
+  VERSION = "1.6.9"
 end

data/test/command/test-format-regression-test-logs.rb

@@ -109,14 +109,32 @@ Arguments:
   query: column_create
   table: Entries
 Slow:
-  Old: 174.8usec
-  New: 201.7usec
+  Old: 174.8usec (174.8usec)
+  New: 201.7usec (201.7usec)
   Ratio: +15.4%
     OUTPUT
     assert_equal([true, output],
                  run_command([fixture_path("slow.log")]))
   end
 
+  def test_slow_elapsed_times
+    output = <<-OUTPUT
+Command:
+/d/select?match_columns=description&query=column_create&table=Entries
+Name: select
+Arguments:
+  match_columns: description
+  query: column_create
+  table: Entries
+Slow:
+  Old: 174.8usec (174.8usec 184.8usec)
+  New: 201.7usec (201.7usec 211.7usec)
+  Ratio: +15.4%
+    OUTPUT
+    assert_equal([true, output],
+                 run_command([fixture_path("slow-elapsed-times.log")]))
+  end
+
   sub_test_case(".new") do
     def setup
     end

data/test/fixtures/regression-test-logs/slow-elapsed-times.log

@@ -0,0 +1,6 @@
+command: /d/select?match_columns=description&query=column_create&table=Entries
+elapsed_time_old: 0.0001747608184814453
+elapsed_time_new: 0.0002017021179199219
+elapsed_times_old: 0.0001747608184814453 0.0001847608184814453
+elapsed_times_new: 0.0002017021179199219 0.0002117021179199219
+elapsed_time_ratio: 1.154160982264666

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: groonga-query-log
 version: !ruby/object:Gem::Version
-  version: 1.6.4
+  version: 1.6.9
 platform: ruby
 authors:
 - Kouhei Sutou
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-17 00:00:00.000000000 Z
+date: 2020-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: charty
@@ -272,6 +272,7 @@ files:
 - test/fixtures/query.log
 - test/fixtures/regression-test-logs/command-format.log
 - test/fixtures/regression-test-logs/error.log
+- test/fixtures/regression-test-logs/slow-elapsed-times.log
 - test/fixtures/regression-test-logs/slow.log
 - test/fixtures/regression-test-logs/url-format.log
 - test/fixtures/reporter/console.expected
@@ -345,6 +346,7 @@ test_files:
 - test/fixtures/query.log
 - test/fixtures/regression-test-logs/command-format.log
 - test/fixtures/regression-test-logs/error.log
+- test/fixtures/regression-test-logs/slow-elapsed-times.log
 - test/fixtures/regression-test-logs/slow.log
 - test/fixtures/regression-test-logs/url-format.log
 - test/fixtures/reporter/console.expected