procon_bypass_man 0.1.13 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62fab79bffee3adf43af06325d7ef6bce2060f844d8caaa824968ff77219e5de
-  data.tar.gz: c15ab8b50da926169727b9af5ff097585cd35c7e24fdf2ce75d2ca7d4fe5f07e
+  metadata.gz: 346ad7fa333241bf5464ac38fce07caec0e0a021def6e2d456b7dc49a1f70b0a
+  data.tar.gz: 5f9f6d94706fd00c9ecc738f9626c5a2e6418039997f487f856d2298a6a9df1c
 SHA512:
-  metadata.gz: c94bc5e37b89c54a31fe165e53f84ac32c1b4d10fc617cc1397e0347baf1a39206fd50aff3a65626b8546545d00f33ac0e44a90da5ff25c02778d27e60aafe0f
-  data.tar.gz: 7ad56ef9e17bb8a26d840003faf8fa7d065ba878182dcd23d66118b43053c2827221814f37bb4098174cdfbcc449486d895bf6431520f60ce295a4e7382c39e7
+  metadata.gz: 792586a96060eb9adb8e7c0cf31bd56663da6343fa753709158890d47aed1025e87f24f670d176dea543d71cf6de2c6e8bb200b3bf109981f99e0f73b8eaa932
+  data.tar.gz: 8e82db2b88efb8d5752797eab1e203379d30edf6e71fcda3ff35bdba8e46e27923e5da313442be366c50e6c38b8a0583296a36e94c35f078d648fb18f59c2a0d

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## [0.1.14] - 2021-12-02
+- 外部サーバからOSの再起動やprocon_bypass_manのバージョンアップができるようになりました
+
 ## [0.1.13] - 2021-11-24
 - 起動を早くするために、procon_bypass_man-splatoon2を同梱しました
 

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    procon_bypass_man (0.1.13)
+    procon_bypass_man (0.1.14)
+      pbmenv
 
 GEM
   remote: https://rubygems.org/
@@ -30,6 +31,7 @@ GEM
     parallel (1.21.0)
     parser (3.0.2.0)
       ast (~> 2.4.1)
+    pbmenv (0.1.5)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)

data/README.md

