puppeteer-ruby 0.0.15 → 0.0.20

data/lib/puppeteer/remote_object.rb

@@ -6,6 +6,7 @@ class Puppeteer::RemoteObject
   # @param payload [Hash]
   def initialize(payload)
     @object_id = payload['objectId']
+    @type = payload['type']
     @sub_type = payload['subtype']
     @unserializable_value = payload['unserializableValue']
     @value = payload['value']
@@ -42,6 +43,21 @@ class Puppeteer::RemoteObject
     end
   end
 
+  # @return [String]
+  def type_str
+    # used in JSHandle#to_s
+    # original logic:
+    #   if (this._remoteObject.objectId) {
+    #     const type =  this._remoteObject.subtype || this._remoteObject.type;
+    #     return 'JSHandle@' + type;
+    #   }
+    if @object_id
+      @sub_type || @type
+    else
+      nil
+    end
+  end
+
   # used in JSHandle#properties
   def properties(client)
     # original logic:
@@ -64,7 +80,18 @@ class Puppeteer::RemoteObject
 
   # used in ElementHandle#_box_model
   def box_model(client)
-    client.send_message('DOM.getBoxModel', objectId: @object_id)
+    result = client.send_message('DOM.getBoxModel', objectId: @object_id)
+
+    # Firefox returns width/height = 0, content/padding/border/margin = [nil, nil, nil, nil, nil, nil, nil, nil]
+    # while Chrome throws Error(Could not compute box model)
+    model = result['model']
+    if model['width'] == 0 && model['height'] == 0 &&
+      %w(content padding border margin).all? { |key| model[key].all?(&:nil?) }
+
+      debug_puts('Could not compute box model in Firefox.')
+      return nil
+    end
+    result
   rescue => err
     debug_puts(err)
     nil

data/lib/puppeteer/request.rb

