Merge remote-tracking branch 'origin/trunk' into remote-image

Author: VietND96

.github/workflows/pre-release.yml

@@ -97,17 +97,19 @@ jobs:
             **Warning: Manually update the changelogs before merging**
 
             This PR:
-              * Updates Rust version for Selenium Manager release
               * Updates Pinned browser version to coincide with new CDP release
               * Adds support for new CDP version and removes old CDP version
               * Selenium Manager references the new Selenium Manager release
               * Updates Maven Dependencies
               * Adds new authors to authors file
               * Updates all versions for all bindings
               * Generates *rough* change logs for each bindings (please tidy them up before merging this)
+                  * Not all commits need to be in the change log — users do not need to see anything about building or testing Selenium
+                  * Remove references to updating versions including nightly
+                  * The code now outputs the complete body of the commit message; make sure the changelog message is complete and correct
 
-            - Auto-generated by [create-pull-request][1]
+            - This PR was auto-generated by workflow run: [release-preparation][1]
 
-            [1]: https://github.com/peter-evans/create-pull-request
+            [1]: https://github.com/SeleniumHQ/selenium/actions/runs/${{ github.run_id }}
           labels: C-build
           draft: true

README.md

@@ -201,7 +201,7 @@ for Maven to use locally by deploying to your local maven repository (`~/.m2/rep
 
 #### Updating Dependencies
 
-Dependencies are defined in the file [maven_deps.bzl](https://github.com/SeleniumHQ/selenium/blob/trunk/java/maven_deps.bzl).
+Dependencies are defined in the file [MODULE.bazel](https://github.com/SeleniumHQ/selenium/blob/trunk/MODULE.bazel).
 To automatically update and pin new dependencies, run:
 
 ```shell

Rakefile

@@ -129,7 +129,7 @@ def verify_java_release_targets
   current_targets = []
 
   Bazel.execute('query', [], query) do |output|
-    current_targets = output.lines.map(&:strip).reject(&:empty?)
+    current_targets = output.lines.map(&:strip).reject(&:empty?).select { |line| line.start_with?('//') }
   end
 
   missing_targets = current_targets - JAVA_RELEASE_TARGETS
@@ -1110,34 +1110,38 @@ namespace :all do
     commit!('Update selenium manager version', ['common/selenium_manager.bzl'])
 
     Rake::Task['java:update'].invoke
-    commit!('Update Maven Dependencies', ['java/maven_deps.bzl', 'java/maven_install.json'])
+    commit!('Update Maven Dependencies', ['MODULE.bazel', 'java/maven_install.json'])
 
     Rake::Task['authors'].invoke
     commit!('Update authors file', ['AUTHORS'])
 
     # Note that this does not include Rust version changes that are handled in separate rake:version task
     # TODO: These files are all defined in other tasks; remove duplication
     Rake::Task['all:version'].invoke(version)
-    commit!("FIX CHANGELOGS BEFORE MERGING!\n\nUpdate versions and change logs to release Selenium #{java_version}",
-            ['dotnet/CHANGELOG',
-             'dotnet/selenium-dotnet-version.bzl',
-             'java/CHANGELOG',
+    commit!("Update Version in all bindings to #{java_version}",
+            ['dotnet/selenium-dotnet-version.bzl',
              'java/version.bzl',
-             'javascript/node/selenium-webdriver/CHANGES.md',
+             'javascript/node/selenium-webdriver/BUILD.bazel',
              'javascript/node/selenium-webdriver/package.json',
              'py/docs/source/conf.py',
+             'py/pyproject.toml',
              'py/selenium/__init__.py',
              'py/selenium/webdriver/__init__.py',
              'py/BUILD.bazel',
-             'py/CHANGES',
              'rb/lib/selenium/webdriver/version.rb',
-             'rb/CHANGES',
              'rb/Gemfile.lock',
-             'rust/CHANGELOG.md',
              'rust/BUILD.bazel',
              'rust/Cargo.Bazel.lock',
              'rust/Cargo.toml',
              'rust/Cargo.lock'])
+
+    commit!("FIX CHANGELOGS BEFORE MERGING! #{java_version}",
+            ['dotnet/CHANGELOG',
+             'java/CHANGELOG',
+             'javascript/node/selenium-webdriver/CHANGES.md',
+             'py/CHANGES',
+             'rb/CHANGES',
+             'rust/CHANGELOG.md'])
   end
 
   desc 'Update all versions'
@@ -1214,16 +1218,25 @@ end
 
 def update_changelog(version, language, path, changelog, header)
   tag = previous_tag(version, language)
-  log = if language == 'javascript'
-          `git --no-pager log #{tag}...HEAD --pretty=format:"- %s" --reverse #{path}`
-        else
-          `git --no-pager log #{tag}...HEAD --pretty=format:"* %s" --reverse #{path}`
-        end
-  commits = log.split('>>>').map { |entry|
-    lines = entry.split("\n")
-    lines.reject! { |line| line.match?(/^(----|Co-authored|Signed-off)/) || line.empty? }
-    lines.join("\n")
-  }.join("\n>>>")
+  bullet = language == 'javascript' ? '- ' : '* '
+  commit_delimiter = '===DELIM==='
+  tags_to_remove = /\[(dotnet|rb|py|java|js|rust)\]:?\s?/
+
+  command = "git --no-pager log #{tag}...HEAD --pretty=format:\"%s%n%b#{commit_delimiter}\" --reverse #{path}"
+  puts "Executing git command: #{command}"
+
+  log = `#{command}`
+
+  commits = log.split(commit_delimiter).map { |commit|
+    lines = commit.gsub(tags_to_remove, '').strip.lines.map(&:chomp)
+    subject = "#{bullet}#{lines[0]}"
+
+    body = lines[1..]
+           .reject { |line| line.match?(/^(----|Co-authored|Signed-off)/) || line.empty? }
+           .map { |line| "    > #{line}" }
+           .join("\n")
+    body.empty? ? subject : "#{subject}\n#{body}"
+  }.join("\n")
 
   File.open(changelog, 'r+') do |file|
     new_content = "#{header}\n#{commits}\n\n#{file.read}"

java/test/org/openqa/selenium/bidi/BiDiSessionCleanUpTest.java

@@ -20,7 +20,6 @@
 import static org.assertj.core.api.AssertionsForClassTypes.assertThat;
 import static org.assertj.core.api.AssertionsForClassTypes.assertThatExceptionOfType;
 
-import java.util.Collections;
 import org.junit.jupiter.api.Test;
 import org.openqa.selenium.WebDriverException;
 import org.openqa.selenium.WindowType;
@@ -42,8 +41,7 @@ void shouldNotCloseBiDiSessionIfOneWindowIsClosed() {
 
     BiDi biDi = driver.getBiDi();
 
-    BiDiSessionStatus status =
-        biDi.send(new Command<>("session.status", Collections.emptyMap(), BiDiSessionStatus.class));
+    BiDiSessionStatus status = biDi.getBidiSessionStatus();
     assertThat(status).isNotNull();
     assertThat(status.getMessage()).isEqualTo("Session already started");
 
@@ -53,8 +51,7 @@ void shouldNotCloseBiDiSessionIfOneWindowIsClosed() {
 
     driver.close();
 
-    BiDiSessionStatus statusAfterClosing =
-        biDi.send(new Command<>("session.status", Collections.emptyMap(), BiDiSessionStatus.class));
+    BiDiSessionStatus statusAfterClosing = biDi.getBidiSessionStatus();
     assertThat(statusAfterClosing).isNotNull();
     assertThat(status.getMessage()).isEqualTo("Session already started");
     driver.quit();
@@ -70,19 +67,14 @@ void shouldCloseBiDiSessionIfLastWindowIsClosed() {
 
     BiDi biDi = driver.getBiDi();
 
-    BiDiSessionStatus status =
-        biDi.send(new Command<>("session.status", Collections.emptyMap(), BiDiSessionStatus.class));
+    BiDiSessionStatus status = biDi.getBidiSessionStatus();
     assertThat(status).isNotNull();
     assertThat(status.getMessage()).isEqualTo("Session already started");
 
     driver.close();
 
     // Closing the last top-level browsing context, closes the WebDriver and BiDi session
     assertThatExceptionOfType(WebDriverException.class)
-        .isThrownBy(
-            () ->
-                biDi.send(
-                    new Command<>(
-                        "session.status", Collections.emptyMap(), BiDiSessionStatus.class)));
+        .isThrownBy(() -> biDi.getBidiSessionStatus());
   }
 }

java/test/org/openqa/selenium/bidi/BiDiSessionTest.java

@@ -19,7 +19,6 @@
 
 import static org.assertj.core.api.AssertionsForClassTypes.assertThat;
 
-import java.util.Collections;
 import org.junit.jupiter.api.Test;
 import org.openqa.selenium.testing.JupiterTestBase;
 
@@ -29,8 +28,7 @@ class BiDiSessionTest extends JupiterTestBase {
   void shouldBeAbleToCreateABiDiSession() {
     BiDi biDi = ((HasBiDi) driver).getBiDi();
 
-    BiDiSessionStatus status =
-        biDi.send(new Command<>("session.status", Collections.emptyMap(), BiDiSessionStatus.class));
+    BiDiSessionStatus status = biDi.getBidiSessionStatus();
     assertThat(status).isNotNull();
     assertThat(status.getMessage()).isNotEmpty();
   }

java/test/org/openqa/selenium/grid/router/RemoteWebDriverBiDiTest.java

@@ -21,7 +21,6 @@
 import static org.openqa.selenium.testing.drivers.Browser.*;
 
 import java.io.StringReader;
-import java.util.Collections;
 import java.util.Objects;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.ExecutionException;
@@ -37,7 +36,6 @@
 import org.openqa.selenium.WindowType;
 import org.openqa.selenium.bidi.BiDi;
 import org.openqa.selenium.bidi.BiDiSessionStatus;
-import org.openqa.selenium.bidi.Command;
 import org.openqa.selenium.bidi.HasBiDi;
 import org.openqa.selenium.bidi.browsingcontext.BrowsingContext;
 import org.openqa.selenium.bidi.browsingcontext.NavigationResult;
@@ -89,9 +87,7 @@ void setup() {
   @NotYetImplemented(EDGE)
   void ensureBiDiSessionCreation() {
     try (BiDi biDi = ((HasBiDi) driver).getBiDi()) {
-      BiDiSessionStatus status =
-          biDi.send(
-              new Command<>("session.status", Collections.emptyMap(), BiDiSessionStatus.class));
+      BiDiSessionStatus status = biDi.getBidiSessionStatus();
       assertThat(status).isNotNull();
       assertThat(status.getMessage()).isNotEmpty();
     }

javascript/node/selenium-webdriver/BUILD.bazel

@@ -38,6 +38,7 @@ js_library(
         "devtools/*.js",
         "common/*.js",
         "bidi/*.js",
+        "bidi/external/*.js",
     ]),
     deps = [
         ":node_modules/@bazel/runfiles",

javascript/node/selenium-webdriver/bidi/external/permissions.js

@@ -0,0 +1,73 @@
+// 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.
+
+const PermissionState = Object.freeze({
+  GRANTED: 'granted',
+  DENIED: 'denied',
+  PROMPT: 'prompt',
+})
+
+class Permission {
+  constructor(driver) {
+    this._driver = driver
+  }
+
+  async init() {
+    if (!(await this._driver.getCapabilities()).get('webSocketUrl')) {
+      throw Error('WebDriver instance must support BiDi protocol')
+    }
+
+    this.bidi = await this._driver.getBidi()
+  }
+
+  /**
+   * Sets a permission state for a given permission descriptor.
+   * @param {Object} permissionDescriptor The permission descriptor.
+   * @param {string} state The permission state (granted, denied, prompt).
+   * @param {string} origin The origin for which the permission is set.
+   * @param {string} [userContext] The user context id (optional).
+   * @returns {Promise<void>}
+   */
+  async setPermission(permissionDescriptor, state, origin, userContext = null) {
+    if (!Object.values(PermissionState).includes(state)) {
+      throw new Error(`Invalid permission state. Must be one of: ${Object.values(PermissionState).join(', ')}`)
+    }
+
+    const command = {
+      method: 'permissions.setPermission',
+      params: {
+        descriptor: permissionDescriptor,
+        state: state,
+        origin: origin,
+      },
+    }
+
+    if (userContext) {
+      command.params.userContext = userContext
+    }
+
+    await this.bidi.send(command)
+  }
+}
+
+async function getPermissionInstance(driver) {
+  let instance = new Permission(driver)
+  await instance.init()
+  return instance
+}
+
+module.exports = { getPermissionInstance, PermissionState }