1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
# frozen_string_literal: true
# Licensed to the Software Freedom Conservancy (SFC) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The SFC licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
module Selenium
module WebDriver
module DriverExtensions
module HasLogEvents
include Atoms
KINDS = %i[console exception mutation].freeze
#
# Registers listener to be called whenever browser receives
# a new Console API message such as console.log() or an unhandled
# exception.
#
# This currently relies on DevTools so is only supported in
# Chromium browsers.
#
# @example Collect console messages
# logs = []
# driver.on_log_event(:console) do |event|
# logs.push(event)
# end
#
# @example Collect JavaScript exceptions
# exceptions = []
# driver.on_log_event(:exception) do |event|
# exceptions.push(event)
# end
#
# @example Collect DOM mutations
# mutations = []
# driver.on_log_event(:mutation) do |event|
# mutations.push(event)
# end
#
# @param [Symbol] kind :console, :exception or :mutation
# @param [#call] block which is called when event happens
# @yieldparam [DevTools::ConsoleEvent, DevTools::ExceptionEvent, DevTools::MutationEvent]
#
def on_log_event(kind, &block)
if browser == :firefox
WebDriver.logger.deprecate(
'Driver#on_log_event on Firefox',
'the script.add_console_message_handler or the script.add_javascript_error_handler methods',
id: :on_log_event
)
end
raise Error::WebDriverError, "Don't know how to handle #{kind} events" unless KINDS.include?(kind)
enabled = log_listeners[kind].any?
log_listeners[kind] << block
return if enabled
devtools.runtime.enable
__send__(:"log_#{kind}_events")
end
private
def log_listeners
@log_listeners ||= Hash.new { |listeners, kind| listeners[kind] = [] }
end
def log_console_events
devtools.runtime.on(:console_api_called) do |params|
event = DevTools::ConsoleEvent.new(
type: params['type'],
timestamp: params['timestamp'],
args: params['args']
)
log_listeners[:console].each do |listener|
listener.call(event)
end
end
end
def log_exception_events
devtools.runtime.on(:exception_thrown) do |params|
description = if params.dig('exceptionDetails', 'exception')
params.dig('exceptionDetails', 'exception', 'description')
else
params.dig('exceptionDetails', 'text')
end
event = DevTools::ExceptionEvent.new(
description: description,
timestamp: params['timestamp'],
stacktrace: params.dig('exceptionDetails', 'stackTrace', 'callFrames')
)
log_listeners[:exception].each do |listener|
listener.call(event)
end
end
end
def log_mutation_events
devtools.page.enable
devtools.runtime.add_binding(name: '__webdriver_attribute')
execute_script(mutation_listener)
devtools.page.add_script_to_evaluate_on_new_document(source: mutation_listener)
devtools.runtime.on(:binding_called) { |event| log_mutation_event(event) }
end
def log_mutation_event(params)
payload = JSON.parse(params['payload'])
elements = find_elements(css: "*[data-__webdriver_id='#{payload['target']}']")
return if elements.empty?
event = DevTools::MutationEvent.new(
element: elements.first,
attribute_name: payload['name'],
current_value: payload['value'],
old_value: payload['oldValue']
)
log_listeners[:mutation].each do |log_listener|
log_listener.call(event)
end
end
def mutation_listener
@mutation_listener ||= read_atom(:mutationListener)
end
end # HasLogEvents
end # DriverExtensions
end # WebDriver
end # Selenium
|
