-
-
Notifications
You must be signed in to change notification settings - Fork 765
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: Make server startup error messages more useful (#2130)
- Loading branch information
1 parent
6144fb2
commit 4176929
Showing
3 changed files
with
241 additions
and
48 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
158 changes: 158 additions & 0 deletions
158
src/main/java/io/appium/java_client/service/local/AppiumServerAvailabilityChecker.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,158 @@ | ||
| /* | ||
| * 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.service.local; | ||
|
|
||
| import lombok.Getter; | ||
|
|
||
| import java.io.BufferedReader; | ||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.io.InputStreamReader; | ||
| import java.net.HttpURLConnection; | ||
| import java.net.URL; | ||
| import java.time.Duration; | ||
| import java.time.Instant; | ||
| import java.util.LinkedList; | ||
| import java.util.List; | ||
| import java.util.Optional; | ||
|
|
||
| public class AppiumServerAvailabilityChecker { | ||
| private static final Duration CONNECT_TIMEOUT = Duration.ofMillis(500); | ||
| private static final Duration READ_TIMEOUT = Duration.ofSeconds(1); | ||
| private static final Duration MAX_POLL_INTERVAL = Duration.ofMillis(320); | ||
| private static final Duration MIN_POLL_INTERVAL = Duration.ofMillis(10); | ||
|
|
||
| /** | ||
| * Verifies a possibility of establishing a connection | ||
| * to a running Appium server. | ||
| * | ||
| * @param serverStatusUrl The URL of /status endpoint. | ||
| * @param timeout Wait timeout. If the server responds with non-200 error | ||
| * code then we are not going to retry, but throw an exception | ||
| * immediately. | ||
| * @return true in case of success | ||
| * @throws InterruptedException If the API is interrupted | ||
| * @throws ConnectionTimeout If it is not possible to successfully open | ||
| * an HTTP connection to the server's /status endpoint. | ||
| * @throws ConnectionError If an HTTP connection was opened successfully, | ||
| * but non-200 error code was received. | ||
| */ | ||
| public boolean waitUntilAvailable(URL serverStatusUrl, Duration timeout) throws InterruptedException { | ||
| var interval = MIN_POLL_INTERVAL; | ||
| var start = Instant.now(); | ||
| IOException lastError = null; | ||
| while (Duration.between(start, Instant.now()).compareTo(timeout) <= 0) { | ||
| HttpURLConnection connection = null; | ||
| try { | ||
| connection = connectToUrl(serverStatusUrl); | ||
| return checkResponse(connection); | ||
| } catch (IOException e) { | ||
| lastError = e; | ||
| } finally { | ||
| Optional.ofNullable(connection).ifPresent(HttpURLConnection::disconnect); | ||
| } | ||
| //noinspection BusyWait | ||
| Thread.sleep(interval.toMillis()); | ||
| interval = interval.compareTo(MAX_POLL_INTERVAL) >= 0 ? interval : interval.multipliedBy(2); | ||
| } | ||
| throw new ConnectionTimeout(timeout, lastError); | ||
| } | ||
|
|
||
| private HttpURLConnection connectToUrl(URL url) throws IOException { | ||
| var connection = (HttpURLConnection) url.openConnection(); | ||
| connection.setConnectTimeout((int) CONNECT_TIMEOUT.toMillis()); | ||
| connection.setReadTimeout((int) READ_TIMEOUT.toMillis()); | ||
| connection.connect(); | ||
| return connection; | ||
| } | ||
|
|
||
| private boolean checkResponse(HttpURLConnection connection) throws IOException { | ||
| var responseCode = connection.getResponseCode(); | ||
| if (responseCode == HttpURLConnection.HTTP_OK) { | ||
| return true; | ||
| } | ||
| var is = responseCode < HttpURLConnection.HTTP_BAD_REQUEST | ||
| ? connection.getInputStream() | ||
| : connection.getErrorStream(); | ||
| throw new ConnectionError(connection.getURL(), responseCode, is); | ||
| } | ||
|
|
||
| @Getter | ||
| public static class ConnectionError extends RuntimeException { | ||
| private static final int MAX_PAYLOAD_LEN = 1024; | ||
|
|
||
| private final URL statusUrl; | ||
| private final int responseCode; | ||
| private final Optional<String> payload; | ||
|
|
||
| /** | ||
| * Thrown on server connection errors. | ||
| * | ||
| * @param statusUrl Appium server status URL. | ||
| * @param responseCode The response code received from the URL above. | ||
| * @param body The response body stream received from the URL above. | ||
| */ | ||
| public ConnectionError(URL statusUrl, int responseCode, InputStream body) { | ||
| super(ConnectionError.class.getSimpleName()); | ||
| this.statusUrl = statusUrl; | ||
| this.responseCode = responseCode; | ||
| this.payload = readResponseStreamSafely(body); | ||
| } | ||
|
|
||
| private static Optional<String> readResponseStreamSafely(InputStream is) { | ||
| try (var br = new BufferedReader(new InputStreamReader(is))) { | ||
| var result = new LinkedList<String>(); | ||
| String currentLine; | ||
| var payloadSize = 0L; | ||
| while ((currentLine = br.readLine()) != null) { | ||
| result.addFirst(currentLine); | ||
| payloadSize += currentLine.length(); | ||
| while (payloadSize > MAX_PAYLOAD_LEN && result.size() > 1) { | ||
| payloadSize -= result.removeLast().length(); | ||
| } | ||
| } | ||
| var s = abbreviate(result); | ||
| return s.isEmpty() ? Optional.empty() : Optional.of(s); | ||
| } catch (IOException e) { | ||
| return Optional.empty(); | ||
| } | ||
| } | ||
|
|
||
| private static String abbreviate(List<String> filo) { | ||
| var result = String.join("\n", filo).trim(); | ||
| return result.length() > MAX_PAYLOAD_LEN | ||
| ? "…" + result.substring(0, MAX_PAYLOAD_LEN) | ||
| : result; | ||
| } | ||
| } | ||
|
|
||
| @Getter | ||
| public static class ConnectionTimeout extends RuntimeException { | ||
| private final Duration timeout; | ||
|
|
||
| /** | ||
| * Thrown on server timeout errors. | ||
| * | ||
| * @param timeout Timeout value. | ||
| * @param cause Timeout cause. | ||
| */ | ||
| public ConnectionTimeout(Duration timeout, Throwable cause) { | ||
| super(ConnectionTimeout.class.getSimpleName(), cause); | ||
| this.timeout = timeout; | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters