FME proxy support

build.gradle

@@ -19,7 +19,7 @@ apply from: 'spec.gradle'
 apply from: 'jacoco.gradle'
 
 ext {
-    splitVersion = '5.3.2'
+    splitVersion = '5.4.0-rc1'
     jacocoVersion = '0.8.8'
 }
 

src/androidTest/java/fake/HttpResponseMock.java

@@ -1,8 +1,6 @@
 package fake;
 
-import java.io.PipedInputStream;
-import java.io.PipedOutputStream;
-import java.util.concurrent.BlockingQueue;
+import java.security.cert.Certificate;
 
 import io.split.android.client.network.BaseHttpResponseImpl;
 import io.split.android.client.network.HttpResponse;
@@ -25,4 +23,9 @@ public HttpResponseMock(int status, String data) {
     public String getData() {
         return data;
     }
+
+    @Override
+    public Certificate[] getServerCertificates() {
+        return new Certificate[0];
+    }
 }

src/androidTest/java/fake/HttpResponseStub.java

@@ -1,5 +1,7 @@
 package fake;
 
+import java.security.cert.Certificate;
+
 import io.split.android.client.network.BaseHttpResponseImpl;
 import io.split.android.client.network.HttpResponse;
 
@@ -29,4 +31,9 @@ public boolean isSuccess() {
     public String getData() {
         return data;
     }
+
+    @Override
+    public Certificate[] getServerCertificates() {
+        return new Certificate[0];
+    }
 }

src/androidTest/java/helper/TestableSplitConfigBuilder.java

@@ -9,6 +9,7 @@
 import io.split.android.client.impressions.ImpressionListener;
 import io.split.android.client.network.CertificatePinningConfiguration;
 import io.split.android.client.network.DevelopmentSslConfig;
+import io.split.android.client.network.ProxyConfiguration;
 import io.split.android.client.network.SplitAuthenticator;
 import io.split.android.client.service.ServiceConstants;
 import io.split.android.client.service.impressions.ImpressionsMode;
