Skip to content

Commit

Permalink
[bidi][java] Add support for Input module (Actions) (#13259)
Browse files Browse the repository at this point in the history
  • Loading branch information
pujagani committed Dec 18, 2023
1 parent 273c3d4 commit 060288e
Show file tree
Hide file tree
Showing 8 changed files with 1,919 additions and 0 deletions.
83 changes: 83 additions & 0 deletions java/src/org/openqa/selenium/bidi/Input.java
@@ -0,0 +1,83 @@
// 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.

package org.openqa.selenium.bidi;

import java.lang.reflect.InvocationTargetException;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.interactions.Sequence;

public class Input {
private final BiDi bidi;

public Input(WebDriver driver) {
this.bidi = ((HasBiDi) driver).getBiDi();
}

// This will make porting from W3C WebDriver classic to BiDi seamless for Actions
public void perform(String browsingContext, Collection<Sequence> actions) {

// This step is needed to map the origin if it's an element to the key expected by BiDi
List<Map<String, Object>> encodedActions =
actions.stream().map(Sequence::encode).collect(Collectors.toList());

encodedActions.forEach(
encodedAction -> {
String type = (String) encodedAction.get("type");
// Element as origin is only possible for input pointer or wheel
if (type.equals("pointer") || type.equals("wheel")) {
List<Map<String, Object>> actionList =
(List<Map<String, Object>>) encodedAction.get("actions");

actionList.stream()
.filter(
action ->
// For pointer only pointMove action can have element as origin
action.get("type").equals("pointerMove")
|| action.get("type").equals("scroll"))
.filter(action -> action.get("origin") instanceof WebElement)
.forEach(
action -> {
Object element = action.get("origin");
try {
// Using reflection because adding RemoteWebElement as a dependency creates
// a circular dependency in Bazel
String id = (String) element.getClass().getMethod("getId").invoke(element);
// sharedId is required by BiDi, the reason for this step
action.put(
"origin", Map.of("type", "element", "element", Map.of("sharedId", id)));
} catch (NoSuchMethodException
| InvocationTargetException
| IllegalAccessException e) {
throw new RuntimeException(e);
}
});
}
});
bidi.send(
new Command<>(
"input.performActions",
Map.of(
"context", browsingContext,
"actions", encodedActions)));
}
}
5 changes: 5 additions & 0 deletions java/src/org/openqa/selenium/interactions/Actions.java
Expand Up @@ -22,6 +22,7 @@

import java.time.Duration;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashMap;
Expand Down Expand Up @@ -584,6 +585,10 @@ private Sequence getSequence(InputSource source) {
return sequence;
}

public Collection<Sequence> getSequences() {
return sequences.values();
}

private static class BuiltAction implements Action {
private final WebDriver driver;
private final Map<InputSource, Sequence> sequences;
Expand Down
33 changes: 33 additions & 0 deletions java/test/org/openqa/selenium/bidi/input/BUILD.bazel
@@ -0,0 +1,33 @@
load("@rules_jvm_external//:defs.bzl", "artifact")
load("//java:defs.bzl", "JUNIT5_DEPS", "java_selenium_test_suite")

java_selenium_test_suite(
name = "large-tests",
size = "large",
srcs = glob(["*Test.java"]),
browsers = [
"firefox",
],
data = [
"//third_party/chrome_ext:backspace.crx",
],
tags = [
"selenium-remote",
],
deps = [
"//java/src/org/openqa/selenium/chrome",
"//java/src/org/openqa/selenium/firefox",
"//java/src/org/openqa/selenium/json",
"//java/src/org/openqa/selenium/remote",
"//java/src/org/openqa/selenium/support",
"//java/test/org/openqa/selenium:helpers",
"//java/test/org/openqa/selenium/build",
"//java/test/org/openqa/selenium/environment",
"//java/test/org/openqa/selenium/testing:annotations",
"//java/test/org/openqa/selenium/testing:test-base",
"//java/test/org/openqa/selenium/testing/drivers",
artifact("org.junit.jupiter:junit-jupiter-api"),
artifact("org.assertj:assertj-core"),
artifact("org.mockito:mockito-core"),
] + JUNIT5_DEPS,
)

0 comments on commit 060288e

Please sign in to comment.