Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
75 changes: 65 additions & 10 deletions src/main/java/io/percy/selenium/Percy.java
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ public class Percy {
// Maybe get the CLI server address
private static String PERCY_SERVER_ADDRESS = System.getenv().getOrDefault("PERCY_SERVER_ADDRESS", "http://localhost:5338");

// Upper bound for readiness.timeoutMs, matching the Percy CLI config schema.
private static final long MAX_READINESS_TIMEOUT_MS = 60000L;

// Determine if we're debug logging
private static boolean PERCY_DEBUG = System.getenv().getOrDefault("PERCY_LOGLEVEL", "info").equals("debug");

Expand Down Expand Up @@ -350,18 +353,16 @@ private List<Map<String, Object>> parseWidthsConfigResponse(HttpResponse respons
}

private boolean isCaptureResponsiveDOM(Map<String, Object> options) {
if (cliConfig.has("percy") && !cliConfig.isNull("percy")) {
JSONObject percyProperty = cliConfig.getJSONObject("percy");

if (percyProperty.has("deferUploads") && !percyProperty.isNull("deferUploads") && percyProperty.getBoolean("deferUploads")) {
return false;
}
JSONObject percyProperty = cliConfig == null ? null : cliConfig.optJSONObject("percy");
if (percyProperty != null && percyProperty.optBoolean("deferUploads", false)) {
return false;
}

boolean responsiveSnapshotCaptureCLI = false;
if (eligibleWidths == null) { return false; }
if (cliConfig.getJSONObject("snapshot").has("responsiveSnapshotCapture")) {
responsiveSnapshotCaptureCLI = cliConfig.getJSONObject("snapshot").getBoolean("responsiveSnapshotCapture");
JSONObject snapshotConfig = cliConfig == null ? null : cliConfig.optJSONObject("snapshot");
if (snapshotConfig != null && snapshotConfig.has("responsiveSnapshotCapture")) {
responsiveSnapshotCaptureCLI = snapshotConfig.getBoolean("responsiveSnapshotCapture");
}
Object responsiveSnapshotCaptureSDK = options.get("responsiveSnapshotCapture");

Expand Down Expand Up @@ -582,9 +583,9 @@ private boolean healthcheck() {
HttpEntity entity = response.getEntity();
String responseString = EntityUtils.toString(entity, "UTF-8");
JSONObject responseObject = new JSONObject(responseString);
sessionType = (String) responseObject.optString("type", null);
sessionType = sanitizeSessionType(responseObject.opt("type"));
eligibleWidths = responseObject.optJSONObject("widths");
cliConfig = responseObject.optJSONObject("config");
cliConfig = sanitizeCliConfig(responseObject.optJSONObject("config"));

return true;
} catch (Exception ex) {
Expand All @@ -596,6 +597,60 @@ private boolean healthcheck() {
}
}

/**
* Only accept the session types the CLI reports; anything else is treated as
* absent, the same as an older CLI that does not report a type.
*/
static String sanitizeSessionType(Object type) {
if ("web".equals(type) || "automate".equals(type)) { return (String) type; }
if (type != null && type != JSONObject.NULL) {
log("Ignoring unknown session type in Percy CLI healthcheck response", "debug");
}
return null;
}

/**
* Drop malformed sections of the healthcheck config instead of letting them
* break snapshots, and bound readiness.timeoutMs to the CLI schema maximum.
* Snapshots keep running with defaults for anything that is dropped.
*/
static JSONObject sanitizeCliConfig(JSONObject config) {
if (config == null) { return null; }
for (String key : new String[] { "snapshot", "percy" }) {
if (config.has(key) && !(config.opt(key) instanceof JSONObject)) {
log("Ignoring malformed '" + key + "' config in Percy CLI healthcheck response", "debug");
config.remove(key);
}
}

JSONObject percy = config.optJSONObject("percy");
if (percy != null && percy.has("deferUploads") && !(percy.opt("deferUploads") instanceof Boolean)) {
log("Ignoring malformed 'deferUploads' config in Percy CLI healthcheck response", "debug");
percy.remove("deferUploads");
}

JSONObject snapshot = config.optJSONObject("snapshot");
Comment thread
Shivanshu-07 marked this conversation as resolved.
Resolved
if (snapshot != null && snapshot.has("responsiveSnapshotCapture")
&& !(snapshot.opt("responsiveSnapshotCapture") instanceof Boolean)) {
log("Ignoring malformed 'responsiveSnapshotCapture' config in Percy CLI healthcheck response", "debug");
snapshot.remove("responsiveSnapshotCapture");
}
if (snapshot != null && snapshot.has("readiness") && !(snapshot.opt("readiness") instanceof JSONObject)) {
log("Ignoring malformed 'readiness' config in Percy CLI healthcheck response", "debug");
snapshot.remove("readiness");
}
JSONObject readiness = snapshot == null ? null : snapshot.optJSONObject("readiness");
if (readiness != null && readiness.has("timeoutMs")) {
if (!(readiness.opt("timeoutMs") instanceof Number)) {
log("Ignoring malformed 'timeoutMs' readiness config in Percy CLI healthcheck response", "debug");
readiness.remove("timeoutMs");
} else if (readiness.getLong("timeoutMs") > MAX_READINESS_TIMEOUT_MS) {
readiness.put("timeoutMs", MAX_READINESS_TIMEOUT_MS);
}
}
return config;
}

/**
* Attempts to load dom.js from the local Percy server. Use cached value in `domJs`,
* if it exists.
Expand Down
137 changes: 137 additions & 0 deletions src/test/java/io/percy/selenium/PercyLogicTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -866,6 +866,137 @@ public void handle(HttpExchange exchange) throws IOException {
}
}

@Test
public void healthcheckIgnoresUnknownSessionTypeAndMalformedConfig() throws Exception {
HttpServer server = HttpServer.create(new InetSocketAddress(0), 0);
server.createContext("/percy/healthcheck", new HttpHandler() {
@Override
public void handle(HttpExchange exchange) throws IOException {
exchange.getResponseHeaders().add("x-percy-core-version", "1.2.3");
byte[] body = ("{\"type\":\"bogus\",\"config\":{\"snapshot\":\"not-an-object\","
+ "\"percy\":{\"deferUploads\":\"yes\"},\"other\":1}}").getBytes("UTF-8");
exchange.sendResponseHeaders(HttpURLConnection.HTTP_OK, body.length);
try (OutputStream os = exchange.getResponseBody()) { os.write(body); }
}
});
server.start();

String originalAddress = getStaticStringField(Percy.class, "PERCY_SERVER_ADDRESS");
try {
setStaticField(Percy.class, "PERCY_SERVER_ADDRESS", "http://localhost:" + server.getAddress().getPort());
Percy percy = new Percy(mock(RemoteWebDriver.class));

// Percy stays enabled; only the malformed parts are dropped.
assertTrue(getBooleanField(percy, "isPercyEnabled"));
assertNull(percy.sessionType);
JSONObject config = (JSONObject) getField(percy, "cliConfig");
assertFalse(config.has("snapshot"));
assertFalse(config.getJSONObject("percy").has("deferUploads"));
assertEquals(1, config.getInt("other"));
} finally {
setStaticField(Percy.class, "PERCY_SERVER_ADDRESS", originalAddress);
server.stop(0);
}
}

@Test
public void sanitizeSessionTypeKeepsKnownTypesOnly() {
assertEquals("web", Percy.sanitizeSessionType("web"));
assertEquals("automate", Percy.sanitizeSessionType("automate"));
assertNull(Percy.sanitizeSessionType("Automate"));
assertNull(Percy.sanitizeSessionType(1));
assertNull(Percy.sanitizeSessionType(JSONObject.NULL));
assertNull(Percy.sanitizeSessionType(null));
}

@Test
public void sanitizeCliConfigCapsReadinessTimeoutAndKeepsValidValues() {
JSONObject capped = Percy.sanitizeCliConfig(new JSONObject()
.put("snapshot", new JSONObject().put("readiness",
new JSONObject().put("timeoutMs", 86400000L).put("preset", "strict")))
.put("percy", new JSONObject().put("deferUploads", true)));
JSONObject readiness = capped.getJSONObject("snapshot").getJSONObject("readiness");
assertEquals(60000L, readiness.getLong("timeoutMs"));
assertEquals("strict", readiness.getString("preset"));
assertTrue(capped.getJSONObject("percy").getBoolean("deferUploads"));

JSONObject kept = Percy.sanitizeCliConfig(new JSONObject()
.put("snapshot", new JSONObject().put("readiness", new JSONObject().put("timeoutMs", 5000))));
assertEquals(5000, kept.getJSONObject("snapshot").getJSONObject("readiness").getInt("timeoutMs"));

JSONObject badReadiness = Percy.sanitizeCliConfig(new JSONObject()
.put("snapshot", new JSONObject().put("readiness", "not-an-object").put("minHeight", 700)));
assertFalse(badReadiness.getJSONObject("snapshot").has("readiness"));
assertEquals(700, badReadiness.getJSONObject("snapshot").getInt("minHeight"));

JSONObject stringTimeout = Percy.sanitizeCliConfig(new JSONObject()
.put("snapshot", new JSONObject().put("readiness", new JSONObject().put("timeoutMs", "86400000"))));
assertFalse(stringTimeout.getJSONObject("snapshot").getJSONObject("readiness").has("timeoutMs"));

assertNull(Percy.sanitizeCliConfig(null));
}

@Test
public void snapshotStillPostsWhenHealthcheckResponsiveFlagIsNotBoolean() throws Exception {
RemoteWebDriver mockedDriver = mock(RemoteWebDriver.class);
Percy mockedPercy = spy(new Percy(mockedDriver));
setField(mockedPercy, "isPercyEnabled", true);
setField(mockedPercy, "domJs", "window.PercyDOM = window.PercyDOM || {};");
setField(mockedPercy, "eligibleWidths", new JSONObject().put("default", 1280));
JSONObject config = Percy.sanitizeCliConfig(new JSONObject()
.put("snapshot", new JSONObject().put("responsiveSnapshotCapture", 1)));
assertFalse(config.getJSONObject("snapshot").has("responsiveSnapshotCapture"));
setField(mockedPercy, "cliConfig", config);
mockedPercy.sessionType = "web";

when(mockedDriver.getCurrentUrl()).thenReturn("https://example.com");
WebDriver.Options mockedOptions = mock(WebDriver.Options.class);
when(mockedDriver.manage()).thenReturn(mockedOptions);
when(mockedOptions.getCookies()).thenReturn(Collections.<Cookie>emptySet());
when(mockedDriver.findElements(By.tagName("iframe"))).thenReturn(Collections.<WebElement>emptyList());
Map<String, Object> dom = new HashMap<String, Object>();
dom.put("html", "<html></html>");
when(((JavascriptExecutor) mockedDriver).executeScript(anyString())).thenReturn(dom);

ArgumentCaptor<JSONObject> payload = ArgumentCaptor.forClass(JSONObject.class);
doReturn(new JSONObject().put("name", "bad_flag"))
.when(mockedPercy).request(eq("/percy/snapshot"), payload.capture(), eq("bad_flag"));

mockedPercy.snapshot("bad_flag");
assertTrue(payload.getValue().has("domSnapshot"));
}

@Test
public void snapshotStillPostsWhenHealthcheckSnapshotConfigIsMalformed() throws Exception {
RemoteWebDriver mockedDriver = mock(RemoteWebDriver.class);
Percy mockedPercy = spy(new Percy(mockedDriver));
setField(mockedPercy, "isPercyEnabled", true);
setField(mockedPercy, "domJs", "window.PercyDOM = window.PercyDOM || {};");
setField(mockedPercy, "eligibleWidths", new JSONObject().put("default", 1280));
setField(mockedPercy, "cliConfig",
Percy.sanitizeCliConfig(new JSONObject().put("snapshot", "not-an-object")));
mockedPercy.sessionType = "web";

when(mockedDriver.getCurrentUrl()).thenReturn("https://example.com");
WebDriver.Options mockedOptions = mock(WebDriver.Options.class);
when(mockedDriver.manage()).thenReturn(mockedOptions);
when(mockedOptions.getCookies()).thenReturn(Collections.<Cookie>emptySet());
when(mockedDriver.findElements(By.tagName("iframe"))).thenReturn(Collections.<WebElement>emptyList());
Map<String, Object> dom = new HashMap<String, Object>();
dom.put("html", "<html></html>");
when(((JavascriptExecutor) mockedDriver).executeScript(anyString())).thenReturn(dom);

ArgumentCaptor<JSONObject> payload = ArgumentCaptor.forClass(JSONObject.class);
doReturn(new JSONObject().put("name", "malformed_cfg"))
.when(mockedPercy).request(eq("/percy/snapshot"), payload.capture(), eq("malformed_cfg"));

JSONObject data = mockedPercy.snapshot("malformed_cfg");
assertEquals("malformed_cfg", data.getString("name"));
// A DOM was captured (not an empty snapshot) despite the bad config.
assertTrue(payload.getValue().has("domSnapshot"));
assertFalse(payload.getValue().isNull("domSnapshot"));
}

// ------------------------------------------------------------------
// log
// ------------------------------------------------------------------
Expand Down Expand Up @@ -1061,6 +1192,12 @@ private static boolean getBooleanField(Object target, String fieldName) throws E
return (boolean) field.get(target);
}

private static Object getField(Object target, String fieldName) throws Exception {
Field field = Percy.class.getDeclaredField(fieldName);
field.setAccessible(true);
return field.get(target);
}

private static void setStaticField(Class<?> clazz, String fieldName, Object value) throws Exception {
Field field = clazz.getDeclaredField(fieldName);
field.setAccessible(true);
Expand Down
Loading