@@ -66,6 +67,7 @@ public class TestableSplitConfigBuilder {
     private CertificatePinningConfiguration mCertificatePinningConfiguration;
     private long mImpressionsDedupeTimeInterval = ServiceConstants.DEFAULT_IMPRESSIONS_DEDUPE_TIME_INTERVAL;
     private RolloutCacheConfiguration mRolloutCacheConfiguration = RolloutCacheConfiguration.builder().build();
+    private ProxyConfiguration mProxyConfiguration = null;
 
     public TestableSplitConfigBuilder() {
         mServiceEndpoints = ServiceEndpoints.builder().build();
@@ -281,6 +283,11 @@ public TestableSplitConfigBuilder rolloutCacheConfiguration(RolloutCacheConfigur
         return this;
     }
 
+    public TestableSplitConfigBuilder logger(ProxyConfiguration proxyConfiguration) {
+        this.mProxyConfiguration = proxyConfiguration;
+        return this;
+    }
+
     public SplitClientConfig build() {
         Constructor constructor = SplitClientConfig.class.getDeclaredConstructors()[0];
         constructor.setAccessible(true);
@@ -337,7 +344,8 @@ public SplitClientConfig build() {
                     mObserverCacheExpirationPeriod,
                     mCertificatePinningConfiguration,
                     mImpressionsDedupeTimeInterval,
-                    mRolloutCacheConfiguration);
+                    mRolloutCacheConfiguration,
+                    mProxyConfiguration);
 
             Logger.instance().setLevel(mLogLevel);
             return config;

src/androidTest/java/tests/storage/GeneralInfoStorageTest.java

@@ -21,7 +21,7 @@ public class GeneralInfoStorageTest {
     @Before
     public void setUp() {
         mDb = DatabaseHelper.getTestDatabase(InstrumentationRegistry.getInstrumentation().getContext());
-        mGeneralInfoStorage = new GeneralInfoStorageImpl(mDb.generalInfoDao());
+        mGeneralInfoStorage = new GeneralInfoStorageImpl(mDb.generalInfoDao(), null);
     }
 
     @After

src/androidTest/java/tests/workmanager/WorkManagerWrapperTest.java

@@ -295,6 +295,7 @@ private Data buildInputData(Data customData) {
         dataBuilder.putString("databaseName", "test_database_name");
         dataBuilder.putString("apiKey", "api_key");
         dataBuilder.putBoolean("encryptionEnabled", false);
+        dataBuilder.putBoolean("usesProxy", false);
         if (customData != null) {
             dataBuilder.putAll(customData);
         }

src/main/java/io/split/android/client/SplitClientConfig.java

@@ -4,6 +4,7 @@
 import static io.split.android.client.utils.Utils.checkNotNull;
 
 import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
 
 import java.net.URI;
 import java.util.concurrent.TimeUnit;
@@ -17,6 +18,7 @@
 import io.split.android.client.network.CertificatePinningConfiguration;
 import io.split.android.client.network.DevelopmentSslConfig;
 import io.split.android.client.network.HttpProxy;
+import io.split.android.client.network.ProxyConfiguration;
 import io.split.android.client.network.SplitAuthenticator;
 import io.split.android.client.service.ServiceConstants;
 import io.split.android.client.service.impressions.ImpressionsMode;
@@ -132,6 +134,8 @@ public class SplitClientConfig {
     private final long mImpressionsDedupeTimeInterval;
     @NonNull
     private final RolloutCacheConfiguration mRolloutCacheConfiguration;
+    @Nullable
+    private final ProxyConfiguration mProxyConfiguration;
 
     public static Builder builder() {
         return new Builder();
@@ -187,7 +191,8 @@ private SplitClientConfig(String endpoint,
                               long observerCacheExpirationPeriod,
                               CertificatePinningConfiguration certificatePinningConfiguration,
                               long impressionsDedupeTimeInterval,
-                              RolloutCacheConfiguration rolloutCacheConfiguration) {
+                              @NonNull RolloutCacheConfiguration rolloutCacheConfiguration,
+                              @Nullable ProxyConfiguration proxyConfiguration) {
         mEndpoint = endpoint;
         mEventsEndpoint = eventsEndpoint;
         mTelemetryEndpoint = telemetryEndpoint;
@@ -246,6 +251,7 @@ private SplitClientConfig(String endpoint,
         mCertificatePinningConfiguration = certificatePinningConfiguration;
         mImpressionsDedupeTimeInterval = impressionsDedupeTimeInterval;
         mRolloutCacheConfiguration = rolloutCacheConfiguration;
+        mProxyConfiguration = proxyConfiguration;
     }
 
     public String trafficType() {
@@ -436,7 +442,9 @@ public boolean persistentAttributesEnabled() {
         return mIsPersistentAttributesEnabled;
     }
 
-    public int offlineRefreshRate() { return mOfflineRefreshRate; }
+    public int offlineRefreshRate() {
+        return mOfflineRefreshRate;
+    }
 
     public boolean shouldRecordTelemetry() {
         return mShouldRecordTelemetry;
@@ -446,7 +454,9 @@ public long telemetryRefreshRate() {
         return mTelemetryRefreshRate;
     }
 
-    public boolean syncEnabled() { return mSyncEnabled; }
+    public boolean syncEnabled() {
+        return mSyncEnabled;
+    }
 
     public int mtkPerPush() {
         return mMtkPerPush;
@@ -476,7 +486,9 @@ public int sseDisconnectionDelay() {
         return mSSEDisconnectionDelayInSecs;
     }
 
-    private void enableTelemetry() { mShouldRecordTelemetry = true; }
+    private void enableTelemetry() {
+        mShouldRecordTelemetry = true;
+    }
 
     public long observerCacheExpirationPeriod() {
         return Math.max(mImpressionsDedupeTimeInterval, mObserverCacheExpirationPeriod);
@@ -572,6 +584,8 @@ public static final class Builder {
 
         private RolloutCacheConfiguration mRolloutCacheConfiguration = RolloutCacheConfiguration.builder().build();
 
+        private ProxyConfiguration mProxyConfiguration = null;
+
         public Builder() {
             mServiceEndpoints = ServiceEndpoints.builder().build();
         }
@@ -806,7 +820,9 @@ public Builder ready(int milliseconds) {
          *
          * @param proxyHost proxy URI
          * @return this builder
+         * @deprecated use {@link #proxyConfiguration(ProxyConfiguration)}
          */
+        @Deprecated
         public Builder proxyHost(String proxyHost) {
             if (proxyHost != null && proxyHost.endsWith("/")) {
                 mProxyHost = proxyHost.substring(0, proxyHost.length() - 1);
@@ -823,6 +839,7 @@ public Builder proxyHost(String proxyHost) {
          * @param proxyAuthenticator
          * @return this builder
          */
+        @Deprecated
         public Builder proxyAuthenticator(SplitAuthenticator proxyAuthenticator) {
             mProxyAuthenticator = proxyAuthenticator;
             return this;
@@ -1030,6 +1047,7 @@ public Builder offlineRefreshRate(int offlineRefreshRate) {
          * <p>
          * This is an ADVANCED parameter
          * </p>
+         *
          * @param telemetryRefreshRate Rate in seconds for telemetry refresh.
          * @return This builder
          * @default 3600 seconds
@@ -1101,10 +1119,9 @@ public Builder certificatePinningConfiguration(CertificatePinningConfiguration c
         /**
          * This configuration is used to control the size of the impressions deduplication window.
          *
+         * @param impressionsDedupeTimeInterval The time interval in milliseconds.
          * @Experimental This method is experimental and may change or be removed in future versions.
          * To be used upon Split team recommendation.
-         *
-         * @param impressionsDedupeTimeInterval The time interval in milliseconds.
          */
         @Deprecated
         public Builder impressionsDedupeTimeInterval(long impressionsDedupeTimeInterval) {
@@ -1128,6 +1145,17 @@ public Builder rolloutCacheConfiguration(@NonNull RolloutCacheConfiguration roll
             return this;
         }
 
+        /**
+         * Sets the proxy configuration
+         *
+         * @param proxyConfiguration
+         * @return this builder
+         */
+        public Builder proxyConfiguration(ProxyConfiguration proxyConfiguration) {
+            mProxyConfiguration = proxyConfiguration;
+            return this;
+        }
+
         public SplitClientConfig build() {
             Logger.instance().setLevel(mLogLevel);
 
@@ -1207,7 +1235,7 @@ public SplitClientConfig build() {
                 mImpressionsDedupeTimeInterval = ServiceConstants.DEFAULT_IMPRESSIONS_DEDUPE_TIME_INTERVAL;
             }
 
-            HttpProxy proxy = parseProxyHost(mProxyHost);
+            HttpProxy proxy = parseProxyHost(mProxyHost, mProxyConfiguration);
 
             return new SplitClientConfig(
                     mServiceEndpoints.getSdkEndpoint(),
@@ -1260,26 +1288,53 @@ public SplitClientConfig build() {
                     mObserverCacheExpirationPeriod,
                     mCertificatePinningConfiguration,
                     mImpressionsDedupeTimeInterval,
-                    mRolloutCacheConfiguration);
+                    mRolloutCacheConfiguration,
+                    mProxyConfiguration);
+        }
+
+        private HttpProxy parseProxyHost(String proxyUri, ProxyConfiguration proxyConfiguration) {
+            // Use legacy proxy behavior if proxyConfiguration is null
+            if (proxyConfiguration == null) {
+                return legacyProxyBehavior(proxyUri);
+            }
+
+            if (mProxyHost != null || mProxyAuthenticator != null) {
+                Logger.w("Both the deprecated proxy configuration methods (proxyHost, proxyAuthenticator) and the new ProxyConfiguration builder are being used. ProxyConfiguration will take precedence.");
+            }
+
+            // Initialize internal config with null url. This will be verified when building the factory.
+            HttpProxy.Builder builder = HttpProxy.newBuilder(null, -1);
+            if (proxyConfiguration.getUrl() != null) {
+                builder = HttpProxy.newBuilder(proxyConfiguration.getUrl().getHost(), proxyConfiguration.getUrl().getPort())
+                        .mtls(proxyConfiguration.getClientCert(), proxyConfiguration.getClientPk())
+                        .proxyCacert(proxyConfiguration.getCaCert())
+                        .credentialsProvider(proxyConfiguration.getCredentialsProvider());
+            }
+            return builder.build();
         }
 
-        private HttpProxy parseProxyHost(String proxyUri) {
+        @Nullable
+        private HttpProxy legacyProxyBehavior(String proxyUri) {
             if (!Utils.isNullOrEmpty(proxyUri)) {
                 try {
                     String username = null;
                     String password = null;
                     URI uri = URI.create(proxyUri);
                     int port = uri.getPort() != -1 ? uri.getPort() : PROXY_PORT_DEFAULT;
                     String userInfo = uri.getUserInfo();
-                    if(!Utils.isNullOrEmpty(userInfo)) {
+                    if (!Utils.isNullOrEmpty(userInfo)) {
                         String[] userInfoComponents = userInfo.split(":");
-                        if(userInfoComponents.length > 1) {
+                        if (userInfoComponents.length > 1) {
                             username = userInfoComponents[0];
                             password = userInfoComponents[1];
                         }
                     }
                     String host = String.format("%s%s", uri.getHost(), uri.getPath());
-                    return new HttpProxy(host, port, username, password);
+                    if (username != null && password != null) {
+                        return HttpProxy.newBuilder(host, port).basicAuth(username, password).buildLegacy();
+                    } else {
+                        return HttpProxy.newBuilder(host, port).buildLegacy();
+                    }
                 } catch (IllegalArgumentException e) {
                     Logger.e("Proxy URI not valid: " + e.getLocalizedMessage());
                     throw new IllegalArgumentException();

src/main/java/io/split/android/client/SplitFactoryBuilder.java

@@ -67,6 +67,9 @@ public static synchronized SplitFactory build(@NonNull String sdkKey, @NonNull K
                 return new SplitFactoryImpl(sdkKey, key, config, context);
             }
         } catch (Exception ex) {
+            if (ex instanceof SplitInstantiationException) {
+                throw (SplitInstantiationException) ex;
+            }
             throw new SplitInstantiationException("Could not instantiate SplitFactory", ex);
         }
     }
@@ -97,5 +100,9 @@ private static void checkPreconditions(@NonNull String sdkKey, @NonNull Key key,
         if (context == null) {
             throw new SplitInstantiationException("Could not instantiate SplitFactory. Context cannot be null");
         }
+
+        if (config.proxy() != null && config.proxy().getHost() == null) {
+            throw new SplitInstantiationException("Could not instantiate SplitFactory. When configured, proxy host cannot be null");
+        }
     }
 }

src/main/java/io/split/android/client/SplitFactoryHelper.java

@@ -49,7 +49,6 @@
 import io.split.android.client.service.sseclient.notifications.MySegmentsV2PayloadDecoder;
 import io.split.android.client.service.sseclient.notifications.NotificationParser;
 import io.split.android.client.service.sseclient.notifications.NotificationProcessor;
-import io.split.android.client.service.sseclient.notifications.SplitsChangeNotification;
 import io.split.android.client.service.sseclient.notifications.mysegments.MembershipsNotificationProcessorFactory;
 import io.split.android.client.service.sseclient.notifications.mysegments.MembershipsNotificationProcessorFactoryImpl;
 import io.split.android.client.service.sseclient.reactor.MySegmentsUpdateWorkerRegistry;
@@ -94,6 +93,7 @@
 import io.split.android.client.telemetry.TelemetrySynchronizerStub;
 import io.split.android.client.telemetry.storage.TelemetryRuntimeProducer;
 import io.split.android.client.telemetry.storage.TelemetryStorage;
+import io.split.android.client.utils.HttpProxySerializer;
 import io.split.android.client.utils.Utils;
 import io.split.android.client.utils.logger.Logger;
 
@@ -165,14 +165,15 @@ SplitStorageContainer buildStorageContainer(UserConsent userConsentStatus,
                                                 TelemetryStorage telemetryStorage,
                                                 long observerCacheExpirationPeriod,
                                                 ScheduledThreadPoolExecutor impressionsObserverExecutor,
-                                                SplitsStorage splitsStorage) {
+                                                SplitsStorage splitsStorage,
+                                                SplitCipher alwaysEncryptedSplitCipher) {
 
         boolean isPersistenceEnabled = userConsentStatus == UserConsent.GRANTED;
         PersistentEventsStorage persistentEventsStorage =
                 StorageFactory.getPersistentEventsStorage(splitRoomDatabase, splitCipher);
         PersistentImpressionsStorage persistentImpressionsStorage =
                 StorageFactory.getPersistentImpressionsStorage(splitRoomDatabase, splitCipher);
-        GeneralInfoStorage generalInfoStorage = StorageFactory.getGeneralInfoStorage(splitRoomDatabase);
+        GeneralInfoStorage generalInfoStorage = StorageFactory.getGeneralInfoStorage(splitRoomDatabase, alwaysEncryptedSplitCipher);
         return new SplitStorageContainer(
                 splitsStorage,
                 StorageFactory.getMySegmentsStorage(splitRoomDatabase, splitCipher),
@@ -228,6 +229,29 @@ WorkManagerWrapper buildWorkManagerWrapper(Context context, SplitClientConfig sp
 
     }
 
+    static void setupProxyForBackgroundSync(@NonNull SplitClientConfig config, Runnable proxyConfigSaveTask) {
+        if (config.proxy() != null && !config.proxy().isLegacy() && config.synchronizeInBackground()) {
+            // Store proxy config for background sync usage
+            new Thread(proxyConfigSaveTask).start();
+        }
+    }
+
+    // Visible to inject for testing
+    @NonNull
+    static Runnable getProxyConfigSaveTask(@NonNull SplitClientConfig config, WorkManagerWrapper workManagerWrapper, GeneralInfoStorage generalInfoStorage) {
+        return new Runnable() {
+            @Override
+            public void run() {
+                try {
+                    generalInfoStorage.setProxyConfig(HttpProxySerializer.serialize(config.proxy()));
+                } catch (Exception ex) {
+                    Logger.w("Failed to store proxy config for background sync. Disabling background sync", ex);
+                    workManagerWrapper.removeWork();
+                }
+            }
+        };
+    }
+
     SyncManager buildSyncManager(SplitClientConfig config,
                                  SplitTaskExecutor splitTaskExecutor,
                                  Synchronizer synchronizer,