@@ -67,7 +67,7 @@ sudo kill -USR2 `cat ./pbm_pid`
 ```
 
 ### 起動ログをサーバに送信する
-* `ProconBypassMan.api_server = "http://.."` を設定すると、 `POST /api/events` に対して起動ログなどを送信するようになります
+* `ProconBypassMan.api_servers = "http://.."` を設定すると、 `POST /api/events` に対して起動ログなどを送信するようになります
 
 ### 開発環境でログの送信を確認する方法
 * `bundle exec bin/dev_api_server.rb`

data/lib/procon_bypass_man/background/jobs/base_job.rb

@@ -1,12 +1,7 @@
 class ProconBypassMan::BaseJob
-  extend ProconBypassMan::Background::HasServerPool
   extend ProconBypassMan::Background::JobRunnable
 
   def self.servers
-    ProconBypassMan.config.api_servers
-  end
-
-  def self.path
-    "/api/events"
+    raise NotImplementedError
   end
 end

data/lib/procon_bypass_man/background/jobs/concerns/has_external_api_setting.rb

@@ -0,0 +1,5 @@
+module ProconBypassMan::HasExternalApiSetting
+  def server_pool
+    ProconBypassMan.config.server_pool
+  end
+end

data/lib/procon_bypass_man/background/jobs/concerns/has_internal_api_setting.rb

@@ -0,0 +1,5 @@
+module ProconBypassMan::HasInternalApiSetting
+  def server_pool
+    ProconBypassMan.config.internal_server_pool
+  end
+end

data/lib/procon_bypass_man/background/jobs/fetch_and_run_remote_pbm_action_job.rb

@@ -0,0 +1,29 @@
+class ProconBypassMan::FetchAndRunRemotePbmActionJob < ProconBypassMan::BaseJob
+  extend ProconBypassMan::HasExternalApiSetting
+
+  def self.perform
+    pbm_jobs = ProconBypassMan::HttpClient.new(path: path, server_pool: server_pool).get
+    if pbm_jobs.nil? || pbm_jobs.size.zero?
+      # ProconBypassMan.logger.debug "remote pbm_jobsはありませんでした"
+      return
+    else
+      pbm_job_hash = pbm_jobs.first
+      begin
+        pbm_job_object = ProconBypassMan::RemotePbmActionObject.new(action: pbm_job_hash["action"],
+                                                                    status: pbm_job_hash["status"],
+                                                                    uuid: pbm_job_hash["uuid"],
+                                                                    created_at: pbm_job_hash["created_at"],
+                                                                    job_args: pbm_job_hash["args"])
+        pbm_job_object.validate!
+        ProconBypassMan::RunRemotePbmActionDispatchCommand.execute(action: pbm_job_object.action, uuid: pbm_job_object.uuid, job_args: pbm_job_object.job_args)
+      rescue ProconBypassMan::RemotePbmActionObject::ValidationError => e
+        ProconBypassMan::SendErrorCommand.execute(error: e)
+      end
+    end
+  end
+
+  def self.path
+    device_id = ProconBypassMan.device_id
+    "/api/devices/#{device_id}/pbm_jobs"
+  end
+end

data/lib/procon_bypass_man/background/jobs/report_boot_job.rb

@@ -1,9 +1,11 @@
-class ProconBypassMan::ReportBootJob <  ProconBypassMan::BaseJob
+class ProconBypassMan::ReportBootJob < ProconBypassMan::ReportEventBaseJob
+  extend ProconBypassMan::HasExternalApiSetting
+
   # @param [String] body
   def self.perform(body)
-    ProconBypassMan::Background::HttpClient.new(
+    ProconBypassMan::ReportHttpClient.new(
       path: path,
-      pool_server: pool_server,
+      server_pool: server_pool,
       retry_on_connection_error: true,
     ).post(body: body, event_type: :boot)
   end

data/lib/procon_bypass_man/background/jobs/report_error_job.rb

@@ -1,10 +1,11 @@
-class ProconBypassMan::ReportErrorJob < ProconBypassMan::BaseJob
+class ProconBypassMan::ReportErrorJob < ProconBypassMan::ReportEventBaseJob
+  extend ProconBypassMan::HasExternalApiSetting
+
   # @param [String] body
   def self.perform(body)
-    ProconBypassMan::Background::HttpClient.new(
+    ProconBypassMan::ReportHttpClient.new(
       path: path,
-      pool_server: pool_server,
-      retry_on_connection_error: false,
-    ).post(body: body, event_type: :error,)
+      server_pool: server_pool,
+    ).post(body: body, event_type: :error)
   end
 end

data/lib/procon_bypass_man/background/jobs/report_event_base_job.rb

@@ -0,0 +1,5 @@
+class ProconBypassMan::ReportEventBaseJob < ProconBypassMan::BaseJob
+  def self.path
+    "/api/events".freeze
+  end
+end

data/lib/procon_bypass_man/background/jobs/report_load_config_job.rb

@@ -1,10 +1,11 @@
-class ProconBypassMan::ReportLoadConfigJob <  ProconBypassMan::BaseJob
+class ProconBypassMan::ReportLoadConfigJob < ProconBypassMan::ReportEventBaseJob
+  extend ProconBypassMan::HasExternalApiSetting
+
   # @param [String] body
   def self.perform(body)
-    ProconBypassMan::Background::HttpClient.new(
+    ProconBypassMan::ReportHttpClient.new(
       path: path,
-      pool_server: pool_server,
-      retry_on_connection_error: false,
+      server_pool: server_pool,
     ).post(body: body, event_type: :load_config)
   end
 end

data/lib/procon_bypass_man/background/jobs/report_pressed_buttons_job.rb

@@ -1,18 +1,15 @@
-class ProconBypassMan::ReportPressedButtonsJob
-  extend ProconBypassMan::Background::HasServerPool
-  extend ProconBypassMan::Background::JobRunnable
-
-  PATH = "/api/pressed_buttons"
+class ProconBypassMan::ReportPressedButtonsJob < ProconBypassMan::BaseJob
+  extend ProconBypassMan::HasInternalApiSetting
 
   # @param [String] body
   def self.perform(body)
-    ProconBypassMan::Background::HttpClient.new(
-      path: PATH,
-      pool_server: pool_server,
+    ProconBypassMan::ReportHttpClient.new(
+      path: path,
+      server_pool: server_pool,
     ).post(body: body, event_type: :internal)
   end
 
-  def self.servers
-    ProconBypassMan.config.internal_api_servers
+  def self.path
+    "/api/pressed_buttons"
   end
 end

data/lib/procon_bypass_man/background/jobs/report_reload_config_job.rb

@@ -1,10 +1,11 @@
-class ProconBypassMan::ReportReloadConfigJob <  ProconBypassMan::BaseJob
+class ProconBypassMan::ReportReloadConfigJob < ProconBypassMan::ReportEventBaseJob
+  extend ProconBypassMan::HasExternalApiSetting
+
   # @param [String] body
   def self.perform(body)
-    ProconBypassMan::Background::HttpClient.new(
+    ProconBypassMan::ReportHttpClient.new(
       path: path,
-      pool_server: pool_server,
-      retry_on_connection_error: false,
+      server_pool: server_pool,
     ).post(body: body, event_type: :reload_config)
   end
 end

data/lib/procon_bypass_man/background/jobs/sync_device_stats_job.rb

@@ -0,0 +1,16 @@
+class ProconBypassMan::SyncDeviceStatsJob < ProconBypassMan::BaseJob
+  extend ProconBypassMan::HasExternalApiSetting
+
+  # @param [Symbol] status
+  def self.perform(status)
+    ProconBypassMan::SendDeviceStatsHttpClient.new(
+      path: path,
+      server_pool: server_pool,
+    ).post(status: status, pbm_session_id: ProconBypassMan.session_id)
+  end
+
+  def self.path
+    device_id = ProconBypassMan.device_id
+    "/api/devices/#{ProconBypassMan.device_id}/device_statuses"
+  end
+end

data/lib/procon_bypass_man/background.rb

@@ -1,12 +1,14 @@
-require "procon_bypass_man/background/job_runnable"
+require "procon_bypass_man/background/jobs/concerns/has_internal_api_setting"
+require "procon_bypass_man/background/jobs/concerns/has_external_api_setting"
+require "procon_bypass_man/background/jobs/concerns/job_runnable"
 require "procon_bypass_man/background/job_runner"
 require "procon_bypass_man/background/job_performer"
-require "procon_bypass_man/background/has_server_pool"
-require "procon_bypass_man/background/http_client"
 require "procon_bypass_man/background/jobs/base_job"
+require "procon_bypass_man/background/jobs/report_event_base_job"
 require "procon_bypass_man/background/jobs/report_boot_job"
 require "procon_bypass_man/background/jobs/report_reload_config_job"
 require "procon_bypass_man/background/jobs/report_load_config_job"
 require "procon_bypass_man/background/jobs/report_error_job"
-require "procon_bypass_man/background/jobs/report_heartbeat_job"
 require "procon_bypass_man/background/jobs/report_pressed_buttons_job"
+require "procon_bypass_man/background/jobs/fetch_and_run_remote_pbm_action_job"
+require "procon_bypass_man/background/jobs/sync_device_stats_job"

data/lib/procon_bypass_man/boot_message.rb

@@ -9,6 +9,8 @@ class ProconBypassMan::BootMessage
     @table[:setting_path] = ProconBypassMan::ButtonsSettingConfiguration.instance.setting_path
     @table[:uptime_from_boot] = ProconBypassMan::Uptime.from_boot
     @table[:use_pbmenv] = !(!!`which pbmenv`.empty?)
+    @table[:session_id] = ProconBypassMan.session_id
+    @table[:device_id] = ProconBypassMan.device_id
 
     # 開発中のHEADを取りたかったけど、Gem::Specification経由から取得する必要がありそう
     # build_version = `git rev-parse --short HEAD`.chomp
@@ -33,6 +35,8 @@ class ProconBypassMan::BootMessage
       setting_path: #{@table[:setting_path]}
       uptime from boot: #{@table[:uptime_from_boot]} sec
       use_pbmenv: #{@table[:use_pbmenv]}
+      session_id: #{ProconBypassMan.session_id}
+      device_id: #{ProconBypassMan.device_id}
       ----
     EOF
   end

data/lib/procon_bypass_man/bypass/usb_hid_logger.rb

@@ -33,10 +33,6 @@ class ProconBypassMan::Bypass
           ProconBypassMan::ProconReader.new(binary: bypass_value.binary).to_hash
         )
       end
-
-      ProconBypassMan.cache.fetch key: 'heartbeat_reporter', expires_in: 60 do
-        ProconBypassMan::ReportHeartbeatJob.perform_async(ProconBypassMan::BootMessage.new.to_hash)
-      end
     end
   end
 end

data/lib/procon_bypass_man/commands/connect_device_command.rb

@@ -2,8 +2,13 @@ class ProconBypassMan::ConnectDeviceCommand
   # @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::NotFoundProconError
   rescue ProconBypassMan::SafeTimeout::Timeout
-    ::ProconBypassMan.logger.error "デバイスとの通信でタイムアウトが起きて接続ができませんでした。"
+    ProconBypassMan.logger.error "デバイスとの通信でタイムアウトが起きて接続ができませんでした。"
     gadget&.close
     procon&.close
     raise ::ProconBypassMan::EternalConnectionError

data/lib/procon_bypass_man/commands/run_local_shell_command.rb

@@ -0,0 +1,6 @@
+class ProconBypassMan::RunLocalShellCommand
+  class LocalCommandError < StandardError; end
+
+  def self.execute(action: , uuid: )
+  end
+end

data/lib/procon_bypass_man/commands/run_remote_pbm_action_dispatch_command.rb

@@ -0,0 +1,19 @@
+class ProconBypassMan::RunRemotePbmActionDispatchCommand
+  # @param [String] action
+  # @param [String] uuid
+  # @return [void]
+  def self.execute(action: , uuid: , job_args: )
+    case action
+    when ProconBypassMan::RemotePbmAction::ACTION_CHANGE_PBM_VERSION
+      ProconBypassMan::RemotePbmAction::ChangePbmVersionAction.new(pbm_job_uuid: uuid).run!(job_args: job_args)
+    when ProconBypassMan::RemotePbmAction::ACTION_STOP_PBM
+      ProconBypassMan::RemotePbmAction::StopPbmAction.new(pbm_job_uuid: uuid).run!(job_args: {})
+    when ProconBypassMan::RemotePbmAction::ACTION_REBOOT_OS
+      ProconBypassMan::RemotePbmAction::RebootOsAction.new(pbm_job_uuid: uuid).run!(job_args: {})
+    else
+      ProconBypassMan::SendErrorCommand.execute(error: "#{action}は対応していないアクションです")
+    end
+  rescue ProconBypassMan::RemotePbmAction::ActionUnexpectedError => e
+    ProconBypassMan::SendErrorCommand.execute(error: e)
+  end
+end

data/lib/procon_bypass_man/commands/send_error_command.rb

@@ -14,6 +14,6 @@ class ProconBypassMan::SendErrorCommand
     ProconBypassMan.error_logger.error body
     puts body
 
-    ProconBypassMan::ReportErrorJob.perform_async(error)
+    ProconBypassMan::ReportErrorJob.perform(error)
   end
 end

data/lib/procon_bypass_man/commands/write_session_id_command.rb

@@ -2,12 +2,6 @@ class ProconBypassMan::WriteSessionIdCommand
   # @return [String] session_id ラズパイが起動してからshutdownするまで同じ文字列を返す
   # 起動すると/tmp がなくなる前提の実装
   def self.execute
-    path = "/tmp/pbm_session_id"
-    if(sid = File.read(path))
-      return sid
-    end
-  rescue Errno::ENOENT
-    File.write(path, "s_#{SecureRandom.uuid}")
-    return SecureRandom.uuid
+    @@session_id ||= "s_#{SecureRandom.uuid}"
   end
 end

data/lib/procon_bypass_man/commands.rb

@@ -5,3 +5,4 @@ require "procon_bypass_man/commands/send_reload_config_event_command"
 require "procon_bypass_man/commands/send_error_command"
 require "procon_bypass_man/commands/connect_device_command"
 require "procon_bypass_man/commands/bypass_command"
+require "procon_bypass_man/commands/run_remote_pbm_action_dispatch_command"

data/lib/procon_bypass_man/configuration.rb

@@ -16,6 +16,11 @@ class ProconBypassMan::Configuration
       @@pid_path ||= File.expand_path("#{root}/pbm_pid", __dir__).freeze
     end
 
+    # @return [Integer]
+    def pid
+      File.read(pid_path).to_i
+    end
+
     def digest_path
       config.digest_path
     end
@@ -31,7 +36,7 @@ class ProconBypassMan::Configuration
 
     # @return [String]
     def device_id
-      ProconBypassMan::WriteDeviceIdCommand.execute
+      ENV["DEBUG_DEVICE_ID"] || ProconBypassMan::WriteDeviceIdCommand.execute
     end
   end
 
@@ -96,6 +101,17 @@ class ProconBypassMan::Configuration
     end
   end
 
+  # @return [Array<ProconBypassMan::ServerPool>]
+  def internal_server_pool
+    @internal_server_pool ||= ProconBypassMan::ServerPool.new(servers: internal_api_servers)
+  end
+
+  # @return [Array<ProconBypassMan::ServerPool>]
+  def server_pool
+    @server_pool ||= ProconBypassMan::ServerPool.new(servers: api_servers)
+  end
+
+  # @return [Array<String>]
   def api_servers
     if !!ENV["API_SERVER"]
       [ENV["API_SERVER"]].reject(&:nil?)

data/lib/procon_bypass_man/device_connector.rb

@@ -1,5 +1,6 @@
 class ProconBypassMan::DeviceConnector
   class BytesMismatchError < StandardError; end
+  class NotFoundProconError < StandardError; end
 
   class Value
     attr_accessor :read_from, :values
@@ -300,7 +301,7 @@ class ProconBypassMan::DeviceConnector
       @procon = File.open(PROCON2_PATH, "w+b")
       @gadget = File.open('/dev/hidg0', "w+b")
     else
-      raise "/dev/hidraw0, /dev/hidraw1の両方見つかりませんでした"
+      raise NotFoundProconError, "/dev/hidraw0, /dev/hidraw1の両方見つかりませんでした"
     end
     system('echo > /sys/kernel/config/usb_gadget/procon/UDC')
     system('ls /sys/class/udc > /sys/kernel/config/usb_gadget/procon/UDC')

data/lib/procon_bypass_man/device_status.rb

@@ -0,0 +1,44 @@
+class ProconBypassMan::DeviceStatus
+  INITIALIZED = :initialized
+  RUNNING = :running
+  CONNECTED_BUT_SLEEPING = :connected_but_sleeping # コードはつながっているが、switchがsleepしているとき
+  PROCON_NOT_FOUND_ERROR = :procon_not_found_error # 繋がっていないとか、デバイスが使えない時
+  CONNECTED_BUT_ERROR = :connected_but_error # 実行時エラーあたり
+  SETTING_SYNTAX_ERROR_AND_SHUTDOWN = :setting_syntax_error_and_shutdown
+
+  @@status = nil
+
+  def self.current
+    @@status || INITIALIZED
+  end
+
+  def self.change_to_running!
+    @@status = RUNNING
+    ProconBypassMan::SyncDeviceStatsJob.perform_async(ProconBypassMan::DeviceStatus.current)
+  end
+
+  def self.change_to_connected_but_sleeping!
+    @@status = CONNECTED_BUT_SLEEPING
+    ProconBypassMan::SyncDeviceStatsJob.perform_async(ProconBypassMan::DeviceStatus.current)
+  end
+
+  def self.change_to_procon_not_found_error!
+    @@status = PROCON_NOT_FOUND_ERROR
+    ProconBypassMan::SyncDeviceStatsJob.perform_async(ProconBypassMan::DeviceStatus.current)
+  end
+
+  def self.change_to_device_error!
+    @@status = DEVICE_ERROR
+    ProconBypassMan::SyncDeviceStatsJob.perform_async(ProconBypassMan::DeviceStatus.current)
+  end
+
+  def self.change_to_connected_but_error!
+    @@status = CONNECTED_BUT_ERROR
+    ProconBypassMan::SyncDeviceStatsJob.perform_async(ProconBypassMan::DeviceStatus.current)
+  end
+
+  def self.change_to_setting_syntax_error_and_shutdown!
+    @@status = SETTING_SYNTAX_ERROR_AND_SHUTDOWN
+    ProconBypassMan::SyncDeviceStatsJob.perform_async(ProconBypassMan::DeviceStatus.current)
+  end
+end

data/lib/procon_bypass_man/remote_pbm_action/base_action.rb

@@ -0,0 +1,53 @@
+module ProconBypassMan
+  module RemotePbmAction
+    class ActionUnexpectedError < StandardError; end
+    class NeedPbmVersionError < ActionUnexpectedError; end
+
+    class BaseAction
+      attr_accessor :pbm_job_uuid
+
+      # @param [String] pbm_job_uuid
+      def initialize(pbm_job_uuid: )
+        self.pbm_job_uuid = pbm_job_uuid
+      end
+
+      # @return [void]
+      def action_content(_args)
+        raise NotImplementedError, nil
+      end
+
+      # @param [Hash] args
+      # @return [void]
+      def run!(job_args: )
+        before_action_callback
+        action_content(args: job_args)
+        after_action_callback
+      rescue => e
+        be_failed
+        ProconBypassMan::SendErrorCommand.execute(error: e)
+      end
+
+      private
+
+      # @return [void]
+      def before_action_callback; end
+      # @return [void]
+      def after_action_callback; end
+
+      # @return [void]
+      def be_failed
+        ProconBypassMan::UpdateRemotePbmActionStatusCommand.new(pbm_job_uuid: pbm_job_uuid).execute(to_status: :failed)
+      end
+
+      # @return [void]
+      def be_in_progress
+        ProconBypassMan::UpdateRemotePbmActionStatusCommand.new(pbm_job_uuid: pbm_job_uuid).execute(to_status: :in_progress)
+      end
+
+      # @return [void]
+      def be_processed
+        ProconBypassMan::UpdateRemotePbmActionStatusCommand.new(pbm_job_uuid: pbm_job_uuid).execute(to_status: :processed)
+      end
+    end
+  end
+end

data/lib/procon_bypass_man/remote_pbm_action/change_pbm_version_action.rb

@@ -0,0 +1,21 @@
+module ProconBypassMan
+  module RemotePbmAction
+    class ChangePbmVersionAction < BaseAction
+
+      def action_content(args: )
+        require "pbmenv"
+        ProconBypassMan.logger.info "execute ChangePbmVersionAction!"
+        pbm_version = args["pbm_version"] or raise(ProconBypassMan::RemotePbmAction::NeedPbmVersionError, "pbm_versionが必要です, #{args.inspect}")
+        Pbmenv.install(pbm_version)
+        Pbmenv.use(pbm_version)
+        `reboot` # symlinkの参照先が変わるのでrebootする必要がある
+      end
+
+      private
+
+      def before_action_callback
+        be_processed
+      end
+    end
+  end
+end

data/lib/procon_bypass_man/remote_pbm_action/lib/update_remote_pbm_action_status_command.rb

@@ -0,0 +1,24 @@
+module ProconBypassMan
+  class UpdateRemotePbmActionStatusCommand
+    # @param [String] pbm_job_uuid
+    def initialize(pbm_job_uuid: )
+      @pbm_job_uuid = pbm_job_uuid
+    end
+
+    # @param [String] to_status
+    # @return [void]
+    def execute(to_status: )
+      ProconBypassMan::UpdateRemotePbmActionStatusHttpClient.new(
+        path: path,
+        server_pool: ProconBypassMan.config.server_pool,
+      ).put(to_status: to_status)
+    end
+
+    private
+
+    # @return [String]
+    def path
+      "/api/devices/#{ProconBypassMan.device_id}/pbm_jobs/#{@pbm_job_uuid}"
+    end
+  end
+end

data/lib/procon_bypass_man/remote_pbm_action/reboot_os_action.rb

@@ -0,0 +1,17 @@
+module ProconBypassMan
+  module RemotePbmAction
+    class RebootOsAction < BaseAction
+
+      def action_content(_args)
+        ProconBypassMan.logger.info "execute RebootOsAction!"
+        `reboot`
+      end
+
+      private
+
+      def before_action_callback
+        be_processed
+      end
+    end
+  end
+end

data/lib/procon_bypass_man/remote_pbm_action/stop_pbm_action.rb

@@ -0,0 +1,17 @@
+module ProconBypassMan
+  module RemotePbmAction
+    class StopPbmAction < BaseAction
+
+      def action_content(_args)
+        ProconBypassMan.logger.info "execute StopPbmAction!"
+        Process.kill("TERM", ProconBypassMan.pid)
+      end
+
+      private
+
+      def before_action_callback
+        be_processed
+      end
+    end
+  end
+end

data/lib/procon_bypass_man/remote_pbm_action.rb

@@ -0,0 +1,31 @@
+module ProconBypassMan
+  module RemotePbmAction
+    require "procon_bypass_man/remote_pbm_action/base_action"
+    require "procon_bypass_man/remote_pbm_action/change_pbm_version_action"
+    require "procon_bypass_man/remote_pbm_action/reboot_os_action"
+    require "procon_bypass_man/remote_pbm_action/stop_pbm_action"
+    require "procon_bypass_man/remote_pbm_action/lib/update_remote_pbm_action_status_command"
+
+    ACTION_CHANGE_PBM_VERSION = "change_pbm_version"
+    ACTION_REBOOT_OS = "reboot_os"
+    ACTION_STOP_PBM = "stop_pbm"
+    ACTION_RESTORE_SETTING = "restore_setting" # TODO
+
+    ACTIONS = [
+      ACTION_CHANGE_PBM_VERSION,
+      ACTION_REBOOT_OS,
+      ACTION_STOP_PBM,
+      ACTION_RESTORE_SETTING,
+    ]
+
+    STATUS_FAILED = :failed
+    STATUS_IN_PROGRESS = :in_progress
+    STATUS_PROCESSED = :processed
+
+    ACTION_STATUSES = [
+      STATUS_FAILED,
+      STATUS_IN_PROGRESS,
+      STATUS_PROCESSED,
+    ]
+  end
+end

data/lib/procon_bypass_man/scheduler.rb

@@ -0,0 +1,92 @@
+module ProconBypassMan
+  class Scheduler
+    class Schedule
+      attr_accessor :klass, :args, :interval, :next_enqueue_at
+
+      # @param [any] klass
+      # @param [Array] args
+      # @param [Integer] interval
+      def initialize(klass: , args: , interval: )
+        self.klass = klass
+        self.args = args
+        self.interval = interval
+        self.next_enqueue_at = Time.now
+      end
+
+      # @return [void]
+      def enqueue
+        klass.perform_async(*unwrap_args(args))
+        set_next_enqueue_at!
+      end
+
+      # @return [boolean]
+      def past_interval?
+        next_enqueue_at < Time.now
+      end
+
+      private
+
+      # @return [void]
+      def set_next_enqueue_at!
+        self.next_enqueue_at = Time.now + interval
+      end
+
+      # @param [Array] args
+      # @return [void]
+      def unwrap_args(args)
+        args.map do |arg|
+          case arg
+          when Proc
+            arg.call
+          else
+            arg
+          end
+        end
+      end
+    end
+
+    # @return [Hash]
+    def self.schedules
+      @@schedules
+    end
+
+    @@schedules = {}
+
+    def self.start!
+      register_schedules
+
+      @@thread = Thread.start do
+        loop do
+          schedules.each do |_key, schedule|
+            if schedule.past_interval?
+              schedule.enqueue
+            end
+          end
+          sleep 10
+        end
+      end
+    end
+
+    def self.register_schedules
+      register(
+        schedule: Schedule.new(
+          klass: ProconBypassMan::FetchAndRunRemotePbmActionJob,
+          args: [],
+          interval: 3,
+        )
+      )
+      register(
+        schedule: Schedule.new(
+          klass: ProconBypassMan::SyncDeviceStatsJob,
+          args: [->{ ProconBypassMan::DeviceStatus.current }],
+          interval: 60,
+        )
+      )
+    end
+
+    # @param [Schedule] schedule
+    def self.register(schedule: )
+      schedules[schedule.klass] = schedule
+    end
+  end
+end

data/lib/procon_bypass_man/support/http_client.rb

@@ -0,0 +1,102 @@
+module ProconBypassMan
+  class HttpClient
+    class HttpRequest
+      class Get
+        def self.request!(uri: )
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = uri.scheme === "https"
+          http.get(uri.path, { "Content-Type" => "application/json" })
+        end
+      end
+
+      class Post
+        def self.request!(uri: , request_body: {})
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = uri.scheme === "https"
+          http.post(uri.path, request_body.to_json, { "Content-Type" => "application/json" })
+        end
+      end
+
+      class Put
+        def self.request!(uri: , request_body: {})
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = uri.scheme === "https"
+          http.put(uri.path, request_body.to_json, { "Content-Type" => "application/json" })
+        end
+      end
+    end
+
+    def initialize(path: , server_pool: , retry_on_connection_error: false)
+      @server_pool = server_pool
+      @uri = URI.parse("#{server_pool.server}#{path}")
+      @retry_on_connection_error = retry_on_connection_error
+    end
+
+    def get
+      handle_request do
+        response = HttpRequest::Get.request!(
+          uri: @uri,
+        )
+        break process_response(response)
+      end
+    end
+
+    def post(request_body: )
+      handle_request do
+        body = {}.merge!(request_body)
+        response = HttpRequest::Post.request!(
+          uri: @uri,
+          request_body: body,
+        )
+        break process_response(response)
+      end
+    end
+
+    def put(request_body: )
+      handle_request do
+        body = {
+          hostname: `hostname`.chomp,
+        }.merge!(request_body)
+        response = HttpRequest::Put.request!(
+          uri: @uri,
+          request_body: body,
+        )
+        break process_response(response)
+      end
+    end
+
+    private
+
+    def process_response(response)
+      case response.code
+      when /^200/
+        begin
+          return JSON.parse(response.body)
+        rescue JSON::ParserError
+          return response.body
+        end
+      else
+        @server_pool.next!
+        ProconBypassMan.logger.error("#{@uri}から200以外(#{response.code})が帰ってきました. #{response.body}")
+      end
+    end
+
+    def handle_request
+      raise "need block" unless block_given?
+      if @server_pool.server.nil?
+        ProconBypassMan.logger.info('送信先が未設定なのでスキップしました')
+        return
+      end
+      return yield
+    rescue SocketError => e
+      ProconBypassMan.logger.error(e)
+      if @retry_on_connection_error
+        sleep(10)
+        retry
+      end
+    rescue => e
+      puts e
+      ProconBypassMan.logger.error(e)
+    end
+  end
+end

data/lib/procon_bypass_man/support/report_http_client.rb

@@ -0,0 +1,19 @@
+module ProconBypassMan
+  class ReportHttpClient < HttpClient
+    def post(body: , event_type: )
+      if body.is_a?(String)
+        b = { text: body }
+      else
+        b = body
+      end
+
+      super(request_body: {
+        session_id: ProconBypassMan.session_id,
+        device_id: ProconBypassMan.device_id,
+        hostname: `hostname`.chomp,
+        event_type: event_type,
+        body: b,
+      })
+    end
+  end
+end

data/lib/procon_bypass_man/support/send_device_stats_http_client.rb

@@ -0,0 +1,9 @@
+module ProconBypassMan
+  class SendDeviceStatsHttpClient < HttpClient
+    def post(status: , pbm_session_id: )
+      super(request_body: {
+        body: { status: status, pbm_session_id: pbm_session_id },
+      })
+    end
+  end
+end

data/lib/procon_bypass_man/{background/has_server_pool.rb → support/server_pool.rb}

@@ -1,4 +1,4 @@
-module ProconBypassMan::Background::HasServerPool
+module ProconBypassMan
   class ServerPool
     def initialize(servers: )
       if servers.nil? || servers.empty?
@@ -29,6 +29,8 @@ module ProconBypassMan::Background::HasServerPool
       end
     end
 
+    private
+
     def reset
       @index = 0
     end
@@ -37,18 +39,4 @@ module ProconBypassMan::Background::HasServerPool
       @index = @index + 1
     end
   end
-
-  def reset_server_pool!
-    @pool_server = nil
-  end
-
-  def pool_server
-    @pool_server ||= ServerPool.new(
-      servers: servers
-    )
-  end
-
-  def servers
-    raise NotImplementedError, nil
-  end
 end

data/lib/procon_bypass_man/support/update_remote_pbm_action_status_http_client.rb

@@ -0,0 +1,9 @@
+module ProconBypassMan
+  class UpdateRemotePbmActionStatusHttpClient < HttpClient
+    def put(to_status: )
+      super(request_body: {
+        body: { status: to_status },
+      })
+    end
+  end
+end

data/lib/procon_bypass_man/value_objects/remote_pbm_action_object.rb

@@ -0,0 +1,38 @@
+module ProconBypassMan
+  class RemotePbmActionObject
+    # valueobjectがvalidatorの責務も持っている. 今度分離する
+    class ValidationError < StandardError; end
+    class MustBeNotNilError < ValidationError; end
+    class NonSupportAction < ValidationError; end
+
+    attr_accessor :action, :status, :uuid, :created_at, :job_args
+
+    # @param [String] action
+    # @param [String] status
+    # @param [String] #uuid
+    # @param [Time] created_at
+    # @return [Hash] job_args
+    def initialize(action: , status:, uuid:, created_at:, job_args: )
+      self.action = action
+      self.status = status
+      self.uuid = uuid
+      self.created_at = created_at
+      self.job_args = job_args
+
+      freeze
+    end
+
+    # @raise [MustBeNotNilError]
+    # @raise [NonSupportAction]
+    # @return [void]
+    def validate!
+      self.action or raise MustBeNotNilError, "actionは値が必須です"
+      self.status or raise MustBeNotNilError, "statusは値が必須です"
+      self.uuid or raise MustBeNotNilError, "uuidは値が必須です"
+
+      unless ProconBypassMan::RemotePbmAction::ACTIONS.include?(action)
+        raise NonSupportAction, "知らないアクションです"
+      end
+    end
+  end
+end

data/lib/procon_bypass_man/version.rb

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

data/lib/procon_bypass_man.rb

@@ -6,16 +6,23 @@ require "fileutils"
 require "securerandom"
 
 require_relative "procon_bypass_man/version"
+require_relative "procon_bypass_man/remote_pbm_action"
 require_relative "procon_bypass_man/support/signal_handler"
 require_relative "procon_bypass_man/support/callbacks"
 require_relative "procon_bypass_man/support/safe_timeout"
 require_relative "procon_bypass_man/support/compress_array"
 require_relative "procon_bypass_man/support/uptime"
 require_relative "procon_bypass_man/support/on_memory_cache"
+require_relative "procon_bypass_man/support/http_client"
+require_relative "procon_bypass_man/support/report_http_client"
+require_relative "procon_bypass_man/support/update_remote_pbm_action_status_http_client"
+require_relative "procon_bypass_man/support/send_device_stats_http_client"
+require_relative "procon_bypass_man/support/server_pool"
 require_relative "procon_bypass_man/background"
 require_relative "procon_bypass_man/commands"
 require_relative "procon_bypass_man/bypass"
 require_relative "procon_bypass_man/device_connector"
+require_relative "procon_bypass_man/device_status"
 require_relative "procon_bypass_man/runner"
 require_relative "procon_bypass_man/processor"
 require_relative "procon_bypass_man/configuration"
@@ -24,6 +31,8 @@ require_relative "procon_bypass_man/procon"
 require_relative "procon_bypass_man/procon_reader"
 require_relative "procon_bypass_man/procon/analog_stick"
 require_relative "procon_bypass_man/procon/analog_stick_cap"
+require_relative "procon_bypass_man/value_objects/remote_pbm_action_object"
+require_relative "procon_bypass_man/scheduler"
 require_relative "procon_bypass_man/splatoon2"
 
 STDOUT.sync = true
@@ -34,6 +43,7 @@ module ProconBypassMan
 
   class CouldNotLoadConfigError < StandardError; end
   class FirstConnectionError < StandardError; end
+  class NotFoundProconError < StandardError; end
   class EternalConnectionError < StandardError; end
 
   def self.buttons_setting_configure(setting_path: nil, &block)
@@ -50,25 +60,36 @@ module ProconBypassMan
 
   # @return [void]
   def self.run(setting_path: nil, &block)
+    ProconBypassMan::Scheduler.start!
+    ProconBypassMan::Background::JobRunner.start!
+
     ProconBypassMan.logger.info "PBMを起動しています"
     puts "PBMを起動しています"
     buttons_setting_configure(setting_path: setting_path, &block)
     initialize_pbm
     File.write(pid_path, $$)
     ProconBypassMan::WriteSessionIdCommand.execute
-    ProconBypassMan::Background::JobRunner.start!
     gadget, procon = ProconBypassMan::ConnectDeviceCommand.execute!
+    ProconBypassMan::DeviceStatus.change_to_running!
     Runner.new(gadget: gadget, procon: procon).run
-  rescue CouldNotLoadConfigError
+  rescue ProconBypassMan::CouldNotLoadConfigError
     ProconBypassMan::SendErrorCommand.execute(error: "設定ファイルが不正です。設定ファイルの読み込みに失敗しました")
+    ProconBypassMan::DeviceStatus.change_to_setting_syntax_error_and_shutdown!
+    FileUtils.rm_rf(ProconBypassMan.pid_path)
+    FileUtils.rm_rf(ProconBypassMan.digest_path)
+    exit 1
+  rescue ProconBypassMan::NotFoundProconError
+    ProconBypassMan::SendErrorCommand.execute(error: "プロコンが見つかりませんでした。終了します。")
+    ProconBypassMan::DeviceStatus.change_to_procon_not_found_error!
     FileUtils.rm_rf(ProconBypassMan.pid_path)
     FileUtils.rm_rf(ProconBypassMan.digest_path)
     exit 1
-  rescue EternalConnectionError
+  rescue ProconBypassMan::EternalConnectionError
     ProconBypassMan::SendErrorCommand.execute(error: "接続の見込みがないのでsleepしまくります")
+    ProconBypassMan::DeviceStatus.change_to_connected_but_sleeping!
     FileUtils.rm_rf(ProconBypassMan.pid_path)
-    sleep(999999999)
-  rescue FirstConnectionError
+    eternal_sleep
+  rescue ProconBypassMan::FirstConnectionError
     ProconBypassMan::SendErrorCommand.execute(error: "接続を確立できませんでした。やりなおします。")
     retry
   end
@@ -96,4 +117,8 @@ module ProconBypassMan
   def self.initialize_pbm
     ProconBypassMan::WriteDeviceIdCommand.execute
   end
+
+  def self.eternal_sleep
+    sleep(999999999)
+  end
 end

data/procon_bypass_man.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "pbmenv"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/project_template/app.rb

@@ -5,7 +5,7 @@ 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.13'
+  gem 'procon_bypass_man', '0.1.14'
 end
 
 ProconBypassMan.configure do |config|

data/sig/main.rbs

@@ -182,6 +182,7 @@ class ProconBypassMan::Configuration
   end
 
   attr_reader api_server: untyped
+  attr_reader api_servers: untyped
 
   attr_accessor enable_critical_error_logging: untyped
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: procon_bypass_man
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.14
 platform: ruby
 authors:
 - jiikko
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-23 00:00:00.000000000 Z
-dependencies: []
+date: 2021-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pbmenv
+  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'
 description: An extension for Nintendo Switch Pro Controller
 email:
 - n905i.1214@gmail.com
@@ -39,18 +53,20 @@ files:
 - docs/setup_raspi_by_mitamae.md
 - lib/procon_bypass_man.rb
 - lib/procon_bypass_man/background.rb
-- lib/procon_bypass_man/background/has_server_pool.rb
-- lib/procon_bypass_man/background/http_client.rb
 - lib/procon_bypass_man/background/job_performer.rb
-- lib/procon_bypass_man/background/job_runnable.rb
 - lib/procon_bypass_man/background/job_runner.rb
 - lib/procon_bypass_man/background/jobs/base_job.rb
+- lib/procon_bypass_man/background/jobs/concerns/has_external_api_setting.rb
+- lib/procon_bypass_man/background/jobs/concerns/has_internal_api_setting.rb
+- lib/procon_bypass_man/background/jobs/concerns/job_runnable.rb
+- lib/procon_bypass_man/background/jobs/fetch_and_run_remote_pbm_action_job.rb
 - lib/procon_bypass_man/background/jobs/report_boot_job.rb
 - lib/procon_bypass_man/background/jobs/report_error_job.rb
-- lib/procon_bypass_man/background/jobs/report_heartbeat_job.rb
+- lib/procon_bypass_man/background/jobs/report_event_base_job.rb
 - lib/procon_bypass_man/background/jobs/report_load_config_job.rb
 - lib/procon_bypass_man/background/jobs/report_pressed_buttons_job.rb
 - lib/procon_bypass_man/background/jobs/report_reload_config_job.rb
+- lib/procon_bypass_man/background/jobs/sync_device_stats_job.rb
 - lib/procon_bypass_man/boot_message.rb
 - lib/procon_bypass_man/buttons_setting_configuration.rb
 - lib/procon_bypass_man/buttons_setting_configuration/layer.rb
@@ -62,12 +78,15 @@ files:
 - 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/run_local_shell_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_status.rb
 - lib/procon_bypass_man/io_monitor.rb
 - lib/procon_bypass_man/processor.rb
 - lib/procon_bypass_man/procon.rb
@@ -82,7 +101,14 @@ files:
 - lib/procon_bypass_man/procon/press_button_aware.rb
 - lib/procon_bypass_man/procon/user_operation.rb
 - lib/procon_bypass_man/procon_reader.rb
+- 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/lib/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/stop_pbm_action.rb
 - lib/procon_bypass_man/runner.rb
+- lib/procon_bypass_man/scheduler.rb
 - lib/procon_bypass_man/splatoon2.rb
 - lib/procon_bypass_man/splatoon2/macro/fast_return.rb
 - lib/procon_bypass_man/splatoon2/macro/jump_to_left_key.rb
@@ -92,10 +118,16 @@ files:
 - lib/procon_bypass_man/splatoon2/version.rb
 - lib/procon_bypass_man/support/callbacks.rb
 - lib/procon_bypass_man/support/compress_array.rb
+- lib/procon_bypass_man/support/http_client.rb
 - lib/procon_bypass_man/support/on_memory_cache.rb
+- lib/procon_bypass_man/support/report_http_client.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/server_pool.rb
 - 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/value_objects/remote_pbm_action_object.rb
 - lib/procon_bypass_man/version.rb
 - procon_bypass_man.gemspec
 - project_template/README.md

data/lib/procon_bypass_man/background/http_client.rb

@@ -1,67 +0,0 @@
-module ProconBypassMan
-  module Background
-    class HttpClient
-      class HttpRequest
-        def self.request!(uri: , hostname: , params: , device_id: , session_id: nil, event_type: )
-          @uri = uri
-          @http = Net::HTTP.new(uri.host, uri.port)
-          @http.use_ssl = uri.scheme === "https"
-          @params = {
-            hostname: hostname,
-            event_type: event_type,
-            session_id: session_id,
-            device_id: device_id,
-          }.merge(params)
-          @http.post(
-            @uri.path,
-            @params.to_json,
-            { "Content-Type" => "application/json" },
-          )
-        end
-      end
-
-      def initialize(path: , pool_server: , retry_on_connection_error: false)
-        @path = path
-        @pool_server = pool_server
-        @hostname = `hostname`.chomp
-        @retry_on_connection_error = retry_on_connection_error
-      end
-
-      def post(body: , event_type: )
-        if @pool_server.server.nil?
-          ProconBypassMan.logger.info('送信先が未設定なのでスキップしました')
-          return
-        end
-
-        params = { body: body.to_json }
-        session_id = ProconBypassMan.session_id
-        device_id = ProconBypassMan.device_id
-
-        response = HttpRequest.request!(
-          uri: URI.parse("#{@pool_server.server}#{@path}"),
-          hostname: @hostname,
-          device_id: device_id,
-          session_id: session_id,
-          params: params,
-          event_type: event_type,
-        )
-        case response.code
-        when /^200/
-          return
-        else
-          @pool_server.next!
-          ProconBypassMan.logger.error("200以外(#{response.code})が帰ってきました. #{response.body}")
-        end
-      rescue SocketError => e
-        ProconBypassMan.logger.error("error in outbound module: #{e}")
-        if @retry_on_connection_error
-          sleep(10)
-          retry
-        end
-      rescue => e
-        puts e
-        ProconBypassMan.logger.error("error in outbound module: #{e}")
-      end
-    end
-  end
-end

data/lib/procon_bypass_man/background/jobs/report_heartbeat_job.rb

@@ -1,10 +0,0 @@
-class ProconBypassMan::ReportHeartbeatJob < ProconBypassMan::BaseJob
-  # @param [String] body
-  def self.perform(body)
-    ProconBypassMan::Background::HttpClient.new(
-      path: path,
-      pool_server: pool_server,
-      retry_on_connection_error: false,
-    ).post(body: body, event_type: :heartbeat)
-  end
-end