Add some real scenario logs and get them running successfully.

- Move analysis server startup into log_player.dart, parse the protocol
  from the arguments.
- Add {{workspaceRoot}} and {{dartSdk}} root placeholder support to log
  files.
- Create logs of a real sdk scenario (rename the analysis server class),
  anonymize the logs using the placeholders.

Future work:

- We should add support for mutating a log to put in these placeholders.
- Figure out how we want to support package dependencies in a similar way.
- Implement the matching for server responses so the scenarios don't just complete early.

Change-Id: Ic0f6ac9c26da9d0a4473d08709aa05e9ff1e8536
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/462620
Reviewed-by: Brian Wilkerson <[email protected]>
Reviewed-by: Keerti Parthasarathy <[email protected]>
Auto-Submit: Jake Macdonald <[email protected]>
Commit-Queue: Keerti Parthasarathy <[email protected]>

Author: jakemac53

pkg/analysis_server/tool/log_player/log.dart

@@ -14,17 +14,23 @@ class Log {
 
   /// Creates a log by reading the content of the [file] and decoding it as a
   /// list of entries.
-  factory Log.fromFile(File file) {
-    return Log.fromString(file.readAsStringSync());
+  factory Log.fromFile(File file, Map<String, String> replacements) {
+    return Log.fromString(file.readAsStringSync(), replacements);
   }
 
   /// Creates a log by decoding the [logContent] as a list of entries.
   ///
   /// The [logContent] should not include the opening and closing delimiters
   /// for a Json array ('[' and ']'), but otherwise should be a comma-separated
   /// list of json-encoded log entries.
-  factory Log.fromString(String logContent) {
+  ///
+  /// Each entry in [replacements] is all occurences of the key replaced with
+  /// the value.
+  factory Log.fromString(String logContent, Map<String, String> replacements) {
     logContent = logContent.trim();
+    for (var entry in replacements.entries) {
+      logContent = logContent.replaceAll(entry.key, entry.value);
+    }
     if (logContent.endsWith(',')) {
       logContent = logContent.substring(0, logContent.length - 1);
     }

pkg/analysis_server/tool/log_player/log_player.dart

@@ -2,6 +2,8 @@
 // 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 'package:analysis_server/src/server/driver.dart';
+import 'package:analysis_server/src/session_logger/entry_kind.dart';
 import 'package:analysis_server/src/session_logger/log_entry.dart';
 import 'package:analysis_server/src/session_logger/process_id.dart';
 
@@ -17,42 +19,68 @@ class LogPlayer {
   Log log;
 
   /// The object used to communicate with the running server.
-  ServerDriver server;
+  ServerDriver? server;
 
   /// Whether the `shutdown` method has been seen.
   bool _hasSeenShutdown = false;
 
   /// Whether the `exit` method has been seen.
   bool _hasSeenExit = false;
 
-  LogPlayer({required this.log, required this.server});
+  /// Arg parser equivalent to what the real driver uses, used to extract
+  /// options from command line arguments.
+  final driverArgParser = Driver.createArgParser();
+
+  LogPlayer({required this.log});
 
   /// Plays the log.
   Future<void> play() async {
     var entries = log.entries;
     var nextIndex = 0;
-    var entry = entries[nextIndex];
-    if (entry.isCommandLine) {
-      server.additionalArguments.addAll(entry.argList);
-      nextIndex++;
-    }
     while (nextIndex < entries.length) {
       // TODO(brianwilkerson): This doesn't currently attempt to retain the same
       //  timing of messages as was recorded in the log.
       var entry = entries[nextIndex];
-      if (entry.receiver == ProcessId.server) {
-        await _sendMessageToServer(entry);
-      } else if (entry.sender == ProcessId.server) {
-        _handleMessageFromServer(entry);
+      switch (entry.kind) {
+        case EntryKind.commandLine:
+          if (this.server != null) {
+            throw StateError(
+              'Analysis server already started, only one instance is allowed.',
+            );
+          }
+          var parsedArgs = driverArgParser.parse(entry.argList);
+          var protocolOption = parsedArgs.option(Driver.serverProtocolOption);
+          var protocol = switch (protocolOption) {
+            Driver.protocolAnalyzer => ServerProtocol.legacy,
+            Driver.protocolLsp => ServerProtocol.lsp,
+            _ => throw StateError('Unrecognized protocol $protocolOption'),
+          };
+          var server = this.server = ServerDriver(protocol: protocol);
+          server.additionalArguments.addAll(entry.argList);
+          await server.start();
+        case EntryKind.message:
+          if (entry.receiver == ProcessId.server) {
+            await _sendMessageToServer(entry);
+          } else if (entry.sender == ProcessId.server) {
+            _handleMessageFromServer(entry);
+          } else {
+            throw StateError('''
+Unexpected sender/reciever for message:
+
+sender: ${entry.sender}
+receiver: ${entry.receiver}
+''');
+          }
       }
       nextIndex++;
     }
     if (!_hasSeenShutdown) {
-      server.shutdown();
+      server?.shutdown();
     }
     if (!_hasSeenExit) {
-      server.exit();
+      server?.exit();
     }
+    server = null;
   }
 
   /// Responds to a message sent from the server to some other process.
@@ -86,6 +114,10 @@ class LogPlayer {
 
   /// Sends the message in the [entry] to the server.
   Future<void> _sendMessageToServer(LogEntry entry) async {
+    var server = this.server;
+    if (server == null) {
+      throw StateError('Analysis server not started.');
+    }
     var message = entry.message;
     switch (entry.sender) {
       case ProcessId.dtd:
@@ -104,6 +136,7 @@ class LogPlayer {
           _hasSeenShutdown = true;
         } else if (message.isExit) {
           _hasSeenExit = true;
+          this.server = null;
         }
         server.sendMessageFromIde(message);
       case ProcessId.plugin:

pkg/analysis_server/tool/log_player/server_driver.dart

@@ -83,7 +83,9 @@ class ServerDriver {
       );
     }
     _stdinSink?.close();
+    _stdinSink = null;
     _dtdSocket?.close();
+    _dtdSocket = null;
   }
 
   void sendMessageFromDTD(Message message) {
@@ -149,6 +151,12 @@ class ServerDriver {
 
   /// Create and start the server.
   Future<void> start() async {
+    if (_stdinSink != null) {
+      throw StateError(
+        'Analysis server already started, only one active instance is allowed '
+        'at a time.',
+      );
+    }
     var process = await Process.start(_dartExecutable, [
       'language-server',
       '--protocol=${_protocol.flagValue}',

pkg/analysis_server/tool/performance/project_generator/git_worktree_project_generator.dart

@@ -25,12 +25,22 @@ class GitWorktreeProjectGenerator implements ProjectGenerator {
   @override
   Future<Directory> setUp() async {
     var projectDir = await Directory.systemTemp.createTemp('as_git_worktree');
-    await runGitCommand(['worktree', 'add', projectDir.path], originalRepo);
+    await runGitCommand([
+      'worktree',
+      'add',
+      '-d',
+      projectDir.path,
+    ], originalRepo);
     return projectDir;
   }
 
   @override
   Future<void> tearDown(Directory projectDir) async {
-    await runGitCommand(['worktree', 'remove', projectDir.path], originalRepo);
+    await runGitCommand([
+      'worktree',
+      'remove',
+      '-f',
+      projectDir.path,
+    ], originalRepo);
   }
 }

pkg/analysis_server/tool/performance/scenarios/logs/empty.json

@@ -0,0 +1,3 @@
+{"time":1763408263553,"kind":"commandLine","argList":["--protocol=lsp","--port=0","--client-id=VS-Code","--client-version=3.122.0","--with-fine-dependencies"]},
+{"time":1763408263573,"kind":"message","sender":"ide","receiver":"server","message":{"jsonrpc":"2.0","id":0,"method":"initialize","params":{"processId":2053633,"clientInfo":{"name":"code-server","version":"1.98.2"},"locale":"en","rootPath":"{{workspaceRoot}}","rootUri":"file://{{workspaceRoot}}","capabilities":{"workspace":{"applyEdit":true,"workspaceEdit":{"documentChanges":true,"resourceOperations":["create","rename","delete"],"failureHandling":"textOnlyTransactional","normalizesLineEndings":true,"changeAnnotationSupport":{"groupsOnLabel":true}},"configuration":true,"didChangeWatchedFiles":{"dynamicRegistration":true,"relativePatternSupport":true},"symbol":{"dynamicRegistration":true,"symbolKind":{"valueSet":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26]},"tagSupport":{"valueSet":[1]},"resolveSupport":{"properties":["location.range"]}},"codeLens":{"refreshSupport":true},"executeCommand":{"dynamicRegistration":true},"didChangeConfiguration":{"dynamicRegistration":true},"workspaceFolders":true,"semanticTokens":{"refreshSupport":true},"fileOperations":{"dynamicRegistration":true,"didCreate":true,"didRename":true,"didDelete":true,"willCreate":true,"willRename":true,"willDelete":true},"inlineValue":{"refreshSupport":true},"inlayHint":{"refreshSupport":true},"diagnostics":{"refreshSupport":true}},"textDocument":{"publishDiagnostics":{"relatedInformation":true,"versionSupport":false,"tagSupport":{"valueSet":[1,2]},"codeDescriptionSupport":true,"dataSupport":true},"synchronization":{"dynamicRegistration":true,"willSave":true,"willSaveWaitUntil":true,"didSave":true},"completion":{"dynamicRegistration":true,"contextSupport":true,"completionItem":{"snippetSupport":true,"commitCharactersSupport":true,"documentationFormat":["markdown","plaintext"],"deprecatedSupport":true,"preselectSupport":true,"tagSupport":{"valueSet":[1]},"insertReplaceSupport":true,"resolveSupport":{"properties":["documentation","detail","additionalTextEdits"]},"insertTextModeSupport":{"valueSet":[1,2]},"labelDetailsSupport":true},"insertTextMode":2,"completionItemKind":{"valueSet":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25]},"completionList":{"itemDefaults":["commitCharacters","editRange","insertTextFormat","insertTextMode"]}},"hover":{"dynamicRegistration":true,"contentFormat":["markdown","plaintext"]},"signatureHelp":{"dynamicRegistration":true,"signatureInformation":{"documentationFormat":["markdown","plaintext"],"parameterInformation":{"labelOffsetSupport":true},"activeParameterSupport":true},"contextSupport":true},"definition":{"dynamicRegistration":true,"linkSupport":true},"references":{"dynamicRegistration":true},"documentHighlight":{"dynamicRegistration":true},"documentSymbol":{"dynamicRegistration":true,"symbolKind":{"valueSet":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26]},"hierarchicalDocumentSymbolSupport":true,"tagSupport":{"valueSet":[1]},"labelSupport":true},"codeAction":{"dynamicRegistration":true,"isPreferredSupport":true,"disabledSupport":true,"dataSupport":true,"resolveSupport":{"properties":["edit"]},"codeActionLiteralSupport":{"codeActionKind":{"valueSet":["","quickfix","refactor","refactor.extract","refactor.inline","refactor.rewrite","source","source.organizeImports"]}},"honorsChangeAnnotations":false},"codeLens":{"dynamicRegistration":true},"formatting":{"dynamicRegistration":true},"rangeFormatting":{"dynamicRegistration":true},"onTypeFormatting":{"dynamicRegistration":true},"rename":{"dynamicRegistration":true,"prepareSupport":true,"prepareSupportDefaultBehavior":1,"honorsChangeAnnotations":true},"documentLink":{"dynamicRegistration":true,"tooltipSupport":true},"typeDefinition":{"dynamicRegistration":true,"linkSupport":true},"implementation":{"dynamicRegistration":true,"linkSupport":true},"colorProvider":{"dynamicRegistration":true},"foldingRange":{"dynamicRegistration":true,"rangeLimit":5000,"lineFoldingOnly":true,"foldingRangeKind":{"valueSet":["comment","imports","region"]},"foldingRange":{"collapsedText":false}},"declaration":{"dynamicRegistration":true,"linkSupport":true},"selectionRange":{"dynamicRegistration":true},"callHierarchy":{"dynamicRegistration":true},"semanticTokens":{"dynamicRegistration":true,"tokenTypes":["namespace","type","class","enum","interface","struct","typeParameter","parameter","variable","property","enumMember","event","function","method","macro","keyword","modifier","comment","string","number","regexp","operator","decorator"],"tokenModifiers":["declaration","definition","readonly","static","deprecated","abstract","async","modification","documentation","defaultLibrary"],"formats":["relative"],"requests":{"range":true,"full":{"delta":true}},"multilineTokenSupport":false,"overlappingTokenSupport":false,"serverCancelSupport":true,"augmentsSyntaxTokens":true},"linkedEditingRange":{"dynamicRegistration":true},"typeHierarchy":{"dynamicRegistration":true},"inlineValue":{"dynamicRegistration":true},"inlayHint":{"dynamicRegistration":true,"resolveSupport":{"properties":["tooltip","textEdits","label.tooltip","label.location","label.command"]}},"diagnostic":{"dynamicRegistration":true,"relatedDocumentSupport":false}},"window":{"showMessage":{"messageActionItem":{"additionalPropertiesSupport":true}},"showDocument":{"support":true},"workDoneProgress":true},"general":{"staleRequestSupport":{"cancel":true,"retryOnContentModified":["textDocument/semanticTokens/full","textDocument/semanticTokens/range","textDocument/semanticTokens/full/delta"]},"regularExpressions":{"engine":"ECMAScript","version":"ES2020"},"markdown":{"parser":"marked","version":"1.1.0","allowedTags":["ul","li","p","code","blockquote","ol","h1","h2","h3","h4","h5","h6","hr","em","pre","table","thead","tbody","tr","th","td","div","del","a","strong","br","img","span"]},"positionEncodings":["utf-16"]},"notebookDocument":{"synchronization":{"dynamicRegistration":true,"executionSummarySupport":true}},"experimental":{"supportsWindowShowMessageRequest":true,"commands":["dart.goToLocation"],"dartCodeAction":{"commandParameterSupport":{"supportedKinds":["saveUri"]}},"snippetTextEdit":true,"supportsDartTextDocumentContentProvider":true,"supportsDartTextDocumentContentProviderEXP1":true}},"initializationOptions":{"allowOpenUri":true,"appHost":"server-distro","closingLabels":true,"flutterOutline":false,"hostKind":"server-distro","onlyAnalyzeProjectsWithOpenFiles":false,"outline":true,"previewSurveys":true,"suggestFromUnimportedLibraries":true,"useInEditorDartFixPrompt":true},"trace":"off","workspaceFolders":[{"uri":"{{workspaceRoot}}","name":"sdk"}]},"clientRequestTime":1763408262903}},
+{"time":1763408263726,"kind":"message","sender":"ide","receiver":"server","message":{"jsonrpc":"2.0","method":"initialized","params":{},"clientRequestTime":1763408263726}},