diff --git a/appium_lib.gemspec b/appium_lib.gemspec index e074e8cd..8e8cbd40 100644 --- a/appium_lib.gemspec +++ b/appium_lib.gemspec @@ -13,6 +13,7 @@ Gem::Specification.new do |s| s.homepage = 'https://github.com/appium/ruby_lib' # published as appium_lib s.require_paths = ['lib'] + # TODO: We must remove start_logs_broadcast/stop_logs_broadcast to bump the appium_lib_core version to v12+. s.add_dependency 'appium_lib_core', '>= 9.2.1', '< 12.0' s.add_dependency 'nokogiri', '~> 1.8', '>= 1.8.1' s.add_dependency 'tomlrb', '>= 1.1', '< 3.0' diff --git a/lib/appium_lib/android/common/command/command.rb b/lib/appium_lib/android/common/command/command.rb index 424480fb..5a7846ea 100644 --- a/lib/appium_lib/android/common/command/command.rb +++ b/lib/appium_lib/android/common/command/command.rb @@ -31,6 +31,8 @@ def shell(command, arguments) @driver.execute_script 'mobile: shell', args end + # @deprecated Please use BiDi implementation via `$driver.driver.bidi` directly instead. + # # Starts Android logcat broadcast websocket # # @param [String] logcat_file A file path to write messages from a logcat WebSocket client @@ -46,6 +48,8 @@ def start_logs_broadcast(logcat_file = 'logcat.log') @logcat_client = ::Appium::Common::Command::WsLogcat.new(url: socket_url, output_file: logcat_file) end + # @deprecated Please use BiDi implementation directly instead. + # # Stop Android logcat broadcast websocket # # @example diff --git a/lib/appium_lib/common/command/ws_logcat.rb b/lib/appium_lib/common/command/ws_logcat.rb index 87f02707..0832f916 100644 --- a/lib/appium_lib/common/command/ws_logcat.rb +++ b/lib/appium_lib/common/command/ws_logcat.rb @@ -15,6 +15,7 @@ module Appium module Common module Command + # TODO: Remove this implementation after dropping start_logs_broadcast class WsLogcat < ::Appium::Core::WebSocket def initialize(url:, output_file: 'logcat.log') super(url: url) diff --git a/lib/appium_lib/ios/xcuitest/command.rb b/lib/appium_lib/ios/xcuitest/command.rb index 9cb0bdca..18601b50 100644 --- a/lib/appium_lib/ios/xcuitest/command.rb +++ b/lib/appium_lib/ios/xcuitest/command.rb @@ -22,6 +22,8 @@ module Appium module Ios module Xcuitest module Command + # @deprecated Please use BiDi implementation via `$driver.driver.bidi` directly instead. + # # Starts iOS syslog broadcast websocket # # @param [String] syslog_file A file path to write messages from a syslog WebSocket client @@ -37,6 +39,8 @@ def start_logs_broadcast(syslog_file = 'syslog.log') @logcat_client = ::Appium::Common::Command::WsLogcat.new(url: socket_url, output_file: syslog_file) end + # @deprecated Please use BiDi implementation directly instead. + # # Stop iOS syslog broadcast websocket # # @example