procon_bypass_man 0.1.22 → 0.2.1

data/lib/procon_bypass_man.rb

@@ -14,8 +14,14 @@ require "pbmenv"
 require_relative "procon_bypass_man/version"
 require_relative "procon_bypass_man/remote_pbm_action"
 require_relative "procon_bypass_man/remote_macro"
+
+require_relative "procon_bypass_man/device_connection"
+require_relative "procon_bypass_man/support/usb_device_controller"
+require_relative "procon_bypass_man/support/device_procon_finder"
+require_relative "procon_bypass_man/support/device_mouse_finder"
 require_relative "procon_bypass_man/support/signal_handler"
 require_relative "procon_bypass_man/support/callbacks"
+require_relative "procon_bypass_man/support/yaml_loader"
 require_relative "procon_bypass_man/support/yaml_writer"
 require_relative "procon_bypass_man/support/safe_timeout"
 require_relative "procon_bypass_man/support/compress_array"
@@ -29,22 +35,19 @@ require_relative "procon_bypass_man/support/send_device_stats_http_client"
 require_relative "procon_bypass_man/support/server_pool"
 require_relative "procon_bypass_man/support/analog_stick_hypotenuse_tilting_power_scaler"
 require_relative "procon_bypass_man/support/never_exit_accidentally"
+require_relative "procon_bypass_man/support/cycle_sleep"
+require_relative "procon_bypass_man/procon_display"
 require_relative "procon_bypass_man/background"
 require_relative "procon_bypass_man/commands"
 require_relative "procon_bypass_man/bypass"
-require_relative "procon_bypass_man/domains"
-require_relative "procon_bypass_man/device_connector"
-require_relative "procon_bypass_man/device_procon_finder"
 require_relative "procon_bypass_man/device_status"
-require_relative "procon_bypass_man/usb_device_controller"
 require_relative "procon_bypass_man/runner"
 require_relative "procon_bypass_man/processor"
 require_relative "procon_bypass_man/configuration"
 require_relative "procon_bypass_man/buttons_setting_configuration"
 require_relative "procon_bypass_man/procon"
+require_relative "procon_bypass_man/device_model"
 require_relative "procon_bypass_man/procon/button"
-require_relative "procon_bypass_man/procon/value_objects/analog_stick"
-require_relative "procon_bypass_man/procon/value_objects/procon_reader"
 require_relative "procon_bypass_man/procon/analog_stick_cap"
 require_relative "procon_bypass_man/procon/analog_stick_manipulator"
 require_relative "procon_bypass_man/remote_pbm_action/value_objects/remote_pbm_action_object"
@@ -62,61 +65,59 @@ module ProconBypassMan
   extend ProconBypassMan::NeverExitAccidentally
 
   class CouldNotLoadConfigError < StandardError; end
-  class ConnectionError < StandardError; end
-  class FirstConnectionError < ConnectionError; end
-  class EternalConnectionError < ConnectionError; end
+  class NotFoundProconError < StandardError; end
 
   # @return [void]
   def self.run(setting_path: nil)
-    ProconBypassMan::Scheduler.start!
-    ProconBypassMan::Background::JobRunner.start!
-    ProconBypassMan::Websocket::Client.start!
-    ProconBypassMan::QueueOverProcess.start!
-
     ProconBypassMan::PrintMessageCommand.execute(text: "PBMを起動しています")
     initialize_pbm
