Skip to content

fix: Add fallback commands for file management APIs #1910

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 9, 2023
Merged

fix: Add fallback commands for file management APIs #1910

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 36 additions & 11 deletions src/main/java/io/appium/java_client/PullsFiles.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,14 @@
import com.google.common.collect.ImmutableMap;

import java.nio.charset.StandardCharsets;
import java.util.AbstractMap;
import java.util.Base64;

import static com.google.common.base.Preconditions.checkNotNull;
import static io.appium.java_client.MobileCommand.PULL_FILE;
import static io.appium.java_client.MobileCommand.PULL_FOLDER;

public interface PullsFiles extends ExecutesMethod {
public interface PullsFiles extends ExecutesMethod, CanRememberExtensionPresence {

/**
* Pull a file from the remote system.
Expand All @@ -38,11 +41,22 @@ public interface PullsFiles extends ExecutesMethod {
* @return A byte array of Base64 encoded data.
*/
default byte[] pullFile(String remotePath) {
String base64String = checkNotNull(
CommandExecutionHelper.executeScript(this, "mobile: pullFile", ImmutableMap.of(
"remotePath", remotePath
))
);
final String extName = "mobile: pullFile";
String base64String;
try {
base64String = checkNotNull(
CommandExecutionHelper.executeScript(assertExtensionExists(extName), extName,
ImmutableMap.of("remotePath", remotePath)
)
);
} catch (UnsupportedOperationException e) {
// TODO: Remove the fallback
base64String = checkNotNull(
CommandExecutionHelper.execute(markExtensionAbsence(extName),
new AbstractMap.SimpleEntry<>(PULL_FILE, ImmutableMap.of("path", remotePath))
)
);
}
return Base64.getDecoder().decode(base64String.getBytes(StandardCharsets.UTF_8));
}

Expand All @@ -59,11 +73,22 @@ default byte[] pullFile(String remotePath) {
* @return A byte array of Base64 encoded zip archive data.
*/
default byte[] pullFolder(String remotePath) {
String base64String = checkNotNull(
CommandExecutionHelper.executeScript(this, "mobile: pullFolder", ImmutableMap.of(
"remotePath", remotePath
))
);
final String extName = "mobile: pullFolder";
String base64String;
try {
base64String = checkNotNull(
CommandExecutionHelper.executeScript(assertExtensionExists(extName), extName,
ImmutableMap.of("remotePath", remotePath)
)
);
} catch (UnsupportedOperationException e) {
// TODO: Remove the fallback
base64String = checkNotNull(
CommandExecutionHelper.execute(markExtensionAbsence(extName),
new AbstractMap.SimpleEntry<>(PULL_FOLDER, ImmutableMap.of("path", remotePath))
)
);
}
return Base64.getDecoder().decode(base64String.getBytes(StandardCharsets.UTF_8));
}

Expand Down
19 changes: 14 additions & 5 deletions src/main/java/io/appium/java_client/PushesFiles.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,16 @@

import com.google.common.collect.ImmutableMap;
import org.apache.commons.io.FileUtils;
import org.openqa.selenium.UnsupportedCommandException;

import java.io.File;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.util.Base64;

public interface PushesFiles extends ExecutesMethod {
import static io.appium.java_client.MobileCommand.pushFileCommand;

public interface PushesFiles extends ExecutesMethod, CanRememberExtensionPresence {

/**
* Saves base64-encoded data as a file on the remote system.
Expand All @@ -36,10 +39,16 @@ public interface PushesFiles extends ExecutesMethod {
* @param base64Data Base64 encoded byte array of media file data to write to remote device
*/
default void pushFile(String remotePath, byte[] base64Data) {
CommandExecutionHelper.executeScript(this, "mobile: pushFile", ImmutableMap.of(
"remotePath", remotePath,
"payload", new String(base64Data, StandardCharsets.UTF_8)
));
final String extName = "mobile: pushFile";
try {
CommandExecutionHelper.executeScript(assertExtensionExists(extName), extName, ImmutableMap.of(
"remotePath", remotePath,
"payload", new String(base64Data, StandardCharsets.UTF_8)
));
} catch (UnsupportedCommandException e) {
// TODO: Remove the fallback
CommandExecutionHelper.execute(markExtensionAbsence(extName), pushFileCommand(remotePath, base64Data));
}
}

/**
Expand Down