Skip to content

Commit 0f68841

Browse files
pujaganipujagani
authored
[bidi][js] Add dom mutation handlers (#14238)
Related to #13992.
1 parent 785914e commit 0f68841

File tree

7 files changed

+221
-0
lines changed

7 files changed

+221
-0
lines changed

‎javascript/bidi-support/BUILD.bazel‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
package(default_visibility = [
2+
"//dotnet/src/webdriver:__pkg__",
3+
"//java/src/org/openqa/selenium/bidi:__pkg__",
4+
"//java/src/org/openqa/selenium/remote:__pkg__",
5+
"//javascript/node/selenium-webdriver:__pkg__",
6+
])
7+
8+
exports_files([
9+
"bidi-mutation-listener.js",
10+
])

‎javascript/bidi-support/bidi-mutation-listener.js‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
// Licensed to the Software Freedom Conservancy (SFC) under one
2+
// or more contributor license agreements. See the NOTICE file
3+
// distributed with this work for additional information
4+
// regarding copyright ownership. The SFC licenses this file
5+
// to you under the Apache License, Version 2.0 (the
6+
// "License"); you may not use this file except in compliance
7+
// with the License. You may obtain a copy of the License at
8+
//
9+
// http://www.apache.org/licenses/LICENSE-2.0
10+
//
11+
// Unless required by applicable law or agreed to in writing,
12+
// software distributed under the License is distributed on an
13+
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
// KIND, either express or implied. See the License for the
15+
// specific language governing permissions and limitations
16+
// under the License.
17+
18+
function observeMutations(channel) {
19+
const observer = new MutationObserver((mutations) => {
20+
for (const mutation of mutations) {
21+
switch (mutation.type) {
22+
case 'attributes':
23+
// Don't report our own attribute has changed.
24+
if (mutation.attributeName === 'data-__webdriver_id') {
25+
break
26+
}
27+
const curr = mutation.target.getAttribute(mutation.attributeName)
28+
let id = mutation.target.dataset.__webdriver_id
29+
if (!id) {
30+
id = Math.random().toString(36).substring(2) + Date.now().toString(36)
31+
mutation.target.dataset.__webdriver_id = id
32+
}
33+
const json = JSON.stringify({
34+
target: id,
35+
name: mutation.attributeName,
36+
value: curr,
37+
oldValue: mutation.oldValue,
38+
})
39+
channel(json)
40+
break
41+
default:
42+
break
43+
}
44+
}
45+
})
46+
47+
observer.observe(document, {
48+
attributes: true,
49+
attributeOldValue: true,
50+
characterData: true,
51+
characterDataOldValue: true,
52+
childList: true,
53+
subtree: true,
54+
})
55+
}

‎javascript/node/selenium-webdriver/BUILD.bazel‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ js_library(
3232
"http/*.js",
3333
"io/*.js",
3434
"lib/*.js",
35+
"lib/atoms/bidi-mutation-listener.js",
3536
"net/*.js",
3637
"remote/*.js",
3738
"testing/*.js",
@@ -55,6 +56,7 @@ npm_package(
5556
":manager-macos",
5657
":manager-windows",
5758
":prod-src-files",
59+
"//javascript/node/selenium-webdriver/lib/atoms:bidi-mutation-listener",
5860
"//javascript/node/selenium-webdriver/lib/atoms:find-elements",
5961
"//javascript/node/selenium-webdriver/lib/atoms:get_attribute",
6062
"//javascript/node/selenium-webdriver/lib/atoms:is_displayed",

‎javascript/node/selenium-webdriver/lib/atoms/BUILD.bazel‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,10 @@ copy_file(
4949
out = "mutation-listener.js",
5050
visibility = ["//javascript/node/selenium-webdriver:__pkg__"],
5151
)
52+
53+
copy_file(
54+
name = "bidi-mutation-listener",
55+
src = "//javascript/bidi-support:bidi-mutation-listener.js",
56+
out = "bidi-mutation-listener.js",
57+
visibility = ["//javascript/node/selenium-webdriver:__pkg__"],
58+
)

‎javascript/node/selenium-webdriver/lib/atoms/bidi-mutation-listener.js‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
// Licensed to the Software Freedom Conservancy (SFC) under one
2+
// or more contributor license agreements. See the NOTICE file
3+
// distributed with this work for additional information
4+
// regarding copyright ownership. The SFC licenses this file
5+
// to you under the Apache License, Version 2.0 (the
6+
// "License"); you may not use this file except in compliance
7+
// with the License. You may obtain a copy of the License at
8+
//
9+
// http://www.apache.org/licenses/LICENSE-2.0
10+
//
11+
// Unless required by applicable law or agreed to in writing,
12+
// software distributed under the License is distributed on an
13+
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
// KIND, either express or implied. See the License for the
15+
// specific language governing permissions and limitations
16+
// under the License.
17+
18+
function observeMutations(channel) {
19+
const observer = new MutationObserver((mutations) => {
20+
for (const mutation of mutations) {
21+
switch (mutation.type) {
22+
case 'attributes':
23+
// Don't report our own attribute has changed.
24+
if (mutation.attributeName === 'data-__webdriver_id') {
25+
break
26+
}
27+
const curr = mutation.target.getAttribute(mutation.attributeName)
28+
let id = mutation.target.dataset.__webdriver_id
29+
if (!id) {
30+
id = Math.random().toString(36).substring(2) + Date.now().toString(36)
31+
mutation.target.dataset.__webdriver_id = id
32+
}
33+
const json = JSON.stringify({
34+
target: id,
35+
name: mutation.attributeName,
36+
value: curr,
37+
oldValue: mutation.oldValue,
38+
})
39+
channel(json)
40+
break
41+
default:
42+
break
43+
}
44+
}
45+
})
46+
47+
observer.observe(document, {
48+
attributes: true,
49+
attributeOldValue: true,
50+
characterData: true,
51+
characterDataOldValue: true,
52+
childList: true,
53+
subtree: true,
54+
})
55+
}

‎javascript/node/selenium-webdriver/lib/script.js‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,17 @@
1616
// under the License.
1717

1818
const logInspector = require('../bidi/logInspector')
19+
const scriptManager = require('../bidi//scriptManager')
20+
const { ArgumentValue } = require('../bidi/argumentValue')
21+
const { LocalValue, ChannelValue } = require('../bidi/protocolValue')
22+
const fs = require('node:fs')
23+
const path = require('node:path')
24+
const by = require('./by')
1925

2026
class Script {
2127
#driver
2228
#logInspector
29+
#script
2330

2431
constructor(driver) {
2532
this.#driver = driver
@@ -38,6 +45,13 @@ class Script {
3845
this.#logInspector = await logInspector(this.#driver)
3946
}
4047

48+
async #initScript() {
49+
if (this.#script !== undefined) {
50+
return
51+
}
52+
this.#script = await scriptManager([], this.#driver)
53+
}
54+
4155
async addJavaScriptErrorHandler(callback) {
4256
await this.#init()
4357
return await this.#logInspector.onJavascriptException(callback)
@@ -58,6 +72,46 @@ class Script {
5872

5973
await this.#logInspector.removeCallback(id)
6074
}
75+
76+
async addDomMutationHandler(callback) {
77+
await this.#initScript()
78+
79+
let argumentValues = []
80+
let value = new ArgumentValue(LocalValue.createChannelValue(new ChannelValue('channel_name')))
81+
argumentValues.push(value)
82+
83+
const filePath = path.join(__dirname, 'atoms', 'bidi-mutation-listener.js')
84+
85+
let mutationListener = fs.readFileSync(filePath, 'utf-8').toString()
86+
await this.#script.addPreloadScript(mutationListener, argumentValues)
87+
88+
let id = await this.#script.onMessage(async (message) => {
89+
let payload = JSON.parse(message['data']['value'])
90+
let elements = await this.#driver.findElements({
91+
css: '*[data-__webdriver_id=' + by.escapeCss(payload['target']) + ']',
92+
})
93+
94+
if (elements.length === 0) {
95+
return
96+
}
97+
98+
let event = {
99+
element: elements[0],
100+
attribute_name: payload['name'],
101+
current_value: payload['value'],
102+
old_value: payload['oldValue'],
103+
}
104+
callback(event)
105+
})
106+
107+
return id
108+
}
109+
110+
async removeDomMutationHandler(id) {
111+
await this.#initScript()
112+
113+
await this.#script.removeCallback(id)
114+
}
61115
}
62116

