[rb] only create input devices if needed

titusfortner · titusfortner · commit 4915e2b763b3 · 2021-12-01T00:15:26.000-06:00
diff --git a/rb/lib/selenium/webdriver/common/action_builder.rb b/rb/lib/selenium/webdriver/common/action_builder.rb
@@ -61,9 +61,6 @@ def initialize(bridge, deprecated_mouse = nil, deprecated_keyboard = nil, deprec
                                      id: :action_devices
           add_input(deprecated_mouse)
           add_input(deprecated_keyboard)
-        elsif devices.empty?
-          add_pointer_input(:mouse, 'mouse')
-          add_key_input('keyboard')
         else
           devices.each { |device| add_input(device) }
         end
@@ -84,9 +81,7 @@ def initialize(bridge, deprecated_mouse = nil, deprecated_keyboard = nil, deprec
       #
 
       def add_pointer_input(kind, name)
-        new_input = Interactions.pointer(kind, name: name)
-        add_input(new_input)
-        new_input
+        add_input(Interactions.pointer(kind, name: name))
       end
 
       #
@@ -102,9 +97,7 @@ def add_pointer_input(kind, name)
       #
 
       def add_key_input(name)
-        new_input = Interactions.key(name)
-        add_input(new_input)
-        new_input
+        add_input(Interactions.key(name))
       end
 
       #
@@ -115,7 +108,26 @@ def add_key_input(name)
       #
 
       def get_device(name)
-        @devices.find { |device| device.name == name.to_s } || raise(ArgumentError, "Can not find device: #{name}")
+        WebDriver.logger.deprecate('#get_device with name parameter',
+                                   '#device with :name or :type keyword',
+                                   id: :get_device)
+        device(name: name)
+      end
+
+      #
+      # Retrieves the input device for the given name or type
+      #
+      # @param [String] name name of the input device
+      # @param [String] type name of the input device
+      # @return [Selenium::WebDriver::Interactions::InputDevice] input device with given name or type
+      #
+
+      def device(name: nil, type: nil)
+        input = @devices.find { |device| (device.name == name.to_s || name.nil?) && (device.type == type || type.nil?) }
+
+        raise(ArgumentError, "Can not find device: #{name}") if name && input.nil?
+
+        input
       end
 
       #
@@ -232,9 +244,8 @@ def add_input(device)
           pauses(device, max_device.actions.length) if max_device
         end
         @devices << device
+        device
       end
-    end
-
-    # ActionBuilder
+    end # ActionBuilder
   end # WebDriver
 end # Selenium
diff --git a/rb/lib/selenium/webdriver/common/interactions/input_device.rb b/rb/lib/selenium/webdriver/common/interactions/input_device.rb
@@ -30,7 +30,7 @@ module Interactions
       #
 
       class InputDevice
-        attr_reader :name, :actions
+        attr_reader :name, :actions, :type
 
         def initialize(name = nil)
           @name = name || SecureRandom.uuid
@@ -51,13 +51,8 @@ def create_pause(duration = 0)
           add_action(Pause.new(self, duration))
         end
 
-        def no_actions? # Determine if only pauses are present
-          actions = @actions.reject { |action| action.type == :pause }
-          actions.empty?
-        end
-
         def encode
-          {type: type, id: name, actions: @actions.map(&:encode)} unless no_actions?
+          {type: type, id: name, actions: @actions.map(&:encode)} unless @actions.empty?
         end
       end # InputDevice
     end # Interactions
diff --git a/rb/lib/selenium/webdriver/common/interactions/key_actions.rb b/rb/lib/selenium/webdriver/common/interactions/key_actions.rb
@@ -141,10 +141,9 @@ def key_action(*args, action: nil, device: nil)
         self
       end
 
-      def key_input(device = nil)
-        device ? get_device(device) : key_inputs.first
+      def key_input(name = nil)
+        device(name: name, type: Interactions::KEY) || add_key_input('keyboard')
       end
-
     end # KeyActions
   end # WebDriver
 end # Selenium
diff --git a/rb/lib/selenium/webdriver/common/interactions/key_input.rb b/rb/lib/selenium/webdriver/common/interactions/key_input.rb
@@ -29,8 +29,9 @@ module Interactions
       class KeyInput < InputDevice
         SUBTYPES = {down: :keyDown, up: :keyUp, pause: :pause}.freeze
 
-        def type
-          Interactions::KEY
+        def initialize(name = nil)
+          super
+          @type = Interactions::KEY
         end
 
         def create_key_down(key)
diff --git a/rb/lib/selenium/webdriver/common/interactions/none_input.rb b/rb/lib/selenium/webdriver/common/interactions/none_input.rb
@@ -28,8 +28,9 @@ module Interactions
       #
 
       class NoneInput < InputDevice
-        def type
-          Interactions::NONE
+        def initialize(name = nil)
+          super
+          @type = Interactions::NONE
         end
       end # NoneInput
     end # Interactions
diff --git a/rb/lib/selenium/webdriver/common/interactions/pointer_actions.rb b/rb/lib/selenium/webdriver/common/interactions/pointer_actions.rb
@@ -355,8 +355,8 @@ def button_action(button, action: nil, device: nil)
         self
       end
 
-      def pointer_input(device = nil)
-        device ? get_device(device) : pointer_inputs.first
+      def pointer_input(name = nil)
+        device(name: name, type: Interactions::POINTER) || add_pointer_input(:mouse, 'mouse')
       end
     end # PointerActions
   end # WebDriver
diff --git a/rb/lib/selenium/webdriver/common/interactions/pointer_input.rb b/rb/lib/selenium/webdriver/common/interactions/pointer_input.rb
@@ -34,10 +34,7 @@ class PointerInput < InputDevice
         def initialize(kind, name: nil)
           super(name)
           @kind = assert_kind(kind)
-        end
-
-        def type
-          Interactions::POINTER
+          @type = Interactions::POINTER
         end
 
         def encode
diff --git a/rb/spec/unit/selenium/webdriver/common/action_builder_spec.rb b/rb/spec/unit/selenium/webdriver/common/action_builder_spec.rb
@@ -29,10 +29,9 @@ module WebDriver
       let(:async_builder) { ActionBuilder.new(bridge, devices: [mouse, keyboard], async: true) }
 
       describe '#initialize' do
-        it 'creates default mouse and keyboard when none are provided' do
+        it 'does not create input devices when not provided' do
           action_builder = ActionBuilder.new(bridge)
-          expect(action_builder.devices).to include(a_kind_of(Interactions::KeyInput),
-                                                    a_kind_of(Interactions::PointerInput))
+          expect(action_builder.devices).to be_empty
         end
 
         it 'deprecates using mouse and keyboard directly' do
@@ -44,9 +43,7 @@ module WebDriver
 
         it 'deprecates using async parameter' do
           expect {
-            action_builder = ActionBuilder.new(bridge, nil, nil, true)
-            expect(action_builder.devices).to include(a_kind_of(Interactions::PointerInput))
-            expect(action_builder.devices).to include(a_kind_of(Interactions::KeyInput))
+            ActionBuilder.new(bridge, nil, nil, true)
           }.to have_deprecated(:action_async)
         end
 
@@ -90,12 +87,9 @@ module WebDriver
         let(:device) { Interactions.pointer :mouse }
 
         it 'creates pointer and adds to devices' do
-          builder
-          allow(Interactions).to receive(:pointer).and_return(device)
-          builder.add_pointer_input(:touch, 'name')
+          device = builder.add_pointer_input(:touch, 'name')
 
           expect(builder.devices).to include(device)
-          expect(Interactions).to have_received(:pointer).with(:touch, name: 'name')
         end
 
         it 'adds pauses to match other devices when sync' do
@@ -127,13 +121,9 @@ module WebDriver
         let(:device) { Interactions.key }
 
         it 'creates keyboard and adds to devices' do
-          builder
-          allow(Interactions).to receive(:key).and_return(device)
-
-          builder.add_key_input('name')
+          device = builder.add_key_input('name')
 
           expect(builder.devices).to include(device)
-          expect(Interactions).to have_received(:key).with('name')
         end
 
         it 'adds pauses to match other devices' do
@@ -148,10 +138,29 @@ module WebDriver
         end
       end
 
-      describe '#get_device' do
+      describe '#device' do
         it 'gets device by name' do
-          expect(builder.get_device('mouse')).to eq(mouse)
-          expect(builder.get_device('key')).to eq(keyboard)
+          expect(builder.device(name: 'mouse')).to eq(mouse)
+        end
+
+        it 'raises ArgumentError when name not found' do
+          expect { builder.device(name: 'none', type: Interactions::NONE) }.to raise_error(ArgumentError)
+        end
+
+        it 'gets device by type' do
+          expect(builder.device(type: Interactions::POINTER)).to eq(mouse)
+        end
+
+        it 'returns nil when type not found' do
+          expect(builder.device(type: Interactions::NONE)).to be_nil
+        end
+      end
+
+      describe '#get_device' do
+        it 'gets device by name with deprecation' do
+          expect {
+            expect(builder.get_device('mouse')).to eq(mouse)
+          }.to have_deprecated(:get_device)
         end
       end
 
diff --git a/rb/spec/unit/selenium/webdriver/common/interactions/input_device_spec.rb b/rb/spec/unit/selenium/webdriver/common/interactions/input_device_spec.rb
@@ -81,24 +81,6 @@ def type
             expect(device).to have_received(:add_action).with(action)
           end
         end
-
-        describe '#no_actions?' do
-          let(:typing) { instance_double(TypingInteraction, type: :not_pause) }
-
-          it 'returns true when all actions are pauses' do
-            allow(device).to receive(:type).and_return(:none)
-            2.times { device.create_pause }
-            expect(device.no_actions?).to be true
-          end
-
-          it 'returns false when not all actions are pauses' do
-            allow(device).to receive(:type).and_return(:none)
-            allow(typing).to receive(:class).and_return(TypingInteraction)
-            device.create_pause
-            device.add_action(typing)
-            expect(device.no_actions?).to be false
-          end
-        end
       end
     end # Interactions
   end # WebDriver
diff --git a/rb/spec/unit/selenium/webdriver/common/interactions/interaction_spec.rb b/rb/spec/unit/selenium/webdriver/common/interactions/interaction_spec.rb
@@ -23,8 +23,9 @@ module Selenium
   module WebDriver
     module Interactions
       class NewDevice < InputDevice
-        def type
-          :special
+        def initialize(name = nil)
+          super
+          @type = :special
         end
 
         def create_special(val)
@@ -54,22 +55,18 @@ def special_action(special, device: nil)
           self
         end
 
-        def special_inputs
-          @devices.select { |device| device.is_a? NewDevice }
-        end
-
         private
 
-        def special_input(device = nil)
-          device ? get_device(device) : special_inputs.first
+        def special_input(name = nil)
+          device(name: name, type: :newType) || add_input(NewDevice.new('new'))
         end
       end
 
       describe Interaction do
         it 'can create subclass' do
           bridge = instance_double(Remote::Bridge)
           allow(bridge).to receive(:send_actions)
-          sub_action_builder = SubActionBuilder.new(bridge, devices: [NewDevice.new('new')])
+          sub_action_builder = SubActionBuilder.new(bridge)
           sub_action_builder.special_action('special').perform
 
           expect(bridge).to have_received(:send_actions).with([{type: :special,
diff --git a/rb/spec/unit/selenium/webdriver/common/interactions/key_actions_spec.rb b/rb/spec/unit/selenium/webdriver/common/interactions/key_actions_spec.rb
@@ -22,10 +22,9 @@
 module Selenium
   module WebDriver
     describe KeyActions do
-      let(:keyboard) { Interactions::KeyInput.new('keyboard') }
-      let(:mouse) { Interactions::PointerInput.new(:mouse, name: 'pointer') }
+      let(:keyboard) { Interactions::KeyInput.new('key_input') }
       let(:bridge) { instance_double('Bridge').as_null_object }
-      let(:builder) { Selenium::WebDriver::ActionBuilder.new(bridge, devices: [mouse, keyboard]) }
+      let(:builder) { Selenium::WebDriver::ActionBuilder.new(bridge, devices: [keyboard]) }
       let(:element) { Selenium::WebDriver::Element.new(bridge, 'element') }
       let(:key) { 'a' }
       let(:keys) { 'abc' }
@@ -42,6 +41,11 @@ module WebDriver
         it 'gets default key input' do
           expect(builder.send(:key_input)).to eq keyboard
         end
+
+        it 'creates a new default key input if one not defined' do
+          action_builder = Selenium::WebDriver::ActionBuilder.new(bridge)
+          expect(action_builder.send(:key_input).name).to eq 'keyboard'
+        end
       end
 
       describe '#key_down' do
diff --git a/rb/spec/unit/selenium/webdriver/common/interactions/key_input_spec.rb b/rb/spec/unit/selenium/webdriver/common/interactions/key_input_spec.rb
@@ -34,16 +34,10 @@ module Interactions
         end
 
         describe '#encode' do
-          it 'returns nil if no_actions? is true' do
-            allow(key_input).to receive(:no_actions?).and_return(true)
+          it 'returns nil if no actions' do
             expect(key_input.encode).to eq(nil)
           end
 
-          it 'returns Hash with expected parameters if no_actions? is false' do
-            allow(key_input).to receive(:no_actions?).and_return(false)
-            expect(key_input.encode).to eq(type: :key, id: :name, actions: [])
-          end
-
           it 'encodes each action' do
             allow(interaction).to receive(:encode).and_call_original
             2.times { key_input.add_action(interaction) }
diff --git a/rb/spec/unit/selenium/webdriver/common/interactions/none_input_spec.rb b/rb/spec/unit/selenium/webdriver/common/interactions/none_input_spec.rb
@@ -33,16 +33,10 @@ module Interactions
         end
 
         describe '#encode' do
-          it 'returns nil if no_actions? is true' do
-            allow(none).to receive(:no_actions?).and_return(true)
+          it 'returns nil if no actions' do
             expect(none.encode).to eq(nil)
           end
 
-          it 'returns Hash with expected parameters if no_actions? is false' do
-            allow(none).to receive(:no_actions?).and_return(false)
-            expect(none.encode).to eq(type: :none, id: :name, actions: [])
-          end
-
           it 'encodes each action' do
             allow(none).to receive(:no_actions?).and_return(false)
             allow(interaction).to receive(:encode).and_call_original
diff --git a/rb/spec/unit/selenium/webdriver/common/interactions/pointer_actions_spec.rb b/rb/spec/unit/selenium/webdriver/common/interactions/pointer_actions_spec.rb
@@ -22,10 +22,9 @@
 module Selenium
   module WebDriver
     describe PointerActions do
-      let(:keyboard) { Interactions::KeyInput.new('keyboard') }
       let(:mouse) { Interactions::PointerInput.new(:mouse, name: 'pointer') }
       let(:bridge) { instance_double('Bridge').as_null_object }
-      let(:builder) { ActionBuilder.new(bridge, devices: [mouse, keyboard]) }
+      let(:builder) { ActionBuilder.new(bridge, devices: [mouse]) }
       let(:element) { Element.new(bridge, 'element') }
       let(:element2) { Element.new(bridge, 'element2') }
       let(:duration) { builder.default_move_duration }
@@ -40,7 +39,7 @@ module WebDriver
           expect { builder.send(:pointer_input, 'none') }.to raise_error(ArgumentError)
         end
 
-        it 'gets default key input' do
+        it 'gets default pointer input' do
           expect(builder.send(:pointer_input)).to eq mouse
         end
       end
diff --git a/rb/spec/unit/selenium/webdriver/common/interactions/pointer_input_spec.rb b/rb/spec/unit/selenium/webdriver/common/interactions/pointer_input_spec.rb
