Merge branch 'dev' into mchand/proguard-rules

Author: Mohit

changelog.txt

@@ -1,6 +1,7 @@
 vNext
 ----------
 - [MAJOR] Update proguard rules in common (#2756)
+- [MINOR] Add query parameter for Android Release OS Version (#2754)
 - [MINOR] Add client scenario to JwtRequestBody (#2755)
 
 Version 22.1.0

common/src/main/java/com/microsoft/identity/common/internal/platform/AndroidDeviceMetadata.java

@@ -73,11 +73,16 @@ public String getCpu() {
 
     @Override
     public @NonNull String getOsForMats() {
-        return android.os.Build.VERSION.RELEASE;
+        return getAndroidReleaseOs();
     }
 
     @Override
     public @NonNull String getOsForDrs() {
+        return getAndroidReleaseOs();
+    }
+
+    @Override
+    public @NonNull String getAndroidReleaseOs() {
         return android.os.Build.VERSION.RELEASE;
     }
 

common4j/src/main/com/microsoft/identity/common/java/platform/Device.java

@@ -214,6 +214,25 @@ public static String getOsForDrs() {
         }
     }
 
+    /**
+     * Get the Android Release OS of this device
+     *
+     * @return a String representing the Android Release OS information
+     */
+    @NonNull
+    @GuardedBy("sLock")
+    public static String getAndroidReleaseOs() {
+        sLock.readLock().lock();
+        try {
+            if (sDeviceMetadata != null) {
+                return sDeviceMetadata.getAndroidReleaseOs();
+            }
+            return NOT_SET;
+        } finally {
+            sLock.readLock().unlock();
+        }
+    }
+
     /**
      * Gets the manufacturer of the current device.
      *

common4j/src/main/com/microsoft/identity/common/java/platform/IDeviceMetadata.java

@@ -66,6 +66,14 @@ public interface IDeviceMetadata {
     @NonNull
     String getOsForMats();
 
+    /**
+     * Get the Android Release OS of this device (i.e 14, 15, 16).
+     *
+     * @return a String representing the Release OS information
+     */
+    @NonNull
+    String getAndroidReleaseOs();
+
     /**
      * Get the model name of this device.
      *

common4j/src/main/com/microsoft/identity/common/java/providers/microsoft/MicrosoftAuthorizationRequest.java

@@ -119,6 +119,12 @@ public abstract class MicrosoftAuthorizationRequest<T extends MicrosoftAuthoriza
     @SerializedName("x-client-OS")
     private final String mDiagnosticOS;
 
+    @Expose()
+    @Getter
+    @Accessors(prefix = "m")
+    @SerializedName("x-client-ReleaseOS")
+    private final String mDiagnosticReleaseOS;
+
     @Expose()
     @Getter
     @Accessors(prefix = "m")
@@ -186,9 +192,11 @@ protected MicrosoftAuthorizationRequest(@SuppressWarnings(WarningType.rawtype_wa
         // If the flight is enabled, set the fields
         if (CommonFlightsManager.INSTANCE.getFlightsProvider().isFlightEnabled(CommonFlight.ENABLE_AM_API_WORKPROFILE_EXTRA_QUERY_PARAMETERS)) {
             mDiagnosticMN = Device.getManufacturer();
+            mDiagnosticReleaseOS = Device.getAndroidReleaseOs();
             mWorkProfileAvailable = Device.isInPersonalProfileButClouddpcWorkProfileAvailable();
         } else {
             mDiagnosticMN = null;
+            mDiagnosticReleaseOS = null;
             mWorkProfileAvailable = null;
         }
     }

common4j/src/test/com/microsoft/identity/common/java/platform/MockDeviceMetadata.java

@@ -31,6 +31,7 @@ public class MockDeviceMetadata extends AbstractDeviceMetadata {
     public static final String TEST_OS_ESTS = "TestOSEsts";
     public static final String TEST_OS_MATS = "TestOSMats";
     public static final String TEST_OS_DRS = "TestOSDrs";
+    public static final String TEST_RELEASE_OS = "TestReleaseOS";
     public static final String TEST_DEVICE_MODEL = "TestDeviceModel";
     public static final String TEST_MANUFACTURER = "TestManufacturer";
 
@@ -57,6 +58,11 @@ public class MockDeviceMetadata extends AbstractDeviceMetadata {
         return TEST_OS_DRS;
     }
 
+    @Override
+    public @NonNull String getAndroidReleaseOs() {
+        return TEST_RELEASE_OS;
+    }
+
     @Override
     public @NonNull String getDeviceModel() {
         return TEST_DEVICE_MODEL;

common4j/src/test/com/microsoft/identity/common/java/providers/microsoft/MicrosoftAuthorizationRequestTest.java

@@ -87,6 +87,7 @@ public void testCreateUriFromAuthorizationRequest() throws MalformedURLException
                             "&x-client-Ver=" + MOCK_LIBRARY_VERSION +
                             "&x-client-SKU=" + MOCK_LIBRARY_NAME +
                             "&x-client-OS=" + MockDeviceMetadata.TEST_OS_ESTS +
+                            "&x-client-ReleaseOS=" + MockDeviceMetadata.TEST_RELEASE_OS +
                             "&x-client-CPU=" + MockDeviceMetadata.TEST_CPU +
                             "&x-client-DM=" + MockDeviceMetadata.TEST_DEVICE_MODEL +
                             "&x-client-MN=" + MockDeviceMetadata.TEST_MANUFACTURER +
@@ -141,6 +142,7 @@ public void testCreateUriFromAuthorizationRequestWithWPAvailable() throws Malfor
                             "&x-client-Ver=" + MOCK_LIBRARY_VERSION +
                             "&x-client-SKU=" + MOCK_LIBRARY_NAME +
                             "&x-client-OS=" + MockDeviceMetadata.TEST_OS_ESTS +
+                            "&x-client-ReleaseOS=" + MockDeviceMetadata.TEST_RELEASE_OS +
                             "&x-client-CPU=" + MockDeviceMetadata.TEST_CPU +
                             "&x-client-DM=" + MockDeviceMetadata.TEST_DEVICE_MODEL +
                             "&x-client-MN=" + MockDeviceMetadata.TEST_MANUFACTURER +

common4j/src/test/com/microsoft/identity/common/java/providers/microsoft/microsoftsts/MicrosoftStsAuthorizationRequestTests.java

@@ -142,6 +142,7 @@ public void testCreateUriFromAuthorizationRequest() throws MalformedURLException
                             "&code_challenge=" + MOCK_PKCE_CHALLENGE.getCodeChallenge() +
                             "&code_challenge_method=" + MOCK_PKCE_CHALLENGE.getCodeChallengeMethod() +
                             "&x-client-OS=" + MockDeviceMetadata.TEST_OS_ESTS +
+                            "&x-client-ReleaseOS=" + MockDeviceMetadata.TEST_RELEASE_OS +
                             "&x-client-CPU=" + MockDeviceMetadata.TEST_CPU +
                             "&x-client-DM=" + MockDeviceMetadata.TEST_DEVICE_MODEL +
                             "&x-client-MN=" + MockDeviceMetadata.TEST_MANUFACTURER +
@@ -220,6 +221,7 @@ public void testCreateUriFromAuthorizationRequestWithWPAvailable() throws Malfor
                             "&code_challenge=" + MOCK_PKCE_CHALLENGE.getCodeChallenge() +
                             "&code_challenge_method=" + MOCK_PKCE_CHALLENGE.getCodeChallengeMethod() +
                             "&x-client-OS=" + MockDeviceMetadata.TEST_OS_ESTS +
+                            "&x-client-ReleaseOS=" + MockDeviceMetadata.TEST_RELEASE_OS +
                             "&x-client-CPU=" + MockDeviceMetadata.TEST_CPU +
                             "&x-client-DM=" + MockDeviceMetadata.TEST_DEVICE_MODEL +
                             "&x-client-MN=" + MockDeviceMetadata.TEST_MANUFACTURER +