-    ProconBypassMan::ButtonsSettingConfiguration::Loader.load(setting_path: setting_path)
-    gadget, procon = ProconBypassMan::ConnectDeviceCommand.execute!
-    Runner.new(gadget: gadget, procon: procon).run # ここでblockingする
-    FileUtils.rm_rf(ProconBypassMan.pid_path)
-    FileUtils.rm_rf(ProconBypassMan.digest_path)
-    ProconBypassMan::QueueOverProcess.shutdown
-  rescue ProconBypassMan::CouldNotLoadConfigError
-    ProconBypassMan::SendErrorCommand.execute(error: "設定ファイルが不正です。設定ファイルの読み込みに失敗しました")
-    ProconBypassMan::DeviceStatus.change_to_setting_syntax_error_and_shutdown!
-    # TODO シグナルトラップをしていないのでUSR2を送ったときにプロセスが停止している. 明示的にハンドリングするべき.
-    ProconBypassMan.exit_if_allow(1) do
-      FileUtils.rm_rf(ProconBypassMan.pid_path)
-      FileUtils.rm_rf(ProconBypassMan.digest_path)
-      ProconBypassMan::QueueOverProcess.shutdown
-    end
-  rescue ProconBypassMan::ConnectDeviceCommand::NotFoundProconError
-    ProconBypassMan::SendErrorCommand.execute(error: "プロコンが見つかりませんでした。")
-    ProconBypassMan::DeviceStatus.change_to_procon_not_found_error!
-    # TODO シグナルトラップをしていないのでUSR2を送ったときにプロセスが停止している. 明示的にハンドリングするべき.
-    ProconBypassMan.exit_if_allow(1) do
-      FileUtils.rm_rf(ProconBypassMan.pid_path)
-      FileUtils.rm_rf(ProconBypassMan.digest_path)
-      ProconBypassMan::QueueOverProcess.shutdown
+
+    begin
+      ProconBypassMan::ButtonsSettingConfiguration::Loader.load(setting_path: setting_path)
+    rescue ProconBypassMan::CouldNotLoadConfigError
+      ProconBypassMan::SendErrorCommand.execute(error: "設定ファイルが不正です。設定ファイルの読み込みに失敗しました")
+      ProconBypassMan::DeviceStatus.change_to_setting_syntax_error_and_shutdown!
+      # TODO シグナルトラップをしていないのでUSR2を送ったときにプロセスが停止している. 明示的にハンドリングするべき.
+      ProconBypassMan::NeverExitAccidentally.exit_if_allow_at_config do
+        terminate_pbm
+      end
+      return
     end
-  rescue ProconBypassMan::ConnectionError
+
     begin
-      raise
-    rescue ProconBypassMan::EternalConnectionError
+      gadget, procon = ProconBypassMan::DeviceConnection::Command.execute!
+    rescue ProconBypassMan::DeviceConnection::NotFoundProconError
+      ProconBypassMan::SendErrorCommand.execute(error: "プロコンが見つかりませんでした。")
+      ProconBypassMan::DeviceStatus.change_to_procon_not_found_error!
+      # TODO シグナルトラップをしていないので以下の状態に、USR2を送ったときにプロセスが停止してしまう
+      ProconBypassMan::NeverExitAccidentally.exit_if_allow_at_config do
+        terminate_pbm
+      end
+      return
+    rescue ProconBypassMan::DeviceConnection::TimeoutError
       ProconBypassMan::SendErrorCommand.execute(error: "接続の見込みがないのでsleepしまくります")
       ProconBypassMan::DeviceStatus.change_to_connected_but_sleeping!
-      FileUtils.rm_rf(ProconBypassMan.pid_path)
+      %w(TERM INT).each do |sig|
+        Kernel.trap(sig) { exit 0 }
+      end
+      Kernel.trap :USR2 do
+        exit 0 # TODO retryする
+      end
       eternal_sleep
-    rescue ProconBypassMan::FirstConnectionError
-      ProconBypassMan::SendErrorCommand.execute(error: "接続を確立できませんでした。やりなおします。")
-      retry
+      return
     end
+
+    ready_pbm
+    Runner.new(gadget: gadget, procon: procon).run # ここでblockingする
+    terminate_pbm
   end
 
+  # 実行ファイル(app.rb)から呼び出している
+  # @return [void]
   def self.configure(&block)
     @@configuration = ProconBypassMan::Configuration.new
     @@configuration.instance_eval(&block)
-    @@configuration
+    nil
   end
 
   # @return [ProconBypassMan::Configuration]
@@ -133,20 +134,34 @@ module ProconBypassMan
     ProconBypassMan::IOMonitor.reset!
   end
 
+  # @return [void]
   def self.initialize_pbm
+    ProconBypassMan::Scheduler.start!
+    ProconBypassMan::Background::JobRunner.start!
+    ProconBypassMan::Websocket::Client.start!
+    ProconBypassMan::QueueOverProcess.start!
+
     ProconBypassMan::WriteDeviceIdCommand.execute
     ProconBypassMan::WriteSessionIdCommand.execute
-    system("renice -n -20 -p #{$$}")
+    `renice -n -20 -p #{$$}`
     File.write(pid_path, $$)
     ProconBypassMan::DeviceStatus.change_to_running!
   end
 
