Merge pull request #7688 from dibarbet/vscode_output_logging

Use new LogOutputChannel for improved logging experience

Author: dibarbet

.vscode/launch.json

@@ -24,7 +24,9 @@
                 "csharp-test-profile",
                 "${workspaceRoot}/test/lsptoolshost/integrationTests/testAssets/slnWithCsproj/.vscode/slnWithCsproj.code-workspace",
                 "--extensionDevelopmentPath=${workspaceRoot}",
-                "--extensionTestsPath=${workspaceRoot}/out/test/lsptoolshost/integrationTests"
+                "--extensionTestsPath=${workspaceRoot}/out/test/lsptoolshost/integrationTests",
+                "--log",
+                "ms-dotnettools.csharp:trace"
             ],
             "env": {
                 "CODE_EXTENSIONS_PATH": "${workspaceRoot}",
@@ -49,7 +51,9 @@
                 "csharp-test-profile",
                 "${workspaceRoot}/test/lsptoolshost/integrationTests/testAssets/slnWithCsproj/.vscode/devkit_slnWithCsproj.code-workspace",
                 "--extensionDevelopmentPath=${workspaceRoot}",
-                "--extensionTestsPath=${workspaceRoot}/out/test/lsptoolshost/integrationTests"
+                "--extensionTestsPath=${workspaceRoot}/out/test/lsptoolshost/integrationTests",
+                "--log",
+                "ms-dotnettools.csharp:trace"
             ],
             "env": {
                 "CODE_EXTENSIONS_PATH": "${workspaceRoot}",
@@ -74,7 +78,9 @@
                 "csharp-test-profile",
                 "${workspaceRoot}/test/razor/razorIntegrationTests/testAssets/BasicRazorApp2_1/.vscode/lsp_tools_host_BasicRazorApp2_1.code-workspace",
                 "--extensionDevelopmentPath=${workspaceRoot}",
-                "--extensionTestsPath=${workspaceRoot}/out/test/razor/razorIntegrationTests"
+                "--extensionTestsPath=${workspaceRoot}/out/test/razor/razorIntegrationTests",
+                "--log",
+                "ms-dotnettools.csharp:trace"
             ],
             "env": {
                 "CODE_EXTENSIONS_PATH": "${workspaceRoot}",

CHANGELOG.md

@@ -4,6 +4,12 @@
 - Debug from .csproj and .sln [#5876](https://github.com/dotnet/vscode-csharp/issues/5876)
 
 # 2.55.x
+* Switch to new log output window API and remove `dotnet.server.trace` (PR: [#7688](https://github.com/dotnet/vscode-csharp/pull/7688))
+* Update Roslyn to 4.13.0-1.24528.3 (PR: [#7688](https://github.com/dotnet/vscode-csharp/pull/7688))
+  * Fix crash when 'add await' analyzers binding expressions (PR: [#75644](https://github.com/dotnet/roslyn/pull/75644))
+  * Shorten names shown in 'pull member up' (PR: [#75643](https://github.com/dotnet/roslyn/pull/75643))
+  * Fix inaccessible constructors shown in sighelp (PR: [#75642](https://github.com/dotnet/roslyn/pull/75642))
+  * Allow the client to update the server logging level dynamically (PR: [#75615](https://github.com/dotnet/roslyn/pull/75615))
 * Bumped xamlTools to 17.13.35429.30 (PR: [#7706](https://github.com/dotnet/vscode-csharp/pull/7706))
 
 # 2.54.x

SUPPORT.md

@@ -19,15 +19,25 @@ We highly recommend using the C# extension's built-in command, `CSharp: Report a
 
 The template has a section to include the `C#` output window logs.  These logs are not automatically included as they may contain personal information (such as full file paths and project names), but they are key to resolving problems.  
 
-1.  First, set `dotnet.server.trace` to `Trace` in VSCode settings
-    ![settings window showing trace option](./docs/trace_logs.png)
-2.  Reload the window via the `Developer: Reload Window` (`workbench.action.reloadWindow`) command
+1.  Find the `C#` output window (`View` -> `Output`) and set the log level to `Trace`
+    ![c# output window showing trace option](./docs/csharp_trace.png)
+2.  Reproduce the issue
+3.  In the `C#` output window, select all (e.g. `cntrl+a`) and copy paste into the issue template under the 'C# Log' section.  If you need to redact file paths and other information, please do so at this time.
+4.  Once the logs are collected, reset the window log level to `Info`
+
+If the issue only reproduces on extension startup, you can set `Trace` as the default (see screenshot above), reload the window, and trace logs will be captured on startup.
+
+##### C# LSP Trace Logs
+Sometimes we need to know exactly what requests were sent to the Roslyn language server.  To capture these logs:
+
+1.  Set the log level to `Trace` for the `C#` output window as described above.
+2.  Find the `C# LSP Trace Logs` output window
 3.  Reproduce the issue
-4.  Open the output window via `View` -> `Output` and change to the `C#` output window.
-5.  Select all (e.g. cntrl+a) and copy paste into the issue template under the 'C# Log' section.  If you need to redact file paths and other information, please do so at this time.
-6.  Once the logs are collected, reset `dotnet.server.trace` back to `Information`
+4.  Copy the contents of the `C# LSP Trace Logs` output window.
 
-Oftentimes the C# logs are enough, but sometimes when dealing with LSP server issues, the LSP trace logs are required.  These can be found by following the same steps as above, but using the `C# LSP Trace Logs` output window instead.
+##### Other ways to set the log level
+1.  When launching VSCode from the CLI, pass the `--log ms-dotnettools.csharp:trace` parameter.
+2.  Invoke the `Developer: Set Log Level` command from the VSCode command palette, find the `C#` entry and set the level.
 
 #### Project loading problems
 

docs/csharp_trace.png

@@ -37,7 +37,7 @@
     }
   },
   "defaults": {
-    "roslyn": "4.13.0-1.24525.2",
+    "roslyn": "4.13.0-1.24528.3",
     "omniSharp": "1.39.11",
     "razor": "9.0.0-preview.24524.4",
     "razorOmnisharp": "7.0.0-preview.23363.1",
@@ -132,7 +132,7 @@
     "@types/tmp": "0.0.33",
     "@types/unzipper": "^0.9.1",
     "@types/uuid": "^9.0.1",
-    "@types/vscode": "1.73.0",
+    "@types/vscode": "1.93.0",
     "@types/yauzl": "2.10.0",
     "@typescript-eslint/eslint-plugin": "^8.5.0",
     "@typescript-eslint/parser": "^8.5.0",
@@ -689,7 +689,7 @@
     }
   ],
   "engines": {
-    "vscode": "^1.75.0"
+    "vscode": "^1.93.0"
   },
   "activationEvents": [
     "onDebugInitialConfigurations",
@@ -1441,21 +1441,6 @@
             "default": false,
             "description": "%configuration.dotnet.server.waitForDebugger%"
           },
-          "dotnet.server.trace": {
-            "scope": "window",
-            "type": "string",
-            "enum": [
-              "Trace",
-              "Debug",
-              "Information",
-              "Warning",
-              "Error",
-              "Critical",
-              "None"
-            ],
-            "default": "Information",
-            "description": "%configuration.dotnet.server.trace%"
-          },
           "dotnet.server.extensionPaths": {
             "scope": "machine-overridable",
             "type": [

docs/trace_logs.png

@@ -69,7 +69,6 @@
   "configuration.dotnet.server.startTimeout": "Určuje časový limit (v ms), aby se klient úspěšně spustil a připojil k jazykovému serveru.",
   "configuration.dotnet.server.suppressLspErrorToasts": "Potlačí zobrazování informačních zpráv o chybách, pokud na serveru dojde k chybě, ze které se dá zotavit.",
   "configuration.dotnet.server.suppressMiscellaneousFilesToasts": "Potlačí zobrazování informačních upozornění, pokud je aktivní dokument mimo otevřený pracovní prostor.",
-  "configuration.dotnet.server.trace": "Nastaví úroveň protokolování pro jazykový server",
   "configuration.dotnet.server.useServerGC": "Nakonfigurujte jazykový server tak, aby používal uvolňování paměti serveru .NET.  Uvolňování paměti serveru obecně přináší vyšší výkon za cenu vyšší spotřeby paměti.",
   "configuration.dotnet.server.waitForDebugger": "Při spuštění serveru předá příznak --debug, aby bylo možné připojit ladicí program. (Dříve omnisharp.waitForDebugger)",
   "configuration.dotnet.symbolSearch.searchReferenceAssemblies": "Hledat symboly v referenčních sestaveních Ovlivňuje funkce, které vyžadují vyhledávání symbolů, například přidání importů.",

package-lock.json

@@ -69,7 +69,6 @@
   "configuration.dotnet.server.startTimeout": "Gibt ein Timeout (in ms) an, mit dem der Client erfolgreich gestartet und eine Verbindung mit dem Sprachserver hergestellt werden kann.",
   "configuration.dotnet.server.suppressLspErrorToasts": "Unterdrückt, dass Fehler-Popups angezeigt werden, wenn auf dem Server ein wiederherstellbarer Fehler auftritt.",
   "configuration.dotnet.server.suppressMiscellaneousFilesToasts": "Hiermit wird die Anzeige von Popupwarnungen unterdrückt, wenn sich das aktive Dokument außerhalb des geöffneten Arbeitsbereichs befindet.",
-  "configuration.dotnet.server.trace": "Legt den Protokolliergrad für den Sprachserver fest.",
   "configuration.dotnet.server.useServerGC": "Konfigurieren Sie den Sprachserver für die Verwendung der GC des .NET-Servers.  Die GC auf dem Server bietet im Allgemeinen eine bessere Leistung bei einem höheren Arbeitsspeicherverbrauch.",
   "configuration.dotnet.server.waitForDebugger": "Übergibt das Flag \"--debug\" beim Starten des Servers, damit ein Debugger angefügt werden kann. (Zuvor \"omnisharp.waitForDebugger\")",
   "configuration.dotnet.symbolSearch.searchReferenceAssemblies": "Symbole in Verweisassemblys suchen. Dies wirkt sich auf Features aus, die eine Symbolsuche erfordern, z. B. Importe hinzufügen.",

package.json

@@ -69,7 +69,6 @@
   "configuration.dotnet.server.startTimeout": "Especifica un tiempo de espera (en ms) para que el cliente se inicie correctamente y se conecte al servidor de lenguaje.",
   "configuration.dotnet.server.suppressLspErrorToasts": "Suprime la visualización de notificaciones del sistema de error si el servidor encuentra un error recuperable.",
   "configuration.dotnet.server.suppressMiscellaneousFilesToasts": "Impida que aparezcan notificaciones de advertencia si el documento activo se encuentra fuera del área de trabajo abierta.",
-  "configuration.dotnet.server.trace": "Establece el nivel de registro para el servidor de lenguaje",
   "configuration.dotnet.server.useServerGC": "Configure el servidor de idiomas para usar la recolección de elementos no utilizados del servidor de .NET.  La recolección de elementos no utilizados del servidor suele proporcionar un mejor rendimiento a costa de un mayor consumo de memoria.",
   "configuration.dotnet.server.waitForDebugger": "Pasa la marca --debug al iniciar el servidor para permitir que se adjunte un depurador. (Anteriormente \"omnisharp.waitForDebugger\")",
   "configuration.dotnet.symbolSearch.searchReferenceAssemblies": "Buscar símbolos en ensamblados de referencia. Afecta a las características y requiere la búsqueda de símbolos, como agregar importaciones.",