Added a check to see if the URL scheme is lowercase; if not, log an error and open our warning popup to indicate that using uppercase characters in the URL scheme may lead to deeplinking issues on certain platforms (e.g. Android) (#293)

Author: BellringerQuinn

Packages/Sequence-Unity/Editor/AndroidCustomGradleCheck.cs

@@ -15,7 +15,7 @@ public class AndroidCustomGradleCheck : IPreprocessBuildWithReport
 
         private static List<string> _cachedWarnings;
 
-        private const string _docsUrl = "https://docs.sequence.xyz/sdk/unity/recovering-sessions#android";
+        private const string _docsUrl = "https://docs.sequence.xyz/sdk/unity/onboard/recovering-sessions#android";
 
         public void OnPreprocessBuild(BuildReport report)
         {
@@ -48,7 +48,7 @@ public void OnPreprocessBuild(BuildReport report)
 
                 if (warnings.Count > 0)
                 {
-                    WarningPopup.ShowWindow(warnings);
+                    SequenceWarningPopup.ShowWindow(warnings, _docsUrl);
                 }
             }
         }
@@ -84,44 +84,5 @@ private bool GetProjectSettingsFlag(string key)
 
             return false;
         }
-
-        private class WarningPopup : EditorWindow
-        {
-            private static List<string> warnings;
-
-            public static void ShowWindow(List<string> warningsToShow)
-            {
-                if (warningsToShow == null || warningsToShow.Count == 0)
-                {
-                    return;
-                }
-                warnings = warningsToShow;
-                var window = GetWindow<WarningPopup>("Sequence Build Warnings");
-                window.position = new Rect(Screen.width / 2, Screen.height / 2, 400, 200);
-                window.Show();
-            }
-
-            private void OnGUI()
-            {
-                GUILayout.Label("Warnings Detected", EditorStyles.boldLabel);
-
-                foreach (string warning in warnings)
-                {
-                    EditorGUILayout.HelpBox(warning, MessageType.Warning);
-
-                    if (GUILayout.Button("Learn More", GUILayout.Width(100)))
-                    {
-                        Application.OpenURL(_docsUrl);
-                    }
-                }
-
-                GUILayout.FlexibleSpace();
-
-                if (GUILayout.Button("Dismiss", GUILayout.Height(30)))
-                {
-                    Close();
-                }
-            }
-        }
     }
 }

Packages/Sequence-Unity/Editor/CheckUrlScheme.cs

@@ -3,16 +3,17 @@
 using Sequence.Config;
 using UnityEditor;
 using UnityEditor.Build;
+using UnityEditor.Build.Reporting;
 using UnityEditor.Callbacks;
 using UnityEngine;
-#if UNITY_IOS || UNITY_STANDALONE_OSX
 using System.Collections.Generic;
+#if UNITY_IOS || UNITY_STANDALONE_OSX
 using UnityEditor.iOS.Xcode;
 #endif
 
 namespace Sequence.Editor
 {
-    public class CheckUrlScheme
+    public class CheckUrlScheme : IPreprocessBuildWithReport
     {
         private static string _plistPath;
         private static string _urlScheme;
@@ -91,5 +92,34 @@ private static void CheckPlistUrlScheme()
             }
 #endif
         }
+        
+        public int callbackOrder => 0;
+        public void OnPreprocessBuild(BuildReport report)
+        {
+            SequenceConfig config = SequenceConfig.GetConfig();
+            _urlScheme = config.UrlScheme;
+
+            List<string> warnings = new List<string>();
+
+            if (string.IsNullOrWhiteSpace(_urlScheme))
+            {
+                warnings.Add(SequenceConfig.MissingConfigError("Url Scheme").Message);
+            }
+
+            if (_urlScheme.ToLower() != _urlScheme)
+            {
+                warnings.Add($"{nameof(config.UrlScheme)} should be all lowercase; if uppercase characters are included, you may encounter difficulties with deep-linking on certain platforms.");
+            }
+            
+            if (warnings.Count > 0)
+            {
+                foreach (var warning in warnings)
+                {
+                    Debug.LogWarning(warning);
+                }
+                
+                SequenceWarningPopup.ShowWindow(warnings, "https://docs.sequence.xyz/sdk/unity/onboard/authentication/oidc");
+            }
+        }
     }
 }

Packages/Sequence-Unity/Editor/SequenceWarningPopup.cs

@@ -0,0 +1,72 @@
+using System.Collections.Generic;
+using UnityEditor;
+using UnityEngine;
+
+namespace Sequence.Editor
+{
+    internal class SequenceWarningPopup : EditorWindow
+    {
+        private class Warning
+        {
+            public string WarningMessage;
+            public string RelatedDocsUrl;
+
+            public Warning(string warningMessage, string relatedDocsUrl)
+            {
+                WarningMessage = warningMessage;
+                RelatedDocsUrl = relatedDocsUrl;
+            }
+        }
+        
+        private static List<Warning> warnings = new List<Warning>();
+
+        public static void ShowWindow(List<string> warningsToShow, string docsUrl)
+        {
+            if (warningsToShow == null || warningsToShow.Count == 0)
+            {
+                return;
+            }
+
+            List<Warning> warningsToAdd = new List<Warning>();
+            foreach (var warning in warningsToShow)
+            {
+                warningsToAdd.Add(new Warning(warning, docsUrl));
+            }
+
+            if (warnings.Count > 0)
+            {
+                warnings.AddRange(warningsToAdd);
+            }
+            else
+            {
+                warnings = warningsToAdd;
+            }
+            var window = GetWindow<SequenceWarningPopup>("Sequence Build Warnings");
+            window.position = new Rect(Screen.width / 2, Screen.height / 2, 400, 200);
+            window.Show();
+        }
+
+        private void OnGUI()
+        {
+            GUILayout.Label("Warnings Detected", EditorStyles.boldLabel);
+
+            foreach (Warning warning in warnings)
+            {
+                EditorGUILayout.HelpBox(warning.WarningMessage, MessageType.Warning);
+
+                if (GUILayout.Button("Learn More", GUILayout.Width(100)))
+                {
+                    Application.OpenURL(warning.RelatedDocsUrl);
+                }
+            }
+
+            GUILayout.FlexibleSpace();
+
+            if (GUILayout.Button("Dismiss", GUILayout.Height(30)))
+            {
+                warnings = new List<Warning>();
+                Close();
+            }
+        }
+    }
+}

Packages/Sequence-Unity/Editor/SequenceWarningPopup.cs.meta

@@ -1,6 +1,6 @@
 {
   "name": "xyz.0xsequence.waas-unity",
-  "version": "4.1.0",
+  "version": "4.1.1",
   "displayName": "Sequence Embedded Wallet SDK",
   "description": "A Unity SDK for Sequence APIs",
   "unity": "2021.3",