-  def self.eternal_sleep
-    sleep(999999999)
+  def self.ready_pbm
+    ProconBypassMan::PrintBootMessageCommand.execute
+    ProconBypassMan::ReportLoadConfigJob.perform_async(ProconBypassMan.config.raw_setting)
   end
 
-  # @return [Void]
-  def self.hot_reload!
-    Process.kill(:USR2, pid)
+  # @return [void]
+  def self.terminate_pbm
+    FileUtils.rm_rf(ProconBypassMan.pid_path)
+    FileUtils.rm_rf(ProconBypassMan.digest_path)
+    ProconBypassMan::QueueOverProcess.shutdown
+  end
+
+  # @return [void]
+  def self.eternal_sleep
+    sleep(999999999)
   end
 end

data/project_template/app.rb

@@ -2,15 +2,25 @@
 
 require 'bundler/inline'
 
-gemfile do
-  source 'https://rubygems.org'
-  git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-  gem 'procon_bypass_man', '0.1.22'
+begin
+  gemfile do
+    source 'https://rubygems.org'
+    git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+    gem 'procon_bypass_man', '0.2.1'
+  end
+rescue Bundler::Source::Git::GitCommandError => e
+  # install中に強制終了するとgitの管理ファイルが不正状態になり、次のエラーが起きるので発生したらcache directoryを削除する
+  #"Git error: command `git fetch --force --quiet --tags https://github.com/splaplapla/procon_bypass_man refs/heads/\\*:refs/heads/\\*` in directory /home/pi/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/cache/bundler/git/procon_bypass_man-ae4c9016d76b667658c8ba66f3bbd2eebf2656af has failed.\n\nIf this error persists you could try removing the cache directory '/home/pi/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/cache/bundler/git/procon_bypass_man-ae4c9016d76b667658c8ba66f3bbd2eebf2656af'"
+  if /try removing the cache directory '([^']+)'/ =~ e.message
+    require 'fileutils'
+    FileUtils.rm_rf($1)
+    retry
+  end
 end
 
 ProconBypassMan.configure do |config|
   config.root = File.expand_path(__dir__)
-  config.logger = Logger.new("#{ProconBypassMan.root}/app.log", 5, 1024 * 1024 * 10)
+  config.logger = Logger.new("#{ProconBypassMan.root}/app.log", 1, 1024 * 1024 * 1)
   config.logger.level = :debug
 
   # バイパスするログを全部app.logに流すか
@@ -25,8 +35,14 @@ ProconBypassMan.configure do |config|
   # pbm-cloudで使う場合はnever_exitにtrueをセットしてください. trueがセットされている場合、不慮の事故が発生してもプロセスが終了しなくなります
   config.never_exit_accidentally = true
 
-  # 操作が高頻度で固まるときは、 gadget_to_procon_interval の数値は大きくしてください
-  config.bypass_mode = { mode: :normal, gadget_to_procon_interval: 5 }
+  # 毎秒行ったIOをログに出力するか
+  config.io_monitor_logging = false
+
+  # 接続に成功したらコントローラーのHOME LEDを光らせるか
+  config.enable_home_led_on_connect = true
+
+  # 操作が高頻度で固まるときは、 gadget_to_procon_interval の数値を大きくしてください
+  config.bypass_mode = { mode: :normal, gadget_to_procon_interval: 10 }
 end
 
 ProconBypassMan.run(setting_path: "/usr/share/pbm/current/setting.yml")

data/sig/main.rbs

@@ -11,12 +11,6 @@ module ProconBypassMan
   class CouldNotLoadConfigError < StandardError
   end
 
-  class FirstConnectionError < StandardError
-  end
-
-  class EternalConnectionError < StandardError
-  end
-
   def self.configure: (?setting_path: untyped? setting_path) { () -> untyped } -> untyped
 
   def self.run: (?setting_path: untyped? setting_path) { () -> untyped } -> untyped
@@ -192,6 +186,7 @@ class ProconBypassMan::Configuration
   attr_reader api_server: untyped
   attr_reader api_servers: untyped
   attr_writer never_exit_accidentally: bool
+  attr_writer io_monitor_logging: bool
 
   attr_accessor enable_critical_error_logging: bool
 
@@ -231,6 +226,8 @@ class ProconBypassMan::Configuration
   def verbose_bypass_log: () -> bool
 
   def never_exit_accidentally: () -> bool
+
+  def io_monitor_logging: () -> bool
 end
 
 
