Skip to content

Commit

Permalink
Fallback to file-system-based xml streaming if the memory-based one f…
Browse files Browse the repository at this point in the history 
…ails with OOM error (#344)
  • Loading branch information
@mykola-mokhnach
mykola-mokhnach authored Dec 12, 2018
1 parent 84ea805 commit 9c88097
Show file tree
Hide file tree
Showing 2 changed files with 114 additions and 31 deletions.
142 changes: 112 additions & 30 deletions ...so-server/app/src/androidTest/java/io/appium/espressoserver/lib/model/SourceDocument.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,13 @@

package io.appium.espressoserver.lib.model;

import android.content.Context;
import android.os.SystemClock;
import android.text.TextUtils;
import android.util.SparseArray;
import android.util.Xml;
import android.view.View;
import android.view.ViewGroup;
import android.widget.Adapter;
import android.widget.AdapterView;

Expand All @@ -29,11 +31,18 @@
import org.xml.sax.InputSource;
import org.xmlpull.v1.XmlSerializer;

import java.io.BufferedReader;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.StringReader;
import java.io.StringWriter;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
import java.util.concurrent.Semaphore;

import javax.annotation.Nullable;
import javax.xml.xpath.XPath;
Expand All @@ -46,7 +55,7 @@
import io.appium.espressoserver.lib.handlers.exceptions.XPathLookupException;
import io.appium.espressoserver.lib.viewaction.ViewGetter;

import static androidx.test.espresso.util.TreeIterables.breadthFirstViewTraversal;
import static androidx.test.core.app.ApplicationProvider.getApplicationContext;
import static io.appium.espressoserver.lib.helpers.AndroidLogger.logger;
import static io.appium.espressoserver.lib.helpers.StringHelpers.abbreviate;
import static io.appium.espressoserver.lib.helpers.XMLHelpers.toNodeName;
Expand All @@ -57,20 +66,27 @@ public class SourceDocument {
private static final String NON_XML_CHAR_REPLACEMENT = "?";
private static final String VIEW_INDEX = "viewIndex";
private static final String NAMESPACE = "";
private final static String DEFAULT_VIEW_CLASS_NAME = "android.view.View";
private final static int MAX_TRAVERSE_DEPTH = 70;
private final static int MAX_XML_VALUE_LENGTH = 64 * 1024;
private static final String DEFAULT_VIEW_CLASS_NAME = "android.view.View";
private static final int MAX_TRAVERSAL_DEPTH = 70;
private static final int MAX_XML_VALUE_LENGTH = 64 * 1024;
private static final String XML_ENCODING = "UTF-8";
private final Semaphore RESOURCES_GUARD = new Semaphore(1);

private XmlSerializer serializer;
@Nullable
private final SparseArray<View> viewMap;
@Nullable
private final View root;
private String tmpXmlName;

public SourceDocument() {
this(null, null);
}

public SourceDocument(@Nullable View root) {
this(root, new SparseArray<View>());
}

private SourceDocument(@Nullable View root, @Nullable SparseArray<View> viewMap) {
this.root = root;
this.viewMap = viewMap;
Expand Down Expand Up @@ -134,7 +150,7 @@ private static String toXmlNodeName(@Nullable String className) {
/**
* Recursively visit all of the views and map them to XML elements
*
* @param view The root view
* @param view The root view
* @param depth The current traversal depth
*/
private void serializeView(View view, final int depth) throws IOException {
Expand Down Expand Up @@ -179,11 +195,11 @@ private void serializeView(View view, final int depth) throws IOException {
viewMap.put(viewMap.size(), view);
}

if (depth < MAX_TRAVERSE_DEPTH) {
if (depth < MAX_TRAVERSAL_DEPTH) {
// Visit the children and build them too
for (View childView : breadthFirstViewTraversal(view)) {
if (!view.equals(childView)) {
serializeView(childView, depth + 1);
if (view instanceof ViewGroup) {
for (int index = 0; index < ((ViewGroup) view).getChildCount(); ++index) {
serializeView(((ViewGroup) view).getChildAt(index), depth + 1);
}
}
} else {
Expand All @@ -194,34 +210,100 @@ private void serializeView(View view, final int depth) throws IOException {
serializer.endTag(NAMESPACE, tagName);
}

public synchronized String toXMLString() throws AppiumException {
serializer = Xml.newSerializer();
if (viewMap != null) {
viewMap.clear();
private InputStream toStream() throws AppiumException {
Throwable lastError = null;
final View rootView = root == null ? new ViewGetter().getRootView() : root;
// Try to serialize the xml into the memory first, since it is fast
// Switch to a file system serializer if the first approach causes OutOfMemory
for (Class<?> streamType : new Class[]{ByteArrayOutputStream.class, FileOutputStream.class}) {
serializer = Xml.newSerializer();
if (viewMap != null) {
viewMap.clear();
}

try {
OutputStream outputStream;
if (streamType.equals(FileOutputStream.class)) {
tmpXmlName = String.format("%s.xml", UUID.randomUUID().toString());
outputStream = getApplicationContext().openFileOutput(tmpXmlName, Context.MODE_PRIVATE);
} else {
outputStream = new ByteArrayOutputStream();
}
try {
serializer.setOutput(outputStream, XML_ENCODING);
serializer.startDocument(XML_ENCODING, true);
serializer.setFeature("http://xmlpull.org/v1/doc/features.html#indent-output", true);
final long startTime = SystemClock.uptimeMillis();
serializeView(rootView, 0);
serializer.endDocument();
logger.info(String.format("The source XML tree has been fetched in %sms using %s",
SystemClock.uptimeMillis() - startTime, streamType.getSimpleName()));
} catch (OutOfMemoryError e) {
lastError = e;
continue;
} finally {
outputStream.close();
}
return outputStream instanceof FileOutputStream
? getApplicationContext().openFileInput(tmpXmlName)
: new ByteArrayInputStream(((ByteArrayOutputStream) outputStream).toByteArray());
} catch (IOException e) {
lastError = e;
}
}
final StringWriter writer = new StringWriter();
if (lastError instanceof OutOfMemoryError) {
throw (OutOfMemoryError) lastError;
}
throw new AppiumException(lastError);
}

private void performCleanup() {
if (tmpXmlName != null) {
getApplicationContext().deleteFile(tmpXmlName);
tmpXmlName = null;
}
}

public String toXMLString() throws AppiumException {
try {
serializer.setOutput(writer);
serializer.startDocument("UTF-8", true);
serializer.setFeature("http://xmlpull.org/v1/doc/features.html#indent-output", true);
final long startTime = SystemClock.uptimeMillis();
serializeView(root == null ? new ViewGetter().getRootView() : root, 0);
serializer.endDocument();
logger.info(String.format("The source XML tree has been fetched in %sms", SystemClock.uptimeMillis() - startTime));
return writer.toString();
} catch (Exception e) {
RESOURCES_GUARD.acquire();
} catch (InterruptedException e) {
throw new AppiumException(e);
}
try (InputStream xmlStream = toStream()) {
StringBuilder sb = new StringBuilder();
String line;
BufferedReader reader = new BufferedReader(new InputStreamReader(xmlStream, XML_ENCODING));
while ((line = reader.readLine()) != null) {
sb.append(line);
}
return sb.toString();
} catch (IOException e) {
throw new AppiumException(e);
} finally {
performCleanup();
RESOURCES_GUARD.release();
}
}

public static List<View> findViewsByXPath(@Nullable View root, String xpathSelector) throws AppiumException {
final SparseArray<View> viewMap = new SparseArray<>();
public List<View> findViewsByXPath(String xpathSelector) throws AppiumException {
try {
// Get the Nodes that match the provided xpath
XPathExpression expr = xpath.compile(xpathSelector);
NodeList list = (NodeList) expr.evaluate(
new InputSource(new StringReader(new SourceDocument(root, viewMap).toXMLString())),
XPathConstants.NODESET);
NodeList list;
try {
RESOURCES_GUARD.acquire();
} catch (InterruptedException e) {
throw new AppiumException(e);
}
try (InputStream xmlStream = toStream()) {
list = (NodeList) expr.evaluate(new InputSource(xmlStream), XPathConstants.NODESET);
} catch (IOException e) {
throw new AppiumException(e);
} finally {
performCleanup();
RESOURCES_GUARD.release();
}

// Get a list of elements that are associated with that node
List<View> views = new ArrayList<>();
Expand Down
3 changes: 2 additions & 1 deletion ...o-server/app/src/androidTest/java/io/appium/espressoserver/lib/viewmatcher/WithXPath.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
package io.appium.espressoserver.lib.viewmatcher;

import androidx.annotation.Nullable;

import android.view.View;

import org.hamcrest.Description;
Expand All @@ -32,7 +33,7 @@ public class WithXPath {
public static Matcher<View> withXPath(@Nullable final View root, final String xpath,
@Nullable final Integer index) throws AppiumException {
// Get a list of the Views that match the provided xpath
final List<View> matchedXPathViews = SourceDocument.findViewsByXPath(root, xpath);
final List<View> matchedXPathViews = new SourceDocument(root).findViewsByXPath(xpath);

return new TypeSafeMatcher<View>() {
@Override
Expand Down

0 comments on commit 9c88097

Please sign in to comment.