Add the Troubleshooting section (#90)

.config/dotnet-tools.json

@@ -3,7 +3,7 @@
     "isRoot": true,
     "tools": {
       "cake.tool": {
-        "version": "3.2.0",
+        "version": "4.0.0",
         "commands": [
           "dotnet-cake"
         ]

README.md

@@ -116,6 +116,19 @@ Conversion complete
 
  *The profiler can capture and analyze functions executed within the Mono runtime. To profile native code, you can leverage platform-specific tools, such as Android Studio and Xcode.*
 
+### Troubleshooting
+
+**.NET Meteor** uses the `.NET Diagnostics` tools to profile applications. The process of profiling consists of two stages:
+
+1) `dsrouter` creates a connection between the application and the profiler.
+2) `dotnet-trace` or `dotnet-gcdump` captures the data.
+
+If you encounter any issues, please check the following:
+
+- VSCode **Debug Console** tab should display a message about the successful connection. If you see the `Router stopped` message or something similar, the connection is not established. You can try to change the **profiler port** in the **.NET Meteor** settings.
+
+- When profiling is started, the **Debug Console** tab should display the `Output File:` message. If you don't see this message after running the app and displaying the first view (after the splash screen), try deleting the `bin` and `obj` folders and rerunning the project. *Sometimes the issue occurs when you frequently switch between the profiling and debugging modes.*
+
 ---
 
 ## Compatibility

azure-pipelines.yml

@@ -202,25 +202,27 @@ stages:
             failTaskOnMissingResultsFile: true
 #//////////////////////////////////////////////////////////////////////
 #// Windows Tests
+#// TODO: Hangs on Azure DevOps
+#// uncomment when new version of DotNet is available
 #//////////////////////////////////////////////////////////////////////
-      - job: Windows
-        pool:
-          vmImage: windows-latest
-        timeoutInMinutes: 15
-        steps:
-        - task: UseDotNet@2
-          inputs:
-            version: '9.x'
-            includePreviewVersions: true
-        - script: dotnet tool restore
-          displayName: 'Restore .NET tools'
-        - script: dotnet cake --target=test --configuration=release
-          displayName: 'Run tests'
-          continueOnError: true
-        - task: PublishTestResults@2
-          inputs:
-            testResultsFormat: 'VSTest'
-            testResultsFiles: 'artifacts/*.trx'
-            failTaskOnFailedTests: true
-            failTaskOnMissingResultsFile: true
+      # - job: Windows
+      #   pool:
+      #     vmImage: windows-latest
+      #   timeoutInMinutes: 10
+      #   steps:
+      #   - task: UseDotNet@2
+      #     inputs:
+      #       version: '9.x'
+      #       includePreviewVersions: true
+      #   - script: dotnet tool restore
+      #     displayName: 'Restore .NET tools'
+      #   - script: dotnet cake --target=test --configuration=release
+      #     displayName: 'Run tests'
+      #     continueOnError: true
+      #   - task: PublishTestResults@2
+      #     inputs:
+      #       testResultsFormat: 'VSTest'
+      #       testResultsFiles: 'artifacts/*.trx'
+      #       failTaskOnFailedTests: true
+      #       failTaskOnMissingResultsFile: true
 

build.cake

@@ -1,4 +1,4 @@
-#addin nuget:?package=Cake.FileHelpers&version=6.1.2
+#addin nuget:?package=Cake.FileHelpers&version=7.0.0
 
 using _Path = System.IO.Path;
 

src/DotNet.Meteor.Tests/DotNet.Meteor.Tests.csproj

@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
 	<Import Project="..\Common.Build.props" />
-	
+
 	<ItemGroup>
 		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
 		<PackageReference Include="xunit" Version="2.7.1" />

src/DotNet.Meteor.Workspace/DeviceProvider.cs

@@ -6,29 +6,40 @@
 namespace DotNet.Meteor.Workspace;
 
 public static class DeviceProvider {
-    public static List<DeviceData> GetDevices(Action<Exception>? errorHandler = null) {
+    public static List<DeviceData> GetDevices(Action<Exception>? errorHandler = null, Action<string>? debugHandler = null) {
         var devices = new List<DeviceData>();
+        debugHandler?.Invoke("Fetching devices...");
 
-        try { /* Windows Devices */
+        try {
             if (RuntimeSystem.IsWindows) {
                 devices.Add(WindowsTool.WindowsDevice());
+                debugHandler?.Invoke("Windows device added.");
                 //TODO: devices.Add(IDeviceTool.Info());
             }
         } catch (Exception e) { errorHandler?.Invoke(e); }
 
-        try { /* Android Devices */
+        try {
             devices.AddRange(AndroidTool.PhysicalDevices().OrderBy(x => x.Name));
+            debugHandler?.Invoke("Android physical devices added.");
+
             devices.AddRange(AndroidTool.VirtualDevices().OrderBy(x => !x.IsRunning).ThenBy(x => x.Name));
+            debugHandler?.Invoke("Android virtual devices added.");
         } catch (Exception e) { errorHandler?.Invoke(e); }
 
-        try { /* Apple Devices */
+        try {
             if (RuntimeSystem.IsMacOS) {
                 devices.AddRange(AppleTool.MacintoshDevices());
+                debugHandler?.Invoke("MacOS devices added.");
+
                 devices.AddRange(AppleTool.PhysicalDevices().OrderBy(x => x.Name));
+                debugHandler?.Invoke("Apple physical devices added.");
+
                 devices.AddRange(AppleTool.VirtualDevices().OrderBy(x => !x.IsRunning).ThenBy(x => x.Name));
+                debugHandler?.Invoke("Apple virtual devices added.");
             }
         } catch (Exception e) { errorHandler?.Invoke(e); }
 
+        debugHandler?.Invoke($"Devices fetched. Total: {devices.Count}.");
         return devices;
     }
-    }
+}

src/DotNet.Meteor.Workspace/Main.cs

@@ -37,7 +37,7 @@ public class Program {
     }
 
     public static void AllDevices(string[] args) {
-        var devices = DeviceProvider.GetDevices(logger.Error);
+        var devices = DeviceProvider.GetDevices(logger.Error, logger.Debug);
         Console.WriteLine(JsonSerializer.Serialize(devices, TrimmableContext.Default.ListDeviceData));
     }