procon_bypass_man 0.1.14 → 0.1.17

data/lib/procon_bypass_man.rb

@@ -4,6 +4,9 @@ require "json"
 require "net/http"
 require "fileutils"
 require "securerandom"
+require 'em/pure_ruby'
+require "action_cable_client"
+require "ext/em_pure_ruby"
 
 require_relative "procon_bypass_man/version"
 require_relative "procon_bypass_man/remote_pbm_action"
@@ -21,6 +24,7 @@ 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/domains"
 require_relative "procon_bypass_man/device_connector"
 require_relative "procon_bypass_man/device_status"
 require_relative "procon_bypass_man/runner"
@@ -28,49 +32,50 @@ 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/procon_reader"
-require_relative "procon_bypass_man/procon/analog_stick"
+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/value_objects/remote_pbm_action_object"
+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/splatoon2"
+require_relative "procon_bypass_man/plugins"
+require_relative "procon_bypass_man/websocket/pbm_job_client"
 
 STDOUT.sync = true
 Thread.abort_on_exception = true
 
+# pluginの定数を握りつぶす
+class Module
+  def const_missing(id)
+    if self.name =~ /^ProconBypassMan::Plugin/
+      parent_const = Object.const_get("#{self.name}")
+      parent_const.const_set(id, Module.new)
+      Object.const_get("#{self.name}::#{id}")
+    else
+      super
+    end
+  end
+end
+
 module ProconBypassMan
   extend ProconBypassMan::Configuration::ClassMethods
 
   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)
-    unless setting_path
-      logger.warn "setting_pathが未設定です。設定ファイルのライブリロードが使えません。"
-    end
-
-    if block_given?
-      ProconBypassMan::ButtonsSettingConfiguration.instance.instance_eval(&block)
-    else
-      ProconBypassMan::ButtonsSettingConfiguration::Loader.load(setting_path: setting_path)
-    end
-  end
+  class ConnectionError < StandardError; end
+  class FirstConnectionError < ConnectionError; end
+  class EternalConnectionError < ConnectionError; end
 
   # @return [void]
-  def self.run(setting_path: nil, &block)
+  def self.run(setting_path: nil)
     ProconBypassMan::Scheduler.start!
     ProconBypassMan::Background::JobRunner.start!
+    ProconBypassMan::Websocket::PbmJobClient.start!
 
-    ProconBypassMan.logger.info "PBMを起動しています"
-    puts "PBMを起動しています"
-    buttons_setting_configure(setting_path: setting_path, &block)
+    ProconBypassMan::PrintMessageCommand.execute(text: "PBMを起動しています")
+    ProconBypassMan::ButtonsSettingConfiguration::Loader.load(setting_path: setting_path)
     initialize_pbm
-    File.write(pid_path, $$)
-    ProconBypassMan::WriteSessionIdCommand.execute
     gadget, procon = ProconBypassMan::ConnectDeviceCommand.execute!
-    ProconBypassMan::DeviceStatus.change_to_running!
     Runner.new(gadget: gadget, procon: procon).run
   rescue ProconBypassMan::CouldNotLoadConfigError
     ProconBypassMan::SendErrorCommand.execute(error: "設定ファイルが不正です。設定ファイルの読み込みに失敗しました")
@@ -84,14 +89,18 @@ module ProconBypassMan
     FileUtils.rm_rf(ProconBypassMan.pid_path)
     FileUtils.rm_rf(ProconBypassMan.digest_path)
     exit 1
-  rescue ProconBypassMan::EternalConnectionError
-    ProconBypassMan::SendErrorCommand.execute(error: "接続の見込みがないのでsleepしまくります")
-    ProconBypassMan::DeviceStatus.change_to_connected_but_sleeping!
-    FileUtils.rm_rf(ProconBypassMan.pid_path)
-    eternal_sleep
-  rescue ProconBypassMan::FirstConnectionError
-    ProconBypassMan::SendErrorCommand.execute(error: "接続を確立できませんでした。やりなおします。")
-    retry
+  rescue ProconBypassMan::ConnectionError
+    begin
+      raise
+    rescue ProconBypassMan::EternalConnectionError
+      ProconBypassMan::SendErrorCommand.execute(error: "接続の見込みがないのでsleepしまくります")
+      ProconBypassMan::DeviceStatus.change_to_connected_but_sleeping!
+      FileUtils.rm_rf(ProconBypassMan.pid_path)
+      eternal_sleep
+    rescue ProconBypassMan::FirstConnectionError
+      ProconBypassMan::SendErrorCommand.execute(error: "接続を確立できませんでした。やりなおします。")
+      retry
+    end
   end
 
   def self.configure(&block)
@@ -116,9 +125,17 @@ module ProconBypassMan
 
   def self.initialize_pbm
     ProconBypassMan::WriteDeviceIdCommand.execute