@@ -255,21 +252,12 @@ class ProconBypassMan::DeviceConnector
 
   def self.connect: () -> ::Array[untyped]
 
-  def initialize: (?throw_error_if_timeout: bool throw_error_if_timeout, ?throw_error_if_mismatch: bool throw_error_if_mismatch, ?enable_at_exit: bool enable_at_exit) -> untyped
+  def initialize: (?throw_error_if_timeout: bool throw_error_if_timeout, ?throw_error_if_mismatch: bool throw_error_if_mismatch) -> untyped
 
   def add: (untyped values, read_from: untyped read_from) -> untyped
 
   def drain_all: () -> untyped
 
-  # switchに任意の命令を入力して、switchから読み取る
-  def write_switch: (untyped data, ?only_write: bool only_write) -> untyped
-
-  def write_procon: (untyped data, ?only_write: bool only_write) -> untyped
-
-  def read_procon: (?only_read: bool only_read) -> untyped
-
-  def read_switch: (?only_read: bool only_read) -> untyped
-
   def from_device: (untyped item) -> untyped
 
   # fromの対になる

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: procon_bypass_man
 version: !ruby/object:Gem::Version
-  version: 0.1.22
+  version: 0.2.1
 platform: ruby
 authors:
 - jiikko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-09 00:00:00.000000000 Z
+date: 2022-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pbmenv
@@ -60,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".github/workflows/gitleacks.yml"
 - ".github/workflows/release.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
@@ -122,29 +123,28 @@ files:
 - lib/procon_bypass_man/buttons_setting_configuration/param_normalizer/open_macro_steps.rb
 - lib/procon_bypass_man/buttons_setting_configuration/validator.rb
 - lib/procon_bypass_man/bypass.rb
+- lib/procon_bypass_man/bypass/bypass_command.rb
 - lib/procon_bypass_man/bypass/usb_hid_logger.rb
 - lib/procon_bypass_man/commands.rb
-- lib/procon_bypass_man/commands/bypass_command.rb
-- lib/procon_bypass_man/commands/connect_device_command.rb
 - lib/procon_bypass_man/commands/print_boot_message_command.rb
 - lib/procon_bypass_man/commands/print_message_command.rb
-- lib/procon_bypass_man/commands/run_remote_pbm_action_dispatch_command.rb
 - lib/procon_bypass_man/commands/send_error_command.rb
 - lib/procon_bypass_man/commands/send_reload_config_event_command.rb
 - lib/procon_bypass_man/commands/write_device_id_command.rb
 - lib/procon_bypass_man/commands/write_session_id_command.rb
 - lib/procon_bypass_man/configuration.rb
-- lib/procon_bypass_man/device_connector.rb
-- lib/procon_bypass_man/device_procon_finder.rb
+- lib/procon_bypass_man/device_connection.rb
+- lib/procon_bypass_man/device_connection/command.rb
+- lib/procon_bypass_man/device_connection/executor.rb
+- lib/procon_bypass_man/device_connection/output_report_generator.rb
+- lib/procon_bypass_man/device_connection/output_report_markerable.rb
+- lib/procon_bypass_man/device_connection/output_report_sub_command_table.rb
+- lib/procon_bypass_man/device_connection/output_report_watcher.rb
+- lib/procon_bypass_man/device_connection/pre_bypass.rb
+- lib/procon_bypass_man/device_connection/procon_setting_overrider.rb
+- lib/procon_bypass_man/device_connection/spoofing_output_report_watcher.rb
+- lib/procon_bypass_man/device_model.rb
 - lib/procon_bypass_man/device_status.rb
-- lib/procon_bypass_man/domains.rb
-- lib/procon_bypass_man/domains/analog_stick_position.rb
-- lib/procon_bypass_man/domains/binary/base.rb
-- lib/procon_bypass_man/domains/binary/has_immutable_binary.rb
-- lib/procon_bypass_man/domains/binary/has_mutable_binary.rb
-- lib/procon_bypass_man/domains/binary/inbound_procon_binary.rb
-- lib/procon_bypass_man/domains/binary/processing_procon_binary.rb
-- lib/procon_bypass_man/domains/bypass_mode.rb
 - lib/procon_bypass_man/io_monitor.rb
 - lib/procon_bypass_man/plugin/splatoon2/macro/charge_tansan_bomb.rb
 - lib/procon_bypass_man/plugin/splatoon2/macro/dasei_cancel.rb
