[analysis_server] Prevent convert method<->getter refactors on SDK/external package files

Fixes Dart-Code/Dart-Code#4221.

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

Author: DanTup

pkg/analysis_server/lib/src/handler/legacy/edit_get_available_refactorings.dart

@@ -59,16 +59,16 @@ class EditGetAvailableRefactoringsHandler extends LegacyHandler {
       var node = NodeLocator(offset).searchWithin(resolvedUnit.unit);
       var element = server.getElementOfNode(node);
       if (element != null) {
+        final refactoringWorkspace = server.refactoringWorkspace;
         // try CONVERT_METHOD_TO_GETTER
         if (element is ExecutableElement) {
           if (ConvertMethodToGetterRefactoring(
-                  searchEngine, resolvedUnit.session, element)
+                  refactoringWorkspace, resolvedUnit.session, element)
               .isAvailable()) {
             kinds.add(RefactoringKind.CONVERT_METHOD_TO_GETTER);
           }
         }
         // try RENAME
-        final refactoringWorkspace = server.refactoringWorkspace;
         var renameRefactoring = RenameRefactoring.create(
             refactoringWorkspace, resolvedUnit, element);
         if (renameRefactoring != null) {

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

@@ -112,7 +112,7 @@ abstract class AbstractRefactorCommandHandler extends SimpleEditCommandHandler
         if (element != null) {
           if (element is PropertyAccessorElement) {
             final refactor = ConvertGetterToMethodRefactoring(
-                server.searchEngine, result.session, element);
+                server.refactoringWorkspace, result.session, element);
             return success(refactor);
           }
         }
@@ -125,7 +125,7 @@ abstract class AbstractRefactorCommandHandler extends SimpleEditCommandHandler
         if (element != null) {
           if (element is ExecutableElement) {
             final refactor = ConvertMethodToGetterRefactoring(
-                server.searchEngine, result.session, element);
+                server.refactoringWorkspace, result.session, element);
             return success(refactor);
           }
         }

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