+    ProconBypassMan::WriteSessionIdCommand.execute
+    File.write(pid_path, $$)
+    ProconBypassMan::DeviceStatus.change_to_running!
   end
 
   def self.eternal_sleep
     sleep(999999999)
   end
+
+  # @return [Void]
+  def self.hot_reload!
+    Process.kill(:USR2, pid)
+  end
 end

data/procon_bypass_man.gemspec

@@ -29,6 +29,8 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   spec.add_dependency "pbmenv"
+  spec.add_dependency "action_cable_client"
+  spec.add_dependency "sorted_set"
 
   # 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,11 +1,16 @@
 # Project Template
-これらは https://github.com/splaplapla/pbmenv がinstallするときに配備するファイルです
+* これらは https://github.com/splaplapla/pbmenv がinstallするときに配備するファイルです
+* pbm_webはオプショナルです
 
 ## systemdを使ってサービスに登録する方法
-* sudo ln -s /usr/share/pbm/current/systemd_units/pbm.service /etc/systemd/system/pbm.service
-* sudo ln -s /usr/share/pbm/current/systemd_units/pbm_web.service /etc/systemd/system/pbm_web.service
-* sudo systemctl enable pbm.service
-* sudo systemctl enable pbm_web.service
+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

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.14'
+  gem 'procon_bypass_man', '0.1.17'
 end
 
 ProconBypassMan.configure do |config|

data/project_template/setting.yml

@@ -1,12 +1,12 @@
 version: 1.0
 setting: |-
-  fast_return = ProconBypassMan::Splatoon2::Macro::FastReturn
-  guruguru = ProconBypassMan::Splatoon2::Mode::Guruguru
+  fast_return = ProconBypassMan::Plugin::Splatoon2::Macro::FastReturn
+  guruguru = ProconBypassMan::Plugin::Splatoon2::Mode::Guruguru
 
   install_macro_plugin fast_return
-  install_macro_plugin ProconBypassMan::Splatoon2::Macro::JumpToUpKey
-  install_macro_plugin ProconBypassMan::Splatoon2::Macro::JumpToRightKey
-  install_macro_plugin ProconBypassMan::Splatoon2::Macro::JumpToLeftKey
+  install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::JumpToUpKey
+  install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::JumpToRightKey
+  install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::JumpToLeftKey
   install_mode_plugin guruguru
 
   prefix_keys_for_changing_layer [:zr, :zl, :l]
@@ -18,9 +18,9 @@ setting: |-
     flip :a, if_pressed: [:a]
     flip :down, if_pressed: :down
     macro fast_return.name, if_pressed: [:y, :b, :down]
-    macro ProconBypassMan::Splatoon2::Macro::JumpToUpKey, if_pressed: [:y, :b, :up]
-    macro ProconBypassMan::Splatoon2::Macro::JumpToRightKey, if_pressed: [:y, :b, :right]
-    macro ProconBypassMan::Splatoon2::Macro::JumpToLeftKey, if_pressed: [:y, :b, :left]
+    macro ProconBypassMan::Plugin::Splatoon2::Macro::JumpToUpKey, if_pressed: [:y, :b, :up]
+    macro ProconBypassMan::Plugin::Splatoon2::Macro::JumpToRightKey, if_pressed: [:y, :b, :right]
+    macro ProconBypassMan::Plugin::Splatoon2::Macro::JumpToLeftKey, if_pressed: [:y, :b, :left]
     remap :l, to: :zr
   end
   layer :right, mode: guruguru.name

data/sig/main.rbs

@@ -34,7 +34,13 @@ module ProconBypassMan
 
   def self.root=: (untyped path) -> untyped
 
+  def self.pid: () -> Integer
+
   def self.digest_path: () -> ::String
+
+  def self.session_id: () -> ::String
+
+  def self.device_id: () -> ::String
 end
 
 class ProconBypassMan::Bypass
@@ -166,42 +172,60 @@ end
 
 class ProconBypassMan::Configuration
   module ClassMethods
-    def root: () -> untyped
+    def root: () -> String
 
-    def logger: () -> untyped
+    def logger: () -> Logger
 
     def error_logger: () -> untyped
 
-    def pid_path: () -> untyped
+    def pid_path: () -> String
 
-    def digest_path: () -> untyped
+    def digest_path: () -> String
 
-    def cache: () -> untyped
+    def cache: () -> ProconBypassMan::OnMemoryCache
 
-    def config: () -> untyped
+    def config: () -> ProconBypassMan::Configuration
   end
 
   attr_reader api_server: untyped
   attr_reader api_servers: untyped
 
-  attr_accessor enable_critical_error_logging: untyped
+  attr_accessor enable_critical_error_logging: bool
 
-  def root=: (untyped path) -> untyped
+  def root=: (String path) -> ProconBypassMan::Configuration
 
