procon_bypass_man 0.3.7 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86e705d2907d51077191585d2cd16fb198a8a55226613d25f44b15b5e58f8806
-  data.tar.gz: a13290f301295913bbc30a06a1e06689dc5aae328cadd39ed1e91982ff7586d2
+  metadata.gz: 1933db5fe8c39267f980712a5477a457277cdd3ce9148a81966c1e1d818805e8
+  data.tar.gz: 404ce5c7ada74a92afb5abf2b2f583c3fe1c87bbc4d3ae2372e0ff3f961d9245
 SHA512:
-  metadata.gz: 30618560c54d7c7a730bf97d74b601fce287d6900ed3eaf3c54b1071349b8a7d8b9e346c9099f6dbfad25a568710c5aaa4ce09ad4b12805a2f6d2d3a8134b27f
-  data.tar.gz: 96c796ecbbfa544a0427537a50ea17a0b7f10eee360bc6b072872c7621627dccf5403e78bdc2b580e5957fc5758f9b58979ef1f7f341da1a58b849a693ae79f8
+  metadata.gz: eeeb32ff42fc02d2b40b19be2a1eba55a9fc5ffc6a3f08af47b4ed86bb67edba60dc7ef409f892ba9ef21953a349abda01a28d04f4a4f99f0032382a68c2f904
+  data.tar.gz: 811f537dd6ea2659678911678022c02734a2a21ef099d7ed140067a56e88edf0fabc4aec8264c052e8e8e9759c54085a17ab7a72c668a338560250b880395e2f

data/.github/workflows/gitleacks.yml

@@ -7,6 +7,6 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v3
     - name: gitleaks-action
       uses: zricethezav/gitleaks-action@v1.6.0

data/.github/workflows/release.yml

@@ -11,7 +11,7 @@ jobs:
       contents: write
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         token: ${{ secrets.GITHUB_TOKEN }}
     - name: Set up Ruby 3.0.1

data/.github/workflows/ruby.yml

@@ -16,10 +16,10 @@ jobs:
     timeout-minutes: 5
     strategy:
       matrix:
-        ruby-version: ['3.0.1', '3.1.1']
+        ruby-version: ['3.0', '3.1', '3.2']
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Ruby
     # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
     # change this to (see https://github.com/ruby/setup-ruby#versioning):

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [0.3.8] 2023-05-03
+* TCP/IP経由でPBMに入力ができるようになりました
+* 多重起動ができないようにしました
+* pbm-cloudとの連携時に、pbmenvを使っているかの判定を修正しました
+* actioncable(websocket)serverのURLをpbm-cloudから取得するようにしました
+
 ## [0.3.7] 2023-04-06
 * PBM-Cloudと連携しているかをbootメッセージに表示ようになりました
 * シリアルポート経由でPBMに入力ができるようになりました

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    procon_bypass_man (0.3.7)
+    procon_bypass_man (0.3.8)
       action_cable_client
       blue_green_process (= 0.1.4.2)
       pbmenv (>= 0.1.11)
@@ -38,7 +38,7 @@ GEM
     parallel (1.21.0)
     parser (3.0.3.2)
       ast (~> 2.4.1)
-    pbmenv (0.1.11)
+    pbmenv (0.1.12)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)

data/README.md

@@ -11,7 +11,7 @@
 
 https://user-images.githubusercontent.com/1664497/171327108-f12f56a5-fc36-48da-95a5-65e976553a20.mov
 
-## 使うハードウェア
+## 必要なハードウェア
 * Nintendo Switch Proコントローラー
 * Switch本体とドック
 * Raspberry Pi4 (Raspberry Pi OS)
@@ -38,7 +38,7 @@ https://user-images.githubusercontent.com/1664497/171327108-f12f56a5-fc36-48da-9
 * レイヤーを切り替える方法は？
     * 設定ファイルに記述している `prefix_keys_for_changing_layer`の後ろにあるキーを同時押しながら、十字キーのどれかを押すことで任意のレイヤーに切り替わります
 * このツールでできることは？
-    * キーリマップ, 連射, マクロ
+    * キーリマップ, 連射, マクロ, 外部ツールからの入力
         * リマップは1つのキーを別のキーに割り当てます
     * 連射中には特定のキーの入力を無視したり、複数のキーをトリガーに連射することができます
 * どうしてsudoが必要なの？

data/bin/console

@@ -14,9 +14,6 @@ require "pry"
 
 require "irb"
 
-# TODO: replのときチェックが入らないので、書く詳細な実装に触れないようにする。PBM_ENVを参照するなどをする
-ProconBypassMan::ExternalInput.prepare_channels
-
 ProconBypassMan.config.logger = Logger.new($stdout)
 
 IRB.start(__FILE__)