@@ -171,9 +171,25 @@ files:
 - lib/procon_bypass_man/procon/macro_registry.rb
 - lib/procon_bypass_man/procon/mode_registry.rb
 - lib/procon_bypass_man/procon/press_button_aware.rb
+- lib/procon_bypass_man/procon/suppress_rumble.rb
 - lib/procon_bypass_man/procon/user_operation.rb
 - lib/procon_bypass_man/procon/value_objects/analog_stick.rb
+- lib/procon_bypass_man/procon/value_objects/analog_stick_position.rb
+- lib/procon_bypass_man/procon/value_objects/binary.rb
+- lib/procon_bypass_man/procon/value_objects/binary/base.rb
+- lib/procon_bypass_man/procon/value_objects/binary/has_immutable_binary.rb
+- lib/procon_bypass_man/procon/value_objects/binary/has_mutable_binary.rb
+- lib/procon_bypass_man/procon/value_objects/binary/inbound_procon_binary.rb
+- lib/procon_bypass_man/procon/value_objects/binary/processing_procon_binary.rb
+- lib/procon_bypass_man/procon/value_objects/bypass_mode.rb
 - lib/procon_bypass_man/procon/value_objects/procon_reader.rb
+- lib/procon_bypass_man/procon/value_objects/rumble_binary.rb
+- lib/procon_bypass_man/procon_display.rb
+- lib/procon_bypass_man/procon_display/http_request.rb
+- lib/procon_bypass_man/procon_display/http_response.rb
+- lib/procon_bypass_man/procon_display/server.rb
+- lib/procon_bypass_man/procon_display/server_app.rb
+- lib/procon_bypass_man/procon_display/status.rb
 - lib/procon_bypass_man/remote_macro.rb
 - lib/procon_bypass_man/remote_macro/queue_over_process.rb
 - lib/procon_bypass_man/remote_macro/remote_macro_object.rb
@@ -184,6 +200,7 @@ files:
 - lib/procon_bypass_man/remote_pbm_action.rb
 - lib/procon_bypass_man/remote_pbm_action/base_action.rb
 - lib/procon_bypass_man/remote_pbm_action/change_pbm_version_action.rb
+- lib/procon_bypass_man/remote_pbm_action/commands/run_remote_pbm_action_dispatch_command.rb
 - lib/procon_bypass_man/remote_pbm_action/commands/update_remote_pbm_action_status_command.rb
 - lib/procon_bypass_man/remote_pbm_action/reboot_os_action.rb
 - lib/procon_bypass_man/remote_pbm_action/restore_pbm_setting.rb
@@ -194,6 +211,9 @@ files:
 - lib/procon_bypass_man/support/analog_stick_hypotenuse_tilting_power_scaler.rb
 - lib/procon_bypass_man/support/callbacks.rb
 - lib/procon_bypass_man/support/compress_array.rb
+- 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/http_client.rb
 - lib/procon_bypass_man/support/never_exit_accidentally.rb
 - lib/procon_bypass_man/support/on_memory_cache.rb
@@ -205,8 +225,9 @@ files:
 - lib/procon_bypass_man/support/signal_handler.rb
 - lib/procon_bypass_man/support/update_remote_pbm_action_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/yaml_loader.rb
 - lib/procon_bypass_man/support/yaml_writer.rb
-- lib/procon_bypass_man/usb_device_controller.rb
 - lib/procon_bypass_man/version.rb
 - lib/procon_bypass_man/websocket/client.rb
 - lib/procon_bypass_man/websocket/forever.rb

data/lib/procon_bypass_man/commands/connect_device_command.rb

@@ -1,18 +0,0 @@
-class ProconBypassMan::ConnectDeviceCommand
-  class NotFoundProconError < StandardError; end
-
-  # @return [void]
-  def self.execute!
-    gadget, procon = ProconBypassMan::DeviceConnector.connect
-  rescue ProconBypassMan::DeviceConnector::NotFoundProconError => e
-    ProconBypassMan.logger.error e
-    gadget&.close
-    procon&.close
-    raise ProconBypassMan::ConnectDeviceCommand::NotFoundProconError
-  rescue ProconBypassMan::SafeTimeout::Timeout
-    ProconBypassMan.logger.error "デバイスとの通信でタイムアウトが起きて接続ができませんでした。"
-    gadget&.close
-    procon&.close
-    raise ProconBypassMan::EternalConnectionError
-  end
-end