[analysis_server] Minor LSP refactors + fix

Some minor fixes/tweaks extracted from another CL

1. Fix tool/lsp_spec/codegen_dart to set `options` on `CodeStyleOptions` (a late field that needs to be set to the owning options file)
2. Fix a wrapped TODO to be indented so it's detected correctly
3. Move the custom `DartTextDocumentContentProviderHandler` handler into the `custom` folder
4. Merge `LspHandlerHelperMixin ` into `HandlerHelperMixin` since the APIs it uses are no longer LSP-specific and exist on the base server

Change-Id: Ie1b3a8057575346cf9bfb98465c0a3e330c28a82
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/392909
Reviewed-by: Brian Wilkerson <[email protected]>
Commit-Queue: Phil Quitslund <[email protected]>
Reviewed-by: Phil Quitslund <[email protected]>

Author: DanTup

pkg/analysis_server/lib/src/lsp/constants.dart

@@ -144,7 +144,7 @@ abstract final class CustomMethods {
       Method('dart/textDocumentContentDidChange');
 
   // TODO(dantup): Remove custom AnalyzerStatus status method soon as no clients
-  // should be relying on it as we now support proper $/progress events.
+  //  should be relying on it as we now support proper $/progress events.
   static const analyzerStatus = Method(r'$/analyzerStatus');
 
   /// Semantic tokens are dynamically registered using a single string

pkg/analysis_server/lib/src/lsp/handlers/commands/fix_all.dart

@@ -16,8 +16,7 @@ import 'package:analysis_server/src/lsp/temporary_overlay_operation.dart';
 import 'package:analysis_server/src/services/correction/bulk_fix_processor.dart';
 import 'package:analysis_server/src/utilities/source_change_merger.dart';
 
-class FixAllCommandHandler extends SimpleEditCommandHandler
-    with LspHandlerHelperMixin {
+class FixAllCommandHandler extends SimpleEditCommandHandler {
   FixAllCommandHandler(super.server);
 
   @override

pkg/analysis_server/lib/src/lsp/handlers/commands/perform_refactor.dart

@@ -14,8 +14,7 @@ import 'package:analysis_server/src/lsp/progress.dart';
 import 'package:analysis_server/src/protocol_server.dart';
 import 'package:meta/meta.dart';
 
-class PerformRefactorCommandHandler extends AbstractRefactorCommandHandler
-    with LspHandlerHelperMixin {
+class PerformRefactorCommandHandler extends AbstractRefactorCommandHandler {
   /// A [Future] used by tests to allow inserting a delay between resolving
   /// the initial unit and the refactor running.
   @visibleForTesting

pkg/analysis_server/lib/src/lsp/handlers/handler_dart_text_document_content_provider.dart renamed to pkg/analysis_server/lib/src/lsp/handlers/custom/handler_dart_text_document_content_provider.dart

@@ -41,7 +41,7 @@ typedef _ScoredCompletionItem = ({CompletionItem item, double score});
 
 class CompletionHandler
     extends LspMessageHandler<CompletionParams, CompletionList>
-    with LspPluginRequestHandlerMixin, LspHandlerHelperMixin {
+    with LspPluginRequestHandlerMixin {
   /// A [Future] used by tests to allow inserting a delay between resolving
   /// the initial unit and the completion code running.
   @visibleForTesting
@@ -528,7 +528,7 @@ class CompletionHandler
         for (var suggestion in candidateSuggestions.suggestions) {
           var item = await candidateSuggestionToCompletionItem(suggestion);
           if (item != null) {
-              completionItems.add((item: item, score: suggestion.matcherScore));          
+            completionItems.add((item: item, score: suggestion.matcherScore));
           }
         }
         return completionItems;

pkg/analysis_server/lib/src/lsp/handlers/handler_completion.dart

@@ -13,8 +13,7 @@ typedef StaticOptions
     = Either3<bool, InlayHintOptions, InlayHintRegistrationOptions>;
 
 class InlayHintHandler
-    extends LspMessageHandler<InlayHintParams, List<InlayHint>>
-    with LspHandlerHelperMixin {
+    extends LspMessageHandler<InlayHintParams, List<InlayHint>> {
   InlayHintHandler(super.server);
   @override
   Method get handlesMessage => Method.textDocument_inlayHint;

pkg/analysis_server/lib/src/lsp/handlers/handler_inlay_hint.dart

@@ -99,8 +99,7 @@ class PrepareRenameHandler extends LspMessageHandler<TextDocumentPositionParams,
   }
 }
 
-class RenameHandler extends LspMessageHandler<RenameParams, WorkspaceEdit?>
-    with LspHandlerHelperMixin {
+class RenameHandler extends LspMessageHandler<RenameParams, WorkspaceEdit?> {
   RenameHandler(super.server);
 
   LspGlobalClientConfiguration get config =>

pkg/analysis_server/lib/src/lsp/handlers/handler_rename.dart

@@ -11,6 +11,7 @@ import 'package:analysis_server/src/lsp/error_or.dart';
 import 'package:analysis_server/src/lsp/handlers/custom/handler_augmentation.dart';
 import 'package:analysis_server/src/lsp/handlers/custom/handler_augmented.dart';
 import 'package:analysis_server/src/lsp/handlers/custom/handler_connect_to_dtd.dart';
+import 'package:analysis_server/src/lsp/handlers/custom/handler_dart_text_document_content_provider.dart';
 import 'package:analysis_server/src/lsp/handlers/custom/handler_diagnostic_server.dart';
 import 'package:analysis_server/src/lsp/handlers/custom/handler_reanalyze.dart';
 import 'package:analysis_server/src/lsp/handlers/custom/handler_super.dart';
@@ -20,7 +21,6 @@ import 'package:analysis_server/src/lsp/handlers/handler_code_actions.dart';
 import 'package:analysis_server/src/lsp/handlers/handler_code_lens.dart';
 import 'package:analysis_server/src/lsp/handlers/handler_completion.dart';
 import 'package:analysis_server/src/lsp/handlers/handler_completion_resolve.dart';
-import 'package:analysis_server/src/lsp/handlers/handler_dart_text_document_content_provider.dart';
 import 'package:analysis_server/src/lsp/handlers/handler_definition.dart';
 import 'package:analysis_server/src/lsp/handlers/handler_document_color.dart';
 import 'package:analysis_server/src/lsp/handlers/handler_document_color_presentation.dart';

pkg/analysis_server/lib/src/lsp/handlers/handler_states.dart

@@ -83,9 +83,41 @@ mixin HandlerHelperMixin<S extends AnalysisServer> {
   ErrorOr<T> analysisFailedError<T>(String path) => error<T>(
       ServerErrorCodes.FileAnalysisFailed, 'Analysis failed for file', path);
 
+  /// Extracts the current document version from [textDocument] if available,
+  /// or uses the version that the server has via
+  /// [LspAnalysisServer.getVersionedDocumentIdentifier].
+  OptionalVersionedTextDocumentIdentifier extractDocumentVersion(
+    TextDocumentIdentifier textDocument,
+    String path,
+  ) {
+    return switch (textDocument) {
+      OptionalVersionedTextDocumentIdentifier() => textDocument,
+      VersionedTextDocumentIdentifier() =>
+        OptionalVersionedTextDocumentIdentifier(
+            uri: textDocument.uri, version: textDocument.version),
+      _ => server.getVersionedDocumentIdentifier(path),
+    };
+  }
+
+  bool fileHasBeenModified(String path, int? clientVersion) {
+    var serverDocumentVersion = server.getDocumentVersion(path);
+    return clientVersion != null && clientVersion != serverDocumentVersion;
+  }
+
   ErrorOr<T> fileNotAnalyzedError<T>(String path) => error<T>(
       ServerErrorCodes.FileNotAnalyzed, 'File is not being analyzed', path);
 
+  ErrorOr<LineInfo> getLineInfo(String path) {
+    var lineInfo = server.getLineInfo(path);
+
+    if (lineInfo == null) {
+      return error(ServerErrorCodes.InvalidFilePath,
+          'Unable to obtain line information for file', path);
+    } else {
+      return success(lineInfo);
+    }
+  }
+
   /// Returns whether [doc] is a user-editable document or not.
   ///
   /// Only editable documents have overlays and can be modified by the client.
@@ -254,44 +286,6 @@ mixin HandlerHelperMixin<S extends AnalysisServer> {
   }
 }
 
-/// Provides some helpers for request handlers to produce common errors or
-/// obtain resolved results after waiting for in-progress analysis.
-mixin LspHandlerHelperMixin {
-  LspAnalysisServer get server;
-
-  /// Extracts the current document version from [textDocument] if available,
-  /// or uses the version that the server has via
-  /// [LspAnalysisServer.getVersionedDocumentIdentifier].
-  OptionalVersionedTextDocumentIdentifier extractDocumentVersion(
-    TextDocumentIdentifier textDocument,
-    String path,
-  ) {
-    return switch (textDocument) {
-      OptionalVersionedTextDocumentIdentifier() => textDocument,
-      VersionedTextDocumentIdentifier() =>
-        OptionalVersionedTextDocumentIdentifier(
-            uri: textDocument.uri, version: textDocument.version),
-      _ => server.getVersionedDocumentIdentifier(path),
-    };
-  }
-
-  bool fileHasBeenModified(String path, int? clientVersion) {
-    var serverDocumentVersion = server.getDocumentVersion(path);
-    return clientVersion != null && clientVersion != serverDocumentVersion;
-  }
-
-  ErrorOr<LineInfo> getLineInfo(String path) {
-    var lineInfo = server.getLineInfo(path);
-
-    if (lineInfo == null) {
-      return error(ServerErrorCodes.InvalidFilePath,
-          'Unable to obtain line information for file', path);
-    } else {
-      return success(lineInfo);
-    }
-  }
-}
-
 /// A base class for LSP handlers that require an LSP analysis server and are
 /// not supported over the legacy protocol.
 abstract class LspMessageHandler<P, R>

pkg/analysis_server/lib/src/lsp/handlers/handlers.dart

@@ -5,12 +5,12 @@
 import 'package:analysis_server/lsp_protocol/protocol.dart';
 import 'package:analysis_server/src/lsp/client_capabilities.dart';
 import 'package:analysis_server/src/lsp/client_configuration.dart';
+import 'package:analysis_server/src/lsp/handlers/custom/handler_dart_text_document_content_provider.dart';
 import 'package:analysis_server/src/lsp/handlers/handler_call_hierarchy.dart';
 import 'package:analysis_server/src/lsp/handlers/handler_change_workspace_folders.dart';
 import 'package:analysis_server/src/lsp/handlers/handler_code_actions.dart';
 import 'package:analysis_server/src/lsp/handlers/handler_code_lens.dart';
 import 'package:analysis_server/src/lsp/handlers/handler_completion.dart';
-import 'package:analysis_server/src/lsp/handlers/handler_dart_text_document_content_provider.dart';
 import 'package:analysis_server/src/lsp/handlers/handler_definition.dart';
 import 'package:analysis_server/src/lsp/handlers/handler_document_color.dart';
 import 'package:analysis_server/src/lsp/handlers/handler_document_highlights.dart';