Commit: 4f41d115925bb32d24b7624a5e1bc8a4fde66dfd - shogi-server (git)

shogi-server source

Commit MetaInfo

• Revision: 4f41d115925bb32d24b7624a5e1bc8a4fde66dfd (tree)
• Time: 2020-12-06 17:57:36
• Author: Daigo Moriwaki <beatles@sgtp...>
• Commiter: Daigo Moriwaki

Log Message

[shogi-server] Improve timed-up detection (continued)

The server now checks timed up when it receives a-single-space keep
alive messages as well.
(Closes #40821)

Change Summary

• modified: changelog
• modified: shogi_server/command.rb
• modified: test/TC_command.rb

Incremental Difference

--- a/changelog
+++ b/changelog
@@ -1,3 +1,11 @@
[phone]  Daigo Moriwaki <daigo at debian dot org>
+
+	* [shogi-server] Improve timed-up detection (continued).
+	  The server now checks timed up when it receives a-single-space keep
+	  alive messages as well.
+	  Thanks to mizar for reports and patches.
+	  (Closes #40821)
+
 2020-10-04  Daigo Moriwaki <daigo at debian dot org>
 
 	* [shogi-server] Improve timed-up detection.

--- a/shogi_server/command.rb
+++ b/shogi_server/command.rb
@@ -28,7 +28,7 @@ module ShogiServer
     def Command.factory(str, player, time=Time.now)
       cmd = nil
       case str
-      when "", /^%[^%]/, :timeout
+      when "", " ", /^%[^%]/, :timeout
         cmd = SpecialCommand.new(str, player)
       when /^[\+\-][^%]/
         cmd = MoveCommand.new(str, player)
@@ -174,9 +174,15 @@ module ShogiServer
 
   # Command like "%TORYO", :timeout, or keep alive
   #
-  # Keep Alive is an application-level protocol. Whenever the server receives
-  # an LF, it sends back an LF.  Note that the 30 sec rule (client may not send
-  # LF again within 30 sec) is not implemented yet.
+  # Keep Alive is an application-level protocol here. There are two representations:
+  # 1) LF (empty string)
+  #    The server sends back an LF (empty string).
+  #    Note that the 30 sec rule (client may not send LF again within 30 sec)
+  #    is not implemented yet.
+  #    This is compliant with CSA's protocol in certain situations.
+  # 2) Space + LF (a single space)
+  #    The sever replies nothing.
+  #    This is an enhancement to CSA's protocol.
   #
   class SpecialCommand < Command
     def initialize(str, player)
@@ -186,9 +192,9 @@ module ShogiServer
     def call
       rc = :continue
 
-      if @str == "" # keep alive
+      if @str == "" || @str == " " # keep alive
         log_debug("received keep alive from #{@player.name}")
-        @player.write_safe("\n")
+        @player.write_safe("\n") if @str == ""
         # Fall back to :timeout to check the game gets timed up
         @str = :timeout
       end

--- a/test/TC_command.rb
+++ b/test/TC_command.rb
@@ -93,6 +93,11 @@ class TestFactoryMethod < Test::Unit::TestCase
     assert_instance_of(ShogiServer::SpecialCommand, cmd)
   end
 
+  def test_keep_alive_command_space
+    cmd = ShogiServer::Command.factory(" ", @p)
+    assert_instance_of(ShogiServer::SpecialCommand, cmd)
+  end
+
   def test_move_command
     cmd = ShogiServer::Command.factory("+7776FU", @p)
     assert_instance_of(ShogiServer::MoveCommand, cmd)
@@ -409,6 +414,12 @@ class TestSpecialComand < Test::Unit::TestCase
     rc = cmd.call
     assert_equal(:continue, rc)
   end
+
+  def test_keep_alive_space
+    cmd = ShogiServer::SpecialCommand.new(" ", @p)
+    rc = cmd.call
+    assert_equal(:continue, rc)
+  end
 end
 
 #