groonga-query-log 1.7.5 → 1.7.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddc6abfd57bfd9684c695179c7cac74c76ea66fffb0b87b9a0d44726a16128b6
-  data.tar.gz: 52dfaf4698c92587f155e3d4e0fd70fcc7c94b7c6ae58fdab43e72695a3e7722
+  metadata.gz: af3ac522ec27ea395b44209b8ab56521de14b828d67bf4b8d4dad52bb0df2d1c
+  data.tar.gz: c570a4a49aad267b71047d992e0593afac1290135711a7f45b8114ded4232dbd
 SHA512:
-  metadata.gz: 0747f843b5cce48e3540cace8c2be2ab4200c7d6c406917a56b7eb05dbd047437249400f25178045d29b1aef8c84253e6c3a70ef806db9f581ae47392a34c2a5
-  data.tar.gz: 47391f44a1d86c8aa37ae8893f87381e49fddf15100762938cacb73b742b0a909c2b32e574564d32415c82e8ca2c5b618f0c86b0028c288b0570685a4b3f0d60
+  metadata.gz: 7f0dc1247dc380bd50f8b249fcc7976a800bb67de75f10e4cd600741508f4236d89aa750277043336dc4abd561641804cf53056373338ef9ae2dd2b0f9cc5c0e
+  data.tar.gz: ddcce99bb10e8b8876fbbce95d9c0c49f5d1b8ca7e6ce8beb4a9178624ab169475ce49173c33f1e1a5796909ae20c1fa1976126033c944757859f18e9a05689f

data/doc/text/news.md

@@ -1,5 +1,21 @@
 # News
 
+## 1.7.7: 2024-04-08
+
+### Improvements
+
+  * `run-regression-test`: Added a test to verify that the `request_cancel` command can be successfully cancelled.
+
+  * `analyze-load`: Added support for reporting throughput.
+
+## 1.7.6: 2021-02-24
+
+### Improvements
+
+  * `replayer`: Ignored `load` without `values`.
+
+  * `statistics`: Added `n_records` to each operation.
+
 ## 1.7.5: 2020-11-18
 
 ### Improvements

data/groonga-query-log.gemspec

@@ -54,6 +54,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency("charty")
   spec.add_runtime_dependency("diff-lcs")
+  spec.add_runtime_dependency("net-smtp")
   spec.add_runtime_dependency("groonga-client", ">= 0.6.2")
   spec.add_runtime_dependency("groonga-log", ">= 0.1.2")
 

data/lib/groonga-query-log/command/analyze-load.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2018  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2017-2024  Sutou Kouhei <kou@clear-code.com>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -147,9 +147,15 @@ module GroongaQueryLog
           n_column_errors = nil
           total = nil
         end
+        if n_loaded_records and n_loaded_records > 0
+          throughput = statistic.elapsed_in_seconds / n_loaded_records
+        else
+          throughput = nil
+        end
         entry = [
           statistic.start_time.iso8601,
           statistic.elapsed_in_seconds,
+          throughput,
           load_command.table,
           n_loaded_records,
           n_record_errors,
@@ -171,6 +177,7 @@ module GroongaQueryLog
         header = [
           "start_time",
           "elapsed",
+          "throughput",
           "table",
           "n_loaded_records",
           "n_record_errors",

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

@@ -67,6 +67,8 @@ module GroongaQueryLog
         @debug_rewrite = false
         @omit_rate = 0.0
         @max_limit = -1
+        @verify_cancel = false
+        @cancel_max_wait = 5.0
 
         @care_order = true
         @ignored_drilldown_keys = []
@@ -426,6 +428,20 @@ module GroongaQueryLog
                   "(#{@notifier_options[:mail_only_on_failure]})") do |boolean|
           @notifier_options[:mail_only_on_failure] = boolean
         end
+        parser.on("--[no-]verify-cancel",
+                  "Verify cancellation",
+                  "(#{@verify_cancel})") do |boolean|
+          @verify_cancel = boolean
+        end
+        parser.on("--cancel-max-wait=SECONDS", Float,
+                  "Used with --verify_cancel. " +
+                  "You can specify the maximum number of seconds to wait " +
+                  "before sending request_cancel command. " +
+                  "For example, if you specify 5.0 in this option, " +
+                  "wait randomly between 0~5.0 seconds before sending request_cancel command.",
+                  "(#{@cancel_max_wait})") do |seconds|
+          @cancel_max_wait = seconds
+        end
         parser
       end
 
@@ -478,6 +494,8 @@ module GroongaQueryLog
           :verify_performance => @verify_performance,
           :performance_verfifier_options => @performance_verfifier_options,
           :read_timeout => @read_timeout,
+          :verify_cancel => @verify_cancel,
+          :cancel_max_wait => @cancel_max_wait,
         }
         directory_options.merge(options)
       end
