Skip to content

Commit

Permalink
chore: Add non-W3C Location-management endpoints deprecated in Seleni…
Browse files Browse the repository at this point in the history
…um client
  • Loading branch information
valfirst committed Jan 14, 2024
1 parent 43bbd48 commit 5f36e28
Show file tree
Hide file tree
Showing 7 changed files with 120 additions and 4 deletions.
1 change: 1 addition & 0 deletions src/main/java/io/appium/java_client/AppiumDriver.java
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ public class AppiumDriver extends RemoteWebDriver implements
// frequently used command parameters
@Getter
private final URL remoteAddress;
@Deprecated(forRemoval = true)
protected final RemoteLocationContext locationContext;
private final ExecuteMethod executeMethod;
private final Set<String> absentExtensionNames = new HashSet<>();
Expand Down
56 changes: 56 additions & 0 deletions src/main/java/io/appium/java_client/Location.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
/*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
* 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 io.appium.java_client;

import lombok.Getter;
import lombok.ToString;

import javax.annotation.Nullable;

/**
* Represents the physical location.
*/
@Getter
@ToString
public class Location {
private final double latitude;
private final double longitude;
private final Double altitude;

/**
* Create {@link Location} with latitude, longitude and altitude values.
*
* @param latitude latitude value.
* @param longitude longitude value.
* @param altitude altitude value (can be null).
*/
public Location(double latitude, double longitude, @Nullable Double altitude) {
this.latitude = latitude;
this.longitude = longitude;
this.altitude = altitude;
}

/**
* Create {@link Location} with latitude and longitude values.
*
* @param latitude latitude value.
* @param longitude longitude value.
*/
public Location(double latitude, double longitude) {
this(latitude, longitude, null);
}
}
6 changes: 6 additions & 0 deletions src/main/java/io/appium/java_client/MobileCommand.java
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,9 @@ public class MobileCommand {
public static final String GET_CURRENT_CONTEXT_HANDLE = "getCurrentContextHandle";
public static final String SWITCH_TO_CONTEXT = "switchToContext";

public static final String GET_LOCATION = "getLocation";
public static final String SET_LOCATION = "setLocation";

public static final Map<String, CommandInfo> commandRepository;

static {
Expand Down Expand Up @@ -365,6 +368,9 @@ public class MobileCommand {
commandRepository.put(GET_CONTEXT_HANDLES, getC("/session/:sessionId/contexts"));
commandRepository.put(GET_CURRENT_CONTEXT_HANDLE, getC("/session/:sessionId/context"));
commandRepository.put(SWITCH_TO_CONTEXT, postC("/session/:sessionId/context"));

commandRepository.put(GET_LOCATION, getC("/session/:sessionId/location"));
commandRepository.put(SET_LOCATION, postC("/session/:sessionId/location"));
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,7 @@ public AndroidBatteryInfo getBatteryInfo() {
}

@Override
@Deprecated(forRemoval = true)
public RemoteLocationContext getLocationContext() {
return locationContext;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

import io.appium.java_client.CommandExecutionHelper;
import io.appium.java_client.ExecutesMethod;
import org.openqa.selenium.remote.DriverCommand;
import io.appium.java_client.MobileCommand;

import java.util.Map;

Expand All @@ -31,7 +31,7 @@ public interface SupportsExtendedGeolocationCommands extends ExecutesMethod {
* @param location The location object to set.
*/
default void setLocation(AndroidGeoLocation location) {
CommandExecutionHelper.execute(this, Map.entry(DriverCommand.SET_LOCATION,
CommandExecutionHelper.execute(this, Map.entry(MobileCommand.SET_LOCATION,
Map.of("location", location.build())
));
}
Expand Down
1 change: 1 addition & 0 deletions src/main/java/io/appium/java_client/ios/IOSDriver.java
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,7 @@ class IOSAlert implements Alert {
}

@Override
@Deprecated(forRemoval = true)
public RemoteLocationContext getLocationContext() {
return locationContext;
}
Expand Down
55 changes: 53 additions & 2 deletions src/main/java/io/appium/java_client/remote/SupportsLocation.java
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,70 @@

package io.appium.java_client.remote;

import io.appium.java_client.CommandExecutionHelper;
import io.appium.java_client.ExecutesMethod;
import io.appium.java_client.MobileCommand;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebDriverException;
import org.openqa.selenium.html5.Location;
import org.openqa.selenium.html5.LocationContext;
import org.openqa.selenium.remote.html5.RemoteLocationContext;

public interface SupportsLocation extends WebDriver, LocationContext {
public RemoteLocationContext getLocationContext();
import java.util.Map;
import java.util.Optional;

public interface SupportsLocation extends WebDriver, ExecutesMethod, LocationContext {

@Deprecated(forRemoval = true)
RemoteLocationContext getLocationContext();

/**
* Gets the physical location of the browser.
*
* @return A {@link Location} containing the location information. Returns null if the location is not available
* @deprecated This method and whole {@link LocationContext} interface are deprecated, use {@link #getLocation()}
* instead.
*/
@Deprecated(forRemoval = true)
default Location location() {
return getLocationContext().location();
}

/**
* Gets the physical location.
*
* @return A {@link Location} containing the location information. Throws {@link WebDriverException} if the
* location is not available.
*/
default io.appium.java_client.Location getLocation() {
Map<String, Number> result = CommandExecutionHelper.execute(this, MobileCommand.GET_LOCATION);
return Optional.ofNullable(result).map(r ->
new io.appium.java_client.Location(
r.get("latitude").doubleValue(),
r.get("longitude").doubleValue(),
Optional.ofNullable(r.get("altitude")).map(Number::doubleValue).orElse(null)
)
).orElseThrow(() -> new WebDriverException("Cannot retrieve location"));
}

/**
* Sets the physical location.
*
* @param location A {@link Location} containing the new location information.
* @deprecated This method and whole {@link LocationContext} interface are deprecated, use
* {@link #setLocation(io.appium.java_client.Location)} instead.
*/
@Deprecated(forRemoval = true)
default void setLocation(Location location) {
getLocationContext().setLocation(location);
}

/**
* Sets the physical location.
*
* @param location A {@link Location} containing the new location information.
*/
default void setLocation(io.appium.java_client.Location location) {
execute(MobileCommand.SET_LOCATION, Map.of("location", location));
}
}

0 comments on commit 5f36e28

Please sign in to comment.