Tests for workspace traversal

Author: wkillerud

pkgs/sass_language_services/lib/src/features/go_to_definition/go_to_definition_feature.dart

@@ -1,4 +1,5 @@
 import 'package:lsp_server/lsp_server.dart' as lsp;
+import 'package:sass_api/sass_api.dart' as sass;
 import 'package:sass_language_services/sass_language_services.dart';
 import 'package:sass_language_services/src/features/go_to_definition/scoped_symbols.dart';
 import 'package:sass_language_services/src/features/node_at_offset_visitor.dart';
@@ -46,10 +47,35 @@ class GoToDefinitionFeature extends LanguageFeature {
       return lsp.Location(uri: document.uri, range: symbol.selectionRange);
     }
 
-    // If not, look for it elsewhere in the workspace.
+    // Start looking from the linked document In case of a namespace
+    // so we don't accidentally match with a symbol of the same kind
+    // and name, but in a different module.
+    String? namespace;
+    if (node is sass.VariableExpression) {
+      namespace = node.namespace;
+    } else if (node is sass.IncludeRule) {
+      namespace = node.namespace;
+    } else if (node is sass.FunctionExpression) {
+      namespace = node.namespace;
+    }
+
+    var initialDocument = document;
+    if (namespace != null) {
+      var links = await ls.findDocumentLinks(document);
+      try {
+        var link = links.firstWhere((l) => l.namespace == namespace);
+        if (link.target case var target?) {
+          initialDocument = await getTextDocument(target);
+        }
+      } on StateError {
+        return null;
+      }
+    }
+
     var definition = await findInWorkspace<lsp.Location>(
       lazy: true,
-      initialDocument: document,
+      initialDocument: initialDocument,
+      depth: initialDocument.uri != document.uri ? 1 : 0,
       callback: ({
         required TextDocument document,
         required String prefix,
@@ -58,18 +84,19 @@ class GoToDefinitionFeature extends LanguageFeature {
         required List<String> shownMixinsAndFunctions,
         required List<String> shownVariables,
       }) async {
-        // Some symbols may change names in `@forward`.
-        var prefixedName = kind == ReferenceKind.function ||
+        // `@forward` may add a prefix to [name],
+        // but we're comparing it to symbols without that prefix.
+        var unprefixedName = kind == ReferenceKind.function ||
                 kind == ReferenceKind.mixin ||
                 kind == ReferenceKind.variable
-            ? '$prefix$name'
+            ? name.replaceFirst(prefix, '')
             : name;
 
         var stylesheet = ls.parseStylesheet(document);
         var symbols = ScopedSymbols(stylesheet,
             document.languageId == 'sass' ? Dialect.indented : Dialect.scss);
         var symbol = symbols.globalScope.getSymbol(
-          name: prefixedName,
+          name: unprefixedName,
           referenceKind: kind,
         );
 

pkgs/sass_language_services/lib/src/features/language_feature.dart

@@ -102,24 +102,7 @@ abstract class LanguageFeature {
       }
 
       var uri = link.target!;
-      var next = ls.cache.getDocument(uri);
-      if (next == null) {
-        // We shouldn't really end up here outside of unit tests.
-        // The language server's initial scan should have put all
-        // linked documents in the cache already.
-        var text = await ls.fs.readFile(uri);
-        next = TextDocument(
-          uri,
-          uri.path.endsWith('.sass')
-              ? 'sass'
-              : uri.path.endsWith('.css')
-                  ? 'css'
-                  : 'scss',
-          1,
-          text,
-        );
-        ls.parseStylesheet(next);
-      }
+      var next = await getTextDocument(uri);
 
       var prefix = accumulatedPrefix;
       if (link.type == LinkType.forward) {
@@ -164,6 +147,28 @@ abstract class LanguageFeature {
     return result;
   }
 
+  Future<TextDocument> getTextDocument(Uri uri) async {
+    var textDocument = ls.cache.getDocument(uri);
+    if (textDocument == null) {
+      // We shouldn't really end up here outside of unit tests.
+      // The language server's initial scan should have put all
+      // linked documents in the cache already.
+      var text = await ls.fs.readFile(uri);
+      textDocument = TextDocument(
+        uri,
+        uri.path.endsWith('.sass')
+            ? 'sass'
+            : uri.path.endsWith('.css')
+                ? 'css'
+                : 'scss',
+        1,
+        text,
+      );
+      ls.parseStylesheet(textDocument);
+    }
+    return textDocument;
+  }
+
   DocumentContext getDocumentContext() {
     return DocumentContext(
         workspaceRoot: ls.configuration.workspace.workspaceRoot);

pkgs/sass_language_services/test/features/go_to_definition/go_to_definition_test.dart

@@ -36,15 +36,18 @@ $b: blue
 
     test('global in a different document', () async {
       fs.createDocument(r'$b: #000;', uri: 'colors.scss');
+      fs.createDocument(r'$b: 800;', uri: 'weights.scss');
 
       var document = fs.createDocument(r'''
 @use "colors";
+@use "weights" as w;
 
 .a {
-  color: $b;
+  color: colors.$b;
+  font-weight: w.$b;
 }
 ''');
-      var result = await ls.goToDefinition(document, at(line: 3, char: 10));
+      var result = await ls.goToDefinition(document, at(line: 4, char: 17));
 
       expect(result, isNotNull);
       expect(result!.range, StartsAtLine(0));
@@ -53,6 +56,15 @@ $b: blue
       expect(result.range, EndsAtCharacter(2));
 
       expect(result.uri.toString(), endsWith('colors.scss'));
+
+      result = await ls.goToDefinition(document, at(line: 5, char: 18));
+      expect(result, isNotNull);
+      expect(result!.range, StartsAtLine(0));
+      expect(result.range, EndsAtLine(0));
+      expect(result.range, StartsAtCharacter(0));
+      expect(result.range, EndsAtCharacter(2));
+
+      expect(result.uri.toString(), endsWith('weights.scss'));
     });
 
     test('scoped in the same document', () async {
@@ -84,10 +96,10 @@ $b: blue
 @use "links";
 
 .a {
-  color: $b;
+  color: links.$b;
 }
 ''');
-      var result = await ls.goToDefinition(document, at(line: 3, char: 10));
+      var result = await ls.goToDefinition(document, at(line: 3, char: 16));
 
       expect(result, isNull);
     });
@@ -150,7 +162,7 @@ nav ul
 @use "list";
 
 nav ul {
-  @include horizontal-list;
+  @include list.horizontal-list;
 }
 ''');
       var result = await ls.goToDefinition(document, at(line: 3, char: 12));
@@ -163,6 +175,45 @@ nav ul {
 
       expect(result.uri.toString(), endsWith('list.sass'));
     });
+
+    test('behind a prefix', () async {
+      fs.createDocument(r'''
+=reset-list
+  margin: 0
+  padding: 0
+  list-style: none
+
+=horizontal-list
+  +reset-list
+
+  li
+    display: inline-block
+    margin:
+      left: -2px
+      right: 2em
+''', uri: '_list.sass');
+
+      fs.createDocument(r'''
+@forward "list" as list-*
+''', uri: 'shared.sass');
+
+      var document = fs.createDocument(r'''
+@use "shared";
+
+nav ul {
+  @include shared.list-horizontal-list;
+}
+''');
+      var result = await ls.goToDefinition(document, at(line: 3, char: 24));
+
+      expect(result, isNotNull);
+      expect(result!.range, StartsAtLine(5));
+      expect(result.range, EndsAtLine(5));
+      expect(result.range, StartsAtCharacter(1));
+      expect(result.range, EndsAtCharacter(16));
+
+      expect(result.uri.toString(), endsWith('_list.sass'));
+    });
   });
 
   group('sass functions', () {

pkgs/sass_language_services/test/features/go_to_definition/scoped_symbols_test.dart

@@ -44,28 +44,6 @@ void main() {
       expect(second.length, equals(18));
     });
 
-    test('at rules', () {
-      var document = fs.createDocument('''
-@font-face {
-  font-family: "Vulf Mono", monospace;
-}
-
-@keyframes animation {
-
-}
-''');
-      var symbols = getSymbols(document);
-
-      expect(symbols.globalScope.children, hasLength(2));
-
-      var [first, second] = symbols.globalScope.children;
-      expect(first.offset, equals(11));
-      expect(first.length, equals(42));
-
-      expect(second.offset, equals(76));
-      expect(second.length, equals(4));
-    });
-
     test('each rules', () {
       var document = fs.createDocument(r'''
 @each $i in 1, 2, 3 {