blob: 7098d096d037fb90f8892e9d56b672259c11cd1e [file] [log] [blame]
// Copyright (c) 2018, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
import 'dart:async';
import 'package:analysis_server/lsp_protocol/protocol_custom_generated.dart';
import 'package:analysis_server/lsp_protocol/protocol_generated.dart';
import 'package:analysis_server/lsp_protocol/protocol_special.dart';
import 'package:analysis_server/src/analysis_server.dart';
import 'package:analysis_server/src/analysis_server_abstract.dart';
import 'package:analysis_server/src/collections.dart';
import 'package:analysis_server/src/computer/computer_closingLabels.dart';
import 'package:analysis_server/src/computer/computer_outline.dart';
import 'package:analysis_server/src/context_manager.dart';
import 'package:analysis_server/src/domain_completion.dart'
show CompletionDomainHandler;
import 'package:analysis_server/src/flutter/flutter_outline_computer.dart';
import 'package:analysis_server/src/lsp/channel/lsp_channel.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/constants.dart';
import 'package:analysis_server/src/lsp/handlers/handler_states.dart';
import 'package:analysis_server/src/lsp/handlers/handlers.dart';
import 'package:analysis_server/src/lsp/mapping.dart';
import 'package:analysis_server/src/lsp/notification_manager.dart';
import 'package:analysis_server/src/lsp/progress.dart';
import 'package:analysis_server/src/lsp/server_capabilities_computer.dart';
import 'package:analysis_server/src/plugin/notification_manager.dart';
import 'package:analysis_server/src/plugin/plugin_manager.dart';
import 'package:analysis_server/src/protocol_server.dart' as protocol;
import 'package:analysis_server/src/server/crash_reporting_attachments.dart';
import 'package:analysis_server/src/server/diagnostic_server.dart';
import 'package:analysis_server/src/server/error_notifier.dart';
import 'package:analysis_server/src/services/completion/completion_performance.dart'
show CompletionPerformance;
import 'package:analysis_server/src/services/refactoring/refactoring.dart';
import 'package:analysis_server/src/utilities/process.dart';
import 'package:analyzer/dart/analysis/context_locator.dart';
import 'package:analyzer/dart/analysis/results.dart';
import 'package:analyzer/error/error.dart';
import 'package:analyzer/exception/exception.dart';
import 'package:analyzer/file_system/file_system.dart';
import 'package:analyzer/instrumentation/instrumentation.dart';
import 'package:analyzer/source/line_info.dart';
import 'package:analyzer/src/dart/analysis/driver.dart' as analysis;
import 'package:analyzer/src/dart/analysis/status.dart' as analysis;
import 'package:analyzer/src/generated/sdk.dart';
import 'package:analyzer/src/util/file_paths.dart' as file_paths;
import 'package:analyzer_plugin/protocol/protocol_common.dart' as plugin;
import 'package:analyzer_plugin/protocol/protocol_generated.dart' as plugin;
import 'package:analyzer_plugin/src/protocol/protocol_internal.dart' as plugin;
import 'package:collection/collection.dart';
import 'package:http/http.dart' as http;
import 'package:meta/meta.dart';
import 'package:watcher/watcher.dart';
/// Instances of the class [LspAnalysisServer] implement an LSP-based server
/// that listens on a [CommunicationChannel] for LSP messages and processes
/// them.
class LspAnalysisServer extends AbstractAnalysisServer {
/// The capabilities of the LSP client. Will be null prior to initialization.
LspClientCapabilities? _clientCapabilities;
/// Initialization options provided by the LSP client. Allows opting in/out of
/// specific server functionality. Will be null prior to initialization.
LspInitializationOptions? _initializationOptions;
/// Configuration for the workspace from the client. This is similar to
/// initializationOptions but can be updated dynamically rather than set
/// only when the server starts.
final LspClientConfiguration clientConfiguration = LspClientConfiguration();
/// The channel from which messages are received and to which responses should
/// be sent.
final LspServerCommunicationChannel channel;
/// The workspace for rename refactorings. Should be accessed through the
/// refactoringWorkspace getter to be automatically created (lazily).
RefactoringWorkspace? _refactoringWorkspace;
/// The versions of each document known to the server (keyed by path), used to
/// send back to the client for server-initiated edits so that the client can
/// ensure they have a matching version of the document before applying them.
///
/// Handlers should prefer to use the `getVersionedDocumentIdentifier` method
/// which will return a null-versioned identifier if the document version is
/// not known.
final Map<String, VersionedTextDocumentIdentifier> documentVersions = {};
late ServerStateMessageHandler messageHandler;
int nextRequestId = 1;
final Map<int, Completer<ResponseMessage>> completers = {};
/// Capabilities of the server. Will be null prior to initialization as
/// the server capabilities depend on the client capabilities.
ServerCapabilities? capabilities;
late ServerCapabilitiesComputer capabilitiesComputer;
LspPerformance performanceStats = LspPerformance();
/// Whether or not the server is controlling the shutdown and will exit
/// automatically.
bool willExit = false;
StreamSubscription? _pluginChangeSubscription;
/// The current workspace folders provided by the client. Used as analysis roots.
final _workspaceFolders = <String>{};
/// A progress reporter for analysis status.
ProgressReporter? analyzingProgressReporter;
/// The number of times contexts have been created/recreated.
@visibleForTesting
int contextBuilds = 0;
/// Initialize a newly created server to send and receive messages to the
/// given [channel].
LspAnalysisServer(
this.channel,
ResourceProvider baseResourceProvider,
AnalysisServerOptions options,
DartSdkManager sdkManager,
CrashReportingAttachmentsBuilder crashReportingAttachmentsBuilder,
InstrumentationService instrumentationService, {
http.Client? httpClient,
ProcessRunner? processRunner,
DiagnosticServer? diagnosticServer,
// Disable to avoid using this in unit tests.
bool enableBazelWatcher = false,
}) : super(
options,
sdkManager,
diagnosticServer,
crashReportingAttachmentsBuilder,
baseResourceProvider,
instrumentationService,
httpClient,
processRunner,
LspNotificationManager(channel, baseResourceProvider.pathContext),
enableBazelWatcher: enableBazelWatcher,
) {
notificationManager.server = this;
messageHandler = UninitializedStateMessageHandler(this);
capabilitiesComputer = ServerCapabilitiesComputer(this);
final contextManagerCallbacks =
LspServerContextManagerCallbacks(this, resourceProvider);
contextManager.callbacks = contextManagerCallbacks;
analysisDriverScheduler.status.listen(sendStatusNotification);
analysisDriverScheduler.start();
channel.listen(handleMessage, onDone: done, onError: socketError);
_pluginChangeSubscription =
pluginManager.pluginsChanged.listen((_) => _onPluginsChanged());
}
/// The capabilities of the LSP client. Will be null prior to initialization.
LspClientCapabilities? get clientCapabilities => _clientCapabilities;
Future<void> get exited => channel.closed;
/// Initialization options provided by the LSP client. Allows opting in/out of
/// specific server functionality. Will be null prior to initialization.
LspInitializationOptions get initializationOptions =>
_initializationOptions as LspInitializationOptions;
@override
LspNotificationManager get notificationManager =>
super.notificationManager as LspNotificationManager;
@override
set pluginManager(PluginManager value) {
// we exchange the plugin manager in tests
super.pluginManager = value;
_pluginChangeSubscription?.cancel();
_pluginChangeSubscription =
pluginManager.pluginsChanged.listen((_) => _onPluginsChanged());
}
RefactoringWorkspace get refactoringWorkspace => _refactoringWorkspace ??=
RefactoringWorkspace(driverMap.values, searchEngine);
void addPriorityFile(String filePath) {
// When pubspecs are opened, trigger pre-loading of pub package names and
// versions.
if (file_paths.isPubspecYaml(resourceProvider.pathContext, filePath)) {
pubPackageService.beginCachePreloads([filePath]);
}
final didAdd = priorityFiles.add(filePath);
assert(didAdd);
if (didAdd) {
_updateDriversAndPluginsPriorityFiles();
_refreshAnalysisRoots();
}
}
/// The socket from which messages are being read has been closed.
void done() {}
/// Fetches configuration from the client (if supported) and then sends
/// register/unregister requests for any supported/enabled dynamic registrations.
Future<void> fetchClientConfigurationAndPerformDynamicRegistration() async {
if (clientCapabilities?.configuration ?? false) {
// Take a copy of workspace folders because we need to match up the
// responses to the request by index and it's possible _workspaceFolders
// will change after we sent the request but before we get the response.
final folders = _workspaceFolders.toList();
// Fetch all configuration we care about from the client. This is just
// "dart" for now, but in future this may be extended to include
// others (for example "flutter").
final response = await sendRequest(
Method.workspace_configuration,
ConfigurationParams(items: [
// Dart settings for each workspace folder.
for (final folder in folders)
ConfigurationItem(
scopeUri: Uri.file(folder).toString(),
section: 'dart',
),
// Global Dart settings. This comes last to simplify matching up the
// indexes in the results (folder[i] is the i'th item).
ConfigurationItem(section: 'dart'),
]));
final result = response.result;
// Expect the result to be a list with 1 + folders.length items to
// match the request above, and each should be a standard map of settings.
// If the above code is extended to support multiple sets of config
// this will need tweaking to handle the item for each section.
if (result != null &&
result is List<dynamic> &&
result.length == 1 + folders.length) {
// Config is stored as a map keyed by the workspace folder, and a key of
// null for the global config
final workspaceFolderConfig = {
for (var i = 0; i < folders.length; i++)
folders[i]: result[i] as Map<String, Object?>? ?? {},
};
final newGlobalConfig = result.last as Map<String, Object?>? ?? {};
final oldGlobalConfig = clientConfiguration.global;
clientConfiguration.replace(newGlobalConfig, workspaceFolderConfig);
if (clientConfiguration.affectsAnalysisRoots(oldGlobalConfig)) {
_refreshAnalysisRoots();
}
}
}
// Client config can affect capabilities, so this should only be done after
// we have the initial/updated config.
capabilitiesComputer.performDynamicRegistration();
}
/// Return the LineInfo for the file with the given [path]. The file is
/// analyzed in one of the analysis drivers to which the file was added,
/// otherwise in the first driver, otherwise `null` is returned.
LineInfo? getLineInfo(String path) {
var result = getAnalysisDriver(path)?.getFileSync2(path);
return result is FileResult ? result.lineInfo : null;
}
/// Gets the version of a document known to the server, returning a
/// [OptionalVersionedTextDocumentIdentifier] with a version of `null` if the document
/// version is not known.
OptionalVersionedTextDocumentIdentifier getVersionedDocumentIdentifier(
String path) {
return OptionalVersionedTextDocumentIdentifier(
uri: Uri.file(path).toString(),
version: documentVersions[path]?.version);
}
void handleClientConnection(
ClientCapabilities capabilities, dynamic initializationOptions) {
_clientCapabilities = LspClientCapabilities(capabilities);
_initializationOptions = LspInitializationOptions(initializationOptions);
performanceAfterStartup = ServerPerformance();
performance = performanceAfterStartup!;
}
/// Handles a response from the client by invoking the completer that the
/// outbound request created.
void handleClientResponse(ResponseMessage message) {
// The ID from the client is an Either2<num, String>?, though it's not valid
// for it to be a null or a string because it should match a request we sent
// to the client (and we always use numeric IDs for outgoing requests).
final id = message.id;
if (id == null) {
showErrorMessageToUser('Unexpected response with no ID!');
return;
}
id.map(
(id) {
// It's possible that even if we got a numeric ID that it's not valid.
// If it's not in our completers list (which is a list of the
// outstanding requests we've sent) then show an error.
final completer = completers[id];
if (completer == null) {
showErrorMessageToUser('Response with ID $id was unexpected');
} else {
completers.remove(id);
completer.complete(message);
}
},
(stringID) {
showErrorMessageToUser('Unexpected String ID for response $stringID');
},
);
}
/// Handle a [message] that was read from the communication channel.
void handleMessage(Message message) {
performance.logRequestTiming(null);
runZonedGuarded(() async {
try {
if (message is ResponseMessage) {
handleClientResponse(message);
} else if (message is RequestMessage) {
final result = await messageHandler.handleMessage(message);
if (result.isError) {
sendErrorResponse(message, result.error);
} else {
channel.sendResponse(ResponseMessage(
id: message.id,
result: result.result,
jsonrpc: jsonRpcVersion));
}
} else if (message is NotificationMessage) {
final result = await messageHandler.handleMessage(message);
if (result.isError) {
sendErrorResponse(message, result.error);
}
} else {
showErrorMessageToUser('Unknown message type');
}
} catch (error, stackTrace) {
final errorMessage = message is ResponseMessage
? 'An error occurred while handling the response to request ${message.id}'
: message is RequestMessage
? 'An error occurred while handling ${message.method} request'
: message is NotificationMessage
? 'An error occurred while handling ${message.method} notification'
: 'Unknown message type';
sendErrorResponse(
message,
ResponseError(
code: ServerErrorCodes.UnhandledError,
message: errorMessage,
));
logException(errorMessage, error, stackTrace);
}
}, socketError);
}
/// Logs the error on the client using window/logMessage.
void logErrorToClient(String message) {
channel.sendNotification(NotificationMessage(
method: Method.window_logMessage,
params: LogMessageParams(type: MessageType.Error, message: message),
jsonrpc: jsonRpcVersion,
));
}
/// Logs an exception by sending it to the client (window/logMessage) and
/// recording it in a buffer on the server for diagnostics.
void logException(String message, exception, stackTrace) {
var fullMessage = message;
if (exception is CaughtException) {
stackTrace ??= exception.stackTrace;
fullMessage = '$fullMessage: ${exception.exception}';
} else if (exception != null) {
fullMessage = '$fullMessage: $exception';
}
final fullError =
stackTrace == null ? fullMessage : '$fullMessage\n$stackTrace';
// Log the full message since showMessage above may be truncated or
// formatted badly (eg. VS Code takes the newlines out).
logErrorToClient(fullError);
// remember the last few exceptions
exceptions.add(ServerException(
message,
exception,
stackTrace is StackTrace ? stackTrace : StackTrace.current,
false,
));
instrumentationService.logException(
FatalException(
message,
exception,
stackTrace,
),
null,
crashReportingAttachmentsBuilder.forException(exception),
);
}
void onOverlayCreated(String path, String content) {
resourceProvider.setOverlay(path,
content: content, modificationStamp: overlayModificationStamp++);
_afterOverlayChanged(path, plugin.AddContentOverlay(content));
}
void onOverlayDestroyed(String path) {
resourceProvider.removeOverlay(path);
_afterOverlayChanged(path, plugin.RemoveContentOverlay());
}
/// Updates an overlay on [path] by applying the [edits] to the current
/// overlay.
///
/// If the result of applying the edits is already known, [newContent] can be
/// set to avoid doing that calculation twice.
void onOverlayUpdated(String path, List<plugin.SourceEdit> edits,
{String? newContent}) {
assert(resourceProvider.hasOverlay(path));
if (newContent == null) {
final oldContent = resourceProvider.getFile(path).readAsStringSync();
newContent = plugin.applySequenceOfEdits(oldContent, edits);
}
resourceProvider.setOverlay(path,
content: newContent, modificationStamp: overlayModificationStamp++);
_afterOverlayChanged(path, plugin.ChangeContentOverlay(edits));
}
void publishClosingLabels(String path, List<ClosingLabel> labels) {
final params = PublishClosingLabelsParams(
uri: Uri.file(path).toString(), labels: labels);
final message = NotificationMessage(
method: CustomMethods.publishClosingLabels,
params: params,
jsonrpc: jsonRpcVersion,
);
sendNotification(message);
}
void publishDiagnostics(String path, List<Diagnostic> errors) {
final params = PublishDiagnosticsParams(
uri: Uri.file(path).toString(), diagnostics: errors);
final message = NotificationMessage(
method: Method.textDocument_publishDiagnostics,
params: params,
jsonrpc: jsonRpcVersion,
);
sendNotification(message);
}
void publishFlutterOutline(String path, FlutterOutline outline) {
final params = PublishFlutterOutlineParams(
uri: Uri.file(path).toString(), outline: outline);
final message = NotificationMessage(
method: CustomMethods.publishFlutterOutline,
params: params,
jsonrpc: jsonRpcVersion,
);
sendNotification(message);
}
void publishOutline(String path, Outline outline) {
final params =
PublishOutlineParams(uri: Uri.file(path).toString(), outline: outline);
final message = NotificationMessage(
method: CustomMethods.publishOutline,
params: params,
jsonrpc: jsonRpcVersion,
);
sendNotification(message);
}
void removePriorityFile(String path) {
final didRemove = priorityFiles.remove(path);
assert(didRemove);
if (didRemove) {
_updateDriversAndPluginsPriorityFiles();
_refreshAnalysisRoots();
}
}
void sendErrorResponse(Message message, ResponseError error) {
if (message is RequestMessage) {
channel.sendResponse(ResponseMessage(
id: message.id, error: error, jsonrpc: jsonRpcVersion));
} else if (message is ResponseMessage) {
// For bad response messages where we can't respond with an error, send it
// as show instead of log.
showErrorMessageToUser(error.message);
} else {
// For notifications where we couldn't respond with an error, send it as
// show instead of log.
showErrorMessageToUser(error.message);
}
// Handle fatal errors where the client/server state is out of sync and we
// should not continue.
if (error.code == ServerErrorCodes.ClientServerInconsistentState) {
// Do not process any further messages.
messageHandler = FailureStateMessageHandler(this);
final message = 'An unrecoverable error occurred.';
logErrorToClient(
'$message\n\n${error.message}\n\n${error.code}\n\n${error.data}');
shutdown();
}
}
/// Send the given [notification] to the client.
void sendNotification(NotificationMessage notification) {
channel.sendNotification(notification);
}
/// Send the given [request] to the client and wait for a response. Completes
/// with the raw [ResponseMessage] which could be an error response.
Future<ResponseMessage> sendRequest(Method method, Object params) {
final requestId = nextRequestId++;
final completer = Completer<ResponseMessage>();
completers[requestId] = completer;
channel.sendRequest(RequestMessage(
id: Either2<int, String>.t1(requestId),
method: method,
params: params,
jsonrpc: jsonRpcVersion,
));
return completer.future;
}
/// Send the given [response] to the client.
void sendResponse(ResponseMessage response) {
channel.sendResponse(response);
}
@override
void sendServerErrorNotification(String message, exception, stackTrace,
{bool fatal = false}) {
message = exception == null ? message : '$message: $exception';
// Show message (without stack) to the user.
showErrorMessageToUser(message);
logException(message, exception, stackTrace);
}
/// Send status notification to the client. The state of analysis is given by
/// the [status] information.
Future<void> sendStatusNotification(analysis.AnalysisStatus status) async {
// Send old custom notifications to clients that do not support $/progress.
// TODO(dantup): Remove this custom notification (and related classes) when
// it's unlikely to be in use by any clients.
if (clientCapabilities?.workDoneProgress != true) {
channel.sendNotification(NotificationMessage(
method: CustomMethods.analyzerStatus,
params: AnalyzerStatusParams(isAnalyzing: status.isAnalyzing),
jsonrpc: jsonRpcVersion,
));
return;
}
if (status.isAnalyzing) {
analyzingProgressReporter ??=
ProgressReporter.serverCreated(this, analyzingProgressToken)
..begin('Analyzing…');
} else {
if (analyzingProgressReporter != null) {
// Do not null this out until after end completes, otherwise we may try
// to create a new token before it's really completed.
await analyzingProgressReporter?.end();
analyzingProgressReporter = null;
}
}
}
/// Returns `true` if closing labels should be sent for [file] with the given
/// absolute path.
bool shouldSendClosingLabelsFor(String file) {
// Closing labels should only be sent for open (priority) files in the
// workspace.
return initializationOptions.closingLabels &&
priorityFiles.contains(file) &&
isAnalyzed(file);
}
/// Returns `true` if Flutter outlines should be sent for [file] with the
/// given absolute path.
bool shouldSendFlutterOutlineFor(String file) {
// Outlines should only be sent for open (priority) files in the workspace.
return initializationOptions.flutterOutline && priorityFiles.contains(file);
}
/// Returns `true` if outlines should be sent for [file] with the given
/// absolute path.
bool shouldSendOutlineFor(String file) {
// Outlines should only be sent for open (priority) files in the workspace.
return initializationOptions.outline && priorityFiles.contains(file);
}
void showErrorMessageToUser(String message) {
showMessageToUser(MessageType.Error, message);
}
void showMessageToUser(MessageType type, String message) {
channel.sendNotification(NotificationMessage(
method: Method.window_showMessage,
params: ShowMessageParams(type: type, message: message),
jsonrpc: jsonRpcVersion,
));
}
/// Shows the user a prompt with some actions to select using ShowMessageRequest.
Future<MessageActionItem> showUserPrompt(
MessageType type, String message, List<MessageActionItem> actions) async {
final response = await sendRequest(
Method.window_showMessageRequest,
ShowMessageRequestParams(type: type, message: message, actions: actions),
);
return MessageActionItem.fromJson(response.result as Map<String, Object?>);
}
@override
Future<void> shutdown() {
super.shutdown();
// Defer closing the channel so that the shutdown response can be sent and
// logged.
Future(() {
channel.close();
});
_pluginChangeSubscription?.cancel();
return Future.value();
}
/// There was an error related to the socket from which messages are being
/// read.
void socketError(error, stack) {
// Don't send to instrumentation service; not an internal error.
sendServerErrorNotification('Socket error', error, stack);
}
Future<void> updateWorkspaceFolders(
List<String> addedPaths, List<String> removedPaths) async {
// TODO(dantup): This is currently case-sensitive!
_workspaceFolders
..addAll(addedPaths)
..removeAll(removedPaths);
await fetchClientConfigurationAndPerformDynamicRegistration();
_refreshAnalysisRoots();
}
void _afterOverlayChanged(String path, dynamic changeForPlugins) {
driverMap.values.forEach((driver) => driver.changeFile(path));
pluginManager.setAnalysisUpdateContentParams(
plugin.AnalysisUpdateContentParams({path: changeForPlugins}),
);
notifyDeclarationsTracker(path);
notifyFlutterWidgetDescriptions(path);
}
/// Computes analysis roots for a set of open files.
///
/// This is used when there are no workspace folders open directly.
List<String> _getRootsForOpenFiles() {
final openFiles = priorityFiles.toList();
final contextLocator = ContextLocator(resourceProvider: resourceProvider);
final roots = contextLocator.locateRoots(includedPaths: openFiles);
var packages = <String>{};
var additionalFiles = <String>[];
for (var file in openFiles) {
var package = roots
.where((root) => root.isAnalyzed(file))
.map((root) => root.workspace.findPackageFor(file)?.root)
.firstWhereOrNull((p) => p != null);
if (package != null && !resourceProvider.getFolder(package).isRoot) {
packages.add(package);
} else {
additionalFiles.add(file);
}
}
return [
...packages,
...additionalFiles,
];
}
void _onPluginsChanged() {
capabilitiesComputer.performDynamicRegistration();
}
void _refreshAnalysisRoots() {
// When there are open folders, they are always the roots. If there are no
// open workspace folders, then we use the open (priority) files to compute
// roots.
final includedPaths = _workspaceFolders.isNotEmpty
? _workspaceFolders.toSet()
: _getRootsForOpenFiles();
final excludedPaths = clientConfiguration.global.analysisExcludedFolders
.expand((excludePath) => resourceProvider.pathContext
.isAbsolute(excludePath)
? [excludePath]
// Apply the relative path to each open workspace folder.
// TODO(dantup): Consider supporting per-workspace config by
// calling workspace/configuration whenever workspace folders change
// and caching the config for each one.
: _workspaceFolders.map(
(root) => resourceProvider.pathContext.join(root, excludePath)))
.toSet();
notificationManager.setAnalysisRoots(
includedPaths.toList(), excludedPaths.toList());
contextManager.setRoots(includedPaths.toList(), excludedPaths.toList());
}
void _updateDriversAndPluginsPriorityFiles() {
final priorityFilesList = priorityFiles.toList();
driverMap.values.forEach((driver) {
driver.priorityFiles = priorityFilesList;
});
final pluginPriorities =
plugin.AnalysisSetPriorityFilesParams(priorityFilesList);
pluginManager.setAnalysisSetPriorityFilesParams(pluginPriorities);
// Plugins send most of their analysis results via notifications, but with
// LSP we're supposed to have them available per request. Assume that we'll
// only receive requests for files that are currently open.
final pluginSubscriptions = plugin.AnalysisSetSubscriptionsParams({
for (final service in plugin.AnalysisService.VALUES)
service: priorityFilesList,
});
pluginManager.setAnalysisSetSubscriptionsParams(pluginSubscriptions);
notificationManager.setSubscriptions({
for (final service in protocol.AnalysisService.VALUES)
service: priorityFiles
});
}
}
class LspInitializationOptions {
final bool onlyAnalyzeProjectsWithOpenFiles;
final bool suggestFromUnimportedLibraries;
final bool closingLabels;
final bool outline;
final bool flutterOutline;
LspInitializationOptions(dynamic options)
: onlyAnalyzeProjectsWithOpenFiles = options != null &&
options['onlyAnalyzeProjectsWithOpenFiles'] == true,
// suggestFromUnimportedLibraries defaults to true, so must be
// explicitly passed as false to disable.
suggestFromUnimportedLibraries = options == null ||
options['suggestFromUnimportedLibraries'] != false,
closingLabels = options != null && options['closingLabels'] == true,
outline = options != null && options['outline'] == true,
flutterOutline = options != null && options['flutterOutline'] == true;
}
class LspPerformance {
/// A list of code completion performance measurements for the latest
/// completion operation up to [performanceListMaxLength] measurements.
final RecentBuffer<CompletionPerformance> completion =
RecentBuffer<CompletionPerformance>(
CompletionDomainHandler.performanceListMaxLength);
}
class LspServerContextManagerCallbacks extends ContextManagerCallbacks {
// TODO(dantup): Lots of copy/paste from the Analysis Server one here.
final LspAnalysisServer analysisServer;
/// The [ResourceProvider] by which paths are converted into [Resource]s.
final ResourceProvider resourceProvider;
/// The set of files for which notifications were sent.
final Set<String> filesToFlush = {};
LspServerContextManagerCallbacks(this.analysisServer, this.resourceProvider);
@override
void afterContextsCreated() {
analysisServer.contextBuilds++;
analysisServer.addContextsToDeclarationsTracker();
}
@override
void afterContextsDestroyed() {
for (var file in filesToFlush) {
analysisServer.publishDiagnostics(file, []);
}
filesToFlush.clear();
}
@override
void afterWatchEvent(WatchEvent event) {
// TODO: implement afterWatchEvent
}
@override
void applyFileRemoved(String file) {
analysisServer.publishDiagnostics(file, []);
filesToFlush.remove(file);
}
@override
void broadcastWatchEvent(WatchEvent event) {
analysisServer.notifyDeclarationsTracker(event.path);
analysisServer.notifyFlutterWidgetDescriptions(event.path);
analysisServer.pluginManager.broadcastWatchEvent(event);
}
@override
void listenAnalysisDriver(analysis.AnalysisDriver analysisDriver) {
// TODO(dantup): Is this required, or covered by
// addContextsToDeclarationsTracker? The original server does not appear to
// have an equivalent call.
final analysisContext = analysisDriver.analysisContext;
if (analysisContext != null) {
analysisServer.declarationsTracker?.addContext(analysisContext);
}
analysisDriver.results.listen((result) {
if (result is FileResult) {
_handleFileResult(result);
}
});
analysisDriver.exceptions.listen(analysisServer.logExceptionResult);
analysisDriver.priorityFiles = analysisServer.priorityFiles.toList();
}
@override
void pubspecChanged(String pubspecPath) {
analysisServer.pubPackageService.fetchPackageVersionsViaPubOutdated(
pubspecPath,
pubspecWasModified: true);
}
@override
void pubspecRemoved(String pubspecPath) {
analysisServer.pubPackageService.flushPackageCaches(pubspecPath);
}
@override
void recordAnalysisErrors(String path, List<protocol.AnalysisError> errors) {
final errorsToSend = errors.where(_shouldSendError).toList();
filesToFlush.add(path);
analysisServer.notificationManager
.recordAnalysisErrors(NotificationManager.serverId, path, errorsToSend);
}
void _handleFileResult(FileResult result) {
var path = result.path;
filesToFlush.add(path);
if (result is AnalysisResultWithErrors) {
if (analysisServer.isAnalyzed(path)) {
final serverErrors = protocol.doAnalysisError_listFromEngine(result);
recordAnalysisErrors(path, serverErrors);
}
}
if (result is ResolvedUnitResult) {
_handleResolvedUnitResult(result);
}
}
void _handleResolvedUnitResult(ResolvedUnitResult result) {
var path = result.path;
analysisServer.getDocumentationCacheFor(result)?.cacheFromResult(result);
analysisServer.getExtensionCacheFor(result)?.cacheFromResult(result);
final unit = result.unit;
if (analysisServer.shouldSendClosingLabelsFor(path)) {
final labels = DartUnitClosingLabelsComputer(result.lineInfo, unit)
.compute()
.map((l) => toClosingLabel(result.lineInfo, l))
.toList();
analysisServer.publishClosingLabels(path, labels);
}
if (analysisServer.shouldSendOutlineFor(path)) {
final outline = DartUnitOutlineComputer(
result,
withBasicFlutter: true,
).compute();
final lspOutline = toOutline(result.lineInfo, outline);
analysisServer.publishOutline(path, lspOutline);
}
if (analysisServer.shouldSendFlutterOutlineFor(path)) {
final outline = FlutterOutlineComputer(result).compute();
final lspOutline = toFlutterOutline(result.lineInfo, outline);
analysisServer.publishFlutterOutline(path, lspOutline);
}
}
bool _shouldSendError(protocol.AnalysisError error) {
if (error.type.name != ErrorType.TODO.name) {
return true;
}
if (analysisServer.clientConfiguration.global.showAllTodos) {
return true;
}
return analysisServer.clientConfiguration.global.showTodoTypes
.contains(error.code.toUpperCase());
}
}