DAS plugins: Normalize a plugin path

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

Author: srawlins

pkg/analyzer/lib/src/dart/analysis/analysis_options.dart

@@ -195,7 +195,8 @@ final class AnalysisOptionsBuilder {
     }
   }
 
-  void _applyPluginsOptions(YamlNode? plugins) {
+  void _applyPluginsOptions(
+      YamlNode? plugins, ResourceProvider? resourceProvider) {
     if (plugins is! YamlMap) {
       return;
     }
@@ -232,8 +233,23 @@ final class AnalysisOptionsBuilder {
         source = VersionedPluginSource(constraint: value);
       } else {
         var pathSource = pluginNode.valueAt(AnalysisOptionsFile.path);
-        if (pathSource case YamlScalar(:String value)) {
-          source = PathPluginSource(path: value);
+        if (pathSource case YamlScalar(value: String pathValue)) {
+          var file = this.file;
+          assert(
+            file != null,
+            "AnalysisOptionsImpl must be initialized with a non-null 'file' if "
+            'plugins are specified with path constraints.',
+          );
+          if (file != null &&
+              resourceProvider != null &&
+              resourceProvider.pathContext.isRelative(pathValue)) {
+            // We need to store the absolute path, before this value is used in
+            // a synthetic pub package.
+            pathValue =
+                resourceProvider.pathContext.join(file.parent.path, pathValue);
+            pathValue = resourceProvider.pathContext.normalize(pathValue);
+          }
+          source = PathPluginSource(path: pathValue);
         }
       }
 
@@ -379,8 +395,11 @@ class AnalysisOptionsImpl implements AnalysisOptions {
   /// [optionsMap].
   ///
   /// Optionally pass [file] as the file where the YAML can be found.
-  factory AnalysisOptionsImpl.fromYaml(
-      {required YamlMap optionsMap, File? file}) {
+  factory AnalysisOptionsImpl.fromYaml({
+    required YamlMap optionsMap,
+    File? file,
+    ResourceProvider? resourceProvider,
+  }) {
     var builder = AnalysisOptionsBuilder()..file = file;
 
     var analyzer = optionsMap.valueAt(AnalysisOptionsFile.analyzer);
@@ -433,7 +452,7 @@ class AnalysisOptionsImpl implements AnalysisOptions {
 
     // Process the 'plugins' option.
     var plugins = optionsMap.valueAt(AnalysisOptionsFile.plugins);
-    builder._applyPluginsOptions(plugins);
+    builder._applyPluginsOptions(plugins, resourceProvider);
 
     var ruleConfigs = parseLinterSection(optionsMap);
     if (ruleConfigs != null) {

pkg/analyzer/lib/src/dart/analysis/context_builder.dart

@@ -202,7 +202,10 @@ class ContextBuilderImpl {
     for (var entry in optionsMappings) {
       var file = entry.value;
       var options = AnalysisOptionsImpl.fromYaml(
-          file: file, optionsMap: provider.getOptionsFromFile(file));
+        optionsMap: provider.getOptionsFromFile(file),
+        file: file,
+        resourceProvider: resourceProvider,
+      );
 
       _optionsMap.add(entry.key, options);
     }
@@ -291,6 +294,7 @@ class ContextBuilderImpl {
         options = AnalysisOptionsImpl.fromYaml(
           optionsMap: provider.getOptionsFromFile(optionsFile),
           file: optionsFile,
+          resourceProvider: resourceProvider,
         );
       } catch (e) {
         // Ignore exception.

pkg/analyzer/lib/src/dart/analysis/context_locator.dart

@@ -553,8 +553,9 @@ class ContextLocatorImpl {
           AnalysisOptionsProvider(workspace.createSourceFactory(null, null));
 
       var options = AnalysisOptionsImpl.fromYaml(
-        file: optionsFile,
         optionsMap: provider.getOptionsFromFile(optionsFile),
+        file: optionsFile,
+        resourceProvider: resourceProvider,
       );
 
       return options.enabledLegacyPluginNames.toSet();

pkg/analyzer/test/src/options/analysis_options_test.dart

@@ -2,7 +2,10 @@
 // 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:analyzer/dart/analysis/analysis_options.dart';
 import 'package:analyzer/error/error.dart';
+import 'package:analyzer/file_system/file_system.dart';
+import 'package:analyzer/file_system/memory_file_system.dart';
 import 'package:analyzer/src/analysis_options/analysis_options_provider.dart';
 import 'package:analyzer/src/dart/analysis/analysis_options.dart';
 import 'package:analyzer/src/error/codes.dart';
@@ -21,11 +24,16 @@ main() {
 class AnalysisOptionsTest {
   final AnalysisOptionsProvider optionsProvider = AnalysisOptionsProvider();
 
+  final ResourceProvider resourceProvider = MemoryResourceProvider();
+
   // TODO(srawlins): Add tests that exercise
   // `optionsProvider.getOptionsFromString` throwing an exception.
   AnalysisOptionsImpl parseOptions(String content) =>
       AnalysisOptionsImpl.fromYaml(
-          optionsMap: optionsProvider.getOptionsFromString(content));
+        optionsMap: optionsProvider.getOptionsFromString(content),
+        file: resourceProvider.getFile('/project/analysis_options.yaml'),
+        resourceProvider: resourceProvider,
+      );
 
   test_analyzer_cannotIgnore() {
     var analysisOptions = parseOptions('''
@@ -283,6 +291,114 @@ analyzer:
     expect(analysisOptions.propagateLinterExceptions, true);
   }
 
+  test_analyzer_plugins_pathConstraint() {
+    var analysisOptions = parseOptions('''
+plugins:
+  plugin_one:
+    path: /foo/bar
+''');
+
+    var configuration = analysisOptions.pluginConfigurations.single;
+    expect(configuration.isEnabled, isTrue);
+    expect(configuration.name, 'plugin_one');
+    expect(
+      configuration.source,
+      isA<PathPluginSource>().having(
+        (e) => e.toYaml(name: 'plugin_one'),
+        'toYaml',
+        '''
+  plugin_one:
+    path: /foo/bar
+''',
+      ),
+    );
+  }
+
+  test_analyzer_plugins_pathConstraint_relative() {
+    var analysisOptions = parseOptions('''
+plugins:
+  plugin_one:
+    path: foo/bar
+''');
+
+    var configuration = analysisOptions.pluginConfigurations.single;
+    expect(configuration.isEnabled, isTrue);
+    expect(configuration.name, 'plugin_one');
+    expect(
+      configuration.source,
+      isA<PathPluginSource>().having(
+        (e) => e.toYaml(name: 'plugin_one'),
+        'toYaml',
+        '''
+  plugin_one:
+    path: /project/foo/bar
+''',
+      ),
+    );
+  }
+
+  test_analyzer_plugins_pathConstraint_relativeNonNormal() {
+    var analysisOptions = parseOptions('''
+plugins:
+  plugin_one:
+    path: .././foo/bar/../baz
+''');
+
+    var configuration = analysisOptions.pluginConfigurations.single;
+    expect(configuration.isEnabled, isTrue);
+    expect(configuration.name, 'plugin_one');
+    expect(
+      configuration.source,
+      isA<PathPluginSource>().having(
+        (e) => e.toYaml(name: 'plugin_one'),
+        'toYaml',
+        '''
+  plugin_one:
+    path: /foo/baz
+''',
+      ),
+    );
+  }
+
+  test_analyzer_plugins_scalarConstraint() {
+    var analysisOptions = parseOptions('''
+plugins:
+  plugin_one: ^1.2.3
+''');
+
+    var configuration = analysisOptions.pluginConfigurations.single;
+    expect(configuration.isEnabled, isTrue);
+    expect(configuration.name, 'plugin_one');
+    expect(
+      configuration.source,
+      isA<VersionedPluginSource>().having(
+        (e) => e.toYaml(name: 'plugin_one'),
+        'toYaml',
+        '  plugin_one: ^1.2.3\n',
+      ),
+    );
+  }
+
+  test_analyzer_plugins_versionConstraint() {
+    var analysisOptions = parseOptions('''
+plugins:
+  plugin_one:
+    version: ^1.2.3
+''');
+
+    var configuration = analysisOptions.pluginConfigurations.single;
+    expect(configuration.isEnabled, isTrue);
+    expect(configuration.name, 'plugin_one');
+    expect(
+      configuration.source,
+      isA<VersionedPluginSource>().having(
+        (e) => e.toYaml(name: 'plugin_one'),
+        'toYaml',
+        '  plugin_one: ^1.2.3\n',
+      ),
+    );
+  }
+
   test_codeStyle_format_false() {
     var analysisOptions = parseOptions('''
 code-style: