webkit_remote 0.3.1 → 0.3.2

data/README.md

@@ -136,6 +136,42 @@ Again, release the WebKit state.
 client.clear_all
 ```
 
+### See Network Traffic
+
+Record network requests and reload the page.
+
+```ruby
+client.page_events = true
+client.network_events = true
+client.clear_cache
+client.clear_cookies
+client.navigate_to 'http://translate.google.com'
+client.wait_for(type: WebkitRemote::Event::PageLoaded).last
+```
+
+See the network traffic generated by the page.
+
+```ruby
+client.network_resources.length
+resource = client.network_resources.first
+resource.canceled
+resource.type
+resource.request.url
+resource.request.headers
+resource.response.mime_type
+resource.response.url
+resource.response.status
+resource.response.headers
+resource.body
+```
+
+Clean up.
+
+```ruby
+client.clear_all
+```
+
+
 ### Close the Browser
 
 ```ruby

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.3.2

data/lib/webkit_remote/client/network_events.rb

@@ -1,3 +1,5 @@
+require 'base64'
+
 module WebkitRemote
 
 class Event
@@ -129,7 +131,8 @@ class NetworkMemoryCacheHit < WebkitRemote::Event
     super
 
     if raw_data['resource']
-      @cache_data = raw_data['resource']
+      @cache_data = WebkitRemote::Client::NetworkCacheEntry.new(
+          raw_data['resource'])
     end
     @document_url = raw_data['documentURL']
     if raw_data['initiator']
@@ -324,6 +327,24 @@ class NetworkResource
     @initiator = nil
     @canceled = false
     @last_event = nil
+    @body = false
+  end
+
+  # @return [String] the contents of the resource
+  def body
+    @body ||= body!
+  end
+
+  # Re-fetches the resource from the Webkit remote debugging server.
+  #
+  # @return [String] the contents of the resource
+  def body!
+    result = @client.rpc.call 'Network.getResponseBody', requestId: @remote_id
+    if result['base64Encoded']
+      @body = Base64.decode64 result['body']
+    else
+      @body = result['body']
+    end
   end
 
   # @private Rely on the event processing code to set this property.

data/lib/webkit_remote/client/runtime.rb

@@ -168,7 +168,7 @@ class RemoteObject
   # @return [Webkit::Client::RemoteObject] self
   def release
     return if @released
-    @rpc.call 'Runtime.releaseObject', objectId: @remote_id
+    @client.rpc.call 'Runtime.releaseObject', objectId: @remote_id
     @group.remove self
     released!
   end
@@ -191,7 +191,7 @@ class RemoteObject
   # @return [Hash<Symbol, Webkit::Client::RemoteProperty>] frozen Hash containg
   #     the object's properties
   def properties!
