Merge pull request #895 from AzureAD/shahzaibj/mergeRelease2.0.7ToMaster

Merge release 2.0.7 to master

Author: shahzaibj

README.md

@@ -19,3 +19,7 @@ provided by the bot. You will only need to do this once across all repos using o
 This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
 For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
 contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+
+### Android Studio Build Requirement
+Please note that this project uses [Lombok](https://projectlombok.org/) internally and while using Android Studio you will need to install [Lobmok Plugin](https://plugins.jetbrains.com/plugin/6317-lombok) to get the project to build successfully within Android Studio.
+

changelog.txt

@@ -1,3 +1,12 @@
+Version 2.0.7
+------------
+- Added throttling
+- Added Dual Client Stack support for FoCI apps
+- Added support to compress broker payload using GZIP
+- Added flag to enable/disable power optimization check
+- Removed check for usage stat manager to determine if network is disabled
+- Project wide internal code refactoring using Lombok
+
 Version 2.0.6
 ------------
 - Use fixed thread pool for silent requests

common/build.gradle

@@ -84,6 +84,8 @@ dependencies {
     implementation "com.google.code.gson:gson:$rootProject.ext.gsonVersion"
     implementation "androidx.browser:browser:$rootProject.ext.browserVersion"
     implementation "androidx.constraintlayout:constraintlayout:$rootProject.ext.constraintLayoutVersion"
+    compileOnly "org.projectlombok:lombok:$rootProject.ext.lombokVersion"
+    annotationProcessor "org.projectlombok:lombok:$rootProject.ext.lombokVersion"
 
     // Test dependencies
     // Needed to resolve JSONObject inside of non-instrumented tests

common/src/androidTest/java/com/microsoft/identity/common/MsalOAuth2TokenCacheTest.java

@@ -1307,4 +1307,43 @@ public void getAccoutsWithIdTokensEmpty() {
         assertTrue(records.isEmpty());
     }
 
+    @Test
+    public void testFrtFallback() throws ClientException {
+        // This test verifies changes in common/#893
+        // We will fallback on an FRT in the local cache for the current user if one is avail
+        final List<ICacheRecord> result = loadTestBundleIntoCacheWithAggregation(
+                defaultTestBundleV2
+        );
+
+        assertEquals(1, result.size());
+
+        final ICacheRecord entry = result.get(0);
+
+        assertNotNull(entry.getAccount());
+        assertNotNull(entry.getIdToken());
+        assertNotNull(entry.getAccessToken());
+        assertNotNull(entry.getRefreshToken());
+
+        // delete the existing RT and insert our FRT
+        accountCredentialCache.removeCredential(entry.getRefreshToken());
+
+        // Modify the existing RT to change the client_id and set a FoCI affiliation
+        final String fociRtClientId = UUID.randomUUID().toString();
+        final RefreshTokenRecord modifiedRT = entry.getRefreshToken();
+        modifiedRT.setFamilyId("1");
+        modifiedRT.setClientId(fociRtClientId);
+
+        accountCredentialCache.saveCredential(modifiedRT);
+
+        final ICacheRecord secondaryLoad = mOauth2TokenCache.load(
+                entry.getAccessToken().getClientId(),
+                TARGET,
+                entry.getAccount(),
+                BEARER_AUTHENTICATION_SCHEME
+        );
+
+        assertNotNull(secondaryLoad.getRefreshToken());
+        assertEquals(fociRtClientId, secondaryLoad.getRefreshToken().getClientId());
+    }
+
 }

common/src/main/java/com/microsoft/identity/common/adal/internal/AuthenticationConstants.java

@@ -628,7 +628,7 @@ public static final class Broker {
         /**
          * The maximum broker protocol version that common supports.
          */
-        public static final String BROKER_PROTOCOL_VERSION_CODE = "4.0";
+        public static final String BROKER_PROTOCOL_VERSION_CODE = "5.0";
 
         /**
          * The key of maximum broker protocol version that client advertised.
@@ -1070,11 +1070,22 @@ public static final class Broker {
          */
         public static final String BROKER_REQUEST_V2 = "broker_request_v2";
 
+
+        /**
+         * String to send MSAL V2 Request params as gzip compressed byte array.
+         */
+        public static final String BROKER_REQUEST_V2_COMPRESSED = "broker_request_v2_compressed";
+
         /**
          * String to return Msal V2 response.
          */
         public static final String BROKER_RESULT_V2 = "broker_result_v2";
 
+        /**
+         * String to return MSA: V2 response as gzip compressed byte array.
+         */
+        public static final String BROKER_RESULT_V2_COMPRESSED = "broker_result_v2_compressed";
+
         /**
          * Represents the broker device mode boolean (true = shared device mode).
          * This is used to determine what PublicClientApplication MSAL will return to its caller.
@@ -1137,6 +1148,11 @@ public static final class Broker {
          */
         public static final String BROKER_ACCOUNTS = "broker_accounts";
 
+        /**
+         * String to return account list as compressed json.
+         */
+        public static final String BROKER_ACCOUNTS_COMPRESSED = "broker_accounts_compressed";
+
         /**
          * String to return current account from broker (only available in shared device mode)
          */

common/src/main/java/com/microsoft/identity/common/adal/internal/net/DefaultConnectionService.java

@@ -64,7 +64,7 @@ public boolean isConnectionAvailable() {
                 .getSystemService(Context.CONNECTIVITY_SERVICE);
         NetworkInfo activeNetwork = connectivityManager.getActiveNetworkInfo();
         @SuppressWarnings("deprecation")
-        final boolean isConnectionAvailable = activeNetwork != null && activeNetwork.isConnectedOrConnecting() && !isNetworkDisabledFromOptimizations();
+        final boolean isConnectionAvailable = activeNetwork != null && activeNetwork.isConnectedOrConnecting();
         Telemetry.emit((BaseEvent) new BaseEvent().put(TelemetryEventStrings.Key.NETWORK_CONNECTION, String.valueOf(isConnectionAvailable)));
         return isConnectionAvailable;
     }
@@ -78,19 +78,12 @@ public boolean isConnectionAvailable() {
     @TargetApi(Build.VERSION_CODES.M)
     public boolean isNetworkDisabledFromOptimizations() {
         if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
-            final UsageStatsManagerWrapper usageStatsManagerWrapper = UsageStatsManagerWrapper.getInstance();
-            if (usageStatsManagerWrapper.isAppInactive(mConnectionContext)) {
-                Telemetry.emit((BaseEvent) new BaseEvent().put(TelemetryEventStrings.Key.POWER_OPTIMIZATION, String.valueOf(true)));
-                return true;
-            }
-
             final PowerManagerWrapper powerManagerWrapper = PowerManagerWrapper.getInstance();
             if (powerManagerWrapper.isDeviceIdleMode(mConnectionContext) && !powerManagerWrapper.isIgnoringBatteryOptimizations(mConnectionContext)) {
                 Telemetry.emit((BaseEvent) new BaseEvent().put(TelemetryEventStrings.Key.POWER_OPTIMIZATION, String.valueOf(true)));
                 return true;
             }
         }
-
         Telemetry.emit((BaseEvent) new BaseEvent().put(TelemetryEventStrings.Key.POWER_OPTIMIZATION, String.valueOf(false)));
         return false;
     }

common/src/main/java/com/microsoft/identity/common/adal/internal/net/HttpWebRequest.java

@@ -185,24 +185,28 @@ public HttpWebResponse send() throws IOException {
      * when connection is not available to refresh token because power optimization is enabled, or
      * throw with error code {@link ErrorStrings#DEVICE_NETWORK_NOT_AVAILABLE} otherwise.
      *
-     * @param context Context
+     * @param context Context : application context
+     * @param skipPowerOptimizationCheck : boolean to skip power optimization check
+     *
      * @throws ClientException throw network exception
      */
-    public static void throwIfNetworkNotAvailable(final Context context) throws ClientException {
+    public static void throwIfNetworkNotAvailable(final Context context,
+                                                  final boolean skipPowerOptimizationCheck)
+            throws ClientException {
+
         final DefaultConnectionService connectionService = new DefaultConnectionService(context);
+
+        if (skipPowerOptimizationCheck && connectionService.isNetworkDisabledFromOptimizations()) {
+            throw new ClientException(
+                    ErrorStrings.NO_NETWORK_CONNECTION_POWER_OPTIMIZATION,
+                    "Connection is not available to refresh token because power optimization is "
+                            + "enabled. And the device is in doze mode or the app is standby");
+        }
+
         if (!connectionService.isConnectionAvailable()) {
-            if (connectionService.isNetworkDisabledFromOptimizations()) {
-                final ClientException dozeModeException = new ClientException(
-                        ErrorStrings.NO_NETWORK_CONNECTION_POWER_OPTIMIZATION,
-                        "Connection is not available to refresh token because power optimization is "
-                                + "enabled. And the device is in doze mode or the app is standby");
-                throw dozeModeException;
-            } else {
-                final ClientException generalNetworkException = new ClientException(
-                        ErrorStrings.DEVICE_NETWORK_NOT_AVAILABLE,
-                        "Connection is not available to refresh token");
-                throw generalNetworkException;
-            }
+            throw new ClientException(
+                    ErrorStrings.DEVICE_NETWORK_NOT_AVAILABLE,
+                    "Connection is not available to refresh token");
         }
     }
 

common/src/main/java/com/microsoft/identity/common/internal/authscheme/AbstractAuthenticationScheme.java

@@ -26,9 +26,12 @@
 
 import com.google.gson.annotations.SerializedName;
 
+import lombok.EqualsAndHashCode;
+
 /**
  * Abstract base class for AuthenticationSchemes.
  */
+@EqualsAndHashCode
 public abstract class AbstractAuthenticationScheme implements INameable {
 
     private static final long serialVersionUID = -2437270903389813253L;

common/src/main/java/com/microsoft/identity/common/internal/broker/BrokerRequest.java

@@ -57,6 +57,7 @@ private class SerializedNames {
         final static String MULTIPLE_CLOUDS_SUPPORTED = "multiple_clouds_supported";
         final static String AUTHORIZATION_AGENT = "authorization_agent";
         final static String AUTHENTICATION_SCHEME = "authentication_scheme";
+        final static String POWER_OPT_CHECK_ENABLED = "power_opt_check_enabled";
     }
 
     /**
@@ -189,6 +190,10 @@ private class SerializedNames {
     @SerializedName(SerializedNames.AUTHENTICATION_SCHEME)
     private AbstractAuthenticationScheme mAuthenticationScheme;
 
+    @Nullable
+    @SerializedName(SerializedNames.POWER_OPT_CHECK_ENABLED)
+    private boolean mPowerOptCheckEnabled;
+
     private BrokerRequest(BrokerRequest.Builder builder) {
         mAuthority = builder.mAuthority;
         mScope = builder.mScope;
@@ -209,6 +214,7 @@ private BrokerRequest(BrokerRequest.Builder builder) {
         mMultipleCloudsSupported = builder.mMultipleCloudsSupported;
         mAuthorizationAgent = builder.mAuthorizationAgent;
         mAuthenticationScheme = builder.mAuthenticationScheme;
+        mPowerOptCheckEnabled = builder.mPowerOptCheckEnabled;
     }
 
     public String getAuthority() {
@@ -287,6 +293,10 @@ public AbstractAuthenticationScheme getAuthenticationScheme() {
         return mAuthenticationScheme;
     }
 
+    public boolean isPowerOptCheckEnabled(){
+        return mPowerOptCheckEnabled;
+    }
+
     /**
      * Builder class for Broker Request.
      */
@@ -330,6 +340,8 @@ public static class Builder {
 
         private AbstractAuthenticationScheme mAuthenticationScheme;
 
+        private boolean mPowerOptCheckEnabled;
+
         /**
          * Authority for the request
          */
@@ -476,6 +488,11 @@ public BrokerRequest.Builder authenticationScheme(@NonNull final AbstractAuthent
             return this;
         }
 
+        public BrokerRequest.Builder powerOptCheckEnabled(final boolean powerOptCheckEnabled) {
+            this.mPowerOptCheckEnabled = powerOptCheckEnabled;
+            return this;
+        }
+
         /**
          * Builds and returns a BrokerRequest
          */

common/src/main/java/com/microsoft/identity/common/internal/cache/IAccountCredentialCache.java

@@ -76,7 +76,7 @@ public interface IAccountCredentialCache {
      * @param homeAccountId The homeAccountId used to match Account cache keys.
      * @param environment   The environment used to match Account cache keys.
      * @param realm         The realm used to match Account cache keys.
-     * @return A List of Accounts matching the supplied criteria.
+     * @return A mutable List of Accounts matching the supplied criteria.
      */
     List<AccountRecord> getAccountsFilteredBy(
             final String homeAccountId,
@@ -87,7 +87,7 @@ List<AccountRecord> getAccountsFilteredBy(
     /**
      * Returns all of the Credentials saved in the cache.
      *
-     * @return The saved Credentials.
+     * @return A mutable List of saved Credentials.
      */
     List<Credential> getCredentials();
 
@@ -100,7 +100,7 @@ List<AccountRecord> getAccountsFilteredBy(
      * @param clientId       The clientId used to match Credential cache keys.
      * @param realm          The realm used to match Credential cache keys.
      * @param target         The target used to match Credential cache keys.
-     * @return A List of Credentials matching the supplied criteria.
+     * @return A mutable List of Credentials matching the supplied criteria.
      */
     List<Credential> getCredentialsFilteredBy(
             final String homeAccountId,