Deprecate MemoryResourceProvider.convertPath in favor of extension

Work towards #55660

The comment for `MemoryResourceProvider.convertPath` includes:

> This is a utility method for testing; paths passed in to other
> methods in this class are never converted automatically.

and indeed, the actual impl of this method is found in an extension,
in analyzer's test_utilities/ directory. It seems to me better to
leave a testing utility as a testing utility, and not expose it in
the public API of MemoryResourceProvider.

Additionally, the extension method is used by `ResourceProviderMixin`,
which is moving to the public analyzer_testing package. It is illegal
to have a circular non-dev dependency between the analyzer package
and the analyzer_testing package.

The migration for the ~half dozen test files that use this method is
to call the extension method directly. Sometimes with an extension
override, and sometimes without.

Change-Id: I9c2e18600461134bfd91c082b3af0d5079600f0c
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/426984
Commit-Queue: Samuel Rawlins <[email protected]>
Reviewed-by: Konstantin Shcheglov <[email protected]>
Reviewed-by: Brian Wilkerson <[email protected]>

Author: srawlins

pkg/analysis_server/test/src/plugin/notification_manager_test.dart

@@ -6,7 +6,9 @@ import 'package:analysis_server/protocol/protocol.dart' as server;
 import 'package:analysis_server/protocol/protocol_generated.dart' as server;
 import 'package:analysis_server/src/channel/channel.dart';
 import 'package:analysis_server/src/plugin/notification_manager.dart';
+import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/file_system/memory_file_system.dart';
+import 'package:analyzer/src/test_utilities/resource_provider_mixin.dart';
 import 'package:analyzer_plugin/protocol/protocol_common.dart';
 import 'package:analyzer_plugin/protocol/protocol_generated.dart' as plugin;
 import 'package:test/test.dart';