-    result = @rpc.call 'Runtime.getProperties', objectId: @remote_id
+    result = @client.rpc.call 'Runtime.getProperties', objectId: @remote_id
     @properties = Hash[
       result['result'].map do |raw_property|
         property = WebkitRemote::Client::RemoteProperty.new raw_property, self
@@ -218,7 +218,7 @@ class RemoteObject
         { value: arg }
       end
     end
-    result = @rpc.call 'Runtime.callFunctionOn', objectId: @remote_id,
+    result = @client.rpc.call 'Runtime.callFunctionOn', objectId: @remote_id,
         functionDeclaration: function_expression, arguments: call_args,
         returnByValue: false
     object = WebkitRemote::Client::RemoteObject.for result['result'], @client,
@@ -277,7 +277,6 @@ class RemoteObject
   def initialize(raw_object, group)
     @group = group
     @client = group.client
-    @rpc = client.rpc
     @released = false
 
     @raw_data = raw_object
@@ -329,7 +328,7 @@ class RemoteObjectGroup
         object.release
       end
     else
-      @rpc.call 'Runtime.releaseObjectGroup', objectGroup: name
+      @client.rpc.call 'Runtime.releaseObjectGroup', objectGroup: name
     end
 
     @released = true
@@ -359,7 +358,6 @@ class RemoteObjectGroup
   def initialize(name, client)
     @name = name
     @client = client
-    @rpc = client.rpc
     # TODO(pwnall): turn @objects into a set once equality is working
     @objects = {}
     @released = false

data/lib/webkit_remote/client.rb

@@ -17,6 +17,7 @@ class Client
       raise ArgumentError, 'Target tab not specified'
     end
     @rpc = WebkitRemote::Rpc.new opts
+    @debug_url = @rpc.debug_url
     @browser = tab.browser
     @close_browser = opts.fetch :close_browser, false
     @closed = false
@@ -145,6 +146,14 @@ END_METHOD
   def clear_modules
     # NOTE: this gets called after all the module cleaners complete
   end
+
+  # Debugging output.
+  def inspect
+    result = self.to_s
+    result[-1, 0] =
+        " server=#{@debug_url.inspect} closed=#{@closed.inspect}"
+    result
+  end
 end  # class WebkitRemote::Client
 
 end  # namespace WebkitRemote

data/lib/webkit_remote/rpc.rb

@@ -23,7 +23,8 @@ class Rpc
     @events = []
 
     self.class.em_start
-    @web_socket = Faye::WebSocket::Client.new tab.debug_url
+    @debug_url = tab.debug_url
+    @web_socket = Faye::WebSocket::Client.new @debug_url
     setup_web_socket
   end
 
@@ -91,6 +92,9 @@ class Rpc
   attr_reader :closed
   alias_method :closed?, :closed
 
+  # @return [String] points to this client's Webkit remote debugging server
+  attr_reader :debug_url
+
   # Hooks up the event handlers of the WebSocket client.
   def setup_web_socket
     @web_socket.onopen = lambda do |event|

data/test/fixtures/config.ru

@@ -14,7 +14,7 @@ end
 
 # Cache headers for Network domain testing.
 use Rack::StaticCache, urls: ['/html', '/js', '/png'], root: 'test/fixtures',
-                       versioning: false
+                       versioning: false, duration: 24 * 60 * 60
 app = lambda do |env|
   [
     200,

data/test/fixtures/html/network.html

@@ -2,6 +2,7 @@
 <html>
   <head>
     <title>WebkitRemote Network test</title>
+    <script type="text/javascript" src="../js/network_not_found.js"></script>
     <script type="text/javascript" src="../js/network.js"></script>
   </head>
   <body>

data/test/helper.rb

@@ -22,8 +22,8 @@ require 'thread'
 Thread.abort_on_exception = true
 
 # Launch a dev server and wait until it starts.
-pid = Process.spawn 'bundle exec puma --port 9969 --quiet test/fixtures/config.ru',
-                    :in => '/dev/null', :out => '/dev/null'
+pid = Process.spawn 'bundle exec puma --port 9969 --quiet --threads 1:1 ' +
+    'test/fixtures/config.ru', :in => '/dev/null', :out => '/dev/null'
 Process.detach pid
 at_exit { Process.kill 'TERM', pid }
 loop do

data/test/webkit_remote/client/network_test.rb

@@ -14,7 +14,8 @@ describe WebkitRemote::Client::Network do
     before :all do
       @client.network_events = false
       @client.navigate_to fixture_url(:network)
-      @events = @client.wait_for type: WebkitRemote::Event::ConsoleMessage
+      @events = @client.wait_for type: WebkitRemote::Event::ConsoleMessage,
+                                 level: :log
     end
 
     it 'does not receive any network event' do
@@ -38,7 +39,8 @@ describe WebkitRemote::Client::Network do
       @client.disable_cache = true
       @client.network_events = true
       @client.navigate_to fixture_url(:network)
-      @events = @client.wait_for type: WebkitRemote::Event::ConsoleMessage
+      @events = @client.wait_for type: WebkitRemote::Event::ConsoleMessage,
+                                 level: :log
       @requests = @events.select do |event|
         event.kind_of? WebkitRemote::Event::NetworkRequest
       end
@@ -51,6 +53,9 @@ describe WebkitRemote::Client::Network do
       @chunks = @events.select do |event|
         event.kind_of? WebkitRemote::Event::NetworkData
       end
+      @failures = @events.select do |event|
+        event.kind_of? WebkitRemote::Event::NetworkFailure
+      end
       @resources = @client.network_resources
     end
 
@@ -58,7 +63,7 @@ describe WebkitRemote::Client::Network do
       @requests.wont_be :empty?
     end
 
-    it 'parses initial requests inside NetworkRequest events correctly' do
+    it 'parses initial requests inside NetworkRequest events' do
       @requests[0].request.must_be_kind_of WebkitRemote::Client::NetworkRequest
       @requests[0].request.url.must_equal fixture_url(:network)
       @requests[0].request.method.must_equal :get
@@ -68,18 +73,24 @@ describe WebkitRemote::Client::Network do
       @requests[0].initiator.stack_trace.must_equal nil
     end
 
-    it 'parses derived requests inside NetworkRequest events correctly' do
+    it 'parses derived requests inside NetworkRequest events' do
       @requests[1].document_url.must_equal fixture_url(:network)
       @requests[1].request.must_be_kind_of WebkitRemote::Client::NetworkRequest
-      @requests[1].request.url.must_equal fixture_url(:network, :js)
+      @requests[1].request.url.must_equal fixture_url(:network_not_found, :js)
       @requests[1].initiator.type.must_equal :parser
       @requests[1].initiator.stack_trace.must_equal nil
 
       @requests[2].document_url.must_equal fixture_url(:network)
       @requests[2].request.must_be_kind_of WebkitRemote::Client::NetworkRequest
-      @requests[2].request.url.must_equal fixture_url(:network, :png)
-      @requests[2].initiator.type.must_equal :script
-      @requests[2].initiator.stack_trace.must_equal [
+      @requests[2].request.url.must_equal fixture_url(:network, :js)
+      @requests[2].initiator.type.must_equal :parser
+      @requests[2].initiator.stack_trace.must_equal nil
+
+      @requests[3].document_url.must_equal fixture_url(:network)
+      @requests[3].request.must_be_kind_of WebkitRemote::Client::NetworkRequest
+      @requests[3].request.url.must_equal fixture_url(:network, :png)
+      @requests[3].initiator.type.must_equal :script
+      @requests[3].initiator.stack_trace.must_equal [
         {column: 7, line: 10, function: "", url: fixture_url(:network, :js)},
         {column: 3, line: 11, function: "", url: fixture_url(:network, :js)},
       ]
@@ -89,7 +100,7 @@ describe WebkitRemote::Client::Network do
       @responses.wont_be :empty?
     end
 
-    it 'parses initial NetworkRequest and NetworkResponse events correctly' do
+    it 'parses initial NetworkRequest and NetworkResponse events' do
       @responses[0].type.must_equal :document
       @requests[0].initiator.type.must_equal :other
       @requests[0].loader_id.wont_be :empty?
@@ -99,7 +110,7 @@ describe WebkitRemote::Client::Network do
       @requests[0].timestamp.must_be :<, @responses[0].timestamp
     end
 
-    it 'parses the initial response inside NetworkResponse events correctly' do
+    it 'parses the initial response inside a NetworkResponse event' do
       @responses[0].type.must_equal :document
       @responses[0].response.
                    must_be_kind_of WebkitRemote::Client::NetworkResponse
@@ -116,16 +127,34 @@ describe WebkitRemote::Client::Network do
       @responses[0].response.connection_reused.must_equal false
     end
 
-    it 'parses derived responses inside NetworkResponse events correctly' do
+    it 'parses a 404 response inside a NetworkResponse event' do
+      @responses[1].type.must_equal :script
+      @responses[1].response.
+                   must_be_kind_of WebkitRemote::Client::NetworkResponse
+      @responses[1].response.url.
+                    must_equal fixture_url(:network_not_found, :js)
+      @responses[1].response.status.must_equal 404
+      @responses[1].response.status_text.must_match /not found/i
+      @responses[1].response.headers.must_include 'X-Unit-Test'
+      @responses[1].response.headers['X-Unit-Test'].must_equal 'webkit-remote'
+      @responses[1].response.mime_type.must_equal 'text/plain'
+      @responses[1].response.request_headers.must_include 'User-Agent'
+      @responses[1].response.request_headers['User-Agent']
+                   .must_match(/webkit/i)
+      @responses[1].response.from_cache.must_equal false
+    end
+
+    it 'parses derived responses inside NetworkResponse events' do
       @responses[1].type.must_equal :script
-      @responses[2].type.must_equal :xhr
+      @responses[2].type.must_equal :script
+      @responses[3].type.must_equal :xhr
     end
 
     it 'receives NetworkData events' do
       @chunks.wont_be :empty?
     end
 
-    it 'parses NetworkData events correctly' do
+    it 'parses NetworkData events' do
       @chunks[0].resource.must_equal @chunks[0].resource
       @chunks[0].data_length.
                  must_equal File.read(fixture_path(:network)).length
@@ -136,9 +165,19 @@ describe WebkitRemote::Client::Network do
       @loads.wont_be :empty?
     end
 
-    it 'parses NetworkLoad events correctly' do
+    it 'parses NetworkLoad events' do
       @loads[0].resource.must_equal @requests[0].resource
-      @loads[1].resource.must_equal @requests[1].resource
+      @loads[1].resource.must_equal @requests[2].resource
+    end
+
+    it 'receives NetworkFailure events' do
+      @failures.wont_be :empty?
+    end
+
+    it 'parses NetworkFailure events' do
+      @failures[0].resource.must_equal @requests[1].resource
+      @failures[0].error.wont_equal nil
+      @failures[0].canceled.must_equal true
     end
 
     it 'collects request and response data in NetworkResources' do
@@ -148,12 +187,79 @@ describe WebkitRemote::Client::Network do
       @resources[1].type.must_equal :script
       @resources[1].document_url.must_equal fixture_url(:network)
       @resources[1].initiator.must_equal @requests[1].initiator
-      @resources[1].canceled.must_equal false
-      @resources[1].error.must_equal nil
-      @resources[1].last_event.must_equal @loads[1]
+      @resources[1].canceled.must_equal true
+      @resources[1].error.must_equal @failures[0].error
+      @resources[1].last_event.must_equal @failures[0]
       @resources[1].client.must_equal @client
 
+      @resources[2].must_equal @requests[2].resource
+      @resources[2].request.must_equal @requests[2].request
+      @resources[2].response.must_equal @responses[2].response
+      @resources[2].type.must_equal :script
+      @resources[2].document_url.must_equal fixture_url(:network)
+      @resources[2].initiator.must_equal @requests[2].initiator
+      @resources[2].canceled.must_equal false
+      @resources[2].error.must_equal nil
+      @resources[2].last_event.must_equal @loads[1]
+      @resources[2].client.must_equal @client
+
       @resources[-1].last_event.must_equal @chunks[-1]
     end
+
+    it 'retrieves the body for a text NetworkResource' do
+      @resources[0].body.must_equal File.read(fixture_path(:network))
+    end
+
+    it 'retrieves the body for a binary NetworkResource' do
+      skip 'waiting for http://crbug.com/160397'
+      @resources[2].body.must_equal File.binread(fixture_path(:network, :png))
+    end
+  end
+
+  describe 'and a cached request' do
+    before :all do
+      @client.disable_cache = false
+      @client.navigate_to fixture_url(:network)
+      @client.wait_for type: WebkitRemote::Event::ConsoleMessage, level: :log
+      @client.clear_all
+
+      @client.network_events = true
+      @client.navigate_to fixture_url(:network)
+      @events = @client.wait_for type: WebkitRemote::Event::ConsoleMessage,
+                                 level: :log
+      @requests = @events.select do |event|
+        event.kind_of? WebkitRemote::Event::NetworkRequest
+      end
+      @responses = @events.select do |event|
+        event.kind_of? WebkitRemote::Event::NetworkResponse
+      end
+      @loads = @events.select do |event|
+        event.kind_of? WebkitRemote::Event::NetworkLoad
+      end
+      @chunks = @events.select do |event|
+        event.kind_of? WebkitRemote::Event::NetworkData
+      end
+      @hits = @events.select do |event|
+        event.kind_of? WebkitRemote::Event::NetworkCacheHit
+      end
+      @memory_hits = @events.select do |event|
+        event.kind_of? WebkitRemote::Event::NetworkMemoryCacheHit
+      end
+
+      @resources = @client.network_resources
+    end
+
+    it 'receives NetworkCacheHit events' do
+      @hits.wont_be :empty?
+    end
+
+    it 'parses NetworkCacheHits events' do
+      @hits[0].resource.must_equal @requests[2].resource
+    end
+
+    it 'receives NetworkMemoryCacheHit events' do
+      skip 'waiting for http://crbug.com/160404'
+      @memory_hits.wont_be :empty?
+    end
   end
 end

data/test/webkit_remote/client_test.rb

@@ -32,6 +32,10 @@ describe WebkitRemote::Client do
     it 'closes the browser master debugging session' do
       @browser.closed?.must_equal true
     end
+
+    it 'still retuns a good inspect string' do
+      @client.inspect.must_match(/<.*WebkitRemote::Client.*>/)
+    end
   end
 
   describe 'each_event' do
@@ -102,5 +106,12 @@ describe WebkitRemote::Client do
       @client.clear_all
     end
   end
+
+  describe 'inspect' do
+    it 'includes the debugging URL and closed flag' do
+      @client.inspect.must_match(
+        /<WebkitRemote::Client:.*\s+server=".*"\s+closed=.+>/)
+    end
+  end
 end
 

data/webkit_remote.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "webkit_remote"
-  s.version = "0.3.1"
+  s.version = "0.3.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Victor Costan"]
-  s.date = "2012-11-08"
+  s.date = "2012-11-10"
   s.description = "Launches Google Chrome instances and controls them via the Remote Debugging server"
   s.email = "victor@costan.us"
   s.extra_rdoc_files = [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webkit_remote
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-08 00:00:00.000000000 Z
+date: 2012-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -286,7 +286,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2944886604051237369
+      hash: 3000124756786155400
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: