Allow subscriptions to be removed (#455)

Author: rzane

lib/ferrum/client.rb

@@ -28,6 +28,10 @@ def on(event, &block)
       @client.on(event_name(event), &block)
     end
 
+    def off(event, id)
+      @client.off(event_name(event), id)
+    end
+
     def subscribed?(event)
       @client.subscribed?(event_name(event))
     end
@@ -101,6 +105,10 @@ def on(event, &block)
       @subscriber.on(event, &block)
     end
 
+    def off(event, id)
+      @subscriber.off(event, id)
+    end
+
     def subscribed?(event)
       @subscriber.subscribed?(event)
     end

lib/ferrum/client/subscriber.rb

@@ -24,6 +24,11 @@ def <<(message)
       def on(event, &block)
         @on[event] ||= Concurrent::Array.new
         @on[event] << block
+        @on[event].index(block)
+      end
+
+      def off(event, id)
+        @on[event].delete_at(id)
         true
       end
 

lib/ferrum/page.rb

@@ -393,6 +393,19 @@ def on(name, &block)
       end
     end
 
+    def off(name, id)
+      case name
+      when :dialog
+        client.off("Page.javascriptDialogOpening", id)
+      when :request
+        client.off("Fetch.requestPaused", id)
+      when :auth
+        client.off("Fetch.authRequired", id)
+      else
+        client.off(name, id)
+      end
+    end
+
     def subscribed?(event)
       client.subscribed?(event)
     end

spec/page_spec.rb

@@ -196,4 +196,42 @@
       expect(page.device_pixel_ratio).to eq(2)
     end
   end
+
+  describe "#on" do
+    it "subscribes to an event" do
+      message = nil
+
+      page.on("Runtime.consoleAPICalled") do |params|
+        message = params.dig("args", 0, "value")
+      end
+
+      page.evaluate("console.log('hello')")
+      expect(message).to eq("hello")
+    end
+  end
+
+  describe "#off" do
+    it "unsubscribes a specific event handler" do
+      message_a = nil
+      message_b = nil
+
+      a = page.on("Runtime.consoleAPICalled") do |params|
+        message_a = params.dig("args", 0, "value")
+      end
+
+      page.on("Runtime.consoleAPICalled") do |params|
+        message_b = params.dig("args", 0, "value")
+      end
+
+      page.evaluate("console.log('hello')")
+      expect(message_a).to eq("hello")
+      expect(message_b).to eq("hello")
+
+      page.off("Runtime.consoleAPICalled", a)
+      page.evaluate("console.log('goodbye')")
+
+      expect(message_a).to eq("hello")
+      expect(message_b).to eq("goodbye")
+    end
+  end
 end