procon_bypass_man 0.2.1 → 0.3.0

data/lib/procon_bypass_man/support/load_agv.rb

@@ -0,0 +1,20 @@
+module ProconBypassMan
+  class LoadAgv
+    PATH = '/proc/loadavg'
+
+    # @return [[Integer, Integer, Integer]]
+    def get
+      loadavg = get_proc_loadavg
+      loadavg =~ /^([0-9.]+)\s([0-9.]+)\s([0-9.]+)/
+      return [$1.to_f, $2.to_f, $3.to_f].join("-")
+    rescue Errno::ENOENT
+      ""
+    end
+
+    private
+
+    def get_proc_loadavg
+      File.read('/proc/loadavg')
+    end
+  end
+end

data/lib/procon_bypass_man/support/procon_performance_http_client.rb

@@ -0,0 +1,7 @@
+module ProconBypassMan
+  class ProconPerformanceHttpClient < HttpClient
+    def post(body: )
+      super(request_body: { body: body })
+    end
+  end
+end

data/lib/procon_bypass_man/support/renice_command.rb

@@ -0,0 +1,17 @@
+module ProconBypassMan
+  class ReniceCommand
+    def self.change_priority(to: , pid: )
+      cmd =
+        case to
+        when :high
+          "renice -n -20 -p #{pid}"
+        when :low
+          "renice -n 20 -p #{pid}"
+        else
+          raise "unknown priority"
+        end
+      ProconBypassMan.logger.debug { "[SHELL] #{cmd}" }
+      `#{cmd}`
+    end
+  end
+end

data/lib/procon_bypass_man/support/retryable.rb

@@ -0,0 +1,16 @@
+module ProconBypassMan
+  class Retryable
+    def self.retryable(tries: , retried: 0, on_no_retry: [])
+      return yield(retried)
+    rescue *on_no_retry
+      raise
+    rescue
+      if tries <= retried
+        raise
+      else
+        retried = retried + 1
+        retry
+      end
+    end
+  end
+end

data/lib/procon_bypass_man/support/signal_handler.rb

@@ -3,7 +3,7 @@ module ProconBypassMan::SignalHandler
     ProconBypassMan.logger.info "#{$$}で#{sig}を受け取りました"
     case sig
     when 'USR2'
-      raise ProconBypassMan::Runner::InterruptForRestart
+      raise ProconBypassMan::InterruptForRestart
     when 'INT', 'TERM'
       raise Interrupt
     end

data/lib/procon_bypass_man/version.rb

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

data/lib/procon_bypass_man/websocket/client.rb

@@ -99,11 +99,11 @@ module ProconBypassMan
       def self.validate_and_run_remote_macro(data: )
         pbm_job_hash = data.dig("message")
         begin
