Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Rollback of commit 7f8e045.
*** Reason for rollback ***

Breaks Bazel tests: http://ci.bazel.io/job/bazel-tests/331/#showFailuresLink

*** Original change description ***

Improve reliability/performance of Bazel downloads

1. We now retry on connection failures.
  a. With exponential backoff.
  b. While recovering quickly from ephemeral failures.
  c. While still working if internet or web server is slow.
2. We now request gzip responses from web server.

Fixed #1760
Fixed #1910

RELNOTES: External downloads now retry with exponential backoff and support gzip content-encoding.

--
MOS_MIGRATED_REVID=139899835
  • Loading branch information
dslomov committed Nov 22, 2016
1 parent bc3f264 commit 2a26c3c
Show file tree
Hide file tree
Showing 10 changed files with 397 additions and 197 deletions.
@@ -0,0 +1,238 @@
// Copyright 2016 The Bazel Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// 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 com.google.devtools.build.lib.bazel.repository.downloader;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Optional;
import com.google.common.io.ByteStreams;
import com.google.common.net.MediaType;
import java.io.Closeable;
import java.io.IOException;
import java.io.InputStream;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.Proxy;
import java.net.SocketTimeoutException;
import java.net.URL;
import java.net.URLConnection;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.util.Map;

/**
* Represents a connection over HTTP.
*/
class HttpConnection implements Closeable {
private static final int MAX_REDIRECTS = 20;
private static final int TIMEOUT_MS = 60000;
private final InputStream inputStream;
private final int contentLength;

private HttpConnection(InputStream inputStream, int contentLength) {
this.inputStream = inputStream;
this.contentLength = contentLength;
}

public InputStream getInputStream() {
return inputStream;
}

/**
* @return The length of the response, or -1 if unknown.
*/
int getContentLength() {
return contentLength;
}

@Override
public void close() throws IOException {
inputStream.close();
}

private static int parseContentLength(HttpURLConnection connection) {
String length;
try {
length = connection.getHeaderField("Content-Length");
if (length == null) {
return -1;
}
return Integer.parseInt(length);
} catch (NumberFormatException e) {
return -1;
}
}

/**
* Connects to the given URL. Should not leave any connections open if anything goes wrong.
*/
static HttpConnection createAndConnect(URL url, Map<String, String> clientEnv)
throws IOException {
Proxy proxy = ProxyHelper.createProxyIfNeeded(url.toString(), clientEnv);
for (int i = 0; i < MAX_REDIRECTS; ++i) {
URLConnection urlConnection = url.openConnection(proxy);
if (!(urlConnection instanceof HttpURLConnection)) {
return createFileConnection(urlConnection);
}

HttpURLConnection connection = (HttpURLConnection) urlConnection;
int statusCode;
try {
statusCode = createAndConnectViaHttp(connection);
} catch (IOException e) {
connection.disconnect();
throw e;
}

switch (statusCode) {
case HttpURLConnection.HTTP_OK:
try {
return new HttpConnection(connection.getInputStream(), parseContentLength(connection));
} catch (IOException e) {
connection.disconnect();
throw e;
}
case HttpURLConnection.HTTP_MOVED_PERM:
case HttpURLConnection.HTTP_MOVED_TEMP:
// Try again with the new URL. This is the only case that doesn't return/throw.
url = tryGetLocation(statusCode, connection);
connection.disconnect();
break;
case -1:
throw new IOException("An HTTP error occurred");
default:
throw new IOException(
String.format(
"%s %s: %s",
connection.getResponseCode(),
connection.getResponseMessage(),
readBody(connection)));
}
}
throw new IOException("Maximum redirects (" + MAX_REDIRECTS + ") exceeded");
}

// For file:// URLs.
private static HttpConnection createFileConnection(URLConnection connection)
throws IOException {
int contentLength = connection.getContentLength();
// check for empty file. -1 is a valid contentLength, meaning the size of unknown. It's a
// common return value for an FTP download request for example. Local files will always
// have a valid contentLength value.
if (contentLength == 0) {
throw new IOException("Attempted to download an empty file");
}

return new HttpConnection(connection.getInputStream(), contentLength);
}

private static int createAndConnectViaHttp(HttpURLConnection connection) throws IOException {
connection.setConnectTimeout(TIMEOUT_MS);
connection.setReadTimeout(TIMEOUT_MS);
try {
connection.connect();
} catch (SocketTimeoutException e) {
throw new IOException(
"Timed out connecting to " + connection.getURL() + " : " + e.getMessage(), e);
} catch (IllegalArgumentException | IOException e) {
throw new IOException(
"Failed to connect to " + connection.getURL() + " : " + e.getMessage(), e);
}
return connection.getResponseCode();
}

private static URL tryGetLocation(int statusCode, HttpURLConnection connection)
throws IOException {
String newLocation = connection.getHeaderField("Location");
if (newLocation == null) {
throw new IOException(
"Remote returned " + statusCode + " but did not return location header.");
}

URL newUrl;
try {
newUrl = new URL(newLocation);
} catch (MalformedURLException e) {
throw new IOException("Remote returned invalid location header: " + newLocation);
}

String newProtocol = newUrl.getProtocol();
if (!("http".equals(newProtocol) || "https".equals(newProtocol))) {
throw new IOException(
"Remote returned invalid location header: " + newLocation);
}

return newUrl;
}

/**
* Attempts to detect the encoding the HTTP reponse is using.
*
* <p>This attempts to read the Content-Encoding header, then the Content-Type header,
* then just falls back to UTF-8.</p>
*
* @throws IOException If something goes wrong (the encoding isn't parsable or is, but isn't
* supported by the system).
*/
@VisibleForTesting
static Charset getEncoding(HttpURLConnection connection) throws IOException {
String encoding = connection.getContentEncoding();
if (encoding != null) {
if (Charset.availableCharsets().containsKey(encoding)) {
try {
return Charset.forName(encoding);
} catch (IllegalArgumentException | UnsupportedOperationException e) {
throw new IOException(
"Got invalid encoding from " + connection.getURL() + ": " + encoding);
}
} else {
throw new IOException(
"Got unavailable encoding from " + connection.getURL() + ": " + encoding);
}
}
encoding = connection.getContentType();
if (encoding == null) {
return StandardCharsets.UTF_8;
}
try {
MediaType mediaType = MediaType.parse(encoding);
if (mediaType == null) {
return StandardCharsets.UTF_8;
}
Optional<Charset> charset = mediaType.charset();
if (charset.isPresent()) {
return charset.get();
}
} catch (IllegalArgumentException | IllegalStateException e) {
throw new IOException(
"Got invalid encoding from " + connection.getURL() + ": " + encoding);
}
return StandardCharsets.UTF_8;
}

private static String readBody(HttpURLConnection connection) throws IOException {
InputStream errorStream = connection.getErrorStream();
Charset encoding = getEncoding(connection);
if (errorStream != null) {
return new String(ByteStreams.toByteArray(errorStream), encoding);
}

InputStream responseStream = connection.getInputStream();
if (responseStream != null) {
return new String(ByteStreams.toByteArray(responseStream), encoding);
}

return null;
}
}
Expand Up @@ -31,7 +31,6 @@
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.Proxy;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
Expand Down Expand Up @@ -83,7 +82,10 @@ public Path download(
try {
return download(url, sha256, type, outputDirectory, eventHandler, clientEnv);
} catch (IOException e) {
throw new RepositoryFunctionException(e, SkyFunctionException.Transience.TRANSIENT);
throw new RepositoryFunctionException(
new IOException(
"Error downloading from " + url + " to " + outputDirectory + ": " + e.getMessage()),
SkyFunctionException.Transience.TRANSIENT);
}
}

