Parse import aliases in ref expressions (#2942)

fixes #2935

packages/riverpod_analyzer_utils/CHANGELOG.md

@@ -1,3 +1,7 @@
+## Unreleased patch
+
+- Correctly parse import aliases when used inside `ref.watch(<...>)`
+
 ## 0.3.4 - 2023-09-27
 
 - Fixed `refInvocations` not getting parsed for generated providers with arguments.

packages/riverpod_analyzer_utils/lib/src/riverpod_ast/provider_listenable_expression.dart

@@ -6,15 +6,16 @@ class ProviderListenableExpression extends RiverpodAst {
   ProviderListenableExpression._({
     required this.node,
     required this.provider,
+    required this.providerPrefix,
     required this.providerElement,
     required this.familyArguments,
   });
 
   static ProviderListenableExpression? _parse(Expression? expression) {
     if (expression == null) return null;
 
-    // print('oy $expression // ${expression.runtimeType}');
     SimpleIdentifier? provider;
+    SimpleIdentifier? providerPrefix;
     ProviderDeclarationElement? providerElement;
     ArgumentList? familyArguments;
 
@@ -26,6 +27,7 @@ class ProviderListenableExpression extends RiverpodAst {
         provider = expression;
         final element = expression.staticElement;
         if (element is PropertyAccessorElement) {
+          // watch(provider)
           DartObject? annotation;
           try {
             annotation =
@@ -50,7 +52,13 @@ class ProviderListenableExpression extends RiverpodAst {
         parseExpression(expression.target);
       } else if (expression is PrefixedIdentifier) {
         // watch(expression.modifier)
-        parseExpression(expression.prefix);
+        final element = expression.prefix.staticElement;
+        if (element is PrefixElement) {
+          providerPrefix = expression.prefix;
+          parseExpression(expression.identifier);
+        } else {
+          parseExpression(expression.prefix);
+        }
       } else if (expression is IndexExpression) {
         // watch(expression[])
         parseExpression(expression.target);
@@ -65,6 +73,7 @@ class ProviderListenableExpression extends RiverpodAst {
     return ProviderListenableExpression._(
       node: expression,
       provider: provider,
+      providerPrefix: providerPrefix,
       providerElement: providerElement,
       // Make sure `(){}()` doesn't report an argument list even though it's not a provider
       familyArguments: provider == null ? null : familyArguments,
@@ -96,6 +105,7 @@ class ProviderListenableExpression extends RiverpodAst {
   }
 
   final Expression node;
+  final SimpleIdentifier? providerPrefix;
   final SimpleIdentifier? provider;
   final ProviderDeclarationElement? providerElement;
 

packages/riverpod_analyzer_utils_tests/test/analyser_test_utils.dart

@@ -20,6 +20,7 @@ void testSource(
   String description,
   Future<void> Function(Resolver resolver) run, {
   required String source,
+  Map<String, String> files = const {},
   bool runGenerator = false,
 }) {
   final testId = _testNumber++;
@@ -33,10 +34,19 @@ void testSource(
 
       final enclosingZone = Zone.current;
 
+      final otherSources = {
+        for (final entry in files.entries)
+          '$packageName|lib/${entry.key}':
+              'library "${entry.key}"; ${entry.value}',
+      };
+
       String? generated;
       if (runGenerator) {
         final analysisResult = await resolveSources(
-          {'$packageName|lib/foo.dart': sourceWithLibrary},
+          {
+            '$packageName|lib/foo.dart': sourceWithLibrary,
+            ...otherSources,
+          },
           (resolver) {
             return resolver.resolveRiverpodLibraryResult(
               ignoreErrors: true,
@@ -50,6 +60,7 @@ void testSource(
         '$packageName|lib/foo.dart': sourceWithLibrary,
         if (generated != null)
           '$packageName|lib/foo.g.dart': 'part of "foo.dart";$generated',
+        ...otherSources,
       }, (resolver) async {
         try {
           final originalZone = Zone.current;

packages/riverpod_analyzer_utils_tests/test/ref_invocation_test.dart

@@ -4,6 +4,47 @@ import 'package:test/test.dart';
 import 'analyser_test_utils.dart';
 
 void main() {
+  testSource(
+    'Parses import aliases',
+    runGenerator: true,
+    files: {
+      'file.dart': '''
+import 'package:riverpod_annotation/riverpod_annotation.dart';
+final aProvider = Provider<int>((ref) => 0);
+''',
+    },
+    source: '''
+import 'package:riverpod_annotation/riverpod_annotation.dart';
+import 'file.dart' as alias;
+part 'foo.g.dart';
+
+@Riverpod(keepAlive: true)
+int aliased(AliasedRef ref) {
+  ref.watch(alias.aProvider);
+  return 0;
+}
+''',
+    (resolver) async {
+      final result = await resolver.resolveRiverpodAnalyssiResult();
+
+      expect(result.refWatchInvocations, hasLength(1));
+      expect(result.refInvocations.single.function.toSource(), 'watch');
+      expect(
+        result.refInvocations.single.node.toSource(),
+        'ref.watch(alias.aProvider)',
+      );
+
+      expect(
+        result.refWatchInvocations.single.provider.provider?.toSource(),
+        'aProvider',
+      );
+      expect(
+        result.refWatchInvocations.single.provider.providerPrefix?.toSource(),
+        'alias',
+      );
+    },
+  );
+
   testSource('Decode watch expressions with syntax errors', source: '''
 import 'package:riverpod_annotation/riverpod_annotation.dart';
 

packages/riverpod_lint/CHANGELOG.md

@@ -1,6 +1,7 @@
 ## Unreleased minor
 
 - Added `avoid_build_context_in_providers` (thanks to @charlescyt)
+- Fixed false positive with `avoid_manual_providers_as_generated_provider_dependency` when using import aliases
 
 ## 2.1.1 - 2023-09-27
 

packages/riverpod_lint_flutter_test/test/lints/another.dart

@@ -0,0 +1,8 @@
+import 'package:riverpod_annotation/riverpod_annotation.dart';
+
+part 'another.g.dart';
+
+final aProvider = Provider<int>((ref) => 0);
+
+@riverpod
+int b(BRef ref) => 0;

packages/riverpod_lint_flutter_test/test/lints/dependencies.dart

@@ -1,4 +1,7 @@
+// ignore_for_file: unused_field
+
 import 'package:riverpod_annotation/riverpod_annotation.dart';
+import 'another.dart' as import_alias;
 
 part 'dependencies.g.dart';
 
@@ -198,3 +201,23 @@ int familyDep2(FamilyDep2Ref ref, int p) {
   final test = ref.watch(familyDepProvider(0));
   return test * p;
 }
+
+// Regression test for https://github.com/rrousselGit/riverpod/issues/2935
+@riverpod
+int alias(AliasRef ref) {
+  // expect_lint: avoid_manual_providers_as_generated_provider_dependency
+  ref.watch(import_alias.aProvider);
+  ref.watch(import_alias.bProvider);
+  return 0;
+}
+
+// Regression test for https://github.com/rrousselGit/riverpod/issues/2935
+@riverpod
+class AliasClass extends _$AliasClass {
+  // expect_lint: avoid_manual_providers_as_generated_provider_dependency
+  late final int _a = ref.read(import_alias.aProvider);
+  late final int _b = ref.read(import_alias.bProvider);
+
+  @override
+  int build() => 0;
+}