@@ -629,7 +629,7 @@ class CodeActionHandler
         // Getter to Method
         if (element is PropertyAccessorElement &&
             ConvertGetterToMethodRefactoring(
-                    server.searchEngine, unit.session, element)
+                    server.refactoringWorkspace, unit.session, element)
                 .isAvailable()) {
           refactorActions.add(createRefactor(
               CodeActionKind.RefactorRewrite,
@@ -640,7 +640,7 @@ class CodeActionHandler
         // Method to Getter
         if (element is ExecutableElement &&
             ConvertMethodToGetterRefactoring(
-                    server.searchEngine, unit.session, element)
+                    server.refactoringWorkspace, unit.session, element)
                 .isAvailable()) {
           refactorActions.add(createRefactor(
               CodeActionKind.RefactorRewrite,

pkg/analysis_server/lib/src/services/refactoring/legacy/convert_getter_to_method.dart

@@ -18,14 +18,16 @@ import 'package:analyzer_plugin/utilities/range_factory.dart';
 /// [ConvertMethodToGetterRefactoring] implementation.
 class ConvertGetterToMethodRefactoringImpl extends RefactoringImpl
     implements ConvertGetterToMethodRefactoring {
+  final RefactoringWorkspace workspace;
   final SearchEngine searchEngine;
   final AnalysisSession session;
   final PropertyAccessorElement element;
 
   late SourceChange change;
 
   ConvertGetterToMethodRefactoringImpl(
-      this.searchEngine, this.session, this.element);
+      this.workspace, this.session, this.element)
+      : searchEngine = workspace.searchEngine;
 
   @override
   String get refactoringName => 'Convert Getter To Method';
@@ -77,6 +79,11 @@ class ConvertGetterToMethodRefactoringImpl extends RefactoringImpl
 
   /// Checks if [element] is valid to perform this refactor.
   RefactoringStatus _checkElement() {
+    if (!workspace.containsElement(element)) {
+      return RefactoringStatus.fatal(
+          'Only getters in your workspace can be converted.');
+    }
+
     if (!element.isGetter || element.isSynthetic) {
       return RefactoringStatus.fatal(
           'Only explicit getters can be converted to methods.');

pkg/analysis_server/lib/src/services/refactoring/legacy/convert_method_to_getter.dart

@@ -18,15 +18,17 @@ import 'package:analyzer_plugin/utilities/range_factory.dart';
 /// [ConvertMethodToGetterRefactoring] implementation.
 class ConvertMethodToGetterRefactoringImpl extends RefactoringImpl
     implements ConvertMethodToGetterRefactoring {
+  final RefactoringWorkspace workspace;
   final SearchEngine searchEngine;
   final AnalysisSessionHelper sessionHelper;
   final ExecutableElement element;
 
   late SourceChange change;
 
   ConvertMethodToGetterRefactoringImpl(
-      this.searchEngine, AnalysisSession session, this.element)
-      : sessionHelper = AnalysisSessionHelper(session);
+      this.workspace, AnalysisSession session, this.element)
+      : sessionHelper = AnalysisSessionHelper(session),
+        searchEngine = workspace.searchEngine;
 
   @override
   String get refactoringName => 'Convert Method To Getter';
@@ -70,6 +72,11 @@ class ConvertMethodToGetterRefactoringImpl extends RefactoringImpl
 
   /// Checks if [element] is valid to perform this refactor.
   RefactoringStatus _checkElement() {
+    if (!workspace.containsElement(element)) {
+      return RefactoringStatus.fatal(
+          'Only methods in your workspace can be converted.');
+    }
+
     // check Element type
     if (element is FunctionElement) {
       if (element.enclosingElement is! CompilationUnitElement) {

pkg/analysis_server/lib/src/services/refactoring/legacy/refactoring.dart

@@ -38,9 +38,9 @@ import 'package:analyzer_plugin/protocol/protocol_common.dart'
 abstract class ConvertGetterToMethodRefactoring implements Refactoring {
   /// Returns a new [ConvertMethodToGetterRefactoring] instance for converting
   /// [element] and all the corresponding hierarchy elements.
-  factory ConvertGetterToMethodRefactoring(SearchEngine searchEngine,
+  factory ConvertGetterToMethodRefactoring(RefactoringWorkspace workspace,
       AnalysisSession session, PropertyAccessorElement element) {
-    return ConvertGetterToMethodRefactoringImpl(searchEngine, session, element);
+    return ConvertGetterToMethodRefactoringImpl(workspace, session, element);
   }
 
   /// Return `true` if refactoring is available, possibly without checking all
@@ -58,9 +58,9 @@ abstract class ConvertGetterToMethodRefactoring implements Refactoring {
 abstract class ConvertMethodToGetterRefactoring implements Refactoring {
   /// Returns a new [ConvertMethodToGetterRefactoring] instance for converting
   /// [element] and all the corresponding hierarchy elements.
-  factory ConvertMethodToGetterRefactoring(SearchEngine searchEngine,
+  factory ConvertMethodToGetterRefactoring(RefactoringWorkspace workspace,
       AnalysisSession session, ExecutableElement element) {
-    return ConvertMethodToGetterRefactoringImpl(searchEngine, session, element);
+    return ConvertMethodToGetterRefactoringImpl(workspace, session, element);
   }
 
   /// Return `true` if refactoring is available, possibly without checking all

pkg/analysis_server/lib/src/services/refactoring/legacy/refactoring_manager.dart

@@ -205,7 +205,7 @@ class RefactoringManager {
         if (element != null) {
           if (element is PropertyAccessorElement) {
             refactoring = ConvertGetterToMethodRefactoring(
-                searchEngine, resolvedUnit.session, element);
+                refactoringWorkspace, resolvedUnit.session, element);
           }
         }
       }
@@ -217,7 +217,7 @@ class RefactoringManager {
         if (element != null) {
           if (element is ExecutableElement) {
             refactoring = ConvertMethodToGetterRefactoring(
-                searchEngine, resolvedUnit.session, element);
+                refactoringWorkspace, resolvedUnit.session, element);
           }
         }
       }

pkg/analysis_server/test/abstract_context.dart

@@ -166,6 +166,9 @@ class AbstractContextTest with ResourceProviderMixin {
     return context.driver;
   }
 
+  Future<ResolvedUnitResult> getResolvedUnit(String path) async =>
+      await (await session).getResolvedUnit(path) as ResolvedUnitResult;
+
   @override
   File newFile(String path, String content) {
     if (_analysisContextCollection != null && !path.endsWith('.dart')) {

pkg/analysis_server/test/abstract_single_unit.dart

@@ -64,8 +64,7 @@ class AbstractSingleUnitTest extends AbstractContextTest {
       useLineEndingsForPlatform ? normalizeNewlinesForPlatform(code) : code;
 
   Future<void> resolveFile2(String path) async {
-    var result =
-        await (await session).getResolvedUnit(path) as ResolvedUnitResult;
+    var result = await getResolvedUnit(path);
     testAnalysisResult = result;
     testCode = result.content;
     testUnit = result.unit;

pkg/analysis_server/test/services/completion/dart/completion_contributor_util.dart

@@ -558,8 +558,7 @@ abstract class _BaseDartCompletionContributorTest extends AbstractContextTest {
       DartCompletionRequest request);
 
   Future computeSuggestions({int times = 200}) async {
-    result =
-        await (await session).getResolvedUnit(testFile) as ResolvedUnitResult;
+    result = await getResolvedUnit(testFile);
 
     // Build the request
     var request = DartCompletionRequest.forResolvedUnit(