data/docs/getting_started.md

@@ -18,7 +18,8 @@
 * [設定ファイルの書き方がわからない、エラーが起きるとき](#設定ファイルの書き方がわからない、エラーが起きるとき)
 * [procon_bypass_manのアップグレード方法](#procon_bypass_manのアップグレード方法)
 * [procon_bypass_man_cloudについて](#procon_bypass_man_cloudについて)
-* [シリアルポート・GPIOから読み取る](#シリアルポートから読み取る)
+* [シリアルポート連携](#シリアルポート連携)
+* [TCPIP連携](#TCPIP連携)
 * [最適化について](#最適化について)
 
 ## はじめに
@@ -252,10 +253,32 @@ procon_bypass_man_cloudとの接続が完了後、Raspberry Piを起動時にpro
   
 セットアップ方法は https://pbm-cloud.jiikko.com/faq に書いています。
 
-## シリアルポートから読み取る
+## シリアルポート連携
 * [ラズベリーパイのシリアルポート(GPIO)へ書き込んでPBM経由してSwitchへ入力をする方法](/docs/setting/integration_external_input_serial_port.md)
 * [ラズベリーパイのシリアルポート(GPIO)に書き込むフォーマットについて](/docs/setting/integration_external_input_serial_port_format.md)
 
+## TCPIP連携
+procon_bypass_man: 0.3.8 からTCP/IP経由で入力ができるようになりました。  
+書き込みフォーマットはJSONのみに対応しています。JSONの詳細な仕様については  [ラズベリーパイのシリアルポート(GPIO)に書き込むフォーマットについて](/docs/setting/integration_external_input_serial_port_format.md) を参照してください。  
+
+次は、PBM側の設定方法についてです。app.rbに以下の行を追加すると、連携するためのTCPサーバを起動するようになります。
+
+```diff
++ config.external_input_channels = [
++   ProconBypassMan::ExternalInput::Channels::TCPIPChannel.new(port: 9000),
++ ]
+```
+
+クライアント側のサンプル実装は次の通りです。これを実行するとAボタンを入力します。
+
+```ruby
+socket = TCPSocket.new('ras1.local', 9000)
+json = { buttons: [:a] }.to_json
+message = "#{json}\r\n"
+socket.write(message)
+puts socket.gets
+```
+
 ## 最適化について
 本稿では、Rubyの最適化について書きます。上級者向けです。適用しなくても普通に動きますが、逆に適用したことで何らかのケースで遅くなる場合があるかもしれません。
 

data/lib/procon_bypass_man/commands/print_boot_message_command.rb

@@ -10,7 +10,7 @@ class ProconBypassMan::PrintBootMessageCommand
       @table[:pid_path] = ProconBypassMan.pid_path
       @table[:setting_path] = ProconBypassMan::ButtonsSettingConfiguration.instance.setting_path
       @table[:uptime_from_boot] = ProconBypassMan::Uptime.from_boot
-      @table[:use_pbmenv] = !(!!`which pbmenv`.empty?)
+      @table[:use_pbmenv] = ProconBypassMan.root.start_with?(Pbmenv::PBM_DIR)
       @table[:session_id] = ProconBypassMan.session_id
       @table[:device_id] = ProconBypassMan.device_id
       @table[:never_exit_accidentally] = ProconBypassMan.config.never_exit_accidentally
@@ -34,7 +34,8 @@ class ProconBypassMan::PrintBootMessageCommand
       ProconBypassMan::VERSION: #{@table[:pbm_version]}
       RUBY_VERSION: #{@table[:ruby_version]}
       Pbmenv::VERSION: #{@table[:pbmenv_version]}
-      PBM-Cloud Integration: #{ProconBypassMan::WebConnectivityChecker.new(ProconBypassMan.config.api_server)}
+      PBM-Cloud Integration: #{ProconBypassMan::WebConnectivityChecker.new(ProconBypassMan.config.api_server, ProconBypassMan.config.current_ws_server_url)}
+      ExternalInput Integration: #{ProconBypassMan::ExternalInput::BootMessage.new(channels: ProconBypassMan::ExternalInput.channels)}
       pid: #{@table[:pid]}
       root: #{@table[:root_path]}
       pid_path: #{@table[:pid_path]}

data/lib/procon_bypass_man/configuration.rb

@@ -19,9 +19,11 @@ class ProconBypassMan::Configuration
       @@pid_path ||= File.expand_path("#{root}/pbm_pid", __dir__).freeze
     end
 
-    # @return [Integer]
+    # @return [Integer, nil]
     def pid
       File.read(pid_path).to_i
+    rescue Errno::ENOENT
+      nil
     end
 
     def digest_path
@@ -70,6 +72,7 @@ class ProconBypassMan::Configuration
     if defined?(@root)
       @root
     else
+      ProconBypassMan.logger.warn 'root pathが未設定です'
       File.expand_path('..', __dir__ || ".").freeze
     end
   end
@@ -126,22 +129,30 @@ class ProconBypassMan::Configuration
   end
 
   # @return [String, NilClass]
-  def current_ws_server
-    if (uri = URI.parse(api_server))
-      if uri.port == 443
-        return "ws://#{uri.host}"
+  def current_ws_server_url
+    return @current_ws_server_url if defined?(@current_ws_server_url)
+    return unless api_server
+
+    response_json = ProconBypassMan::HttpClient.new(server: api_server, path: '/api/v1/configuration').get
+    ws_server_url = response_json&.fetch("ws_server_url", nil)
+
+    begin
+      uri = URI.parse(ws_server_url)
+      if uri.scheme == 'ws'
+        @current_ws_server_url = uri.to_s
+        return @current_ws_server_url
+      elsif uri.scheme == 'wss' # NOTE:  SSL_CTX_use_certificate: ee key too small (OpenSSL::SSL::SSLError) が起きるので
+        uri.scheme = 'ws'
+        @current_ws_server_url = uri.to_s
+        return @current_ws_server_url
       else
-        return "ws://#{uri.host}:#{uri.port}"
+        ProconBypassMan.logger.warn { "#{ws_server_url} is invalid." }
+        return nil
       end
+    rescue URI::InvalidURIError => e
+      ProconBypassMan.logger.warn { "#{ws_server_url} is invalid. #{e}" }
+      nil
     end
-  rescue URI::InvalidURIError
-    nil
-  end
-
-  # @return [String, NilClass]
-  def current_ws_server_url
-    return unless current_ws_server
-    "#{current_ws_server}/websocket/"
   end
 
   # @return [Boolean]

data/lib/procon_bypass_man/external_input/boot_message.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ProconBypassMan
+  module ExternalInput
+    class BootMessage
+      # @return [ProconBypassMan::ExternalInput::Channels::Base]
+      def initialize(channels: )
+        @channels = channels
+      end
+
+      # @return [String]
+      def to_s
+        if @channels.nil? or @channels.empty?
+          return 'DISABLE'
+        end
+
+        @channels.map(&:display_name_for_boot_message).join(', ')
+      end
+    end
+  end
+end

data/lib/procon_bypass_man/external_input/channels/base.rb

@@ -6,6 +6,16 @@ module ProconBypassMan
         def read
           raise NotImplementedError
         end
+
+        # @return [void]
+        def shutdown
+          raise NotImplementedError
+        end
+
+        # @return [String]
+        def display_name_for_boot_message
+          raise NotImplementedError
+        end
       end
     end
   end

data/lib/procon_bypass_man/external_input/channels/serial_port_channel.rb

@@ -14,7 +14,7 @@ module ProconBypassMan
           data_bits = 8
           stop_bits = 1
           parity = SerialPort::NONE
-          @serial_port= SerialPort.new(device_path, baud_rate, data_bits, stop_bits, parity)
+          @serial_port = SerialPort.new(device_path, baud_rate, data_bits, stop_bits, parity)
         end
 
         # @return [String, NilClass]
@@ -42,6 +42,14 @@ module ProconBypassMan
           end
           chunks.first
         end
+
+        def shutdown
+          # no-op
+        end
+
+        def display_name_for_boot_message
+          'SerialPort'
+        end
       end
     end
   end

data/lib/procon_bypass_man/external_input/channels/tcpip_channel.rb

@@ -0,0 +1,131 @@
+module ProconBypassMan
+  module ExternalInput
+    module Channels
+      class TCPIPChannel < Base
+        class ShutdownSignal < StandardError; end
+
+        class AppServer < SimpleTCPServer
+          @command_queue = Queue.new
+
+          class << self
+            attr_accessor :command_queue
+          end
+
+          def post_init
+            ProconBypassMan.logger.info { "[ExternalInput][TCPIPChannel] A client has connected" }
+          end
+
+          def unbind
+            ProconBypassMan.logger.info { "[ExternalInput][TCPIPChannel] A client has disconnected" }
+          end
+
+          # @return [String]
+          def receive_data(client, data)
+            case data
+            when /^{/
+              self.class.command_queue.push(data)
+              client.write("OK\n")
+              return
+            when /^\n/
+              if self.class.command_queue.empty?
+                client.write("EMPTY\n")
+                return
+              end
+
+              data = self.class.command_queue.pop
+              client.write("#{data}\n")
+              return
+            else
+              client.write("Unknown command\n")
+              return
+            end
+          end
+        end
+
+        def initialize(port: )
+          @port = port
+          super()
+
+          begin
+            @server = AppServer.new('0.0.0.0', @port)
+          rescue Errno::EADDRINUSE # NOTE: Address already in use - bind(2) for "0.0.0.0" port XXXX
+            ProconBypassMan::SendErrorCommand.execute(error: "[ExternalInput][TCPIPChannel] 起動に失敗しました。#{e.message}")
+            @server_thread = Thread.start {}
+            return
+          end
+
+          # NOTE: masterプロセスで起動する
+          @server_thread = Thread.start do
+            begin
+              loop do
+                @server.start_server
+                @server.run
+              end
+            rescue Errno::EPIPE, EOFError, Errno::ECONNRESET => e
+              ProconBypassMan::SendErrorCommand.execute(error: "[ExternalInput][TCPIPChannel] #{e.message}(#{e})")
+              sleep(5)
+
+              @server.shutdown
+              retry
+            rescue ShutdownSignal => e
+              ProconBypassMan::SendErrorCommand.execute(error: "[ExternalInput][TCPIPChannel] ShutdownSignalを受け取りました。終了します。")
+              @server.shutdown
+            rescue => e
+              ProconBypassMan::SendErrorCommand.execute(error: "[ExternalInput][TCPIPChannel] #{e.message}(#{e})")
+            end
+          end
+        end
+
+        # NOTE: bypassプロセスから呼ばれ、masterプロセスへ繋ぐ
+        # @return [String, NilClass]
+        def read
+          @socket ||= TCPSocket.new('0.0.0.0', @port)
+          read_command = "\n"
+          @socket.write(read_command)
+          response = @socket.gets&.strip
+          # ProconBypassMan.logger.debug { "Received: #{response}" }
+
+          case response
+          when /^{/
+            return response
+          when /^EMPTY/, ''
+            return nil
+          else
+            ProconBypassMan.logger.warn { "[ExternalInput][TCPIPChannel] Unknown response(#{response}, codepoints: #{response.codepoints})" }
+            return nil
+          end
+        rescue Errno::EPIPE, EOFError => e
+          @socket = nil
+          sleep(10)
+          ProconBypassMan.logger.error { "[ExternalInput][TCPIPChannel] #{e.message}!!!!!!!(#{e})" }
+          retry
+        rescue => e
+          @socket = nil
+          ProconBypassMan.logger.error { "[ExternalInput][TCPIPChannel] #{e.message} が起きました(#{e})" }
+          return nil
+        end
+
+        def shutdown
+          ProconBypassMan.logger.info { "[ExternalInput][TCPIPChannel] shutdown" }
+          @server_thread.raise(ShutdownSignal)
+        end
+
+        def alive_server?
+          return false if not @server_thread.alive?
+
+          begin
+            TCPSocket.new('0.0.0.0', @port).close
+          rescue Errno::ECONNREFUSED, Errno::ECONNRESET
+            return false
+          end
+
+          true
+        end
+
+        def display_name_for_boot_message
+          "TCPIP(port: #{@port})"
+        end
+      end
+    end
+  end
+end

data/lib/procon_bypass_man/external_input/channels.rb

@@ -9,4 +9,4 @@ end
 
 require "procon_bypass_man/external_input/channels/base"
 require "procon_bypass_man/external_input/channels/serial_port_channel"
-require "procon_bypass_man/external_input/channels/tcpip"
+require "procon_bypass_man/external_input/channels/tcpip_channel"

data/lib/procon_bypass_man/external_input.rb

@@ -4,25 +4,20 @@ module ProconBypassMan
   module ExternalInput
     class ParseError < StandardError; end
 
-    @@channels = nil
-
     # @return [Array<ProconBypassMan::ExternalInput::Channels::Base>]
     def self.channels
-      @@channels
+      @@channels ||= ProconBypassMan.config.external_input_channels
     end
 
-    # @return [void]
-    def self.prepare_channels
-      @@channels = ProconBypassMan.config.external_input_channels
+    def self.shutdown
+      channels.each(&:shutdown)
     end
 
     # @return [NilClass, String]
     # NOTE: 外部入力からのreadがボトルネックになるなら、Concurrent::Futureを使ってプロコンからの読み出しと並列化することを検討する
     def self.read
-      raise '外部入力が未初期化です' if @@channels.nil?
-
       value = nil
-      @@channels.each do |channel|
+      channels.each do |channel|
         value = channel.read
         break if value
       end
@@ -33,3 +28,4 @@ end
 
 require "procon_bypass_man/external_input/external_data"
 require "procon_bypass_man/external_input/channels.rb"
+require "procon_bypass_man/external_input/boot_message"

data/lib/procon_bypass_man/support/forever.rb

@@ -0,0 +1,51 @@
+module ProconBypassMan
+  class Forever
+    # 動作確認方法
+    # - 10秒ごとにrefreshするのでタイムアウトは起きない
+    #   - ProconBypassMan::Forever.run { |watchdog| loop { puts(:hi); sleep(10); watchdog.active! } }
+    # - タイムアウトが起きること
+    #   - ProconBypassMan::Forever.run { |watchdog| loop { puts(:hi); sleep(10); } }
+    def self.run(&block)
+      loop do
+        new.run(&block)
+      end
+    end
+
+    # @return [void]
+    def run(&block)
+      raise(ArgumentError, "need a block") unless block_given?
+
+      thread, watchdog = work_one(callable: block)
+      wait_and_kill_if_outdated(thread, watchdog)
+    end
+
+    # @param [Proc] callable
+    # @return [Array<Thread, ProconBypassMan::Watchdog>]
+    def work_one(callable: )
+      watchdog = ProconBypassMan::Watchdog.new
+      thread = Thread.start do
+        callable.call(watchdog)
+      rescue => e
+        ProconBypassMan.logger.error("[Forever] #{e.full_message}")
+      end
+
+      return [thread, watchdog]
+    end
+
+    # @param [ProconBypassMan::Watchdog] watchdog
+    # @param [Thread] thread
+    # @return [void]
+    def wait_and_kill_if_outdated(thread, watchdog)
+      loop do
+        if watchdog.outdated?
+          watchdog.active!
+          ProconBypassMan.logger.error("watchdog timeout!!")
+          thread.kill
+          return
+        end
+
+        sleep(10)
+      end
+    end
+  end
+end

data/lib/procon_bypass_man/support/proccess_cheacker.rb

@@ -0,0 +1,14 @@
+class ProconBypassMan::ProcessChecker
+  # @param [integer] pid
+  # @return [Boolean]
+  def self.running?(pid)
+    begin
+      Process.kill(0, pid)
+      true
+    rescue Errno::ESRCH
+      false
+    rescue Errno::EPERM
+      true
+    end
+  end
+end

data/lib/procon_bypass_man/support/retryable.rb

@@ -1,6 +1,6 @@
 module ProconBypassMan
   class Retryable
-    def self.retryable(tries: , retried: 0, on_no_retry: [], log_label: nil)
+    def self.retryable(tries: , retried: 0, on_no_retry: [], log_label: nil, interval_on_retry: 0)
       return yield(retried)
     rescue *on_no_retry
       raise
@@ -11,6 +11,7 @@ module ProconBypassMan
         retried = retried + 1
         ProconBypassMan.logger.debug "[Retryable]#{log_label && "[#{log_label}]"} #{e}が起きました。retryします。#{retried} / #{tries}"
 
+        sleep(interval_on_retry)
         retry
       end
     end

data/lib/procon_bypass_man/support/simple_tcp_server.rb

@@ -0,0 +1,63 @@
+require 'socket'
+
+class SimpleTCPServer
+  def initialize(host, port)
+    @host = host
+    @port = port
+  end
+
+  def start_server
+    @connections = []
+    @server = TCPServer.new(@host, @port)
+  end
+
+  def run
+    loop do
+      timeout = 5 # 5秒のタイムアウト
+      readable, _ = IO.select(@connections + [@server], nil, nil, timeout)
+      next if readable.nil? # timeoutを迎えるとnilになる
+
+      readable.each do |socket|
+        if socket == @server
+          client = @server.accept
+          post_init
+          @connections << client
+        else
+          data = socket.gets
+          if data.nil?
+            @connections.delete(socket)
+            unbind
+            socket.close
+          else
+            receive_data(socket, data)
+          end
+        end
+      end
+    rescue Errno::EBADF, IOError => e
+      unbind
+      @connections = []
+      @server.close
+    end
+  end
+
+  def shutdown
+    @server.close
+  end
+
+  # @return [Integer]
+  def connections_size
+    @connections.size
+  end
+
+  def post_init
+    # Override this method
+  end
+
+  def receive_data(socket, data)
+    # Override this method
+  end
+
+  def unbind
+    # Override this method
+  end
+end

data/lib/procon_bypass_man/support/watchdog.rb

@@ -0,0 +1,23 @@
+module ProconBypassMan
+  class Watchdog
+    def initialize(timeout: 100)
+      @timeout = timeout
+      active!
+    end
+
+    # @return [Boolean]
+    def outdated?
+      @time < Time.now
+    end
+
+    # @return [Time]
+    def time
+      @time
+    end
+
+    # @return [void]
+    def active!
+      @time = Time.now + @timeout
+    end
+  end
+end

data/lib/procon_bypass_man/support/web_connectivity_checker.rb

@@ -1,7 +1,9 @@
 class ProconBypassMan::WebConnectivityChecker
   # @param [String, NilClass] url
-  def initialize(url)
+  # @param [String, NilClass] ws_url
+  def initialize(url, ws_url)
     @url = url
+    @ws_url = ws_url
   end
 
   # @return [String]
@@ -11,7 +13,7 @@ class ProconBypassMan::WebConnectivityChecker
     end
 
     if alive?
-      return "ENABLE (#{@url})"
+      return "ENABLE (#{@url}, #{@ws_url})"
     else
      return "UNREACHABLE (#{@url})"
     end

data/lib/procon_bypass_man/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ProconBypassMan
-  VERSION = "0.3.7"
+  VERSION = "0.3.8"
 end

data/lib/procon_bypass_man/websocket/client.rb

@@ -7,11 +7,13 @@ module ProconBypassMan
         return unless ProconBypassMan.config.enable_ws?
 
         Thread.start do
-          Forever.run { run }
+          ProconBypassMan::Forever.run do |watchdog|
+            run(watchdog: watchdog)
+          end
         end
       end
 
-      def self.run
+      def self.run(watchdog: )
         EventMachine.run do
           client = ActionCableClient.new(
             ProconBypassMan.config.current_ws_server_url, {
@@ -20,15 +22,15 @@ module ProconBypassMan
           )
 
           client.connected {
-            ProconBypassMan.logger.info('websocket client: successfully connected in ProconBypassMan::Websocket::Client')
+            ProconBypassMan.logger.info('[WebsocketClient] successfully connected in ProconBypassMan::Websocket::Client')
           }
           client.subscribed { |msg|
-            ProconBypassMan.logger.info("websocket client: subscribed(#{msg})")
+            ProconBypassMan.logger.info("[WebsocketClient] subscribed(#{msg})")
             ProconBypassMan::SyncDeviceStatsJob.perform(ProconBypassMan::DeviceStatus.current)
           }
 
           client.received do |data|
-            ProconBypassMan.logger.info('websocket client: received!!')
+            ProconBypassMan.logger.info('[WebsocketClient] received!!')
             ProconBypassMan.logger.info(data)
 
             dispatch(data: data, client: client)
@@ -37,20 +39,20 @@ module ProconBypassMan
           end
 
           client.disconnected {
-            ProconBypassMan.logger.info('websocket client: disconnected!!')
+            ProconBypassMan.logger.info('[WebsocketClient] disconnected!!')
             client.reconnect!
             sleep 2
           }
           client.errored { |msg|
-            ProconBypassMan.logger.error("websocket client: errored!!, #{msg}")
+            ProconBypassMan.logger.error("[WebsocketClient] errored!!, #{msg}")
             client.reconnect!
             sleep 2
           }
           client.pinged { |msg|
-            Watchdog.active!
+            watchdog.active!
 
             ProconBypassMan.cache.fetch key: 'ws_pinged', expires_in: 10 do
-              ProconBypassMan.logger.info('websocket client: pinged!!')
+              ProconBypassMan.logger.info('[WebsocketClient] pinged!!')
               ProconBypassMan.logger.info(msg)
             end
           }

data/lib/procon_bypass_man.rb

@@ -42,6 +42,10 @@ require_relative "procon_bypass_man/support/can_over_process"
 require_relative "procon_bypass_man/support/retryable"
 require_relative "procon_bypass_man/support/renice_command"
 require_relative "procon_bypass_man/support/web_connectivity_checker"
+require_relative "procon_bypass_man/support/watchdog"
+require_relative "procon_bypass_man/support/forever"
+require_relative "procon_bypass_man/support/simple_tcp_server"
+require_relative "procon_bypass_man/support/proccess_cheacker"
 require_relative "procon_bypass_man/procon_display"
 require_relative "procon_bypass_man/background"
 require_relative "procon_bypass_man/commands"
@@ -61,8 +65,6 @@ require_relative "procon_bypass_man/scheduler"
 require_relative "procon_bypass_man/plugins"
 require_relative "procon_bypass_man/worker"
 require_relative "procon_bypass_man/websocket/client"
-require_relative "procon_bypass_man/websocket/watchdog"
-require_relative "procon_bypass_man/websocket/forever"
 require_relative "procon_bypass_man/external_input"
 require_relative "procon_bypass_man/remote_action"
 
@@ -124,8 +126,6 @@ module ProconBypassMan
       return
     end
 
-    ProconBypassMan::ExternalInput.prepare_channels
-
     ready_pbm
     Runner.new(gadget: gadget, procon: procon).run # ここでblockingする
     terminate_pbm
@@ -161,6 +161,12 @@ module ProconBypassMan
 
   # @return [void]
   def self.initialize_pbm
+    if ProconBypassMan.pid && ProconBypassMan::ProcessChecker.running?(ProconBypassMan.pid)
+      ProconBypassMan::SendErrorCommand.execute(error: "別のプロセスでPBMがすでに起動中なので処理を停止します。")
+      raise 'テスト実行中でここに入ると調査が面倒なのでエラーにします' if ENV['PBM_ENV'] == 'test'
+      exit 1
+    end
+
     ProconBypassMan::ReniceCommand.change_priority(to: :low, pid: $$)
     ProconBypassMan::Background::JobQueue.start!
     ProconBypassMan::Websocket::Client.start!
@@ -211,6 +217,7 @@ module ProconBypassMan
     ProconBypassMan::RemoteAction::QueueOverProcess.shutdown
     ProconBypassMan::Procon::PerformanceMeasurement::QueueOverProcess.shutdown
     self.worker&.shutdown
+    ProconBypassMan::ExternalInput.shutdown
   end
 
   # @return [void]

data/project_template/app.rb

@@ -12,7 +12,7 @@ begin
   gemfile do
     source 'https://rubygems.org'
     git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-    gem 'procon_bypass_man', '0.3.7'
+    gem 'procon_bypass_man', '0.3.8'
     # uncomment if you want to use master branch
     # gem 'procon_bypass_man', github: 'splaplapla/procon_bypass_man', branch: 'master'
     # uncomment if you want to use serial communication feature
@@ -57,6 +57,7 @@ ProconBypassMan.configure do |config|
   # シリアル通信やTCP/IP経由で入力するときに設定してください
   # config.external_input_channels = [
   #   ProconBypassMan::ExternalInput::Channels::SerialPortChannel.new(device_path: '/dev/serial0', baud_rate: 9600),
+  #   ProconBypassMan::ExternalInput::Channels::TCPIPChannel.new(port: 9000),
   # ]
 end
 

data/project_template/app.rb.erb

@@ -12,7 +12,7 @@ begin
   gemfile do
     source 'https://rubygems.org'
     git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-    gem 'procon_bypass_man', '0.3.7'
+    gem 'procon_bypass_man', '0.3.8'
     # uncomment if you want to use master branch
     # gem 'procon_bypass_man', github: 'splaplapla/procon_bypass_man', branch: 'master'
     # uncomment if you want to use serial communication feature
@@ -62,7 +62,7 @@ ProconBypassMan.configure do |config|
   # シリアル通信やTCP/IP経由で入力するときに設定してください
   # config.external_input_channels = [
   #   ProconBypassMan::ExternalInput::Channels::SerialPortChannel.new(device_path: '/dev/serial0', baud_rate: 9600),
-  <%-# ProconBypassMan::ExternalInput::Channels::TCPIP.new(port: 9000), # TODO: まだ実装していない -%>
+  #   ProconBypassMan::ExternalInput::Channels::TCPIPChannel.new(port: 9000),
   # ]
 end
 

data/sig/main.rbs

@@ -210,7 +210,7 @@ class ProconBypassMan::Configuration
 
   def current_ws_server: () -> (String | nil)
 
-  def current_ws_server_url: () -> ::String
+  def current_ws_server_url: () -> (String | nil)
 
   def enable_ws?: () -> bool
 
@@ -577,7 +577,7 @@ module ProconBypassMan
     @retry_on_connection_error: false
 
     def initialize: (path: String, server: untyped, ?retry_on_connection_error: false) -> void
-    def get: -> nil
+    def get: -> Hash[untyped, untyped]?
     def post: (request_body: untyped) -> nil
     def put: (request_body: untyped) -> nil
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: procon_bypass_man
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.3.8
 platform: ruby
 authors:
 - jiikko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-06 00:00:00.000000000 Z
+date: 2023-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pbmenv
@@ -180,10 +180,11 @@ files:
 - lib/procon_bypass_man/device_status.rb
 - lib/procon_bypass_man/ephemeral_configuration.rb
 - lib/procon_bypass_man/external_input.rb
+- lib/procon_bypass_man/external_input/boot_message.rb
 - lib/procon_bypass_man/external_input/channels.rb
 - lib/procon_bypass_man/external_input/channels/base.rb
 - lib/procon_bypass_man/external_input/channels/serial_port_channel.rb
-- lib/procon_bypass_man/external_input/channels/tcpip.rb
+- lib/procon_bypass_man/external_input/channels/tcpip_channel.rb
 - lib/procon_bypass_man/external_input/external_data.rb
 - lib/procon_bypass_man/plugin/splatoon2/macro/charge_tansan_bomb.rb
 - lib/procon_bypass_man/plugin/splatoon2/macro/dasei_cancel.rb
@@ -276,10 +277,12 @@ files:
 - lib/procon_bypass_man/support/cycle_sleep.rb
 - lib/procon_bypass_man/support/device_mouse_finder.rb
 - lib/procon_bypass_man/support/device_procon_finder.rb
+- lib/procon_bypass_man/support/forever.rb
 - lib/procon_bypass_man/support/http_client.rb
 - lib/procon_bypass_man/support/load_agv.rb
 - lib/procon_bypass_man/support/never_exit_accidentally.rb
 - lib/procon_bypass_man/support/on_memory_cache.rb
+- lib/procon_bypass_man/support/proccess_cheacker.rb
 - lib/procon_bypass_man/support/procon_performance_http_client.rb
 - lib/procon_bypass_man/support/remote_macro_http_client.rb
 - lib/procon_bypass_man/support/renice_command.rb
@@ -287,16 +290,16 @@ files:
 - lib/procon_bypass_man/support/retryable.rb
 - lib/procon_bypass_man/support/safe_timeout.rb
 - lib/procon_bypass_man/support/send_device_stats_http_client.rb
+- lib/procon_bypass_man/support/simple_tcp_server.rb
 - lib/procon_bypass_man/support/update_remote_pbm_job_status_http_client.rb
 - lib/procon_bypass_man/support/uptime.rb
 - lib/procon_bypass_man/support/usb_device_controller.rb
+- lib/procon_bypass_man/support/watchdog.rb
 - lib/procon_bypass_man/support/web_connectivity_checker.rb
 - lib/procon_bypass_man/support/yaml_loader.rb
 - lib/procon_bypass_man/support/yaml_writer.rb
 - lib/procon_bypass_man/version.rb
 - lib/procon_bypass_man/websocket/client.rb
-- lib/procon_bypass_man/websocket/forever.rb
-- lib/procon_bypass_man/websocket/watchdog.rb
 - lib/procon_bypass_man/worker.rb
 - procon_bypass_man.gemspec
 - project_template/README.md

data/lib/procon_bypass_man/external_input/channels/tcpip.rb

@@ -1,16 +0,0 @@
-# TODO: 実装する
-# module ProconBypassMan
-#   module ExternalInput
-#     module Channels
-#       class TCPIP < Base
-#         def initialize(port: )
-#           super()
-#           # TODO: ここでTCPサーバを起動する(port)
-#         end
-#
-#         def read
-#         end
-#       end
-#     end
-#   end
-# end

data/lib/procon_bypass_man/websocket/forever.rb

@@ -1,47 +0,0 @@
-module ProconBypassMan
-  module Websocket
-    class Forever
-      # 動作確認方法
-      # - 10秒ごとにrefreshするのでタイムアウトは起きない
-      #   - ProconBypassMan::Websocket::Forever.run { loop { puts(:hi); sleep(10); ProconBypassMan::Websocket::Watchdog.active!  } }
-      # - タイムアウトが起きること
-      #   - ProconBypassMan::Websocket::Forever.run { puts(:hi); sleep(3000);  }
-      # - ブロックを1回評価するとThreadが死ぬので100秒後にタイムアウトが起きること
-      #   - ProconBypassMan::Websocket::Forever.run { puts(:hi); sleep(10); ProconBypassMan::Websocket::Watchdog.active!  }
-      def self.run(&block)
-        loop do
-          new.run(&block)
-        end
-      end
-
-      def run(&block)
-        raise("need a block") unless block_given?
-
-        ws_thread = work_one(callable: block)
-        wait_and_kill_if_outdated(ws_thread)
-      end
-
-      # @return [Thread]
-      def work_one(callable: )
-        Thread.start do
-          callable.call
-        rescue => e
-          ProconBypassMan.logger.error("websocket client with forever: #{e.full_message}")
-        end
-      end
-
-      def wait_and_kill_if_outdated(thread)
-        loop do
-          if Watchdog.outdated?
-            Watchdog.active!
-            ProconBypassMan.logger.error("watchdog timeout!!")
-            thread.kill
-            return
-          end
-
-          sleep(10)
-        end
-      end
-    end
-  end
-end

data/lib/procon_bypass_man/websocket/watchdog.rb

@@ -1,19 +0,0 @@
-module ProconBypassMan
-  module Websocket
-    class Watchdog
-      def self.outdated?
-        @@time < Time.now
-      end
-
-      def self.time
-        @@time
-      end
-
-      def self.active!
-        @@time = Time.now + 100
-      end
-
-      active!
-    end
-  end
-end