Report cohost status in initialize telemetry (#12001)

Fixes #11654

Author: davidwengier

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/RazorInitializeEndpoint.cs

@@ -11,15 +11,8 @@
 namespace Microsoft.AspNetCore.Razor.LanguageServer;
 
 [RazorLanguageServerEndpoint(Methods.InitializeName)]
-internal class RazorInitializeEndpoint(
-    LanguageServerFeatureOptions options,
-    ITelemetryReporter telemetryReporter) : IRazorDocumentlessRequestHandler<InitializeParams, InitializeResult>
+internal class RazorInitializeEndpoint : IRazorDocumentlessRequestHandler<InitializeParams, InitializeResult>
 {
-    private static bool s_reportedFeatureFlagState = false;
-
-    private readonly LanguageServerFeatureOptions _options = options;
-    private readonly ITelemetryReporter _telemetryReporter = telemetryReporter;
-
     public bool MutatesSolutionState { get; } = true;
 
     public Task<InitializeResult> HandleRequestAsync(InitializeParams request, RazorRequestContext requestContext, CancellationToken cancellationToken)
@@ -29,17 +22,6 @@ public Task<InitializeResult> HandleRequestAsync(InitializeParams request, Razor
         capabilitiesManager.SetInitializeParams(request);
         var serverCapabilities = capabilitiesManager.GetInitializeResult();
 
-        // Initialize can be called multiple times in a VS session, but the feature flag can't change in that time, so we only
-        // need to report once. In VS Code things could change between solution loads, but each solution load starts a new rzls
-        // process, so the static field gets reset anyway.
-        if (!s_reportedFeatureFlagState)
-        {
-            s_reportedFeatureFlagState = true;
-            _telemetryReporter.ReportEvent("initialize", Severity.Normal,
-                new Property(nameof(LanguageServerFeatureOptions.ForceRuntimeCodeGeneration), _options.ForceRuntimeCodeGeneration),
-                new Property(nameof(LanguageServerFeatureOptions.UseNewFormattingEngine), _options.UseNewFormattingEngine));
-        }
-
         return Task.FromResult(serverCapabilities);
     }
 }

src/Razor/src/Microsoft.CodeAnalysis.Razor.CohostingShared/CohostInitializeReporter.cs

@@ -0,0 +1,40 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.ComponentModel.Composition;
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.CodeAnalysis.ExternalAccess.Razor.Cohost;
+using Microsoft.CodeAnalysis.Razor.Telemetry;
+using Microsoft.CodeAnalysis.Razor.Workspaces;
+
+namespace Microsoft.VisualStudio.Razor.LanguageClient.Cohost;
+
+[Export(typeof(IRazorCohostStartupService))]
+[method: ImportingConstructor]
+internal class CohostInitializeReporter(
+    LanguageServerFeatureOptions languageServerFeatureOptions,
+    ITelemetryReporter telemetryReporter) : IRazorCohostStartupService
+{
+    private static bool s_reportedFeatureFlagState = false;
+
+    private readonly LanguageServerFeatureOptions _options = languageServerFeatureOptions;
+    private readonly ITelemetryReporter _telemetryReporter = telemetryReporter;
+
+    public int Order => WellKnownStartupOrder.Default;
+
+    public Task StartupAsync(VSInternalClientCapabilities clientCapabilities, RazorCohostRequestContext requestContext, CancellationToken cancellationToken)
+    {
+        // Make sure we don't report telemetry multiple times in the same VS session (as solutions are closed and opened).
+        if (!s_reportedFeatureFlagState)
+        {
+            s_reportedFeatureFlagState = true;
+            _telemetryReporter.ReportEvent("initialize", Severity.Normal,
+                new Property(nameof(LanguageServerFeatureOptions.ForceRuntimeCodeGeneration), _options.ForceRuntimeCodeGeneration),
+                new Property(nameof(LanguageServerFeatureOptions.UseNewFormattingEngine), _options.UseNewFormattingEngine),
+                new Property(nameof(LanguageServerFeatureOptions.UseRazorCohostServer), _options.UseRazorCohostServer));
+        }
+
+        return Task.CompletedTask;
+    }
+}

src/Razor/src/Microsoft.CodeAnalysis.Razor.CohostingShared/Microsoft.CodeAnalysis.Razor.CohostingShared.projitems

@@ -13,6 +13,7 @@
     <Compile Include="$(MSBuildThisFileDirectory)CodeActions\CohostCodeActionsResolveEndpoint.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)CohostEndpointAttribute.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)CohostDocSyncEndpointRegistration.cs" />
+    <Compile Include="$(MSBuildThisFileDirectory)CohostInitializeReporter.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)CohostStartupService.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)Completion\CohostCompletionListCache.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)Completion\CohostDocumentCompletionEndpoint.cs" />

src/Razor/src/Microsoft.VisualStudio.LanguageServices.Razor/LanguageClient/Cohost/IncompatibleProjectNotifier.cs

@@ -11,6 +11,7 @@
 using Microsoft.CodeAnalysis.Razor;
 using Microsoft.CodeAnalysis.Razor.Cohost;
 using Microsoft.CodeAnalysis.Razor.Logging;
+using Microsoft.CodeAnalysis.Razor.Telemetry;
 using WorkspacesSR = Microsoft.CodeAnalysis.Razor.Workspaces.Resources.SR;
 
 namespace Microsoft.VisualStudio.Razor.LanguageClient.Cohost;
@@ -19,14 +20,17 @@ namespace Microsoft.VisualStudio.Razor.LanguageClient.Cohost;
 [Export(typeof(IIncompatibleProjectNotifier))]
 [method: ImportingConstructor]
 internal sealed class IncompatibleProjectNotifier(
+    ITelemetryReporter telemetryReporter,
     ILoggerFactory loggerFactory) : IIncompatibleProjectNotifier, IProjectCapabilityListener
 {
     private readonly ILogger _logger = loggerFactory.GetOrCreateLogger<IncompatibleProjectNotifier>();
 
     private readonly HashSet<string> _frameworkProjects = new(PathUtilities.OSSpecificPathComparer);
+    private readonly ITelemetryReporter _telemetryReporter = telemetryReporter;
 
     public void NotifyMiscFilesDocument(TextDocument textDocument)
     {
+        _telemetryReporter.ReportEvent("cohost/miscFilesDocument", Severity.Normal);
         _logger.Log(LogLevel.Error, $"{WorkspacesSR.FormatIncompatibleProject_MiscFiles(Path.GetFileName(textDocument.FilePath))}");
     }
 
@@ -41,11 +45,13 @@ public void NotifyMissingDocument(Project project, string filePath)
             if (_frameworkProjects.Contains(project.FilePath.AssumeNotNull()))
             {
                 // This project doesn't have the .NET Core C# capability, so it's a .NET Framework project and we don't want
+
                 // to notify the user, as those projects use a different editor.
                 return;
             }
         }
 
+        _telemetryReporter.ReportEvent("cohost/missingDocument", Severity.Normal);
         _logger.Log(LogLevel.Error, $"{(
             project.AdditionalDocuments.Any(d => d.FilePath is not null && d.FilePath.IsRazorFilePath())
                 ? WorkspacesSR.FormatIncompatibleProject_NotAnAdditionalFile(Path.GetFileName(filePath), project.Name)

src/Razor/src/Microsoft.VisualStudio.RazorExtension/Microsoft.VisualStudio.RazorExtension.Custom.pkgdef

@@ -61,7 +61,7 @@
 "Description"="Uses the Razor language server that is cohosted in Roslyn to provide some Razor tooling functionality."
 "Value"=dword:00000000
 "Title"="Use Roslyn Cohost server for Razor (requires restart)"
-"PreviewPaneChannels"="IntPreview,int.main"
+"PreviewPaneChannels"="*"
 
 [$RootKey$\FeatureFlags\Razor\LSP\ForceRuntimeCodeGeneration]
 "Description"="Enable combined design time/runtime code generation for Razor files"

src/Razor/src/Microsoft.VisualStudioCode.RazorExtension/Services/IncompatibleProjectNotifier.cs

@@ -10,23 +10,29 @@
 using Microsoft.CodeAnalysis.Razor;
 using Microsoft.CodeAnalysis.Razor.Cohost;
 using Microsoft.CodeAnalysis.Razor.Logging;
+using Microsoft.CodeAnalysis.Razor.Telemetry;
 using WorkspacesSR = Microsoft.CodeAnalysis.Razor.Workspaces.Resources.SR;
 
 namespace Microsoft.VisualStudioCode.RazorExtension.Services;
 
 [Export(typeof(IIncompatibleProjectNotifier))]
 [method: ImportingConstructor]
-internal sealed class IncompatibleProjectNotifier(ILoggerFactory loggerFactory) : IIncompatibleProjectNotifier
+internal sealed class IncompatibleProjectNotifier(
+     ITelemetryReporter telemetryReporter,
+     ILoggerFactory loggerFactory) : IIncompatibleProjectNotifier
 {
     private readonly ILogger _logger = loggerFactory.GetOrCreateLogger<IncompatibleProjectNotifier>();
+    private readonly ITelemetryReporter _telemetryReporter = telemetryReporter;
 
     public void NotifyMiscFilesDocument(TextDocument textDocument)
     {
+        _telemetryReporter.ReportEvent("cohost/miscFilesDocument", Severity.Normal);
         _logger.Log(LogLevel.Error, $"{WorkspacesSR.FormatIncompatibleProject_MiscFiles(Path.GetFileName(textDocument.FilePath))}");
     }
 
     public void NotifyMissingDocument(Project project, string filePath)
     {
+        _telemetryReporter.ReportEvent("cohost/missingDocument", Severity.Normal);
         _logger.Log(LogLevel.Error, $"{(
             project.AdditionalDocuments.Any(d => d.FilePath is not null && d.FilePath.IsRazorFilePath())
                 ? WorkspacesSR.FormatIncompatibleProject_NotAnAdditionalFile(Path.GetFileName(filePath), project.Name)