[bidi][js] Add high-level script pinning APIs (#14250)

SeleniumHQ · Jul 11, 2024 · 7334bfc · 7334bfc
1 parent 0f68841
commit 7334bfc
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 0 deletions.
diff --git a/javascript/node/selenium-webdriver/lib/script.js b/javascript/node/selenium-webdriver/lib/script.js
@@ -112,6 +112,16 @@ class Script {
 
     await this.#script.removeCallback(id)
   }
+
+  async pin(script) {
+    await this.#initScript()
+    return await this.#script.addPreloadScript(script)
+  }
+
+  async unpin(id) {
+    await this.#initScript()
+    await this.#script.removePreloadScript(id)
+  }
 }
 
 module.exports = Script
diff --git a/javascript/node/selenium-webdriver/test/lib/webdriver_script_test.js b/javascript/node/selenium-webdriver/test/lib/webdriver_script_test.js
@@ -122,6 +122,38 @@ suite(
 
         assert.strictEqual(message, null)
       })
+
+      it('can pin script', async function () {
+        await driver.script().pin("() => { console.log('Hello!'); }")
+        let log
+
+        await driver.script().addConsoleMessageHandler((logEntry) => {
+          log = logEntry
+        })
+
+        await driver.get(Pages.logEntryAdded)
+
+        await delay(3000)
+
+        assert.equal(log.text, 'Hello!')
+      })
+
+      it('can unpin script', async function () {
+        const id = await driver.script().pin("() => { console.log('Hello!'); }")
+
+        let count = 0
+        await driver.script().addConsoleMessageHandler((logEntry) => {
+          count++
+        })
+
+        await driver.get(Pages.logEntryAdded)
+
+        await driver.script().unpin(id)
+
+        await driver.get(Pages.logEntryAdded)
+
+        assert.equal(count, 1)
+      })
     })
   },
   { browsers: [Browser.FIREFOX, Browser.CHROME, Browser.EDGE] },