@@ -40,7 +42,7 @@ class NotificationManagerTest extends ProtocolTestUtilities {
   late NotificationManager manager;
 
   void setUp() {
-    var provider = MemoryResourceProvider();
+    ResourceProvider provider = MemoryResourceProvider();
     testDir = provider.convertPath('/test');
     fileA = provider.convertPath('/test/a.dart');
     fileB = provider.convertPath('/test/b.dart');

pkg/analyzer/api.txt

@@ -4535,7 +4535,7 @@ package:analyzer/file_system/memory_file_system.dart:
     nextStamp (getter: int)
     nextStamp= (setter: int)
     pathContext (getter: Context)
-    convertPath (method: String Function(String))
+    convertPath (method: String Function(String), deprecated)
     deleteFile (method: void Function(String))
     deleteFolder (method: void Function(String))
     getFile (method: File Function(String))

pkg/analyzer/lib/file_system/memory_file_system.dart

@@ -57,6 +57,7 @@ class MemoryResourceProvider implements ResourceProvider {
   ///
   /// This is a utility method for testing; paths passed in to other methods in
   /// this class are never converted automatically.
+  @Deprecated("Use 'ResourceProviderExtensions.convertPath' directly")
   String convertPath(String filePath) =>
       ResourceProviderExtensions(this).convertPath(filePath);
 
@@ -135,7 +136,9 @@ class MemoryResourceProvider implements ResourceProvider {
 
   @override
   Folder getStateLocation(String pluginId) {
-    var path = convertPath('/user/home/$pluginId');
+    var path = ResourceProviderExtensions(
+      this,
+    ).convertPath('/user/home/$pluginId');
     return newFolder(path);
   }
 

pkg/analyzer/test/file_system/memory_file_system_test.dart

@@ -10,6 +10,7 @@ import 'package:analyzer/source/file_source.dart';
 import 'package:analyzer/source/source.dart';
 import 'package:analyzer/src/generated/engine.dart' show TimestampedData;
 import 'package:analyzer/src/generated/utilities_dart.dart';
+import 'package:analyzer/src/test_utilities/resource_provider_mixin.dart';
 import 'package:path/path.dart' as path;
 import 'package:test/test.dart';
 import 'package:test_reflective_loader/test_reflective_loader.dart';
@@ -59,6 +60,9 @@ abstract class BaseTest extends FileSystemTestSupport {
   @override
   MemoryResourceProvider get provider => _provider ??= createProvider();
 
+  String convertPath(String filePath) =>
+      ResourceProviderExtensions(provider).convertPath(filePath);
+
   /// Create the resource provider to be used by the tests. Subclasses can
   /// override this method to change the class of resource provider that is
   /// used.
@@ -69,7 +73,7 @@ abstract class BaseTest extends FileSystemTestSupport {
     if (filePath == null) {
       filePath = defaultFilePath;
     } else {
-      filePath = provider.convertPath(filePath);
+      filePath = convertPath(filePath);
     }
     if (exists) {
       provider.newFile(filePath, content ?? defaultFileContent);
@@ -82,7 +86,7 @@ abstract class BaseTest extends FileSystemTestSupport {
     if (folderPath == null) {
       folderPath = defaultFolderPath;
     } else {
-      folderPath = provider.convertPath(folderPath);
+      folderPath = convertPath(folderPath);
     }
     if (exists) {
       provider.newFolder(folderPath);
@@ -92,17 +96,17 @@ abstract class BaseTest extends FileSystemTestSupport {
 
   @override
   Link getLink({required String linkPath, String? target}) {
-    linkPath = provider.convertPath(linkPath);
+    linkPath = convertPath(linkPath);
     if (target != null) {
-      target = provider.convertPath(target);
+      target = convertPath(target);
 
       provider.newLink(linkPath, target);
     }
     return provider.getLink(linkPath);
   }
 
   setUp() {
-    tempPath = provider.convertPath('/temp');
+    tempPath = convertPath('/temp');
     defaultFolderPath = join(tempPath, 'bar');
     defaultFilePath = join(tempPath, 'bar', 'test.dart');
   }
@@ -184,16 +188,14 @@ class MemoryFileSourceExistingTest extends BaseTest {
     );
     expect(
       relative,
-      provider.pathContext.toUri(
-        provider.convertPath('/temp/bar/bar/baz.dart'),
-      ),
+      provider.pathContext.toUri(convertPath('/temp/bar/bar/baz.dart')),
     );
   }
 
   test_resolveRelative_dart() {
     File file = getFile(
       exists: false,
-      filePath: provider.convertPath('/sdk/lib/core/core.dart'),
+      filePath: convertPath('/sdk/lib/core/core.dart'),
     );
     Source source = FileSource(file, Uri.parse('dart:core'));
 
@@ -238,9 +240,7 @@ class MemoryFileSourceNotExistingTest extends BaseTest {
     );
     expect(
       relative,
-      provider.pathContext.toUri(
-        provider.convertPath('/temp/bar/bar/baz.dart'),
-      ),
+      provider.pathContext.toUri(convertPath('/temp/bar/bar/baz.dart')),
     );
   }
 
@@ -296,12 +296,12 @@ class MemoryFileTest extends BaseTest with FileTestMixin {
 @reflectiveTest
 class MemoryFolderTest extends BaseTest with FolderTestMixin {
   test_isRoot_false() {
-    var path = provider.convertPath('/foo');
+    var path = convertPath('/foo');
     expect(provider.getFolder(path).isRoot, isFalse);
   }
 
   test_isRoot_true() {
-    var path = provider.convertPath('/');
+    var path = convertPath('/');
     expect(provider.getFolder(path).isRoot, isTrue);
   }
 }
@@ -404,16 +404,13 @@ class MemoryResourceProviderTest extends BaseTest
   }
 
   test_newLink_folder() {
-    provider.newLink(
-      provider.convertPath('/test/lib/foo'),
-      provider.convertPath('/test/lib'),
-    );
+    provider.newLink(convertPath('/test/lib/foo'), convertPath('/test/lib'));
 
-    provider.newFile(provider.convertPath('/test/lib/a.dart'), 'aaa');
+    provider.newFile(convertPath('/test/lib/a.dart'), 'aaa');
 
     {
       var path = '/test/lib/foo/a.dart';
-      var convertedPath = provider.convertPath(path);
+      var convertedPath = convertPath(path);
       var file = provider.getFile(convertedPath);
       expect(file.exists, true);
       expect(file.modificationStamp, isNonNegative);
@@ -422,7 +419,7 @@ class MemoryResourceProviderTest extends BaseTest
 
     {
       var path = '/test/lib/foo/foo/a.dart';
-      var convertedPath = provider.convertPath(path);
+      var convertedPath = convertPath(path);
       var file = provider.getFile(convertedPath);
       expect(file.exists, true);
       expect(file.modificationStamp, isNonNegative);
@@ -444,7 +441,7 @@ class MemoryResourceProviderTest extends BaseTest
   }
 
   test_watch_createFile() {
-    String rootPath = provider.convertPath('/my/path');
+    String rootPath = convertPath('/my/path');
     provider.newFolder(rootPath);
     return _watchingFolder(rootPath, (changesReceived) {
       expect(changesReceived, hasLength(0));
@@ -460,7 +457,7 @@ class MemoryResourceProviderTest extends BaseTest
   }
 
   test_watch_deleteFile() {
-    String rootPath = provider.convertPath('/my/path');
+    String rootPath = convertPath('/my/path');
     provider.newFolder(rootPath);
     String path = provider.pathContext.join(rootPath, 'foo');
     provider.newFile(path, 'contents 1');
@@ -477,7 +474,7 @@ class MemoryResourceProviderTest extends BaseTest
   }
 
   test_watch_modifyFile() {
-    String rootPath = provider.convertPath('/my/path');
+    String rootPath = convertPath('/my/path');
     provider.newFolder(rootPath);
     String path = provider.pathContext.join(rootPath, 'foo');
     provider.newFile(path, 'contents 1');
@@ -494,7 +491,7 @@ class MemoryResourceProviderTest extends BaseTest
   }
 
   test_watch_modifyFile_inSubDir() {
-    String rootPath = provider.convertPath('/my/path');
+    String rootPath = convertPath('/my/path');
     provider.newFolder(rootPath);
     String subdirPath = provider.pathContext.join(rootPath, 'foo');
     provider.newFolder(subdirPath);