-  def root: () -> untyped
+  def root: () -> String
 
   def api_server=: (untyped api_server) -> untyped
 
-  def logger=: (untyped logger) -> untyped
+  def logger=: (Logger logger) -> ProconBypassMan::Configuration
 
-  def logger: () -> untyped
+  def logger: () -> Logger
 
-  def error_logger: () -> untyped
+  def error_logger: () -> Logger
 
-  def digest_path: () -> ::String
+  def digest_path: () -> String
 
   # @return [String] pbm-webの接続先
-  def internal_api_servers: () -> untyped
+  def current_server: () -> String
+
+  def current_ws_server: () -> (String | nil)
+
+  def current_ws_server_url: () -> ::String
+
+  def enable_ws?: () -> bool
+
+  def server_pool: () -> untyped
+
+  def internal_server_pool: () -> untyped
+
+  def internal_servers: () -> ::Array[string | nil]
+
+  def internal_api_servers: () -> ::Array[untyped]
+
+  def raw_setting: () -> untyped
+
+  def verbose_bypass_log: () -> bool
 end
 
 
@@ -373,41 +397,41 @@ end
 
 class ProconBypassMan::Procon::MacroRegistry
   class Macro
-    attr_accessor name: untyped
+    attr_accessor name: Symbol
 
     attr_accessor steps: untyped
 
-    def initialize: (name: untyped name, steps: untyped steps) -> untyped
+    def initialize: (name: untyped Symbol, steps: Symbol) -> void
 
-    def next_step: () -> untyped
+    def next_step: () -> Symbol
 
-    def finished?: () -> untyped
+    def finished?: () -> bool
 
-    def ongoing?: () -> untyped
+    def ongoing?: () -> bool
   end
 
-  PRESETS: ::Hash[untyped, untyped]
+  PRESETS: ::Hash[Symbol, Array[Symbol]]
 
   def self.install_plugin: (untyped klass) -> untyped
 
-  def self.load: (untyped name) -> untyped
+  def self.load: (Symbol name) -> untyped
 
-  def self.reset!: () -> untyped
+  def self.reset!: () -> void
 
-  def self.plugins: () -> untyped
+  def self.plugins: () -> ::Hash[Symbol, Array[Symbol]]
 end
 
 class ProconBypassMan::Procon::ModeRegistry
   class Mode
-    attr_accessor name: untyped
+    attr_accessor name: Symbol
 
-    attr_accessor binaries: untyped
+    attr_accessor binaries: Array[String]
 
-    attr_accessor source_binaries: untyped
+    attr_accessor source_binaries: Array[String]
 
-    def initialize: (name: untyped name, binaries: untyped binaries) -> untyped
+    def initialize: (name: Symbol, binaries: Array[String]) -> void
 
-    def next_binary: () -> untyped
+    def next_binary: () -> String
   end
 
   PRESETS: ::Hash[untyped, untyped]
@@ -421,30 +445,20 @@ class ProconBypassMan::Procon::ModeRegistry
   def self.plugins: () -> untyped
 end
 
-module ProconBypassMan::Procon::PressedButtonHelper
-  module Static
-    def pressed_button?: (untyped button) -> untyped
-  end
-end
-
 class ProconBypassMan::Procon
   class UserOperation
     include LayerChangeable
 
-    include PressedButtonHelper::Static
-
     attr_reader binary: untyped
 
     def initialize: (untyped binary) -> untyped
 
-    ZERO_BIT: untyped
-
     ASCII_ENCODING: ::String
 
     # @depilicate
     def binary=: (untyped binary) -> untyped
 
-    def set_no_action!: () -> untyped
+    def set_no_action!: () -> void
 
     def unpress_button: (untyped button) -> untyped
 
@@ -482,7 +496,7 @@ module ProconBypassMan
     end
 
     # 5秒後がタイムアウト
-    def initialize: (?timeout: untyped timeout) -> untyped
+    def initialize: (?timeout: untyped timeout) -> void
 
     def throw_if_timeout!: () -> untyped
   end
@@ -494,7 +508,7 @@ module ProconBypassMan
     def self.from_boot: () -> Integer
 
     # @param [String] uptime_cmd_result
-    def initialize: (uptime_cmd_result: String uptime_cmd_result) -> void
+    def initialize: (uptime_cmd_result: String) -> void
 
     # @return [Integer]
     def from_boot: () -> Integer
@@ -504,3 +518,174 @@ end
 module ProconBypassMan
   VERSION: ::String
 end