@@ -517,7 +535,7 @@ module GroongaQueryLog
         end
         formatted << "\n"
         unless n_leaked_objects.zero?
-          formatted << "\nLeaked: #{n_leaked_objects}"
+          formatted << "\nLeaked: #{n_leaked_objects}\n"
         end
         unless success
           output = StringIO.new
@@ -945,6 +963,11 @@ module GroongaQueryLog
             command_line << "--read-timeout"
             command_line << @options[:read_timeout].to_s
           end
+          if @options[:verify_cancel]
+            command_line << "--verify_cancel"
+            command_line << "--cancel-max-wait"
+            command_line << @options[:cancel_max_wait].to_s
+          end
           verify_server = VerifyServer.new
           same = verify_server.run(command_line, &callback)
           @n_executed_commands = verify_server.n_executed_commands

data/lib/groonga-query-log/command/verify-server.rb

@@ -287,6 +287,22 @@ module GroongaQueryLog
           @options.max_limit = limit
         end
 
+        parser.on("--[no-]verify-cancel",
+                  "Verify cancellation",
+                  "(#{@options.verify_cancel?})") do |boolean|
+          @options.verify_cancel = boolean
+        end
+
+        parser.on("--cancel-max-wait=SECONDS", Float,
+                  "Used with --verify_cancel. " +
+                  "You can specify the maximum number of seconds to wait " +
+                  "before sending request_cancel command. " +
+                  "For example, if you specify 5.0 in this option, " +
+                  "wait randomly between 0~5.0 seconds before sending request_cancel command.",
+                  "(#{@options.cancel_max_wait})") do |seconds|
+          @options.cancel_max_wait = seconds
+        end
+
         create_parser_performance(parser)
 
         parser.separator("")

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

@@ -47,6 +47,7 @@ module GroongaQueryLog
           parser.parse(input) do |statistic|
             next if statistic.command.nil?
             next unless target_command?(statistic.command)
+            next unless available_command?(statistic.command)
             # TODO: validate orignal_source is one line
             output.puts(statistic.command.original_source)
             output.flush
@@ -132,6 +133,15 @@ module GroongaQueryLog
       @options.target_command_name?(command.command_name)
     end
 
+    def available_command?(command)
+      case command.command_name
+      when "load"
+        not command.values.nil?
+      else
+        true
+      end
+    end
+
     class NullOutput
       class << self
         def open

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

@@ -27,12 +27,15 @@ require "groonga-query-log/response-comparer"
 
 module GroongaQueryLog
   class ServerVerifier
+    GRN_CANCEL = -77
+
     attr_reader :n_executed_commands
     def initialize(options)
       @options = options
       @queue = SizedQueue.new(@options.request_queue_size)
       @events = Queue.new
       @n_executed_commands = 0
+      @request_id_counter = 0
     end
 
     def verify(input, &callback)
@@ -167,9 +170,15 @@ module GroongaQueryLog
       @options.stop_on_failure? and failed?
     end
 
+    def generate_request_id
+      (@request_id_counter += 1).to_s
+    end
+
     def verify_command(groonga1_client, groonga2_client, command)
       command["cache"] = "no" if @options.disable_cache?
       command["cache"] = "no" if @options.verify_performance?
+      command["request_id"] = generate_request_id if @options.verify_cancel?
+
       if @options.max_limit >= 0 and command["limit"]
         limit = command["limit"].to_i
         if limit >= 0
@@ -181,8 +190,26 @@ module GroongaQueryLog
       command["output_type"] = "json"
       rewrite_filter(command, "filter")
       rewrite_filter(command, "scorer")