Expand Down Expand Up @@ -128,10 +130,10 @@ public Path download(
AtomicInteger totalBytes = new AtomicInteger(0);
final ScheduledFuture<?> loggerHandle = getLoggerHandle(totalBytes, eventHandler, urlString);
final URL url = new URL(urlString);
Proxy proxy = ProxyHelper.createProxyIfNeeded(url.toString(), clientEnv);

try (OutputStream out = destination.getOutputStream();
InputStream inputStream = HttpConnector.connect(url, proxy, eventHandler)) {
HttpConnection connection = HttpConnection.createAndConnect(url, clientEnv)) {
InputStream inputStream = connection.getInputStream();
int read;
byte[] buf = new byte[BUFFER_SIZE];
while ((read = inputStream.read(buf)) > 0) {
Expand All @@ -141,6 +143,11 @@ public Path download(
throw new InterruptedException("Download interrupted");
}
}
if (connection.getContentLength() != -1
&& totalBytes.get() != connection.getContentLength()) {
throw new IOException("Expected " + formatSize(connection.getContentLength()) + ", got "
+ formatSize(totalBytes.get()));
}
} catch (IOException e) {
throw new IOException(
"Error downloading " + url + " to " + destination + ": " + e.getMessage());
Expand Down
Expand Up @@ -38,9 +38,8 @@ public RuleClass build(Builder builder, RuleDefinitionEnvironment environment) {
/* <!-- #BLAZE_RULE(http_archive).ATTRIBUTE(url) -->
A URL referencing an archive file containing a Bazel repository.
<p>This must be a file, http, or https URL. Archives of the following types are allowed:
`"zip"`, `"jar"`, `"war"`, `"tar.gz"`, `"tgz"`, `"tar.xz"`, and `tar.bz2`. Redirects
are followed. There is no support for authentication.</p>
<p>Archives of type .zip, .jar, .war, .tar.gz or .tgz are supported. There is no support
for authentication. Redirections are followed, but not from HTTP to HTTPS.</p>
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(attr("url", STRING).mandatory())
/* <!-- #BLAZE_RULE(http_archive).ATTRIBUTE(sha256) -->
Expand Down
Expand Up @@ -39,8 +39,8 @@ public RuleClass build(Builder builder, RuleDefinitionEnvironment environment) {
/* <!-- #BLAZE_RULE(http_file).ATTRIBUTE(url) -->
A URL to a file that will be made available to Bazel.
<p>This must be a file, http or https URL. Redirects are followed. Authentication is not
supported.</p>
<p>This must be an http or https URL. Authentication is not support.
Redirections are followed, but not from HTTP to HTTPS.</p>
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(attr("url", STRING).mandatory())
/* <!-- #BLAZE_RULE(http_file).ATTRIBUTE(sha256) -->
Expand Down
Expand Up @@ -38,8 +38,8 @@ public RuleClass build(Builder builder, RuleDefinitionEnvironment environment) {
/* <!-- #BLAZE_RULE(http_jar).ATTRIBUTE(url) -->
A URL to an archive file containing a Bazel repository.
<p>This must be a file, http or https URL that ends with .jar. Redirections are
followed. There is no support for authentication.</p>
<p>This must be an http or https URL that ends with .jar. Redirections are followed, but
not from HTTP to HTTPS.</p>
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(attr("url", STRING).mandatory())
/* <!-- #BLAZE_RULE(http_jar).ATTRIBUTE(sha256) -->
Expand Down
Expand Up @@ -35,9 +35,8 @@ public RuleClass build(RuleClass.Builder builder, RuleDefinitionEnvironment envi
/* <!-- #BLAZE_RULE(new_http_archive).ATTRIBUTE(url) -->
A URL referencing an archive file containing a Bazel repository.
<p>This must be a file, http, or https URL. Archives of the following types are allowed:
`"zip"`, `"jar"`, `"war"`, `"tar.gz"`, `"tgz"`, `"tar.xz"`, and `tar.bz2`. Redirects
are followed. There is no support for authentication.</p>
<p>Archives of type .zip, .jar, .war, .tar.gz or .tgz are supported. There is no support
for authentication. Redirections are followed, but not from HTTP to HTTPS.</p>
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(attr("url", STRING).mandatory())
/* <!-- #BLAZE_RULE(new_http_archive).ATTRIBUTE(sha256) -->
Expand Down
Expand Up @@ -5,11 +5,11 @@ filegroup(
)

java_test(
name = "DownloaderTestSuite",
name = "DownloaderTests",
srcs = glob(["*.java"]),
tags = ["rules"],
test_class = "com.google.devtools.build.lib.AllTests",
deps = [
"//src/main/java/com/google/devtools/build/lib:events",
"//src/main/java/com/google/devtools/build/lib/bazel/repository/downloader",
"//src/test/java/com/google/devtools/build/lib:foundations_testutil",
"//src/test/java/com/google/devtools/build/lib:test_runner",
Expand Down

This file was deleted.

0 comments on commit 2a26c3c

Please sign in to comment.