performance measurement: add explicit temp source directory argument

pkg/analysis_server/test/performance/input_converter.dart

 // Copyright (c) 2015, 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.
 
 library input.transformer;
 
 import 'dart:convert';
 import 'dart:io';
 
 import 'package:analysis_server/src/constants.dart';
 import 'package:analysis_server/src/protocol.dart';
 import 'package:analyzer/src/generated/java_engine.dart';
 import 'package:logging/logging.dart';
+import 'package:path/path.dart' as path;
 
 import 'instrumentation_input_converter.dart';
 import 'log_file_input_converter.dart';
 import 'operation.dart';
 
 /**
  * Common input converter superclass for sharing implementation.
  */
 abstract class CommonInputConverter extends Converter<String, Operation> {
   static final ERROR_PREFIX = 'Server responded with an error: ';
   final Logger logger = new Logger('InstrumentationInputConverter');
   final Set<String> eventsSeen = new Set<String>();
 
   /**
    * A mapping from request/response id to expected error message.
    */
   final Map<String, dynamic> expectedErrors = new Map<String, dynamic>();
 
   /**
+   * A mapping of current overlay content
+   * parallel to what is in the analysis server
+   * so that we can update the file system.
+   */
+  final Map<String, String> overlays = new Map<String, String>();
+
+  /**
+   * The prefix used to determine if a request parameter is a file path.
+   */
+  final String rootPrefix = path.rootPrefix(path.current);
+
+  /**
    * A mapping of source path prefixes
    * from location where instrumentation or log file was generated
    * to the target location of the source using during performance measurement.
    */
   final Map<String, String> srcPathMap;
 
   /**
-   * A mapping of current overlay content
-   * parallel to what is in the analysis server
-   * so that we can update the file system.
+   * The root directory for all source being modified
+   * during performance measurement.
    */
-  final Map<String, String> overlays = new Map<String, String>();
+  final String tmpSrcDirPath;
 
-  CommonInputConverter(this.srcPathMap);
+  CommonInputConverter(this.tmpSrcDirPath, this.srcPathMap);
 
   /**
    * Return an operation for the notification or `null` if none.
    */
   Operation convertNotification(Map<String, dynamic> json) {
     String event = json['event'];
     if (event == SERVER_STATUS) {
       // {"event":"server.status","params":{"analysis":{"isAnalyzing":false}}}
       Map<String, dynamic> params = json['params'];
       if (params != null) {
@@ skipping 12 matching lines @@
     }
     return null;
   }
 
   /**
    * Return an operation for the request or `null` if none.
    */
   Operation convertRequest(Map<String, dynamic> origJson) {
     Map<String, dynamic> json = translateSrcPaths(origJson);
     String method = json['method'];
-    if (method == ANALYSIS_GET_HOVER ||
-        method == ANALYSIS_SET_ANALYSIS_ROOTS ||
-        method == ANALYSIS_SET_PRIORITY_FILES ||
-        method == ANALYSIS_SET_SUBSCRIPTIONS ||
-        method == ANALYSIS_UPDATE_OPTIONS ||
-        method == COMPLETION_GET_SUGGESTIONS ||
-        method == EDIT_GET_ASSISTS ||
-        method == EDIT_GET_AVAILABLE_REFACTORINGS ||
-        method == EDIT_GET_FIXES ||
-        method == EDIT_GET_REFACTORING ||
-        method == EDIT_SORT_MEMBERS ||
-        method == EXECUTION_CREATE_CONTEXT ||
-        method == EXECUTION_DELETE_CONTEXT ||
-        method == EXECUTION_MAP_URI ||
-        method == EXECUTION_SET_SUBSCRIPTIONS ||
-        method == SERVER_GET_VERSION ||
-        method == SERVER_SET_SUBSCRIPTIONS) {
-      return new RequestOperation(this, json);
-    }
     // Sanity check operations that modify source
     // to ensure that the operation is on source in temp space
     if (method == ANALYSIS_UPDATE_CONTENT) {
       try {
         validateSrcPaths(json);
       } catch (e, s) {
         throw new AnalysisException('invalid src path in update request\n$json',
             new CaughtException(e, s));
       }
       // Track overlays in parallel with the analysis server
@@ skipping 19 matching lines @@
             throw 'expected cached overlay content\n$json';
           }
           validateSrcPaths(path);
           new File(path).writeAsStringSync(content);
         } else {
           throw 'unknown overlay change $change\n$json';
         }
       });
       return new RequestOperation(this, json);
     }
