Fix #1586 - add correct Preserve attribute (#1599)

bgavrilMS · web-flow · commit bedc8a205562 · 2020-01-28T19:39:08.000-08:00
* Fix #1586 - add correct Preseve attribute * remove dead * Removing switch to log page on mobile test failure
diff --git a/src/client/Microsoft.Identity.Client/Cache/AdalResult.cs b/src/client/Microsoft.Identity.Client/Cache/AdalResult.cs
@@ -12,7 +12,7 @@ namespace Microsoft.Identity.Client.Cache
     /// with MSAL, only Refresh Tokens are.
     /// </summary>
     [JsonObject]
-    [Preserve]
+    [Preserve(AllMembers = true)]
     internal sealed class AdalResult
     {
         internal AdalResult() 
diff --git a/src/client/Microsoft.Identity.Client/Cache/AdalResultWrapper.cs b/src/client/Microsoft.Identity.Client/Cache/AdalResultWrapper.cs
@@ -9,7 +9,7 @@
 namespace Microsoft.Identity.Client.Cache
 {
     [JsonObject]
-    [Preserve]
+    [Preserve(AllMembers = true)]
     internal class AdalResultWrapper
     {
         [JsonProperty]
diff --git a/src/client/Microsoft.Identity.Client/Cache/AdalUserInfo.cs b/src/client/Microsoft.Identity.Client/Cache/AdalUserInfo.cs
@@ -10,7 +10,7 @@ namespace Microsoft.Identity.Client.Cache
     /// Contains information of a single user. This information is used for token cache lookup. Also if created with userId, userId is sent to the service when login_hint is accepted.
     /// </summary>
     [JsonObject]
-    [Preserve]
+    [Preserve(AllMembers = true)]
     internal sealed class AdalUserInfo
     {
         /// <summary>
diff --git a/src/client/Microsoft.Identity.Client/Core/ClientInfo.cs b/src/client/Microsoft.Identity.Client/Core/ClientInfo.cs
@@ -9,10 +9,10 @@
 namespace Microsoft.Identity.Client.Core
 {
     [JsonObject]
-    [Preserve]
+    [Preserve(AllMembers = true)]
     internal class ClientInfo
     {
-        [JsonProperty(PropertyName = ClientInfoClaim.UniqueIdentifier )]
+        [JsonProperty(PropertyName = ClientInfoClaim.UniqueIdentifier)]
         public string UniqueObjectIdentifier { get; set; }
 
         [JsonProperty(PropertyName = ClientInfoClaim.UniqueTenantIdentifier)]
diff --git a/src/client/Microsoft.Identity.Client/Core/IdToken.cs b/src/client/Microsoft.Identity.Client/Core/IdToken.cs
@@ -24,7 +24,7 @@ internal class IdTokenClaim
     }
 
     [JsonObject]
-    [Preserve]
+    [Preserve(AllMembers = true)]
     internal class IdToken
     {
         [JsonProperty(PropertyName = IdTokenClaim.Issuer)]
diff --git a/src/client/Microsoft.Identity.Client/Instance/AdfsWebFingerResponse.cs b/src/client/Microsoft.Identity.Client/Instance/AdfsWebFingerResponse.cs
@@ -16,7 +16,7 @@ internal class AdfsWebFingerResponseClaim : OAuth2ResponseBaseClaim
     }
 
     [JsonObject(Title = AdfsWebFingerResponseClaim.Links)]
-    [Preserve]
+    [Preserve(AllMembers = true)]
     internal class LinksList
     {
         [JsonProperty(PropertyName = AdfsWebFingerResponseClaim.Rel)]
@@ -27,7 +27,7 @@ internal class LinksList
     }
 
     [JsonObject]
-    [Preserve]
+    [Preserve(AllMembers = true)]
     internal class AdfsWebFingerResponse : OAuth2ResponseBase
     {
         [JsonProperty(PropertyName = AdfsWebFingerResponseClaim.Subject)]
diff --git a/src/client/Microsoft.Identity.Client/Instance/Discovery/InstanceDiscoveryMetadataEntry.cs b/src/client/Microsoft.Identity.Client/Instance/Discovery/InstanceDiscoveryMetadataEntry.cs
@@ -6,7 +6,7 @@
 namespace Microsoft.Identity.Client.Instance.Discovery
 {
     [JsonObject]
-    [Preserve]
+    [Preserve(AllMembers = true)]
     internal sealed class InstanceDiscoveryMetadataEntry
     {
         [JsonProperty(PropertyName = "preferred_network")]
diff --git a/src/client/Microsoft.Identity.Client/Instance/Discovery/InstanceDiscoveryResponse.cs b/src/client/Microsoft.Identity.Client/Instance/Discovery/InstanceDiscoveryResponse.cs
@@ -7,7 +7,7 @@
 namespace Microsoft.Identity.Client.Instance.Discovery
 {
     [JsonObject]
-    [Preserve]
+    [Preserve(AllMembers = true)]
     internal sealed class InstanceDiscoveryResponse : OAuth2ResponseBase
     {
         [JsonProperty(PropertyName = "tenant_discovery_endpoint")]
diff --git a/src/client/Microsoft.Identity.Client/Instance/DrsMetadataResponse.cs b/src/client/Microsoft.Identity.Client/Instance/DrsMetadataResponse.cs
@@ -14,15 +14,15 @@ internal class DrsMetadataResponseClaim : OAuth2ResponseBaseClaim
     }
 
     [JsonObject]
-    [Preserve]
+    [Preserve(AllMembers = true)]
     internal class IdentityProviderService
     {
         [JsonProperty(PropertyName = DrsMetadataResponseClaim.PassiveAuthEndpoint)]
         public Uri PassiveAuthEndpoint { get; set; }
     }
 
     [JsonObject]
-    [Preserve]
+    [Preserve(AllMembers = true)]
     internal class DrsMetadataResponse : OAuth2ResponseBase
     {
         [JsonProperty(PropertyName = DrsMetadataResponseClaim.IdentityProviderService)]
diff --git a/src/client/Microsoft.Identity.Client/Instance/TenantDiscoveryResponse.cs b/src/client/Microsoft.Identity.Client/Instance/TenantDiscoveryResponse.cs
@@ -14,7 +14,7 @@ internal class TenantDiscoveryResponseClaim : OAuth2ResponseBaseClaim
     }
 
     [JsonObject]
-    [Preserve]
+    [Preserve(AllMembers = true)]
     internal class TenantDiscoveryResponse : OAuth2ResponseBase
     {
         [JsonProperty(PropertyName = TenantDiscoveryResponseClaim.AuthorizationEndpoint)]
diff --git a/src/client/Microsoft.Identity.Client/Internal/DeviceCodeResponse.cs b/src/client/Microsoft.Identity.Client/Internal/DeviceCodeResponse.cs
@@ -9,7 +9,7 @@
 namespace Microsoft.Identity.Client.Internal
 {
     [JsonObject]
-    [Preserve]
+    [Preserve(AllMembers = true)]
     internal class DeviceCodeResponse : OAuth2ResponseBase
     {
         [JsonProperty(PropertyName = "user_code")]
diff --git a/src/client/Microsoft.Identity.Client/Internal/JsonWebToken.cs b/src/client/Microsoft.Identity.Client/Internal/JsonWebToken.cs
@@ -118,7 +118,7 @@ private string Encode(ClientCredentialWrapper credential, bool sendCertificate)
         }
 
         [JsonObject]
-        [Preserve]
+        [Preserve(AllMembers = true)]
         internal class JWTHeader
         {
             public JWTHeader(ClientCredentialWrapper credential)
@@ -157,7 +157,7 @@ public string Algorithm
         }
 
         [JsonObject]
-        [Preserve]
+        [Preserve(AllMembers = true)]
         internal class JWTPayload
         {
             [JsonProperty(PropertyName = JsonWebTokenConstants.ReservedClaims.Audience)]
@@ -184,7 +184,7 @@ internal class JWTPayload
         }
 
         [JsonObject]
-        [Preserve]
+        [Preserve(AllMembers = true)]
         internal sealed class JWTHeaderWithCertificate : JWTHeader
         {
             public JWTHeaderWithCertificate(ClientCredentialWrapper credential, bool sendCertificate)
diff --git a/src/client/Microsoft.Identity.Client/OAuth2/MsalTokenResponse.cs b/src/client/Microsoft.Identity.Client/OAuth2/MsalTokenResponse.cs
@@ -29,7 +29,7 @@ internal class TokenResponseClaim : OAuth2ResponseBaseClaim
     }
 
     [JsonObject]
-    [Preserve]
+    [Preserve(AllMembers = true)]
     internal class MsalTokenResponse : OAuth2ResponseBase
     {
         private long _expiresIn;
diff --git a/src/client/Microsoft.Identity.Client/OAuth2/OAuth2ResponseBase.cs b/src/client/Microsoft.Identity.Client/OAuth2/OAuth2ResponseBase.cs
@@ -16,7 +16,7 @@ internal class OAuth2ResponseBaseClaim
     }
 
     [JsonObject]
-    [Preserve]
+    [Preserve(AllMembers = true)]
     internal class OAuth2ResponseBase
     {
         [JsonProperty(PropertyName = OAuth2ResponseBaseClaim.Error)]
diff --git a/src/client/Microsoft.Identity.Client/Platforms/Android/BrokerRequest.cs b/src/client/Microsoft.Identity.Client/Platforms/Android/BrokerRequest.cs
@@ -7,7 +7,7 @@
 namespace Microsoft.Identity.Client.Platforms.Android
 {
     [JsonObject]
-    [Preserve]
+    [Preserve(AllMembers = true)]
     internal class BrokerRequest
     {
         [JsonProperty("authority")]
diff --git a/src/client/Microsoft.Identity.Client/Platforms/Android/BrowserTabActivity.cs b/src/client/Microsoft.Identity.Client/Platforms/Android/BrowserTabActivity.cs
@@ -17,7 +17,7 @@ namespace Microsoft.Identity.Client
     /// </summary>
     //[Activity(Name = "microsoft.identity.client.BrowserTabActivity")]
     [CLSCompliant(false)]
-    [Preserve]
+    [Preserve(AllMembers = true)]
     public class BrowserTabActivity : Activity
     {
         /// <summary>
diff --git a/src/client/Microsoft.Identity.Client/PreserveAttribute.cs b/src/client/Microsoft.Identity.Client/PreserveAttribute.cs
@@ -1,26 +1,19 @@
 ﻿// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-using System;
-using System.Globalization;
-
 namespace Microsoft.Identity.Client
 {
     /// <summary>
     /// Attribute that will be picked up by the Xamarin Linker, as a hint for the linker to not remove the type.
     /// Needs to be added to types that get created by reflection, e.g. JSON serialization types
     /// </summary>
-    [AttributeUsage(AttributeTargets.Class)]
-    public sealed class PreserveAttribute : System.Attribute
+    /// <remarks>It's important to not change the name and the 2 fields of this class. The linker looks for these.</remarks>
+    [System.AttributeUsage(System.AttributeTargets.All)]
+    class PreserveAttribute : System.Attribute // do not rename
     {
-        /// <summary>
-        /// 
-        /// </summary>
-        public bool AllMembers;
+        public PreserveAttribute() { }
 
-        /// <summary>
-        /// 
-        /// </summary>
-        public bool Conditional;
+        public bool Conditional; // do not change to a property or rename
+        public bool AllMembers;  // do not change to a property or rename
     }
 }
diff --git a/src/client/Microsoft.Identity.Client/Properties/AssemblyInfo.cs b/src/client/Microsoft.Identity.Client/Properties/AssemblyInfo.cs
@@ -14,3 +14,4 @@
 // COM, set the ComVisible attribute to true on that type.
 [assembly: ComVisible(false)]
 [assembly: CLSCompliant(true)]
+
diff --git a/src/client/Microsoft.Identity.Client/UI/AuthorizationResult.cs b/src/client/Microsoft.Identity.Client/UI/AuthorizationResult.cs
@@ -19,7 +19,7 @@ internal enum AuthorizationStatus
     }
 
     [JsonObject]
-    [Preserve]
+    [Preserve(AllMembers = true)]
     internal class AuthorizationResult
     {
         public static AuthorizationResult FromUri(string webAuthenticationResult)
diff --git a/src/client/Microsoft.Identity.Client/WsTrust/UserRealmDiscoveryResponse.cs b/src/client/Microsoft.Identity.Client/WsTrust/UserRealmDiscoveryResponse.cs
@@ -7,7 +7,7 @@
 namespace Microsoft.Identity.Client.WsTrust
 {
     [JsonObject]
-    [Preserve]
+    [Preserve(AllMembers = true)]
     internal sealed class UserRealmDiscoveryResponse
     {
         [JsonProperty(PropertyName = "ver")]
diff --git a/tests/Microsoft.Identity.Test.Core.UIAutomation/MobileTestHelper.cs b/tests/Microsoft.Identity.Test.Core.UIAutomation/MobileTestHelper.cs
@@ -280,12 +280,10 @@ public void VerifyResult(ITestController controller)
                 }
                 else if (result.Contains(CoreUiTestConstants.TestResultFailureMessage))
                 {
-                    controller.Tap("LogPage");
                     throw new ResultVerificationFailureException(VerificationError.ResultIndicatesFailure);
                 }
                 else
                 {
-                    controller.Tap("LogPage");
                     throw new ResultVerificationFailureException(VerificationError.ResultNotFound);
                 }
             });
diff --git a/tests/Microsoft.Identity.Test.Unit.net45/UtilTests/LinkerTests.cs b/tests/Microsoft.Identity.Test.Unit.net45/UtilTests/LinkerTests.cs
@@ -0,0 +1,35 @@
+﻿// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Reflection;
+using System.Text;
+using System.Threading.Tasks;
+using Microsoft.Identity.Client;
+using Microsoft.Identity.Json;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using NSubstitute;
+
+namespace Microsoft.Identity.Test.Unit.UtilTests
+{
+    [TestClass]
+    public class LinkerTests
+    {
+        [TestMethod]
+        public void JsonObjectsArePreserved()
+        {
+            const string Message = "Please add a [Preserve(AllMembers=true)] attribute to each serializable object to avoid the Xamarin Linker removing this type. Type missing this: ";
+            var serializableTypes = typeof(PublicClientApplication).Assembly.GetTypes()
+                .Where(
+                    t => t.GetCustomAttributes(typeof(JsonObjectAttribute), true).Any());
+
+            foreach (var serializableType in serializableTypes)
+            {
+                var preserveAttribute = serializableType.GetCustomAttribute<PreserveAttribute>();
+                Assert.IsNotNull(preserveAttribute, Message + serializableType);
+                Assert.IsTrue(preserveAttribute.AllMembers, Message + serializableType);
+            }
+        }
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ namespace Microsoft.Identity.Client.Cache`
`12`	`12`	`/// with MSAL, only Refresh Tokens are.`
`13`	`13`	`/// </summary>`
`14`	`14`	`[JsonObject]`
`15`		`- [Preserve]`
	`15`	`+ [Preserve(AllMembers = true)]`
`16`	`16`	`internal sealed class AdalResult`
`17`	`17`	`{`
`18`	`18`	`internal AdalResult()`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`namespace Microsoft.Identity.Client.Cache`
`10`	`10`	`{`
`11`	`11`	`[JsonObject]`
`12`		`- [Preserve]`
	`12`	`+ [Preserve(AllMembers = true)]`
`13`	`13`	`internal class AdalResultWrapper`
`14`	`14`	`{`
`15`	`15`	`[JsonProperty]`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ namespace Microsoft.Identity.Client.Cache`
`10`	`10`	`/// Contains information of a single user. This information is used for token cache lookup. Also if created with userId, userId is sent to the service when login_hint is accepted.`
`11`	`11`	`/// </summary>`
`12`	`12`	`[JsonObject]`
`13`		`- [Preserve]`
	`13`	`+ [Preserve(AllMembers = true)]`
`14`	`14`	`internal sealed class AdalUserInfo`
`15`	`15`	`{`
`16`	`16`	`/// <summary>`
Original file line number	Diff line number	Diff line change
`@@ -9,10 +9,10 @@`
`9`	`9`	`namespace Microsoft.Identity.Client.Core`
`10`	`10`	`{`
`11`	`11`	`[JsonObject]`
`12`		`- [Preserve]`
	`12`	`+ [Preserve(AllMembers = true)]`
`13`	`13`	`internal class ClientInfo`
`14`	`14`	`{`
`15`		`- [JsonProperty(PropertyName = ClientInfoClaim.UniqueIdentifier )]`
	`15`	`+ [JsonProperty(PropertyName = ClientInfoClaim.UniqueIdentifier)]`
`16`	`16`	`public string UniqueObjectIdentifier { get; set; }`
`17`	`17`
`18`	`18`	`[JsonProperty(PropertyName = ClientInfoClaim.UniqueTenantIdentifier)]`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ internal class IdTokenClaim`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`[JsonObject]`
`27`		`- [Preserve]`
	`27`	`+ [Preserve(AllMembers = true)]`
`28`	`28`	`internal class IdToken`
`29`	`29`	`{`
`30`	`30`	`[JsonProperty(PropertyName = IdTokenClaim.Issuer)]`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ internal class AdfsWebFingerResponseClaim : OAuth2ResponseBaseClaim`
`16`	`16`	`}`
`17`	`17`
`18`	`18`	`[JsonObject(Title = AdfsWebFingerResponseClaim.Links)]`
`19`		`- [Preserve]`
	`19`	`+ [Preserve(AllMembers = true)]`
`20`	`20`	`internal class LinksList`
`21`	`21`	`{`
`22`	`22`	`[JsonProperty(PropertyName = AdfsWebFingerResponseClaim.Rel)]`
`@@ -27,7 +27,7 @@ internal class LinksList`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`[JsonObject]`
`30`		`- [Preserve]`
	`30`	`+ [Preserve(AllMembers = true)]`
`31`	`31`	`internal class AdfsWebFingerResponse : OAuth2ResponseBase`
`32`	`32`	`{`
`33`	`33`	`[JsonProperty(PropertyName = AdfsWebFingerResponseClaim.Subject)]`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`namespace Microsoft.Identity.Client.Instance.Discovery`
`7`	`7`	`{`
`8`	`8`	`[JsonObject]`
`9`		`- [Preserve]`
	`9`	`+ [Preserve(AllMembers = true)]`
`10`	`10`	`internal sealed class InstanceDiscoveryMetadataEntry`
`11`	`11`	`{`
`12`	`12`	`[JsonProperty(PropertyName = "preferred_network")]`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`namespace Microsoft.Identity.Client.Instance.Discovery`
`8`	`8`	`{`
`9`	`9`	`[JsonObject]`
`10`		`- [Preserve]`
	`10`	`+ [Preserve(AllMembers = true)]`
`11`	`11`	`internal sealed class InstanceDiscoveryResponse : OAuth2ResponseBase`
`12`	`12`	`{`
`13`	`13`	`[JsonProperty(PropertyName = "tenant_discovery_endpoint")]`
Original file line number	Diff line number	Diff line change
`@@ -14,15 +14,15 @@ internal class DrsMetadataResponseClaim : OAuth2ResponseBaseClaim`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`[JsonObject]`
`17`		`- [Preserve]`
	`17`	`+ [Preserve(AllMembers = true)]`
`18`	`18`	`internal class IdentityProviderService`
`19`	`19`	`{`
`20`	`20`	`[JsonProperty(PropertyName = DrsMetadataResponseClaim.PassiveAuthEndpoint)]`
`21`	`21`	`public Uri PassiveAuthEndpoint { get; set; }`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`[JsonObject]`
`25`		`- [Preserve]`
	`25`	`+ [Preserve(AllMembers = true)]`
`26`	`26`	`internal class DrsMetadataResponse : OAuth2ResponseBase`
`27`	`27`	`{`
`28`	`28`	`[JsonProperty(PropertyName = DrsMetadataResponseClaim.IdentityProviderService)]`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ internal class TenantDiscoveryResponseClaim : OAuth2ResponseBaseClaim`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`[JsonObject]`
`17`		`- [Preserve]`
	`17`	`+ [Preserve(AllMembers = true)]`
`18`	`18`	`internal class TenantDiscoveryResponse : OAuth2ResponseBase`
`19`	`19`	`{`
`20`	`20`	`[JsonProperty(PropertyName = TenantDiscoveryResponseClaim.AuthorizationEndpoint)]`