updated playmode/editor mode change transitions (#704)

* updated playmode/editor mode change transitions

Disable and destroy all services as soon as we get the quitting event

* use nameof

* fixed project manifest

* properly use nameof

* fixed tests

XRTK-Core/Packages/com.xrtk.core/Runtime/Services/MixedRealityToolkit.cs

@@ -274,7 +274,12 @@ private void InitializeInstance()
                     DontDestroyOnLoad(instance.transform.root);
                 }
 
-                Application.quitting += () => IsApplicationQuitting = true;
+                Application.quitting += () =>
+                {
+                    DisableAllServices();
+                    DestroyAllServices();
+                    IsApplicationQuitting = true;
+                };
 
 #if UNITY_EDITOR
                 UnityEditor.EditorApplication.hierarchyChanged += OnHierarchyChanged;
@@ -284,27 +289,35 @@ void OnHierarchyChanged()
                 {
                     if (instance != null)
                     {
-                        Debug.Assert(instance.transform.parent == null, "The MixedRealityToolkit should not be parented under any other GameObject!");
-                        Debug.Assert(instance.transform.childCount == 0, "The MixedRealityToolkit should not have GameObject children!");
+                        Debug.Assert(instance.transform.parent == null, $"The {nameof(MixedRealityToolkit)} should not be parented under any other GameObject!");
+                        Debug.Assert(instance.transform.childCount == 0, $"The {nameof(MixedRealityToolkit)} should not have GameObject children!");
                     }
                 }
 
                 void OnPlayModeStateChanged(UnityEditor.PlayModeStateChange playModeState)
                 {
-                    if (playModeState == UnityEditor.PlayModeStateChange.ExitingEditMode ||
-                        playModeState == UnityEditor.PlayModeStateChange.EnteredEditMode)
+                    switch (playModeState)
                     {
-                        IsApplicationQuitting = false;
+                        case UnityEditor.PlayModeStateChange.EnteredEditMode:
+                            IsApplicationQuitting = false;
+                            break;
+                        case UnityEditor.PlayModeStateChange.ExitingEditMode:
+                            if (activeProfile == null)
+                            {
+                                UnityEditor.EditorApplication.isPlaying = false;
+                                UnityEditor.Selection.activeObject = Instance;
+                                UnityEditor.EditorApplication.delayCall += () =>
+                                    UnityEditor.EditorGUIUtility.PingObject(Instance);
+                            }
+                            break;
+                        case UnityEditor.PlayModeStateChange.EnteredPlayMode:
+                        case UnityEditor.PlayModeStateChange.ExitingPlayMode:
+                            // Nothing for now.
+                            break;
+                        default:
+                            throw new ArgumentOutOfRangeException(nameof(playModeState), playModeState, null);
                     }
 
-                    if (activeProfile == null &&
-                        playModeState == UnityEditor.PlayModeStateChange.ExitingEditMode)
-                    {
-                        UnityEditor.EditorApplication.isPlaying = false;
-                        UnityEditor.Selection.activeObject = Instance;
-                        UnityEditor.EditorApplication.delayCall += () =>
-                            UnityEditor.EditorGUIUtility.PingObject(Instance);
-                    }
                 }
 #endif // UNITY_EDITOR
 
@@ -335,7 +348,7 @@ void OnPlayModeStateChanged(UnityEditor.PlayModeStateChange playModeState)
         /// </summary>
         public static void AssertIsInitialized()
         {
-            Debug.Assert(IsInitialized, "The MixedRealityToolkit has not been initialized.");
+            Debug.Assert(IsInitialized, $"The {nameof(MixedRealityToolkit)} has not been initialized.");
         }
 
         /// <summary>
@@ -361,16 +374,16 @@ private void InitializeServiceLocator()
         {
             if (isInitializing)
             {
-                Debug.LogWarning("Already attempting to initialize the service locator!");
+                Debug.LogWarning($"Already attempting to initialize the {nameof(MixedRealityToolkit)}!");
                 return;
             }
 
             isInitializing = true;
 
-            //If the Mixed Reality Toolkit is not configured, stop.
+            // If the Mixed Reality Toolkit is not configured, stop.
             if (ActiveProfile == null)
             {
-                Debug.LogError("No Mixed Reality Root Profile found, cannot initialize the Mixed Reality Toolkit");
+                Debug.LogError($"No {nameof(MixedRealityToolkitRootProfile)} found, cannot initialize the {nameof(MixedRealityToolkit)}");
                 isInitializing = false;
                 return;
             }
@@ -636,7 +649,7 @@ private static void EnsureMixedRealityRequirements()
 
                     if (raiseWarning)
                     {
-                        Debug.LogWarning("Found an existing event system in your scene. The Mixed Reality Toolkit requires only one, and must be found on the main camera.");
+                        Debug.LogWarning($"Found an existing event system in your scene. The {nameof(MixedRealityToolkit)} requires only one, and must be found on the main camera.");
                     }
                 }
             }