+    // TODO(danrubel) replace this with code 
+    // that just forwards the translated request
+    if (method == ANALYSIS_GET_HOVER ||
+        method == ANALYSIS_SET_ANALYSIS_ROOTS ||
+        method == ANALYSIS_SET_PRIORITY_FILES ||
+        method == ANALYSIS_SET_SUBSCRIPTIONS ||
+        method == ANALYSIS_UPDATE_OPTIONS ||
+        method == COMPLETION_GET_SUGGESTIONS ||
+        method == EDIT_GET_ASSISTS ||
+        method == EDIT_GET_AVAILABLE_REFACTORINGS ||
+        method == EDIT_GET_FIXES ||
+        method == EDIT_GET_REFACTORING ||
+        method == EDIT_SORT_MEMBERS ||
+        method == EXECUTION_CREATE_CONTEXT ||
+        method == EXECUTION_DELETE_CONTEXT ||
+        method == EXECUTION_MAP_URI ||
+        method == EXECUTION_SET_SUBSCRIPTIONS ||
+        method == SEARCH_FIND_ELEMENT_REFERENCES ||
+        method == SERVER_GET_VERSION ||
+        method == SERVER_SET_SUBSCRIPTIONS) {
+      return new RequestOperation(this, json);
+    }
     throw 'unknown request: $method\n  $json';
   }
 
   /**
    * Determine if the given request is expected to fail
    * and log an exception if not.
    */
   void recordErrorResponse(Map<String, dynamic> jsonRequest, exception) {
     var actualErr;
     if (exception is UnimplementedError) {
@@ skipping 69 matching lines @@
     return json;
   }
 
   /**
    * Recursively verify that the source paths in the specified JSON
    * only reference the temporary source used during performance measurement.
    */
   void validateSrcPaths(json) {
     if (json is String) {
       if (json != null &&
-          json.startsWith('/Users/') &&
-          !srcPathMap.values.any((String prefix) => json.startsWith(prefix))) {
+          path.isWithin(rootPrefix, json) &&
+          !path.isWithin(tmpSrcDirPath, json)) {
         throw 'found path referencing source outside temp space\n$json';
       }
     } else if (json is List) {
       for (int i = json.length - 1; i >= 0; --i) {
         validateSrcPaths(json[i]);
       }
     } else if (json is Map) {
       json.forEach((String key, value) {
         validateSrcPaths(key);
         validateSrcPaths(value);
@@ skipping 11 matching lines @@
   final Logger logger = new Logger('InputConverter');
 
   /**
    * A mapping of source path prefixes
    * from location where instrumentation or log file was generated
    * to the target location of the source using during performance measurement.
    */
   final Map<String, String> srcPathMap;
 
   /**
+   * The root directory for all source being modified
+   * during performance measurement.
+   */
+  final String tmpSrcDirPath;
+
+  /**
    * The number of lines read before the underlying converter was determined
    * or the end of file was reached.
    */
   int headerLineCount = 0;
 
   /**
    * The underlying converter used to translate lines into operations
    * or `null` if it has not yet been determined.
    */
   Converter<String, Operation> converter;
 
   /**
    * [active] is `true` if converting lines to operations
    * or `false` if an exception has occurred.
    */
   bool active = true;
 
-  InputConverter(this.srcPathMap);
+  InputConverter(this.tmpSrcDirPath, this.srcPathMap);
 
   @override
   Operation convert(String line) {
     if (!active) {
       return null;
     }
     if (converter != null) {
       try {
         return converter.convert(line);
       } catch (e) {
         active = false;
         rethrow;
       }
     }
     if (headerLineCount == 20) {
       throw 'Failed to determine input file format';
     }
     if (InstrumentationInputConverter.isFormat(line)) {
-      converter = new InstrumentationInputConverter(srcPathMap);
+      converter = new InstrumentationInputConverter(tmpSrcDirPath, srcPathMap);
     } else if (LogFileInputConverter.isFormat(line)) {
-      converter = new LogFileInputConverter(srcPathMap);
+      converter = new LogFileInputConverter(tmpSrcDirPath, srcPathMap);
     }
     if (converter != null) {
       return converter.convert(line);
     }
     logger.log(Level.INFO, 'skipped input line: $line');
     return null;
   }
 
   @override
   _InputSink startChunkedConversion(outSink) {
@@ skipping 13 matching lines @@
     if (op != null) {
       outSink.add(op);
     }
   }
 
   @override
   void close() {
     outSink.close();
   }
 }