+
       response1 = groonga1_client.execute(command)
-      response2 = groonga2_client.execute(command)
+      # groonga2 is new Groonga.
+      response2 = nil
+      if @options.verify_cancel?
+        request = groonga2_client.execute(command) do |response|
+          response2 = response
+        end
+        # Randomize timing of sending request_cancel command
+        sleep(rand(0..@options.cancel_max_wait))
+        @options.groonga2.create_client do |cancel_client|
+          cancel_client.execute("request_cancel", id: command.request_id)
+        end
+        request.wait
+
+        return if response2.return_code == GRN_CANCEL
+      else
+        response2 = groonga2_client.execute(command)
+      end
+
       compare_options = {
         :care_order => @options.care_order,
         :ignored_drilldown_keys => @options.ignored_drilldown_keys,
@@ -326,6 +353,8 @@ module GroongaQueryLog
       attr_writer :debug_rewrite
       attr_writer :omit_rate
       attr_accessor :max_limit
+      attr_writer :verify_cancel
+      attr_writer :cancel_max_wait
       def initialize
         @groonga1 = GroongaOptions.new
         @groonga2 = GroongaOptions.new
@@ -361,6 +390,8 @@ module GroongaQueryLog
         @debug_rewrite = false
         @omit_rate = 0.0
         @max_limit = -1
+        @verify_cancel = false
+        @cancel_max_wait = 5.0
       end
 
       def request_queue_size
@@ -460,6 +491,14 @@ module GroongaQueryLog
       def omit_rate
         @omit_rate
       end
+
+      def verify_cancel?
+        @verify_cancel
+      end
+
+      def cancel_max_wait
+        @cancel_max_wait
+      end
     end
 
     class GroongaOptions

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

@@ -152,6 +152,7 @@ module GroongaQueryLog
         operation_data["relative_elapsed"] = operation[:relative_elapsed_in_seconds]
         operation_data["context"] = operation[:context]
         operation_data["slow"] = operation[:slow?]
+        operation_data["n_records"] = operation[:n_records]
         operations << operation_data
       end
       data["operations"] = operations

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2012-2020  Sutou Kouhei <kou@clear-code.com>
+# Copyright (C) 2012-2021  Sutou Kouhei <kou@clear-code.com>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -15,5 +15,5 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
 module GroongaQueryLog
-  VERSION = "1.7.5"
+  VERSION = "1.7.7"
 end

data/test/command/test-analyzer.rb

@@ -1,5 +1,5 @@
 # Copyright (C) 2012  Haruka Yoshihara <yoshihara@clear-code.com>
-# Copyright (C) 2014-2019  Sutou Kouhei <kou@clear-code.com>
+# Copyright (C) 2014-2021  Sutou Kouhei <kou@clear-code.com>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -42,6 +42,7 @@ class AnalyzerCommandTest < Test::Unit::TestCase
     end
 
     def test_no_specified
+      require_tty
       assert_equal("Error: Please specify input log files.\n",
                    run_analyzer)
     end

data/test/command/test-extract.rb

@@ -1,5 +1,5 @@
 # Copyright (C) 2012  Haruka Yoshihara <yoshihara@clear-code.com>
-# Copyright (C) 2015-2018  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2015-2021  Sutou Kouhei <kou@clear-code.com>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -45,6 +45,7 @@ column_create --flags "COLUMN_SCALAR" --name "title" --table "Comments" --type "
     end
 
     def test_no_specified
+      require_tty
       assert_equal("Error: Please specify input log files.\n",
                    run_extractor)
     end

data/test/fixtures/reporter/json-stream.expected

@@ -1,2 +1,2 @@
 {"start_time":START_TIME,"end_time":END_TIME,"elapsed":0.003128856,"return_code":0,"slow":false,"command":{"raw":"load --table Video","name":"load","parameters":[{"key":"table","value":"Video"}]},"operations":[]}
-{"start_time":START_TIME,"end_time":END_TIME,"elapsed":0.00121714,"return_code":0,"slow":false,"command":{"raw":"select --table Users --query follower:@groonga --output_columns _key,name","name":"select","parameters":[{"key":"table","value":"Users"},{"key":"query","value":"follower:@groonga"},{"key":"output_columns","value":"_key,name"}]},"operations":[{"name":"filter","relative_elapsed":0.0008429529999999999,"context":"Users.follower match \"groonga\"","slow":false},{"name":"select","relative_elapsed":2.7947e-05,"context":null,"slow":false},{"name":"output","relative_elapsed":0.000195852,"context":"_key,name","slow":false}]}
+{"start_time":START_TIME,"end_time":END_TIME,"elapsed":0.00121714,"return_code":0,"slow":false,"command":{"raw":"select --table Users --query follower:@groonga --output_columns _key,name","name":"select","parameters":[{"key":"table","value":"Users"},{"key":"query","value":"follower:@groonga"},{"key":"output_columns","value":"_key,name"}]},"operations":[{"name":"filter","relative_elapsed":0.0008429529999999999,"context":"Users.follower match \"groonga\"","slow":false,"n_records":2},{"name":"select","relative_elapsed":2.7947e-05,"context":null,"slow":false,"n_records":2},{"name":"output","relative_elapsed":0.000195852,"context":"_key,name","slow":false,"n_records":2}]}

data/test/fixtures/reporter/json.expected

@@ -1,4 +1,4 @@
 [
 {"start_time":START_TIME,"end_time":END_TIME,"elapsed":0.003128856,"return_code":0,"slow":false,"command":{"raw":"load --table Video","name":"load","parameters":[{"key":"table","value":"Video"}]},"operations":[]},
-{"start_time":START_TIME,"end_time":END_TIME,"elapsed":0.00121714,"return_code":0,"slow":false,"command":{"raw":"select --table Users --query follower:@groonga --output_columns _key,name","name":"select","parameters":[{"key":"table","value":"Users"},{"key":"query","value":"follower:@groonga"},{"key":"output_columns","value":"_key,name"}]},"operations":[{"name":"filter","relative_elapsed":0.0008429529999999999,"context":"Users.follower match \"groonga\"","slow":false},{"name":"select","relative_elapsed":2.7947e-05,"context":null,"slow":false},{"name":"output","relative_elapsed":0.000195852,"context":"_key,name","slow":false}]}
+{"start_time":START_TIME,"end_time":END_TIME,"elapsed":0.00121714,"return_code":0,"slow":false,"command":{"raw":"select --table Users --query follower:@groonga --output_columns _key,name","name":"select","parameters":[{"key":"table","value":"Users"},{"key":"query","value":"follower:@groonga"},{"key":"output_columns","value":"_key,name"}]},"operations":[{"name":"filter","relative_elapsed":0.0008429529999999999,"context":"Users.follower match \"groonga\"","slow":false,"n_records":2},{"name":"select","relative_elapsed":2.7947e-05,"context":null,"slow":false,"n_records":2},{"name":"output","relative_elapsed":0.000195852,"context":"_key,name","slow":false,"n_records":2}]}
 ]

data/test/helper.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2011-2017  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2011-2021  Sutou Kouhei <kou@clear-code.com>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -29,6 +29,10 @@ module Helper
   end
 
   module Command
+    def require_tty
+      omit("Require tty") unless $stdin.tty?
+    end
+
     def open_error_output
       Tempfile.open("groonga-query-log.error") do |error|
         error.sync = true

data/test/test-replayer.rb

@@ -51,7 +51,7 @@ class ReplayerTest < Test::Unit::TestCase
           :read_timeout => 60,
         }
         expected_open_options = default_options.merge(expected_options)
-        mock(Groonga::Client).open(expected_open_options).yields(client) do
+        mock(Groonga::Client).open(**expected_open_options).yields(client) do
           client
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: groonga-query-log
 version: !ruby/object:Gem::Version
-  version: 1.7.5
+  version: 1.7.7
 platform: ruby
 authors:
 - Kouhei Sutou
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-18 00:00:00.000000000 Z
+date: 2024-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: charty
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-smtp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: groonga-client
   requirement: !ruby/object:Gem::Requirement
@@ -315,7 +329,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0.rc.2
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Groonga-query-log is a collection of library and tools to process [Groonga](http://groonga.org/)'s