@@ -1894,7 +1907,7 @@ private static bool CanGetService(Type interfaceType, string serviceName)
 
             if (!typeof(IMixedRealityService).IsAssignableFrom(interfaceType))
             {
-                Debug.LogError($"{interfaceType.Name} does not implement {typeof(IMixedRealityService).Name}.");
+                Debug.LogError($"{interfaceType.Name} does not implement {nameof(IMixedRealityService)}.");
                 return false;
             }
 

XRTK-Core/Packages/com.xrtk.core/Tests/Core/TestFixture_01_MixedRealityToolkitTests.cs

@@ -5,6 +5,7 @@
 using UnityEditor.SceneManagement;
 using UnityEngine;
 using UnityEngine.TestTools;
+using XRTK.Definitions;
 using XRTK.Editor.Utilities;
 using XRTK.Interfaces;
 using XRTK.Services;
@@ -52,7 +53,7 @@ public void Test_02_TestNoMixedRealityProfileFound()
             Assert.IsFalse(MixedRealityToolkit.HasActiveProfile);
             Assert.IsNull(MixedRealityToolkit.Instance.ActiveProfile);
             Assert.IsFalse(MixedRealityToolkit.HasActiveProfile);
-            LogAssert.Expect(LogType.Error, "No Mixed Reality Root Profile found, cannot initialize the Mixed Reality Toolkit");
+            LogAssert.Expect(LogType.Error, $"No {nameof(MixedRealityToolkitRootProfile)} found, cannot initialize the {nameof(MixedRealityToolkit)}");
         }
 
         [Test]
@@ -127,10 +128,10 @@ public void Test_04_02_01_UnregisterMixedRealityServiceAndDataProviderByType()
 
             // Unregister
             var successService = MixedRealityToolkit.TryUnregisterServicesOfType<ITestService>();
-            LogAssert.Expect(LogType.Error, $"Unable to find {typeof(ITestService).Name} service.");
+            LogAssert.Expect(LogType.Error, $"Unable to find {nameof(ITestService)} service.");
 
             var successDataProvider = MixedRealityToolkit.TryUnregisterServicesOfType<ITestDataProvider1>();
-            LogAssert.Expect(LogType.Error, $"Unable to find {typeof(ITestDataProvider1).Name} service.");
+            LogAssert.Expect(LogType.Error, $"Unable to find {nameof(ITestDataProvider1)} service.");
 
             // Validate non-existent service
             var isServiceRegistered = MixedRealityToolkit.IsServiceRegistered<ITestService>();
@@ -175,9 +176,9 @@ public void Test_04_02_02_UnregisterMixedRealityDataProviderByTypeAndName()
 
             // Unregister
             var successService = MixedRealityToolkit.TryUnregisterService<ITestService>(testService1.Name);
-            LogAssert.Expect(LogType.Error, $"Unable to find {typeof(ITestService).Name} service.");
+            LogAssert.Expect(LogType.Error, $"Unable to find {nameof(ITestService)} service.");
             var successDataProvider = MixedRealityToolkit.TryUnregisterService<ITestDataProvider1>(dataProvider1.Name);
-            LogAssert.Expect(LogType.Error, $"Unable to find {typeof(ITestDataProvider1).Name} service.");
+            LogAssert.Expect(LogType.Error, $"Unable to find {nameof(ITestDataProvider1)} service.");
 
             // Validate non-existent service
             var isServiceRegistered = MixedRealityToolkit.IsServiceRegistered<ITestService>();
@@ -268,11 +269,11 @@ public void Test_04_04_UnregisterMixedRealityDataProvidersByType()
 
             // Validate non-existent service
             var isServiceRegistered = MixedRealityToolkit.IsServiceRegistered<ITestService>();
-            LogAssert.Expect(LogType.Error, $"Unable to find {typeof(ITestService).Name} service.");
+            LogAssert.Expect(LogType.Error, $"Unable to find {nameof(ITestService)} service.");
             var isService1Registered = MixedRealityToolkit.IsServiceRegistered<ITestDataProvider1>();
-            LogAssert.Expect(LogType.Error, $"Unable to find {typeof(ITestDataProvider1).Name} service.");
+            LogAssert.Expect(LogType.Error, $"Unable to find {nameof(ITestDataProvider1)} service.");
             var isService2Registered = MixedRealityToolkit.IsServiceRegistered<ITestDataProvider2>();
-            LogAssert.Expect(LogType.Error, $"Unable to find {typeof(ITestDataProvider2).Name} service.");
+            LogAssert.Expect(LogType.Error, $"Unable to find {nameof(ITestDataProvider2)} service.");
 
             // Tests
             Assert.IsFalse(isServiceRegistered);
@@ -299,7 +300,7 @@ public void Test_04_05_MixedRealityDataProviderDoesNotExist()
             var isServiceRegistered = MixedRealityToolkit.IsServiceRegistered<ITestDataProvider2>();
 
             // Tests