-          remote_macro_object = ProconBypassMan::RemoteMacroObject.new(name: pbm_job_hash["name"],
+          remote_macro_object = ProconBypassMan::RemoteMacro::RemoteMacroObject.new(name: pbm_job_hash["name"],
                                                                        uuid: pbm_job_hash["uuid"],
                                                                        steps: pbm_job_hash["steps"])
           remote_macro_object.validate!
-        rescue ProconBypassMan::RemoteMacroObject::ValidationError => e
+        rescue ProconBypassMan::RemoteMacro::RemoteMacroObject::ValidationError => e
           ProconBypassMan::SendErrorCommand.execute(error: e)
           return
         end

data/lib/procon_bypass_man/worker.rb

@@ -0,0 +1,32 @@
+module ProconBypassMan
+  class Worker
+    attr_accessor :pid
+
+    def self.run
+      new.run
+    end
+
+    # @param [Boolean]
+    def run
+      return self if @thread
+      @thread = Thread.new do
+        while(item = ProconBypassMan::Background::JobQueue.pop)
+          begin
+            # プロセスを越えるので、文字列でenqueueしてくれる前提. evalしてクラスにする
+            ProconBypassMan::Background::JobPerformer.new(klass: eval(item[:job_class]), args: item[:args]).perform
+          rescue => e
+            ProconBypassMan.logger.error(e)
+            sleep(0.2) # busy loopしないように
+          end
+        end
+      end
+
+      return self
+    end
+
+    # 重要な非同期ジョブは存在しないのでqueueが捌けるのを待たずにkill
+    def shutdown
+      @thread&.kill
+    end
+  end
+end

data/lib/procon_bypass_man.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "logger"
 require 'yaml'
 require "json"
@@ -10,10 +12,9 @@ require "ext/em_pure_ruby"
 require "ext/module"
 require "resolv-replace"
 require "pbmenv"
+require "blue_green_process"
 
 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"
@@ -26,16 +27,21 @@ require_relative "procon_bypass_man/support/yaml_writer"
 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/load_agv"
 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/remote_macro_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/support/procon_performance_http_client"
 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/support/can_over_process"
+require_relative "procon_bypass_man/support/gc"
+require_relative "procon_bypass_man/support/retryable"
+require_relative "procon_bypass_man/support/renice_command"
 require_relative "procon_bypass_man/procon_display"
 require_relative "procon_bypass_man/background"
 require_relative "procon_bypass_man/commands"
@@ -53,10 +59,14 @@ require_relative "procon_bypass_man/procon/analog_stick_manipulator"
 require_relative "procon_bypass_man/remote_pbm_action/value_objects/remote_pbm_action_object"
 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/remote_pbm_action"
+require_relative "procon_bypass_man/remote_macro"
+
 STDOUT.sync = true
 Thread.abort_on_exception = true
 
@@ -67,11 +77,18 @@ module ProconBypassMan
   class CouldNotLoadConfigError < StandardError; end
   class NotFoundProconError < StandardError; end
 
+  class InterruptForRestart < StandardError; end
+
+  class << self
+    attr_accessor :worker
+  end
+
   # @return [void]
   def self.run(setting_path: nil)
     ProconBypassMan::PrintMessageCommand.execute(text: "PBMを起動しています")
     initialize_pbm
 
+    # 設定ファイルの読み込み
     begin
       ProconBypassMan::ButtonsSettingConfiguration::Loader.load(setting_path: setting_path)
     rescue ProconBypassMan::CouldNotLoadConfigError
@@ -84,6 +101,7 @@ module ProconBypassMan
       return
     end
 
+    # デバイスの接続フェーズ
     begin
       gadget, procon = ProconBypassMan::DeviceConnection::Command.execute!
     rescue ProconBypassMan::DeviceConnection::NotFoundProconError
@@ -95,7 +113,7 @@ module ProconBypassMan
       end
       return
     rescue ProconBypassMan::DeviceConnection::TimeoutError
-      ProconBypassMan::SendErrorCommand.execute(error: "接続の見込みがないのでsleepしまくります")
+      ProconBypassMan::SendErrorCommand.execute(error: "接続に失敗しました。プロコンとRaspberry Piのケーブルを差し直して、再実行してください。\n改善しない場合は、app.logの中身を添えて不具合報告をお願いします。")
       ProconBypassMan::DeviceStatus.change_to_connected_but_sleeping!
       %w(TERM INT).each do |sig|
         Kernel.trap(sig) { exit 0 }
@@ -131,33 +149,58 @@ module ProconBypassMan
     ProconBypassMan::Procon::ModeRegistry.reset!
     ProconBypassMan::Procon.reset!
     ProconBypassMan::ButtonsSettingConfiguration.instance.reset!
-    ProconBypassMan::IOMonitor.reset!
   end
 
   # @return [void]
   def self.initialize_pbm
-    ProconBypassMan::Scheduler.start!
-    ProconBypassMan::Background::JobRunner.start!
+    ProconBypassMan::ReniceCommand.change_priority(to: :low, pid: $$)
+    ProconBypassMan::Background::JobQueue.start!
     ProconBypassMan::Websocket::Client.start!
-    ProconBypassMan::QueueOverProcess.start!
+    # TODO ProconBypassMan::DrbObjects.start_all! みたいな感じで書きたい
+    ProconBypassMan::RemoteMacro::QueueOverProcess.start!
+    ProconBypassMan::Procon::PerformanceMeasurement::QueueOverProcess.start!
+    ProconBypassMan::Scheduler.start!
 
     ProconBypassMan::WriteDeviceIdCommand.execute
     ProconBypassMan::WriteSessionIdCommand.execute
-    `renice -n -20 -p #{$$}`
     File.write(pid_path, $$)
     ProconBypassMan::DeviceStatus.change_to_running!
   end
 
+  # @return [void]
   def self.ready_pbm
     ProconBypassMan::PrintBootMessageCommand.execute
     ProconBypassMan::ReportLoadConfigJob.perform_async(ProconBypassMan.config.raw_setting)
+
+    self.worker = ProconBypassMan::Worker.run
+  end
+
+  # @return [void]
+  def self.after_fork_on_bypass_process
+    ProconBypassMan::ReniceCommand.change_priority(to: :high, pid: $$)
+    ::GC.start
+    DRb.start_service if defined?(DRb)
+    # GC対策することによって一時的に削除した機能
+    # ProconBypassMan::ProconDisplay::Server.start!
+
+    DRb.start_service if defined?(DRb)
+    BlueGreenProcess.configure do |config|
+      config.after_fork = -> {
+        DRb.start_service if defined?(DRb)
+        ProconBypassMan::RemoteMacroReceiver.start!
+        BlueGreenProcess.config.logger = ProconBypassMan.logger
+      }
+      config.shared_variables = [:buttons, :current_layer_key]
+    end
   end
 
   # @return [void]
   def self.terminate_pbm
     FileUtils.rm_rf(ProconBypassMan.pid_path)
     FileUtils.rm_rf(ProconBypassMan.digest_path)
-    ProconBypassMan::QueueOverProcess.shutdown
+    ProconBypassMan::RemoteMacro::QueueOverProcess.shutdown
+    ProconBypassMan::Procon::PerformanceMeasurement::QueueOverProcess.shutdown
+    self.worker&.shutdown
   end
 
   # @return [void]

data/procon_bypass_man.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = spec.summary
   spec.homepage      = "https://github.com/splaplapla/procon_bypass_man"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
@@ -28,9 +28,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency "pbmenv", ">= 0.1.9" # Pbmenv.installでのenable_pbm_cloudに依存している
+  spec.add_dependency "pbmenv", ">= 0.1.9" # enable_pbm_cloud連携機能でPbmenv.installを使っている.
   spec.add_dependency "action_cable_client"
   spec.add_dependency "sorted_set"
+  spec.add_dependency "blue_green_process"
+  # spec.add_dependency "blue_green_process"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/project_template/README.md

@@ -1,6 +1,5 @@
 # Project Template
 * これらは https://github.com/splaplapla/pbmenv がinstallするときに配備するファイルです
-* pbm_webはオプショナルです
 
 ## systemdを使ってサービスに登録する方法
 systemctl enableした後は、次回のOS起動時にserviceも自動起動します
@@ -8,13 +7,9 @@ systemctl enableした後は、次回のOS起動時にserviceも自動起動し
 * pbm
   * sudo systemctl link /usr/share/pbm/current/systemd_units/pbm.service
   * sudo systemctl enable pbm.service
-* pbm_web
-  * sudo systemctl link /usr/share/pbm/current/systemd_units/pbm_web.service
-  * sudo systemctl enable pbm_web.service
 
 ## systemdを使ってサービスから解除する方法
 * sudo systemctl disable pbm.service
-* sudo systemctl disable pbm_web.service
 
 ### CheatSheet
 * systemctl daemon-reload

data/project_template/app.rb

@@ -2,20 +2,31 @@
 
 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.1'
+    gem 'procon_bypass_man', '0.3.0'
   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|
@@ -26,8 +37,9 @@ ProconBypassMan.configure do |config|
   # バイパスするログを全部app.logに流すか
   config.verbose_bypass_log = false
 
-  # webからProconBypassManを操作できるwebサービス
-  # config.api_servers = ['https://pbm-cloud.herokuapp.com']
+  # webからProconBypassManを操作できるwebサービスと連携します
+  # 連携中はエラーログ、パフォーマンスに関するメトリクスを送信します
+  # config.api_servers = 'https://pbm-cloud.herokuapp.com'
 
   # エラーが起きたらerror.logに書き込みます
   config.enable_critical_error_logging = true
@@ -35,14 +47,8 @@ ProconBypassMan.configure do |config|
   # 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/app.rb.erb

@@ -0,0 +1,59 @@
+#!/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.3.0'
+  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
+
+  # 接続に成功したらコントローラーのHOME LEDを光らせるか
+  config.enable_home_led_on_connect = true
+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

@@ -174,6 +174,8 @@ class ProconBypassMan::Configuration
 
     def pid_path: () -> String
 
+    def worker_pid_path: () -> String
+
     def digest_path: () -> String
 
     def cache: () -> ProconBypassMan::OnMemoryCache
@@ -186,7 +188,6 @@ 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
 
@@ -213,9 +214,13 @@ class ProconBypassMan::Configuration
 
   def enable_ws?: () -> bool
 
-  def server_pool: () -> untyped
+  def has_api_server?: () -> bool
+
+  def enable_procon_performance_measurement?: () -> bool
 
-  def internal_server_pool: () -> untyped
+  def server: () -> untyped
+
+  def internal_server: () -> untyped
 
   def internal_servers: () -> ::Array[string | nil]
 
@@ -226,8 +231,6 @@ class ProconBypassMan::Configuration
   def verbose_bypass_log: () -> bool
 
   def never_exit_accidentally: () -> bool
-
-  def io_monitor_logging: () -> bool
 end
 
 
@@ -274,35 +277,6 @@ class ProconBypassMan::DeviceConnector
   def init_devices: () -> untyped
 end
 
-module ProconBypassMan
-  class Counter
-    attr_accessor label: untyped
-
-    attr_accessor table: untyped
-
-    attr_accessor previous_table: untyped
-
-    def initialize: (label: untyped label) -> untyped
-
-    # アクティブなバケットは1つだけ
-    def record: (untyped event_name) -> untyped
-
-    def formated_previous_table: () -> ::String
-  end
-
-  module IOMonitor
-    def self.new: (label: untyped label) -> untyped
-
-    # @return [Array<Counter>]
-    def self.targets: () -> untyped
-
-    # ここで集計する
-    def self.start!: () -> untyped
-
-    def self.reset!: () -> untyped
-  end
-end
-
 class ProconBypassMan::Processor
   # @return [String] binary
   def initialize: (untyped binary) -> untyped
@@ -598,11 +572,11 @@ end
 
 module ProconBypassMan
   class HttpClient
-    @server_pool: untyped
+    @server: untyped
     @uri: ::URI
     @retry_on_connection_error: false
 
-    def initialize: (path: String, server_pool: untyped, ?retry_on_connection_error: false) -> void
+    def initialize: (path: String, server: untyped, ?retry_on_connection_error: false) -> void
     def get: -> nil
     def post: (request_body: untyped) -> nil
     def put: (request_body: untyped) -> nil
@@ -645,22 +619,6 @@ module ProconBypassMan
   end
 end
 
-module ProconBypassMan
-  class ServerPool
-    @servers: Array[String]
-    @index: Integer?
-
-    def initialize: (servers: Array[String]) -> void
-    def pick: -> String?
-    def server: -> String?
-    def next!: -> nil
-
-    private
-    def reset: -> Integer
-    def inc_index: -> Integer
-  end
-end
-
 module ProconBypassMan
   class CompressArray
     @array: [String]