fix(riverpod_lint): correctly detects nested ref invocations

packages/riverpod_analyzer_utils/CHANGELOG.md

@@ -1,3 +1,8 @@
+## Unreleased fix
+
+- Fixed analyzer to correctly detect nested RefInvocations when used as parameters (e.g., ref.watch(provider(ref.watch(...)))). This improves the accuracy of the analyzer's error detection for complex provider compositions. (thanks to @josh-burton)
+
+
 ## 0.5.6 - 2024-10-22
 
 - Support analyzer >=6.7.0 <7.0.0

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

@@ -110,6 +110,12 @@ mixin _ParseRefInvocationMixin on RecursiveAstVisitor<void> {
     final refInvocation = RefInvocation._parse(node, superCall: superCall);
     if (refInvocation != null) {
       visitRefInvocation(refInvocation);
+
+      for (final argument in refInvocation.node.argumentList.arguments
+          .whereType<InvocationExpression>()) {
+        argument.accept(this);
+      }
+
       // Don't call super as RefInvocation should already be recursive
       return;
     }
@@ -118,6 +124,11 @@ mixin _ParseRefInvocationMixin on RecursiveAstVisitor<void> {
         WidgetRefInvocation._parse(node, superCall: superCall);
     if (widgetRefInvocation != null) {
       visitWidgetRefInvocation(widgetRefInvocation);
+
+      for (final argument in widgetRefInvocation.node.argumentList.arguments
+          .whereType<InvocationExpression>()) {
+        argument.accept(this);
+      }
       // Don't call super as WidgetRefInvocation should already be recursive
       return;
     }

packages/riverpod_analyzer_utils_tests/test/ref_invocation_test.dart

@@ -411,6 +411,76 @@ final provider = Provider<int>((ref) {
     );
   });
 
+  testSource('Decodes nested ref.read invocations with family providers',
+      runGenerator: true, source: '''
+import 'package:riverpod/riverpod.dart';
+import 'package:riverpod_annotation/riverpod_annotation.dart';
+
+part 'foo.g.dart';
+
+final dep = FutureProvider((ref) => 0);
+final dep2 = FutureProvider.family((ref, int arg) => 0);
+final dep3 = FutureProvider.family((ref, int arg) => 0);
+
+final provider = Provider<int>((ref) {
+  ref.read(dep2(ref.read(dep)));
+
+  return 0;
+});
+
+final provider2 = Provider<int>((ref) {
+  ref.read(dep3(ref.read(dep2(ref.read(dep)))));
+
+  return 0;
+});
+''', (resolver) async {
+    final result = await resolver.resolveRiverpodAnalysisResult();
+
+    expect(result.refReadInvocations, hasLength(5));
+    expect(result.refInvocations, result.refReadInvocations);
+
+    // provider
+    expect(
+      result.refReadInvocations[0].node.toSource(),
+      'ref.read(dep2(ref.read(dep)))',
+    );
+    expect(result.refReadInvocations[0].function.toSource(), 'read');
+    expect(
+      result.refReadInvocations[0].provider.providerElement,
+      same(
+        result.legacyProviderDeclarations.findByName('dep2').providerElement,
+      ),
+    );
+
+    expect(result.refReadInvocations[1].node.toSource(), 'ref.read(dep)');
+    expect(result.refReadInvocations[1].function.toSource(), 'read');
+    expect(
+      result.refReadInvocations[1].provider.providerElement,
+      same(
+        result.legacyProviderDeclarations.findByName('dep').providerElement,
+      ),
+    );
+
+    // provider2
+    expect(
+      result.refReadInvocations[2].node.toSource(),
+      'ref.read(dep3(ref.read(dep2(ref.read(dep)))))',
+    );
+    expect(result.refReadInvocations[2].function.toSource(), 'read');
+    expect(
+      result.refReadInvocations[2].provider.providerElement,
+      same(
+        result.legacyProviderDeclarations.findByName('dep3').providerElement,
+      ),
+    );
+
+    expect(
+      result.refReadInvocations[3].node.toSource(),
+      'ref.read(dep2(ref.read(dep)))',
+    );
+    expect(result.refReadInvocations[4].node.toSource(), 'ref.read(dep)');
+  });
+
   testSource('Decodes unknown ref usages', source: '''
 import 'package:riverpod/riverpod.dart';
 import 'package:riverpod_annotation/riverpod_annotation.dart';
@@ -575,6 +645,123 @@ void fn(_Ref ref) {
     );
   });
 
+  testSource('Decodes nested ref.watch invocations with family providers',
+      runGenerator: true, source: '''
+import 'package:riverpod/riverpod.dart';
+import 'package:riverpod_annotation/riverpod_annotation.dart';
+
+part 'foo.g.dart';
+
+final dep = FutureProvider((ref) => 0);
+final dep2 = FutureProvider.family((ref, int arg) => 0);
+final dep3 = FutureProvider.family((ref, int arg) => 0);
+
+final provider = Provider<int>((ref) {
+  ref.watch(dep2(ref.watch(dep)));
+
+  return 0;
+});
+
+final provider2 = Provider<int>((ref) {
+  ref.watch(dep3(ref.watch(dep2(ref.watch(dep)))));
+
+  return 0;
+});
+''', (resolver) async {
+    final result = await resolver.resolveRiverpodAnalysisResult();
+
+    expect(result.refWatchInvocations, hasLength(5));
+    expect(result.refInvocations, result.refWatchInvocations);
+
+    // provider
+    expect(
+      result.refWatchInvocations[0].node.toSource(),
+      'ref.watch(dep2(ref.watch(dep)))',
+    );
+    expect(result.refWatchInvocations[0].function.toSource(), 'watch');
+    expect(
+      result.refWatchInvocations[0].provider.providerElement,
+      same(
+        result.legacyProviderDeclarations.findByName('dep2').providerElement,
+      ),
+    );
+
+    expect(result.refWatchInvocations[1].node.toSource(), 'ref.watch(dep)');
+    expect(result.refWatchInvocations[1].function.toSource(), 'watch');
+    expect(
+      result.refWatchInvocations[1].provider.providerElement,
+      same(
+        result.legacyProviderDeclarations.findByName('dep').providerElement,
+      ),
+    );
+
+    // provider2
+    expect(
+      result.refWatchInvocations[2].node.toSource(),
+      'ref.watch(dep3(ref.watch(dep2(ref.watch(dep)))))',
+    );
+    expect(result.refWatchInvocations[2].function.toSource(), 'watch');
+    expect(
+      result.refWatchInvocations[2].provider.providerElement,
+      same(
+        result.legacyProviderDeclarations.findByName('dep3').providerElement,
+      ),
+    );
+
+    expect(
+      result.refWatchInvocations[3].node.toSource(),
+      'ref.watch(dep2(ref.watch(dep)))',
+    );
+    expect(result.refWatchInvocations[4].node.toSource(), 'ref.watch(dep)');
+  });
+
+  testSource('Decodes mix of nested ref.watch and ref.read invocations',
+      runGenerator: true, source: '''
+import 'package:riverpod/riverpod.dart';
+import 'package:riverpod_annotation/riverpod_annotation.dart';
+
+part 'foo.g.dart';
+
+final dep = FutureProvider((ref) => 0);
+final dep2 = FutureProvider.family((ref, int arg) => 0);
+
+final provider = Provider<int>((ref) {
+  ref.watch(dep2(ref.read(dep)));
+
+  return 0;
+});
+''', (resolver) async {
+    final result = await resolver.resolveRiverpodAnalysisResult();
+
+    expect(result.refWatchInvocations, hasLength(1));
+    expect(result.refReadInvocations, hasLength(1));
+    expect(
+      result.refInvocations,
+      [...result.refWatchInvocations, ...result.refReadInvocations],
+    );
+
+    expect(
+      result.refWatchInvocations[0].node.toSource(),
+      'ref.watch(dep2(ref.read(dep)))',
+    );
+    expect(result.refWatchInvocations[0].function.toSource(), 'watch');
+    expect(
+      result.refWatchInvocations[0].provider.providerElement,
+      same(
+        result.legacyProviderDeclarations.findByName('dep2').providerElement,
+      ),
+    );
+
+    expect(result.refReadInvocations[0].node.toSource(), 'ref.read(dep)');
+    expect(result.refReadInvocations[0].function.toSource(), 'read');
+    expect(
+      result.refReadInvocations[0].provider.providerElement,
+      same(
+        result.legacyProviderDeclarations.findByName('dep').providerElement,
+      ),
+    );
+  });
+
   testSource('Decodes provider.query ref.watch usages',
       runGenerator: true, source: r'''
 import 'package:riverpod/riverpod.dart';

packages/riverpod_lint/CHANGELOG.md

@@ -1,3 +1,7 @@
+## Unreleased fix
+
+- provider_dependencies now correctly detects nested ref invocations where a dependency is used as a parameter of another dependency (thanks to @josh-burton)
+
 ## 2.6.1 - 2024-10-22
 
 - Support analyzer >=6.7.0 <7.0.0

packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.dart

@@ -9,6 +9,9 @@ int dep(Ref ref) => 0;
 @Riverpod(dependencies: [])
 int dep2(Ref ref) => 0;
 
+@Riverpod(dependencies: [])
+int dep3(Ref ref, int parameter) => 0;
+
 ////////////
 
 // expect_lint: provider_dependencies
@@ -70,6 +73,18 @@ int extraDep(Ref ref) {
   return 0;
 }
 
+@Riverpod(
+  keepAlive: false,
+  // expect_lint: provider_dependencies
+  dependencies: [
+    dep3,
+  ],
+)
+int onFamilyDep(Ref ref) {
+  ref.read(dep3Provider(ref.read(dep2Provider)));
+  return 0;
+}
+
 @Riverpod(
   keepAlive: false,
   dependencies: [

packages/riverpod_lint_flutter_test/test/lints/provider_dependencies/provider_dependencies.diff

@@ -1,6 +1,6 @@
 Message: `Specify "dependencies"`
 Priority: 100
-Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:15`:
+Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:18`:
 ```
 
 // expect_lint: provider_dependencies
@@ -12,7 +12,7 @@ int plainAnnotation(Ref ref) {
 ---
 Message: `Specify "dependencies"`
 Priority: 100
-Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:22`:
+Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:25`:
 ```
 
 // expect_lint: provider_dependencies
@@ -24,7 +24,7 @@ int customAnnotation(Ref ref) {
 ---
 Message: `Specify "dependencies"`
 Priority: 100
-Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:30`:
+Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:33`:
 ```
 // expect_lint: provider_dependencies
 @Riverpod(
@@ -36,7 +36,7 @@ int customAnnotationWithTrailingComma(
 ---
 Message: `Update "dependencies"`
 Priority: 100
-Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:42`:
+Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:45`:
 ```
   keepAlive: false,
   // expect_lint: provider_dependencies
@@ -48,7 +48,7 @@ int existingDep(Ref ref) {
 ---
 Message: `Update "dependencies"`
 Priority: 100
-Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:52`:
+Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:55`:
 ```
   keepAlive: false,
   // expect_lint: provider_dependencies
@@ -60,7 +60,7 @@ int multipleDeps(Ref ref) {
 ---
 Message: `Update "dependencies"`
 Priority: 100
-Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:62`:
+Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:65`:
 ```
 @Riverpod(
   keepAlive: false,
@@ -74,9 +74,23 @@ Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:62`:
 int extraDep(Ref ref) {
 ```
 ---
+Message: `Update "dependencies"`
+Priority: 100
+Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:79`:
+```
+  keepAlive: false,
+  // expect_lint: provider_dependencies
+-   dependencies: [
+-     dep3,
+-   ],
++   dependencies: [dep3, dep2],
+)
+int onFamilyDep(Ref ref) {
+```
+---
 Message: `Remove "dependencies"`
 Priority: 100
-Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:75`:
+Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:90`:
 ```
 @Riverpod(
   keepAlive: false,
@@ -92,7 +106,7 @@ int noDep(Ref ref) {
 ---
 Message: `Remove "dependencies"`
 Priority: 100
-Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:85`:
+Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:100`:
 ```
 
 @Riverpod(
@@ -108,7 +122,7 @@ int dependenciesFirstThenKeepAlive(Ref ref) {
 ---
 Message: `Remove "dependencies"`
 Priority: 100
-Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:95`:
+Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:110`:
 ```
 }
 
@@ -125,7 +139,7 @@ int noDepNoParam(Ref ref) {
 ---
 Message: `Remove "dependencies"`
 Priority: 100
-Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:106`:
+Diff for file `test/lints/provider_dependencies/provider_dependencies.dart:121`:
 ```
 
 // expect_lint: provider_dependencies