procon_bypass_man 0.1.23 → 0.2.2

data/project_template/app.rb

@@ -2,24 +2,36 @@
 
 require 'bundler/inline'
 
+retry_count_on_git_command_error = 0
 begin
+  if retry_count_on_git_command_error > 10
+    STDOUT.puts "Stopped the procon_bypass_man program because could not download any source codes."
+    exit 1
+  end
+
   gemfile do
     source 'https://rubygems.org'
     git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-    gem 'procon_bypass_man', '0.1.23'
+    gem 'procon_bypass_man', '0.2.2'
   end
 rescue Bundler::Source::Git::GitCommandError => e
+  retry_count_on_git_command_error = retry_count_on_git_command_error + 1
+  sleep(5) # サービスの起動順によっては、まだoffline状態なので待機する
+
   # 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
+  if /try removing the cache directory '([^']+)'/ =~ e.message && $1&.start_with?('/home/pi/.rbenv')
+    require 'fileutils'
     FileUtils.rm_rf($1)
-    retry
+    STDOUT.puts "Deleted #{$1}"
   end
+
+  retry
 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に流すか
@@ -34,8 +46,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/project_template/app.rb.erb

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+
+require 'bundler/inline'
+
+retry_count_on_git_command_error = 0
+begin
+  if retry_count_on_git_command_error > 10
+    STDOUT.puts "Stopped the procon_bypass_man program because could not download any source codes."
+    exit 1
+  end
+
+  gemfile do
+    source 'https://rubygems.org'
+    git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+    gem 'procon_bypass_man', '0.2.2'
+  end
+rescue Bundler::Source::Git::GitCommandError => e
+  retry_count_on_git_command_error = retry_count_on_git_command_error + 1
+  sleep(5) # サービスの起動順によっては、まだoffline状態なので待機する
+
+  # 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 && $1&.start_with?('/home/pi/.rbenv')
+    require 'fileutils'
+    FileUtils.rm_rf($1)
+    STDOUT.puts "Deleted #{$1}"
+  end
+
+  retry
+end
+
+ProconBypassMan.configure do |config|
+  config.root = File.expand_path(__dir__)
+  config.logger = Logger.new("#{ProconBypassMan.root}/app.log", 1, 1024 * 1024 * 1)
+  config.logger.level = :debug
+
+  # バイパスするログを全部app.logに流すか
+  config.verbose_bypass_log = false
+
+  # webからProconBypassManを操作できるwebサービス
+  <%- api_server_config = "config.api_servers = ['https://pbm-cloud.herokuapp.com']" -%>
+  <%- if enable_integration_with_pbm_cloud -%>
+  <%= api_server_config %>
+  <%- else -%>
+  <%= "# #{api_server_config}" %>
+  <%- end -%>
+
+  # エラーが起きたらerror.logに書き込みます
+  config.enable_critical_error_logging = true
+
+  # pbm-cloudで使う場合はnever_exitにtrueをセットしてください. trueがセットされている場合、不慮の事故が発生してもプロセスが終了しなくなります
+  config.never_exit_accidentally = true
+
+  # 毎秒行った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/project_template/lib/app_generator.rb

@@ -0,0 +1,31 @@
+require "erb"
+
+# NOTE pbmenvで参照しているクラス
+# 後方互換を維持するために、パラメータの削除・必須をしてはいけない
+class AppGenerator
+  attr_reader :prefix_path
+
+  # @param [String] prefix_path
+  # @param [Boolean] enable_integration_with_pbm_cloud
+  def initialize(prefix_path: , enable_integration_with_pbm_cloud: )
+    @prefix_path = prefix_path
+    @enable_integration_with_pbm_cloud = enable_integration_with_pbm_cloud
+  end
+
+  def generate
+    erb = File.read(template_path)
+    enable_integration_with_pbm_cloud = @enable_integration_with_pbm_cloud
+    app_rb = ERB.new(erb, nil, '-').result(binding)
+    File.write(output_path, app_rb)
+  end
+
+  private
+
+  def template_path
+    File.join(prefix_path, "app.rb.erb")
+  end
+
+  def output_path
+    File.join(prefix_path, "app.rb")
+  end
+end

data/project_template/web.rb

@@ -10,7 +10,7 @@ end
 
 ProconBypassMan::Web.configure do |config|
   config.root = File.expand_path(__dir__)
-  config.logger = Logger.new("#{ProconBypassMan::Web.root}/web.log", 1, 1024 * 1024 * 10)
+  config.logger = Logger.new("#{ProconBypassMan::Web.root}/web.log", 1, 1024 * 1024 * 1)
 end
 
 ProconBypassMan::Web::Server.start

data/sig/main.rbs

@@ -11,9 +11,6 @@ module ProconBypassMan
   class CouldNotLoadConfigError < 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
@@ -189,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
 
@@ -228,6 +226,8 @@ class ProconBypassMan::Configuration
   def verbose_bypass_log: () -> bool
 
   def never_exit_accidentally: () -> bool
+
+  def io_monitor_logging: () -> bool
 end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: procon_bypass_man
 version: !ruby/object:Gem::Version
-  version: 0.1.23
+  version: 0.2.2
 platform: ruby
 authors:
 - jiikko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-04 00:00:00.000000000 Z
+date: 2022-07-10 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"
@@ -75,6 +76,7 @@ files:
 - Steepfile
 - bin/console
 - bin/dev_api_server.rb
+- bin/generate_default_app
 - bin/setup
 - docs/getting_started.md
 - docs/how_to_connect_procon.md
@@ -96,7 +98,7 @@ files:
 - 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/concerns/job_performable.rb
 - lib/procon_bypass_man/background/jobs/post_completed_remote_macro_job.rb
 - lib/procon_bypass_man/background/jobs/report_boot_job.rb
 - lib/procon_bypass_man/background/jobs/report_completed_upgrade_pbm_job.rb
@@ -122,19 +124,27 @@ 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_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/io_monitor.rb
 - lib/procon_bypass_man/plugin/splatoon2/macro/charge_tansan_bomb.rb
@@ -175,6 +185,13 @@ files:
 - 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/bypass_hook.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
@@ -185,6 +202,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
@@ -210,6 +228,7 @@ files:
 - 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/version.rb
 - lib/procon_bypass_man/websocket/client.rb
@@ -218,6 +237,8 @@ files:
 - procon_bypass_man.gemspec
 - project_template/README.md
 - project_template/app.rb
+- project_template/app.rb.erb
+- project_template/lib/app_generator.rb
 - project_template/setting.yml
 - project_template/systemd_units/pbm.service
 - project_template/systemd_units/pbm_web.service
@@ -225,6 +246,7 @@ files:
 - sig/README.md
 - sig/main.rbs
 - sig/on_memory_cache.rbs
+- tmp/.keep
 homepage: https://github.com/splaplapla/procon_bypass_man
 licenses:
 - MIT
@@ -240,7 +262,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

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