+
+module ProconBypassMan
+  module Domains
+    module Binary
+    end
+  end
+end
+
+class ProconBypassMan::Domains::Binary::Base
+  # @param [String] binary
+  def initialize: (binary: untyped binary) -> void
+
+  # @return [String] バイナリ
+  def binary: () -> untyped
+
+  # @return [String]
+  def raw: () -> ::String
+
+  def unpack: () -> Array[::String]
+
+  # @return [ProconBypassMan::ProconReader]
+  def to_procon_reader: () -> untyped
+end
+
+module ProconBypassMan::Domains::HasImmutableBinary
+  def binary: () -> untyped
+end
+
+module ProconBypassMan::Domains::HasMutableBinary
+  def binary: () -> untyped
+end
+
+class ProconBypassMan::Domains::InboundProconBinary < ProconBypassMan::Domains::Binary::Base
+  include ProconBypassMan::Domains::HasImmutableBinary
+
+  # @return [Boolean]
+  def user_operation_data?: () -> bool
+end
+
+# バイナリの書き換えのみをする
+class ProconBypassMan::Domains::ProcessingProconBinary < ProconBypassMan::Domains::Binary::Base
+  include ProconBypassMan::Domains::HasMutableBinary
+
+  ALL_ZERO_BIT: ::String
+
+  def set_no_action!: () -> untyped
+
+  # @param [ProconBypassMan::Domains::ProcessingProconBinary]
+  # @return [ProconBypassMan::Domains::ProcessingProconBinary]
+  # アナログスティックは上書きし、ボタンだけマージする
+  def write_as_merge!: (untyped target_binary) -> ProconBypassMan::Domains::ProcessingProconBinary
+
+  # @param [Symbol] button
+  def write_as_press_button: (Symbol button) -> void
+
+  # @param [Symbol] button
+  def write_as_unpress_button: (Symbol  button) -> void
+
+  # @param [Symbol] button
+  def write_as_press_button_only: (Symbol button) -> void
+
+  # @param [Integer] cap
+  def write_as_apply_left_analog_stick_cap: (cap: Integer cap) -> void
+end
+
+module ProconBypassMan
+  class HttpClient
+    @server_pool: untyped
+    @uri: ::URI
+    @retry_on_connection_error: false
+
+    def initialize: (path: String, server_pool: untyped, ?retry_on_connection_error: false) -> void
+    def get: -> nil
+    def post: (request_body: untyped) -> nil
+    def put: (request_body: untyped) -> nil
+
+    private
+    def process_response: (untyped response) -> untyped
+    def handle_request: { -> bot } -> nil
+
+    class HttpRequest
+      class Get
+        def self.request!: (uri: ::URI) -> untyped
+      end
+
+      class Post
+        def self.request!: (uri: ::URI, ?request_body: Hash[untyped, untyped]) -> untyped
+      end
+
+      class Put
+        def self.request!: (uri: ::URI, ?request_body: {hostname: String}) -> untyped
+      end
+    end
+  end
+end
+
+module ProconBypassMan
+  class SendDeviceStatsHttpClient
+    def post: (status: ::Symbol, pbm_session_id: String) -> untyped
+  end
+end
+
+module ProconBypassMan
+  class ReportHttpClient
+    def post: (body: Hash[untyped, untyped] | String, event_type: ::Symbol) -> untyped
+  end
+end
+
+module ProconBypassMan
+  class UpdateRemotePbmActionStatusHttpClient
+    def post: (to_status: ::Symbol) -> untyped
+  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]
+
+    def initialize: ([String] array) -> void
+    def compress: -> Array[String?]
+
+    class CompressibleValue
+      @prev: String?
+      @current: String
+
+      def initialize: (String? prev, String current) -> void
+      def compress?: -> bool
+      def to_s_with_mark: -> String?
+    end
+  end
+end
+
+module ProconBypassMan
+  module Callbacks
+    def run_callbacks: (untyped kind) -> untyped
+    def get_callbacks: (untyped kind) -> untyped
+    def set_callbacks: (untyped name, untyped callbacks) -> untyped
+
+    class CallbacksChain
+      @block: nil
+
+      attr_accessor filter: untyped
+      attr_accessor chain_method: untyped
+      def initialize: (filter: untyped, chain_method: untyped, block: nil) -> void
+    end
+
+    module M
+    end
+
+    module ClassMethods
+      def define_callbacks: (untyped name) -> untyped
+      def set_callback: (untyped kind, untyped filter, untyped chain_method) -> CallbacksChain
+    end
+  end
+end

data/sig/on_memory_cache.rbs

@@ -0,0 +1,16 @@
+class ProconBypassMan::OnMemoryCache
+  class CacheValue
+    # @param [Time]
+    attr_accessor expired_at: Time
+
+    attr_accessor value: untyped
+
+    def initialize: (expired_at: Time, value: untyped) -> void
+  end
+
+  def initialize: () -> void
+
+  # @param [Integer] expires_in 秒数
+  # @param [String] key
+  def fetch: (key: string, expires_in: Time) { () -> untyped } -> untyped
+end