-            LogAssert.Expect(LogType.Error, $"Unable to find {typeof(ITestDataProvider2).Name} service.");
+            LogAssert.Expect(LogType.Error, $"Unable to find {nameof(ITestDataProvider2)} service.");
             Assert.IsFalse(isServiceRegistered);
         }
 
@@ -362,7 +363,7 @@ public void Test_04_08_GetMixedRealityDataProviderCollectionByInterface()
 
             // Add test data provider 2
             MixedRealityToolkit.TryRegisterService<ITestDataProvider2>(failService);
-            LogAssert.Expect(LogType.Error, $"{failService.Name} does not implement {typeof(ITestDataProvider2).Name}");
+            LogAssert.Expect(LogType.Error, $"{failService.Name} does not implement {nameof(ITestDataProvider2)}");
 
             MixedRealityToolkit.TryRegisterService<ITestDataProvider2>(new TestDataProvider2(testService1, "Test04-08-2.2"));
 
@@ -418,7 +419,7 @@ public void Test_05_02_01_UnregisterMixedRealityExtensionServiceByType()
 
             // Validate non-existent service
             var isServiceRegistered = MixedRealityToolkit.IsServiceRegistered<ITestExtensionService1>();
-            LogAssert.Expect(LogType.Error, $"Unable to find {typeof(ITestExtensionService1).Name} service.");
+            LogAssert.Expect(LogType.Error, $"Unable to find {nameof(ITestExtensionService1)} service.");
 
             // Tests
             Assert.IsTrue(success);
@@ -449,7 +450,7 @@ public void Test_05_02_02_UnregisterMixedRealityExtensionServiceByTypeAndName()
 
             // Validate non-existent service
             var isServiceRegistered = MixedRealityToolkit.IsServiceRegistered<ITestExtensionService1>();
-            LogAssert.Expect(LogType.Error, $"Unable to find {typeof(ITestExtensionService1).Name} service.");
+            LogAssert.Expect(LogType.Error, $"Unable to find {nameof(ITestExtensionService1)} service.");
 
             // Tests
             Assert.IsTrue(success);
@@ -509,9 +510,9 @@ public void Test_05_04_UnregisterMixedRealityExtensionServicesByType()
 
             // Validate non-existent service
             var isService1Registered = MixedRealityToolkit.IsServiceRegistered<ITestExtensionService1>();
-            LogAssert.Expect(LogType.Error, $"Unable to find {typeof(ITestExtensionService1).Name} service.");
+            LogAssert.Expect(LogType.Error, $"Unable to find {nameof(ITestExtensionService1)} service.");
             var isService2Registered = MixedRealityToolkit.IsServiceRegistered<ITestExtensionService2>();
-            LogAssert.Expect(LogType.Error, $"Unable to find {typeof(ITestExtensionService2).Name} service.");
+            LogAssert.Expect(LogType.Error, $"Unable to find {nameof(ITestExtensionService2)} service.");
 
             // Tests
             Assert.IsTrue(success);
@@ -533,7 +534,7 @@ public void Test_05_05_MixedRealityExtensionService2DoesNotExist()
             var isServiceRegistered = MixedRealityToolkit.IsServiceRegistered<ITestExtensionService2>();
 
             // Tests
-            LogAssert.Expect(LogType.Error, $"Unable to find {typeof(ITestExtensionService2).Name} service.");
+            LogAssert.Expect(LogType.Error, $"Unable to find {nameof(ITestExtensionService2)} service.");
             Assert.IsFalse(isServiceRegistered);
         }
 

XRTK-Core/Packages/com.xrtk.core/Tests/InputSystem/TestFixture_03_InputSystemTests.cs

@@ -56,7 +56,7 @@ public void Test03_TestMixedRealityInputSystemDoesNotExist()
 
             // Tests
             Assert.IsFalse(inputSystemExists);
-            LogAssert.Expect(LogType.Error, $"Unable to find {typeof(IMixedRealityInputSystem).Name} service.");
+            LogAssert.Expect(LogType.Error, $"Unable to find {nameof(IMixedRealityInputSystem)} service.");
         }
 
         [Test]

XRTK-Core/Packages/manifest.json

@@ -17,7 +17,6 @@
     "com.unity.test-framework": "1.1.19",
     "com.unity.textmeshpro": "2.1.3",
     "com.unity.ugui": "1.0.0",
-    "com.unity.xr.legacyinputhelpers": "2.1.6",
     "com.unity.xr.magicleap": "4.1.3",
     "com.unity.modules.ai": "1.0.0",
     "com.unity.modules.androidjni": "1.0.0",

XRTK-Core/Packages/packages-lock.json

@@ -98,7 +98,7 @@
     },
     "com.unity.xr.legacyinputhelpers": {
       "version": "2.1.6",
-      "depth": 0,
+      "depth": 1,
       "source": "registry",
       "dependencies": {},
       "url": "https://packages.unity.com"