@@ -0,0 +1,330 @@
+class Puppeteer::Request
+  include Puppeteer::DebugPrint
+  include Puppeteer::IfPresent
+
+  # defines some methods used only in NetworkManager, Response
+  class InternalAccessor
+    def initialize(request)
+      @request = request
+    end
+
+    def request_id
+      @request.instance_variable_get(:@request_id)
+    end
+
+    def interception_id
+      @request.instance_variable_get(:@interception_id)
+    end
+
+    # @param response [Puppeteer::Response]
+    def response=(response)
+      @request.instance_variable_set(:@response, response)
+    end
+
+    def redirect_chain
+      @request.instance_variable_get(:@redirect_chain)
+    end
+
+    def failure_text=(failure_text)
+      @request.instance_variable_set(:@failure_text, failure_text)
+    end
+
+    def from_memory_cache=(from_memory_cache)
+      @request.instance_variable_set(:@from_memory_cache, from_memory_cache)
+    end
+
+    def from_memory_cache?
+      @request.instance_variable_get(:@from_memory_cache)
+    end
+  end
+
+  # @param client [Puppeteer::CDPSession]
+  # @param frame [Puppeteer::Frame]
+  # @param interception_id [string|nil]
+  # @param allow_interception [boolean]
+  # @param event [Hash]
+  # @param redirect_chain Array<Request>
+  def initialize(client, frame, interception_id, allow_interception, event, redirect_chain)
+    @client = client
+    @request_id = event['requestId']
+    @is_navigation_request = event['requestId'] == event['loaderId'] && event['type'] == 'Document'
+    @interception_id = interception_id
+    @allow_interception = allow_interception
+    @url = event['request']['url']
+    @resource_type = event['type'].downcase
+    @method = event['request']['method']
+    @post_data = event['request']['postData']
+    @frame = frame
+    @redirect_chain = redirect_chain
+    @headers = {}
+    event['request']['headers'].each do |key, value|
+      @headers[key.downcase] = value
+    end
+    @from_memory_cache = false
+
+    @internal = InternalAccessor.new(self)
+  end
+
+  attr_reader :internal
+  attr_reader :url, :resource_type, :method, :post_data, :headers, :response, :frame
+
+  def navigation_request?
+    @is_navigation_request
+  end
+
+  def redirect_chain
+    @redirect_chain.dup
+  end
+
+  def failure
+    if_present(@failure_text) do |failure_text|
+      { errorText: @failure_text }
+    end
+  end
+
+  private def headers_to_array(headers)
+    return nil unless headers
+
+    headers.map do |key, value|
+      { name: key, value: value.to_s }
+    end
+  end
+
+  class InterceptionNotEnabledError < StandardError
+    def initialize
+      super('Request Interception is not enabled!')
+    end
+  end
+
+  class AlreadyHandledError < StandardError
+    def initialize
+      super('Request is already handled!')
+    end
+  end
+
+  # proceed request on request interception.
+  #
+  # Example:
+  #
+  #   page.on 'request' do |req|
+  #     # Override headers
+  #     headers = req.headers.merge(
+  #       foo: 'bar', # set "foo" header
+  #       origin: nil, # remove "origin" header
+  #     )
+  #     req.continue(headers: headers)
+  #   end
+  #
+  # @param error_code [String|Symbol]
+  def continue(url: nil, method: nil, post_data: nil, headers: nil)
+    # Request interception is not supported for data: urls.
+    return if @url.start_with?('data:')
+
+    unless @allow_interception
+      raise InterceptionNotEnabledError.new
+    end
+    if @interception_handled
+      raise AlreadyHandledError.new
+    end
+    @interception_handled = true
+
+    overrides = {
+      url: url,
+      method: method,
+      post_data: post_data,
+      headers: headers_to_array(headers),
+    }.compact
+    begin
+      @client.send_message('Fetch.continueRequest',
+        requestId: @interception_id,
+        **overrides,
+      )
+    rescue => err
+      # In certain cases, protocol will return error if the request was already canceled
+      # or the page was closed. We should tolerate these errors.
+      debug_puts(err)
+    end
+  end
+
+  # Mocking response.
+  #
+  # Example:
+  #
+  #   page.on 'request' do |req|
+  #     req.respond(
+  #       status: 404,
+  #       content_type: 'text/plain',
+  #       body: 'Not Found!'
+  #     )
+  #   end
+  #
+  # @param status [Integer]
+  # @param headers [Hash<String, String>]
+  # @param content_type [String]
+  # @param body [String]
+  def respond(status: nil, headers: nil, content_type: nil, body: nil)
+    # Mocking responses for dataURL requests is not currently supported.
+    return if @url.start_with?('data:')
+
+    unless @allow_interception
+      raise InterceptionNotEnabledError.new
+    end
+    if @interception_handled
+      raise AlreadyHandledError.new
+    end
+    @interception_handled = true
+
+    mock_response_headers = {}
+    headers&.each do |key, value|
+      mock_response_headers[key.downcase] = value
+    end
+    if content_type
+      mock_response_headers['content-type'] = content_type
+    end
+    if body
+      mock_response_headers['content-length'] = body.length
+    end
+
+    mock_response = {
+      responseCode: status || 200,
+      responsePhrase: STATUS_TEXTS[(status || 200).to_s],
+      responseHeaders: headers_to_array(mock_response_headers),
+      body: if_present(body) { |mock_body| Base64.strict_encode64(mock_body) },
+    }.compact
+    begin
+      @client.send_message('Fetch.fulfillRequest',
+        requestId: @interception_id,
+        **mock_response,
+      )
+    rescue => err
+      # In certain cases, protocol will return error if the request was already canceled
+      # or the page was closed. We should tolerate these errors.
+      debug_puts(err)
+    end
+  end
+
+  # abort request on request interception.
+  #
+  # Example:
+  #
+  #   page.on 'request' do |req|
+  #     if req.url.include?("porn")
+  #       req.abort
+  #     else
+  #       req.continue
+  #     end
+  #   end
+  #
+  # @param error_code [String|Symbol]
+  def abort(error_code: :failed)
+    # Request interception is not supported for data: urls.
+    return if @url.start_with?('data:')
+
+    error_reason = ERROR_REASONS[error_code.to_s]
+    unless error_reason
+      raise ArgumentError.new("Unknown error code: #{error_code}")
+    end
+    unless @allow_interception
+      raise InterceptionNotEnabledError.new
+    end
+    if @interception_handled
+      raise AlreadyHandledError.new
+    end
+    @interception_handled = true
+
+    begin
+      @client.send_message('Fetch.failRequest',
+        requestId: @interception_id,
+        errorReason: error_reason,
+      )
+    rescue => err
+      # In certain cases, protocol will return error if the request was already canceled
+      # or the page was closed. We should tolerate these errors.
+      debug_puts(err)
+    end
+  end
+
+  ERROR_REASONS = {
+    'aborted' => 'Aborted',
+    'accessdenied' => 'AccessDenied',
+    'addressunreachable' => 'AddressUnreachable',
+    'blockedbyclient' => 'BlockedByClient',
+    'blockedbyresponse' => 'BlockedByResponse',
+    'connectionaborted' => 'ConnectionAborted',
+    'connectionclosed' => 'ConnectionClosed',
+    'connectionfailed' => 'ConnectionFailed',
+    'connectionrefused' => 'ConnectionRefused',
+    'connectionreset' => 'ConnectionReset',
+    'internetdisconnected' => 'InternetDisconnected',
+    'namenotresolved' => 'NameNotResolved',
+    'timedout' => 'TimedOut',
+    'failed' => 'Failed',
+  }.freeze
+
+  # List taken from https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml with extra 306 and 418 codes.
+  STATUS_TEXTS = {
+    '100' => 'Continue',
+    '101' => 'Switching Protocols',
+    '102' => 'Processing',
+    '103' => 'Early Hints',
+    '200' => 'OK',
+    '201' => 'Created',
+    '202' => 'Accepted',
+    '203' => 'Non-Authoritative Information',
+    '204' => 'No Content',
+    '205' => 'Reset Content',
+    '206' => 'Partial Content',
+    '207' => 'Multi-Status',
+    '208' => 'Already Reported',
+    '226' => 'IM Used',
+    '300' => 'Multiple Choices',
+    '301' => 'Moved Permanently',
+    '302' => 'Found',
+    '303' => 'See Other',
+    '304' => 'Not Modified',
+    '305' => 'Use Proxy',
+    '306' => 'Switch Proxy',
+    '307' => 'Temporary Redirect',
+    '308' => 'Permanent Redirect',
+    '400' => 'Bad Request',
+    '401' => 'Unauthorized',
+    '402' => 'Payment Required',
+    '403' => 'Forbidden',
+    '404' => 'Not Found',
+    '405' => 'Method Not Allowed',
+    '406' => 'Not Acceptable',
+    '407' => 'Proxy Authentication Required',
+    '408' => 'Request Timeout',
+    '409' => 'Conflict',
+    '410' => 'Gone',
+    '411' => 'Length Required',
+    '412' => 'Precondition Failed',
+    '413' => 'Payload Too Large',
+    '414' => 'URI Too Long',
+    '415' => 'Unsupported Media Type',
+    '416' => 'Range Not Satisfiable',
+    '417' => 'Expectation Failed',
+    '418' => 'I\'m a teapot',
+    '421' => 'Misdirected Request',
+    '422' => 'Unprocessable Entity',
+    '423' => 'Locked',
+    '424' => 'Failed Dependency',
+    '425' => 'Too Early',
+    '426' => 'Upgrade Required',
+    '428' => 'Precondition Required',
+    '429' => 'Too Many Requests',
+    '431' => 'Request Header Fields Too Large',
+    '451' => 'Unavailable For Legal Reasons',
+    '500' => 'Internal Server Error',
+    '501' => 'Not Implemented',
+    '502' => 'Bad Gateway',
+    '503' => 'Service Unavailable',
+    '504' => 'Gateway Timeout',
+    '505' => 'HTTP Version Not Supported',
+    '506' => 'Variant Also Negotiates',
+    '507' => 'Insufficient Storage',
+    '508' => 'Loop Detected',
+    '510' => 'Not Extended',
+    '511' => 'Network Authentication Required',
+  }.freeze
+end

data/lib/puppeteer/response.rb

@@ -0,0 +1,113 @@
+require 'json'
+
+class Puppeteer::Response
+  include Puppeteer::IfPresent
+
+  class Redirected < StandardError
+    def initialize
+      super('Response body is unavailable for redirect responses')
+    end
+  end
+
+  # defines methods used only in NetworkManager
+  class InternalAccessor
+    def initialize(response)
+      @response = response
+    end
+
+    def body_loaded_promise
+      @response.instance_variable_get(:@body_loaded_promise)
+    end
+  end
+
+  class RemoteAddress
+    def initialize(ip:, port:)
+      @ip = ip
+      @port = port
+    end
+    attr_reader :ip, :port
+  end
+
+  # @param client [Puppeteer::CDPSession]
+  # @param request [Puppeteer::Request]
+  # @param response_payload [Hash]
+  def initialize(client, request, response_payload)
+    @client = client
+    @request = request
+
+    @body_loaded_promise = resolvable_future
+    @remote_address = RemoteAddress.new(
+      ip: response_payload['remoteIPAddress'],
+      port: response_payload['remotePort'],
+    )
+
+    @status = response_payload['status']
+    @status_text = response_payload['statusText']
+    @url = request.url
+    @from_disk_cache = !!response_payload['fromDiskCache']
+    @from_service_worker = !!response_payload['fromServiceWorker']
+
+    @headers = {}
+    response_payload['headers'].each do |key, value|
+      @headers[key.downcase] = value
+    end
+    @security_details = if_present(response_payload['securityDetails']) do |security_payload|
+      SecurityDetails.new(security_payload)
+    end
+
+    @internal = InternalAccessor.new(self)
+  end
+
+  attr_reader :internal
+
+  attr_reader :remote_address, :url, :status, :status_text, :headers, :security_details, :request
+
+  # @return [Boolean]
+  def ok?
+    @status == 0 || (@status >= 200 && @status <= 299)
+  end
+
+  def buffer
+    await @body_loaded_promise
+    response = @client.send_message('Network.getResponseBody', requestId: @request.internal.request_id)
+    if response['base64Encoded']
+      Base64.decode64(response['body'])
+    else
+      response['body']
+    end
+  end
+
+  # @param text [String]
+  def text
+    buffer
+  end
+
+  # @param json [Hash]
+  def json
+    JSON.parse(text)
+  end
+
+  def from_cache?
+    @from_disk_cache || @request.internal.from_memory_cache?
+  end
+
+  def from_service_worker?
+    @from_service_worker
+  end
+
+  def frame
+    @request.frame
+  end
+
+  class SecurityDetails
+    def initialize(security_payload)
+      @subject_name = security_payload['subjectName']
+      @issuer = security_payload['issuer']
+      @valid_from = security_payload['validFrom']
+      @valid_to = security_payload['validTo']
+      @protocol = security_payload['protocol']
+    end
+
+    attr_reader :subject_name, :issuer, :valid_from, :valid_to, :protocol
+  end
+end