-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[FSSDK-10501] forward exceptions for ODP fetch segments (#483)
Forward exceptions for ODP fetch segments to support debugging in the application.
- Loading branch information
Showing
4 changed files
with
212 additions
and
22 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
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
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
189 changes: 189 additions & 0 deletions
189
shared/src/main/java/com/optimizely/ab/android/shared/ClientForODPOnly.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,189 @@ | ||
| /**************************************************************************** | ||
| * Copyright 2016-2017,2021, Optimizely, Inc. and contributors * | ||
| * * | ||
| * 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.optimizely.ab.android.shared; | ||
|
|
||
| import android.os.Build; | ||
|
|
||
| import androidx.annotation.NonNull; | ||
| import androidx.annotation.Nullable; | ||
|
|
||
| import org.slf4j.Logger; | ||
|
|
||
| import java.io.BufferedInputStream; | ||
| import java.io.InputStream; | ||
| import java.net.HttpURLConnection; | ||
| import java.net.URL; | ||
| import java.net.URLConnection; | ||
| import java.util.Scanner; | ||
| import java.util.concurrent.TimeUnit; | ||
|
|
||
| import javax.net.ssl.HttpsURLConnection; | ||
| import javax.net.ssl.SSLContext; | ||
| import javax.net.ssl.SSLSocketFactory; | ||
|
|
||
| /** | ||
| * Functionality common to all clients using http connections | ||
| */ | ||
| public class ClientForODPOnly { | ||
|
|
||
| static final int MAX_BACKOFF_TIMEOUT = (int) Math.pow(2, 5); | ||
|
|
||
| @NonNull private final OptlyStorage optlyStorage; | ||
| @NonNull private final Logger logger; | ||
|
|
||
| /** | ||
| * Constructs a new Client instance | ||
| * | ||
| * @param optlyStorage an instance of {@link OptlyStorage} | ||
| * @param logger an instance of {@link Logger} | ||
| */ | ||
| public ClientForODPOnly(@NonNull OptlyStorage optlyStorage, @NonNull Logger logger) { | ||
| this.optlyStorage = optlyStorage; | ||
| this.logger = logger; | ||
| } | ||
|
|
||
| /** | ||
| * Opens {@link HttpURLConnection} from a {@link URL} | ||
| * | ||
| * @param url a {@link URL} instance | ||
| * @return an open {@link HttpURLConnection} | ||
| */ | ||
| @Nullable | ||
| public HttpURLConnection openConnection(URL url) { | ||
| try { | ||
| // API 21 (LOLLIPOP)+ supposed to use TLS1.2 as default, but some API-21 devices still fail, so include it here. | ||
| if (Build.VERSION.SDK_INT <= Build.VERSION_CODES.LOLLIPOP) { | ||
| SSLContext sslContext = SSLContext.getInstance("TLSv1.2"); | ||
| sslContext.init(null, null, null); | ||
| SSLSocketFactory sslSocketFactory = new TLSSocketFactory(); | ||
| HttpsURLConnection.setDefaultSSLSocketFactory(sslSocketFactory); | ||
| } | ||
|
|
||
| return (HttpURLConnection) url.openConnection(); | ||
| } catch (Exception e) { | ||
| logger.warn("Error making request to {}.", url); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| /** | ||
| * Adds a if-modified-since header to the open {@link URLConnection} if this value is | ||
| * stored in {@link OptlyStorage}. | ||
| * @param urlConnection an open {@link URLConnection} | ||
| */ | ||
| public void setIfModifiedSince(@NonNull URLConnection urlConnection) { | ||
| if (urlConnection == null || urlConnection.getURL() == null) { | ||
| logger.error("Invalid connection"); | ||
| return; | ||
| } | ||
|
|
||
| long lastModified = optlyStorage.getLong(urlConnection.getURL().toString(), 0); | ||
| if (lastModified > 0) { | ||
| urlConnection.setIfModifiedSince(lastModified); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Retrieves the last-modified head from a {@link URLConnection} and saves it | ||
| * in {@link OptlyStorage}. | ||
| * @param urlConnection a {@link URLConnection} instance | ||
| */ | ||
| public void saveLastModified(@NonNull URLConnection urlConnection) { | ||
| if (urlConnection == null || urlConnection.getURL() == null) { | ||
| logger.error("Invalid connection"); | ||
| return; | ||
| } | ||
|
|
||
| long lastModified = urlConnection.getLastModified(); | ||
| if (lastModified > 0) { | ||
| optlyStorage.saveLong(urlConnection.getURL().toString(), urlConnection.getLastModified()); | ||
| } else { | ||
| logger.warn("CDN response didn't have a last modified header"); | ||
| } | ||
| } | ||
|
|
||
| @Nullable | ||
| public String readStream(@NonNull URLConnection urlConnection) { | ||
| Scanner scanner = null; | ||
| try { | ||
| InputStream in = new BufferedInputStream(urlConnection.getInputStream()); | ||
| scanner = new Scanner(in).useDelimiter("\\A"); | ||
| return scanner.hasNext() ? scanner.next() : ""; | ||
| } catch (Exception e) { | ||
| logger.warn("Error reading urlConnection stream.", e); | ||
| return null; | ||
| } | ||
| finally { | ||
| if (scanner != null) { | ||
| // We assume that closing the scanner will close the associated input stream. | ||
| try { | ||
| scanner.close(); | ||
| } | ||
| catch (Exception e) { | ||
| logger.error("Problem with closing the scanner on a input stream" , e); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Executes a request with exponential backoff | ||
| * @param request the request executable, would be a lambda on Java 8 | ||
| * @param timeout the numerical base for the exponential backoff | ||
| * @param power the number of retries | ||
| * @param <T> the response type of the request | ||
| * @return the response | ||
| */ | ||
| public <T> T execute(Request<T> request, int timeout, int power) { | ||
| int baseTimeout = timeout; | ||
| int maxTimeout = (int) Math.pow(baseTimeout, power); | ||
| T response = null; | ||
| while(timeout <= maxTimeout) { | ||
| try { | ||
| response = request.execute(); | ||
| } catch (Exception e) { | ||
| logger.error("(ClientForODPOnly) Request failed with error: ", e); | ||
| throw e; | ||
| } | ||
|
|
||
| if (response == null || response == Boolean.FALSE) { | ||
| // retry is disabled when timeout set to 0 | ||
| if (timeout == 0) break; | ||
|
|
||
| try { | ||
| logger.info("Request failed, waiting {} seconds to try again", timeout); | ||
| Thread.sleep(TimeUnit.MILLISECONDS.convert(timeout, TimeUnit.SECONDS)); | ||
| } catch (InterruptedException e) { | ||
| logger.warn("Exponential backoff failed", e); | ||
| break; | ||
| } | ||
| timeout = timeout * baseTimeout; | ||
| } else { | ||
| break; | ||
| } | ||
| } | ||
| return response; | ||
| } | ||
|
|
||
| /** | ||
| * Bundles up a request allowing it's execution to be deferred | ||
| * @param <T> The response type of the request | ||
| */ | ||
| public interface Request<T> { | ||
| T execute(); | ||
| } | ||
| } |