63117
module.exports = Script

‎javascript/node/selenium-webdriver/test/lib/webdriver_script_test.js‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@
2020
const assert = require('node:assert')
2121
const { Browser } = require('selenium-webdriver')
2222
const { Pages, suite } = require('../../lib/test')
23+
const fileServer = require('../../lib/test/fileserver')
24+
const until = require('selenium-webdriver/lib/until')
2325

2426
suite(
2527
function (env) {
@@ -84,6 +86,42 @@ suite(
8486
assert.strictEqual(e.message, 'Callback with id 10 not found')
8587
}
8688
})
89+
90+
it('can listen to dom mutations', async function () {
91+
let message = null
92+
await driver.script().addDomMutationHandler((m) => {
93+
message = m
94+
})
95+
96+
await driver.get(fileServer.Pages.dynamicPage)
97+
98+
let element = driver.findElement({ id: 'reveal' })
99+
await element.click()
100+
let revealed = driver.findElement({ id: 'revealed' })
101+
await driver.wait(until.elementIsVisible(revealed), 5000)
102+
103+
assert.strictEqual(message['attribute_name'], 'style')
104+
assert.strictEqual(message['current_value'], '')
105+
assert.strictEqual(message['old_value'], 'display:none;')
106+
})
107+
108+
it('can remove to dom mutation handler', async function () {
109+
let message = null
110+
let id = await driver.script().addDomMutationHandler((m) => {
111+
message = m
112+
})
113+
114+
await driver.get(fileServer.Pages.dynamicPage)
115+
116+
await driver.script().removeDomMutationHandler(id)
117+
118+
let element = driver.findElement({ id: 'reveal' })
119+
await element.click()
120+
let revealed = driver.findElement({ id: 'revealed' })
121+
await driver.wait(until.elementIsVisible(revealed), 5000)
122+
123+
assert.strictEqual(message, null)
124+
})
87125
})
88126
},
89127
{ browsers: [Browser.FIREFOX, Browser.CHROME, Browser.EDGE] },

0 commit comments

Comments
 (0)